fix: use unique Algolia index for each CI job

Author: nicholaschiang

.github/workflows/tests.yml

@@ -44,12 +44,13 @@ jobs:
             .next
             public/sw.js
   test:
-    # Note: This is run in a separate job in order to support parallelization
-    # that is currently disabled due to Algolia conflicts. All tests use the
-    # same Algolia `test-*` indices which leads to shared db test state (e.g.
-    # one test might clear the search index while another one is using it).
     needs: build
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        browser: [electron, firefox, chrome]
+        parallel: [1, 2, 3, 4, 5]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
@@ -68,8 +69,11 @@ jobs:
             node_modules
           key: ${{ runner.os }}-${{ hashFiles('yarn.lock') }}
       - run: yarn install --immutable --immutable-cache
+      # Each job uses its own Algolia index so as to not mess up the state of
+      # other jobs. Ideally, we'd run Algolia locally, but this works for now.
+      - run: echo "ALGOLIA_PREFIX=$(uuidgen)" >> $GITHUB_ENV
       - run: yarn start:db & yarn wait-on http-get://localhost:8080
       - run: yarn start:next & yarn wait-on http-get://localhost:3000
-      - run: yarn start:cy --record --parallel --headless
+      - run: yarn start:cy --record --parallel --headless --group ${{ matrix.browser }} -b ${{ matrix.browser }}
       - uses: codecov/codecov-action@v1
         if: ${{ success() || failure() }}

cypress/plugins/index.ts

@@ -69,10 +69,10 @@ const algoliaId = process.env.NEXT_PUBLIC_ALGOLIA_APP_ID as string;
 const algoliaKey = process.env.ALGOLIA_ADMIN_KEY as string;
 const search = algoliasearch(algoliaId, algoliaKey);
 
-const partition = process.env.NODE_ENV || 'test';
-const usersIdx = search.initIndex(`${partition}-users`);
-const matchesIdx = search.initIndex(`${partition}-matches`);
-const meetingsIdx = search.initIndex(`${partition}-meetings`);
+const prefix = process.env.ALGOLIA_PREFIX || (process.env.APP_ENV as string);
+const usersIdx = search.initIndex(`${prefix}-users`);
+const matchesIdx = search.initIndex(`${prefix}-matches`);
+const meetingsIdx = search.initIndex(`${prefix}-meetings`);
 
 export interface Overrides {
   match?: Partial<MatchJSON> | null;

lib/api/algolia.ts

@@ -6,6 +6,7 @@ import {
 import { WaitablePromise } from '@algolia/client-common';
 import algoliasearch from 'algoliasearch';
 
+const prefix = process.env.ALGOLIA_PREFIX || (process.env.APP_ENV as string);
 const algoliaId = process.env.NEXT_PUBLIC_ALGOLIA_APP_ID as string;
 const algoliaKey = process.env.ALGOLIA_ADMIN_KEY as string;
 
@@ -15,7 +16,7 @@ export function updateFilterableAttrs(
   indexId: string,
   attrs: string[]
 ): WaitablePromise<SetSettingsResponse> {
-  const idx = client.initIndex(`${process.env.APP_ENV as string}-${indexId}`);
+  const idx = client.initIndex(`${prefix}-${indexId}`);
   const attributesForFaceting = attrs.map((attr) => `filterOnly(${attr})`);
   return idx.setSettings({ attributesForFaceting });
 }
@@ -24,14 +25,14 @@ export function deleteObj(
   indexId: string,
   objId: string
 ): WaitablePromise<DeleteResponse> {
-  const idx = client.initIndex(`${process.env.APP_ENV as string}-${indexId}`);
+  const idx = client.initIndex(`${prefix}-${indexId}`);
   return idx.deleteObject(objId);
 }
 
 export default function index<T extends { toSearchHit: () => object }>(
   indexId: string,
   obj: T
 ): WaitablePromise<SaveObjectResponse> {
-  const idx = client.initIndex(`${process.env.APP_ENV as string}-${indexId}`);
+  const idx = client.initIndex(`${prefix}-${indexId}`);
   return idx.saveObject(obj.toSearchHit());
 }

lib/api/search.ts

@@ -3,6 +3,7 @@ import algoliasearch from 'algoliasearch';
 import { Option, Query } from 'lib/model/query/base';
 import { APIError } from 'lib/api/error';
 
+const prefix = process.env.ALGOLIA_PREFIX || (process.env.APP_ENV as string);
 const algoliaId = process.env.NEXT_PUBLIC_ALGOLIA_APP_ID as string;
 const algoliaKey = process.env.ALGOLIA_ADMIN_KEY as string;
 
@@ -86,7 +87,7 @@ export async function list<T, H = T>(
   try {
     let hits = 0;
     const results: T[] = [];
-    const idx = client.initIndex(`${process.env.APP_ENV as string}-${indexId}`);
+    const idx = client.initIndex(`${prefix}-${indexId}`);
 
     await Promise.all(
       filterStrings.map(async (filters) => {