Add operation status (#305)

Azure · Feb 23, 2024 · 66b8ae2 · 66b8ae2
1 parent 315ab0c
commit 66b8ae2
Show file tree

Hide file tree

Showing 3 changed files with 100 additions and 6 deletions.
diff --git a/.chronus/changes/add_operation_status-2024-1-23-16-6-53.md b/.chronus/changes/add_operation_status-2024-1-23-16-6-53.md
@@ -0,0 +1,7 @@
+---
+changeKind: fix
+packages:
+  - "@azure-tools/typespec-client-generator-core"
+---
+
+getAllModels will return models only used as final envelope results
diff --git a/packages/typespec-client-generator-core/src/types.ts b/packages/typespec-client-generator-core/src/types.ts
@@ -1070,17 +1070,19 @@ function updateTypesFromOperation(
     }
   }
   const lroMetaData = getLroMetadata(program, operation);
-  if (lroMetaData) {
+  if (lroMetaData && generateConvenient) {
     const logicalResult = diagnostics.pipe(
       checkAndGetClientType(context, lroMetaData.logicalResult, operation)
     );
-    if (
-      logicalResult &&
-      ["model", "enum", "array", "dict", "union"].includes(logicalResult.kind) &&
-      generateConvenient
-    ) {
+    if (logicalResult) {
       updateUsageOfModel(context, logicalResult, UsageFlags.Output);
     }
+    const envelopeResult = diagnostics.pipe(
+      checkAndGetClientType(context, lroMetaData.envelopeResult, operation)
+    );
+    if (envelopeResult) {
+      updateUsageOfModel(context, envelopeResult, UsageFlags.Output);
+    }
   }
   return diagnostics.wrap(undefined);
 }

diff --git a/packages/typespec-client-generator-core/test/public-utils.test.ts b/packages/typespec-client-generator-core/test/public-utils.test.ts
@@ -1,3 +1,4 @@
+import { AzureCoreTestLibrary } from "@azure-tools/typespec-azure-core/testing";
 import {
   Model,
   ModelProperty,
@@ -1387,5 +1388,89 @@ describe("typespec-client-generator-core: public-utils", () => {
         strictEqual(stringType.values[2].kind, "string");
       });
     });
+
+    describe("getLroMetadata", () => {
+      const lroCode = `
+      @versioned(Versions)
+      @service({title: "Test Service"})
+      namespace TestService;
+      alias ResourceOperations = Azure.Core.ResourceOperations<NoConditionalRequests &
+      NoRepeatableRequests &
+      NoClientRequestId>;
+
+      @doc("The API version.")
+      enum Versions {
+        @doc("The 2022-12-01-preview version.")
+        @useDependency(Azure.Core.Versions.v1_0_Preview_2)
+        v2022_12_01_preview: "2022-12-01-preview",
+      }
+
+      @resource("users")
+      @doc("Details about a user.")
+      model User {
+      @key
+      @visibility("read")
+      @doc("The name of user.")
+      name: string;
+
+      @doc("The role of user")
+      role: string;
+      }
+
+      @doc("The parameters for exporting a user.")
+      model UserExportParams {
+      @query
+      @doc("The format of the data.")
+      format: string;
+      }
+
+      @doc("The exported user data.")
+      model ExportedUser {
+      @doc("The name of user.")
+      name: string;
+
+      @doc("The exported URI.")
+      resourceUri: string;
+      }
+
+      op export is ResourceOperations.LongRunningResourceAction<User, UserExportParams, ExportedUser>;
+    `;
+      it("filter-out-core-models true", async () => {
+        const runnerWithCore = await createSdkTestRunner({
+          librariesToAdd: [AzureCoreTestLibrary],
+          autoUsings: ["Azure.Core", "Azure.Core.Traits"],
+          emitterName: "@azure-tools/typespec-java",
+        });
+        await runnerWithCore.compile(lroCode);
+        const models = getAllModelsAssertNoDiagnostics(runnerWithCore.context);
+        strictEqual(models.length, 1);
+        // there should only be one non-core model
+        strictEqual(models[0].name, "ExportedUser");
+      });
+      it("filter-out-core-models false", async () => {
+        const runnerWithCore = await createSdkTestRunner({
+          librariesToAdd: [AzureCoreTestLibrary],
+          autoUsings: ["Azure.Core", "Azure.Core.Traits"],
+          emitterName: "@azure-tools/typespec-java",
+        });
+        await runnerWithCore.compile(lroCode);
+        runnerWithCore.context.filterOutCoreModels = false;
+        const models = getAllModelsAssertNoDiagnostics(runnerWithCore.context);
+        strictEqual(models.length, 7);
+        // there should only be one non-core model
+        deepStrictEqual(
+          models.map((x) => x.name),
+          [
+            "ResourceOperationStatus",
+            "OperationState",
+            "Error",
+            "InnerError",
+            "ExportedUser",
+            "ErrorResponse",
+            "OperationStatus",
+          ]
+        );
+      });
+    });
   });
 });