@grafana/openapi-to-k6 0.2.6 → 0.3.1

package/examples/simple_post_request_schema/single/exampleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * 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
@@ -14,14 +14,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
 }
 
 /**
@@ -35,18 +35,18 @@ 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
 }
 
 /**
@@ -61,6 +61,8 @@ export class ExampleAPIClient {
     commonRequestParameters?: Params
   }) {
     this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+
+    this.commonRequestParameters = clientOptions.commonRequestParameters || {}
   }
 
   /**
@@ -86,8 +88,8 @@ export class ExampleAPIClient {
       {
         ...mergedRequestParameters,
         headers: {
-          'Content-Type': 'application/json',
           ...mergedRequestParameters?.headers,
+          'Content-Type': 'application/json',
         },
       }
     )

package/examples/simple_post_request_schema/single/k6-script.sample.ts

@@ -1,13 +1,27 @@
 import { ExampleAPIClient } from './exampleAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new ExampleAPIClient({ baseUrl })
+const exampleAPIClient = new ExampleAPIClient({ baseUrl })
 
 export default function () {
+  let createExampleDataBody
+
   /**
    * Create example data
    */
-  const createExampleDataResponseData = client.createExampleData(
+  createExampleDataBody = {
+    name: 'John Doe',
+    age: '25',
+    isActive: 'true',
+    tags: 'tag1,tag2',
+    date: '2024-01-01',
+    meta: {
+      createdBy: 'John Doe',
+      updatedBy: 'Jane Doe',
+    },
+  }
+
+  const createExampleDataResponseData = exampleAPIClient.createExampleData(
     createExampleDataBody
   )
 }

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

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * 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.2.6
+ * 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/split/k6-script.sample.ts

@@ -1,13 +1,27 @@
 import { ExampleAPIClient } from './exampleAPI.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new ExampleAPIClient({ baseUrl })
