fix(ipa): use rule name from function input instead of hard coded name

Author: yelizhenden-mdb

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

@@ -1,20 +1,20 @@
 import { evaluateAndCollectAdoptionStatusWithoutExceptions, handleInternalError } from './utils/collectionUtils.js';
 
-const RULE_NAME = 'xgen-IPA-005-exception-extension-format';
 const ERROR_MESSAGE = 'IPA exceptions must have a valid rule name and a reason.';
 const RULE_NAME_PREFIX = 'xgen-IPA-';
 
 // Note: This rule does not allow exceptions
-export default (input, _, { path }) => {
-  const errors = checkViolationsAndReturnErrors(input, path);
-  return evaluateAndCollectAdoptionStatusWithoutExceptions(errors, RULE_NAME, path);
+export default (input, _, { path, rule }) => {
+  const ruleName = rule.name;
+  const errors = checkViolationsAndReturnErrors(input, path, ruleName);
+  return evaluateAndCollectAdoptionStatusWithoutExceptions(errors, ruleName, path);
 };
 
 function isValidException(ruleName, reason) {
   return ruleName.startsWith(RULE_NAME_PREFIX) && typeof reason === 'string' && reason !== '';
 }
 
-function checkViolationsAndReturnErrors(input, path) {
+function checkViolationsAndReturnErrors(input, path, ruleName) {
   const errors = [];
   try {
     const exemptedRules = Object.keys(input);
@@ -29,6 +29,6 @@ function checkViolationsAndReturnErrors(input, path) {
     });
     return errors;
   } catch (e) {
-    return handleInternalError(RULE_NAME, path, e);
+    return handleInternalError(ruleName, path, e);
   }
 }

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

@@ -3,7 +3,6 @@ import { isPathParam } from './utils/componentUtils.js';
 import { casing } from '@stoplight/spectral-functions';
 import { findExceptionInPathHierarchy } from './utils/exceptions.js';
 
-const RULE_NAME = 'xgen-IPA-102-collection-identifier-camelCase';
 const ERROR_MESSAGE = 'Collection identifiers must be in camelCase.';
 
 /**
@@ -15,26 +14,27 @@ const ERROR_MESSAGE = 'Collection identifiers must be in camelCase.';
  * @param {object} options - Rule configuration options
  * @param {object} context - The context object containing the path and documentInventory
  */
-export default (input, options, { path, documentInventory }) => {
+export default (input, options, { path, documentInventory, rule }) => {
+  const ruleName = rule.name;
   const oas = documentInventory.resolved;
   const pathKey = input;
 
   // Extract ignored values from options
   const ignoredValues = options?.ignoredValues || [];
 
-  const violations = checkViolations(pathKey, path, ignoredValues);
+  const violations = checkViolations(pathKey, path, ignoredValues, ruleName);
 
   // Check for exceptions in path hierarchy
-  const result = findExceptionInPathHierarchy(oas, pathKey, RULE_NAME, path);
+  const result = findExceptionInPathHierarchy(oas, pathKey, ruleName, path);
   if (result?.error) {
     return result.error;
   }
   const objectToCheckForException = result ? oas.paths[result.parentPath] : oas.paths[input];
 
-  return evaluateAndCollectAdoptionStatus(violations, RULE_NAME, objectToCheckForException, path);
+  return evaluateAndCollectAdoptionStatus(violations, ruleName, objectToCheckForException, path);
 };
 
-function checkViolations(pathKey, path, ignoredValues = []) {
+function checkViolations(pathKey, path, ignoredValues = [], ruleName) {
   const violations = [];
   try {
     // Don't filter out empty segments - they should be treated as violations
@@ -105,9 +105,8 @@ function checkViolations(pathKey, path, ignoredValues = []) {
         });
       }
     });
+    return violations;
   } catch (e) {
-    return handleInternalError(RULE_NAME, [...path, pathKey], e);
+    return handleInternalError(ruleName, [...path, pathKey], e);
   }
-
-  return violations;
 }

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

