latex-stickies 1.3.6 → 1.3.7

package/README.md

@@ -146,6 +146,7 @@ npm test         # unit suites
 npm run vendor   # rebuild the bundled libraries
 npm run icon     # rebuild the app icon from assets/icon-master.png
 npm run demo     # re-record assets/demo.gif from the real app (needs ffmpeg)
+npm run verify   # install the packed tarball and check what a user gets
 npm run dist     # build a macOS .app and .dmg
 ```
 
@@ -158,6 +159,7 @@ node scripts/smoke.js --lifecycle # closing every note behaves per platform
 node scripts/render-check.js      # the first-run note renders correctly
 node scripts/ghost-check.js       # autocomplete suggests, and Tab accepts
 node scripts/snapshot-check.js    # a long note is captured whole
+node scripts/verify-install.js    # the install path, end to end (macOS)
 ```
 
 The renderer loads over `file://` under a strict content-security policy, so

package/bin/latex-stickies.js

@@ -10,8 +10,29 @@
 const { spawn } = require('child_process');
 const path = require('path');
 
+// Name the Electron shell before resolving it, not only at install time.
+//
+// postinstall scripts are increasingly blocked -- npm warns about them by
+// default now, and plenty of people and companies set ignore-scripts -- and a
+// user who installs with them off gets "Electron" in their Dock. Doing it here
+// as well means the name is right by the time macOS reads the bundle, whatever
+// happened during the install. It returns immediately once done.
+//
+// Strictly before require('electron'): branding renames the executable and
+// rewrites the path.txt that require reads, so a path captured first points at
+// a file that no longer exists and the launch fails with ENOENT. That cost a
+// release -- every first launch after upgrading failed, and only the second
+// worked.
+try {
+  require('../scripts/brand-electron.js');
+} catch (_) { /* cosmetic: never block a launch over the name */ }
+
 let electron;
 try {
+  // Branding resolved the electron module itself, so it is already in Node's
+  // module cache holding the path from before the rename. Drop it and read it
+  // again, or the launch spawns a file that no longer exists.
+  delete require.cache[require.resolve('electron')];
   electron = require('electron');
 } catch (_) {
   console.error(
@@ -21,16 +42,6 @@ try {
   process.exit(1);
 }
 
-// Name the Electron shell before launching it, not only at install time.
-// postinstall scripts are increasingly blocked -- npm warns about them by
-// default now, and plenty of people and companies set ignore-scripts -- and a
-// user who installs with them off gets "Electron" in their Dock. Doing it here
-// as well means the name is right by the time macOS reads the bundle, whatever
-// happened during the install. It returns immediately once done.
-try {
-  require('../scripts/brand-electron.js');
-} catch (_) { /* cosmetic: never block a launch over the name */ }
-
 const appDir = path.join(__dirname, '..');
 const child = spawn(electron, [appDir, ...process.argv.slice(2)], {
   detached: true,

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "latex-stickies",
-  "version": "1.3.6",
+  "version": "1.3.7",
   "description": "Sticky notes for your desktop that render LaTeX and Markdown.",
   "main": "src/main.js",
   "scripts": {
     "start": "electron .",
     "test": "node scripts/test.js",
+    "verify": "node scripts/verify-install.js",
     "vendor": "node scripts/vendor.js",
     "icon": "node scripts/make-icon.js",
     "demo": "node scripts/make-demo.js",

package/scripts/brand-electron.js

@@ -49,6 +49,35 @@ function refreshLaunchServices(appPath) {
   } catch (_) { /* the name is still right; only the cache is stale */ }
 }
 
+/**
+ * Puts our icon in the bundle, and says whether it had to.
+ *
+ * The bundle icon is what macOS shows before the app is running -- in Finder,
+ * in Cmd-Tab, and in the Dock at launch -- so app.dock.setIcon() alone is not
+ * enough. Compared byte for byte rather than copied blindly, because a copy
+ * invalidates the signature and costs a re-sign every launch.
+ */
+function copyIcon(appPath) {
+  const icon = path.join(__dirname, '..', 'build', 'icon.icns');
+  const target = path.join(appPath, 'Contents', 'Resources', 'electron.icns');
+  if (!fs.existsSync(icon) || !fs.existsSync(target)) return false;
+  if (fs.readFileSync(icon).equals(fs.readFileSync(target))) return false;
+  fs.copyFileSync(icon, target);
+  return true;
+}
+
+/**
+ * Re-signs the bundle. Required, not optional: any edit under Contents/
+ * invalidates the ad-hoc signature, and macOS refuses to launch a bundle whose
+ * signature does not match its contents.
+ */
+function resign(appPath) {
+  execFileSync('codesign', ['--force', '--deep', '--sign', '-', appPath], {
+    stdio: 'ignore',
+  });
+  execFileSync('codesign', ['--verify', appPath], { stdio: 'ignore' });
+}
+
 function main() {
   if (process.platform !== 'darwin') return; // only macOS names apps this way
 
@@ -76,7 +105,16 @@ function main() {
   if (read('CFBundleName') === NAME
       && read('CFBundleIdentifier') === APP_ID
       && fs.existsSync(binary)) {
-    // Already named, so a wrong name in the Dock can only be a stale cache.
+    // Named already, but the icon may still be an old one: someone who
+    // installed an earlier version has a bundle branded with that version's
+    // artwork, and every upgrade since has taken this path and left it there.
+    if (copyIcon(appPath)) {
+      resign(appPath);
+      refreshLaunchServices(appPath);
+      console.log('updated the icon on the Electron shell');
+      return;
+    }
+    // Otherwise a wrong name in the Dock can only be a stale cache.
     refreshLaunchServices(appPath);
     // Say so rather than exiting in silence. A user reporting "the Dock still
     // says Electron" needs to know whether the rename failed or whether they
@@ -118,18 +156,8 @@ function main() {
       fs.writeFileSync(pathTxt, `Electron.app/Contents/MacOS/${NAME}`);
     }
 
-    // The bundle icon is what shows before the app can set its own.
-    const icon = path.join(__dirname, '..', 'build', 'icon.icns');
-    const target = path.join(appPath, 'Contents', 'Resources', 'electron.icns');
-    if (fs.existsSync(icon) && fs.existsSync(target)) fs.copyFileSync(icon, target);
-
-    // Required: the edits above invalidate the ad-hoc signature, and macOS
-    // refuses to launch a bundle whose signature does not match its contents.
-    execFileSync('codesign', ['--force', '--deep', '--sign', '-', appPath], {
-      stdio: 'ignore',
-    });
-    execFileSync('codesign', ['--verify', appPath], { stdio: 'ignore' });
-
+    copyIcon(appPath);
+    resign(appPath);
     refreshLaunchServices(appPath);
 
     console.log(`named the Electron shell "${NAME}"`);

package/src/main.js

@@ -473,11 +473,23 @@ let quitting = false;
  */
 function prepareToExit() {
   quitting = true;
-  if (stopWatchingNotes) {
-    stopWatchingNotes();
-    stopWatchingNotes = null;
+  // Nothing here may throw. The caller's next statement is process.exit(), and
+  // an exception thrown on the way out skips it -- leaving exactly the
+  // invisible, unreachable process this whole path exists to prevent. Saving
+  // is worth attempting; it is not worth staying alive for.
+  try {
+    if (stopWatchingNotes) {
+      stopWatchingNotes();
+      stopWatchingNotes = null;
+    }
+  } catch (err) {
+    console.error('could not stop watching the notes folder', err);
+  }
+  try {
+    store.saveNow();
+  } catch (err) {
+    console.error('could not save on the way out', err);
   }
-  store.saveNow();
 }
 
 function watchNotesFolder() {
@@ -490,12 +502,16 @@ function watchNotesFolder() {
 }
 
 app.whenReady().then(async () => {
-  // Run from npm there is no .app bundle to carry the icon, so macOS would show
-  // the generic Electron atom in the Dock. Set it explicitly.
-  // Only when running from source or from npm. A packaged app already carries
-  // its icon in the bundle, and build/ is not shipped inside it -- trying
-  // anyway logged a missing-file error on every launch of the built app.
-  if (!app.isPackaged && process.platform === 'darwin' && app.dock) {
+  // Run from npm there is no .app bundle of our own to carry the icon, so
+  // macOS would show the generic Electron atom in the Dock. Set it explicitly.
+  //
+  // Keyed on the file existing, not on app.isPackaged. Naming the Dock entry
+  // means renaming the executable inside the vendored Electron.app, and
+  // isPackaged is derived from that executable's name -- so an npm install
+  // started reporting itself as packaged, this branch stopped running, and
+  // fixing the name cost the icon. A packaged build has no build/ directory
+  // inside it, which is the same condition, tested directly.
+  if (process.platform === 'darwin' && app.dock && fs.existsSync(ICON)) {
     try {
       const image = nativeImage.createFromBuffer(fs.readFileSync(ICON));
       if (!image.isEmpty()) app.dock.setIcon(image);

package/src/store.js

@@ -20,7 +20,16 @@ const { app } = require('electron');
 const fs = require('fs');
 const path = require('path');
 
-const DIR = path.join(app.getPath('documents'), 'LaTeX Stickies');
+/**
+ * Where the notes live.
+ *
+ * The override exists for harnesses. On macOS Electron resolves the documents
+ * folder through the OS rather than $HOME, so a test that redirects HOME still
+ * reads and writes the real notes -- which is how a verification run ended up
+ * touching them.
+ */
+const DIR = process.env.LATEX_STICKIES_NOTES_DIR
+  || path.join(app.getPath('documents'), 'LaTeX Stickies');
 const INDEX = path.join(DIR, '.stickies.json');
 /** The old single-file store, migrated from once and then left alone. */
 const LEGACY = path.join(app.getPath('userData'), 'notes.json');