@grafana/openapi-to-k6 0.1.2 → 0.2.0

package/examples/simple_post_request_schema/split/exampleAPI.ts

@@ -0,0 +1,99 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Example API
+ * API with all formats of data in the POST request body
+ * OpenAPI spec version: 1.0.0
+ */
+import { URL } from 'https://jslib.k6.io/url/1.0.0/index.js'
+import http from 'k6/http'
+import type { Params, Response } from 'k6/http'
+import type {
+  CreateExampleData201,
+  CreateExampleDataBody,
+} from './exampleAPI.schemas'
+
+/**
+ * This is the base client to use for interacting with the API.
+ */
+export class ExampleAPIClient {
+  private cleanBaseUrl: string
+  private commonRequestParameters: Params
+
+  constructor(clientOptions: {
+    baseUrl: string
+    commonRequestParameters?: Params
+  }) {
+    this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+  }
+
+  /**
+   * This endpoint demonstrates the use of various data formats in the input body
+   * @summary Create example data
+   */
+  createExampleData(
+    createExampleDataBody: CreateExampleDataBody,
+    requestParameters?: Params
+  ): {
+    response: Response
+    data: CreateExampleData201
+  } {
+    const url = new URL(this.cleanBaseUrl + `/example`)
+    const mergedRequestParameters = this._mergeRequestParameters(
+      requestParameters || {},
+      this.commonRequestParameters
+    )
+    const response = http.request(
+      'POST',
+      url.toString(),
+      JSON.stringify(createExampleDataBody),
+      {
+        ...mergedRequestParameters,
+        headers: {
+          'Content-Type': 'application/json',
+          ...mergedRequestParameters?.headers,
+        },
+      }
+    )
+    let data
+
+    try {
+      data = response.json()
+    } catch {
+      data = response.body
+    }
+    return {
+      response,
+      data,
+    }
+  }
+
+  /**
+   * Merges the provided request parameters with default parameters for the client.
+   *
+   * @param {Params} requestParameters - The parameters provided specifically for the request
+   * @param {Params} commonRequestParameters - Common parameters for all requests
+   * @returns {Params} - The merged parameters
+   */
+  private _mergeRequestParameters(
+    requestParameters?: Params,
+    commonRequestParameters?: Params
+  ): Params {
+    return {
+      ...commonRequestParameters, // Default to common parameters
+      ...requestParameters, // Override with request-specific parameters
+      headers: {
+        ...(commonRequestParameters?.headers || {}), // Ensure headers are defined
+        ...(requestParameters?.headers || {}),
+      },
+      cookies: {
+        ...(commonRequestParameters?.cookies || {}), // Ensure cookies are defined
+        ...(requestParameters?.cookies || {}),
+      },
+      tags: {
+        ...(commonRequestParameters?.tags || {}), // Ensure tags are defined
+        ...(requestParameters?.tags || {}),
+      },
+    }
+  }
+}

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

@@ -0,0 +1,13 @@
+import { ExampleAPIClient } from './exampleAPI.ts'
+
+const baseUrl = '<BASE_URL>'
+const client = new ExampleAPIClient({ baseUrl })
+
+export default function () {
+  /**
+   * Create example data
+   */
+  const createExampleDataResponseData = client.createExampleData(
+    createExampleDataBody
+  )
+}

package/examples/simple_post_request_schema/tags/default.ts

