Skip to content

Add migration progress bars for packs #6848

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arbron merged 2 commits into from
Jun 5, 2026
+52 −13
Merged

Add migration progress bars for packs #6848

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b52c60e
Add migration progress bars for packs
arbron Mar 25, 2026
2cfc32b
Swap to error progress bar if migration fails in strict mode
arbron Jun 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion dnd5e.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -578,7 +578,7 @@ Hooks.once("ready", function() {

// Perform the migration
if ( cv && foundry.utils.isNewerVersion(game.system.flags.compatibleMigrationVersion, cv) ) {
ui.notifications.error("MIGRATION.5eVersionTooOldWarning", { permanent: true });
ui.notifications.error("MIGRATION.DND5E.Warning.VersionTooOld", { permanent: true });
}
migrations.migrateWorld();
});
Expand Down
17 changes: 14 additions & 3 deletions lang/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5826,9 +5826,20 @@
"MACRO.5eNoActorSelected": "No selected or assigned actor could be found to target with macro.",
"MACRO.5eUnownedWarn": "You can only create macro buttons for owned Items",

"MIGRATION.5eBegin": "Applying D&D 5e System Migration for version {version}. Please be patient and do not close your game or shut down your server.",
"MIGRATION.5eComplete": "D&D 5e System Migration to version {version} completed!",
"MIGRATION.5eVersionTooOldWarning": "Your D&D 5e system data is from too old a Foundry version and cannot be reliably migrated to the latest version. The process will be attempted, but errors may occur.",
"MIGRATION.DND5E": {
"Compendium": {
"Failed": "Migration failed for compendium {compendium}.",
"Migrate": "Migrating compendium {compendium} for version {version}.",
"Refresh": "Refreshing compendium {compendium}."
},
"World": {
"Begin": "Applying D&D 5e System Migration for version {version}. Please be patient and do not close your game or shut down your server.",
"Complete": "D&D 5e System Migration to version {version} completed!"
},
"Warning": {
"VersionTooOld": "Your D&D 5e system data is from too old a Foundry version and cannot be reliably migrated to the latest version. The process will be attempted, but errors may occur."
}
},

"SETTINGS.5eAutoCollapseCardL": "Automatically collapse Item Card descriptions in the Chat Log",
"SETTINGS.5eAutoCollapseCardN": "Collapse Item Cards in Chat",
Expand Down
46 changes: 37 additions & 9 deletions module/migration.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { formatIdentifier, log } from "./utils.mjs";
*/
export async function migrateWorld({ bypassVersionCheck=false }={}) {
const version = game.system.version;
const progress = ui.notifications.info("MIGRATION.5eBegin", {
const progress = ui.notifications.info("MIGRATION.DND5E.World.Begin", {
Comment thread
arbron marked this conversation as resolved.
console: false, format: { version }, permanent: true, progress: true
});
const { packs, packDocuments } = game.packs.reduce((obj, pack) => {
Expand Down Expand Up @@ -191,7 +191,7 @@ export async function migrateWorld({ bypassVersionCheck=false }={}) {
// Set the migration as complete
game.settings.set("dnd5e", "systemMigrationVersion", game.system.version);
progress.element?.classList.add(hasErrors ? "warning" : "success");
progress.update({ message: "MIGRATION.5eComplete", format: { version }, pct: 1 });
progress.update({ message: "MIGRATION.DND5E.World.Complete", format: { version }, pct: 1 });
}

/* -------------------------------------------- */
Expand Down Expand Up @@ -230,6 +230,13 @@ export async function migrateCompendium(pack, { bypassVersionCheck=false, increm
const documentName = pack.documentName;
if ( !["Actor", "Item", "Scene"].includes(documentName) ) return;

const format = { compendium: pack.collection, version: game.system.version };
const progress = ui.notifications.info("MIGRATION.DND5E.Compendium.Migrate", {
console: false, format, permanent: true, progress: true
});
let hasErrors = false;
let migrated = 0;

const migrationData = await getMigrationData();

// Unlock the pack for editing
Expand Down Expand Up @@ -278,20 +285,29 @@ export async function migrateCompendium(pack, { bypassVersionCheck=false, increm
catch(err) {
err.message = `Failed dnd5e system migration for document ${doc.name} in pack ${pack.collection}: ${err.message}`;
console.error(err);
if ( strict ) throw err;
hasErrors = true;
if ( strict ) {
progress.element?.classList.add("error");
progress.update({ format, message: "MIGRATION.DND5E.Compendium.Failed" });
throw err;
}
}

finally {
incrementProgress?.();
progress.update({ pct: ++migrated / pack.index.size });
}
}

log(`Migrated all ${documentName} documents from Compendium ${pack.collection}`);
} finally {
// Apply the original locked status for the pack
await pack.configure({locked: wasLocked});
await pack.configure({ locked: wasLocked });
game.compendiumArt.enabled = true;
}

progress.element?.classList.add(hasErrors ? "warning" : "success");
progress.update({ format, message: "MIGRATION.DND5E.Compendium.Migrate", pct: 1 });
Comment thread
arbron marked this conversation as resolved.
}

/* -------------------------------------------- */
Expand Down Expand Up @@ -340,9 +356,11 @@ export function reparentCompendiums(from, to) {
* @param {boolean} [options.bypassVersionCheck=false] Bypass certain migration restrictions gated behind system
* version stored in item stats.
* @param {boolean} [options.migrate=true] Also perform a system migration before refreshing.
* @param {string} [options.package] Only update compendiums belonging to this package.
*/
export async function refreshAllCompendiums(options) {
export async function refreshAllCompendiums(options={}) {
for ( const pack of game.packs ) {
if ( options.package && (options.package !== pack.metadata.packageName) ) continue;
await refreshCompendium(pack, options);
}
}
Expand All @@ -369,21 +387,31 @@ export async function refreshCompendium(pack, { bypassVersionCheck, migrate=true
}
}

const format = { compendium: pack.collection };
const progress = ui.notifications.info("MIGRATION.DND5E.Compendium.Refresh", {
console: false, format, permanent: true, progress: true
});
let migrated = 0;

game.compendiumArt.enabled = false;
const DocumentClass = CONFIG[pack.documentName].documentClass;
const wasLocked = pack.locked;
await pack.configure({locked: false});
await pack.configure({ locked: false });

ui.notifications.info(`Beginning to refresh Compendium ${pack.collection}`);
const documents = await pack.getDocuments();
for ( const doc of documents ) {
const data = doc.toObject();
await doc.delete();
await DocumentClass.create(data, {keepId: true, keepEmbeddedIds: true, pack: pack.collection});
log(`Refreshed ${pack.documentName} document ${doc.name} in Compendium ${pack.collection}`);
progress.update({ pct: ++migrated / pack.index.size });
}
await pack.configure({locked: wasLocked});

await pack.configure({ locked: wasLocked });
game.compendiumArt.enabled = true;
ui.notifications.info(`Refreshed all documents from Compendium ${pack.collection}`);

progress.element?.classList.add("success");
progress.update({ format, message: "MIGRATION.DND5E.Compendium.Refresh", pct: 1 });
}

/* -------------------------------------------- */
Expand Down