Merge remote-tracking branch 'origin' into PPLT_2492

percy · Nov 16, 2023 · 7d50258 · 7d50258
2 parents 673b04e + bb901bc
commit 7d50258
Show file tree

Hide file tree

Showing 49 changed files with 609 additions and 237 deletions.
diff --git a/lerna.json b/lerna.json
@@ -1,5 +1,5 @@
 {
-  "version": "1.27.4-beta.1",
+  "version": "1.27.4",
   "packages": [
     "packages/*"
   ],

diff --git a/packages/cli-app/package.json b/packages/cli-app/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-app",
-  "version": "1.27.4-beta.1",
+  "version": "1.27.4",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "beta"
+    "tag": "latest"
   },
   "engines": {
     "node": ">=14"
@@ -33,7 +33,7 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.27.4-beta.1",
-    "@percy/cli-exec": "1.27.4-beta.1"
+    "@percy/cli-command": "1.27.4",
+    "@percy/cli-exec": "1.27.4"
   }
 }
diff --git a/packages/cli-build/package.json b/packages/cli-build/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-build",
-  "version": "1.27.4-beta.1",
+  "version": "1.27.4",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "beta"
+    "tag": "latest"
   },
   "engines": {
     "node": ">=14"
@@ -33,6 +33,6 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.27.4-beta.1"
+    "@percy/cli-command": "1.27.4"
   }
 }
diff --git a/packages/cli-command/package.json b/packages/cli-command/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-command",
-  "version": "1.27.4-beta.1",
+  "version": "1.27.4",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "beta"
+    "tag": "latest"
   },
   "files": [
     "dist",
@@ -36,8 +36,8 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/config": "1.27.4-beta.1",
-    "@percy/core": "1.27.4-beta.1",
-    "@percy/logger": "1.27.4-beta.1"
+    "@percy/config": "1.27.4",
+    "@percy/core": "1.27.4",
+    "@percy/logger": "1.27.4"
   }
 }
diff --git a/packages/cli-config/package.json b/packages/cli-config/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-config",
-  "version": "1.27.4-beta.1",
+  "version": "1.27.4",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "beta"
+    "tag": "latest"
   },
   "engines": {
     "node": ">=14"
@@ -33,6 +33,6 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.27.4-beta.1"
+    "@percy/cli-command": "1.27.4"
   }
 }
diff --git a/packages/cli-exec/package.json b/packages/cli-exec/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-exec",
-  "version": "1.27.4-beta.1",
+  "version": "1.27.4",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "beta"
+    "tag": "latest"
   },
   "engines": {
     "node": ">=14"
@@ -33,7 +33,7 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.27.4-beta.1",
+    "@percy/cli-command": "1.27.4",
     "cross-spawn": "^7.0.3",
     "which": "^2.0.2"
   }

diff --git a/packages/cli-exec/src/exec.js b/packages/cli-exec/src/exec.js
@@ -2,6 +2,9 @@ import command from '@percy/cli-command';
 import start from './start.js';
 import stop from './stop.js';
 import ping from './ping.js';
