Merge Hotfix back into main (#4167)

.github/workflows/consistency.yml

@@ -24,13 +24,13 @@ jobs:
 
       - uses: ./.github/actions/setup
 
-      - run: git pull --force --no-tags origin main:main
+      - run: git pull --force --no-tags origin ${{ github.event.pull_request.base.ref }}:${{ github.event.pull_request.base.ref }}
-        name: Get main ref
+        name: Get ${{ github.event.pull_request.base.ref }} ref for ${{ github.ref}}, evt ${{ github.event_name }}
 
       - run: pnpm install
         name: Install dependencies
 
-      - run: npx chronus verify
+      - run: npx chronus verify --since ${{ github.event.pull_request.base.ref }}
         name: Check changelog
         if: |
           !startsWith(github.head_ref, 'publish/') &&

eng/common/pipelines/ci.yml

@@ -7,6 +7,7 @@ pr:
   branches:
     include:
       - main
+      - release/*
 
 extends:
   template: /eng/common/pipelines/templates/1es-redirect.yml

packages/http/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log - @typespec/http
 
+## 0.59.1
+
+### Bug Fixes
+
+- [#4155](https://github.com/microsoft/typespec/pull/4155) HotFix: Uri template not correctly built when using `@autoRoute`
+
+
 ## 0.59.0
 
 ### Bug Fixes

packages/http/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/http",
-  "version": "0.59.0",
+  "version": "0.59.1",
   "author": "Microsoft Corporation",
   "description": "TypeSpec HTTP protocol binding",
   "homepage": "https://github.com/microsoft/typespec",

packages/http/src/route.ts

@@ -15,6 +15,7 @@ import {
   HttpOperation,
   HttpOperationParameter,
   HttpOperationParameters,
+  HttpOperationPathParameter,
   PathParameterOptions,
   RouteOptions,
   RoutePath,
@@ -223,24 +224,30 @@ const styleToOperator: Record<PathParameterOptions["style"], string> = {
   fragment: "#",
 };
 
-function addOperationTemplateToUriTemplate(uriTemplate: string, params: HttpOperationParameter[]) {
+export function getUriTemplatePathParam(param: HttpOperationPathParameter) {
-  const pathParams = params
-    .filter((x) => x.type === "path")
-    .map((param) => {
   const operator = param.allowReserved ? "+" : styleToOperator[param.style];
   return `{${operator}${param.name}${param.explode ? "*" : ""}}`;
-    });
+}
+
+export function addQueryParamsToUriTemplate(uriTemplate: string, params: HttpOperationParameter[]) {
   const queryParams = params.filter((x) => x.type === "query");
 
-  const pathPart = joinPathSegments([uriTemplate, ...pathParams]);
   return (
-    pathPart +
+    uriTemplate +
     (queryParams.length > 0
       ? `{?${queryParams.map((x) => escapeUriTemplateParamName(x.name)).join(",")}}`
       : "")
   );
 }
 
+function addOperationTemplateToUriTemplate(uriTemplate: string, params: HttpOperationParameter[]) {
+  const pathParams = params.filter((x) => x.type === "path").map(getUriTemplatePathParam);
+  const queryParams = params.filter((x) => x.type === "query");
+
+  const pathPart = joinPathSegments([uriTemplate, ...pathParams]);
+  return addQueryParamsToUriTemplate(pathPart, queryParams);
+}
+
 function escapeUriTemplateParamName(name: string) {
   return name.replaceAll(":", "%3A");
 }

packages/openapi3/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log - @typespec/openapi3
 
+## 0.59.1
+
+### Bug Fixes
+
+- [#4168](https://github.com/microsoft/typespec/pull/4168) Fix: query params are `explode: true` by default in OpenAPI 3.0
+
+
 ## 0.59.0
 
 ### Bug Fixes

packages/openapi3/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/openapi3",
-  "version": "0.59.0",
+  "version": "0.59.1",
   "author": "Microsoft Corporation",
   "description": "TypeSpec library for emitting OpenAPI 3.0 from the TypeSpec REST protocol binding and converting OpenAPI3 to TypeSpec",
   "homepage": "https://typespec.io",

packages/openapi3/src/openapi.ts

@@ -1456,8 +1456,9 @@ function createOAPIEmitter(
   function getQueryParameterAttributes(parameter: HttpOperationParameter & { type: "query" }) {
     const attributes: { style?: string; explode?: boolean } = {};
 
-    if (parameter.explode) {
+    if (parameter.explode !== true) {
-      attributes.explode = true;
+      // For query parameters(style: form) the default is explode: true https://spec.openapis.org/oas/v3.0.2#fixed-fields-9
+      attributes.explode = false;
     }
 
     switch (parameter.format) {
@@ -1465,9 +1466,10 @@ function createOAPIEmitter(
         return { style: "spaceDelimited", explode: false };
       case "pipes":
         return { style: "pipeDelimited", explode: false };
-      case undefined:
       case "csv":
       case "simple":
+        return { explode: false };
+      case undefined:
       case "multi":
       case "form":
         return attributes;

packages/openapi3/test/metadata.test.ts

@@ -661,6 +661,7 @@ describe("openapi3: metadata", () => {
         "Parameters.q": {
           name: "q",
           in: "query",
+          explode: false,
           required: true,
           schema: { type: "string" },
         },
@@ -717,6 +718,7 @@ describe("openapi3: metadata", () => {
               name: "q",
               in: "query",
               required: true,
+              explode: false,
               schema: { type: "string" },
             },
             {

packages/openapi3/test/parameters.test.ts

@@ -31,18 +31,32 @@ describe("query parameters", () => {
     strictEqual(param.name, "$select");
   });
 
-  describe("set explode: true", () => {
+  describe("doesn't set explode if explode: true (Openapi3.0 inverse default)", () => {
     it("with option", async () => {
       const param = await getQueryParam(`op test(@query(#{explode: true}) myParam: string): void;`);
-      expect(param).toMatchObject({
+      expect(param).not.toHaveProperty("explode");
-        explode: true,
-      });
     });
 
     it("with uri template", async () => {
       const param = await getQueryParam(`@route("{?myParam*}") op test(myParam: string): void;`);
+      expect(param).not.toHaveProperty("explode");
+    });
+  });
+
+  describe("set explode: false if explode is not set", () => {
+    it("with option", async () => {
+      const param = await getQueryParam(
+        `op test(@query(#{explode: false}) myParam: string): void;`
+      );
       expect(param).toMatchObject({
-        explode: true,
+        explode: false,
+      });
+    });
+
+    it("with uri template", async () => {
+      const param = await getQueryParam(`@route("{?myParam}") op test(myParam: string): void;`);
+      expect(param).toMatchObject({
+        explode: false,
       });
     });
   });
@@ -66,7 +80,6 @@ describe("query parameters", () => {
       in: "query",
       name: "$multi",
       required: true,
-      explode: true,
       schema: {
         type: "array",
         items: {
@@ -77,6 +90,7 @@ describe("query parameters", () => {
     deepStrictEqual(params[1], {
       in: "query",
       name: "$csv",
+      explode: false,
       schema: {
         type: "array",
         items: {
@@ -134,6 +148,7 @@ describe("query parameters", () => {
     deepStrictEqual(res.paths["/"].get.parameters[0], {
       in: "query",
       name: "id",
+      explode: false,
       required: true,
       schema: {
         type: "string",

packages/openapi3/test/shared-routes.test.ts

@@ -70,6 +70,7 @@ describe("openapi3: shared routes", () => {
       {
         in: "query",
         name: "resourceGroup",
+        explode: false,
         required: false,
         schema: {
           type: "string",
@@ -78,6 +79,7 @@ describe("openapi3: shared routes", () => {
       {
         in: "query",
         name: "foo",
+        explode: false,
         required: true,
         schema: {
           type: "string",
@@ -86,6 +88,7 @@ describe("openapi3: shared routes", () => {
       {
         in: "query",
         name: "subscription",
+        explode: false,
         required: false,
         schema: {
           type: "string",
@@ -130,6 +133,7 @@ describe("openapi3: shared routes", () => {
       {
         in: "query",
         name: "filter",
+        explode: false,
         required: true,
         schema: {
           type: "string",
@@ -176,6 +180,7 @@ describe("openapi3: shared routes", () => {
         name: "filter",
         in: "query",
         required: false,
+        explode: false,
         schema: {
           type: "string",
           enum: ["resourceGroup"],

packages/rest/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log - @typespec/rest
 
+## 0.59.1
+
+### Bug Fixes
+
+- [#4155](https://github.com/microsoft/typespec/pull/4155) HotFix: Uri template not correctly built when using `@autoRoute`
+
+
 ## 0.59.0
 
 ### Bump dependencies

packages/rest/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/rest",
-  "version": "0.59.0",
+  "version": "0.59.1",
   "author": "Microsoft Corporation",
   "description": "TypeSpec REST protocol binding",
   "homepage": "https://typespec.io",

packages/rest/src/rest.ts

@@ -12,11 +12,13 @@ import {
   Type,
 } from "@typespec/compiler";
 import {
+  addQueryParamsToUriTemplate,
   DefaultRouteProducer,
   getOperationParameters,
   getOperationVerb,
   getRoutePath,
   getRouteProducer,
+  getUriTemplatePathParam,
   HttpOperation,
   HttpOperationParameter,
   HttpOperationParameters,
@@ -119,7 +121,7 @@ function autoRouteProducer(
   );
 
   for (const httpParam of parameters.parameters) {
-    const { type, param, name } = httpParam;
+    const { type, param } = httpParam;
     if (type === "path") {
       addSegmentFragment(program, param, segments);
 
@@ -137,7 +139,7 @@ function autoRouteProducer(
           segments.push(`/${param.type.value}`);
           continue; // Skip adding to the parameter list
         } else {
-          segments.push(`/{${name}}`);
+          segments.push(`/${getUriTemplatePathParam(httpParam)}`);
         }
       }
     }
@@ -155,8 +157,10 @@ function autoRouteProducer(
   // Add the operation's action segment if present
   addActionFragment(program, operation, segments);
 
+  const pathPart = joinPathSegments(segments);
+
   return diagnostics.wrap({
-    uriTemplate: joinPathSegments(segments),
+    uriTemplate: addQueryParamsToUriTemplate(pathPart, filteredParameters),
     parameters: {
       ...parameters,
       parameters: filteredParameters,

packages/rest/test/routes.test.ts

@@ -2,7 +2,7 @@ import { ModelProperty, Operation } from "@typespec/compiler";
 import { expectDiagnostics } from "@typespec/compiler/testing";
 import { isSharedRoute } from "@typespec/http";
 import { deepStrictEqual, strictEqual } from "assert";
-import { describe, it } from "vitest";
+import { describe, expect, it } from "vitest";
 import {
   compileOperations,
   createRestTestRunner,
@@ -521,3 +521,29 @@ describe("rest: routes", () => {
     ]);
   });
 });
+
+describe("uri template", () => {
+  async function getOp(code: string) {
+    const ops = await getOperations(code);
+    return ops[0];
+  }
+
+  describe("build uriTemplate from parameter", () => {
+    it.each([
+      ["@path one: string", "/foo/{one}"],
+      ["@path(#{allowReserved: true}) one: string", "/foo/{+one}"],
+      ["@path(#{explode: true}) one: string", "/foo/{one*}"],
+      [`@path(#{style: "matrix"}) one: string`, "/foo/{;one}"],
+      [`@path(#{style: "label"}) one: string`, "/foo/{.one}"],
+      [`@path(#{style: "fragment"}) one: string`, "/foo/{#one}"],
+      [`@path(#{style: "path"}) one: string`, "/foo/{/one}"],
+      ["@path(#{allowReserved: true, explode: true}) one: string", "/foo/{+one*}"],
+      ["@query one: string", "/foo{?one}"],
+      // cspell:ignore Atwo
+      [`@query("one:two") one: string`, "/foo{?one%3Atwo}"],
+    ])("%s -> %s", async (param, expectedUri) => {
+      const op = await getOp(`@route("/foo") interface Test {@autoRoute op foo(${param}): void;}`);
+      expect(op.uriTemplate).toEqual(expectedUri);
+    });
+  });
+});

packages/samples/test/output/grpc-library-example/@typespec/openapi3/openapi.yaml

@@ -270,6 +270,7 @@ components:
       schema:
         type: integer
         format: int32
+      explode: false
     ListRequestBase.page_token:
       name: page_token
       in: query
@@ -281,6 +282,7 @@ components:
         returned from the previous call to `ListShelves` method.
       schema:
         type: string
+      explode: false
     MergeShelvesRequest.name:
       name: name
       in: path

packages/samples/test/output/nullable/@typespec/openapi3/openapi.yaml

@@ -14,6 +14,7 @@ paths:
           schema:
             type: string
             nullable: true
+          explode: false
       responses:
         '200':
           description: The request has succeeded.

packages/samples/test/output/optional/@typespec/openapi3/openapi.yaml

@@ -14,6 +14,7 @@ paths:
           schema:
             type: string
             default: defaultQueryString
+          explode: false
       responses:
         '200':
           description: The request has succeeded.

packages/samples/test/output/param-decorators/@typespec/openapi3/openapi.yaml

@@ -23,6 +23,7 @@ paths:
             format: int32
             minimum: 0
             maximum: 10
+          explode: false
       responses:
         '200':
           description: The request has succeeded.

packages/samples/test/output/petstore/@typespec/openapi3/openapi.yaml

@@ -15,6 +15,7 @@ paths:
           required: false
           schema:
             type: string
+          explode: false
       responses:
         '200':
           description: The request has succeeded.
@@ -103,6 +104,7 @@ paths:
           required: true
           schema:
             type: string
+          explode: false
       responses:
         '200':
           description: The request has succeeded.

packages/samples/test/output/rest/petstore/@typespec/openapi3/openapi.yaml

@@ -459,6 +459,7 @@ paths:
           required: true
           schema:
             type: string
+          explode: false
       responses:
         '200':
           description: The request has succeeded.

packages/samples/test/output/visibility/@typespec/openapi3/openapi.yaml

@@ -86,7 +86,6 @@ paths:
             type: array
             items:
               type: string
-          explode: true
       responses:
         '200':
           description: The request has succeeded.