fix(core): assign unique ID to elements only when missing (#3841)

Refs #3840
swagger-api · Feb 21, 2024 · 89af0a9 · 89af0a9
1 parent 83c085e
commit 89af0a9
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 8 deletions.
diff --git a/packages/apidom-core/src/identity/index.ts b/packages/apidom-core/src/identity/index.ts
@@ -41,8 +41,8 @@ export const IdentityManager: stampit.Stamp<IdentityManager> = stampit({
       // use already assigned identity
       if (
         element.meta.hasKey('id') &&
-        isStringElement(element.meta.id) &&
-        !element.meta.id.equals('')
+        isStringElement(element.meta.get('id')) &&
+        !element.meta.get('id').equals('')
       ) {
         return element.id;
       }

diff --git a/packages/apidom-core/src/refractor/plugins/element-identity.ts b/packages/apidom-core/src/refractor/plugins/element-identity.ts
@@ -1,4 +1,4 @@
-import { Element, StringElement } from 'minim';
+import { Element } from 'minim';
 
 import { IdentityManager } from '../../identity';
 
@@ -17,7 +17,7 @@ const plugin =
       },
       visitor: {
         enter<T extends Element>(element: T) {
-          element.id = new StringElement(identityManager!.generateId()); // eslint-disable-line no-param-reassign
+          element.id = identityManager!.identify(element); // eslint-disable-line no-param-reassign
         },
       },
       post() {

diff --git a/packages/apidom-core/src/refractor/plugins/semantic-element-identity.ts b/packages/apidom-core/src/refractor/plugins/semantic-element-identity.ts
@@ -1,4 +1,4 @@
-import { Element, StringElement } from 'minim';
+import { Element } from 'minim';
 
 import { IdentityManager } from '../../identity';
 import { isPrimitiveElement } from '../../predicates';
@@ -23,7 +23,7 @@ const plugin =
       visitor: {
         enter<T extends Element>(element: T) {
           if (!predicates.isPrimitiveElement(element)) {
-            (element as Element).id = new StringElement(identityManager!.generateId()); // eslint-disable-line no-param-reassign
+            (element as Element).id = identityManager!.identify(element); // eslint-disable-line no-param-reassign
           }
         },
       },

diff --git a/packages/apidom-core/test/refractor/plugins/element-identity.ts b/packages/apidom-core/test/refractor/plugins/element-identity.ts
@@ -1,6 +1,11 @@
 import { assert } from 'chai';
 
-import { ObjectElement, refractorPluginElementIdentity } from '../../../src';
+import {
+  ObjectElement,
+  StringElement,
+  refractorPluginElementIdentity,
+  dispatchRefractorPlugins,
+} from '../../../src';
 
 describe('refractor', function () {
   context('plugins', function () {
@@ -31,6 +36,16 @@ describe('refractor', function () {
           assert.lengthOf(objectElement.getMember('a').value.id, length);
         },
       );
+
+      specify('should not add unique ID when already present', function () {
+        const objectElement = new ObjectElement({ id: '123' });
+        objectElement.id = new StringElement('unique-id');
+        const newObjectElement = dispatchRefractorPlugins(objectElement, [
+          refractorPluginElementIdentity(),
+        ]);
+
+        assert.isTrue(newObjectElement.id.equals('unique-id'));
+      });
     });
   });
 });
diff --git a/packages/apidom-core/test/refractor/plugins/semantic-element-identity.ts b/packages/apidom-core/test/refractor/plugins/semantic-element-identity.ts
@@ -1,7 +1,12 @@
 import { assert } from 'chai';
 import { InfoElement } from '@swagger-api/apidom-ns-openapi-3-1';
 
-import { ObjectElement, refractorPluginSemanticElementIdentity } from '../../../src';
+import {
+  ObjectElement,
+  StringElement,
+  dispatchRefractorPlugins,
+  refractorPluginSemanticElementIdentity,
+} from '../../../src';
 
 describe('refractor', function () {
   context('plugins', function () {
@@ -57,6 +62,20 @@ describe('refractor', function () {
           assert.lengthOf(objectElement.getMember('info').value.get('contact').id, length);
         },
       );
+
+      specify('should not add unique ID when already present', function () {
+        const infoElement = InfoElement.refract({
+          title: 'title',
+          summary: 'summary',
+          contact: { name: 'John Doe' },
+        });
+        infoElement.id = new StringElement('unique-id');
+        const newInfoElement = dispatchRefractorPlugins(infoElement, [
+          refractorPluginSemanticElementIdentity(),
+        ]);
+
+        assert.isTrue(newInfoElement.id.equals('unique-id'));
+      });
     });
   });
 });