Merge pull request #48 from rolandbernard/devel

Improved refresh logic and increased version number
rolandbernard · Aug 16, 2021 · cb5314d · cb5314d
2 parents 4d575f1 + 407749d
commit cb5314d
Show file tree

Hide file tree

Showing 7 changed files with 69 additions and 25 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "marvin",
-    "version": "0.3.0",
+    "version": "0.4.0",
     "description": "This is a keystroke launcher for Linux",
     "repository": "https://github.com/rolandbernard/marvin/",
     "author": "Roland Bernard",

diff --git a/src/common/module.ts b/src/common/module.ts
@@ -11,6 +11,7 @@ export interface Module<ModuleResult extends Result> {
     deinit?: () => Promise<void>;
 
     search?: (query: Query) => Promise<ModuleResult[]>;
+    refresh?: () => Promise<unknown>;
     rebuild?: (query: Query, result: ModuleResult) => Promise<ModuleResult | undefined>;
     execute?: (result: ModuleResult) => Promise<void>;
     executeAny?: (result: Result) => Promise<void>;

diff --git a/src/main/executor.ts b/src/main/executor.ts
@@ -63,9 +63,9 @@ function filterAndSortQueryResults(results: Result[]): Result[] {
 
 export async function searchQuery(query: Query, callback?: (results: Result[]) => unknown): Promise<Result[]> {
     let results: Result[] = [];
-    const modules = findPossibleModules(query);
+    const possible_modules = findPossibleModules(query);
     await Promise.all(
-        modules.map(async id => {
+        possible_modules.map(async id => {
             const result = await searchQueryInModule(id, query);
             results.push(...result);
             if (callback) {
@@ -74,14 +74,15 @@ export async function searchQuery(query: Query, callback?: (results: Result[]) =
             }
         })
     );
+    possible_modules.map(id => modules[id].refresh?.().catch(() => { /* Ignore errors */ }));
     return filterAndSortQueryResults(results);
 }
 
 export async function executeResult(result: Result) {
+    await moduleForId(result.module)?.execute?.(result).catch(() => { /* Ignore errors */ });
     await Promise.all(
         Object.values(modules)
             .map(module => module.executeAny?.(result).catch(() => { /* Ignore errors */ }))
     );
-    await moduleForId(result.module)?.execute?.(result).catch(() => { /* Ignore errors */ });
 }
 
diff --git a/src/main/modules/applications.ts b/src/main/modules/applications.ts
@@ -48,7 +48,7 @@ ipcMain.on(IpcChannels.REFRESH_APPLICATIONS, () => {
 export class ApplicationsModule implements Module<ApplicationsResult> {
     readonly configs = ApplicationsConfig;
 
-    refresh?: NodeJS.Timer;
+    last_load?: number;
 
     get config() {
         return moduleConfig<ApplicationsConfig>(MODULE_ID);
@@ -60,20 +60,19 @@ export class ApplicationsModule implements Module<ApplicationsResult> {
 
     async init() {
         if (this.config.active) {
-            this.refreshApplications();
-            this.refresh = setInterval(() => {
-                this.refreshApplications();
-            }, this.config.refresh_interval_min);
+            this.refresh();
         }
     }
 
     async update() {
-        await this.deinit();
         await this.init();
     }
 
-    async deinit() {
-        clearInterval(this.refresh!);
+    async refresh() {
+        if (!this.last_load || (Date.now() - this.last_load) > this.config.refresh_interval_min) {
+            this.last_load = Date.now();
+            await this.refreshApplications();
+        }
     }
 
     forLanguage(names?: Record<string, string>): string | undefined {
@@ -115,7 +114,7 @@ export class ApplicationsModule implements Module<ApplicationsResult> {
             return [];
         }
     }
-
+    
     async rebuild(query: Query, result: ApplicationsResult): Promise<ApplicationsResult | undefined> {
         const application = (await getAllApplications()).find(app => app.id === result.app_id);
         return application && this.itemForApplication(query, application);

diff --git a/src/main/modules/bookmarks.ts b/src/main/modules/bookmarks.ts
@@ -4,6 +4,7 @@ import { Query } from 'common/query';
 import { SimpleResult } from 'common/result';
 import { Module } from 'common/module';
 import { getAllTranslations, getTranslation } from 'common/local/locale';
+import { time, TimeUnit } from 'common/time';
 
 import { module } from 'main/modules';
 import { config, moduleConfig } from 'main/config';
@@ -19,6 +20,9 @@ interface BookmarkResult extends SimpleResult {
 }
 
 class BookmarkConfig extends ModuleConfig {
+    @configKind('time')
+    refresh_interval_min = time(1, TimeUnit.SECOND);
+
     @configKind('quality')
     default_quality = 0;
 
@@ -45,12 +49,25 @@ export class BookmarkModule implements Module<BookmarkResult> {
     get config() {
         return moduleConfig<BookmarkConfig>(MODULE_ID);
     }
+
+    async init() {
+        if (this.config.active) {
+            this.refresh();
+        }
+    }
 
-    async search(query: Query): Promise<BookmarkResult[]> {
-        if (!this.last_load || (Date.now() - this.last_load) > 1000) {
-            updateBookmarkCache(this.config.chromium_directories, this.config.firefox_directories);
+    async update() {
+        await this.init();
+    }
+
+    async refresh() {
+        if (!this.last_load || (Date.now() - this.last_load) > this.config.refresh_interval_min) {
             this.last_load = Date.now();
+            await updateBookmarkCache(this.config.chromium_directories, this.config.firefox_directories);
         }
+    }
+
+    async search(query: Query): Promise<BookmarkResult[]> {
         if (query.text.length > 0) {
             const match = query.matchAny(getAllTranslations('bookmarks'), getTranslation('bookmarks', config));
             return (await getAllBookmarks()).map(bookmark => ({

diff --git a/src/main/modules/currency-converter.ts b/src/main/modules/currency-converter.ts
@@ -69,12 +69,22 @@ export class CurrencyConverterModule implements Module<SimpleResult> {
         return moduleConfig<CurrencyConfig>(MODULE_ID);
     }
 
-    async loadCurrencyRates() {
+    async init() {
+        if (this.config.active) {
+            this.refresh();
+        }
+    }
+
+    async update() {
+        await this.init();
+    }
+
+    async refresh() {
         if (!this.last_rate || !this.rates || Date.now() - this.last_rate > this.config.refresh_interval_min) {
+            this.last_rate = Date.now();
             const response = await fetch(`${API_ROOT}/latest`);
             const json = await response.json();
             this.rates = json.rates;
-            this.last_rate = Date.now();
         }
     }
 
@@ -97,7 +107,6 @@ export class CurrencyConverterModule implements Module<SimpleResult> {
     async itemForQuery(query: Query, text: string, raw?: string): Promise<SimpleResult | undefined> {
         const { value, from, to } = this.parseQuery(text);
         if (value !== undefined && from && to) {
-            await this.loadCurrencyRates();
             const round = Math.pow(10, this.config.round_to);
             const result = Math.round(value / this.rates![from] * this.rates![to] * round) / round;
             return {

diff --git a/src/main/modules/windows.ts b/src/main/modules/windows.ts
@@ -1,9 +1,10 @@
 
-import { ModuleConfig } from 'common/config';
+import { ModuleConfig, configKind } from 'common/config';
 import { Query } from 'common/query';
 import { SimpleResult } from 'common/result';
-import { Module } from 'common/module';
+import { time, TimeUnit } from 'common/time';
 
+import { Module } from 'common/module';
 import { moduleConfig } from 'main/config';
 import { module } from 'main/modules';
 import { focusWindow, openWindows, updateWindowCache, Window } from 'main/adapters/windows';
@@ -16,6 +17,9 @@ interface WindowsResult extends SimpleResult {
 }
 
 class WindowsConfig extends ModuleConfig {
+    @configKind('time')
+    refresh_interval_min = time(1, TimeUnit.SECOND);
+
     constructor() {
         super(true);
     }
@@ -29,6 +33,23 @@ export class WindowsModule implements Module<WindowsResult> {
 
     get config() {
         return moduleConfig<WindowsConfig>(MODULE_ID);
+    }   
+
+    async init() {
+        if (this.config.active) {
+            this.refresh();
+        }
+    }
+
+    async update() {
+        await this.init();
+    }
+
+    async refresh() {
+        if (!this.last_load || (Date.now() - this.last_load) > this.config.refresh_interval_min) {
+            this.last_load = Date.now();
+            await updateWindowCache();
+        }
     }
 
     itemForWindow(query: Query, window: Window): WindowsResult {
@@ -49,10 +70,6 @@ export class WindowsModule implements Module<WindowsResult> {
     }
 
     async search(query: Query): Promise<WindowsResult[]> {
-        if (!this.last_load || (Date.now() - this.last_load) > 1000) {
-            updateWindowCache();
-            this.last_load = Date.now();
-        }
         if (query.text.length > 0) {
             return (await openWindows()).map(window => this.itemForWindow(query, window));
         } else {