[IMP] data: match data versions to release versions

This commit fixes two issues at once.

Issue 1
-------
Currently, the migration process will ONLY run if the version of the original
data (in json) is smaller than the last version set in the source code
(`CURRENT_VERSION`). This means that any additional step set outside of the
library is not run without incrementing CURRENT_VERSION in o-spreadsheet.

Example:
- we bump the latest version to 25 in o-spreadsheet;
- we push that value in Odoo
- users start creating spreadsheets in that version so their spreadsheets are
  set to version 25
- later on, we need to add a migration step for whatever reason in Odoo, we
  assign it to 25.1

=> the migration code will check against the latest version in the source (25)
vs the one in the spreadsheet data (25 as well) and will simply skip the
migration.
So 25.1 will never run...

Issue 2
-------
The current scheme of the incremented integer is impractical when it comes
to figure out which odoo version it matches(*).

Knowing the release version is usefull for bug fixes to know which version of
the code generated the json data.

With this commit, data format version are now aligned with odoo versions
Current master is 18.3. Next, it'll be 18.4, 19.0, 19.1, etc.

(*) o-spreadsheet releases follow the same version numbers as odoo releases.

closes #5973

Task: 4659206
Signed-off-by: Pierre Rousseau (pro) <[email protected]>

Author: LucasLefevre

src/helpers/ui/paste_interactive.ts

@@ -1,4 +1,4 @@
-import { CURRENT_VERSION } from "../../migrations/data";
+import { getCurrentVersion } from "../../migrations/data";
 import { _t } from "../../translation";
 import {
   ClipboardPasteOptions,
@@ -75,7 +75,7 @@ export async function interactivePasteFromOS(
   } catch (error) {
     const parsedSpreadsheetContent = parsedClipboardContent.data;
 
-    if (parsedSpreadsheetContent?.version !== CURRENT_VERSION) {
+    if (parsedSpreadsheetContent?.version !== getCurrentVersion()) {
       env.raiseError(
         _t(
           "An unexpected error occurred while pasting content.\

src/migrations/data.ts

@@ -15,11 +15,18 @@ import { XlsxReader } from "../xlsx/xlsx_reader";
 import { migrationStepRegistry } from "./migration_steps";
 
 /**
- * This is the current state version number. It should be incremented each time
- * a breaking change is made in the way the state is handled, and an upgrade
- * function should be defined
+ * Represents the current version of the exported JSON data.
+ * A new version must be created whenever a breaking change is introduced in the export format.
+ * To define a new version, add an upgrade function to `migrationStepRegistry`.
  */
-export const CURRENT_VERSION = 25;
+export function getCurrentVersion() {
+  return getSortedVersions().at(-1)!;
+}
+
+function getSortedVersions() {
+  return migrationStepRegistry.getKeys().sort(compareVersions);
+}
+
 const INITIAL_SHEET_ID = "Sheet1";
 
 /**
@@ -47,7 +54,10 @@ export function load(data?: any, verboseImport?: boolean): WorkbookData {
 
   // apply migrations, if needed
   if ("version" in data) {
-    if (data.version < CURRENT_VERSION) {
+    if (isLegacyVersioning(data)) {
+      data.version = LEGACY_VERSION_MAPPING[data.version];
+    }
+    if (data.version !== getCurrentVersion()) {
       console.debug("Migrating data from version", data.version);
       data = migrate(data);
     }
@@ -58,6 +68,44 @@ export function load(data?: any, verboseImport?: boolean): WorkbookData {
   return data;
 }
 
+const LEGACY_VERSION_MAPPING = {
+  25: "18.2",
+  24: "18.1.1",
+  23: "18.1",
+  22: "18.0.4",
+  21: "18.0.3",
+  20: "18.0.2",
+  19: "18.0.1",
+  18: "18.0",
+  17: "17.4",
+  16: "17.3",
+  15: "17.2",
+  14: "16.4",
+  13: "16.3",
+  12: "15.4",
+
+  // not accurate starting at this point
+  11: "0.10",
+  10: "0.9",
+  9: "0.8",
+  8: "0.7",
+  7: "0.6",
+  6: "0.5",
+  5: "0.4",
+  4: "0.3",
+  3: "0.2",
+  2: "0.1",
+  1: "0",
+};
+
+/**
+ * Versions used to be an incremented integer.
+ * This was later changed to match release versions (matching Odoo release names).
+ */
+function isLegacyVersioning(data: { version: number | string }): boolean {
+  return typeof data.version === "number";
+}
+
 // -----------------------------------------------------------------------------
 // Migrations
 // -----------------------------------------------------------------------------
@@ -83,12 +131,11 @@ function compareVersions(v1: string, v2: string): number {
 
 function migrate(data: any): WorkbookData {
   const start = performance.now();
-  const steps = migrationStepRegistry
-    .getAll()
-    .sort((a, b) => compareVersions(a.versionFrom, b.versionFrom));
-  const index = steps.findIndex((step) => step.versionFrom === data.version.toString());
-  for (let i = index; i < steps.length; i++) {
-    data = steps[i].migrate(data);
+  const versions = getSortedVersions();
+  const index = versions.findIndex((v) => v === data.version);
+  for (let i = index + 1; i < versions.length; i++) {
+    const nextVersion = versions[i];
+    data = migrationStepRegistry.get(nextVersion).migrate(data);
   }
   console.debug("Data migrated in", performance.now() - start, "ms");
   return data;
@@ -131,7 +178,7 @@ function forceUnicityOfFigure(data: Partial<WorkbookData>): Partial<WorkbookData
  */
 function setDefaults(partialData: Partial<WorkbookData>): Partial<WorkbookData> {
   const data: WorkbookData = Object.assign(createEmptyWorkbookData(), partialData, {
-    version: CURRENT_VERSION,
+    version: getCurrentVersion(),
   });
   data.sheets = data.sheets
     ? data.sheets.map((s, i) =>
@@ -291,7 +338,7 @@ export function createEmptySheet(sheetId: UID, name: string): SheetData {
 
 export function createEmptyWorkbookData(sheetName = "Sheet1"): WorkbookData {
   return {
-    version: CURRENT_VERSION,
+    version: getCurrentVersion(),
     sheets: [createEmptySheet(INITIAL_SHEET_ID, sheetName)],
     styles: {},
     formats: {},