Make the code self-mindblowing

iterative · Sep 28, 2022 · 17f380d · 17f380d · github-actions · Sep 28, 2022
1 parent 4a79556
commit 17f380d
Show file tree

Hide file tree

Showing 11 changed files with 82 additions and 272 deletions.
diff --git a/bin/cml.js b/bin/cml.js
@@ -3,7 +3,6 @@
 const { basename } = require('path');
 const { pseudoexec } = require('pseudoexec');
 
-const camelcaseKeys = require('camelcase-keys');
 const which = require('which');
 const winston = require('winston');
 const yargs = require('yargs');
@@ -78,40 +77,25 @@ const setupLogger = (opts) => {
 
 const setupTelemetry = async (opts, { parsed: { defaulted } }) => {
   const { cml, _: command } = opts;
-  const action = command.join(':');
-
-  const allowedTelemetryOptions = {
-    'runner:launch': {
-      cloud: 'plain',
-      cloudStartupScript: 'masked'
-    },
-    'comment:create': {
-      native: 'plain',
-      publishUrl: 'masked'
-    }
-    // IMPORTANT!  --no-watermark and runner launch --reuse
-  };
 
-  const options = Object.fromEntries(
-    Object.entries(opts)
-      .filter(
-        ([key]) =>
-          Object.prototype.hasOwnProperty.call(
-            allowedTelemetryOptions[action] || {},
-            key
-          ) &&
-          !Object.prototype.hasOwnProperty.call(camelcaseKeys(defaulted), key)
-      )
-      .map(([key, value]) => [
-        key,
-        (allowedTelemetryOptions[action] || {})[key] === 'plain' ? value : '***'
-      ])
-  );
+  const options = {};
+  for (const [name, option] of Object.entries(opts.options)) {
+    if (opts[name] && !defaulted[name]) {
+      switch (option.telemetry) {
+        case 'presence':
+          options[name] = null;
+          break;
+        case 'full':
+          options[name] = opts[name];
+          break;
+      }
+    }
+  }
 
   opts.telemetryEvent = await jitsuEventPayload({
-    action,
-    cml,
-    extra: { options }
+    action: command.join(':'),
+    extra: { options },
+    cml
   });
 };
 

diff --git a/bin/cml/asset/publish.js b/bin/cml/asset/publish.js
@@ -23,7 +23,12 @@ exports.handler = async (opts) => {
   else await fs.writeFile(file, output);
 };
 
-exports.builder = (yargs) => yargs.env('CML_ASSET').options(exports.options);
+exports.builder = (yargs) =>
+  yargs
+    .env('CML_ASSET')
+    .option('options', { default: exports.options, hidden: true })
+    .options(exports.options)
+    .options(exports.options);
 
 exports.options = kebabcaseKeys({
   url: {
@@ -51,7 +56,8 @@ exports.options = kebabcaseKeys({
   },
   rmWatermark: {
     type: 'boolean',
-    description: 'Avoid CML watermark.'
+    description: 'Avoid CML watermark.',
+    telemetry: 'presence'
   },
   mimeType: {
     type: 'string',

diff --git a/bin/cml/check/create.js b/bin/cml/check/create.js
@@ -10,7 +10,12 @@ exports.handler = async (opts) => {
   await cml.checkCreate({ ...opts, report });
 };
 
-exports.builder = (yargs) => yargs.env('CML_CHECK').options(exports.options);
+exports.builder = (yargs) =>
+  yargs
+    .env('CML_CHECK')
+    .option('options', { default: exports.options, hidden: true })
+    .options(exports.options)
+    .options(exports.options);
 
 exports.options = kebabcaseKeys({
   token: {

diff --git a/bin/cml/comment/create.js b/bin/cml/comment/create.js
@@ -8,7 +8,12 @@ exports.handler = async (opts) => {
   console.log(await cml.commentCreate(opts));
 };
 
-exports.builder = (yargs) => yargs.env('CML_COMMENT').options(exports.options);
+exports.builder = (yargs) =>
+  yargs
+    .env('CML_COMMENT')
+    .option('options', { default: exports.options, hidden: true })
+    .options(exports.options)
+    .options(exports.options);
 
 exports.options = kebabcaseKeys({
   pr: {
@@ -29,7 +34,8 @@ exports.options = kebabcaseKeys({
   publishUrl: {
     type: 'string',
     default: 'https://asset.cml.dev',
-    description: 'Self-hosted image server URL'
+    description: 'Self-hosted image server URL',
+    telemetry: 'presence'
   },
   watch: {
     type: 'boolean',
@@ -43,7 +49,8 @@ exports.options = kebabcaseKeys({
   native: {
     type: 'boolean',
     description:
-      "Uses driver's native capabilities to upload assets instead of CML's storage; not available on GitHub"
+      "Uses driver's native capabilities to upload assets instead of CML's storage; not available on GitHub",
+    telemetry: 'presence'
   },
   update: {
     type: 'boolean',
@@ -54,6 +61,7 @@ exports.options = kebabcaseKeys({
   rmWatermark: {
     type: 'boolean',
     description:
-      'Avoid watermark; CML needs a watermark to be able to distinguish CML comments from others'
+      'Avoid watermark; CML needs a watermark to be able to distinguish CML comments from others',
+    telemetry: 'presence'
   }
 });
diff --git a/bin/cml/pr/create.js b/bin/cml/pr/create.js
@@ -15,7 +15,12 @@ exports.handler = async (opts) => {
   console.log(link);
 };
 
-exports.builder = (yargs) => yargs.env('CML_PR').options(exports.options);
+exports.builder = (yargs) =>
+  yargs
+    .env('CML_PR')
+    .option('options', { default: exports.options, hidden: true })
+    .options(exports.options)
+    .options(exports.options);
 
 exports.options = kebabcaseKeys({
   md: {

diff --git a/bin/cml/repo/prepare.js b/bin/cml/repo/prepare.js
@@ -10,7 +10,12 @@ exports.handler = async (opts) => {
   await cml.ci(opts);
 };
 
-exports.builder = (yargs) => yargs.env('CML_REPO').options(exports.options);
+exports.builder = (yargs) =>
+  yargs
+    .env('CML_REPO')
+    .option('options', { default: exports.options, hidden: true })
+    .options(exports.options)
+    .options(exports.options);
 
 exports.options = kebabcaseKeys({
   unshallow: {

diff --git a/bin/cml/runner/launch.js b/bin/cml/runner/launch.js
@@ -426,7 +426,11 @@ exports.handler = async (opts) => {
   }
 };
 
-exports.builder = (yargs) => yargs.env('CML_RUNNER').options(exports.options);
+exports.builder = (yargs) =>
+  yargs
+    .env('CML_RUNNER')
+    .option('options', { default: exports.options, hidden: true })
+    .options(exports.options);
 
 exports.options = kebabcaseKeys({
   labels: {
@@ -462,13 +466,15 @@ exports.options = kebabcaseKeys({
     type: 'boolean',
     conflicts: ['single', 'reuseIdle'],
     description:
-      "Don't launch a new runner if an existing one has the same name or overlapping labels"
+      "Don't launch a new runner if an existing one has the same name or overlapping labels",
+    telemetry: 'presence'
   },
   reuseIdle: {
     type: 'boolean',
     conflicts: ['reuse', 'single'],
     description:
-      "Creates a new runner only if the matching labels don't exist or are already busy"
+      "Creates a new runner only if the matching labels don't exist or are already busy",
+    telemetry: 'presence'
   },
   workdir: {
     type: 'string',
@@ -484,7 +490,8 @@ exports.options = kebabcaseKeys({
   cloud: {
     type: 'string',
     choices: ['aws', 'azure', 'gcp', 'kubernetes'],
-    description: 'Cloud to deploy the runner'
+    description: 'Cloud to deploy the runner',
+    telemetry: 'full'
   },
   cloudRegion: {
     type: 'string',
@@ -537,12 +544,14 @@ exports.options = kebabcaseKeys({
     type: 'number',
     default: -1,
     description:
-      'Maximum spot instance bidding price in USD. Defaults to the current spot bidding price'
+      'Maximum spot instance bidding price in USD. Defaults to the current spot bidding price',
+    telemetry: 'presence'
   },
   cloudStartupScript: {
     type: 'string',
     description:
-      'Run the provided Base64-encoded Linux shell script during the instance initialization'
+      'Run the provided Base64-encoded Linux shell script during the instance initialization',
+    telemetry: 'presence'
   },
   cloudAwsSecurityGroup: {
     type: 'string',

diff --git a/bin/cml/tensorboard/connect.js b/bin/cml/tensorboard/connect.js
@@ -96,7 +96,11 @@ exports.handler = async (opts) => {
 };
 
 exports.builder = (yargs) =>
-  yargs.env('CML_TENSORBOARD').options(exports.options);
+  yargs
+    .env('CML_TENSORBOARD')
+    .option('options', { default: exports.options, hidden: true })
+    .options(exports.options)
+    .options(exports.options);
 
 exports.options = kebabcaseKeys({
   credentials: {
@@ -137,6 +141,7 @@ exports.options = kebabcaseKeys({
   },
   rmWatermark: {
     type: 'boolean',
-    description: 'Avoid CML watermark'
+    description: 'Avoid CML watermark',
+    telemetry: 'presence'
   }
 });
diff --git a/bin/cml/workflow/rerun.js b/bin/cml/workflow/rerun.js
@@ -8,7 +8,12 @@ exports.handler = async (opts) => {
   await cml.pipelineRerun(opts);
 };
 
-exports.builder = (yargs) => yargs.env('CML_WORKFLOW').options(exports.options);
+exports.builder = (yargs) =>
+  yargs
+    .env('CML_WORKFLOW')
+    .option('options', { default: exports.options, hidden: true })
+    .options(exports.options)
+    .options(exports.options);
 
 exports.options = kebabcaseKeys({
   id: {