fix(algoliasearch): correctly retrieve headers for v5 (#1263)

algolia · Jul 9, 2024 · 148b677 · 148b677
1 parent 0ae0c5c
commit 148b677
Show file tree

Hide file tree

Showing 12 changed files with 144 additions and 44 deletions.
diff --git a/examples/react-17/src/Highlight.tsx b/examples/react-17/src/Highlight.tsx
@@ -11,7 +11,7 @@ type HighlightHitParams<THit> = {
    *
    * You can use the array syntax to reference nested attributes.
    */
-  attribute: keyof THit | (string | number)[];
+  attribute: keyof THit | Array<string | number>;
   /**
    * The tag name to use for highlighted parts.
    *

diff --git a/package.json b/package.json
@@ -45,6 +45,7 @@
     "@typescript-eslint/eslint-plugin": "2.34.0",
     "@typescript-eslint/parser": "2.34.0",
     "algoliasearch": "4.16.0",
+    "algoliasearch-v5": "npm:algoliasearch@5.0.0-beta.8",
     "autoprefixer": "10.4.14",
     "babel-eslint": "10.1.0",
     "babel-loader": "8.2.3",

diff --git a/packages/autocomplete-preset-algolia/src/highlight/ParseAlgoliaHitParams.ts b/packages/autocomplete-preset-algolia/src/highlight/ParseAlgoliaHitParams.ts
@@ -1,4 +1,4 @@
 export type ParseAlgoliaHitParams<TItem> = {
   hit: TItem;
-  attribute: keyof TItem | (string | number)[];
+  attribute: keyof TItem | Array<string | number>;
 };
diff --git a/...ages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitHighlight.test.ts b/...ages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitHighlight.test.ts
@@ -175,16 +175,19 @@ describe('parseAlgoliaHitHighlight', () => {
           objectID: '1',
           titles: ['Hello', 'world'],
           _highlightResult: {
-            titles: [{
-              value: 'Hello',
-              matchLevel: 'none',
-              matchedWords: [],
-            }, {
-              value: '__aa-highlight__world__/aa-highlight__',
-              matchLevel: 'full',
-              matchedWords: ['world'],
-              fullyHighlighted: true,
-            }]
+            titles: [
+              {
+                value: 'Hello',
+                matchLevel: 'none',
+                matchedWords: [],
+              },
+              {
+                value: '__aa-highlight__world__/aa-highlight__',
+                matchLevel: 'full',
+                matchedWords: ['world'],
+                fullyHighlighted: true,
+              },
+            ],
           },
         },
       })

diff --git a/...tocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitReverseHighlight.test.ts b/...tocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitReverseHighlight.test.ts
@@ -172,16 +172,19 @@ describe('parseAlgoliaHitReverseHighlight', () => {
           objectID: '1',
           titles: ['Hello', 'world'],
           _highlightResult: {
-            titles: [{
-              value: 'Hello',
-              matchLevel: 'none',
-              matchedWords: [],
-            }, {
-              value: '__aa-highlight__world__/aa-highlight__',
-              matchLevel: 'full',
-              matchedWords: ['world'],
-              fullyHighlighted: true,
-            }]
+            titles: [
+              {
+                value: 'Hello',
+                matchLevel: 'none',
+                matchedWords: [],
+              },
+              {
+                value: '__aa-highlight__world__/aa-highlight__',
+                matchLevel: 'full',
+                matchedWords: ['world'],
+                fullyHighlighted: true,
+              },
+            ],
           },
         },
       })

diff --git a/...autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitReverseSnippet.test.ts b/...autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitReverseSnippet.test.ts
@@ -163,13 +163,16 @@ describe('parseAlgoliaHitReverseSnippet', () => {
           objectID: '1',
           titles: ['Hello', 'world'],
           _snippetResult: {
-            titles: [{
-              value: 'Hello',
-              matchLevel: 'none',
-            }, {
-              value: '__aa-highlight__world__/aa-highlight__',
-              matchLevel: 'full',
-            }]
+            titles: [
+              {
+                value: 'Hello',
+                matchLevel: 'none',
+              },
+              {
+                value: '__aa-highlight__world__/aa-highlight__',
+                matchLevel: 'full',
+              },
+            ],
           },
         },
       })

diff --git a/packages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitSnippet.test.ts b/packages/autocomplete-preset-algolia/src/highlight/__tests__/parseAlgoliaHitSnippet.test.ts
@@ -163,13 +163,16 @@ describe('parseAlgoliaHitSnippet', () => {
           objectID: '1',
           titles: ['Hello', 'world'],
           _snippetResult: {
-            titles: [{
-              value: 'Hello',
-              matchLevel: 'none',
-            }, {
-              value: '__aa-highlight__world__/aa-highlight__',
-              matchLevel: 'full',
-            }]
+            titles: [
+              {
+                value: 'Hello',
+                matchLevel: 'none',
+              },
+              {
+                value: '__aa-highlight__world__/aa-highlight__',
+                matchLevel: 'full',
+              },
+            ],
           },
         },
       })

diff --git a/packages/autocomplete-preset-algolia/src/utils/__tests__/getAppIdAndApiKey.test.ts b/packages/autocomplete-preset-algolia/src/utils/__tests__/getAppIdAndApiKey.test.ts
@@ -1,23 +1,30 @@
 import algoliasearchV4 from 'algoliasearch';
+import { liteClient as algoliasearchV5 } from 'algoliasearch-v5/lite';
 
 import { getAppIdAndApiKey } from '../getAppIdAndApiKey';
 
 const APP_ID = 'myAppId';
 const API_KEY = 'myApiKey';
 
 describe('getAppIdAndApiKey', () => {
-  it('gets appId and apiKey from searchClient', () => {
+  it('gets appId and apiKey from searchClient@v4', () => {
     const searchClient = algoliasearchV4(APP_ID, API_KEY);
     const { appId, apiKey } = getAppIdAndApiKey(searchClient);
     expect(appId).toEqual(APP_ID);
     expect(apiKey).toEqual(API_KEY);
   });
 
+  it('gets appId and apiKey from searchClient@v5', () => {
+    const searchClient = algoliasearchV5(APP_ID, API_KEY);
+    const { appId, apiKey } = getAppIdAndApiKey(searchClient);
+    expect(appId).toEqual(APP_ID);
+    expect(apiKey).toEqual(API_KEY);
+  });
+
   it('gets undefined appId and apiKey from broken search client', () => {
     const searchClient = {
       search: algoliasearchV4(APP_ID, API_KEY).search,
     };
-    // @ts-expect-error
     const { appId, apiKey } = getAppIdAndApiKey(searchClient);
     expect(appId).toEqual(undefined);
     expect(apiKey).toEqual(undefined);

diff --git a/packages/autocomplete-preset-algolia/src/utils/getAppIdAndApiKey.ts b/packages/autocomplete-preset-algolia/src/utils/getAppIdAndApiKey.ts
@@ -1,10 +1,12 @@
-import type { SearchClient } from '../types';
-
-export function getAppIdAndApiKey(searchClient: SearchClient): {
+// typed as any, since it accepts the _real_ js clients, not the interface we otherwise expect
+export function getAppIdAndApiKey(searchClient: any): {
   appId: string;
   apiKey: string;
 } {
-  const { headers = {}, queryParameters = {} } = searchClient.transporter || {};
+  const transporter = searchClient.transporter || {};
+  const headers = transporter.headers || transporter.baseHeaders || {};
+  const queryParameters =
+    transporter.queryParameters || transporter.baseQueryParameters || {};
   const APP_ID = 'x-algolia-application-id';
   const API_KEY = 'x-algolia-api-key';
   const appId = headers[APP_ID] || queryParameters[APP_ID];

diff --git a/packages/autocomplete-shared/src/getAttributeValueByPath.ts b/packages/autocomplete-shared/src/getAttributeValueByPath.ts
@@ -1,6 +1,6 @@
 export function getAttributeValueByPath<TRecord>(
   record: TRecord,
-  path: (string | number)[]
+  path: Array<string | number>
 ): any {
   return path.reduce((current, key) => current && current[key], record);
 }
diff --git a/packages/autocomplete-shared/src/js/HighlightHitParams.ts b/packages/autocomplete-shared/src/js/HighlightHitParams.ts
@@ -8,7 +8,7 @@ export type HighlightHitParams<THit> = {
    *
    * You can use the array syntax to reference nested attributes.
    */
-  attribute: keyof THit | (string | number)[];
+  attribute: keyof THit | Array<string | number>;
   /**
    * The tag name to use for highlighted parts.
    *

diff --git a/yarn.lock b/yarn.lock
@@ -35,6 +35,15 @@
   dependencies:
     "@algolia/cache-common" "4.16.0"
 
+"@algolia/client-abtesting@5.0.0-beta.8":
+  version "5.0.0-beta.8"
+  resolved "https://registry.yarnpkg.com/@algolia/client-abtesting/-/client-abtesting-5.0.0-beta.8.tgz#07950e042e19abe473b6659660dbbaf3d5ae5750"
+  integrity sha512-SX9/v/1CinWhn8UyPS4zoiCuqLepAoaPiwiJvMal1q8huQzHPYgaQRGu5SwXf/jzUnXnWLiWakyZZ0WkGHj6yA==
+  dependencies:
+    "@algolia/client-common" "5.0.0-beta.9"
+    "@algolia/requester-browser-xhr" "5.0.0-beta.9"
+    "@algolia/requester-node-http" "5.0.0-beta.9"
+
 "@algolia/client-account@4.16.0":
   version "4.16.0"
   resolved "https://registry.yarnpkg.com/@algolia/client-account/-/client-account-4.16.0.tgz#3164e28df1b6428a60f43b8a97ea669d6bbbce9e"
@@ -54,6 +63,15 @@
     "@algolia/requester-common" "4.16.0"
     "@algolia/transporter" "4.16.0"
 
+"@algolia/client-analytics@5.0.0-beta.8":
+  version "5.0.0-beta.8"
+  resolved "https://registry.yarnpkg.com/@algolia/client-analytics/-/client-analytics-5.0.0-beta.8.tgz#86d110bed99ca28359bd4e70eaeff568cb6462bb"
+  integrity sha512-SzMg3FeF7do/+plUawHRw2Lr3/KebKF8rCkswdR907kUa/aMVCFzsginL3xc/k8bIxx6wU8fk5iKLeK1+Ykxnw==
+  dependencies:
+    "@algolia/client-common" "5.0.0-beta.9"
+    "@algolia/requester-browser-xhr" "5.0.0-beta.9"
+    "@algolia/requester-node-http" "5.0.0-beta.9"
+
 "@algolia/client-common@4.16.0":
   version "4.16.0"
   resolved "https://registry.yarnpkg.com/@algolia/client-common/-/client-common-4.16.0.tgz#670f4b2286755090a6389c55d79402716e4556ac"
@@ -62,6 +80,11 @@
     "@algolia/requester-common" "4.16.0"
     "@algolia/transporter" "4.16.0"
 
+"@algolia/client-common@5.0.0-beta.9":
+  version "5.0.0-beta.9"
+  resolved "https://registry.yarnpkg.com/@algolia/client-common/-/client-common-5.0.0-beta.9.tgz#f659c0fca45663a09f7bcf5eb36318ef5ab39b40"
+  integrity sha512-TWf6l4/pWMk8CgV+8A4zTe49XaygaCZ6ir8bwf4WnpDgAxx8Y5X/I6e7vPzl7sljQEEB9q1+qlkss1nxNeRJPw==
+
 "@algolia/client-personalization@4.16.0":
   version "4.16.0"
   resolved "https://registry.yarnpkg.com/@algolia/client-personalization/-/client-personalization-4.16.0.tgz#927728c069b42f39fc83ce61a1fdcc79cd38b842"
@@ -71,6 +94,15 @@
     "@algolia/requester-common" "4.16.0"
     "@algolia/transporter" "4.16.0"
 
+"@algolia/client-personalization@5.0.0-beta.8":
+  version "5.0.0-beta.8"
+  resolved "https://registry.yarnpkg.com/@algolia/client-personalization/-/client-personalization-5.0.0-beta.8.tgz#18b624c9e268da3c36c5416e593e778cdaca338c"
+  integrity sha512-8mGxWE3TA3+2ekc+rM38JAwFfpwPyWyPxjjOe33afiFkmDliLrsGDAyoCasu7w34JhpuLeR1wfgo58g9s9+OLw==
+  dependencies:
+    "@algolia/client-common" "5.0.0-beta.9"
+    "@algolia/requester-browser-xhr" "5.0.0-beta.9"
+    "@algolia/requester-node-http" "5.0.0-beta.9"
+
 "@algolia/client-search@4.16.0":
   version "4.16.0"
   resolved "https://registry.yarnpkg.com/@algolia/client-search/-/client-search-4.16.0.tgz#19a76bc6cfa495aa9011b32dd85305baa2579589"
@@ -80,6 +112,15 @@
     "@algolia/requester-common" "4.16.0"
     "@algolia/transporter" "4.16.0"
 
+"@algolia/client-search@5.0.0-beta.8":
+  version "5.0.0-beta.8"
+  resolved "https://registry.yarnpkg.com/@algolia/client-search/-/client-search-5.0.0-beta.8.tgz#5abeb90de119ee868aa6a2d898c9d98cf8292258"
+  integrity sha512-Ub7CEFLDvCF13tq6imE7sEKnxmo177k4euXjaKGUMlznUf9qLWT5g6HuvBH4Nrxwaotima3cRnIw3zkq4JZORw==
+  dependencies:
+    "@algolia/client-common" "5.0.0-beta.9"
+    "@algolia/requester-browser-xhr" "5.0.0-beta.9"
+    "@algolia/requester-node-http" "5.0.0-beta.9"
+
 "@algolia/events@^4.0.1":
   version "4.0.1"
   resolved "https://registry.yarnpkg.com/@algolia/events/-/events-4.0.1.tgz#fd39e7477e7bc703d7f893b556f676c032af3950"
@@ -97,13 +138,29 @@
   dependencies:
     "@algolia/logger-common" "4.16.0"
 
+"@algolia/recommend@5.0.0-beta.8":
+  version "5.0.0-beta.8"
+  resolved "https://registry.yarnpkg.com/@algolia/recommend/-/recommend-5.0.0-beta.8.tgz#eff81537479a3390a33ddbffcbf82ae194160019"
+  integrity sha512-B7tuqYF2YlPmRH5jfDbbC3V1sq8X3a7oadwzAOPGGC1qwi2tO8BoBLM2iIwJRAAesw4NRVeBVDDmdsdiStHeEQ==
+  dependencies:
+    "@algolia/client-common" "5.0.0-beta.9"
+    "@algolia/requester-browser-xhr" "5.0.0-beta.9"
+    "@algolia/requester-node-http" "5.0.0-beta.9"
+
 "@algolia/requester-browser-xhr@4.16.0":
   version "4.16.0"
   resolved "https://registry.yarnpkg.com/@algolia/requester-browser-xhr/-/requester-browser-xhr-4.16.0.tgz#742090e53301889ae01581eedcc5bfc2c6dd7660"
   integrity sha512-gK+kvs6LHl/PaOJfDuwjkopNbG1djzFLsVBklGBsSU6h6VjFkxIpo6Qq80IK14p9cplYZfhfaL12va6Q9p3KVQ==
   dependencies:
     "@algolia/requester-common" "4.16.0"
 
+"@algolia/requester-browser-xhr@5.0.0-beta.9":
+  version "5.0.0-beta.9"
+  resolved "https://registry.yarnpkg.com/@algolia/requester-browser-xhr/-/requester-browser-xhr-5.0.0-beta.9.tgz#7b43b57cfabe9328e54fb4a96dd10026d27329f1"
+  integrity sha512-zw/ZmZv/CLjLqBUfukk5kR8N/xF/TbUt6xLdXF1LkaEJDj7BWU1RqMMDeSU5SEcehPMqNumfzFjpaz8D0rZ/jw==
+  dependencies:
+    "@algolia/client-common" "5.0.0-beta.9"
+
 "@algolia/requester-common@4.16.0":
   version "4.16.0"
   resolved "https://registry.yarnpkg.com/@algolia/requester-common/-/requester-common-4.16.0.tgz#a24eb9fc9062f76c2e06599c678542e78c8bce1c"
@@ -116,6 +173,13 @@
   dependencies:
     "@algolia/requester-common" "4.16.0"
 
+"@algolia/requester-node-http@5.0.0-beta.9":
+  version "5.0.0-beta.9"
+  resolved "https://registry.yarnpkg.com/@algolia/requester-node-http/-/requester-node-http-5.0.0-beta.9.tgz#afc04a658c1b624e03e378ea076020a51e737637"
+  integrity sha512-/32llTTdZ0zMNwn8I8FA12Pw4wZW93AvoHU/8Si2UR8S+FyL8dAkwgmQAvRZinNXD/Bo45Mpjwgydhx9UNZNBA==
+  dependencies:
+    "@algolia/client-common" "5.0.0-beta.9"
+
 "@algolia/transporter@4.16.0":
   version "4.16.0"
   resolved "https://registry.yarnpkg.com/@algolia/transporter/-/transporter-4.16.0.tgz#5e6ca73c8a72d91b7dd75b00b5e45e8538bad8b6"
@@ -5150,6 +5214,20 @@ algoliasearch-helper@^3.11.3:
   dependencies:
     "@algolia/events" "^4.0.1"
 
+"algoliasearch-v5@npm:algoliasearch@5.0.0-beta.8":
+  version "5.0.0-beta.8"
+  resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-5.0.0-beta.8.tgz#df9ae7351f4d16ef20f04c7ed90203bfb8bdc9df"
+  integrity sha512-HeHubssxYRD9OEBySLXM8DdsrDthdyVSogncyQkxO3U+EYfg94Fxe7Kn9ooDm4sX88HS+lOaIV3I+JSwpvoy6A==
+  dependencies:
+    "@algolia/client-abtesting" "5.0.0-beta.8"
+    "@algolia/client-analytics" "5.0.0-beta.8"
+    "@algolia/client-common" "5.0.0-beta.9"
+    "@algolia/client-personalization" "5.0.0-beta.8"
+    "@algolia/client-search" "5.0.0-beta.8"
+    "@algolia/recommend" "5.0.0-beta.8"
+    "@algolia/requester-browser-xhr" "5.0.0-beta.9"
+    "@algolia/requester-node-http" "5.0.0-beta.9"
+
 algoliasearch@4.16.0:
   version "4.16.0"
   resolved "https://registry.yarnpkg.com/algoliasearch/-/algoliasearch-4.16.0.tgz#2807f1aee8a574fa8480f39a09b16e407d4cc1a6"