Revert "Merge pull request #79 from tjprescott/FixInheritanceChain"

This reverts commit 3fbeb14, reversing
changes made to 5f5aa1e.

Author: tjprescott

CHANGELOG.md

@@ -1,8 +1,14 @@
 # @azure-tools/rest-api-diff
 
+## 0.2.2 (2025-04-14)
+
+- Reverted change for inheritance chains. This will be fixed in a future release.
+- Removed `--group-violations`. Now violations will always be grouped.
+- `.env` file will now override cached variables set in the environment.
+
 ## 0.2.1 (2025-04-09)
 
-- Added `--suppressions` option to point to a file containing point suppressions of violations.
+- Added `--suppressions` option to point to a filing containing point suppressions of violations.
 - Fixed issue where inheritance chains were not being properly expanded.
 
 ## 0.2.0 (2025-03-11)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/rest-api-diff",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "author": "Microsoft Corporation",
   "description": "Compares two Swagger definitions to identify relevant differences.",
   "license": "MIT",

pnpm-lock.yaml

@@ -120,7 +120,6 @@ export class DefinitionRegistry {
     this.currentPath = [];
     this.client = client;
     this.#gatherDefinitions(map);
-    this.#expandInheritanceChains();
     this.#expandReferences();
   }
 
@@ -204,7 +203,7 @@ export class DefinitionRegistry {
 
   #expandAllOf(base: any): any {
     const allOf = base.allOf;
-
+    delete base.allOf;
     if (allOf === undefined) {
       return base;
     }
@@ -418,31 +417,9 @@ export class DefinitionRegistry {
         this.data.securityDefinitions.add(path, name, data);
       }
     }
-  }
-
-  /**
-   * Ensures inheritance chains are expanded for polymorphic references in the `polymorphicMap`.
-   * This is to ensure than an inheritance chain A > B > C is fully expanded to reflect
-   * that both B and C are derived from A.
-   *
-   * This method iterates through all entries in the `polymorphicMap`, which maps references
-   * to their derived classes. For each key in the map, it:
-   * 1. Retrieves the base class associated with the reference key.
-   * 2. Logs an unresolved reference if the base class cannot be found.
-   * 3. Checks if any derived classes of the reference also have their own derived classes
-   *    and combines them into the current set of derived classes.
-   * 4. Updates the base class with a `$derivedClasses` property containing the complete
-   *    set of derived classes.
-   *
-   * Throws:
-   * - An `Error` if a reference cannot be parsed.
-   *
-   * Side Effects:
-   * - Updates the `$derivedClasses` property of base classes in the `polymorphicMap`.
-   * - Logs unresolved references using `logUnresolvedReference`.
-   */
-  #expandInheritanceChains() {
-    for (const [ref, derived_set] of this.polymorphicMap.entries()) {
+    // ensure each base class has a list of derived classes for use
+    // when interpretting allOf.
+    for (const [ref, set] of this.polymorphicMap.entries()) {
       const refResult = parseReference(ref);
       if (!refResult) {
         throw new Error(`Could not parse reference: ${ref}`);
@@ -452,17 +429,7 @@ export class DefinitionRegistry {
         this.logUnresolvedReference(ref);
         continue;
       }
-      // check if refKey also has derived classes and combine them
-      for (const derived of derived_set) {
-        const derivedRef = parseReference(derived)!.expandedRef;
-        const match = this.polymorphicMap.get(derivedRef);
-        if (match !== undefined) {
-          for (const item of match) {
-            derived_set.add(item);
-          }
-        }
-      }
-      baseClass["$derivedClasses"] = Array.from(derived_set);
+      baseClass["$derivedClasses"] = Array.from(set);
     }
   }
 

src/definitions.ts

@@ -4,7 +4,9 @@ import { VERSION } from "./version.js";
 import { DiffClient } from "./diff-client.js";
 import * as dotenv from "dotenv";
 
-dotenv.config();
+dotenv.config({
+  override: true,
+});
 
 export const epilogue = `This tool is under active development. If you experience issues or have questions, please contact Travis Prescott directly ([email protected]). [Tool version: ${VERSION}]`;
 

src/main.ts

@@ -1 +1 @@
-export const VERSION = "0.2.1";
+export const VERSION = "0.2.2";

src/version.ts

@@ -158,24 +158,3 @@ it("should ignore example references", async () => {
     expect(ref.includes("examples")).toBe(false);
   }
 });
-
-it("expands inheritance chains", async () => {
-  const config: DiffClientConfig = {
-    lhs: ["test/files/inheritanceChain.json"],
-    rhs: ["test/files/inheritanceChain.json"],
-    args: {},
-    rules: getApplicableRules({}),
-  };
-  const client = await TestableDiffClient.create(config);
-  client.parse();
-  const [parser, _] = client.getParsers();
-  const defRegistry = getDefinitionRegistry(parser).getCollection(
-    RegistryKind.Definition
-  );
-  let filePath = Object.keys(defRegistry)[0];
-  let quad = defRegistry[filePath].get("D");
-  let expected_properties = ["aProp", "bProp", "cProp", "dProp"];
-  for (const prop of expected_properties) {
-    expect(quad.properties).toHaveProperty(prop);
-  }
-});