@@ -0,0 +1,99 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Example API
+ * API with all formats of data in the POST request body
+ * OpenAPI spec version: 1.0.0
+ */
+import { URL } from 'https://jslib.k6.io/url/1.0.0/index.js'
+import http from 'k6/http'
+import type { Params, Response } from 'k6/http'
+import type {
+  CreateExampleData201,
+  CreateExampleDataBody,
+} from './exampleAPI.schemas'
+
+/**
+ * This is the base client to use for interacting with the API.
+ */
+export class DefaultClient {
+  private cleanBaseUrl: string
+  private commonRequestParameters: Params
+
+  constructor(clientOptions: {
+    baseUrl: string
+    commonRequestParameters?: Params
+  }) {
+    this.cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+  }
+
+  /**
+   * This endpoint demonstrates the use of various data formats in the input body
+   * @summary Create example data
+   */
+  createExampleData(
+    createExampleDataBody: CreateExampleDataBody,
+    requestParameters?: Params
+  ): {
+    response: Response
+    data: CreateExampleData201
+  } {
+    const url = new URL(this.cleanBaseUrl + `/example`)
+    const mergedRequestParameters = this._mergeRequestParameters(
+      requestParameters || {},
+      this.commonRequestParameters
+    )
+    const response = http.request(
+      'POST',
+      url.toString(),
+      JSON.stringify(createExampleDataBody),
+      {
+        ...mergedRequestParameters,
+        headers: {
+          'Content-Type': 'application/json',
+          ...mergedRequestParameters?.headers,
+        },
+      }
+    )
+    let data
+
+    try {
+      data = response.json()
+    } catch {
+      data = response.body
+    }
+    return {
+      response,
+      data,
+    }
+  }
+
+  /**
+   * Merges the provided request parameters with default parameters for the client.
+   *
+   * @param {Params} requestParameters - The parameters provided specifically for the request
+   * @param {Params} commonRequestParameters - Common parameters for all requests
+   * @returns {Params} - The merged parameters
+   */
+  private _mergeRequestParameters(
+    requestParameters?: Params,
+    commonRequestParameters?: Params
+  ): Params {
+    return {
+      ...commonRequestParameters, // Default to common parameters
+      ...requestParameters, // Override with request-specific parameters
+      headers: {
+        ...(commonRequestParameters?.headers || {}), // Ensure headers are defined
+        ...(requestParameters?.headers || {}),
+      },
+      cookies: {
+        ...(commonRequestParameters?.cookies || {}), // Ensure cookies are defined
+        ...(requestParameters?.cookies || {}),
+      },
+      tags: {
+        ...(commonRequestParameters?.tags || {}), // Ensure tags are defined
+        ...(requestParameters?.tags || {}),
+      },
+    }
+  }
+}

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

