From 78c2a5a51cce6a76c765335a5de2abaafa7d24ad Mon Sep 17 00:00:00 2001 From: mike12345567 Date: Tue, 17 Dec 2024 15:23:24 +0000 Subject: [PATCH] Typing datasource and sorted integration stores --- .../{datasources.js => datasources.ts} | 112 +++++++++++++----- .../src/stores/builder/sortedIntegrations.js | 39 ------ .../src/stores/builder/sortedIntegrations.ts | 46 +++++++ .../scripts/integrations/mysql/init.sql | 4 + packages/types/src/api/web/app/datasource.ts | 2 +- packages/types/src/index.ts | 1 + packages/types/src/ui/index.ts | 1 + packages/types/src/ui/stores/index.ts | 1 + packages/types/src/ui/stores/integration.ts | 5 + 9 files changed, 139 insertions(+), 72 deletions(-) rename packages/builder/src/stores/builder/{datasources.js => datasources.ts} (64%) delete mode 100644 packages/builder/src/stores/builder/sortedIntegrations.js create mode 100644 packages/builder/src/stores/builder/sortedIntegrations.ts create mode 100644 packages/types/src/ui/index.ts create mode 100644 packages/types/src/ui/stores/index.ts create mode 100644 packages/types/src/ui/stores/integration.ts diff --git a/packages/builder/src/stores/builder/datasources.js b/packages/builder/src/stores/builder/datasources.ts similarity index 64% rename from packages/builder/src/stores/builder/datasources.js rename to packages/builder/src/stores/builder/datasources.ts index 1cb7d49200..e167b10c2c 100644 --- a/packages/builder/src/stores/builder/datasources.js +++ b/packages/builder/src/stores/builder/datasources.ts @@ -7,11 +7,26 @@ import { import { tables } from "./tables" import { queries } from "./queries" import { API } from "api" -import { DatasourceFeature } from "@budibase/types" +import { + DatasourceFeature, + Datasource, + Table, + Integration, + UIIntegration, + SourceName, +} from "@budibase/types" +// @ts-ignore import { TableNames } from "constants" +// when building the internal DS - seems to represent it slightly differently to the backend typing of a DS +interface InternalDatasource extends Omit { + entities: Table[] +} + class TableImportError extends Error { - constructor(errors) { + errors: Record + + constructor(errors: Record) { super() this.name = "TableImportError" this.errors = errors @@ -26,8 +41,13 @@ class TableImportError extends Error { } } +interface DatasourceStore { + list: Datasource[] + selectedDatasourceId: null | string +} + export function createDatasourcesStore() { - const store = writable({ + const store = writable({ list: [], selectedDatasourceId: null, }) @@ -36,23 +56,25 @@ export function createDatasourcesStore() { // 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 = $store.list?.find(ds => ds._id === BUDIBASE_INTERNAL_DB_ID) + 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.list?.filter(table => { - return ( - table.sourceId === BUDIBASE_INTERNAL_DB_ID && - table._id !== TableNames.USERS - ) - }), + entities: tables, } } // Build up enriched DS list // Only add the internal DS if we have at least one non-users table - let list = [] + let list: (InternalDatasource | Datasource)[] = [] if (internalDS?.entities?.length) { list.push(internalDS) } @@ -75,62 +97,82 @@ export function createDatasourcesStore() { })) } - const select = id => { + const select = (id: string) => { store.update(state => ({ ...state, selectedDatasourceId: id, })) } - const updateDatasource = (response, { ignoreErrors } = {}) => { + const updateDatasource = ( + response: { datasource: Datasource; errors?: Record }, + { ignoreErrors }: { ignoreErrors?: boolean } = {} + ) => { const { datasource, errors } = response if (!ignoreErrors && errors && Object.keys(errors).length > 0) { throw new TableImportError(errors) } - replaceDatasource(datasource._id, datasource) - select(datasource._id) + replaceDatasource(datasource._id!, datasource) + select(datasource._id!) return datasource } - const updateSchema = async (datasource, tablesFilter) => { + const updateSchema = async ( + datasource: Datasource, + tablesFilter: string[] + ) => { const response = await API.buildDatasourceSchema( - datasource?._id, + datasource?._id!, tablesFilter ) updateDatasource(response) } - const sourceCount = source => { + const sourceCount = (source: string) => { return get(store).list.filter(datasource => datasource.source === source) .length } - const checkDatasourceValidity = async (integration, datasource) => { + const checkDatasourceValidity = async ( + integration: Integration, + datasource: Datasource + ): Promise<{ valid: boolean; error?: string }> => { if (integration.features?.[DatasourceFeature.CONNECTION_CHECKING]) { const { connected, error } = await API.validateDatasource(datasource) if (connected) { - return + return { valid: true } + } else { + return { valid: false, error } } - - throw new Error(`Unable to connect: ${error}`) } + return { valid: true } } - const create = async ({ integration, config }) => { + const create = async ({ + integration, + config, + }: { + integration: UIIntegration + config: Record + }) => { const count = sourceCount(integration.name) const nameModifier = count === 0 ? "" : ` ${count + 1}` - const datasource = { + const datasource: Datasource = { type: "datasource", - source: integration.name, + source: integration.name as SourceName, config, name: `${integration.friendlyName}${nameModifier}`, plus: integration.plus && integration.name !== IntegrationTypes.REST, isSQL: integration.isSQL, } - if (await checkDatasourceValidity(integration, datasource)) { - throw new Error("Unable to connect") + const { valid, error } = await checkDatasourceValidity( + integration, + datasource + ) + if (!valid) { + throw new Error(`Unable to connect - ${error}`) } const response = await API.createDatasource({ @@ -141,7 +183,13 @@ export function createDatasourcesStore() { return updateDatasource(response, { ignoreErrors: true }) } - const update = async ({ integration, datasource }) => { + const update = async ({ + integration, + datasource, + }: { + integration: Integration + datasource: Datasource + }) => { if (await checkDatasourceValidity(integration, datasource)) { throw new Error("Unable to connect") } @@ -151,15 +199,15 @@ export function createDatasourcesStore() { return updateDatasource(response) } - const deleteDatasource = async datasource => { + const deleteDatasource = async (datasource: Datasource) => { if (!datasource?._id || !datasource?._rev) { return } await API.deleteDatasource(datasource._id, datasource._rev) - replaceDatasource(datasource._id, null) + replaceDatasource(datasource._id) } - const replaceDatasource = (datasourceId, datasource) => { + const replaceDatasource = (datasourceId: string, datasource?: Datasource) => { if (!datasourceId) { return } @@ -197,7 +245,7 @@ export function createDatasourcesStore() { } } - const getTableNames = async datasource => { + const getTableNames = async (datasource: Datasource) => { const info = await API.fetchInfoForDatasource(datasource) return info.tableNames || [] } diff --git a/packages/builder/src/stores/builder/sortedIntegrations.js b/packages/builder/src/stores/builder/sortedIntegrations.js deleted file mode 100644 index 3f5dd850ab..0000000000 --- a/packages/builder/src/stores/builder/sortedIntegrations.js +++ /dev/null @@ -1,39 +0,0 @@ -import { integrations } from "./integrations" -import { derived } from "svelte/store" - -import { DatasourceTypes } from "constants/backend" - -const getIntegrationOrder = type => { - if (type === DatasourceTypes.API) return 1 - if (type === DatasourceTypes.RELATIONAL) return 2 - if (type === DatasourceTypes.NON_RELATIONAL) return 3 - - // Sort all others arbitrarily by the first character of their name. - // Character codes can technically be as low as 0, so make sure the number is at least 4 - return type.charCodeAt(0) + 4 -} - -export const createSortedIntegrationsStore = () => { - return derived(integrations, $integrations => { - const integrationsAsArray = Object.entries($integrations).map( - ([name, integration]) => ({ - name, - ...integration, - }) - ) - - return integrationsAsArray.sort((integrationA, integrationB) => { - const integrationASortOrder = getIntegrationOrder(integrationA.type) - const integrationBSortOrder = getIntegrationOrder(integrationB.type) - if (integrationASortOrder === integrationBSortOrder) { - return integrationA.friendlyName.localeCompare( - integrationB.friendlyName - ) - } - - return integrationASortOrder < integrationBSortOrder ? -1 : 1 - }) - }) -} - -export const sortedIntegrations = createSortedIntegrationsStore() diff --git a/packages/builder/src/stores/builder/sortedIntegrations.ts b/packages/builder/src/stores/builder/sortedIntegrations.ts new file mode 100644 index 0000000000..bd8bb8154f --- /dev/null +++ b/packages/builder/src/stores/builder/sortedIntegrations.ts @@ -0,0 +1,46 @@ +import { integrations } from "./integrations" +import { derived } from "svelte/store" + +import { DatasourceTypes } from "constants/backend" +import { UIIntegration, Integration } from "@budibase/types" + +const getIntegrationOrder = (type: string | undefined) => { + // if type is not known, sort to end + if (!type) { + return Number.MAX_SAFE_INTEGER + } + if (type === DatasourceTypes.API) return 1 + if (type === DatasourceTypes.RELATIONAL) return 2 + if (type === DatasourceTypes.NON_RELATIONAL) return 3 + + // Sort all others arbitrarily by the first character of their name. + // Character codes can technically be as low as 0, so make sure the number is at least 4 + return type.charCodeAt(0) + 4 +} + +export const createSortedIntegrationsStore = () => { + return derived( + integrations, + $integrations => { + const entries: [string, Integration][] = Object.entries($integrations) + const integrationsAsArray = entries.map(([name, integration]) => ({ + name, + ...integration, + })) + + return integrationsAsArray.sort((integrationA, integrationB) => { + const integrationASortOrder = getIntegrationOrder(integrationA.type) + const integrationBSortOrder = getIntegrationOrder(integrationB.type) + if (integrationASortOrder === integrationBSortOrder) { + return integrationA.friendlyName.localeCompare( + integrationB.friendlyName + ) + } + + return integrationASortOrder < integrationBSortOrder ? -1 : 1 + }) + } + ) +} + +export const sortedIntegrations = createSortedIntegrationsStore() diff --git a/packages/server/scripts/integrations/mysql/init.sql b/packages/server/scripts/integrations/mysql/init.sql index e687c7c3b1..bbb2425b0d 100644 --- a/packages/server/scripts/integrations/mysql/init.sql +++ b/packages/server/scripts/integrations/mysql/init.sql @@ -30,6 +30,10 @@ CREATE TABLE Products ( name text, updated time ); +CREATE TABLE `table with space` ( + id serial primary key, + name text +); INSERT INTO Persons (FirstName, LastName, Age, Address, City, CreatedAt) VALUES ('Mike', 'Hughes', 28.2, '123 Fake Street', 'Belfast', '2021-01-19 03:14:07'); INSERT INTO Persons (FirstName, LastName, Age, Address, City, CreatedAt) VALUES ('Dave', 'Johnson', 29, '124 Fake Street', 'Belfast', '2022-04-01 00:11:11'); INSERT INTO Person (Name) VALUES ('Elf'); diff --git a/packages/types/src/api/web/app/datasource.ts b/packages/types/src/api/web/app/datasource.ts index 6f982d7060..77c47c02d6 100644 --- a/packages/types/src/api/web/app/datasource.ts +++ b/packages/types/src/api/web/app/datasource.ts @@ -12,7 +12,7 @@ export interface UpdateDatasourceResponse { export interface CreateDatasourceRequest { datasource: Datasource fetchSchema?: boolean - tablesFilter: string[] + tablesFilter?: string[] } export interface VerifyDatasourceRequest { diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts index a0932829cf..264daa70ad 100644 --- a/packages/types/src/index.ts +++ b/packages/types/src/index.ts @@ -3,3 +3,4 @@ export * from "./sdk" export * from "./api" export * from "./core" export * from "./shared" +export * from "./ui" diff --git a/packages/types/src/ui/index.ts b/packages/types/src/ui/index.ts new file mode 100644 index 0000000000..766d5b3652 --- /dev/null +++ b/packages/types/src/ui/index.ts @@ -0,0 +1 @@ +export * from "./stores" diff --git a/packages/types/src/ui/stores/index.ts b/packages/types/src/ui/stores/index.ts new file mode 100644 index 0000000000..658691cc6d --- /dev/null +++ b/packages/types/src/ui/stores/index.ts @@ -0,0 +1 @@ +export * from "./integration" diff --git a/packages/types/src/ui/stores/integration.ts b/packages/types/src/ui/stores/integration.ts new file mode 100644 index 0000000000..4580fd00b1 --- /dev/null +++ b/packages/types/src/ui/stores/integration.ts @@ -0,0 +1,5 @@ +import { Integration } from "@budibase/types" + +export interface UIIntegration extends Integration { + name: string +}