fix(cli): execute all tests; fix broken tests

Author: freakyfelt

packages/cli/examples/widgets.oas.json

@@ -106,7 +106,7 @@
         }
       }
     },
-    "/mutations/createWidget": {
+    "/v1/widgets": {
       "post": {
         "operationId": "createWidget",
         "description": "Create a widget",
@@ -115,27 +115,14 @@
           "content": {
             "application/json": {
               "schema": {
-                "type": "object",
-                "properties": {
-                  "name": {
-                    "type": "string",
-                    "description": "The name of the widget"
-                  },
-                  "status": {
-                    "$ref": "#/components/schemas/WidgetStatus"
-                  }
-                },
-                "required": [
-                  "name",
-                  "status"
-                ]
+                "$ref": "#/components/schemas/CreateWidgetInput"
               }
             }
           }
         },
         "responses": {
-          "200": {
-            "description": "OK",
+          "201": {
+            "description": "Widget created successfully",
             "content": {
               "application/json": {
                 "schema": {
@@ -165,22 +152,14 @@
           "content": {
             "application/json": {
               "schema": {
-                "type": "object",
-                "properties": {
-                  "id": {
-                    "$ref": "#/components/schemas/WidgetID"
-                  }
-                },
-                "required": [
-                  "id"
-                ]
+                "$ref": "#/components/schemas/DeactivateWidgetInput"
               }
             }
           }
         },
         "responses": {
           "200": {
-            "description": "OK",
+            "description": "Widget successfully deactivated",
             "content": {
               "application/json": {
                 "schema": {

packages/cli/examples/widgets.oas.yaml

@@ -65,7 +65,7 @@ paths:
           $ref: "#/components/responses/InvalidCredentials"
         "403":
           $ref: "#/components/responses/Forbidden"
-  /mutations/createWidget:
+  /v1/widgets:
     post:
       operationId: createWidget
       description: Create a widget
@@ -74,19 +74,10 @@ paths:
         content:
           application/json:
             schema:
-              type: object
-              properties:
-                name:
-                  type: string
-                  description: The name of the widget
-                status:
-                  $ref: "#/components/schemas/WidgetStatus"
-              required:
-                - name
-                - status
+              $ref: "#/components/schemas/CreateWidgetInput"
       responses:
-        "200":
-          description: OK
+        "201":
+          description: Widget created successfully
           content:
             application/json:
               schema:
@@ -106,15 +97,10 @@ paths:
         content:
           application/json:
             schema:
-              type: object
-              properties:
-                id:
-                  $ref: "#/components/schemas/WidgetID"
-              required:
-                - id
+              $ref: "#/components/schemas/DeactivateWidgetInput"
       responses:
         "200":
-          description: OK
+          description: Widget successfully deactivated
           content:
             application/json:
               schema:

packages/cli/examples/widgets.rpc.yaml

@@ -30,9 +30,12 @@ operations:
   mutations:
     createWidget:
       description: Create a widget
+      path: /v1/widgets
       input:
         schema: { $ref: "#/components/schemas/CreateWidgetInput" }
       output:
+        description: Widget created successfully
+        statusCode: 201
         schema: { $ref: "#/components/schemas/Widget" }
       errors:
         400: { $ref: "#/components/responses/BadRequest" }
@@ -43,6 +46,7 @@ operations:
       input:
         schema: { $ref: "#/components/schemas/DeactivateWidgetInput" }
       output:
+        description: Widget successfully deactivated
         schema: { $ref: "#/components/schemas/Widget" }
       errors:
         400: { $ref: "#/components/responses/BadRequest" }

packages/cli/package.json

@@ -33,7 +33,7 @@
   "scripts": {
     "build": "tsup-node src/index.ts",
     "build:check": "tsc --noEmit",
-    "build:examples": "npm run build && npm run build:examples:yaml && npm run build:examples:json",
+    "build:examples": "npm run build:examples:yaml && npm run build:examples:json",
     "build:examples:yaml": "bin/yarpc-cli.mjs -i examples/widgets.rpc.yaml -o examples/widgets.oas.yaml -f yaml",
     "build:examples:json": "bin/yarpc-cli.mjs -i examples/widgets.rpc.yaml -o examples/widgets.oas.json -f json",
     "ci": "npm run build:check && npm run lint:check && npm run test:node && npm run format:check",
@@ -45,7 +45,8 @@
     "lint:check": "eslint . --cache --ext .ts",
     "pretest": "npm run lint && tsc --noEmit",
     "test": "npm run build:check && npm run test:node",
-    "test:node": "node --loader ts-node/esm --test src/*.test.ts",
+    "test:node": "npm run test:only -- src/**/*.test.ts",
+    "test:only": "node --loader ts-node/esm --test",
     "posttest": "npm run format && npm run build:examples"
   },
   "devDependencies": {

packages/cli/src/transformers/document-transformer.test.ts

@@ -172,6 +172,10 @@ test("DocumentTransformer#transform", async (t) => {
 		};
 
 		const actual = await DocumentTransformer.transform(doc, { logger });
-		assert.deepStrictEqual(actual, expected);
+
+		assert.deepStrictEqual(
+			actual.paths?.["/health/deep"],
+			expected.paths["/health/deep"]
+		);
 	});
 });

packages/cli/src/transformers/operation-transformer.test.ts

@@ -66,6 +66,7 @@ test("OperationTransformer#transformMutationOperation", async (t) => {
 				},
 			];
 			const expectedRequestBody = {
+				required: true,
 				content: {
 					"application/json": {
 						schema: {
@@ -173,17 +174,33 @@ test("OperationTransformer#transformQueryOperation", async (t) => {
 				}
 			);
 
-			const expectedResponseLength =
-				Object.keys(listUserWidgetsOAS.responses).length + 1;
-			assert.equal(Object.keys(actual.responses), expectedResponseLength);
-			assert.strictEqual(actual.responses["418"], {
+			const expectedResponseLength = Object.keys(
+				listUserWidgetsOAS.responses
+			).length;
+			assert.equal(
+				Object.keys(actual.responses).length,
+				expectedResponseLength
+			);
+			assert.deepStrictEqual(actual.responses["418"], {
 				description: "I'm a teapot",
 				content: {
-					418: {
-						"application/json": operations.listUserWidgets.output,
-					},
+					"application/json": operations.listUserWidgets.output,
 				},
 			});
 		}
 	);
+
+	await t.test("does not include the path if it was specified", async () => {
+		const actual = await transformer.transformQueryOperation(
+			"listUserWidgets",
+			{
+				...operations.listUserWidgets,
+				path: "/widgets",
+			}
+		);
+
+		console.log({ actual });
+		// @ts-expect-error path should not be included
+		assert.strictEqual(actual.path, undefined);
+	});
 });

packages/cli/src/transformers/operation-transformer.ts

@@ -8,7 +8,6 @@ import {
 	RPCInputObject,
 	RPCOperationObject,
 	RPCOutputObject,
-	ResponseObject,
 	ResponsesObject,
 	isReferenceObject,
 } from "../types/index.js";
@@ -18,10 +17,6 @@ import {
 	transformRPCInputs,
 } from "./parameter-transformer.js";
 
-const DEFAULT_RESPONSE: ResponseObject = {
-	description: "OK",
-};
-
 type TransformerDeps = {
 	resolver: IRefResolver;
 	logger?: Logger;
@@ -100,7 +95,18 @@ export class OperationTransformer {
 			{ operationId, operation, parameterDefaults },
 			`Transforming operation "${operationId}"`
 		);
-		const { description, input, output, errors, ...rest } = operation;
+		const {
+			// eslint-disable-next-line @typescript-eslint/no-unused-vars
+			path: _path,
+			// eslint-disable-next-line @typescript-eslint/no-unused-vars
+			method: _method,
+
+			description,
+			input,
+			output,
+			errors,
+			...rest
+		} = operation;
 
 		let transformedInputs: TransformOutput | undefined;
 		let responses: ResponsesObject | undefined;
@@ -127,7 +133,7 @@ export class OperationTransformer {
 
 		return {
 			operationId,
-			description,
+			...(description ? { description } : {}),
 			...transformedInputs,
 			responses,
 			...rest,
@@ -150,7 +156,12 @@ export class OperationTransformer {
 			? await this.resolver.resolve(schemaOrRef)
 			: schemaOrRef;
 
-		return transformRPCInputs(inputSchema, defaults, parameterOverrides);
+		return transformRPCInputs(
+			schemaOrRef,
+			inputSchema,
+			defaults,
+			parameterOverrides
+		);
 	}
 
 	private transformOperationResponses(
@@ -167,7 +178,7 @@ export class OperationTransformer {
 							"application/json": mediaType,
 						},
 				  }
-				: DEFAULT_RESPONSE;
+				: { description };
 
 		return {
 			[statusCode]: successResponse,

packages/cli/src/transformers/parameter-transformer.ts

@@ -4,6 +4,7 @@ import {
 	RPCParameterLocation,
 	RPCParameterObject,
 	RPCParametersObject,
+	ReferenceObject,
 	SchemaObject,
 	assertObjectTypeSchema,
 } from "../types/index.js";
@@ -59,6 +60,7 @@ export type ParameterDefaults = RPCParameterObject & {
  * @returns
  */
 export function transformRPCInputs(
+	schemaOrRef: SchemaObject | ReferenceObject,
 	inputSchema: SchemaObject,
 	defaults: ParameterDefaults,
 	overrides: RPCParametersObject = {}
@@ -75,7 +77,7 @@ export function transformRPCInputs(
 				required: true,
 				content: {
 					"application/json": {
-						schema: inputSchema,
+						schema: schemaOrRef,
 					},
 				},
 			},