+import { getPackageJSON } from '@percy/cli-command/utils';
+
+const pkg = getPackageJSON(import.meta.url);
 
 export const exec = command('exec', {
   description: 'Start and stop Percy around a supplied command',
@@ -83,7 +86,7 @@ export const exec = command('exec', {
 
   // run the provided command
   log.info(`Running "${[command, ...args].join(' ')}"`);
-  let [status, error] = yield* spawn(command, args);
+  let [status, error] = yield* spawn(command, args, percy);
 
   // stop percy if running (force stop if there is an error);
   await percy?.stop(!!error);
@@ -94,15 +97,43 @@ export const exec = command('exec', {
 
 // Spawn a command with cross-spawn and return an array containing the resulting status code along
 // with any error encountered while running. Uses a generator pattern to handle interupt signals.
-async function* spawn(cmd, args) {
+async function* spawn(cmd, args, percy) {
   let { default: crossSpawn } = await import('cross-spawn');
   let proc, closed, error;
 
   try {
-    proc = crossSpawn(cmd, args, { stdio: 'inherit' });
-    proc.on('close', code => (closed = code));
+    proc = crossSpawn(cmd, args, { stdio: 'pipe' });
+    // Writing stdout of proc to process
+    if (proc.stdout) {
+      proc.stdout.on('data', (data) => {
+        process.stdout.write(`${data}`);
+      });
+    }
+
+    if (proc.stderr) {
+      proc.stderr.on('data', (data) => {
+        process.stderr.write(`${data}`);
+      });
+    }
+
     proc.on('error', err => (error = err));
 
+    proc.on('close', code => {
+      closed = code;
+      if (code !== 0) {
+        // Only send event when there is a global error code and
+        // percy token is present
+        if (process.env.PERCY_TOKEN) {
+          const myObject = {
+            errorKind: 'cli',
+            cliVersion: pkg.version,
+            message: '1'
+          };
+          percy.client.sendBuildEvents(percy.build.id, myObject);
+        }
+      }
+    });
+
     // run until an event is triggered
     /* eslint-disable-next-line no-unmodified-loop-condition */
     while (closed == null && error == null) {

diff --git a/packages/cli-exec/test/exec.test.js b/packages/cli-exec/test/exec.test.js
@@ -1,5 +1,6 @@
 import { logger, api, setupTest } from '@percy/cli-command/test/helpers';
 import exec from '@percy/cli-exec';
+import { getPackageJSON } from '@percy/cli-command/utils';
 
 describe('percy exec', () => {
   beforeEach(async () => {
@@ -130,6 +131,63 @@ describe('percy exec', () => {
     ]);
   });
 
+  it('tests process.stdout', async () => {
+    let stdoutSpy = spyOn(process.stdout, 'write').and.resolveTo('some response');
+    await exec(['--', 'echo', 'Hi!']);
+
+    expect(stdoutSpy).toHaveBeenCalled();
+    expect(logger.stderr).toEqual([]);
+    expect(logger.stdout).toEqual([
+      '[percy] Percy has started!',
+      '[percy] Running "echo Hi!"',
+      '[percy] Finalized build #1: https://percy.io/test/test/123'
+    ]);
+  });
+
+  it('tests process.stderr when token is present', async () => {
+    const pkg = getPackageJSON(import.meta.url);
+    let stderrSpy = spyOn(process.stderr, 'write').and.resolveTo('some response');
+    await expectAsync(
+      exec(['--', 'node', 'random.js']) // invalid command
+    ).toBeRejectedWithError('EEXIT: 1');
+
+    expect(stderrSpy).toHaveBeenCalled();
+    expect(logger.stderr).toEqual([]);
+    expect(logger.stdout).toEqual([
+      '[percy] Percy has started!',
+      '[percy] Running "node random.js"',
+      '[percy] Finalized build #1: https://percy.io/test/test/123'
+    ]);
+
+    expect(api.requests['/builds/123/send-events']).toBeDefined();
+    expect(api.requests['/builds/123/send-events'][0].body).toEqual({
+      data: {
+        errorKind: 'cli',
+        cliVersion: pkg.version,
+        message: '1'
+      }
+    });
+  });
+
+  it('tests process.stderr when token is not present', async () => {
+    delete process.env.PERCY_TOKEN;
+    let stderrSpy = spyOn(process.stderr, 'write').and.resolveTo('some response');
+    await expectAsync(
+      exec(['--', 'node', 'random.js']) // invalid command
+    ).toBeRejectedWithError('EEXIT: 1');
+
+    expect(stderrSpy).toHaveBeenCalled();
+    expect(logger.stderr).toEqual([
+      '[percy] Skipping visual tests',
+      '[percy] Error: Missing Percy token'
+    ]);
+    expect(logger.stdout).toEqual([
+      '[percy] Running "node random.js"'
+    ]);
+
+    expect(api.requests['/builds/123/send-events']).not.toBeDefined();
+  });
+
   it('does not run the command if canceled beforehand', async () => {
     // delay build creation to give time to cancel
     api.reply('/builds', () => new Promise(resolve => {

diff --git a/packages/cli-snapshot/package.json b/packages/cli-snapshot/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-snapshot",
-  "version": "1.27.4-beta.1",
+  "version": "1.27.4",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "beta"
+    "tag": "latest"
   },
   "engines": {
     "node": ">=14"
@@ -33,7 +33,7 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.27.4-beta.1",
+    "@percy/cli-command": "1.27.4",
     "yaml": "^2.0.0"
   }
 }
diff --git a/packages/cli-upload/package.json b/packages/cli-upload/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli-upload",
-  "version": "1.27.4-beta.1",
+  "version": "1.27.4",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "beta"
+    "tag": "latest"
   },
   "engines": {
     "node": ">=14"
@@ -33,7 +33,7 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.27.4-beta.1",
+    "@percy/cli-command": "1.27.4",
     "fast-glob": "^3.2.11",
     "image-size": "^1.0.0"
   }

diff --git a/packages/cli-upload/test/upload.test.js b/packages/cli-upload/test/upload.test.js
@@ -87,7 +87,8 @@ describe('percy upload', () => {
           widths: [10],
           scope: null,
           'minimum-height': 10,
-          'enable-javascript': null
+          'enable-javascript': null,
+          'enable-layout': false
         },
         relationships: {
           resources: {

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@percy/cli",
-  "version": "1.27.4-beta.1",
+  "version": "1.27.4",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "beta"
+    "tag": "latest"
   },
   "files": [
     "bin",
@@ -31,14 +31,14 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/cli-app": "1.27.4-beta.1",
-    "@percy/cli-build": "1.27.4-beta.1",
-    "@percy/cli-command": "1.27.4-beta.1",
-    "@percy/cli-config": "1.27.4-beta.1",
-    "@percy/cli-exec": "1.27.4-beta.1",
-    "@percy/cli-snapshot": "1.27.4-beta.1",
-    "@percy/cli-upload": "1.27.4-beta.1",
-    "@percy/client": "1.27.4-beta.1",
-    "@percy/logger": "1.27.4-beta.1"
+    "@percy/cli-app": "1.27.4",
+    "@percy/cli-build": "1.27.4",
+    "@percy/cli-command": "1.27.4",
+    "@percy/cli-config": "1.27.4",
+    "@percy/cli-exec": "1.27.4",
+    "@percy/cli-snapshot": "1.27.4",
+    "@percy/cli-upload": "1.27.4",
+    "@percy/client": "1.27.4",
+    "@percy/logger": "1.27.4"
   }
 }