fix(html): keep workspace settings renderer-safe

linonetwo · linonetwo · commit 17a9e3a7842f · 2026-06-24T20:56:10.000+08:00
Avoid Node globals in renderer-loaded workspace settings code and cover HTML workspace rename persistence.
diff --git a/features/htmlWikiWorkspace.feature b/features/htmlWikiWorkspace.feature
@@ -105,3 +105,24 @@ Feature: HTML wiki workspace
     Then the HTML sync info should describe workspace "mobile-sync-wiki"
     When I PUT HTML sync file for workspace "mobile-sync-wiki" with content "<html><body>MobileSyncUpdated</body></html>"
     Then file "{tmpDir}/mobile-sync-wiki.html" should contain text "MobileSyncUpdated"
+
+  @html-wiki @settings
+  Scenario: HTML workspace settings can rename the workspace and persist
+    When I generate blank HTML wiki at "{tmpDir}/config-html.html"
+    And I click on an "add workspace button" element with selector "#add-workspace-button"
+    And I switch to "addWorkspace" window
+    And I wait for the page to load completely
+    When I click on a "open html wiki tab" element with selector "button:has-text('打开 HTML 知识库文件')"
+    When I prepare to select file in dialog "wiki-test/config-html.html"
+    When I click on a "choose html file button" element with selector "button:has-text('选择')"
+    And I click on a "open html wiki done button" element with selector "[data-testid='open-html-wiki-done-button']"
+    When I switch to "main" window
+    Then I wait for "workspace created" log marker "[test-id-WORKSPACE_CREATED]"
+    Then I wait for "html wiki started" log marker "[test-id-HTML_WIKI_STARTED]"
+    When I open edit workspace window for workspace with name "config-html"
+    And I switch to "editWorkspace" window
+    And I wait for the page to load completely
+    When I type "Renamed HTML Workspace" in "workspace name" element with selector "input[value='config-html']"
+    And I click on a "save workspace button" element with selector "[data-testid='edit-workspace-save-button']"
+    Then I should not see a "save workspace button" element with selector "[data-testid='edit-workspace-save-button']"
+    Then settings.json should have workspace "Renamed HTML Workspace" with "name" set to "Renamed HTML Workspace"
diff --git a/src/helpers/testKeyboardShortcuts.ts b/src/helpers/testKeyboardShortcuts.ts
@@ -25,12 +25,10 @@
  * NativeService.registerKeyboardShortcut using Electron's globalShortcut API.
  */
 