@@ -0,0 +1,47 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.2.0
+ * Do not edit manually.
+ * Example API
+ * API with all formats of data in the POST request body
+ * OpenAPI spec version: 1.0.0
+ */
+export type CreateExampleData201Meta = {
+  createdBy?: string
+  updatedBy?: string
+}
+
+export type CreateExampleData201 = {
+  age?: number
+  date?: string
+  /** The unique ID of the created resource */
+  id?: string
+  isActive?: boolean
+  meta?: CreateExampleData201Meta
+  name?: string
+  tags?: string[]
+}
+
+/**
+ * An object parameter containing metadata
+ */
+export type CreateExampleDataBodyMeta = {
+  /** A string parameter for the creator's name */
+  createdBy?: string
+  /** A string parameter for the updater's name */
+  updatedBy?: string
+}
+
+export type CreateExampleDataBody = {
+  /** 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[]
+}

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

@@ -0,0 +1,13 @@
+import { ExampleAPIClient } from './exampleAPI.ts'
+
+const baseUrl = '<BASE_URL>'
+const client = new ExampleAPIClient({ baseUrl })
+
+export default function () {
+  /**
+   * Create example data
+   */
+  const createExampleDataResponseData = client.createExampleData(
+    createExampleDataBody
+  )
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/openapi-to-k6",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "A CLI tool to generate helper modules for K6 from OpenAPI schema",
   "main": "dist/cli.js",
   "bin": {
@@ -13,7 +13,7 @@
     "lint": "eslint --ext .ts,.tsx .",
     "lint:fix": "eslint --ext .ts,.tsx . --fix",
     "format": "prettier --ignore-unknown --write \"./**/*\"",
-    "update-examples": "for dir in ./examples/*/; do (npm run dev -- \"$dir/schema.json\" \"$dir\"); done",
+    "update-examples": "for dir in ./examples/*/; do (npm run dev -- \"$dir/schema.json\" \"$dir/single/\" -m single && npm run dev -- \"$dir/schema.json\" \"$dir/split/\" -m split && npm run dev -- \"$dir/schema.json\" \"$dir/tags/\" -m tags); done",
     "prepare": "husky"
   },
   "author": "",

package/src/cli.ts

@@ -1,8 +1,9 @@
 #!/usr/bin/env node
 
 import chalk from 'chalk'
-import { Command } from 'commander'
+import { Command, InvalidArgumentError } from 'commander'
 import { generateDefaultAnalyticsData, reportUsageAnalytics } from './analytics'
+import { Mode } from './constants'
 import generateK6SDK from './generator'
 import { getPackageDetails } from './helper'
 import { logger } from './logger'
@@ -11,11 +12,27 @@ import { AnalyticsData, GenerateK6SDKOptions } from './type'
 const program = new Command()
 const packageDetails = getPackageDetails()
 
+/**
+ * Validate that the mode argument is one of the supported modes.
+ *
+ * @param {string} value - The mode value to validate
+ * @return {Mode} - The validated mode value
+ */
+function validateMode(value: string): Mode {
+  if (!Object.values(Mode).includes(value as Mode)) {
+    throw new InvalidArgumentError(
+      `Supported modes: ${Object.values(Mode).join(', ')}`
+    )
+  }
+  return value as Mode
+}
+
 async function generateSDK({
   openApiPath,
   outputDir,
   shouldGenerateSampleK6Script,
   analyticsData,
+  mode,
 }: GenerateK6SDKOptions) {
   logger.logMessage('Generating TypeScript client for k6...\n')
   logger.logMessage(`OpenAPI schema: ${openApiPath}`)
@@ -26,6 +43,7 @@ async function generateSDK({
     outputDir,
     shouldGenerateSampleK6Script,
     analyticsData,
+    mode,
   })
 
   if (shouldGenerateSampleK6Script) {
@@ -44,8 +62,14 @@ program
   .version(packageDetails.version)
   .argument('<openApiPath>', 'Path or URL for the OpenAPI schema file')
   .argument('<outputDir>', 'Directory where the SDK should be generated')
+  .option(
+    '-m, --mode <string>',
+    `mode to use for generating the client. Valid values - ${Object.values(Mode).join(', ')}`,
+    validateMode,
+    Mode.SINGLE
+  )
   .option('-v, --verbose', 'enable verbose mode to show debug logs')
-  .option('--no-sample-script', 'disable generating sample k6 script')
+  .option('--disable-sample-script', 'disable generating sample k6 script')
   .option('--disable-analytics', 'disable anonymous usage data collection')
   .action(
     async (
@@ -53,6 +77,7 @@ program
       outputDir,
       options: {
         verbose?: boolean
+        mode: Mode
         disableAnalytics?: boolean
         disableSampleScript?: boolean
       }
@@ -86,6 +111,7 @@ program
           outputDir,
           shouldGenerateSampleK6Script: !shouldDisableSampleScript,
           analyticsData,
+          mode: options.mode,
         })
       } catch (error) {
         logger.error('Failed to generate SDK:')

package/src/constants.ts

@@ -5,7 +5,7 @@ export const K6_SCRIPT_TEMPLATE = `
 import { {{clientFunctionName}} } from '{{clientPath}}'
 
 const baseUrl = '<BASE_URL>';
-const client = {{clientFunctionName}}({ baseUrl })
+const client = new {{clientFunctionName}}({ baseUrl })
 
 export default function () {
     {{#each clientFunctionsList}}
@@ -17,3 +17,9 @@ export default function () {
     {{/each}}
 }
 `
+
+export enum Mode {
+  SINGLE = 'single',
+  SPLIT = 'split',
+  TAGS = 'tags',
+}

package/src/{generator.ts → generator/index.ts}

@@ -2,15 +2,15 @@ import fs from 'fs'
 import { InfoObject } from 'openapi3-ts/oas30'
 import orval from 'orval'
 import path from 'path'
-import { DEFAULT_SCHEMA_TITLE } from './constants'
+import { DEFAULT_SCHEMA_TITLE } from '../constants'
 import {
   formatFileWithPrettier,
   getPackageDetails,
   OutputOverrider,
-} from './helper'
-import { getK6ClientBuilder } from './k6SdkClient'
-import { logger } from './logger'
-import { GenerateK6SDKOptions, SchemaDetails } from './type'
+} from '../helper'
+import { logger } from '../logger'
+import { GenerateK6SDKOptions } from '../type'
+import { getK6ClientBuilder } from './k6Client'
 
 const outputOverrider = OutputOverrider.getInstance()
 const packageDetails = getPackageDetails()
@@ -49,11 +49,8 @@ export default async ({
   outputDir,
   shouldGenerateSampleK6Script,
   analyticsData,
+  mode,
 }: GenerateK6SDKOptions) => {
-  const schemaDetails: SchemaDetails = {
-    title: '',
-  }
-
   /**
    * Note!
    * 1. override.requestOptions is not supported for the custom K6 client
@@ -64,13 +61,9 @@ export default async ({
       input: openApiPath,
       output: {
         target: outputDir,
-        mode: 'single',
+        mode: mode,
         client: () =>
-          getK6ClientBuilder(
-            schemaDetails,
-            shouldGenerateSampleK6Script,
-            analyticsData
-          ),
+          getK6ClientBuilder(shouldGenerateSampleK6Script, analyticsData),
         override: {
           header: generatedFileHeaderGenerator,
         },
@@ -81,10 +74,4 @@ export default async ({
       },
     })
   })
-
-  if (!schemaDetails.title) {
-    logger.warning(
-      'Could not find schema title in the OpenAPI spec. Please provide a `title` in the schema in `info` block to generate proper file names'
-    )
-  }
 }