fix tests

packages/docusaurus-theme-common/src/contexts/__tests__/docsSidebar.test.tsx

@@ -0,0 +1,31 @@
+/**
+ * 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 React from 'react';
+import {renderHook} from '@testing-library/react-hooks';
+import {useDocsSidebar, DocsSidebarProvider} from '../docsSidebar';
+import type {PropSidebar} from '@docusaurus/plugin-content-docs';
+
+describe('useDocsSidebar', () => {
+  it('throws if context provider is missing', () => {
+    expect(
+      () => renderHook(() => useDocsSidebar()).result.current,
+    ).toThrowErrorMatchingInlineSnapshot(
+      `"Hook useDocsSidebar is called outside the <DocsSidebarProvider>. "`,
+    );
+  });
+
+  it('reads value from context provider', () => {
+    const sidebar: PropSidebar = [];
+    const {result} = renderHook(() => useDocsSidebar(), {
+      wrapper: ({children}) => (
+        <DocsSidebarProvider sidebar={sidebar}>{children}</DocsSidebarProvider>
+      ),
+    });
+    expect(result.current).toBe(sidebar);
+  });
+});

packages/docusaurus-theme-common/src/contexts/__tests__/docsVersion.test.tsx

@@ -0,0 +1,46 @@
+/**
+ * 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 React from 'react';
+import {renderHook} from '@testing-library/react-hooks';
+import {useDocsVersion, DocsVersionProvider} from '../docsVersion';
+import type {PropVersionMetadata} from '@docusaurus/plugin-content-docs';
+
+function testVersion(data?: Partial<PropVersionMetadata>): PropVersionMetadata {
+  return {
+    version: 'versionName',
+    label: 'Version Label',
+    className: 'version className',
+    badge: true,
+    banner: 'unreleased',
+    docs: {},
+    docsSidebars: {},
+    isLast: false,
+    pluginId: 'default',
+    ...data,
+  };
+}
+
+describe('useDocsVersion', () => {
+  it('throws if context provider is missing', () => {
+    expect(
+      () => renderHook(() => useDocsVersion()).result.current,
+    ).toThrowErrorMatchingInlineSnapshot(
+      `"Hook useDocsVersion is called outside the <DocsVersionProvider>. "`,
+    );
+  });
+
+  it('reads value from context provider', () => {
+    const version = testVersion();
+    const {result} = renderHook(() => useDocsVersion(), {
+      wrapper: ({children}) => (
+        <DocsVersionProvider version={version}>{children}</DocsVersionProvider>
+      ),
+    });
+    expect(result.current).toBe(version);
+  });
+});

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

@@ -30,15 +30,17 @@ export {createStorageSlot, listStorageKeys} from './utils/storageUtils';
 
 export {useAlternatePageUtils} from './utils/useAlternatePageUtils';
 
-export {useContextualSearchFilters} from './utils/useContextualSearchFilters';
-
 export {
   parseCodeBlockTitle,
   parseLanguage,
   parseLines,
 } from './utils/codeBlockUtils';
 
-export {docVersionSearchTag, DEFAULT_SEARCH_TAG} from './utils/searchUtils';
+export {
+  docVersionSearchTag,
+  DEFAULT_SEARCH_TAG,
+  useContextualSearchFilters,
+} from './utils/searchUtils';
 
 export {
   isDocsPluginEnabled,

packages/docusaurus-theme-common/src/utils/__tests__/docsUtils.test.tsx

@@ -10,15 +10,13 @@ import {renderHook} from '@testing-library/react-hooks';
 import {
   findFirstCategoryLink,
   isActiveSidebarItem,
-  DocsVersionProvider,
-  useDocsVersion,
   useDocById,
-  useDocsSidebar,
-  DocsSidebarProvider,
   findSidebarCategory,
   useCurrentSidebarCategory,
   useSidebarBreadcrumbs,
 } from '../docsUtils';
+import {DocsSidebarProvider} from '../../contexts/docsSidebar';
+import {DocsVersionProvider} from '../../contexts/docsVersion';
 import {StaticRouter} from 'react-router-dom';
 import {Context} from '@docusaurus/core/src/client/docusaurusContext';
 import type {
@@ -68,46 +66,6 @@ function testVersion(data?: Partial<PropVersionMetadata>): PropVersionMetadata {
   };
 }
 
-describe('useDocsVersion', () => {
-  it('throws if context provider is missing', () => {
-    expect(
-      () => renderHook(() => useDocsVersion()).result.current,
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"Hook useDocsVersion is called outside the <DocsVersionProvider>. "`,
-    );
-  });
-
-  it('reads value from context provider', () => {
-    const version = testVersion();
-    const {result} = renderHook(() => useDocsVersion(), {
-      wrapper: ({children}) => (
-        <DocsVersionProvider version={version}>{children}</DocsVersionProvider>
-      ),
-    });
-    expect(result.current).toBe(version);
-  });
-});
-
-describe('useDocsSidebar', () => {
-  it('throws if context provider is missing', () => {
-    expect(
-      () => renderHook(() => useDocsSidebar()).result.current,
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"Hook useDocsSidebar is called outside the <DocsSidebarProvider>. "`,
-    );
-  });
-
-  it('reads value from context provider', () => {
-    const sidebar: PropSidebar = [];
-    const {result} = renderHook(() => useDocsSidebar(), {
-      wrapper: ({children}) => (
-        <DocsSidebarProvider sidebar={sidebar}>{children}</DocsSidebarProvider>
-      ),
-    });
-    expect(result.current).toBe(sidebar);
-  });
-});
-
 describe('useDocById', () => {
   const version = testVersion({
     docs: {
@@ -506,11 +464,11 @@ describe('useCurrentSidebarCategory', () => {
     const mockUseCurrentSidebarCategory = createUseCurrentSidebarCategoryMock([
       category,
     ]);
-    expect(() => mockUseCurrentSidebarCategory('/cat'))
-      .toThrowErrorMatchingInlineSnapshot(`
-      "Unexpected: sidebar category could not be found for pathname='/cat'.
-      Hook useCurrentSidebarCategory() should only be used on Category pages"
-    `);
+    expect(() =>
+      mockUseCurrentSidebarCategory('/cat'),
+    ).toThrowErrorMatchingInlineSnapshot(
+      `"/cat is not associated with a category. useCurrentSidebarCategory() should only be used on category index pages."`,
+    );
   });
 
   it('throws when sidebar is missing', () => {

packages/docusaurus-theme-common/src/utils/metadataUtils.tsx

@@ -47,6 +47,7 @@ export function PageMetadata({
         <meta
           name="keywords"
           content={
+            // https://github.com/microsoft/TypeScript/issues/17002
             (Array.isArray(keywords) ? keywords.join(',') : keywords) as string
           }
         />

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

@@ -69,11 +69,7 @@ export function findHomePageRoute({
 export function useHomePageRoute(): Route | undefined {
   const {baseUrl} = useDocusaurusContext().siteConfig;
   return useMemo(
-    () =>
-      findHomePageRoute({
-        routes: generatedRoutes,
-        baseUrl,
-      }),
+    () => findHomePageRoute({routes: generatedRoutes, baseUrl}),
     [baseUrl],
   );
 }

packages/docusaurus-theme-common/src/utils/scrollUtils.tsx

@@ -127,12 +127,8 @@ export function useScrollPosition(
     window.addEventListener('scroll', handleScroll, opts);
 
     return () => window.removeEventListener('scroll', handleScroll, opts);
-  }, [
-    dynamicEffect,
-    scrollEventsEnabledRef,
     // eslint-disable-next-line react-hooks/exhaustive-deps
-    ...deps,
-  ]);
+  }, [dynamicEffect, scrollEventsEnabledRef, ...deps]);
 }
 
 type UseScrollPositionSaver = {

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

@@ -5,6 +5,13 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+import {
+  useAllDocsData,
+  useActivePluginAndVersion,
+} from '@docusaurus/plugin-content-docs/client';
+import {useDocsPreferredVersionByPluginId} from '../contexts/docsPreferredVersion';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+
 export const DEFAULT_SEARCH_TAG = 'default';
 
 /** The search tag to append as each doc's metadata. */
@@ -14,3 +21,44 @@ export function docVersionSearchTag(
 ): 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();
+
+  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,
+  };
+}