mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
1117 lines
37 KiB
JavaScript
1117 lines
37 KiB
JavaScript
Cu.import("resource://services-sync/base_records/crypto.js");
|
|
Cu.import("resource://services-sync/base_records/keys.js");
|
|
Cu.import("resource://services-sync/base_records/wbo.js");
|
|
Cu.import("resource://services-sync/constants.js");
|
|
Cu.import("resource://services-sync/engines.js");
|
|
Cu.import("resource://services-sync/identity.js");
|
|
Cu.import("resource://services-sync/resource.js");
|
|
Cu.import("resource://services-sync/stores.js");
|
|
Cu.import("resource://services-sync/trackers.js");
|
|
Cu.import("resource://services-sync/util.js");
|
|
|
|
/*
|
|
* A fake engine implementation.
|
|
*
|
|
* Complete with record, store, and tracker implementations.
|
|
*/
|
|
|
|
function SteamRecord(uri) {
|
|
CryptoWrapper.call(this, uri);
|
|
}
|
|
SteamRecord.prototype = {
|
|
__proto__: CryptoWrapper.prototype
|
|
};
|
|
Utils.deferGetSet(SteamRecord, "cleartext", ["denomination"]);
|
|
|
|
function SteamStore() {
|
|
Store.call(this, "Steam");
|
|
this.items = {};
|
|
}
|
|
SteamStore.prototype = {
|
|
__proto__: Store.prototype,
|
|
|
|
create: function Store_create(record) {
|
|
this.items[record.id] = record.denomination;
|
|
},
|
|
|
|
remove: function Store_remove(record) {
|
|
delete this.items[record.id];
|
|
},
|
|
|
|
update: function Store_update(record) {
|
|
this.items[record.id] = record.denomination;
|
|
},
|
|
|
|
itemExists: function Store_itemExists(id) {
|
|
return (id in this.items);
|
|
},
|
|
|
|
createRecord: function(id) {
|
|
var record = new SteamRecord();
|
|
record.id = id;
|
|
record.denomination = this.items[id] || "Data for new record: " + id;
|
|
return record;
|
|
},
|
|
|
|
changeItemID: function(oldID, newID) {
|
|
this.items[newID] = this.items[oldID];
|
|
delete this.items[oldID];
|
|
},
|
|
|
|
getAllIDs: function() {
|
|
let ids = {};
|
|
for (var id in this.items) {
|
|
ids[id] = true;
|
|
}
|
|
return ids;
|
|
},
|
|
|
|
wipe: function() {
|
|
this.items = {};
|
|
}
|
|
};
|
|
|
|
function SteamTracker() {
|
|
Tracker.call(this, "Steam");
|
|
}
|
|
SteamTracker.prototype = {
|
|
__proto__: Tracker.prototype
|
|
};
|
|
|
|
|
|
function SteamEngine() {
|
|
SyncEngine.call(this, "Steam");
|
|
}
|
|
SteamEngine.prototype = {
|
|
__proto__: SyncEngine.prototype,
|
|
_storeObj: SteamStore,
|
|
_trackerObj: SteamTracker,
|
|
_recordObj: SteamRecord,
|
|
|
|
_findDupe: function(item) {
|
|
for (let [id, value] in Iterator(this._store.items)) {
|
|
if (item.denomination == value) {
|
|
return id;
|
|
}
|
|
}
|
|
}
|
|
};
|
|
|
|
|
|
function makeSteamEngine() {
|
|
return new SteamEngine();
|
|
}
|
|
|
|
var syncTesting = new SyncTestingInfrastructure(makeSteamEngine);
|
|
|
|
|
|
/*
|
|
* Test setup helpers
|
|
*/
|
|
|
|
function sync_httpd_setup(handlers) {
|
|
handlers["/1.0/foo/storage/meta/global"]
|
|
= (new ServerWBO('global', {})).handler();
|
|
handlers["/1.0/foo/storage/keys/pubkey"]
|
|
= (new ServerWBO('pubkey')).handler();
|
|
handlers["/1.0/foo/storage/keys/privkey"]
|
|
= (new ServerWBO('privkey')).handler();
|
|
return httpd_setup(handlers);
|
|
}
|
|
|
|
function createAndUploadKeypair() {
|
|
let storageURL = Svc.Prefs.get("clusterURL") + Svc.Prefs.get("storageAPI")
|
|
+ "/" + ID.get("WeaveID").username + "/storage/";
|
|
|
|
PubKeys.defaultKeyUri = storageURL + "keys/pubkey";
|
|
PrivKeys.defaultKeyUri = storageURL + "keys/privkey";
|
|
let keys = PubKeys.createKeypair(ID.get("WeaveCryptoID"),
|
|
PubKeys.defaultKeyUri,
|
|
PrivKeys.defaultKeyUri);
|
|
PubKeys.uploadKeypair(keys);
|
|
}
|
|
|
|
function createAndUploadSymKey(url) {
|
|
let symkey = Svc.Crypto.generateRandomKey();
|
|
let pubkey = PubKeys.getDefaultKey();
|
|
let meta = new CryptoMeta(url);
|
|
meta.addUnwrappedKey(pubkey, symkey);
|
|
let res = new Resource(meta.uri);
|
|
res.put(meta);
|
|
}
|
|
|
|
// Turn WBO cleartext into "encrypted" payload as it goes over the wire
|
|
function encryptPayload(cleartext) {
|
|
if (typeof cleartext == "object") {
|
|
cleartext = JSON.stringify(cleartext);
|
|
}
|
|
|
|
return {encryption: "http://localhost:8080/1.0/foo/storage/crypto/steam",
|
|
ciphertext: cleartext, // ciphertext == cleartext with fake crypto
|
|
IV: "irrelevant",
|
|
hmac: Utils.sha256HMAC(cleartext, null)};
|
|
}
|
|
|
|
|
|
/*
|
|
* Tests
|
|
*
|
|
* SyncEngine._sync() is divided into four rather independent steps:
|
|
*
|
|
* - _syncStartup()
|
|
* - _processIncoming()
|
|
* - _uploadOutgoing()
|
|
* - _syncFinish()
|
|
*
|
|
* In the spirit of unit testing, these are tested individually for
|
|
* different scenarios below.
|
|
*/
|
|
|
|
function test_syncStartup_emptyOrOutdatedGlobalsResetsSync() {
|
|
_("SyncEngine._syncStartup resets sync and wipes server data if there's no or an oudated global record");
|
|
|
|
Svc.Prefs.set("clusterURL", "http://localhost:8080/");
|
|
Svc.Prefs.set("username", "foo");
|
|
let crypto_steam = new ServerWBO('steam');
|
|
|
|
// Some server side data that's going to be wiped
|
|
let collection = new ServerCollection();
|
|
collection.wbos.flying = new ServerWBO(
|
|
'flying', encryptPayload({id: 'flying',
|
|
denomination: "LNER Class A3 4472"}));
|
|
collection.wbos.scotsman = new ServerWBO(
|
|
'scotsman', encryptPayload({id: 'scotsman',
|
|
denomination: "Flying Scotsman"}));
|
|
|
|
let server = sync_httpd_setup({
|
|
"/1.0/foo/storage/crypto/steam": crypto_steam.handler(),
|
|
"/1.0/foo/storage/steam": collection.handler()
|
|
});
|
|
do_test_pending();
|
|
createAndUploadKeypair();
|
|
|
|
let engine = makeSteamEngine();
|
|
engine._store.items = {rekolok: "Rekonstruktionslokomotive"};
|
|
try {
|
|
|
|
// Confirm initial environment
|
|
do_check_eq(crypto_steam.payload, undefined);
|
|
do_check_eq(engine._tracker.changedIDs["rekolok"], undefined);
|
|
let metaGlobal = Records.get(engine.metaURL);
|
|
do_check_eq(metaGlobal.payload.engines, undefined);
|
|
do_check_true(!!collection.wbos.flying.payload);
|
|
do_check_true(!!collection.wbos.scotsman.payload);
|
|
|
|
engine.lastSync = Date.now() / 1000;
|
|
engine._syncStartup();
|
|
|
|
// The meta/global WBO has been filled with data about the engine
|
|
let engineData = metaGlobal.payload.engines["steam"];
|
|
do_check_eq(engineData.version, engine.version);
|
|
do_check_eq(engineData.syncID, engine.syncID);
|
|
|
|
// Sync was reset and server data was wiped
|
|
do_check_eq(engine.lastSync, 0);
|
|
do_check_eq(collection.wbos.flying.payload, undefined);
|
|
do_check_eq(collection.wbos.scotsman.payload, undefined);
|
|
|
|
// Bulk key was uploaded
|
|
do_check_true(!!crypto_steam.payload);
|
|
do_check_true(!!crypto_steam.data.keyring);
|
|
|
|
// WBO IDs are added to tracker (they're all marked for uploading)
|
|
do_check_eq(engine._tracker.changedIDs["rekolok"], 0);
|
|
|
|
} finally {
|
|
server.stop(do_test_finished);
|
|
Svc.Prefs.resetBranch("");
|
|
Records.clearCache();
|
|
CryptoMetas.clearCache();
|
|
syncTesting = new SyncTestingInfrastructure(makeSteamEngine);
|
|
}
|
|
}
|
|
|
|
function test_syncStartup_metaGet404() {
|
|
_("SyncEngine._syncStartup resets sync and wipes server data if the symmetric key is missing 404");
|
|
|
|
Svc.Prefs.set("clusterURL", "http://localhost:8080/");
|
|
Svc.Prefs.set("username", "foo");
|
|
|
|
// A symmetric key with an incorrect HMAC
|
|
let crypto_steam = new ServerWBO("steam");
|
|
|
|
// A proper global record with matching version and syncID
|
|
let engine = makeSteamEngine();
|
|
let global = new ServerWBO("global",
|
|
{engines: {steam: {version: engine.version,
|
|
syncID: engine.syncID}}});
|
|
|
|
// Some server side data that's going to be wiped
|
|
let collection = new ServerCollection();
|
|
collection.wbos.flying = new ServerWBO(
|
|
"flying", encryptPayload({id: "flying",
|
|
denomination: "LNER Class A3 4472"}));
|
|
collection.wbos.scotsman = new ServerWBO(
|
|
"scotsman", encryptPayload({id: "scotsman",
|
|
denomination: "Flying Scotsman"}));
|
|
|
|
let server = sync_httpd_setup({
|
|
"/1.0/foo/storage/crypto/steam": crypto_steam.handler(),
|
|
"/1.0/foo/storage/steam": collection.handler()
|
|
});
|
|
do_test_pending();
|
|
createAndUploadKeypair();
|
|
|
|
try {
|
|
|
|
_("Confirm initial environment");
|
|
do_check_false(!!crypto_steam.payload);
|
|
do_check_true(!!collection.wbos.flying.payload);
|
|
do_check_true(!!collection.wbos.scotsman.payload);
|
|
|
|
engine.lastSync = Date.now() / 1000;
|
|
engine._syncStartup();
|
|
|
|
_("Sync was reset and server data was wiped");
|
|
do_check_eq(engine.lastSync, 0);
|
|
do_check_eq(collection.wbos.flying.payload, undefined);
|
|
do_check_eq(collection.wbos.scotsman.payload, undefined);
|
|
|
|
_("New bulk key was uploaded");
|
|
let key = crypto_steam.data.keyring["http://localhost:8080/1.0/foo/storage/keys/pubkey"];
|
|
do_check_eq(key.wrapped, "fake-symmetric-key-0");
|
|
do_check_eq(key.hmac, "fake-symmetric-key-0 ");
|
|
|
|
} finally {
|
|
server.stop(do_test_finished);
|
|
Svc.Prefs.resetBranch("");
|
|
Records.clearCache();
|
|
CryptoMetas.clearCache();
|
|
syncTesting = new SyncTestingInfrastructure(makeSteamEngine);
|
|
}
|
|
}
|
|
|
|
function test_syncStartup_failedMetaGet() {
|
|
_("SyncEngine._syncStartup non-404 failures for getting cryptometa should stop sync");
|
|
|
|
Svc.Prefs.set("clusterURL", "http://localhost:8080/");
|
|
Svc.Prefs.set("username", "foo");
|
|
let server = httpd_setup({
|
|
"/1.0/foo/storage/crypto/steam": function(request, response) {
|
|
response.setStatusLine(request.httpVersion, 405, "Method Not Allowed");
|
|
response.bodyOutputStream.write("Fail!", 5);
|
|
}
|
|
});
|
|
do_test_pending();
|
|
|
|
let engine = makeSteamEngine();
|
|
try {
|
|
|
|
_("Getting the cryptometa will fail and should set the appropriate failure");
|
|
let error;
|
|
try {
|
|
engine._syncStartup();
|
|
} catch (ex) {
|
|
error = ex;
|
|
}
|
|
do_check_eq(error.failureCode, ENGINE_METARECORD_DOWNLOAD_FAIL);
|
|
|
|
} finally {
|
|
server.stop(do_test_finished);
|
|
Svc.Prefs.resetBranch("");
|
|
Records.clearCache();
|
|
syncTesting = new SyncTestingInfrastructure(makeSteamEngine);
|
|
}
|
|
}
|
|
|
|
function test_syncStartup_serverHasNewerVersion() {
|
|
_("SyncEngine._syncStartup ");
|
|
|
|
Svc.Prefs.set("clusterURL", "http://localhost:8080/");
|
|
Svc.Prefs.set("username", "foo");
|
|
let global = new ServerWBO('global', {engines: {steam: {version: 23456}}});
|
|
let server = httpd_setup({
|
|
"/1.0/foo/storage/meta/global": global.handler()
|
|
});
|
|
do_test_pending();
|
|
|
|
let engine = makeSteamEngine();
|
|
try {
|
|
|
|
// The server has a newer version of the data and our engine can
|
|
// handle. That should give us an exception.
|
|
let error;
|
|
try {
|
|
engine._syncStartup();
|
|
} catch (ex) {
|
|
error = ex;
|
|
}
|
|
do_check_eq(error.failureCode, VERSION_OUT_OF_DATE);
|
|
|
|
} finally {
|
|
server.stop(do_test_finished);
|
|
Svc.Prefs.resetBranch("");
|
|
Records.clearCache();
|
|
syncTesting = new SyncTestingInfrastructure(makeSteamEngine);
|
|
}
|
|
}
|
|
|
|
|
|
function test_syncStartup_syncIDMismatchResetsClient() {
|
|
_("SyncEngine._syncStartup resets sync if syncIDs don't match");
|
|
|
|
Svc.Prefs.set("clusterURL", "http://localhost:8080/");
|
|
Svc.Prefs.set("username", "foo");
|
|
let crypto_steam = new ServerWBO('steam');
|
|
let server = sync_httpd_setup({
|
|
"/1.0/foo/storage/crypto/steam": crypto_steam.handler()
|
|
});
|
|
do_test_pending();
|
|
|
|
// global record with a different syncID than our engine has
|
|
let engine = makeSteamEngine();
|
|
let global = new ServerWBO('global',
|
|
{engines: {steam: {version: engine.version,
|
|
syncID: 'foobar'}}});
|
|
server.registerPathHandler("/1.0/foo/storage/meta/global", global.handler());
|
|
|
|
createAndUploadKeypair();
|
|
|
|
try {
|
|
|
|
// Confirm initial environment
|
|
do_check_eq(engine.syncID, 'fake-guid-0');
|
|
do_check_eq(crypto_steam.payload, undefined);
|
|
do_check_eq(engine._tracker.changedIDs["rekolok"], undefined);
|
|
|
|
engine.lastSync = Date.now() / 1000;
|
|
engine._syncStartup();
|
|
|
|
// The engine has assumed the server's syncID
|
|
do_check_eq(engine.syncID, 'foobar');
|
|
|
|
// Sync was reset
|
|
do_check_eq(engine.lastSync, 0);
|
|
|
|
} finally {
|
|
server.stop(do_test_finished);
|
|
Svc.Prefs.resetBranch("");
|
|
Records.clearCache();
|
|
CryptoMetas.clearCache();
|
|
syncTesting = new SyncTestingInfrastructure(makeSteamEngine);
|
|
}
|
|
}
|
|
|
|
|
|
function test_syncStartup_badKeyWipesServerData() {
|
|
_("SyncEngine._syncStartup resets sync and wipes server data if there's something wrong with the symmetric key");
|
|
|
|
Svc.Prefs.set("clusterURL", "http://localhost:8080/");
|
|
Svc.Prefs.set("username", "foo");
|
|
|
|
// A symmetric key with an incorrect HMAC
|
|
let crypto_steam = new ServerWBO('steam');
|
|
crypto_steam.payload = JSON.stringify({
|
|
keyring: {
|
|
"http://localhost:8080/1.0/foo/storage/keys/pubkey": {
|
|
wrapped: Svc.Crypto.generateRandomKey(),
|
|
hmac: "this-hmac-is-incorrect"
|
|
}
|
|
}
|
|
});
|
|
|
|
// A proper global record with matching version and syncID
|
|
let engine = makeSteamEngine();
|
|
let global = new ServerWBO('global',
|
|
{engines: {steam: {version: engine.version,
|
|
syncID: engine.syncID}}});
|
|
|
|
// Some server side data that's going to be wiped
|
|
let collection = new ServerCollection();
|
|
collection.wbos.flying = new ServerWBO(
|
|
'flying', encryptPayload({id: 'flying',
|
|
denomination: "LNER Class A3 4472"}));
|
|
collection.wbos.scotsman = new ServerWBO(
|
|
'scotsman', encryptPayload({id: 'scotsman',
|
|
denomination: "Flying Scotsman"}));
|
|
|
|
let server = sync_httpd_setup({
|
|
"/1.0/foo/storage/crypto/steam": crypto_steam.handler(),
|
|
"/1.0/foo/storage/steam": collection.handler()
|
|
});
|
|
do_test_pending();
|
|
createAndUploadKeypair();
|
|
|
|
try {
|
|
|
|
// Confirm initial environment
|
|
let key = crypto_steam.data.keyring["http://localhost:8080/1.0/foo/storage/keys/pubkey"];
|
|
do_check_eq(key.wrapped, "fake-symmetric-key-0");
|
|
do_check_eq(key.hmac, "this-hmac-is-incorrect");
|
|
do_check_true(!!collection.wbos.flying.payload);
|
|
do_check_true(!!collection.wbos.scotsman.payload);
|
|
|
|
engine.lastSync = Date.now() / 1000;
|
|
engine._syncStartup();
|
|
|
|
// Sync was reset and server data was wiped
|
|
do_check_eq(engine.lastSync, 0);
|
|
do_check_eq(collection.wbos.flying.payload, undefined);
|
|
do_check_eq(collection.wbos.scotsman.payload, undefined);
|
|
|
|
// New bulk key was uploaded
|
|
key = crypto_steam.data.keyring["http://localhost:8080/1.0/foo/storage/keys/pubkey"];
|
|
do_check_eq(key.wrapped, "fake-symmetric-key-1");
|
|
do_check_eq(key.hmac, "fake-symmetric-key-1 ");
|
|
|
|
} finally {
|
|
server.stop(do_test_finished);
|
|
Svc.Prefs.resetBranch("");
|
|
Records.clearCache();
|
|
CryptoMetas.clearCache();
|
|
syncTesting = new SyncTestingInfrastructure(makeSteamEngine);
|
|
}
|
|
}
|
|
|
|
|
|
function test_processIncoming_emptyServer() {
|
|
_("SyncEngine._processIncoming working with an empty server backend");
|
|
|
|
Svc.Prefs.set("clusterURL", "http://localhost:8080/");
|
|
Svc.Prefs.set("username", "foo");
|
|
let crypto_steam = new ServerWBO('steam');
|
|
let collection = new ServerCollection();
|
|
|
|
let server = sync_httpd_setup({
|
|
"/1.0/foo/storage/crypto/steam": crypto_steam.handler(),
|
|
"/1.0/foo/storage/steam": collection.handler()
|
|
});
|
|
do_test_pending();
|
|
createAndUploadKeypair();
|
|
|
|
let engine = makeSteamEngine();
|
|
try {
|
|
|
|
// Merely ensure that this code path is run without any errors
|
|
engine._processIncoming();
|
|
do_check_eq(engine.lastSync, 0);
|
|
do_check_eq(engine.toFetch.length, 0);
|
|
|
|
} finally {
|
|
server.stop(do_test_finished);
|
|
Svc.Prefs.resetBranch("");
|
|
Records.clearCache();
|
|
CryptoMetas.clearCache();
|
|
syncTesting = new SyncTestingInfrastructure(makeSteamEngine);
|
|
}
|
|
}
|
|
|
|
|
|
function test_processIncoming_createFromServer() {
|
|
_("SyncEngine._processIncoming creates new records from server data");
|
|
|
|
Svc.Prefs.set("clusterURL", "http://localhost:8080/");
|
|
Svc.Prefs.set("username", "foo");
|
|
let crypto_steam = new ServerWBO('steam');
|
|
|
|
// Some server records that will be downloaded
|
|
let collection = new ServerCollection();
|
|
collection.wbos.flying = new ServerWBO(
|
|
'flying', encryptPayload({id: 'flying',
|
|
denomination: "LNER Class A3 4472"}));
|
|
collection.wbos.scotsman = new ServerWBO(
|
|
'scotsman', encryptPayload({id: 'scotsman',
|
|
denomination: "Flying Scotsman"}));
|
|
|
|
let server = sync_httpd_setup({
|
|
"/1.0/foo/storage/crypto/steam": crypto_steam.handler(),
|
|
"/1.0/foo/storage/steam": collection.handler(),
|
|
"/1.0/foo/storage/steam/flying": collection.wbos.flying.handler(),
|
|
"/1.0/foo/storage/steam/scotsman": collection.wbos.scotsman.handler()
|
|
});
|
|
do_test_pending();
|
|
createAndUploadKeypair();
|
|
createAndUploadSymKey("http://localhost:8080/1.0/foo/storage/crypto/steam");
|
|
|
|
let engine = makeSteamEngine();
|
|
try {
|
|
|
|
// Confirm initial environment
|
|
do_check_eq(engine.lastSync, 0);
|
|
do_check_eq(engine.lastModified, null);
|
|
do_check_eq(engine._store.items.flying, undefined);
|
|
do_check_eq(engine._store.items.scotsman, undefined);
|
|
|
|
engine._processIncoming();
|
|
|
|
// Timestamps of last sync and last server modification are set.
|
|
do_check_true(engine.lastSync > 0);
|
|
do_check_true(engine.lastModified > 0);
|
|
|
|
// Local records have been created from the server data.
|
|
do_check_eq(engine._store.items.flying, "LNER Class A3 4472");
|
|
do_check_eq(engine._store.items.scotsman, "Flying Scotsman");
|
|
|
|
} finally {
|
|
server.stop(do_test_finished);
|
|
Svc.Prefs.resetBranch("");
|
|
Records.clearCache();
|
|
CryptoMetas.clearCache();
|
|
syncTesting = new SyncTestingInfrastructure(makeSteamEngine);
|
|
}
|
|
}
|
|
|
|
|
|
function test_processIncoming_reconcile() {
|
|
_("SyncEngine._processIncoming updates local records");
|
|
|
|
Svc.Prefs.set("clusterURL", "http://localhost:8080/");
|
|
Svc.Prefs.set("username", "foo");
|
|
let crypto_steam = new ServerWBO('steam');
|
|
let collection = new ServerCollection();
|
|
|
|
// This server record is newer than the corresponding client one,
|
|
// so it'll update its data.
|
|
collection.wbos.newrecord = new ServerWBO(
|
|
'newrecord', encryptPayload({id: 'newrecord',
|
|
denomination: "New stuff..."}));
|
|
|
|
// This server record is newer than the corresponding client one,
|
|
// so it'll update its data.
|
|
collection.wbos.newerserver = new ServerWBO(
|
|
'newerserver', encryptPayload({id: 'newerserver',
|
|
denomination: "New data!"}));
|
|
|
|
// This server record is 2 mins older than the client counterpart
|
|
// but identical to it, so we're expecting the client record's
|
|
// changedID to be reset.
|
|
collection.wbos.olderidentical = new ServerWBO(
|
|
'olderidentical', encryptPayload({id: 'olderidentical',
|
|
denomination: "Older but identical"}));
|
|
collection.wbos.olderidentical.modified -= 120;
|
|
|
|
// This item simply has different data than the corresponding client
|
|
// record (which is unmodified), so it will update the client as well
|
|
collection.wbos.updateclient = new ServerWBO(
|
|
'updateclient', encryptPayload({id: 'updateclient',
|
|
denomination: "Get this!"}));
|
|
|
|
// This is a dupe of 'original' but with a longer GUID, so we're
|
|
// expecting it to be marked for deletion from the server
|
|
collection.wbos.duplication = new ServerWBO(
|
|
'duplication', encryptPayload({id: 'duplication',
|
|
denomination: "Original Entry"}));
|
|
|
|
// This is a dupe of 'long_original' but with a shorter GUID, so we're
|
|
// expecting it to replace 'long_original'.
|
|
collection.wbos.dupe = new ServerWBO(
|
|
'dupe', encryptPayload({id: 'dupe',
|
|
denomination: "Long Original Entry"}));
|
|
|
|
// This record is marked as deleted, so we're expecting the client
|
|
// record to be removed.
|
|
collection.wbos.nukeme = new ServerWBO(
|
|
'nukeme', encryptPayload({id: 'nukeme',
|
|
denomination: "Nuke me!",
|
|
deleted: true}));
|
|
|
|
let server = sync_httpd_setup({
|
|
"/1.0/foo/storage/crypto/steam": crypto_steam.handler(),
|
|
"/1.0/foo/storage/steam": collection.handler()
|
|
});
|
|
do_test_pending();
|
|
createAndUploadKeypair();
|
|
createAndUploadSymKey("http://localhost:8080/1.0/foo/storage/crypto/steam");
|
|
|
|
let engine = makeSteamEngine();
|
|
engine._store.items = {newerserver: "New data, but not as new as server!",
|
|
olderidentical: "Older but identical",
|
|
updateclient: "Got data?",
|
|
original: "Original Entry",
|
|
long_original: "Long Original Entry",
|
|
nukeme: "Nuke me!"};
|
|
// Make this record 1 min old, thus older than the one on the server
|
|
engine._tracker.addChangedID('newerserver', Date.now()/1000 - 60);
|
|
// This record has been changed 2 mins later than the one on the server
|
|
engine._tracker.addChangedID('olderidentical', Date.now()/1000);
|
|
|
|
try {
|
|
|
|
// Confirm initial environment
|
|
do_check_eq(engine._store.items.newrecord, undefined);
|
|
do_check_eq(engine._store.items.newerserver, "New data, but not as new as server!");
|
|
do_check_eq(engine._store.items.olderidentical, "Older but identical");
|
|
do_check_eq(engine._store.items.updateclient, "Got data?");
|
|
do_check_eq(engine._store.items.nukeme, "Nuke me!");
|
|
do_check_true(engine._tracker.changedIDs['olderidentical'] > 0);
|
|
|
|
engine._delete = {}; // normally set up by _syncStartup
|
|
engine._processIncoming();
|
|
|
|
// Timestamps of last sync and last server modification are set.
|
|
do_check_true(engine.lastSync > 0);
|
|
do_check_true(engine.lastModified > 0);
|
|
|
|
// The new record is created.
|
|
do_check_eq(engine._store.items.newrecord, "New stuff...");
|
|
|
|
// The 'newerserver' record is updated since the server data is newer.
|
|
do_check_eq(engine._store.items.newerserver, "New data!");
|
|
|
|
// The data for 'olderidentical' is identical on the server, so
|
|
// it's no longer marked as changed anymore.
|
|
do_check_eq(engine._store.items.olderidentical, "Older but identical");
|
|
do_check_eq(engine._tracker.changedIDs['olderidentical'], undefined);
|
|
|
|
// Updated with server data.
|
|
do_check_eq(engine._store.items.updateclient, "Get this!");
|
|
|
|
// The dupe with the shorter ID is kept, the longer one is slated
|
|
// for deletion.
|
|
do_check_eq(engine._store.items.long_original, undefined);
|
|
do_check_eq(engine._store.items.dupe, "Long Original Entry");
|
|
do_check_neq(engine._delete.ids.indexOf('duplication'), -1);
|
|
|
|
// The 'nukeme' record marked as deleted is removed.
|
|
do_check_eq(engine._store.items.nukeme, undefined);
|
|
|
|
} finally {
|
|
server.stop(do_test_finished);
|
|
Svc.Prefs.resetBranch("");
|
|
Records.clearCache();
|
|
CryptoMetas.clearCache();
|
|
syncTesting = new SyncTestingInfrastructure(makeSteamEngine);
|
|
}
|
|
}
|
|
|
|
|
|
function test_processIncoming_fetchNum() {
|
|
_("SyncEngine._processIncoming doesn't fetch everything at ones on mobile clients");
|
|
|
|
Svc.Prefs.set("clusterURL", "http://localhost:8080/");
|
|
Svc.Prefs.set("username", "foo");
|
|
Svc.Prefs.set("client.type", "mobile");
|
|
let crypto_steam = new ServerWBO('steam');
|
|
let collection = new ServerCollection();
|
|
|
|
// Let's create some 234 server side records. They're all at least
|
|
// 10 minutes old.
|
|
for (var i = 0; i < 234; i++) {
|
|
let id = 'record-no-' + i;
|
|
let payload = encryptPayload({id: id, denomination: "Record No. " + i});
|
|
let wbo = new ServerWBO(id, payload);
|
|
wbo.modified = Date.now()/1000 - 60*(i+10);
|
|
collection.wbos[id] = wbo;
|
|
}
|
|
|
|
let server = sync_httpd_setup({
|
|
"/1.0/foo/storage/crypto/steam": crypto_steam.handler(),
|
|
"/1.0/foo/storage/steam": collection.handler()
|
|
});
|
|
do_test_pending();
|
|
createAndUploadKeypair();
|
|
createAndUploadSymKey("http://localhost:8080/1.0/foo/storage/crypto/steam");
|
|
|
|
let engine = makeSteamEngine();
|
|
|
|
try {
|
|
|
|
// On a mobile client, the first sync will only get the first 50
|
|
// objects from the server
|
|
engine._processIncoming();
|
|
do_check_eq([id for (id in engine._store.items)].length, 50);
|
|
do_check_true('record-no-0' in engine._store.items);
|
|
do_check_true('record-no-49' in engine._store.items);
|
|
do_check_eq(engine.toFetch.length, 234 - 50);
|
|
|
|
|
|
// The next sync will get another 50 objects, assuming the server
|
|
// hasn't got any new data.
|
|
engine._processIncoming();
|
|
do_check_eq([id for (id in engine._store.items)].length, 100);
|
|
do_check_true('record-no-50' in engine._store.items);
|
|
do_check_true('record-no-99' in engine._store.items);
|
|
do_check_eq(engine.toFetch.length, 234 - 100);
|
|
|
|
|
|
// Now let's say there are some new items on the server
|
|
for (i=0; i < 5; i++) {
|
|
let id = 'new-record-no-' + i;
|
|
let payload = encryptPayload({id: id, denomination: "New record No. " + i});
|
|
let wbo = new ServerWBO(id, payload);
|
|
wbo.modified = Date.now()/1000 - 60*i;
|
|
collection.wbos[id] = wbo;
|
|
}
|
|
// Let's tell the engine the server has got newer data. This is
|
|
// normally done by the WeaveSvc after retrieving info/collections.
|
|
engine.lastModified = Date.now() / 1000 + 1;
|
|
|
|
// Now we'll fetch another 50 items, but 5 of those are the new
|
|
// ones, so we've only fetched another 45 of the older ones.
|
|
engine._processIncoming();
|
|
do_check_eq([id for (id in engine._store.items)].length, 150);
|
|
do_check_true('new-record-no-0' in engine._store.items);
|
|
do_check_true('new-record-no-4' in engine._store.items);
|
|
do_check_true('record-no-100' in engine._store.items);
|
|
do_check_true('record-no-144' in engine._store.items);
|
|
do_check_eq(engine.toFetch.length, 234 - 100 - 45);
|
|
|
|
|
|
// Now let's modify a few existing records on the server so that
|
|
// they have to be refetched.
|
|
collection.wbos['record-no-3'].modified = Date.now()/1000 + 1;
|
|
collection.wbos['record-no-41'].modified = Date.now()/1000 + 1;
|
|
collection.wbos['record-no-122'].modified = Date.now()/1000 + 1;
|
|
|
|
// Once again we'll tell the engine that the server's got newer data
|
|
// and once again we'll fetch 50 items, but 3 of those are the
|
|
// existing records, so we're only fetching 47 new ones.
|
|
engine.lastModified = Date.now() / 1000 + 2;
|
|
engine._processIncoming();
|
|
do_check_eq([id for (id in engine._store.items)].length, 197);
|
|
do_check_true('record-no-145' in engine._store.items);
|
|
do_check_true('record-no-191' in engine._store.items);
|
|
do_check_eq(engine.toFetch.length, 234 - 100 - 45 - 47);
|
|
|
|
|
|
// Finally let's fetch the rest, making sure that will fetch
|
|
// everything up to the last record.
|
|
while(engine.toFetch.length) {
|
|
engine._processIncoming();
|
|
}
|
|
do_check_eq([id for (id in engine._store.items)].length, 234 + 5);
|
|
do_check_true('record-no-233' in engine._store.items);
|
|
|
|
} finally {
|
|
server.stop(do_test_finished);
|
|
Svc.Prefs.resetBranch("");
|
|
Records.clearCache();
|
|
CryptoMetas.clearCache();
|
|
syncTesting = new SyncTestingInfrastructure(makeSteamEngine);
|
|
}
|
|
}
|
|
|
|
|
|
function test_uploadOutgoing_toEmptyServer() {
|
|
_("SyncEngine._uploadOutgoing uploads new records to server");
|
|
|
|
Svc.Prefs.set("clusterURL", "http://localhost:8080/");
|
|
Svc.Prefs.set("username", "foo");
|
|
let crypto_steam = new ServerWBO('steam');
|
|
let collection = new ServerCollection();
|
|
collection.wbos.flying = new ServerWBO('flying');
|
|
collection.wbos.scotsman = new ServerWBO('scotsman');
|
|
|
|
let server = sync_httpd_setup({
|
|
"/1.0/foo/storage/crypto/steam": crypto_steam.handler(),
|
|
"/1.0/foo/storage/steam": collection.handler(),
|
|
"/1.0/foo/storage/steam/flying": collection.wbos.flying.handler(),
|
|
"/1.0/foo/storage/steam/scotsman": collection.wbos.scotsman.handler()
|
|
});
|
|
do_test_pending();
|
|
createAndUploadKeypair();
|
|
createAndUploadSymKey("http://localhost:8080/1.0/foo/storage/crypto/steam");
|
|
|
|
let engine = makeSteamEngine();
|
|
engine._store.items = {flying: "LNER Class A3 4472",
|
|
scotsman: "Flying Scotsman"};
|
|
// Mark one of these records as changed
|
|
engine._tracker.addChangedID('scotsman', 0);
|
|
|
|
try {
|
|
|
|
// Confirm initial environment
|
|
do_check_eq(collection.wbos.flying.payload, undefined);
|
|
do_check_eq(collection.wbos.scotsman.payload, undefined);
|
|
do_check_eq(engine._tracker.changedIDs['scotsman'], 0);
|
|
|
|
engine._uploadOutgoing();
|
|
|
|
// Ensure the marked record ('scotsman') has been uploaded and is
|
|
// no longer marked.
|
|
do_check_eq(collection.wbos.flying.payload, undefined);
|
|
do_check_true(!!collection.wbos.scotsman.payload);
|
|
do_check_eq(JSON.parse(collection.wbos.scotsman.data.ciphertext).id,
|
|
'scotsman');
|
|
do_check_eq(engine._tracker.changedIDs['scotsman'], undefined);
|
|
|
|
// The 'flying' record wasn't marked so it wasn't uploaded
|
|
do_check_eq(collection.wbos.flying.payload, undefined);
|
|
|
|
} finally {
|
|
server.stop(do_test_finished);
|
|
Svc.Prefs.resetBranch("");
|
|
Records.clearCache();
|
|
CryptoMetas.clearCache();
|
|
syncTesting = new SyncTestingInfrastructure(makeSteamEngine);
|
|
}
|
|
}
|
|
|
|
|
|
function test_uploadOutgoing_failed() {
|
|
_("SyncEngine._uploadOutgoing doesn't clear the tracker of objects that failed to upload.");
|
|
|
|
Svc.Prefs.set("clusterURL", "http://localhost:8080/");
|
|
Svc.Prefs.set("username", "foo");
|
|
let crypto_steam = new ServerWBO('steam');
|
|
let collection = new ServerCollection();
|
|
// We only define the "flying" WBO on the server, not the "scotsman"
|
|
// and "peppercorn" ones.
|
|
collection.wbos.flying = new ServerWBO('flying');
|
|
|
|
let server = sync_httpd_setup({
|
|
"/1.0/foo/storage/crypto/steam": crypto_steam.handler(),
|
|
"/1.0/foo/storage/steam": collection.handler()
|
|
});
|
|
do_test_pending();
|
|
createAndUploadKeypair();
|
|
createAndUploadSymKey("http://localhost:8080/1.0/foo/storage/crypto/steam");
|
|
|
|
let engine = makeSteamEngine();
|
|
engine._store.items = {flying: "LNER Class A3 4472",
|
|
scotsman: "Flying Scotsman",
|
|
peppercorn: "Peppercorn Class"};
|
|
// Mark one of these records as changed
|
|
const FLYING_CHANGED = 12345;
|
|
const SCOTSMAN_CHANGED = 23456;
|
|
const PEPPERCORN_CHANGED = 34567;
|
|
engine._tracker.addChangedID('flying', FLYING_CHANGED);
|
|
engine._tracker.addChangedID('scotsman', SCOTSMAN_CHANGED);
|
|
engine._tracker.addChangedID('peppercorn', PEPPERCORN_CHANGED);
|
|
|
|
try {
|
|
|
|
// Confirm initial environment
|
|
do_check_eq(collection.wbos.flying.payload, undefined);
|
|
do_check_eq(engine._tracker.changedIDs['flying'], FLYING_CHANGED);
|
|
do_check_eq(engine._tracker.changedIDs['scotsman'], SCOTSMAN_CHANGED);
|
|
do_check_eq(engine._tracker.changedIDs['peppercorn'], PEPPERCORN_CHANGED);
|
|
|
|
engine._uploadOutgoing();
|
|
|
|
// Ensure the 'flying' record has been uploaded and is no longer marked.
|
|
do_check_true(!!collection.wbos.flying.payload);
|
|
do_check_eq(engine._tracker.changedIDs['flying'], undefined);
|
|
|
|
// The 'scotsman' and 'peppercorn' records couldn't be uploaded so
|
|
// they weren't cleared from the tracker.
|
|
do_check_eq(engine._tracker.changedIDs['scotsman'], SCOTSMAN_CHANGED);
|
|
do_check_eq(engine._tracker.changedIDs['peppercorn'], PEPPERCORN_CHANGED);
|
|
|
|
} finally {
|
|
server.stop(do_test_finished);
|
|
Svc.Prefs.resetBranch("");
|
|
Records.clearCache();
|
|
CryptoMetas.clearCache();
|
|
syncTesting = new SyncTestingInfrastructure(makeSteamEngine);
|
|
}
|
|
}
|
|
|
|
|
|
function test_uploadOutgoing_MAX_UPLOAD_RECORDS() {
|
|
_("SyncEngine._uploadOutgoing uploads in batches of MAX_UPLOAD_RECORDS");
|
|
|
|
Svc.Prefs.set("clusterURL", "http://localhost:8080/");
|
|
Svc.Prefs.set("username", "foo");
|
|
let crypto_steam = new ServerWBO('steam');
|
|
let collection = new ServerCollection();
|
|
|
|
// Let's count how many times the client posts to the server
|
|
var noOfUploads = 0;
|
|
collection.post = (function(orig) {
|
|
return function() {
|
|
noOfUploads++;
|
|
return orig.apply(this, arguments);
|
|
};
|
|
}(collection.post));
|
|
|
|
// Create a bunch of records (and server side handlers)
|
|
let engine = makeSteamEngine();
|
|
for (var i = 0; i < 234; i++) {
|
|
let id = 'record-no-' + i;
|
|
engine._store.items[id] = "Record No. " + i;
|
|
engine._tracker.addChangedID(id, 0);
|
|
collection.wbos[id] = new ServerWBO(id);
|
|
}
|
|
|
|
let server = sync_httpd_setup({
|
|
"/1.0/foo/storage/crypto/steam": crypto_steam.handler(),
|
|
"/1.0/foo/storage/steam": collection.handler()
|
|
});
|
|
do_test_pending();
|
|
createAndUploadKeypair();
|
|
createAndUploadSymKey("http://localhost:8080/1.0/foo/storage/crypto/steam");
|
|
|
|
try {
|
|
|
|
// Confirm initial environment
|
|
do_check_eq(noOfUploads, 0);
|
|
|
|
engine._uploadOutgoing();
|
|
|
|
// Ensure all records have been uploaded
|
|
for (i = 0; i < 234; i++) {
|
|
do_check_true(!!collection.wbos['record-no-'+i].payload);
|
|
}
|
|
|
|
// Ensure that the uploads were performed in batches of MAX_UPLOAD_RECORDS
|
|
do_check_eq(noOfUploads, Math.ceil(234/MAX_UPLOAD_RECORDS));
|
|
|
|
} finally {
|
|
server.stop(do_test_finished);
|
|
Svc.Prefs.resetBranch("");
|
|
Records.clearCache();
|
|
CryptoMetas.clearCache();
|
|
syncTesting = new SyncTestingInfrastructure(makeSteamEngine);
|
|
}
|
|
}
|
|
|
|
|
|
function test_syncFinish_noDelete() {
|
|
_("SyncEngine._syncFinish resets tracker's score");
|
|
let engine = makeSteamEngine();
|
|
engine._delete = {}; // Nothing to delete
|
|
engine._tracker.score = 100;
|
|
|
|
// _syncFinish() will reset the engine's score.
|
|
engine._syncFinish();
|
|
do_check_eq(engine.score, 0);
|
|
}
|
|
|
|
|
|
function test_syncFinish_deleteByIds() {
|
|
_("SyncEngine._syncFinish deletes server records slated for deletion (list of record IDs).");
|
|
|
|
Svc.Prefs.set("clusterURL", "http://localhost:8080/");
|
|
Svc.Prefs.set("username", "foo");
|
|
let collection = new ServerCollection();
|
|
collection.wbos.flying = new ServerWBO(
|
|
'flying', encryptPayload({id: 'flying',
|
|
denomination: "LNER Class A3 4472"}));
|
|
collection.wbos.scotsman = new ServerWBO(
|
|
'scotsman', encryptPayload({id: 'scotsman',
|
|
denomination: "Flying Scotsman"}));
|
|
collection.wbos.rekolok = new ServerWBO(
|
|
'rekolok', encryptPayload({id: 'rekolok',
|
|
denomination: "Rekonstruktionslokomotive"}));
|
|
|
|
let server = httpd_setup({
|
|
"/1.0/foo/storage/steam": collection.handler()
|
|
});
|
|
do_test_pending();
|
|
|
|
let engine = makeSteamEngine();
|
|
try {
|
|
engine._delete = {ids: ['flying', 'rekolok']};
|
|
engine._syncFinish();
|
|
|
|
// The 'flying' and 'rekolok' records were deleted while the
|
|
// 'scotsman' one wasn't.
|
|
do_check_eq(collection.wbos.flying.payload, undefined);
|
|
do_check_true(!!collection.wbos.scotsman.payload);
|
|
do_check_eq(collection.wbos.rekolok.payload, undefined);
|
|
|
|
// The deletion todo list has been reset.
|
|
do_check_eq(engine._delete.ids, undefined);
|
|
|
|
} finally {
|
|
server.stop(do_test_finished);
|
|
Svc.Prefs.resetBranch("");
|
|
Records.clearCache();
|
|
syncTesting = new SyncTestingInfrastructure(makeSteamEngine);
|
|
}
|
|
}
|
|
|
|
|
|
function test_syncFinish_deleteLotsInBatches() {
|
|
_("SyncEngine._syncFinish deletes server records in batches of 100 (list of record IDs).");
|
|
|
|
Svc.Prefs.set("clusterURL", "http://localhost:8080/");
|
|
Svc.Prefs.set("username", "foo");
|
|
let collection = new ServerCollection();
|
|
|
|
// Let's count how many times the client does a DELETE request to the server
|
|
var noOfUploads = 0;
|
|
collection.delete = (function(orig) {
|
|
return function() {
|
|
noOfUploads++;
|
|
return orig.apply(this, arguments);
|
|
};
|
|
}(collection.delete));
|
|
|
|
// Create a bunch of records on the server
|
|
let now = Date.now();
|
|
for (var i = 0; i < 234; i++) {
|
|
let id = 'record-no-' + i;
|
|
let payload = encryptPayload({id: id, denomination: "Record No. " + i});
|
|
let wbo = new ServerWBO(id, payload);
|
|
wbo.modified = now / 1000 - 60 * (i + 110);
|
|
collection.wbos[id] = wbo;
|
|
}
|
|
|
|
let server = httpd_setup({
|
|
"/1.0/foo/storage/steam": collection.handler()
|
|
});
|
|
do_test_pending();
|
|
|
|
let engine = makeSteamEngine();
|
|
try {
|
|
|
|
// Confirm initial environment
|
|
do_check_eq(noOfUploads, 0);
|
|
|
|
// Declare what we want to have deleted: all records no. 100 and
|
|
// up and all records that are less than 200 mins old (which are
|
|
// records 0 thru 90).
|
|
engine._delete = {ids: [],
|
|
newer: now / 1000 - 60 * 200.5};
|
|
for (i = 100; i < 234; i++) {
|
|
engine._delete.ids.push('record-no-' + i);
|
|
}
|
|
|
|
engine._syncFinish();
|
|
|
|
// Ensure that the appropriate server data has been wiped while
|
|
// preserving records 90 thru 200.
|
|
for (i = 0; i < 234; i++) {
|
|
let id = 'record-no-' + i;
|
|
if (i <= 90 || i >= 100) {
|
|
do_check_eq(collection.wbos[id].payload, undefined);
|
|
} else {
|
|
do_check_true(!!collection.wbos[id].payload);
|
|
}
|
|
}
|
|
|
|
// The deletion was done in batches
|
|
do_check_eq(noOfUploads, 2 + 1);
|
|
|
|
// The deletion todo list has been reset.
|
|
do_check_eq(engine._delete.ids, undefined);
|
|
|
|
} finally {
|
|
server.stop(do_test_finished);
|
|
Svc.Prefs.resetBranch("");
|
|
Records.clearCache();
|
|
syncTesting = new SyncTestingInfrastructure(makeSteamEngine);
|
|
}
|
|
}
|
|
|
|
function run_test() {
|
|
test_syncStartup_emptyOrOutdatedGlobalsResetsSync();
|
|
test_syncStartup_metaGet404();
|
|
test_syncStartup_failedMetaGet();
|
|
test_syncStartup_serverHasNewerVersion();
|
|
test_syncStartup_syncIDMismatchResetsClient();
|
|
test_syncStartup_badKeyWipesServerData();
|
|
test_processIncoming_emptyServer();
|
|
test_processIncoming_createFromServer();
|
|
test_processIncoming_reconcile();
|
|
test_processIncoming_fetchNum();
|
|
test_uploadOutgoing_toEmptyServer();
|
|
test_uploadOutgoing_failed();
|
|
test_uploadOutgoing_MAX_UPLOAD_RECORDS();
|
|
test_syncFinish_noDelete();
|
|
test_syncFinish_deleteByIds();
|
|
test_syncFinish_deleteLotsInBatches();
|
|
}
|