@docusaurus/plugin-client-redirects 2.0.0-beta.1decd6f80 → 2.0.0-beta.20

package/src/collectRedirects.ts

@@ -5,40 +5,64 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {flatten, uniqBy, difference, groupBy} from 'lodash';
-import {
-  PluginContext,
-  RedirectMetadata,
-  PluginOptions,
-  RedirectOption,
-} from './types';
+import _ from 'lodash';
+import type {PluginOptions, RedirectOption} from './options';
+import type {PluginContext, RedirectMetadata} from './types';
 import {
   createFromExtensionsRedirects,
   createToExtensionsRedirects,
 } from './extensionRedirects';
 import {validateRedirect} from './redirectValidation';
+import {
+  applyTrailingSlash,
+  type ApplyTrailingSlashParams,
+} from '@docusaurus/utils-common';
 
-import chalk from 'chalk';
+import logger from '@docusaurus/logger';
 
 export default function collectRedirects(
   pluginContext: PluginContext,
+  trailingSlash: boolean | undefined,
 ): RedirectMetadata[] {
-  const redirects = doCollectRedirects(pluginContext);
+  let redirects = doCollectRedirects(pluginContext);
+
+  redirects = applyRedirectsTrailingSlash(redirects, {
+    trailingSlash,
+    baseUrl: pluginContext.baseUrl,
+  });
+
   validateCollectedRedirects(redirects, pluginContext);
   return filterUnwantedRedirects(redirects, pluginContext);
 }
 
+// If users wants to redirect to=/abc and they enable trailingSlash=true then
+// => we don't want to reject the to=/abc (as only /abc/ is an existing/valid
+// path now)
+// => we want to redirect to=/abc/ without the user having to change all its
+// redirect plugin options
+// It should be easy to toggle siteConfig.trailingSlash option without having to
+// change other configs
+function applyRedirectsTrailingSlash(
+  redirects: RedirectMetadata[],
+  params: ApplyTrailingSlashParams,
+) {
+  return redirects.map((redirect) => ({
+    ...redirect,
+    to: applyTrailingSlash(redirect.to, params),
+  }));
+}
+
 function validateCollectedRedirects(
   redirects: RedirectMetadata[],
   pluginContext: PluginContext,
 ) {
-  const redirectValidationErrors: string[] = redirects
+  const redirectValidationErrors = redirects
     .map((redirect) => {
       try {
         validateRedirect(redirect);
         return undefined;
-      } catch (e) {
-        return e.message;
+      } catch (err) {
+        return (err as Error).message;
       }
     })
     .filter(Boolean);
@@ -52,7 +76,7 @@ function validateCollectedRedirects(
 
   const allowedToPaths = pluginContext.relativeRoutesPaths;
   const toPaths = redirects.map((redirect) => redirect.to);
-  const illegalToPaths = difference(toPaths, allowedToPaths);
+  const illegalToPaths = _.difference(toPaths, allowedToPaths);
   if (illegalToPaths.length > 0) {
     throw new Error(
       `You are trying to create client-side redirections to paths that do not exist:
@@ -69,36 +93,28 @@ function filterUnwantedRedirects(
   redirects: RedirectMetadata[],
   pluginContext: PluginContext,
 ): RedirectMetadata[] {
-  // we don't want to create twice the same redirect
-  // that would lead to writing twice the same html redirection file
-  Object.entries(groupBy(redirects, (redirect) => redirect.from)).forEach(
+  // We don't want to create the same redirect twice, since that would lead to
+  // writing the same html redirection file twice.
+  Object.entries(_.groupBy(redirects, (redirect) => redirect.from)).forEach(
     ([from, groupedFromRedirects]) => {
       if (groupedFromRedirects.length > 1) {
-        console.error(
-          chalk.red(
-            `@docusaurus/plugin-client-redirects: multiple redirects are created with the same "from" pathname=${from}
-It is not possible to redirect the same pathname to multiple destinations:
-- ${groupedFromRedirects.map((r) => JSON.stringify(r)).join('\n- ')}
-`,
-          ),
-        );
+        logger.error`name=${'@docusaurus/plugin-client-redirects'}: multiple redirects are created with the same "from" pathname: path=${from}
+It is not possible to redirect the same pathname to multiple destinations: ${groupedFromRedirects.map(
+          (r) => JSON.stringify(r),
+        )}`;
       }
     },
   );
-  const collectedRedirects = uniqBy(redirects, (redirect) => redirect.from);
+  const collectedRedirects = _.uniqBy(redirects, (redirect) => redirect.from);
 
   // We don't want to override an already existing route with a redirect file!
   const redirectsOverridingExistingPath = collectedRedirects.filter(
     (redirect) => pluginContext.relativeRoutesPaths.includes(redirect.from),
   );
   if (redirectsOverridingExistingPath.length > 0) {
-    console.error(
-      chalk.red(
-        `@docusaurus/plugin-client-redirects: some redirects would override existing paths, and will be ignored:
-- ${redirectsOverridingExistingPath.map((r) => JSON.stringify(r)).join('\n- ')}
-`,
-      ),
-    );
+    logger.error`name=${'@docusaurus/plugin-client-redirects'}: some redirects would override existing paths, and will be ignored: ${redirectsOverridingExistingPath.map(
+      (r) => JSON.stringify(r),
+    )}`;
   }
   return collectedRedirects.filter(
     (redirect) => !pluginContext.relativeRoutesPaths.includes(redirect.from),
@@ -127,7 +143,7 @@ function doCollectRedirects(pluginContext: PluginContext): RedirectMetadata[] {
 function createRedirectsOptionRedirects(
   redirectsOption: PluginOptions['redirects'],
 ): RedirectMetadata[] {
-  // For conveniency, user can use a string or a string[]
+  // For convenience, user can use a string or a string[]
   function optionToRedirects(option: RedirectOption): RedirectMetadata[] {
     if (typeof option.from === 'string') {
       return [{from: option.from, to: option.to}];
@@ -138,7 +154,7 @@ function createRedirectsOptionRedirects(
     }));
   }
 
-  return flatten(redirectsOption.map(optionToRedirects));
+  return redirectsOption.flatMap(optionToRedirects);
 }
 
 // Create redirects from the "createRedirects" fn provided by the user
@@ -147,20 +163,16 @@ function createCreateRedirectsOptionRedirects(
   createRedirects: PluginOptions['createRedirects'],
 ): RedirectMetadata[] {
   function createPathRedirects(path: string): RedirectMetadata[] {
-    const fromsMixed: string | string[] = createRedirects
-      ? createRedirects(path) || []
-      : [];
+    const fromsMixed: string | string[] = createRedirects?.(path) ?? [];
 
     const froms: string[] =
       typeof fromsMixed === 'string' ? [fromsMixed] : fromsMixed;
 
-    return froms.map((from) => {
-      return {
-        from,
-        to: path,
-      };
-    });
+    return froms.map((from) => ({
+      from,
+      to: path,
+    }));
   }
 
-  return flatten(paths.map(createPathRedirects));
+  return paths.flatMap(createPathRedirects);
 }

package/src/createRedirectPageContent.ts

@@ -7,24 +7,22 @@
 
 import * as eta from 'eta';
 import redirectPageTemplate from './templates/redirectPage.template.html';
-import {memoize} from 'lodash';
+import _ from 'lodash';
 
-type CreateRedirectPageOptions = {
-  toUrl: string;
-};
-
-const getCompiledRedirectPageTemplate = memoize(() => {
-  return eta.compile(redirectPageTemplate.trim());
-});
+const getCompiledRedirectPageTemplate = _.memoize(() =>
+  eta.compile(redirectPageTemplate.trim()),
+);
 
-function renderRedirectPageTemplate(data: Record<string, unknown>) {
+function renderRedirectPageTemplate(data: {toUrl: string}) {
   const compiled = getCompiledRedirectPageTemplate();
   return compiled(data, eta.defaultConfig);
 }
 
 export default function createRedirectPageContent({
   toUrl,
-}: CreateRedirectPageOptions): string {
+}: {
+  toUrl: string;
+}): string {
   return renderRedirectPageTemplate({
     toUrl: encodeURI(toUrl),
   });

package/src/extensionRedirects.ts

@@ -5,34 +5,35 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {flatten} from 'lodash';
-import {removeSuffix} from '@docusaurus/utils';
-import {RedirectMetadata} from './types';
+import {
+  addTrailingSlash,
+  removeSuffix,
+  removeTrailingSlash,
+} from '@docusaurus/utils';
+import type {RedirectMetadata} from './types';
 
 const ExtensionAdditionalMessage =
-  "If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the 'createRedirects' plugin option.";
+  'If the redirect extension system is not good enough for your use case, you can create redirects yourself with the "createRedirects" plugin option.';
 
 const validateExtension = (ext: string) => {
   if (!ext) {
     throw new Error(
-      `Extension=['${String(
-        ext,
-      )}'] is not allowed. ${ExtensionAdditionalMessage}`,
+      `Extension "${ext}" is not allowed.\n${ExtensionAdditionalMessage}`,
     );
   }
   if (ext.includes('.')) {
     throw new Error(
-      `Extension=['${ext}'] contains a . (dot) and is not allowed. ${ExtensionAdditionalMessage}`,
+      `Extension "${ext}" contains a "." (dot) which is not allowed.\n${ExtensionAdditionalMessage}`,
     );
   }
   if (ext.includes('/')) {
     throw new Error(
-      `Extension=['${ext}'] contains a / and is not allowed. ${ExtensionAdditionalMessage}`,
+      `Extension "${ext}" contains a "/" (slash) which is not allowed.\n${ExtensionAdditionalMessage}`,
     );
   }
   if (encodeURIComponent(ext) !== ext) {
     throw new Error(
-      `Extension=['${ext}'] contains invalid uri characters. ${ExtensionAdditionalMessage}`,
+      `Extension "${ext}" contains invalid URI characters.\n${ExtensionAdditionalMessage}`,
     );
   }
 };
@@ -60,10 +61,11 @@ export function createToExtensionsRedirects(
     return [];
   };
 
-  return flatten(paths.map(createPathRedirects));
+  return paths.flatMap(createPathRedirects);
 }
 
-// Create new /path.html that redirects to existing an /path
+// Create new /path.html/index.html that redirects to existing an /path
+// The filename pattern might look weird but it's on purpose (see https://github.com/facebook/docusaurus/issues/5055)
 export function createFromExtensionsRedirects(
   paths: string[],
   extensions: string[],
@@ -76,14 +78,18 @@ export function createFromExtensionsRedirects(
     dottedExtensions.some((ext) => str.endsWith(ext));
 
   const createPathRedirects = (path: string): RedirectMetadata[] => {
-    if (path === '' || path.endsWith('/') || alreadyEndsWithAnExtension(path)) {
+    if (path === '' || path === '/' || alreadyEndsWithAnExtension(path)) {
       return [];
     }
     return extensions.map((ext) => ({
-      from: `${path}.${ext}`,
+      // /path => /path.html
+      // /path/ => /path.html/
+      from: path.endsWith('/')
+        ? addTrailingSlash(`${removeTrailingSlash(path)}.${ext}`)
+        : `${path}.${ext}`,
       to: path,
     }));
   };
 
-  return flatten(paths.map(createPathRedirects));
+  return paths.flatMap(createPathRedirects);
 }

package/src/index.ts

@@ -5,26 +5,26 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {LoadContext, Plugin, Props} from '@docusaurus/types';
-import {UserPluginOptions, PluginContext, RedirectMetadata} from './types';
+import type {LoadContext, Plugin} from '@docusaurus/types';
+import type {PluginContext, RedirectMetadata} from './types';
+import type {PluginOptions, Options} from './options';
 
-import normalizePluginOptions from './normalizePluginOptions';
 import collectRedirects from './collectRedirects';
 import writeRedirectFiles, {
   toRedirectFilesMetadata,
-  RedirectFileMetadata,
+  type RedirectFileMetadata,
 } from './writeRedirectFiles';
 import {removePrefix, addLeadingSlash} from '@docusaurus/utils';
 
 export default function pluginClientRedirectsPages(
-  _context: LoadContext,
-  opts: UserPluginOptions,
+  context: LoadContext,
+  options: PluginOptions,
 ): Plugin<unknown> {
-  const options = normalizePluginOptions(opts);
+  const {trailingSlash} = context.siteConfig;
 
   return {
     name: 'docusaurus-plugin-client-redirects',
-    async postBuild(props: Props) {
+    async postBuild(props) {
       const pluginContext: PluginContext = {
         relativeRoutesPaths: props.routesPaths.map(
           (path) => `${addLeadingSlash(removePrefix(path, props.baseUrl))}`,
@@ -34,11 +34,15 @@ export default function pluginClientRedirectsPages(
         options,
       };
 
-      const redirects: RedirectMetadata[] = collectRedirects(pluginContext);
+      const redirects: RedirectMetadata[] = collectRedirects(
+        pluginContext,
+        trailingSlash,
+      );
 
       const redirectFiles: RedirectFileMetadata[] = toRedirectFilesMetadata(
         redirects,
         pluginContext,
+        trailingSlash,
       );
 
       // Write files only at the end: make code more easy to test without IO
@@ -46,3 +50,6 @@ export default function pluginClientRedirectsPages(
     },
   };
 }
+
+export {validateOptions} from './options';
+export type {PluginOptions, Options};

package/src/options.ts

@@ -0,0 +1,71 @@
+/**
+ * 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 type {OptionValidationContext} from '@docusaurus/types';
+import {Joi, PathnameSchema} from '@docusaurus/utils-validation';
+
+export type RedirectOption = {
+  to: string;
+  from: string | string[];
+};
+
+export type PluginOptions = {
+  /** Plugin ID. */
+  id: string;
+  /** The extensions to be removed from the route after redirecting. */
+  fromExtensions: string[];
+  /** The extensions to be appended to the route after redirecting. */
+  toExtensions: string[];
+  /** The list of redirect rules, each one with multiple `from`s → one `to`. */
+  redirects: RedirectOption[];
+  /**
+   * A callback to create a redirect rule.
+   * @returns All the paths from which we should redirect to `path`
+   */
+  createRedirects?: (
+    /** An existing Docusaurus route path */
+    path: string,
+  ) => string[] | string | null | undefined;
+};
+
+export type Options = Partial<PluginOptions>;
+
+export const DEFAULT_OPTIONS: Partial<PluginOptions> = {
+  fromExtensions: [],
+  toExtensions: [],
+  redirects: [],
+};
+
+const RedirectPluginOptionValidation = Joi.object<RedirectOption>({
+  to: PathnameSchema.required(),
+  from: Joi.alternatives().try(
+    PathnameSchema.required(),
+    Joi.array().items(PathnameSchema.required()),
+  ),
+});
+
+const isString = Joi.string().required().not(null);
+
+const UserOptionsSchema = Joi.object<PluginOptions>({
+  fromExtensions: Joi.array()
+    .items(isString)
+    .default(DEFAULT_OPTIONS.fromExtensions),
+  toExtensions: Joi.array()
+    .items(isString)
+    .default(DEFAULT_OPTIONS.toExtensions),
+  redirects: Joi.array()
+    .items(RedirectPluginOptionValidation)
+    .default(DEFAULT_OPTIONS.redirects),
+  createRedirects: Joi.function().maxArity(1),
+}).default(DEFAULT_OPTIONS);
+
+export function validateOptions({
+  validate,
+  options: userOptions,
+}: OptionValidationContext<Options, PluginOptions>): PluginOptions {
+  return validate(UserOptionsSchema, userOptions);
+}

package/src/redirectValidation.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {RedirectMetadata} from './types';
+import type {RedirectMetadata} from './types';
 import {Joi, PathnameSchema} from '@docusaurus/utils-validation';
 
 const RedirectSchema = Joi.object<RedirectMetadata>({

package/src/types.ts

@@ -5,39 +5,25 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {Props} from '@docusaurus/types';
+import type {Props} from '@docusaurus/types';
+import type {PluginOptions} from './options';
 
-export type PluginOptions = {
-  id: string;
-  fromExtensions: string[];
-  toExtensions: string[];
-  redirects: RedirectOption[];
-  createRedirects?: CreateRedirectsFnOption;
-};
-
-// For a given existing route path,
-// return all the paths from which we should redirect from
-export type CreateRedirectsFnOption = (
-  path: string,
-) => string[] | string | null | undefined;
-
-export type RedirectOption = {
-  to: string;
-  from: string | string[];
-};
-
-export type UserPluginOptions = Partial<PluginOptions>;
-
-// The minimal infos the plugin needs to work
+/**
+ * The minimal infos the plugin needs to work
+ */
 export type PluginContext = Pick<Props, 'outDir' | 'baseUrl'> & {
   options: PluginOptions;
   relativeRoutesPaths: string[];
 };
 
-// In-memory representation of redirects we want: easier to test
-// /!\ easy to be confused: "from" is the new page we should create,
-// that redirects to "to": the existing Docusaurus page
+/**
+ * In-memory representation of redirects we want: easier to test
+ * /!\ easy to be confused: "from" is the new page we should create,
+ * that redirects to "to": the existing Docusaurus page
+ */
 export type RedirectMetadata = {
-  from: string; // pathname
-  to: string; // pathname
+  /** Pathname of the new page we should create */
+  from: string;
+  /** Pathname of an existing Docusaurus page */
+  to: string;
 };

package/src/writeRedirectFiles.ts

@@ -7,11 +7,11 @@
 
 import fs from 'fs-extra';
 import path from 'path';
-import {memoize} from 'lodash';
+import _ from 'lodash';
 
-import {PluginContext, RedirectMetadata} from './types';
+import type {PluginContext, RedirectMetadata} from './types';
 import createRedirectPageContent from './createRedirectPageContent';
-import {getFilePathForRoutePath, normalizeUrl} from '@docusaurus/utils';
+import {normalizeUrl} from '@docusaurus/utils';
 
 export type WriteFilesPluginContext = Pick<PluginContext, 'baseUrl' | 'outDir'>;
 
@@ -24,22 +24,52 @@ export function createToUrl(baseUrl: string, to: string): string {
   return normalizeUrl([baseUrl, to]);
 }
 
+// Create redirect file path
+// Make sure this path has lower precedence over the original file path when
+// served by host providers!
+// Otherwise it can produce infinite redirect loops!
+//
+// See https://github.com/facebook/docusaurus/issues/5055
+// See https://github.com/facebook/docusaurus/pull/5085
+// See https://github.com/facebook/docusaurus/pull/5102
+function getRedirectFilePath(
+  fromPath: string,
+  trailingSlash: boolean | undefined, // Now unused, on purpose
+): string {
+  const fileName = path.basename(fromPath);
+  const filePath = path.dirname(fromPath);
+  // Edge case for https://github.com/facebook/docusaurus/pull/5102
+  // If the redirect source path is /xyz, with file /xyz.html
+  // We can't write the redirect file at /xyz.html/index.html because for Unix
+  // FS, a file/folder can't have the same name "xyz.html"
+  // The only possible solution for a redirect file is thus /xyz.html.html (I
+  // know, looks suspicious)
+  if (trailingSlash === false && fileName.endsWith('.html')) {
+    return path.join(filePath, `${fileName}.html`);
+  }
+  // If the target path is /xyz, with file /xyz/index.html, we don't want the
+  // redirect file to be /xyz.html, otherwise it would be picked in priority and
+  // the redirect file would redirect to itself. We prefer the redirect file to
+  // be /xyz.html/index.html, served with lower priority for most static hosting
+  // tools
+  return path.join(filePath, `${fileName}/index.html`);
+}
+
 export function toRedirectFilesMetadata(
   redirects: RedirectMetadata[],
   pluginContext: WriteFilesPluginContext,
+  trailingSlash: boolean | undefined,
 ): RedirectFileMetadata[] {
   // Perf: avoid rendering the template twice with the exact same "props"
   // We might create multiple redirect pages for the same destination url
   // note: the first fn arg is the cache key!
-  const createPageContentMemoized = memoize((toUrl: string) => {
-    return createRedirectPageContent({toUrl});
-  });
+  const createPageContentMemoized = _.memoize((toUrl: string) =>
+    createRedirectPageContent({toUrl}),
+  );
 
   const createFileMetadata = (redirect: RedirectMetadata) => {
-    const fileAbsolutePath = path.join(
-      pluginContext.outDir,
-      getFilePathForRoutePath(redirect.from),
-    );
+    const fileRelativePath = getRedirectFilePath(redirect.from, trailingSlash);
+    const fileAbsolutePath = path.join(pluginContext.outDir, fileRelativePath);
     const toUrl = createToUrl(pluginContext.baseUrl, redirect.to);
     const fileContent = createPageContentMemoized(toUrl);
     return {
@@ -59,11 +89,10 @@ export async function writeRedirectFile(
     // User-friendly security to prevent file overrides
     if (await fs.pathExists(file.fileAbsolutePath)) {
       throw new Error(
-        'The redirect plugin is not supposed to override existing files',
+        'The redirect plugin is not supposed to override existing files.',
       );
     }
-    await fs.ensureDir(path.dirname(file.fileAbsolutePath));
-    await fs.writeFile(
+    await fs.outputFile(
       file.fileAbsolutePath,
       file.fileContent,
       // Hard security to prevent file overrides
@@ -72,7 +101,7 @@ export async function writeRedirectFile(
     );
   } catch (err) {
     throw new Error(
-      `Redirect file creation error for path=${file.fileAbsolutePath}: ${err}`,
+      `Redirect file creation error for "${file.fileAbsolutePath}" path: ${err}.`,
     );
   }
 }