[tcgc] ensure operation examples to be ordered (#2000)

fix: #1986

.chronus/changes/fix_example_order-2024-11-18-20-58-12.md

@@ -0,0 +1,7 @@
+---
+changeKind: fix
+packages:
+  - "@azure-tools/typespec-client-generator-core"
+---
+
+ensure operation examples to be ordered

packages/typespec-client-generator-core/src/example.ts

@@ -252,6 +252,9 @@ function handleHttpOperationExamples(
     operation.examples.push(operationExample);
   }
 
+  // sort examples by file path
+  operation.examples.sort((a, b) => (a.filePath > b.filePath ? 1 : -1));
+
   return diagnostics.wrap(undefined);
 }
 

packages/typespec-client-generator-core/test/examples/load.test.ts

@@ -253,4 +253,25 @@ describe("typespec-client-generator-core: load examples", () => {
     ok(operation);
     strictEqual(operation.examples?.length, 1);
   });
+
+  it("ensure ordering for multiple examples", async () => {
+    await runner.host.addRealTypeSpecFile("./examples/a_b_c.json", `${__dirname}/load/a_b_c.json`);
+    await runner.host.addRealTypeSpecFile("./examples/a_b.json", `${__dirname}/load/a_b.json`);
+    await runner.host.addRealTypeSpecFile("./examples/a.json", `${__dirname}/load/a.json`);
+    await runner.compile(`
+      @service({})
+      namespace TestClient {
+        op get(): string;
+      }
+    `);
+
+    const operation = (
+      runner.context.sdkPackage.clients[0].methods[0] as SdkServiceMethod<SdkHttpOperation>
+    ).operation;
+    ok(operation);
+    strictEqual(operation.examples?.length, 3);
+    strictEqual(operation.examples![0].filePath, "a.json");
+    strictEqual(operation.examples![1].filePath, "a_b.json");
+    strictEqual(operation.examples![2].filePath, "a_b_c.json");
+  });
 });

packages/typespec-client-generator-core/test/examples/load/a.json

@@ -0,0 +1,11 @@
+{
+  "operationId": "get",
+  "title": "a",
+  "parameters": {},
+  "responses": {
+    "200": {
+      "description": "ARM operation completed successfully.",
+      "body": "test"
+    }
+  }
+}

packages/typespec-client-generator-core/test/examples/load/a_b.json

@@ -0,0 +1,11 @@
+{
+  "operationId": "get",
+  "title": "ab",
+  "parameters": {},
+  "responses": {
+    "200": {
+      "description": "ARM operation completed successfully.",
+      "body": "test"
+    }
+  }
+}

packages/typespec-client-generator-core/test/examples/load/a_b_c.json

@@ -0,0 +1,11 @@
+{
+  "operationId": "get",
+  "title": "abc",
+  "parameters": {},
+  "responses": {
+    "200": {
+      "description": "ARM operation completed successfully.",
+      "body": "test"
+    }
+  }
+}