@grafana/openapi-to-k6 0.1.0 → 0.1.1

package/.eslintignore

@@ -0,0 +1,5 @@
+node_modules
+README.md
+package.json
+package-lock.json
+examples/

package/.github/workflows/publish.yaml

@@ -24,11 +24,13 @@ jobs:
         run: |
           NEW_VERSION=${{ github.event.release.tag_name }}
           npm version $NEW_VERSION --no-git-tag-version
+      - name: Update generated examples
+        run: npm run update-examples
       - name: Commit updated package.json
         run: |
           git config --global user.name 'github-actions[bot]'
           git config --global user.email 'github-actions[bot]@users.noreply.github.com'
-          git add package.json package-lock.json
+          git add package.json package-lock.json examples/
           git commit -m "Update package.json version to ${{ github.event.release.tag_name }}"
           git push origin HEAD:main
       - run: npm run build

package/.github/workflows/tests.yaml

@@ -3,10 +3,7 @@ name: Run Tests
 on:
   push:
     branches:
-      - main
-  pull_request:
-    branches:
-      - main
+      - "**"
 
 jobs:
   test:
@@ -41,3 +38,22 @@ jobs:
           path: './tests/e2e/k6Script.ts'
           flags: '--compatibility-mode=experimental_enhanced'
           inspect-flags: '--compatibility-mode=experimental_enhanced'
+  run-examples:
+    runs-on: ubuntu-latest
+    needs: [test, e2e-test]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '21.5.0'
+      - run: npm ci
+      - name: Update examples
+        run: npm run update-examples
+      - name: Compare generated Clients with existing ones
+        id: diff
+        run: |
+          if [ "$(git diff --ignore-space-at-eol --text examples/ | wc -l)" -gt "0" ]; then
+            echo "Detected changes in the examples, run `npm run update-examples` to update all the examples."
+            git diff --ignore-space-at-eol --text examples/
+            exit 1
+          fi

package/.prettierignore

@@ -0,0 +1,4 @@
+examples/
+dist/
+.github/
+.vscode/

package/README.md

@@ -1,5 +1,11 @@
 # openapi-to-k6
 
+<p align="center">⚠️</p>
+
+***This tool is currently in the experimental stage. Expect bugs, incomplete features, and breaking changes as development progresses. Use at your own risk, and please report any issues or feedback to help us improve.***
+
+---
+
 ## Overview
 
 The _openapi-to-k6_ repository is a tool designed to ease the process of writing k6 scripts.
@@ -9,6 +15,13 @@ easily call your endpoints and have auto completion in your IDE.
 This allows developers to easily create performance tests for their APIs based on their existing
 OpenAPI documentation.
 
+Along with the client, it also generates a sample k6 script as an example of how to use the client.
+
+To get started, install the tool with npm via `npm install openapi-to-k6` and run it to convert your
+OpenAPI specification to a TypeScript client for k6.
+
+To take a look at a few examples of how the generated client and sample script looks, check out the [examples](./examples) directory.
+
 Note: Optional usage analytics are gathered to make the tool better. To disable this, use the option
 `--disable-analytics` or set an environment variable `DISABLE_ANALYTICS=true`.
 

package/dist/generator.js

@@ -12,7 +12,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
 const orval_1 = __importDefault(require("orval"));
+const path_1 = __importDefault(require("path"));
+const constants_1 = require("./constants");
 const helper_1 = require("./helper");
 const k6SdkClient_1 = require("./k6SdkClient");
 const logger_1 = require("./logger");
@@ -27,6 +30,20 @@ const generatedFileHeaderGenerator = (info) => {
         ...(info.version ? [`OpenAPI spec version: ${info.version}`] : []),
     ];
 };
