@grafana/openapi-to-k6 0.2.5 → 0.3.0

package/examples/simple_post_request_schema/schema.json

@@ -20,39 +20,46 @@
                 "properties": {
                   "name": {
                     "type": "string",
-                    "description": "A string parameter"
+                    "description": "A string parameter",
+                    "example": "John Doe"
                   },
                   "age": {
                     "type": "integer",
                     "format": "int32",
-                    "description": "An integer parameter"
+                    "description": "An integer parameter",
+                    "example": 25
                   },
                   "isActive": {
                     "type": "boolean",
-                    "description": "A boolean parameter"
+                    "description": "A boolean parameter",
+                    "example": true
                   },
                   "tags": {
                     "type": "array",
                     "items": {
                       "type": "string"
                     },
-                    "description": "An array of strings"
+                    "description": "An array of strings",
+                    "example": ["tag1", "tag2"]
                   },
                   "date": {
                     "type": "string",
                     "format": "date",
-                    "description": "A date parameter in YYYY-MM-DD format"
+                    "description": "A date parameter in YYYY-MM-DD format",
+                    "example": "2024-01-01"
                   },
                   "meta": {
                     "type": "object",
                     "properties": {
                       "createdBy": {
                         "type": "string",
-                        "description": "A string parameter for the creator's name"
+                        "description": "A string parameter for the creator's name",
+                        "example": "John Doe"
                       },
                       "updatedBy": {
                         "type": "string",
-                        "description": "A string parameter for the updater's name"
+                        "description": "A string parameter for the updater's name",
+                        "example": "Jane Doe"
                       }
                     },
                     "description": "An object parameter containing metadata"
@@ -77,36 +84,44 @@
                   "properties": {
                     "id": {
                       "type": "string",
-                      "description": "The unique ID of the created resource"
+                      "description": "The unique ID of the created resource",
+                      "example": "12345"
                     },
                     "name": {
-                      "type": "string"
+                      "type": "string",
+                      "example": "John Doe"
                     },
                     "age": {
                       "type": "integer",
-                      "format": "int32"
+                      "format": "int32",
+                      "example": 25
                     },
                     "isActive": {
-                      "type": "boolean"
+                      "type": "boolean",
+                      "example": true
                     },
                     "tags": {
                       "type": "array",
                       "items": {
-                        "type": "string"
+                        "type": "string",
+                        "example": ["tag1", "tag2"]
                       }
                     },
                     "date": {
                       "type": "string",
-                      "format": "date"
+                      "format": "date",
+                      "example": "2024-01-01"
                     },
                     "meta": {
                       "type": "object",
                       "properties": {
                         "createdBy": {
-                          "type": "string"
+                          "type": "string",
+                          "example": "John Doe"
                         },
                         "updatedBy": {
-                          "type": "string"
+                          "type": "string",
+                          "example": "Jane Doe"
                         }
                       }
                     }

package/examples/simple_post_request_schema/single/exampleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body

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.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body

package/examples/simple_post_request_schema/split/exampleAPI.ts

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body

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.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body

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

@@ -1,5 +1,5 @@
 /**
- * Automatically generated by @grafana/openapi-to-k6: 0.2.5
+ * Automatically generated by @grafana/openapi-to-k6: 0.3.0
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body

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.5",
+  "version": "0.3.0",
   "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,6 +21,7 @@
   "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",

package/src/cli.ts

@@ -4,6 +4,7 @@ import chalk from 'chalk'
 import { Command, InvalidArgumentError } from 'commander'
 import { generateDefaultAnalyticsData, reportUsageAnalytics } from './analytics'
 import { Mode } from './constants'
+import { NoFilesGeneratedError } from './errors'
 import generateK6SDK from './generator'
 import { getPackageDetails } from './helper'
 import { logger } from './logger'
@@ -33,10 +34,21 @@ async function generateSDK({
   shouldGenerateSampleK6Script,
   analyticsData,
   mode,
+  tags,
 }: GenerateK6SDKOptions) {
-  logger.logMessage('Generating TypeScript client for k6...\n')
-  logger.logMessage(`OpenAPI schema: ${openApiPath}`)
-  logger.logMessage(`Output: ${outputDir}\n`)
+  logger.logMessage(
+    'Generating TypeScript client for k6...\n' +
+      'OpenAPI schema: ' +
+      chalk.cyan(openApiPath) +
+      '\n' +
+      'Output: ' +
+      chalk.cyan(outputDir) +
+      '\n' +
+      (tags?.length
+        ? 'Filtering by tag(s): ' + chalk.cyan(tags.join(', '))
+        : '') +
+      '\n'
+  )
 
   await generateK6SDK({
     openApiPath,
@@ -44,16 +56,13 @@ async function generateSDK({
     shouldGenerateSampleK6Script,
     analyticsData,
     mode,
+    tags,
   })
 
-  if (shouldGenerateSampleK6Script) {
-    logger.logMessage(
-      `TypeScript client and sample k6 script generated successfully.`,
-      chalk.green
-    )
-  } else {
-    logger.logMessage(`TypeScript client generated successfully.`, chalk.green)
-  }
+  const message = shouldGenerateSampleK6Script
+    ? 'TypeScript client and sample k6 script generated successfully.'
+    : 'TypeScript client generated successfully.'
+  logger.logMessage(message, chalk.green)
 }
 
 program
@@ -68,6 +77,10 @@ program
     validateMode,
     Mode.SINGLE
   )
+  .option(
+    '--only-tags <filters...>',
+    'list of tags to filter on. Generated client will only include operations with these tags'
+  )
   .option('-v, --verbose', 'enable verbose mode to show debug logs')
   .option('--include-sample-script', 'generate a sample k6 script')
   .option('--disable-analytics', 'disable anonymous usage data collection')
@@ -78,6 +91,7 @@ program
       options: {
         verbose?: boolean
         mode: Mode
+        onlyTags?: (string | RegExp)[]
         disableAnalytics?: boolean
         includeSampleScript?: boolean
       }
@@ -112,16 +126,20 @@ program
           shouldGenerateSampleK6Script: !!options.includeSampleScript,
           analyticsData,
           mode: options.mode,
+          tags: options.onlyTags,
         })
       } catch (error) {
-        logger.error('Failed to generate SDK:')
-        console.error(error)
+        if (error instanceof NoFilesGeneratedError) {
+          logger.logMessage(error.message, chalk.yellow)
+        } else {
+          logger.error('Failed to generate SDK:')
+          console.error(error)
+        }
       }
 
       if (!shouldDisableAnalytics && analyticsData) {
         logger.debug('Reporting following usage analytics data:')
         logger.debug(JSON.stringify(analyticsData, null, 2))
-
         await reportUsageAnalytics(analyticsData)
       }
     }

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/errors.ts

@@ -0,0 +1,6 @@
+export class NoFilesGeneratedError extends Error {
+  constructor(message: string = 'No files were generated') {
+    super(message)
+    this.name = 'NoFilesGeneratedError'
+  }
+}

package/src/generator/index.ts

@@ -3,9 +3,11 @@ import { InfoObject } from 'openapi3-ts/oas30'
 import orval from 'orval'
 import path from 'path'
 import { DEFAULT_SCHEMA_TITLE } from '../constants'
+import { NoFilesGeneratedError } from '../errors'
 import {
   formatFileWithPrettier,
   getPackageDetails,
+  hasOnlyComments,
   OutputOverrider,
 } from '../helper'
 import { logger } from '../logger'
@@ -26,7 +28,32 @@ const generatedFileHeaderGenerator = (info: InfoObject) => {
 }
 
 const afterAllFilesWriteHandler = async (filePaths: string[]) => {
+  const removeSingleFile = (filePath: string) => {
+    try {
+      fs.unlinkSync(filePath)
+    } catch (error) {
+      // This is non-critical, so we just log it
+      logger.debug(
+        `afterAllFilesWriteHandler ~ Error deleting file ${filePath}: ${error}`
+      )
+    }
+  }
+  const emptyFileList: string[] = []
+
   for (const filePath of filePaths) {
+    // There is a bug in the orval library which generates empty files when tags filter is applied
+    // and no matching endpoints are found and used mode is split or single.
+    // It generates the file with only the header comment.
+    // Hence, we manually remove those empty files.
+    // Issue link - https://github.com/orval-labs/orval/issues/1691
+
+    if (hasOnlyComments(fs.readFileSync(filePath, 'utf-8'))) {
+      emptyFileList.push(filePath)
+      // Delete the file
+      removeSingleFile(filePath)
+      continue
+    }
+
     await formatFileWithPrettier(filePath)
 
     const fileName = path.basename(filePath)
@@ -42,6 +69,28 @@ const afterAllFilesWriteHandler = async (filePaths: string[]) => {
       fs.renameSync(filePath, newPath)
     }
   }
+
+  if (emptyFileList.length > 0) {
+    logger.debug(
+      `afterAllFilesWriteHandler ~ The following files were empty and removed: ${emptyFileList.join(
+        ', '
+      )}`
+    )
+  }
+
+  // Return the list of generated file paths excluding the empty files
+  const filteredFilePaths = filePaths.filter(
+    (filePath) => !emptyFileList.includes(filePath)
+  )
+
+  // Check if all the filtered file path end with `.schemas.ts`
+  if (filteredFilePaths.every((filePath) => filePath.endsWith('.schemas.ts'))) {
+    // If yes we should remove them as only schemas files is not needed
+    filteredFilePaths.map(removeSingleFile)
+    return []
+  }
+
+  return filteredFilePaths
 }
 
 export default async ({
@@ -50,15 +99,20 @@ export default async ({
   shouldGenerateSampleK6Script,
   analyticsData,
   mode,
+  tags,
 }: GenerateK6SDKOptions) => {
   /**
    * Note!
    * 1. override.requestOptions is not supported for the custom K6 client
    * 2. override.mutator is not supported for the custom K6 client
    */
+  const generatedFilePaths: string[] = []
   await outputOverrider.redirectOutputToNullStream(async () => {
     await orval({
-      input: openApiPath,
+      input: {
+        target: openApiPath,
+        filters: { tags: tags && tags.length > 0 ? tags : undefined },
+      },
       output: {
         target: outputDir,
         mode: mode,
@@ -70,8 +124,19 @@ export default async ({
         headers: true,
       },
       hooks: {
-        afterAllFilesWrite: afterAllFilesWriteHandler,
+        afterAllFilesWrite: async (filePaths: string[]) => {
+          const filteredFilePaths = await afterAllFilesWriteHandler(filePaths)
+          generatedFilePaths.push(...filteredFilePaths)
+        },
       },
     })
   })
+
+  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}`)
+  }
 }

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
@@ -260,7 +251,7 @@ const generateK6Implementation = (
   `
 }
 
-const generateTitle: ClientTitleBuilder = (title) => {
+export const generateTitle: ClientTitleBuilder = (title) => {
   const sanTitle = sanitize(title || DEFAULT_SCHEMA_TITLE)
   return `${pascal(sanTitle)}Client`
 }
@@ -295,66 +286,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,