@grafana/openapi-to-k6 0.2.0 → 0.2.1

package/.github/workflows/publish.yaml

@@ -26,8 +26,6 @@ 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]'

package/README.md

@@ -45,20 +45,25 @@ To take a look at a few examples of how the generated client looks and sample sc
 
     This will the generate a TypeScript client and a sample k6 script in the corresponding directory.
 
+    You can also supply the optional flag `--include-sample-script` to also generate a sample k6 script
+    along with the client.
+
+💡 _Note_: The tool supports both JSON and YAML format for OpenAPI schema.
+
 ### Options
 
 Following are some of the configuration options supported by the tool.
 
-1. `--mode` or ` -m`: Specify the mode to use for generating the client. Following are available options:
+1. `--mode` or `-m`: Specify the mode to use for generating the client. Following are available options:
    1. `single`: This is the default mode used is nothing is specified. It generated the TypeScript client as a single file with all the types and implementation in a single file.
    2. `split`: This mode splits the types and implementation into separate files.
    3. `tags`: This modes splits your OpenAPI schema based on the tags and generates a separate client for each tag. If a route has no tag set, it will be available in `default.ts` file.
 
    To check how the output looks for each mode, check out the [examples](./examples) directory.
 2. `--disable-analytics`: Disable anonymous usage analytics reporting which helping making the tool better. You can also set an environment variable `DISABLE_ANALYTICS=true` to disable the analytics.
-3. `--disable-sample-script`: Disable the generation of sample k6 script.
-4. `--verbose` or ` -v` : Enable verbose logging to see more detailed logging output.
-5. `--help` or ` -h` : Show help message.
+3. `--include-sample-script`: Generate a sample k6 script.
+4. `--verbose` or `-v` : Enable verbose logging to see more detailed logging output.
+5. `--help` or `-h` : Show help message.
 
 ## Developing locally
 

package/dist/analytics.js

