Restore default rules at startup, even for Pro users

Previously, if Pro users had removed default rules, they were removed
entirely until the rules were reset, which could be confusing, or
problematic when new default rules are added (e.g. the new websocket
passthrough rule - without recreating this, Pro user's websockets would
all break).

Now, we recreate/reset the default group if it's not present at startup
or has been modified/doesn't match the default somehow.

Author: pimterry

src/model/rules/rule-creation.ts

@@ -131,71 +131,78 @@ export function buildRuleFromExchange(exchange: HttpExchange): HtkMockRule {
     };
 }
 
-export const buildDefaultGroup = (items: HtkMockItem[]): HtkMockRuleGroup => ({
+export const buildDefaultGroupWrapper = (items: HtkMockItem[]): HtkMockRuleGroup => ({
     id: 'default-group',
     title: "Default rules",
     collapsed: true,
     items: items
-})
+});
+
+export const buildDefaultGroupRules = (
+    rulesStore: RulesStore,
+    proxyStore: ProxyStore
+): HtkMockItem[] => [
+    // Respond to amiusing.httptoolkit.tech with an emphatic YES
+    {
+        id: 'default-amiusing',
+        type: 'http',
+        activated: true,
+        matchers: [
+            new HttpRule.MethodMatchers.GET(),
+            new HttpRule.AmIUsingMatcher()
+        ],
+        completionChecker: new completionCheckers.Always(),
+        handler: new HttpRule.StaticResponseHandler(200, undefined, amIUsingHtml, {
+            'content-type': 'text/html',
+            'cache-control': 'no-store',
+            'httptoolkit-active': 'true'
+        })
+    },
+
+    // Share the server certificate on a convenient URL, assuming it supports that
+    ...(versionSatisfies(proxyStore.serverVersion, FROM_FILE_HANDLER_SERVER_RANGE)
+        ? [{
+            id: 'default-certificate',
+            type: 'http' as 'http',
+            activated: true,
+            matchers: [
+                new HttpRule.MethodMatchers.GET(),
+                new matchers.SimplePathMatcher("amiusing.httptoolkit.tech/certificate")
+            ],
+            completionChecker: new completionCheckers.Always(),
+            handler: new HttpRule.FromFileResponseHandler(200, undefined, proxyStore.certPath, {
+                'content-type': 'application/x-x509-ca-cert'
+            })
+        }] : []
+    ),
+
+    // Pass through all other traffic to the real target
+    {
+        id: 'default-wildcard',
+        type: 'http',
+        activated: true,
+        matchers: [new HttpRule.DefaultWildcardMatcher()],
+        completionChecker: new completionCheckers.Always(),
+        handler: new HttpRule.PassThroughHandler(rulesStore)
+    },
+    {
+        id: 'default-ws-wildcard',
+        type: 'websocket',
+        activated: true,
+        matchers: [new DefaultWebSocketWildcardMatcher()],
+        completionChecker: new completionCheckers.Always(),
+        handler: new WebSocketPassThroughHandler(rulesStore)
+    }
+];
 
