@grafana/openapi-to-k6 0.2.5 → 0.2.6

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.2.6
  * 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.2.6
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body

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.2.6
  * 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.2.6
  * Do not edit manually.
  * Example API
  * API with all formats of data in the POST request body

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/openapi-to-k6",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "description": "A CLI tool to generate helper modules for K6 from OpenAPI schema",
   "main": "dist/cli.js",
   "bin": {

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

@@ -1,5 +1,7 @@
 import { camel, getFileInfo } from '@orval/core'
 import fs from 'fs'
+import { createSourceFile, ScriptTarget } from 'typescript'
+
 import path from 'path'
 import { format, resolveConfig } from 'prettier'
 import packageJson from '../package.json'
@@ -158,3 +160,41 @@ export function getDirectoryForPath(pathString: string): string {
   // If the path has an extension, it is a file
   return path.dirname(pathString)
 }
+
+/**
+ * Checks if a file contains only comments and whitespace, with no actual code.
+ *
+ * This function uses TypeScript's parser to accurately detect and remove all types
+ * of comments (single-line, multi-line, JSDoc) and whitespace from the input text.
+ * If nothing remains after removing comments and whitespace, then the file is
+ * considered to contain only comments.
+ *
+ * @param fileContent - The string content of the file to check
+ * @returns True if the file contains only comments and whitespace, false if it contains any actual code
+ *
+ * @example
+ * // Returns true
+ * hasOnlyComments('// Just a comment');
+ *
+ * // Returns false
+ * hasOnlyComments('// A comment\nconst x = 1;');
+ */
+export function hasOnlyComments(fileContent: string): boolean {
+  // Create a source file
+  const sourceFile = createSourceFile(
+    'temp.ts',
+    fileContent,
+    ScriptTarget.Latest,
+    true
+  )
+
+  // Remove all comments and whitespace
+  const textWithoutComments = sourceFile
+    .getFullText()
+    .replace(/\/\*[\s\S]*?\*\/|\/\/.*/g, '') // Remove comments
+    .replace(/\s+/g, '') // Remove whitespace
+
+  // If there's any content left after removing comments and whitespace,
+  // then there's actual code
+  return textWithoutComments.length === 0
+}

package/src/type.d.ts

@@ -31,4 +31,5 @@ export interface GenerateK6SDKOptions {
   shouldGenerateSampleK6Script?: boolean
   analyticsData?: AnalyticsData
   mode: Mode
+  tags?: (string | RegExp)[]
 }

package/tests/e2e/schema.json

@@ -251,6 +251,7 @@
     },
     "/items-header": {
       "get": {
+        "tags": ["ItemsHeader"],
         "summary": "Get an item with custom headers",
         "parameters": [
           {

package/tests/e2e/single-tag-filter/k6Script.ts

@@ -0,0 +1,50 @@
+/* eslint-disable import/no-unresolved */
+import { check } from 'k6'
+import { Counter } from 'k6/metrics'
+import { ComprehensiveAPIClient } from './sdk.ts'
+/* eslint-enable import/no-unresolved */
+
+const CounterErrors = new Counter('Errors')
+const CounterSuccess = new Counter('Success')
+const baseUrl = 'http://localhost:3000'
+const client = new ComprehensiveAPIClient({ baseUrl })
+
+export const options = {
+  thresholds: {
+    Errors: ['count>=1'],
+    Success: ['count>=1'],
+    // the rate of successful checks should be higher than 90%
+  },
+}
+
+function checkResponseStatus(response, expectedStatus) {
+  const result = check(response, {
+    [`status is ${expectedStatus}`]: (r) => r.status === expectedStatus,
+  })
+
+  if (!result) {
+    console.error(
+      `Check failed! Expected status ${expectedStatus} but got ${response.status}. Following is the response:`
+    )
+    console.log(JSON.stringify(response, null, 2))
+  } else {
+    CounterSuccess.add(1)
+  }
+}
+
+export default function () {
+  try {
+    const getResponseData = client.getItemsId('1')
+    checkResponseStatus(getResponseData.response, 200)
+  } catch (error) {
+    if (error instanceof TypeError) {
+      // Add a k6 check to verify if the error is thrown
+      CounterErrors.add(1)
+    }
+  }
+
+  const getItemsHeaderResponseData = client.getItemsHeader({
+    id: 'test',
+  })
+  checkResponseStatus(getItemsHeaderResponseData.response, 200)
+}

package/tests/e2e/tags/k6Script.ts

@@ -1,7 +1,7 @@
 /* eslint-disable import/no-unresolved */
 import { check } from 'k6'
-import { DefaultClient } from './default.ts'
 import { ItemsFormClient } from './items-form.ts'
+import { ItemsHeaderClient } from './items-header.ts'
 import { ItemsClient } from './items.ts'
 
 /* eslint-enable import/no-unresolved */
@@ -9,7 +9,7 @@ import { ItemsClient } from './items.ts'
 const baseUrl = 'http://localhost:3000'
 const itemsClient = new ItemsClient({ baseUrl })
 const itemFormClient = new ItemsFormClient({ baseUrl })
-const defaultClient = new DefaultClient({ baseUrl })
+const itemsHeaderClient = new ItemsHeaderClient({ baseUrl })
 
 export const options = {
   thresholds: {
@@ -98,7 +98,7 @@ export default function () {
   // Items form client call end
 
   // Default client call start
-  const getItemsHeaderResponseData = defaultClient.getItemsHeader({
+  const getItemsHeaderResponseData = itemsHeaderClient.getItemsHeader({
     id: 'test',
   })
   checkResponseStatus(getItemsHeaderResponseData.response, 200)

package/tests/functional-tests/fixtures/tags_filtering.json

@@ -0,0 +1,141 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Sample API",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/users": {
+      "get": {
+        "tags": ["users"],
+        "responses": {
+          "200": {
+            "description": "Success"
+          }
+        }
+      }
+    },
+    "/user-profiles": {
+      "get": {
+        "tags": ["userProfiles"],
+        "responses": {
+          "200": {
+            "description": "Success"
+          }
+        }
+      }
+    },
+    "/pets": {
+      "get": {
+        "tags": ["pets"],
+        "responses": {
+          "200": {
+            "description": "Success"
+          }
+        }
+      }
+    },
+    "/auth": {
+      "post": {
+        "tags": ["auth"],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/AuthRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Success"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "AuthRequest": {
+        "type": "object",
+        "properties": {
+          "username": {
+            "type": "string",
+            "example": "user123"
+          },
+          "password": {
+            "type": "string",
+            "format": "password",
+            "example": "mypassword"
+          }
+        },
+        "required": ["username", "password"]
+      },
+      "User": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "example": "abc123"
+          },
+          "name": {
+            "type": "string",
+            "example": "John Doe"
+          },
+          "email": {
+            "type": "string",
+            "format": "email",
+            "example": "john.doe@example.com"
+          }
+        },
+        "required": ["id", "name", "email"]
+      },
+      "UserProfile": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "example": "profile123"
+          },
+          "userId": {
+            "type": "string",
+            "example": "abc123"
+          },
+          "bio": {
+            "type": "string",
+            "example": "Software developer with 10 years of experience"
+          },
+          "avatarUrl": {
+            "type": "string",
+            "format": "uri",
+            "example": "https://example.com/avatar.jpg"
+          }
+        },
+        "required": ["id", "userId", "bio"]
+      },
+      "Pet": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "example": "pet123"
+          },
+          "name": {
+            "type": "string",
+            "example": "Buddy"
+          },
+          "species": {
+            "type": "string",
+            "example": "Dog"
+          },
+          "age": {
+            "type": "integer",
+            "example": 3
+          }
+        },
+        "required": ["id", "name", "species"]
+      }
+    }
+  }
+}