♻️ Update package exports and refactor test helpers (#830)

* ♻ Update @percy/env exports

✅ Refactor @percy/env test helper

* ♻ Update @percy/logger exports

✅ Refactor test helpers slightly

* ✅ Update test config

- Allow respying with jasmine spies
- Add generator spacing lint config for methods
- Clean up defunct babel plugin

* ♻ Update @percy/client exports

✅ Rename client test helper

* ♻ Update @percy/sdk-utils exports

✅ Fix test helper imports

* ♻ Update @percy/config exports

✅ Refactor test helpers to use full filesystem mocks

* ♻ Update @percy/core exports & imports

✅ Refactor test helpers and usage within tests

* ♻ Update @percy/cli-command exports & imports

✅ Reexport core test helpers for consuming packages

* ♻ Update @percy/cli-build exports

✅ Update test imports

* ♻ Update @percy/cli-config exports

🐛 Create parent directories when creating config files
🐛 Fix renaming extensionless cnofig files when migrating
✅ Update test imports and remove unnecessary helpers file

* ♻ Update @percy/cli-upload exports

♻ Replace globby with fast-glob
✅ Refactor tests to use new helpers

* ♻ Update @percy/cli exports & imports

✅ Refactor tests to use new helpers

* ♻ Update @percy/cli-snapshot exports

✅ Refactor tests to use new helpers
✅ Remove redundant default import test

* ♻ Update @percy/cli-exec exports & imports

✅ Refactor tests to use new helpers

* ➖ Remove quibble dev dependency

* 💚 Increment cache key for windows

* ✅ Correctly alias package exports during dev

* ♻ Update cli-command utils exports

.eslintrc

@@ -18,6 +18,7 @@ rules:
     - before: false
       after: false
       named: after
+      method: before
   space-before-function-paren:
     - error
     - anonymous: never

.github/.cache-key

@@ -7,3 +7,4 @@
               /   \
 _____________/_ __ \_____________
 Times we have broken CI: 3
+Times Windows has broken CI: 99+

babel.config.js

@@ -14,9 +14,6 @@ const base = {
           node: '12'
         }
       }]
-    ],
-    plugins: [
-      '@babel/proposal-class-properties'
     ]
   }]
 };
@@ -27,7 +24,7 @@ const development = {
       cwd: __dirname,
       alias: {
         '^@percy/((?!dom)[^/]+)$': './packages/\\1/src',
-        '^@percy/(.+)/dist/(.+)$': './packages/\\1/src/\\2'
+        '^@percy/([^/]+)/((?!test).+)$': './packages/\\1/src/\\2'
       }
     }]
   ]

package.json

@@ -24,7 +24,6 @@
     "@babel/cli": "^7.11.6",
     "@babel/core": "^7.14.6",
     "@babel/eslint-parser": "^7.14.7",
-    "@babel/plugin-proposal-class-properties": "^7.14.5",
     "@babel/preset-env": "^7.14.7",
     "@babel/register": "^7.11.5",
     "@rollup/plugin-alias": "^3.1.3",
@@ -53,7 +52,6 @@
     "memfs": "^3.4.0",
     "nock": "^13.1.1",
     "nyc": "^15.1.0",
-    "quibble": "^0.6.8",
     "rollup": "^2.53.2",
     "tsd": "^0.19.0"
   }

packages/cli-build/package.json

@@ -10,13 +10,14 @@
   "publishConfig": {
     "access": "public"
   },
-  "main": "dist/index.js",
-  "files": [
-    "dist"
-  ],
   "engines": {
     "node": ">=12"
   },
+  "files": [
+    "./dist"
+  ],
+  "main": "./dist/index.js",
+  "exports": "./dist/index.js",
   "scripts": {
     "build": "node ../../scripts/build",
     "lint": "eslint --ignore-path ../../.gitignore .",
@@ -30,7 +31,6 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.0.0-beta.76",
-    "@percy/logger": "1.0.0-beta.76"
+    "@percy/cli-command": "1.0.0-beta.76"
   }
 }

packages/cli-build/test/finalize.test.js

