refactor contextual search code

packages/docusaurus-theme-common/src/utils/__tests__/searchUtils.test.ts → packages/docusaurus-plugin-content-docs/src/client/docsSearch.test.ts

@@ -5,10 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {docVersionSearchTag} from '../searchUtils';
+import {getDocsVersionSearchTag} from './docsSearch';
 
 describe('docVersionSearchTag', () => {
   it('works', () => {
-    expect(docVersionSearchTag('foo', 'bar')).toBe('docs-foo-bar');
+    expect(getDocsVersionSearchTag('foo', 'bar')).toBe('docs-foo-bar');
   });
 });

packages/docusaurus-plugin-content-docs/src/client/docsSearch.ts

@@ -0,0 +1,57 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import {
+  useAllDocsData,
+  useActivePluginAndVersion,
+} from '@docusaurus/plugin-content-docs/client';
+import {useDocsPreferredVersionByPluginId} from './docsPreferredVersion';
+
+/** The search tag to append as each doc's metadata. */
+export function getDocsVersionSearchTag(
+  pluginId: string,
+  versionName: string,
+): string {
+  return `docs-${pluginId}-${versionName}`;
+}
+
+/**
+ * Gets the relevant docs tags to search.
+ * This is the logic that powers the contextual search feature.
+ *
+ * If user is browsing Android 1.4 docs, he'll get presented with:
+ * - Android '1.4' docs
+ * - iOS 'preferred | latest' docs
+ *
+ * The result is generic and not coupled to Algolia/DocSearch on purpose.
+ */
+export function useDocsContextualSearchTags(): string[] {
+  const allDocsData = useAllDocsData();
+  const activePluginAndVersion = useActivePluginAndVersion();
+  const docsPreferredVersionByPluginId = useDocsPreferredVersionByPluginId();
+
+  // This can't use more specialized hooks because we are mapping over all
+  // plugin instances.
+  function getDocPluginTags(pluginId: string) {
+    const activeVersion =
+      activePluginAndVersion?.activePlugin.pluginId === pluginId
+        ? activePluginAndVersion.activeVersion
+        : undefined;
+
+    const preferredVersion = docsPreferredVersionByPluginId[pluginId];
+
+    const latestVersion = allDocsData[pluginId]!.versions.find(
+      (v) => v.isLast,
+    )!;
+
+    const version = activeVersion ?? preferredVersion ?? latestVersion;
+
+    return getDocsVersionSearchTag(pluginId, version.name);
+  }
+
+  return [...Object.keys(allDocsData).map(getDocPluginTags)];
+}

packages/docusaurus-plugin-content-docs/src/client/index.ts

@@ -55,6 +55,11 @@ export {
   DocsPreferredVersionContextProvider,
 } from './docsPreferredVersion';
 
+export {
+  useDocsContextualSearchTags,
+  getDocsVersionSearchTag,
+} from './docsSearch';
+
 export type ActivePlugin = {
   pluginId: string;
   pluginData: GlobalPluginData;

packages/docusaurus-theme-classic/src/theme/DocVersionRoot/index.tsx

@@ -8,9 +8,9 @@
 import React from 'react';
 import {HtmlClassNameProvider, PageMetadata} from '@docusaurus/theme-common';
 import {
-  docVersionSearchTag,
+  getDocsVersionSearchTag,
   DocsVersionProvider,
-} from '@docusaurus/theme-common/internal';
+} from '@docusaurus/plugin-content-docs/client';
 import renderRoutes from '@docusaurus/renderRoutes';
 import SearchMetadata from '@theme/SearchMetadata';
 
