From bc24c2b11defdead246d2f76d51973aef984a440 Mon Sep 17 00:00:00 2001 From: "mr. m" Date: Mon, 12 Jan 2026 21:07:27 +0100 Subject: [PATCH] feat: Implement a better identified migration system for window sync, b=no-bug, c=glance, mods --- eslint.config.mjs | 20 ---- src/zen/glance/moz.build | 1 - src/zen/mods/ZenMods.mjs | 4 +- .../sessionstore/ZenSessionManager.sys.mjs | 37 ++++-- tsconfig.json | 113 ++++++++++++++++++ 5 files changed, 141 insertions(+), 34 deletions(-) create mode 100644 tsconfig.json diff --git a/eslint.config.mjs b/eslint.config.mjs index 68ead2cdd..8a7e2c28e 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -12,7 +12,6 @@ import mozilla from "eslint-plugin-mozilla"; import reactHooks from "eslint-plugin-react-hooks"; import zenGlobals from "./src/zen/zen.globals.mjs"; -import fs from "fs"; import globals from "globals"; import path from "path"; @@ -24,13 +23,6 @@ import subdirConfigs from "./engine/eslint-subdirs.config.mjs"; const testPaths = testPathsConfig.testPaths; -function readFile(filePath) { - return fs - .readFileSync(filePath, { encoding: "utf-8" }) - .split("\n") - .filter((p) => p && !p.startsWith("#")); -} - const httpTestingPaths = [ `**/*mixedcontent*.{${mozilla.allFileExtensions.join(",")}}`, `**/*CrossOrigin*.{${mozilla.allFileExtensions.join(",")}}`, @@ -91,7 +83,6 @@ function wrapPathsInConfig(configs) { } return configs; } - let config = [ { name: "import-plugin-settings", @@ -412,11 +403,6 @@ let config = [ files: wrapPaths({ paths: ["**"] }), ...mozilla.configs["flat/valid-jsdoc"], }, - { - name: "mozilla/require-jsdoc", - files: wrapPaths({ paths: ["**"] }), - ...mozilla.configs["flat/require-jsdoc"], - }, { name: "rollout-no-browser-refs-in-toolkit", files: ["toolkit/**"], @@ -439,12 +425,6 @@ let config = [ "mozilla/no-newtab-refs-outside-newtab": "error", }, }, - { - name: "jsdoc/require-jsdoc", - ignores: wrapPaths({ paths: ["**"] }), - ...mozilla.configs["flat/jsdoc-require-jsdoc"], - }, - ...wrapPathsInConfig(subdirConfigs), ...wrapPathsInConfig(repositoryGlobals), diff --git a/src/zen/glance/moz.build b/src/zen/glance/moz.build index 9588459dc..39567ca4c 100644 --- a/src/zen/glance/moz.build +++ b/src/zen/glance/moz.build @@ -1,4 +1,3 @@ -# # This Source Code Form is subject to the terms of the Mozilla Public # License, v. 2.0. If a copy of the MPL was not distributed with this # file, You can obtain one at http://mozilla.org/MPL/2.0/. diff --git a/src/zen/mods/ZenMods.mjs b/src/zen/mods/ZenMods.mjs index 075b7349d..c22c17890 100644 --- a/src/zen/mods/ZenMods.mjs +++ b/src/zen/mods/ZenMods.mjs @@ -295,7 +295,7 @@ class nsZenMods extends nsZenPreloadedFeature { return `https://zen-browser.github.io/theme-store/themes/${modId}/theme.json`; } - async #downloadUrlToFile(url, path, isStyleSheet = false, maxRetries = 3, retryDelayMs = 500) { + async #downloadUrlToFile(url, path, maxRetries = 3, retryDelayMs = 500) { let attempt = 0; while (attempt < maxRetries) { @@ -603,7 +603,7 @@ class nsZenMods extends nsZenPreloadedFeature { const modPath = PathUtils.join(this.modsRootPath, mod.id); await IOUtils.makeDirectory(modPath, { ignoreExisting: true }); - await this.#downloadUrlToFile(mod.style, PathUtils.join(modPath, "chrome.css"), true); + await this.#downloadUrlToFile(mod.style, PathUtils.join(modPath, "chrome.css")); await this.#downloadUrlToFile(mod.readme, PathUtils.join(modPath, "readme.md")); if (mod.preferences) { diff --git a/src/zen/sessionstore/ZenSessionManager.sys.mjs b/src/zen/sessionstore/ZenSessionManager.sys.mjs index a8bd78812..cd4af5b99 100644 --- a/src/zen/sessionstore/ZenSessionManager.sys.mjs +++ b/src/zen/sessionstore/ZenSessionManager.sys.mjs @@ -28,7 +28,6 @@ const SHOULD_COMPRESS_FILE = Services.prefs.getBoolPref("zen.session-store.compr const SHOULD_BACKUP_FILE = Services.prefs.getBoolPref("zen.session-store.backup-file", true); const FILE_NAME = SHOULD_COMPRESS_FILE ? "zen-sessions.jsonlz4" : "zen-sessions.json"; -const MIGRATION_PREF = "zen.ui.migration.session-manager-restore"; // 'browser.startup.page' preference value to resume the previous session. const BROWSER_STARTUP_RESUME_SESSION = 3; @@ -74,14 +73,12 @@ export class nsZenSessionManager { init() { this.log("Initializing session manager"); - let profileDir = Services.dirsvc.get("ProfD", Ci.nsIFile).path; let backupFile = null; if (SHOULD_BACKUP_FILE) { backupFile = PathUtils.join(this.#backupFolderPath, FILE_NAME); } - let filePath = PathUtils.join(profileDir, FILE_NAME); this.#file = new JSONFile({ - path: filePath, + path: this.#storeFilePath, compression: SHOULD_COMPRESS_FILE ? "lz4" : undefined, backupFile, }); @@ -97,6 +94,11 @@ export class nsZenSessionManager { } } + get #storeFilePath() { + let profileDir = Services.dirsvc.get("ProfD", Ci.nsIFile).path; + return PathUtils.join(profileDir, FILE_NAME); + } + get #backupFolderPath() { let profileDir = Services.dirsvc.get("ProfD", Ci.nsIFile).path; return PathUtils.join(profileDir, "zen-sessions-backup"); @@ -144,12 +146,16 @@ export class nsZenSessionManager { * @see SessionFileInternal.read */ async readFile() { + let fileExists = await IOUtils.exists(this.#storeFilePath); + if (!fileExists) { + this._shouldRunMigration = true; + } this.init(); try { this.log("Reading Zen session file from disk"); let promises = []; promises.push(this.#file.load()); - if (!Services.prefs.getBoolPref(MIGRATION_PREF, false)) { + if (this._shouldRunMigration) { promises.push(this.#getDataFromDBForMigration()); } await Promise.all(promises); @@ -157,6 +163,13 @@ export class nsZenSessionManager { console.error("ZenSessionManager: Failed to read session file", e); } this.#sidebar = this.#file.data || {}; + if (!this.#sidebar.spaces?.length && !this._shouldRunMigration) { + // If we have no spaces data, we should run migration + // to restore them from the database. Note we also do a + // check if we already planned to run migration for optimization. + this._shouldRunMigration = true; + await this.#getDataFromDBForMigration(); + } } /** @@ -174,13 +187,14 @@ export class nsZenSessionManager { // That where going to be restored by SessionStore. The sidebar // object will always be empty after migration because we haven't // gotten the opportunity to save the session yet. - if (!Services.prefs.getBoolPref(MIGRATION_PREF, false)) { - Services.prefs.setBoolPref(MIGRATION_PREF, true); + if (this._shouldRunMigration) { this.log("Restoring tabs from Places DB after migration"); - this.#sidebar = { - ...this.#sidebar, - spaces: this._migrationData?.spaces || [], - }; + if (!this.#sidebar.spaces?.length) { + this.#sidebar = { + ...this.#sidebar, + spaces: this._migrationData?.spaces || [], + }; + } // There might be cases where there are no windows in the // initial state, for example if the user had 'restore previous // session' disabled before migration. In that case, we try @@ -201,6 +215,7 @@ export class nsZenSessionManager { // to the session file. this.saveState(initialState); delete this._migrationData; + delete this._shouldRunMigration; return; } // If there are no windows, we create an empty one. By default, diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 000000000..dc77eccaf --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,113 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */, + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "libReplacement": true, /* Enable lib replacement. */ + // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + "module": "commonjs" /* Specify what module code is generated. */, + // "rootDir": "./", /* Specify the root folder within your source files. */ + // "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ + // "rewriteRelativeImportExtensions": true, /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */ + // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ + // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ + // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ + // "noUncheckedSideEffectImports": true, /* Check side effect imports. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + // "outDir": "./", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ + // "isolatedDeclarations": true, /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */ + // "erasableSyntaxOnly": true, /* Do not allow runtime constructs that are not part of ECMAScript. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */, + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */, + + /* Type Checking */ + "strict": true /* Enable all strict type-checking options. */, + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "strictBuiltinIteratorReturn": true, /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +}