4786187378

Build Type

push

github

Committed by GitHub

Commit Message

chore(*): remove Ergo References from Concerto (#610) (#637)

Run Details

2847 of 2927 branches covered (97.27%)

Branch coverage included in aggregate %.

9 of 9 new or added lines in 3 files covered. (100.0%)

1 existing line in 1 file now uncovered.

5545 of 5571 relevant lines covered (99.53%)

8998.97 hits per line

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

98.8

/packages/concerto-core/lib/serializer/jsongenerator.js

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

'use strict';

const Resource = require('../model/resource');
const Typed = require('../model/typed');
const ModelUtil = require('../modelutil');
const Util = require('../util');

/**
 * Converts the contents of a Resource to JSON. The parameters
 * object should contain the keys
 * 'stack' - the TypedStack of objects being processed. It should
 * start with a Resource.
 * 'modelManager' - the ModelManager to use.
 * @private
 * @class
 * @memberof module:concerto-core
 */
class JSONGenerator {

    /**
     * Constructor.
     * @param {boolean} [convertResourcesToRelationships] Convert resources that
     * are specified for relationship fields into relationships, false by default.
     * @param {boolean} [permitResourcesForRelationships] Permit resources in the
     * place of relationships (serializing them as resources), false by default.
     * @param {boolean} [deduplicateResources] If resources appear several times
     * in the object graph only the first instance is serialized, with only the $id
     * written for subsequent instances, false by default.
     * @param {boolean} [convertResourcesToId] Convert resources that
     * @param {boolean} [ergo] - Deprecated - This is a dummy parameter to avoid breaking any consumers. It will be removed in a future release.
     * are specified for relationship fields into their id, false by default.
     * @param {number} [utcOffset] UTC Offset for DateTime values.
     */
    constructor(convertResourcesToRelationships, permitResourcesForRelationships, deduplicateResources, convertResourcesToId, ergo, utcOffset) {
        this.convertResourcesToRelationships = convertResourcesToRelationships;
        this.permitResourcesForRelationships = permitResourcesForRelationships;
        this.deduplicateResources = deduplicateResources;
        this.convertResourcesToId = convertResourcesToId;
        this.utcOffset = utcOffset || 0;
    }

    /**
     * Visitor design pattern
     * @param {Object} thing - the object being visited
     * @param {Object} parameters  - the parameter
     * @return {Object} the result of visiting or null
     * @private
     */
    visit(thing, parameters) {
        if (thing.isClassDeclaration?.()) {
            return this.visitClassDeclaration(thing, parameters);
        } else if (thing.isRelationship?.()) {
            return this.visitRelationshipDeclaration(thing, parameters);
        } else if (thing.isTypeScalar?.()) {
            return this.visitField(thing.getScalarField(), parameters);
        } else if (thing.isField?.()) {
            return this.visitField(thing, parameters);
        } else {
            throw new Error('Unrecognised ' + JSON.stringify(thing));
        }
    }

    /**
     * Visitor design pattern
     * @param {ClassDeclaration} classDeclaration - the object being visited
     * @param {Object} parameters  - the parameter
     * @return {Object} the result of visiting or null
     * @private
     */
    visitClassDeclaration(classDeclaration, parameters) {

        const obj = parameters.stack.pop();
        if (!((obj instanceof Resource))) {
            throw new Error('Expected a Resource, but found ' + obj);
        }

        let result = {};
        let id = null;

        if (obj.isIdentifiable() && this.deduplicateResources) {
            id = obj.toURI();
            if( parameters.dedupeResources.has(id)) {
                return id;
            }
            else {
                parameters.dedupeResources.add(id);
            }
        }

        result.$class = classDeclaration.getFullyQualifiedName();
        if(this.deduplicateResources && id) {
            result.$id = id;
        }

        // Walk each property of the class declaration
        const properties = classDeclaration.getProperties();
        for (let index in properties) {
            const property = properties[index];
            const value = obj[property.getName()];
            if (!Util.isNull(value)) {
                parameters.stack.push(value);
                result[property.getName()] = property.accept(this, parameters);
            }
        }

        return result;
    }

    /**
     * Visitor design pattern
     * @param {Field} field - the object being visited
     * @param {Object} parameters  - the parameter
     * @return {Object} the result of visiting or null
     * @private
     */
    visitField(field, parameters) {
        const obj = parameters.stack.pop();
        let result;
        if (field.isArray()) {
            let array = [];
            // Walk the object
            for (let index in obj) {
                const item = obj[index];
                if (!field.isPrimitive() && !ModelUtil.isEnum(field)) {
                    parameters.stack.push(item, Typed);
                    const classDeclaration = parameters.modelManager.getType(item.getFullyQualifiedType());
                    array.push(classDeclaration.accept(this, parameters));
                } else {
                    array.push(this.convertToJSON(field, item));
                }
            }
            result = array;
        } else if (field.isPrimitive()) {
            result = this.convertToJSON(field, obj);
        } else if (ModelUtil.isEnum(field)) {
            result = this.convertToJSON(field, obj);
        } else {
            parameters.stack.push(obj);
            const classDeclaration = parameters.modelManager.getType(obj.getFullyQualifiedType());
            result = classDeclaration.accept(this, parameters);
        }

        return result;
    }

    /**
     * Converts to JSON safe format.
     *
     * @param {Field} field - the field declaration of the object
     * @param {Object} obj - the object to convert to text
     * @return {Object} the text JSON safe representation
     */
    convertToJSON(field, obj) {
        switch (field.getType()) {
        case 'DateTime':
        {
            const objWithOffset = obj.utc().utcOffset(this.utcOffset);
            const inZ = objWithOffset.utcOffset() === 0;
            return objWithOffset.format(`YYYY-MM-DDTHH:mm:ss.SSS${inZ ? '[Z]': 'Z'}`);
        }
        case 'Integer':
        case 'Long': {
            return obj;
        }
        case 'Double':
        case 'Boolean':
        default:
        {
            return obj;
        }
        }
    }

    /**
     * Visitor design pattern
     * @param {RelationshipDeclaration} relationshipDeclaration - the object being visited
     * @param {Object} parameters  - the parameter
     * @return {Object} the result of visiting or null
     * @private
     */
    visitRelationshipDeclaration(relationshipDeclaration, parameters) {
        const obj = parameters.stack.pop();
        let result;

        if (relationshipDeclaration.isArray()) {
            let array = [];
            // walk the object
            for (let index in obj) {
                const item = obj[index];
                if (this.permitResourcesForRelationships && item instanceof Resource) {
                    let fqi = item.getFullyQualifiedIdentifier();
                    if (parameters.seenResources.has(fqi)) {
                        let relationshipText = this.getRelationshipText(relationshipDeclaration, item);
                        array.push(relationshipText);
                    } else {
                        parameters.seenResources.add(fqi);
                        parameters.stack.push(item, Resource);
                        const classDecl = parameters.modelManager.getType(relationshipDeclaration.getFullyQualifiedTypeName());
                        array.push(classDecl.accept(this, parameters));
                        parameters.seenResources.delete(fqi);
                    }
                } else {
                    let relationshipText = this.getRelationshipText(relationshipDeclaration, item);
                    array.push(relationshipText);
                }
            }
            result = array;
        } else if (this.permitResourcesForRelationships && obj instanceof Resource) {
            let fqi = obj.getFullyQualifiedIdentifier();
            if (parameters.seenResources.has(fqi)) {
                let relationshipText = this.getRelationshipText(relationshipDeclaration, obj);
                result = relationshipText;
            } else {
                parameters.seenResources.add(fqi);
                parameters.stack.push(obj, Resource);
                const classDecl = parameters.modelManager.getType(relationshipDeclaration.getFullyQualifiedTypeName());
                result = classDecl.accept(this, parameters);
                parameters.seenResources.delete(fqi);
            }
        } else {
            let relationshipText = this.getRelationshipText(relationshipDeclaration, obj);
            result = relationshipText;
        }
        return result;
    }

    /**
     * Returns the persistent format for a relationship.
     * @param {RelationshipDeclaration} relationshipDeclaration - the relationship being persisted
     * @param {Identifiable} relationshipOrResource - the relationship or the resource
     * @returns {string} the text to use to persist the relationship
     */
    getRelationshipText(relationshipDeclaration, relationshipOrResource) {
        if (relationshipOrResource instanceof Resource) {
            const allowRelationships =
                this.convertResourcesToRelationships || this.permitResourcesForRelationships;
            if (!allowRelationships) {
                throw new Error('Did not find a relationship for ' + relationshipDeclaration.getFullyQualifiedTypeName() + ' found ' + relationshipOrResource);
            }
        }
        if (this.convertResourcesToId) {
            return relationshipOrResource.getIdentifier();
        } else {
            return relationshipOrResource.toURI();
        }
    }
}

module.exports = JSONGenerator;

1	/*
2	* Licensed under the Apache License, Version 2.0 (the "License");
3	* you may not use this file except in compliance with the License.
4	* You may obtain a copy of the License at
5	*
6	* http://www.apache.org/licenses/LICENSE-2.0
7	*
8	* Unless required by applicable law or agreed to in writing, software
9	* distributed under the License is distributed on an "AS IS" BASIS,
10	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11	* See the License for the specific language governing permissions and
12	* limitations under the License.
13	*/
14
15	'use strict';
16
17	const Resource = require('../model/resource');	3✔
18	const Typed = require('../model/typed');	3✔
19	const ModelUtil = require('../modelutil');	3✔
20	const Util = require('../util');	3✔
21
22	/**
23	* Converts the contents of a Resource to JSON. The parameters
24	* object should contain the keys
25	* 'stack' - the TypedStack of objects being processed. It should
26	* start with a Resource.
27	* 'modelManager' - the ModelManager to use.
28	* @private
29	* @class
30	* @memberof module:concerto-core
31	*/
32	class JSONGenerator {
33
34	/**
35	* Constructor.
36	* @param {boolean} [convertResourcesToRelationships] Convert resources that
37	* are specified for relationship fields into relationships, false by default.
38	* @param {boolean} [permitResourcesForRelationships] Permit resources in the
39	* place of relationships (serializing them as resources), false by default.
40	* @param {boolean} [deduplicateResources] If resources appear several times
41	* in the object graph only the first instance is serialized, with only the $id
42	* written for subsequent instances, false by default.
43	* @param {boolean} [convertResourcesToId] Convert resources that
44	* @param {boolean} [ergo] - Deprecated - This is a dummy parameter to avoid breaking any consumers. It will be removed in a future release.
45	* are specified for relationship fields into their id, false by default.
46	* @param {number} [utcOffset] UTC Offset for DateTime values.
47	*/
48	constructor(convertResourcesToRelationships, permitResourcesForRelationships, deduplicateResources, convertResourcesToId, ergo, utcOffset) {
49	this.convertResourcesToRelationships = convertResourcesToRelationships;	399✔
50	this.permitResourcesForRelationships = permitResourcesForRelationships;	399✔
51	this.deduplicateResources = deduplicateResources;	399✔
52	this.convertResourcesToId = convertResourcesToId;	399✔
53	this.utcOffset = utcOffset \|\| 0;	399✔
54	}
55
56	/**
57	* Visitor design pattern
58	* @param {Object} thing - the object being visited
59	* @param {Object} parameters - the parameter
60	* @return {Object} the result of visiting or null
61	* @private
62	*/
63	visit(thing, parameters) {
64	if (thing.isClassDeclaration?.()) {	5,463✔
65	return this.visitClassDeclaration(thing, parameters);	1,437✔
66	} else if (thing.isRelationship?.()) {	4,026✔
67	return this.visitRelationshipDeclaration(thing, parameters);	129✔
68	} else if (thing.isTypeScalar?.()) {	3,897✔
69	return this.visitField(thing.getScalarField(), parameters);	6✔
70	} else if (thing.isField?.()) {	3,891✔
71	return this.visitField(thing, parameters);	3,888✔
72	} else {
73	throw new Error('Unrecognised ' + JSON.stringify(thing));	3✔
74	}
75	}
76
77	/**
78	* Visitor design pattern
79	* @param {ClassDeclaration} classDeclaration - the object being visited
80	* @param {Object} parameters - the parameter
81	* @return {Object} the result of visiting or null
82	* @private
83	*/
84	visitClassDeclaration(classDeclaration, parameters) {
85
86	const obj = parameters.stack.pop();	1,440✔
87	if (!((obj instanceof Resource))) {	1,440✔
88	throw new Error('Expected a Resource, but found ' + obj);	3✔
89	}
90
91	let result = {};	1,437✔
92	let id = null;	1,437✔
93
94	if (obj.isIdentifiable() && this.deduplicateResources) {	1,437✔
95	id = obj.toURI();	21✔
96	if( parameters.dedupeResources.has(id)) {	21✔
97	return id;	6✔
98	}
99	else {
100	parameters.dedupeResources.add(id);	15✔
101	}
102	}
103
104	result.$class = classDeclaration.getFullyQualifiedName();	1,431✔
105	if(this.deduplicateResources && id) {	1,431✔
106	result.$id = id;	15✔
107	}
108
109	// Walk each property of the class declaration
110	const properties = classDeclaration.getProperties();	1,431✔
111	for (let index in properties) {	1,431✔
112	const property = properties[index];	4,941✔
113	const value = obj[property.getName()];	4,941✔
114	if (!Util.isNull(value)) {	4,941✔
115	parameters.stack.push(value);	4,023✔
116	result[property.getName()] = property.accept(this, parameters);	4,023✔
117	}
118	}
119
120	return result;	1,431✔
121	}
122
123	/**
124	* Visitor design pattern
125	* @param {Field} field - the object being visited
126	* @param {Object} parameters - the parameter
127	* @return {Object} the result of visiting or null
128	* @private
129	*/
130	visitField(field, parameters) {
131	const obj = parameters.stack.pop();	3,933✔
132	let result;
133	if (field.isArray()) {	3,933✔
134	let array = [];	204✔
135	// Walk the object
136	for (let index in obj) {	204✔
137	const item = obj[index];	354✔
138	if (!field.isPrimitive() && !ModelUtil.isEnum(field)) {	354✔
139	parameters.stack.push(item, Typed);	255✔
140	const classDeclaration = parameters.modelManager.getType(item.getFullyQualifiedType());	255✔
141	array.push(classDeclaration.accept(this, parameters));	255✔
142	} else {
143	array.push(this.convertToJSON(field, item));	99✔
144	}
145	}
146	result = array;	204✔
147	} else if (field.isPrimitive()) {	3,729✔
148	result = this.convertToJSON(field, obj);	2,850✔
149	} else if (ModelUtil.isEnum(field)) {	879✔
150	result = this.convertToJSON(field, obj);	54✔
151	} else {
152	parameters.stack.push(obj);	825✔
153	const classDeclaration = parameters.modelManager.getType(obj.getFullyQualifiedType());	825✔
154	result = classDeclaration.accept(this, parameters);	825✔
155	}
156
157	return result;	3,933✔
158	}
159
160	/**
161	* Converts to JSON safe format.
162	*
163	* @param {Field} field - the field declaration of the object
164	* @param {Object} obj - the object to convert to text
165	* @return {Object} the text JSON safe representation
166	*/
167	convertToJSON(field, obj) {
168	switch (field.getType()) {	3,033✔
169	case 'DateTime':
170	{
171	const objWithOffset = obj.utc().utcOffset(this.utcOffset);	219✔
172	const inZ = objWithOffset.utcOffset() === 0;	219✔
173	return objWithOffset.format(`YYYY-MM-DDTHH:mm:ss.SSS${inZ ? '[Z]': 'Z'}`);	219✔
174	}
175	case 'Integer':
176	case 'Long': {
177	return obj;	1,404✔
178	}
179	case 'Double':
180	case 'Boolean':
181	default:
182	{
183	return obj;	1,410✔
184	}
185	}
186	}
187
188	/**
189	* Visitor design pattern
190	* @param {RelationshipDeclaration} relationshipDeclaration - the object being visited
191	* @param {Object} parameters - the parameter
192	* @return {Object} the result of visiting or null
193	* @private
194	*/
195	visitRelationshipDeclaration(relationshipDeclaration, parameters) {
196	const obj = parameters.stack.pop();	153✔
197	let result;
198
199	if (relationshipDeclaration.isArray()) {	153✔
200	let array = [];	66✔
201	// walk the object
202	for (let index in obj) {	66✔
203	const item = obj[index];	132✔
204	if (this.permitResourcesForRelationships && item instanceof Resource) {	132✔
205	let fqi = item.getFullyQualifiedIdentifier();	105✔
206	if (parameters.seenResources.has(fqi)) {	105✔
207	let relationshipText = this.getRelationshipText(relationshipDeclaration, item);	54✔
208	array.push(relationshipText);	54✔
209	} else {
210	parameters.seenResources.add(fqi);	51✔
211	parameters.stack.push(item, Resource);	51✔
212	const classDecl = parameters.modelManager.getType(relationshipDeclaration.getFullyQualifiedTypeName());	51✔
213	array.push(classDecl.accept(this, parameters));	51✔
214	parameters.seenResources.delete(fqi);	51✔
215	}
216	} else {
217	let relationshipText = this.getRelationshipText(relationshipDeclaration, item);	27✔
218	array.push(relationshipText);	24✔
219	}
220	}
221	result = array;	63✔
222	} else if (this.permitResourcesForRelationships && obj instanceof Resource) {	87✔
223	let fqi = obj.getFullyQualifiedIdentifier();	33✔
224	if (parameters.seenResources.has(fqi)) {	33✔
225	let relationshipText = this.getRelationshipText(relationshipDeclaration, obj);	6✔
226	result = relationshipText;	6✔
227	} else {
228	parameters.seenResources.add(fqi);	27✔
229	parameters.stack.push(obj, Resource);	27✔
230	const classDecl = parameters.modelManager.getType(relationshipDeclaration.getFullyQualifiedTypeName());	27✔
231	result = classDecl.accept(this, parameters);	27✔
232	parameters.seenResources.delete(fqi);	27✔
233	}
234	} else {
235	let relationshipText = this.getRelationshipText(relationshipDeclaration, obj);	54✔
236	result = relationshipText;	51✔
237	}
238	return result;	147✔
239	}
240
241	/**
242	* Returns the persistent format for a relationship.
243	* @param {RelationshipDeclaration} relationshipDeclaration - the relationship being persisted
244	* @param {Identifiable} relationshipOrResource - the relationship or the resource
245	* @returns {string} the text to use to persist the relationship
246	*/
247	getRelationshipText(relationshipDeclaration, relationshipOrResource) {
248	if (relationshipOrResource instanceof Resource) {	153✔
249	const allowRelationships =
250	this.convertResourcesToRelationships \|\| this.permitResourcesForRelationships;	72✔
251	if (!allowRelationships) {	72✔
252	throw new Error('Did not find a relationship for ' + relationshipDeclaration.getFullyQualifiedTypeName() + ' found ' + relationshipOrResource);	9✔
253	}
254	}
255	if (this.convertResourcesToId) {	144!
UNCOV 256	return relationshipOrResource.getIdentifier();	×
257	} else {
258	return relationshipOrResource.toURI();	144✔
259	}
260	}
261	}
262
263	module.exports = JSONGenerator;	3✔

accordproject / concerto / 4786187378

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