Foundry/stat-tracker
1
0
Fork 0
Code Issues 19 Pull requests Releases Activity Actions

Add an API interface for performing DB migrations as required

Browse source
This commit is contained in:
Oliver-Akins 2025-05-29 01:22:17 -06:00
parent 2567f5fb62
commit 1e007af52a
6 changed files with 83 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

32
module/hooks/ready.mjs
View file

@ -11,6 +11,38 @@ Hooks.on(`ready`, () => {
CONFIG.stats.db = NilDatabase;
};
/*
Perform any required data migration if any is required for the version
jump that the user may have caused. This only migrates the data iff the
currently authenticated user is able to perform the full migration of
data.
*/
const db = CONFIG.stats.db;
const lastVersion = game.settings.get(__ID__, `lastVersion`);
const canDoMigration = db.canPerformMigration();
const requiresMigration = db.requiresMigrationFrom(lastVersion);
if (requiresMigration) {
if (canDoMigration) {
const notif = ui.notifications.info(
`${__TITLE__} | Performing data migration, please do not close the window`,
{ progress: true, permanent: true },
);
// Fire and forget
CONFIG.stats.db.migrateData(notif)
.then(() => {
game.settings.set(__ID__, __VERSION__);
setTimeout(() => ui.notifications.remove(notif), 500);
});
} else {
ui.notifications.error(
`The stat-tracker database is out of date, temporarily disabling the stat-tracker module's functionality until the migration can be performed by a GM user logging into the world.`,
{ console: false, permanent: true },
);
CONFIG.stats.db = NilDatabase;
};
};
/*
Prevent any run-time modifications to the CONFIG API so that users can't wreck
themselves nor their data by fooling around with the values.