Merge pull request #2094 from RedisInsight/fe/bugfix/RI-4487

#RI-4487 - fix incorrect path format

Author: vlad-dargel

redisinsight/api/src/modules/custom-tutorial/providers/custom-tutorial.manifest.provider.spec.ts

@@ -7,6 +7,7 @@ import {
   mockCustomTutorial,
   mockCustomTutorialManifest, mockCustomTutorialManifestJson,
 } from 'src/__mocks__';
+import * as Utils from 'src/utils/path';
 
 jest.mock('fs-extra');
 const mFs = fs as jest.Mocked<typeof fs>;
@@ -61,6 +62,8 @@ describe('CustomTutorialManifestProvider', () => {
       expect(result).toEqual([]);
     });
     it('should return empty array for empty folder', async () => {
+      const spy = jest.spyOn(Utils as any, 'winPathToNormalPath');
+
       // root level entries
       const mockRootLevelEntries = [
         'intro.md',
@@ -160,6 +163,7 @@ describe('CustomTutorialManifestProvider', () => {
           type: 'group',
         },
       ]);
+      expect(spy).toBeCalledTimes(5); // Should call util to fix win path
     });
   });
 

redisinsight/api/src/modules/custom-tutorial/providers/custom-tutorial.manifest.provider.ts

@@ -9,6 +9,7 @@ import {
   RootCustomTutorialManifest,
 } from 'src/modules/custom-tutorial/models/custom-tutorial.manifest';
 import { plainToClass } from 'class-transformer';
+import { winPathToNormalPath } from 'src/utils';
 
 const MANIFEST_FILE = 'manifest.json';
 const SYS_MANIFEST_FILE = '_manifest.json';
@@ -75,7 +76,7 @@ export class CustomTutorialManifestProvider {
           label: name,
           type: CustomTutorialManifestType.InternalLink,
           args: {
-            path: join(relativePath, entry),
+            path: winPathToNormalPath(join(relativePath, entry)),
           },
         });
       }

redisinsight/api/src/utils/index.ts

@@ -8,3 +8,4 @@ export * from './analytics-helper';
 export * from './redis-connection-helper';
 export * from './class-transformer';
 export * from './file-helper';
+export * from './path';

redisinsight/api/src/utils/path.spec.ts

@@ -0,0 +1,20 @@
+import { winPathToNormalPath } from 'src/utils';
+
+const winPathToNormalPathTests: Record<string, any>[] = [
+  { input: '\\dir/file.js', output: '/dir/file.js' },
+  { input: '/dir/file.js', output: '/dir/file.js' },
+  { input: 'file.js', output: 'file.js' },
+  { input: '\\file.js', output: '/file.js' },
+  { input: '\\dir\\file.js', output: '/dir/file.js' },
+  { input: 'dir/file.js', output: 'dir/file.js' },
+];
+
+describe('winPathToNormalPath', () => {
+  winPathToNormalPathTests.forEach((test) => {
+    it(`should be output: ${test.output} for input: ${JSON.stringify(test.input)}`, () => {
+      const result = winPathToNormalPath(test.input);
+
+      expect(result).toEqual(test.output);
+    });
+  });
+});

redisinsight/api/src/utils/path.ts

@@ -0,0 +1 @@
+export const winPathToNormalPath = (path: string) => path.replace(/\\/g, '/');

redisinsight/ui/src/constants/mocks/mock-guides.ts

@@ -30,6 +30,14 @@ export const MOCK_GUIDES_ITEMS: IEnablementAreaItem[] = [
         args: {
           path: 'quick-guides/working-with-hash.html',
         },
+      },
+      {
+        type: EnablementAreaComponent.InternalLink,
+        id: 'working-with-hash-2',
+        label: 'Working with HASH',
+        args: {
+          path: '\\quick-guides\\working-with-hash.html',
+        },
       }
     ]
   },

redisinsight/ui/src/pages/workbench/components/enablement-area/EnablementArea/utils/getFileInfo.ts

@@ -97,7 +97,7 @@ export const getMarkdownPathByManifest = (
   if (!manifestPath || !manifest) return pathPrefix
   const path = removeManifestPrefix(manifestPath)
   const pathToMarkDown = path.replaceAll('/', '.children.')
-  const markDownPath = get(manifest, pathToMarkDown)?.args?.path
+  const markDownPath = get(manifest, pathToMarkDown)?.args?.path?.replaceAll('\\', '/')
 
   if (!markDownPath) return ''
 
@@ -116,7 +116,7 @@ export const getMarkdownPathByManifest = (
     return undefined
   })
 
-  return pathPrefix + folderPath + (markDownPath.match(/^(\/|\\)/) ? markDownPath : '/'.concat(markDownPath))
+  return pathPrefix + folderPath + (markDownPath.match(/^(\/)/) ? markDownPath : '/'.concat(markDownPath))
 }
 
 export const removeManifestPrefix = (path?: string): string => path

redisinsight/ui/src/pages/workbench/components/enablement-area/EnablementArea/utils/tests/getFileInfo.spec.ts

@@ -147,9 +147,13 @@ const getMarkdownPathByManifestTests = [
     input: [MOCK_GUIDES_ITEMS, '/quick-guides/0/1'],
     expected: `/123123-123123${MOCK_GUIDES_ITEMS[0]?.children?.[1]?.args?.path}`
   },
+  {
+    input: [MOCK_GUIDES_ITEMS, '/quick-guides/0/3'],
+    expected: '/quick-guides/working-with-hash.html'
+  },
 ]
 
-describe('getWBSourcePath', () => {
+describe('getMarkdownPathByManifest', () => {
   test.each(getMarkdownPathByManifestTests)(
     '%j',
     ({ input, expected }) => {

redisinsight/ui/src/utils/pathUtil.ts

@@ -20,10 +20,7 @@ export const getRootStaticPath = (mdPath: string) => {
 }
 
 const processAbsolutePath = (nodeUrl: string, mdPath: string) => {
-  // todo: quick fix. find the root cause why path has both '/' and '\'
-  const normalizedMdPath = mdPath.replaceAll('\\', '/')
-  const tutorialRootPath = getRootStaticPath(normalizedMdPath)
-
+  const tutorialRootPath = getRootStaticPath(mdPath)
   return new URL(tutorialRootPath + nodeUrl, getOriginUrl()).toString()
 }