CBL-5684: Database.getDefaultCollection() should be non-null

Co-authored-by: Jeff Lockhart <[email protected]>

common/main/java/com/couchbase/lite/AbstractDatabase.java

@@ -238,8 +238,6 @@ static Database getDbForCollections(@Nullable Set<Collection> collections) {
 
  @GuardedBy("dbLock")
  private Collection defaultCollection;
- @GuardedBy("dbLock")
- private boolean noDefaultCollection;
 
  private volatile CountDownLatch closeLatch;
 
@@ -484,11 +482,11 @@ public final Collection getCollection(@NonNull String collectionName, @Nullable
  }
 
  /**
- * Get the default collection. If the default collection has been deleted the function will return null.
+ * Get the default collection.
  *
- * @return the default collection or null if it does not exist.
+ * @return the default collection.
  */
- @Nullable
+ @NonNull
  public final Collection getDefaultCollection() throws CouchbaseLiteException {
  synchronized (getDbLock()) {
  assertOpenChecked();
@@ -497,8 +495,8 @@ public final Collection getDefaultCollection() throws CouchbaseLiteException {
  }
 
  /**
- * Delete a collection by name  in the default scope. If the collection doesn't exist, the operation
- * will be no-ops. Note: the default collection can be deleted but cannot be recreated.
+ * Delete a collection by name in the default scope. If the collection doesn't exist, the operation
+ * will do nothing. Note: the default collection cannot be deleted.
  *
  * @param name the collection to be deleted
  * @throws CouchbaseLiteException on failure
@@ -508,8 +506,8 @@ public final void deleteCollection(@NonNull String name) throws CouchbaseLiteExc
  }
 
  /**
- * Delete a collection by name  in the specified scope. If the collection doesn't exist, the operation
- * will be no-ops. Note: the default collection can be deleted but cannot be recreated.
+ * Delete a collection by name in the specified scope. If the collection doesn't exist, the operation
+ * will do nothing. Note: the default collection cannot be deleted.
  *
  * @param collectionName the collection to be deleted
  * @param scopeName the scope from which to delete the collection
@@ -634,15 +632,10 @@ public boolean equals(Object o) {
  */
  @Deprecated
  public long getCount() {
- final Collection defaultCollection;
  try {
- synchronized (getDbLock()) { defaultCollection = getDefaultCollectionLocked(); }
+ synchronized (getDbLock()) { return getDefaultCollectionLocked().getCount(); }
  }
- catch (CouchbaseLiteException e) {
- throw new CouchbaseLiteError("Failed getting default collection", e);
- }
-
- return (defaultCollection == null) ? 0 : defaultCollection.getCount();
+ catch (CouchbaseLiteException e) { throw new CouchbaseLiteError("Failed getting default collection", e); }
  }
 
  /**
@@ -1024,9 +1017,6 @@ Set<Collection> getDefaultCollectionAsSet() {
  final Collection defaultCollection;
  try { defaultCollection = Collection.getDefaultCollection(this.getDatabase()); }
  catch (CouchbaseLiteException e) { throw new CouchbaseLiteError("Can't get default collection", e); }
- if (defaultCollection == null) {
- throw new IllegalArgumentException("Database " + getName() + "has no default collection");
- }
  final HashSet<Collection> collections = new HashSet<>();
  collections.add(defaultCollection);
  return collections;
@@ -1044,7 +1034,7 @@ C4Collection getC4Collection(@NonNull String scopeName, @NonNull String collecti
  synchronized (getDbLock()) { return getOpenC4DbLocked().getCollection(scopeName, collectionName); }
  }
 
- @Nullable
+ @NonNull
  C4Collection getDefaultC4Collection() throws LiteCoreException {
  synchronized (getDbLock()) { return getOpenC4DbLocked().getDefaultCollection(); }
  }
@@ -1298,27 +1288,23 @@ FLEncoder getSharedFleeceEncoder() {
 
  @NonNull
  private Collection getDefaultCollectionOrThrow() {
- Exception err = null;
  try {
  synchronized (getDbLock()) {
  assertOpenUnchecked();
- final Collection collection = getDefaultCollectionLocked();
- if (collection != null) { return collection; }
+ return getDefaultCollectionLocked();
  }
  }
- catch (CouchbaseLiteException e) { err = e; }
-
- throw new CouchbaseLiteError(Log.lookupStandardMessage("DBClosedOrCollectionDeleted"), err);
+ catch (CouchbaseLiteException e) {
+ throw new CouchbaseLiteError(Log.lookupStandardMessage("DBClosedOrCollectionDeleted"), e);
+ }
  }
 
- @Nullable
+ @NonNull
  private Collection getDefaultCollectionLocked() throws CouchbaseLiteException {
- if (noDefaultCollection) { return null; }
-
  if (defaultCollection == null) { defaultCollection = Collection.getDefaultCollection(getDatabase()); }
- else if (!defaultCollection.isValid()) { defaultCollection = null; }
-
- noDefaultCollection = defaultCollection == null;
+ else if (!defaultCollection.isValid()) {
+ throw new CouchbaseLiteException("Database " + getName() + " default collection is invalid");
+ }
 
  return defaultCollection;
  }

common/main/java/com/couchbase/lite/AbstractReplicatorConfiguration.java

@@ -84,10 +84,6 @@ protected static Map<Collection, CollectionConfiguration> configureDefaultCollec
  throw new CouchbaseLiteError(Log.lookupStandardMessage("NoDefaultCollectionInConfig"), e);
  }
 
- if (defaultCollection == null) {
- throw new CouchbaseLiteError(Log.lookupStandardMessage("NoDefaultCollectionInConfig"));
- }
-
  final Map<Collection, CollectionConfiguration> collections = new HashMap<>();
  collections.put(defaultCollection, new CollectionConfiguration());
 

common/main/java/com/couchbase/lite/Collection.java

@@ -116,12 +116,9 @@ static Collection getCollection(
  catch (LiteCoreException e) { throw CouchbaseLiteException.convertException(e); }
  }
 
- @Nullable
+ @NonNull
  static Collection getDefaultCollection(@NonNull Database db) throws CouchbaseLiteException {
- try {
- final C4Collection c4Coll = db.getDefaultC4Collection();
- return (c4Coll == null) ? null : new Collection(db, c4Coll);
- }
+ try { return new Collection(db, db.getDefaultC4Collection()); }
  catch (LiteCoreException e) { throw CouchbaseLiteException.convertException(e); }
  }
 
@@ -429,7 +426,7 @@ public ListenerToken addDocumentChangeListener(
  /**
  * Get a list of the names of indices in the collection.
  *
- * @return the list of index names
+ * @return the set of index names
  * @throws CouchbaseLiteException on failure
  */
  @NonNull

common/main/java/com/couchbase/lite/DataSource.java

@@ -72,7 +72,7 @@ public static As database(@NonNull Database database) {
  Preconditions.assertNotNull(database, "database");
 
  final Collection defaultCollection;
- try { defaultCollection = Preconditions.assertNotNull(database.getDefaultCollection(), "default collection"); }
+ try { defaultCollection = database.getDefaultCollection(); }
  catch (CouchbaseLiteException e) { throw new IllegalArgumentException("Database not open", e); }
 
  final As source = new As(defaultCollection);

common/main/java/com/couchbase/lite/DatabaseChange.java

@@ -30,13 +30,10 @@
 public class DatabaseChange {
  @NonNull
  private static Collection getDefaultCollection(@NonNull Database database) {
- CouchbaseLiteException fail = null;
- try {
- final Collection defaultCollection = database.getDefaultCollection();
- if (defaultCollection != null) { return defaultCollection; }
+ try { return database.getDefaultCollection(); }
+ catch (CouchbaseLiteException e) {
+ throw new CouchbaseLiteError("Failed retrieving default collection for database: " + database.getName(), e);
  }
- catch (CouchbaseLiteException e) { fail = e; }
- throw new CouchbaseLiteError("Database " + database.getName() + " has no default collection", fail);
  }
 
  @NonNull

common/main/java/com/couchbase/lite/internal/core/C4Collection.java

@@ -92,7 +92,7 @@ public static C4Collection get(@NonNull C4Database c4db, @NonNull String scope,
  return get(NATIVE_IMPL, c4db, scope, collection);
  }
 
- @Nullable
+ @NonNull
  public static C4Collection getDefault(@NonNull C4Database c4db) throws LiteCoreException {
  return getDefault(NATIVE_IMPL, c4db);
  }
@@ -126,12 +126,13 @@ static C4Collection get(
  }
 
  @VisibleForTesting
- @Nullable
+ @NonNull
  static C4Collection getDefault(@NonNull NativeImpl impl, @NonNull C4Database c4db) throws LiteCoreException {
- final long c4collection = impl.nGetDefaultCollection(c4db.getPeer());
- return (c4collection == 0)
- ? null
- : new C4Collection(impl, c4collection, c4db, Scope.DEFAULT_NAME, Collection.DEFAULT_NAME);
+ return new C4Collection(
+ impl,
+ impl.nGetDefaultCollection(c4db.getPeer()),
+ c4db, Scope.DEFAULT_NAME,
+ Collection.DEFAULT_NAME);
  }
 
 

common/main/java/com/couchbase/lite/internal/core/C4Database.java

@@ -472,7 +472,7 @@ public C4Collection getCollection(@NonNull String scopeName, @NonNull String col
  return C4Collection.get(this, scopeName, collectionName);
  }
 
- @Nullable
+ @NonNull
  public final C4Collection getDefaultCollection() throws LiteCoreException {
  return C4Collection.getDefault(this);
  }

common/main/kotlin/com/couchbase/lite/CommonConfigurationFactories.kt

@@ -201,9 +201,7 @@ fun LogFileConfiguration?.create(
 // database default collection, we are about to lose information.
 internal fun checkDbCollections(db: Database, collections: Set<Collection>?) {
  val colls = collections ?: emptySet()
- val defaultCollection = db.defaultCollection
- ?: throw IllegalArgumentException(Log.lookupStandardMessage("NoDefaultCollectionInConfig"))
- if ((colls.size != 1) || (!colls.contains(defaultCollection))) {
+ if ((colls.size != 1) || (!colls.contains(db.defaultCollection))) {
  Log.d(LogDomain.LISTENER, "Copy to deprecated config loses collection information")
  }
 }

common/test/java/com/couchbase/lite/CollectionQueryTest.kt

@@ -31,7 +31,6 @@ class CollectionQueryTest : BaseQueryTest() {
  @Test
  fun testQueryDefaultCollectionA() {
  val defaultCollection = testDatabase.defaultCollection
- Assert.assertNotNull(defaultCollection!!)
  loadJSONResourceIntoCollection("names_100.json", collection = defaultCollection)
 
  // create with _
@@ -54,7 +53,6 @@ class CollectionQueryTest : BaseQueryTest() {
  @Test
  fun testQueryDefaultCollectionB() {
  val defaultCollection = testDatabase.defaultCollection
- Assert.assertNotNull(defaultCollection!!)
  loadJSONResourceIntoCollection("names_100.json", collection = defaultCollection)
  verifyQuery(
  QueryBuilder.createQuery("SELECT name.first FROM _default ORDER BY name.first LIMIT 1", testDatabase),
@@ -75,7 +73,6 @@ class CollectionQueryTest : BaseQueryTest() {
  @Test
  fun testQueryDefaultCollectionC() {
  val defaultCollection = testDatabase.defaultCollection
- Assert.assertNotNull(defaultCollection!!)
  loadJSONResourceIntoCollection("names_100.json", collection = defaultCollection)
  val query = QueryBuilder.createQuery(
  "SELECT name.first FROM " + testDatabase.name + " ORDER BY name.first LIMIT 1",
@@ -303,7 +300,6 @@ class CollectionQueryTest : BaseQueryTest() {
  @Test
  fun testFTSQueryWithFullTextIndexInDefaultCollectionA() {
  val defaultCollection = testDatabase.defaultCollection
- Assert.assertNotNull(defaultCollection!!)
 
  loadJSONResourceIntoCollection("sentences.json", collection = defaultCollection)
 
@@ -331,7 +327,6 @@ class CollectionQueryTest : BaseQueryTest() {
  @Test
  fun testFTSQueryWithFullTextIndexInDefaultCollectionB() {
  val defaultCollection = testDatabase.defaultCollection
- Assert.assertNotNull(defaultCollection!!)
 
  loadJSONResourceIntoCollection("sentences.json", collection = defaultCollection)
 
@@ -359,7 +354,6 @@ class CollectionQueryTest : BaseQueryTest() {
  @Test
  fun testFTSQueryWithFullTextIndexInDefaultCollectionC() {
  val defaultCollection = testDatabase.defaultCollection
- Assert.assertNotNull(defaultCollection!!)
 
  loadJSONResourceIntoCollection("sentences.json", collection = defaultCollection)
 
@@ -387,7 +381,6 @@ class CollectionQueryTest : BaseQueryTest() {
  @Test
  fun testFTSQueryWithFullTextIndexInDefaultCollectionD() {
  val defaultCollection = testDatabase.defaultCollection
- Assert.assertNotNull(defaultCollection!!)
 
  loadJSONResourceIntoCollection("sentences.json", collection = defaultCollection)
 
@@ -415,7 +408,6 @@ class CollectionQueryTest : BaseQueryTest() {
  @Test
  fun testFTSQueryWithFullTextIndexInDefaultCollectionE() {
  val defaultCollection = testDatabase.defaultCollection
- Assert.assertNotNull(defaultCollection!!)
 
  loadJSONResourceIntoCollection("sentences.json", collection = defaultCollection)
 
@@ -617,7 +609,6 @@ class CollectionQueryTest : BaseQueryTest() {
  @Test
  fun testSelectAllResultKeyA() {
  val defaultCollection = testDatabase.defaultCollection
- Assert.assertNotNull(defaultCollection!!)
 
  var doc = MutableDocument()
  doc.setValue("name", "rose")
@@ -643,7 +634,6 @@ class CollectionQueryTest : BaseQueryTest() {
  @Test
  fun testSelectAllResultKeyB() {
  val defaultCollection = testDatabase.defaultCollection
- Assert.assertNotNull(defaultCollection!!)
 
  var doc = MutableDocument()
  doc.setValue("name", "rose")
@@ -669,7 +659,6 @@ class CollectionQueryTest : BaseQueryTest() {
  @Test
  fun testSelectAllResultKeyC() {
  val defaultCollection = testDatabase.defaultCollection
- Assert.assertNotNull(defaultCollection!!)
 
  var doc = MutableDocument()
  doc.setValue("name", "rose")
@@ -750,7 +739,6 @@ class CollectionQueryTest : BaseQueryTest() {
  @Test
  fun testQueryBuilderWithDefaultCollectionAsDataSource() {
  val defaultCollection = testDatabase.defaultCollection
- Assert.assertNotNull(defaultCollection!!)
  loadJSONResourceIntoCollection("names_100.json", collection = defaultCollection)
 
  // create with default collection
@@ -906,7 +894,6 @@ class CollectionQueryTest : BaseQueryTest() {
  @Test
  fun testBuilderSelectAllResultKeyC() {
  val defaultCollection = testDatabase.defaultCollection
- Assert.assertNotNull(defaultCollection!!)
 
  var doc = MutableDocument()
  doc.setValue("name", "rose")