Fix unknown never type

packages/cadl-rlc-test/test/authoring/cadl-output/review/authoring.api.md

@@ -588,7 +588,6 @@ export type MicrosoftCognitiveLanguageServiceAnalyzeTextAuthoringClient = Client
 export interface OperationStatusOutput {
     error?: ErrorModelOutput;
     id: string;
-    result?: never;
     status: string;
 }
 

packages/cadl-rlc-test/test/authoring/cadl-output/src/outputModels.ts

@@ -42,8 +42,6 @@ export interface OperationStatusOutput {
   status: string;
   /** Error object that describes the error when status is "Failed". */
   error?: ErrorModelOutput;
-  /** The result of the operation. */
-  result?: never;
 }
 
 /** The error object. */

packages/cadl-typescript/src/index.ts

@@ -31,7 +31,7 @@ import { listClients } from "@azure-tools/cadl-dpg";
 
 export async function $onEmit(program: Program, options: RLCOptions) {
   const clients = listClients(program);
-  for(const client of clients) {
+  for (const client of clients) {
     const rlcModels = await transformRLCModel(program, options, client);
     await emitModels(rlcModels, program);
     await emitContentByBuilder(program, buildClientDefinitions, rlcModels);
@@ -69,5 +69,4 @@ export async function $onEmit(program: Program, options: RLCOptions) {
       rlcModels
     );
   }
-
 }

packages/cadl-typescript/src/modelUtils.ts

@@ -103,7 +103,12 @@ export function getSchemaForType(
     return type;
   }
   if (type.kind === "Intrinsic" && type.name === "unknown") {
-    return { type: "unknown" };
+    const returnType: any = { type: "unknown" };
+    if (usage && usage.includes(SchemaContext.Output)) {
+      returnType.outputTypeName = "any";
+      returnType.typeName = "unknown";
+    }
+    return returnType;
   }
   if (type.kind === "Intrinsic" && type.name === "never") {
     return { type: "never" };
@@ -693,6 +698,13 @@ function mapCadlIntrinsicModelToTypeScript(
             schema.outputTypeName = `Record<string, ${valueType.name}Output>`;
             schema.outputValueTypeName = `${valueType.name}Output`;
           }
+        } else if (isUnknownType(indexer.value!)) {
+          schema.typeName = `Record<string, ${valueType.type}>`;
+          schema.valueTypeName = valueType.name;
+          if (usage && usage.includes(SchemaContext.Output)) {
+            schema.outputTypeName = `Record<string, ${valueType.outputTypeName}>`;
+            schema.outputValueTypeName = `${valueType.outputTypeName}`;
+          }
         } else {
           schema.typeName = `Record<string, ${valueType.type}>`;
         }
@@ -874,6 +886,12 @@ function getPriorityName(schema: Schema): string {
   return schema.outputTypeName ?? schema.typeName ?? schema.name;
 }
 function getDictionaryValueName(schema: DictionarySchema): string | undefined {
+  if (
+    schema.outputValueTypeName === "any" ||
+    schema.outputValueTypeName === "unknown"
+  ) {
+    return undefined;
+  }
   return schema.outputValueTypeName ?? schema.valueTypeName ?? undefined;
 }
 function getEnumStringDescription(type: any) {

packages/cadl-typescript/src/operationUtil.ts

@@ -2,7 +2,13 @@
 // Licensed under the MIT License.
 
 import { NameType, normalizeName } from "@azure-tools/rlc-common";
-import { DecoratedType, ignoreDiagnostics, Model, Program, Type } from "@cadl-lang/compiler";
+import {
+  DecoratedType,
+  ignoreDiagnostics,
+  Model,
+  Program,
+  Type
+} from "@cadl-lang/compiler";
 import {
   getHttpOperation,
   HttpOperation,
@@ -13,7 +19,12 @@ import {
   getPagedResult,
   PagedResultMetadata
 } from "@azure-tools/cadl-azure-core";
-import { Client, listOperationGroups, listOperationsInOperationGroup, OperationGroup } from "@azure-tools/cadl-dpg";
+import {
+  Client,
+  listOperationGroups,
+  listOperationsInOperationGroup,
+  OperationGroup
+} from "@azure-tools/cadl-dpg";
 
 export function getNormalizedOperationName(
   route: HttpOperation,
@@ -39,9 +50,7 @@ export function getOperationStatuscode(
 }
 
 // FIXME: this is the placeholder function to extract the operationGroupName
-export function getOperationGroupName(
-  operationGroup?: OperationGroup,
-) {
+export function getOperationGroupName(operationGroup?: OperationGroup) {
   return operationGroup?.type.name ?? "";
 }
 
@@ -97,17 +106,17 @@ function hasDecorator(type: DecoratedType, name: string): boolean {
 
 export function hasPollingOperations(program: Program, client: Client) {
   const operationGroups = listOperationGroups(program, client);
-  for(const operationGroup of operationGroups) {
+  for (const operationGroup of operationGroups) {
     const operations = listOperationsInOperationGroup(program, operationGroup);
-    for(const op of operations) {
+    for (const op of operations) {
       const route = ignoreDiagnostics(getHttpOperation(program, op));
       if (isLongRunningOperation(program, route)) {
         return true;
       }
     }
   }
   const clientOperations = listOperationsInOperationGroup(program, client);
-  for(const clientOp of clientOperations) {
+  for (const clientOp of clientOperations) {
     const route = ignoreDiagnostics(getHttpOperation(program, clientOp));
     if (isLongRunningOperation(program, route)) {
       return true;
@@ -129,17 +138,17 @@ export function isPagingOperation(program: Program, operation: HttpOperation) {
 
 export function hasPagingOperations(program: Program, client: Client) {
   const operationGroups = listOperationGroups(program, client);
-  for(const operationGroup of operationGroups) {
+  for (const operationGroup of operationGroups) {
     const operations = listOperationsInOperationGroup(program, operationGroup);
-    for(const op of operations) {
+    for (const op of operations) {
       const route = ignoreDiagnostics(getHttpOperation(program, op));
       if (isPagingOperation(program, route)) {
         return true;
       }
     }
   }
   const clientOperations = listOperationsInOperationGroup(program, client);
-  for(const clientOp of clientOperations) {
+  for (const clientOp of clientOperations) {
     const route = ignoreDiagnostics(getHttpOperation(program, clientOp));
     if (isPagingOperation(program, route)) {
       return true;

packages/cadl-typescript/test/integration/generated/arrays/itemTypes/src/responses.ts

@@ -84,7 +84,7 @@ export interface DurationValuePut204Response extends HttpResponse {
 /** The request has succeeded. */
 export interface UnknownValueGet200Response extends HttpResponse {
   status: "200";
-  body: unknown[];
+  body: any[];
 }
 
 /** There is no content to send for this request, but the headers may be useful. */

packages/cadl-typescript/test/integration/generated/dictionary/src/responses.ts

@@ -84,7 +84,7 @@ export interface DurationValuePut204Response extends HttpResponse {
 /** The request has succeeded. */
 export interface UnknownValueGet200Response extends HttpResponse {
   status: "200";
-  body: Record<string, unknown>;
+  body: Record<string, any>;
 }
 
 /** There is no content to send for this request, but the headers may be useful. */

packages/cadl-typescript/test/integration/generated/models/propertyTypes/src/models.ts

@@ -96,7 +96,4 @@ export interface DictionaryStringProperty {
 }
 
 /** Model with a property never. (This property should not be included). */
-export interface NeverProperty {
-  /** Property */
-  property: never;
-}
+export interface NeverProperty {}

packages/cadl-typescript/test/integration/generated/models/propertyTypes/src/outputModels.ts

@@ -96,7 +96,4 @@ export interface DictionaryStringPropertyOutput {
 }
 
 /** Model with a property never. (This property should not be included). */
-export interface NeverPropertyOutput {
-  /** Property */
-  property: never;
-}
+export interface NeverPropertyOutput {}

packages/cadl-typescript/test/integration/modelPropertyType.spec.ts

@@ -67,6 +67,10 @@ const testedTypes: TypeDetail[] = [
   {
     type: "dictionary/string",
     defaultValue: { k1: "hello", k2: "world" }
+  },
+  {
+    type: "never",
+    defaultValue: undefined
   }
 ];
 describe("ModelsPropertyTypesClient Rest Client", () => {

packages/cadl-typescript/test/unit/generate/models.spec.ts

@@ -200,16 +200,22 @@ describe("Input/output model type", () => {
       await verifyPropertyType(cadlType, typeScriptType);
     });
 
-    it("should handle never -> never", async () => {
-      const cadlType = "never";
-      const typeScriptType = "never";
-      await verifyPropertyType(cadlType, typeScriptType);
-    });
-
-    it("should handle unknown -> unknown", async () => {
-      const cadlType = "unknown";
-      const typeScriptType = "unknown";
-      await verifyPropertyType(cadlType, typeScriptType);
+    it("should handle never, its property will be ignored both in Input and Ouput model", async () => {
+      const cadlDefinition = `
+      model SimpleModel {
+        prop1: never;
+        prop2: never;
+      }`;
+      const cadlType = "SimpleModel";
+      const inputModelName = "SimpleModel";
+      await verifyPropertyType(cadlType, inputModelName, {
+        additionalCadlDefinition: cadlDefinition,
+        outputType: `${inputModelName}Output`,
+        additionalInputContent: `
+        export interface ${inputModelName} {}`,
+        additionalOutputContent: `
+        export interface ${inputModelName}Output {}`
+      });
     });
   });
 
@@ -269,10 +275,18 @@ describe("Input/output model type", () => {
       await verifyPropertyType(cadlType, typeScriptType);
     });
 
-    it("should handle unknown[] -> unknown[]", async () => {
+    it("should handle unknown[] -> input 'unknown[]' output type 'any[]'", async () => {
       const cadlType = "unknown[]";
-      const typeScriptType = "unknown[]";
-      await verifyPropertyType(cadlType, typeScriptType);
+      const inputType = "unknown[]";
+      const outputType = "any[]";
+      await verifyPropertyType(cadlType, inputType, { outputType });
+    });
+
+    it("should handle unknown -> input 'unknown' output type 'any'", async () => {
+      const cadlType = "unknown";
+      const inputType = "unknown";
+      const outputType = "any";
+      await verifyPropertyType(cadlType, inputType, { outputType });
     });
   });
   describe("array models generation", () => {
@@ -313,7 +327,7 @@ describe("Input/output model type", () => {
       const inputModelName = typeScriptType;
       await verifyPropertyType(cadlType, inputModelName, {
         additionalCadlDefinition: cadlDefinition,
-        outputType: typeScriptType,
+        outputType: typeScriptType
       });
     });
   });
@@ -640,6 +654,12 @@ describe("Input/output model type", () => {
     it("should handle Record<string> -> Record<string, string>", async () => {
       await verifyPropertyType("Record<string>", "Record<string, string>");
     });
+    it("should handle Record<unknown> -> input 'Record<unknown>' output type 'Record<any>'", async () => {
+      const cadlType = "Record<unknown>";
+      const inputType = "Record<string, unknown>";
+      const outputType = "Record<string, any>";
+      await verifyPropertyType(cadlType, inputType, { outputType });
+    });
   });
 
   describe("Record Model generation", () => {

packages/cadl-typescript/test/unit/generate/responses.spec.ts

@@ -104,6 +104,24 @@ describe("Responses.ts", () => {
   });
 
   describe("body generation", () => {
+    it("should generate Record<unknown> as body property", async () => {
+      const responses = await emitResponsesFromCadl(`
+        op read(): Record<unknown>;
+    `);
+      assert.ok(responses);
+      assertEqualContent(
+        responses!.content,
+        `
+    import { HttpResponse } from "@azure-rest/core-client";
+
+    /** The request has succeeded. */
+    export interface Read200Response extends HttpResponse {
+      status: "200";
+      body: Record<string, any>;
+    }
+    `
+      );
+    });
     it("@header contentType not json or text should set format to binary(finally unit8array)", async () => {
       const responses = await emitResponsesFromCadl(`
       @get op read(): {@header contentType: "image/png", @body body: bytes};

packages/rlc-common/src/buildObjectTypes.ts

@@ -351,11 +351,10 @@ function getPropertySignatures(
   importedModels: Set<string>
 ) {
   let validProperties = Object.keys(properties);
-  if (schemaUsage.includes(SchemaContext.Input)) {
-    validProperties = validProperties.filter((p) => {
-      return !properties[p].readOnly;
-    });
-  }
+  const readOnlyFilter = (name: string) =>
+    !(schemaUsage.includes(SchemaContext.Input) && properties[name].readOnly);
+  const neverFilter = (name: string) => properties[name].type !== "never";
+  validProperties = validProperties.filter(readOnlyFilter).filter(neverFilter);
   return validProperties.map((p) =>
     getPropertySignature(
       { ...properties[p], name: p },

packages/rlc-common/src/buildParameterTypes.ts

@@ -462,20 +462,6 @@ export function buildBodyTypeAlias(parameters: ParameterMetadatas) {
   }
 
   const contentType = headerParameters[0].param.type;
-  const readOnlyProperties = [];
-  if (schema.properties) {
-    for (const propertyName of Object.keys(schema.properties)) {
-      const prop = schema.properties[propertyName];
-      if (prop?.readOnly) {
-        if (propertyName.startsWith('"') && propertyName.endsWith('"')) {
-          readOnlyProperties.push(`${propertyName}`);
-        } else {
-          readOnlyProperties.push(`"${propertyName}"`);
-        }
-      }
-    }
-  }
-
   const description = `${schema.description}`;
   const typeName = `${schema.typeName}ResourceMergeAndPatch`;
   if (contentType.includes("application/merge-patch+json")) {