Merge pull request #1191 from chromaui/CAP-3243

Get build progress updates through Chromatic notify service

Author: justin-thurman

node-src/lib/getEnvironment.test.ts

@@ -0,0 +1,34 @@
+import { describe, expect, it, vi } from 'vitest';
+
+describe('CHROMATIC_NOTIFY_SERVICE_URL', () => {
+  it('returns production url by default', async () => {
+    const { default: getEnvironment } = await import('./getEnvironment');
+    expect(getEnvironment().CHROMATIC_NOTIFY_SERVICE_URL).toBe('wss://notify.chromatic.com');
+  });
+
+  it('returns dev url if index url is dev', async () => {
+    vi.stubEnv('CHROMATIC_INDEX_URL', 'https://index.dev-chromatic.com');
+    vi.resetModules();
+
+    const { default: getEnvironment } = await import('./getEnvironment');
+    expect(getEnvironment().CHROMATIC_NOTIFY_SERVICE_URL).toBe('wss://notify.dev-chromatic.com');
+  });
+
+  it('returns staging url if index url is staging', async () => {
+    vi.stubEnv('CHROMATIC_INDEX_URL', 'https://index.staging-chromatic.com');
+    vi.resetModules();
+
+    const { default: getEnvironment } = await import('./getEnvironment');
+    expect(getEnvironment().CHROMATIC_NOTIFY_SERVICE_URL).toBe(
+      'wss://notify.staging-chromatic.com'
+    );
+  });
+
+  it('returns the configured CHROMATIC_NOTIFY_SERVICE_URL if it is set', async () => {
+    vi.stubEnv('CHROMATIC_NOTIFY_SERVICE_URL', 'wss://notify.other-chromatic.com');
+    vi.resetModules();
+
+    const { default: getEnvironment } = await import('./getEnvironment');
+    expect(getEnvironment().CHROMATIC_NOTIFY_SERVICE_URL).toBe('wss://notify.other-chromatic.com');
+  });
+});

node-src/lib/getEnvironment.ts

@@ -3,6 +3,7 @@ export interface Environment {
   CHROMATIC_DNS_SERVERS: string[];
   CHROMATIC_HASH_CONCURRENCY: number;
   CHROMATIC_INDEX_URL: string;
+  CHROMATIC_NOTIFY_SERVICE_URL: string;
   CHROMATIC_OUTPUT_INTERVAL: number;
   CHROMATIC_POLL_INTERVAL: number;
   CHROMATIC_PROJECT_TOKEN?: string;
@@ -24,6 +25,7 @@ const {
   CHROMATIC_DNS_SERVERS = '',
   CHROMATIC_HASH_CONCURRENCY = '48',
   CHROMATIC_INDEX_URL = 'https://index.chromatic.com',
+  CHROMATIC_NOTIFY_SERVICE_URL,
   CHROMATIC_OUTPUT_INTERVAL = String(10 * 1000),
   CHROMATIC_POLL_INTERVAL = String(1000),
   CHROMATIC_PROJECT_TOKEN,
@@ -60,6 +62,8 @@ export default function getEnvironment(): Environment {
       .filter(Boolean),
     CHROMATIC_HASH_CONCURRENCY: Number.parseInt(CHROMATIC_HASH_CONCURRENCY, 10),
     CHROMATIC_INDEX_URL,
+    CHROMATIC_NOTIFY_SERVICE_URL:
+      CHROMATIC_NOTIFY_SERVICE_URL || getNotifyServiceUrl(CHROMATIC_INDEX_URL),
     CHROMATIC_OUTPUT_INTERVAL: Number.parseInt(CHROMATIC_OUTPUT_INTERVAL, 10),
     CHROMATIC_POLL_INTERVAL: Number.parseInt(CHROMATIC_POLL_INTERVAL, 10),
     CHROMATIC_PROJECT_TOKEN,
@@ -76,3 +80,15 @@ export default function getEnvironment(): Environment {
     STORYBOOK_NODE_ENV,
   };
 }
+
+function getNotifyServiceUrl(indexUrl: string) {
+  if (indexUrl.includes('dev')) {
+    return 'wss://notify.dev-chromatic.com';
+  }
+
+  if (indexUrl.includes('staging')) {
+    return 'wss://notify.staging-chromatic.com';
+  }
+
+  return 'wss://notify.chromatic.com';
+}