@budibase/worker 2.1.39 → 2.1.40-alpha.1

package/src/api/routes/global/tests/auth.spec.ts

@@ -1,11 +1,16 @@
 jest.mock("nodemailer")
-import { TestConfiguration, mocks, API } from "../../../../tests"
+import { TestConfiguration, mocks } from "../../../../tests"
 const sendMailMock = mocks.email.mock()
 import { events } from "@budibase/backend-core"
 
+const expectSetAuthCookie = (res: any) => {
+  expect(
+    res.get("Set-Cookie").find((c: string) => c.startsWith("budibase:auth"))
+  ).toBeDefined()
+}
+
 describe("/api/global/auth", () => {
   const config = new TestConfiguration()
-  const api = new API(config)
 
   beforeAll(async () => {
     await config.beforeAll()
@@ -19,90 +24,155 @@ describe("/api/global/auth", () => {
     jest.clearAllMocks()
   })
 
-  it("should logout", async () => {
-    await api.auth.logout()
-    expect(events.auth.logout).toBeCalledTimes(1)
-  })
+  describe("password", () => {
+    describe("POST /api/global/auth/:tenantId/login", () => {
+      it("should login", () => {})
+    })
 
-  it("should be able to generate password reset email", async () => {
-    const { res, code } = await api.auth.requestPasswordReset(sendMailMock)
-    const user = await config.getUser("test@test.com")
+    describe("POST /api/global/auth/logout", () => {
+      it("should logout", async () => {
+        await config.api.auth.logout()
+        expect(events.auth.logout).toBeCalledTimes(1)
 
-    expect(res.body).toEqual({
-      message: "Please check your email for a reset link.",
+        // TODO: Verify sessions deleted
+      })
     })
-    expect(sendMailMock).toHaveBeenCalled()
 
-    expect(code).toBeDefined()
-    expect(events.user.passwordResetRequested).toBeCalledTimes(1)
-    expect(events.user.passwordResetRequested).toBeCalledWith(user)
+    describe("POST /api/global/auth/:tenantId/reset", () => {
+      it("should generate password reset email", async () => {
+        const { res, code } = await config.api.auth.requestPasswordReset(
+          sendMailMock
+        )
+        const user = await config.getUser("test@test.com")
+
+        expect(res.body).toEqual({
+          message: "Please check your email for a reset link.",
+        })
+        expect(sendMailMock).toHaveBeenCalled()
+
+        expect(code).toBeDefined()
+        expect(events.user.passwordResetRequested).toBeCalledTimes(1)
+        expect(events.user.passwordResetRequested).toBeCalledWith(user)
+      })
+    })
+
+    describe("POST /api/global/auth/:tenantId/reset/update", () => {
+      it("should reset password", async () => {
+        const { code } = await config.api.auth.requestPasswordReset(
+          sendMailMock
+        )
+        const user = await config.getUser("test@test.com")
+        delete user.password
+
+        const res = await config.api.auth.updatePassword(code)
+
+        expect(res.body).toEqual({ message: "password reset successfully." })
+        expect(events.user.passwordReset).toBeCalledTimes(1)
+        expect(events.user.passwordReset).toBeCalledWith(user)
+
+        // TODO: Login using new password
+      })
+    })
+  })
+
+  describe("init", () => {
+    describe("POST /api/global/auth/init", () => {})
+
+    describe("GET /api/global/auth/init", () => {})
   })
 
-  it("should allow resetting user password with code", async () => {
-    const { code } = await api.auth.requestPasswordReset(sendMailMock)
-    const user = await config.getUser("test@test.com")
-    delete user.password
+  describe("datasource", () => {
+    // MULTI TENANT
+
+    describe("GET /api/global/auth/:tenantId/datasource/:provider", () => {})
+
+    describe("GET /api/global/auth/:tenantId/datasource/:provider/callback", () => {})
 
-    const res = await api.auth.updatePassword(code)
+    // SINGLE TENANT
 
-    expect(res.body).toEqual({ message: "password reset successfully." })
-    expect(events.user.passwordReset).toBeCalledTimes(1)
-    expect(events.user.passwordReset).toBeCalledWith(user)
+    describe("GET /api/global/auth/datasource/:provider/callback", () => {})
   })
 
-  describe("oidc", () => {
-    const auth = require("@budibase/backend-core/auth")
+  describe("google", () => {
+    // MULTI TENANT
+
+    describe("GET /api/global/auth/:tenantId/google", () => {})
 
-    const passportSpy = jest.spyOn(auth.passport, "authenticate")
-    let oidcConf
-    let chosenConfig: any
-    let configId: string
+    describe("GET /api/global/auth/:tenantId/google/callback", () => {})
 
-    // mock the oidc strategy implementation and return value
-    let strategyFactory = jest.fn()
-    let mockStrategyReturn = jest.fn()
-    let mockStrategyConfig = jest.fn()
-    auth.oidc.fetchStrategyConfig = mockStrategyConfig
+    // SINGLE TENANT
 
-    strategyFactory.mockReturnValue(mockStrategyReturn)
-    auth.oidc.strategyFactory = strategyFactory
+    describe("GET /api/global/auth/google/callback", () => {})
 
+    describe("GET /api/admin/auth/google/callback", () => {})
+  })
+
+  describe("oidc", () => {
     beforeEach(async () => {
-      oidcConf = await config.saveOIDCConfig()
-      chosenConfig = oidcConf.config.configs[0]
-      configId = chosenConfig.uuid
-      mockStrategyConfig.mockReturnValue(chosenConfig)
-    })
+      jest.clearAllMocks()
+      mockGetWellKnownConfig()
 
-    afterEach(() => {
-      expect(strategyFactory).toBeCalledWith(chosenConfig, expect.any(Function))
+      // see: __mocks__/oauth
+      // for associated mocking inside passport
     })
 
-    describe("oidc configs", () => {
-      it("should load strategy and delegate to passport", async () => {
-        await api.configs.getOIDCConfig(configId)
-
-        expect(passportSpy).toBeCalledWith(mockStrategyReturn, {
-          scope: ["profile", "email", "offline_access"],
-        })
-        expect(passportSpy.mock.calls.length).toBe(1)
+    const generateOidcConfig = async () => {
+      const oidcConf = await config.saveOIDCConfig()
+      const chosenConfig = oidcConf.config.configs[0]
+      return chosenConfig.uuid
+    }
+
+    const mockGetWellKnownConfig = () => {
+      mocks.fetch.mockReturnValue({
+        ok: true,
+        json: () => ({
+          issuer: "test",
+          authorization_endpoint: "http://localhost/auth",
+          token_endpoint: "http://localhost/token",
+          userinfo_endpoint: "http://localhost/userinfo",
+        }),
+      })
+    }
+
+    // MULTI TENANT
+    describe("GET /api/global/auth/:tenantId/oidc/configs/:configId", () => {
+      it("redirects to auth provider", async () => {
+        const configId = await generateOidcConfig()
+
+        const res = await config.api.configs.getOIDCConfig(configId)
+
+        expect(res.status).toBe(302)
+        const location: string = res.get("location")
+        expect(
+          location.startsWith(
+            "http://localhost/auth?response_type=code&client_id=clientId&redirect_uri=http%3A%2F%2Flocalhost%3A10000%2Fapi%2Fglobal%2Fauth%2Fdefault%2Foidc%2Fcallback&scope=openid%20profile%20email%20offline_access"
+          )
+        ).toBe(true)
       })
     })
 
-    describe("oidc callback", () => {
-      it("should load strategy and delegate to passport", async () => {
-        await api.configs.OIDCCallback(configId)
-
-        expect(passportSpy).toBeCalledWith(
-          mockStrategyReturn,
-          {
-            successRedirect: "/",
-            failureRedirect: "/error",
-          },
-          expect.anything()
-        )
-        expect(passportSpy.mock.calls.length).toBe(1)
+    describe("GET /api/global/auth/:tenantId/oidc/callback", () => {
+      it("logs in", async () => {
+        const configId = await generateOidcConfig()
+        const preAuthRes = await config.api.configs.getOIDCConfig(configId)
+
+        const res = await config.api.configs.OIDCCallback(configId, preAuthRes)
+
+        expect(events.auth.login).toBeCalledWith("oidc")
+        expect(events.auth.login).toBeCalledTimes(1)
+        expect(res.status).toBe(302)
+        const location: string = res.get("location")
+        expect(location).toBe("/")
+        expectSetAuthCookie(res)
       })
     })
+
+    // SINGLE TENANT
+
+    describe("GET /api/global/auth/oidc/callback", () => {})
+
+    describe("GET /api/global/auth/oidc/callback", () => {})
+
+    describe("GET /api/admin/auth/oidc/callback", () => {})
   })
 })

package/src/api/routes/global/tests/configs.spec.ts

@@ -1,12 +1,11 @@
 // mock the email system
 jest.mock("nodemailer")
-import { TestConfiguration, structures, mocks, API } from "../../../../tests"
+import { TestConfiguration, structures, mocks } from "../../../../tests"
 mocks.email.mock()
-import { Configs, events } from "@budibase/backend-core"
+import { Config, events } from "@budibase/backend-core"
 
 describe("configs", () => {
   const config = new TestConfiguration()
-  const api = new API(config)
 
   beforeAll(async () => {
     await config.beforeAll()
@@ -28,7 +27,7 @@ describe("configs", () => {
         _rev,
       }
 
-      const res = await api.configs.saveConfig(data)
+      const res = await config.api.configs.saveConfig(data)
 
       return {
         ...data,
@@ -50,20 +49,20 @@ describe("configs", () => {
         it("should create activated google config", async () => {
           await saveGoogleConfig()
           expect(events.auth.SSOCreated).toBeCalledTimes(1)
-          expect(events.auth.SSOCreated).toBeCalledWith(Configs.GOOGLE)
+          expect(events.auth.SSOCreated).toBeCalledWith(Config.GOOGLE)
           expect(events.auth.SSODeactivated).not.toBeCalled()
           expect(events.auth.SSOActivated).toBeCalledTimes(1)
-          expect(events.auth.SSOActivated).toBeCalledWith(Configs.GOOGLE)
-          await config.deleteConfig(Configs.GOOGLE)
+          expect(events.auth.SSOActivated).toBeCalledWith(Config.GOOGLE)
+          await config.deleteConfig(Config.GOOGLE)
         })
 
         it("should create deactivated google config", async () => {
           await saveGoogleConfig({ activated: false })
           expect(events.auth.SSOCreated).toBeCalledTimes(1)
-          expect(events.auth.SSOCreated).toBeCalledWith(Configs.GOOGLE)
+          expect(events.auth.SSOCreated).toBeCalledWith(Config.GOOGLE)
           expect(events.auth.SSOActivated).not.toBeCalled()
           expect(events.auth.SSODeactivated).not.toBeCalled()
-          await config.deleteConfig(Configs.GOOGLE)
+          await config.deleteConfig(Config.GOOGLE)
         })
       })
 
@@ -77,11 +76,11 @@ describe("configs", () => {
             googleConf._rev
           )
           expect(events.auth.SSOUpdated).toBeCalledTimes(1)
-          expect(events.auth.SSOUpdated).toBeCalledWith(Configs.GOOGLE)
+          expect(events.auth.SSOUpdated).toBeCalledWith(Config.GOOGLE)
           expect(events.auth.SSOActivated).not.toBeCalled()
           expect(events.auth.SSODeactivated).toBeCalledTimes(1)
-          expect(events.auth.SSODeactivated).toBeCalledWith(Configs.GOOGLE)
-          await config.deleteConfig(Configs.GOOGLE)
+          expect(events.auth.SSODeactivated).toBeCalledWith(Config.GOOGLE)
+          await config.deleteConfig(Config.GOOGLE)
         })
 
         it("should update google config to activated", async () => {
@@ -93,11 +92,11 @@ describe("configs", () => {
             googleConf._rev
           )
           expect(events.auth.SSOUpdated).toBeCalledTimes(1)
-          expect(events.auth.SSOUpdated).toBeCalledWith(Configs.GOOGLE)
+          expect(events.auth.SSOUpdated).toBeCalledWith(Config.GOOGLE)
           expect(events.auth.SSODeactivated).not.toBeCalled()
           expect(events.auth.SSOActivated).toBeCalledTimes(1)
-          expect(events.auth.SSOActivated).toBeCalledWith(Configs.GOOGLE)
-          await config.deleteConfig(Configs.GOOGLE)
+          expect(events.auth.SSOActivated).toBeCalledWith(Config.GOOGLE)
+          await config.deleteConfig(Config.GOOGLE)
         })
       })
     })
@@ -116,20 +115,20 @@ describe("configs", () => {
         it("should create activated OIDC config", async () => {
           await saveOIDCConfig()
           expect(events.auth.SSOCreated).toBeCalledTimes(1)
-          expect(events.auth.SSOCreated).toBeCalledWith(Configs.OIDC)
+          expect(events.auth.SSOCreated).toBeCalledWith(Config.OIDC)
           expect(events.auth.SSODeactivated).not.toBeCalled()
           expect(events.auth.SSOActivated).toBeCalledTimes(1)
-          expect(events.auth.SSOActivated).toBeCalledWith(Configs.OIDC)
-          await config.deleteConfig(Configs.OIDC)
+          expect(events.auth.SSOActivated).toBeCalledWith(Config.OIDC)
+          await config.deleteConfig(Config.OIDC)
         })
 
         it("should create deactivated OIDC config", async () => {
           await saveOIDCConfig({ activated: false })
           expect(events.auth.SSOCreated).toBeCalledTimes(1)
-          expect(events.auth.SSOCreated).toBeCalledWith(Configs.OIDC)
+          expect(events.auth.SSOCreated).toBeCalledWith(Config.OIDC)
           expect(events.auth.SSOActivated).not.toBeCalled()
           expect(events.auth.SSODeactivated).not.toBeCalled()
-          await config.deleteConfig(Configs.OIDC)
+          await config.deleteConfig(Config.OIDC)
         })
       })
 
@@ -143,11 +142,11 @@ describe("configs", () => {
             oidcConf._rev
           )
           expect(events.auth.SSOUpdated).toBeCalledTimes(1)
-          expect(events.auth.SSOUpdated).toBeCalledWith(Configs.OIDC)
+          expect(events.auth.SSOUpdated).toBeCalledWith(Config.OIDC)
           expect(events.auth.SSOActivated).not.toBeCalled()
           expect(events.auth.SSODeactivated).toBeCalledTimes(1)
-          expect(events.auth.SSODeactivated).toBeCalledWith(Configs.OIDC)
-          await config.deleteConfig(Configs.OIDC)
+          expect(events.auth.SSODeactivated).toBeCalledWith(Config.OIDC)
+          await config.deleteConfig(Config.OIDC)
         })
 
         it("should update OIDC config to activated", async () => {
@@ -159,11 +158,11 @@ describe("configs", () => {
             oidcConf._rev
           )
           expect(events.auth.SSOUpdated).toBeCalledTimes(1)
-          expect(events.auth.SSOUpdated).toBeCalledWith(Configs.OIDC)
+          expect(events.auth.SSOUpdated).toBeCalledWith(Config.OIDC)
           expect(events.auth.SSODeactivated).not.toBeCalled()
           expect(events.auth.SSOActivated).toBeCalledTimes(1)
-          expect(events.auth.SSOActivated).toBeCalledWith(Configs.OIDC)
-          await config.deleteConfig(Configs.OIDC)
+          expect(events.auth.SSOActivated).toBeCalledWith(Config.OIDC)
+          await config.deleteConfig(Config.OIDC)
         })
       })
     })
@@ -180,11 +179,11 @@ describe("configs", () => {
 
       describe("create", () => {
         it("should create SMTP config", async () => {
-          await config.deleteConfig(Configs.SMTP)
+          await config.deleteConfig(Config.SMTP)
           await saveSMTPConfig()
           expect(events.email.SMTPUpdated).not.toBeCalled()
           expect(events.email.SMTPCreated).toBeCalledTimes(1)
-          await config.deleteConfig(Configs.SMTP)
+          await config.deleteConfig(Config.SMTP)
         })
       })
 
@@ -195,7 +194,7 @@ describe("configs", () => {
           await saveSMTPConfig(smtpConf.config, smtpConf._id, smtpConf._rev)
           expect(events.email.SMTPCreated).not.toBeCalled()
           expect(events.email.SMTPUpdated).toBeCalledTimes(1)
-          await config.deleteConfig(Configs.SMTP)
+          await config.deleteConfig(Config.SMTP)
         })
       })
     })
@@ -212,7 +211,7 @@ describe("configs", () => {
 
       describe("create", () => {
         it("should create settings config with default settings", async () => {
-          await config.deleteConfig(Configs.SETTINGS)
+          await config.deleteConfig(Config.SETTINGS)
 
           await saveSettingsConfig()
 
@@ -223,7 +222,7 @@ describe("configs", () => {
 
         it("should create settings config with non-default settings", async () => {
           config.modeSelf()
-          await config.deleteConfig(Configs.SETTINGS)
+          await config.deleteConfig(Config.SETTINGS)
           const conf = {
             company: "acme",
             logoUrl: "http://example.com",
@@ -235,14 +234,14 @@ describe("configs", () => {
           expect(events.org.nameUpdated).toBeCalledTimes(1)
           expect(events.org.logoUpdated).toBeCalledTimes(1)
           expect(events.org.platformURLUpdated).toBeCalledTimes(1)
-          config.modeAccount()
+          config.modeCloud()
         })
       })
 
       describe("update", () => {
         it("should update settings config", async () => {
           config.modeSelf()
-          await config.deleteConfig(Configs.SETTINGS)
+          await config.deleteConfig(Config.SETTINGS)
           const settingsConfig = await saveSettingsConfig()
           settingsConfig.config.company = "acme"
           settingsConfig.config.logoUrl = "http://example.com"
@@ -257,7 +256,7 @@ describe("configs", () => {
           expect(events.org.nameUpdated).toBeCalledTimes(1)
           expect(events.org.logoUpdated).toBeCalledTimes(1)
           expect(events.org.platformURLUpdated).toBeCalledTimes(1)
-          config.modeAccount()
+          config.modeCloud()
         })
       })
     })
@@ -266,7 +265,7 @@ describe("configs", () => {
   it("should return the correct checklist status based on the state of the budibase installation", async () => {
     await config.saveSmtpConfig()
 
-    const res = await api.configs.getConfigChecklist()
+    const res = await config.api.configs.getConfigChecklist()
     const checklist = res.body
 
     expect(checklist.apps.checked).toBeFalsy()

package/src/api/routes/global/tests/email.spec.ts

@@ -1,11 +1,10 @@
 jest.mock("nodemailer")
-import { TestConfiguration, mocks, API } from "../../../../tests"
+import { TestConfiguration, mocks } from "../../../../tests"
 const sendMailMock = mocks.email.mock()
 import { EmailTemplatePurpose } from "../../../../constants"
 
 describe("/api/global/email", () => {
   const config = new TestConfiguration()
-  const api = new API(config)
 
   beforeAll(async () => {
     await config.beforeAll()
@@ -20,7 +19,9 @@ describe("/api/global/email", () => {
     await config.saveSmtpConfig()
     await config.saveSettingsConfig()
 
-    const res = await api.emails.sendEmail(EmailTemplatePurpose.INVITATION)
+    const res = await config.api.emails.sendEmail(
+      EmailTemplatePurpose.INVITATION
+    )
 
     expect(res.body.message).toBeDefined()
     expect(sendMailMock).toHaveBeenCalled()

package/src/api/routes/global/tests/license.spec.ts

@@ -0,0 +1,31 @@
+import { TestConfiguration } from "../../../../tests"
+
+// TODO
+
+describe("/api/global/license", () => {
+  const config = new TestConfiguration()
+
+  beforeAll(async () => {
+    await config.beforeAll()
+  })
+
+  afterAll(async () => {
+    await config.afterAll()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  describe("POST /api/global/license/activate", () => {
+    it("activates license", () => {})
+  })
+
+  describe("POST /api/global/license/refresh", () => {})
+
+  describe("GET /api/global/license/info", () => {})
+
+  describe("DELETE /api/global/license/info", () => {})
+
+  describe("GET /api/global/license/usage", () => {})
+})

package/src/api/routes/global/tests/realEmail.spec.ts

@@ -1,4 +1,4 @@
-import { TestConfiguration, API } from "../../../../tests"
+import { TestConfiguration } from "../../../../tests"
 import { EmailTemplatePurpose } from "../../../../constants"
 const nodemailer = require("nodemailer")
 const fetch = require("node-fetch")
@@ -8,7 +8,6 @@ jest.setTimeout(30000)
 
 describe("/api/global/email", () => {
   const config = new TestConfiguration()
-  const api = new API(config)
 
   beforeAll(async () => {
     await config.beforeAll()
@@ -35,7 +34,7 @@ describe("/api/global/email", () => {
       await Promise.race([config.saveEtherealSmtpConfig(), timeout()])
       await Promise.race([config.saveSettingsConfig(), timeout()])
 
-      const res = await api.emails.sendEmail(purpose).timeout(20000)
+      const res = await config.api.emails.sendEmail(purpose).timeout(20000)
       // ethereal hiccup, can't test right now
       if (res.status >= 300) {
         return

package/src/api/routes/global/tests/roles.spec.ts

@@ -0,0 +1,27 @@
+import { TestConfiguration } from "../../../../tests"
+
+// TODO
+
+describe("/api/global/roles", () => {
+  const config = new TestConfiguration()
+
+  beforeAll(async () => {
+    await config.beforeAll()
+  })
+
+  afterAll(async () => {
+    await config.afterAll()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  describe("GET /api/global/roles", () => {
+    it("retrieves roles", () => {})
+  })
+
+  describe("GET /api/global/roles/:appId", () => {})
+
+  describe("DELETE /api/global/roles/:appId", () => {})
+})

package/src/api/routes/global/tests/self.spec.ts

@@ -1,10 +1,9 @@
 jest.mock("nodemailer")
-import { TestConfiguration, API, mocks } from "../../../../tests"
+import { TestConfiguration, mocks } from "../../../../tests"
 import { events } from "@budibase/backend-core"
 
 describe("/api/global/self", () => {
   const config = new TestConfiguration()
-  const api = new API(config)
 
   beforeAll(async () => {
     await config.beforeAll()
@@ -24,7 +23,7 @@ describe("/api/global/self", () => {
       await config.createSession(user)
 
       delete user.password
-      const res = await api.self.updateSelf(user)
+      const res = await config.api.self.updateSelf(user)
 
       const dbUser = await config.getUser(user.email)
       user._rev = dbUser._rev
@@ -40,7 +39,7 @@ describe("/api/global/self", () => {
       await config.createSession(user)
 
       user.password = "newPassword"
-      const res = await api.self.updateSelf(user)
+      const res = await config.api.self.updateSelf(user)
 
       const dbUser = await config.getUser(user.email)
       user._rev = dbUser._rev

package/src/api/routes/global/tests/templates.spec.ts

@@ -0,0 +1,35 @@
+import { TestConfiguration } from "../../../../tests"
+
+// TODO
+
+describe("/api/global/template", () => {
+  const config = new TestConfiguration()
+
+  beforeAll(async () => {
+    await config.beforeAll()
+  })
+
+  afterAll(async () => {
+    await config.afterAll()
+  })
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  describe("GET /api/global/template/definitions", () => {
+    it("retrieves definitions", () => {})
+  })
+
+  describe("POST /api/global/template", () => {})
+
+  describe("GET /api/global/template", () => {})
+
+  describe("GET /api/global/template/:type", () => {})
+
+  describe("GET /api/global/template/:ownerId", () => {})
+
+  describe("GET /api/global/template/:id", () => {})
+
+  describe("DELETE /api/global/template/:id/:rev", () => {})
+})