feat(scaffold/builder): check length of pref number value (#114)

* feat: check length of pref number value

* test: update tests

Author: northword

packages/scaffold/src/core/builder.ts

@@ -12,6 +12,7 @@ import { copy, emptyDir, move, outputFile, outputJSON, readJSON, writeJson } fro
 import styleText from "node-style-text";
 import { glob } from "tinyglobby";
 import { generateHash } from "../utils/crypto.js";
+import { is32BitNumber } from "../utils/number.js";
 import { PrefsManager, renderPluginPrefsDts } from "../utils/prefs-manager.js";
 import { dateFormat, replaceInFile, toArray } from "../utils/string.js";
 import { Base } from "./base.js";
@@ -268,6 +269,22 @@ export default class Build extends Base {
     const prefsWithPrefix = prefsManager.getPrefsWithPrefix(prefix);
     const prefsWithoutPrefix = prefsManager.getPrefsWithoutPrefix(prefix);
 
+    // Checks if the preference value for the number type is less than 32 bits.
+    // Since the underlying Preference is implemented in C++,
+    // although firefox specifies the preference value for the number type as long int,
+    // the length of long int is different on each operating system.
+    // e.g. on Windows x64:
+    // Zotero Prefs.set("extensions.test.number" 22222222222222222)
+    // zotero.Prefs.get("extensions.test.number") // return 1383176888 but expected 22222222222222222
+    const prefs = prefsManager.getPrefs();
+    Object.entries(prefs).forEach(([key, value]) => {
+      if (typeof value === "number") {
+        if (!is32BitNumber(value)) {
+          this.logger.warn(`Pref key '${styleText.blue(key)}' is a number, but is more than 4 bytes, which can be problematic on some OS.`);
+        }
+      }
+    });
+
     // Generate prefs.d.ts
     if (dts) {
       const dtsContent = renderPluginPrefsDts(prefsWithoutPrefix);

packages/scaffold/src/core/builder/prefs.ts

@@ -0,0 +1,8 @@
+/**
+ * Check if a number is a C++ integer.
+ */
+export function is32BitNumber(n: number): boolean {
+  return Number.isInteger(n)
+    && n >= -2147483648
+    && n <= 2147483647;
+}

packages/scaffold/src/utils/number.ts

@@ -10,3 +10,4 @@ pref("fake-number", "123");
 pref("templateLiteral", `{
   "key": "value"  
 }`);
+pref("long-number", 2222222222222222);

packages/scaffold/test/e2e/fixtures/static/prefs.js

@@ -4,3 +4,4 @@ pref("extensions.testplugin.number", 123);
 pref("extensions.testplugin.break-line", "123");
 pref("extensions.testplugin.fake-number", "123");
 pref("extensions.testplugin.templateLiteral", '{\n  "key": "value"  \n}');
+pref("extensions.testplugin.long-number", 2222222222222222);

packages/scaffold/test/e2e/snap/dist/addon/prefs.js

@@ -13,6 +13,7 @@ declare namespace _ZoteroTypes {
       "break-line": string;
       "fake-number": string;
       "templateLiteral": string;
+      "long-number": number;
     };
   }
 }

packages/scaffold/test/e2e/snap/typings/prefs.d.ts

@@ -26,7 +26,11 @@ describe("#build", () => {
     }
   });
 
-  it("should output correct warnings", () => {
+  it("should output correct warnings - ftl", () => {
     expect(stdout.toString()).toEqual(expect.stringContaining("meaasge-3"));
   });
+
+  it("should output correct warnings - pref long int number", () => {
+    expect(stdout.toString()).toEqual(expect.stringContaining("is a number, but is more than 4 bytes, which can be problematic on some OS."));
+  });
 });