sha checksum check

Author: jochen-testingbot

src/cli.ts

@@ -305,6 +305,10 @@ const maestroCommand = program
     '--artifacts-output-dir <path>',
     'Directory to save artifacts zip (defaults to current directory).',
   )
+  .option(
+    '--ignore-checksum-check',
+    'Skip checksum verification and always upload the app.',
+  )
   // Authentication
   .option('--api-key <key>', 'TestingBot API key.')
   .option('--api-secret <secret>', 'TestingBot API secret.')
@@ -362,6 +366,7 @@ const maestroCommand = program
         realDevice: args.realDevice,
         downloadArtifacts: args.downloadArtifacts,
         artifactsOutputDir: args.artifactsOutputDir,
+        ignoreChecksumCheck: args.ignoreChecksumCheck,
       });
       const credentials = await Auth.getCredentials({
         apiKey: args.apiKey,

src/models/maestro_options.ts

@@ -54,6 +54,7 @@ export default class MaestroOptions {
   private _realDevice: boolean;
   private _downloadArtifacts: boolean;
   private _artifactsOutputDir?: string;
+  private _ignoreChecksumCheck: boolean;
 
   public constructor(
     app: string,
@@ -80,6 +81,7 @@ export default class MaestroOptions {
       realDevice?: boolean;
       downloadArtifacts?: boolean;
       artifactsOutputDir?: string;
+      ignoreChecksumCheck?: boolean;
     },
   ) {
     this._app = app;
@@ -105,6 +107,7 @@ export default class MaestroOptions {
     this._realDevice = options?.realDevice ?? false;
     this._downloadArtifacts = options?.downloadArtifacts ?? false;
     this._artifactsOutputDir = options?.artifactsOutputDir;
+    this._ignoreChecksumCheck = options?.ignoreChecksumCheck ?? false;
   }
 
   public get app(): string {
@@ -199,6 +202,10 @@ export default class MaestroOptions {
     return this._artifactsOutputDir;
   }
 
+  public get ignoreChecksumCheck(): boolean {
+    return this._ignoreChecksumCheck;
+  }
+
   public getMaestroOptions(): MaestroRunOptions | undefined {
     const opts: MaestroRunOptions = {};
 

src/providers/espresso.ts

@@ -280,6 +280,10 @@ export default class Espresso {
         },
       });
 
+      // Check for version update notification
+      const latestVersion = response.headers?.['x-testingbotctl-version'];
+      utils.checkForUpdate(latestVersion);
+
       return response.data;
     } catch (error) {
       throw new TestingBotError(`Failed to get Espresso test status`, {
@@ -455,6 +459,10 @@ export default class Espresso {
         },
       });
 
+      // Check for version update notification
+      const latestVersion = response.headers?.['x-testingbotctl-version'];
+      utils.checkForUpdate(latestVersion);
+
       const reportContent = response.data;
 
       if (!reportContent) {

src/providers/maestro.ts

@@ -260,6 +260,21 @@ export default class Maestro {
       contentType = 'application/octet-stream';
     }
 
+    // Check if app already exists (unless checksum check is disabled)
+    if (!this.options.ignoreChecksumCheck) {
+      const checksum = await this.upload.calculateChecksum(appPath);
+      const existingApp = await this.checkAppChecksum(checksum);
+
+      if (existingApp) {
+        this.appId = existingApp.id;
+        if (!this.options.quiet) {
+          logger.info('  App already uploaded, skipping upload');
+        }
+        return true;
+      }
+    }
+
+    // App doesn't exist (or checksum check skipped), upload it
     const result = await this.upload.upload({
       filePath: appPath,
       url: `${this.URL}/app`,
@@ -269,9 +284,45 @@ export default class Maestro {
     });
 
     this.appId = result.id;
+
     return true;
   }
 
+  private async checkAppChecksum(
+    checksum: string,
+  ): Promise<{ id: number } | null> {
+    try {
+      const response = await axios.post(
+        `${this.URL}/app/checksum`,
+        { checksum },
+        {
+          headers: {
+            'Content-Type': 'application/json',
+            'User-Agent': utils.getUserAgent(),
+          },
+          auth: {
+            username: this.credentials.userName,
+            password: this.credentials.accessKey,
+          },
+        },
+      );
+
+      // Check for version update notification
+      const latestVersion = response.headers?.['x-testingbotctl-version'];
+      utils.checkForUpdate(latestVersion);
+
+      const result = response.data;
+      if (result.app_exists && result.id) {
+        return { id: result.id };
+      }
+
+      return null;
+    } catch {
+      // If checksum check fails, proceed with upload
+      return null;
+    }
+  }
+
   private async uploadFlows() {
     const flowsPaths = this.options.flows;
 
@@ -807,6 +858,10 @@ export default class Maestro {
         },
       });
 
+      // Check for version update notification
+      const latestVersion = response.headers?.['x-testingbotctl-version'];
+      utils.checkForUpdate(latestVersion);
+
       return response.data;
     } catch (error) {
       throw new TestingBotError(`Failed to get Maestro test status`, {
@@ -1001,6 +1056,10 @@ export default class Maestro {
           },
         );
 
+        // Check for version update notification
+        const latestVersion = response.headers?.['x-testingbotctl-version'];
+        utils.checkForUpdate(latestVersion);
+
         // Extract the report content from the JSON response
         const reportKey =
           reportFormat === 'junit' ? 'junit_report' : 'html_report';
@@ -1040,6 +1099,10 @@ export default class Maestro {
         },
       });
 
+      // Check for version update notification
+      const latestVersion = response.headers?.['x-testingbotctl-version'];
+      utils.checkForUpdate(latestVersion);
+
       return response.data;
     } catch (error) {
       throw new TestingBotError(`Failed to get run details for run ${runId}`, {

src/providers/xcuitest.ts

@@ -280,6 +280,10 @@ export default class XCUITest {
         },
       });
 
+      // Check for version update notification
+      const latestVersion = response.headers?.['x-testingbotctl-version'];
+      utils.checkForUpdate(latestVersion);
+
       return response.data;
     } catch (error) {
       throw new TestingBotError(`Failed to get XCUITest status`, {
@@ -456,6 +460,10 @@ export default class XCUITest {
           responseType: reportFormat === 'html' ? 'arraybuffer' : 'text',
         });
 
+        // Check for version update notification
+        const latestVersion = response.headers?.['x-testingbotctl-version'];
+        utils.checkForUpdate(latestVersion);
+
         const reportContent = response.data;
 
         if (!reportContent) {

src/upload.ts

@@ -1,4 +1,5 @@
 import axios from 'axios';
+import crypto from 'node:crypto';
 import fs from 'node:fs';
 import path from 'node:path';
 import FormData from 'form-data';
@@ -18,6 +19,7 @@ export interface UploadOptions {
   credentials: Credentials;
   contentType: ContentType;
   showProgress?: boolean;
+  checksum?: string;
 }
 
 export interface UploadResult {
@@ -40,7 +42,6 @@ export default class Upload {
     const totalSize = fileStats.size;
     const sizeMB = (totalSize / (1024 * 1024)).toFixed(2);
 
-    // Create progress tracker
     const progressTracker = progress({
       length: totalSize,
       time: 100, // Emit progress every 100ms
@@ -49,7 +50,6 @@ export default class Upload {
     let lastPercent = 0;
 
     if (showProgress) {
-      // Draw initial progress bar
       this.drawProgressBar(fileName, sizeMB, 0);
 
       progressTracker.on('progress', (prog) => {
@@ -61,7 +61,6 @@ export default class Upload {
       });
     }
 
-    // Create file stream and pipe through progress tracker
     const fileStream = fs.createReadStream(filePath);
     const trackedStream = fileStream.pipe(progressTracker);
 
@@ -72,6 +71,10 @@ export default class Upload {
       knownLength: totalSize,
     });
 
+    if (options.checksum) {
+      formData.append('checksum', options.checksum);
+    }
+
     try {
       const response = await axios.post(url, formData, {
         headers: {
@@ -87,6 +90,10 @@ export default class Upload {
         maxRedirects: 0, // Recommended for stream uploads to avoid buffering
       });
 
+      // Check for version update notification
+      const latestVersion = response.headers?.['x-testingbotctl-version'];
+      utils.checkForUpdate(latestVersion);
+
       const result = response.data;
       if (result.id) {
         if (showProgress) {
@@ -151,4 +158,19 @@ export default class Upload {
       throw new TestingBotError(`File not found or not readable: ${filePath}`);
     }
   }
+
+  /**
+   * Calculate MD5 checksum of a file, returning base64-encoded result
+   * This matches ActiveStorage's checksum format
+   */
+  public async calculateChecksum(filePath: string): Promise<string> {
+    return new Promise((resolve, reject) => {
+      const hash = crypto.createHash('md5');
+      const stream = fs.createReadStream(filePath);
+
+      stream.on('data', (chunk) => hash.update(chunk));
+      stream.on('end', () => resolve(hash.digest('base64')));
+      stream.on('error', (err) => reject(err));
+    });
+  }
 }

src/utils.ts

@@ -41,16 +41,22 @@ export default {
     const currentVersion = this.getCurrentVersion();
     if (this.compareVersions(currentVersion, latestVersion) < 0) {
       versionCheckDisplayed = true;
+      const border = '─'.repeat(80);
+
+      logger.info(`\nCLI Version: ${colors.cyan(currentVersion)}\n`);
+      logger.warn(colors.yellow(border));
+      logger.warn(colors.yellow('⚠  Update Available'));
       logger.warn(
         colors.yellow(
-          `\n📦 A new version of testingbotctl is available: ${colors.green(latestVersion)} (current: ${currentVersion})`,
+          `   A new version of the TestingBot CLI is available: ${colors.green(latestVersion)}`,
         ),
       );
       logger.warn(
         colors.yellow(
-          `   Run ${colors.cyan('npm update -g testingbotctl')} to update.\n`,
+          `   Run: ${colors.cyan('npm install -g @testingbot/cli@latest')}`,
         ),
       );
+      logger.warn(colors.yellow(border) + '\n');
     }
   },
 };