creating helper method to send failed event from js sdk's

percy · Oct 20, 2023 · 78ec02e · 78ec02e
1 parent 15b3d06
commit 78ec02e
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 10 deletions.
diff --git a/packages/core/src/api.js b/packages/core/src/api.js
@@ -124,7 +124,7 @@ export function createPercyServer(percy, port) {
   // Recieves events from sdk's.
     .route('post', '/percy/events', async (req, res) => {
       percyFailedEventHandler(req, pkg.version);
-      await percy.client.sendFailedEvents(percy.build.id, req.body);
+      await percy.client.sendFailedEvents(percy.build?.id, req.body);
       res.json(200, { success: true });
     })
   // stops percy at the end of the current event loop

diff --git a/packages/core/src/utils.js b/packages/core/src/utils.js
@@ -1,5 +1,5 @@
 import EventEmitter from 'events';
-import { sha256hash, getPackageJSON } from '@percy/client/utils';
+import { sha256hash } from '@percy/client/utils';
 import { camelcase, merge } from '@percy/config/utils';
 
 export {
@@ -72,9 +72,9 @@ export function percyFailedEventHandler(req, cliVersion) {
     // Remove the original clientInfo field
     delete req.body.clientInfo;
   }
-  req.body.cliVersion = cliVersion;
-  let pkg = getPackageJSON(import.meta.url);
-  req.body.cliVersion = pkg.version;
+  if (!req.body.cliVersion) {
+    req.body.cliVersion = cliVersion;
+  }
 }
 
 // Creates a local resource object containing the resource URL, mimetype, content, sha, and any

diff --git a/packages/core/test/api.test.js b/packages/core/test/api.test.js
@@ -344,23 +344,22 @@ describe('API Server', () => {
   });
 
   it('has a /events endpoint that calls #sendFailedEvents() async with provided options with clientInfo absent', async () => {
-    let { getPackageJSON } = await import('@percy/client/utils');
-    let pkg = getPackageJSON(import.meta.url);
     let resolve, test = new Promise(r => (resolve = r));
     let sendFailedEventsSpy = spyOn(percy.client, 'sendFailedEvents').and.resolveTo('some response');
 
     await percy.start();
 
     await expectAsync(request('/percy/events', {
       body: {
-        errorMessage: 'some error'
+        errorMessage: 'some error',
+        cliVersion: '1.2.3'
       },
       method: 'post'
     })).toBeResolvedTo({ success: true });
 
     expect(sendFailedEventsSpy).toHaveBeenCalledOnceWith(percy.build.id, jasmine.objectContaining({
       errorMessage: 'some error',
-      cliVersion: pkg.version
+      cliVersion: '1.2.3'
     }));
 
     await expectAsync(test).toBePending();

diff --git a/packages/sdk-utils/src/index.js b/packages/sdk-utils/src/index.js
@@ -6,6 +6,7 @@ import waitForPercyIdle from './percy-idle.js';
 import fetchPercyDOM from './percy-dom.js';
 import postSnapshot from './post-snapshot.js';
 import postComparison from './post-comparison.js';
+import postFailedEvent from './post-failed-event.js';
 import flushSnapshots from './flush-snapshots.js';
 import captureAutomateScreenshot from './post-screenshot.js';
 
@@ -19,7 +20,8 @@ export {
   postSnapshot,
   postComparison,
   flushSnapshots,
-  captureAutomateScreenshot
+  captureAutomateScreenshot,
+  postFailedEvent
 };
 
 // export the namespace by default

diff --git a/packages/sdk-utils/src/post-failed-event.js b/packages/sdk-utils/src/post-failed-event.js
@@ -0,0 +1,10 @@
+import request from './request.js';
+
+// Post failed event data to the CLI event endpoint.
+export async function postFailedEvent(options) {
+  return await request.post('/percy/events', options).catch(err => {
+    throw err;
+  });
+}
+
+export default postFailedEvent;
diff --git a/packages/sdk-utils/test/index.test.js b/packages/sdk-utils/test/index.test.js
@@ -298,6 +298,32 @@ describe('SDK Utils', () => {
     });
   });
 
+  describe('postFailedEvent(options)', () => {
+    let { postFailedEvent } = utils;
+    let options;
+
+    beforeEach(() => {
+      options = {
+        errorMessage: 'someError',
+        errorKind: 'sdk',
+        cliVersion: '1.2.3'
+      };
+    });
+
+    it('posts comparison options to the CLI API event endpoint', async () => {
+      spyOn(utils.request, 'post').and.callFake(() => Promise.resolve());
+      await expectAsync(postFailedEvent(options)).toBeResolved();
+      await expectAsync(helpers.get('requests')).toBeResolvedTo({});
+    });
+
+    it('throws when the event API fails', async () => {
+      await helpers.test('error', '/percy/events');
+
+      await expectAsync(postFailedEvent({}))
+        .toBeRejectedWithError('testing');
+    });
+  });
+
   describe('flushSnapshots([options])', () => {
     let { flushSnapshots } = utils;