Function TestDatabaseInitTeardownTiming

rest/database_init_manager_test.go:417–482

TestDatabaseInitTeardownTiming tests scenarios where InitializeDatabase is called during the completion phase of a previous async initialization. Ensures there are no cases where a watcher is added but never receives a done notification.

(t *testing.T)

// the completion phase of a previous async initialization.  Ensures there are no cases where a
// watcher is added but never receives a done notification.
func TestDatabaseInitTeardownTiming(t *testing.T) {

	RequireN1QLIndexes(t)
	base.TestRequiresCollections(t)
	base.SetUpTestLogging(t, base.LevelInfo, base.KeyHTTP, base.KeyConfig)

	sc, closeFn := StartBootstrapServer(t)
	defer closeFn()
	ctx := base.TestCtx(t)

	// Get a test bucket for bootstrap testing, and drop indexes created by bucket pool readier
	tb := base.GetTestBucket(t)
	defer tb.Close(ctx)

	// Drop all test indexes so we can test InitializeDatabase
	DropAllTestIndexes(t, tb)

	// Set up collection names and ScopesConfig for testing
	scopesConfig := GetCollectionsConfig(t, tb, 3)
	dataStoreNames := GetDataStoreNamesFromScopesConfig(scopesConfig)
	scopeName := dataStoreNames[0].ScopeName()
	collection1Name := dataStoreNames[0].CollectionName()
	collection2Name := dataStoreNames[1].CollectionName()
	collection1and2ScopesConfig := makeScopesConfig(scopeName, []string{collection1Name, collection2Name})

	initMgr := sc.DatabaseInitManager

	// Create collection callback that blocks and waits for test notification the first time a collection is initialized, does not block afterward.
	var collectionCount atomic.Int64
	initMgr.testCollectionStatusUpdateCallback = func(_ string, _ base.ScopeAndCollectionName, status db.CollectionIndexStatus) {
		if status != db.CollectionIndexStatusReady {
			return
		}
		collectionCount.Add(1)
	}
	dbName := "dbName"
	dbConfig := makeDbConfig(tb.GetName(), dbName, collection1and2ScopesConfig)
	require.NoError(t, dbConfig.setup(ctx, dbName, sc.Config.Bootstrap, nil, nil, false))

	wg := &sync.WaitGroup{}
	wg.Add(1)
	var databaseCompleteCount atomic.Int64
	initMgr.testDatabaseCompleteCallback = func(dbName string) {
		// On first completion, invoke InitializeDatabase with the same collection set post-completion
		if databaseCompleteCount.Add(1) == 1 {
			defer wg.Done()
			log.Printf("invoking InitializeDatabase again during teardown")
			doneChan2, err := initMgr.InitializeDatabase(ctx, sc.Config, dbConfig.ToDatabaseConfig(), testUseLegacySyncDocsIndex)
			require.NoError(t, err)
			WaitForChannel(t, doneChan2, "done chan 2")
		}
	}

	// Start first async index creation, should block after first collection
	doneChan1, err := initMgr.InitializeDatabase(ctx, sc.Config, dbConfig.ToDatabaseConfig(), testUseLegacySyncDocsIndex)
	require.NoError(t, err)

	WaitForChannel(t, doneChan1, "done chan 1")