Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

custom_profile_fields: Migrate admin table to use ListWidget. 

ListWidget will allow us to use our standard structure for empty table
placeholder.

This is a prep commit for #27250.
This commit is contained in:
tnmkr 2024-06-23 09:10:39 +05:30 committed by Tim Abbott
parent 55f97cd06f
commit 2c8b1adc5f
2 changed files with 55 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

87
web/src/settings_profile_fields.ts
View File

@ -13,6 +13,7 @@ import * as channel from "./channel";
import * as confirm_dialog from "./confirm_dialog";
import * as dialog_widget from "./dialog_widget";
import {$t, $t_html} from "./i18n";
import * as ListWidget from "./list_widget";
import * as loading from "./loading";
import * as people from "./people";
import * as settings_components from "./settings_components";
@ -665,51 +666,55 @@ export function do_populate_profile_fields(profile_fields_data: CustomProfileFie
// We should only call this internally or from tests.
const $profile_fields_table = $("#admin_profile_fields_table").expectOne();
$profile_fields_table.find("tr.profile-field-row").remove(); // Clear all rows.
$profile_fields_table.find("tr.profile-field-form").remove(); // Clear all rows.
order = [];
let display_in_profile_summary_fields_count = 0;
for (const profile_field of profile_fields_data) {
order.push(profile_field.id);
let choices: FieldChoice[] = [];
if (profile_field.field_data && profile_field.type === field_types.SELECT.id) {
const field_data = settings_components.select_field_data_schema.parse(
JSON.parse(profile_field.field_data),
);
choices = parse_field_choices_from_field_data(field_data);
}
const display_in_profile_summary = profile_field.display_in_profile_summary === true;
const required = profile_field.required;
$profile_fields_table.append(
$(
render_admin_profile_field_list({
profile_field: {
id: profile_field.id,
name: profile_field.name,
hint: profile_field.hint,
type: field_type_id_to_string(profile_field.type),
choices,
is_select_field: profile_field.type === field_types.SELECT.id,
is_external_account_field:
profile_field.type === field_types.EXTERNAL_ACCOUNT.id,
display_in_profile_summary,
valid_to_display_in_summary: is_valid_to_display_in_summary(
profile_field.type,
),
required,
},
can_modify: current_user.is_admin,
realm_default_external_accounts: realm.realm_default_external_accounts,
}),
),
);
// Keeping counts of all display_in_profile_summary profile fields, to keep track.
if (display_in_profile_summary) {
display_in_profile_summary_fields_count += 1;
}
}
ListWidget.create($profile_fields_table, profile_fields_data, {
name: "settings_profile_fields_list",
get_item(profile_field) {
order.push(profile_field.id);
return profile_field;
},
modifier_html(profile_field) {
let choices: FieldChoice[] = [];
if (profile_field.field_data && profile_field.type === field_types.SELECT.id) {
const field_data = settings_components.select_field_data_schema.parse(
JSON.parse(profile_field.field_data),
);
choices = parse_field_choices_from_field_data(field_data);
}
const display_in_profile_summary = profile_field.display_in_profile_summary === true;
const required = profile_field.required;
// Keeping counts of all display_in_profile_summary profile fields, to keep track of
// whether the limit has been reached.
if (display_in_profile_summary) {
display_in_profile_summary_fields_count += 1;
}
return render_admin_profile_field_list({
profile_field: {
id: profile_field.id,
name: profile_field.name,
hint: profile_field.hint,
type: field_type_id_to_string(profile_field.type),
choices,
is_select_field: profile_field.type === field_types.SELECT.id,
is_external_account_field:
profile_field.type === field_types.EXTERNAL_ACCOUNT.id,
display_in_profile_summary,
valid_to_display_in_summary: is_valid_to_display_in_summary(profile_field.type),
required,
},
can_modify: current_user.is_admin,
realm_default_external_accounts: realm.realm_default_external_accounts,
});
},
$parent_container: $("#profile-field-settings").expectOne(),
$simplebar_container: $("#profile-field-settings .progressive-table-wrapper"),
});
// Update whether we're at the limit for display_in_profile_summary.
display_in_profile_summary_fields_limit_reached = display_in_profile_summary_fields_count >= 2;

22
web/tests/settings_profile_fields.test.js
View File

@ -48,6 +48,15 @@ const Sortable = {create: noop};
mock_esm("sortablejs", {default: Sortable});
mock_esm("../src/list_widget", {
generic_sort_functions: noop,
create(_container, custom_profile_data, opts) {
for (const item of custom_profile_data) {
opts.modifier_html(item);
}
},
});
const settings_profile_fields = zrequire("settings_profile_fields");
const {set_current_user, set_realm} = zrequire("state_data");
@ -63,27 +72,14 @@ function test_populate(opts, template_data) {
override(realm, "custom_profile_field_types", custom_profile_field_types);
override(current_user, "is_admin", opts.is_admin);
const $table = $("#admin_profile_fields_table");
const $rows = $.create("rows");
const $form = $.create("forms");
$table.set_find_results("tr.profile-field-row", $rows);
$table.set_find_results("tr.profile-field-form", $form);
$table[0] = "stub";
$rows.remove = noop;
$form.remove = noop;
let num_appends = 0;
$table.append = () => {
num_appends += 1;
};
loading.destroy_indicator = noop;
settings_profile_fields.do_populate_profile_fields(fields_data);
assert.deepEqual(template_data, opts.expected_template_data);
assert.equal(num_appends, fields_data.length);
});
}