12303026020

Committed 12 Dec 2024 07:02PM UTC coverage: 64.78% (-0.1%) from 64.91%

Build # 12303026020

Build Type

Pull #2421

github

Committed by

web-flow

Commit Message

Merge 777dd6696 into f41bc9ac2

Pull Request Pull Request #2421: [ENG-6665] Add user messaging modal to user's tab on institutional dashboard

Run Details

2738 of 4645 branches covered (58.95%)

Branch coverage included in aggregate %.

2 of 28 new or added lines in 2 files covered. (7.14%)

19 existing lines in 1 file now uncovered.

6970 of 10341 relevant lines covered (67.4%)

200.85 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

48.54

/app/institutions/dashboard/-components/institutional-users-list/component.ts

import { task } from 'ember-concurrency';
import Component from '@glimmer/component';
import { tracked } from '@glimmer/tracking';
import { action } from '@ember/object';
import { inject as service } from '@ember/service';
import { waitFor } from '@ember/test-waiters';
import { restartableTask, timeout } from 'ember-concurrency';
import Intl from 'ember-intl/services/intl';

import InstitutionModel from 'ember-osf-web/models/institution';
import InstitutionDepartmentsModel from 'ember-osf-web/models/institution-department';
import Analytics from 'ember-osf-web/services/analytics';
import { RelationshipWithLinks } from 'osf-api';

interface Column {
    key: string;
    selected: boolean;
    label: string;
    sort_key: string | false;
    type: 'string' | 'date_by_month' | 'osf_link' | 'user_name' | 'orcid';
}

interface InstitutionalUsersListArgs {
    institution: InstitutionModel;
    departmentMetrics: InstitutionDepartmentsModel[];
}

export default class InstitutionalUsersList extends Component<InstitutionalUsersListArgs> {
    @service analytics!: Analytics;
    @service intl!: Intl;
    @service store;
    @service currentUser!: CurrentUser;

    institution?: InstitutionModel;

    departmentMetrics?: InstitutionDepartmentsModel[];

    // Properties
    @tracked department = this.defaultDepartment;
    @tracked sort = 'user_name';
    @tracked selectedDepartments: string[] = [];
    @tracked filteredUsers = [];
    @tracked messageModalShown = false;
    @tracked messageText = '';
    @tracked selectedUserId = null;
    @service toast!: Toast;

    @tracked columns: Column[] = [
        {
            key: 'user_name',
            sort_key: 'user_name',
            label: this.intl.t('institutions.dashboard.users_list.name'),
            selected: true,
            type: 'user_name',
        },
        {
            key: 'department',
            sort_key: 'department',
            label: this.intl.t('institutions.dashboard.users_list.department'),
            selected: true,
            type: 'string',
        },
        {
            key: 'osf_link',
            sort_key: false,
            label: this.intl.t('institutions.dashboard.users_list.osf_link'),
            selected: true,
            type: 'osf_link',
        },
        {
            key: 'orcid',
            sort_key: false,
            label: this.intl.t('institutions.dashboard.users_list.orcid'),
            selected: true,
            type: 'orcid',
        },
        {
            key: 'publicProjects',
            sort_key: 'public_projects',
            label: this.intl.t('institutions.dashboard.users_list.public_projects'),
            selected: true,
            type: 'string',
        },
        {
            key: 'privateProjects',
            sort_key: 'private_projects',
            label: this.intl.t('institutions.dashboard.users_list.private_projects'),
            selected: true,
            type: 'string',
        },
        {
            key: 'publicRegistrationCount',
            sort_key: 'public_registration_count',
            label: this.intl.t('institutions.dashboard.users_list.public_registration_count'),
            selected: true,
            type: 'string',
        },
        {
            key: 'embargoedRegistrationCount',
            sort_key: 'embargoed_registration_count',
            label: this.intl.t('institutions.dashboard.users_list.embargoed_registration_count'),
            selected: true,
            type: 'string',
        },
        {
            key: 'publishedPreprintCount',
            sort_key: 'published_preprint_count',
            label: this.intl.t('institutions.dashboard.users_list.published_preprint_count'),
            selected: true,
            type: 'string',
        },
        {
            key: 'publicFileCount',
            sort_key: 'public_file_count',
            label: this.intl.t('institutions.dashboard.users_list.public_file_count'),
            selected: false,
            type: 'string',
        },
        {
            key: 'userDataUsage',
            sort_key: 'storage_byte_count',
            label: this.intl.t('institutions.dashboard.users_list.storage_byte_count'),
            selected: false,
            type: 'string',
        },
        {
            key: 'accountCreationDate',
            sort_key: 'account_creation_date',
            label: this.intl.t('institutions.dashboard.users_list.account_created'),
            selected: false,
            type: 'date_by_month',
        },
        {
            key: 'monthLastLogin',
            sort_key: 'month_last_login',
            label: this.intl.t('institutions.dashboard.users_list.month_last_login'),
            selected: false,
            type: 'date_by_month',
        },
        {
            key: 'monthLastActive',
            sort_key: 'month_last_active',
            label: this.intl.t('institutions.dashboard.users_list.month_last_active'),
            selected: false,
            type: 'date_by_month',
        },
    ];

