Merge pull request #1728 from rosahbruno/1839934-data-migration

Author: rosahbruno

glean/src/core/internal_metrics/sync.ts

@@ -126,8 +126,25 @@ export class CoreMetricsSync {
   }
 
   initialize(): void {
-    this.initializeClientId();
-    this.initializeFirstRunDate();
+    // If the client had used previous versions of Glean.js before we moved
+    // to LocalStorage as the data store, then we need to move important
+    // user data from IndexedDB to LocalStorage.
+    //
+    // Currently we are interested in migrating two things
+    // 1. The client_id - consistent clientId across all sessions.
+    // 2. The first_run_date - the date when the client was first run.
+
+    // The migration is done only once per client. The flag is set in
+    // LocalStorage to indicate that the migration has been completed.
+    const migrationFlag = localStorage.getItem("GLEAN_MIGRATION_FLAG");
+    if (migrationFlag !== "1") {
+      this.migrateCoreMetricsFromIdb();
+      localStorage.setItem("GLEAN_MIGRATION_FLAG", "1");
+    } else {
+      // If we do not need to migrate anything, then we can set the metrics
+      // for the first time.
+      this.initializeUserLifetimeMetrics();
+    }
 
     this.os.set((Context.platform as PlatformSync).info.os());
     this.osVersion.set((Context.platform as PlatformSync).info.osVersion(Context.config.osVersion));
@@ -187,4 +204,80 @@ export class CoreMetricsSync {
       this.firstRunDate.set();
     }
   }
+
+  /**
+   * Initializes the Glean internal user-lifetime metrics.
+   */
+  private initializeUserLifetimeMetrics(): void {
+    this.initializeClientId();
+    this.initializeFirstRunDate();
+  }
+
+  /**
+   * Migrates the core metrics from the old IDB storage to LocalStorage
+   * on first launch IF the client had used previous versions of Glean.js -
+   * pre LocalStorage.
+   *
+   * There is no way to access IDB data synchronously, so we rely on listeners
+   * for when specific actions complete. This means that we need to be careful
+   * and ensure that the clientId and firstRunDate are always set.
+   *
+   * Once the migration is complete, running the initialize functions for the
+   * clientId and firstRunDate equate to no-ops. If there is an error anywhere
+   * along the way and the migration is not complete, then the initialize the
+   * two metrics as usual.
+   */
+  private migrateCoreMetricsFromIdb(): void {
+    const dbRequest = window.indexedDB.open("Glean");
+    dbRequest.onerror = () => {
+      this.initializeUserLifetimeMetrics();
+    };
+
+    dbRequest.onsuccess = () => {
+      try {
+        const db = dbRequest.result;
+        const transaction = db?.transaction("Main", "readwrite");
+        const store = transaction.objectStore("Main");
+
+        // All the core metrics are stored in the userLifetimeMetrics object.
+        const req = store.get("userLifetimeMetrics");
+        req.onsuccess = () => {
+          // Pull and set the existing clientId.
+          // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+          const clientId = req.result?.["glean_client_info"]?.["uuid"]?.["client_id"] as string;
+          if (!!clientId) {
+            this.clientId.set(clientId);
+          } else {
+            this.initializeClientId();
+          }
+
+          // Pull and set the existing firstRunDate.
+          // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+          const firstRunDate = req.result?.["glean_client_info"]?.["datetime"]?.[
+            "first_run_date"
+          ] as {
+            date: string;
+            timezone: number;
+            timeUnit: TimeUnit;
+          };
+          if (!!firstRunDate) {
+            this.firstRunDate.setSyncRaw(
+              firstRunDate.date,
+              firstRunDate.timezone,
+              firstRunDate.timeUnit
+            );
+          } else {
+            this.initializeFirstRunDate();
+          }
+        };
+
+        req.onerror = () => {
+          this.initializeUserLifetimeMetrics();
+        };
+      } catch (e) {
+        // Fail-safe in case any generic error occurs.
+        this.initializeUserLifetimeMetrics();
+      }
+    };
+  }
 }

glean/src/core/metrics/types/datetime.ts

@@ -35,7 +35,7 @@ export type DatetimeInternalRepresentation = {
   // The time unit of the metric type at the time of recording.
   timeUnit: TimeUnit;
   // This timezone should be the exact output of `Date.getTimezoneOffset`
-  // and as such it should alwaye be in minutes.
+  // and as such it should always be in minutes.
   timezone: number;
   // This date string should be the exact output of `Date.toISOString`
   // and as such it is always in UTC.
@@ -59,6 +59,18 @@ export class DatetimeMetric extends Metric<DatetimeInternalRepresentation, strin
     });
   }
 
+  static fromRawDatetime(
+    isoString: string,
+    timezoneOffset: number,
+    timeUnit: TimeUnit
+  ): DatetimeMetric {
+    return new DatetimeMetric({
+      timeUnit,
+      timezone: timezoneOffset,
+      date: isoString
+    });
+  }
+
   /**
    * Gets the datetime data as a Date object.
    *
@@ -282,6 +294,32 @@ export class InternalDatetimeMetricType extends MetricType {
     }
   }
 
+  /**
+   * Set a datetime metric from raw values.
+   *
+   * # Important
+   * This method should **never** be exposed to users. This is used solely
+   * for migrating IDB data to LocalStorage.
+   *
+   * @param isoString Raw isoString.
+   * @param timezone Raw timezone.
+   * @param timeUnit Raw timeUnit.
+   */
+  setSyncRaw(isoString: string, timezone: number, timeUnit: TimeUnit) {
+    if (!this.shouldRecord(Context.uploadEnabled)) {
+      return;
+    }
+
+    try {
+      const metric = DatetimeMetric.fromRawDatetime(isoString, timezone, timeUnit);
+      (Context.metricsDatabase as MetricsDatabaseSync).record(this, metric);
+    } catch (e) {
+      if (e instanceof MetricValidationError) {
+        e.recordErrorSync(this);
+      }
+    }
+  }
+
   /// TESTING ///
   /**
    * Test-only API