CodeMirror/budibase
1
0
Fork 0
mirror of synced 2024-07-06 15:00:49 +12:00
Code Issues Projects Releases Wiki Activity

Major update to make the table.type always 'table' and then adding a new sourceType which states what source the table came from, external or internal. Don't want to keep using a type that should be static as two different things.

Browse source
This commit is contained in:
mike12345567 2023-10-26 13:19:09 +01:00
parent fd0d8f17f2
commit ed0670a008
44 changed files with 236 additions and 136 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
packages/builder/src/builderStore/store/frontend.js
View file

@ -580,7 +580,7 @@ export const getFrontendStore = () => {
let table = validTables.find(table => {
return (
table.sourceId !== BUDIBASE_INTERNAL_DB_ID &&
table.type === DB_TYPE_INTERNAL
table.sourceType === DB_TYPE_INTERNAL
)
})
if (table) {
@ -591,7 +591,7 @@ export const getFrontendStore = () => {
table = validTables.find(table => {
return (
table.sourceId === BUDIBASE_INTERNAL_DB_ID &&
table.type === DB_TYPE_INTERNAL
table.sourceType === DB_TYPE_INTERNAL
)
})
if (table) {
@ -599,7 +599,7 @@ export const getFrontendStore = () => {
}
// Finally try an external table
return validTables.find(table => table.type === DB_TYPE_EXTERNAL)
return validTables.find(table => table.sourceType === DB_TYPE_EXTERNAL)
},
enrichEmptySettings: (component, opts) => {
if (!component?._component) {

3
packages/builder/src/components/backend/DataTable/RelationshipDataTable.svelte
View file

@ -16,7 +16,6 @@
$: linkedTable = $tables.list.find(table => table._id === linkedTableId)
$: schema = linkedTable?.schema
$: table = $tables.list.find(table => table._id === tableId)
$: type = table?.type
$: fetchData(tableId, rowId)
$: {
let rowLabel = row?.[table?.primaryDisplay]
@ -41,5 +40,5 @@
</script>
{#if row && row._id === rowId}
<Table {title} {schema} {data} {type} />
<Table {title} {schema} {data} />
{/if}

8
packages/builder/src/components/backend/DataTable/TableDataTable.svelte
View file

@ -16,6 +16,7 @@
import GridRelationshipButton from "components/backend/DataTable/buttons/grid/GridRelationshipButton.svelte"
import GridEditColumnModal from "components/backend/DataTable/modals/grid/GridEditColumnModal.svelte"
import GridUsersTableButton from "components/backend/DataTable/modals/grid/GridUsersTableButton.svelte"
import { DB_TYPE_EXTERNAL } from "constants/backend"
const userSchemaOverrides = {
firstName: { displayName: "First name", disabled: true },
@ -27,7 +28,7 @@
$: id = $tables.selected?._id
$: isUsersTable = id === TableNames.USERS
$: isInternal = $tables.selected?.type !== "external"
$: isInternal = $tables.selected?.sourceType !== DB_TYPE_EXTERNAL
$: gridDatasource = {
type: "table",
tableId: id,
@ -46,10 +47,7 @@
tables.replaceTable(id, e.detail)
// We need to refresh datasources when an external table changes.
// Type "external" may exist - sometimes type is "table" and sometimes it
// is "external" - it has different meanings in different endpoints.
// If we check both these then we hopefully catch all external tables.
if (e.detail?.type === "external" || e.detail?.sql) {
if (e.detail?.sourceType === DB_TYPE_EXTERNAL || e.detail?.sql) {
await datasources.fetch()
}
}

2
packages/builder/src/components/backend/DataTable/ViewDataTable.svelte
View file

@ -17,7 +17,6 @@
let hideAutocolumns = true
let data = []
let loading = false
let type = "internal"
$: name = view.name
$: calculation = view.calculation
@ -65,7 +64,6 @@
tableId={view.tableId}
{data}
{loading}
{type}
rowCount={10}
allowEditing={false}
bind:hideAutocolumns

2
packages/builder/src/components/backend/DataTable/buttons/grid/GridImportButton.svelte
View file

@ -10,6 +10,6 @@
<ImportButton
{disabled}
tableId={$datasource?.tableId}
tableType={$definition?.type}
tableType={$definition?.sourceType}
on:importrows={rows.actions.refreshData}
/>

14
packages/builder/src/components/backend/DataTable/modals/CreateEditColumn.svelte
View file

@ -26,6 +26,7 @@
ALLOWABLE_NUMBER_TYPES,
SWITCHABLE_TYPES,
PrettyRelationshipDefinitions,
DB_TYPE_EXTERNAL,
} from "constants/backend"
import { getAutoColumnInformation, buildAutoColumn } from "builderStore/utils"
import ConfirmDialog from "components/common/ConfirmDialog.svelte"
@ -254,10 +255,11 @@
!uneditable &&
editableColumn?.type !== AUTO_TYPE &&
!editableColumn.autocolumn
$: external = table.type === "external"
$: externalTable = table.sourceType === DB_TYPE_EXTERNAL
// in the case of internal tables the sourceId will just be undefined
$: tableOptions = $tables.list.filter(
opt => opt.type === table.type && table.sourceId === opt.sourceId
opt =>
opt.sourceType === table.sourceType && table.sourceId === opt.sourceId
)
$: typeEnabled =
!originalName ||
@ -409,7 +411,7 @@
editableColumn.type === FieldType.BB_REFERENCE &&
editableColumn.subtype === FieldSubtype.USERS
if (!external) {
if (!externalTable) {
return [
FIELDS.STRING,
FIELDS.BARCODEQR,
@ -441,7 +443,7 @@
isUsers ? FIELDS.USERS : FIELDS.USER,
]
// no-sql or a spreadsheet
if (!external || table.sql) {
if (!externalTable || table.sql) {
fields = [...fields, FIELDS.LINK, FIELDS.ARRAY]
}
return fields
@ -486,7 +488,7 @@
})
}
const newError = {}
if (!external && fieldInfo.name?.startsWith("_")) {
if (!externalTable && fieldInfo.name?.startsWith("_")) {
newError.name = `Column name cannot start with an underscore.`
} else if (fieldInfo.name && !fieldInfo.name.match(ValidColumnNameRegex)) {
newError.name = `Illegal character; must be alpha-numeric.`
@ -498,7 +500,7 @@
newError.name = `Column name already in use.`
}
if (fieldInfo.type == "auto" && !fieldInfo.subtype) {
if (fieldInfo.type === "auto" && !fieldInfo.subtype) {
newError.subtype = `Auto Column requires a type`
}

4
packages/builder/src/components/backend/TableNavigator/ExistingTableDataImport.svelte
View file

@ -1,6 +1,6 @@
<script>
import { Select, Toggle, Multiselect } from "@budibase/bbui"
import { FIELDS } from "constants/backend"
import { DB_TYPE_INTERNAL, FIELDS } from "constants/backend"
import { API } from "api"
import { parseFile } from "./utils"
@ -169,7 +169,7 @@
</div>
{/each}
</div>
{#if tableType === "internal"}
{#if tableType === DB_TYPE_INTERNAL}
<br />
<Toggle
bind:value={updateExistingRows}

4
packages/builder/src/components/backend/TableNavigator/modals/CreateTableModal.svelte
View file

@ -8,6 +8,7 @@
import {
BUDIBASE_INTERNAL_DB_ID,
BUDIBASE_DATASOURCE_TYPE,
DB_TYPE_INTERNAL,
} from "constants/backend"
$: tableNames = $tables.list.map(table => table.name)
@ -55,8 +56,9 @@
name,
schema: { ...schema },
rows,
type: "internal",
type: "table",
sourceId: targetDatasourceId,
sourceType: DB_TYPE_INTERNAL,
}
// Only set primary display if defined

9
packages/builder/src/components/backend/TableNavigator/popovers/EditTablePopover.svelte
View file

@ -13,6 +13,7 @@
notifications,
} from "@budibase/bbui"
import ConfirmDialog from "components/common/ConfirmDialog.svelte"
import { DB_TYPE_EXTERNAL } from "constants/backend"
export let table
@ -27,8 +28,8 @@
let willBeDeleted
let deleteTableName
$: external = table?.type === "external"
$: allowDeletion = !external || table?.created
$: externalTable = table?.sourceType === DB_TYPE_EXTERNAL
$: allowDeletion = !externalTable || table?.created
function showDeleteModal() {
templateScreens = $store.screens.filter(
@ -48,7 +49,7 @@
for (let screen of templateScreens) {
await store.actions.screens.delete(screen)
}
if (table.type === "external") {
if (table.sourceType === DB_TYPE_EXTERNAL) {
await datasources.fetch()
}
notifications.success("Table deleted")
@ -91,7 +92,7 @@
<div slot="control" class="icon">
<Icon s hoverable name="MoreSmallList" />
</div>
{#if !external}
{#if !externalTable}
<MenuItem icon="Edit" on:click={editorModal.show}>Edit</MenuItem>
{/if}
<MenuItem icon="Delete" on:click={showDeleteModal}>Delete</MenuItem>

2
packages/builder/src/components/integration/QueryViewerSidePanel/PreviewPanel.svelte
View file

@ -23,7 +23,7 @@
</script>
<div class="table">
<Table {schema} data={rowsCopy} type="external" allowEditing={false} />
<Table {schema} data={rowsCopy} allowEditing={false} />
</div>
<style>

4
packages/builder/src/pages/builder/app/[application]/data/datasource/[datasourceId]/_components/panels/Tables/CreateExternalTableModal.svelte
View file

@ -2,6 +2,7 @@
import { ModalContent, Body, Input, notifications } from "@budibase/bbui"
import { tables, datasources } from "stores/backend"
import { goto } from "@roxi/routify"
import { DB_TYPE_EXTERNAL } from "constants/backend"
export let datasource
@ -16,9 +17,10 @@
function buildDefaultTable(tableName, datasourceId) {
return {
name: tableName,
type: "external",
type: "table",
primary: ["id"],
sourceId: datasourceId,
sourceType: DB_TYPE_EXTERNAL,
schema: {
id: {
autocolumn: true,

4
packages/builder/src/pages/builder/app/[application]/data/datasource/bb_internal/index.svelte
View file

@ -5,7 +5,7 @@
import { tables, datasources } from "stores/backend"
import { goto } from "@roxi/routify"
import { onMount } from "svelte"
import { BUDIBASE_INTERNAL_DB_ID } from "constants/backend"
import { BUDIBASE_INTERNAL_DB_ID, DB_TYPE_EXTERNAL } from "constants/backend"
import { TableNames } from "constants"
import { store } from "builderStore"
@ -14,7 +14,7 @@
$: store.actions.websocket.selectResource(BUDIBASE_INTERNAL_DB_ID)
$: internalTablesBySourceId = $tables.list.filter(
table =>
table.type !== "external" &&
table.sourceType !== DB_TYPE_EXTERNAL &&
table.sourceId === BUDIBASE_INTERNAL_DB_ID &&
table._id !== TableNames.USERS
)

5
packages/builder/src/pages/builder/app/[application]/data/datasource/datasource_internal_bb_default/index.svelte
View file

@ -4,7 +4,7 @@
import ICONS from "components/backend/DatasourceNavigator/icons"
import { tables, datasources } from "stores/backend"
import { goto } from "@roxi/routify"
import { DEFAULT_BB_DATASOURCE_ID } from "constants/backend"
import { DEFAULT_BB_DATASOURCE_ID, DB_TYPE_EXTERNAL } from "constants/backend"
import { onMount } from "svelte"
import { store } from "builderStore"
@ -13,7 +13,8 @@
$: store.actions.websocket.selectResource(DEFAULT_BB_DATASOURCE_ID)
$: internalTablesBySourceId = $tables.list.filter(
table =>
table.type !== "external" && table.sourceId === DEFAULT_BB_DATASOURCE_ID
table.sourceType !== DB_TYPE_EXTERNAL &&
table.sourceId === DEFAULT_BB_DATASOURCE_ID
)
onMount(() => {

7
packages/server/src/api/controllers/table/index.ts
View file

@ -13,12 +13,13 @@ import {
FetchTablesResponse,
MigrateRequest,
MigrateResponse,
Row,
SaveTableRequest,
SaveTableResponse,
Table,
TableResponse,
TableSourceType,
UserCtx,
Row,
} from "@budibase/types"
import sdk from "../../../sdk"
import { jsonFromCsvString } from "../../../utilities/csv"
@ -29,7 +30,7 @@ function pickApi({ tableId, table }: { tableId?: string; table?: Table }) {
if (table && !tableId) {
tableId = table._id
}
if (table && table.type === "external") {
if (table && table.sourceType === TableSourceType.EXTERNAL) {
return external
} else if (tableId && isExternalTable(tableId)) {
return external
@ -48,7 +49,7 @@ export async function fetch(ctx: UserCtx<void, FetchTablesResponse>) {
if (entities) {
return Object.values(entities).map<Table>((entity: Table) => ({
...entity,
type: "external",
sourceType: TableSourceType.EXTERNAL,
sourceId: datasource._id!,
sql: isSQL(datasource),
}))

6
packages/server/src/api/controllers/table/internal.ts
View file

@ -7,6 +7,7 @@ import {
SaveTableRequest,
SaveTableResponse,
Table,
TableSourceType,
UserCtx,
} from "@budibase/types"
import sdk from "../../../sdk"
@ -16,10 +17,11 @@ export async function save(ctx: UserCtx<SaveTableRequest, SaveTableResponse>) {
let tableToSave: Table & {
_rename?: RenameColumn
} = {
type: "table",
_id: generateTableID(),
views: {},
...rest,
type: "table",
sourceType: TableSourceType.INTERNAL,
views: {},
}
const renaming = tableToSave._rename
delete tableToSave._rename

9
packages/server/src/api/routes/tests/row.spec.ts
View file

@ -10,6 +10,7 @@ import {
FieldSchema,
FieldType,
FieldTypeSubtypes,
INTERNAL_TABLE_SOURCE_ID,
MonthlyQuotaName,
PermissionLevel,
QuotaUsageType,
@ -21,7 +22,7 @@ import {
SortType,
StaticQuotaName,
Table,
INTERNAL_TABLE_SOURCE_ID,
TableSourceType,
} from "@budibase/types"
import {
expectAnyExternalColsAttributes,
@ -66,6 +67,7 @@ describe.each([
type: "table",
primary: ["id"],
primaryDisplay: "name",
sourceType: TableSourceType.INTERNAL,
sourceId: INTERNAL_TABLE_SOURCE_ID,
schema: {
id: {
@ -441,6 +443,7 @@ describe.each([
describe("view save", () => {
it("views have extra data trimmed", async () => {
const table = await config.createTable({
type: "table",
name: "orders",
primary: ["OrderID"],
schema: {
@ -883,6 +886,7 @@ describe.each([
return {
name: `users_${generator.word()}`,
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
type: "table",
primary: ["id"],
schema: {
@ -1066,6 +1070,7 @@ describe.each([
return {
name: `users_${generator.word()}`,
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
type: "table",
primary: ["id"],
schema: {
@ -1603,7 +1608,7 @@ describe.each([
if (config.datasource) {
tableConfig.sourceId = config.datasource._id!
if (config.datasource.plus) {
tableConfig.type = "external"
tableConfig.sourceType = TableSourceType.EXTERNAL
}
}
const table = await config.api.table.create({

23
packages/server/src/api/routes/tests/table.spec.ts
View file

@ -1,21 +1,23 @@
import { events, context } from "@budibase/backend-core"
import { context, events } from "@budibase/backend-core"
import {
FieldType,
SaveTableRequest,
RelationshipType,
Table,
ViewCalculation,
AutoFieldSubTypes,
InternalTable,
FieldSubtype,
Row,
FieldType,
INTERNAL_TABLE_SOURCE_ID,
InternalTable,
RelationshipType,
Row,
SaveTableRequest,
Table,
TableSourceType,
ViewCalculation,
} from "@budibase/types"
import { checkBuilderEndpoint } from "./utilities/TestFunctions"
import * as setup from "./utilities"
const { basicTable } = setup.structures
import sdk from "../../../sdk"
const { basicTable } = setup.structures
describe("/tables", () => {
let request = setup.getRequest()
let config = setup.getConfig()
@ -434,6 +436,7 @@ describe("/tables", () => {
name: "table",
type: "table",
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
schema: {
"user relationship": {
type: FieldType.LINK,
@ -494,6 +497,7 @@ describe("/tables", () => {
name: "table",
type: "table",
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
schema: {
"user relationship": {
type: FieldType.LINK,
@ -556,6 +560,7 @@ describe("/tables", () => {
name: "table",
type: "table",
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
schema: {
"user relationship": {
type: FieldType.LINK,

6
packages/server/src/api/routes/tests/viewV2.spec.ts
View file

@ -3,14 +3,15 @@ import {
CreateViewRequest,
FieldSchema,
FieldType,
INTERNAL_TABLE_SOURCE_ID,
SearchQueryOperators,
SortOrder,
SortType,
Table,
TableSourceType,
UIFieldMetadata,
UpdateViewRequest,
ViewV2,
INTERNAL_TABLE_SOURCE_ID,
} from "@budibase/types"
import { generator } from "@budibase/backend-core/tests"
import { generateDatasourceID } from "../../../db/utils"
@ -20,6 +21,7 @@ function priceTable(): Table {
name: "table",
type: "table",
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
schema: {
Price: {
type: FieldType.NUMBER,
@ -59,7 +61,7 @@ describe.each([
return config.createTable({
...priceTable(),
sourceId: datasource._id,
type: "external",
sourceType: TableSourceType.EXTERNAL,
})
},
],

7
packages/server/src/constants/index.ts
View file

@ -1,9 +1,11 @@
import { objectStore, roles, constants } from "@budibase/backend-core"
import { constants, objectStore, roles } from "@budibase/backend-core"
import {
FieldType as FieldTypes,
Table,
INTERNAL_TABLE_SOURCE_ID,
Table,
TableSourceType,
} from "@budibase/types"
export {
FieldType as FieldTypes,
RelationshipType,
@ -78,6 +80,7 @@ export const USERS_TABLE_SCHEMA: Table = {
_id: "ta_users",
type: "table",
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
views: {},
name: "Users",
// TODO: ADMIN PANEL - when implemented this doesn't need to be carried out

21
packages/server/src/db/defaultData/datasource_bb_default.ts
View file

@ -1,4 +1,4 @@
import { FieldTypes, AutoFieldSubTypes } from "../../constants"
import { AutoFieldSubTypes, FieldTypes } from "../../constants"
import { importToRows } from "../../api/controllers/table/utils"
import { cloneDeep } from "lodash/fp"
import LinkDocument from "../linkedRows/LinkDocument"
@ -8,11 +8,12 @@ import { jobsImport } from "./jobsImport"
import { expensesImport } from "./expensesImport"
import { db as dbCore } from "@budibase/backend-core"
import {
Table,
Row,
RelationshipType,
FieldType,
RelationshipType,
Row,
Table,
TableSchema,
TableSourceType,
} from "@budibase/types"
export const DEFAULT_JOBS_TABLE_ID = "ta_bb_jobs"
@ -89,9 +90,10 @@ const AUTO_COLUMNS: TableSchema = {
export const DEFAULT_INVENTORY_TABLE_SCHEMA: Table = {
_id: DEFAULT_INVENTORY_TABLE_ID,
type: "internal",
type: "table",
views: {},
sourceId: DEFAULT_BB_DATASOURCE_ID,
sourceType: TableSourceType.INTERNAL,
primaryDisplay: "Item Name",
name: "Inventory",
schema: {
@ -198,10 +200,11 @@ export const DEFAULT_INVENTORY_TABLE_SCHEMA: Table = {
export const DEFAULT_EMPLOYEE_TABLE_SCHEMA: Table = {
_id: DEFAULT_EMPLOYEE_TABLE_ID,
type: "internal",
type: "table",
views: {},
name: "Employees",
sourceId: DEFAULT_BB_DATASOURCE_ID,
sourceType: TableSourceType.INTERNAL,
primaryDisplay: "First Name",
schema: {
"First Name": {
@ -346,9 +349,10 @@ export const DEFAULT_EMPLOYEE_TABLE_SCHEMA: Table = {
export const DEFAULT_JOBS_TABLE_SCHEMA: Table = {
_id: DEFAULT_JOBS_TABLE_ID,
type: "internal",
type: "table",
name: "Jobs",
sourceId: DEFAULT_BB_DATASOURCE_ID,
sourceType: TableSourceType.INTERNAL,
primaryDisplay: "Job ID",
schema: {
"Job ID": {
@ -503,10 +507,11 @@ export const DEFAULT_JOBS_TABLE_SCHEMA: Table = {
export const DEFAULT_EXPENSES_TABLE_SCHEMA: Table = {
_id: DEFAULT_EXPENSES_TABLE_ID,
type: "internal",
type: "table",
views: {},
name: "Expenses",
sourceId: DEFAULT_BB_DATASOURCE_ID,
sourceType: TableSourceType.INTERNAL,
primaryDisplay: "Expense ID",
schema: {
"Expense ID": {

14
packages/server/src/integration-test/postgres.spec.ts
View file

@ -1,6 +1,4 @@
import fetch from "node-fetch"
// @ts-ignore
fetch.mockSearch()
import {
generateMakeRequest,
MakeRequestResponse,
@ -13,12 +11,15 @@ import {
RelationshipType,
Row,
Table,
TableSourceType,
} from "@budibase/types"
import _ from "lodash"
import { generator } from "@budibase/backend-core/tests"
import { utils } from "@budibase/backend-core"
import { databaseTestProviders } from "../integrations/tests/utils"
import { Client } from "pg"
// @ts-ignore
fetch.mockSearch()
const config = setup.getConfig()!
@ -52,7 +53,7 @@ describe("postgres integrations", () => {
async function createAuxTable(prefix: string) {
return await config.createTable({
name: `${prefix}_${generator.word({ length: 6 })}`,
type: "external",
type: "table",
primary: ["id"],
primaryDisplay: "title",
schema: {
@ -67,6 +68,7 @@ describe("postgres integrations", () => {
},
},
sourceId: postgresDatasource._id,
sourceType: TableSourceType.EXTERNAL,
})
}
@ -88,7 +90,7 @@ describe("postgres integrations", () => {
primaryPostgresTable = await config.createTable({
name: `p_${generator.word({ length: 6 })}`,
type: "external",
type: "table",
primary: ["id"],
schema: {
id: {
@ -143,6 +145,7 @@ describe("postgres integrations", () => {
},
},
sourceId: postgresDatasource._id,
sourceType: TableSourceType.EXTERNAL,
})
})
@ -249,7 +252,7 @@ describe("postgres integrations", () => {
async function createDefaultPgTable() {
return await config.createTable({
name: generator.word({ length: 10 }),
type: "external",
type: "table",
primary: ["id"],
schema: {
id: {
@ -259,6 +262,7 @@ describe("postgres integrations", () => {
},
},
sourceId: postgresDatasource._id,
sourceType: TableSourceType.EXTERNAL,
})
}

5
packages/server/src/integrations/googlesheets.ts
View file

@ -10,11 +10,12 @@ import {
QueryJson,
QueryType,
Row,
Schema,
SearchFilters,
SortJson,
Table,
TableRequest,
Schema,
TableSourceType,
} from "@budibase/types"
import { OAuth2Client } from "google-auth-library"
import {
@ -263,10 +264,12 @@ class GoogleSheetsIntegration implements DatasourcePlus {
) {
// base table
const table: Table = {
type: "table",
name: title,
primary: [GOOGLE_SHEETS_PRIMARY_KEY],
schema: {},
sourceId: datasourceId,
sourceType: TableSourceType.EXTERNAL,
}
if (id) {
table._id = id

3
packages/server/src/integrations/microsoftSqlServer.ts
View file

@ -12,6 +12,7 @@ import {
ConnectionInfo,
SourceName,
Schema,
TableSourceType,
} from "@budibase/types"
import {
getSqlQuery,
@ -439,7 +440,9 @@ class SqlServerIntegration extends Sql implements DatasourcePlus {
}
tables[tableName] = {
_id: buildExternalTableId(datasourceId, tableName),
type: "table",
sourceId: datasourceId,
sourceType: TableSourceType.EXTERNAL,
primary: primaryKeys,
name: tableName,
schema,

3
packages/server/src/integrations/mysql.ts
View file

@ -11,6 +11,7 @@ import {
ConnectionInfo,
SourceName,
Schema,
TableSourceType,
} from "@budibase/types"
import {
getSqlQuery,
@ -317,8 +318,10 @@ class MySQLIntegration extends Sql implements DatasourcePlus {
}
if (!tables[tableName]) {
tables[tableName] = {
type: "table",
_id: buildExternalTableId(datasourceId, tableName),
sourceId: datasourceId,
sourceType: TableSourceType.EXTERNAL,
primary: primaryKeys,
name: tableName,
schema,

3
packages/server/src/integrations/oracle.ts
View file

@ -10,6 +10,7 @@ import {
DatasourceFeature,
ConnectionInfo,
Schema,
TableSourceType,
} from "@budibase/types"
import {
buildExternalTableId,
@ -277,11 +278,13 @@ class OracleIntegration extends Sql implements DatasourcePlus {
let table = tables[oracleTable.name]
if (!table) {
table = {
type: "table",
_id: buildExternalTableId(datasourceId, oracleTable.name),
primary: [],
name: oracleTable.name,
schema: {},
sourceId: datasourceId,
sourceType: TableSourceType.EXTERNAL,
}
tables[oracleTable.name] = table
}

3
packages/server/src/integrations/postgres.ts
View file

@ -11,6 +11,7 @@ import {
ConnectionInfo,
SourceName,
Schema,
TableSourceType,
} from "@budibase/types"
import {
getSqlQuery,
@ -309,11 +310,13 @@ class PostgresIntegration extends Sql implements DatasourcePlus {
// table key doesn't exist yet
if (!tables[tableName] || !tables[tableName].schema) {
tables[tableName] = {
type: "table",
_id: buildExternalTableId(datasourceId, tableName),
primary: tableKeys[tableName] || [],
name: tableName,
schema: {},
sourceId: datasourceId,
sourceType: TableSourceType.EXTERNAL,
}
}

4
packages/server/src/integrations/tests/googlesheets.spec.ts
View file

@ -30,7 +30,7 @@ GoogleSpreadsheet.mockImplementation(() => mockGoogleIntegration)
import { structures } from "@budibase/backend-core/tests"
import TestConfiguration from "../../tests/utilities/TestConfiguration"
import GoogleSheetsIntegration from "../googlesheets"
import { FieldType, Table, TableSchema } from "@budibase/types"
import { FieldType, Table, TableSchema, TableSourceType } from "@budibase/types"
import { generateDatasourceID } from "../../db/utils"
describe("Google Sheets Integration", () => {
@ -61,8 +61,10 @@ describe("Google Sheets Integration", () => {
function createBasicTable(name: string, columns: string[]): Table {
return {
type: "table",
name,
sourceId: generateDatasourceID(),
sourceType: TableSourceType.EXTERNAL,
schema: {
...columns.reduce((p, c) => {
p[c] = {

2
packages/server/src/middleware/tests/trimViewRowInfo.spec.ts
View file

@ -5,6 +5,7 @@ import {
Row,
Table,
INTERNAL_TABLE_SOURCE_ID,
TableSourceType,
} from "@budibase/types"
import * as utils from "../../db/utils"
import trimViewRowInfoMiddleware from "../trimViewRowInfo"
@ -80,6 +81,7 @@ describe("trimViewRowInfo middleware", () => {
_id: tableId,
name: generator.word(),
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
type: "table",
schema: {
name: {

1
packages/server/src/middleware/trimViewRowInfo.ts
View file

@ -1,7 +1,6 @@
import { Ctx, Row } from "@budibase/types"
import * as utils from "../db/utils"
import sdk from "../sdk"
import { db } from "@budibase/backend-core"
import { Next } from "koa"
import { getTableId } from "../api/controllers/row/utils"

4
packages/server/src/sdk/app/rows/search/tests/external.spec.ts
View file

@ -7,6 +7,7 @@ import {
SourceName,
Table,
SearchParams,
TableSourceType,
} from "@budibase/types"
import TestConfiguration from "../../../../../tests/utilities/TestConfiguration"
@ -59,9 +60,10 @@ describe.skip("external", () => {
tableData = {
name: generator.word(),
type: "external",
type: "table",
primary: ["id"],
sourceId: externalDatasource._id!,
sourceType: TableSourceType.EXTERNAL,
schema: {
id: {
name: "id",

2
packages/server/src/sdk/app/rows/search/tests/internal.spec.ts
View file

@ -4,6 +4,7 @@ import {
Table,
SearchParams,
INTERNAL_TABLE_SOURCE_ID,
TableSourceType,
} from "@budibase/types"
import TestConfiguration from "../../../../../tests/utilities/TestConfiguration"
import { search } from "../internal"
@ -19,6 +20,7 @@ describe("internal", () => {
name: generator.word(),
type: "table",
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
schema: {
name: {
name: "name",

9
packages/server/src/sdk/app/rows/search/tests/utils.spec.ts
View file

@ -3,16 +3,19 @@ import { db as dbCore } from "@budibase/backend-core"
import {
FieldType,
FieldTypeSubtypes,
Table,
SearchParams,
INTERNAL_TABLE_SOURCE_ID,
SearchParams,
Table,
TableSourceType,
} from "@budibase/types"
const tableId = "ta_a"
const tableWithUserCol: Table = {
type: "table",
_id: tableId,
name: "table",
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
schema: {
user: {
name: "user",
@ -23,9 +26,11 @@ const tableWithUserCol: Table = {
}
const tableWithUsersCol: Table = {
type: "table",
_id: tableId,
name: "table",
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
schema: {
user: {
name: "user",

5
packages/server/src/sdk/app/tables/external/utils.ts vendored
View file

@ -6,6 +6,7 @@ import {
RelationshipFieldMetadata,
RelationshipType,
Table,
TableSourceType,
} from "@budibase/types"
import { FieldTypes } from "../../../../constants"
import {
@ -78,12 +79,14 @@ export function generateManyLinkSchema(
const jcTblName = generateJunctionTableName(column, table, relatedTable)
const datasourceId = datasource._id!
// first create the new table
const junctionTable = {
const junctionTable: Table = {
type: "table",
_id: buildExternalTableId(datasourceId, jcTblName),
name: jcTblName,
primary: [primary, relatedPrimary],
constrained: [primary, relatedPrimary],
sourceId: datasourceId,
sourceType: TableSourceType.EXTERNAL,
schema: {
[primary]: foreignKeyStructure(primary, {
toTable: table.name,

55
packages/server/src/sdk/app/tables/getters.ts
View file

@ -7,24 +7,41 @@ import {
} from "../../../integrations/utils"
import {
Database,
INTERNAL_TABLE_SOURCE_ID,
Table,
TableResponse,
TableSourceType,
TableViewsResponse,
INTERNAL_TABLE_SOURCE_ID,
} from "@budibase/types"
import datasources from "../datasources"
import sdk from "../../../sdk"
function processInternalTables(tables: Table[]): Table[] {
return tables.map(processInternalTable)
export function processTable(table: Table): Table {
if (table._id && isExternalTable(table._id)) {
return {
...table,
type: "table",
sourceType: TableSourceType.EXTERNAL,
}
} else {
return {
...table,
type: "table",
sourceId: table.sourceId || INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
}
}
}
export function processInternalTable(table: Table): Table {
return {
...table,
type: "internal",
sourceId: table.sourceId || INTERNAL_TABLE_SOURCE_ID,
export function processTables(tables: Table[]): Table[] {
return tables.map(table => processTable(table))
}
function processEntities(tables: Record<string, Table>) {
for (let key of Object.keys(tables)) {
tables[key] = processTable(tables[key])
}
return tables
}
export async function getAllInternalTables(db?: Database): Promise<Table[]> {
@ -36,7 +53,7 @@ export async function getAllInternalTables(db?: Database): Promise<Table[]> {
include_docs: true,
})
)
return processInternalTables(internalTables.rows.map(row => row.doc!))
return processTables(internalTables.rows.map(row => row.doc!))
}
async function getAllExternalTables(): Promise<Table[]> {
@ -48,7 +65,7 @@ async function getAllExternalTables(): Promise<Table[]> {
final = final.concat(Object.values(entities))
}
}
return final
return processTables(final)
}
export async function getExternalTable(
@ -56,19 +73,21 @@ export async function getExternalTable(
tableName: string
): Promise<Table> {
const entities = await getExternalTablesInDatasource(datasourceId)
return entities[tableName]
return processTable(entities[tableName])
}
export async function getTable(tableId: string): Promise<Table> {
const db = context.getAppDB()
let output: Table
if (isExternalTable(tableId)) {
let { datasourceId, tableName } = breakExternalTableId(tableId)
const datasource = await datasources.get(datasourceId!)
const table = await getExternalTable(datasourceId!, tableName!)
return { ...table, sql: isSQL(datasource) }
output = { ...table, sql: isSQL(datasource) }
} else {
return processInternalTable(await db.get<Table>(tableId))
output = await db.get<Table>(tableId)
}
return processTable(output)
}
export async function getAllTables() {
@ -76,7 +95,7 @@ export async function getAllTables() {
getAllInternalTables(),
getAllExternalTables(),
])
return [...internal, ...external]
return processTables([...internal, ...external])
}
export async function getExternalTablesInDatasource(
@ -86,7 +105,7 @@ export async function getExternalTablesInDatasource(
if (!datasource || !datasource.entities) {
throw new Error("Datasource is not configured fully.")
}
return datasource.entities
return processEntities(datasource.entities)
}
export async function getTables(tableIds: string[]): Promise<Table[]> {
@ -106,11 +125,9 @@ export async function getTables(tableIds: string[]): Promise<Table[]> {
const internalTableDocs = await db.allDocs<Table[]>(
getMultiIDParams(internalTableIds)
)
tables = tables.concat(
processInternalTables(internalTableDocs.rows.map(row => row.doc!))
)
tables = tables.concat(internalTableDocs.rows.map(row => row.doc!))
}
return tables
return processTables(tables)
}
export function enrichViewSchemas(table: Table): TableResponse {

2
packages/server/src/sdk/app/tables/tests/tables.spec.ts
View file

@ -2,6 +2,7 @@ import {
FieldType,
INTERNAL_TABLE_SOURCE_ID,
Table,
TableSourceType,
ViewV2,
} from "@budibase/types"
import { generator } from "@budibase/backend-core/tests"
@ -19,6 +20,7 @@ describe("table sdk", () => {
name: "TestTable",
type: "table",
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
schema: {
name: {
type: FieldType.STRING,

6
packages/server/src/sdk/app/tables/tests/validation.spec.ts
View file

@ -7,6 +7,7 @@ import {
RelationshipType,
SourceName,
Table,
TableSourceType,
} from "@budibase/types"
import { isEqual } from "lodash"
import { generateDatasourceID } from "../../../../db/utils"
@ -19,11 +20,13 @@ const SCHEMA: Datasource = {
_id: datasourceId,
entities: {
client: {
type: "table",
_id: "tableA",
name: "client",
primary: ["idC"],
primaryDisplay: "Name",
sourceId: datasourceId,
sourceType: TableSourceType.EXTERNAL,
schema: {
idC: {
autocolumn: true,
@ -49,11 +52,13 @@ const SCHEMA: Datasource = {
},
},
project: {
type: "table",
_id: "tableB",
name: "project",
primary: ["idP"],
primaryDisplay: "Name",
sourceId: datasourceId,
sourceType: TableSourceType.EXTERNAL,
schema: {
idC: {
externalType: "int unsigned",
@ -82,7 +87,6 @@ const SCHEMA: Datasource = {
},
},
sql: true,
type: "table",
},
},
}

4
packages/server/src/sdk/app/tables/utils.ts
View file

@ -1,8 +1,8 @@
import { Table } from "@budibase/types"
import { Table, TableSourceType } from "@budibase/types"
import { isExternalTable } from "../../../integrations/utils"
export function isExternal(opts: { table?: Table; tableId?: string }): boolean {
if (opts.table && opts.table.type === "external") {
if (opts.table && opts.table.sourceType === TableSourceType.EXTERNAL) {
return true
} else if (opts.tableId && isExternalTable(opts.tableId)) {
return true

2
packages/server/src/sdk/app/views/tests/views.spec.ts
View file

@ -5,6 +5,7 @@ import {
INTERNAL_TABLE_SOURCE_ID,
Table,
TableSchema,
TableSourceType,
ViewV2,
} from "@budibase/types"
import { generator } from "@budibase/backend-core/tests"
@ -16,6 +17,7 @@ describe("table sdk", () => {
name: "TestTable",
type: "table",
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
schema: {
name: {
type: FieldType.STRING,

73
packages/server/src/tests/utilities/TestConfiguration.ts
View file

@ -2,37 +2,31 @@ import { generator, mocks, structures } from "@budibase/backend-core/tests"
// init the licensing mock
import * as pro from "@budibase/pro"
mocks.licenses.init(pro)
// use unlimited license by default
mocks.licenses.useUnlimited()
import { init as dbInit } from "../../db"
dbInit()
import env from "../../environment"
import {
basicTable,
basicRow,
basicRole,
basicAutomation,
basicDatasource,
basicQuery,
basicScreen,
basicLayout,
basicWebhook,
basicAutomationResults,
basicDatasource,
basicLayout,
basicQuery,
basicRole,
basicRow,
basicScreen,
basicTable,
basicWebhook,
} from "./structures"
import {
constants,
tenancy,
sessions,
auth,
cache,
constants,
context,
db as dbCore,
encryption,
auth,
roles,
env as coreEnv,
roles,
sessions,
tenancy,
} from "@budibase/backend-core"
import * as controllers from "./controllers"
import { cleanup } from "../../utilities/fileSystem"
@ -43,24 +37,32 @@ import supertest from "supertest"
import {
App,
AuthToken,
Automation,
CreateViewRequest,
Datasource,
FieldType,
INTERNAL_TABLE_SOURCE_ID,
RelationshipFieldMetadata,
RelationshipType,
Row,
SearchFilters,
SourceName,
Table,
SearchFilters,
UserRoles,
Automation,
View,
FieldType,
RelationshipType,
CreateViewRequest,
RelationshipFieldMetadata,
TableSourceType,
User,
INTERNAL_TABLE_SOURCE_ID,
UserRoles,
View,
} from "@budibase/types"
import API from "./api"
mocks.licenses.init(pro)
// use unlimited license by default
mocks.licenses.useUnlimited()
dbInit()
type DefaultUserValues = {
globalUserId: string
email: string
@ -69,8 +71,9 @@ type DefaultUserValues = {
csrfToken: string
}
interface TableToBuild extends Omit<Table, "sourceId"> {
interface TableToBuild extends Omit<Table, "sourceId" | "sourceType"> {
sourceId?: string
sourceType?: TableSourceType
}
class TestConfiguration {
@ -547,9 +550,8 @@ class TestConfiguration {
{ skipReassigning } = { skipReassigning: false }
): Promise<Table> {
config = config || basicTable()
if (!config.sourceId) {
config.sourceId = INTERNAL_TABLE_SOURCE_ID
}
config.sourceType = config.sourceType || TableSourceType.INTERNAL
config.sourceId = config.sourceId || INTERNAL_TABLE_SOURCE_ID
const response = await this._req(config, null, controllers.table.save)
if (!skipReassigning) {
this.table = response
@ -571,7 +573,7 @@ class TestConfiguration {
if (this.datasource && !config.sourceId) {
config.sourceId = this.datasource._id || INTERNAL_TABLE_SOURCE_ID
if (this.datasource.plus) {
config.type = "external"
config.sourceType = TableSourceType.EXTERNAL
}
}
@ -609,12 +611,11 @@ class TestConfiguration {
if (this.datasource && !tableConfig.sourceId) {
tableConfig.sourceId = this.datasource._id || INTERNAL_TABLE_SOURCE_ID
if (this.datasource.plus) {
tableConfig.type = "external"
tableConfig.sourceType = TableSourceType.EXTERNAL
}
}
const linkedTable = await this.createTable(tableConfig)
return linkedTable
return await this.createTable(tableConfig)
}
async createAttachmentTable() {

2
packages/server/src/tests/utilities/structures.ts
View file

@ -20,6 +20,7 @@ import {
SourceName,
Table,
INTERNAL_TABLE_SOURCE_ID,
TableSourceType,
} from "@budibase/types"
export function basicTable(): Table {
@ -27,6 +28,7 @@ export function basicTable(): Table {
name: "TestTable",
type: "table",
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
schema: {
name: {
type: FieldType.STRING,

5
packages/server/src/utilities/rowProcessor/tests/inputProcessing.spec.ts
View file

@ -5,6 +5,7 @@ import {
FieldTypeSubtypes,
INTERNAL_TABLE_SOURCE_ID,
Table,
TableSourceType,
} from "@budibase/types"
import * as bbReferenceProcessor from "../bbReferenceProcessor"
@ -26,6 +27,7 @@ describe("rowProcessor - inputProcessing", () => {
name: "TestTable",
type: "table",
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
schema: {
name: {
type: FieldType.STRING,
@ -77,6 +79,7 @@ describe("rowProcessor - inputProcessing", () => {
name: "TestTable",
type: "table",
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
schema: {
name: {
type: FieldType.STRING,
@ -118,6 +121,7 @@ describe("rowProcessor - inputProcessing", () => {
name: "TestTable",
type: "table",
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
schema: {
name: {
type: FieldType.STRING,
@ -159,6 +163,7 @@ describe("rowProcessor - inputProcessing", () => {
name: "TestTable",
type: "table",
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
schema: {
name: {
type: FieldType.STRING,

4
packages/server/src/utilities/rowProcessor/tests/outputProcessing.spec.ts
View file

@ -4,6 +4,7 @@ import {
FieldTypeSubtypes,
INTERNAL_TABLE_SOURCE_ID,
Table,
TableSourceType,
} from "@budibase/types"
import { outputProcessing } from ".."
import { generator, structures } from "@budibase/backend-core/tests"
@ -28,6 +29,7 @@ describe("rowProcessor - outputProcessing", () => {
name: "TestTable",
type: "table",
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
schema: {
name: {
type: FieldType.STRING,
@ -74,6 +76,7 @@ describe("rowProcessor - outputProcessing", () => {
name: "TestTable",
type: "table",
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
schema: {
name: {
type: FieldType.STRING,
@ -112,6 +115,7 @@ describe("rowProcessor - outputProcessing", () => {
name: "TestTable",
type: "table",
sourceId: INTERNAL_TABLE_SOURCE_ID,
sourceType: TableSourceType.INTERNAL,
schema: {
name: {
type: FieldType.STRING,

7
packages/server/src/websockets/builder.ts
View file

@ -16,8 +16,7 @@ import { gridSocket } from "./index"
import { clearLock, updateLock } from "../utilities/redis"
import { Socket } from "socket.io"
import { BuilderSocketEvent } from "@budibase/shared-core"
import { processInternalTable } from "../sdk/app/tables/getters"
import { isInternalTable } from "../integrations/utils"
import { processTable } from "../sdk/app/tables/getters"
export default class BuilderSocket extends BaseSocket {
constructor(app: Koa, server: http.Server) {
@ -106,9 +105,7 @@ export default class BuilderSocket extends BaseSocket {
// This was added to make sure that sourceId is always present when
// sending this message to clients. Without this, tables without a
// sourceId (e.g. ta_users) won't get correctly updated client-side.
if (isInternalTable(table._id!)) {
table = processInternalTable(table)
}
table = processTable(table)
this.emitToRoom(
ctx,

8
packages/types/src/documents/app/table/table.ts
View file

@ -5,8 +5,14 @@ import { TableSchema } from "./schema"
export const INTERNAL_TABLE_SOURCE_ID = "bb_internal"
export enum TableSourceType {
EXTERNAL = "external",
INTERNAL = "internal",
}
export interface Table extends Document {
type?: string
type: "table"
sourceType: TableSourceType
views?: { [key: string]: View | ViewV2 }
name: string
sourceId: string