13504987529

Committed 24 Feb 2025 05:51PM UTC coverage: 66.825% (-1.2%) from 68.015%

Build # 13504987529

Build Type

push

github

Committed by

adlius

Commit Message

Merge branch 'release/25.04.0'

Run Details

3107 of 5068 branches covered (61.31%)

Branch coverage included in aggregate %.

452 of 809 new or added lines in 38 files covered. (55.87%)

9 existing lines in 3 files now uncovered.

7897 of 11399 relevant lines covered (69.28%)

189.72 hits per line

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

81.44

/lib/osf-components/addon/components/node-metadata-manager/component.ts

import Store from '@ember-data/store';
import { assert } from '@ember/debug';
import { action, notifyPropertyChange } from '@ember/object';
import { alias, or } from '@ember/object/computed';
import { inject as service } from '@ember/service';
import { waitFor } from '@ember/test-waiters';
import Component from '@glimmer/component';
import Intl from 'ember-intl/services/intl';
import Toast from 'ember-toastr/services/toast';
import { BufferedChangeset } from 'ember-changeset/types';
import { restartableTask, task } from 'ember-concurrency';
import { taskFor } from 'ember-concurrency-ts';

import NodeModel from 'ember-osf-web/models/node';
import CustomItemMetadataRecordModel from 'ember-osf-web/models/custom-item-metadata-record';
import { resourceTypeGeneralOptions } from 'ember-osf-web/models/custom-metadata';
import { Permission } from 'ember-osf-web/models/osf-model';
import captureException, { getApiErrorMessage } from 'ember-osf-web/utils/capture-exception';
import { languageCodes, LanguageCode } from 'ember-osf-web/utils/languages';
import buildChangeset from 'ember-osf-web/utils/build-changeset';
import { tracked } from '@glimmer/tracking';

import { languageFromLanguageCode } from 'osf-components/components/file-metadata-manager/component';
import InstitutionModel from 'ember-osf-web/models/institution';
import LicenseModel from 'ember-osf-web/models/license';
import IdentifierModel from 'ember-osf-web/models/identifier';
import CurrentUser from 'ember-osf-web/services/current-user';
import UserModel from 'ember-osf-web/models/user';

interface Args {
    node: (NodeModel);
}

export interface NodeMetadataManager {
    editDescription: () => void;
    editFunding: () => void;
    editInstitutions: () => void;
    editResources: () => void;
    saveMetadata: () => void;
    saveNode: () => void;
    saveInstitutions: () => void;
    cancelMetadata: () => void;
    cancelNode: () => void;
    cancelInstitutions: () => void;
    toggleInstitution: () => void;
    metadata: CustomItemMetadataRecordModel;
    node: (NodeModel);
    changeset: BufferedChangeset;
    inEditMode: boolean;
    isSaving: boolean;
    userCanEdit: boolean;
    isDirty: boolean;
    isGatheringData: boolean;
    license: LicenseModel;
    identifiers: IdentifierModel[];
    isEditingInstitutions: boolean;
    isSavingInstitutions: boolean;
    affiliatedList: InstitutionModel[];
    user: UserModel;
}

export default class NodeMetadataManagerComponent extends Component<Args> {
    @service store!: Store;
    @service intl!: Intl;
    @service toast!: Toast;
    @service currentUser!: CurrentUser;

    @tracked metadata!: CustomItemMetadataRecordModel;
    node: (NodeModel) = this.args.node;
    @tracked changeset!: BufferedChangeset;
    @tracked nodeChangeset!: BufferedChangeset;
    @or(
        'isEditingDescription',
        'isEditingFunding',
        'isEditingResources',
        'isEditingInstitutions',
    ) inEditMode!: boolean;
    @tracked isEditingDescription = false;
    @tracked isEditingFunding = false;
    @tracked isEditingResources = false;
    @tracked isEditingInstitutions = false;
    @tracked userCanEdit!: boolean;
    @or(
        'getGuidMetadata.isRunning',
        'cancelMetadata.isRunning',
        'cancelNode.isRunning',
    ) isGatheringData!: boolean;
    @or('saveNode.isRunning', 'saveMetadata.isRunning', 'saveInstitutions.isRunning') isSaving!: boolean;
    @alias('changeset.isDirty') isDirty!: boolean;
    @alias('node.id') nodeId!: string;
    @tracked license!: LicenseModel;
    @tracked identifiers!: IdentifierModel[];
    @tracked guidType!: string | undefined;
    @tracked affiliatedList!: InstitutionModel[];
    @tracked currentAffiliatedList!: InstitutionModel[];
    resourceTypeGeneralOptions: string[] = resourceTypeGeneralOptions;
    languageCodes: LanguageCode[] = languageCodes;
    saveErrored = false;
    saveNodeErrored = false;

