Merge branch 'master' into cli-updates

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,29 @@
+name: CodeQL
+
+on:
+  pull_request:
+    paths-ignore:
+      - '**.md'
+      - assets/**
+  schedule:
+    - cron: '0 0 * * *' # everyday @ 0000 UTC
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref_name }}
+  cancel-in-progress: true
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    steps:
+      - uses: actions/checkout@v3
+      - uses: github/codeql-action/init@v2
+        with:
+          languages: javascript
+      - uses: github/codeql-action/autobuild@v2
+      - uses: github/codeql-action/analyze@v2

.github/workflows/test-deploy.yml

@@ -101,48 +101,27 @@ jobs:
         with:
           registry-url: https://registry.npmjs.org
       - run: npm install
-      - run:
-          npm ${{ inputs.release && 'publish' || 'publish --dry-run' }}
+      - run: npm ${{ inputs.release && 'publish' || 'publish --dry-run' }}
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-      - name: install ldid
-        run: |
-          sudo apt install --yes libplist-dev
-          git clone --branch v2.1.5 git://git.saurik.com/ldid.git
-          sudo g++ -pipe -o /usr/bin/ldid ldid/ldid.cpp -I. -x c ldid/{lookup2.c,sha1.h} -lplist -lcrypto
-      - id: build
-        name: build
-        run: |
-          echo ::set-output name=tag::${GITHUB_REF#refs/tags/}
+      # Step required "thanks" to https://github.com/actions/runner-images/issues/6283
+      - uses: Homebrew/actions/setup-homebrew@29b2973f18e5aca5443f4b3d87f68eda7a27b22b
+      - run: brew install ldid
+      - run: |
           cp node_modules/@npcz/magic/dist/magic.mgc assets/magic.mgc
           npx --yes pkg --no-bytecode --public-packages "*" --public package.json
-          rm assets/magic.mgc
-          for cmd in '' runner publish pr; do
-            build/cml-linux-x64 $cmd --version
-          done
+          for cmd in '' runner publish pr; do build/cml-linux-x64 $cmd --version; done
           cp build/cml-linux{-x64,}
           cp build/cml-macos{-x64,}
-      - uses: softprops/action-gh-release@v1
-        if: inputs.release
-        with:
-          files: |
-            build/cml-alpine-arm64
-            build/cml-alpine-x64
-            build/cml-linux-arm64
-            build/cml-linuxstatic-arm64
-            build/cml-linuxstatic-x64
-            build/cml-linux-x64
-            build/cml-linux
-            build/cml-macos-arm64
-            build/cml-macos-x64
-            build/cml-macos
-            build/cml-win-arm64.exe
-            build/cml-win-x64.exe
+      - if: inputs.release
+        run:
+          find build -type f | xargs gh release upload $(basename ${{
+          github.head_ref }})
         env:
           GITHUB_TOKEN: ${{ secrets.TEST_GITHUB_TOKEN }}
   images:
     needs: packages
     secrets: inherit
     uses: ./.github/workflows/images.yml
     with:
-      release: ${{ inputs.release }}
+      release: ${{ inputs.release || false }}

Dockerfile

@@ -116,6 +116,8 @@ WORKDIR ${CML_RUNNER_PATH}
 # SET SPECIFIC ENVIRONMENT VARIABLES
 ENV IN_DOCKER=1
 ENV RUNNER_ALLOW_RUNASROOT=1
+# Environment variable used by cml to detect it's been installed using the docker image.
+ENV _CML_CONTAINER_IMAGE=true
 
 # DEFINE ENTRY POINT AND COMMAND
 # Smart entrypoint understands commands like `bash` or `/bin/sh` but defaults to `cml`;

bin/cml.js

@@ -48,7 +48,6 @@ const setupOpts = (opts) => {
 
   const { markdownfile } = opts;
   opts.markdownFile = markdownfile;
-  opts.cmlCommand = opts._[0];
   opts.cml = new CML(opts);
 };
 
@@ -76,9 +75,29 @@ const setupLogger = (opts) => {
   });
 };
 
-const setupTelemetry = async (opts) => {
-  const { cml, cmlCommand: action } = opts;
-  opts.telemetryEvent = await jitsuEventPayload({ action, cml });
+const setupTelemetry = async (opts, yargs) => {
+  const { cml, _: command } = opts;
+
+  const options = {};
+  for (const [name, option] of Object.entries(opts.options)) {
+    // Skip options with default values (i.e. not explicitly set by users)
+    if (opts[name] && !yargs.parsed.defaulted[name]) {
+      switch (option.telemetryData) {
+        case 'name':
+          options[name] = null;
+          break;
+        case 'full':
+          options[name] = opts[name];
+          break;
+      }
+    }
+  }
+
+  opts.telemetryEvent = await jitsuEventPayload({
+    action: command.join(':'),
+    extra: { options },
+    cml
+  });
 };
 
 const runPlugin = async ({ $0: executable, command }) => {
@@ -99,6 +118,7 @@ const handleError = (message, error) => {
 
 (async () => {
   setupLogger({ log: 'debug' });
+
   try {
     await yargs
       .env('CML')

bin/cml/asset/publish.js

@@ -15,15 +15,19 @@ exports.handler = async (opts) => {
     opts.native = true;
   }
 
-  const { file, repo, native, asset: path } = opts;
-  const cml = new CML({ ...opts, repo: native ? repo : 'cml' });
+  const { file, asset: path } = opts;
+  const cml = new CML({ ...opts });
   const output = await cml.publish({ ...opts, path });
 
   if (!file) console.log(output);
   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);
 
 exports.options = kebabcaseKeys({
   url: {
@@ -51,7 +55,8 @@ exports.options = kebabcaseKeys({
   },
   rmWatermark: {
     type: 'boolean',
-    description: 'Avoid CML watermark.'
+    description: 'Avoid CML watermark.',
+    telemetryData: 'name'
   },
   mimeType: {
     type: 'string',

bin/cml/check/create.js

@@ -10,7 +10,11 @@ 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);
 
 exports.options = kebabcaseKeys({
   token: {

bin/cml/comment/create.js

@@ -8,7 +8,11 @@ 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);
 
 exports.options = kebabcaseKeys({
   pr: {
@@ -33,18 +37,21 @@ exports.options = kebabcaseKeys({
   },
   publish: {
     type: 'boolean',
+    default: true,
     description: 'Upload any local images found in the Markdown report'
   },
   publishUrl: {
     type: 'string',
     default: 'https://asset.cml.dev',
-    description: 'Self-hosted image server URL'
+    description: 'Self-hosted image server URL',
+    telemetryData: 'name'
   },
   publishNative: {
     type: 'boolean',
     alias: 'native',
     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",
+    telemetryData: 'name'
   },
   update: {
     type: 'boolean',
@@ -55,6 +62,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',
+    telemetryData: 'name'
   }
 });

bin/cml/comment/create.test.js

@@ -25,7 +25,7 @@ describe('Comment integration tests', () => {
         --commit-sha, --head-sha    Commit SHA linked to this comment
                                                             [string] [default: \\"HEAD\\"]
         --publish                   Upload any local images found in the Markdown
-                                    report                                   [boolean]
+                                    report                   [boolean] [default: true]
         --publish-url               Self-hosted image server URL
                                            [string] [default: \\"https://asset.cml.dev\\"]
         --publish-native, --native  Uses driver's native capabilities to upload assets

bin/cml/pr.js

@@ -16,5 +16,6 @@ exports.builder = (yargs) =>
         ])
       )
     )
+    .option('options', { default: options, hidden: true })
     .check(({ globpath }) => globpath)
     .strict();

bin/cml/pr/create.js

@@ -15,7 +15,11 @@ 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);
 
 exports.options = kebabcaseKeys({
   md: {

bin/cml/repo/prepare.js

@@ -10,7 +10,11 @@ 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);
 
 exports.options = kebabcaseKeys({
   unshallow: {

bin/cml/runner.js

@@ -16,5 +16,6 @@ exports.builder = (yargs) =>
         ])
       )
     )
+    .option('options', { default: options, hidden: true })
     .check(() => process.argv.some((arg) => arg.startsWith('-')))
     .strict();

bin/cml/runner/launch.js

@@ -338,16 +338,8 @@ const run = async (opts) => {
     process.on(signal, () => shutdown({ ...opts, reason: signal }));
   });
 
-  const {
-    driver,
-    workdir,
-    cloud,
-    labels,
-    name,
-    reuse,
-    reuseIdle,
-    dockerVolumes
-  } = opts;
+  const { workdir, cloud, labels, name, reuse, reuseIdle, dockerVolumes } =
+    opts;
 
   await cml.repoTokenCheck();
 
@@ -375,7 +367,7 @@ const run = async (opts) => {
   }
 
   if (reuseIdle) {
-    if (driver === 'bitbucket') {
+    if (cml.driver === 'bitbucket') {
       throw new Error(
         'cml runner flag --reuse-idle is unsupported by bitbucket'
       );
@@ -396,7 +388,7 @@ const run = async (opts) => {
   if (dockerVolumes.length && cml.driver !== 'gitlab')
     winston.warn('Parameters --docker-volumes is only supported in gitlab');
 
-  if (driver === 'github')
+  if (cml.driver === 'github')
     winston.warn(
       'Github Actions timeout has been updated from 72h to 35 days. Update your workflow accordingly to be able to restart it automatically.'
     );
@@ -426,7 +418,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 +458,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",
+    telemetryData: 'name'
   },
   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",
+    telemetryData: 'name'
   },
   workdir: {
     type: 'string',
@@ -484,7 +482,8 @@ exports.options = kebabcaseKeys({
   cloud: {
     type: 'string',
     choices: ['aws', 'azure', 'gcp', 'kubernetes'],
-    description: 'Cloud to deploy the runner'
+    description: 'Cloud to deploy the runner',
+    telemetryData: 'full'
   },
   cloudRegion: {
     type: 'string',
@@ -537,12 +536,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',
+    telemetryData: 'name'
   },
   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',
+    telemetryData: 'name'
   },
   cloudAwsSecurityGroup: {
     type: 'string',

bin/cml/tensorboard/connect.e2e.test.js

@@ -34,7 +34,7 @@ describe('tbLink', () => {
       error = err;
     }
 
-    expect(error.message).toBe(`Tensorboard took too long. ${message}`);
+    expect(error.message).toBe(`Tensorboard took too long`);
   });
 
   test('valid url is returned', async () => {