Update dependencies.

Author: tjprescott

.github/workflows/ci.yaml

@@ -27,8 +27,11 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
 
+      - name: Install pnpm
+        run: npm install -g pnpm
+
       - name: Install dependencies
-        run: npm install
+        run: pnpm install --frozen-lockfile
 
       - name: List installed packages
         run: npm ls -a

CHANGELOG.md

@@ -1,8 +1,9 @@
 # @azure-tools/rest-api-diff
 
-## 0.2.1 (TBD)
+## 0.2.1 (2025-04-09)
 
-- Added `--suppressions` option to point to a filing containing point suppressions of violations.
+- Added `--suppressions` option to point to a file 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.0",
+  "version": "0.2.1",
   "author": "Microsoft Corporation",
   "description": "Compares two Swagger definitions to identify relevant differences.",
   "license": "MIT",
@@ -31,18 +31,18 @@
     "cmd/rest-api-diff.js"
   ],
   "devDependencies": {
-    "@azure-tools/typespec-azure-resource-manager": ">=0.44.0, <1.0.0",
+    "@azure-tools/typespec-azure-resource-manager": ">=0.54.0, <1.0.0",
     "@azure/avocado": "^0.9.1",
     "@types/deep-diff": "^1.0.5",
     "@types/diff": "^7.0.0",
     "@types/node": "^20.14.7",
     "@types/yargs": "^17.0.32",
-    "@typespec/compiler": ">=0.57.0, <1.0.0",
-    "@typespec/http": ">=0.57.0, <1.0.0",
-    "@typespec/openapi": ">=0.57.0, <1.0.0",
-    "@typespec/openapi3": ">=0.57.0, <1.0.0",
-    "@typespec/rest": ">=0.57.0, <1.0.0",
-    "@typespec/versioning": ">=0.57.0, <1.0.0",
+    "@typespec/compiler": "^1.0.0-0",
+    "@typespec/http": "^1.0.0-0",
+    "@typespec/openapi": "^1.0.0-0",
+    "@typespec/openapi3": "^1.0.0-0",
+    "@typespec/rest": ">=0.68.0, <1.0.0",
+    "@typespec/versioning": ">=0.68.0, <1.0.0",
     "@vitest/coverage-v8": "^2.1.0",
     "openapi-types": "^1.0.0",
     "prettier": "~3.2.5",
@@ -53,8 +53,8 @@
     "vitest": "^2.1.3"
   },
   "dependencies": {
-    "@azure-tools/typespec-autorest": ">=0.44.0, <1.0.0",
-    "@azure-tools/typespec-azure-core": ">=0.44.0, <1.0.0",
+    "@azure-tools/typespec-autorest": ">=0.54.0, <1.0.0",
+    "@azure-tools/typespec-azure-core": ">=0.54.0, <1.0.0",
     "acorn": "^8.12.0",
     "acorn-walk": "^8.3.3",
     "arg": "^4.1.3",

pnpm-lock.yaml

@@ -204,7 +204,7 @@ export class DefinitionRegistry {
 
   #expandAllOf(base: any): any {
     const allOf = base.allOf;
-    delete base.allOf;
+
     if (allOf === undefined) {
       return base;
     }
@@ -303,7 +303,6 @@ export class DefinitionRegistry {
     this.referenceStack = [];
     for (const [filepath, values] of collection.data.entries()) {
       for (const [key, value] of values.entries()) {
-        console.log(key);
         this.currentPath.push(key);
         let expanded = this.#expand(value, key, filepath);
         collection.data.get(filepath)!.set(key, expanded);
@@ -421,9 +420,28 @@ export class DefinitionRegistry {
     }
   }
 
+  /**
+   * 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() {
-    // ensure each base class has a list of derived classes for use
-    // when interpretting allOf.
     for (const [ref, derived_set] of this.polymorphicMap.entries()) {
       const refResult = parseReference(ref);
       if (!refResult) {

src/definitions.ts

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

src/version.ts

@@ -173,8 +173,8 @@ it("expands inheritance chains", async () => {
     RegistryKind.Definition
   );
   let filePath = Object.keys(defRegistry)[0];
-  let quad = defRegistry[filePath].get("Quadrilateral");
-  let expected_properties = ["length", "width", "sides", "name"];
+  let quad = defRegistry[filePath].get("D");
+  let expected_properties = ["aProp", "bProp", "cProp", "dProp"];
   for (const prop of expected_properties) {
     expect(quad.properties).toHaveProperty(prop);
   }

test/definition-registry.test.ts

@@ -15,48 +15,56 @@
   "tags": [],
   "paths": {},
   "definitions": {
-    "Polygon": {
+    "A": {
       "type": "object",
       "properties": {
-        "sides": {
-          "type": "integer",
-          "format": "int16"
+        "aProp": {
+          "type": "string"
+        }
+      },
+      "required": ["aProp"]
+    },
+    "B": {
+      "type": "object",
+      "properties": {
+        "bProp": {
+          "type": "string"
         }
       },
-      "required": ["sides"],
+      "required": ["bProp"],
       "allOf": [
         {
-          "$ref": "#/definitions/Shape"
+          "$ref": "#/definitions/A"
         }
       ]
     },
-    "Quadrilateral": {
+    "C": {
       "type": "object",
       "properties": {
-        "length": {
-          "type": "integer",
-          "format": "int16"
-        },
-        "width": {
-          "type": "integer",
-          "format": "int16"
+        "cProp": {
+          "type": "string"
         }
       },
-      "required": ["length", "width"],
+      "required": ["cProp"],
       "allOf": [
         {
-          "$ref": "#/definitions/Polygon"
+          "$ref": "#/definitions/B"
         }
       ]
     },
-    "Shape": {
+    "D": {
       "type": "object",
       "properties": {
-        "name": {
+        "dProp": {
           "type": "string"
         }
       },
-      "required": ["name"]
+      "required": ["dProp"],
+      "allOf": [
+        {
+          "$ref": "#/definitions/C"
+        }
+      ]
     }
   },
   "parameters": {}