self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2025-11-23 22:36:32 +02:00
Code Issues Releases Activity

Desktop: Resolves #11687: Plugins: Allow editor plugins to support multiple windows (#12041)

Browse Source
This commit is contained in:
Henry Heino
2025-06-06 02:00:47 -07:00
committed by GitHub
parent 291ba88224
commit 608dbab453
46 changed files with 1022 additions and 195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

95
packages/lib/services/plugins/EditorPluginHandler.ts
View File

@@ -12,32 +12,81 @@ import WebviewController from './WebviewController';
const logger = Logger.create('EditorPluginHandler');
const makeNoteUpdateAction = (pluginService: PluginService, shownEditorViewIds: string[]) => {
export interface UpdateEvent {
noteId: string;
newBody: string;
}
interface EmitActivationCheckOptions {
noteId: string;
parentWindowId: string;
}
interface SaveNoteEvent {
id: string;
body: string;
}
export type OnSaveNoteCallback = (updatedNote: SaveNoteEvent)=> void;
const makeNoteUpdateAction = (pluginService: PluginService, event: UpdateEvent, shownEditorViewIds: string[]) => {
return async () => {
for (const viewId of shownEditorViewIds) {
const controller = pluginService.viewControllerByViewId(viewId) as WebviewController;
if (controller) controller.emitUpdate();
if (controller) {
controller.emitUpdate({
noteId: event.noteId,
newBody: event.newBody,
});
}
}
};
};
export default class {
private pluginService_: PluginService;
private viewUpdateAsyncQueue_ = new AsyncActionQueue(100, IntervalType.Fixed);
private lastNoteState_: UpdateEvent|null = null;
private lastShownEditorViewIds_ = '';
private lastEditorPluginShown_: string|null = null;
public constructor(pluginService: PluginService) {
this.pluginService_ = pluginService;
public constructor(
private pluginService_: PluginService,
private onSaveNote_: OnSaveNoteCallback,
) {
}
public emitUpdate(shownEditorViewIds: string[]) {
logger.info('emitUpdate:', shownEditorViewIds);
this.viewUpdateAsyncQueue_.push(makeNoteUpdateAction(this.pluginService_, shownEditorViewIds));
public emitUpdate(event: UpdateEvent, shownEditorViewIds: string[]) {
if (shownEditorViewIds.length === 0) return;
const isEventDifferentFrom = (other: UpdateEvent|null) => {
if (!other) return true;
return event.noteId !== other.noteId || event.newBody !== other.newBody;
};
const shownEditorViewIdsString = shownEditorViewIds.join(',');
const differentEditorViewsShown = shownEditorViewIdsString !== this.lastShownEditorViewIds_;
// lastNoteState_ often contains the last change saved by the editor. As a result,
// if `event` matches `lastNoteState_`, the event was probably caused by the last save.
// In this case, avoid sending an update event (which plugins often interpret as refreshing
// the editor):
const isDifferentFromSave = isEventDifferentFrom(this.lastNoteState_);
if (isDifferentFromSave || differentEditorViewsShown) {
logger.info('emitUpdate:', shownEditorViewIds);
this.viewUpdateAsyncQueue_.push(makeNoteUpdateAction(this.pluginService_, event, shownEditorViewIds));
this.lastNoteState_ = { ...event };
this.lastShownEditorViewIds_ = shownEditorViewIdsString;
}
}
public async emitActivationCheck() {
public async emitActivationCheck({ noteId, parentWindowId }: EmitActivationCheckOptions) {
let filterObject: EditorActivationCheckFilterObject = {
activatedEditors: [],
effectiveNoteId: noteId,
windowId: parentWindowId,
};
filterObject = await eventManager.filterEmit('editorActivationCheck', filterObject);
@@ -45,8 +94,34 @@ export default class {
for (const editor of filterObject.activatedEditors) {
const controller = this.pluginService_.pluginById(editor.pluginId).viewController(editor.viewId) as WebviewController;
controller.setActive(editor.isActive);
if (controller.parentWindowId === parentWindowId) {
controller.setActive(editor.isActive);
}
}
}
public onEditorPluginShown(editorViewId: string) {
// Don't double-register callbacks
if (editorViewId === this.lastEditorPluginShown_) {
return;
}
this.lastEditorPluginShown_ = editorViewId;
const controller = this.pluginService_.viewControllerByViewId(editorViewId) as WebviewController;
controller?.onNoteSaveRequested(event => {
this.scheduleSaveNote_(event.noteId, event.body);
});
}
private scheduleSaveNote_(noteId: string, noteBody: string) {
this.lastNoteState_ = {
noteId,
newBody: noteBody,
};
return this.onSaveNote_({
id: noteId,
body: noteBody,
});
}
}