@@ -22,7 +22,7 @@ function DocVersionRootMetadata(props: Props): JSX.Element {
     <>
       <SearchMetadata
         version={version.version}
-        tag={docVersionSearchTag(version.pluginId, version.version)}
+        tag={getDocsVersionSearchTag(version.pluginId, version.version)}
       />
       <PageMetadata>
         {version.noIndex && <meta name="robots" content="noindex, nofollow" />}

packages/docusaurus-theme-common/src/index.ts

@@ -32,8 +32,6 @@ export {
   listStorageKeys,
 } from './utils/storageUtils';
 
-export {useContextualSearchFilters} from './utils/searchUtils';
-
 export {usePluralForm} from './utils/usePluralForm';
 
 export {useCollapsible, Collapsible} from './components/Collapsible';

packages/docusaurus-theme-common/src/internal.ts

@@ -40,7 +40,7 @@ export {
   containsLineNumbers,
 } from './utils/codeBlockUtils';
 
-export {docVersionSearchTag, DEFAULT_SEARCH_TAG} from './utils/searchUtils';
+export {DEFAULT_SEARCH_TAG} from './utils/searchUtils';
 
 export {useTitleFormatter} from './utils/generalUtils';
 

packages/docusaurus-theme-common/src/utils/searchUtils.ts

@@ -5,62 +5,4 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {
-  useAllDocsData,
-  useActivePluginAndVersion,
-} from '@docusaurus/plugin-content-docs/client';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import {useDocsPreferredVersionByPluginId} from '@docusaurus/plugin-content-docs/src/client/docsPreferredVersion';
-
 export const DEFAULT_SEARCH_TAG = 'default';
-
-/** The search tag to append as each doc's metadata. */
-export function docVersionSearchTag(
-  pluginId: string,
-  versionName: string,
-): string {
-  return `docs-${pluginId}-${versionName}`;
-}
-
-/**
- * Gets the relevant context information for contextual search.
- *
- * The value is generic and not coupled to Algolia/DocSearch, since we may want
- * to support multiple search engines, or allowing users to use their own search
- * engine solution.
- */
-export function useContextualSearchFilters(): {locale: string; tags: string[]} {
-  const {i18n} = useDocusaurusContext();
-  const allDocsData = useAllDocsData();
-  const activePluginAndVersion = useActivePluginAndVersion();
-  const docsPreferredVersionByPluginId = useDocsPreferredVersionByPluginId();
-
-  // This can't use more specialized hooks because we are mapping over all
-  // plugin instances.
-  function getDocPluginTags(pluginId: string) {
-    const activeVersion =
-      activePluginAndVersion?.activePlugin.pluginId === pluginId
-        ? activePluginAndVersion.activeVersion
-        : undefined;
-
-    const preferredVersion = docsPreferredVersionByPluginId[pluginId];
-
-    const latestVersion = allDocsData[pluginId]!.versions.find(
-      (v) => v.isLast,
-    )!;
-
-    const version = activeVersion ?? preferredVersion ?? latestVersion;
-
-    return docVersionSearchTag(pluginId, version.name);
-  }
-
-  const tags = [
-    DEFAULT_SEARCH_TAG,
-    ...Object.keys(allDocsData).map(getDocPluginTags),
-  ];
-
-  return {
-    locale: i18n.currentLocale,
-    tags,
-  };
-}

packages/docusaurus-theme-search-algolia/src/client/useAlgoliaContextualFacetFilters.ts

@@ -5,11 +5,20 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {useContextualSearchFilters} from '@docusaurus/theme-common';
+import {DEFAULT_SEARCH_TAG} from '@docusaurus/theme-common/internal';
+import {useDocsContextualSearchTags} from '@docusaurus/plugin-content-docs/client';
+import useDocusaurusContext from '@docusaurus/core/src/client/exports/useDocusaurusContext';
 
-// Translate search-engine agnostic search filters to Algolia search filters
+function useSearchTags() {
+  // only docs have custom search tags per version
+  const docsTags = useDocsContextualSearchTags();
+  return [DEFAULT_SEARCH_TAG, ...docsTags];
+}
+
+// Translate search-engine agnostic search tags to Algolia search filters
 export function useAlgoliaContextualFacetFilters(): [string, string[]] {
-  const {locale, tags} = useContextualSearchFilters();
+  const locale = useDocusaurusContext().i18n.currentLocale;
+  const tags = useSearchTags();
 
   // Seems safe to convert locale->language, see AlgoliaSearchMetadata comment
   const languageFilter = `language:${locale}`;