@lightdash/common 1.242.3 → 1.242.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/dist/cjs/.tsbuildinfo +1 -1
  2. package/dist/cjs/authorization/roleToScopeMapping.testUtils.d.ts +98 -98
  3. package/dist/cjs/index.d.ts +2 -1
  4. package/dist/cjs/index.d.ts.map +1 -1
  5. package/dist/cjs/index.js +1 -0
  6. package/dist/cjs/index.js.map +1 -1
  7. package/dist/cjs/types/projects.d.ts +20 -0
  8. package/dist/cjs/types/projects.d.ts.map +1 -1
  9. package/dist/cjs/types/projects.js.map +1 -1
  10. package/dist/cjs/utils/warehouseLocation.d.ts +33 -0
  11. package/dist/cjs/utils/warehouseLocation.d.ts.map +1 -0
  12. package/dist/cjs/utils/warehouseLocation.js +196 -0
  13. package/dist/cjs/utils/warehouseLocation.js.map +1 -0
  14. package/dist/cjs/utils/warehouseLocation.test.d.ts +2 -0
  15. package/dist/cjs/utils/warehouseLocation.test.d.ts.map +1 -0
  16. package/dist/cjs/utils/warehouseLocation.test.js +167 -0
  17. package/dist/cjs/utils/warehouseLocation.test.js.map +1 -0
  18. package/dist/esm/.tsbuildinfo +1 -1
  19. package/dist/esm/index.d.ts +2 -1
  20. package/dist/esm/index.d.ts.map +1 -1
  21. package/dist/esm/index.js +1 -0
  22. package/dist/esm/index.js.map +1 -1
  23. package/dist/esm/types/projects.d.ts +20 -0
  24. package/dist/esm/types/projects.d.ts.map +1 -1
  25. package/dist/esm/types/projects.js.map +1 -1
  26. package/dist/esm/utils/warehouseLocation.d.ts +33 -0
  27. package/dist/esm/utils/warehouseLocation.d.ts.map +1 -0
  28. package/dist/esm/utils/warehouseLocation.js +186 -0
  29. package/dist/esm/utils/warehouseLocation.js.map +1 -0
  30. package/dist/esm/utils/warehouseLocation.test.d.ts +2 -0
  31. package/dist/esm/utils/warehouseLocation.test.d.ts.map +1 -0
  32. package/dist/esm/utils/warehouseLocation.test.js +165 -0
  33. package/dist/esm/utils/warehouseLocation.test.js.map +1 -0
  34. package/dist/types/.tsbuildinfo +1 -1
  35. package/dist/types/index.d.ts +2 -1
  36. package/dist/types/index.d.ts.map +1 -1
  37. package/dist/types/index.js +1 -0
  38. package/dist/types/index.js.map +1 -1
  39. package/dist/types/types/projects.d.ts +20 -0
  40. package/dist/types/types/projects.d.ts.map +1 -1
  41. package/dist/types/types/projects.js.map +1 -1
  42. package/dist/types/utils/warehouseLocation.d.ts +33 -0
  43. package/dist/types/utils/warehouseLocation.d.ts.map +1 -0
  44. package/dist/types/utils/warehouseLocation.js +186 -0
  45. package/dist/types/utils/warehouseLocation.js.map +1 -0
  46. package/dist/types/utils/warehouseLocation.test.d.ts +2 -0
  47. package/dist/types/utils/warehouseLocation.test.d.ts.map +1 -0
  48. package/dist/types/utils/warehouseLocation.test.js +165 -0
  49. package/dist/types/utils/warehouseLocation.test.js.map +1 -0
  50. package/package.json +1 -1