+const afterAllFilesWriteHandler = (filePaths) => __awaiter(void 0, void 0, void 0, function* () {
+    for (const filePath of filePaths) {
+        yield (0, helper_1.formatFileWithPrettier)(filePath);
+        const fileName = path_1.default.basename(filePath);
+        if (fileName === '.ts') {
+            // Generated SDK had no name because there was no title in the schema
+            // Rename it to the default name
+            const directoryPath = path_1.default.dirname(filePath);
+            const newPath = path_1.default.join(directoryPath, `${constants_1.DEFAULT_SCHEMA_TITLE}.ts`);
+            logger_1.logger.debug(`afterAllFilesWriteHandler ~ Renaming ${filePath} to ${newPath}`);
+            fs_1.default.renameSync(filePath, newPath);
+        }
+    }
+});
 exports.default = (_a) => __awaiter(void 0, [_a], void 0, function* ({ openApiPath, outputDir, shouldGenerateSampleK6Script, analyticsData, }) {
     const schemaDetails = {
         title: '',
@@ -48,10 +65,12 @@ exports.default = (_a) => __awaiter(void 0, [_a], void 0, function* ({ openApiPa
                 },
                 headers: true,
             },
+            hooks: {
+                afterAllFilesWrite: afterAllFilesWriteHandler,
+            },
         });
     }));
     if (!schemaDetails.title) {
         logger_1.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');
     }
-    yield (0, helper_1.formatGeneratedFiles)(outputDir, schemaDetails.title, !!shouldGenerateSampleK6Script);
 });

package/dist/helper.js

@@ -14,7 +14,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OutputOverrider = exports.getPackageDetails = void 0;
 exports.formatFileWithPrettier = formatFileWithPrettier;
-exports.formatGeneratedFiles = formatGeneratedFiles;
 exports.getGeneratedClientPath = getGeneratedClientPath;
 exports.isTsNode = isTsNode;
 exports.djb2Hash = djb2Hash;
@@ -24,7 +23,6 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const prettier_1 = require("prettier");
 const package_json_1 = __importDefault(require("../package.json"));
