CLOUDP-306294: Refactored IPA109 Validation function + prettier

Author: Sophia Marie Terry

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

@@ -2,7 +2,7 @@ import { hasException } from './utils/exceptions.js';
 import { collectAdoption, collectException, collectAndReturnViolation } from './utils/collectionUtils.js';
 import { isCustomMethodIdentifier, getCustomMethodName, stripCustomMethodName } from './utils/resourceEvaluation.js';
 import { generateOperationID } from './utils/operationIdGeneration.js';
-import { hasMethodWithVerbOverride, hasCustomMethodOverride } from './utils/extensions.js';
+import { hasMethodWithVerbOverride, hasCustomMethodOverride, VERB_OVERRIDE_EXTENSION } from './utils/extensions.js';
 
 const RULE_NAME = 'xgen-IPA-109-valid-operation-id';
 const ERROR_MESSAGE = 'Invalid OperationID.';
@@ -14,11 +14,12 @@ export default (input, _, { path }) => {
     return;
   }
 
-  let errors = [];
-  let expectedOperationID = '';
-  if (isCustomMethodIdentifier(resourcePath)) {
-    expectedOperationID = generateOperationID(getCustomMethodName(resourcePath), stripCustomMethodName(resourcePath));
+  if (hasException(input, RULE_NAME)) {
+    collectException(input, RULE_NAME, path);
+    return;
+  }
 
+  if (isCustomMethodIdentifier(resourcePath)) {
     let obj;
     if (input.post) {
       obj = input.post;
@@ -28,12 +29,11 @@ export default (input, _, { path }) => {
       return;
     }
 
-    if (hasException(obj, RULE_NAME)) {
-      collectException(obj, RULE_NAME, path);
-      return;
-    }
-
     const operationId = obj.operationId;
+    const expectedOperationID = generateOperationID(
+      getCustomMethodName(resourcePath),
+      stripCustomMethodName(resourcePath)
+    );
     if (operationId !== expectedOperationID) {
       const errors = [
         {
@@ -44,27 +44,27 @@ export default (input, _, { path }) => {
       return collectAndReturnViolation(path, RULE_NAME, errors);
     }
   } else if (hasMethodWithVerbOverride(input)) {
-    const methods = Object.keys(input);
-    for (let i = 0; i < methods.length; i++) {
-      let obj = input[methods[i]];
-      const operationId = obj.operationId;
-      if (hasCustomMethodOverride(obj)) {
-        expectedOperationID = generateOperationID(obj['x-xgen-method-verb-override'].verb, resourcePath);
+    const methods = Object.values(input);
+    let errors = [];
+    methods.forEach((method) => {
+      if (hasCustomMethodOverride(method)) {
+        const operationId = method.operationId;
+        const expectedOperationID = generateOperationID(method[VERB_OVERRIDE_EXTENSION].verb, resourcePath);
         if (operationId !== expectedOperationID) {
           errors.push({
             path,
             message: `${ERROR_MESSAGE} Found ${operationId}, expected ${expectedOperationID}.`,
           });
         }
       }
+    });
+
+    if (errors.length !== 0) {
+      return collectAndReturnViolation(path, RULE_NAME, errors);
     }
   } else {
     return;
   }
 
-  if (errors.length !== 0) {
-    return collectAndReturnViolation(path, RULE_NAME, errors);
-  }
-
   collectAdoption(path, RULE_NAME);
 };

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

@@ -7,7 +7,7 @@ export const VERB_OVERRIDE_EXTENSION = 'x-xgen-method-verb-override';
  * @returns {boolean} true if the endpoint has a nested method with the extension, otherwise false
  */
 export function hasMethodWithVerbOverride(endpoint) {
-  return Object.values(endpoint).some(hasVerbOverride);  
+  return Object.values(endpoint).some(hasVerbOverride);
 }
 
 /**
@@ -27,11 +27,10 @@ export function hasCustomMethodOverride(object) {
  * @param verb the verb to inspect the extension for
  * @returns {boolean} true if the object has the extension with the given verb, otherwise false
  */
-export function hasMethodVerbOverride(object, verb){
-  return hasVerbOverride(object) && object[VERB_OVERRIDE_EXTENSION].verb === verb
+export function hasMethodVerbOverride(object, verb) {
+  return hasVerbOverride(object) && object[VERB_OVERRIDE_EXTENSION].verb === verb;
 }
 
-
 /**
  * Checks if the object has an extension "x-xgen-method-verb-override"
  *