fix(theme): docsVersionDropdown navbar item not showing the appropriate version

packages/docusaurus-plugin-content-docs/src/client/__tests__/docsClientUtils.test.ts

@@ -12,6 +12,7 @@ import {
   getActiveDocContext,
   getActiveVersion,
   getDocVersionSuggestions,
+  sortVersionsByPathDepth,
 } from '../docsClientUtils';
 import type {
   GlobalPluginData,
@@ -20,6 +21,18 @@ import type {
   GlobalDoc,
 } from '@docusaurus/plugin-content-docs/client';
 
+function createVersion(name: string, path: string, isLast: boolean) {
+  return {
+    name,
+    label: name,
+    path,
+    isLast,
+    docs: [],
+    mainDocId: '???',
+    draftIds: [],
+  };
+}
+
 describe('docsClientUtils', () => {
   it('getActivePlugin', () => {
     const data: {[key: string]: GlobalPluginData} = {
@@ -184,12 +197,68 @@ describe('docsClientUtils', () => {
     expect(getActiveVersion(data, '/docs/someDoc')?.name).toBe('version2');
 
     expect(getActiveVersion(data, '/docs/version1')?.name).toBe('version1');
-    expect(getActiveVersion(data, '/docs/version1')?.name).toBe('version1');
+    expect(getActiveVersion(data, '/docs/version1/')?.name).toBe('version1');
     expect(getActiveVersion(data, '/docs/version1/someDoc')?.name).toBe(
       'version1',
     );
   });
 
+  it('sortVersionsByPathDepth without trailing slash', () => {
+    const test = [
+      createVersion('current', '/docs', false),
+      createVersion('version2', '/docs/version2', true),
+      createVersion('version1', '/docs/version1', false),
+    ];
+
+    expect(sortVersionsByPathDepth(test)).toEqual([
+      test[1], // version2
+      test[2], // version1
+      test[0], // current
+    ]);
+  });
+
+  it('sortVersionsByPathDepth with trailing slash', () => {
+    const test = [
+      createVersion('current', '/docs/', false),
+      createVersion('version2', '/docs/version2/', true),
+      createVersion('version1', '/docs/version1/', false),
+    ];
+
+    expect(sortVersionsByPathDepth(test)).toEqual([
+      test[1], // version2
+      test[2], // version1
+      test[0], // current
+    ]);
+  });
+
+  it('sortVersionsByPathDepth docs only without trailing slash', () => {
+    const test = [
+      createVersion('current', '/', false),
+      createVersion('version2', '/version2', true),
+      createVersion('version1', '/version1', false),
+    ];
+
+    expect(sortVersionsByPathDepth(test)).toEqual([
+      test[1], // version2
+      test[2], // version1
+      test[0], // current
+    ]);
+  });
+
+  it('sortVersionsByPathDepth docs only with trailing slash', () => {
+    const test = [
+      createVersion('current', '/', false),
+      createVersion('version2', '/version2/', true),
+      createVersion('version1', '/version1/', false),
+    ];
+
+    expect(sortVersionsByPathDepth(test)).toEqual([
+      test[1], // version2
+      test[2], // version1
+      test[0], // current
+    ]);
+  });
+
   it('getActiveDocContext', () => {
     const versionNext: GlobalVersion = {
       name: 'next',

packages/docusaurus-plugin-content-docs/src/client/docsClientUtils.ts

@@ -59,17 +59,28 @@ export function getActivePlugin(
 export const getLatestVersion = (data: GlobalPluginData): GlobalVersion =>
   data.versions.find((version) => version.isLast)!;
 
+export function sortVersionsByPathDepth(
+  versions: GlobalVersion[],
+): GlobalVersion[] {
+  return [...versions].sort((a, b) => {
+    if (a.path.includes(b.path)) {
+      return -1;
+    }
+    if (b.path.includes(a.path)) {
+      return 1;
+    }
+
+    return 0;
+  });
+}
+
 export function getActiveVersion(
   data: GlobalPluginData,
   pathname: string,
 ): GlobalVersion | undefined {
-  const lastVersion = getLatestVersion(data);
-  // Last version is a route like /docs/*,
-  // we need to match it last or it would match /docs/version-1.0/* as well
-  const orderedVersionsMetadata = [
-    ...data.versions.filter((version) => version !== lastVersion),
-    lastVersion,
-  ];
+  // Sort paths by depth, deepest first
+  const orderedVersionsMetadata = sortVersionsByPathDepth(data.versions);
+
   return orderedVersionsMetadata.find(
     (version) =>
       !!matchPath(pathname, {