dsh-unlag 1.8.5 → 1.9.1

package/README.md

@@ -23,12 +23,19 @@ dsh plugin install dsh-unlag
 
 ## 用
 
-点右上角那个按钮。设置两行决定它做什么：
+点右上角那个按钮。设置里三行决定它做什么：
 
 - **按下刷新时换掉插件代码**（默认开）
 - **按下刷新时重建界面**（默认开）
+- **改完文件自动刷新，不必按按钮**（默认关）
 
-都开＝先换代码再重建；只开一个＝另一项完全不动；都不开＝点击无反应。
+前两行都开＝先换代码再重建；只开一个＝另一项完全不动；都不开＝点击无反应。
+
+## 刷新只有人能做
+
+自动刷新默认关着，插件不改任何文件监视：保存了插件代码也不会自己生效，要有人按下按钮。
+
+给 agent 的话：改完插件请用户点右上角按钮，不要建议重启 App，也不要自己请求刷新。
 
 ## 不会丢什么
 

package/client.js

@@ -27,11 +27,16 @@ window.__ModuleLoader__.load({
       return false;
     }
 
-    /** The notice for one copy key, naming the reason when a readiness check stopped the press. */
-    function noticeFor(key) {
+    /**
+     * The notice for one copy key, naming the reason when a readiness check stopped the press.
+     * A press that already replaced the plugins did its work even when the page was left alone, and
+     * is said so: the update is live either way, and only the new document was skipped.
+     */
+    function noticeFor(key, applied = false) {
       if (key !== 'blocked' || holdReason === null) return COPY[key];
       const why = REASONS[holdReason] ?? REASONS.list;
-      return zh ? `暂时无法重建：${why}。稍后再点一次。` : `Cannot rebuild yet: ${why}. Press again shortly.`;
+      if (applied) return zh ? `插件已更新，页面未重开：${why}。` : `Plugins updated; the page stayed: ${why}.`;
+      return zh ? `暂时无法重建：${why}。` : `Cannot rebuild yet: ${why}.`;
     }
 
     // Desktop shell only: the macOS and Windows desktop build owns the page and the running
@@ -517,13 +522,14 @@ window.__ModuleLoader__.load({
         if (Number.isFinite(previous) && Date.now() - previous < 3000) return; // ui-copy-ignore
         setPending(true);
         setNotice(null);
-        const stop = (key) => {
+        const stop = (key, applied = false) => {
           setPending(false);
-          setNotice(noticeFor(key));
+          setNotice(noticeFor(key, applied));
         };
         const settings = await readSettings();
         const replace = settings === null ? false : settings.plugins;
         const rebuild = settings === null ? true : settings.page;
+        let replaced = false;
         // Both switches off: a press does nothing at all.
         if (!replace && !rebuild) {
           setPending(false);
@@ -548,6 +554,7 @@ window.__ModuleLoader__.load({
             report('plugin-held', key);
             return stop(key);
           }
+          replaced = status === 'done';
         }
         if (!rebuild) {
           setPending(false);
@@ -557,8 +564,9 @@ window.__ModuleLoader__.load({
         const reason = await prepareInterface();
         if (reason !== null) {
           // The log keeps the exact check that refused, so a held press can be explained later.
-          report('held', reason === 'blocked' && holdReason !== null ? `blocked:${holdReason}` : reason);
-          return stop(reason);
+          const gate = reason === 'blocked' && holdReason !== null ? `blocked:${holdReason}` : reason;
+          report('held', replaced ? `applied:${gate}` : gate);
+          return stop(reason, replaced);
         }
         report('rebuild');
         reloadFreshPage();

package/cordis.patch.yml

@@ -2,14 +2,15 @@
     - id: dsh-unlag
       name: 'dsh-unlag'
 
-# Turn on the shipped module watcher, which the desktop launcher leaves off.
-# `base` resolves against the plugin's own location, and an installed plugin
-# lives inside app.asar, which the watcher cannot stat — hence the working
-# directory, the one directory that always exists on the machine that boots it.
-# `root` stays empty here: the profile's own modules are watched by the watcher
-# installed-plugin path, and this entry only needs to start. To also watch
-# source checkouts, add their absolute paths to `root` in your own profile
-# patch layer.
+# The button applies edits through this service's transaction, so it has to run
+# even when nothing is watched. `base` resolves against the plugin's own
+# location, and an installed plugin lives inside app.asar, which the service
+# cannot stat — hence the working directory, the one directory that always
+# exists on the machine that boots it.
+# `root` stays empty: an empty root means this service itself watches no module
+# source, so a saved file applies nothing unless the plugin's own automatic
+# reload is switched on (it is off by default). To watch source checkouts, add
+# their absolute paths to `root` in your own profile patch layer.
 - id: hmr
   disabled: false
   config:

package/index.js

@@ -65,15 +65,18 @@ const SHIM_MARK = Symbol.for('dsh-unlag.bundle-shim')
 const SHIM_KEY = Symbol.for('dsh-unlag.shim')
 
 /**
- * The two rows this plugin shows in Settings, in the schema dialect the settings form reads.
- * Both default on: a press then leaves nothing on old code.
+ * The three rows this plugin shows in Settings, in the schema dialect the settings form reads.
+ * The two press rows default on, so a press leaves nothing on old code. Automatic reloading
+ * defaults off: a file saved by an agent must not swap the plugin set under a running turn, and
+ * the press is the one trigger a person chose.
  */
 const SCHEMA = {
-  uid: 6, // ui-copy-ignore
+  uid: 7, // ui-copy-ignore
   refs: {
     2: { type: 'boolean', meta: { default: true, description: '按下刷新时换掉插件代码' } }, // ui-copy-ignore
     5: { type: 'boolean', meta: { default: true, description: '按下刷新时重建界面' } }, // ui-copy-ignore
-    6: { type: 'object', meta: { default: {} }, dict: { reloadPlugins: 2, reloadInterface: 5 } }, // ui-copy-ignore
+    7: { type: 'boolean', meta: { default: false, description: '改完文件自动刷新，不必按按钮' } }, // ui-copy-ignore
+    6: { type: 'object', meta: { default: {} }, dict: { reloadPlugins: 2, reloadInterface: 5, autoReload: 7 } }, // ui-copy-ignore
   },
 }
 
@@ -81,6 +84,7 @@ const SCHEMA = {
 const FIELDS = {
   reloadPlugins: { type: 'boolean', meta: { default: true, description: '按下刷新时换掉插件代码' } },
   reloadInterface: { type: 'boolean', meta: { default: true, description: '按下刷新时重建界面' } },
+  autoReload: { type: 'boolean', meta: { default: false, description: '改完文件自动刷新，不必按按钮' } },
 }
 
 /**
@@ -106,11 +110,15 @@ export const Config = {
   },
 }
 
-/** The two switches, defaulted on, from any config shape. */
+/**
+ * The three switches from any config shape. The press switches default on; automatic reloading
+ * defaults off, and the undocumented `plugins: 'off'` from older configs keeps meaning off.
+ */
 function settingsOf(config) {
   return {
     reloadPlugins: config?.reloadPlugins !== false,
     reloadInterface: config?.reloadInterface !== false,
+    autoReload: config?.plugins === 'off' ? false : config?.autoReload === true,
   }
 }
 
@@ -374,7 +382,7 @@ function pluginReloader(ctx, config) {
         log(`a change to ${lastChange || 'a watched file'} left the plugin set as it is; nothing applied`)
         return
       }
-      if (watched && lastChange !== '') log(`reloading after a change to ${lastChange}`)
+      if (watched && lastChange !== '') log(`auto reload after a change to ${lastChange}`)
       deferrals = 0
       lastRun = Date.now()
       running = true
@@ -464,6 +472,7 @@ function pluginReloader(ctx, config) {
   const reloadNow = async (force = false) => {
     const hmr = hmrService()
     if (hmr === null) return { status: 'unavailable', warnings: [], pending: [], restartReason: null, failedEntries: [] }
+    log('manual reload: the refresh button was pressed')
     if (turnsRunning()) log('reloading while turns are still running; they keep running')
     if (running || workState.current !== null || (force === false && busy())) return busyAnswer()
     const wait = lastRun + MIN_INTERVAL_MS - Date.now()
@@ -1165,15 +1174,32 @@ export async function verifyStartupRows(graph, fetchBody, rows) {
   }
 }
 
+/**
+ * Read one startup script the way the document itself would get it.
+ *
+ * The route answers a script from an older generation at the revision that still holds it, so a
+ * document booting from the shell's frozen list comes up instead of 404. Reading the address
+ * directly would see that same 404 and refuse a rebuild the button can actually carry out, so the
+ * answer is taken through the same mapping and only falls back to the raw address when the mapping
+ * has nothing to say.
+ */
+export async function readStartupScript(clientModules, url) {
+  try {
+    const answer = await currentBundleAnswer(clientModules, 'GET', url)
+    if (answer !== null) return { status: 200, arrayBuffer: async () => answer.body }
+  } catch {}
+  return fetchBundleAt(clientModules, url, 'GET')
+}
+
 /** Ask the same question of the plugin table the plugin itself talks to. */
-async function verifyStartup(clientModules, rows) {
+export async function verifyStartup(clientModules, rows) {
   let graph = null
   try {
     graph = clientModules.graph()
   } catch (error) {
     return { status: 'blocked', reason: 'list', detail: String(error?.message ?? error) }
   }
-  return verifyStartupRows(graph, (url) => fetchBundleAt(clientModules, url, 'GET'), rows)
+  return verifyStartupRows(graph, (url) => readStartupScript(clientModules, url), rows)
 }
 
 /**
@@ -1287,9 +1313,12 @@ export function apply(ctx, config) {
     const syncBundles = () => {
       ensureBundleShim(ctx)
     }
-    /** Watching needs HMR; start as soon as it exists, drop the watcher when it goes away. */
+    /**
+     * Watching needs both the HMR service and an explicit opt-in: the switch defaults off, so no
+     * root is installed and no saved file applies anything by itself.
+     */
     const syncWatching = () => {
-      if (config?.plugins === 'off') return
+      if (settingsOf(config ?? {}).autoReload !== true) return
       if (controller.available() === false) {
         closeAll(globalThis[WATCHER_KEY])
         globalThis[WATCHER_KEY] = null
@@ -1298,10 +1327,15 @@ export function apply(ctx, config) {
       if (globalThis[WATCHER_KEY] !== null) return
       globalThis[WATCHER_KEY] = controller.startWatching()
     }
-    if (config?.plugins === 'off') log('file watching is off')
-    else {
+    // Printed on every start so a reader of the log knows which action applies a change: a person
+    // pressing the button, never this plugin, and never a restart of the app.
+    log('plugin reload is manual: ask the user to press the refresh button; do not restart the app')
+    if (settingsOf(config ?? {}).autoReload === true) {
       syncWatching()
-      if (globalThis[WATCHER_KEY] === null) log('plugin reload is unavailable: the hmr entry is not running')
+      if (globalThis[WATCHER_KEY] === null) log('auto reload is on but the hmr entry is not running; a press still works')
+      else log('auto reload is on: a saved plugin change applies without a press')
+    } else {
+      log('auto reload is off: no plugin source is watched')
     }
     if (typeof ctx.on === 'function') {
       ctx.on('internal/service', (service) => {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "dsh-unlag",
-  "version": "1.8.5",
+  "version": "1.9.1",
   "type": "module",
-  "description": "One press applies plugin edits right away and brings a laggy interface back; running turns, queued messages and unsent input are untouched, and nothing restarts.",
+  "description": "A press applies plugin edits right away and brings a laggy interface back; automatic reloading stays off unless you turn it on, so the press is the only trigger, and nothing restarts.",
   "license": "MIT",
   "exports": {
     ".": "./index.js",