@@ -1,11 +1,9 @@
-import mockAPI from '@percy/client/test/helpers';
-import logger from '@percy/logger/test/helpers';
+import { logger, setupTest } from '@percy/cli-command/test/helpers';
 import finalize from '../src/finalize';
 
 describe('percy build:finalize', () => {
   beforeEach(() => {
-    mockAPI.start();
-    logger.mock();
+    setupTest();
   });
 
   afterEach(() => {

packages/cli-build/test/wait.test.js

@@ -1,5 +1,4 @@
-import logger from '@percy/logger/test/helpers';
-import mockAPI from '@percy/client/test/helpers';
+import { logger, api, setupTest } from '@percy/cli-command/test/helpers';
 import wait from '../src/wait';
 
 describe('percy build:wait', () => {
@@ -19,8 +18,7 @@ describe('percy build:wait', () => {
 
   beforeEach(() => {
     process.env.PERCY_TOKEN = '<<PERCY_TOKEN>>';
-    mockAPI.start();
-    logger.mock({ isTTY: true });
+    setupTest({ loggerTTY: true });
   });
 
   afterEach(() => {
@@ -48,7 +46,7 @@ describe('percy build:wait', () => {
   });
 
   it('logs while recieving snapshots', async () => {
-    mockAPI
+    api
       .reply('/builds/123', () => [200, build({
         state: 'pending'
       })])
@@ -66,7 +64,7 @@ describe('percy build:wait', () => {
   });
 
   it('logs while processing snapshots', async () => {
-    mockAPI
+    api
       .reply('/builds/123', () => [200, build({
         'total-comparisons-finished': 16
       })])
@@ -91,7 +89,7 @@ describe('percy build:wait', () => {
   });
 
   it('logs found diffs when finished', async () => {
-    mockAPI.reply('/builds/123', () => [200, build({
+    api.reply('/builds/123', () => [200, build({
       'total-comparisons-diff': 16,
       state: 'finished'
     })]);
@@ -106,7 +104,7 @@ describe('percy build:wait', () => {
   });
 
   it('errors and logs found diffs when finished', async () => {
-    mockAPI.reply('/builds/123', () => [200, build({
+    api.reply('/builds/123', () => [200, build({
       'total-comparisons-diff': 16,
       state: 'finished'
     })]);
@@ -121,7 +119,7 @@ describe('percy build:wait', () => {
   });
 
   it('does not error when diffs are not found', async () => {
-    mockAPI.reply('/builds/123', () => [200, build({
+    api.reply('/builds/123', () => [200, build({
       'total-comparisons-diff': 0,
       state: 'finished'
     })]);
@@ -136,7 +134,7 @@ describe('percy build:wait', () => {
   });
 
   it('errors and logs the build state when unrecognized', async () => {
-    mockAPI.reply('/builds/123', () => [200, build({ state: 'expired' })]);
+    api.reply('/builds/123', () => [200, build({ state: 'expired' })]);
     await expectAsync(wait(['--build=123'])).toBeRejected();
 
     expect(logger.stdout).toEqual([]);
@@ -146,7 +144,7 @@ describe('percy build:wait', () => {
   });
 
   it('stops waiting on process termination', async () => {
-    mockAPI.reply('/builds/123', () => [200, build()]);
+    api.reply('/builds/123', () => [200, build()]);
 
     let waiting = wait(['--build=123']);
 
@@ -165,7 +163,7 @@ describe('percy build:wait', () => {
 
   describe('failure messages', () => {
     it('logs an error when there are no snapshots', async () => {
-      mockAPI.reply('/builds/123', () => [200, build({
+      api.reply('/builds/123', () => [200, build({
         state: 'failed',
         'failure-reason': 'render_timeout'
       })]);
@@ -181,7 +179,7 @@ describe('percy build:wait', () => {
     });
 
     it('logs an error when there are no snapshots', async () => {
-      mockAPI.reply('/builds/123', () => [200, build({
+      api.reply('/builds/123', () => [200, build({
         state: 'failed',
         'failure-reason': 'no_snapshots'
       })]);
@@ -196,7 +194,7 @@ describe('percy build:wait', () => {
     });
 
     it('logs an error when the build was not finalized', async () => {
-      mockAPI.reply('/builds/123', () => [200, build({
+      api.reply('/builds/123', () => [200, build({
         state: 'failed',
         'failure-reason': 'missing_finalize'
       })]);
@@ -211,7 +209,7 @@ describe('percy build:wait', () => {
     });
 
     it('logs an error and exits when build is missing resources', async () => {
-      mockAPI.reply('/builds/123', () => [200, build({
+      api.reply('/builds/123', () => [200, build({
         state: 'failed',
         'failure-reason': 'missing_resources'
       })]);
@@ -226,7 +224,7 @@ describe('percy build:wait', () => {
     });
 
     it('logs an error and exits when parallel builds are missing', async () => {
-      mockAPI.reply('/builds/123', () => [200, build({
+      api.reply('/builds/123', () => [200, build({
         state: 'failed',
         'failure-reason': 'missing_resources',
         'failure-details': {
@@ -246,7 +244,7 @@ describe('percy build:wait', () => {
     });
 
     it('logs the failure reason and exits when the reason is unrecognized', async () => {
-      mockAPI.reply('/builds/123', () => [200, build({
+      api.reply('/builds/123', () => [200, build({
         state: 'failed',
         'failure-reason': 'unrecognized_reason'
       })]);

packages/cli-command/package.json

@@ -10,16 +10,21 @@
   "publishConfig": {
     "access": "public"
   },
-  "main": "dist/index.js",
-  "bin": {
-    "percy-cli-readme": "bin/readme"
-  },
   "files": [
-    "dist"
+    "./dist"
   ],
   "engines": {
     "node": ">=12"
   },
+  "bin": {
+    "percy-cli-readme": "./bin/readme"
+  },
+  "main": "./dist/index.js",
+  "exports": {
+    ".": "./dist/index.js",
+    "./utils": "./dist/utils.js",
+    "./test/helpers": "./test/helpers.js"
+  },
   "scripts": {
     "build": "node ../../scripts/build",
     "lint": "eslint --ignore-path ../../.gitignore .",

packages/cli-command/src/command.js

@@ -1,7 +1,7 @@
 import logger from '@percy/logger';
 import PercyConfig from '@percy/config';
-import { set, del } from '@percy/config/dist/utils';
-import * as CoreConfig from '@percy/core/dist/config';
+import { set, del } from '@percy/config/utils';
+import * as CoreConfig from '@percy/core/config';
 import * as builtInFlags from './flags';
 import formatHelp from './help';
 import parse from './parse';

packages/cli-command/src/index.js

@@ -1,2 +1,5 @@
 export { default, command } from './command';
 export { legacyCommand, legacyFlags as flags } from './legacy';
+// export common packages to avoid dependency resolution issues
+export { default as PercyConfig } from '@percy/config';
+export { default as logger } from '@percy/logger';

packages/cli-command/src/legacy.js

@@ -1,5 +1,5 @@
+import { merge } from '@percy/config/utils';
 import { command } from './command';
-import { merge } from '@percy/config/dist/utils';
 
 // Legacy flags for older commands that inadvertently import a newer @percy/cli-command
 export const legacyFlags = {

packages/cli-command/src/parse.js

@@ -1,5 +1,5 @@
 import logger from '@percy/logger';
-import { camelcase } from '@percy/config/dist/normalize';
+import { camelcase } from '@percy/config/utils';
 import { flagUsage } from './help';
 
 // Make it possible to identify parse errors.

packages/cli-command/src/utils.js

@@ -0,0 +1,2 @@
+export * from '@percy/config/utils';
+export * from '@percy/core/utils';

packages/cli-command/test/command.test.js

@@ -1,5 +1,4 @@
-import logger from '@percy/logger/test/helpers';
-import dedent from '@percy/core/test/helpers/dedent';
+import { logger, dedent } from './helpers';
 import command from '../src';
 
 describe('Command', () => {

packages/cli-command/test/flags.test.js

@@ -1,5 +1,4 @@
-import logger from '@percy/logger/test/helpers';
-import dedent from '@percy/core/test/helpers/dedent';
+import { logger, dedent } from './helpers';
 import command from '../src';
 
 describe('Built-in flags:', () => {

packages/cli-command/test/help.test.js

@@ -1,5 +1,4 @@
-import logger from '@percy/logger/test/helpers';
-import dedent from '@percy/core/test/helpers/dedent';
+import { logger, dedent } from './helpers';
 import command from '../src';
 
 describe('Help output', () => {

packages/cli-command/test/helpers.js

@@ -0,0 +1 @@
+export * from '@percy/core/test/helpers';

packages/cli-command/test/legacy.test.js

@@ -1,5 +1,4 @@
-import logger from '@percy/logger/test/helpers';
-import dedent from '@percy/core/test/helpers/dedent';
+import { logger, dedent } from './helpers';
 import { command, legacyCommand, flags } from '../src';
 
 describe('Legacy support', () => {

packages/cli-command/test/parse.test.js

@@ -1,4 +1,4 @@
-import logger from '@percy/logger/test/helpers';
+import { logger } from './helpers';
 import command from '../src';
 
 describe('Option parsing', () => {

packages/cli-config/package.json

@@ -10,13 +10,14 @@
   "publishConfig": {
     "access": "public"
   },
-  "main": "dist/index.js",
-  "files": [
-    "dist"
-  ],
   "engines": {
     "node": ">=12"
   },
+  "files": [
+    "./dist"
+  ],
+  "main": "dist/index.js",
+  "exports": "dist/index.js",
   "scripts": {
     "build": "node ../../scripts/build",
     "lint": "eslint --ignore-path ../../.gitignore .",
@@ -30,7 +31,6 @@
     ]
   },
   "dependencies": {
-    "@percy/cli-command": "1.0.0-beta.76",
-    "@percy/config": "1.0.0-beta.76"
+    "@percy/cli-command": "1.0.0-beta.76"
   }
 }

packages/cli-config/src/create.js

@@ -1,6 +1,8 @@
 import fs from 'fs';
 import path from 'path';
-import command from '@percy/cli-command';
+import command, {
+  PercyConfig
+} from '@percy/cli-command';
 
 const DEFAULT_FILES = {
   rc: '.percyrc',
@@ -58,8 +60,6 @@ export const create = command('create', {
     '$0 ./config/percy.yml'
   ]
 }, async ({ flags, args, log, exit }) => {
-  let PercyConfig = await import('@percy/config');
-
   // discern the filetype
   let filetype = args.filepath
     ? path.extname(args.filepath).replace(/^./, '')
@@ -80,6 +80,7 @@ export const create = command('create', {
 
   // write stringified default config options to the filepath
   let format = ['rc', 'yaml', 'yml'].includes(filetype) ? 'yaml' : filetype;
+  fs.mkdirSync(path.dirname(filepath), { recursive: true });
   fs.writeFileSync(filepath, PercyConfig.stringify(format));
   log.info(`Created Percy config: ${filepath}`);
 });