Skip to content

Commit

Permalink
Bug 1515094 - minimally convert notificationstore to kvstore r=asuth,…
Browse files Browse the repository at this point in the history 
…lina

Differential Revision: https://phabricator.services.mozilla.com/D13568

--HG--
extra : moz-landing-system : lando
  • Loading branch information
@mykmelez
mykmelez committed Mar 21, 2019
1 parent 6c69533 commit 2e54129
Show file tree
Hide file tree
Showing 6 changed files with 194 additions and 124 deletions.
3 changes: 0 additions & 3 deletions browser/base/content/test/static/browser_all_files_referenced.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -169,9 +169,6 @@ var whitelist = [
{file: "chrome://devtools/skin/images/aboutdebugging-firefox-release.svg",
isFromDevTools: true},
{file: "chrome://devtools/skin/images/next.svg", isFromDevTools: true},
// kvstore.jsm wraps the API in nsIKeyValue.idl in a more ergonomic API
// It landed in bug 1490496, and we expect to start using it shortly.
{file: "resource://gre/modules/kvstore.jsm"},
// Bug 1526672
{file: "resource://app/localization/en-US/browser/touchbar/touchbar.ftl",
platforms: ["linux", "win"]},
Expand Down
217 changes: 100 additions & 117 deletions dom/notification/NotificationDB.jsm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,35 +9,41 @@ var EXPORTED_SYMBOLS = [];
const DEBUG = false;
function debug(s) { dump("-*- NotificationDB component: " + s + "\n"); }

const {OS} = ChromeUtils.import("resource://gre/modules/osfile.jsm");

ChromeUtils.defineModuleGetter(this, "Services",
"resource://gre/modules/Services.jsm");

const NOTIFICATION_STORE_DIR = OS.Constants.Path.profileDir;
const NOTIFICATION_STORE_PATH =
OS.Path.join(NOTIFICATION_STORE_DIR, "notificationstore.json");
ChromeUtils.defineModuleGetter(this, "FileUtils", "resource://gre/modules/FileUtils.jsm");
ChromeUtils.defineModuleGetter(this, "KeyValueService", "resource://gre/modules/kvstore.jsm");
ChromeUtils.defineModuleGetter(this, "OS", "resource://gre/modules/osfile.jsm");
ChromeUtils.defineModuleGetter(this, "Services", "resource://gre/modules/Services.jsm");

const kMessages = [
"Notification:Save",
"Notification:Delete",
"Notification:GetAll",
];

// Given its origin and ID, produce the key that uniquely identifies
// a notification.
function makeKey(origin, id) {
return origin.concat("\t", id);
}

var NotificationDB = {

// Ensure we won't call init() while xpcom-shutdown is performed
_shutdownInProgress: false,

// A handle to the kvstore, retrieved lazily when we load the data.
_store: null,

// A promise that resolves once the store has been loaded.
// The promise doesn't resolve to a value; it merely captures the state
// of the load via its resolution.
_loadPromise: null,

init() {
if (this._shutdownInProgress) {
return;
}

this.notifications = {};
this.byTag = {};
this.loaded = false;

this.tasks = []; // read/write operation queue
this.runningTask = null;

Expand Down Expand Up @@ -85,68 +91,67 @@ var NotificationDB = {
return notifications;
},

// Attempt to read notification file, if it's not there we will create it.
load() {
var promise = OS.File.read(NOTIFICATION_STORE_PATH, { encoding: "utf-8"});
return promise.then(
data => {
if (data.length > 0) {
// Preprocessing phase intends to cleanly separate any migration-related
// tasks.
this.notifications = this.filterNonAppNotifications(JSON.parse(data));
}
async maybeMigrateData() {
// We avoid using OS.File until we know we're going to migrate data
// to avoid the performance cost of loading that module.
const oldStore = FileUtils.getFile("ProfD", ["notificationstore.json"]);

// populate the list of notifications by tag
if (this.notifications) {
for (var origin in this.notifications) {
this.byTag[origin] = {};
for (var id in this.notifications[origin]) {
var curNotification = this.notifications[origin][id];
if (curNotification.tag) {
this.byTag[origin][curNotification.tag] = curNotification;
}
}
}
}
if (!oldStore.exists()) {
if (DEBUG) { debug("Old store doesn't exist; not migrating data."); }
return;
}

this.loaded = true;
},
let data;
try {
data = await OS.File.read(oldStore.path, { encoding: "utf-8"});
} catch (ex) {
// If read failed, we assume we have no notifications to migrate.
if (DEBUG) { debug("Failed to read old store; not migrating data."); }
return;
} finally {
// Finally, delete the old file so we don't try to migrate it again.
await OS.File.remove(oldStore.path);
}

// If read failed, we assume we have no notifications to load.
reason => {
this.loaded = true;
return this.createStore();
if (data.length > 0) {
// Preprocessing phase intends to cleanly separate any migration-related
// tasks.
//
// NB: This code existed before we migrated the data to a kvstore,
// and the "migration-related tasks" it references are from an earlier
// migration. We used to do it every time we read the JSON file;
// now we do it once, when migrating the JSON file to the kvstore.
const notifications = this.filterNonAppNotifications(JSON.parse(data));

// Copy the data from the JSON file to the kvstore.
// TODO: use a transaction to improve the performance of these operations
// once the kvstore API supports it (bug 1515096).
for (const origin in notifications) {
for (const id in notifications[origin]) {
await this._store.put(makeKey(origin, id),
JSON.stringify(notifications[origin][id]));
}
}
);
},

// Creates the notification directory.
createStore() {
var promise = OS.File.makeDir(NOTIFICATION_STORE_DIR, {
ignoreExisting: true,
});
return promise.then(
this.createFile.bind(this)
);
},

// Creates the notification file once the directory is created.
createFile() {
return OS.File.writeAtomic(NOTIFICATION_STORE_PATH, "");
}
},

// Save current notifications to the file.
save() {
var data = JSON.stringify(this.notifications);
return OS.File.writeAtomic(NOTIFICATION_STORE_PATH, data, { encoding: "utf-8"});
// Attempt to read notification file, if it's not there we will create it.
async load() {
// Get and cache a handle to the kvstore.
const dir = FileUtils.getDir("ProfD", ["notificationstore"], true);
this._store = await KeyValueService.getOrCreate(dir.path, "notifications");

// Migrate data from the old JSON file to the new kvstore if the old file
// is present in the user's profile directory.
await this.maybeMigrateData();
},

// Helper function: promise will be resolved once file exists and/or is loaded.
ensureLoaded() {
if (!this.loaded) {
return this.load();
if (!this._loadPromise) {
this._loadPromise = this.load();
}
return Promise.resolve();
return this._loadPromise;
},

receiveMessage(message) {
Expand Down Expand Up @@ -217,11 +222,7 @@ var NotificationDB = {

var defer = {};

this.tasks.push({
operation,
data,
defer,
});
this.tasks.push({ operation, data, defer });

var promise = new Promise(function(resolve, reject) {
defer.resolve = resolve;
Expand Down Expand Up @@ -259,11 +260,9 @@ var NotificationDB = {

case "delete":
return this.taskDelete(task.data);

default:
return Promise.reject(
new Error(`Found a task with unknown operation ${task.operation}`));
}

throw new Error(`Unknown task operation: ${task.operation}`);
})
.then(payload => {
if (DEBUG) {
Expand All @@ -282,70 +281,54 @@ var NotificationDB = {
});
},

taskGetAll(data) {
enumerate(origin) {
// The "from" and "to" key parameters to nsIKeyValueStore.enumerate()
// are inclusive and exclusive, respectively, and keys are tuples
// of origin and ID joined by a tab (\t), which is character code 9;
// so enumerating ["origin", "origin\n"), where the line feed (\n)
// is character code 10, enumerates all pairs with the given origin.
return this._store.enumerate(origin, `${origin}\n`);
},

async taskGetAll(data) {
if (DEBUG) { debug("Task, getting all"); }
var origin = data.origin;
var notifications = [];
// Grab only the notifications for specified origin.
if (this.notifications[origin]) {
if (data.tag) {
let n;
if ((n = this.byTag[origin][data.tag])) {
notifications.push(n);
}
} else {
for (var i in this.notifications[origin]) {
notifications.push(this.notifications[origin][i]);
}
}

for (const {value} of await this.enumerate(origin)) {
notifications.push(JSON.parse(value));
}

if (data.tag) {
notifications = notifications.filter(n => n.tag === data.tag);
}
return Promise.resolve(notifications);

return notifications;
},

taskSave(data) {
async taskSave(data) {
if (DEBUG) { debug("Task, saving"); }
var origin = data.origin;
var notification = data.notification;
if (!this.notifications[origin]) {
this.notifications[origin] = {};
this.byTag[origin] = {};
}

// We might have existing notification with this tag,
// if so we need to remove it before saving the new one.
if (notification.tag) {
var oldNotification = this.byTag[origin][notification.tag];
if (oldNotification) {
delete this.notifications[origin][oldNotification.id];
for (const {key, value} of await this.enumerate(origin)) {
const oldNotification = JSON.parse(value);
if (oldNotification.tag === notification.tag) {
await this._store.delete(key);
}
}
this.byTag[origin][notification.tag] = notification;
}

this.notifications[origin][notification.id] = notification;
return this.save();
await this._store.put(makeKey(origin, notification.id),
JSON.stringify(notification));
},

taskDelete(data) {
async taskDelete(data) {
if (DEBUG) { debug("Task, deleting"); }
var origin = data.origin;
var id = data.id;
if (!this.notifications[origin]) {
if (DEBUG) { debug("No notifications found for origin: " + origin); }
return Promise.resolve();
}

// Make sure we can find the notification to delete.
var oldNotification = this.notifications[origin][id];
if (!oldNotification) {
if (DEBUG) { debug("No notification found with id: " + id); }
return Promise.resolve();
}

if (oldNotification.tag) {
delete this.byTag[origin][oldNotification.tag];
}
delete this.notifications[origin][id];
return this.save();
await this._store.delete(makeKey(data.origin, data.id));
},
};

Expand Down
6 changes: 4 additions & 2 deletions dom/notification/test/unit/head_notificationdb.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,18 @@
var {XPCOMUtils} = ChromeUtils.import("resource://gre/modules/XPCOMUtils.jsm");
var {Services} = ChromeUtils.import("resource://gre/modules/Services.jsm");

function getNotificationObject(app, id, tag) {
function getNotificationObject(app, id, tag, includeScope) {
const origin = `https://${app}.gaiamobile.org/`;
return {
origin: "https://" + app + ".gaiamobile.org/",
origin,
id,
title: app + "Notification:" + Date.now(),
dir: "auto",
lang: "",
body: app + " notification body",
tag: tag || "",
icon: "icon.png",
serviceWorkerRegistrationScope: includeScope ? origin : undefined,
};
}

Expand Down
4 changes: 2 additions & 2 deletions dom/notification/test/unit/test_notificationdb_bug1024090.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ function run_test() {
add_test(function test_bug1024090_purge() {
const {OS} = ChromeUtils.import("resource://gre/modules/osfile.jsm");
const NOTIFICATION_STORE_PATH =
OS.Path.join(OS.Constants.Path.profileDir, "notificationstore.json");
let cleanup = OS.File.writeAtomic(NOTIFICATION_STORE_PATH, "");
OS.Path.join(OS.Constants.Path.profileDir, "notificationstore");
let cleanup = OS.File.removeDir(NOTIFICATION_STORE_PATH);
cleanup.then(
function onSuccess() {
ok(true, "Notification database cleaned.");
Expand Down
Loading

0 comments on commit 2e54129

Please sign in to comment.