Feat/Native AI Agent (#640)

* refactor: only use message id

* feat: stream update, but react don't react on it dny

* feat: start stop

* feat: basic resoponse handlers

* feat: load handler config schema

* chore: upgrade to "moduleResolution": "bundler"

* fix: prompt concat

* feat: rjfs with mui

* fix: mui v7 upgrade

* fix: field editor tabs

* feat: Description field is i18n key, use i18nAlly extension to see it on VSCode. And use react-i18next to translate it on frontend.

* refactor: extract some shared components

* refactor: remove @mui/lab

* feat: faster editor

* feat: beautify editor

* refactor: better style

* fix: fullscreen style

* fix: array sort

* fix: editor not saved

* fix: broken array

* chore: upgrade mui deps

* Update type.d.ts

* feat: upgrade and install react dev tools

* refactor: simplify the code

* refactor: simplify the code

* refactor: simplify ai generated garbage code

* fix: translated label

* feat: translate enum and conditional show field based on enum

* feat: click to open source

* fix: ai generated garbage code to solve id and index problem

* refactor: simplify

* refactor: shorten

* test: add jest

* chore: node-linker=hoisted as electron forge suggested

* test: e2e

* fix: test failed on ci

* test: faster by disable some typecheck

* fix: ci

* fix: ci

* refactor: remove unused

* fix: use macos and take screenshot in ci

* docs:

(cherry picked from commit b1a9706264)

* fix: ci crash due to no dugite binary, due to NODE_ENV=test not set

* Update test.yml

* fix: ci

* Update release.yml

* docs: test

* refactor: move folders and lint

* refactor: organize pages to reduce level

* refactor: merge page service and workspace service to allow drag & drop of pages

* Update ipc-syncadaptor.ts

* Update browserViewMetaData.ts

* fix: view.webContents.loadURL won't reload on new electron version

* fix: try to disable annoying useless disabling pasting "feature"

https://github.com/electron/electron/issues/40995

* fix: initial page

* feat: allow sort add icon

* test: use vitest instead

* refactor: use emotion instead

* fix: all ts error after migrate to vitest and emotion

* fix: Component selectors can only be used in conjunction with @emotion/babel-plugin, the swc Emotion plugin, or another Emotion-aware compiler transform.

fix by not using this usage

* fix: too many open files

* test: add basic main page test

* refactor: split workspace type to make it more specific

* test: support mock react lazy import component by re-export them

* test: sidebar

* refactor: move mock to global

* test: testing library fix

* test: new wiki form

* docs: test with vitest

* lint: fix

* docs: pronounication & remove toc as gh build in

* feat: tools and rag

* feat: prompt for build-in tools

* fix: i18n

* fix: tool using

* test: fix

* refactor: Auto-create default wiki workspace if none exists (handled in backend)

* fix: create wiki workspace so it is on first one

* refactor: remove some useless feature

* refactor: use plugin instead of handler

* chore: make concatPrompt async iterator

* feat: show progress on frontend

* fix: errors

* fix: ConfigError: Config (unnamed): Key "overrides": This appears to be in eslintrc format rather than flat config format.

* Update package.json

* feat: allow windows to hide titlebar

* fix: logger error when ctrl+c on mac

* lint

* refactor: use plugin everywhere

* refactor: move more logic to plugin

* refactor: run tool in plugin, simplify abstraction

* refactor: remove ai generated duplicate

* refactor

* refactor: less plugins

* test: simplify wiki search test

* test: remove any

* fix: not streaming, tool order wrong

* test: plugin system and streaming

* refactor: remove useless auto reply plugin

* fix: hide duration expired tool calling message, so long tool result only show to ai once

* fix: $ props should lower cased

* test: support run as electron so can use sqlite3 compiled bin for electron

* docs: better electron as node run and doc

* test: restore to use threads instead of fock. Seems this also works for inmemory database

* test: fix frontend ui test

* lint: ai content

* test: fix coverage

* test: Refactor test mocks to dedicated __mocks__ directory

Moved common test mocks from setup-vitest.ts into separate files under src/__tests__/__mocks__ for better organization and maintainability. Updated documentation to reflect the new structure. Removed fileMock.js and updated setup-vitest.ts to import and use the new centralized mocks.

* Update ErrorDuringStart.md

* Update messageManagementPlugin.test.ts

* test: Fix Electron test process cleanup and update test config

Update test:unit script to use cross-env for ELECTRON_RUN_AS_NODE, ensuring child processes inherit the variable and preventing resource leaks. Remove manual process.env setting from vitest.config.ts and add documentation on handling related errors in Testing.md. Also, add 'hanging-process' reporter to Vitest config for improved diagnostics.

* fix: warning in test

* Create AgentInstanceWorkflow.md

* fix: duration bug

* fix: ai not response for tool result

* test: Add agent workflow feature and step definitions

Introduces a new Cucumber feature for agent workflow, including multi-round conversation and tool usage. Adds agent-specific step definitions for message input and chat history validation. Refactors application step definitions for improved selector handling and element interaction. Updates test scripts in package.json to include a preparation step for e2e tests.

* Update application.ts

* test: Add mock OpenAI server and tests

Introduces a MockOpenAIServer for simulating OpenAI chat completions, including tool call and tool result responses. Adds corresponding tests and updates vitest config to include tests in the features directory.

* test: simplify steps

* test: Add separate test userData and wiki folders

Introduces 'userData-test' and 'wiki-test' folders for test environments, updating appPaths, fileNames, and paths constants to distinguish between development and test modes. This helps prevent conflicts when running test and development instances simultaneously.

* Update eslint.config.mjs

@typescript-eslint/no-unnecessary-condition': 'off'

* test: Add data-testid attributes for test automation

Added data-testid attributes to form inputs and buttons in ExternalAPI components to improve test automation reliability. Updated feature files and step definitions to use these selectors, refined window switching logic, and improved timing for UI interactions. Also exposed isElectronDevelopment and added isMainWindowPage utility for window identification.

* test: fix wront page type by ai written garbage code

* Update application.ts

* Update Testing.md

* fix: no log during e2e test, and error creating wiki blocks other init steps

* test: click agent workspace button, and refactor mock server

* test: mock streamable openai api

* rename

* chore: try esbuild loader, renderer build too slow

* chore: organize webpack

* chore: ignore service code from hot reload

* Update Testing.md

* test: use full agentinstance in test

* chore: webpack error

* Update Testing.md

* chore: remove useless spectron

* test: EsbuildPlugin's `define` doesn't work, it won't set env properly.

* test: e2e mock openai

* lint: disable @typescript-eslint/require-await

* test: Add quick access to create default agent tab

Introduces a 'Create Default Agent' quick access button in the Agent New Tab page, with localization support. Adds utility to close all tabs and create a default agent tab for fallback scenarios, improves test selectors for tab and close actions, and refactors agent chat tab creation logic for consistency and testability.

* feat: remove unuse favorite

* feat: Add wiki operation and workspaces list plugins

Introduces wikiOperationPlugin and workspacesListPlugin for agent instance prompt and response handling. Updates plugin registry, test coverage, and default agent configuration to support wiki workspace listing and wiki note operations (create, update, delete) via tool calls. Refactors wikiSearchPlugin to delegate workspace list injection to workspacesListPlugin.

* Refactor plugin schema system for dynamic registration

Introduces a dynamic plugin schema registry, allowing plugins to register their parameter schemas and metadata at runtime. Refactors prompt concat schema generation to use dynamically registered plugin schemas, removes static plugin schema definitions, and updates all plugin files to export their parameter schemas. Adds new modelContextProtocolPlugin and schemaRegistry modules, and updates plugin initialization to register schemas and metadata. This enables extensibility and type safety for plugin configuration and validation.

* refactor: move PromptConfigForm to inside PromptPreviewDialog

* test: frontent render tool usage info

* test: split file

* test: fix error

* test: wiki operation

* test: remove log and clean up test deps

* Update i18next-electron-fs-backend.ts

* fix: wikiOperationInServer not called due to no message

* test: fix

* test: Refactor agent feature setup and improve mock server URL handling

Moved AI provider and model configuration to a shared setup scenario in agent.feature to avoid redundant steps in each test. Enhanced application.ts to use a fallback localhost URL for MOCK_SERVER_URL when the mock server is not available, improving test reliability.

* Remove retry logic from basicPromptConcatHandler

Eliminated retryCount and maxRetries from basicPromptConcatHandler, simplifying the control flow and removing the retry limit for LLM calls. Logging and yield logic were updated to reflect the removal of retries.

* Update agent.feature

* test: agent and default wiki

* test: refactor wiki cleanup

* Update agent.feature

* Refactor AI settings setup and add preference feature

Moved AI provider and model configuration steps from agent.feature to a new preference.feature file for better separation of concerns. Updated step definitions in agent.ts to improve robustness when reading and writing settings files, including type usage and directory checks.

* test: try debug can't stop bug

* Update Testing.md

* fix: cancel agent not update cancel button

* refactor: update Frontend use `void window.service.native.log` to log to file.

* test: log from renderer test

* feat: add default embedding model config and victor search service and search preference panel

* test: default embedding form and

* test: default agent

* refator: unused tool listing methods

* Refactor test database setup for integration tests

Centralizes in-memory SQLite test database initialization and cleanup in shared utilities for all integration tests. Updates agentDefinition and messageManagementPlugin tests to use the shared test database, improving reliability and reducing code duplication.

* fix: app path wrong in unit test

* feat: externalAPIDebug

* test: embedding service and let db use real in memory one

* test: provide at least one tab for close tab test

* fix: victor db not loaded in new connection

* test: disable hot reload

* Update DeveloperTools.tsx

* feat: tool message & wiki tool schema

* feat: pref to open db

* chore: skip ExternalsPlugin on dev

* fix: APIs doesn't accept 'tool' role, and it won't return anything when API calls

* fix: docs and remove ai fake fix

* refactor: get agent list don't need to have message

* Update basicPromptConcatHandler.failure.test.ts

* Update basicPromptConcatHandler.test.ts

* fix: role wrong cause e2e failed

* test: allow e2e create .db file to check

* feat: create new agent

* feat: getAgentDefinitionTemplatesFromWikis

* fix: Prevent update non-active (hiding) wiki workspace, so it won't pop up to cover other active agent workspace

* fix: Ensure the config change is fully persisted before proceeding

* test: Don't bring up window when running e2e test, otherwise it will annoy the developer who is doing other things.

* feat: Edit existing agent definition workflow

* Update StyledArrayContainer.tsx

* test: prevent mock server hang

* Refactor UI step definitions into separate file

Moved UI-related Cucumber step definitions from application.ts to a new ui.ts file for better separation of concerns and maintainability. application.ts now only contains application-specific logic.

* lint: ai auto fix

* Clean up feature files and improve test coverage

Removed unnecessary blank lines and improved formatting in feature files for better readability. Updated tsconfig to use 'bundler' module resolution. Enhanced EditAgentDefinitionContent test to mock and verify console.error output. Added type annotation for IAgentDefinitionService in basicPromptConcatHandler.failure.test.ts for improved type safety.

* test: simplify message text match

* feat: transcription and image generation model config

* fix: style props error

* chore: remove unused file

* chore: try to imporove dev start speed but no sig improvment

Replaces 'pnpm start' with 'pnpm start:init' for initial setup and documents slow startup in development. Adds a debug Webpack script, disables polling in renderer file watching, and only enables CircularDependencyPlugin in production/CI for faster dev builds. WebpackBar now only shows when DEBUG includes 'electron-forge:*'. ForkTsCheckerWebpackPlugin is now configured for async checks with memory limits and test file exclusion. Updates documentation to reflect these changes.

* docs: why not vite

* refactor: basic vite usage, but wiki worker is not running and view is not showing

* refactor: remove lazy inject so vite works and wiki worker works, wiki in browser view can loads

* Replace electron-squirrel-startup with inline implementation

Added a custom Squirrel event handler in src/helpers/squirrelStartup.ts to handle Windows install/update/uninstall events, replacing the electron-squirrel-startup package. This avoids ESM/CommonJS compatibility issues and simplifies event handling in src/main.ts.

* refactor: vite build and test

* fix: e2e still use dev wiki folder

* fix: provide env

* chore: "tiddlywiki": "5.3.7"

* Apply suggestion from @Copilot

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Apply suggestion from @Copilot

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Apply suggestion from @Copilot

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Apply suggestion from @Copilot

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix: missing i18n

* test:  Module did not self-register: '/home/runner/work/TidGi-Desktop/TidGi-Desktop/node_modules/better-sqlite3/build/Release/better_sqlite3.node'.

* feat: i18n

* feat: zh-Hant i18n

* Update test.yml

* feat: zh-Hans in test

* test: i18n

* refactor: ts forge config

* lint: fix

* chore: update wiki

* Update pnpm-lock.yaml

* chore: update github action versions

* Update wiki

* fix: pnpm then node

* fix: Multiple versions of pnpm specified

* Update test.yml

* fix: Failed to take screenshot: page.screenshot: Target page, context or browser has been closed

* chore: CodeQL Action major versions v1 and v2 have been deprecated.

* chore: parallel codeql

* Update test.yml

* fix: i18n test not passing

* test: step screenshot in each folder

* fix: can't unzip, may due to file path

* test: increase timeout in CI

* docs: more log about wiki creation, and add log to criticial path

* Refactor: logging for structured and consistent output

Replaces string-based logger messages with structured logging throughout the codebase, providing function names, error messages, and relevant context as objects. This improves log readability, enables better filtering and searching, and standardizes error and debug reporting across services.

* chore: debug wiki copy

* fix: wiki submodule not cloned

* Revert "test: increase timeout in CI"

This reverts commit eff8583a01.

* test: reduce wait time, because most check already will wait for a while

* test: batch some e2e steps to reduce screenshot count

* Update index.ts

* chore: remove webpack files, use vite plugins

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
lin onetwo 2025-10-10 17:16:56 +08:00 committed by GitHub
parent a39023627d
commit fa9751e5ea
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
533 changed files with 53202 additions and 11006 deletions

View file

@ -1,17 +1,12 @@
/* eslint-disable @typescript-eslint/strict-boolean-expressions */
/* eslint-disable @typescript-eslint/promise-function-async */
/* eslint-disable unicorn/no-null */
/* eslint-disable @typescript-eslint/require-await */
/* eslint-disable unicorn/consistent-destructuring */
import { mapSeries } from 'bluebird';
import { app, dialog, session } from 'electron';
import { injectable } from 'inversify';
import { inject, injectable } from 'inversify';
import { WikiChannel } from '@/constants/channels';
import { tiddlywikiLanguagesMap } from '@/constants/languages';
import { WikiCreationMethod } from '@/constants/wikiCreation';
import type { IAuthenticationService } from '@services/auth/interface';
import { lazyInject } from '@services/container';
import { container } from '@services/container';
import { i18n } from '@services/libs/i18n';
import { logger } from '@services/libs/log';
import type { IMenuService } from '@services/menu/interface';
@ -23,89 +18,108 @@ import type { IWikiService } from '@services/wiki/interface';
import type { IWindowService } from '@services/windows/interface';
import { WindowNames } from '@services/windows/WindowProperties';
import type { IWorkspace, IWorkspaceService } from '@services/workspaces/interface';
import { isWikiWorkspace } from '@services/workspaces/interface';
import { DELAY_MENU_REGISTER } from '@/constants/parameters';
import { ISyncService } from '@services/sync/interface';
import type { ISyncService } from '@services/sync/interface';
import type { IInitializeWorkspaceOptions, IWorkspaceViewService } from './interface';
import { registerMenu } from './registerMenu';
@injectable()
export class WorkspaceView implements IWorkspaceViewService {
@lazyInject(serviceIdentifier.Authentication)
private readonly authService!: IAuthenticationService;
@lazyInject(serviceIdentifier.View)
private readonly viewService!: IViewService;
@lazyInject(serviceIdentifier.Wiki)
private readonly wikiService!: IWikiService;
@lazyInject(serviceIdentifier.Workspace)
private readonly workspaceService!: IWorkspaceService;
@lazyInject(serviceIdentifier.Window)
private readonly windowService!: IWindowService;
@lazyInject(serviceIdentifier.Preference)
private readonly preferenceService!: IPreferenceService;
@lazyInject(serviceIdentifier.MenuService)
private readonly menuService!: IMenuService;
@lazyInject(serviceIdentifier.Sync)
private readonly syncService!: ISyncService;
constructor() {
constructor(
@inject(serviceIdentifier.Authentication) private readonly authService: IAuthenticationService,
@inject(serviceIdentifier.Preference) private readonly preferenceService: IPreferenceService,
) {
setTimeout(() => {
void registerMenu();
}, DELAY_MENU_REGISTER);
}
public async initializeAllWorkspaceView(): Promise<void> {
const workspacesList = await this.workspaceService.getWorkspacesAsList();
workspacesList.filter((workspace) => !workspace.isSubWiki).forEach((workspace) => {
this.wikiService.setWikiStartLockOn(workspace.id);
logger.info('starting', { function: 'initializeAllWorkspaceView' });
const workspaceService = container.get<IWorkspaceService>(serviceIdentifier.Workspace);
const workspacesList = await workspaceService.getWorkspacesAsList();
logger.info(`Found ${workspacesList.length} workspaces to initialize`, {
workspaces: workspacesList.map(w => ({ id: w.id, name: w.name, isSubWiki: isWikiWorkspace(w) ? w.isSubWiki : false, pageType: w.pageType })),
}, { function: 'initializeAllWorkspaceView' });
// Only load workspace that is not a subwiki and not a page type
const wikiService = container.get<IWikiService>(serviceIdentifier.Wiki);
workspacesList.filter((workspace) => isWikiWorkspace(workspace) && !workspace.isSubWiki && !workspace.pageType).forEach((workspace) => {
wikiService.setWikiStartLockOn(workspace.id);
});
// sorting (-1 will make a in the front, b in the back)
const sortedList = workspacesList
.sort((a, b) => a.order - b.order) // sort by order, 1-2<0, so first will be the first
.sort((a, b) => (a.active && !b.active ? -1 : 0)) // put active wiki first
.sort((a, b) => (a.isSubWiki && !b.isSubWiki ? -1 : 0)); // put subwiki on top, they can't restart wiki, so need to sync them first, then let main wiki restart the wiki // revert this after tw can reload tid from fs
.sort((a, b) => (isWikiWorkspace(a) && a.isSubWiki && (!isWikiWorkspace(b) || !b.isSubWiki) ? -1 : 0)); // put subwiki on top, they can't restart wiki, so need to sync them first, then let main wiki restart the wiki // revert this after tw can reload tid from fs
await mapSeries(sortedList, async (workspace) => {
await this.initializeWorkspaceView(workspace);
});
this.wikiService.setAllWikiStartLockOff();
wikiService.setAllWikiStartLockOff();
}
public async initializeWorkspaceView(workspace: IWorkspace, options: IInitializeWorkspaceOptions = {}): Promise<void> {
logger.info(i18n.t('Log.InitializeWorkspaceView'));
const { followHibernateSettingWhenInit = true, syncImmediately = true, isNew = false } = options;
// skip if workspace don't contains a valid tiddlywiki setup, this allows user to delete workspace later
if ((await this.wikiService.checkWikiExist(workspace, { shouldBeMainWiki: !workspace.isSubWiki, showDialog: true })) !== true) {
logger.warn(`initializeWorkspaceView() checkWikiExist found workspace ${workspace.id} don't have a valid wiki, and showDialog.`);
// Skip initialization for page workspaces - they don't need TiddlyWiki setup
if (workspace.pageType) {
logger.info('skipping initialization for page workspace', { function: 'initializeWorkspaceView', workspaceId: workspace.id, pageType: workspace.pageType });
return;
}
logger.debug(`initializeWorkspaceView() Initializing workspace ${workspace.id}, ${JSON.stringify(options)}`);
const { followHibernateSettingWhenInit = true, syncImmediately = true, isNew = false } = options;
// skip if workspace don't contains a valid tiddlywiki setup, this allows user to delete workspace later
const wikiService = container.get<IWikiService>(serviceIdentifier.Wiki);
const workspaceService = container.get<IWorkspaceService>(serviceIdentifier.Workspace);
const shouldBeMainWiki = isWikiWorkspace(workspace) && !workspace.isSubWiki;
logger.info('checking wiki existence', {
workspaceId: workspace.id,
shouldBeMainWiki,
wikiFolderLocation: isWikiWorkspace(workspace) ? workspace.wikiFolderLocation : undefined,
function: 'initializeWorkspaceView',
});
const checkResult = await wikiService.checkWikiExist(workspace, { shouldBeMainWiki, showDialog: true });
if (checkResult !== true) {
logger.warn('checkWikiExist found invalid wiki', {
workspaceId: workspace.id,
checkResult,
shouldBeMainWiki,
wikiFolderLocation: isWikiWorkspace(workspace) ? workspace.wikiFolderLocation : undefined,
function: 'initializeWorkspaceView',
});
return;
}
logger.info('wiki validation passed', {
workspaceId: workspace.id,
function: 'initializeWorkspaceView',
});
logger.debug('Initializing workspace', {
workspaceId: workspace.id,
options: JSON.stringify(options),
function: 'initializeWorkspaceView',
});
if (followHibernateSettingWhenInit) {
const hibernateUnusedWorkspacesAtLaunch = await this.preferenceService.get('hibernateUnusedWorkspacesAtLaunch');
if ((hibernateUnusedWorkspacesAtLaunch || workspace.hibernateWhenUnused) && !workspace.active) {
if ((hibernateUnusedWorkspacesAtLaunch || (isWikiWorkspace(workspace) && workspace.hibernateWhenUnused)) && !workspace.active) {
logger.debug(
`initializeWorkspaceView() quit because ${
JSON.stringify({
followHibernateSettingWhenInit,
'workspace.hibernateWhenUnused': workspace.hibernateWhenUnused,
'workspace.hibernateWhenUnused': isWikiWorkspace(workspace) ? workspace.hibernateWhenUnused : false,
'workspace.active': workspace.active,
hibernateUnusedWorkspacesAtLaunch,
})
}`,
);
if (!workspace.hibernated) {
await this.workspaceService.update(workspace.id, { hibernated: true });
if (isWikiWorkspace(workspace) && !workspace.hibernated) {
await workspaceService.update(workspace.id, { hibernated: true });
}
return;
}
}
const syncGitWhenInitializeWorkspaceView = async () => {
if (!isWikiWorkspace(workspace)) return;
const { wikiFolderLocation, gitUrl: githubRepoUrl, storageService, isSubWiki } = workspace;
// we are using syncWikiIfNeeded that handles recursive sync for all subwiki, so we only need to pass main wiki to it in this method.
if (isSubWiki) {
@ -118,15 +132,15 @@ export class WorkspaceView implements IWorkspaceViewService {
if (typeof githubRepoUrl !== 'string') {
throw new TypeError(`githubRepoUrl is undefined in initializeAllWorkspaceView when init ${wikiFolderLocation}`);
}
const mainWindow = this.windowService.get(WindowNames.main);
const mainWindow = container.get<IWindowService>(serviceIdentifier.Window).get(WindowNames.main);
if (mainWindow === undefined) {
throw new Error(i18n.t(`Error.MainWindowMissing`));
}
const userInfo = await this.authService.getStorageServiceUserInfo(workspace.storageService);
// eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
const userInfo = await this.authService.getStorageServiceUserInfo(storageService);
if (userInfo?.accessToken) {
// sync in non-blocking way
void this.syncService.syncWikiIfNeeded(workspace);
void container.get<ISyncService>(serviceIdentifier.Sync).syncWikiIfNeeded(workspace);
} else {
// user not login into Github or something else
void dialog.showMessageBox(mainWindow, {
@ -139,25 +153,30 @@ export class WorkspaceView implements IWorkspaceViewService {
}
}
} catch (error) {
logger.error(`Can't sync at wikiStartup(), ${(error as Error).message}\n${(error as Error).stack ?? 'no stack'}`);
const error_ = error instanceof Error ? error : new Error(String(error));
logger.error('wikiStartup sync failed', {
function: 'initializeAllWorkspaceView',
error: error_.message,
stack: error_.stack ?? 'no stack',
});
}
};
const addViewWhenInitializeWorkspaceView = async (): Promise<void> => {
// adding WebContentsView for each workspace
// skip view initialize if this is a sub wiki
if (workspace.isSubWiki) {
if (isWikiWorkspace(workspace) && workspace.isSubWiki) {
return;
}
// if we run this due to RestartService, then skip the view adding and the while loop, because the workspaceMetadata.isLoading will be false, because addViewForAllBrowserViews will return before it run loadInitialUrlWithCatch
if (await this.viewService.alreadyHaveView(workspace)) {
logger.debug('Skip initializeWorkspaceView() because alreadyHaveView');
if (await container.get<IViewService>(serviceIdentifier.View).alreadyHaveView(workspace)) {
logger.debug('Skip because alreadyHaveView');
return;
}
// Create browserView, and if user want a menubar, we also create a new window for that
await this.addViewForAllBrowserViews(workspace);
if (isNew && options.from === WikiCreationMethod.Create) {
const view = this.viewService.getView(workspace.id, WindowNames.main);
const view = container.get<IViewService>(serviceIdentifier.View).getView(workspace.id, WindowNames.main);
if (view !== undefined) {
// if is newly created wiki, we set the language as user preference
const currentLanguage = await this.preferenceService.get('language');
@ -168,16 +187,18 @@ export class WorkspaceView implements IWorkspaceViewService {
tiddlywikiLanguagesMap,
});
} else {
logger.debug(`Setting wiki language to ${currentLanguage} (${tiddlywikiLanguageName}) on init`);
await this.wikiService.setWikiLanguage(workspace.id, tiddlywikiLanguageName);
logger.debug('setting wiki language on init', { function: 'initializeWorkspaceView', currentLanguage, tiddlywikiLanguageName });
await container.get<IWikiService>(serviceIdentifier.Wiki).setWikiLanguage(workspace.id, tiddlywikiLanguageName);
}
}
}
};
logger.debug(`initializeWorkspaceView() calling wikiStartup()`);
logger.debug('calling wikiStartup', {
function: 'initializeWorkspaceView',
});
await Promise.all([
this.wikiService.wikiStartup(workspace),
container.get<IWikiService>(serviceIdentifier.Wiki).wikiStartup(workspace),
addViewWhenInitializeWorkspaceView(),
]);
void syncGitWhenInitializeWorkspaceView();
@ -185,35 +206,44 @@ export class WorkspaceView implements IWorkspaceViewService {
public async addViewForAllBrowserViews(workspace: IWorkspace): Promise<void> {
await Promise.all([
this.viewService.addView(workspace, WindowNames.main),
container.get<IViewService>(serviceIdentifier.View).addView(workspace, WindowNames.main),
this.preferenceService.get('attachToMenubar').then(async (attachToMenubar) => {
return await (attachToMenubar && this.viewService.addView(workspace, WindowNames.menuBar));
return await (attachToMenubar && container.get<IViewService>(serviceIdentifier.View).addView(workspace, WindowNames.menuBar));
}),
]);
}
public async openWorkspaceWindowWithView(workspace: IWorkspace, configs?: { uri?: string }): Promise<void> {
const uriToOpen = configs?.uri ?? workspace.lastUrl ?? workspace.homeUrl;
const uriToOpen = configs?.uri ?? (isWikiWorkspace(workspace) ? workspace.lastUrl : undefined) ?? (isWikiWorkspace(workspace) ? workspace.homeUrl : undefined);
logger.debug('Open workspace in new window. uriToOpen here will overwrite the decision in initializeWorkspaceViewHandlersAndLoad.', {
id: workspace.id,
uriToOpen,
function: 'openWorkspaceWindowWithView',
});
const browserWindow = await this.windowService.open(WindowNames.secondary, undefined, { multiple: true }, true);
const sharedWebPreferences = await this.viewService.getSharedWebPreferences(workspace);
const view = await this.viewService.createViewAddToWindow(workspace, browserWindow, sharedWebPreferences, WindowNames.secondary);
const browserWindow = await container.get<IWindowService>(serviceIdentifier.Window).open(WindowNames.secondary, undefined, { multiple: true }, true);
const sharedWebPreferences = await container.get<IViewService>(serviceIdentifier.View).getSharedWebPreferences(workspace);
const view = await container.get<IViewService>(serviceIdentifier.View).createViewAddToWindow(workspace, browserWindow, sharedWebPreferences, WindowNames.secondary);
logger.debug('View created in new window.', { id: workspace.id, uriToOpen, function: 'openWorkspaceWindowWithView' });
await this.viewService.initializeWorkspaceViewHandlersAndLoad(browserWindow, view, { workspace, sharedWebPreferences, windowName: WindowNames.secondary, uri: uriToOpen });
await container.get<IViewService>(serviceIdentifier.View).initializeWorkspaceViewHandlersAndLoad(browserWindow, view, {
workspace,
sharedWebPreferences,
windowName: WindowNames.secondary,
uri: uriToOpen,
});
}
public async updateLastUrl(
workspaceID: string,
view: Electron.CrossProcessExports.WebContentsView | undefined = this.viewService.getView(workspaceID, WindowNames.main),
view: Electron.CrossProcessExports.WebContentsView | undefined = container.get<IViewService>(serviceIdentifier.View).getView(workspaceID, WindowNames.main),
): Promise<void> {
if (view?.webContents) {
const currentUrl = view.webContents.getURL();
logger.debug(`updateLastUrl() Updating lastUrl for workspace ${workspaceID} to ${currentUrl}`);
await this.workspaceService.update(workspaceID, {
logger.debug('Updating lastUrl for workspace', {
workspaceID,
currentUrl,
function: 'updateLastUrl',
});
await container.get<IWorkspaceService>(serviceIdentifier.Workspace).update(workspaceID, {
lastUrl: currentUrl,
});
} else {
@ -225,9 +255,9 @@ export class WorkspaceView implements IWorkspaceViewService {
if (typeof id === 'string' && id.length > 0) {
// if id is defined, switch to that workspace
await this.setActiveWorkspaceView(id);
await this.menuService.buildMenu();
await container.get<IMenuService>(serviceIdentifier.MenuService).buildMenu();
// load url in the current workspace
const activeWorkspace = await this.workspaceService.getActiveWorkspace();
const activeWorkspace = await container.get<IWorkspaceService>(serviceIdentifier.Workspace).getActiveWorkspace();
if (activeWorkspace !== undefined) {
await this.loadURL(url, activeWorkspace.id);
}
@ -235,93 +265,122 @@ export class WorkspaceView implements IWorkspaceViewService {
}
public async setWorkspaceView(workspaceID: string, workspaceOptions: IWorkspace): Promise<void> {
await this.workspaceService.set(workspaceID, workspaceOptions);
this.viewService.setViewsAudioPref();
this.viewService.setViewsNotificationsPref();
await container.get<IWorkspaceService>(serviceIdentifier.Workspace).set(workspaceID, workspaceOptions);
container.get<IViewService>(serviceIdentifier.View).setViewsAudioPref();
container.get<IViewService>(serviceIdentifier.View).setViewsNotificationsPref();
}
public async setWorkspaceViews(workspaces: Record<string, IWorkspace>): Promise<void> {
await this.workspaceService.setWorkspaces(workspaces);
this.viewService.setViewsAudioPref();
this.viewService.setViewsNotificationsPref();
await container.get<IWorkspaceService>(serviceIdentifier.Workspace).setWorkspaces(workspaces);
container.get<IViewService>(serviceIdentifier.View).setViewsAudioPref();
container.get<IViewService>(serviceIdentifier.View).setViewsNotificationsPref();
}
public async wakeUpWorkspaceView(workspaceID: string): Promise<void> {
const workspace = await this.workspaceService.get(workspaceID);
const workspace = await container.get<IWorkspaceService>(serviceIdentifier.Workspace).get(workspaceID);
if (workspace !== undefined) {
await Promise.all([
this.workspaceService.update(workspaceID, {
container.get<IWorkspaceService>(serviceIdentifier.Workspace).update(workspaceID, {
hibernated: false,
}),
this.authService.getUserName(workspace).then(userName => this.wikiService.startWiki(workspaceID, userName)),
this.authService.getUserName(workspace).then(userName => container.get<IWikiService>(serviceIdentifier.Wiki).startWiki(workspaceID, userName)),
this.addViewForAllBrowserViews(workspace),
]);
}
}
public async hibernateWorkspaceView(workspaceID: string): Promise<void> {
const workspace = await this.workspaceService.get(workspaceID);
logger.debug(`Hibernating workspace ${workspaceID}, workspace.active: ${String(workspace?.active)}`);
const workspace = await container.get<IWorkspaceService>(serviceIdentifier.Workspace).get(workspaceID);
logger.debug('hibernating workspace', {
function: 'hibernateWorkspaceView',
workspaceID,
active: String(workspace?.active),
});
if (workspace !== undefined && !workspace.active) {
await Promise.all([
this.wikiService.stopWiki(workspaceID),
this.workspaceService.update(workspaceID, {
container.get<IWikiService>(serviceIdentifier.Wiki).stopWiki(workspaceID),
container.get<IWorkspaceService>(serviceIdentifier.Workspace).update(workspaceID, {
hibernated: true,
}),
]);
this.viewService.removeAllViewOfWorkspace(workspaceID, true);
container.get<IViewService>(serviceIdentifier.View).removeAllViewOfWorkspace(workspaceID, true);
}
}
public async setActiveWorkspaceView(nextWorkspaceID: string): Promise<void> {
logger.debug('setActiveWorkspaceView', { nextWorkspaceID });
const [oldActiveWorkspace, newWorkspace] = await Promise.all([this.workspaceService.getActiveWorkspace(), this.workspaceService.get(nextWorkspaceID)]);
const [oldActiveWorkspace, newWorkspace] = await Promise.all([
container.get<IWorkspaceService>(serviceIdentifier.Workspace).getActiveWorkspace(),
container.get<IWorkspaceService>(serviceIdentifier.Workspace).get(nextWorkspaceID),
]);
if (newWorkspace === undefined) {
throw new Error(`Workspace id ${nextWorkspaceID} does not exist. When setActiveWorkspaceView().`);
}
logger.debug(
`Set active workspace oldActiveWorkspace.id: ${oldActiveWorkspace?.id ?? 'undefined'} nextWorkspaceID: ${nextWorkspaceID} newWorkspace.isSubWiki ${
String(
newWorkspace.isSubWiki,
isWikiWorkspace(newWorkspace) ? newWorkspace.isSubWiki : false,
)
}`,
);
if (newWorkspace.isSubWiki && typeof newWorkspace.mainWikiID === 'string') {
// Handle page workspace - only update workspace state, no view management needed
if (newWorkspace.pageType) {
logger.debug(`${nextWorkspaceID} is a page workspace, only updating workspace state.`);
await container.get<IWorkspaceService>(serviceIdentifier.Workspace).setActiveWorkspace(nextWorkspaceID, oldActiveWorkspace?.id);
// Hide old workspace view if switching from a regular workspace
if (oldActiveWorkspace !== undefined && oldActiveWorkspace.id !== nextWorkspaceID && !oldActiveWorkspace.pageType) {
await this.hideWorkspaceView(oldActiveWorkspace.id);
if (isWikiWorkspace(oldActiveWorkspace) && oldActiveWorkspace.hibernateWhenUnused) {
await this.hibernateWorkspaceView(oldActiveWorkspace.id);
}
}
return;
}
if (isWikiWorkspace(newWorkspace) && newWorkspace.isSubWiki && typeof newWorkspace.mainWikiID === 'string') {
logger.debug(`${nextWorkspaceID} is a subwiki, set its main wiki ${newWorkspace.mainWikiID} to active instead.`);
await this.setActiveWorkspaceView(newWorkspace.mainWikiID);
if (typeof newWorkspace.tagName === 'string') {
await this.wikiService.wikiOperationInBrowser(WikiChannel.openTiddler, newWorkspace.mainWikiID, [newWorkspace.tagName]);
await container.get<IWikiService>(serviceIdentifier.Wiki).wikiOperationInBrowser(WikiChannel.openTiddler, newWorkspace.mainWikiID, [newWorkspace.tagName]);
}
return;
}
// later process will use the current active workspace
await this.workspaceService.setActiveWorkspace(nextWorkspaceID, oldActiveWorkspace?.id);
if (newWorkspace.hibernated) {
await container.get<IWorkspaceService>(serviceIdentifier.Workspace).setActiveWorkspace(nextWorkspaceID, oldActiveWorkspace?.id);
if (isWikiWorkspace(newWorkspace) && newWorkspace.hibernated) {
await this.wakeUpWorkspaceView(nextWorkspaceID);
}
try {
await this.viewService.setActiveViewForAllBrowserViews(nextWorkspaceID);
await container.get<IViewService>(serviceIdentifier.View).setActiveViewForAllBrowserViews(nextWorkspaceID);
await this.realignActiveWorkspace(nextWorkspaceID);
} catch (error) {
logger.error(`Error while setActiveWorkspaceView(): ${(error as Error).message}`, error);
const error_ = error instanceof Error ? error : new Error(String(error));
logger.error('setActiveWorkspaceView error', {
function: 'setActiveWorkspaceView',
error: error_.message,
errorObj: error_,
});
throw error;
}
// if we are switching to a new workspace, we hide and/or hibernate old view, and activate new view
if (oldActiveWorkspace !== undefined && oldActiveWorkspace.id !== nextWorkspaceID) {
await this.hideWorkspaceView(oldActiveWorkspace.id);
if (oldActiveWorkspace.hibernateWhenUnused) {
if (isWikiWorkspace(oldActiveWorkspace) && oldActiveWorkspace.hibernateWhenUnused) {
await this.hibernateWorkspaceView(oldActiveWorkspace.id);
}
}
}
public async clearActiveWorkspaceView(idToDeactivate?: string): Promise<void> {
const activeWorkspace = idToDeactivate === undefined ? await this.workspaceService.getActiveWorkspace() : await this.workspaceService.get(idToDeactivate);
await this.workspaceService.clearActiveWorkspace(activeWorkspace?.id);
const activeWorkspace = idToDeactivate === undefined
? await container.get<IWorkspaceService>(serviceIdentifier.Workspace).getActiveWorkspace()
: await container.get<IWorkspaceService>(serviceIdentifier.Workspace).get(idToDeactivate);
await container.get<IWorkspaceService>(serviceIdentifier.Workspace).clearActiveWorkspace(activeWorkspace?.id);
if (activeWorkspace === undefined) {
return;
}
if (activeWorkspace.isSubWiki && typeof activeWorkspace.mainWikiID === 'string') {
if (isWikiWorkspace(activeWorkspace) && activeWorkspace.isSubWiki && typeof activeWorkspace.mainWikiID === 'string') {
logger.debug(`${activeWorkspace.id} is a subwiki, set its main wiki ${activeWorkspace.mainWikiID} to deactivated instead.`, { function: 'clearActiveWorkspaceView' });
await this.clearActiveWorkspaceView(activeWorkspace.mainWikiID);
return;
@ -329,24 +388,32 @@ export class WorkspaceView implements IWorkspaceViewService {
try {
await this.hideWorkspaceView(activeWorkspace.id);
} catch (error) {
logger.error(`Error while setActiveWorkspaceView(): ${(error as Error).message}`, error);
const error_ = error instanceof Error ? error : new Error(String(error));
logger.error('setActiveWorkspaceView error', {
function: 'clearActiveWorkspaceView',
error: error_.message,
errorObj: error_,
});
throw error;
}
if (activeWorkspace.hibernateWhenUnused) {
if (isWikiWorkspace(activeWorkspace) && activeWorkspace.hibernateWhenUnused) {
await this.hibernateWorkspaceView(activeWorkspace.id);
}
}
public async removeWorkspaceView(workspaceID: string): Promise<void> {
this.viewService.removeAllViewOfWorkspace(workspaceID, true);
const mainWindow = this.windowService.get(WindowNames.main);
container.get<IViewService>(serviceIdentifier.View).removeAllViewOfWorkspace(workspaceID, true);
const mainWindow = container.get<IWindowService>(serviceIdentifier.Window).get(WindowNames.main);
// if there's only one workspace left, clear all
if ((await this.workspaceService.countWorkspaces()) === 1) {
if ((await container.get<IWorkspaceService>(serviceIdentifier.Workspace).countWorkspaces()) === 1) {
if (mainWindow !== undefined) {
mainWindow.setTitle(app.name);
}
} else if ((await this.workspaceService.countWorkspaces()) > 1 && (await this.workspaceService.get(workspaceID))?.active === true) {
const previousWorkspace = await this.workspaceService.getPreviousWorkspace(workspaceID);
} else if (
(await container.get<IWorkspaceService>(serviceIdentifier.Workspace).countWorkspaces()) > 1 &&
(await container.get<IWorkspaceService>(serviceIdentifier.Workspace).get(workspaceID))?.active === true
) {
const previousWorkspace = await container.get<IWorkspaceService>(serviceIdentifier.Workspace).getPreviousWorkspace(workspaceID);
if (previousWorkspace !== undefined) {
await this.setActiveWorkspaceView(previousWorkspace.id);
}
@ -354,12 +421,14 @@ export class WorkspaceView implements IWorkspaceViewService {
}
public async restartWorkspaceViewService(id?: string): Promise<void> {
const workspaceToRestart = id === undefined ? await this.workspaceService.getActiveWorkspace() : await this.workspaceService.get(id);
const workspaceToRestart = id === undefined
? await container.get<IWorkspaceService>(serviceIdentifier.Workspace).getActiveWorkspace()
: await container.get<IWorkspaceService>(serviceIdentifier.Workspace).get(id);
if (workspaceToRestart === undefined) {
logger.warn(`restartWorkspaceViewService: no workspace ${id ?? 'id undefined'} to restart`);
return;
}
if (workspaceToRestart.isSubWiki) {
if (isWikiWorkspace(workspaceToRestart) && workspaceToRestart.isSubWiki) {
const mainWikiIDToRestart = workspaceToRestart.mainWikiID;
if (mainWikiIDToRestart) {
await this.restartWorkspaceViewService(mainWikiIDToRestart);
@ -369,27 +438,33 @@ export class WorkspaceView implements IWorkspaceViewService {
logger.info(`Restarting workspace ${workspaceToRestart.id}`);
await this.updateLastUrl(workspaceToRestart.id);
// start restarting. Set isLoading to false, and it will be set by some callback elsewhere to true.
await this.workspaceService.updateMetaData(workspaceToRestart.id, { didFailLoadErrorMessage: null, isLoading: false, isRestarting: true });
await this.wikiService.stopWiki(workspaceToRestart.id);
await container.get<IWorkspaceService>(serviceIdentifier.Workspace).updateMetaData(workspaceToRestart.id, {
didFailLoadErrorMessage: null,
isLoading: false,
isRestarting: true,
});
await container.get<IWikiService>(serviceIdentifier.Wiki).stopWiki(workspaceToRestart.id);
await this.initializeWorkspaceView(workspaceToRestart, { syncImmediately: false });
if (await this.workspaceService.workspaceDidFailLoad(workspaceToRestart.id)) {
logger.warn('restartWorkspaceViewService() skip because workspaceDidFailLoad');
if (await container.get<IWorkspaceService>(serviceIdentifier.Workspace).workspaceDidFailLoad(workspaceToRestart.id)) {
logger.warn('skip because workspaceDidFailLoad', { function: 'restartWorkspaceViewService' });
return;
}
await this.viewService.reloadViewsWebContents(workspaceToRestart.id);
await this.wikiService.wikiOperationInBrowser(WikiChannel.generalNotification, workspaceToRestart.id, [i18n.t('ContextMenu.RestartServiceComplete')]);
await this.workspaceService.updateMetaData(workspaceToRestart.id, { isRestarting: false });
await container.get<IViewService>(serviceIdentifier.View).reloadViewsWebContents(workspaceToRestart.id);
await container.get<IWikiService>(serviceIdentifier.Wiki).wikiOperationInBrowser(WikiChannel.generalNotification, workspaceToRestart.id, [
i18n.t('ContextMenu.RestartServiceComplete'),
]);
await container.get<IWorkspaceService>(serviceIdentifier.Workspace).updateMetaData(workspaceToRestart.id, { isRestarting: false });
}
public async restartAllWorkspaceView(): Promise<void> {
const workspaces = await this.workspaceService.getWorkspacesAsList();
const workspaces = await container.get<IWorkspaceService>(serviceIdentifier.Workspace).getWorkspacesAsList();
await Promise.all(
workspaces.map(async (workspace) => {
await Promise.all(
[WindowNames.main, WindowNames.menuBar].map(async (windowName) => {
const view = this.viewService.getView(workspace.id, windowName);
const view = container.get<IViewService>(serviceIdentifier.View).getView(workspace.id, windowName);
if (view !== undefined) {
await this.viewService.loadUrlForView(workspace, view);
await container.get<IViewService>(serviceIdentifier.View).loadUrlForView(workspace, view);
}
}),
);
@ -398,7 +473,8 @@ export class WorkspaceView implements IWorkspaceViewService {
}
public async clearBrowsingDataWithConfirm(): Promise<void> {
const availableWindowToShowDialog = this.windowService.get(WindowNames.preferences) ?? this.windowService.get(WindowNames.main);
const availableWindowToShowDialog = container.get<IWindowService>(serviceIdentifier.Window).get(WindowNames.preferences) ??
container.get<IWindowService>(serviceIdentifier.Window).get(WindowNames.main);
if (availableWindowToShowDialog !== undefined) {
await dialog
.showMessageBox(availableWindowToShowDialog, {
@ -418,7 +494,7 @@ export class WorkspaceView implements IWorkspaceViewService {
public async clearBrowsingData(): Promise<void> {
await session.defaultSession.clearStorageData();
const workspaces = await this.workspaceService.getWorkspaces();
const workspaces = await container.get<IWorkspaceService>(serviceIdentifier.Workspace).getWorkspaces();
await Promise.all(
Object.keys(workspaces).map(async (id) => {
await session.fromPartition(`persist:${id}`).clearStorageData();
@ -430,11 +506,11 @@ export class WorkspaceView implements IWorkspaceViewService {
}
public async loadURL(url: string, id: string | undefined): Promise<void> {
const mainWindow = this.windowService.get(WindowNames.main);
const activeWorkspace = await this.workspaceService.getActiveWorkspace();
const mainWindow = container.get<IWindowService>(serviceIdentifier.Window).get(WindowNames.main);
const activeWorkspace = await container.get<IWorkspaceService>(serviceIdentifier.Workspace).getActiveWorkspace();
const activeWorkspaceID = id ?? activeWorkspace?.id;
if (mainWindow !== undefined && activeWorkspaceID !== undefined) {
const view = this.viewService.getView(activeWorkspaceID, WindowNames.main);
const view = container.get<IViewService>(serviceIdentifier.View).getView(activeWorkspaceID, WindowNames.main);
if (view?.webContents) {
view.webContents.focus();
await view.webContents.loadURL(url);
@ -451,26 +527,37 @@ export class WorkspaceView implements IWorkspaceViewService {
// as it breaks page focus (cursor, scroll bar not visible)
await this.realignActiveWorkspaceView(id);
try {
await this.menuService.buildMenu();
await container.get<IMenuService>(serviceIdentifier.MenuService).buildMenu();
} catch (error) {
logger.error(`Error buildMenu() while realignActiveWorkspace(): ${(error as Error).message}`, error);
const error_ = error instanceof Error ? error : new Error(String(error));
logger.error('realignActiveWorkspace buildMenu error', {
function: 'realignActiveWorkspace',
error: error_.message,
errorObj: error_,
});
throw error;
}
}
private async realignActiveWorkspaceView(id?: string): Promise<void> {
const workspaceToRealign = id === undefined ? await this.workspaceService.getActiveWorkspace() : await this.workspaceService.get(id);
logger.debug(`realignActiveWorkspaceView() activeWorkspace.id: ${workspaceToRealign?.id ?? 'undefined'}`, { stack: new Error('stack').stack?.replace('Error:', '') });
if (workspaceToRealign?.isSubWiki) {
logger.debug(`realignActiveWorkspaceView() skip because ${workspaceToRealign.id} is a subwiki. Realign main wiki instead.`);
const workspaceToRealign = id === undefined
? await container.get<IWorkspaceService>(serviceIdentifier.Workspace).getActiveWorkspace()
: await container.get<IWorkspaceService>(serviceIdentifier.Workspace).get(id);
logger.debug('activeWorkspace.id', {
workspaceId: workspaceToRealign?.id ?? 'undefined',
stack: new Error('stack').stack?.replace('Error:', ''),
function: 'realignActiveWorkspaceView',
});
if (workspaceToRealign && isWikiWorkspace(workspaceToRealign) && workspaceToRealign.isSubWiki) {
logger.debug('skip because subwiki; realign main wiki instead', { workspaceId: workspaceToRealign.id, function: 'realignActiveWorkspaceView' });
if (workspaceToRealign.mainWikiID) {
await this.realignActiveWorkspaceView(workspaceToRealign.mainWikiID);
}
return;
}
const mainWindow = this.windowService.get(WindowNames.main);
const menuBarWindow = this.windowService.get(WindowNames.menuBar);
/* eslint-disable @typescript-eslint/strict-boolean-expressions */
const mainWindow = container.get<IWindowService>(serviceIdentifier.Window).get(WindowNames.main);
const menuBarWindow = container.get<IWindowService>(serviceIdentifier.Window).get(WindowNames.menuBar);
logger.info(
`realignActiveWorkspaceView: id ${workspaceToRealign?.id ?? 'undefined'}`,
);
@ -486,36 +573,35 @@ export class WorkspaceView implements IWorkspaceViewService {
if (mainWindow === undefined) {
logger.warn(`realignActiveWorkspaceView: no mainBrowserViewWebContent, skip main window for ${workspaceToRealign.id}.`);
} else {
tasks.push(this.viewService.realignActiveView(mainWindow, workspaceToRealign.id, WindowNames.main));
tasks.push(container.get<IViewService>(serviceIdentifier.View).realignActiveView(mainWindow, workspaceToRealign.id, WindowNames.main));
logger.debug(`realignActiveWorkspaceView: realign main window for ${workspaceToRealign.id}.`);
}
if (menuBarWindow === undefined) {
logger.info(`realignActiveWorkspaceView: no menuBarBrowserViewWebContent, skip menu bar window for ${workspaceToRealign.id}.`);
} else {
logger.debug(`realignActiveWorkspaceView: realign menu bar window for ${workspaceToRealign.id}.`);
tasks.push(this.viewService.realignActiveView(menuBarWindow, workspaceToRealign.id, WindowNames.menuBar));
tasks.push(container.get<IViewService>(serviceIdentifier.View).realignActiveView(menuBarWindow, workspaceToRealign.id, WindowNames.menuBar));
}
await Promise.all(tasks);
}
private async hideWorkspaceView(idToDeactivate: string): Promise<void> {
const mainWindow = this.windowService.get(WindowNames.main);
const menuBarWindow = this.windowService.get(WindowNames.menuBar);
const mainWindow = container.get<IWindowService>(serviceIdentifier.Window).get(WindowNames.main);
const menuBarWindow = container.get<IWindowService>(serviceIdentifier.Window).get(WindowNames.menuBar);
const tasks = [];
if (mainWindow === undefined) {
logger.warn(`hideWorkspaceView: no mainBrowserWindow, skip main window browserView.`);
} else {
logger.info(`hideWorkspaceView: hide main window browserView.`);
tasks.push(this.viewService.hideView(mainWindow, WindowNames.main, idToDeactivate));
tasks.push(container.get<IViewService>(serviceIdentifier.View).hideView(mainWindow, WindowNames.main, idToDeactivate));
}
if (menuBarWindow === undefined) {
logger.debug(`hideWorkspaceView: no menuBarBrowserWindow, skip menu bar window browserView.`);
} else {
logger.info(`hideWorkspaceView: hide menu bar window browserView.`);
tasks.push(this.viewService.hideView(menuBarWindow, WindowNames.menuBar, idToDeactivate));
tasks.push(container.get<IViewService>(serviceIdentifier.View).hideView(menuBarWindow, WindowNames.menuBar, idToDeactivate));
}
await Promise.all(tasks);
logger.info(`hideWorkspaceView: done.`);
}
/* eslint-enable @typescript-eslint/strict-boolean-expressions */
}

View file

@ -2,7 +2,7 @@ import { ProxyPropertyType } from 'electron-ipc-cat/common';
import { WorkspaceViewChannel } from '@/constants/channels';
import { WikiCreationMethod } from '@/constants/wikiCreation';
import { IWorkspace } from '@services/workspaces/interface';
import type { IWorkspace } from '@services/workspaces/interface';
export interface IInitializeWorkspaceOptions {
/**
@ -63,7 +63,7 @@ export interface IWorkspaceViewService {
/**
* Restart nodejs wiki and reload the view. Only works for main wiki.
*/
restartWorkspaceViewService(workspaceID?: string | undefined): Promise<void>;
restartWorkspaceViewService(workspaceID?: string): Promise<void>;
/**
* If is main workspace, set workspace to active and load the url.
* If is sub workspace, just load url with #tag for its main workspace.
@ -74,7 +74,7 @@ export interface IWorkspaceViewService {
setWorkspaceView(workspaceID: string, workspaceOptions: IWorkspace): Promise<void>;
setWorkspaceViews(workspaces: Record<string, IWorkspace>): Promise<void>;
/** get view's current url, store into the workspace. Can provide a designated view to operate */
updateLastUrl(workspaceID: string, view?: Electron.CrossProcessExports.WebContentsView | undefined): Promise<void>;
updateLastUrl(workspaceID: string, view?: Electron.CrossProcessExports.WebContentsView): Promise<void>;
wakeUpWorkspaceView(workspaceID: string): Promise<void>;
}
export const WorkspaceViewServiceIPCDescriptor = {

View file

@ -6,14 +6,16 @@ import getFromRenderer from '@services/libs/getFromRenderer';
import { i18n } from '@services/libs/i18n';
import { isBrowserWindow } from '@services/libs/isBrowserWindow';
import { logger } from '@services/libs/log';
import { IMenuService } from '@services/menu/interface';
import { INativeService } from '@services/native/interface';
import type { IMenuService } from '@services/menu/interface';
import type { INativeService } from '@services/native/interface';
import serviceIdentifier from '@services/serviceIdentifier';
import { IViewService } from '@services/view/interface';
import { IWikiService } from '@services/wiki/interface';
import { IWindowService } from '@services/windows/interface';
import { IBrowserViewMetaData, WindowNames } from '@services/windows/WindowProperties';
import { IWorkspaceService } from '@services/workspaces/interface';
import type { IViewService } from '@services/view/interface';
import type { IWikiService } from '@services/wiki/interface';
import type { IWindowService } from '@services/windows/interface';
import type { IBrowserViewMetaData } from '@services/windows/WindowProperties';
import { WindowNames } from '@services/windows/WindowProperties';
import type { IWorkspaceService } from '@services/workspaces/interface';
import { isWikiWorkspace } from '@services/workspaces/interface';
import { clipboard, dialog } from 'electron';
import { CancelError as DownloadCancelError, download } from 'electron-dl';
import { minify } from 'html-minifier-terser';
@ -33,7 +35,7 @@ export async function registerMenu(): Promise<void> {
{
label: () => i18n.t('Menu.DeveloperToolsActiveWorkspace'),
accelerator: 'CmdOrCtrl+Option+I',
click: async () => (await viewService.getActiveBrowserView())?.webContents?.openDevTools?.({ mode: 'detach' }),
click: async () => (await viewService.getActiveBrowserView())?.webContents.openDevTools({ mode: 'detach' }),
enabled: hasActiveWorkspaces,
},
]);
@ -45,25 +47,26 @@ export async function registerMenu(): Promise<void> {
const browserView = await viewService.getActiveBrowserView();
const win = windowService.get(WindowNames.main);
logger.info(
`print page, browserView printToPDF method is ${browserView?.webContents?.printToPDF === undefined ? 'undefined' : 'define'}, win is ${
`print page, browserView printToPDF method is ${browserView?.webContents.printToPDF === undefined ? 'undefined' : 'define'}, win is ${
win === undefined ? 'undefined' : 'define'
}`,
);
if (browserView === undefined || win === undefined) {
return;
}
const pdfBuffer = await browserView?.webContents?.printToPDF({
const pdfBuffer = await browserView.webContents.printToPDF({
generateTaggedPDF: true,
});
// turn buffer to data uri
const dataUri = `data:application/pdf;base64,${pdfBuffer?.toString('base64')}`;
const dataUri = `data:application/pdf;base64,${pdfBuffer.toString('base64')}`;
await download(win, dataUri, { filename: 'wiki.pdf', overwrite: false });
logger.info(`print page done`);
} catch (error) {
if (error instanceof DownloadCancelError) {
logger.debug('item.cancel() was called');
logger.debug('cancelled', { function: 'registerMenu.printPage' });
} else {
logger.error(`print page error: ${(error as Error).message}`, error);
const error_ = error instanceof Error ? error : new Error(String(error));
logger.error('print page error', { function: 'registerMenu.printPage', error: error_.message, errorObj: error_ });
}
}
},
@ -116,6 +119,10 @@ export async function registerMenu(): Promise<void> {
logger.error('Can not export whole wiki, activeWorkspace is undefined');
return;
}
if (!isWikiWorkspace(activeWorkspace)) {
logger.error('Can not export whole wiki, activeWorkspace is not a wiki workspace');
return;
}
const pathOfNewHTML = await nativeService.pickDirectory(DEFAULT_DOWNLOADS_PATH, {
allowOpenFile: true,
filters: [{ name: 'HTML', extensions: wikiHtmlExtensions }],
@ -145,7 +152,7 @@ export async function registerMenu(): Promise<void> {
}
}
const view = await viewService.getActiveBrowserView();
const url = view?.webContents?.getURL();
const url = view?.webContents.getURL();
if (typeof url === 'string') {
clipboard.writeText(url);
}