@percy/client 1.32.6 → 1.32.7-beta.2

package/dist/client.js

@@ -401,10 +401,42 @@ export class PercyClient {
 
   // Retrieves snapshot/comparison data by id. Requires a read access token.
   async getStatus(type, ids) {
-    if (!['snapshot', 'comparison'].includes(type)) throw new Error('Invalid type passed');
+    if (!['snapshot', 'comparison', 'intelli_story_graph'].includes(type)) throw new Error('Invalid type passed');
     this.log.debug(`Getting ${type} status for ids ${ids}`);
     return this.get(`job_status?sync=true&type=${type}&id=${ids.join()}`);
   }
+  async getIntelliStorySnapshotNameToCommit(buildId) {
+    this.log.debug('IntelliStory: looking up baselines...');
+    // `build_id` is the only input. The build already exists by the time this is
+    // called, so its base build has been selected server-side and the endpoint
+    // reads through to that base build's commit — there is nothing to predict
+    // from git/PR context any more.
+    const qs = new URLSearchParams();
+    if (buildId) qs.append('build_id', buildId);
+    const query = qs.toString();
+    return this.get(query ? `intelli_story/snapshot-name-to-commit?${query}` : 'intelli_story/snapshot-name-to-commit', {
+      identifier: 'intelli_story.snapshot_name_to_commit'
+    });
+  }
+  async generateIntelliStoryGraph(buildId, {
+    files,
+    modules,
+    storybookPaths,
+    affectedNodes,
+    affectedFileLocations
+  } = {}) {
+    this.log.debug(`IntelliStory: enqueueing graph build for build ${buildId}...`);
+    return this.post('intelli_story/generate-graph', {
+      build_id: buildId,
+      files,
+      modules,
+      storybook_paths: storybookPaths,
+      affected_nodes: affectedNodes,
+      affected_file_locations: affectedFileLocations
+    }, {
+      identifier: 'intelli_story.generate_graph'
+    });
+  }
 
   // Returns device details enabled on project associated with given token
   async getDeviceDetails(buildId) {
@@ -571,6 +603,8 @@ export class PercyClient {
     regions,
     algorithm,
     algorithmConfiguration,
+    intelliStory,
+    storybookPath,
     resources = [],
     meta
   } = {}) {
@@ -604,7 +638,11 @@ export class PercyClient {
           'enable-javascript': enableJavaScript || null,
           'enable-layout': enableLayout || false,
           'th-test-case-execution-id': thTestCaseExecutionId || null,
-          browsers: normalizeBrowsers(browsers) || null
+          browsers: normalizeBrowsers(browsers) || null,
+          // IntelliStory: when enabled, the API selects affected snapshots
+          // server-side using the story's source path.
+          'intelli-story': intelliStory || null,
+          'storybook-path': storybookPath || null
         },
         relationships: {
           resources: {
@@ -640,23 +678,38 @@ export class PercyClient {
   // Convenience method for creating a snapshot for the active build, uploading
   // missing resources for the snapshot, and finalizing the snapshot.
   async sendSnapshot(buildId, options) {
-    var _snapshot$data$relati;
+    var _snapshot$data, _snapshot$data$relati;
     let {
       meta = {}
     } = options;
     let snapshot = await this.createSnapshot(buildId, options);
+
+    // The API always creates the snapshot record now; when server-side SmartSnap
+    // selection skips it, the response carries `skipped-via-smartsnap: true` and
+    // there are no resources to upload. Tally kept vs skipped so the storybook
+    // flow can print an IntelliStory summary.
+    let skipped = !!(snapshot !== null && snapshot !== void 0 && (_snapshot$data = snapshot.data) !== null && _snapshot$data !== void 0 && (_snapshot$data = _snapshot$data.attributes) !== null && _snapshot$data !== void 0 && _snapshot$data['skipped-via-smartsnap']);
+    if (typeof options.intelliStory === 'boolean') {
+      this.intelliStoryStats ?? (this.intelliStoryStats = {
+        kept: 0,
+        skipped: 0
+      });
+      this.intelliStoryStats[skipped ? 'skipped' : 'kept'] += 1;
+    }
     meta.snapshotId = snapshot.data.id;
     let missing = (_snapshot$data$relati = snapshot.data.relationships) === null || _snapshot$data$relati === void 0 || (_snapshot$data$relati = _snapshot$data$relati['missing-resources']) === null || _snapshot$data$relati === void 0 ? void 0 : _snapshot$data$relati.data;
     this.log.debug(`${(missing === null || missing === void 0 ? void 0 : missing.length) || 0} Missing resources: ${options.name}...`, meta);
-    if (missing !== null && missing !== void 0 && missing.length) {
+    if (skipped) {
+      this.log.debug('skipping resource upload because this is a intellistory skip build', meta);
+    } else if (missing !== null && missing !== void 0 && missing.length) {
       let resources = options.resources.reduce((acc, r) => Object.assign(acc, {
         [r.sha]: r
       }), {});
       await this.uploadResources(buildId, missing.map(({
         id
       }) => resources[id]), meta);
+      this.log.debug(`Resources uploaded: ${options.name}...`, meta);
     }
-    this.log.debug(`Resources uploaded: ${options.name}...`, meta);
     await this.finalizeSnapshot(snapshot.data.id, meta);
     this.log.debug(`Finalized snapshot: ${options.name}...`, meta);
     return snapshot;

package/dist/utils.js

@@ -239,6 +239,17 @@ export async function request(url, options = {}, callback) {
     let req = http.request(requestOptions);
     req.on('response', handleResponse);
     req.on('error', handleError);
+
+    // Node's `timeout` option only *emits* a 'timeout' event once the socket
+    // has been idle that long — it does not abort anything. Without this
+    // listener a caller passing `timeout` still waits forever on a peer that
+    // accepts the connection and then goes silent, and the promise never
+    // settles. Destroying the request surfaces it through 'error' instead.
+    if (requestOptions.timeout) {
+      req.on('timeout', () => req.destroy(Object.assign(new Error(`Request to ${url} timed out after ${requestOptions.timeout}ms`), {
+        code: 'ETIMEDOUT'
+      })));
+    }
     req.end(body);
   }, {
     retries,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@percy/client",
-  "version": "1.32.6",
+  "version": "1.32.7-beta.2",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,7 +9,7 @@
   },
   "publishConfig": {
     "access": "public",
-    "tag": "latest"
+    "tag": "beta"
   },
   "engines": {
     "node": ">=14"
@@ -33,11 +33,11 @@
     "test:coverage": "yarn test --coverage"
   },
   "dependencies": {
-    "@percy/config": "1.32.6",
-    "@percy/env": "1.32.6",
-    "@percy/logger": "1.32.6",
+    "@percy/config": "1.32.7-beta.2",
+    "@percy/env": "1.32.7-beta.2",
+    "@percy/logger": "1.32.7-beta.2",
     "pac-proxy-agent": "^7.0.2",
     "pako": "^2.1.0"
   },
-  "gitHead": "e7dd935acf71273fd045ccceda6d1a37db8e4600"
+  "gitHead": "be6a40b9d99ef190e4f6123491241c27c8308161"
 }