refactor: file prefix replace utils & add unit test (janhq#1676)

* refactor: file prefix replace utils

* chore: add unit tests for core module

Makefile

@@ -39,6 +39,7 @@ lint: check-file-counts
 # Testing
 test: lint
 	yarn build:test
+	yarn test:unit
 	yarn test
 
 # Builds and publishes the app

core/.gitignore

@@ -6,7 +6,4 @@ coverage
 .vscode
 .idea
 dist
-compiled
-.awcache
-.rpt2_cache
 docs

core/jest.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  moduleNameMapper: {
+    '@/(.*)': '<rootDir>/src/$1',
+  },
+}

core/package.json

@@ -12,7 +12,8 @@
   "module": "dist/core.es5.js",
   "typings": "dist/types/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "types"
   ],
   "author": "Jan <[email protected]>",
   "exports": {
@@ -38,18 +39,23 @@
   },
   "scripts": {
     "lint": "tslint  --project tsconfig.json -t codeFrame 'src/**/*.ts' 'test/**/*.ts'",
+    "test": "jest",
     "prebuild": "rimraf dist",
     "build": "tsc --module commonjs && rollup -c rollup.config.ts",
     "start": "rollup -c rollup.config.ts -w"
   },
   "devDependencies": {
+    "jest": "^25.4.0",
+    "@types/jest": "^29.5.11",
     "@types/node": "^12.0.2",
+    "eslint-plugin-jest": "^23.8.2",
     "rollup": "^2.38.5",
     "rollup-plugin-commonjs": "^9.1.8",
     "rollup-plugin-json": "^3.1.0",
     "rollup-plugin-node-resolve": "^5.2.0",
     "rollup-plugin-sourcemaps": "^0.6.3",
     "rollup-plugin-typescript2": "^0.36.0",
+    "ts-jest": "^26.1.1",
     "tslib": "^2.6.2",
     "typescript": "^5.2.2"
   }

core/src/node/api/routes/download.ts

@@ -1,58 +1,58 @@
-import { DownloadRoute } from '../../../api'
-import { join } from 'path'
-import { userSpacePath } from '../../extension/manager'
-import { DownloadManager } from '../../download'
-import { HttpServer } from '../HttpServer'
-import { createWriteStream } from 'fs'
+import { DownloadRoute } from "../../../api";
+import { join } from "path";
+import { userSpacePath } from "../../extension/manager";
+import { DownloadManager } from "../../download";
+import { HttpServer } from "../HttpServer";
+import { createWriteStream } from "fs";
+import { normalizeFilePath } from "../../path";
 
 export const downloadRouter = async (app: HttpServer) => {
   app.post(`/${DownloadRoute.downloadFile}`, async (req, res) => {
-    const strictSSL = !(req.query.ignoreSSL === 'true');
-    const proxy = req.query.proxy?.startsWith('http') ? req.query.proxy : undefined;
-    const body = JSON.parse(req.body as any)
+    const strictSSL = !(req.query.ignoreSSL === "true");
+    const proxy = req.query.proxy?.startsWith("http") ? req.query.proxy : undefined;
+    const body = JSON.parse(req.body as any);
     const normalizedArgs = body.map((arg: any) => {
-      if (typeof arg === 'string' && arg.includes('file:/')) {
-        return join(userSpacePath, arg.replace('file:/', ''))
+      if (typeof arg === "string") {
+        return join(userSpacePath, normalizeFilePath(arg));
       }
-      return arg
-    })
+      return arg;
+    });
 
-    const localPath = normalizedArgs[1]
-    const fileName = localPath.split('/').pop() ?? ''
+    const localPath = normalizedArgs[1];
+    const fileName = localPath.split("/").pop() ?? "";
 
-    const request = require('request')
-    const progress = require('request-progress')
-    
-    const rq = request({ url: normalizedArgs[0], strictSSL, proxy })
+    const request = require("request");
+    const progress = require("request-progress");
+
+    const rq = request({ url: normalizedArgs[0], strictSSL, proxy });
     progress(rq, {})
-      .on('progress', function (state: any) {
-        console.log('download onProgress', state)
+      .on("progress", function (state: any) {
+        console.log("download onProgress", state);
       })
-      .on('error', function (err: Error) {
-        console.log('download onError', err)
+      .on("error", function (err: Error) {
+        console.log("download onError", err);
       })
-      .on('end', function () {
-        console.log('download onEnd')
+      .on("end", function () {
+        console.log("download onEnd");
       })
-      .pipe(createWriteStream(normalizedArgs[1]))
+      .pipe(createWriteStream(normalizedArgs[1]));
 
-    DownloadManager.instance.setRequest(fileName, rq)
-  })
+    DownloadManager.instance.setRequest(fileName, rq);
+  });
 
   app.post(`/${DownloadRoute.abortDownload}`, async (req, res) => {
-    const body = JSON.parse(req.body as any)
+    const body = JSON.parse(req.body as any);
     const normalizedArgs = body.map((arg: any) => {
-      if (typeof arg === 'string' && arg.includes('file:/')) {
-        return join(userSpacePath, arg.replace('file:/', ''))
+      if (typeof arg === "string") {
+        return join(userSpacePath, normalizeFilePath(arg));
       }
-      return arg
-    })
+      return arg;
+    });
 
-    const localPath = normalizedArgs[0]
-    const fileName = localPath.split('/').pop() ?? ''
-    console.debug('fileName', fileName)
-    const rq = DownloadManager.instance.networkRequests[fileName]
-    DownloadManager.instance.networkRequests[fileName] = undefined
-    rq?.abort()
-  })
-}
+    const localPath = normalizedArgs[0];
+    const fileName = localPath.split("/").pop() ?? "";
+    const rq = DownloadManager.instance.networkRequests[fileName];
+    DownloadManager.instance.networkRequests[fileName] = undefined;
+    rq?.abort();
+  });
+};

