author Nan Jiang <najiang@mozilla.com>

Tue, 23 May 2017 14:54:13 -0400

changeset 584479 45467fe4017403ffb6ac5927fdb102453e236ba7

parent 583025 6dfa56094f0cc291945dd3c24d0a4c2682d80ec7

child 584480 7c7a1fbb3391d730603bddec4dc3be70a86f6dfd

child 586564 631f63699fad27520ad3c2f4d857e765e96942db

child 599198 7e78f5655aeae97d189ab9fc1af98ec2fa5a6413

child 599756 a28e467241e2095f21a7438cf577ea202f4b18cc

child 599911 e9004db90f47d9a5951dd4f6c90cd5e241f8e180

push id 60749

push user najiang@mozilla.com

push date Thu, 25 May 2017 14:27:09 +0000

reviewers mak

bugs 1352502

milestone 55.0a1

toolkit/components/places/Database.cpp file | annotate | diff | comparison | revisions

toolkit/components/places/Database.h file | annotate | diff | comparison | revisions

toolkit/components/places/nsPlacesTables.h file | annotate | diff | comparison | revisions

toolkit/components/places/tests/head_common.js file | annotate | diff | comparison | revisions

toolkit/components/places/tests/migration/places_v38.sqlite file | annotate | diff | comparison | revisions

toolkit/components/places/tests/migration/test_current_from_v38.js file | annotate | diff | comparison | revisions

toolkit/components/places/tests/migration/xpcshell.ini file | annotate | diff | comparison | revisions
--- a/toolkit/components/places/Database.cpp
+++ b/toolkit/components/places/Database.cpp
@@ -1076,16 +1076,22 @@ Database::InitSchema(bool* aDatabaseMigr
 
       if (currentSchemaVersion < 37) {
         rv = MigrateV37Up();
         NS_ENSURE_SUCCESS(rv, rv);
       }
 
       // Firefox 55 uses schema version 37.
 
+      if (currentSchemaVersion < 38) {
+        rv = MigrateV38Up();
+        NS_ENSURE_SUCCESS(rv, rv);
+      }
+      // Firefox 56 uses schema version 38.
+
       // Schema Upgrades must add migration code here.
 
       rv = UpdateBookmarkRootTitles();
       // We don't want a broken localization to cause us to think
       // the database is corrupt and needs to be replaced.
       MOZ_ASSERT(NS_SUCCEEDED(rv));
     }
   }
@@ -2269,16 +2275,40 @@ Database::MigrateV37Up() {
 
   // Start the async conversion
   nsFaviconService::ConvertUnsupportedPayloads(mMainConn);
 
   return NS_OK;
 }
 
 nsresult
