Merge pull request #56 from danielmsft/clean-log-lines

Clean log lines

Author: M1Les

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/objectstoreprovider",
-  "version": "0.6.43",
+  "version": "0.6.44",
   "description": "A cross-browser object store library",
   "author": "Mukundan Kavanur Kidambi <[email protected]>",
   "scripts": {

src/IndexedDbProvider.ts

@@ -178,7 +178,6 @@ export class IndexedDbProvider extends DbProvider {
 
     this._lockHelper = new TransactionLockHelper(schema, true);
 
-    this.logWriter.log(`Opening db, version: ${schema.version}`, { dbName });
     const dbOpen = this._dbFactory.open(dbName, schema.version);
 
     let migrationPutters: Promise<void>[] = [];
@@ -187,21 +186,22 @@ export class IndexedDbProvider extends DbProvider {
       const db: IDBDatabase = dbOpen.result;
       const target = <IDBOpenDBRequest>(event.currentTarget || event.target);
       const trans = target.transaction;
+      // Differentiate between upgrade and new db
+      let isActualUpgrade = false;
 
       if (!trans) {
         this.logWriter.error(`No transaction, unable to do upgrade`);
         throw new Error("onupgradeneeded: target is null!");
       }
 
-      this.logWriter.log(`Upgrade needed for db`, { dbName });
-
       // Avoid clearing object stores when event.oldVersion returns 0.
       // oldVersion returns 0 if db doesn't exist yet: https://developer.mozilla.org/en-US/docs/Web/API/IDBVersionChangeEvent/oldVersion
       if (event.oldVersion) {
         if (
           schema.lastUsableVersion &&
           event.oldVersion < schema.lastUsableVersion
         ) {
+          isActualUpgrade = true;
           // Clear all stores if it's past the usable version
           this.logWriter.log(
             `Old version detected (${event.oldVersion}), clearing all data`
@@ -222,7 +222,11 @@ export class IndexedDbProvider extends DbProvider {
       }
 
       // Create all stores
-      this.logWriter.log(`Creating stores as part of upgrade process`);
+      if (isActualUpgrade) {
+        this.logWriter.log(
+          `Creating stores after db wipe due to lastUsableVersion change`
+        );
+      }
       each(schema.stores, (storeSchema) => {
         let store: IDBObjectStore;
         const storeExistedBefore = includes(
@@ -238,10 +242,6 @@ export class IndexedDbProvider extends DbProvider {
           }
 
           // Any is to fix a lib.d.ts issue in TS 2.0.3 - it doesn't realize that keypaths can be compound for some reason...
-          this.logWriter.log(`Store doesn't exist, creating object store`, {
-            dbName,
-            storeName: storeSchema.name,
-          });
           store = db.createObjectStore(storeSchema.name, {
             keyPath: primaryKeyPath,
           } as any);
@@ -373,6 +373,12 @@ export class IndexedDbProvider extends DbProvider {
               });
             }
           }
+
+          if (needsMigrate) {
+            this.logWriter.log(`schema changes require rebuilding indices`);
+          } else {
+            this.logWriter.log(`Creating stores as part of upgrade process`);
+          }
         });
 
         if (needsMigrate) {
@@ -428,12 +434,18 @@ export class IndexedDbProvider extends DbProvider {
 
     return promise.then(
       (db) => {
-        this.logWriter.log(
-          `Waiting for migrationPutters: ${migrationPutters.length} to complete for db`,
-          { dbName }
-        );
+        // OnUpgradeNeeded will get called for new DBs too so we want to avoid logging those
+        const isActualMigration = migrationPutters.length > 0;
+        if (isActualMigration) {
+          this.logWriter.log(
+            `Waiting for migrationPutters: ${migrationPutters.length} to complete for db`,
+            { dbName }
+          );
+        }
         return Promise.all(migrationPutters).then(() => {
-          this.logWriter.log(`Opening db success`, { dbName });
+          if (isActualMigration) {
+            this.logWriter.log(`Opening db success`, { dbName });
+          }
           this._db = db;
           this._db.onclose = (event: Event) => {
             if (this._handleOnClose) {
@@ -483,9 +495,12 @@ export class IndexedDbProvider extends DbProvider {
             return this.open(dbName, schema, true, verbose);
           }
         }
-        this.logWriter.error(`Error opening db, message: ${err?.message}`, {
-          dbName,
-        });
+        this.logWriter.error(
+          `Error opening db, message: ${err?.message} ${err?.target?.error} ${err?.target?.error?.name}`,
+          {
+            dbName,
+          }
+        );
         return Promise.reject<void>(err);
       }
     );