-export const buildDefaultRules = (rulesStore: RulesStore, proxyStore: ProxyStore) => ({
+export const buildDefaultRulesRoot = (rulesStore: RulesStore, proxyStore: ProxyStore) => ({
     id: 'root',
     title: "HTTP Toolkit Rules",
     isRoot: true,
     items: [
-        buildDefaultGroup([
-            // Respond to amiusing.httptoolkit.tech with an emphatic YES
-            {
-                id: 'default-amiusing',
-                type: 'http',
-                activated: true,
-                matchers: [
-                    new HttpRule.MethodMatchers.GET(),
-                    new HttpRule.AmIUsingMatcher()
-                ],
-                completionChecker: new completionCheckers.Always(),
-                handler: new HttpRule.StaticResponseHandler(200, undefined, amIUsingHtml, {
-                    'content-type': 'text/html',
-                    'cache-control': 'no-store',
-                    'httptoolkit-active': 'true'
-                })
-            },
-
-            // Share the server certificate on a convenient URL, assuming it supports that
-            ...(versionSatisfies(proxyStore.serverVersion, FROM_FILE_HANDLER_SERVER_RANGE)
-                ? [{
-                    id: 'default-certificate',
-                    type: 'http' as 'http',
-                    activated: true,
-                    matchers: [
-                        new HttpRule.MethodMatchers.GET(),
-                        new matchers.SimplePathMatcher("amiusing.httptoolkit.tech/certificate")
-                    ],
-                    completionChecker: new completionCheckers.Always(),
-                    handler: new HttpRule.FromFileResponseHandler(200, undefined, proxyStore.certPath, {
-                        'content-type': 'application/x-x509-ca-cert'
-                    })
-                }] : []
-            ),
-
-            // Pass through all other traffic to the real target
-            {
-                id: 'default-wildcard',
-                type: 'http',
-                activated: true,
-                matchers: [new HttpRule.DefaultWildcardMatcher()],
-                completionChecker: new completionCheckers.Always(),
-                handler: new HttpRule.PassThroughHandler(rulesStore)
-            },
-            {
-                id: 'default-ws-wildcard',
-                type: 'websocket',
-                activated: true,
-                matchers: [new DefaultWebSocketWildcardMatcher()],
-                completionChecker: new completionCheckers.Always(),
-                handler: new WebSocketPassThroughHandler(rulesStore)
-            }
-        ])
+        buildDefaultGroupWrapper(
+            buildDefaultGroupRules(rulesStore, proxyStore)
+        )
     ]
 } as HtkMockRuleRoot);
 

src/model/rules/rule-migrations.ts

@@ -2,7 +2,7 @@ import * as _ from 'lodash';
 import * as dedent from 'dedent';
 
 import { isRuleGroup } from './rules-structure';
-import { buildDefaultGroup } from './rule-creation';
+import { buildDefaultGroupWrapper } from './rule-creation';
 
 // Take some raw serialized rule data, exported from any version of the app since HTTP Mock was
 // launched, and convert it into raw modern rule data, ready to be deserialized.
@@ -22,7 +22,7 @@ export function migrateRuleData(data: any) {
             if (defaultRules.length) {
                 data.items = [
                     ...otherRules,
-                    buildDefaultGroup(defaultRules)
+                    buildDefaultGroupWrapper(defaultRules)
                 ];
             } else {
                 data.items = otherRules;

src/model/rules/rules-store.ts

@@ -59,8 +59,9 @@ import {
     areItemsEqual,
 } from './rules-structure';
 import {
-    buildDefaultGroup,
-    buildDefaultRules,
+    buildDefaultGroupRules,
+    buildDefaultGroupWrapper,
+    buildDefaultRulesRoot,
     buildForwardingRuleIntegration,
 } from './rule-creation';
 import {
@@ -214,6 +215,10 @@ export class RulesStore {
             } else {
                 // Drafts are never persisted, so always need resetting to match the just-loaded data:
                 this.resetRuleDrafts();
+
+                // Recreate default rules on startup, even if we're restoring persisted rules
+                const defaultRules = buildDefaultGroupRules(this, this.proxyStore);
+                defaultRules.forEach(r => this.ensureRuleExists(r));
             }
         } else {
             // For free users, reset rules to default (separately, so defaults can use settings loaded above)
@@ -371,7 +376,7 @@ export class RulesStore {
     @action.bound
     resetRulesToDefault() {
         // Set the rules back to the default settings
-        this.rules = buildDefaultRules(this, this.proxyStore);
+        this.rules = buildDefaultRulesRoot(this, this.proxyStore);
         this.resetRuleDrafts();
     }
 
@@ -382,7 +387,7 @@ export class RulesStore {
 
     @computed
     get areSomeRulesNonDefault() {
-        const defaultRules = buildDefaultRules(this, this.proxyStore);
+        const defaultRules = buildDefaultRulesRoot(this, this.proxyStore);
         return !_.isEqualWith(this.draftRules, defaultRules, areItemsEqual);
     }
 
@@ -686,7 +691,7 @@ export class RulesStore {
         let draftDefaultGroupPath = findItemPath(this.draftRules, { id: 'default-group' });
         if (!draftDefaultGroupPath) {
             // If there's no draft default rules at all, build one
-            this.draftRules.items.push(buildDefaultGroup([rule]));
+            this.draftRules.items.push(buildDefaultGroupWrapper([rule]));
             draftDefaultGroupPath = [this.draftRules.items.length - 1];
         } else {
             const draftDefaultGroup = getItemAtPath(this.draftRules, draftDefaultGroupPath) as HtkMockRuleGroup;