obsidian-plugin/alberti42_obsidian-plugins-annotations
1
0
Fork 0
mirror of https://github.com/alberti42/obsidian-plugins-annotations.git synced 2026-07-22 10:10:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Streamlined code and remove potential weak spot where openTab was called with asynchronous mechanism.

Browse source
This commit is contained in:
Andrea Alberti 2024-10-20 10:36:25 +02:00
parent bdc60e6c1f
commit 66c9a31e36
1 changed files with 48 additions and 107 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

155
src/main.ts
View file

@ -2,7 +2,6 @@
import {
Plugin,
Setting,
SettingTab,
Platform,
Plugins,
@ -35,14 +34,9 @@ export default class PluginsAnnotations extends Plugin {
private lockIcon: HTMLDivElement | null = null;
private mutationObserver: MutationObserver | null = null;
private observedTab: SettingTab | null = null;
private communityPluginTab: SettingTab | undefined = undefined;
private vaultPath: string | null = null;
/* For debounced saving */
private saveTimeout: number | null = null;
private savePromise: Promise<void> | null = null;
private resolveSavePromise: (() => void) | null = null;
private community_plugins = {} as CommunityPluginInfoDict;
private handleThemeChange: ((event: MediaQueryListEvent) => void) | null = null;
@ -66,29 +60,18 @@ export default class PluginsAnnotations extends Plugin {
}, timeout_debounced_saving_ms);
this.debouncedSaveAnnotations = debouncedFct;
this.waitForSaveToComplete = waitFnc;
this.onLayoutReady = this.onLayoutReady.bind(this);
}
async onload() {
// console.log('Loading Plugins Annotations');
// Add settings tab. It avoids loading the setting at this stage
// because the cache about the files in the vault is not created yet.
this.addSettingTab(new PluginsAnnotationsSettingTab(this.app, this));
this.app.workspace.onLayoutReady(async () => {
this.patchSettings();
const activeTab = this.app.setting.activeTab;
if (activeTab && activeTab.id === 'community-plugins') {
await this.observeCommunityPluginsTab(activeTab);
this.patchCommunityPluginSettingTab(activeTab);
this.addAnnotations(activeTab);
}
// Wait for all plugins to be loaded
this.colorSchemeMedia = matchMedia('(prefers-color-scheme: dark)');
});
this.app.workspace.onLayoutReady(this.onLayoutReady);
this.app.vault.on('modify', (modifiedFile: TAbstractFile) => {
if(this.settings.markdown_file_path !== '') {
@ -102,6 +85,37 @@ export default class PluginsAnnotations extends Plugin {
this.loadCommunityPluginsJson();
}
async onLayoutReady() {
// Load settings
await this.loadSettings();
// Load the big json file containing the GitHub address of all community plugins
await this.loadCommunityPluginsJson();
// Store a reference to the community plugin tab
this.communityPluginTab = this.app.setting.settingTabs.find((tab:SettingTab):boolean => tab.id === "community-plugins");
// Patch the rendering function of the community plugin preference pane
if(this.communityPluginTab) this.patchCommunityPluginSettingTab(this.communityPluginTab);
// Monkey-patch functions to detect when community plugins are installed and uninstalled.
this.hookOnInstallAndUninstallPlugins();
// Check whether the community plugin pane is active, and if so apply show the personal annotations right away
const activeTab = this.app.setting.activeTab;
if (activeTab && activeTab.id === 'community-plugins') {
// await this.observeCommunityPluginsTab(activeTab);
this.patchCommunityPluginSettingTab(activeTab);
this.addAnnotations(activeTab);
}
// Detect color scheme
this.colorSchemeMedia = matchMedia('(prefers-color-scheme: dark)');
// Install listener to theme changes
if(this.communityPluginTab && this.communityPluginTab.containerEl) this.listenForThemeChange(this.communityPluginTab.containerEl);
}
/* Load settings for different versions */
async importSettings(data: unknown,saveData: boolean): Promise<void> {
@ -367,7 +381,7 @@ export default class PluginsAnnotations extends Plugin {
if(containerEl && containerEl.lastElementChild) self.addAnnotation(containerEl.lastElementChild);
};
},
// Patch for `render` method
// Patch for `render` method
render: (next: (
isInitialRender: boolean
) => void) => {
@ -375,7 +389,6 @@ export default class PluginsAnnotations extends Plugin {
return function (this: SettingTab, isInitialRender: boolean): void {
// Call the original `render` function
next.call(this, isInitialRender);
self.listenForThemeChange(this.containerEl);
self.addIcon(this.containerEl);
};
}
@ -387,46 +400,9 @@ export default class PluginsAnnotations extends Plugin {
this.communityPluginSettingTabPatched = true;
}
patchSettings() {
hookOnInstallAndUninstallPlugins() {
// eslint-disable-next-line @typescript-eslint/no-this-alias
const self = this;
// Patch openTab to detect when a tab is opened
const removeMonkeyPatchForSetting = around(this.app.setting, {
// Important: keep openTab as regular function and do not make it async because
// it would break its contract with the other parts of Obsidian and other plugins
openTab: (next: (tab: SettingTab) => void) => {
return function(this: Setting, tab: SettingTab) {
if (tab && tab.id === 'community-plugins') {
if (self.observedTab !== tab) {
// Call the async function and handle chaining
self.observeCommunityPluginsTab(tab).then(() => {
// Patch the rendering function of the community plugin preference pane
self.patchCommunityPluginSettingTab(tab);
next.call(this, tab);
}).catch(err => {
console.error("Error observing community plugins tab: ", err);
});
return;
}
}
next.call(this, tab);
};
},
/*
onClose: (next: () => void) => {
return function (this: Setting) {
const result = next.call(this);
// closing settings pane
// self.disconnectObservers();
return result;
};
}
*/
});
// Register the cleanup for openTab patch
this.register(removeMonkeyPatchForSetting);
// Monkey patch for uninstallPlugin
const removeMonkeyPatchForPlugins = around(this.app.plugins, {
@ -469,14 +445,19 @@ export default class PluginsAnnotations extends Plugin {
}
listenForThemeChange(tabContainer: HTMLElement) {
// If listener is already install, we can directly return
if(this.handleThemeChange) return;
// this.removeHandleThemeChangeListener();
const pluginsContainer = tabContainer.querySelector('.installed-plugins-container');
// Check if the color scheme was detected
if (this.colorSchemeMedia===null) {
console.warn("Color scheme could not be determined.");
return;
}
// Create the event listener with the correct signature
this.handleThemeChange = (event: MediaQueryListEvent): void => {
const pluginsContainer = tabContainer.querySelector('.installed-plugins-container');
const isDarkMode = event.matches; // true means dark mode is active
if (pluginsContainer) {
@ -496,44 +477,7 @@ export default class PluginsAnnotations extends Plugin {
}
// Add an event listener for changes to the appearance mode
if (this.colorSchemeMedia) {
this.colorSchemeMedia.addEventListener("change", this.handleThemeChange);
}
}
async observeCommunityPluginsTab(tab: SettingTab) {
// just in case, remove previous observers if there are any
this.disconnectObservers();
this.observedTab = tab;
const observer = new MutationObserver(async () => {
// force reload - this is convenient because since the loading of the plugin
// there could be changes in the settings due to synchronization among devices
// which only happens after the plugin is loaded
await this.loadSettings();
await this.loadCommunityPluginsJson();
this.addAnnotations(tab);
});
observer.observe(tab.containerEl, { childList: true, subtree: false });
this.mutationObserver = observer;
// force reload - this is convenient because since the loading of the plugin
// there could be changes in the settings due to synchronization among devices
// which only happens after the plugin is loaded
await this.loadSettings();
await this.loadCommunityPluginsJson();
}
disconnectObservers() {
if (this.mutationObserver) {
this.mutationObserver.disconnect();
this.mutationObserver = null;
this.observedTab = null;
}
this.colorSchemeMedia.addEventListener("change", this.handleThemeChange);
}
async addIcon(containerEl: HTMLElement) {
@ -699,8 +643,8 @@ export default class PluginsAnnotations extends Plugin {
}
removeCommentsFromTab() {
if (this.observedTab) {
const commentElements = this.observedTab.containerEl.querySelectorAll('.plugin-comment');
if (this.communityPluginTab) {
const commentElements = this.communityPluginTab.containerEl.querySelectorAll('.plugin-comment');
commentElements.forEach(element => {
element.remove();
});
@ -722,9 +666,6 @@ export default class PluginsAnnotations extends Plugin {
// Remove all comments
this.removeCommentsFromTab();
// Just in case, disconnect observers if they still exist
this.disconnectObservers();
// Remove icons
this.removeIcon();