Prevent 5.0 flakyness from async db creation (#1786)

* Add util fn for properly creating databases to avoid flakyness from slow database creations

* Run run multidb tests only on dbs with full SHOW DATABASE command

Author: OskarDamkjaer

e2e_tests/integration/connect-form.spec.ts

@@ -113,7 +113,7 @@ describe('Connect form', () => {
       })
     }
   }
-  if (Cypress.config('serverVersion') >= 4.0) {
+  if (Cypress.config('serverVersion') >= 4.1) {
     it('can connect with the neo4j:// scheme', () => {
       cy.executeCommand(':clear')
       const boltUrl = 'neo4j://' + stripScheme(Cypress.config('boltUrl'))
@@ -125,10 +125,7 @@ describe('Connect form', () => {
       it('shows correct metadata when using db field', () => {
         cy.connect('neo4j', Cypress.config('password'))
         cy.executeCommand(':use system')
-        cy.executeCommand('DROP DATABASE sidebartest IF EXISTS')
-        cy.executeCommand('CREATE DATABASE sidebartest')
-        cy.wait(10000) // Wait for db to come online
-        cy.contains('1 system update, no records')
+        cy.createDatabase('sidebartest')
         cy.executeCommand(':use sidebartest')
         cy.executeCommand('create (:TestLabel)')
         cy.executeCommand(':use neo4j')

e2e_tests/integration/multi-db.spec.ts

@@ -40,14 +40,13 @@ describe('Multi database', () => {
   before(() => {
     cy.visit(Cypress.config('url')).title().should('include', 'Neo4j Browser')
     cy.wait(3000)
+    cy.ensureConnection()
   })
-  it('can connect', () => {
-    const password = Cypress.config('password')
-    cy.connect('neo4j', password)
-  })
-  if (Cypress.config('serverVersion') >= 4.0) {
+
+  if (Cypress.config('serverVersion') >= 4.1) {
     if (isEnterpriseEdition()) {
       it('shows a message indicating whether system updates have occurred', () => {
+        cy.executeCommand('DROP DATABASE test1 IF EXISTS')
         cy.executeCommand(':clear')
 
         cy.executeCommand(':use system')
@@ -94,10 +93,7 @@ describe('Multi database', () => {
       it('adds databases to the sidebar and adds backticks to special db names', () => {
         // Add db
         cy.executeCommand(':use system')
-        cy.executeCommand('CREATE DATABASE `name-with-dash`')
-        cy.resultContains('1 system update')
-        cy.wait(10000) // wait for db to come online
-        cy.executeCommand(':clear')
+        cy.createDatabase('`name-with-dash`')
 
         // Count items in list
         cy.get('[data-testid="navigationDBMS"]').click()
@@ -178,11 +174,8 @@ describe('Multi database', () => {
 
     if (isEnterpriseEdition()) {
       it('lists new databases with :dbs command', () => {
-        cy.executeCommand('CREATE DATABASE sidebartest')
+        cy.createDatabase('sidebartest')
 
-        cy.wait(3000) // CREATE database can take a sec
-
-        cy.executeCommand(':clear')
         cy.executeCommand(':dbs')
         databaseList().should('have.length', 3)
         databaseList().contains('system')

e2e_tests/integration/multistatements.spec.ts

@@ -112,7 +112,7 @@ describe('Multi statements', () => {
       .first()
       .should('contain', 'ERROR')
   })
-  if (Cypress.config('serverVersion') >= 4.0) {
+  if (Cypress.config('serverVersion') >= 4.1) {
     if (isEnterpriseEdition()) {
       it('Can use :use command in multi-statements', () => {
         cy.executeCommand(':clear')
@@ -122,25 +122,9 @@ describe('Multi statements', () => {
           'have.length',
           1
         )
-        cy.executeCommand('DROP DATABASE test1')
-        cy.executeCommand('DROP DATABASE test2')
-        cy.get('[data-testid="frame"]', { timeout: 10000 }).should(
-          'have.length',
-          3
-        )
-        cy.executeCommand(':clear')
 
-        cy.executeCommand('CREATE DATABASE test1')
-        cy.get('[data-testid="frame"]', { timeout: 10000 }).should(
-          'have.length',
-          1
-        )
-        cy.executeCommand('CREATE DATABASE test2')
-        cy.get('[data-testid="frame"]', { timeout: 10000 }).should(
-          'have.length',
-          2
-        )
-        cy.executeCommand(':clear')
+        cy.createDatabase('test1')
+        cy.createDatabase('test2')
 
         // Time to try it
         const query = ':use test1; CREATE(:Test1); :use test2; CREATE(:Test2);'

e2e_tests/support/commands.ts

@@ -189,3 +189,32 @@ Cypress.Commands.add(
     })
   }
 )
+
+Cypress.Commands.add('createDatabase', (dbName: string) => {
+  cy.executeCommand(`DROP DATABASE ${dbName} IF EXISTS;`)
+  cy.executeCommand(':clear')
+  cy.executeCommand(`CREATE DATABASE ${dbName}`)
+  cy.contains('1 system update, no records')
+
+  pollForDbOnline()
+
+  function pollForDbOnline(totalWaitMs = 0) {
+    if (totalWaitMs > 6000) {
+      throw new Error('Database did not come online')
+    }
+
+    cy.get('[data-testid="frameCommand"]').click()
+    cy.typeInFrame(`SHOW DATABASE ${dbName} YIELD currentStatus{enter}`)
+    cy.get('[data-testid="frameContents"] [role="cell"] span').then(
+      statusSpan => {
+        if (statusSpan.text().includes('online')) {
+          // started properly, clear stream & carry on.
+          cy.executeCommand(':clear')
+        } else {
+          cy.wait(500)
+          pollForDbOnline(totalWaitMs + 500)
+        }
+      }
+    )
+  }
+})

e2e_tests/support/global.d.ts

@@ -44,6 +44,10 @@ declare global {
         options?: Partial<Cypress.TypeOptions>
       ): Cypress.Chainable<void>
       waitForCommandResult(): Cypress.Chainable<void>
+      /**
+       * Custom command to create a database and wait for it to come online
+       */
+      createDatabase(dbName: string): Cypress.Chainable<void>
       /**
        * Custom command for testing content of frame
        */