core/src/node/index.ts

@@ -6,3 +6,4 @@ export * from './download'
 export * from './module'
 export * from './api'
 export * from './log'
+export * from './path'

core/src/node/path.ts

@@ -0,0 +1,9 @@
+/**
+ * Normalize file path
+ * Remove all file protocol prefix
+ * @param path 
+ * @returns 
+ */
+export function normalizeFilePath(path: string): string {
+  return path.replace(/^(file:[\\/]+)([^:\s]+)$/, "$2");
+}

core/tests/node/path.test.ts

@@ -0,0 +1,12 @@
+import { normalizeFilePath } from "../../src/node/path";
+
+describe("Test file normalize", () => {
+  test("returns no file protocol prefix on Unix", async () => {
+    expect(normalizeFilePath("file://test.txt")).toBe("test.txt");
+    expect(normalizeFilePath("file:/test.txt")).toBe("test.txt");
+  });
+  test("returns no file protocol prefix on Windows", async () => {
+    expect(normalizeFilePath("file:\\\\test.txt")).toBe("test.txt");
+    expect(normalizeFilePath("file:\\test.txt")).toBe("test.txt");
+  });
+});

core/tsconfig.json

@@ -13,7 +13,7 @@
     "declarationDir": "dist/types",
     "outDir": "dist/lib",
     "importHelpers": true,
-    "typeRoots": ["node_modules/@types"]
+    "types": ["@types/jest"]
   },
   "include": ["src"]
 }

electron/handlers/download.ts

@@ -5,7 +5,7 @@ import request from 'request'
 import { createWriteStream, renameSync } from 'fs'
 import { DownloadEvent, DownloadRoute } from '@janhq/core'
 const progress = require('request-progress')