-export function initTestKeyboardShortcutFallback(): () => void {
-  const isTestEnvironment = process.env.NODE_ENV === 'test';
+export function initTestKeyboardShortcutFallback(isTestEnvironment: boolean): () => void {
   if (!isTestEnvironment) return () => {};
   void window.service.native.log('debug', 'Renderer(Test): initTestKeyboardShortcutFallback called', {
     isTestEnvironment,
-    nodeEnv: process.env.NODE_ENV,
   });
 
   let allShortcuts: Record<string, string> = {};
diff --git a/src/pages/Agent/components/Search/TemplateSearch.tsx b/src/pages/Agent/components/Search/TemplateSearch.tsx
@@ -148,9 +148,9 @@ export function TemplateSearch({ placeholder, onTemplateSelect, testId }: Templa
       return undefined;
     }
 
-    // Only skip in unit test environment, not E2E
+    // Only skip in jsdom-style unit tests, not E2E.
     const ua = typeof navigator !== 'undefined' ? navigator.userAgent ?? '' : '';
-    const isUnitTest = /jsdom/i.test(ua) && process.env.NODE_ENV === 'test' && typeof window.service === 'undefined';
+    const isUnitTest = /jsdom/i.test(ua) && typeof window.service === 'undefined';
     if (isUnitTest) {
       return undefined;
     }
diff --git a/src/renderer.tsx b/src/renderer.tsx
@@ -30,12 +30,20 @@ import { Pages } from './windows';
 function App(): JSX.Element {
   const theme = useThemeObservable();
   useEffect(() => {
-    if (process.env.NODE_ENV === 'test') {
+    let cleanup: (() => void) | undefined;
+    let cancelled = false;
+    void (async () => {
+      const isTest = await window.service.context.get('isTest');
+      if (!isTest || cancelled) return;
       // Lazy-load test-only keyboard shortcut fallback to avoid any overhead in production
-      void import('./helpers/testKeyboardShortcuts').then(({ initTestKeyboardShortcutFallback }) => {
-        initTestKeyboardShortcutFallback();
-      });
-    }
+      const { initTestKeyboardShortcutFallback } = await import('./helpers/testKeyboardShortcuts');
+      if (cancelled) return;
+      cleanup = initTestKeyboardShortcutFallback(isTest);
+    })();
+    return () => {
+      cancelled = true;
+      cleanup?.();
+    };
   }, []);
 
   return (
diff --git a/src/services/context/index.ts b/src/services/context/index.ts
@@ -1,3 +1,4 @@
+import { isTest } from '@/constants/environment';
 import { isElectronDevelopment } from '@/constants/isElectronDevelopment';
 import { LOCALIZATION_FOLDER } from '@/constants/paths';
 import { app, net } from 'electron';
@@ -18,6 +19,7 @@ export class ContextService implements IContextService {
   private readonly pathConstants: IPaths = { ...paths, ...appPaths };
   private readonly constants: IConstants = {
     isDevelopment: isElectronDevelopment,
+    isTest,
     platform: process.platform,
     appVersion: app.getVersion(),
     appName: app.name,
diff --git a/src/services/context/interface.ts b/src/services/context/interface.ts
@@ -26,6 +26,7 @@ export interface IConstants {
   appVersion: string;
   environmentVersions: NodeJS.ProcessVersions;
   isDevelopment: boolean;
+  isTest: boolean;
   oSVersion: string;
   platform: string;
 }
diff --git a/src/services/workspaces/__tests__/workspacePaths.test.ts b/src/services/workspaces/__tests__/workspacePaths.test.ts
@@ -1,4 +1,3 @@
-import path from 'node:path';
 import { describe, expect, it } from 'vitest';
 
 import { getWorkspaceGitScope, getWorkspaceType, isHtmlWikiWorkspace, normalizeHtmlWorkspacePaths } from '@services/workspaces/workspacePaths';
@@ -33,9 +32,9 @@ describe('workspacePaths', () => {
   });
 
   it('normalizes html workspace paths', () => {
-    const normalized = normalizeHtmlWorkspacePaths('/data/my.wiki.html');
-    expect(normalized.htmlFileLocation).toBe(path.resolve('/data/my.wiki.html'));
-    expect(normalized.wikiFolderLocation).toBe(path.resolve('/data'));
+    const normalized = normalizeHtmlWorkspacePaths('C:\\data\\my.wiki.html');
+    expect(normalized.htmlFileLocation).toBe('C:/data/my.wiki.html');
+    expect(normalized.wikiFolderLocation).toBe('C:/data');
   });
 
   it('scopes git to a single html file', () => {
@@ -45,14 +44,14 @@ describe('workspacePaths', () => {
       active: false,
       order: 0,
       picturePath: null,
-      wikiFolderLocation: '/data',
+      wikiFolderLocation: 'C:\\data',
       workspaceType: WorkspaceType.html,
-      htmlFileLocation: '/data/my.wiki.html',
+      htmlFileLocation: 'C:\\data\\my.wiki.html',
     };
     expect(getWorkspaceGitScope(workspace)).toEqual({
-      repoPath: path.resolve('/data'),
+      repoPath: 'C:/data',
       managedRelativePath: 'my.wiki.html',
-      managedAbsolutePath: path.resolve('/data/my.wiki.html'),
+      managedAbsolutePath: 'C:/data/my.wiki.html',
       managedDisplayName: 'my.wiki.html',
     });
   });
diff --git a/src/services/workspaces/workspacePaths.ts b/src/services/workspaces/workspacePaths.ts
@@ -1,9 +1,25 @@
-import path from 'node:path';
-
 import { isHtmlWiki } from '@/constants/fileNames';
 import type { IWikiWorkspace, IWorkspace } from './interface';
 import { WorkspaceType } from './workspaceType';
 
+function normalizePathSeparators(filePath: string): string {
+  return filePath.replace(/\\/g, '/');
+}
+
+function dirname(filePath: string): string {
+  const normalized = normalizePathSeparators(filePath).replace(/\/+$/, '');
+  const separatorIndex = normalized.lastIndexOf('/');
+  if (separatorIndex <= 0) {
+    return normalized;
+  }
+  return normalized.slice(0, separatorIndex);
+}
+
+function basename(filePath: string): string {
+  const normalized = normalizePathSeparators(filePath).replace(/\/+$/, '');
+  return normalized.slice(normalized.lastIndexOf('/') + 1);
+}
+
 /** Local guard to avoid runtime circular import with interface.ts */
 function isWikiWorkspace(workspace: IWorkspace): workspace is IWikiWorkspace {
   return 'wikiFolderLocation' in workspace;
@@ -61,7 +77,7 @@ export function getHtmlFileLocation(workspace: IWikiWorkspace): string | undefin
  */
 export function getWorkspaceContainerPath(workspace: IWikiWorkspace): string {
   if (isHtmlWikiWorkspace(workspace)) {
-    return path.dirname(workspace.htmlFileLocation);
+    return dirname(workspace.htmlFileLocation);
   }
   return workspace.wikiFolderLocation;
 }
@@ -81,9 +97,9 @@ export function getWorkspaceGitScope(workspace: IWorkspace): IWorkspaceGitScope
     return undefined;
   }
   if (isHtmlWikiWorkspace(workspace)) {
-    const managedAbsolutePath = path.resolve(workspace.htmlFileLocation);
-    const repoPath = path.dirname(managedAbsolutePath);
-    const managedRelativePath = path.basename(managedAbsolutePath);
+    const managedAbsolutePath = normalizePathSeparators(workspace.htmlFileLocation);
+    const repoPath = dirname(managedAbsolutePath);
+    const managedRelativePath = basename(managedAbsolutePath);
     return {
       repoPath,
       managedRelativePath,
@@ -92,19 +108,19 @@ export function getWorkspaceGitScope(workspace: IWorkspace): IWorkspaceGitScope
     };
   }
   return {
-    repoPath: path.resolve(workspace.wikiFolderLocation),
-    managedAbsolutePath: path.resolve(workspace.wikiFolderLocation),
-    managedDisplayName: path.basename(workspace.wikiFolderLocation),
+    repoPath: normalizePathSeparators(workspace.wikiFolderLocation),
+    managedAbsolutePath: normalizePathSeparators(workspace.wikiFolderLocation),
+    managedDisplayName: basename(workspace.wikiFolderLocation),
   };
 }
 
 export function normalizeHtmlWorkspacePaths(htmlFileLocation: string): Pick<IHtmlWikiWorkspace, 'htmlFileLocation' | 'wikiFolderLocation'> {
-  const resolvedHtml = path.resolve(htmlFileLocation);
+  const resolvedHtml = normalizePathSeparators(htmlFileLocation);
   if (!isHtmlWiki(resolvedHtml)) {
     throw new Error(`Not a valid HTML wiki file: ${resolvedHtml}`);
   }
   return {
     htmlFileLocation: resolvedHtml,
-    wikiFolderLocation: path.dirname(resolvedHtml),
+    wikiFolderLocation: dirname(resolvedHtml),
   };
 }
diff --git a/src/windows/Preferences/GenericSchemaRenderer.tsx b/src/windows/Preferences/GenericSchemaRenderer.tsx
@@ -19,7 +19,7 @@ import type {
   IGenericStringItem,
 } from '@services/preferences/definitions/types';
 import { getCustomComponent } from './customComponentRegistry';
-import { DeferredSectionSkeleton, INITIAL_GENERIC_SECTION_COUNT, IS_TEST_ENV, matchesPlatform, SearchSectionLabel, toKebabCase } from './genericSchemaRendererShared';
+import { DeferredSectionSkeleton, INITIAL_GENERIC_SECTION_COUNT, matchesPlatform, SearchSectionLabel, toKebabCase } from './genericSchemaRendererShared';
 import { HighlightText } from './HighlightText';
 import { Paper, SectionTitle } from './PreferenceComponents';
 
@@ -308,9 +308,8 @@ export function AllGenericSectionsRenderer<TRecord extends Record<string, unknow
     [hiddenSections, sections],
   );
 
-  const [visibleCount, setVisibleCount] = React.useState(IS_TEST_ENV ? visibleSections.length : initialSectionCount);
+  const [visibleCount, setVisibleCount] = React.useState(initialSectionCount);
   React.useEffect(() => {
-    if (IS_TEST_ENV) return;
     if (query.trim()) return;
     if (visibleCount >= visibleSections.length) return;
     const id = requestIdleCallback(() => {
diff --git a/src/windows/Preferences/SchemaRenderer.tsx b/src/windows/Preferences/SchemaRenderer.tsx
@@ -418,7 +418,6 @@ interface IAllSectionsRendererProps {
 }
 
 const INITIAL_SECTION_COUNT = 4;
-const IS_TEST_ENV = process.env.NODE_ENV === 'test';
 
 /** Placeholder skeleton shown for deferred sections while waiting for idle time */
 function DeferredSectionSkeleton({ sectionRef }: { sectionRef?: React.RefObject<HTMLSpanElement | null> }): React.JSX.Element {
@@ -440,9 +439,8 @@ export function AllSectionsRenderer({ onNeedsRestart, sectionRefs, query = '' }:
   const { t } = useTranslation(['translation', 'agent']);
 
   // All hooks must be called unconditionally before any conditional return.
-  const [visibleCount, setVisibleCount] = React.useState(IS_TEST_ENV ? allSections.length : INITIAL_SECTION_COUNT);
+  const [visibleCount, setVisibleCount] = React.useState(INITIAL_SECTION_COUNT);
   React.useEffect(() => {
-    if (IS_TEST_ENV) return;
     if (query.trim()) return; // don't advance deferred loading while searching
     if (preference === undefined || visibleCount >= allSections.length) return;
     const id = requestIdleCallback(() => {
diff --git a/src/windows/Preferences/genericSchemaRendererShared.tsx b/src/windows/Preferences/genericSchemaRendererShared.tsx
@@ -38,4 +38,3 @@ export function DeferredSectionSkeleton({ sectionRef }: { sectionRef?: React.Ref
 }
 
 export const INITIAL_GENERIC_SECTION_COUNT = 3;
-export const IS_TEST_ENV = process.env.NODE_ENV === 'test';

Original file line number	Diff line number	Diff line change
`@@ -148,9 +148,9 @@ export function TemplateSearch({ placeholder, onTemplateSelect, testId }: Templa`
`148`	`148`	`return undefined;`
`149`	`149`	`}`
`150`	`150`
`151`		`- // Only skip in unit test environment, not E2E`
	`151`	`+ // Only skip in jsdom-style unit tests, not E2E.`
`152`	`152`	`const ua = typeof navigator !== 'undefined' ? navigator.userAgent ?? '' : '';`
`153`		`- const isUnitTest = /jsdom/i.test(ua) && process.env.NODE_ENV === 'test' && typeof window.service === 'undefined';`
	`153`	`+ const isUnitTest = /jsdom/i.test(ua) && typeof window.service === 'undefined';`
`154`	`154`	`if (isUnitTest) {`
`155`	`155`	`return undefined;`
`156`	`156`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ export interface IConstants {`
`26`	`26`	`appVersion: string;`
`27`	`27`	`environmentVersions: NodeJS.ProcessVersions;`
`28`	`28`	`isDevelopment: boolean;`
	`29`	`+ isTest: boolean;`
`29`	`30`	`oSVersion: string;`
`30`	`31`	`platform: string;`
`31`	`32`	`}`