extract createSiteStorage to external file

packages/docusaurus-types/src/config.d.ts

@@ -5,6 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+import type {SiteStorage} from './context';
 import type {RuleSetRule} from 'webpack';
 import type {Required as RequireKeys, DeepPartial} from 'utility-types';
 import type {I18nConfig} from './i18n';
@@ -115,6 +116,15 @@ export type MarkdownConfig = {
   anchors: MarkdownAnchorsConfig;
 };
 
+export type StorageOption = {
+  type: SiteStorage['type'];
+  namespace: boolean | string;
+};
+
+export type DocusaurusFuture = {
+  experimental_storage: StorageOption;
+};
+
 /**
  * Docusaurus config, after validation/normalization.
  */
@@ -171,6 +181,11 @@ export type DocusaurusConfig = {
    * @see https://docusaurus.io/docs/api/docusaurus-config#i18n
    */
   i18n: I18nConfig;
+  /**
+   * Docusaurus future flags and experimental features.
+   * Similar to Remix future flags, see https://remix.run/blog/future-flags
+   */
+  future: DocusaurusFuture;
   /**
    * This option adds `<meta name="robots" content="noindex, nofollow">` to
    * every page to tell search engines to avoid indexing your site.

packages/docusaurus-types/src/context.d.ts

@@ -27,16 +27,13 @@ export type SiteMetadata = {
   readonly pluginVersions: {[pluginName: string]: PluginVersionInformation};
 };
 
-// Should we have a value to disable storage?
-export type SiteStorageType = 'localStorage' | 'sessionStorage';
-
 export type SiteStorage = {
   /**
    * Which browser storage do you want to use?
    * Between "localStorage" and "sessionStorage".
    * The default is "localStorage".
    */
-  type: SiteStorageType;
+  type: 'localStorage' | 'sessionStorage';
 
   /**
    * Applies a namespace to the theme storage key

packages/docusaurus/src/server/site.ts

@@ -10,8 +10,6 @@ import {
   localizePath,
   DEFAULT_BUILD_DIR_NAME,
   GENERATED_FILES_DIR_NAME,
-  normalizeUrl,
-  simpleHash,
 } from '@docusaurus/utils';
 import combinePromises from 'combine-promises';
 import {loadSiteConfig} from './config';
@@ -27,14 +25,14 @@ import {
 import {PerfLogger} from '../utils';
 import {generateSiteFiles} from './codegen/codegen';
 import {getRoutesPaths, handleDuplicateRoutes} from './routes';
+import {createSiteStorage} from './storage';
 import type {LoadPluginsResult} from './plugins/plugins';
 import type {
   DocusaurusConfig,
   GlobalData,
   LoadContext,
   Props,
   PluginIdentifier,
-  SiteStorage,
 } from '@docusaurus/types';
 
 export type LoadContextParams = {
@@ -62,21 +60,6 @@ export type Site = {
   params: LoadSiteParams;
 };
 
-function defaultNamespace(config: DocusaurusConfig): string {
-  return simpleHash(normalizeUrl([config.url, config.baseUrl]), 3);
-}
-
-function createSiteStorage(config: DocusaurusConfig): SiteStorage {
-  // TODO make it configurable, default to ""
-  const namespaceSuffix = defaultNamespace(config);
-
-  const namespace = `-${namespaceSuffix}`;
-  return {
-    type: 'localStorage',
-    namespace,
-  };
-}
-
 /**
  * Loading context is the very first step in site building. Its params are
  * directly acquired from CLI options. It mainly loads `siteConfig` and the i18n

packages/docusaurus/src/server/storage.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 {normalizeUrl, simpleHash} from '@docusaurus/utils';
+import type {DocusaurusConfig, SiteStorage} from '@docusaurus/types';
+
+type Params = Pick<DocusaurusConfig, 'url' | 'baseUrl' | 'future'>;
+
+function automaticNamespace(params: Params): string {
+  return simpleHash(normalizeUrl([params.url, params.baseUrl]), 3);
+}
+
+function getNamespaceString(params: Params): string | null {
+  if (params.future.experimental_storage.namespace === true) {
+    return automaticNamespace(params);
+  } else if (params.future.experimental_storage.namespace === false) {
+    return null;
+  } else {
+    return params.future.experimental_storage.namespace;
+  }
+}
+
+export function createSiteStorage(config: DocusaurusConfig): SiteStorage {
+  const {type} = config.future.experimental_storage;
+  const namespaceString = getNamespaceString(config);
+
+  const namespace = namespaceString ? `-${namespaceString}` : '';
+  return {
+    type,
+    namespace,
+  };
+}