-const constants_1 = require("./constants");
 const logger_1 = require("./logger");
 const getPackageDetails = () => {
     const commandName = Object.keys(package_json_1.default.bin)[0] || 'openapi-to-k6';
@@ -43,6 +41,10 @@ exports.getPackageDetails = getPackageDetails;
  */
 function formatFileWithPrettier(filePath) {
     return __awaiter(this, void 0, void 0, function* () {
+        if (!fs_1.default.existsSync(filePath)) {
+            logger_1.logger.debug(`formatFileWithPrettier ~ File does not exist: ${filePath}, skipping formatting with prettier.`);
+            return;
+        }
         // Read file contents
         const content = fs_1.default.readFileSync(filePath, 'utf-8');
         // Format using Prettier
@@ -53,35 +55,6 @@ function formatFileWithPrettier(filePath) {
         logger_1.logger.debug(`Formatted: ${filePath}`);
     });
 }
-/**
- * Format the generated files using Prettier.
- *
- * @param outputTarget - Path to the generated files.
- * @param schemaTitle - Title of the schema.
- */
-function formatGeneratedFiles(outputTarget, schemaTitle, isSampleK6ScriptGenerated) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // Here we call the original function from @orval/core used by the library to generate the
-        // file name with same defaults.
-        const { path: clientPath } = yield getGeneratedClientPath(outputTarget, schemaTitle);
-        logger_1.logger.debug('Following are the details for formatting generated files:');
-        logger_1.logger.debug(`Path: ${path_1.default}`);
-        logger_1.logger.debug(`Schema Title: ${schemaTitle}`);
-        logger_1.logger.debug(`Output Target: ${outputTarget}`);
-        yield exports.formatFileWithPrettier(clientPath);
-        if (isSampleK6ScriptGenerated) {
-            const k6ScriptPath = path_1.default.join(getDirectoryForPath(clientPath), constants_1.SAMPLE_K6_SCRIPT_FILE_NAME);
-            logger_1.logger.debug(`Generated sample K6 Script Path: ${k6ScriptPath}`);
-            if (fs_1.default.existsSync(k6ScriptPath)) {
-                logger_1.logger.debug('Formatting sample k6 script file');
-                yield exports.formatFileWithPrettier(k6ScriptPath);
-            }
-            else {
-                logger_1.logger.error('Unable to format sample K6 script file as it does not exist!');
-            }
-        }
-    });
-}
 /**
  * Get the path for the generated client file.
  *
@@ -131,7 +104,10 @@ class OutputOverrider {
     }
     redirectOutputToNullStream(callback) {
         return __awaiter(this, void 0, void 0, function* () {
-            process.stdout.write = process.stderr.write = () => true;
+            if (!logger_1.logger.getVerbose()) {
+                // Redirect stdout and stderr to null stream only if not running in verbose mode
+                process.stdout.write = process.stderr.write = () => true;
+            }
             try {
                 if (callback) {
                     yield callback();

package/dist/k6SdkClient.js

@@ -19,6 +19,7 @@ const handlebars_1 = __importDefault(require("handlebars"));
 const path_1 = __importDefault(require("path"));
 const constants_1 = require("./constants");
 const helper_1 = require("./helper");
+const logger_1 = require("./logger");
 // A map to store the operationNames for which a return type is to be written at the end to export
 // and the return type definition
 const returnTypesToWrite = new Map();
@@ -69,10 +70,12 @@ const getK6Dependencies = () => [
 exports.getK6Dependencies = getK6Dependencies;
 function getSchemaTitleFromContext(context) {
     const specData = Object.values(context.specs);
+    let schemaTitle;
     if (specData[0]) {
-        return specData[0].info.title;
+        schemaTitle = specData[0].info.title;
     }
-    return constants_1.DEFAULT_SCHEMA_TITLE;
+    schemaTitle !== null && schemaTitle !== void 0 ? schemaTitle : (schemaTitle = constants_1.DEFAULT_SCHEMA_TITLE);
+    return schemaTitle;
 }
 function _generateResponseTypeName(operationName) {
     return `${(0, core_1.pascal)(operationName)}Response`;
@@ -249,15 +252,18 @@ const generateFooter = ({ operationNames }) => {
 };
 exports.generateFooter = generateFooter;
 const k6ScriptBuilder = (verbOptions, output, context) => __awaiter(void 0, void 0, void 0, function* () {
-    console.log(JSON.stringify({
-        verbOptions,
-        output,
-        context,
-    }, null, 2));
     const schemaTitle = getSchemaTitleFromContext(context);
     const { path: pathOfGeneratedClient, filename, extension, } = yield (0, helper_1.getGeneratedClientPath)(output.target, schemaTitle);
     const directoryPath = (0, helper_1.getDirectoryForPath)(pathOfGeneratedClient);
     const generateScriptPath = path_1.default.join(directoryPath, constants_1.SAMPLE_K6_SCRIPT_FILE_NAME);
+    logger_1.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;

package/dist/logger.js

@@ -25,6 +25,9 @@ class Logger {
     setVerbose(verbose) {
         this.isVerbose = verbose;
     }
+    getVerbose() {
+        return this.isVerbose;
+    }
     logWithColor(message, level, color) {
         const timestamp = new Date().toISOString();
         console.log(`${color(`[${level}]`)} ${chalk_1.default.gray(`[${timestamp}]`)} ${message}`);

package/examples/basic_schema/k6-script.sample.ts

@@ -0,0 +1,11 @@
+import { createSimpleAPI } from './simpleAPI.ts'
+
+const baseUrl = '<BASE_URL>'
+const client = createSimpleAPI({ baseUrl })
+
+export default function () {
+  /**
+   * Retrieve example data
+   */
+  const getExampleResponseData = client.getExample()
+}

package/examples/basic_schema/schema.json

