@devicecloud.dev/dcd 4.0.1 → 4.0.3-beta.1

package/dist/commands/cloud.d.ts

@@ -18,6 +18,7 @@ export default class Cloud extends Command {
         'app-binary-id': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         'app-file': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         'artifacts-path': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'junit-path': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         async: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         config: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         debug: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
@@ -54,10 +55,14 @@ export default class Cloud extends Command {
     private versionCheck;
     run(): Promise<any>;
     /**
-     * Generate the JSON output file path based on upload ID or custom filename
-     * @param uploadId - Upload ID to use if custom filename is not provided
-     * @param jsonFileName - Optional custom filename (can include relative path)
-     * @returns Path to the JSON output file
+     * Handle downloading reports based on the report type specified
+     * @param reportType The type of report to download ('junit', 'allure', or 'all')
+     * @param apiUrl The base URL for the API server
+     * @param apiKey The API key for authentication
+     * @param uploadId The unique identifier for the test upload
+     * @param junitPath Optional file path where the JUnit report should be saved
+     * @param debug Whether debug logging is enabled
+     * @returns Promise that resolves when all reports have been downloaded
      */
-    private getJsonOutputPath;
+    private handleReportDownloads;
 }

package/dist/commands/cloud.js

@@ -64,7 +64,7 @@ class Cloud extends core_1.Command {
         let jsonFile = false;
         try {
             const { args, flags, raw } = await this.parse(Cloud);
-            let { '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, 'artifacts-path': artifactsPath, async, config: configFile, debug, 'device-locale': deviceLocale, 'download-artifacts': downloadArtifacts, 'dry-run': dryRun, env, 'exclude-flows': excludeFlows, 'exclude-tags': excludeTags, flows, 'google-play': googlePlay, 'ignore-sha-check': ignoreShaCheck, 'include-tags': includeTags, 'ios-device': iOSDevice, 'ios-version': iOSVersion, json, 'json-file-name': jsonFileName, 'maestro-version': maestroVersion, metadata, mitmHost, mitmPath, 'moropo-v1-api-key': moropoApiKey, name, orientation, quiet, report, retry, 'runner-type': runnerType, 'x86-arch': x86Arch, ...rest } = flags;
+            let { '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, 'artifacts-path': artifactsPath, 'junit-path': junitPath, async, config: configFile, debug, 'device-locale': deviceLocale, 'download-artifacts': downloadArtifacts, 'dry-run': dryRun, env, 'exclude-flows': excludeFlows, 'exclude-tags': excludeTags, flows, 'google-play': googlePlay, 'ignore-sha-check': ignoreShaCheck, 'include-tags': includeTags, 'ios-device': iOSDevice, 'ios-version': iOSVersion, json, 'json-file-name': jsonFileName, 'maestro-version': maestroVersion, metadata, mitmHost, mitmPath, 'moropo-v1-api-key': moropoApiKey, name, orientation, quiet, report, retry, 'runner-type': runnerType, 'x86-arch': x86Arch, ...rest } = flags;
             // Resolve "latest" maestro version to actual version
             const resolvedMaestroVersion = (0, constants_1.resolveMaestroVersion)(maestroVersion);
             // Store debug flag for use in catch block
@@ -228,6 +228,9 @@ class Cloud extends core_1.Command {
             if (runnerType === 'm1') {
                 this.log('Note: runnerType m1 is experimental and currently supports Android (Pixel 7, API Level 34) only.');
             }
+            if (runnerType === 'gpu1') {
+                this.log('Note: runnerType gpu1 is Android-only and requires contacting support to enable. Without support enablement, your runner type will revert to default.');
+            }
             const additionalAppBinaryIds = nonFlatAdditionalAppBinaryIds?.flat();
             const additionalAppFiles = nonFlatAdditionalAppFiles?.flat();
             const { firstFile, secondFile } = args;
@@ -589,7 +592,7 @@ class Cloud extends core_1.Command {
                     uploadId: results[0].test_upload_id,
                 };
                 if (flags['json-file']) {
-                    const jsonFilePath = this.getJsonOutputPath(results[0].test_upload_id, jsonFileName);
+                    const jsonFilePath = jsonFileName || `${results[0].test_upload_id}_dcd.json`;
                     (0, methods_1.writeJSONFile)(jsonFilePath, jsonOutput, this);
                 }
                 if (json) {
@@ -681,6 +684,10 @@ class Cloud extends core_1.Command {
                                     this.warn('Failed to download artifacts');
                                 }
                             }
+                            // Handle report downloads based on --report flag
+                            if (report && ['allure', 'html', 'junit'].includes(report)) {
+                                await this.handleReportDownloads(report, apiUrl, apiKey, results[0].test_upload_id, junitPath, debug);
+                            }
                             const resultsWithoutEarlierTries = updatedResults.filter((result) => {
                                 const originalTryId = result.retry_of || result.id;
                                 const tries = updatedResults.filter((r) => r.retry_of === originalTryId || r.id === originalTryId);
@@ -704,7 +711,7 @@ class Cloud extends core_1.Command {
                                     uploadId: results[0].test_upload_id,
                                 };
                                 if (flags['json-file']) {
-                                    const jsonFilePath = this.getJsonOutputPath(results[0].test_upload_id, jsonFileName);
+                                    const jsonFilePath = jsonFileName || `${results[0].test_upload_id}_dcd.json`;
                                     (0, methods_1.writeJSONFile)(jsonFilePath, jsonOutput, this);
                                 }
                                 if (json) {
@@ -730,7 +737,7 @@ class Cloud extends core_1.Command {
                                     uploadId: results[0].test_upload_id,
                                 };
                                 if (flags['json-file']) {
-                                    const jsonFilePath = this.getJsonOutputPath(results[0].test_upload_id, jsonFileName);
+                                    const jsonFilePath = jsonFileName || `${results[0].test_upload_id}_dcd.json`;
                                     (0, methods_1.writeJSONFile)(jsonFilePath, jsonOutput, this);
                                 }
                                 if (json) {
@@ -781,16 +788,62 @@ class Cloud extends core_1.Command {
         }
     }
     /**
-     * Generate the JSON output file path based on upload ID or custom filename
-     * @param uploadId - Upload ID to use if custom filename is not provided
-     * @param jsonFileName - Optional custom filename (can include relative path)
-     * @returns Path to the JSON output file
+     * Handle downloading reports based on the report type specified
+     * @param reportType The type of report to download ('junit', 'allure', or 'all')
+     * @param apiUrl The base URL for the API server
+     * @param apiKey The API key for authentication
+     * @param uploadId The unique identifier for the test upload
+     * @param junitPath Optional file path where the JUnit report should be saved
+     * @param debug Whether debug logging is enabled
+     * @returns Promise that resolves when all reports have been downloaded
      */
-    getJsonOutputPath(uploadId, jsonFileName) {
-        if (jsonFileName) {
-            return jsonFileName;
+    // eslint-disable-next-line max-params
+    async handleReportDownloads(reportType, apiUrl, apiKey, uploadId, junitPath, debug) {
+        const downloadReport = async (type, filePath) => {
+            try {
+                if (debug) {
+                    this.log(`DEBUG: Downloading ${type.toUpperCase()} report`);
+                }
+                await api_gateway_1.ApiGateway.downloadReportGeneric(apiUrl, apiKey, uploadId, type, filePath);
+                this.log(`${type.toUpperCase()} test report has been downloaded to ${filePath}`);
+            }
+            catch (error) {
+                if (debug) {
+                    this.log(`DEBUG: Error downloading ${type.toUpperCase()} report: ${error}`);
+                }
+                const errorMessage = error instanceof Error ? error.message : String(error);
+                this.warn(`Failed to download ${type.toUpperCase()} report: ${errorMessage}`);
+                if (errorMessage.includes('404')) {
+                    this.warn(`No ${type.toUpperCase()} reports found for this upload. Make sure your tests generated results.`);
+                }
+                else if (errorMessage.includes('EACCES') || errorMessage.includes('EPERM')) {
+                    this.warn('Permission denied. Check write permissions for the current directory.');
+                }
+                else if (errorMessage.includes('ENOENT')) {
+                    this.warn('Directory does not exist. Make sure you have write access to the current directory.');
+                }
+            }
+        };
+        switch (reportType) {
+            case 'junit': {
+                const reportPath = path.resolve(process.cwd(), junitPath || 'report.xml');
+                await downloadReport('junit', reportPath);
+                break;
+            }
+            case 'allure': {
+                const allureReportPath = path.resolve(process.cwd(), `allure-report-${uploadId}.zip`);
+                await downloadReport('allure', allureReportPath);
+                break;
+            }
+            case 'html': {
+                const htmlReportPath = path.resolve(process.cwd(), `html-report-${uploadId}.zip`);
+                await downloadReport('html', htmlReportPath);
+                break;
+            }
+            default: {
+                this.warn(`Unknown report type: ${reportType}`);
+            }
         }
-        return `${uploadId}_dcd.json`;
     }
 }
 exports.default = Cloud;

package/dist/constants.d.ts

@@ -12,6 +12,7 @@ export declare const flags: {
     'app-binary-id': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
     'app-file': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
     'artifacts-path': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'junit-path': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
     async: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     config: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
     debug: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;

package/dist/constants.js

@@ -73,6 +73,10 @@ exports.flags = {
         dependsOn: ['download-artifacts'],
         description: 'Custom file path for downloaded artifacts (default: ./artifacts.zip)',
     }),
+    'junit-path': core_1.Flags.string({
+        dependsOn: ['report'],
+        description: 'Custom file path for downloaded JUnit report (default: ./report.xml)',
+    }),
     async: core_1.Flags.boolean({
         description: 'Immediately return (exit code 0) from the command without waiting for the results of the run (useful for saving CI minutes)',
     }),
@@ -87,7 +91,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: '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 be debited a $0.01 egress fee for each result. Options: ALL (everything), FAILED (failures only).',
         options: ['ALL', 'FAILED'],
     }),
     'dry-run': core_1.Flags.boolean({
@@ -190,16 +194,16 @@ exports.flags = {
     }),
     report: core_1.Flags.string({
         aliases: ['format'],
-        description: 'Runs Maestro with the --format flag, this will generate a report in the specified format',
-        options: ['junit', 'html'],
+        description: 'Generate and download test reports in the specified format. HTML reports will be returned in the Allure format, please see the documentation for more details.',
+        options: ['junit', 'allure', 'html'],
     }),
     retry: core_1.Flags.integer({
         description: 'Automatically retry the run up to the number of times specified (same as pressing retry in the UI) - this is free of charge',
     }),
     'runner-type': core_1.Flags.string({
         default: 'default',
-        description: '[experimental] The type of runner to use - note: anything other than default will incur premium pricing tiers, see https://docs.devicecloud.dev/reference/runner-type for more information',
-        options: ['default', 'm4', 'm1'],
+        description: '[experimental] The type of runner to use - note: anything other than default will incur premium pricing tiers, see https://docs.devicecloud.dev/reference/runner-type for more information. gpu1 is Android-only and requires contacting support to enable, otherwise reverts to default.',
+        options: ['default', 'm4', 'm1', 'gpu1'],
     }),
     'show-crosshairs': core_1.Flags.boolean({
         default: false,

package/dist/gateways/api-gateway.d.ts

@@ -1,5 +1,12 @@
 import { TAppMetadata } from '../types';
 export declare const ApiGateway: {
+    /**
+     * Standardized error handling for API responses
+     * @param res - The fetch response object
+     * @param operation - Description of the operation that failed
+     * @returns Never returns, always throws
+     */
+    handleApiError(res: Response, operation: string): Promise<never>;
     checkForExistingUpload(baseUrl: string, apiKey: string, sha: string): Promise<{
         appBinaryId: string;
         exists: boolean;
@@ -7,14 +14,14 @@ export declare const ApiGateway: {
     downloadArtifactsZip(baseUrl: string, apiKey: string, uploadId: string, results: "ALL" | "FAILED", artifactsPath?: string): Promise<void>;
     finaliseUpload(baseUrl: string, apiKey: string, id: string, metadata: TAppMetadata, path: string, sha: string): Promise<Record<string, never>>;
     getBinaryUploadUrl(baseUrl: string, apiKey: string, platform: "android" | "ios"): Promise<{
-        id: string;
         message: string;
         path: string;
         token: string;
+        id: string;
     }>;
     getResultsForUpload(baseUrl: string, apiKey: string, uploadId: string): Promise<{
-        results?: import("../types/schema.types").components["schemas"]["TResultResponse"][];
         statusCode?: number;
+        results?: import("../types/schema.types").components["schemas"]["TResultResponse"][];
     }>;
     getUploadStatus(baseUrl: string, apiKey: string, options: {
         name?: string;
@@ -32,4 +39,14 @@ export declare const ApiGateway: {
         message?: string;
         results?: import("../types/schema.types").components["schemas"]["IDBResult"][];
     }>;
+    /**
+     * Generic report download method that handles both junit and allure reports
+     * @param baseUrl - API base URL
+     * @param apiKey - API key for authentication
+     * @param uploadId - Upload ID to download report for
+     * @param reportType - Type of report to download ('junit' or 'allure')
+     * @param reportPath - Optional custom path for the downloaded report
+     * @returns Promise that resolves when download is complete
+     */
+    downloadReportGeneric(baseUrl: string, apiKey: string, uploadId: string, reportType: "allure" | "junit" | "html", reportPath?: string): Promise<void>;
 };

package/dist/gateways/api-gateway.js

@@ -1,7 +1,50 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiGateway = void 0;
+const path = require("node:path");
 exports.ApiGateway = {
+    /**
+     * Standardized error handling for API responses
+     * @param res - The fetch response object
+     * @param operation - Description of the operation that failed
+     * @returns Never returns, always throws
+     */
+    async handleApiError(res, operation) {
+        const errorText = await res.text();
+        let userMessage;
+        // Parse common API error formats
+        try {
+            const errorData = JSON.parse(errorText);
+            userMessage = errorData.message || errorData.error || errorText;
+        }
+        catch {
+            userMessage = errorText;
+        }
+        // Add context and improve readability
+        switch (res.status) {
+            case 400: {
+                throw new Error(`Invalid request: ${userMessage}`);
+            }
+            case 401: {
+                throw new Error(`Authentication failed. Please check your API key.`);
+            }
+            case 403: {
+                throw new Error(`Access denied. ${userMessage}`);
+            }
+            case 404: {
+                throw new Error(`Resource not found. ${userMessage}`);
+            }
+            case 429: {
+                throw new Error(`Rate limit exceeded. Please try again later.`);
+            }
+            case 500: {
+                throw new Error(`Server error occurred. Please try again or contact support.`);
+            }
+            default: {
+                throw new Error(`${operation} failed: ${userMessage} (HTTP ${res.status})`);
+            }
+        }
+    },
     async checkForExistingUpload(baseUrl, apiKey, sha) {
         const res = await fetch(`${baseUrl}/uploads/checkForExistingUpload`, {
             body: JSON.stringify({ sha }),
@@ -23,7 +66,7 @@ exports.ApiGateway = {
             method: 'POST',
         });
         if (!res.ok) {
-            throw new Error(await res.text());
+            await this.handleApiError(res, 'Failed to download artifacts');
         }
         // Handle tilde expansion for home directory
         if (artifactsPath.startsWith('~/') || artifactsPath === '~') {
@@ -66,7 +109,7 @@ exports.ApiGateway = {
             method: 'POST',
         });
         if (!res.ok) {
-            throw new Error(await res.text());
+            await this.handleApiError(res, 'Failed to finalize upload');
         }
         return res.json();
     },
@@ -80,7 +123,7 @@ exports.ApiGateway = {
             method: 'POST',
         });
         if (!res.ok) {
-            throw new Error(await res.text());
+            await this.handleApiError(res, 'Failed to get upload URL');
         }
         return res.json();
     },
@@ -90,7 +133,7 @@ exports.ApiGateway = {
             headers: { 'x-app-api-key': apiKey },
         });
         if (!res.ok) {
-            throw new Error(await res.text());
+            await this.handleApiError(res, 'Failed to get results');
         }
         return res.json();
     },
@@ -108,7 +151,7 @@ exports.ApiGateway = {
             },
         });
         if (!response.ok) {
-            throw new Error(`Failed to fetch status: ${response.statusText}`);
+            await this.handleApiError(response, 'Failed to get upload status');
         }
         return response.json();
     },
@@ -121,8 +164,88 @@ exports.ApiGateway = {
             method: 'POST',
         });
         if (!res.ok) {
-            throw new Error(await res.text());
+            await this.handleApiError(res, 'Failed to upload test flows');
         }
         return res.json();
     },
+    /**
+     * Generic report download method that handles both junit and allure reports
+     * @param baseUrl - API base URL
+     * @param apiKey - API key for authentication
+     * @param uploadId - Upload ID to download report for
+     * @param reportType - Type of report to download ('junit' or 'allure')
+     * @param reportPath - Optional custom path for the downloaded report
+     * @returns Promise that resolves when download is complete
+     */
+    async downloadReportGeneric(baseUrl, apiKey, uploadId, reportType, reportPath) {
+        // Define endpoint and default filename mappings
+        const config = {
+            junit: {
+                endpoint: `/results/${uploadId}/report`,
+                defaultFilename: `report-${uploadId}.xml`,
+                notFoundMessage: `Upload ID '${uploadId}' not found or no results available for this upload`,
+                errorPrefix: 'Failed to download report',
+            },
+            allure: {
+                endpoint: `/allure/${uploadId}/download`,
+                defaultFilename: `allure-report-${uploadId}.zip`,
+                notFoundMessage: `Upload ID '${uploadId}' not found or no Allure report available for this upload`,
+                errorPrefix: 'Failed to download Allure report',
+            },
+            html: {
+                endpoint: `/results/${uploadId}/html-report`,
+                defaultFilename: `html-report-${uploadId}.zip`,
+                notFoundMessage: `Upload ID '${uploadId}' not found or no HTML report available for this upload`,
+                errorPrefix: 'Failed to download HTML report',
+            },
+        };
+        const { endpoint, defaultFilename, notFoundMessage, errorPrefix } = config[reportType];
+        const finalReportPath = reportPath || path.resolve(process.cwd(), defaultFilename);
+        const url = `${baseUrl}${endpoint}`;
+        // Make the download request
+        const res = await fetch(url, {
+            headers: {
+                'x-app-api-key': apiKey,
+            },
+            method: 'GET',
+        });
+        if (!res.ok) {
+            const errorText = await res.text();
+            if (res.status === 404) {
+                throw new Error(notFoundMessage);
+            }
+            throw new Error(`${errorPrefix}: ${res.status} ${errorText}`);
+        }
+        // Handle tilde expansion for home directory (applies to all report types)
+        let expandedPath = finalReportPath;
+        if (finalReportPath.startsWith('~/') || finalReportPath === '~') {
+            expandedPath = finalReportPath.replace(/^~/, 
+            // eslint-disable-next-line unicorn/prefer-module
+            require('node:os').homedir());
+        }
+        // Create directory structure if it doesn't exist
+        // eslint-disable-next-line unicorn/prefer-module
+        const { dirname } = require('node:path');
+        // eslint-disable-next-line unicorn/prefer-module
+        const { createWriteStream, mkdirSync } = require('node:fs');
+        // eslint-disable-next-line unicorn/prefer-module
+        const { finished } = require('node:stream/promises');
+        // eslint-disable-next-line unicorn/prefer-module
+        const { Readable } = require('node:stream');
+        const directory = dirname(expandedPath);
+        if (directory !== '.') {
+            try {
+                mkdirSync(directory, { recursive: true });
+            }
+            catch (error) {
+                // Ignore EEXIST errors (directory already exists)
+                if (error.code !== 'EEXIST') {
+                    throw error;
+                }
+            }
+        }
+        // Write the file using streaming for better memory efficiency
+        const fileStream = createWriteStream(expandedPath, { flags: 'wx' });
+        await finished(Readable.fromWeb(res.body).pipe(fileStream));
+    },
 };