@devicecloud.dev/dcd 3.1.1-alpha.0 → 3.2.0

package/dist/commands/cloud.d.ts

@@ -47,6 +47,7 @@ export default class Cloud extends Command {
         flows: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         'google-play': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         'include-tags': import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces").CustomOptions>;
+        'ignore-sha-check': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         'ios-device': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         'ios-version': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         'maestro-version': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;

package/dist/commands/cloud.js

@@ -62,9 +62,10 @@ class Cloud extends core_1.Command {
             }
             await (0, methods_1.versionCheck)(this.config.version);
             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, 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, 'ios-device': iOSDevice, 'ios-version': iOSVersion, 'maestro-version': maestroVersion, name, orientation, quiet, retry, report, ...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, ...rest } = flags;
+            const apiKey = apiKeyFlag || process.env.DEVICE_CLOUD_API_KEY;
             if (!apiKey)
-                throw new Error('You must provide an API key');
+                throw new Error('You must provide an API key via --api-key flag or DEVICE_CLOUD_API_KEY environment variable');
             if (retry) {
                 if (retry < 0)
                     throw new Error('Retry must be a positive number');
@@ -173,12 +174,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);
+                const binaryId = await (0, methods_1.uploadBinary)(finalAppFile, apiUrl, apiKey, ignoreShaCheck);
                 finalBinaryId = binaryId;
             }
             let uploadedBinaryIds = [];
             if (additionalAppFiles?.length) {
-                uploadedBinaryIds = await (0, methods_1.uploadBinaries)(additionalAppFiles, apiUrl, apiKey);
+                uploadedBinaryIds = await (0, methods_1.uploadBinaries)(additionalAppFiles, apiUrl, apiKey, ignoreShaCheck);
                 finalAdditionalBinaryIds = [
                     ...finalAdditionalBinaryIds,
                     ...uploadedBinaryIds,

package/dist/constants.d.ts

@@ -17,6 +17,7 @@ export declare const flags: {
     flows: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     'google-play': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     'include-tags': import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces").CustomOptions>;
+    'ignore-sha-check': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     'ios-device': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     'ios-version': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     'maestro-version': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;

package/dist/constants.js

@@ -33,7 +33,7 @@ exports.flags = {
     }),
     apiKey: core_1.Flags.string({
         aliases: ['api-key'],
-        description: 'API key',
+        description: 'API key for devicecloud.dev (find this in the console UI). You can also set the DEVICE_CLOUD_API_KEY environment variable.',
     }),
     apiUrl: core_1.Flags.string({
         aliases: ['api-url', 'apiURL'],
@@ -56,7 +56,7 @@ exports.flags = {
         description: 'Locale that will be set to a device, ISO-639-1 code and uppercase ISO-3166-1 code e.g. "de_DE" for Germany',
     }),
     'download-artifacts': core_1.Flags.string({
-        description: 'BETA (API may change) - download a zip containing the logs, screenshots and videos for each result in this run. You will debited a $0.01 egress fee for each result. Use --download-artifacts=FAILED for failures only or --download-artifacts=ALL for every result.',
+        description: 'Download a zip containing the logs, screenshots and videos for each result in this run. You will debited a $0.01 egress fee for each result. Use --download-artifacts=FAILED for failures only or --download-artifacts=ALL for every result.',
         options: ['ALL', 'FAILED'],
     }),
     env: core_1.Flags.file({
@@ -96,6 +96,9 @@ exports.flags = {
         multipleNonGreedy: true,
         parse: (input) => input.split(','),
     }),
+    'ignore-sha-check': core_1.Flags.boolean({
+        description: 'Ignore the sha hash check and upload the binary regardless of whether it already exists (not recommended)',
+    }),
     'ios-device': core_1.Flags.string({
         description: '[iOS only] iOS device to run your flow against',
         options: [

package/dist/methods.d.ts

@@ -22,6 +22,6 @@ 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) => Promise<string>;
-export declare const uploadBinaries: (finalAppFiles: string[], apiUrl: string, apiKey: string) => Promise<string[]>;
+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 verifyAdditionalAppFiles: (appFiles: string[] | undefined) => Promise<void>;

package/dist/methods.js

@@ -17,7 +17,6 @@ const promises_2 = require("node:stream/promises");
 const StreamZip = require("node-stream-zip");
 const plist_1 = require("plist");
 const node_crypto_1 = require("node:crypto");
-const node_fs_2 = require("node:fs");
 const cloud_1 = require("./commands/cloud");
 const PERMITTED_EXTENSIONS = new Set([
     'yml',
@@ -207,19 +206,10 @@ const extractAppMetadataIos = async (appFolderPath) => {
     return { appId, platform: 'ios' };
 };
 exports.extractAppMetadataIos = extractAppMetadataIos;
-const uploadBinary = async (filePath, apiUrl, apiKey) => {
-    core_1.ux.action.start('Uploading binary', 'Initializing', { stdout: true });
-    const { id, message, path, token } = await (0, exports.typeSafePost)(apiUrl, '/uploads/getBinaryUploadUrl', {
-        body: JSON.stringify({
-            platform: filePath?.endsWith('.apk') ? 'android' : 'ios',
-        }),
-        headers: {
-            'content-type': 'application/json',
-            'x-app-api-key': apiKey,
-        },
+const uploadBinary = async (filePath, apiUrl, apiKey, ignoreShaCheck = false) => {
+    core_1.ux.action.start('Checking and uploading binary', 'Initializing', {
+        stdout: true,
     });
-    if (!path)
-        throw new Error(message);
     let file;
     if (filePath?.endsWith('.app')) {
         const zippedAppBlob = await (0, exports.compressFolderToBlob)(filePath);
@@ -233,13 +223,36 @@ const uploadBinary = async (filePath, apiUrl, apiKey) => {
     }
     let sha = undefined;
     try {
-        sha = await getFileHash(filePath);
+        sha = await getFileHashFromFile(file);
+        if (!ignoreShaCheck) {
+            const { appBinaryId, exists } = await (0, exports.typeSafePost)(apiUrl, '/uploads/checkForExistingUpload', {
+                body: JSON.stringify({ sha }),
+                headers: {
+                    'content-type': 'application/json',
+                    'x-app-api-key': apiKey,
+                },
+            });
+            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.`);
+                return appBinaryId;
+            }
+        }
     }
     catch (e) {
-        console.log('Failed to get file hash', e);
-        throw new Error('Failed to get file hash');
-        // do nothing
+        console.warn('Warning: Failed to get file hash or check if binary exists', e);
     }
+    const { id, message, path, token } = await (0, exports.typeSafePost)(apiUrl, '/uploads/getBinaryUploadUrl', {
+        body: JSON.stringify({
+            platform: filePath?.endsWith('.apk') ? 'android' : 'ios',
+        }),
+        headers: {
+            'content-type': 'application/json',
+            'x-app-api-key': apiKey,
+        },
+    });
+    if (!path)
+        throw new Error(message);
     let metadata;
     try {
         metadata = filePath?.endsWith('.apk')
@@ -282,7 +295,7 @@ const uploadBinary = async (filePath, apiUrl, apiKey) => {
     return id;
 };
 exports.uploadBinary = uploadBinary;
-const uploadBinaries = async (finalAppFiles, apiUrl, apiKey) => Promise.all(finalAppFiles.map((f) => (0, exports.uploadBinary)(f, apiUrl, apiKey)));
+const uploadBinaries = async (finalAppFiles, apiUrl, apiKey, ignoreShaCheck = false) => Promise.all(finalAppFiles.map((f) => (0, exports.uploadBinary)(f, apiUrl, apiKey, ignoreShaCheck)));
 exports.uploadBinaries = uploadBinaries;
 const verifyAdditionalAppFiles = async (appFiles) => {
     if (appFiles?.length) {
@@ -297,12 +310,25 @@ const verifyAdditionalAppFiles = async (appFiles) => {
     }
 };
 exports.verifyAdditionalAppFiles = verifyAdditionalAppFiles;
-async function getFileHash(filePath) {
+async function getFileHashFromFile(file) {
     return new Promise((resolve, reject) => {
         const hash = (0, node_crypto_1.createHash)('sha256');
-        const stream = (0, node_fs_2.createReadStream)(filePath);
-        stream.on('error', (err) => reject(err));
-        stream.on('data', (chunk) => hash.update(chunk));
-        stream.on('end', () => resolve(hash.digest('hex')));
+        const stream = file.stream();
+        const reader = stream.getReader();
+        const processChunks = async () => {
+            try {
+                while (true) {
+                    const { done, value } = await reader.read();
+                    if (done)
+                        break;
+                    hash.update(value);
+                }
+                resolve(hash.digest('hex'));
+            }
+            catch (err) {
+                reject(err);
+            }
+        };
+        processChunks();
     });
 }

package/oclif.manifest.json

@@ -69,7 +69,7 @@
           "aliases": [
             "api-key"
           ],
-          "description": "API key",
+          "description": "API key for devicecloud.dev (find this in the console UI). You can also set the DEVICE_CLOUD_API_KEY environment variable.",
           "name": "apiKey",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -122,7 +122,7 @@
           "type": "option"
         },
         "download-artifacts": {
-          "description": "BETA (API may change) - download a zip containing the logs, screenshots and videos for each result in this run. You will debited a $0.01 egress fee for each result. Use --download-artifacts=FAILED for failures only or --download-artifacts=ALL for every result.",
+          "description": "Download a zip containing the logs, screenshots and videos for each result in this run. You will debited a $0.01 egress fee for each result. Use --download-artifacts=FAILED for failures only or --download-artifacts=ALL for every result.",
           "name": "download-artifacts",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -186,6 +186,12 @@
           "multiple": true,
           "type": "option"
         },
+        "ignore-sha-check": {
+          "description": "Ignore the sha hash check and upload the binary regardless of whether it already exists (not recommended)",
+          "name": "ignore-sha-check",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "ios-device": {
           "description": "[iOS only] iOS device to run your flow against",
           "name": "ios-device",
@@ -317,5 +323,5 @@
       ]
     }
   },
-  "version": "3.1.1-alpha.0"
+  "version": "3.2.0"
 }

package/package.json

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