Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-11-30 16:22:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1802961 - Make MigrationUtils an ES6 class singleton. r=kpatenio,credential-management-reviewers,sgalich

Browse Source 
Differential Revision: https://phabricator.services.mozilla.com/D163256
This commit is contained in:
Mike Conley 2022-12-06 14:46:42 +00:00
parent 53e100ace0
commit ba4ff5a0ef
10 changed files with 188 additions and 149 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
browser/base/content/browser-sets.inc
View File

@ -30,8 +30,8 @@
<command id="cmd_pageSetup" oncommand="PrintUtils.showPageSetup();"/>
<command id="cmd_print" oncommand="PrintUtils.startPrintWindow(gBrowser.selectedBrowser.browsingContext);"/>
<command id="cmd_printPreviewToggle" oncommand="PrintUtils.togglePrintPreview(gBrowser.selectedBrowser.browsingContext);"/>
<command id="cmd_file_importFromAnotherBrowser" oncommand="MigrationUtils.showMigrationWizard(window, [MigrationUtils.MIGRATION_ENTRYPOINT_FILE_MENU]);"/>
<command id="cmd_help_importFromAnotherBrowser" oncommand="MigrationUtils.showMigrationWizard(window, [MigrationUtils.MIGRATION_ENTRYPOINT_HELP_MENU]);"/>
<command id="cmd_file_importFromAnotherBrowser" oncommand="MigrationUtils.showMigrationWizard(window, [MigrationUtils.MIGRATION_ENTRYPOINTS.FILE_MENU]);"/>
<command id="cmd_help_importFromAnotherBrowser" oncommand="MigrationUtils.showMigrationWizard(window, [MigrationUtils.MIGRATION_ENTRYPOINTS.HELP_MENU]);"/>
<command id="cmd_close" oncommand="BrowserCloseTabOrWindow(event);"/>
<command id="cmd_closeWindow" oncommand="BrowserTryToCloseWindow(event)"/>
<command id="cmd_toggleMute" oncommand="gBrowser.toggleMuteAudioOnMultiSelectedTabs(gBrowser.selectedTab)"/>

2
browser/base/content/navigator-toolbox.inc.xhtml
View File

@ -562,7 +562,7 @@
<html:template id="BrowserToolbarPalette">
<toolbarbutton id="import-button"
class="toolbarbutton-1 chromeclass-toolbar-additional"
oncommand="MigrationUtils.showMigrationWizard(window, [MigrationUtils.MIGRATION_ENTRYPOINT_BOOKMARKS_TOOLBAR]);"
oncommand="MigrationUtils.showMigrationWizard(window, [MigrationUtils.MIGRATION_ENTRYPOINTS.BOOKMARKS_TOOLBAR]);"
data-l10n-id="browser-import-button2"/>
<toolbarbutton id="new-window-button" class="toolbarbutton-1 chromeclass-toolbar-additional"

2
browser/components/aboutlogins/AboutLoginsParent.jsm
View File