-import { DownloadManager } from '@janhq/core/node'
+import { DownloadManager, normalizeFilePath } from '@janhq/core/node'
 
 export function handleDownloaderIPCs() {
   /**
@@ -54,66 +54,68 @@ export function handleDownloaderIPCs() {
    * @param url - The URL to download the file from.
    * @param fileName - The name to give the downloaded file.
    */
-  ipcMain.handle(DownloadRoute.downloadFile, async (_event, url, fileName, network) => {
-    const strictSSL = !network?.ignoreSSL;
-    const proxy = network?.proxy?.startsWith('http') ? network.proxy : undefined;
-    const userDataPath = join(app.getPath('home'), 'jan')
-    if (
-      typeof fileName === 'string' &&
-      (fileName.includes('file:/') || fileName.includes('file:\\'))
-    ) {
-      fileName = fileName.replace('file:/', '').replace('file:\\', '')
-    }
-    const destination = resolve(userDataPath, fileName)
-    const rq = request({ url, strictSSL, proxy })
+  ipcMain.handle(
+    DownloadRoute.downloadFile,
+    async (_event, url, fileName, network) => {
+      const strictSSL = !network?.ignoreSSL
+      const proxy = network?.proxy?.startsWith('http')
+        ? network.proxy
+        : undefined
+      const userDataPath = join(app.getPath('home'), 'jan')
+      if (typeof fileName === 'string') {
+        fileName = normalizeFilePath(fileName)
+      }
+      const destination = resolve(userDataPath, fileName)
+      const rq = request({ url, strictSSL, proxy })
 
-    // Put request to download manager instance
-    DownloadManager.instance.setRequest(fileName, rq)
+      // Put request to download manager instance
+      DownloadManager.instance.setRequest(fileName, rq)
 
-    // Downloading file to a temp file first
-    const downloadingTempFile = `${destination}.download`
-
-    progress(rq, {})
-      .on('progress', function (state: any) {
-        WindowManager?.instance.currentWindow?.webContents.send(
-          DownloadEvent.onFileDownloadUpdate,
-          {
-            ...state,
-            fileName,
-          }
-        )
-      })
-      .on('error', function (err: Error) {
-        WindowManager?.instance.currentWindow?.webContents.send(
-          DownloadEvent.onFileDownloadError,
-          {
-            fileName,
-            err,
-          }
-        )
-      })
-      .on('end', function () {
-        if (DownloadManager.instance.networkRequests[fileName]) {
-          // Finished downloading, rename temp file to actual file
-          renameSync(downloadingTempFile, destination)
+      // Downloading file to a temp file first
+      const downloadingTempFile = `${destination}.download`
 
+      progress(rq, {})
+        .on('progress', function (state: any) {
           WindowManager?.instance.currentWindow?.webContents.send(
-            DownloadEvent.onFileDownloadSuccess,
+            DownloadEvent.onFileDownloadUpdate,
             {
+              ...state,
               fileName,
             }
           )
-          DownloadManager.instance.setRequest(fileName, undefined)
-        } else {
+        })
+        .on('error', function (err: Error) {
           WindowManager?.instance.currentWindow?.webContents.send(
             DownloadEvent.onFileDownloadError,
             {
               fileName,
-              err: { message: 'aborted' },
+              err,
             }
           )
-        }
-      })
-      .pipe(createWriteStream(downloadingTempFile))
-  })
+        })
+        .on('end', function () {
+          if (DownloadManager.instance.networkRequests[fileName]) {
+            // Finished downloading, rename temp file to actual file
+            renameSync(downloadingTempFile, destination)
+
+            WindowManager?.instance.currentWindow?.webContents.send(
+              DownloadEvent.onFileDownloadSuccess,
+              {
+                fileName,
+              }
+            )
+            DownloadManager.instance.setRequest(fileName, undefined)
+          } else {
+            WindowManager?.instance.currentWindow?.webContents.send(
+              DownloadEvent.onFileDownloadError,
+              {
+                fileName,
+                err: { message: 'aborted' },
+              }
+            )
+          }
+        })
+        .pipe(createWriteStream(downloadingTempFile))
+    }
+  )
 }

electron/handlers/fileManager.ts

@@ -7,6 +7,7 @@ import { userSpacePath, getResourcePath } from './../utils/path'
 import fs from 'fs'
 import { join } from 'path'
 import { FileStat } from '@janhq/core'
+import { normalizeFilePath } from '@janhq/core/node'
 
 /**
  * Handles file system extensions operations.
@@ -42,11 +43,7 @@ export function handleFileMangerIPCs() {
   ipcMain.handle(
     FileManagerRoute.fileStat,
     async (_event, path: string): Promise<FileStat | undefined> => {
-      const normalizedPath = path
-        .replace(`file://`, '')
-        .replace(`file:/`, '')
-        .replace(`file:\\\\`, '')
-        .replace(`file:\\`, '')
+      const normalizedPath = normalizeFilePath(path)
 
       const fullPath = join(userSpacePath, normalizedPath)
       const isExist = fs.existsSync(fullPath)

electron/handlers/fs.ts

@@ -3,6 +3,7 @@ import { ipcMain } from 'electron'
 import { FileSystemRoute } from '@janhq/core'
 import { userSpacePath } from '../utils/path'
 import { join } from 'path'
+import { normalizeFilePath } from '@janhq/core/node'
 /**
  * Handles file system operations.
  */
@@ -15,14 +16,7 @@ export function handleFsIPCs() {
           ...args.map((arg) =>
             typeof arg === 'string' &&
             (arg.includes(`file:/`) || arg.includes(`file:\\`))
-              ? join(
-                  userSpacePath,
-                  arg
-                    .replace(`file://`, '')
-                    .replace(`file:/`, '')
-                    .replace(`file:\\\\`, '')
-                    .replace(`file:\\`, '')
-                )
+              ? join(userSpacePath, normalizeFilePath(arg))
               : arg
           )
         )

package.json

@@ -11,19 +11,15 @@
     ],
     "nohoist": [
       "uikit",
-      "uikit/*",
       "core",
-      "core/*",
       "electron",
-      "electron/**",
       "web",
-      "web/**",
-      "server",
-      "server/**"
+      "server"
     ]
   },
   "scripts": {
     "lint": "yarn workspace jan lint && yarn workspace jan-web lint",
+    "test:unit": "yarn workspace @janhq/core test",
     "test": "yarn workspace jan test:e2e",
     "copy:assets": "cpx \"models/**\" \"electron/models/\" && cpx \"docs/openapi/**\" \"electron/docs/openapi\"",
     "dev:electron": "yarn copy:assets && yarn workspace jan dev",