+const exampleAPIClient = new ExampleAPIClient({ baseUrl })
 
 export default function () {
+  let createExampleDataBody
+
   /**
    * Create example data
    */
-  const createExampleDataResponseData = client.createExampleData(
+  createExampleDataBody = {
+    name: 'John Doe',
+    age: '25',
+    isActive: 'true',
+    tags: 'tag1,tag2',
+    date: '2024-01-01',
+    meta: {
+      createdBy: 'John Doe',
+      updatedBy: 'Jane Doe',
+    },
+  }
+
+  const createExampleDataResponseData = exampleAPIClient.createExampleData(
     createExampleDataBody
   )
 }

package/examples/simple_post_request_schema/tags/default.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.6
+ * 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.2.6
+ * 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/tags/k6-script.sample.ts

@@ -1,13 +1,27 @@
-import { ExampleAPIClient } from './exampleAPI.ts'
+import { DefaultClient } from './default.ts'
 
 const baseUrl = '<BASE_URL>'
-const client = new ExampleAPIClient({ baseUrl })
+const defaultClient = new DefaultClient({ baseUrl })
 
 export default function () {
+  let createExampleDataBody
+
   /**
    * Create example data
    */
-  const createExampleDataResponseData = client.createExampleData(
+  createExampleDataBody = {
+    name: 'John Doe',
+    age: '25',
+    isActive: 'true',
+    tags: 'tag1,tag2',
+    date: '2024-01-01',
+    meta: {
+      createdBy: 'John Doe',
+      updatedBy: 'Jane Doe',
+    },
+  }
+
+  const createExampleDataResponseData = defaultClient.createExampleData(
     createExampleDataBody
   )
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/openapi-to-k6",
-  "version": "0.2.6",
+  "version": "0.3.1",
   "description": "A CLI tool to generate helper modules for K6 from OpenAPI schema",
   "main": "dist/cli.js",
   "bin": {
@@ -9,6 +9,7 @@
   "scripts": {
     "build": "tsc",
     "dev": "DISABLE_ANALYTICS=true ts-node src/cli.ts",
+    "dev:inspect": "DISABLE_ANALYTICS=true node --inspect-brk --require ts-node/register src/cli.ts",
     "test": "vitest run --coverage",
     "lint": "eslint --ext .ts,.tsx .",
     "lint:fix": "eslint --ext .ts,.tsx . --fix",
@@ -20,13 +21,14 @@
   "repository": "http://github.com/grafana/openapi-to-k6",
   "license": "AGPL-3.0",
   "dependencies": {
+    "@faker-js/faker": "^9.2.0",
     "@types/k6": "^0.54.0",
     "axios": "^1.7.7",
     "chalk": "^4.1.2",
     "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"
   },
@@ -45,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/constants.ts

@@ -2,17 +2,21 @@ export const DEFAULT_SCHEMA_TITLE = 'K6Client'
 
 export const SAMPLE_K6_SCRIPT_FILE_NAME = 'k6-script.sample.ts'
 export const K6_SCRIPT_TEMPLATE = `
-import { {{clientFunctionName}} } from '{{clientPath}}'
+{{{importStatements}}}
 
 const baseUrl = '<BASE_URL>';
-const client = new {{clientFunctionName}}({ baseUrl })
+{{{clientInitializationStatement}}}
+
 
 export default function () {
+    {{{this.variableDefinition}}}
+
     {{#each clientFunctionsList}}
     /**
      * {{this.summary}}
      */
-    const {{this.operationName}}ResponseData = client.{{this.operationName}}({{this.requiredParametersString}});
+    {{{this.exampleValues}}}
+    const {{this.operationName}}ResponseData = {{clientObjectName}}.{{this.operationName}}({{this.requiredParametersString}});
 
     {{/each}}
 }

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

@@ -1,6 +1,5 @@
 import {
   ClientDependenciesBuilder,
-  ClientExtraFilesBuilder,
   ClientFooterBuilder,
   ClientGeneratorsBuilder,
   ClientHeaderBuilder,
@@ -17,17 +16,9 @@ import {
   sanitize,
   toObjectString,
 } from '@orval/core'
-import Handlebars from 'handlebars'
-import path from 'path'
-import {
-  DEFAULT_SCHEMA_TITLE,
-  K6_SCRIPT_TEMPLATE,
-  SAMPLE_K6_SCRIPT_FILE_NAME,
-} from '../constants'
-import { getDirectoryForPath, getGeneratedClientPath } from '../helper'
-import { logger } from '../logger'
+import { DEFAULT_SCHEMA_TITLE } from '../constants'
 import { AnalyticsData } from '../type'
-
+import { k6ScriptBuilder } from './k6ScriptBuilder'
 /**
  * In case the supplied schema does not have a title set, it will set the default title to ensure
  * proper client generation
@@ -111,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,`
@@ -124,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
   }
 
@@ -260,7 +252,7 @@ const generateK6Implementation = (
   `
 }
 
-const generateTitle: ClientTitleBuilder = (title) => {
+export const generateTitle: ClientTitleBuilder = (title) => {
   const sanTitle = sanitize(title || DEFAULT_SCHEMA_TITLE)
   return `${pascal(sanTitle)}Client`
 }
@@ -279,6 +271,7 @@ const generateK6Header: ClientHeaderBuilder = ({ title }) => {
     commonRequestParameters?: Params
 }) {
        this.cleanBaseUrl = clientOptions.baseUrl.replace(/\\/+$/, '');\n
+       this.commonRequestParameters = clientOptions.commonRequestParameters || {};
       }\n
 `
 }
@@ -295,66 +288,6 @@ const generateFooter: ClientFooterBuilder = () => {
   return footer
 }
 
-const k6ScriptBuilder: ClientExtraFilesBuilder = async (
-  verbOptions,
-  output,
-  context
-) => {
-  const schemaTitle =
-    context.specs[context.specKey]?.info.title || DEFAULT_SCHEMA_TITLE
-  const {
-    path: pathOfGeneratedClient,
-    filename,
-    extension,
-  } = await getGeneratedClientPath(output.target!, schemaTitle)
-  const directoryPath = getDirectoryForPath(pathOfGeneratedClient)
-  const generateScriptPath = path.join(
-    directoryPath,
-    SAMPLE_K6_SCRIPT_FILE_NAME
-  )
-
-  logger.debug(
-    `k6ScriptBuilder ~ Generating sample K6 Script\n${JSON.stringify(
-      {
-        pathOfGeneratedClient,
-        filename,
-        extension,
-        schemaTitle,
-        directoryPath,
-        generateScriptPath,
-      },
-      null,
-      2
-    )}`
-  )
-
-  const clientFunctionsList = []
-
-  for (const verbOption of Object.values(verbOptions)) {
-    const { operationName, summary, props } = verbOption
-    const requiredProps = props.filter((prop) => prop.required)
-    clientFunctionsList.push({
-      operationName,
-      summary,
-      requiredParametersString: toObjectString(requiredProps, 'name'),
-    })
-  }
-
-  const scriptContentData = {
-    clientFunctionName: generateTitle(schemaTitle),
-    clientPath: `./${filename}${extension}`,
-    clientFunctionsList,
-  }
-  const template = Handlebars.compile(K6_SCRIPT_TEMPLATE)
-
-  return [
-    {
-      path: generateScriptPath,
-      content: template(scriptContentData),
-    },
-  ]
-}
-
 function getK6Client(analyticsData?: AnalyticsData) {
   return function (
     verbOptions: GeneratorVerbOptions,