Support pattern for whitelist (#334)

package.json

@@ -1,6 +1,6 @@
 {
     "name": "timer",
-    "version": "2.5.6",
+    "version": "2.5.7",
     "description": "Time tracker",
     "homepage": "https://www.wfhg.cc",
     "scripts": {
@@ -82,4 +82,4 @@
     "engines": {
         "node": ">=20"
     }
-}
+}

src/background/index.ts

@@ -19,7 +19,7 @@ import initLimitProcessor from "./limit-processor"
 import MessageDispatcher from "./message-dispatcher"
 import initSidePanel from "./side-panel"
 import initTrackServer from "./timer/server"
-import VersionManager from "./version-manager"
+import VersionMigrator from "./migrator"
 import WhitelistMenuManager from "./whitelist-menu-manager"
 
 // Open the log of console
@@ -40,7 +40,7 @@ initCsHandler(messageDispatcher)
 initTrackServer(messageDispatcher)
 
 // Process version
-new VersionManager().init()
+new VersionMigrator().init()
 
 // Backup scheduler
 new BackupScheduler().init()

src/background/migrator/common.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) 2022 Hengyang Zhang
+ *
+ * This software is released under the MIT License.
+ * https://opensource.org/licenses/MIT
+ */
+
+/**
+ * Processor for version
+ *
+ * @since 0.1.2
+ */
+export interface Migrator {
+    onInstall(): void
+
+    onUpdate(version: string): void
+}

src/background/version-manager/0-1-2/host-merge-initializer.ts → src/background/migrator/host-merge-initializer.ts

@@ -6,6 +6,7 @@
  */
 
 import MergeRuleDatabase from "@db/merge-rule-database"
+import { Migrator } from "./common"
 
 const mergeRuleDatabase = new MergeRuleDatabase(chrome.storage.local)
 
@@ -14,13 +15,11 @@ const mergeRuleDatabase = new MergeRuleDatabase(chrome.storage.local)
  *
  * Initialize the merge rules
  */
-export default class HostMergeInitializer implements VersionProcessor {
-
-    since(): string {
-        return '0.1.2'
+export default class HostMergeInitializer implements Migrator {
+    onUpdate(_version: string): void {
     }
 
-    process(): void {
+    onInstall(): void {
         mergeRuleDatabase.add(
             // Google's regional hosts
             { origin: '*.google.com.*', merged: 'google.com' },

src/background/version-manager/index.ts → src/background/migrator/index.ts

@@ -1,40 +1,40 @@
 /**
  * Copyright (c) 2021 Hengyang Zhang
- * 
+ *
  * This software is released under the MIT License.
  * https://opensource.org/licenses/MIT
  */
 
 import { getVersion, onInstalled } from "@api/chrome/runtime"
-import HostMergeInitializer from "./0-1-2/host-merge-initializer"
-import LocalFileInitializer from "./0-7-0/local-file-initializer"
+import HostMergeInitializer from "./host-merge-initializer"
+import LocalFileInitializer from "./local-file-initializer"
+import { Migrator } from "./common"
+import WhitelistInitializer from "./whitelist-initializer"
 
 /**
  * Version manager
- *  
+ *
  * @since 0.1.2
  */
 class VersionManager {
-    processorChain: VersionProcessor[] = []
+    processorChain: Migrator[] = []
 
     constructor() {
         this.processorChain.push(
             new HostMergeInitializer(),
             new LocalFileInitializer(),
+            new WhitelistInitializer(),
         )
-        this.processorChain = this.processorChain.sort((a, b) => a.since() >= b.since() ? 1 : 0)
     }
 
     private onChromeInstalled(reason: ChromeOnInstalledReason) {
         const version: string = getVersion()
         if (reason === 'update') {
             // Update, process the latest version, which equals to current version
-            this.processorChain
-                .filter(processor => processor.since() === version)
-                .forEach(processor => processor.process(reason))
+            this.processorChain.forEach(processor => processor.onUpdate(version))
         } else if (reason === 'install') {
-            // All 
-            this.processorChain.forEach(processor => processor.process(reason))
+            // All
+            this.processorChain.forEach(processor => processor.onInstall())
         }
     }
 

src/background/version-manager/0-7-0/local-file-initializer.ts → src/background/migrator/local-file-initializer.ts

@@ -9,21 +9,20 @@ import MergeRuleDatabase from "@db/merge-rule-database"
 import { JSON_HOST, LOCAL_HOST_PATTERN, MERGED_HOST, PDF_HOST, PIC_HOST, TXT_HOST } from "@util/constant/remain-host"
 import { t2Chrome } from "@i18n/chrome/t"
 import siteService from "@service/site-service"
+import { Migrator } from "./common"
 
-const storage: chrome.storage.StorageArea = chrome.storage.local
-const mergeRuleDatabase = new MergeRuleDatabase(storage)
+const mergeRuleDatabase = new MergeRuleDatabase(chrome.storage.local)
 
 /**
  * Process the host of local files
- * 
+ *
  * @since 0.7.0
  */
-export default class LocalFileInitializer implements VersionProcessor {
-    since(): string {
-        return '0.7.0'
+export default class LocalFileInitializer implements Migrator {
+    onUpdate(_version: string): void {
     }
 
-    process(): void {
+    onInstall(): void {
         // Add merged rules
         mergeRuleDatabase.add({
             origin: LOCAL_HOST_PATTERN,

src/background/migrator/whitelist-initializer.ts

@@ -0,0 +1,12 @@
+import whitelistService from "@service/whitelist-service"
+import { Migrator } from "./common"
+
+export default class WhitelistInitializer implements Migrator {
+    onInstall(): void {
+        whitelistService.add('localhost:*')
+    }
+
+    onUpdate(version: string): void {
+        version === '2.5.7' && this.onInstall()
+    }
+}

src/util/pattern.ts

@@ -102,7 +102,7 @@ export function isValidVirtualHost(host: string) {
  * @returns T/F
  */
 export function judgeVirtualFast(host: string): boolean {
-    return host?.includes('/')
+    return host?.includes('/') || host?.includes('*')
 }
 
 export type HostInfo = {