Fix collector class singleton pattern

Author: yelizhenden-mdb

tools/spectral/ipa/__tests__/metrics/collector.test.js

@@ -0,0 +1,60 @@
+import { beforeEach, describe, expect, it } from '@jest/globals';
+import collector, { EntryType } from '../../metrics/collector';
+import * as fs from 'node:fs';
+
+jest.mock('node:fs');
+
+describe('Collector Class', () => {
+  const expectedOutput = {
+    violations: [
+      { componentId: 'example.component', ruleName: 'rule-1' },
+      { componentId: 'example.component', ruleName: 'rule-2' },
+    ],
+    adoptions: [
+      { componentId: 'example.component', ruleName: 'rule-3' },
+    ],
+    exceptions: [
+      { componentId: 'example.component', ruleName: 'rule-4' },
+    ],
+  };
+
+  beforeEach(() => {
+    collector.entries = {
+      [EntryType.VIOLATION]: [],
+      [EntryType.ADOPTION]: [],
+      [EntryType.EXCEPTION]: [],
+    };
+
+    jest.clearAllMocks();
+  });
+
+  it('should collect violations, adoptions, and exceptions correctly', () => {
+    collector.add(['example', 'component'], 'rule-1', EntryType.VIOLATION);
+    collector.add(['example', 'component'], 'rule-2', EntryType.VIOLATION);
+    collector.add(['example', 'component'], 'rule-3', EntryType.ADOPTION);
+    collector.add(['example', 'component'], 'rule-4', EntryType.EXCEPTION);
+
+    expect(collector.entries).toEqual(expectedOutput);
+
+    collector.flushToFile();
+    const writtenData = JSON.stringify(expectedOutput, null, 2);
+    expect(fs.writeFileSync).toHaveBeenCalledWith(
+      'combined.log',
+      writtenData
+    );
+  });
+
+  it('should not add invalid entries', () => {
+    collector.add(null, 'rule-1', EntryType.VIOLATION);
+    collector.add(['example', 'component'], null, EntryType.ADOPTION);
+    collector.add(['example', 'component'], 'rule-4', null);
+
+    expect(collector.entries).toEqual({
+      violations: [],
+      adoptions: [],
+      exceptions: [],
+    });
+
+    expect(fs.writeFileSync).not.toHaveBeenCalled();
+  });
+});

tools/spectral/ipa/metrics/Collector.js renamed to tools/spectral/ipa/metrics/collector.js

@@ -7,31 +7,33 @@ export const EntryType = Object.freeze({
 });
 
 class Collector {
-  static instance;
+  static instance = null;
+
+  static getInstance() {
+    if (!this.instance) {
+      this.instance = new Collector();
+    }
+    return this.instance;
+  }
 
   constructor() {
     if (Collector.instance) {
-      return Collector.instance;
+      throw new Error('Use Collector.getInstance()');
     }
 
     this.entries = {
       [EntryType.VIOLATION]: [],
       [EntryType.ADOPTION]: [],
       [EntryType.EXCEPTION]: [],
     };
-    this.fileName = "combined.log"
-    //this.exceptionFileName = 'exceptions.log';
-    //this.violationFileName = 'violations.log';
-    //this.adoptionFileName = 'adoptions.log';
 
+    this.fileName = "combined.log"
 
     process.on('exit', () => this.flushToFile());
     process.on('SIGINT', () => {
       this.flushToFile();
-      process.exit(); // Ensure process exits on Ctrl+C
+      process.exit();
     });
-
-    Collector.instance = this;
   }
 
   add(componentId, ruleName, type) {
@@ -52,5 +54,5 @@ class Collector {
   }
 }
 
-const collector = new Collector();
+const collector = Collector.getInstance();
 export default collector;

tools/spectral/ipa/rulesets/functions/eachCustomMethodMustBeGetOrPost.js

@@ -1,6 +1,6 @@
 import { isCustomMethod } from './utils/resourceEvaluation.js';
 import { hasException } from './utils/exceptions.js';
-import collector, { EntryType } from '../../metrics/Collector.js';
+import collector, { EntryType } from '../../metrics/collector.js';
 
 const RULE_NAME = 'xgen-IPA-109-custom-method-must-be-GET-or-POST';
 const ERROR_MESSAGE = 'The HTTP method for custom methods must be GET or POST.';

tools/spectral/ipa/rulesets/functions/eachCustomMethodMustUseCamelCase.js

@@ -1,7 +1,7 @@
 import { getCustomMethodName, isCustomMethod } from './utils/resourceEvaluation.js';
 import { hasException } from './utils/exceptions.js';
 import { casing } from '@stoplight/spectral-functions';
-import collector, { EntryType } from '../../metrics/Collector.js';
+import collector, { EntryType } from '../../metrics/collector.js';
 
 const RULE_NAME = 'xgen-IPA-109-custom-method-must-use-camel-case';
 

tools/spectral/ipa/rulesets/functions/eachEnumValueMustBeUpperSnakeCase.js

@@ -1,7 +1,7 @@
 import { hasException } from './utils/exceptions.js';
 import { resolveObject } from './utils/componentUtils.js';
 import { casing } from '@stoplight/spectral-functions';
-import collector, { EntryType } from '../../metrics/Collector.js';
+import collector, { EntryType } from '../../metrics/collector.js';
 
 const RULE_NAME = 'xgen-IPA-123-enum-values-must-be-upper-snake-case';
 const ERROR_MESSAGE = 'enum value must be UPPER_SNAKE_CASE.';
@@ -35,9 +35,9 @@ export default (input, _, { path, documentInventory }) => {
   });
 
   if(errors.length === 0) {
-    collector.add(path, RULE_NAME, EntryType.ADOPTION);
+    collector.add(schemaPath, RULE_NAME, EntryType.ADOPTION);
   } else {
-    collector.add(path, RULE_NAME, EntryType.VIOLATION);
+    collector.add(schemaPath, RULE_NAME, EntryType.VIOLATION);
   }
 
   return errors;

