Merge pull request #15213 from Budibase/fix-ds-validity-checking

Fix datasource validity checking

packages/builder/src/stores/BudiStore.ts

@@ -1,44 +1,41 @@
-import { writable, Writable } from "svelte/store"
+import { writable, Writable, Readable } from "svelte/store"
 
 interface BudiStoreOpts {
   debug?: boolean
 }
 
-export default class BudiStore<T> implements Writable<T> {
+export class BudiStore<T> {
   store: Writable<T>
   subscribe: Writable<T>["subscribe"]
   update: Writable<T>["update"]
   set: Writable<T>["set"]
 
   constructor(init: T, opts?: BudiStoreOpts) {
-    const store = writable<T>(init)
-
-    /**
-     * Internal Svelte store
-     */
-    this.store = store
-
-    /**
-     * Exposes the svelte subscribe fn to allow $ notation access
-     * @example
-     * $navigation.selectedScreenId
-     */
+    this.store = writable<T>(init)
     this.subscribe = this.store.subscribe
-
-    /**
-     * Exposes the svelte update fn.
-     * *Store modification should be kept to a minimum
-     */
     this.update = this.store.update
     this.set = this.store.set
 
-    /**
-     * Optional debug mode to output the store updates to console
-     */
+    // Optional debug mode to output the store updates to console
     if (opts?.debug) {
       this.subscribe(state => {
         console.warn(`${this.constructor.name}`, state)
       })
     }
   }
 }
+
+export class DerivedBudiStore<T, DerivedT extends T> extends BudiStore<T> {
+  derivedStore: Readable<DerivedT>
+  subscribe: Readable<DerivedT>["subscribe"]
+
+  constructor(
+    init: T,
+    makeDerivedStore: (store: Writable<T>) => Readable<DerivedT>,
+    opts?: BudiStoreOpts
+  ) {
+    super(init, opts)
+    this.derivedStore = makeDerivedStore(this.store)
+    this.subscribe = this.derivedStore.subscribe
+  }
+}

packages/builder/src/stores/builder/app.js

@@ -1,5 +1,5 @@
 import { API } from "api"
-import BudiStore from "../BudiStore"
+import { BudiStore } from "../BudiStore"
 
 export const INITIAL_APP_META_STATE = {
   appId: "",

packages/builder/src/stores/builder/builder.js

@@ -1,7 +1,7 @@
 import { get } from "svelte/store"
 import { createBuilderWebsocket } from "./websocket.js"
 import { BuilderSocketEvent } from "@budibase/shared-core"
-import BudiStore from "../BudiStore.js"
+import { BudiStore } from "../BudiStore.js"
 import { TOUR_KEYS } from "components/portal/onboarding/tours.js"
 
 export const INITIAL_BUILDER_STATE = {

packages/builder/src/stores/builder/components.js

@@ -28,7 +28,7 @@ import {
   DB_TYPE_INTERNAL,
   DB_TYPE_EXTERNAL,
 } from "constants/backend"
-import BudiStore from "../BudiStore"
+import { BudiStore } from "../BudiStore"
 import { Utils } from "@budibase/frontend-core"
 import { FieldType } from "@budibase/types"
 import { utils } from "@budibase/shared-core"

packages/builder/src/stores/builder/datasources.ts

@@ -1,4 +1,4 @@
-import { derived, get } from "svelte/store"
+import { derived, get, Writable } from "svelte/store"
 import {
   IntegrationTypes,
   DEFAULT_BB_DATASOURCE_ID,
@@ -17,12 +17,7 @@ import {
 } from "@budibase/types"
 // @ts-ignore
 import { TableNames } from "constants"
-import BudiStore from "stores/BudiStore"
-
-// when building the internal DS - seems to represent it slightly differently to the backend typing of a DS
-interface InternalDatasource extends Omit<Datasource, "entities"> {
-  entities: Table[]
-}
+import { DerivedBudiStore } from "stores/BudiStore"
 
 class TableImportError extends Error {
   errors: Record<string, string>
@@ -42,68 +37,76 @@ class TableImportError extends Error {
   }
 }
 
+// when building the internal DS - seems to represent it slightly differently to the backend typing of a DS
+interface InternalDatasource extends Omit<Datasource, "entities"> {
+  entities: Table[]
+}
+
 interface BuilderDatasourceStore {
-  list: Datasource[]
+  rawList: Datasource[]
   selectedDatasourceId: null | string
 }
 
-interface DerivedDatasourceStore extends Omit<BuilderDatasourceStore, "list"> {
+interface DerivedDatasourceStore extends BuilderDatasourceStore {
   list: (Datasource | InternalDatasource)[]
   selected?: Datasource | InternalDatasource
   hasDefaultData: boolean
   hasData: boolean
 }
 
-export class DatasourceStore extends BudiStore<DerivedDatasourceStore> {
+export class DatasourceStore extends DerivedBudiStore<
+  BuilderDatasourceStore,
+  DerivedDatasourceStore
+> {
   constructor() {
-    super({
-      list: [],
-      selectedDatasourceId: null,
-      hasDefaultData: false,
-      hasData: false,
-    })
+    const makeDerivedStore = (store: Writable<BuilderDatasourceStore>) => {
+      return derived([store, tables], ([$store, $tables]) => {
+        // Set the internal datasource entities from the table list, which we're
+        // able to keep updated unlike the egress generated definition of the
+        // internal datasource
+        let internalDS: Datasource | InternalDatasource | undefined =
+          $store.rawList?.find(ds => ds._id === BUDIBASE_INTERNAL_DB_ID)
+        let otherDS = $store.rawList?.filter(
+          ds => ds._id !== BUDIBASE_INTERNAL_DB_ID
+        )
+        if (internalDS) {
+          const tables: Table[] = $tables.list?.filter((table: Table) => {
+            return (
+              table.sourceId === BUDIBASE_INTERNAL_DB_ID &&
+              table._id !== TableNames.USERS
+            )
+          })
+          internalDS = {
+            ...internalDS,
+            entities: tables,
+          }
+        }
 
-    const derivedStore = derived<
-      [DatasourceStore, BudiStore<any>],
-      DerivedDatasourceStore
-    >([this, tables as any], ([$store, $tables]) => {
-      // Set the internal datasource entities from the table list, which we're
-      // able to keep updated unlike the egress generated definition of the
-      // internal datasource
-      let internalDS: Datasource | InternalDatasource | undefined =
-        $store.list?.find(ds => ds._id === BUDIBASE_INTERNAL_DB_ID)
-      let otherDS = $store.list?.filter(
-        ds => ds._id !== BUDIBASE_INTERNAL_DB_ID
-      )
-      if (internalDS) {
-        const tables: Table[] = $tables.list?.filter((table: Table) => {
-          return (
-            table.sourceId === BUDIBASE_INTERNAL_DB_ID &&
-            table._id !== TableNames.USERS
-          )
-        })
-        internalDS = {
-          ...internalDS,
-          entities: tables,
+        // Build up enriched DS list
+        // Only add the internal DS if we have at least one non-users table
+        let list: (InternalDatasource | Datasource)[] = []
+        if (internalDS?.entities?.length) {
+          list.push(internalDS)
         }
-      }
+        list = list.concat(otherDS || [])
+
+        return {
+          ...$store,
+          list,
+          selected: list?.find(ds => ds._id === $store.selectedDatasourceId),
+          hasDefaultData: list?.some(ds => ds._id === DEFAULT_BB_DATASOURCE_ID),
+          hasData: list?.length > 0,
+        }
+      })
+    }
 
-      // Build up enriched DS list
-      // Only add the internal DS if we have at least one non-users table
-      let list: (InternalDatasource | Datasource)[] = []
-      if (internalDS?.entities?.length) {
-        list.push(internalDS)
-      }
-      list = list.concat(otherDS || [])
-
-      return {
-        ...$store,
-        list,
-        selected: list?.find(ds => ds._id === $store.selectedDatasourceId),
-        hasDefaultData: list?.some(ds => ds._id === DEFAULT_BB_DATASOURCE_ID),
-        hasData: list?.length > 0,
-      }
-    })
+    super(
+      {
+        rawList: [],
+        selectedDatasourceId: null,
+      },
+      makeDerivedStore
+    )
 
     this.fetch = this.fetch.bind(this)
     this.init = this.fetch.bind(this)
@@ -114,14 +117,13 @@ export class DatasourceStore extends BudiStore<DerivedDatasourceStore> {
     this.save = this.save.bind(this)
     this.replaceDatasource = this.replaceDatasource.bind(this)
     this.getTableNames = this.getTableNames.bind(this)
-    this.subscribe = derivedStore.subscribe
   }
 
   async fetch() {
     const datasources = await API.getDatasources()
     this.store.update(state => ({
       ...state,
-      list: datasources,
+      rawList: datasources,
     }))
   }
 
@@ -158,7 +160,7 @@ export class DatasourceStore extends BudiStore<DerivedDatasourceStore> {
   }
 
   sourceCount(source: string) {
-    return get(this.store).list.filter(
+    return get(this.store).rawList.filter(
       datasource => datasource.source === source
     ).length
   }
@@ -220,7 +222,7 @@ export class DatasourceStore extends BudiStore<DerivedDatasourceStore> {
     integration: Integration
     datasource: Datasource
   }) {
-    if (await this.checkDatasourceValidity(integration, datasource)) {
+    if (!(await this.checkDatasourceValidity(integration, datasource)).valid) {
       throw new Error("Unable to connect")
     }
 
@@ -250,19 +252,21 @@ export class DatasourceStore extends BudiStore<DerivedDatasourceStore> {
     if (!datasource) {
       this.store.update(state => ({
         ...state,
-        list: state.list.filter(x => x._id !== datasourceId),
+        rawList: state.rawList.filter(x => x._id !== datasourceId),
       }))
       tables.removeDatasourceTables(datasourceId)
       queries.removeDatasourceQueries(datasourceId)
       return
     }
 
     // Add new datasource
-    const index = get(this.store).list.findIndex(x => x._id === datasource._id)
+    const index = get(this.store).rawList.findIndex(
+      x => x._id === datasource._id
+    )
     if (index === -1) {
       this.store.update(state => ({
         ...state,
-        list: [...state.list, datasource],
+        rawList: [...state.rawList, datasource],
       }))
 
       // If this is a new datasource then we should refresh the tables list,
@@ -273,7 +277,7 @@ export class DatasourceStore extends BudiStore<DerivedDatasourceStore> {
     // Update existing datasource
     else if (datasource) {
       this.store.update(state => {
-        state.list[index] = datasource
+        state.rawList[index] = datasource
         return state
       })
     }
@@ -283,10 +287,6 @@ export class DatasourceStore extends BudiStore<DerivedDatasourceStore> {
     const info = await API.fetchInfoForDatasource(datasource)
     return info.tableNames || []
   }
-
-  // subscribe() {
-  //   return this.derivedStore.subscribe()
-  // }
 }
 
 export const datasources = new DatasourceStore()

packages/builder/src/stores/builder/hover.js

@@ -1,6 +1,6 @@
 import { get } from "svelte/store"
 import { previewStore } from "stores/builder"
-import BudiStore from "../BudiStore"
+import { BudiStore } from "../BudiStore"
 
 export const INITIAL_HOVER_STATE = {
   componentId: null,

packages/builder/src/stores/builder/layouts.js

@@ -1,6 +1,6 @@
 import { derived, get } from "svelte/store"
 import { componentStore } from "stores/builder"
-import BudiStore from "../BudiStore"
+import { BudiStore } from "../BudiStore"
 import { API } from "api"
 
 export const INITIAL_LAYOUT_STATE = {

packages/builder/src/stores/builder/navigation.js

@@ -1,7 +1,7 @@
 import { get } from "svelte/store"
 import { API } from "api"
 import { appStore } from "stores/builder"
-import BudiStore from "../BudiStore"
+import { BudiStore } from "../BudiStore"
 
 export const INITIAL_NAVIGATION_STATE = {
   navigation: "Top",

packages/builder/src/stores/builder/rowActions.js

@@ -1,5 +1,5 @@
 import { get, derived } from "svelte/store"
-import BudiStore from "stores/BudiStore"
+import { BudiStore } from "stores/BudiStore"
 import { tables } from "./tables"
 import { viewsV2 } from "./viewsV2"
 import { automationStore } from "./automations"

packages/builder/src/stores/builder/screens.js

@@ -12,7 +12,7 @@ import {
 } from "stores/builder"
 import { createHistoryStore } from "stores/builder/history"
 import { API } from "api"
-import BudiStore from "../BudiStore"
+import { BudiStore } from "../BudiStore"
 
 export const INITIAL_SCREENS_STATE = {
   screens: [],

packages/builder/src/stores/builder/sortedIntegrations.ts

@@ -3,7 +3,7 @@ import { derived } from "svelte/store"
 
 import { DatasourceTypes } from "constants/backend"
 import { UIIntegration, Integration } from "@budibase/types"
-import BudiStore from "stores/BudiStore"
+import { BudiStore } from "stores/BudiStore"
 
 const getIntegrationOrder = (type: string | undefined) => {
   // if type is not known, sort to end

packages/builder/src/stores/portal/apps.ts

@@ -3,7 +3,7 @@ import { derived } from "svelte/store"
 import { AppStatus } from "constants"
 import { API } from "api"
 import { auth } from "./auth"
-import BudiStore from "../BudiStore"
+import { BudiStore } from "../BudiStore"
 import { App, UpdateAppRequest } from "@budibase/types"
 
 interface AppIdentifierMetadata {

packages/builder/src/stores/portal/auditLogs.ts

@@ -1,7 +1,7 @@
 import { get } from "svelte/store"
 import { API } from "api"
 import { licensing } from "./licensing"
-import BudiStore from "../BudiStore"
+import { BudiStore } from "../BudiStore"
 import {
   DownloadAuditLogsRequest,
   SearchAuditLogsRequest,

packages/builder/src/stores/portal/auth.ts

@@ -2,7 +2,7 @@ import { get } from "svelte/store"
 import { API } from "api"
 import { admin } from "stores/portal"
 import analytics from "analytics"
-import BudiStore from "stores/BudiStore"
+import { BudiStore } from "stores/BudiStore"
 import {
   isSSOUser,
   SetInitInfoRequest,