@grafana/openapi-to-k6 0.3.0 → 0.3.1

package/examples/simple_post_request_schema/split/exampleAPI.schemas.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body
@@ -11,14 +11,14 @@ export type CreateExampleData201Meta = {
 }
 
 export type CreateExampleData201 = {
-  age?: number
-  date?: string
   /** The unique ID of the created resource */
   id?: string
-  isActive?: boolean
-  meta?: CreateExampleData201Meta
   name?: string
+  age?: number
+  isActive?: boolean
   tags?: string[]
+  date?: string
+  meta?: CreateExampleData201Meta
 }
 
 /**
@@ -32,16 +32,16 @@ export type CreateExampleDataBodyMeta = {
 }
 
 export type CreateExampleDataBody = {
+  /** A string parameter */
+  name: string
   /** An integer parameter */
   age: number
-  /** A date parameter in YYYY-MM-DD format */
-  date?: string
   /** A boolean parameter */
   isActive: boolean
-  /** An object parameter containing metadata */
-  meta?: CreateExampleDataBodyMeta
-  /** A string parameter */
-  name: string
   /** An array of strings */
   tags?: string[]
+  /** A date parameter in YYYY-MM-DD format */
+  date?: string
+  /** An object parameter containing metadata */
+  meta?: CreateExampleDataBodyMeta
 }

package/examples/simple_post_request_schema/split/exampleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body
@@ -25,6 +25,8 @@ export class ExampleAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -50,8 +52,8 @@ export class ExampleAPIClient {
       {
         ...mergedRequestParameters,
         headers: {
-          'Content-Type': 'application/json',
           ...mergedRequestParameters?.headers,
+          'Content-Type': 'application/json',
         },
       }
     )

package/examples/simple_post_request_schema/tags/default.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body
@@ -25,6 +25,8 @@ export class DefaultClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -50,8 +52,8 @@ export class DefaultClient {
       {
         ...mergedRequestParameters,
         headers: {
-          'Content-Type': 'application/json',
           ...mergedRequestParameters?.headers,
+          'Content-Type': 'application/json',
         },
       }
     )

package/examples/simple_post_request_schema/tags/exampleAPI.schemas.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.3.0
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.1
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body
@@ -11,14 +11,14 @@ export type CreateExampleData201Meta = {
 }
 
 export type CreateExampleData201 = {
-  age?: number
-  date?: string
   /** The unique ID of the created resource */
   id?: string
-  isActive?: boolean
-  meta?: CreateExampleData201Meta
   name?: string
+  age?: number
+  isActive?: boolean
   tags?: string[]
+  date?: string
+  meta?: CreateExampleData201Meta
 }
 
 /**
@@ -32,16 +32,16 @@ export type CreateExampleDataBodyMeta = {
 }
 
 export type CreateExampleDataBody = {
+  /** A string parameter */
+  name: string
   /** An integer parameter */
   age: number
-  /** A date parameter in YYYY-MM-DD format */
-  date?: string
   /** A boolean parameter */
   isActive: boolean
-  /** An object parameter containing metadata */
-  meta?: CreateExampleDataBodyMeta
-  /** A string parameter */
-  name: string
   /** An array of strings */
   tags?: string[]
+  /** A date parameter in YYYY-MM-DD format */
+  date?: string
+  /** An object parameter containing metadata */
+  meta?: CreateExampleDataBodyMeta
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/openapi-to-k6",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "A CLI tool to generate helper modules for K6 from OpenAPI schema",
   "main": "dist/cli.js",
   "bin": {
@@ -28,7 +28,7 @@
     "commander": "^12.1.0",
     "handlebars": "^4.7.8",
     "openapi-typescript": "^7.4.1",
-    "orval": "^7.2.0",
+    "orval": "^7.4.1",
     "prettier": "^3.3.3",
     "uuid": "^10.0.0"
   },
@@ -47,6 +47,7 @@
     "prettier": "^3.3.3",
     "ts-node": "^10.9.2",
     "typescript": "^5.6.2",
+    "vite-tsconfig-paths": "^5.1.4",
     "vitest": "^2.1.3"
   },
   "lint-staged": {

package/src/generator/index.ts

@@ -27,7 +27,10 @@ const generatedFileHeaderGenerator = (info: InfoObject) => {
   ]
 }
 
