refactor(core): move browserContext and docusaurusContext out of clie…

…nt exports (#6955)
facebook · Mar 22, 2022 · 0a5354d · 0a5354d
1 parent 6b3d94a
commit 0a5354d
Show file tree

Hide file tree

Showing 17 changed files with 17 additions and 19 deletions.
diff --git a/jest.config.mjs b/jest.config.mjs
@@ -40,8 +40,10 @@ export default {
     '^.+\\.(css|jpe?g|png|svg|webp)$': '<rootDir>/jest/emptyModule.ts',
 
     // Using src instead of lib, so we always get fresh source
-    '@docusaurus/(browserContext|BrowserOnly|ComponentCreator|constants|docusaurusContext|ExecutionEnvironment|Head|Interpolate|isInternalUrl|Link|Noop|renderRoutes|router|Translate|use.*)':
+    '@docusaurus/(BrowserOnly|ComponentCreator|constants|ExecutionEnvironment|Head|Interpolate|isInternalUrl|Link|Noop|renderRoutes|router|Translate|use.*)':
       '@docusaurus/core/src/client/exports/$1',
+
+    // TODO create dedicated testing utility for mocking contexts
     // Maybe point to a fixture?
     '@generated/.*': '<rootDir>/jest/emptyModule.ts',
     // TODO use "projects" + multiple configs if we work on another theme?

diff --git a/packages/docusaurus-theme-common/src/utils/__tests__/docsUtils.test.tsx b/packages/docusaurus-theme-common/src/utils/__tests__/docsUtils.test.tsx
@@ -20,7 +20,7 @@ import {
   useSidebarBreadcrumbs,
 } from '../docsUtils';
 import {StaticRouter} from 'react-router-dom';
-import {Context} from '@docusaurus/docusaurusContext';
+import {Context} from '@docusaurus/core/src/client/docusaurusContext';
 import type {
   PropSidebar,
   PropSidebarItem,

diff --git a/packages/docusaurus-theme-common/src/utils/__tests__/generalUtils.test.tsx b/packages/docusaurus-theme-common/src/utils/__tests__/generalUtils.test.tsx
@@ -8,7 +8,7 @@
 import React from 'react';
 import {useTitleFormatter} from '../generalUtils';
 import {renderHook} from '@testing-library/react-hooks';
-import {Context} from '@docusaurus/docusaurusContext';
+import {Context} from '@docusaurus/core/src/client/docusaurusContext';
 import type {DocusaurusContext} from '@docusaurus/types';
 
 describe('useTitleFormatter', () => {

diff --git a/packages/docusaurus-theme-common/src/utils/__tests__/useAlternatePageUtils.test.tsx b/packages/docusaurus-theme-common/src/utils/__tests__/useAlternatePageUtils.test.tsx
@@ -9,7 +9,7 @@ import React from 'react';
 import {useAlternatePageUtils} from '../useAlternatePageUtils';
 import {renderHook} from '@testing-library/react-hooks';
 import {StaticRouter} from 'react-router-dom';
-import {Context} from '@docusaurus/docusaurusContext';
+import {Context} from '@docusaurus/core/src/client/docusaurusContext';
 import type {DocusaurusContext} from '@docusaurus/types';
 
 describe('useAlternatePageUtils', () => {

diff --git a/packages/docusaurus-theme-common/src/utils/__tests__/useLocalPathname.test.tsx b/packages/docusaurus-theme-common/src/utils/__tests__/useLocalPathname.test.tsx
@@ -9,7 +9,7 @@ import React from 'react';
 import {useLocalPathname} from '../useLocalPathname';
 import {renderHook} from '@testing-library/react-hooks';
 import {StaticRouter} from 'react-router-dom';
-import {Context} from '@docusaurus/docusaurusContext';
+import {Context} from '@docusaurus/core/src/client/docusaurusContext';
 import type {DocusaurusContext} from '@docusaurus/types';
 
 describe('useLocalPathname', () => {

diff --git a/packages/docusaurus-theme-common/src/utils/__tests__/usePluralForm.test.tsx b/packages/docusaurus-theme-common/src/utils/__tests__/usePluralForm.test.tsx
@@ -9,7 +9,7 @@ import {jest} from '@jest/globals';
 import React from 'react';
 import {usePluralForm} from '../usePluralForm';
 import {renderHook} from '@testing-library/react-hooks';
-import {Context} from '@docusaurus/docusaurusContext';
+import {Context} from '@docusaurus/core/src/client/docusaurusContext';
 import type {DocusaurusContext} from '@docusaurus/types';
 
 describe('usePluralForm', () => {

diff --git a/packages/docusaurus/src/client/App.tsx b/packages/docusaurus/src/client/App.tsx
@@ -9,8 +9,8 @@ import React from 'react';
 
 import routes from '@generated/routes';
 import renderRoutes from './exports/renderRoutes';
-import {BrowserContextProvider} from './exports/browserContext';
-import {DocusaurusContextProvider} from './exports/docusaurusContext';
+import {BrowserContextProvider} from './browserContext';
+import {DocusaurusContextProvider} from './docusaurusContext';
 import PendingNavigation from './PendingNavigation';
 import BaseUrlIssueBanner from './baseUrlIssueBanner/BaseUrlIssueBanner';
 import SiteMetadataDefaults from './SiteMetadataDefaults';

diff --git a/...exports/__tests__/browserContext.test.tsx → .../client/__tests__/browserContext.test.tsx b/...exports/__tests__/browserContext.test.tsx → .../client/__tests__/browserContext.test.tsx
@@ -12,7 +12,7 @@
 import React from 'react';
 import {renderHook} from '@testing-library/react-hooks/server';
 import {BrowserContextProvider} from '../browserContext';
-import useIsBrowser from '../useIsBrowser';
+import useIsBrowser from '../exports/useIsBrowser';
 
 describe('BrowserContextProvider', () => {
   const {result, hydrate} = renderHook(() => useIsBrowser(), {

diff --git a/...orts/__tests__/docusaurusContext.test.tsx → ...ient/__tests__/docusaurusContext.test.tsx b/...orts/__tests__/docusaurusContext.test.tsx → ...ient/__tests__/docusaurusContext.test.tsx
@@ -12,7 +12,7 @@
 import React from 'react';
 import {renderHook} from '@testing-library/react-hooks/server';
 import {DocusaurusContextProvider} from '../docusaurusContext';
-import useDocusaurusContext from '../useDocusaurusContext';
+import useDocusaurusContext from '../exports/useDocusaurusContext';
 
 // This test currently isn't quite useful because the @generated aliases point
 // to the empty modules. Maybe we can point that to fixtures in the future.

diff --git a/...rus/src/client/exports/browserContext.tsx → .../docusaurus/src/client/browserContext.tsx b/...rus/src/client/exports/browserContext.tsx → .../docusaurus/src/client/browserContext.tsx
diff --git a/.../src/client/exports/docusaurusContext.tsx → ...cusaurus/src/client/docusaurusContext.tsx b/.../src/client/exports/docusaurusContext.tsx → ...cusaurus/src/client/docusaurusContext.tsx
diff --git a/packages/docusaurus/src/client/exports/__tests__/BrowserOnly.test.tsx b/packages/docusaurus/src/client/exports/__tests__/BrowserOnly.test.tsx
@@ -12,7 +12,7 @@
 import React from 'react';
 import renderer from 'react-test-renderer';
 import BrowserOnly from '../BrowserOnly';
-import {Context} from '../browserContext';
+import {Context} from '../../browserContext';
 
 describe('<BrowserOnly>', () => {
   const originalEnv = process.env;

diff --git a/packages/docusaurus/src/client/exports/__tests__/useBaseUrl.test.tsx b/packages/docusaurus/src/client/exports/__tests__/useBaseUrl.test.tsx
@@ -8,7 +8,7 @@
 import React from 'react';
 import {renderHook} from '@testing-library/react-hooks';
 import useBaseUrl, {useBaseUrlUtils} from '../useBaseUrl';
-import {Context} from '../docusaurusContext';
+import {Context} from '../../docusaurusContext';
 import type {DocusaurusContext} from '@docusaurus/types';
 import type {BaseUrlOptions} from '@docusaurus/useBaseUrl';
 

diff --git a/packages/docusaurus/src/client/exports/__tests__/useGlobalData.test.tsx b/packages/docusaurus/src/client/exports/__tests__/useGlobalData.test.tsx
@@ -11,7 +11,7 @@ import useGlobalData, {
   useAllPluginInstancesData,
   usePluginData,
 } from '../useGlobalData';
-import {Context} from '../docusaurusContext';
+import {Context} from '../../docusaurusContext';
 
 describe('useGlobalData', () => {
   it('returns global data from context', () => {

diff --git a/packages/docusaurus/src/client/exports/useDocusaurusContext.ts b/packages/docusaurus/src/client/exports/useDocusaurusContext.ts
@@ -6,7 +6,7 @@
  */
 
 import {useContext} from 'react';
-import {Context} from './docusaurusContext';
+import {Context} from '../docusaurusContext';
 import type {DocusaurusContext} from '@docusaurus/types';
 
 export default function useDocusaurusContext(): DocusaurusContext {

diff --git a/packages/docusaurus/src/client/exports/useIsBrowser.ts b/packages/docusaurus/src/client/exports/useIsBrowser.ts
@@ -6,7 +6,7 @@
  */
 
 import {useContext} from 'react';
-import {Context} from './browserContext';
+import {Context} from '../browserContext';
 
 export default function useIsBrowser(): boolean {
   return useContext(Context);

diff --git a/packages/docusaurus/src/webpack/__tests__/__snapshots__/base.test.ts.snap b/packages/docusaurus/src/webpack/__tests__/__snapshots__/base.test.ts.snap
@@ -11,9 +11,7 @@ exports[`base webpack config creates webpack aliases 1`] = `
   "@docusaurus/Link": "../../../../client/exports/Link.tsx",
   "@docusaurus/Noop": "../../../../client/exports/Noop.ts",
   "@docusaurus/Translate": "../../../../client/exports/Translate.tsx",
-  "@docusaurus/browserContext": "../../../../client/exports/browserContext.tsx",
   "@docusaurus/constants": "../../../../client/exports/constants.ts",
-  "@docusaurus/docusaurusContext": "../../../../client/exports/docusaurusContext.tsx",
   "@docusaurus/isInternalUrl": "../../../../client/exports/isInternalUrl.ts",
   "@docusaurus/renderRoutes": "../../../../client/exports/renderRoutes.ts",
   "@docusaurus/router": "../../../../client/exports/router.ts",
@@ -61,9 +59,7 @@ exports[`getDocusaurusAliases() returns appropriate webpack aliases 1`] = `
   "@docusaurus/Link": "../../client/exports/Link.tsx",
   "@docusaurus/Noop": "../../client/exports/Noop.ts",
   "@docusaurus/Translate": "../../client/exports/Translate.tsx",
-  "@docusaurus/browserContext": "../../client/exports/browserContext.tsx",
   "@docusaurus/constants": "../../client/exports/constants.ts",
-  "@docusaurus/docusaurusContext": "../../client/exports/docusaurusContext.tsx",
   "@docusaurus/isInternalUrl": "../../client/exports/isInternalUrl.ts",
   "@docusaurus/renderRoutes": "../../client/exports/renderRoutes.ts",
   "@docusaurus/router": "../../client/exports/router.ts",