tools/spectral/ipa/rulesets/functions/eachPathAlternatesBetweenResourceNameAndPathParam.js

@@ -1,6 +1,6 @@
 import { isPathParam } from './utils/componentUtils.js';
 import { hasException } from './utils/exceptions.js';
-import collector, { EntryType } from '../../metrics/Collector.js';
+import collector, { EntryType } from '../../metrics/collector.js';
 
 const RULE_NAME = 'xgen-IPA-102-path-alternate-resource-name-path-param';
 const ERROR_MESSAGE = 'API paths must alternate between resource name and path params.';

tools/spectral/ipa/rulesets/functions/eachResourceHasGetMethod.js

@@ -7,7 +7,7 @@ import {
   getResourcePaths,
 } from './utils/resourceEvaluation.js';
 import { hasException } from './utils/exceptions.js';
-import collector, { EntryType } from '../../metrics/Collector.js';
+import collector, { EntryType } from '../../metrics/collector.js';
 
 const RULE_NAME = 'xgen-IPA-104-resource-has-GET';
 const ERROR_MESSAGE = 'APIs must provide a get method for resources.';

tools/spectral/ipa/rulesets/functions/exceptionExtensionFormat.js

@@ -1,4 +1,4 @@
-import collector, { EntryType } from '../../metrics/Collector.js';
+import collector, { EntryType } from '../../metrics/collector.js';
 
 const RULE_NAME = 'xgen-IPA-005-exception-extension-format';
 const ERROR_MESSAGE = 'IPA exceptions must have a valid rule name and a reason.';

tools/spectral/ipa/rulesets/functions/singletonHasNoId.js

@@ -7,7 +7,7 @@ import {
 } from './utils/resourceEvaluation.js';
 import { hasException } from './utils/exceptions.js';
 import { getAllSuccessfulGetResponseSchemas } from './utils/methodUtils.js';
-import collector, { EntryType } from '../../metrics/Collector.js';
+import collector, { EntryType } from '../../metrics/collector.js';
 
 const RULE_NAME = 'xgen-IPA-113-singleton-must-not-have-id';
 const ERROR_MESSAGE = 'Singleton resources must not have a user-provided or system-generated ID.';

tools/spectral/ipa/rulesets/functions/utils/exceptions.js

@@ -1,4 +1,4 @@
-import collector, { EntryType } from '../../../metrics/Collector.js';
+import collector, { EntryType } from '../../../metrics/collector.js';
 const EXCEPTION_EXTENSION = 'x-xgen-IPA-exception';
 
 /**