Rename BlockSettingPage to SettingPageFilter

Author: HashidaTKS

BrowserGuard.Tests/ConfigLoaderTests.cs

@@ -24,9 +24,9 @@ public void ParsesNestedFeatureGroups()
                 "Enabled": false,
                 "BlockedExtensions": [".exe", ".zip"]
               },
-              "BlockSettingPage": {
+              "SettingPageFilter": {
                 "Enabled": true,
-                "UrlPrefixes": ["edge://settings/", "edge://flags/"]
+                "BlockedPrefixes": ["edge://settings/", "edge://flags/"]
               }
             }
             """;
@@ -41,8 +41,8 @@ public void ParsesNestedFeatureGroups()
             Assert.False(config.UploadGuard.Enabled);
             Assert.Equal(new[] { ".exe", ".zip" }, config.UploadGuard.BlockedExtensions);
 
-            Assert.True(config.BlockSettingPage.Enabled);
-            Assert.Equal(new[] { "edge://settings/", "edge://flags/" }, config.BlockSettingPage.UrlPrefixes);
+            Assert.True(config.SettingPageFilter.Enabled);
+            Assert.Equal(new[] { "edge://settings/", "edge://flags/" }, config.SettingPageFilter.BlockedPrefixes);
         }
 
         [Fact]
@@ -94,8 +94,8 @@ public void OmittedGroupsFallBackToDefaults()
             // Groups that are absent keep their default values.
             Assert.False(config.UploadGuard.Enabled);
             Assert.Equal(new[] { ".exe", ".bat", ".cmd", ".js", ".vbs" }, config.UploadGuard.BlockedExtensions);
-            Assert.False(config.BlockSettingPage.Enabled);
-            Assert.Equal(new[] { "edge://settings/" }, config.BlockSettingPage.UrlPrefixes);
+            Assert.False(config.SettingPageFilter.Enabled);
+            Assert.Equal(new[] { "edge://settings/" }, config.SettingPageFilter.BlockedPrefixes);
         }
 
         [Fact]

BrowserGuard/ConfigLoader.cs

@@ -20,7 +20,7 @@ internal class Config
     {
         public NetLoggerConfig NetLogger { get; set; } = new();
         public UploadGuardConfig UploadGuard { get; set; } = new();
-        public BlockSettingPageConfig BlockSettingPage { get; set; } = new();
+        public SettingPageFilterConfig SettingPageFilter { get; set; } = new();
     }
 
     // Records each kind of operation to the configured endpoint.
@@ -61,10 +61,12 @@ internal class UploadGuardConfig
     }
 
     // Blocks navigation to the browser settings pages and similar URLs.
-    internal class BlockSettingPageConfig
+    internal class SettingPageFilterConfig
     {
         public bool Enabled { get; set; }
-        public string[] UrlPrefixes { get; set; } = ["edge://settings/"];
+
+        // Navigation is blocked when the URL starts with one of these.
+        public string[] BlockedPrefixes { get; set; } = ["edge://settings/"];
     }
 
     internal static class ConfigLoader

Resources/BrowserGuard.json

@@ -16,8 +16,8 @@
     "AllowedPaths": [],
     "BlockedPaths": []
   },
-  "BlockSettingPage": {
+  "SettingPageFilter": {
     "Enabled": false,
-    "UrlPrefixes": ["edge://settings/"]
+    "BlockedPrefixes": ["edge://settings/"]
   }
 }

webextensions/edge/background.js

@@ -5,13 +5,13 @@ import { StartupLauncher } from './startup-launcher.js';
 import { ScriptExecutor } from './script-executor.js';
 import { UploadFileBridge } from './upload-file-bridge.js';
 import { NetLogger } from './net-logger.js';
-import { BlockSettingPage } from './block-setting-page.js';
+import { SettingPageFilter } from './setting-page-filter.js';
 
 // The URL prefixes come from the config, so register without a filter and
 // decide inside the handler instead.
-BlockSettingPage.init();
+SettingPageFilter.init();
 chrome.webNavigation.onBeforeNavigate.addListener(
-  BlockSettingPage.onBeforeNavigate.bind(BlockSettingPage)
+  SettingPageFilter.onBeforeNavigate.bind(SettingPageFilter)
 );
 
 UploadGuard.init();

webextensions/edge/block-setting-page.js webextensions/edge/setting-page-filter.jswebextensions/edge/block-setting-page.js renamed to webextensions/edge/setting-page-filter.js

@@ -2,24 +2,28 @@
 
 import { loadConfig } from './config-loader.js';
 
-export const BlockSettingPage = {
+export const SettingPageFilter = {
   enabled: true,
-  urlPrefixes: ['edge://settings/'],
+  blockedPrefixes: ['edge://settings/'],
 
   async init() {
     const config = await loadConfig();
-    const blockSettingPage = config?.BlockSettingPage;
-    if (!blockSettingPage) return;
-    if (typeof blockSettingPage.Enabled === 'boolean') {
-      this.enabled = blockSettingPage.Enabled;
+    this.applyConfig(config?.SettingPageFilter);
+  },
+
+  // Separated from init so that it can be exercised without the browser.
+  applyConfig(settingPageFilter) {
+    if (!settingPageFilter) return;
+    if (typeof settingPageFilter.Enabled === 'boolean') {
+      this.enabled = settingPageFilter.Enabled;
     }
-    if (Array.isArray(blockSettingPage.UrlPrefixes)) {
-      this.urlPrefixes = blockSettingPage.UrlPrefixes;
+    if (Array.isArray(settingPageFilter.BlockedPrefixes)) {
+      this.blockedPrefixes = settingPageFilter.BlockedPrefixes;
     }
   },
 
   isBlockedUrl(url) {
-    return this.urlPrefixes.some(prefix => url.startsWith(prefix));
+    return this.blockedPrefixes.some(prefix => url.startsWith(prefix));
   },
 
   onBeforeNavigate(details) {