@@ -37,7 +37,7 @@ function getAnonymousUserId() {
  * @param packageDetails - Details of the openapi-to-k6 package.
  * @returns
  */
-function generateDefaultAnalyticsData(packageDetails) {
+function generateDefaultAnalyticsData(packageDetails, isSampleK6ScriptGenerated) {
     const defaultAnalyticsData = {
         generatedRequestsCount: {
             post: 0,
@@ -47,6 +47,7 @@ function generateDefaultAnalyticsData(packageDetails) {
             delete: 0,
             head: 0,
         },
+        isSampleK6ScriptGenerated,
         openApiSpecVersion: '',
         toolVersion: packageDetails.version,
         anonymousUserId: getAnonymousUserId(),

package/dist/cli.js

@@ -62,13 +62,11 @@ program
     .argument('<outputDir>', 'Directory where the SDK should be generated')
     .option('-m, --mode <string>', `mode to use for generating the client. Valid values - ${Object.values(constants_1.Mode).join(', ')}`, validateMode, constants_1.Mode.SINGLE)
     .option('-v, --verbose', 'enable verbose mode to show debug logs')
-    .option('--disable-sample-script', 'disable generating sample k6 script')
+    .option('--include-sample-script', 'generate a sample k6 script')
     .option('--disable-analytics', 'disable anonymous usage data collection')
     .action((openApiPath, outputDir, options) => __awaiter(void 0, void 0, void 0, function* () {
     let analyticsData;
     const shouldDisableAnalytics = options.disableAnalytics || process.env.DISABLE_ANALYTICS === 'true';
-    const shouldDisableSampleScript = options.disableSampleScript ||
-        process.env.DISABLE_SAMPLE_SCRIPT === 'true';
     if (options.verbose) {
         logger_1.logger.setVerbose(true);
         logger_1.logger.debug('Verbose mode enabled, showing debug logs');
@@ -78,7 +76,7 @@ program
     }
     else {
         logger_1.logger.debug('Anonymous usage data collection enabled');
-        analyticsData = (0, analytics_1.generateDefaultAnalyticsData)(packageDetails);
+        analyticsData = (0, analytics_1.generateDefaultAnalyticsData)(packageDetails, !!options.includeSampleScript);
     }
     logger_1.logger.debug(`
             Supplied OpenAPI schema: ${openApiPath}
@@ -88,7 +86,7 @@ program
         yield generateSDK({
             openApiPath,
             outputDir,
-            shouldGenerateSampleK6Script: !shouldDisableSampleScript,
+            shouldGenerateSampleK6Script: !!options.includeSampleScript,
             analyticsData,
             mode: options.mode,
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/openapi-to-k6",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "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/single/\" -m single && npm run dev -- \"$dir/schema.json\" \"$dir/split/\" -m split && npm run dev -- \"$dir/schema.json\" \"$dir/tags/\" -m tags); done",
+    "update-examples": "for dir in ./examples/*/; do (npm run dev -- \"$dir/schema.json\" \"$dir/single/\" -m single --include-sample-script && npm run dev -- \"$dir/schema.json\" \"$dir/split/\" -m split --include-sample-script && npm run dev -- \"$dir/schema.json\" \"$dir/tags/\" -m tags --include-sample-script); done",
     "prepare": "husky"
   },
   "author": "",

package/src/analytics.ts

@@ -26,7 +26,8 @@ function getAnonymousUserId(): string {
  * @returns
  */
 export function generateDefaultAnalyticsData(
-  packageDetails: PackageDetails
+  packageDetails: PackageDetails,
+  isSampleK6ScriptGenerated: boolean
 ): AnalyticsData {
   const defaultAnalyticsData: AnalyticsData = {
     generatedRequestsCount: {
@@ -37,6 +38,7 @@ export function generateDefaultAnalyticsData(
       delete: 0,
       head: 0,
     },
+    isSampleK6ScriptGenerated,
     openApiSpecVersion: '',
     toolVersion: packageDetails.version,
     anonymousUserId: getAnonymousUserId(),

package/src/cli.ts

@@ -69,7 +69,7 @@ program
     Mode.SINGLE
   )
   .option('-v, --verbose', 'enable verbose mode to show debug logs')
-  .option('--disable-sample-script', 'disable generating sample k6 script')
+  .option('--include-sample-script', 'generate a sample k6 script')
   .option('--disable-analytics', 'disable anonymous usage data collection')
   .action(
     async (
@@ -79,15 +79,12 @@ program
         verbose?: boolean
         mode: Mode
         disableAnalytics?: boolean
-        disableSampleScript?: boolean
+        includeSampleScript?: boolean
       }
     ) => {
       let analyticsData: AnalyticsData | undefined
       const shouldDisableAnalytics =
         options.disableAnalytics || process.env.DISABLE_ANALYTICS === 'true'
-      const shouldDisableSampleScript =
-        options.disableSampleScript ||
-        process.env.DISABLE_SAMPLE_SCRIPT === 'true'
 
       if (options.verbose) {
         logger.setVerbose(true)
@@ -98,7 +95,10 @@ program
         logger.debug('Anonymous usage data collection disabled')
       } else {
         logger.debug('Anonymous usage data collection enabled')
-        analyticsData = generateDefaultAnalyticsData(packageDetails)
+        analyticsData = generateDefaultAnalyticsData(
+          packageDetails,
+          !!options.includeSampleScript
+        )
       }
 
       logger.debug(`
@@ -109,7 +109,7 @@ program
         await generateSDK({
           openApiPath,
           outputDir,
-          shouldGenerateSampleK6Script: !shouldDisableSampleScript,
+          shouldGenerateSampleK6Script: !!options.includeSampleScript,
           analyticsData,
           mode: options.mode,
         })

package/src/type.d.ts

@@ -16,6 +16,7 @@ export interface AnalyticsData {
     patch: number
     head: number
   }
+  isSampleK6ScriptGenerated: boolean
   openApiSpecVersion: string
   toolVersion: string
   anonymousUserId: string