[IMP] mail, im_livechat: manage downgrade of local storage

This commit adds versioning to local storage entries, so that when
version is more recent than current version, business code can have
a strategy to drop the values.

This strategy is the one used by local storage field: older versions
are most updated and upgraded fields so 19.1 is implicitly valid for
19.2 and 19.3. 20.0 is invalid as it can potentially be affected
by unknown upgrade scripts of current version (19.3), thus it's
dropped.

Part of Task-5003012

Author: alexkuhn

addons/mail/static/src/core/common/upgrade/upgrade_helpers.js

@@ -104,8 +104,12 @@ function getUpgradeMap() {
  */
 function applyUpgrade(upgradeData) {
     const oldEntry = new LocalStorageEntry(upgradeData.key);
-    const oldValue = oldEntry.rawGet() ?? oldEntry.get();
-    if (oldValue === undefined) {
+    const parsed = oldEntry.parse();
+    const oldValue = parsed ?? oldEntry.get();
+    if (
+        oldValue === null ||
+        (parsed && parsed.version && parseVersion(upgradeData.version).isLowerThan(parsed.version))
+    ) {
         return; // could not upgrade (cannot parse or more recent version)
     }
     const { key, value } =
@@ -114,5 +118,5 @@ function applyUpgrade(upgradeData) {
             : upgradeData.upgrade;
     oldEntry.remove();
     const newEntry = new LocalStorageEntry(key);
-    newEntry.set(value);
+    newEntry.set(value, upgradeData.version);
 }

addons/mail/static/src/core/common/upgrade/upgrade_service.js

@@ -7,9 +7,10 @@ export const discussUpgradeService = {
     dependencies: [],
     start() {
         const lse = new LocalStorageEntry("discuss.upgrade.version");
-        const oldVersion = lse.get() ?? "1.0";
+        const parsed = lse.parse();
+        const oldVersion = parsed?.version ?? "1.0";
         const currentVersion = getCurrentLocalStorageVersion();
-        lse.set(currentVersion);
+        lse.set(true, currentVersion);
         if (parseVersion(oldVersion).isLowerThan(currentVersion)) {
             upgradeFrom(oldVersion);
         }

addons/mail/static/src/model/model_internal.js

@@ -1,5 +1,7 @@
 import { toRaw } from "@odoo/owl";
 import { ATTR_SYM, MANY_SYM, ONE_SYM } from "./misc";
+import { parseVersion } from "@mail/utils/common/misc";
+import { getCurrentLocalStorageVersion } from "@mail/utils/common/local_storage";
 
 export class ModelInternal {
     /** @type {Map<string, boolean>} */
@@ -75,12 +77,13 @@ export class ModelInternal {
                 function fieldLocalStorageCompute() {
                     const record = toRaw(this)._raw;
                     const lse = record._.fieldsLocalStorage.get(fieldName);
-                    const value = lse.get();
-                    if (value === undefined) {
+                    const parsed = lse.parse();
+                    const currentOdooVersion = getCurrentLocalStorageVersion();
+                    if (!parsed || parseVersion(currentOdooVersion).isLowerThan(parsed.version)) {
                         lse.remove();
                         return this[fieldName];
                     }
-                    return value;
+                    return parsed.value;
                 }
             );
 

addons/mail/static/src/model/store_internal.js

@@ -6,7 +6,7 @@ import { RecordInternal } from "./record_internal";
 import { deserializeDate, deserializeDateTime } from "@web/core/l10n/dates";
 import { IS_DELETED_SYM, isCommand, isMany } from "./misc";
 import { browser } from "@web/core/browser/browser";
-import { parseRawValue } from "@mail/utils/common/local_storage";
+import { getCurrentLocalStorageVersion, parseRawValue } from "@mail/utils/common/local_storage";
 
 const Markup = markup().constructor;
 
@@ -55,7 +55,7 @@ export class StoreInternal extends RecordInternal {
                 record._proxy[fieldName] = record._.fieldsDefault.get(fieldName);
             } else {
                 const parsed = parseRawValue(ev.newValue);
-                if (!parsed) {
+                if (!parsed || parsed.version !== getCurrentLocalStorageVersion()) {
                     record._proxy[fieldName] = record._.fieldsDefault.get(fieldName);
                 } else {
                     record._proxy[fieldName] = parsed.value;

addons/mail/static/src/utils/common/local_storage.js

@@ -26,32 +26,28 @@ export class LocalStorageEntry {
         this.key = key;
     }
     get() {
-        const rawValue = this.rawGet();
-        if (rawValue === null) {
-            return undefined;
-        }
-        return parseRawValue(rawValue)?.value;
+        return browser.localStorage.getItem(this.key);
+    }
+    parse() {
+        return parseRawValue(this.get());
     }
-    set(value) {
-        const oldValue = this.get();
-        if (oldValue !== undefined && oldValue === value) {
+    set(value, version = getCurrentLocalStorageVersion()) {
+        const parsed = this.parse();
+        if (parsed && parsed.value === value && parsed.version === version) {
             return;
         }
-        browser.localStorage.setItem(this.key, toRawValue(value));
-    }
-    rawGet() {
-        return browser.localStorage.getItem(this.key);
+        browser.localStorage.setItem(this.key, toRawValue(value, version));
     }
     remove() {
-        if (this.rawGet() === null) {
+        if (this.get() === null) {
             return;
         }
         browser.localStorage.removeItem(this.key);
     }
 }
 
-export function toRawValue(value) {
-    return JSON.stringify({ value });
+export function toRawValue(value, version = getCurrentLocalStorageVersion()) {
+    return JSON.stringify({ value, version });
 }
 
 /**

addons/mail/static/tests/mail_test_helpers.js

@@ -785,7 +785,7 @@ export function setDiscussSidebarCategoryFoldState(categoryId, val) {
 export function isDiscussSidebarCategoryFolded(categoryId) {
     const localId = DiscussAppCategory.localId(categoryId);
     const lse = new LocalStorageEntry(makeRecordFieldLocalId(localId, "is_open"));
-    return !(lse.get() ?? true);
+    return !(lse.parse()?.value ?? true);
 }
 
 export function assertChatHub({ opened = [], folded = [] }) {