    constructor(owner: unknown, args: Args) {
        super(owner, args);
        assert(
            'You will need pass in a node or registration object to the NodeMetadataManager component to get metadata',
            Boolean(args.node),
        );
        try {
            taskFor(this.getGuidMetadata).perform();
            this.userCanEdit = this.node.currentUserPermissions.includes(Permission.Write);
        } catch (e) {
            const errorTitle = this.intl.t('osf-components.item-metadata-manager.error-getting-metadata');
            this.toast.error(getApiErrorMessage(e), errorTitle);
        }
    }

    @task
    @waitFor
    async getGuidMetadata() {
        if (this.node) {
            const guidRecord = await this.store.findRecord('guid', this.node.id, {
                include: 'custom_metadata',
                resolve: false,
            });
            this.guidType = guidRecord.referentType;
            this.metadata = await guidRecord.customMetadata as CustomItemMetadataRecordModel;
            notifyPropertyChange(this, 'metadata');
            const node = this.node as NodeModel;
            this.affiliatedList = await node.queryHasMany(
                'affiliatedInstitutions', {
                    pageSize: 100,
                },
            );
            this.currentAffiliatedList = [...this.affiliatedList];
            this.license = await node.license;
            this.identifiers = await node.queryHasMany('identifiers');
            this.changeset = buildChangeset(this.metadata, null);
            this.changeset.languageObject = {
                code: this.metadata.language,
                name: this.languageFromCode,
            };
            this.changeset.execute();
            this.nodeChangeset = buildChangeset(this.node, null);
        }
    }

    get languageFromCode(){
        const languageCode = this.metadata?.language || '';
        return languageFromLanguageCode(languageCode);
    }

    @action
    editDescription(){
        this.isEditingDescription = true;
    }

    @action
    editResources(){
        this.isEditingResources = true;
    }

    @action
    editFunding(){
        this.isEditingFunding = true;
    }

    @action
    editInstitutions(){
        this.isEditingInstitutions = true;
    }

    @action
    toggleInstitution(institution: InstitutionModel) {
        if (this.currentAffiliatedList.includes(institution)) {
            this.currentAffiliatedList.removeObject(institution);
        } else {
            this.currentAffiliatedList.pushObject(institution);
        }
    }

    @task
    @waitFor
    async cancelMetadata(){
        if (this.saveErrored) {
            await this.metadata.reload();
            this.metadata.rollbackAttributes();
            this.saveErrored = false;
        }
        this.changeset.rollback();
        this.changeset.languageObject = {
            code: this.metadata.language,
            name: this.languageFromCode,
        };
        this.changeset.execute();
        this.isEditingFunding = false;
        this.isEditingResources = false;
    }

    @task
    @waitFor
    async cancelNode(){
        if (this.saveNodeErrored){
            await this.node.reload();
            this.saveNodeErrored = false;
        }
        this.nodeChangeset.rollback();
        this.isEditingDescription = false;
    }

    @action
    cancelInstitutions(){
        this.currentAffiliatedList = [...this.affiliatedList];
        this.isEditingInstitutions = false;
    }

    @action
    changeLanguage(selected: LanguageCode) {
        const language = selected ? selected.code : '';
        this.changeset.set('language', language);
    }

