Support @projectedName (#3147)

* fix a typo * support projected name * update shared code * remove an unused function * the generation is incorrect * fixed issue * add cadl ranch test cases * regenerate * move the constants to a standalone file * fix prettier --------- Co-authored-by: Mingzhe Huang <[email protected]>
Azure · Feb 21, 2023 · aa049aa · aa049aa
1 parent 44a88c1
commit aa049aa
Show file tree

Hide file tree

Showing 17 changed files with 1,350 additions and 106 deletions.
diff --git a/eng/Generate.ps1 b/eng/Generate.ps1
@@ -264,7 +264,8 @@ $cadlRanchProjectPaths =
     'authentication/union',
     'models/property-optional',
     'models/property-types',
-    'models/usage'
+    'models/usage',
+    "projection"
 
 if (!($Exclude -contains "CadlRanchProjects"))
 {

diff --git a/src/AutoRest.CSharp/Common/Input/CadlInputModelPropertyConverter.cs b/src/AutoRest.CSharp/Common/Input/CadlInputModelPropertyConverter.cs
@@ -37,7 +37,7 @@ private static InputModelProperty ReadInputModelProperty(ref Utf8JsonReader read
             {
                 var isKnownProperty = reader.TryReadReferenceId(ref isFirstProperty, ref id)
                     || reader.TryReadString(nameof(InputModelProperty.Name), ref name)
-                    || reader.TryReadString(nameof(InputModelProperty.SerializedName), ref name)
+                    || reader.TryReadString(nameof(InputModelProperty.SerializedName), ref serializedName)
                     || reader.TryReadString(nameof(InputModelProperty.Description), ref description)
                     || reader.TryReadWithConverter(nameof(InputModelProperty.Type), options, ref propertyType)
                     || reader.TryReadBoolean(nameof(InputModelProperty.IsReadOnly), ref isReadOnly)

diff --git a/src/AutoRest.CSharp/Properties/launchSettings.json b/src/AutoRest.CSharp/Properties/launchSettings.json
@@ -200,6 +200,10 @@
       "commandName": "Project",
       "commandLineArgs": "--standalone $(SolutionDir)\\test\\CadlRanchProjects\\models\\usage\\Generated"
     },
+    "cadl-projection": {
+      "commandName": "Project",
+      "commandLineArgs": "--standalone $(SolutionDir)\\test\\CadlRanchProjects\\projection\\Generated"
+    },
     "ClientAndOperationGroup-Cadl": {
       "commandName": "Project",
       "commandLineArgs": "--standalone $(SolutionDir)\\test\\TestProjects\\ClientAndOperationGroup-Cadl\\Generated"

diff --git a/src/CADL.Extension/Emitter.Csharp/src/constants.ts b/src/CADL.Extension/Emitter.Csharp/src/constants.ts
@@ -0,0 +1,6 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+export const projectedNameJsonKey = "json";
+export const projectedNameCSharpKey = "csharp";
+export const projectedNameClientKey = "client";
diff --git a/src/CADL.Extension/Emitter.Csharp/src/emitter.ts b/src/CADL.Extension/Emitter.Csharp/src/emitter.ts
@@ -211,18 +211,10 @@ function deleteFile(filePath: string) {
 function prettierOutput(output: string) {
     return output + "\n";
 }
-function getClient(
-    clients: InputClient[],
-    clientName: string
-): InputClient | undefined {
-    for (const client of clients) {
-        if (client.Name === clientName) return client;
-    }
-
-    return undefined;
-}
 
-export function createModel(context: EmitContext<NetEmitterOptions>): any {
+export function createModel(
+    context: EmitContext<NetEmitterOptions>
+): CodeModel {
     const services = listServices(context.program);
     if (services.length === 0) {
         services.push({ type: context.program.getGlobalNamespaceType() });
@@ -241,7 +233,7 @@ export function createModel(context: EmitContext<NetEmitterOptions>): any {
 export function createModelForService(
     context: EmitContext<NetEmitterOptions>,
     service: Service
-): any {
+): CodeModel {
     const program = context.program;
     const title = service.title;
     const serviceNamespaceType = service.type;
@@ -305,98 +297,84 @@ export function createModelForService(
     let url: string = "";
     const convenienceOperations: HttpOperation[] = [];
     let lroMonitorOperations: Set<Operation>;
-    const dpgContext = createDpgContext(context as EmitContext<any>);
-    try {
-        //create endpoint parameter from servers
-        if (servers !== undefined) {
-            const cadlServers = resolveServers(
-                program,
-                servers,
-                modelMap,
-                enumMap
-            );
-            if (cadlServers.length > 0) {
-                /* choose the first server as endpoint. */
-                url = cadlServers[0].url;
-                urlParameters = cadlServers[0].parameters;
-            }
-        }
-        const [services] = getAllHttpServices(program);
-        const routes = services[0].operations;
-        if (routes.length === 0) {
-            throw `No Route for service ${services[0].namespace.name}`;
+    const dpgContext = createDpgContext(context);
+
+    //create endpoint parameter from servers
+    if (servers !== undefined) {
+        const cadlServers = resolveServers(program, servers, modelMap, enumMap);
+        if (cadlServers.length > 0) {
+            /* choose the first server as endpoint. */
+            url = cadlServers[0].url;
+            urlParameters = cadlServers[0].parameters;
         }
-        console.log("routes:" + routes.length);
-
-        lroMonitorOperations = getAllLroMonitorOperations(routes, program);
-        const clients: InputClient[] = [];
-        const dpgClients = listClients(dpgContext);
-        for (const client of dpgClients) {
-            clients.push(emitClient(client));
-            const dpgOperationGroups = listOperationGroups(dpgContext, client);
-            for (const dpgGroup of dpgOperationGroups) {
-                clients.push(emitClient(dpgGroup, client));
-            }
+    }
+    const [services] = getAllHttpServices(program);
+    const routes = services[0].operations;
+    if (routes.length === 0) {
+        throw `No Route for service ${services[0].namespace.name}`;
+    }
+    console.log("routes:" + routes.length);
+
+    lroMonitorOperations = getAllLroMonitorOperations(routes, program);
+    const clients: InputClient[] = [];
+    const dpgClients = listClients(dpgContext);
+    for (const client of dpgClients) {
+        clients.push(emitClient(client));
+        const dpgOperationGroups = listOperationGroups(dpgContext, client);
+        for (const dpgGroup of dpgOperationGroups) {
+            clients.push(emitClient(dpgGroup, client));
         }
+    }
 
-        for (const client of clients) {
-            for (const op of client.Operations) {
-                const apiVersionIndex = op.Parameters.findIndex(
-                    (value) => value.IsApiVersion
-                );
-                if (apiVersionIndex !== -1) {
-                    const apiVersionInOperation =
-                        op.Parameters[apiVersionIndex];
-                    if (!apiVersionInOperation.DefaultValue?.Value) {
-                        apiVersionInOperation.DefaultValue =
-                            apiVersionParam.DefaultValue;
-                    }
-                    /**
-                     * replace to the global apiVerison parameter if the apiVersion defined in the operation is the same as the global service apiVersion parameter.
-                     * Three checkpoints:
-                     * the parameter is query parameter,
-                     * it is client parameter
-                     * it does not has default value, or the default value is included in the global service apiVersion.
-                     */
-                    if (
-                        apiVersions.has(
-                            apiVersionInOperation.DefaultValue?.Value
-                        ) &&
-                        apiVersionInOperation.Kind ===
-                            InputOperationParameterKind.Client &&
-                        apiVersionInOperation.Location ===
-                            apiVersionParam.Location
-                    ) {
-                        op.Parameters[apiVersionIndex] = apiVersionParam;
-                    }
-                } else {
-                    op.Parameters.push(apiVersionParam);
+    for (const client of clients) {
+        for (const op of client.Operations) {
+            const apiVersionIndex = op.Parameters.findIndex(
+                (value) => value.IsApiVersion
+            );
+            if (apiVersionIndex !== -1) {
+                const apiVersionInOperation = op.Parameters[apiVersionIndex];
+                if (!apiVersionInOperation.DefaultValue?.Value) {
+                    apiVersionInOperation.DefaultValue =
+                        apiVersionParam.DefaultValue;
                 }
+                /**
+                 * replace to the global apiVerison parameter if the apiVersion defined in the operation is the same as the global service apiVersion parameter.
+                 * Three checkpoints:
+                 * the parameter is query parameter,
+                 * it is client parameter
+                 * it does not has default value, or the default value is included in the global service apiVersion.
+                 */
+                if (
+                    apiVersions.has(
+                        apiVersionInOperation.DefaultValue?.Value
+                    ) &&
+                    apiVersionInOperation.Kind ===
+                        InputOperationParameterKind.Client &&
+                    apiVersionInOperation.Location === apiVersionParam.Location
+                ) {
+                    op.Parameters[apiVersionIndex] = apiVersionParam;
+                }
+            } else {
+                op.Parameters.push(apiVersionParam);
             }
         }
-
-        const usages = getUsages(program, convenienceOperations);
-        setUsage(usages, modelMap);
-        setUsage(usages, enumMap);
-
-        const clientModel = {
-            Name: namespace,
-            Description: description,
-            ApiVersions: Array.from(apiVersions.values()),
-            Enums: Array.from(enumMap.values()),
-            Models: Array.from(modelMap.values()),
-            Clients: clients,
-            Auth: auth
-        } as CodeModel;
-        return clientModel;
-    } catch (err) {
-        if (err instanceof ErrorTypeFoundError) {
-            return;
-        } else {
-            throw err;
-        }
     }
 
+    const usages = getUsages(program, convenienceOperations);
+    setUsage(usages, modelMap);
+    setUsage(usages, enumMap);
+
+    const clientModel = {
+        Name: namespace,
+        Description: description,
+        ApiVersions: Array.from(apiVersions.values()),
+        Enums: Array.from(enumMap.values()),
+        Models: Array.from(modelMap.values()),
+        Clients: clients,
+        Auth: auth
+    } as CodeModel;
+    return clientModel;
+
     function emitClient(
         client: Client | OperationGroup,
         parent?: Client

diff --git a/src/CADL.Extension/Emitter.Csharp/src/lib/model.ts b/src/CADL.Extension/Emitter.Csharp/src/lib/model.ts
@@ -21,15 +21,14 @@ import {
     resolveUsages,
     Type,
     UsageFlags,
-    UsageTracker,
-    TrackableType,
     getDiscriminator,
     IntrinsicType,
     isVoidType,
     isArrayModelType,
     isRecordModelType,
     Scalar,
-    Union
+    Union,
+    getProjectedNames
 } from "@cadl-lang/compiler";
 import { getResourceOperation } from "@cadl-lang/rest";
 import {
@@ -39,6 +38,11 @@ import {
     HttpOperation,
     isStatusCode
 } from "@cadl-lang/rest/http";
+import {
+    projectedNameClientKey,
+    projectedNameCSharpKey,
+    projectedNameJsonKey
+} from "../constants.js";
 import { InputEnumTypeValue } from "../type/InputEnumTypeValue.js";
 import { InputModelProperty } from "../type/InputModelProperty.js";
 import {
@@ -72,8 +76,8 @@ export function mapCadlTypeToCSharpInputTypeKind(
         case "Enum":
             return InputTypeKind.Enum;
         case "Number":
-            let nubmerValue = cadlType.value;
-            if (nubmerValue % 1 === 0) {
+            let numberValue = cadlType.value;
+            if (numberValue % 1 === 0) {
                 return InputTypeKind.Int32;
             }
             return InputTypeKind.Float64;
@@ -512,15 +516,22 @@ export function getInputType(
                     isReadOnly = true;
                 }
                 if (isNeverType(value.type) || isVoidType(value.type)) return;
+                const projectedNamesMap = getProjectedNames(program, value);
+                const name =
+                    projectedNamesMap?.get(projectedNameCSharpKey) ??
+                    projectedNamesMap?.get(projectedNameClientKey) ??
+                    value.name;
+                const serializedName =
+                    projectedNamesMap?.get(projectedNameJsonKey) ?? value.name;
                 const inputProp = {
-                    Name: value.name,
-                    SerializedName: value.name,
+                    Name: name,
+                    SerializedName: serializedName,
                     Description: getDoc(program, value) ?? "",
                     Type: getInputType(program, value.type, models, enums),
                     IsRequired: !value.optional,
                     IsReadOnly: isReadOnly,
                     IsDiscriminator: false
-                };
+                } as InputModelProperty;
                 outputProperties.push(inputProp);
             }
         });

diff --git a/src/CADL.Extension/Emitter.Csharp/src/type/InputModelProperty.ts b/src/CADL.Extension/Emitter.Csharp/src/type/InputModelProperty.ts
@@ -10,4 +10,5 @@ export interface InputModelProperty {
     Type: InputType;
     IsRequired: boolean;
     IsReadOnly: boolean;
+    IsDiscriminator: boolean;
 }
diff --git a/test/CadlRanchProjects.Tests/projection.cs b/test/CadlRanchProjects.Tests/projection.cs
@@ -0,0 +1,48 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System.Threading.Tasks;
+using AutoRest.TestServer.Tests.Infrastructure;
+using Azure;
+using NUnit.Framework;
+using ProjectedName;
+using ProjectedName.Models;
+
+namespace CadlRanchProjects.Tests
+{
+    public class ProjectionTests : CadlRanchTestBase
+    {
+        [Test]
+        public Task ProjectedName_jsonProjection() => Test(async (host) =>
+        {
+            Project project = new Project()
+            {
+                ProducedBy = "DPG",
+            };
+            Response response = await new ProjectedNameClient(host, null).JsonProjectionAsync(project);
+            Assert.AreEqual(204, response.Status);
+        });
+
+        [Test]
+        public Task ProjectedName_clientProjection() => Test(async (host) =>
+        {
+            Project project = new Project()
+            {
+                CreatedBy = "DPG",
+            };
+            Response response = await new ProjectedNameClient(host, null).ClientProjectionAsync(project);
+            Assert.AreEqual(204, response.Status);
+        });
+
+        [Test]
+        public Task ProjectedName_languageProjection() => Test(async (host) =>
+        {
+            Project project = new Project()
+            {
+                MadeForCS = "customers"
+            };
+            Response response = await new ProjectedNameClient(host, null).LanguageProjectionAsync(project);
+            Assert.AreEqual(204, response.Status);
+        });
+    }
+}
diff --git a/test/CadlRanchProjects/projection/Generated/Configuration.json b/test/CadlRanchProjects/projection/Generated/Configuration.json