@@ -1,7 +1,6 @@
 import { evaluateAndCollectAdoptionStatus } from './utils/collectionUtils.js';
 import { findExceptionInPathHierarchy } from './utils/exceptions.js';
 
-const RULE_NAME = 'xgen-IPA-102-collection-identifier-pattern';
 const ERROR_MESSAGE =
   'Collection identifiers must begin with a lowercase letter and contain only ASCII letters and numbers (/[a-z][a-zA-Z0-9]*/).';
 const VALID_IDENTIFIER_PATTERN = /^[a-z][a-zA-Z0-9]*$/;
@@ -15,19 +14,20 @@ const VALID_IDENTIFIER_PATTERN = /^[a-z][a-zA-Z0-9]*$/;
  * @param {object} _ - Unused
  * @param {object} context - The context object containing the path and documentInventory
  */
-export default (input, _, { path, documentInventory }) => {
+export default (input, _, { path, documentInventory, rule }) => {
+  const ruleName = rule.name;
   const oas = documentInventory.resolved;
 
   const violations = checkViolations(input, path);
 
   // Check for exceptions in path hierarchy
-  const result = findExceptionInPathHierarchy(oas, input, RULE_NAME, path);
+  const result = findExceptionInPathHierarchy(oas, input, ruleName, path);
   if (result?.error) {
     return result.error;
   }
   const objectToCheckForException = result ? oas.paths[result.parentPath] : oas.paths[input];
 
-  return evaluateAndCollectAdoptionStatus(violations, RULE_NAME, objectToCheckForException, path);
+  return evaluateAndCollectAdoptionStatus(violations, ruleName, objectToCheckForException, path);
 };
 
 function checkViolations(pathKey, path) {

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

@@ -3,7 +3,6 @@ import { evaluateAndCollectAdoptionStatus, handleInternalError } from './utils/c
 import { AUTH_PREFIX, UNAUTH_PREFIX } from './utils/resourceEvaluation.js';
 import { findExceptionInPathHierarchy } from './utils/exceptions.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.';
 
 const getPrefix = (path) => {
@@ -32,7 +31,8 @@ const validatePathStructure = (elements) => {
  * @param {object} _ - Unused
  * @param {object} context - The context object containing the path and documentInventory
  */
-export default (input, _, { path, documentInventory }) => {
+export default (input, _, { path, documentInventory, rule }) => {
+  const ruleName = rule.name;
   const oas = documentInventory.resolved;
 
   const prefix = getPrefix(input);
@@ -45,20 +45,20 @@ export default (input, _, { path, documentInventory }) => {
     return;
   }
 
-  const errors = checkViolationsAndReturnErrors(suffixWithLeadingSlash, path);
+  const errors = checkViolationsAndReturnErrors(suffixWithLeadingSlash, path, ruleName);
 
   // Check for exceptions in path hierarchy
-  const result = findExceptionInPathHierarchy(oas, input, RULE_NAME, path);
+  const result = findExceptionInPathHierarchy(oas, input, ruleName, path);
   if (result?.error) {
     return result.error;
   }
 
   const objectToCheckForException = result ? oas.paths[result.parentPath] : oas.paths[input];
 
-  return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, objectToCheckForException, path);
+  return evaluateAndCollectAdoptionStatus(errors, ruleName, objectToCheckForException, path);
 };
 
-function checkViolationsAndReturnErrors(suffixWithLeadingSlash, path) {
+function checkViolationsAndReturnErrors(suffixWithLeadingSlash, path, ruleName) {
   try {
     let suffix = suffixWithLeadingSlash.slice(1);
     let elements = suffix.split('/');
@@ -67,6 +67,6 @@ function checkViolationsAndReturnErrors(suffixWithLeadingSlash, path) {
     }
     return [];
   } catch (e) {
-    return handleInternalError(RULE_NAME, path, e);
+    return handleInternalError(ruleName, path, e);
   }
 }

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

@@ -7,22 +7,22 @@ import {
 } from './utils/resourceEvaluation.js';
 import { evaluateAndCollectAdoptionStatus, handleInternalError } from './utils/collectionUtils.js';
 
-const RULE_NAME = 'xgen-IPA-104-resource-has-GET';
 const ERROR_MESSAGE = 'APIs must provide a get method for resources.';
 
-export default (input, _, { path, documentInventory }) => {
+export default (input, _, { path, documentInventory, rule }) => {
+  const ruleName = rule.name;
   if (!isResourceCollectionIdentifier(input)) {
     return;
   }
 
   const oas = documentInventory.resolved;
 
-  const errors = checkViolationsAndReturnErrors(oas.paths, input, path);
+  const errors = checkViolationsAndReturnErrors(oas.paths, input, path, ruleName);
 
-  return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, oas.paths[input], path);
+  return evaluateAndCollectAdoptionStatus(errors, ruleName, oas.paths[input], path);
 };
 
-function checkViolationsAndReturnErrors(oasPaths, input, path) {
+function checkViolationsAndReturnErrors(oasPaths, input, path, ruleName) {
   try {
     const resourcePathItems = getResourcePathItems(input, oasPaths);
     const resourcePaths = Object.keys(resourcePathItems);
@@ -42,6 +42,6 @@ function checkViolationsAndReturnErrors(oasPaths, input, path) {
     }
     return [];
   } catch (e) {
-    return handleInternalError(RULE_NAME, path, e);
+    return handleInternalError(ruleName, path, e);
   }
 }

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

@@ -6,10 +6,10 @@ import {
   isSingletonResource,
 } from './utils/resourceEvaluation.js';
 
-const RULE_NAME = 'xgen-IPA-104-get-method-no-request-body';
 const ERROR_MESSAGE = 'The Get method must not include a request body.';
 
-export default (input, _, { path, documentInventory }) => {
+export default (input, _, { path, documentInventory, rule }) => {
+  const ruleName = rule.name;
   const resourcePath = path[1];
   const oas = documentInventory.resolved;
 
@@ -24,7 +24,7 @@ export default (input, _, { path, documentInventory }) => {
 
   const errors = checkViolationsAndReturnErrors(input, path);
 
-  return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, input, path);
+  return evaluateAndCollectAdoptionStatus(errors, ruleName, input, path);
 };
 
 function checkViolationsAndReturnErrors(getOperationObject, path) {

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

@@ -8,10 +8,10 @@ import {
 import { resolveObject } from './utils/componentUtils.js';
 import { checkForbiddenPropertyAttributesAndReturnErrors } from './utils/validations/checkForbiddenPropertyAttributesAndReturnErrors.js';
 
-const RULE_NAME = 'xgen-IPA-104-get-method-response-has-no-input-fields';
 const ERROR_MESSAGE = 'The get method response object must not include output fields (writeOnly properties).';
 
-export default (input, _, { path, documentInventory }) => {
+export default (input, _, { path, documentInventory, rule }) => {
+  const ruleName = rule.name;
   const resourcePath = path[1];
   const responseCode = path[4];
   const oas = documentInventory.resolved;
@@ -37,5 +37,5 @@ export default (input, _, { path, documentInventory }) => {
     ERROR_MESSAGE
   );
 
-  return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, contentPerMediaType, path);
+  return evaluateAndCollectAdoptionStatus(errors, ruleName, contentPerMediaType, path);
 };

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

@@ -1,16 +1,15 @@
 import {
-  isSingleResourceIdentifier,
-  isSingletonResource,
   getResourcePathItems,
   isResourceCollectionIdentifier,
+  isSingleResourceIdentifier,
+  isSingletonResource,
 } from './utils/resourceEvaluation.js';
 import { resolveObject } from './utils/componentUtils.js';
 import { evaluateAndCollectAdoptionStatus } from './utils/collectionUtils.js';
 import { checkSchemaRefSuffixAndReturnErrors } from './utils/validations/checkSchemaRefSuffixAndReturnErrors.js';
 
-const RULE_NAME = 'xgen-IPA-104-get-method-returns-response-suffixed-object';
-
-export default (input, _, { path, documentInventory }) => {
+export default (input, _, { path, documentInventory, rule }) => {
+  const ruleName = rule.name;
   const resourcePath = path[1];
   const responseCode = path[4];
   const oas = documentInventory.unresolved;
@@ -28,7 +27,7 @@ export default (input, _, { path, documentInventory }) => {
     return;
   }
 
-  const errors = checkSchemaRefSuffixAndReturnErrors(path, contentPerMediaType, 'Response', RULE_NAME);
+  const errors = checkSchemaRefSuffixAndReturnErrors(path, contentPerMediaType, 'Response', ruleName);
 
-  return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, contentPerMediaType, path);
+  return evaluateAndCollectAdoptionStatus(errors, ruleName, contentPerMediaType, path);
 };

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

@@ -8,13 +8,13 @@ import { evaluateAndCollectAdoptionStatus, handleInternalError } from './utils/c
 import { schemaIsArray, schemaIsPaginated } from './utils/schemaUtils.js';
 import { resolveObject } from './utils/componentUtils.js';
 
-const RULE_NAME = 'xgen-IPA-104-get-method-returns-single-resource';
 const ERROR_MESSAGE_STANDARD_RESOURCE =
   'Get methods should return data for a single resource. This method returns an array or a paginated response.';
 const ERROR_MESSAGE_SINGLETON_RESOURCE =
   'Get methods for singleton resource should return data for a single resource. This method returns an array or a paginated response. If this is not a singleton resource, please implement all standard methods.';
 
-export default (input, _, { path, documentInventory }) => {
+export default (input, _, { path, documentInventory, rule }) => {
+  const ruleName = rule.name;
   const oas = documentInventory.resolved;
   const resourcePath = path[1];
   const responseCode = path[4];
@@ -34,12 +34,12 @@ export default (input, _, { path, documentInventory }) => {
     return;
   }
 
-  const errors = checkViolationsAndReturnErrors(contentPerMediaType, path, isSingleton);
+  const errors = checkViolationsAndReturnErrors(contentPerMediaType, path, isSingleton, ruleName);
 
-  return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, contentPerMediaType, path);
+  return evaluateAndCollectAdoptionStatus(errors, ruleName, contentPerMediaType, path);
 };
 
-function checkViolationsAndReturnErrors(contentPerMediaType, path, isSingleton) {
+function checkViolationsAndReturnErrors(contentPerMediaType, path, isSingleton, ruleName) {
   try {
     const schema = contentPerMediaType.schema;
     if (schemaIsPaginated(schema) || schemaIsArray(schema)) {
@@ -52,6 +52,6 @@ function checkViolationsAndReturnErrors(contentPerMediaType, path, isSingleton)
     }
     return [];
   } catch (e) {
-    return handleInternalError(RULE_NAME, path, e);
+    return handleInternalError(ruleName, path, e);
   }
 }

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

@@ -7,11 +7,11 @@ import {
 } from './utils/resourceEvaluation.js';
 import { checkResponseCodeAndReturnErrors } from './utils/validations/checkResponseCodeAndReturnErrors.js';
 
-const RULE_NAME = 'xgen-IPA-104-get-method-response-code-is-200';
 const ERROR_MESSAGE =
   'The Get method must return a 200 OK response. This method either lacks a 200 OK response or defines a different 2xx status code.';
 
-export default (input, _, { path, documentInventory }) => {
+export default (input, _, { path, documentInventory, rule }) => {
+  const ruleName = rule.name;
   const resourcePath = path[1];
   const oas = documentInventory.resolved;
   const resourcePaths = getResourcePathItems(resourcePath, oas.paths);
@@ -23,7 +23,7 @@ export default (input, _, { path, documentInventory }) => {
     return;
   }
 
-  const errors = checkResponseCodeAndReturnErrors(input, '200', path, RULE_NAME, ERROR_MESSAGE);
+  const errors = checkResponseCodeAndReturnErrors(input, '200', path, ruleName, ERROR_MESSAGE);
 
-  return evaluateAndCollectAdoptionStatus(errors, RULE_NAME, input, path);
+  return evaluateAndCollectAdoptionStatus(errors, ruleName, input, path);
 };