    @restartableTask
    @waitFor
    async saveMetadata(){
        try {
            await this.changeset.save();
            this.isEditingFunding = false;
            this.isEditingResources = false;
            this.saveErrored = false;
        } catch (e) {
            this.saveErrored = true;
            if (e.errors[0].source.pointer === '/data/attributes/funders/award_uri') {
                this.toast.error(this.intl.t('osf-components.funding-metadata.api_uri_validation_error'));
            } else {
                const errorTitle = this.intl.t('osf-components.item-metadata-manager.error-saving-metadata');
                this.toast.error(getApiErrorMessage(e), errorTitle);
            }
        }
    }

    @restartableTask
    @waitFor
    async saveNode(){
        try {
            await this.nodeChangeset.save();
            this.isEditingDescription = false;
            this.saveNodeErrored = false;
        } catch (e) {
            this.saveNodeErrored = true;
            const errorTitle = this.intl.t('osf-components.item-metadata-manager.error-saving-metadata');
            this.toast.error(getApiErrorMessage(e), errorTitle);
        }
    }

    @restartableTask
    @waitFor
    async saveInstitutions() {
        try {
            await this.node.updateM2MRelationship('affiliatedInstitutions', this.currentAffiliatedList);
            await this.node.reload();
            this.affiliatedList = [...this.currentAffiliatedList];
            this.isEditingInstitutions = false;
        } catch (e) {
            const errorMessage = this.intl.t('registries.drafts.draft.metadata.save_institutions_error');
            captureException(e, { errorMessage });
            this.toast.error(getApiErrorMessage(e), errorMessage);
            throw e;
        }
    }
}