+Database::MigrateV38Up()
+{
+  MOZ_ASSERT(NS_IsMainThread());
+
+  nsCOMPtr<mozIStorageStatement> stmt;
+  nsresult rv = mMainConn->CreateStatement(NS_LITERAL_CSTRING(
+    "SELECT description, preview_image_url FROM moz_places"
+  ), getter_AddRefs(stmt));
+  if (NS_FAILED(rv)) {
+    rv = mMainConn->ExecuteSimpleSQL(NS_LITERAL_CSTRING(
+      "ALTER TABLE moz_places ADD COLUMN description TEXT"
+    ));
+    NS_ENSURE_SUCCESS(rv, rv);
+
+    rv = mMainConn->ExecuteSimpleSQL(NS_LITERAL_CSTRING(
+      "ALTER TABLE moz_places ADD COLUMN preview_image_url TEXT"
+    ));
+    NS_ENSURE_SUCCESS(rv, rv);
+  }
+
+  return NS_OK;
+}
+
+nsresult
 Database::GetItemsWithAnno(const nsACString& aAnnoName, int32_t aItemType,
                            nsTArray<int64_t>& aItemIds)
 {
   nsCOMPtr<mozIStorageStatement> stmt;
   nsresult rv = mMainConn->CreateStatement(NS_LITERAL_CSTRING(
     "SELECT b.id FROM moz_items_annos a "
     "JOIN moz_anno_attributes n ON n.id = a.anno_attribute_id "
     "JOIN moz_bookmarks b ON b.id = a.item_id "
--- a/toolkit/components/places/Database.h
+++ b/toolkit/components/places/Database.h
@@ -13,17 +13,17 @@
 #include "mozilla/storage.h"
 #include "mozilla/storage/StatementCache.h"
 #include "mozilla/Attributes.h"
 #include "nsIEventTarget.h"
 #include "Shutdown.h"
 
 // This is the schema version. Update it at any schema change and add a
 // corresponding migrateVxx method below.
-#define DATABASE_SCHEMA_VERSION 37
+#define DATABASE_SCHEMA_VERSION 38
 
 // Fired after Places inited.
 #define TOPIC_PLACES_INIT_COMPLETE "places-init-complete"
 // Fired when initialization fails due to a locked database.
 #define TOPIC_DATABASE_LOCKED "places-database-locked"
 // This topic is received when the profile is about to be lost.  Places does
 // initial shutdown work and notifies TOPIC_PLACES_SHUTDOWN to all listeners.
 // Any shutdown work that requires the Places APIs should happen here.
@@ -283,16 +283,17 @@ protected:
   nsresult MigrateV30Up();
   nsresult MigrateV31Up();
   nsresult MigrateV32Up();
   nsresult MigrateV33Up();
   nsresult MigrateV34Up();
   nsresult MigrateV35Up();
   nsresult MigrateV36Up();
   nsresult MigrateV37Up();
+  nsresult MigrateV38Up();
 
   nsresult UpdateBookmarkRootTitles();
 
   friend class ConnectionShutdownBlocker;
 
   int64_t CreateMobileRoot();
   nsresult GetItemsWithAnno(const nsACString& aAnnoName, int32_t aItemType,
                             nsTArray<int64_t>& aItemIds);
--- a/toolkit/components/places/nsPlacesTables.h
+++ b/toolkit/components/places/nsPlacesTables.h
@@ -17,16 +17,18 @@
     ", visit_count INTEGER DEFAULT 0" \
     ", hidden INTEGER DEFAULT 0 NOT NULL" \
     ", typed INTEGER DEFAULT 0 NOT NULL" \
     ", frecency INTEGER DEFAULT -1 NOT NULL" \
     ", last_visit_date INTEGER " \
     ", guid TEXT" \
     ", foreign_count INTEGER DEFAULT 0 NOT NULL" \
     ", url_hash INTEGER DEFAULT 0 NOT NULL " \
+    ", description TEXT" \
+    ", preview_image_url TEXT" \
   ")" \
 )
 
 #define CREATE_MOZ_HISTORYVISITS NS_LITERAL_CSTRING( \
   "CREATE TABLE moz_historyvisits (" \
     "  id INTEGER PRIMARY KEY" \
     ", from_visit INTEGER" \
     ", place_id INTEGER" \
--- a/toolkit/components/places/tests/head_common.js
+++ b/toolkit/components/places/tests/head_common.js
@@ -1,17 +1,17 @@
 /* -*- indent-tabs-mode: nil; js-indent-level: 2 -*-
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 // It is expected that the test files importing this file define Cu etc.
 /* global Cu, Ci, Cc, Cr */
 
-const CURRENT_SCHEMA_VERSION = 37;
+const CURRENT_SCHEMA_VERSION = 38;
 const FIRST_UPGRADABLE_SCHEMA_VERSION = 11;
 
 const NS_APP_USER_PROFILE_50_DIR = "ProfD";
 const NS_APP_PROFILE_DIR_STARTUP = "ProfDS";
 
 // Shortcuts to transitions type.
 const TRANSITION_LINK = Ci.nsINavHistoryService.TRANSITION_LINK;
 const TRANSITION_TYPED = Ci.nsINavHistoryService.TRANSITION_TYPED;
new file mode 100644
--- /dev/null
+++ b/toolkit/components/places/tests/migration/test_current_from_v38.js
@@ -0,0 +1,43 @@
+add_task(function* setup() {
+  yield setupPlacesDatabase("places_v38.sqlite");
+});
+
+add_task(function* database_is_valid() {
+  // Accessing the database for the first time triggers migration.
+  Assert.equal(PlacesUtils.history.databaseStatus,
+               PlacesUtils.history.DATABASE_STATUS_UPGRADED);
+
+  let db = yield PlacesUtils.promiseDBConnection();
+  Assert.equal((yield db.getSchemaVersion()), CURRENT_SCHEMA_VERSION);
+});
+
+add_task(function* test_new_fields() {
+  let path = OS.Path.join(OS.Constants.Path.profileDir, DB_FILENAME);
+  let db = yield Sqlite.openConnection({ path });
+
+  // Manually update these two fields for a places record.
+  yield db.execute(`
+    UPDATE moz_places
+    SET description = :description, preview_image_url = :previewImageURL
+    WHERE id = 1`, { description: "Page description",
+                     previewImageURL: "https://example.com/img.png" });
+  let rows = yield db.execute(`SELECT description FROM moz_places
+                               WHERE description IS NOT NULL
+                               AND preview_image_url IS NOT NULL`);
+  Assert.equal(rows.length, 1,
+    "should fetch one record with not null description and preview_image_url");
+
+  // Reset them to the default value
+  yield db.execute(`
+    UPDATE moz_places
+    SET description = NULL,
+        preview_image_url = NULL
+    WHERE id = 1`);
+  rows = yield db.execute(`SELECT description FROM moz_places
+                           WHERE description IS NOT NULL
+                           AND preview_image_url IS NOT NULL`);
+  Assert.equal(rows.length, 0,
+    "should fetch 0 record with not null description and preview_image_url");
+
+  yield db.close();
+});
--- a/toolkit/components/places/tests/migration/xpcshell.ini
+++ b/toolkit/components/places/tests/migration/xpcshell.ini
@@ -18,22 +18,24 @@ support-files =
   places_v30.sqlite
   places_v31.sqlite
   places_v32.sqlite
   places_v33.sqlite
   places_v34.sqlite
   places_v35.sqlite
   places_v36.sqlite
   places_v37.sqlite
+  places_v38.sqlite
 
 [test_current_from_downgraded.js]
 [test_current_from_v6.js]
 [test_current_from_v11.js]
 [test_current_from_v19.js]
 [test_current_from_v24.js]
 [test_current_from_v25.js]
 [test_current_from_v26.js]
 [test_current_from_v27.js]
 [test_current_from_v31.js]
 [test_current_from_v34.js]
 [test_current_from_v34_no_roots.js]
 [test_current_from_v35.js]
 [test_current_from_v36.js]
+[test_current_from_v38.js]
author	Nan Jiang <najiang@mozilla.com>
	Tue, 23 May 2017 14:54:13 -0400
changeset 584479	45467fe4017403ffb6ac5927fdb102453e236ba7
parent 583025	6dfa56094f0cc291945dd3c24d0a4c2682d80ec7
child 584480	7c7a1fbb3391d730603bddec4dc3be70a86f6dfd
child 586564	631f63699fad27520ad3c2f4d857e765e96942db
child 599198	7e78f5655aeae97d189ab9fc1af98ec2fa5a6413
child 599756	a28e467241e2095f21a7438cf577ea202f4b18cc
child 599911	e9004db90f47d9a5951dd4f6c90cd5e241f8e180
push id	60749
push user	najiang@mozilla.com
push date	Thu, 25 May 2017 14:27:09 +0000
reviewers	mak
bugs	1352502
milestone	55.0a1
toolkit/components/places/Database.cpp		file \| annotate \| diff \| comparison \| revisions
toolkit/components/places/Database.h		file \| annotate \| diff \| comparison \| revisions
toolkit/components/places/nsPlacesTables.h		file \| annotate \| diff \| comparison \| revisions
toolkit/components/places/tests/head_common.js		file \| annotate \| diff \| comparison \| revisions
toolkit/components/places/tests/migration/places_v38.sqlite		file \| annotate \| diff \| comparison \| revisions
toolkit/components/places/tests/migration/test_current_from_v38.js		file \| annotate \| diff \| comparison \| revisions
toolkit/components/places/tests/migration/xpcshell.ini		file \| annotate \| diff \| comparison \| revisions