@@ -0,0 +1,186 @@
1
+ import { ParameterError } from '../types/errors';
2
+ import { DuckdbConnectionType, WarehouseTypes, } from '../types/projects';
3
+ import assertUnreachable from './assertUnreachable';
4
+ export const EMPTY_WAREHOUSE_LOCATION = {
5
+ database: null,
6
+ schema: null,
7
+ };
8
+ export const hasWarehouseLocation = (location) => location.database !== null || location.schema !== null;
9
+ /**
10
+ * A blank field means the source inherits the project's location. Callers reach
11
+ * this from an API body as well as the form, so normalise before storing: an
12
+ * empty string stored as an override compiles to `""."table"` and fails.
13
+ */
14
+ export const normalizeWarehouseLocation = (location) => ({
15
+ database: location.database?.trim() || null,
16
+ schema: location.schema?.trim() || null,
17
+ });
18
+ /**
19
+ * A null database means the warehouse has no level above the schema, so a
20
+ * database override is not accepted for it.
21
+ */
22
+ export const getWarehouseLocationLabels = (warehouseType) => {
23
+ switch (warehouseType) {
24
+ case WarehouseTypes.BIGQUERY:
25
+ return { database: 'GCP project', schema: 'Dataset' };
26
+ case WarehouseTypes.DATABRICKS:
27
+ return { database: 'Catalog', schema: 'Schema' };
28
+ case WarehouseTypes.CLICKHOUSE:
29
+ return { database: null, schema: 'Schema' };
30
+ case WarehouseTypes.POSTGRES:
31
+ case WarehouseTypes.REDSHIFT:
32
+ case WarehouseTypes.TRINO:
33
+ case WarehouseTypes.SNOWFLAKE:
34
+ case WarehouseTypes.ATHENA:
35
+ case WarehouseTypes.DUCKDB:
36
+ return { database: 'Database', schema: 'Schema' };
37
+ default:
38
+ return assertUnreachable(warehouseType, `Unknown warehouse type ${warehouseType}`);
39
+ }
40
+ };
41
+ /** The location a warehouse connection already points at. */
42
+ export const getWarehouseLocation = (credentials) => {
43
+ switch (credentials.type) {
44
+ case WarehouseTypes.BIGQUERY:
45
+ return {
46
+ database: credentials.project,
47
+ schema: credentials.dataset,
48
+ };
49
+ case WarehouseTypes.POSTGRES:
50
+ case WarehouseTypes.REDSHIFT:
51
+ case WarehouseTypes.TRINO:
52
+ return {
53
+ database: credentials.dbname,
54
+ schema: credentials.schema,
55
+ };
56
+ case WarehouseTypes.SNOWFLAKE:
57
+ case WarehouseTypes.ATHENA:
58
+ return {
59
+ database: credentials.database,
60
+ schema: credentials.schema,
61
+ };
62
+ case WarehouseTypes.DATABRICKS:
63
+ return {
64
+ database: credentials.catalog ?? null,
65
+ // this supposed to be a `schema` but changing it will break for existing customers
66
+ schema: credentials.database,
67
+ };
68
+ case WarehouseTypes.CLICKHOUSE:
69
+ return { database: null, schema: credentials.schema };
70
+ case WarehouseTypes.DUCKDB:
71
+ switch (credentials.connectionType) {
72
+ case DuckdbConnectionType.MOTHERDUCK:
73
+ return {
74
+ database: credentials.database,
75
+ schema: credentials.schema,
76
+ };
77
+ case DuckdbConnectionType.DUCKLAKE:
78
+ return {
79
+ database: credentials.catalogAlias ?? null,
80
+ schema: credentials.schema,
81
+ };
82
+ case DuckdbConnectionType.EMBEDDED:
83
+ return {
84
+ database: null,
85
+ schema: credentials.schema ?? null,
86
+ };
87
+ default:
88
+ return assertUnreachable(credentials, `Unknown DuckDB connection type`);
89
+ }
90
+ default:
91
+ const { type } = credentials;
92
+ return assertUnreachable(credentials, `Unknown warehouse type ${type}`);
93
+ }
94
+ };
95
+ const unsupportedDatabaseOverride = (warehouseType) => new ParameterError(`${warehouseType} tables are not qualified by a database, so a dbt source cannot override one`);
96
+ /**
97
+ * The project's warehouse credentials with the source's own database and schema,
98
+ * for generating that source's dbt profile. Only the location changes: the
99
+ * connection, and the client that runs queries, stay the project's.
100
+ */
101
+ export const applyWarehouseLocation = (credentials, location) => {
102
+ const { database, schema } = location;
103
+ if (!hasWarehouseLocation(location)) {
104
+ return credentials;
105
+ }
106
+ switch (credentials.type) {
107
+ case WarehouseTypes.BIGQUERY:
108
+ return {
109
+ ...credentials,
110
+ project: database ?? credentials.project,
111
+ dataset: schema ?? credentials.dataset,
112
+ };
113
+ case WarehouseTypes.POSTGRES:
114
+ case WarehouseTypes.REDSHIFT:
115
+ case WarehouseTypes.TRINO:
116
+ return {
117
+ ...credentials,
118
+ dbname: database ?? credentials.dbname,
119
+ schema: schema ?? credentials.schema,
120
+ };
121
+ case WarehouseTypes.SNOWFLAKE:
122
+ case WarehouseTypes.ATHENA:
123
+ return {
124
+ ...credentials,
125
+ database: database ?? credentials.database,
126
+ schema: schema ?? credentials.schema,
127
+ };
128
+ case WarehouseTypes.DATABRICKS:
129
+ return {
130
+ ...credentials,
131
+ catalog: database ?? credentials.catalog,
132
+ // this supposed to be a `schema` but changing it will break for existing customers
133
+ database: schema ?? credentials.database,
134
+ };
135
+ case WarehouseTypes.CLICKHOUSE:
136
+ if (database !== null) {
137
+ throw unsupportedDatabaseOverride(credentials.type);
138
+ }
139
+ return {
140
+ ...credentials,
141
+ schema: schema ?? credentials.schema,
142
+ };
143
+ case WarehouseTypes.DUCKDB:
144
+ switch (credentials.connectionType) {
145
+ case DuckdbConnectionType.MOTHERDUCK:
146
+ return {
147
+ ...credentials,
148
+ database: database ?? credentials.database,
149
+ schema: schema ?? credentials.schema,
150
+ };
151
+ case DuckdbConnectionType.DUCKLAKE:
152
+ return {
153
+ ...credentials,
154
+ catalogAlias: database ?? credentials.catalogAlias,
155
+ schema: schema ?? credentials.schema,
156
+ };
157
+ case DuckdbConnectionType.EMBEDDED:
158
+ throw new ParameterError('Embedded DuckDB credentials cannot be used for dbt compilation');
159
+ default:
160
+ return assertUnreachable(credentials, `Unknown DuckDB connection type`);
161
+ }
162
+ default:
163
+ const { type } = credentials;
164
+ return assertUnreachable(credentials, `Unknown warehouse type ${type}`);
165
+ }
166
+ };
167
+ /**
168
+ * Reject a location a warehouse cannot express when the user saves it, not when
169
+ * a deploy compiles with it hours later. Takes the connection rather than the
170
+ * type because two DuckDB connections differ: embedded cannot compile dbt at
171
+ * all, MotherDuck can.
172
+ */
173
+ export const validateWarehouseLocation = (credentials, location) => {
174
+ if (!hasWarehouseLocation(location)) {
175
+ return;
176
+ }
177
+ if (credentials.type === WarehouseTypes.DUCKDB &&
178
+ credentials.connectionType === DuckdbConnectionType.EMBEDDED) {
179
+ throw new ParameterError('Embedded DuckDB credentials cannot be used for dbt compilation, so a dbt source cannot set a location for them');
180
+ }
181
+ if (location.database !== null &&
182
+ getWarehouseLocationLabels(credentials.type).database === null) {
183
+ throw unsupportedDatabaseOverride(credentials.type);
184
+ }
185
+ };
186
+ //# sourceMappingURL=warehouseLocation.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"warehouseLocation.js","sourceRoot":"","sources":["../../../src/utils/warehouseLocation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EACH,oBAAoB,EACpB,cAAc,GAIjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AAEpD,MAAM,CAAC,MAAM,wBAAwB,GAAsB;IACvD,QAAQ,EAAE,IAAI;IACd,MAAM,EAAE,IAAI;CACf,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,QAA2B,EAAW,EAAE,CACzE,QAAQ,CAAC,QAAQ,KAAK,IAAI,IAAI,QAAQ,CAAC,MAAM,KAAK,IAAI,CAAC;AAE3D;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACtC,QAA2B,EACV,EAAE,CAAC,CAAC;IACrB,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,IAAI;IAC3C,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,IAAI;CAC1C,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACtC,aAA6B,EACc,EAAE;IAC7C,QAAQ,aAAa,EAAE,CAAC;QACpB,KAAK,cAAc,CAAC,QAAQ;YACxB,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;QAC1D,KAAK,cAAc,CAAC,UAAU;YAC1B,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;QACrD,KAAK,cAAc,CAAC,UAAU;YAC1B,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;QAChD,KAAK,cAAc,CAAC,QAAQ,CAAC;QAC7B,KAAK,cAAc,CAAC,QAAQ,CAAC;QAC7B,KAAK,cAAc,CAAC,KAAK,CAAC;QAC1B,KAAK,cAAc,CAAC,SAAS,CAAC;QAC9B,KAAK,cAAc,CAAC,MAAM,CAAC;QAC3B,KAAK,cAAc,CAAC,MAAM;YACtB,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;QACtD;YACI,OAAO,iBAAiB,CACpB,aAAa,EACb,0BAA0B,aAAa,EAAE,CAC5C,CAAC;IACV,CAAC;AACL,CAAC,CAAC;AAEF,6DAA6D;AAC7D,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAChC,WAA8D,EAC7C,EAAE;IACnB,QAAQ,WAAW,CAAC,IAAI,EAAE,CAAC;QACvB,KAAK,cAAc,CAAC,QAAQ;YACxB,OAAO;gBACH,QAAQ,EAAE,WAAW,CAAC,OAAO;gBAC7B,MAAM,EAAE,WAAW,CAAC,OAAO;aAC9B,CAAC;QACN,KAAK,cAAc,CAAC,QAAQ,CAAC;QAC7B,KAAK,cAAc,CAAC,QAAQ,CAAC;QAC7B,KAAK,cAAc,CAAC,KAAK;YACrB,OAAO;gBACH,QAAQ,EAAE,WAAW,CAAC,MAAM;gBAC5B,MAAM,EAAE,WAAW,CAAC,MAAM;aAC7B,CAAC;QACN,KAAK,cAAc,CAAC,SAAS,CAAC;QAC9B,KAAK,cAAc,CAAC,MAAM;YACtB,OAAO;gBACH,QAAQ,EAAE,WAAW,CAAC,QAAQ;gBAC9B,MAAM,EAAE,WAAW,CAAC,MAAM;aAC7B,CAAC;QACN,KAAK,cAAc,CAAC,UAAU;YAC1B,OAAO;gBACH,QAAQ,EAAE,WAAW,CAAC,OAAO,IAAI,IAAI;gBACrC,mFAAmF;gBACnF,MAAM,EAAE,WAAW,CAAC,QAAQ;aAC/B,CAAC;QACN,KAAK,cAAc,CAAC,UAAU;YAC1B,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,CAAC;QAC1D,KAAK,cAAc,CAAC,MAAM;YACtB,QAAQ,WAAW,CAAC,cAAc,EAAE,CAAC;gBACjC,KAAK,oBAAoB,CAAC,UAAU;oBAChC,OAAO;wBACH,QAAQ,EAAE,WAAW,CAAC,QAAQ;wBAC9B,MAAM,EAAE,WAAW,CAAC,MAAM;qBAC7B,CAAC;gBACN,KAAK,oBAAoB,CAAC,QAAQ;oBAC9B,OAAO;wBACH,QAAQ,EAAE,WAAW,CAAC,YAAY,IAAI,IAAI;wBAC1C,MAAM,EAAE,WAAW,CAAC,MAAM;qBAC7B,CAAC;gBACN,KAAK,oBAAoB,CAAC,QAAQ;oBAC9B,OAAO;wBACH,QAAQ,EAAE,IAAI;wBACd,MAAM,EAAE,WAAW,CAAC,MAAM,IAAI,IAAI;qBACrC,CAAC;gBACN;oBACI,OAAO,iBAAiB,CACpB,WAAW,EACX,gCAAgC,CACnC,CAAC;YACV,CAAC;QACL;YACI,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;YAC7B,OAAO,iBAAiB,CACpB,WAAW,EACX,0BAA0B,IAAI,EAAE,CACnC,CAAC;IACV,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,2BAA2B,GAAG,CAAC,aAA6B,EAAS,EAAE,CACzE,IAAI,cAAc,CACd,GAAG,aAAa,8EAA8E,CACjG,CAAC;AAEN;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAClC,WAAuC,EACvC,QAA2B,EACD,EAAE;IAC5B,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC;IACtC,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,EAAE,CAAC;QAClC,OAAO,WAAW,CAAC;IACvB,CAAC;IACD,QAAQ,WAAW,CAAC,IAAI,EAAE,CAAC;QACvB,KAAK,cAAc,CAAC,QAAQ;YACxB,OAAO;gBACH,GAAG,WAAW;gBACd,OAAO,EAAE,QAAQ,IAAI,WAAW,CAAC,OAAO;gBACxC,OAAO,EAAE,MAAM,IAAI,WAAW,CAAC,OAAO;aACzC,CAAC;QACN,KAAK,cAAc,CAAC,QAAQ,CAAC;QAC7B,KAAK,cAAc,CAAC,QAAQ,CAAC;QAC7B,KAAK,cAAc,CAAC,KAAK;YACrB,OAAO;gBACH,GAAG,WAAW;gBACd,MAAM,EAAE,QAAQ,IAAI,WAAW,CAAC,MAAM;gBACtC,MAAM,EAAE,MAAM,IAAI,WAAW,CAAC,MAAM;aACvC,CAAC;QACN,KAAK,cAAc,CAAC,SAAS,CAAC;QAC9B,KAAK,cAAc,CAAC,MAAM;YACtB,OAAO;gBACH,GAAG,WAAW;gBACd,QAAQ,EAAE,QAAQ,IAAI,WAAW,CAAC,QAAQ;gBAC1C,MAAM,EAAE,MAAM,IAAI,WAAW,CAAC,MAAM;aACvC,CAAC;QACN,KAAK,cAAc,CAAC,UAAU;YAC1B,OAAO;gBACH,GAAG,WAAW;gBACd,OAAO,EAAE,QAAQ,IAAI,WAAW,CAAC,OAAO;gBACxC,mFAAmF;gBACnF,QAAQ,EAAE,MAAM,IAAI,WAAW,CAAC,QAAQ;aAC3C,CAAC;QACN,KAAK,cAAc,CAAC,UAAU;YAC1B,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;gBACpB,MAAM,2BAA2B,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACxD,CAAC;YACD,OAAO;gBACH,GAAG,WAAW;gBACd,MAAM,EAAE,MAAM,IAAI,WAAW,CAAC,MAAM;aACvC,CAAC;QACN,KAAK,cAAc,CAAC,MAAM;YACtB,QAAQ,WAAW,CAAC,cAAc,EAAE,CAAC;gBACjC,KAAK,oBAAoB,CAAC,UAAU;oBAChC,OAAO;wBACH,GAAG,WAAW;wBACd,QAAQ,EAAE,QAAQ,IAAI,WAAW,CAAC,QAAQ;wBAC1C,MAAM,EAAE,MAAM,IAAI,WAAW,CAAC,MAAM;qBACvC,CAAC;gBACN,KAAK,oBAAoB,CAAC,QAAQ;oBAC9B,OAAO;wBACH,GAAG,WAAW;wBACd,YAAY,EAAE,QAAQ,IAAI,WAAW,CAAC,YAAY;wBAClD,MAAM,EAAE,MAAM,IAAI,WAAW,CAAC,MAAM;qBACvC,CAAC;gBACN,KAAK,oBAAoB,CAAC,QAAQ;oBAC9B,MAAM,IAAI,cAAc,CACpB,gEAAgE,CACnE,CAAC;gBACN;oBACI,OAAO,iBAAiB,CACpB,WAAW,EACX,gCAAgC,CACnC,CAAC;YACV,CAAC;QACL;YACI,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;YAC7B,OAAO,iBAAiB,CACpB,WAAW,EACX,0BAA0B,IAAI,EAAE,CACnC,CAAC;IACV,CAAC;AACL,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACrC,WAA8D,EAC9D,QAA2B,EACvB,EAAE;IACN,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,EAAE,CAAC;QAClC,OAAO;IACX,CAAC;IACD,IACI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,MAAM;QAC1C,WAAW,CAAC,cAAc,KAAK,oBAAoB,CAAC,QAAQ,EAC9D,CAAC;QACC,MAAM,IAAI,cAAc,CACpB,gHAAgH,CACnH,CAAC;IACN,CAAC;IACD,IACI,QAAQ,CAAC,QAAQ,KAAK,IAAI;QAC1B,0BAA0B,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,QAAQ,KAAK,IAAI,EAChE,CAAC;QACC,MAAM,2BAA2B,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACxD,CAAC;AACL,CAAC,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=warehouseLocation.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"warehouseLocation.test.d.ts","sourceRoot":"","sources":["../../../src/utils/warehouseLocation.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,165 @@
1
+ import { BigqueryAuthenticationType, DuckdbConnectionType, WarehouseTypes, } from '../types/projects';
2
+ import { applyWarehouseLocation, EMPTY_WAREHOUSE_LOCATION, getWarehouseLocation, normalizeWarehouseLocation, validateWarehouseLocation, } from './warehouseLocation';
3
+ const bigqueryCredentials = {
4
+ type: WarehouseTypes.BIGQUERY,
5
+ project: 'primary-gcp-project',
6
+ dataset: 'prod',
7
+ authenticationType: BigqueryAuthenticationType.PRIVATE_KEY,
8
+ keyfileContents: {},
9
+ timeoutSeconds: undefined,
10
+ priority: undefined,
11
+ retries: undefined,
12
+ location: undefined,
13
+ maximumBytesBilled: undefined,
14
+ };
15
+ const snowflakeCredentials = {
16
+ type: WarehouseTypes.SNOWFLAKE,
17
+ account: 'account',
18
+ user: 'user',
19
+ password: 'password',
20
+ role: 'role',
21
+ database: 'primary_database',
22
+ warehouse: 'warehouse',
23
+ schema: 'primary_schema',
24
+ };
25
+ const databricksCredentials = {
26
+ type: WarehouseTypes.DATABRICKS,
27
+ catalog: 'primary_catalog',
28
+ database: 'primary_schema',
29
+ serverHostName: 'host',
30
+ httpPath: 'path',
31
+ personalAccessToken: 'token',
32
+ };
33
+ const clickhouseCredentials = {
34
+ type: WarehouseTypes.CLICKHOUSE,
35
+ host: 'host',
36
+ user: 'user',
37
+ password: 'password',
38
+ port: 8443,
39
+ schema: 'primary_schema',
40
+ };
41
+ const motherduckCredentials = {
42
+ type: WarehouseTypes.DUCKDB,
43
+ connectionType: DuckdbConnectionType.MOTHERDUCK,
44
+ database: 'primary_database',
45
+ schema: 'primary_schema',
46
+ token: 'token',
47
+ };
48
+ describe('applyWarehouseLocation', () => {
49
+ it('returns the credentials untouched when the location is empty', () => {
50
+ expect(applyWarehouseLocation(bigqueryCredentials, EMPTY_WAREHOUSE_LOCATION)).toBe(bigqueryCredentials);
51
+ });
52
+ it('overrides the BigQuery project and dataset', () => {
53
+ expect(applyWarehouseLocation(bigqueryCredentials, {
54
+ database: 'source-gcp-project',
55
+ schema: 'source_dataset',
56
+ })).toMatchObject({
57
+ project: 'source-gcp-project',
58
+ dataset: 'source_dataset',
59
+ });
60
+ });
61
+ it('keeps the fields the location leaves null', () => {
62
+ expect(applyWarehouseLocation(bigqueryCredentials, {
63
+ database: null,
64
+ schema: 'source_dataset',
65
+ })).toMatchObject({
66
+ project: 'primary-gcp-project',
67
+ dataset: 'source_dataset',
68
+ });
69
+ });
70
+ it('leaves the rest of the connection alone', () => {
71
+ expect(applyWarehouseLocation(snowflakeCredentials, {
72
+ database: 'source_database',
73
+ schema: 'source_schema',
74
+ })).toEqual({
75
+ ...snowflakeCredentials,
76
+ database: 'source_database',
77
+ schema: 'source_schema',
78
+ });
79
+ });
80
+ it('maps a Databricks location onto its catalog and schema', () => {
81
+ expect(applyWarehouseLocation(databricksCredentials, {
82
+ database: 'source_catalog',
83
+ schema: 'source_schema',
84
+ })).toMatchObject({
85
+ catalog: 'source_catalog',
86
+ database: 'source_schema',
87
+ });
88
+ });
89
+ it('overrides the MotherDuck database and schema', () => {
90
+ expect(applyWarehouseLocation(motherduckCredentials, {
91
+ database: 'source_database',
92
+ schema: 'source_schema',
93
+ })).toMatchObject({
94
+ database: 'source_database',
95
+ schema: 'source_schema',
96
+ });
97
+ });
98
+ it('rejects a database on a warehouse that has none', () => {
99
+ expect(() => applyWarehouseLocation(clickhouseCredentials, {
100
+ database: 'source_database',
101
+ schema: null,
102
+ })).toThrowError(/not qualified by a database/);
103
+ });
104
+ it('still overrides the schema on a warehouse without a database', () => {
105
+ expect(applyWarehouseLocation(clickhouseCredentials, {
106
+ database: null,
107
+ schema: 'source_schema',
108
+ })).toMatchObject({ schema: 'source_schema' });
109
+ });
110
+ });
111
+ describe('getWarehouseLocation', () => {
112
+ it('reads the location a connection already points at', () => {
113
+ expect(getWarehouseLocation(bigqueryCredentials)).toEqual({
114
+ database: 'primary-gcp-project',
115
+ schema: 'prod',
116
+ });
117
+ expect(getWarehouseLocation(databricksCredentials)).toEqual({
118
+ database: 'primary_catalog',
119
+ schema: 'primary_schema',
120
+ });
121
+ expect(getWarehouseLocation(clickhouseCredentials)).toEqual({
122
+ database: null,
123
+ schema: 'primary_schema',
124
+ });
125
+ });
126
+ });
127
+ describe('validateWarehouseLocation', () => {
128
+ it('accepts a database the warehouse has', () => {
129
+ expect(() => validateWarehouseLocation(bigqueryCredentials, {
130
+ database: 'source-gcp-project',
131
+ schema: null,
132
+ })).not.toThrow();
133
+ });
134
+ it('rejects a database the warehouse does not have', () => {
135
+ expect(() => validateWarehouseLocation(clickhouseCredentials, {
136
+ database: 'source_database',
137
+ schema: null,
138
+ })).toThrowError(/not qualified by a database/);
139
+ });
140
+ it('rejects any location on embedded DuckDB, which cannot compile dbt at all', () => {
141
+ expect(() => validateWarehouseLocation({
142
+ type: WarehouseTypes.DUCKDB,
143
+ connectionType: DuckdbConnectionType.EMBEDDED,
144
+ dataset: 'primary_dataset',
145
+ }, { database: null, schema: 'source_schema' })).toThrowError(/Embedded DuckDB/);
146
+ });
147
+ it('accepts a location on MotherDuck, which can', () => {
148
+ expect(() => validateWarehouseLocation(motherduckCredentials, {
149
+ database: null,
150
+ schema: 'source_schema',
151
+ })).not.toThrow();
152
+ });
153
+ });
154
+ describe('normalizeWarehouseLocation', () => {
155
+ it('reads a blank field as inherit, so it never becomes an override', () => {
156
+ expect(normalizeWarehouseLocation({ database: '', schema: ' ' })).toEqual(EMPTY_WAREHOUSE_LOCATION);
157
+ });
158
+ it('trims a field the caller padded', () => {
159
+ expect(normalizeWarehouseLocation({
160
+ database: ' source-gcp-project ',
161
+ schema: null,
162
+ })).toEqual({ database: 'source-gcp-project', schema: null });
163
+ });
164
+ });
165
+ //# sourceMappingURL=warehouseLocation.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"warehouseLocation.test.js","sourceRoot":"","sources":["../../../src/utils/warehouseLocation.test.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,0BAA0B,EAC1B,oBAAoB,EACpB,cAAc,GAEjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACH,sBAAsB,EACtB,wBAAwB,EACxB,oBAAoB,EACpB,0BAA0B,EAC1B,yBAAyB,GAC5B,MAAM,qBAAqB,CAAC;AAE7B,MAAM,mBAAmB,GAA+B;IACpD,IAAI,EAAE,cAAc,CAAC,QAAQ;IAC7B,OAAO,EAAE,qBAAqB;IAC9B,OAAO,EAAE,MAAM;IACf,kBAAkB,EAAE,0BAA0B,CAAC,WAAW;IAC1D,eAAe,EAAE,EAAE;IACnB,cAAc,EAAE,SAAS;IACzB,QAAQ,EAAE,SAAS;IACnB,OAAO,EAAE,SAAS;IAClB,QAAQ,EAAE,SAAS;IACnB,kBAAkB,EAAE,SAAS;CAChC,CAAC;AAEF,MAAM,oBAAoB,GAA+B;IACrD,IAAI,EAAE,cAAc,CAAC,SAAS;IAC9B,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,kBAAkB;IAC5B,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,gBAAgB;CAC3B,CAAC;AAEF,MAAM,qBAAqB,GAA+B;IACtD,IAAI,EAAE,cAAc,CAAC,UAAU;IAC/B,OAAO,EAAE,iBAAiB;IAC1B,QAAQ,EAAE,gBAAgB;IAC1B,cAAc,EAAE,MAAM;IACtB,QAAQ,EAAE,MAAM;IAChB,mBAAmB,EAAE,OAAO;CAC/B,CAAC;AAEF,MAAM,qBAAqB,GAA+B;IACtD,IAAI,EAAE,cAAc,CAAC,UAAU;IAC/B,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,IAAI,EAAE,IAAI;IACV,MAAM,EAAE,gBAAgB;CAC3B,CAAC;AAEF,MAAM,qBAAqB,GAA+B;IACtD,IAAI,EAAE,cAAc,CAAC,MAAM;IAC3B,cAAc,EAAE,oBAAoB,CAAC,UAAU;IAC/C,QAAQ,EAAE,kBAAkB;IAC5B,MAAM,EAAE,gBAAgB;IACxB,KAAK,EAAE,OAAO;CACjB,CAAC;AAEF,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;IACpC,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACpE,MAAM,CACF,sBAAsB,CAClB,mBAAmB,EACnB,wBAAwB,CAC3B,CACJ,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QAClD,MAAM,CACF,sBAAsB,CAAC,mBAAmB,EAAE;YACxC,QAAQ,EAAE,oBAAoB;YAC9B,MAAM,EAAE,gBAAgB;SAC3B,CAAC,CACL,CAAC,aAAa,CAAC;YACZ,OAAO,EAAE,oBAAoB;YAC7B,OAAO,EAAE,gBAAgB;SAC5B,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACjD,MAAM,CACF,sBAAsB,CAAC,mBAAmB,EAAE;YACxC,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,gBAAgB;SAC3B,CAAC,CACL,CAAC,aAAa,CAAC;YACZ,OAAO,EAAE,qBAAqB;YAC9B,OAAO,EAAE,gBAAgB;SAC5B,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QAC/C,MAAM,CACF,sBAAsB,CAAC,oBAAoB,EAAE;YACzC,QAAQ,EAAE,iBAAiB;YAC3B,MAAM,EAAE,eAAe;SAC1B,CAAC,CACL,CAAC,OAAO,CAAC;YACN,GAAG,oBAAoB;YACvB,QAAQ,EAAE,iBAAiB;YAC3B,MAAM,EAAE,eAAe;SAC1B,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAC9D,MAAM,CACF,sBAAsB,CAAC,qBAAqB,EAAE;YAC1C,QAAQ,EAAE,gBAAgB;YAC1B,MAAM,EAAE,eAAe;SAC1B,CAAC,CACL,CAAC,aAAa,CAAC;YACZ,OAAO,EAAE,gBAAgB;YACzB,QAAQ,EAAE,eAAe;SAC5B,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACpD,MAAM,CACF,sBAAsB,CAAC,qBAAqB,EAAE;YAC1C,QAAQ,EAAE,iBAAiB;YAC3B,MAAM,EAAE,eAAe;SAC1B,CAAC,CACL,CAAC,aAAa,CAAC;YACZ,QAAQ,EAAE,iBAAiB;YAC3B,MAAM,EAAE,eAAe;SAC1B,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACvD,MAAM,CAAC,GAAG,EAAE,CACR,sBAAsB,CAAC,qBAAqB,EAAE;YAC1C,QAAQ,EAAE,iBAAiB;YAC3B,MAAM,EAAE,IAAI;SACf,CAAC,CACL,CAAC,YAAY,CAAC,6BAA6B,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACpE,MAAM,CACF,sBAAsB,CAAC,qBAAqB,EAAE;YAC1C,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,eAAe;SAC1B,CAAC,CACL,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QACzD,MAAM,CAAC,oBAAoB,CAAC,mBAAmB,CAAC,CAAC,CAAC,OAAO,CAAC;YACtD,QAAQ,EAAE,qBAAqB;YAC/B,MAAM,EAAE,MAAM;SACjB,CAAC,CAAC;QACH,MAAM,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,CAAC,CAAC,OAAO,CAAC;YACxD,QAAQ,EAAE,iBAAiB;YAC3B,MAAM,EAAE,gBAAgB;SAC3B,CAAC,CAAC;QACH,MAAM,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,CAAC,CAAC,OAAO,CAAC;YACxD,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,gBAAgB;SAC3B,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;IACvC,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC5C,MAAM,CAAC,GAAG,EAAE,CACR,yBAAyB,CAAC,mBAAmB,EAAE;YAC3C,QAAQ,EAAE,oBAAoB;YAC9B,MAAM,EAAE,IAAI;SACf,CAAC,CACL,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACpB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACtD,MAAM,CAAC,GAAG,EAAE,CACR,yBAAyB,CAAC,qBAAqB,EAAE;YAC7C,QAAQ,EAAE,iBAAiB;YAC3B,MAAM,EAAE,IAAI;SACf,CAAC,CACL,CAAC,YAAY,CAAC,6BAA6B,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0EAA0E,EAAE,GAAG,EAAE;QAChF,MAAM,CAAC,GAAG,EAAE,CACR,yBAAyB,CACrB;YACI,IAAI,EAAE,cAAc,CAAC,MAAM;YAC3B,cAAc,EAAE,oBAAoB,CAAC,QAAQ;YAC7C,OAAO,EAAE,iBAAiB;SAC7B,EACD,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,CAC9C,CACJ,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACnD,MAAM,CAAC,GAAG,EAAE,CACR,yBAAyB,CAAC,qBAAqB,EAAE;YAC7C,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,eAAe;SAC1B,CAAC,CACL,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACpB,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IACxC,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACvE,MAAM,CACF,0BAA0B,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAC9D,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACvC,MAAM,CACF,0BAA0B,CAAC;YACvB,QAAQ,EAAE,sBAAsB;YAChC,MAAM,EAAE,IAAI;SACf,CAAC,CACL,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}