@docusaurus/plugin-client-redirects 2.0.0-beta.15a2b59f9 → 2.0.0-beta.17

package/src/__tests__/collectRedirects.test.ts

@@ -1,340 +0,0 @@
-/**
- * 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 {PluginContext, UserPluginOptions} from '../types';
-import collectRedirects from '../collectRedirects';
-import normalizePluginOptions from '../normalizePluginOptions';
-import {removeTrailingSlash} from '@docusaurus/utils';
-
-function createTestPluginContext(
-  options?: UserPluginOptions,
-  relativeRoutesPaths: string[] = [],
-): PluginContext {
-  return {
-    outDir: '/tmp',
-    baseUrl: 'https://docusaurus.io',
-    relativeRoutesPaths,
-    options: normalizePluginOptions(options),
-  };
-}
-
-describe('collectRedirects', () => {
-  test('should collect no redirect for undefined config', () => {
-    expect(
-      collectRedirects(
-        createTestPluginContext(undefined, ['/', '/path']),
-        undefined,
-      ),
-    ).toEqual([]);
-  });
-
-  test('should collect no redirect for empty config', () => {
-    expect(collectRedirects(createTestPluginContext({}), undefined)).toEqual(
-      [],
-    );
-  });
-
-  test('should collect redirects to html/exe extension', () => {
-    expect(
-      collectRedirects(
-        createTestPluginContext(
-          {
-            fromExtensions: ['html', 'exe'],
-          },
-          ['/', '/somePath', '/otherPath.html'],
-        ),
-        undefined,
-      ),
-    ).toEqual([
-      {
-        from: '/somePath.html',
-        to: '/somePath',
-      },
-      {
-        from: '/somePath.exe',
-        to: '/somePath',
-      },
-    ]);
-  });
-
-  test('should collect redirects to html/exe extension', () => {
-    expect(
-      collectRedirects(
-        createTestPluginContext(
-          {
-            toExtensions: ['html', 'exe'],
-          },
-          ['/', '/somePath', '/otherPath.html'],
-        ),
-        undefined,
-      ),
-    ).toEqual([
-      {
-        from: '/otherPath',
-        to: '/otherPath.html',
-      },
-    ]);
-  });
-
-  test('should collect redirects from plugin option redirects', () => {
-    expect(
-      collectRedirects(
-        createTestPluginContext(
-          {
-            redirects: [
-              {
-                from: '/someLegacyPath',
-                to: '/somePath',
-              },
-              {
-                from: ['/someLegacyPathArray1', '/someLegacyPathArray2'],
-                to: '/',
-              },
-            ],
-          },
-          ['/', '/somePath'],
-        ),
-        undefined,
-      ),
-    ).toEqual([
-      {
-        from: '/someLegacyPath',
-        to: '/somePath',
-      },
-      {
-        from: '/someLegacyPathArray1',
-        to: '/',
-      },
-      {
-        from: '/someLegacyPathArray2',
-        to: '/',
-      },
-    ]);
-  });
-
-  test('should collect redirects from plugin option redirects with trailingSlash=true', () => {
-    expect(
-      collectRedirects(
-        createTestPluginContext(
-          {
-            redirects: [
-              {
-                from: '/someLegacyPath',
-                to: '/somePath',
-              },
-              {
-                from: ['/someLegacyPathArray1', '/someLegacyPathArray2'],
-                to: '/',
-              },
-            ],
-          },
-          ['/', '/somePath/'],
-        ),
-        true,
-      ),
-    ).toEqual([
-      {
-        from: '/someLegacyPath',
-        to: '/somePath/',
-      },
-      {
-        from: '/someLegacyPathArray1',
-        to: '/',
-      },
-      {
-        from: '/someLegacyPathArray2',
-        to: '/',
-      },
-    ]);
-  });
-
-  test('should collect redirects from plugin option redirects with trailingSlash=false', () => {
-    expect(
-      collectRedirects(
-        createTestPluginContext(
-          {
-            redirects: [
-              {
-                from: '/someLegacyPath',
-                to: '/somePath/',
-              },
-              {
-                from: ['/someLegacyPathArray1', '/someLegacyPathArray2'],
-                to: '/',
-              },
-            ],
-          },
-          ['/', '/somePath'],
-        ),
-        false,
-      ),
-    ).toEqual([
-      {
-        from: '/someLegacyPath',
-        to: '/somePath',
-      },
-      {
-        from: '/someLegacyPathArray1',
-        to: '/',
-      },
-      {
-        from: '/someLegacyPathArray2',
-        to: '/',
-      },
-    ]);
-  });
-
-  test('should throw if plugin option redirects contain invalid to paths', () => {
-    expect(() =>
-      collectRedirects(
-        createTestPluginContext(
-          {
-            redirects: [
-              {
-                from: '/someLegacyPath',
-                to: '/',
-              },
-              {
-                from: '/someLegacyPath',
-                to: '/this/path/does/not/exist2',
-              },
-              {
-                from: '/someLegacyPath',
-                to: '/this/path/does/not/exist2',
-              },
-            ],
-          },
-          ['/', '/someExistingPath', '/anotherExistingPath'],
-        ),
-        undefined,
-      ),
-    ).toThrowErrorMatchingSnapshot();
-  });
-
-  test('should collect redirects with custom redirect creator', () => {
-    expect(
-      collectRedirects(
-        createTestPluginContext(
-          {
-            createRedirects: (routePath) => {
-              return [
-                `${removeTrailingSlash(routePath)}/some/path/suffix1`,
-                `${removeTrailingSlash(routePath)}/some/other/path/suffix2`,
-              ];
-            },
-          },
-          ['/', '/testpath', '/otherPath.html'],
-        ),
-        undefined,
-      ),
-    ).toEqual([
-      {
-        from: '/some/path/suffix1',
-        to: '/',
-      },
-      {
-        from: '/some/other/path/suffix2',
-        to: '/',
-      },
-
-      {
-        from: '/testpath/some/path/suffix1',
-        to: '/testpath',
-      },
-      {
-        from: '/testpath/some/other/path/suffix2',
-        to: '/testpath',
-      },
-
-      {
-        from: '/otherPath.html/some/path/suffix1',
-        to: '/otherPath.html',
-      },
-      {
-        from: '/otherPath.html/some/other/path/suffix2',
-        to: '/otherPath.html',
-      },
-    ]);
-  });
-
-  test('should throw if redirect creator creates invalid redirects', () => {
-    expect(() =>
-      collectRedirects(
-        createTestPluginContext(
-          {
-            createRedirects: (routePath) => {
-              if (routePath === '/') {
-                return [
-                  `https://google.com/`,
-                  `//abc`,
-                  `/def?queryString=toto`,
-                ];
-              }
-              return undefined;
-            },
-          },
-          ['/'],
-        ),
-        undefined,
-      ),
-    ).toThrowErrorMatchingSnapshot();
-  });
-
-  test('should throw if redirect creator creates array of array redirect', () => {
-    expect(() =>
-      collectRedirects(
-        createTestPluginContext(
-          {
-            createRedirects: (routePath) => {
-              if (routePath === '/') {
-                return ([[`/fromPath`]] as unknown) as string;
-              }
-              return undefined;
-            },
-          },
-          ['/'],
-        ),
-        undefined,
-      ),
-    ).toThrowErrorMatchingSnapshot();
-  });
-
-  test('should filter unwanted redirects', () => {
-    expect(
-      collectRedirects(
-        createTestPluginContext(
-          {
-            fromExtensions: ['html', 'exe'],
-            toExtensions: ['html', 'exe'],
-          },
-          [
-            '/',
-            '/somePath',
-            '/somePath.html',
-            '/somePath.exe',
-            '/fromShouldWork.html',
-            '/toShouldWork',
-          ],
-        ),
-        undefined,
-      ),
-    ).toEqual([
-      {
-        from: '/toShouldWork.html',
-        to: '/toShouldWork',
-      },
-      {
-        from: '/toShouldWork.exe',
-        to: '/toShouldWork',
-      },
-      {
-        from: '/fromShouldWork',
-        to: '/fromShouldWork.html',
-      },
-    ]);
-  });
-});

package/src/__tests__/createRedirectPageContent.test.ts

@@ -1,26 +0,0 @@
-/**
- * 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 createRedirectPageContent from '../createRedirectPageContent';
-
-describe('createRedirectPageContent', () => {
-  test('should match snapshot', () => {
-    expect(
-      createRedirectPageContent({toUrl: 'https://docusaurus.io/'}),
-    ).toMatchSnapshot();
-  });
-
-  test('should encode uri special chars', () => {
-    const result = createRedirectPageContent({
-      toUrl: 'https://docusaurus.io/gr/σελιδας/',
-    });
-    expect(result).toContain(
-      'https://docusaurus.io/gr/%CF%83%CE%B5%CE%BB%CE%B9%CE%B4%CE%B1%CF%82/',
-    );
-    expect(result).toMatchSnapshot();
-  });
-});

package/src/__tests__/extensionRedirects.test.ts

@@ -1,143 +0,0 @@
-/**
- * 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 {
-  createFromExtensionsRedirects,
-  createToExtensionsRedirects,
-} from '../extensionRedirects';
-
-describe('createToExtensionsRedirects', () => {
-  test('should reject empty extensions', () => {
-    expect(() => {
-      createToExtensionsRedirects(['/'], ['.html']);
-    }).toThrowErrorMatchingInlineSnapshot(`
-      "Extension \\".html\\" contains a \\".\\" (dot) which is not allowed.
-      If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the \\"createRedirects\\" plugin option."
-    `);
-  });
-
-  test('should reject extensions with .', () => {
-    expect(() => {
-      createToExtensionsRedirects(['/'], ['.html']);
-    }).toThrowErrorMatchingInlineSnapshot(`
-      "Extension \\".html\\" contains a \\".\\" (dot) which is not allowed.
-      If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the \\"createRedirects\\" plugin option."
-    `);
-  });
-
-  test('should reject extensions with /', () => {
-    expect(() => {
-      createToExtensionsRedirects(['/'], ['ht/ml']);
-    }).toThrowErrorMatchingInlineSnapshot(`
-      "Extension \\"ht/ml\\" contains a \\"/\\" (slash) which is not allowed.
-      If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the \\"createRedirects\\" plugin option."
-    `);
-  });
-
-  test('should reject extensions with illegal url char', () => {
-    expect(() => {
-      createToExtensionsRedirects(['/'], [',']);
-    }).toThrowErrorMatchingInlineSnapshot(`
-      "Extension \\",\\" contains invalid URI characters.
-      If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the \\"createRedirects\\" plugin option."
-    `);
-  });
-
-  test('should create redirects from html/htm extensions', () => {
-    const ext = ['html', 'htm'];
-    expect(createToExtensionsRedirects([''], ext)).toEqual([]);
-    expect(createToExtensionsRedirects(['/'], ext)).toEqual([]);
-    expect(createToExtensionsRedirects(['/abc.html'], ext)).toEqual([
-      {from: '/abc', to: '/abc.html'},
-    ]);
-    expect(createToExtensionsRedirects(['/abc.htm'], ext)).toEqual([
-      {from: '/abc', to: '/abc.htm'},
-    ]);
-    expect(createToExtensionsRedirects(['/abc.xyz'], ext)).toEqual([]);
-  });
-
-  test('should create "to" redirects when relativeRoutesPath contains a prefix', () => {
-    expect(
-      createToExtensionsRedirects(['/prefix/file.html'], ['html']),
-    ).toEqual([{from: '/prefix/file', to: '/prefix/file.html'}]);
-  });
-
-  test('should not create redirection for an empty extension array', () => {
-    const ext: string[] = [];
-    expect(createToExtensionsRedirects([''], ext)).toEqual([]);
-    expect(createToExtensionsRedirects(['/'], ext)).toEqual([]);
-    expect(createToExtensionsRedirects(['/abc.html'], ext)).toEqual([]);
-  });
-});
-
-describe('createFromExtensionsRedirects', () => {
-  test('should reject empty extensions', () => {
-    expect(() => {
-      createFromExtensionsRedirects(['/'], ['.html']);
-    }).toThrowErrorMatchingInlineSnapshot(`
-      "Extension \\".html\\" contains a \\".\\" (dot) which is not allowed.
-      If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the \\"createRedirects\\" plugin option."
-    `);
-  });
-
-  test('should reject extensions with .', () => {
-    expect(() => {
-      createFromExtensionsRedirects(['/'], ['.html']);
-    }).toThrowErrorMatchingInlineSnapshot(`
-      "Extension \\".html\\" contains a \\".\\" (dot) which is not allowed.
-      If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the \\"createRedirects\\" plugin option."
-    `);
-  });
-
-  test('should reject extensions with /', () => {
-    expect(() => {
-      createFromExtensionsRedirects(['/'], ['ht/ml']);
-    }).toThrowErrorMatchingInlineSnapshot(`
-      "Extension \\"ht/ml\\" contains a \\"/\\" (slash) which is not allowed.
-      If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the \\"createRedirects\\" plugin option."
-    `);
-  });
-
-  test('should reject extensions with illegal url char', () => {
-    expect(() => {
-      createFromExtensionsRedirects(['/'], [',']);
-    }).toThrowErrorMatchingInlineSnapshot(`
-      "Extension \\",\\" contains invalid URI characters.
-      If the redirect extension system is not good enough for your usecase, you can create redirects yourself with the \\"createRedirects\\" plugin option."
-    `);
-  });
-
-  test('should create redirects from html/htm extensions', () => {
-    const ext = ['html', 'htm'];
-    expect(createFromExtensionsRedirects([''], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/'], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/abc'], ext)).toEqual([
-      {from: '/abc.html', to: '/abc'},
-      {from: '/abc.htm', to: '/abc'},
-    ]);
-    expect(createFromExtensionsRedirects(['/def.html'], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/def/'], ext)).toEqual([
-      {from: '/def.html/', to: '/def/'},
-      {from: '/def.htm/', to: '/def/'},
-    ]);
-  });
-
-  test('should create "from" redirects when relativeRoutesPath contains a prefix', () => {
-    expect(createFromExtensionsRedirects(['/prefix/file'], ['html'])).toEqual([
-      {from: '/prefix/file.html', to: '/prefix/file'},
-    ]);
-  });
-
-  test('should not create redirection for an empty extension array', () => {
-    const ext: string[] = [];
-    expect(createFromExtensionsRedirects([''], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/'], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/abc'], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/def.html'], ext)).toEqual([]);
-    expect(createFromExtensionsRedirects(['/def/'], ext)).toEqual([]);
-  });
-});

package/src/__tests__/normalizePluginOptions.test.ts

@@ -1,76 +0,0 @@
-/**
- * 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 normalizePluginOptions, {
-  DefaultPluginOptions,
-} from '../normalizePluginOptions';
-import {CreateRedirectsFnOption} from '../types';
-
-describe('normalizePluginOptions', () => {
-  test('should return default options for undefined user options', () => {
-    expect(normalizePluginOptions()).toEqual(DefaultPluginOptions);
-  });
-
-  test('should return default options for empty user options', () => {
-    expect(normalizePluginOptions()).toEqual(DefaultPluginOptions);
-  });
-
-  test('should override one default options with valid user options', () => {
-    expect(
-      normalizePluginOptions({
-        toExtensions: ['html'],
-      }),
-    ).toEqual({...DefaultPluginOptions, toExtensions: ['html']});
-  });
-
-  test('should override all default options with valid user options', () => {
-    const createRedirects: CreateRedirectsFnOption = (_routePath: string) => {
-      return [];
-    };
-    expect(
-      normalizePluginOptions({
-        fromExtensions: ['exe', 'zip'],
-        toExtensions: ['html'],
-        createRedirects,
-        redirects: [{from: '/x', to: '/y'}],
-      }),
-    ).toEqual({
-      id: 'default',
-      fromExtensions: ['exe', 'zip'],
-      toExtensions: ['html'],
-      createRedirects,
-      redirects: [{from: '/x', to: '/y'}],
-    });
-  });
-
-  test('should reject bad fromExtensions user inputs', () => {
-    expect(() =>
-      normalizePluginOptions({
-        fromExtensions: ([null, undefined, 123, true] as unknown) as string[],
-      }),
-    ).toThrowErrorMatchingSnapshot();
-  });
-
-  test('should reject bad toExtensions user inputs', () => {
-    expect(() =>
-      normalizePluginOptions({
-        toExtensions: ([null, undefined, 123, true] as unknown) as string[],
-      }),
-    ).toThrowErrorMatchingSnapshot();
-  });
-
-  test('should reject bad createRedirects user inputs', () => {
-    expect(() =>
-      normalizePluginOptions({
-        createRedirects: ([
-          'bad',
-          'value',
-        ] as unknown) as CreateRedirectsFnOption,
-      }),
-    ).toThrowErrorMatchingSnapshot();
-  });
-});

package/src/__tests__/redirectValidation.test.ts

@@ -1,66 +0,0 @@
-/**
- * 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 {validateRedirect} from '../redirectValidation';
-
-describe('validateRedirect', () => {
-  test('validate good redirects without throwing', () => {
-    validateRedirect({
-      from: '/fromSomePath',
-      to: '/toSomePath',
-    });
-    validateRedirect({
-      from: '/from/Some/Path',
-      to: '/toSomePath',
-    });
-    validateRedirect({
-      from: '/fromSomePath',
-      to: '/toSomePath',
-    });
-    validateRedirect({
-      from: '/fromSomePath',
-      to: '/to/Some/Path',
-    });
-  });
-
-  test('throw for bad redirects', () => {
-    expect(() =>
-      validateRedirect({
-        from: 'https://fb.com/fromSomePath',
-        to: '/toSomePath',
-      }),
-    ).toThrowErrorMatchingSnapshot();
-
-    expect(() =>
-      validateRedirect({
-        from: '/fromSomePath',
-        to: 'https://fb.com/toSomePath',
-      }),
-    ).toThrowErrorMatchingSnapshot();
-
-    expect(() =>
-      validateRedirect({
-        from: '/fromSomePath',
-        to: '/toSomePath?queryString=xyz',
-      }),
-    ).toThrowErrorMatchingSnapshot();
-
-    expect(() =>
-      validateRedirect({
-        from: (null as unknown) as string,
-        to: '/toSomePath?queryString=xyz',
-      }),
-    ).toThrowErrorMatchingSnapshot();
-
-    expect(() =>
-      validateRedirect({
-        from: (['heyho'] as unknown) as string,
-        to: '/toSomePath?queryString=xyz',
-      }),
-    ).toThrowErrorMatchingSnapshot();
-  });
-});