@@ -0,0 +1,32 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Simple API",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/example": {
+      "get": {
+        "summary": "Retrieve example data",
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string",
+                      "example": "Hello, World!"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/examples/basic_schema/simpleAPI.ts

@@ -0,0 +1,87 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.1.1
+ * Do not edit manually.
+ * Simple API
+ * 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, ResponseBody } from 'k6/http'
+export type GetExample200 = {
+  message?: string
+}
+
+export type CreateSimpleAPIOptions = {
+  baseUrl: string
+  commonRequestParameters?: Params
+}
+
+/**
+ * This is the base client to use for interacting with the API.
+ */
+export const createSimpleAPI = (clientOptions: CreateSimpleAPIOptions) => {
+  const cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+  /**
+   * @summary Retrieve example data
+   */
+  const getExample = (requestParameters?: Params): GetExampleResponse => {
+    const url = new URL(cleanBaseUrl + `/example`)
+    const mergedRequestParameters = _mergeRequestParameters(
+      requestParameters || {},
+      clientOptions.commonRequestParameters
+    )
+    const response = http.request(
+      'GET',
+      url.toString(),
+      undefined,
+      mergedRequestParameters
+    )
+    let data
+
+    try {
+      data = response.json()
+    } catch (error) {
+      data = response.body
+    }
+    return {
+      response,
+      data,
+    }
+  }
+
+  return { getExample }
+}
+
+export type GetExampleResponse = {
+  response: Response
+  data: GetExample200 | ResponseBody
+}
+
+/**
+ * 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
+ */
+const _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/form_data_schema/formDataAPI.ts

@@ -0,0 +1,115 @@
+/**
+ * Automatically generated by @grafana/openapi-to-k6: 0.1.1
+ * Do not edit manually.
+ * Form Data API
+ * OpenAPI spec version: 1.0.0
+ */
+import { FormData } from 'https://jslib.k6.io/formdata/0.0.2/index.js'
+import { URL } from 'https://jslib.k6.io/url/1.0.0/index.js'
+import http from 'k6/http'
+import type { Params, Response, ResponseBody } from 'k6/http'
+export type PostUpload400 = {
+  error?: string
+  success?: boolean
+}
+
+export type PostUpload200 = {
+  message?: string
+  success?: boolean
+}
+
+export type PostUploadBody = {
+  /** Description of the file */
+  description?: string
+  /** File to upload */
+  file: Blob
+  /** User ID associated with the upload */
+  userId: string
+}
+
+export type CreateFormDataAPIOptions = {
+  baseUrl: string
+  commonRequestParameters?: Params
+}
+
+/**
+ * This is the base client to use for interacting with the API.
+ */
+export const createFormDataAPI = (clientOptions: CreateFormDataAPIOptions) => {
+  const cleanBaseUrl = clientOptions.baseUrl.replace(/\/+$/, '')
+  /**
+   * This endpoint accepts form data and file uploads.
+   * @summary Upload files and data
+   */
+  const postUpload = (
+    postUploadBody: PostUploadBody,
+    requestParameters?: Params
+  ): PostUploadResponse => {
+    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(cleanBaseUrl + `/upload`)
+    const mergedRequestParameters = _mergeRequestParameters(
+      requestParameters || {},
+      clientOptions.commonRequestParameters
+    )
+    const response = http.request('POST', url.toString(), formData.body(), {
+      ...mergedRequestParameters,
+      headers: {
+        'Content-Type': 'multipart/form-data; boundary=' + formData.boundary,
+        ...mergedRequestParameters?.headers,
+      },
+    })
+    let data
+
+    try {
+      data = response.json()
+    } catch (error) {
+      data = response.body
+    }
+    return {
+      response,
+      data,
+    }
+  }
+
+  return { postUpload }
+}
+
+export type PostUploadResponse = {
+  response: Response
+  data: PostUpload200 | ResponseBody
+}
+
+/**
+ * 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
+ */
+const _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/form_data_schema/k6-script.sample.ts

@@ -0,0 +1,11 @@
+import { createFormDataAPI } from './formDataAPI.ts'
+
+const baseUrl = '<BASE_URL>'
+const client = createFormDataAPI({ baseUrl })
+
+export default function () {
+  /**
+   * Upload files and data
+   */
+  const postUploadResponseData = client.postUpload(postUploadBody)
+}

package/examples/form_data_schema/schema.json

@@ -0,0 +1,86 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Form Data API",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/upload": {
+      "post": {
+        "summary": "Upload files and data",
+        "description": "This endpoint accepts form data and file uploads.",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "multipart/form-data": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "file": {
+                    "type": "string",
+                    "format": "binary",
+                    "description": "File to upload"
+                  },
+                  "description": {
+                    "type": "string",
+                    "description": "Description of the file"
+                  },
+                  "userId": {
+                    "type": "string",
+                    "description": "User ID associated with the upload"
+                  }
+                },
+                "required": [
+                  "file",
+                  "userId"
+                ]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "File uploaded successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "success": {
+                      "type": "boolean",
+                      "example": true
+                    },
+                    "message": {
+                      "type": "string",
+                      "example": "File uploaded successfully"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "success": {
+                      "type": "boolean",
+                      "example": false
+                    },
+                    "error": {
+                      "type": "string",
+                      "example": "Invalid file or data"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}