feat: Add preload tests (#890)

* refactor: Move getWorkspaceConfigPath to config and getProjectInfoFs to project

* fix: Add @vitest/coverage-v8 package

* fix: Add tests

* fix: Remove unrequired clearAllMocks

* fix: types

* fix: Update test dependencies

Author: cyaiox

package-lock.json

@@ -13,7 +13,7 @@
     "eslint-plugin-import": "2.31.0",
     "happy-dom": "14.12.3",
     "nano-staged": "0.8.0",
-    "playwright": "1.54.1",
+    "playwright": "1.56.1",
     "prettier": "3.5.3",
     "simple-git-hooks": "2.11.1",
     "syncpack": "13.0.4",

package.json

@@ -46,6 +46,7 @@
     "@types/segment-analytics": "0.0.38",
     "@types/semver": "7.5.8",
     "@vitejs/plugin-react": "4.3.1",
+    "@vitest/coverage-v8": "4.0.8",
     "ansi-to-html": "0.7.2",
     "classnames": "2.5.1",
     "cross-env": "7.0.3",
@@ -77,7 +78,7 @@
     "test": "npm run test:unit",
     "test:e2e": "cross-env E2E='true' playwright test",
     "test:main": "vitest run -r main --passWithNoTests",
-    "test:preload": "vitest run -r preload --passWithNoTests",
+    "test:preload": "vitest run -r preload --passWithNoTests --coverage",
     "test:renderer": "vitest run -r renderer --passWithNoTests",
     "test:shared": "vitest run -r shared --passWithNoTests",
     "test:unit": "npm run test:main && npm run test:preload && npm run test:renderer && npm run test:shared",

packages/creator-hub/package.json

@@ -10,7 +10,6 @@ import {
 import { PACKAGES_LIST } from '/shared/types/pkg';
 import { DEFAULT_DEPENDENCY_UPDATE_STRATEGY } from '/shared/types/settings';
 import type { GetProjectsOpts, Template, Workspace } from '/shared/types/workspace';
-import { FileSystemStorage } from '/shared/types/storage';
 
 import type { Services } from '../services';
 
@@ -21,7 +20,7 @@ import { DEFAULT_THUMBNAIL, NEW_SCENE_NAME, EMPTY_SCENE_TEMPLATE_REPO } from './
 import { getProjectId } from './analytics';
 
 export function initializeWorkspace(services: Services) {
-  const { config, fs, ipc, path, pkg, npm } = services;
+  const { config, fs, ipc, path, pkg, npm, project } = services;
 
   // IMPORTANT: when './scene' get's moved to this same factory pattern, we should remove
   // the import for { getScene } and use it as "const scene = initializeScene(services)".
@@ -60,7 +59,7 @@ export function initializeWorkspace(services: Services) {
   }
 
   async function getOldProjectThumbnailPath(_path: string) {
-    const workspaceConfigPath = await getConfigPath(_path);
+    const workspaceConfigPath = await config.getWorkspaceConfigPath(_path);
     return path.join(workspaceConfigPath, 'images', 'project-thumbnail.png');
   }
 
@@ -110,7 +109,7 @@ export function initializeWorkspace(services: Services) {
         getScene(_path),
         fs.stat(_path),
         opts?.omitOutdatedPackages ? Promise.resolve({}) : getOutdatedPackages(_path),
-        getProjectInfoFs(_path),
+        project.getProjectInfoFs(_path),
       ]);
       const thumbnail = await getProjectThumbnailAsBase64(_path, scene);
       const layout = getRowsAndCols(scene.scene.parcels.map($ => parseCoords($)));
@@ -456,19 +455,8 @@ export function initializeWorkspace(services: Services) {
     if (error) throw new Error(error);
   }
 
-  async function getConfigPath(_path: string) {
-    return ipc.invoke('electron.getWorkspaceConfigPath', _path);
-  }
-
-  async function getProjectInfoFs(_path: string) {
-    const configPath = await getConfigPath(_path);
-    const projectInfoPath = path.join(configPath, 'project.json');
-    const projectInfo = await FileSystemStorage.getOrCreate<ProjectInfo>(projectInfoPath);
-    return projectInfo;
-  }
-
   async function updateProjectInfo({ path, info }: { path: string; info: Partial<ProjectInfo> }) {
-    const projectInfoFs = await getProjectInfoFs(path);
+    const projectInfoFs = await project.getProjectInfoFs(path);
     const projectInfo = await projectInfoFs.getAll();
     await projectInfoFs.setAll({ ...projectInfo, ...info });
   }
@@ -479,6 +467,8 @@ export function initializeWorkspace(services: Services) {
     hasNodeModules,
     getProjectThumbnailAsBase64,
     getOutdatedPackages,
+    getProjectThumbnailPath,
+    getOldProjectThumbnailPath,
     getProject,
     getPath,
     getProjects,
@@ -492,9 +482,7 @@ export function initializeWorkspace(services: Services) {
     reimportProject,
     saveThumbnail,
     openFolder,
-    getConfigPath,
     validateScenesPath,
-    getProjectInfoFs,
     updateProjectInfo,
     importProject,
     isProjectPathAvailable,

packages/creator-hub/preload/src/modules/workspace.ts

@@ -14,3 +14,13 @@ export async function setConfig(drafter: (c: WritableDraft<Config>) => void): Pr
   });
   await invoke('config.writeConfig', update);
 }
+
+/**
+ * Retrieves the configuration path for a given workspace path.
+ *
+ * @param {string} path - The path to the workspace.
+ * @returns {Promise<string>} A promise that resolves to the configuration path.
+ */
+export async function getWorkspaceConfigPath(path: string) {
+  return invoke('electron.getWorkspaceConfigPath', path);
+}

packages/creator-hub/preload/src/services/config.ts

@@ -5,6 +5,7 @@ import * as fs from './fs';
 import * as npm from './npm';
 import * as ipc from './ipc';
 import * as pkg from './pkg';
+import * as project from './project';
 
 export type Services = {
   config: typeof config;
@@ -13,6 +14,7 @@ export type Services = {
   ipc: typeof ipc;
   path: typeof path;
   pkg: typeof pkg;
+  project: typeof project;
 };
 
 export const getServices = (): Services => ({
@@ -22,4 +24,5 @@ export const getServices = (): Services => ({
   ipc,
   path,
   pkg,
+  project,
 });

packages/creator-hub/preload/src/services/index.ts

@@ -0,0 +1,12 @@
+import path from 'path';
+
+import { FileSystemStorage } from '/shared/types/storage';
+import type { ProjectInfo } from '/shared/types/projects';
+import { getWorkspaceConfigPath } from './config';
+
+export async function getProjectInfoFs(_path: string) {
+  const configPath = await getWorkspaceConfigPath(_path);
+  const projectInfoPath = path.join(configPath, 'project.json');
+  const projectInfo = await FileSystemStorage.getOrCreate<ProjectInfo>(projectInfoPath);
+  return projectInfo;
+}

packages/creator-hub/preload/src/services/project.ts

@@ -1,19 +1,17 @@
+import path from 'node:path';
 import { vi, type Mock } from 'vitest';
 
 import type { Services } from '../../src/services';
 
 type DeepMock<T> = {
-  [key in keyof T]: T[key] extends (...args: any[]) => any
-    ? Mock<Parameters<T[key]>, ReturnType<T[key]>>
-    : DeepMock<T[key]>;
+  [K in keyof T]: T[K] extends (...args: any[]) => any ? Mock : DeepMock<T[K]>;
 };
 
 export const getMockServices = (): DeepMock<Services> => ({
   config: {
-    getConfigPath: vi.fn(),
     getConfig: vi.fn(),
-    writeConfig: vi.fn(),
     setConfig: vi.fn(),
+    getWorkspaceConfigPath: vi.fn(),
   },
   fs: {
     stat: vi.fn(),
@@ -26,20 +24,29 @@ export const getMockServices = (): DeepMock<Services> => ({
     readdir: vi.fn(),
     isDirectory: vi.fn(),
     cp: vi.fn(),
+    isWritable: vi.fn(),
+    rmdir: vi.fn(),
+    openPath: vi.fn(),
   },
   ipc: {
     invoke: vi.fn(),
   },
   path: {
-    join: vi.fn((...args) => args.join('/')),
+    join: vi.fn((...args) => path.posix.join(...args)),
+    basename: vi.fn((arg: string) => path.posix.basename(arg)),
+    normalize: vi.fn((arg: string) => path.posix.normalize(arg)),
   } as any, // temp until we have a "path" service...
   npm: {
     install: vi.fn(),
     getOutdatedDeps: vi.fn(),
+    getContextFiles: vi.fn(),
   },
   pkg: {
     getPackageJson: vi.fn(),
     getPackageVersion: vi.fn(),
     hasDependency: vi.fn(),
   },
+  project: {
+    getProjectInfoFs: vi.fn(),
+  },
 });