@ -235,7 +235,7 @@ class AboutLoginsParent extends JSWindowActorParent {
#importFromBrowser() {
try {
lazy.MigrationUtils.showMigrationWizard(this.#ownerGlobal, [
lazy.MigrationUtils.MIGRATION_ENTRYPOINT_PASSWORDS,
lazy.MigrationUtils.MIGRATION_ENTRYPOINTS.PASSWORDS,
]);
} catch (ex) {
console.error(ex);

308
browser/components/migration/MigrationUtils.sys.mjs
View File

@ -37,56 +37,6 @@ let gForceExitSpinResolve = false;
let gKeepUndoData = false;
let gUndoData = null;
const gAvailableMigratorKeys = (function() {
if (AppConstants.platform == "win") {
return [
"firefox",
"edge",
"ie",
"opera",
"opera-gx",
"vivaldi",
"brave",
"chrome",
"chromium-edge",
"chromium-edge-beta",
"chrome-beta",
"chromium",
"chromium-360se",
"canary",
];
}
if (AppConstants.platform == "macosx") {
return [
"firefox",
"safari",
"opera",
"opera-gx",
"vivaldi",
"brave",
"chrome",
"chromium-edge",
"chromium-edge-beta",
"chromium",
"canary",
];
}
if (AppConstants.XP_UNIX) {
return [
"firefox",
"opera",
"vivaldi",
"brave",
"chrome",
"chrome-beta",
"chrome-dev",
"chromium",
"opera-gx",
];
}
return [];
})();
function getL10n() {
if (!gL10n) {
gL10n = new Localization(["browser/migration.ftl"]);
@ -557,8 +507,13 @@ export var MigratorPrototype = {
},
};
export var MigrationUtils = Object.seal({
resourceTypes: {
/**
* The singleton MigrationUtils service. This service is the primary mechanism
* by which migrations from other browsers to this browser occur. The singleton
* instance of this class is exported from this module as `MigrationUtils`.
*/
class MigrationUtilsSingleton {
resourceTypes = Object.freeze({
COOKIES: Ci.nsIBrowserProfileMigrator.COOKIES,
HISTORY: Ci.nsIBrowserProfileMigrator.HISTORY,
FORMDATA: Ci.nsIBrowserProfileMigrator.FORMDATA,
@ -566,7 +521,7 @@ export var MigrationUtils = Object.seal({
BOOKMARKS: Ci.nsIBrowserProfileMigrator.BOOKMARKS,
OTHERDATA: Ci.nsIBrowserProfileMigrator.OTHERDATA,
SESSION: Ci.nsIBrowserProfileMigrator.SESSION,
},
});
/**
* Helper for implementing simple asynchronous cases of migration resources'
@ -575,7 +530,8 @@ export var MigrationUtils = Object.seal({
* everything right away, you can wrap the async-function with this helper
* and not worry about notifying the callback.
*
* For example, instead of writing:
* @example
* // For example, instead of writing:
* setTimeout(function() {
* try {
* ....
@ -586,14 +542,14 @@ export var MigrationUtils = Object.seal({
* }
* }, 0);
*
* You may write:
* // You may write:
* setTimeout(MigrationUtils.wrapMigrateFunction(function() {
* if (importingFromMosaic)
* throw Cr.NS_ERROR_UNEXPECTED;
* }, aCallback), 0);
*
* ... and aCallback will be called with aSuccess=false when importing
* from Mosaic, or with aSuccess=true otherwise.
* // ... and aCallback will be called with aSuccess=false when importing
* // from Mosaic, or with aSuccess=true otherwise.
*
* @param {Function} aFunction
* the function that will be called sometime later. If aFunction
@ -604,7 +560,7 @@ export var MigrationUtils = Object.seal({
* @returns {Function}
* the wrapped function.
*/
wrapMigrateFunction: function MU_wrapMigrateFunction(aFunction, aCallback) {
wrapMigrateFunction(aFunction, aCallback) {
return function() {
let success = false;
try {
@ -618,7 +574,7 @@ export var MigrationUtils = Object.seal({
// twice.
aCallback(success);
};
},
}
/**
* Gets localized string corresponding to l10n-id
@ -630,10 +586,10 @@ export var MigrationUtils = Object.seal({
* @returns {Promise<string>}
* A promise that resolves to the retrieved localization.
*/
getLocalizedString: function MU_getLocalizedString(aKey, aArgs) {
getLocalizedString(aKey, aArgs) {
let l10n = getL10n();
return l10n.formatValue(aKey, aArgs);
},
}
/**
* Get all the rows corresponding to a select query from a database, without
@ -699,20 +655,20 @@ export var MigrationUtils = Object.seal({
}
return rows;
})();
},
}
get _migrators() {
get #migrators() {
if (!gMigrators) {
gMigrators = new Map();
}
return gMigrators;
},
}
forceExitSpinResolve: function MU_forceExitSpinResolve() {
forceExitSpinResolve() {
gForceExitSpinResolve = true;
},
}
spinResolve: function MU_spinResolve(promise) {
spinResolve(promise) {
if (!(promise instanceof Promise)) {
return promise;
}
@ -740,7 +696,7 @@ export var MigrationUtils = Object.seal({
} else {
return result;
}
},
}
/**
* Returns the migrator for the given source, if any data is available
@ -752,17 +708,17 @@ export var MigrationUtils = Object.seal({
* (see bug 718280).
*
* @param {string} aKey
* Internal name of the migration source. See `gAvailableMigratorKeys`
* Internal name of the migration source. See `availableMigratorKeys`
* for supported values by OS.
*
* @returns {MigratorPrototype}
* A profile migrator implementing nsIBrowserProfileMigrator, if it can
* import any data, null otherwise.
*/
getMigrator: async function MU_getMigrator(aKey) {
async getMigrator(aKey) {
let migrator = null;
if (this._migrators.has(aKey)) {
migrator = this._migrators.get(aKey);
if (this.#migrators.has(aKey)) {
migrator = this.#migrators.get(aKey);
} else {
try {
migrator = Cc[
@ -771,7 +727,7 @@ export var MigrationUtils = Object.seal({
} catch (ex) {
Cu.reportError(ex);
}
this._migrators.set(aKey, migrator);
this.#migrators.set(aKey, migrator);
}
try {
@ -780,7 +736,7 @@ export var MigrationUtils = Object.seal({
Cu.reportError(ex);
return null;
}
},
}
/**
* Figure out what is the default browser, and if there is a migrator
@ -873,7 +829,7 @@ export var MigrationUtils = Object.seal({
}
}
return key;
},
}
/**
* True if we're in the process of a startup migration.
@ -882,7 +838,7 @@ export var MigrationUtils = Object.seal({
*/
get isStartupMigration() {
return gProfileStartup != null;
},
}
/**
* In the case of startup migration, this is set to the nsIProfileStartup
@ -893,7 +849,7 @@ export var MigrationUtils = Object.seal({
*/
get profileStartup() {
return gProfileStartup;
},
}
/**
* Show the migration wizard. On mac, this may just focus the wizard if it's
@ -916,7 +872,7 @@ export var MigrationUtils = Object.seal({
* constant below, and specify at least the first element of the array
* (the migration entry point for purposes of telemetry).
*/
showMigrationWizard: function MU_showMigrationWizard(aOpener, aParams) {
showMigrationWizard(aOpener, aParams) {
const DIALOG_URL = "chrome://browser/content/migration/migration.xhtml";
let features = "chrome,dialog,modal,centerscreen,titlebar,resizable=no";
if (AppConstants.platform == "macosx" && !this.isStartupMigration) {
@ -993,7 +949,7 @@ export var MigrationUtils = Object.seal({
} else {
Services.ww.openWindow(aOpener, DIALOG_URL, "_blank", features, params);
}
},
}
/**
* Show the migration wizard for startup-migration. This should only be
@ -1017,11 +973,7 @@ export var MigrationUtils = Object.seal({
* if aMigratorKey is invalid or if it points to a non-existent
* source.
*/
startupMigration: function MU_startupMigrator(
aProfileStartup,
aMigratorKey,
aProfileToMigrate
) {
startupMigration(aProfileStartup, aMigratorKey, aProfileToMigrate) {
this.spinResolve(
this.asyncStartupMigration(
aProfileStartup,
@ -1029,9 +981,9 @@ export var MigrationUtils = Object.seal({
aProfileToMigrate
)
);
},
}
asyncStartupMigration: async function MU_asyncStartupMigrator(
async asyncStartupMigration(
aProfileStartup,
aMigratorKey,
aProfileToMigrate
@ -1072,7 +1024,7 @@ export var MigrationUtils = Object.seal({
if (!migrator) {
let migrators = await Promise.all(
gAvailableMigratorKeys.map(key => this.getMigrator(key))
this.availableMigratorKeys.map(key => this.getMigrator(key))
);
// If there's no migrator set so far, ensure that there is at least one
// migrator available before opening the wizard.
@ -1088,9 +1040,9 @@ export var MigrationUtils = Object.seal({
let isRefresh =
migrator && skipSourcePage && migratorKey == AppConstants.MOZ_APP_NAME;
let migrationEntryPoint = this.MIGRATION_ENTRYPOINT_FIRSTRUN;
let migrationEntryPoint = this.MIGRATION_ENTRYPOINTS.FIRSTRUN;
if (isRefresh) {
migrationEntryPoint = this.MIGRATION_ENTRYPOINT_FXREFRESH;
migrationEntryPoint = this.MIGRATION_ENTRYPOINTS.FXREFRESH;
}
let params = [
@ -1102,13 +1054,17 @@ export var MigrationUtils = Object.seal({
aProfileToMigrate,
];
this.showMigrationWizard(null, params);
},
}
_importQuantities: {
/**
* This is only pseudo-private because some tests and helper functions
* still expect to be able to directly access it.
*/
_importQuantities = {
bookmarks: 0,
logins: 0,
history: 0,
},
};
getImportedCount(type) {
if (!this._importQuantities.hasOwnProperty(type)) {
@ -1117,7 +1073,7 @@ export var MigrationUtils = Object.seal({
);
}
return this._importQuantities[type];
},
}
insertBookmarkWrapper(bookmark) {
this._importQuantities.bookmarks++;
@ -1138,7 +1094,7 @@ export var MigrationUtils = Object.seal({
});
return bm;
});
},
}
insertManyBookmarksWrapper(bookmarks, parent) {
let insertionPromise = lazy.PlacesUtils.bookmarks.insertTree({
@ -1163,7 +1119,7 @@ export var MigrationUtils = Object.seal({
},
ex => Cu.reportError(ex)
);
},
}
insertVisitsWrapper(pageInfos) {
let now = new Date();
@ -1179,10 +1135,10 @@ export var MigrationUtils = Object.seal({
}
this._importQuantities.history += pageInfos.length;
if (gKeepUndoData) {
this._updateHistoryUndo(pageInfos);
this.#updateHistoryUndo(pageInfos);
}
return lazy.PlacesUtils.history.insertMany(pageInfos);
},
}
async insertLoginsWrapper(logins) {
this._importQuantities.logins += logins.length;
@ -1196,7 +1152,7 @@ export var MigrationUtils = Object.seal({
gUndoData.get("logins").push({ guid, timePasswordChanged });
}
}
},
}
/**
* Iterates through the favicons, sniffs for a mime type,
@ -1234,7 +1190,7 @@ export var MigrationUtils = Object.seal({
Services.scriptSecurityManager.getSystemPrincipal()
);
}
},
}
initializeUndoData() {
gKeepUndoData = true;
@ -1243,9 +1199,9 @@ export var MigrationUtils = Object.seal({
["visits", []],
["logins", []],
]);
},
}
async _postProcessUndoData(state) {
async #postProcessUndoData(state) {
if (!state) {
return state;
}
@ -1275,16 +1231,16 @@ export var MigrationUtils = Object.seal({
}
}
return state;
},
}
stopAndRetrieveUndoData() {
let undoData = gUndoData;
gUndoData = null;
gKeepUndoData = false;
return this._postProcessUndoData(undoData);
},
return this.#postProcessUndoData(undoData);
}
_updateHistoryUndo(pageInfos) {
#updateHistoryUndo(pageInfos) {
let visits = gUndoData.get("visits");
let visitMap = new Map(visits.map(v => [v.url, v]));
for (let pageInfo of pageInfos) {
@ -1320,30 +1276,126 @@ export var MigrationUtils = Object.seal({
}
}
gUndoData.set("visits", Array.from(visitMap.values()));
},
}
/**
* Cleans up references to migrators and nsIProfileInstance instances.
*/
finishMigration: function MU_finishMigration() {
finishMigration() {
gMigrators = null;
gProfileStartup = null;
gL10n = null;
},
}
gAvailableMigratorKeys,
get availableMigratorKeys() {
if (AppConstants.platform == "win") {
return [
"firefox",
"edge",
"ie",
"opera",
"opera-gx",
"vivaldi",
"brave",
"chrome",
"chromium-edge",
"chromium-edge-beta",
"chrome-beta",
"chromium",
"chromium-360se",
"canary",
];
}
if (AppConstants.platform == "macosx") {
return [
"firefox",
"safari",
"opera",
"opera-gx",
"vivaldi",
"brave",
"chrome",
"chromium-edge",
"chromium-edge-beta",
"chromium",
"canary",
];
}
if (AppConstants.XP_UNIX) {
return [
"firefox",
"opera",
"vivaldi",
"brave",
"chrome",
"chrome-beta",
"chrome-dev",
"chromium",
"opera-gx",
];
}
return [];
}
MIGRATION_ENTRYPOINT_UNKNOWN: 0,
MIGRATION_ENTRYPOINT_FIRSTRUN: 1,
MIGRATION_ENTRYPOINT_FXREFRESH: 2,
MIGRATION_ENTRYPOINT_PLACES: 3,
MIGRATION_ENTRYPOINT_PASSWORDS: 4,
MIGRATION_ENTRYPOINT_NEWTAB: 5,
MIGRATION_ENTRYPOINT_FILE_MENU: 6,
MIGRATION_ENTRYPOINT_HELP_MENU: 7,
MIGRATION_ENTRYPOINT_BOOKMARKS_TOOLBAR: 8,
/**
* Enum for the entrypoint that is being used to start migration.
* Callers can use the MIGRATION_ENTRYPOINTS getter to use these.
*
* These values are what's written into the FX_MIGRATION_ENTRY_POINT
* histogram after a migration.
*
* @see MIGRATION_ENTRYPOINTS
* @readonly
* @enum {number}
*/
#MIGRATION_ENTRYPOINTS_ENUM = Object.freeze({
/** The entrypoint was not supplied */
UNKNOWN: 0,
_sourceNameToIdMapping: {
/** Migration is occurring at startup */
FIRSTRUN: 1,
/** Migration is occurring at after a profile refresh */
FXREFRESH: 2,
/** Migration is being started from the Library window */
PLACES: 3,
/** Migration is being started from our password management UI */
PASSWORDS: 4,
/** Migration is being started from the default about:home/about:newtab */
NEWTAB: 5,
/** Migration is being started from the File menu */
FILE_MENU: 6,
/** Migration is being started from the Help menu */
HELP_MENU: 7,
/** Migration is being started from the Bookmarks Toolbar */
BOOKMARKS_TOOLBAR: 8,
});
/**
* Returns an enum that should be used to record the entrypoint for
* starting a migration.
*
* @returns {number}
*/
get MIGRATION_ENTRYPOINTS() {
return this.#MIGRATION_ENTRYPOINTS_ENUM;
}
/**
* Enum for the numeric value written to the FX_MIGRATION_SOURCE_BROWSER,
* and FX_STARTUP_MIGRATION_EXISTING_DEFAULT_BROWSER histograms.
*
* @see getSourceIdForTelemetry
* @readonly
* @enum {number}
*/
#SOURCE_NAME_TO_ID_MAPPING_ENUM = Object.freeze({
nothing: 1,
firefox: 2,
edge: 3,
@ -1361,15 +1413,11 @@ export var MigrationUtils = Object.seal({
opera: 12,
"opera-gx": 14,
vivaldi: 13,
},
getSourceIdForTelemetry(sourceName) {
return this._sourceNameToIdMapping[sourceName] || 0;
},
});
/* Enum of locations where bookmarks were found in the
source browser that we import from */
SOURCE_BOOKMARK_ROOTS_BOOKMARKS_TOOLBAR: 1,
SOURCE_BOOKMARK_ROOTS_BOOKMARKS_MENU: 2,
SOURCE_BOOKMARK_ROOTS_READING_LIST: 4,
SOURCE_BOOKMARK_ROOTS_UNFILED: 8,
});
getSourceIdForTelemetry(sourceName) {
return this.#SOURCE_NAME_TO_ID_MAPPING_ENUM[sourceName] || 0;
}
}
export const MigrationUtils = new MigrationUtilsSingleton();

2
browser/components/migration/MigrationWizardParent.sys.mjs
View File

@ -36,7 +36,7 @@ export class MigrationWizardParent extends JSWindowActorParent {
if (message.name == "GetAvailableMigrators") {
let availableMigrators = new Map();
for (const key of MigrationUtils.gAvailableMigratorKeys) {
for (const key of MigrationUtils.availableMigratorKeys) {
try {
let migratorPromise = MigrationUtils.getMigrator(key).catch(
console.error

9
browser/components/migration/SafariProfileMigrator.sys.mjs
View File

@ -20,7 +20,6 @@ ChromeUtils.defineESModuleGetters(lazy, {
function Bookmarks(aBookmarksFile) {
this._file = aBookmarksFile;
this._histogramBookmarkRoots = 0;
}
Bookmarks.prototype = {
type: MigrationUtils.resourceTypes.BOOKMARKS,
@ -113,20 +112,14 @@ Bookmarks.prototype = {
// Because the former is only an implementation detail in our UI,
// the unfiled root seems to be the best choice.
folderGuid = lazy.PlacesUtils.bookmarks.unfiledGuid;
this._histogramBookmarkRoots |=
MigrationUtils.SOURCE_BOOKMARK_ROOTS_UNFILED;
break;
}
case this.MENU_COLLECTION: {
folderGuid = lazy.PlacesUtils.bookmarks.menuGuid;
this._histogramBookmarkRoots |=
MigrationUtils.SOURCE_BOOKMARK_ROOTS_BOOKMARKS_MENU;
break;
}
case this.TOOLBAR_COLLECTION: {
folderGuid = lazy.PlacesUtils.bookmarks.toolbarGuid;
this._histogramBookmarkRoots |=
MigrationUtils.SOURCE_BOOKMARK_ROOTS_BOOKMARKS_TOOLBAR;
break;
}
case this.READING_LIST_COLLECTION: {
@ -143,8 +136,6 @@ Bookmarks.prototype = {
title: readingListTitle,
})
).guid;
this._histogramBookmarkRoots |=
MigrationUtils.SOURCE_BOOKMARK_ROOTS_READING_LIST;
break;
}
default:

4
browser/components/migration/content/migration.js
View File

@ -52,12 +52,12 @@ var MigrationWizard = {
this._wiz = document.querySelector("wizard");
let args = window.arguments;
let entryPointId = args[0] || MigrationUtils.MIGRATION_ENTRYPOINT_UNKNOWN;
let entryPointId = args[0] || MigrationUtils.MIGRATION_ENTRYPOINTS.UNKNOWN;
Services.telemetry
.getHistogramById("FX_MIGRATION_ENTRY_POINT")
.add(entryPointId);
this.isInitialMigration =
entryPointId == MigrationUtils.MIGRATION_ENTRYPOINT_FIRSTRUN;
entryPointId == MigrationUtils.MIGRATION_ENTRYPOINTS.FIRSTRUN;
// Record that the uninstaller requested a profile refresh
if (Services.env.get("MOZ_UNINSTALLER_PROFILE_REFRESH")) {

2
browser/components/places/content/places.js
View File

@ -468,7 +468,7 @@ var PlacesOrganizer = {
importFromBrowser: function PO_importFromBrowser() {
// We pass in the type of source we're using for use in telemetry:
MigrationUtils.showMigrationWizard(window, [
MigrationUtils.MIGRATION_ENTRYPOINT_PLACES,
MigrationUtils.MIGRATION_ENTRYPOINTS.PLACES,
]);
},

2
toolkit/components/messaging-system/lib/SpecialMessageActions.jsm
View File

@ -233,7 +233,7 @@ const SpecialMessageActions = {
case "SHOW_MIGRATION_WIZARD":
Services.tm.dispatchToMainThread(() =>
lazy.MigrationUtils.showMigrationWizard(window, [
lazy.MigrationUtils.MIGRATION_ENTRYPOINT_NEWTAB,
lazy.MigrationUtils.MIGRATION_ENTRYPOINTS.NEWTAB,
action.data?.source,
])
);

2
toolkit/components/passwordmgr/LoginManagerParent.jsm
View File

@ -445,7 +445,7 @@ class LoginManagerParent extends JSWindowActorParent {
// Open the migration wizard pre-selecting the appropriate browser.
lazy.MigrationUtils.showMigrationWizard(
this.getRootBrowser().ownerGlobal,
[lazy.MigrationUtils.MIGRATION_ENTRYPOINT_PASSWORDS, browserId]
[lazy.MigrationUtils.MIGRATION_ENTRYPOINTS.PASSWORDS, browserId]
);
}
}