    @tracked selectedColumns: string[] = this.columns.filter(col => col.selected).map(col => col.key);
    // Private properties
    @tracked hasOrcid = false;
    @tracked totalUsers = 0;
    orcidUrlPrefix = 'https://orcid.org/';

    @action
    toggleColumnSelection(columnKey: string) {
        const column = this.columns.find(col => col.key === columnKey);
        if (column) {
            column.selected = !column.selected;
        }
    }

    get defaultDepartment() {
        return this.intl.t('institutions.dashboard.select_default');
    }

    get departments() {
        let departments = [this.defaultDepartment];

        if (this.args.institution && this.args.departmentMetrics) {
            const institutionDepartments = this.args.departmentMetrics.map((x: InstitutionDepartmentsModel) => x.name);
            departments = departments.concat(institutionDepartments);
        }
        return departments;
    }

    get isDefaultDepartment() {
        return this.department === this.defaultDepartment;
    }

    get queryUsers() {
        const query = {} as Record<string, string>;
        if (this.department && !this.isDefaultDepartment) {
            query['filter[department]'] = this.department;
        }
        if (this.hasOrcid) {
            query['filter[orcid_id][ne]'] = '';
        }
        if (this.sort) {
            query.sort = this.sort;
        }
        return query;
    }

    downloadUrl(format: string) {
        const institutionRelationships = this.args.institution.links.relationships;
        const usersLink = (institutionRelationships!.user_metrics as RelationshipWithLinks).links.related.href;
        const userURL = new URL(usersLink!);
        userURL.searchParams.set('format', format);
        userURL.searchParams.set('page[size]', '10000');
        Object.entries(this.queryUsers).forEach(([key, value]) => {
            userURL.searchParams.set(key, value);
        });
        return userURL.toString();
    }

    get downloadCsvUrl() {
        return this.downloadUrl('csv');
    }

    get downloadTsvUrl() {
        return this.downloadUrl('tsv');
    }

    get downloadJsonUrl() {
        return this.downloadUrl('json_report');
    }

    @restartableTask
    @waitFor
    async searchDepartment(name: string) {
        await timeout(500);
        if (this.institution) {
            const depts: InstitutionDepartmentsModel[] = await this.args.institution.queryHasMany('departmentMetrics', {
                filter: {
                    name,
                },
            });
            return depts.map(dept => dept.name);
        }
        return [];
    }

    @action
    onSelectChange(department: string) {
        this.department = department;
    }

    @action
    sortInstitutionalUsers(sortBy: string) {
        if (this.sort === sortBy) {
            // If the current sort is ascending, toggle to descending
            this.sort = `-${sortBy}`;
        } else if (this.sort === `-${sortBy}`) {
            // If the current sort is descending, toggle to ascending
            this.sort = sortBy;
        } else {
            // Set to descending if it's a new sort field
            this.sort = `-${sortBy}`;
        }
    }

    @action
    cancelSelection() {
        this.selectedDepartments = [];
    }

    @action
    applyColumnSelection() {
        this.selectedColumns = this.columns.filter(col => col.selected).map(col => col.key);
    }

    @action
    toggleOrcidFilter(hasOrcid: boolean) {
        this.hasOrcid = hasOrcid;
    }

    @action
    clickToggleOrcidFilter(hasOrcid: boolean) {
        this.hasOrcid = !hasOrcid;
    }

    @action
    openMessageModal(userId: string) {
        this.selectedUserId = userId;
        this.messageModalShown = true;
    }

    @action
    toggleMessageModal(userId: string | null = null) {
        this.messageModalShown = !this.messageModalShown;
        this.selectedUserId = userId;
        if (!this.messageModalShown) {
            this.resetModalFields();
        }
    }

    @action
    resetModalFields() {
        this.messageText = '';
        this.cc = false;
        this.replyTo = false;
        this.selectedUserId = null;
    }

    @action
    updateMessageText(event: Event) {
        this.messageText = (event.target as HTMLTextAreaElement).value;
    }

    @action
    toggleCc() {
        this.cc = !this.cc;
    }

    @action
    toggleReplyTo() {
        this.replyTo = !this.replyTo;
    }

    @task
    @waitFor
    async sendMessage() {
        if (!this.messageText.trim()) {
            this.toast.error(this.intl.t('error.empty_message'));
            return;
        }

        try {
            const userMessage = this.store.createRecord('user-message', {
                messageText: this.messageText.trim(),
                messageType: 'institutional_request',
                cc: this.cc,
                replyTo: this.replyTo,
                institution: this.args.institution,
                user: this.selectedUserId,
            });

            await userMessage.save();
            this.toast.success(this.intl.t('institutions.dashboard.send_message_modal.message_sent_success'));
        } catch (error) {
            this.toast.error(this.intl.t('institutions.dashboard.send_message_modal.message_sent_failed'));
        } finally {
            this.messageModalShown = false;
        }
    }
}