-const afterAllFilesWriteHandler = async (filePaths: string[]) => {
+const afterAllFilesWriteHandler = async (
+  filePaths: string[],
+  outputOverrider: OutputOverrider
+) => {
   const removeSingleFile = (filePath: string) => {
     try {
       fs.unlinkSync(filePath)
@@ -53,8 +56,13 @@ const afterAllFilesWriteHandler = async (filePaths: string[]) => {
       removeSingleFile(filePath)
       continue
     }
-
-    await formatFileWithPrettier(filePath)
+    try {
+      await formatFileWithPrettier(filePath)
+    } catch (error) {
+      await outputOverrider.temporarilyWriteToStdoutAndStderr(async () => {
+        logger.error(`Error in formatting file ${filePath}: ${error}`)
+      })
+    }
 
     const fileName = path.basename(filePath)
 
@@ -125,7 +133,10 @@ export default async ({
       },
       hooks: {
         afterAllFilesWrite: async (filePaths: string[]) => {
-          const filteredFilePaths = await afterAllFilesWriteHandler(filePaths)
+          const filteredFilePaths = await afterAllFilesWriteHandler(
+            filePaths,
+            outputOverrider
+          )
           generatedFilePaths.push(...filteredFilePaths)
         },
       },
@@ -135,8 +146,10 @@ export default async ({
   if (generatedFilePaths.length === 0) {
     const tagsMessage =
       tags?.length && tags.length > 0
-        ? ` Applied tag filter(s): ${tags.join(', ')}`
-        : ''
-    throw new NoFilesGeneratedError(`No files were generated.${tagsMessage}`)
+        ? ` Applied tag filter(s): ${tags.join(', ')}. `
+        : ' '
+    throw new NoFilesGeneratedError(
+      `No files were generated.${tagsMessage}Try running with --verbose flag to get more details.`
+    )
   }
 }

package/src/generator/k6Client.ts

@@ -102,6 +102,7 @@ const _getRequestParamsValue = ({
   // Expand the headers
   if (body.contentType || headers) {
     let headersValue = `\n       headers: {`
+    headersValue += '\n...mergedRequestParameters?.headers,'
     if (body.contentType) {
       if (body.formData) {
         headersValue += `\n'Content-Type': '${body.contentType}; boundary=' + formData.boundary,`
@@ -115,7 +116,7 @@ const _getRequestParamsValue = ({
       headersValue += `\n...Object.fromEntries(Object.entries(headers || {}).map(([key, value]) => [key, String(value)])),`
     }
 
-    headersValue += `\n...mergedRequestParameters?.headers},`
+    headersValue += `\n},`
     value += headersValue
   }
 
@@ -270,6 +271,7 @@ const generateK6Header: ClientHeaderBuilder = ({ title }) => {
     commonRequestParameters?: Params
 }) {
        this.cleanBaseUrl = clientOptions.baseUrl.replace(/\\/+$/, '');\n
+       this.commonRequestParameters = clientOptions.commonRequestParameters || {};
       }\n
 `
 }

package/src/helper.ts

@@ -123,6 +123,23 @@ export class OutputOverrider {
     process.stdout.write = this.originalStdoutWrite
     process.stderr.write = this.originalStderrWrite
   }
+
+  // Method to temporarily write to stdout and stderr
+  public async temporarilyWriteToStdoutAndStderr(
+    callback: () => Promise<void>
+  ) {
+    const currentStdoutWrite = process.stdout.write
+    const currentStderrWrite = process.stderr.write
+
+    process.stdout.write = this.originalStdoutWrite
+    process.stderr.write = this.originalStderrWrite
+    try {
+      await callback()
+    } finally {
+      process.stdout.write = currentStdoutWrite
+      process.stderr.write = currentStderrWrite
+    }
+  }
 }
 
 /**

package/tests/e2e/single/k6Script.ts

@@ -3,8 +3,15 @@ import { check } from 'k6'
 import { ComprehensiveAPIClient } from './sdk.ts'
 /* eslint-enable import/no-unresolved */
 
+const commonRequestParameters = {
+  headers: {
+    'Only-Common-Header': 'test',
+    'Only-Common-Header-2': 'test-2',
+    'X-Correlation-ID': 'only-common-header-value',
+  },
+}
 const baseUrl = 'http://localhost:3000'
-const client = new ComprehensiveAPIClient({ baseUrl })
+const client = new ComprehensiveAPIClient({ baseUrl, commonRequestParameters })
 
 export const options = {
   thresholds: {
@@ -79,4 +86,50 @@ export default function () {
     id: 'test',
   })
   checkResponseStatus(getItemsHeaderResponseData.response, 200)
+
+  const requestParameters = {
+    headers: {
+      'Only-Common-Header-2': 'test-common-header-2-parameter',
+      'X-Correlation-ID': 'test-request-parameter',
+    },
+  }
+  const getItemsNewMandatoryHeadersResponseData =
+    client.getItemsNewMandatoryHeaders(
+      {
+        itemId: 'test',
+      },
+      {
+        'X-Auth-Token': 'test',
+        'X-Correlation-ID': 'test-function-argument',
+      },
+      requestParameters
+    )
+  checkResponseStatus(getItemsNewMandatoryHeadersResponseData.response, 200)
+
+  const requestHeaders =
+    getItemsNewMandatoryHeadersResponseData.response.request.headers
+  console.log('requestHeaders')
+  console.log(requestHeaders)
+
+  // Validate that the header present only in common request parameters is present in the request
+  check(requestHeaders, {
+    'has only-common-header': (r) => r['Only-Common-Header'][0] === 'test',
+  })
+
+  // Validate that the header present only in the request parameters is present in the request
+  check(requestHeaders, {
+    'has X-Auth-Token': (r) => r['X-Auth-Token'][0] === 'test',
+  })
+
+  // Validate that the header present in the requestParameters takes precedence over the value in common request parameters
+  check(requestHeaders, {
+    'has correct value of Only-Common-Header-2 from request parameters': (r) =>
+      r['Only-Common-Header-2'][0] === 'test-common-header-2-parameter',
+  })
+
+  // Validate that the value of the header present in function arguments takes precedence over the value in common request parameters and request parameters
+  check(requestHeaders, {
+    'has correct value X-Correlation-ID from function arguments': (r) =>
+      r['X-Correlation-Id'][0] === 'test-function-argument',
+  })
 }

package/tests/functional-tests/test-generator/fixtures/basic_parameter_in_ref.json

@@ -0,0 +1,59 @@
+{
+  "openapi_schema": {
+    "openapi": "3.0.0",
+    "info": {
+      "title": "Simple API",
+      "version": "1.0.0"
+    },
+    "paths": {
+      "/example": {
+        "get": {
+          "summary": "Retrieve example data",
+          "parameters": [
+            {
+              "$ref": "#/components/parameters/stackId"
+            }
+          ],
+          "responses": {
+            "200": {
+              "description": "Successful response",
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "type": "object",
+                    "properties": {
+                      "message": {
+                        "type": "string",
+                        "example": "Hello, World!"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "components": {
+      "parameters": {
+        "stackId": {
+          "in": "header",
+          "name": "X-Stack-Id",
+          "schema": {
+            "type": "integer"
+          },
+          "required": true
+        }
+      }
+    }
+  },
+  "expected_sdk": {
+    "fileName": "simpleAPI.ts",
+    "expectedSubstrings": [
+      "export class SimpleAPIClient",
+      "export type StackIdParameter = number;",
+      "export type GetExampleHeaders = { \"X-Stack-Id\": StackIdParameter; };"
+    ]
+  }
+}

package/tests/functional-tests/test-generator/fixtures/form_data_schema.json

@@ -88,7 +88,7 @@
       "export class FormDataAPIClient",
       "const formData = new FormData(); formData.append(\"file\", postUploadBody.file); if (postUploadBody.description !== undefined) { formData.append(\"description\", postUploadBody.description); } formData.append(\"userId\", postUploadBody.userId);",
       "const url = new URL(this.cleanBaseUrl + `/upload`);",
-      "const response = http.request(\"POST\", url.toString(), formData.body(), { ...mergedRequestParameters, headers: { \"Content-Type\": \"multipart/form-data; boundary=\" + formData.boundary, ...mergedRequestParameters?.headers, }, });"
+      "const response = http.request(\"POST\", url.toString(), formData.body(), { ...mergedRequestParameters, headers: { ...mergedRequestParameters?.headers, \"Content-Type\": \"multipart/form-data; boundary=\" + formData.boundary, }, });"
     ]
   }
 }

package/tests/functional-tests/test-generator/fixtures/form_url_encoded_data_schema.json

@@ -87,7 +87,7 @@
     "expectedSubstrings": [
       "export class FormURLEncodedAPIClient",
       "const url = new URL(this.cleanBaseUrl + `/submit-form`);",
-      "const response = http.request( \"POST\", url.toString(), JSON.stringify(postSubmitFormBody), { ...mergedRequestParameters, headers: { \"Content-Type\": \"application/x-www-form-urlencoded\", ...mergedRequestParameters?.headers, }, }, );"
+      "const response = http.request( \"POST\", url.toString(), JSON.stringify(postSubmitFormBody), { ...mergedRequestParameters, headers: { ...mergedRequestParameters?.headers, \"Content-Type\": \"application/x-www-form-urlencoded\", }, }, );"
     ]
   }
 }

package/tests/functional-tests/test-generator/fixtures/headers_schema.json

@@ -152,9 +152,9 @@
     "expectedSubstrings": [
       "export class HeaderDemoAPIClient",
       "getExampleGet( headers?: GetExampleGetHeaders, requestParameters?: Params, ): { response: Response; data: GetExampleGet200; }",
-      "response = http.request(\"GET\", url.toString(), undefined, { ...mergedRequestParameters, headers: { // In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string ...Object.fromEntries( Object.entries(headers || {}).map(([key, value]) => [ key, String(value), ]), ), ...mergedRequestParameters?.headers, }, });",
+      "response = http.request(\"GET\", url.toString(), undefined, { ...mergedRequestParameters, headers: { ...mergedRequestParameters?.headers, // In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string ...Object.fromEntries( Object.entries(headers || {}).map(([key, value]) => [ key, String(value), ]), ), }, });",
       "postExamplePost( postExamplePostBody: PostExamplePostBody, headers: PostExamplePostHeaders, requestParameters?: Params, ): { response: Response; data: void; }",
-      "response = http.request( \"POST\", url.toString(), JSON.stringify(postExamplePostBody), { ...mergedRequestParameters, headers: { \"Content-Type\": \"application/json\", // In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string ...Object.fromEntries( Object.entries(headers || {}).map(([key, value]) => [ key, String(value), ]), ), ...mergedRequestParameters?.headers, }, }, );",
+      "response = http.request( \"POST\", url.toString(), JSON.stringify(postExamplePostBody), { ...mergedRequestParameters, headers: { ...mergedRequestParameters?.headers, \"Content-Type\": \"application/json\", // In the schema, headers can be of any type like number but k6 accepts only strings as headers, hence converting all headers to string ...Object.fromEntries( Object.entries(headers || {}).map(([key, value]) => [ key, String(value), ]), ), }, }, );",
       "getExampleResponseHeaders(requestParameters?: Params): { response: Response; data: GetExampleResponseHeaders200; }",
       "response = http.request( \"GET\", url.toString(), undefined, mergedRequestParameters, );"
     ]

package/tests/functional-tests/test-generator/fixtures/simple_post_request_schema.json

@@ -124,7 +124,7 @@
       "const url = new URL(this.cleanBaseUrl + `/example`);",
       "JSON.stringify(createExampleDataBody),",
       "POST",
-      "export type CreateExampleData201 = { age?: number; date?: string; /** The unique ID of the created resource */ id?: string; isActive?: boolean; meta?: CreateExampleData201Meta; name?: string; tags?: string[];"
+      "export type CreateExampleData201 = { /** The unique ID of the created resource */ id?: string; name?: string; age?: number; isActive?: boolean; tags?: string[]; date?: string; meta?: CreateExampleData201Meta; };"
     ]
   }
 }

package/{vite.config.js → vite.config.mjs}

@@ -1,8 +1,12 @@
 import { defineConfig } from 'vite'
+import tsconfigPaths from 'vite-tsconfig-paths'
 
 export default defineConfig({
+  plugins: [tsconfigPaths()],
   test: {
     environment: 'node',
+    globals: true,
+    include: ['tests/**/*.test.ts'],
     coverage: {
       reporter: ['json', 'text', 'lcov'],
       reportsDirectory: 'coverage',