Collection format (#3158)

* emit collection format

Author: chunyu3

src/AutoRest.CSharp/CommandLineOptions.cs

@@ -28,7 +28,7 @@ internal class CommandLineOptions
         [Option(longName: "server", Required = false, Default = null, HelpText = "Server argument.")]
         public string? Server { get; set; }
 
-        [Option('c', "clear-output-folder", Required = false, Default = false, HelpText = "Clear the output folder before generating code.")]
+        [Option('x', "clear-output-folder", Required = false, Default = false, HelpText = "Clear the output folder before generating code.")]
         public bool ClearOutputFolder { get; set; }
     }
 }

src/AutoRest.CSharp/Properties/launchSettings.json

@@ -220,6 +220,10 @@
       "commandName": "Project",
       "commandLineArgs": "--standalone $(SolutionDir)\\test\\TestProjects\\CollapseRequestCondition-LowLevel\\Generated"
     },
+    "CollectionFormat-Cadl": {
+      "commandName": "Project",
+      "commandLineArgs": "--standalone $(SolutionDir)\\test\\TestProjects\\CollectionFormat-Cadl\\Generated"
+    },
     "constants": {
       "commandName": "Project",
       "commandLineArgs": "--standalone $(SolutionDir)\\test\\TestServerProjects\\constants\\Generated"

src/CADL.Extension/Emitter.Csharp/src/emitter.ts

@@ -39,6 +39,7 @@ import { BodyMediaType } from "./type/BodyMediaType.js";
 import { InputParameter } from "./type/InputParameter.js";
 import {
     InputEnumType,
+    InputListType,
     InputModelType,
     InputPrimitiveType,
     InputType
@@ -96,6 +97,10 @@ import {
     resolveOptions,
     resolveOutputFolder
 } from "./options.js";
+import {
+    CollectionFormat,
+    collectionFormatToDelimMap
+} from "./type/CollectionFormat.js";
 
 export const $lib = createCadlLibrary({
     name: "cadl-csharp",
@@ -743,6 +748,10 @@ function loadOperation(
         parameter: HttpOperationParameter
     ): InputParameter {
         const { type: location, name, param } = parameter;
+        let format = undefined;
+        if (parameter.type !== "path") {
+            format = parameter.format;
+        }
         const cadlType = param.type;
         const inputType: InputType = getInputType(
             program,
@@ -784,8 +793,14 @@ function loadOperation(
             IsContentType: isContentType,
             IsEndpoint: false,
             SkipUrlEncoding: false, //TODO: retrieve out value from extension
-            Explode: false,
-            Kind: kind
+            Explode:
+                (inputType as InputListType).ElementType && format === "multi"
+                    ? true
+                    : false,
+            Kind: kind,
+            ArraySerializationDelimiter: format
+                ? collectionFormatToDelimMap[format]
+                : undefined
         } as InputParameter;
     }
 

src/CADL.Extension/Emitter.Csharp/src/type/CollectionFormat.ts

@@ -0,0 +1,20 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+export enum CollectionFormat {
+    CSV = "csv",
+    SSV = "ssv",
+    TSV = "tsv",
+    Pipes = "pipes",
+    Multi = "multi"
+}
+
+export const collectionFormatToDelimMap: {
+    [key in CollectionFormat]: string | undefined;
+} = {
+    [CollectionFormat.CSV]: ",",
+    [CollectionFormat.SSV]: " ",
+    [CollectionFormat.TSV]: "\t",
+    [CollectionFormat.Pipes]: "|",
+    [CollectionFormat.Multi]: undefined
+};

test/CadlRanchMockApis/src/CollectionFormat-Cadl.ts

@@ -0,0 +1,70 @@
+import { passOnSuccess, ScenarioMockApi, mockapi, json } from "@azure-tools/cadl-ranch-api";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+const options = ["value1", "value2", "value3"];
+const thing = {
+    name: "collectionFormat"
+};
+Scenarios.CollectionFormat_CsvQuery = passOnSuccess(
+    mockapi.get("/csvQuery", (req) => {
+        req.expect.containsQueryParam("options", "value1,value2,value3");
+        console.log(req.query["options"]);
+        return {
+            status: 200,
+            body: json(thing),
+          };
+    }),
+);
+
+Scenarios.CollectionFormat_MultiQuery = passOnSuccess(
+    mockapi.get("/multiQuery", (req) => {
+        if (req.query.options.length !== 3) {
+            throw new Error("Query parameter 'options' should exploded as 3 query parameters.");
+        }
+        if (JSON.stringify(["value1", "value2", "value3"]) !== JSON.stringify(req.query.options)) {
+            throw new Error("Query parameter 'options' is not correct.")
+        }
+        return {
+            status: 200,
+            body: json(thing),
+          };
+    }),
+);
+
+Scenarios.CollectionFormat_NoFormatQuery = passOnSuccess(
+    mockapi.get("/noFormatQuery", (req) => {
+        if (req.query.options.length !== 3) {
+            throw new Error("Query parameter 'options' should exploded as 3 query parameters.");
+        }
+        if (JSON.stringify(["value1", "value2", "value3"]) !== JSON.stringify(req.query.options)) {
+            throw new Error("Query parameter 'options' is not correct.")
+        }
+        return {
+            status: 200,
+            body: json(thing),
+          };
+    }),
+);
+
+Scenarios.CollectionFormat_CsvHeader = passOnSuccess(
+    mockapi.get("/csvHeader", (req) => {
+        req.expect.containsHeader("options", "value1,value2,value3");
+        return {
+            status: 200,
+            body: json(thing),
+          };
+    }),
+);
+
+Scenarios.CollectionFormat_NoFormateHeader = passOnSuccess(
+    mockapi.get("/noFormatHeader", (req) => {
+        req.expect.containsHeader("options", "value1,value2,value3");
+        return {
+            status: 200,
+            body: json(thing),
+          };
+    }),
+);
+
+

test/CadlRanchProjects.Tests/CollectionFormat.cs

@@ -0,0 +1,59 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System.Threading.Tasks;
+using AutoRest.TestServer.Tests.Infrastructure;
+using NUnit.Framework;
+using Azure;
+using System.Net;
+using Azure.Core;
+using Azure.Identity;
+using Spread.Models;
+using ArrayAsQueryOrHeader;
+using System.Collections.Generic;
+
+namespace CadlRanchProjects.Tests
+{
+    public class CollectionFormatCadlTests : CadlRanchMockApiTestBase
+    {
+        [Test]
+        public Task CollectionFormat_CsvQueryAsync() => Test(async (host) =>
+        {
+            List<string> options = new List<string>() { "value1", "value2", "value3" };
+            Response response = await new ArrayAsQueryOrHeaderClient(host).CsvQueryAsync(options);
+            Assert.AreEqual(200, response.Status);
+        });
+
+        [Test]
+        public Task CollectionFormat_MultiQueryAsync() => Test(async (host) =>
+        {
+            List<string> options = new List<string>(){"value1", "value2", "value3"};
+            Response response = await new ArrayAsQueryOrHeaderClient(host).MultiQueryAsync(options);
+            Assert.AreEqual(200, response.Status);
+        });
+
+        [Test]
+        public Task CollectionFormat_NoFormatQueryAsync() => Test(async (host) =>
+        {
+            List<string> options = new List<string>() { "value1", "value2", "value3" };
+            Response response = await new ArrayAsQueryOrHeaderClient(host).NoFormatQueryAsync(options);
+            Assert.AreEqual(200, response.Status);
+        });
+
+        [Test]
+        public Task CollectionFormat_CsvHeaderAsync() => Test(async (host) =>
+        {
+            List<string> options = new List<string>(){"value1", "value2", "value3"};
+            Response response = await new ArrayAsQueryOrHeaderClient(host).CsvHeaderAsync(options);
+            Assert.AreEqual(200, response.Status);
+        });
+
+        [Test]
+        public Task CollectionFormat_NoFormatHeaderAsync() => Test(async (host) =>
+        {
+            List<string> options = new List<string>() { "value1", "value2", "value3" };
+            Response response = await new ArrayAsQueryOrHeaderClient(host).NoFormatHeaderAsync(options);
+            Assert.AreEqual(200, response.Status);
+        });
+    }
+}

test/TestProjects/CollectionFormat-Cadl/CollectionFormat-Cadl.cadl

@@ -0,0 +1,50 @@
+import "@cadl-lang/rest";
+import "@cadl-lang/openapi";
+import "@azure-tools/cadl-dpg";
+import "@azure-tools/cadl-azure-core";
+
+@service(
+    {
+        title: "Array Query and Header",
+        version: "0.1.0"
+    }
+)
+@doc("CADL project to test array as query or header.")
+@server(
+    "{CollectionFormatCadlUrl}",
+    "Endpoint Service",
+    {
+        CollectionFormatCadlUrl: string,
+    }
+)
+namespace ArrayAsQueryOrHeader;
+
+using Cadl.Http;
+using Cadl.Rest;
+using Azure.DPG;
+using Azure.Core;
+
+model Thing {
+    @doc("the object name.")
+    name: string;
+}
+
+@get
+@route("/csvQuery")
+op csvQuery(@query({format: "csv"}) options?: string[]): Thing;
+
+@get
+@route("/multiQuery")
+op multiQuery(@query({format: "multi"}) options?: string[]): Thing;
+
+@get
+@route("/noFormatQuery")
+op noFormatQuery(@query options?: string[]): Thing;
+
+@get
+@route("/csvHeader")
+op csvHeader(@header({format: "csv"}) options?: string[]): Thing;
+
+@get
+@route("/noFormatHeader")
+op noFormatHeader(@header options?: string[]): Thing;