1	import { task } from 'ember-concurrency';
2	import Component from '@glimmer/component';
3	import { tracked } from '@glimmer/tracking';
4	import { action } from '@ember/object';
5	import { inject as service } from '@ember/service';
6	import { waitFor } from '@ember/test-waiters';
7	import { restartableTask, timeout } from 'ember-concurrency';
8	import Intl from 'ember-intl/services/intl';
9
10	import InstitutionModel from 'ember-osf-web/models/institution';
11	import InstitutionDepartmentsModel from 'ember-osf-web/models/institution-department';
12	import Analytics from 'ember-osf-web/services/analytics';
13	import { RelationshipWithLinks } from 'osf-api';
14
15	interface Column {
16	key: string;
17	selected: boolean;
18	label: string;
19	sort_key: string \| false;
20	type: 'string' \| 'date_by_month' \| 'osf_link' \| 'user_name' \| 'orcid';
21	}
22
23	interface InstitutionalUsersListArgs {
24	institution: InstitutionModel;
25	departmentMetrics: InstitutionDepartmentsModel[];
26	}
27
28	export default class InstitutionalUsersList extends Component<InstitutionalUsersListArgs> {
29	@service analytics!: Analytics;
30	@service intl!: Intl;
31	@service store;
32	@service currentUser!: CurrentUser;
33
34	institution?: InstitutionModel;
35
36	departmentMetrics?: InstitutionDepartmentsModel[];
37
38	// Properties
39	@tracked department = this.defaultDepartment;	3✔
40	@tracked sort = 'user_name';	3✔
UNCOV 41	@tracked selectedDepartments: string[] = [];	×
42	@tracked filteredUsers = [];	×
43	@tracked messageModalShown = false;	3✔
NEW 44	@tracked messageText = '';	×
NEW 45	@tracked selectedUserId = null;	×
46	@service toast!: Toast;
47
48	@tracked columns: Column[] = [	3✔
49	{
50	key: 'user_name',
51	sort_key: 'user_name',
52	label: this.intl.t('institutions.dashboard.users_list.name'),
53	selected: true,
54	type: 'user_name',
55	},
56	{
57	key: 'department',
58	sort_key: 'department',
59	label: this.intl.t('institutions.dashboard.users_list.department'),
60	selected: true,
61	type: 'string',
62	},
63	{
64	key: 'osf_link',
65	sort_key: false,
66	label: this.intl.t('institutions.dashboard.users_list.osf_link'),
67	selected: true,
68	type: 'osf_link',
69	},
70	{
71	key: 'orcid',
72	sort_key: false,
73	label: this.intl.t('institutions.dashboard.users_list.orcid'),
74	selected: true,
75	type: 'orcid',
76	},
77	{
78	key: 'publicProjects',
79	sort_key: 'public_projects',
80	label: this.intl.t('institutions.dashboard.users_list.public_projects'),
81	selected: true,
82	type: 'string',
83	},
84	{
85	key: 'privateProjects',
86	sort_key: 'private_projects',
87	label: this.intl.t('institutions.dashboard.users_list.private_projects'),
88	selected: true,
89	type: 'string',
90	},
91	{
92	key: 'publicRegistrationCount',
93	sort_key: 'public_registration_count',
94	label: this.intl.t('institutions.dashboard.users_list.public_registration_count'),
95	selected: true,
96	type: 'string',
97	},
98	{
99	key: 'embargoedRegistrationCount',
100	sort_key: 'embargoed_registration_count',
101	label: this.intl.t('institutions.dashboard.users_list.embargoed_registration_count'),
102	selected: true,
103	type: 'string',
104	},
105	{
106	key: 'publishedPreprintCount',
107	sort_key: 'published_preprint_count',
108	label: this.intl.t('institutions.dashboard.users_list.published_preprint_count'),
109	selected: true,
110	type: 'string',
111	},
112	{
113	key: 'publicFileCount',
114	sort_key: 'public_file_count',
115	label: this.intl.t('institutions.dashboard.users_list.public_file_count'),
116	selected: false,
117	type: 'string',
118	},
119	{
120	key: 'userDataUsage',
121	sort_key: 'storage_byte_count',
122	label: this.intl.t('institutions.dashboard.users_list.storage_byte_count'),
123	selected: false,
124	type: 'string',
125	},
126	{
127	key: 'accountCreationDate',
128	sort_key: 'account_creation_date',
129	label: this.intl.t('institutions.dashboard.users_list.account_created'),
130	selected: false,
131	type: 'date_by_month',
132	},
133	{
134	key: 'monthLastLogin',
135	sort_key: 'month_last_login',
136	label: this.intl.t('institutions.dashboard.users_list.month_last_login'),
137	selected: false,
138	type: 'date_by_month',
139	},
140	{
141	key: 'monthLastActive',
142	sort_key: 'month_last_active',
143	label: this.intl.t('institutions.dashboard.users_list.month_last_active'),
144	selected: false,
145	type: 'date_by_month',
146	},
147	];
148
149	@tracked selectedColumns: string[] = this.columns.filter(col => col.selected).map(col => col.key);	42✔
150	// Private properties
151	@tracked hasOrcid = false;	3✔
152	@tracked totalUsers = 0;	3✔
153	orcidUrlPrefix = 'https://orcid.org/';	3✔
154
155	@action
156	toggleColumnSelection(columnKey: string) {
UNCOV 157	const column = this.columns.find(col => col.key === columnKey);	×
UNCOV 158	if (column) {	×
UNCOV 159	column.selected = !column.selected;	×
160	}
161	}
162
163	get defaultDepartment() {
164	return this.intl.t('institutions.dashboard.select_default');	15✔
165	}
166
167	get departments() {
168	let departments = [this.defaultDepartment];	3✔
169
170	if (this.args.institution && this.args.departmentMetrics) {	3✔
171	const institutionDepartments = this.args.departmentMetrics.map((x: InstitutionDepartmentsModel) => x.name);	3✔
172	departments = departments.concat(institutionDepartments);	1✔
173	}
174	return departments;	3✔
175	}
176
177	get isDefaultDepartment() {
178	return this.department === this.defaultDepartment;	9✔
179	}
180
181	get queryUsers() {
182	const query = {} as Record<string, string>;	9✔
183	if (this.department && !this.isDefaultDepartment) {	9!
UNCOV 184	query['filter[department]'] = this.department;	×
185	}
186	if (this.hasOrcid) {	9!
187	query['filter[orcid_id][ne]'] = '';	×
188	}
189	if (this.sort) {	9!
190	query.sort = this.sort;	9✔
191	}
192	return query;	9✔
193	}
194
195	downloadUrl(format: string) {
196	const institutionRelationships = this.args.institution.links.relationships;	3✔
197	const usersLink = (institutionRelationships!.user_metrics as RelationshipWithLinks).links.related.href;	3✔
198	const userURL = new URL(usersLink!);	3✔
199	userURL.searchParams.set('format', format);	3✔
200	userURL.searchParams.set('page[size]', '10000');	3✔
201	Object.entries(this.queryUsers).forEach(([key, value]) => {	3✔
202	userURL.searchParams.set(key, value);	3✔
203	});
204	return userURL.toString();	3✔
205	}
206
207	get downloadCsvUrl() {
208	return this.downloadUrl('csv');	1✔
209	}
210
211	get downloadTsvUrl() {
212	return this.downloadUrl('tsv');	1✔
213	}
214
215	get downloadJsonUrl() {
216	return this.downloadUrl('json_report');	1✔
217	}
218
219	@restartableTask
220	@waitFor
221	async searchDepartment(name: string) {
UNCOV 222	await timeout(500);	×
UNCOV 223	if (this.institution) {	×
UNCOV 224	const depts: InstitutionDepartmentsModel[] = await this.args.institution.queryHasMany('departmentMetrics', {	×
225	filter: {
226	name,
227	},
228	});
UNCOV 229	return depts.map(dept => dept.name);	×
230	}
UNCOV 231	return [];	×
232	}
233
234	@action
235	onSelectChange(department: string) {
UNCOV 236	this.department = department;	×
237	}
238
239	@action
240	sortInstitutionalUsers(sortBy: string) {
241	if (this.sort === sortBy) {	3✔
242	// If the current sort is ascending, toggle to descending
243	this.sort = `-${sortBy}`;	1✔
244	} else if (this.sort === `-${sortBy}`) {	2✔
245	// If the current sort is descending, toggle to ascending
246	this.sort = sortBy;	1✔
247	} else {
248	// Set to descending if it's a new sort field
249	this.sort = `-${sortBy}`;	1✔
250	}
251	}
252
253	@action
254	cancelSelection() {
UNCOV 255	this.selectedDepartments = [];	×
256	}
257
258	@action
259	applyColumnSelection() {
UNCOV 260	this.selectedColumns = this.columns.filter(col => col.selected).map(col => col.key);	×
261	}
262
263	@action
264	toggleOrcidFilter(hasOrcid: boolean) {
UNCOV 265	this.hasOrcid = hasOrcid;	×
266	}
267
268	@action
269	clickToggleOrcidFilter(hasOrcid: boolean) {
UNCOV 270	this.hasOrcid = !hasOrcid;	×
271	}
272
273	@action
274	openMessageModal(userId: string) {
NEW 275	this.selectedUserId = userId;	×
NEW 276	this.messageModalShown = true;	×
277	}
278
279	@action
280	toggleMessageModal(userId: string \| null = null) {	×
NEW 281	this.messageModalShown = !this.messageModalShown;	×
NEW 282	this.selectedUserId = userId;	×
NEW 283	if (!this.messageModalShown) {	×
NEW 284	this.resetModalFields();	×
285	}
286	}
287
288	@action
289	resetModalFields() {
NEW 290	this.messageText = '';	×
NEW 291	this.cc = false;	×
NEW 292	this.replyTo = false;	×
NEW 293	this.selectedUserId = null;	×
294	}
295
296	@action
297	updateMessageText(event: Event) {
NEW 298	this.messageText = (event.target as HTMLTextAreaElement).value;	×
299	}
300
301	@action
302	toggleCc() {
NEW 303	this.cc = !this.cc;	×
304	}
305
306	@action
307	toggleReplyTo() {
NEW 308	this.replyTo = !this.replyTo;	×
309	}
310
311	@task
312	@waitFor
313	async sendMessage() {
NEW 314	if (!this.messageText.trim()) {	×
NEW 315	this.toast.error(this.intl.t('error.empty_message'));	×
NEW 316	return;	×
317	}
318
NEW 319	try {	×
NEW 320	const userMessage = this.store.createRecord('user-message', {	×
321	messageText: this.messageText.trim(),
322	messageType: 'institutional_request',
323	cc: this.cc,
324	replyTo: this.replyTo,
325	institution: this.args.institution,
326	user: this.selectedUserId,
327	});
328
NEW UNCOV 329	await userMessage.save();	×
NEW UNCOV 330	this.toast.success(this.intl.t('institutions.dashboard.send_message_modal.message_sent_success'));	×
331	} catch (error) {
NEW UNCOV 332	this.toast.error(this.intl.t('institutions.dashboard.send_message_modal.message_sent_failed'));	×
333	} finally {
NEW UNCOV 334	this.messageModalShown = false;	×
335	}
336	}
337	}

CenterForOpenScience / ember-osf-web / 12303026020

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous