normalize routeBasePath

allow '' for baseUrl + routeBasePath
facebook · Dec 8, 2022 · 1eb9827 · 1eb9827
1 parent 8c065d3
commit 1eb9827
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 10 deletions.
diff --git a/packages/docusaurus-utils-validation/src/__tests__/validationSchemas.test.ts b/packages/docusaurus-utils-validation/src/__tests__/validationSchemas.test.ts
@@ -25,8 +25,9 @@ function createTestHelpers({
   schema: Joi.Schema;
   defaultValue?: unknown;
 }) {
-  function testOK(value: unknown) {
-    expect(Joi.attempt(value, schema)).toEqual(value ?? defaultValue);
+  function testOK(value: unknown, options?: {normalizedValue?: unknown}) {
+    const expectedValue = options?.normalizedValue ?? value ?? defaultValue;
+    expect(Joi.attempt(value, schema)).toEqual(expectedValue);
   }
 
   function testFail(value: unknown) {
@@ -172,13 +173,18 @@ describe('validation schemas', () => {
   it('routeBasePathSchema', () => {
     const {testFail, testOK} = createTestHelpers({
       schema: RouteBasePathSchema,
-      defaultValue: '',
+      defaultValue: undefined,
     });
 
-    testOK('');
+    testOK('', {normalizedValue: '/'});
     testOK('/');
-    testOK('/foo');
-    testOK('blog');
+    testOK('/foo', {normalizedValue: '/foo'});
+    testOK('foo', {normalizedValue: '/foo'});
+    testOK('blog', {normalizedValue: '/blog'});
+    testOK('blog/', {normalizedValue: '/blog/'});
+    testOK('prefix/blog', {normalizedValue: '/prefix/blog'});
+    testOK('prefix/blog/', {normalizedValue: '/prefix/blog/'});
+    testOK('/prefix/blog', {normalizedValue: '/prefix/blog'});
     testOK(undefined);
 
     testFail(3);

diff --git a/packages/docusaurus-utils-validation/src/validationSchemas.ts b/packages/docusaurus-utils-validation/src/validationSchemas.ts
@@ -5,7 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {isValidPathname, DEFAULT_PLUGIN_ID, type Tag} from '@docusaurus/utils';
+import {
+  isValidPathname,
+  DEFAULT_PLUGIN_ID,
+  type Tag,
+  addLeadingSlash,
+} from '@docusaurus/utils';
 import Joi from './Joi';
 import {JoiFrontMatter} from './JoiFrontMatter';
 
@@ -96,8 +101,25 @@ export const PathnameSchema = Joi.string()
     '{{#label}} is not a valid pathname. Pathname should start with slash and not contain any domain or query string.',
   );
 
-// joi empty string not allowed by default. so using empty('') for custom use
-export const RouteBasePathSchema = Joi.string().empty('').default('');
+// Normalized schema for url path segments: baseUrl + routeBasePath...
+// Note we only add a leading slash
+// we don't always want to enforce a trailing slash on urls such as /docs
+//
+// Examples:
+// '' => '/'
+// 'docs' => '/docs'
+// '/docs' => '/docs'
+// 'docs/' => '/docs'
+// 'prefix/docs' => '/prefix/docs'
+// TODO tighter validation: not all strings are valid path segments
+export const RouteBasePathSchema = Joi
+  // Weird Joi trick needed, otherwise value '' is not normalized...
+  .alternatives()
+  .try(Joi.string().required().allow(''))
+  .custom((value: string) =>
+    // /!\ do not add trailing slash here
+    addLeadingSlash(value),
+  );
 
 const FrontMatterTagSchema = JoiFrontMatter.alternatives()
   .try(

diff --git a/packages/docusaurus/src/server/__tests__/configValidation.test.ts b/packages/docusaurus/src/server/__tests__/configValidation.test.ts
@@ -134,6 +134,11 @@ describe('normalizeConfig', () => {
   });
 
   it('normalizes various base URLs', () => {
+    expect(
+      normalizeConfig({
+        baseUrl: '',
+      }).baseUrl,
+    ).toBe('/');
     expect(
       normalizeConfig({
         baseUrl: 'noSlash',

diff --git a/packages/docusaurus/src/server/configValidation.ts b/packages/docusaurus/src/server/configValidation.ts
@@ -180,7 +180,10 @@ const SiteUrlSchema = Joi.string()
 
 // TODO move to @docusaurus/utils-validation
 export const ConfigSchema = Joi.object<DocusaurusConfig>({
-  baseUrl: Joi.string()
+  baseUrl: Joi
+    // Weird Joi trick needed, otherwise value '' is not normalized...
+    .alternatives()
+    .try(Joi.string().required().allow(''))
     .required()
     .custom((value: string) => addLeadingSlash(addTrailingSlash(value))),
   baseUrlIssueBanner: Joi.boolean().default(DEFAULT_CONFIG.baseUrlIssueBanner),