1	import Store from '@ember-data/store';
2	import { assert } from '@ember/debug';
3	import { action, notifyPropertyChange } from '@ember/object';
4	import { alias, or } from '@ember/object/computed';
5	import { inject as service } from '@ember/service';
6	import { waitFor } from '@ember/test-waiters';
7	import Component from '@glimmer/component';
8	import Intl from 'ember-intl/services/intl';
9	import Toast from 'ember-toastr/services/toast';
10	import { BufferedChangeset } from 'ember-changeset/types';
11	import { restartableTask, task } from 'ember-concurrency';
12	import { taskFor } from 'ember-concurrency-ts';
13
14	import NodeModel from 'ember-osf-web/models/node';
15	import CustomItemMetadataRecordModel from 'ember-osf-web/models/custom-item-metadata-record';
16	import { resourceTypeGeneralOptions } from 'ember-osf-web/models/custom-metadata';
17	import { Permission } from 'ember-osf-web/models/osf-model';
18	import captureException, { getApiErrorMessage } from 'ember-osf-web/utils/capture-exception';
19	import { languageCodes, LanguageCode } from 'ember-osf-web/utils/languages';
20	import buildChangeset from 'ember-osf-web/utils/build-changeset';
21	import { tracked } from '@glimmer/tracking';
22
23	import { languageFromLanguageCode } from 'osf-components/components/file-metadata-manager/component';
24	import InstitutionModel from 'ember-osf-web/models/institution';
25	import LicenseModel from 'ember-osf-web/models/license';
26	import IdentifierModel from 'ember-osf-web/models/identifier';
27	import CurrentUser from 'ember-osf-web/services/current-user';
28	import UserModel from 'ember-osf-web/models/user';
29
30	interface Args {
31	node: (NodeModel);
32	}
33
34	export interface NodeMetadataManager {
35	editDescription: () => void;
36	editFunding: () => void;
37	editInstitutions: () => void;
38	editResources: () => void;
39	saveMetadata: () => void;
40	saveNode: () => void;
41	saveInstitutions: () => void;
42	cancelMetadata: () => void;
43	cancelNode: () => void;
44	cancelInstitutions: () => void;
45	toggleInstitution: () => void;
46	metadata: CustomItemMetadataRecordModel;
47	node: (NodeModel);
48	changeset: BufferedChangeset;
49	inEditMode: boolean;
50	isSaving: boolean;
51	userCanEdit: boolean;
52	isDirty: boolean;
53	isGatheringData: boolean;
54	license: LicenseModel;
55	identifiers: IdentifierModel[];
56	isEditingInstitutions: boolean;
57	isSavingInstitutions: boolean;
58	affiliatedList: InstitutionModel[];
59	user: UserModel;
60	}
61
62	export default class NodeMetadataManagerComponent extends Component<Args> {
63	@service store!: Store;
64	@service intl!: Intl;
65	@service toast!: Toast;
66	@service currentUser!: CurrentUser;
67
68	@tracked metadata!: CustomItemMetadataRecordModel;
69	node: (NodeModel) = this.args.node;	8✔
70	@tracked changeset!: BufferedChangeset;
71	@tracked nodeChangeset!: BufferedChangeset;
72	@or(
73	'isEditingDescription',
74	'isEditingFunding',
75	'isEditingResources',
76	'isEditingInstitutions',
77	) inEditMode!: boolean;
78	@tracked isEditingDescription = false;	8✔
79	@tracked isEditingFunding = false;	7✔
80	@tracked isEditingResources = false;	8✔
81	@tracked isEditingInstitutions = false;	7✔
82	@tracked userCanEdit!: boolean;
83	@or(
84	'getGuidMetadata.isRunning',
85	'cancelMetadata.isRunning',
86	'cancelNode.isRunning',
87	) isGatheringData!: boolean;
88	@or('saveNode.isRunning', 'saveMetadata.isRunning', 'saveInstitutions.isRunning') isSaving!: boolean;
89	@alias('changeset.isDirty') isDirty!: boolean;
90	@alias('node.id') nodeId!: string;
91	@tracked license!: LicenseModel;
92	@tracked identifiers!: IdentifierModel[];
93	@tracked guidType!: string \| undefined;
94	@tracked affiliatedList!: InstitutionModel[];
95	@tracked currentAffiliatedList!: InstitutionModel[];
96	resourceTypeGeneralOptions: string[] = resourceTypeGeneralOptions;	8✔
97	languageCodes: LanguageCode[] = languageCodes;	8✔
98	saveErrored = false;	8✔
99	saveNodeErrored = false;	8✔
100
101	constructor(owner: unknown, args: Args) {
102	super(owner, args);	8✔
103	assert(	8✔
104	'You will need pass in a node or registration object to the NodeMetadataManager component to get metadata',
105	Boolean(args.node),
106	);
107	try {	8✔
108	taskFor(this.getGuidMetadata).perform();	8✔
109	this.userCanEdit = this.node.currentUserPermissions.includes(Permission.Write);	8✔
110	} catch (e) {
111	const errorTitle = this.intl.t('osf-components.item-metadata-manager.error-getting-metadata');	×
112	this.toast.error(getApiErrorMessage(e), errorTitle);	×
113	}
114	}
115
116	@task
117	@waitFor
118	async getGuidMetadata() {
119	if (this.node) {	8!
120	const guidRecord = await this.store.findRecord('guid', this.node.id, {	8✔
121	include: 'custom_metadata',
122	resolve: false,
123	});
124	this.guidType = guidRecord.referentType;	8✔
125	this.metadata = await guidRecord.customMetadata as CustomItemMetadataRecordModel;	8✔
126	notifyPropertyChange(this, 'metadata');	8✔
127	const node = this.node as NodeModel;	8✔
128	this.affiliatedList = await node.queryHasMany(	8✔
129	'affiliatedInstitutions', {
130	pageSize: 100,
131	},
132	);
133	this.currentAffiliatedList = [...this.affiliatedList];	8✔
134	this.license = await node.license;	8✔
135	this.identifiers = await node.queryHasMany('identifiers');	8✔
136	this.changeset = buildChangeset(this.metadata, null);	8✔
137	this.changeset.languageObject = {	8✔
138	code: this.metadata.language,
139	name: this.languageFromCode,
140	};
141	this.changeset.execute();	8✔
142	this.nodeChangeset = buildChangeset(this.node, null);	8✔
143	}
144	}
145
146	get languageFromCode(){
147	const languageCode = this.metadata?.language \|\| '';	19!
148	return languageFromLanguageCode(languageCode);	19✔
149	}
150
151	@action
152	editDescription(){
153	this.isEditingDescription = true;	3✔
154	}
155
156	@action
157	editResources(){
158	this.isEditingResources = true;	2✔
159	}
160
161	@action
162	editFunding(){
163	this.isEditingFunding = true;	1✔
164	}
165
166	@action
167	editInstitutions(){
168	this.isEditingInstitutions = true;	3✔
169	}
170
171	@action
172	toggleInstitution(institution: InstitutionModel) {
173	if (this.currentAffiliatedList.includes(institution)) {	2!
174	this.currentAffiliatedList.removeObject(institution);	×
175	} else {
176	this.currentAffiliatedList.pushObject(institution);	2✔
177	}
178	}
179
180	@task
181	@waitFor
182	async cancelMetadata(){
183	if (this.saveErrored) {	2!
UNCOV 184	await this.metadata.reload();	×
UNCOV 185	this.metadata.rollbackAttributes();	×
UNCOV 186	this.saveErrored = false;	×
187	}
188	this.changeset.rollback();	2✔
189	this.changeset.languageObject = {	2✔
190	code: this.metadata.language,
191	name: this.languageFromCode,
192	};
193	this.changeset.execute();	2✔
194	this.isEditingFunding = false;	2✔
195	this.isEditingResources = false;	2✔
196	}
197
198	@task
199	@waitFor
200	async cancelNode(){
201	if (this.saveNodeErrored){	2✔
202	await this.node.reload();	1✔
203	this.saveNodeErrored = false;	1✔
204	}
205	this.nodeChangeset.rollback();	2✔
206	this.isEditingDescription = false;	2✔
207	}
208
209	@action
210	cancelInstitutions(){
211	this.currentAffiliatedList = [...this.affiliatedList];	2✔
212	this.isEditingInstitutions = false;	2✔
213	}
214
215	@action
216	changeLanguage(selected: LanguageCode) {
217	const language = selected ? selected.code : '';	2!
218	this.changeset.set('language', language);	2✔
219	}
220
221	@restartableTask
222	@waitFor
223	async saveMetadata(){
224	try {	1✔
225	await this.changeset.save();	1✔
226	this.isEditingFunding = false;	1✔
227	this.isEditingResources = false;	1✔
228	this.saveErrored = false;	1✔
229	} catch (e) {
UNCOV 230	this.saveErrored = true;	×
UNCOV 231	if (e.errors[0].source.pointer === '/data/attributes/funders/award_uri') {	×
232	this.toast.error(this.intl.t('osf-components.funding-metadata.api_uri_validation_error'));	×
233	} else {
UNCOV 234	const errorTitle = this.intl.t('osf-components.item-metadata-manager.error-saving-metadata');	×
UNCOV 235	this.toast.error(getApiErrorMessage(e), errorTitle);	×
236	}
237	}
238	}
239
240	@restartableTask
241	@waitFor
242	async saveNode(){
243	try {	2✔
244	await this.nodeChangeset.save();	2✔
245	this.isEditingDescription = false;	1✔
246	this.saveNodeErrored = false;	1✔
247	} catch (e) {
248	this.saveNodeErrored = true;	1✔
249	const errorTitle = this.intl.t('osf-components.item-metadata-manager.error-saving-metadata');	1✔
250	this.toast.error(getApiErrorMessage(e), errorTitle);	1✔
251	}
252	}
253
254	@restartableTask
255	@waitFor
256	async saveInstitutions() {
257	try {	2✔
258	await this.node.updateM2MRelationship('affiliatedInstitutions', this.currentAffiliatedList);	2✔
259	await this.node.reload();	1✔
260	this.affiliatedList = [...this.currentAffiliatedList];	1✔
261	this.isEditingInstitutions = false;	1✔
262	} catch (e) {
263	const errorMessage = this.intl.t('registries.drafts.draft.metadata.save_institutions_error');	1✔
264	captureException(e, { errorMessage });	1✔
265	this.toast.error(getApiErrorMessage(e), errorMessage);	1✔
266	throw e;	1✔
267	}
268	}
269	}

CenterForOpenScience / ember-osf-web / 13504987529

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