sudo-archive/src/lib/storage/base.js

180 lines
6.3 KiB
JavaScript
Raw Normal View History

2021-10-24 21:10:47 +00:00
function buildStoreObject(data) {
return {
versions: data.versions,
currentVersion: data.maxVersion,
id: data.storageString,
update(obj) {
if (!obj)
throw new Error("object to update is not an object");
// repeat until object fully updated
while (obj["--version"] !== this.currentVersion) {
// get version
let version = obj["--version"] || 0;
if (version.constructor !== Number || version < 0)
2021-10-24 21:10:47 +00:00
version = -42; // invalid on purpose so it will reset
else {
version = (version+1).toString()
}
// check if version exists
if (!this.versions[version]) {
console.error(`Version not found for storage item in store ${this.id}, resetting`);
obj = null;
break;
}
// update object
obj = this.versions[version].update(obj);
console.log(obj);
}
// if resulting obj is null, use latest version as init object
if (obj === null) {
console.error(`Storage item for store ${this.id} has been reset due to faulty updates`);
return this.versions[this.currentVersion.toString()].init();
}
// updates succesful, return
return obj;
},
2021-10-24 21:32:47 +00:00
/*
* get a instance of a stored item
* will be migrated to the latest version on fetch
* call .save() on it put the new modified data back
*/
2021-10-24 21:10:47 +00:00
get() {
// get from storage api
const store = this;
let data = localStorage.getItem(this.id);
// parse json if item exists
if (data) {
try {
data = JSON.parse(data);
if (!data.constructor) {
console.error(`Storage item for store ${this.id} has not constructor`)
throw new Error("storage item has no constructor")
}
if (data.constructor !== Object) {
console.error(`Storage item for store ${this.id} is not an object`)
throw new Error("storage item is not an object")
}
} catch (_) {
// if errored, set to null so it generates new one, see below
console.error(`Failed to parse storage item for store ${this.id}`)
data = null;
}
}
// if item doesnt exist, generate from version init
if (!data) {
data = this.versions[this.currentVersion.toString()].init();
}
// update the data if needed
data = this.update(data);
// add a save object to return value
data.save = function save() {
localStorage.setItem(store.id, JSON.stringify(data));
}
// return data
return data;
}
}
}
/*
* Builds a versioned store
*
* manages versioning of localstorage items
*/
export function versionedStoreBuilder() {
return {
_data: {
versionList: [],
maxVersion: 0,
versions: {},
storageString: null,
},
2021-10-24 21:32:47 +00:00
/*
* set key of localstorage item, must be unique
*/
2021-10-24 21:10:47 +00:00
setKey(str) {
this._data.storageString = str;
return this;
},
2021-10-24 21:32:47 +00:00
/*
* add a version to the store
*
* version: version number
* migrate: function to update from previous version to this version
* create: function to return an empty storage item from this version (in correct syntax)
*/
addVersion({ version, migrate, create }) {
// input checking
if (version < 0)
throw new Error("Cannot add version below 0 in store");
if (version > 0 && !migrate)
throw new Error(`Missing migration on version ${version} (needed for any version above 0)`);
2021-10-24 21:10:47 +00:00
// update max version list
if (version > this._data.maxVersion)
this._data.maxVersion = version;
2021-10-24 21:10:47 +00:00
// add to version list
this._data.versionList.push(version);
2021-10-24 21:10:47 +00:00
// register version
this._data.versions[version.toString()] = {
version: version, // version number
update: migrate ? (data) => { // update function, and increment version
migrate(data);
data["--version"] = version;
2021-10-24 21:10:47 +00:00
return data;
} : null,
init: create ? () => { // return an initial object
const data = create();
data["--version"] = version;
2021-10-24 21:10:47 +00:00
return data;
} : null
2021-10-24 21:10:47 +00:00
}
return this;
},
2021-10-24 21:32:47 +00:00
/*
* returns function store based on what has been set
*/
2021-10-24 21:10:47 +00:00
build() {
// check if version list doesnt skip versions
const versionListSorted = this._data.versionList.sort((a,b)=>a-b);
versionListSorted.forEach((v, i, arr) => {
if (i === 0)
return;
if (v !== arr[i-1]+1)
throw new Error("Version list of store is not incremental");
})
// version zero must exist
if (versionListSorted[0] !== 0)
throw new Error("Version 0 doesn't exist in version list of store");
// max version must have init function
if (!this._data.versions[this._data.maxVersion.toString()].init)
throw new Error(`Missing create function on version ${this._data.maxVersion} (needed for latest version of store)`);
2021-10-24 21:10:47 +00:00
// check storage string
if (!this._data.storageString)
throw new Error("storage key not set in store");
// build versioned store
return buildStoreObject(this._data);
}
}
}