@devicecloud.dev/dcd 3.3.6 → 3.3.8

package/dist/commands/cloud.d.ts

@@ -57,6 +57,17 @@ export default class Cloud extends Command {
         quiet: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         retry: import("@oclif/core/lib/interfaces").OptionFlag<number | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         report: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };
-    run(): Promise<void>;
+    static enableJsonFlag: boolean;
+    private versionCheck;
+    run(): Promise<{
+        uploadId: string;
+        consoleUrl: string;
+        status: string;
+        tests: {
+            name: string;
+            status: string;
+        }[];
+    } | undefined>;
 }

package/dist/commands/cloud.js

@@ -63,15 +63,30 @@ class Cloud extends core_1.Command {
     static description = `Test a Flow or set of Flows on devicecloud.dev (https://devicecloud.dev)\nProvide your application file and a folder with Maestro flows to run them in parallel on multiple devices in devicecloud.dev\nThe command will block until all analyses have completed`;
     static examples = ['<%= config.bin %> <%= command.id %>'];
     static flags = constants_1.flags;
+    static enableJsonFlag = true;
+    versionCheck = async () => {
+        const versionResponse = await fetch('https://registry.npmjs.org/@devicecloud.dev/dcd/latest');
+        const versionResponseJson = await versionResponse.json();
+        const latestVersion = versionResponseJson.version;
+        if (latestVersion !== this.config.version) {
+            this.log(`
+  -------------------
+  A new version of the devicecloud.dev CLI is available: ${latestVersion}
+  Run 'npm install -g @devicecloud.dev/dcd@latest' to update to the latest version
+  -------------------
+  `);
+        }
+    };
     async run() {
+        let output = null;
         try {
             const [major] = process.versions.node.split('.').map(Number);
             if (major < 18) {
                 throw new Error(`You are using node version ${major}. DCD requires node version 18 or later`);
             }
-            await (0, methods_1.versionCheck)(this.config.version);
+            await this.versionCheck();
             const { args, flags, raw } = await this.parse(Cloud);
-            const { 'additional-app-binary-ids': nonFlatAdditionalAppBinaryIds, 'additional-app-files': nonFlatAdditionalAppFiles, 'android-api-level': androidApiLevel, 'android-device': androidDevice, apiKey: apiKeyFlag, apiUrl, 'app-binary-id': appBinaryId, 'app-file': appFile, async, 'device-locale': deviceLocale, 'download-artifacts': downloadArtifacts, env, 'exclude-flows': excludeFlows, 'exclude-tags': excludeTags, flows, 'google-play': googlePlay, 'include-tags': includeTags, 'ignore-sha-check': ignoreShaCheck, 'ios-device': iOSDevice, 'ios-version': iOSVersion, 'maestro-version': maestroVersion, name, orientation, quiet, retry, report, 'x86-arch': x86Arch, ...rest } = flags;
+            const { 'additional-app-binary-ids': nonFlatAdditionalAppBinaryIds, 'additional-app-files': nonFlatAdditionalAppFiles, 'android-api-level': androidApiLevel, 'android-device': androidDevice, apiKey: apiKeyFlag, apiUrl, 'app-binary-id': appBinaryId, 'app-file': appFile, async, 'device-locale': deviceLocale, 'download-artifacts': downloadArtifacts, env, 'exclude-flows': excludeFlows, 'exclude-tags': excludeTags, flows, 'google-play': googlePlay, 'include-tags': includeTags, 'ignore-sha-check': ignoreShaCheck, 'ios-device': iOSDevice, 'ios-version': iOSVersion, 'maestro-version': maestroVersion, name, orientation, quiet, retry, report, 'x86-arch': x86Arch, json, ...rest } = flags;
             const apiKey = apiKeyFlag || process.env.DEVICE_CLOUD_API_KEY;
             if (!apiKey)
                 throw new Error('You must provide an API key via --api-key flag or DEVICE_CLOUD_API_KEY environment variable');
@@ -181,12 +196,12 @@ class Cloud extends core_1.Command {
             if (!finalBinaryId) {
                 if (!finalAppFile)
                     throw new Error('You must provide either an app binary id or an app file');
-                const binaryId = await (0, methods_1.uploadBinary)(finalAppFile, apiUrl, apiKey, ignoreShaCheck);
+                const binaryId = await (0, methods_1.uploadBinary)(finalAppFile, apiUrl, apiKey, ignoreShaCheck, !json);
                 finalBinaryId = binaryId;
             }
             let uploadedBinaryIds = [];
             if (additionalAppFiles?.length) {
-                uploadedBinaryIds = await (0, methods_1.uploadBinaries)(additionalAppFiles, apiUrl, apiKey, ignoreShaCheck);
+                uploadedBinaryIds = await (0, methods_1.uploadBinaries)(additionalAppFiles, apiUrl, apiKey, ignoreShaCheck, !json);
                 finalAdditionalBinaryIds = [
                     ...finalAdditionalBinaryIds,
                     ...uploadedBinaryIds,
@@ -269,14 +284,32 @@ class Cloud extends core_1.Command {
                 .join(', ')}\n`);
             this.log('Run triggered, you can access the results at:');
             const url = `https://console.devicecloud.dev/results?upload=${results[0].test_upload_id}&result=${results[0].id}`;
-            core_1.ux.url(url, url);
+            this.log(url);
+            this.log(`\n`);
+            this.log(`Your upload ID is: ${results[0].test_upload_id}`);
+            this.log(`Poll upload status using: dcd status --api-key ... --upload-id ${results[0].test_upload_id}`);
             if (async) {
+                if (json) {
+                    return {
+                        uploadId: results[0].test_upload_id,
+                        consoleUrl: url,
+                        status: 'PENDING',
+                        tests: results.map((r) => ({
+                            name: r.test_file_name,
+                            status: r.status,
+                        })),
+                    };
+                }
                 this.log('Not waiting for results as async flag is set to true');
                 return;
             }
             // poll for the run status every 5 seconds
-            core_1.ux.action.start('Waiting for results', 'Initializing', { stdout: true });
-            this.log('\nYou can safely close this terminal and the tests will continue\n');
+            if (!json) {
+                core_1.ux.action.start('Waiting for results', 'Initializing', {
+                    stdout: true,
+                });
+                this.log('\nYou can safely close this terminal and the tests will continue\n');
+            }
             let sequentialPollFaillures = 0;
             await new Promise((resolve, reject) => {
                 const intervalId = setInterval(async () => {
@@ -287,7 +320,7 @@ class Cloud extends core_1.Command {
                         if (!updatedResults) {
                             throw new Error('no results');
                         }
-                        if (!quiet) {
+                        if (!quiet || !json) {
                             core_1.ux.action.status =
                                 '\nStatus      Test\n─────────── ───────────────';
                             for (const { retry_of: isRetry, status, test_file_name: test, } of updatedResults) {
@@ -295,18 +328,20 @@ class Cloud extends core_1.Command {
                             }
                         }
                         if (updatedResults.every((result) => !['PENDING', 'RUNNING'].includes(result.status))) {
-                            core_1.ux.action.stop('completed');
-                            this.log('\n');
-                            (0, cli_ux_1.table)(updatedResults, {
-                                status: { get: (row) => row.status },
-                                test: {
-                                    get: (row) => `${row.test_file_name} ${row.retry_of ? '(retry)' : ''}`,
-                                },
-                            }, { printLine: this.log.bind(this) });
-                            this.log('\n');
-                            this.log('Run completed, you can access the results at:');
-                            core_1.ux.url(url, url);
-                            this.log('\n');
+                            if (!json) {
+                                core_1.ux.action.stop('completed');
+                                this.log('\n');
+                                (0, cli_ux_1.table)(updatedResults, {
+                                    status: { get: (row) => row.status },
+                                    test: {
+                                        get: (row) => `${row.test_file_name} ${row.retry_of ? '(retry)' : ''}`,
+                                    },
+                                }, { printLine: this.log.bind(this) });
+                                this.log('\n');
+                                this.log('Run completed, you can access the results at:');
+                                this.log(url);
+                                this.log('\n');
+                            }
                             clearInterval(intervalId);
                             if (downloadArtifacts) {
                                 try {
@@ -330,8 +365,32 @@ class Cloud extends core_1.Command {
                                 return result.id === Math.max(...tries.map((t) => t.id));
                             });
                             if (resultsWithoutEarlierTries.some((result) => result.status === 'FAILED')) {
+                                if (json) {
+                                    output = {
+                                        uploadId: results[0].test_upload_id,
+                                        consoleUrl: url,
+                                        status: 'FAILED',
+                                        tests: resultsWithoutEarlierTries.map((r) => ({
+                                            name: r.test_file_name,
+                                            status: r.status,
+                                        })),
+                                    };
+                                }
                                 reject(new Error('RUN_FAILED'));
                             }
+                            else {
+                                if (json) {
+                                    output = {
+                                        uploadId: results[0].test_upload_id,
+                                        consoleUrl: url,
+                                        status: 'PASSED',
+                                        tests: resultsWithoutEarlierTries.map((r) => ({
+                                            name: r.test_file_name,
+                                            status: r.status,
+                                        })),
+                                    };
+                                }
+                            }
                             sequentialPollFaillures = 0;
                             resolve();
                         }
@@ -354,6 +413,11 @@ class Cloud extends core_1.Command {
             }
             this.error(error, { exit: 1 });
         }
+        finally {
+            if (output) {
+                return output;
+            }
+        }
     }
 }
 exports.default = Cloud;

package/dist/commands/status.d.ts

@@ -1,7 +1,18 @@
 import { Command } from '@oclif/core';
+type StatusResponse = {
+    status: 'FAILED' | 'PASSED' | 'CANCELLED' | 'PENDING' | 'RUNNING';
+    tests: {
+        name: string;
+        status: 'FAILED' | 'PASSED' | 'CANCELLED' | 'PENDING' | 'RUNNING';
+    }[];
+    uploadId?: string;
+    appBinaryId?: string;
+    consoleUrl?: string;
+};
 export default class Status extends Command {
     static description: string;
     static examples: string[];
+    static enableJsonFlag: boolean;
     static flags: {
         json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         name: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
@@ -10,5 +21,6 @@ export default class Status extends Command {
         apiUrl: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
     };
     private getStatusSymbol;
-    run(): Promise<void>;
+    run(): Promise<StatusResponse | void>;
 }
+export {};

package/dist/commands/status.js

@@ -9,6 +9,7 @@ class Status extends core_1.Command {
         '<%= config.bin %> <%= command.id %> --name my-upload-name',
         '<%= config.bin %> <%= command.id %> --upload-id 123e4567-e89b-12d3-a456-426614174000 --json',
     ];
+    static enableJsonFlag = true;
     static flags = {
         json: core_1.Flags.boolean({
             description: 'output in json format',
@@ -40,7 +41,7 @@ class Status extends core_1.Command {
     }
     async run() {
         const { flags } = await this.parse(Status);
-        const { apiUrl, apiKey, name, 'upload-id': uploadId } = flags;
+        const { apiUrl, apiKey, name, 'upload-id': uploadId, json } = flags;
         if (!apiKey) {
             this.error('API Key is required. Please provide it via --api-key flag or DEVICE_CLOUD_API_KEY environment variable.');
             return;
@@ -54,8 +55,8 @@ class Status extends core_1.Command {
                 name,
                 uploadId,
             }));
-            if (flags.json) {
-                this.log(JSON.stringify(status, null, 2));
+            if (json) {
+                return status;
             }
             else {
                 this.log('\n📊 Upload Status');

package/dist/constants.d.ts

@@ -27,6 +27,7 @@ export declare const flags: {
     quiet: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     retry: import("@oclif/core/lib/interfaces").OptionFlag<number | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     report: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
 };
 export declare const iOSCompatibilityLookup: {
     [k in EiOSDevices]: string[];

package/dist/constants.js

@@ -166,6 +166,9 @@ exports.flags = {
         description: 'Runs Maestro with the --format flag, this will generate a report in the specified format',
         options: ['junit', 'html'],
     }),
+    json: core_1.Flags.boolean({
+        description: 'Output results in JSON format - note: will always provide exit code 0',
+    }),
 };
 exports.iOSCompatibilityLookup = {
     'ipad-pro-6th-gen': ['16', '17', '18'],

package/dist/methods.d.ts

@@ -1,7 +1,6 @@
 import * as archiver from 'archiver';
 import { paths } from '../../api/schema.types';
 import { TAppMetadata } from './types';
-export declare const versionCheck: (currentVersion: string) => Promise<void>;
 export declare const typeSafePost: <T extends keyof paths>(baseUrl: string, path: string, init?: {
     body?: BodyInit;
     headers?: HeadersInit;
@@ -22,8 +21,8 @@ export declare const verifyAppZip: (zipPath: string) => Promise<void>;
 export declare const extractAppMetadataAndroid: (appFilePath: string) => Promise<TAppMetadata>;
 export declare const extractAppMetadataIosZip: (appFilePath: string) => Promise<TAppMetadata>;
 export declare const extractAppMetadataIos: (appFolderPath: string) => Promise<TAppMetadata>;
-export declare const uploadBinary: (filePath: string, apiUrl: string, apiKey: string, ignoreShaCheck?: boolean) => Promise<string>;
-export declare const uploadBinaries: (finalAppFiles: string[], apiUrl: string, apiKey: string, ignoreShaCheck?: boolean) => Promise<string[]>;
+export declare const uploadBinary: (filePath: string, apiUrl: string, apiKey: string, ignoreShaCheck?: boolean, log?: boolean) => Promise<string>;
+export declare const uploadBinaries: (finalAppFiles: string[], apiUrl: string, apiKey: string, ignoreShaCheck?: boolean, log?: boolean) => Promise<string[]>;
 export declare const verifyAdditionalAppFiles: (appFiles: string[] | undefined) => Promise<void>;
 export declare const getUploadStatus: (apiUrl: string, apiKey: string, options: {
     uploadId?: string;

package/dist/methods.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getUploadStatus = exports.verifyAdditionalAppFiles = exports.uploadBinaries = exports.uploadBinary = exports.extractAppMetadataIos = exports.extractAppMetadataIosZip = exports.extractAppMetadataAndroid = exports.verifyAppZip = exports.compressFilesFromRelativePath = exports.compressFolderToBlob = exports.compressDir = exports.toBuffer = exports.typeSafeGet = exports.typeSafePostDownload = exports.typeSafePost = exports.versionCheck = void 0;
+exports.getUploadStatus = exports.verifyAdditionalAppFiles = exports.uploadBinaries = exports.uploadBinary = exports.extractAppMetadataIos = exports.extractAppMetadataIosZip = exports.extractAppMetadataAndroid = exports.verifyAppZip = exports.compressFilesFromRelativePath = exports.compressFolderToBlob = exports.compressDir = exports.toBuffer = exports.typeSafeGet = exports.typeSafePostDownload = exports.typeSafePost = void 0;
 const core_1 = require("@oclif/core");
 const supabase_js_1 = require("@supabase/supabase-js");
 // required polyfill for node 18
@@ -29,20 +29,6 @@ const PERMITTED_EXTENSIONS = new Set([
     'mp4',
     'js',
 ]);
-const versionCheck = async (currentVersion) => {
-    const versionResponse = await fetch('https://registry.npmjs.org/@devicecloud.dev/dcd/latest');
-    const versionResponseJson = await versionResponse.json();
-    const latestVersion = versionResponseJson.version;
-    if (latestVersion !== currentVersion) {
-        console.log(`
--------------------
-A new version of the devicecloud.dev CLI is available: ${latestVersion}
-Run 'npm install -g @devicecloud.dev/dcd@latest' to update to the latest version
--------------------
-`);
-    }
-};
-exports.versionCheck = versionCheck;
 const typeSafePost = async (baseUrl, path, init) => {
     const res = await fetch(baseUrl + path, {
         ...init,
@@ -193,10 +179,7 @@ const extractAppMetadataIosZip = async (appFilePath) => new Promise((resolve, re
         })
             .catch(reject);
     });
-    zip.on('error', (err) => {
-        console.error(err);
-        reject(err);
-    });
+    zip.on('error', reject);
 });
 exports.extractAppMetadataIosZip = extractAppMetadataIosZip;
 const extractAppMetadataIos = async (appFolderPath) => {
@@ -207,10 +190,12 @@ const extractAppMetadataIos = async (appFolderPath) => {
     return { appId, platform: 'ios' };
 };
 exports.extractAppMetadataIos = extractAppMetadataIos;
-const uploadBinary = async (filePath, apiUrl, apiKey, ignoreShaCheck = false) => {
-    core_1.ux.action.start('Checking and uploading binary', 'Initializing', {
-        stdout: true,
-    });
+const uploadBinary = async (filePath, apiUrl, apiKey, ignoreShaCheck = false, log = true) => {
+    if (log) {
+        core_1.ux.action.start('Checking and uploading binary', 'Initializing', {
+            stdout: true,
+        });
+    }
     let file;
     if (filePath?.endsWith('.app')) {
         const zippedAppBlob = await (0, exports.compressFolderToBlob)(filePath);
@@ -227,7 +212,9 @@ const uploadBinary = async (filePath, apiUrl, apiKey, ignoreShaCheck = false) =>
         sha = await getFileHashFromFile(file);
     }
     catch (e) {
-        console.warn('Warning: Failed to get file hash', e);
+        if (log) {
+            console.warn('Warning: Failed to get file hash', e);
+        }
     }
     if (!ignoreShaCheck && sha) {
         try {
@@ -239,8 +226,10 @@ const uploadBinary = async (filePath, apiUrl, apiKey, ignoreShaCheck = false) =>
                 },
             });
             if (exists) {
-                core_1.ux.info(`sha hash matches existing binary with id: ${appBinaryId}, skipping upload. Force upload with --ignore-sha-check`);
-                core_1.ux.action.stop(`Skipping upload.`);
+                if (log) {
+                    core_1.ux.info(`sha hash matches existing binary with id: ${appBinaryId}, skipping upload. Force upload with --ignore-sha-check`);
+                    core_1.ux.action.stop(`Skipping upload.`);
+                }
                 return appBinaryId;
             }
         }
@@ -268,7 +257,9 @@ const uploadBinary = async (filePath, apiUrl, apiKey, ignoreShaCheck = false) =>
                 : await (0, exports.extractAppMetadataIos)(filePath);
     }
     catch {
-        core_1.ux.warn('Failed to extract app metadata, please share with support@devicecloud.dev so we can improve our parsing.');
+        if (log) {
+            core_1.ux.warn('Failed to extract app metadata, please share with support@devicecloud.dev so we can improve our parsing.');
+        }
     }
     // this needs to made nicer by using envs or maybe fetching the keys from the getSignedURL call
     const SB = {
@@ -297,11 +288,13 @@ const uploadBinary = async (filePath, apiUrl, apiKey, ignoreShaCheck = false) =>
     });
     if (error)
         throw new Error(error);
-    core_1.ux.action.stop(`\nBinary uploaded with id: ${id}`);
+    if (log) {
+        core_1.ux.action.stop(`\nBinary uploaded with id: ${id}`);
+    }
     return id;
 };
 exports.uploadBinary = uploadBinary;
-const uploadBinaries = async (finalAppFiles, apiUrl, apiKey, ignoreShaCheck = false) => Promise.all(finalAppFiles.map((f) => (0, exports.uploadBinary)(f, apiUrl, apiKey, ignoreShaCheck)));
+const uploadBinaries = async (finalAppFiles, apiUrl, apiKey, ignoreShaCheck = false, log = true) => Promise.all(finalAppFiles.map((f) => (0, exports.uploadBinary)(f, apiUrl, apiKey, ignoreShaCheck, log)));
 exports.uploadBinaries = uploadBinaries;
 const verifyAdditionalAppFiles = async (appFiles) => {
     if (appFiles?.length) {

package/oclif.manifest.json

@@ -19,6 +19,12 @@
         "<%= config.bin %> <%= command.id %>"
       ],
       "flags": {
+        "json": {
+          "description": "Output results in JSON format - note: will always provide exit code 0",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "additional-app-binary-ids": {
           "description": "The ID of the additional app binary(s) previously uploaded to devicecloud.dev to install before execution",
           "name": "additional-app-binary-ids",
@@ -315,7 +321,7 @@
       "pluginName": "@devicecloud.dev/dcd",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
+      "enableJsonFlag": true,
       "isESM": false,
       "relativePath": [
         "dist",
@@ -389,7 +395,7 @@
       "pluginName": "@devicecloud.dev/dcd",
       "pluginType": "core",
       "strict": true,
-      "enableJsonFlag": false,
+      "enableJsonFlag": true,
       "isESM": false,
       "relativePath": [
         "dist",
@@ -398,5 +404,5 @@
       ]
     }
   },
-  "version": "3.3.6"
+  "version": "3.3.8"
 }

package/package.json

@@ -80,7 +80,7 @@
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
     "version": "oclif readme && git add README.md"
   },
-  "version": "3.3.6",
+  "version": "3.3.8",
   "bugs": {
     "url": "https://discord.gg/gm3mJwcNw8"
   },