@worldbrain/storex-sync
Version:
Offline-first syncing between multiple databases using Storex
362 lines • 17 kB
JavaScript
"use strict";
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var _this = this;
Object.defineProperty(exports, "__esModule", { value: true });
var expect = require("expect");
var storex_1 = require("@worldbrain/storex");
var storex_backend_dexie_1 = require("@worldbrain/storex-backend-dexie");
var in_memory_1 = require("@worldbrain/storex-backend-dexie/lib/in-memory");
var storex_pattern_modules_1 = require("@worldbrain/storex-pattern-modules");
var _1 = require("./");
var TEST_LOG_ENTRIES = [
{
createdOn: 2,
sharedOn: null,
needsIntegration: false,
collection: 'user',
pk: '1:1',
operation: 'create',
value: { displayName: 'Joe' },
},
{
createdOn: 3,
sharedOn: null,
needsIntegration: false,
collection: 'user',
pk: '2:1',
operation: 'create',
value: { displayName: 'Joe' },
},
{
createdOn: 4,
sharedOn: null,
needsIntegration: false,
collection: 'user',
pk: '1:2',
operation: 'create',
value: { displayName: 'Joe' },
},
];
function setupTest() {
return __awaiter(this, void 0, void 0, function () {
var backend, storageManager, syncLogStorage;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
backend = new storex_backend_dexie_1.DexieStorageBackend({ idbImplementation: in_memory_1.default(), dbName: 'unittest' });
storageManager = new storex_1.default({ backend: backend });
syncLogStorage = new _1.ClientSyncLogStorage({ storageManager: storageManager });
storex_pattern_modules_1.registerModuleCollections(storageManager.registry, syncLogStorage);
return [4, storageManager.finishInitialization()];
case 1:
_a.sent();
return [2, { syncLogStorage: syncLogStorage }];
}
});
});
}
describe('Client sync log', function () {
it('should store and retrieve entries correctly', function () { return __awaiter(_this, void 0, void 0, function () {
var syncLogStorage, _a, _b;
return __generator(this, function (_c) {
switch (_c.label) {
case 0: return [4, setupTest()];
case 1:
syncLogStorage = (_c.sent()).syncLogStorage;
return [4, syncLogStorage.insertEntries([TEST_LOG_ENTRIES[0], TEST_LOG_ENTRIES[2]])];
case 2:
_c.sent();
_a = expect;
return [4, syncLogStorage.getEntriesCreatedAfter(2)];
case 3:
_a.apply(void 0, [_c.sent()]).toEqual([
__assign({}, TEST_LOG_ENTRIES[0], { id: 1 }),
__assign({}, TEST_LOG_ENTRIES[2], { id: 2 }),
]);
_b = expect;
return [4, syncLogStorage.getEntriesCreatedAfter(3)];
case 4:
_b.apply(void 0, [_c.sent()]).toEqual([
__assign({}, TEST_LOG_ENTRIES[2], { id: 2 }),
]);
return [2];
}
});
}); });
it('should store and retrieve entries received out-of-order correctly', function () { return __awaiter(_this, void 0, void 0, function () {
var syncLogStorage, _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4, setupTest()];
case 1:
syncLogStorage = (_b.sent()).syncLogStorage;
return [4, syncLogStorage.insertEntries([TEST_LOG_ENTRIES[0], TEST_LOG_ENTRIES[2]])];
case 2:
_b.sent();
return [4, syncLogStorage.insertEntries([TEST_LOG_ENTRIES[1]])];
case 3:
_b.sent();
_a = expect;
return [4, syncLogStorage.getEntriesCreatedAfter(2)];
case 4:
_a.apply(void 0, [_b.sent()]).toEqual([
__assign({}, TEST_LOG_ENTRIES[0], { id: 1 }),
__assign({}, TEST_LOG_ENTRIES[1], { id: 3 }),
__assign({}, TEST_LOG_ENTRIES[2], { id: 2 }),
]);
return [2];
}
});
}); });
it('should mark entries as synced', function () { return __awaiter(_this, void 0, void 0, function () {
var syncLogStorage, _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4, setupTest()];
case 1:
syncLogStorage = (_b.sent()).syncLogStorage;
return [4, syncLogStorage.insertEntries([TEST_LOG_ENTRIES[0], TEST_LOG_ENTRIES[1], TEST_LOG_ENTRIES[2]])];
case 2:
_b.sent();
return [4, syncLogStorage.updateSharedUntil({ until: 3, sharedOn: 6 })];
case 3:
_b.sent();
_a = expect;
return [4, syncLogStorage.getEntriesCreatedAfter(2)];
case 4:
_a.apply(void 0, [_b.sent()]).toEqual([
__assign({}, TEST_LOG_ENTRIES[0], { id: 1, sharedOn: 6 }),
__assign({}, TEST_LOG_ENTRIES[1], { id: 2, sharedOn: 6 }),
__assign({}, TEST_LOG_ENTRIES[2], { id: 3 }),
]);
return [2];
}
});
}); });
it('should retrieve unshared entries in order of createdOn', function () { return __awaiter(_this, void 0, void 0, function () {
var syncLogStorage, _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4, setupTest()];
case 1:
syncLogStorage = (_b.sent()).syncLogStorage;
return [4, syncLogStorage.insertEntries([TEST_LOG_ENTRIES[0], TEST_LOG_ENTRIES[2]])];
case 2:
_b.sent();
return [4, syncLogStorage.insertEntries([TEST_LOG_ENTRIES[1]])];
case 3:
_b.sent();
return [4, syncLogStorage.updateSharedUntil({ until: 2, sharedOn: 6 })];
case 4:
_b.sent();
_a = expect;
return [4, syncLogStorage.getUnsharedEntries()];
case 5:
_a.apply(void 0, [_b.sent()]).toEqual([
__assign({}, TEST_LOG_ENTRIES[1], { id: 3 }),
__assign({}, TEST_LOG_ENTRIES[2], { id: 2 }),
]);
return [2];
}
});
}); });
it('should be able to insert entries received from shared log', function () { return __awaiter(_this, void 0, void 0, function () {
var syncLogStorage, now, _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4, setupTest()];
case 1:
syncLogStorage = (_b.sent()).syncLogStorage;
now = 56;
return [4, syncLogStorage.insertReceivedEntries(TEST_LOG_ENTRIES.slice(0, 1).map(function (entry) { return ({
userId: 'test-user-1',
deviceId: 'u1d1',
createdOn: entry.createdOn,
sharedOn: now - 10,
data: JSON.stringify({
collection: entry.collection,
pk: entry.pk,
operation: entry.operation,
value: entry['value'],
})
}); }), { now: now })];
case 2:
_b.sent();
_a = expect;
return [4, syncLogStorage.getEntriesCreatedAfter(1)];
case 3:
_a.apply(void 0, [_b.sent()]).toEqual([
{
id: 1,
createdOn: 2,
sharedOn: now,
needsIntegration: true,
collection: 'user',
pk: '1:1',
field: undefined,
operation: 'create',
value: { displayName: 'Joe' },
}
]);
return [2];
}
});
}); });
it('should be able to mark entries as integrated', function () { return __awaiter(_this, void 0, void 0, function () {
var syncLogStorage, entries, _a, _b, _c;
return __generator(this, function (_d) {
switch (_d.label) {
case 0: return [4, setupTest()];
case 1:
syncLogStorage = (_d.sent()).syncLogStorage;
entries = [
{
createdOn: 2, sharedOn: 10,
needsIntegration: true,
operation: 'create',
collection: 'user', pk: '1:1',
value: { displayName: 'Joe' },
},
{
createdOn: 2, sharedOn: 10,
needsIntegration: true,
operation: 'create',
collection: 'user', pk: '1:2',
value: { displayName: 'Joe' },
},
];
return [4, syncLogStorage.insertEntries(entries)];
case 2:
_d.sent();
_b = (_a = syncLogStorage).markAsIntegrated;
return [4, syncLogStorage.getEntriesCreatedAfter(1)];
case 3: return [4, _b.apply(_a, [_d.sent()])];
case 4:
_d.sent();
_c = expect;
return [4, syncLogStorage.getEntriesCreatedAfter(1)];
case 5:
_c.apply(void 0, [_d.sent()]).toEqual([
__assign({}, entries[0], { id: 1, needsIntegration: false }),
__assign({}, entries[1], { id: 2, needsIntegration: false }),
]);
return [2];
}
});
}); });
describe('getNextEntriesToIntgrate()', function () {
it('should be able to get all relevant operations that happened to a single object', function () { return __awaiter(_this, void 0, void 0, function () {
var syncLogStorage, entries, firstEntries, secondEntries, thirdEntries;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4, setupTest()];
case 1:
syncLogStorage = (_a.sent()).syncLogStorage;
entries = [
{
createdOn: 2, sharedOn: 10,
needsIntegration: true,
operation: 'create',
collection: 'user', pk: '1:1',
value: { displayName: 'Joe' },
},
{
createdOn: 2, sharedOn: 10,
needsIntegration: true,
operation: 'create',
collection: 'user', pk: '1:2',
value: { displayName: 'Joe' },
},
{
createdOn: 3, sharedOn: 10,
needsIntegration: true,
operation: 'modify',
collection: 'user', pk: '1:1', field: 'displayName',
value: 'Jack',
},
{
createdOn: 4, sharedOn: 10,
needsIntegration: true,
operation: 'delete',
collection: 'user', pk: '1:1',
},
];
return [4, syncLogStorage.insertEntries(entries)];
case 2:
_a.sent();
return [4, syncLogStorage.getNextEntriesToIntgrate()];
case 3:
firstEntries = _a.sent();
expect(firstEntries).toEqual([
__assign({ id: 1 }, entries[0]),
__assign({ id: 3 }, entries[2]),
__assign({ id: 4 }, entries[3]),
]);
return [4, syncLogStorage.markAsIntegrated(firstEntries)];
case 4:
_a.sent();
return [4, syncLogStorage.getNextEntriesToIntgrate()];
case 5:
secondEntries = _a.sent();
expect(secondEntries).toEqual([
__assign({ id: 2 }, entries[1]),
]);
return [4, syncLogStorage.markAsIntegrated(secondEntries)];
case 6:
_a.sent();
return [4, syncLogStorage.getNextEntriesToIntgrate()];
case 7:
thirdEntries = _a.sent();
expect(thirdEntries).toEqual(null);
return [2];
}
});
}); });
});
});
//# sourceMappingURL=index.test.js.map