@dbx-tools/appkit 0.6.69 → 0.6.71
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.
- package/README.md +7 -8
- package/index.ts +1 -3
- package/lib/index.d.ts +1 -3
- package/lib/index.js +1 -2
- package/lib/src/_cache-storage.d.ts +24 -0
- package/lib/src/_cache-storage.js +106 -0
- package/lib/src/appkit.d.ts +92 -3
- package/lib/src/appkit.js +255 -8
- package/lib/src/interceptor.d.ts +10 -10
- package/lib/src/interceptor.js +7 -7
- package/lib/tsconfig.tsbuildinfo +1 -1
- package/package.json +3 -3
- package/src/_cache-storage.ts +129 -0
- package/src/appkit.ts +338 -7
- package/src/interceptor.ts +10 -10
- package/lib/src/create-app.d.ts +0 -96
- package/lib/src/create-app.js +0 -154
- package/src/create-app.ts +0 -230
package/README.md
CHANGED
|
@@ -50,16 +50,16 @@ Use this package when the friction is around bootstrapping and reuse:
|
|
|
50
50
|
|
|
51
51
|
## Create An Auto-Configured App
|
|
52
52
|
|
|
53
|
-
`
|
|
53
|
+
`appkit.createApp` is a drop-in wrapper around AppKit `createApp` with the
|
|
54
54
|
same config and the same typed plugin-export map. It runs
|
|
55
|
-
`
|
|
55
|
+
`appkit.autoConfigure()` first so enabled capabilities can populate
|
|
56
56
|
environment variables before plugin setup runs.
|
|
57
57
|
|
|
58
58
|
```ts
|
|
59
59
|
import { lakebase, server } from "@databricks/appkit";
|
|
60
|
-
import {
|
|
60
|
+
import { appkit } from "@dbx-tools/appkit";
|
|
61
61
|
|
|
62
|
-
await
|
|
62
|
+
await appkit.createApp({
|
|
63
63
|
plugins: [server(), lakebase()],
|
|
64
64
|
});
|
|
65
65
|
```
|
|
@@ -76,7 +76,7 @@ Databricks Asset Bundle validation, and deployed Apps.
|
|
|
76
76
|
|
|
77
77
|
Boot-time resolution runs as the service principal before any plugin exists, so
|
|
78
78
|
it sits outside AppKit's interceptor chain. It carries its own timeout, and
|
|
79
|
-
`
|
|
79
|
+
`appkit.autoConfigure()` accepts an `AbortSignal` when a caller wants to
|
|
80
80
|
cancel it earlier.
|
|
81
81
|
|
|
82
82
|
Use the lower-level functions when you need to inspect or customize the result:
|
|
@@ -110,7 +110,7 @@ reason.
|
|
|
110
110
|
|
|
111
111
|
## Configuration
|
|
112
112
|
|
|
113
|
-
`
|
|
113
|
+
`appkit.createApp()` accepts everything AppKit's `createApp` does, plus:
|
|
114
114
|
|
|
115
115
|
| Option | Type | Default | Description |
|
|
116
116
|
| --------------- | ------------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -324,11 +324,10 @@ is shared. `@dbx-tools/appkit-mastra` exposes this as its `genieIdentity` option
|
|
|
324
324
|
|
|
325
325
|
| Module | Responsibility |
|
|
326
326
|
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
327
|
-
| `
|
|
327
|
+
| `appkit` | `createApp()` / `autoConfigure()`, plus execution context lookup and initialization. |
|
|
328
328
|
| `lakebaseResolver` | Lakebase connection discovery, default picking, optional auto-create, and env application (`applyLakebaseEnv()` for the full set a pool needs). |
|
|
329
329
|
| `pgaddress` | Permissive Lakebase/Postgres address parser. |
|
|
330
330
|
| `config` | Local/env/bundle/app-yaml config lookup. |
|
|
331
|
-
| `appkit` | Execution context lookup and initialization. |
|
|
332
331
|
| `databricks` | App env detection and SDK context cancellation adapters. |
|
|
333
332
|
| `plugin` | Typed AppKit plugin data, instance, and required-instance lookup. |
|
|
334
333
|
| `provision` | Cache schema provisioning helpers. |
|
package/index.ts
CHANGED
|
@@ -4,7 +4,6 @@
|
|
|
4
4
|
|
|
5
5
|
export * as appkit from "./src/appkit.ts";
|
|
6
6
|
export * as config from "./src/config.ts";
|
|
7
|
-
export * as createApp from "./src/create-app.ts";
|
|
8
7
|
export * as databricks from "./src/databricks.ts";
|
|
9
8
|
export * as identity from "./src/identity.ts";
|
|
10
9
|
export * as interceptor from "./src/interceptor.ts";
|
|
@@ -12,9 +11,8 @@ export * as lakebaseResolver from "./src/lakebase-resolver.ts";
|
|
|
12
11
|
export * as pgaddress from "./src/pgaddress.ts";
|
|
13
12
|
export * as plugin from "./src/plugin.ts";
|
|
14
13
|
export * as provision from "./src/provision.ts";
|
|
15
|
-
export type { ExecutionContextLike, WorkspaceClientLike } from "./src/appkit.ts";
|
|
14
|
+
export type { AutoConfigureMode, CreateAppConfig, ExecutionContextLike, WorkspaceClientLike } from "./src/appkit.ts";
|
|
16
15
|
export type { BundleValidateJson, ConfigFile, ConfigSource, ConfigMapValue, ResolveConfigValueOptions } from "./src/config.ts";
|
|
17
|
-
export type { AutoConfigureMode, CreateAppConfig } from "./src/create-app.ts";
|
|
18
16
|
export { MAX_TCP_PORT } from "./src/databricks.ts";
|
|
19
17
|
export type { ContextLike } from "./src/databricks.ts";
|
|
20
18
|
export { ACCESS_TOKEN_HEADER, USER_ID_HEADER, USER_EMAIL_HEADER, IDENTITY_MODES, DEFAULT_IDENTITY_MODE } from "./src/identity.ts";
|
package/lib/index.d.ts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
export * as appkit from "./src/appkit.ts";
|
|
2
2
|
export * as config from "./src/config.ts";
|
|
3
|
-
export * as createApp from "./src/create-app.ts";
|
|
4
3
|
export * as databricks from "./src/databricks.ts";
|
|
5
4
|
export * as identity from "./src/identity.ts";
|
|
6
5
|
export * as interceptor from "./src/interceptor.ts";
|
|
@@ -8,9 +7,8 @@ export * as lakebaseResolver from "./src/lakebase-resolver.ts";
|
|
|
8
7
|
export * as pgaddress from "./src/pgaddress.ts";
|
|
9
8
|
export * as plugin from "./src/plugin.ts";
|
|
10
9
|
export * as provision from "./src/provision.ts";
|
|
11
|
-
export type { ExecutionContextLike, WorkspaceClientLike } from "./src/appkit.ts";
|
|
10
|
+
export type { AutoConfigureMode, CreateAppConfig, ExecutionContextLike, WorkspaceClientLike } from "./src/appkit.ts";
|
|
12
11
|
export type { BundleValidateJson, ConfigFile, ConfigSource, ConfigMapValue, ResolveConfigValueOptions } from "./src/config.ts";
|
|
13
|
-
export type { AutoConfigureMode, CreateAppConfig } from "./src/create-app.ts";
|
|
14
12
|
export { MAX_TCP_PORT } from "./src/databricks.ts";
|
|
15
13
|
export type { ContextLike } from "./src/databricks.ts";
|
|
16
14
|
export { ACCESS_TOKEN_HEADER, USER_ID_HEADER, USER_EMAIL_HEADER, IDENTITY_MODES, DEFAULT_IDENTITY_MODE } from "./src/identity.ts";
|
package/lib/index.js
CHANGED
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
// Hand edits are overwritten on the next watch; this file is read-only.
|
|
4
4
|
export * as appkit from "./src/appkit.js";
|
|
5
5
|
export * as config from "./src/config.js";
|
|
6
|
-
export * as createApp from "./src/create-app.js";
|
|
7
6
|
export * as databricks from "./src/databricks.js";
|
|
8
7
|
export * as identity from "./src/identity.js";
|
|
9
8
|
export * as interceptor from "./src/interceptor.js";
|
|
@@ -15,4 +14,4 @@ export { MAX_TCP_PORT } from "./src/databricks.js";
|
|
|
15
14
|
export { ACCESS_TOKEN_HEADER, USER_ID_HEADER, USER_EMAIL_HEADER, IDENTITY_MODES, DEFAULT_IDENTITY_MODE } from "./src/identity.js";
|
|
16
15
|
export { LifecycleBridgePlugin, lifecycleBridge } from "./src/interceptor.js";
|
|
17
16
|
export { SSL_MODES } from "./src/pgaddress.js";
|
|
18
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
17
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxPQUFPLEtBQUssTUFBTSxNQUFNLGlCQUFpQixDQUFDO0FBQzFDLE9BQU8sS0FBSyxNQUFNLE1BQU0saUJBQWlCLENBQUM7QUFDMUMsT0FBTyxLQUFLLFVBQVUsTUFBTSxxQkFBcUIsQ0FBQztBQUNsRCxPQUFPLEtBQUssUUFBUSxNQUFNLG1CQUFtQixDQUFDO0FBQzlDLE9BQU8sS0FBSyxXQUFXLE1BQU0sc0JBQXNCLENBQUM7QUFDcEQsT0FBTyxLQUFLLGdCQUFnQixNQUFNLDRCQUE0QixDQUFDO0FBQy9ELE9BQU8sS0FBSyxTQUFTLE1BQU0sb0JBQW9CLENBQUM7QUFDaEQsT0FBTyxLQUFLLE1BQU0sTUFBTSxpQkFBaUIsQ0FBQztBQUMxQyxPQUFPLEtBQUssU0FBUyxNQUFNLG9CQUFvQixDQUFDO0FBR2hELE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUVuRCxPQUFPLEVBQUUsbUJBQW1CLEVBQUUsY0FBYyxFQUFFLGlCQUFpQixFQUFFLGNBQWMsRUFBRSxxQkFBcUIsRUFBRSxNQUFNLG1CQUFtQixDQUFDO0FBRWxJLE9BQU8sRUFBRSxxQkFBcUIsRUFBRSxlQUFlLEVBQUUsTUFBTSxzQkFBc0IsQ0FBQztBQUc5RSxPQUFPLEVBQUUsU0FBUyxFQUFFLE1BQU0sb0JBQW9CLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvLyBHRU5FUkFURUQgYnkgcHJvamVuIHdhdGNoIC0gRE8gTk9UIEVESVQuXG4vLyBSZWdlbmVyYXRlZCBmcm9tIHRoZSBleHBvcnRpbmcgbW9kdWxlcyBpbiAuL3NyYy5cbi8vIEhhbmQgZWRpdHMgYXJlIG92ZXJ3cml0dGVuIG9uIHRoZSBuZXh0IHdhdGNoOyB0aGlzIGZpbGUgaXMgcmVhZC1vbmx5LlxuXG5leHBvcnQgKiBhcyBhcHBraXQgZnJvbSBcIi4vc3JjL2FwcGtpdC50c1wiO1xuZXhwb3J0ICogYXMgY29uZmlnIGZyb20gXCIuL3NyYy9jb25maWcudHNcIjtcbmV4cG9ydCAqIGFzIGRhdGFicmlja3MgZnJvbSBcIi4vc3JjL2RhdGFicmlja3MudHNcIjtcbmV4cG9ydCAqIGFzIGlkZW50aXR5IGZyb20gXCIuL3NyYy9pZGVudGl0eS50c1wiO1xuZXhwb3J0ICogYXMgaW50ZXJjZXB0b3IgZnJvbSBcIi4vc3JjL2ludGVyY2VwdG9yLnRzXCI7XG5leHBvcnQgKiBhcyBsYWtlYmFzZVJlc29sdmVyIGZyb20gXCIuL3NyYy9sYWtlYmFzZS1yZXNvbHZlci50c1wiO1xuZXhwb3J0ICogYXMgcGdhZGRyZXNzIGZyb20gXCIuL3NyYy9wZ2FkZHJlc3MudHNcIjtcbmV4cG9ydCAqIGFzIHBsdWdpbiBmcm9tIFwiLi9zcmMvcGx1Z2luLnRzXCI7XG5leHBvcnQgKiBhcyBwcm92aXNpb24gZnJvbSBcIi4vc3JjL3Byb3Zpc2lvbi50c1wiO1xuZXhwb3J0IHR5cGUgeyBBdXRvQ29uZmlndXJlTW9kZSwgQ3JlYXRlQXBwQ29uZmlnLCBFeGVjdXRpb25Db250ZXh0TGlrZSwgV29ya3NwYWNlQ2xpZW50TGlrZSB9IGZyb20gXCIuL3NyYy9hcHBraXQudHNcIjtcbmV4cG9ydCB0eXBlIHsgQnVuZGxlVmFsaWRhdGVKc29uLCBDb25maWdGaWxlLCBDb25maWdTb3VyY2UsIENvbmZpZ01hcFZhbHVlLCBSZXNvbHZlQ29uZmlnVmFsdWVPcHRpb25zIH0gZnJvbSBcIi4vc3JjL2NvbmZpZy50c1wiO1xuZXhwb3J0IHsgTUFYX1RDUF9QT1JUIH0gZnJvbSBcIi4vc3JjL2RhdGFicmlja3MudHNcIjtcbmV4cG9ydCB0eXBlIHsgQ29udGV4dExpa2UgfSBmcm9tIFwiLi9zcmMvZGF0YWJyaWNrcy50c1wiO1xuZXhwb3J0IHsgQUNDRVNTX1RPS0VOX0hFQURFUiwgVVNFUl9JRF9IRUFERVIsIFVTRVJfRU1BSUxfSEVBREVSLCBJREVOVElUWV9NT0RFUywgREVGQVVMVF9JREVOVElUWV9NT0RFIH0gZnJvbSBcIi4vc3JjL2lkZW50aXR5LnRzXCI7XG5leHBvcnQgdHlwZSB7IElkZW50aXR5TW9kZSwgSGVhZGVyQmVhcmluZyB9IGZyb20gXCIuL3NyYy9pZGVudGl0eS50c1wiO1xuZXhwb3J0IHsgTGlmZWN5Y2xlQnJpZGdlUGx1Z2luLCBsaWZlY3ljbGVCcmlkZ2UgfSBmcm9tIFwiLi9zcmMvaW50ZXJjZXB0b3IudHNcIjtcbmV4cG9ydCB0eXBlIHsgTGlmZWN5Y2xlRXZlbnQsIExpZmVjeWNsZUhhbmRsZXIsIFJlc29sdmVkQXBwRW52LCBCaW5kYWJsZVByb2Nlc3MsIEludGVyY2VwdG9yQ29udGV4dCwgSW50ZXJjZXB0b3IsIEludGVyY2VwdG9yUnVudGltZSB9IGZyb20gXCIuL3NyYy9pbnRlcmNlcHRvci50c1wiO1xuZXhwb3J0IHR5cGUgeyBMYWtlYmFzZVJlc29sdmVySW5wdXRzLCBMYWtlYmFzZUNvbm5lY3Rpb24gfSBmcm9tIFwiLi9zcmMvbGFrZWJhc2UtcmVzb2x2ZXIudHNcIjtcbmV4cG9ydCB7IFNTTF9NT0RFUyB9IGZyb20gXCIuL3NyYy9wZ2FkZHJlc3MudHNcIjtcbmV4cG9ydCB0eXBlIHsgU3NsTW9kZSwgTGFrZWJhc2VDb25uZWN0aW9uSW5wdXRzLCBQYXJzZWRBZGRyZXNzIH0gZnJvbSBcIi4vc3JjL3BnYWRkcmVzcy50c1wiO1xuZXhwb3J0IHR5cGUgeyBQbHVnaW5Db250ZXh0TGlrZSB9IGZyb20gXCIuL3NyYy9wbHVnaW4udHNcIjtcbiJdfQ==
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Soft-fail Lakebase cache storage for AppKit's persistent cache.
|
|
3
|
+
*
|
|
4
|
+
* AppKit's `PersistentStorage.initialize()` runs DDL migrations and throws on
|
|
5
|
+
* any step failure. With `cache.strictPersistence: true` that throw makes
|
|
6
|
+
* `CacheManager` silently disable the cache. This wraps the same storage,
|
|
7
|
+
* still runs its migrations, but logs a failed step instead of throwing so a
|
|
8
|
+
* usable table keeps serving.
|
|
9
|
+
*
|
|
10
|
+
* `PersistentStorage` is not on AppKit's public export map. The deep load is
|
|
11
|
+
* lazy and best-effort: if the installed AppKit layout changes, this returns
|
|
12
|
+
* `undefined` and `createApp` leaves AppKit on its default cache path.
|
|
13
|
+
*
|
|
14
|
+
* @module
|
|
15
|
+
*/
|
|
16
|
+
import { type CacheConfig } from "@databricks/appkit";
|
|
17
|
+
type CacheStorage = NonNullable<CacheConfig["storage"]>;
|
|
18
|
+
/**
|
|
19
|
+
* Build a soft-fail Lakebase cache storage when a pool can be created and
|
|
20
|
+
* AppKit's PersistentStorage can be loaded. Returns `undefined` otherwise so
|
|
21
|
+
* AppKit can fall through to its normal cache path.
|
|
22
|
+
*/
|
|
23
|
+
export declare function createSoftPersistentStorage(cache: CacheConfig | undefined): Promise<CacheStorage | undefined>;
|
|
24
|
+
export {};
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Soft-fail Lakebase cache storage for AppKit's persistent cache.
|
|
3
|
+
*
|
|
4
|
+
* AppKit's `PersistentStorage.initialize()` runs DDL migrations and throws on
|
|
5
|
+
* any step failure. With `cache.strictPersistence: true` that throw makes
|
|
6
|
+
* `CacheManager` silently disable the cache. This wraps the same storage,
|
|
7
|
+
* still runs its migrations, but logs a failed step instead of throwing so a
|
|
8
|
+
* usable table keeps serving.
|
|
9
|
+
*
|
|
10
|
+
* `PersistentStorage` is not on AppKit's public export map. The deep load is
|
|
11
|
+
* lazy and best-effort: if the installed AppKit layout changes, this returns
|
|
12
|
+
* `undefined` and `createApp` leaves AppKit on its default cache path.
|
|
13
|
+
*
|
|
14
|
+
* @module
|
|
15
|
+
*/
|
|
16
|
+
import { createRequire } from "node:module";
|
|
17
|
+
import { dirname, join } from "node:path";
|
|
18
|
+
import { createLakebasePool, getWorkspaceClient } from "@databricks/appkit";
|
|
19
|
+
import { error, log } from "@dbx-tools/shared-core";
|
|
20
|
+
const logger = log.logger("cache-storage");
|
|
21
|
+
/** Whether `LOG_LEVEL` is currently at or below debug. */
|
|
22
|
+
function isDebugEnabled() {
|
|
23
|
+
return log.isLevelEnabled("debug");
|
|
24
|
+
}
|
|
25
|
+
let persistentStorageCtor = null;
|
|
26
|
+
/**
|
|
27
|
+
* Lazily resolve AppKit's internal `PersistentStorage` constructor. `null`
|
|
28
|
+
* means the lookup already failed; `undefined` means not attempted yet.
|
|
29
|
+
*/
|
|
30
|
+
function loadPersistentStorage() {
|
|
31
|
+
if (persistentStorageCtor !== null) {
|
|
32
|
+
return persistentStorageCtor;
|
|
33
|
+
}
|
|
34
|
+
try {
|
|
35
|
+
const require = createRequire(import.meta.url);
|
|
36
|
+
const modulePath = join(dirname(require.resolve("@databricks/appkit")), "cache/storage/persistent.js");
|
|
37
|
+
const loaded = require(modulePath).PersistentStorage;
|
|
38
|
+
if (typeof loaded !== "function") {
|
|
39
|
+
logger.debug("soft persistent cache skipped (PersistentStorage missing)");
|
|
40
|
+
persistentStorageCtor = undefined;
|
|
41
|
+
return undefined;
|
|
42
|
+
}
|
|
43
|
+
persistentStorageCtor = loaded;
|
|
44
|
+
return loaded;
|
|
45
|
+
}
|
|
46
|
+
catch (err) {
|
|
47
|
+
logger.debug("soft persistent cache skipped (PersistentStorage unavailable)", {
|
|
48
|
+
error: error.errorMessage(err),
|
|
49
|
+
});
|
|
50
|
+
persistentStorageCtor = undefined;
|
|
51
|
+
return undefined;
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
/** Soften `initialize()` so a migration failure is logged, not thrown. */
|
|
55
|
+
function softenInitialize(storage) {
|
|
56
|
+
const originalInitialize = storage.initialize.bind(storage);
|
|
57
|
+
storage.initialize = async () => {
|
|
58
|
+
try {
|
|
59
|
+
await originalInitialize();
|
|
60
|
+
}
|
|
61
|
+
catch (err) {
|
|
62
|
+
if (isDebugEnabled()) {
|
|
63
|
+
logger.error("persistent cache migration failed", err);
|
|
64
|
+
}
|
|
65
|
+
else {
|
|
66
|
+
logger.warn("persistent cache migration failed", {
|
|
67
|
+
error: error.errorMessage(err),
|
|
68
|
+
});
|
|
69
|
+
}
|
|
70
|
+
storage.initialized = true;
|
|
71
|
+
}
|
|
72
|
+
};
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* Build a soft-fail Lakebase cache storage when a pool can be created and
|
|
76
|
+
* AppKit's PersistentStorage can be loaded. Returns `undefined` otherwise so
|
|
77
|
+
* AppKit can fall through to its normal cache path.
|
|
78
|
+
*/
|
|
79
|
+
export async function createSoftPersistentStorage(cache) {
|
|
80
|
+
const PersistentStorage = loadPersistentStorage();
|
|
81
|
+
if (!PersistentStorage) {
|
|
82
|
+
return undefined;
|
|
83
|
+
}
|
|
84
|
+
let pool;
|
|
85
|
+
try {
|
|
86
|
+
pool = createLakebasePool({ workspaceClient: getWorkspaceClient({}) });
|
|
87
|
+
const storage = new PersistentStorage(cache ?? {}, pool);
|
|
88
|
+
softenInitialize(storage);
|
|
89
|
+
if (!(await storage.healthCheck())) {
|
|
90
|
+
await storage.close().catch(() => { });
|
|
91
|
+
return undefined;
|
|
92
|
+
}
|
|
93
|
+
await storage.initialize();
|
|
94
|
+
return storage;
|
|
95
|
+
}
|
|
96
|
+
catch (err) {
|
|
97
|
+
logger.debug("soft persistent cache unavailable", {
|
|
98
|
+
error: error.errorMessage(err),
|
|
99
|
+
});
|
|
100
|
+
if (pool) {
|
|
101
|
+
await pool.end().catch(() => { });
|
|
102
|
+
}
|
|
103
|
+
return undefined;
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"_cache-storage.js","sourceRoot":"","sources":["../../src/_cache-storage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAoB,MAAM,oBAAoB,CAAC;AAC9F,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAC;AAEpD,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;AAE3C,0DAA0D;AAC1D,SAAS,cAAc;IACrB,OAAO,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;AACrC,CAAC;AAgBD,IAAI,qBAAqB,GAAoD,IAAI,CAAC;AAElF;;;GAGG;AACH,SAAS,qBAAqB;IAC5B,IAAI,qBAAqB,KAAK,IAAI,EAAE,CAAC;QACnC,OAAO,qBAAqB,CAAC;IAC/B,CAAC;IACD,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CACrB,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,EAC9C,6BAA6B,CAC9B,CAAC;QACF,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,iBACO,CAAC;QAC3C,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;YACjC,MAAM,CAAC,KAAK,CAAC,2DAA2D,CAAC,CAAC;YAC1E,qBAAqB,GAAG,SAAS,CAAC;YAClC,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,qBAAqB,GAAG,MAAM,CAAC;QAC/B,OAAO,MAAM,CAAC;IAChB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,CAAC,KAAK,CAAC,+DAA+D,EAAE;YAC5E,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC;SAC/B,CAAC,CAAC;QACH,qBAAqB,GAAG,SAAS,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,0EAA0E;AAC1E,SAAS,gBAAgB,CAAC,OAA8B;IACtD,MAAM,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC5D,OAAO,CAAC,UAAU,GAAG,KAAK,IAAI,EAAE;QAC9B,IAAI,CAAC;YACH,MAAM,kBAAkB,EAAE,CAAC;QAC7B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,cAAc,EAAE,EAAE,CAAC;gBACrB,MAAM,CAAC,KAAK,CAAC,mCAAmC,EAAE,GAAG,CAAC,CAAC;YACzD,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,CAAC,mCAAmC,EAAE;oBAC/C,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC;iBAC/B,CAAC,CAAC;YACL,CAAC;YACD,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;QAC7B,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAC/C,KAA8B;IAE9B,MAAM,iBAAiB,GAAG,qBAAqB,EAAE,CAAC;IAClD,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACvB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,IAA8B,CAAC;IACnC,IAAI,CAAC;QACH,IAAI,GAAG,kBAAkB,CAAC,EAAE,eAAe,EAAE,kBAAkB,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QACvE,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,KAAK,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;QACzD,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC1B,IAAI,CAAC,CAAC,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YACnC,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YACtC,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,OAAO,CAAC,UAAU,EAAE,CAAC;QAC3B,OAAO,OAAO,CAAC;IACjB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,CAAC,KAAK,CAAC,mCAAmC,EAAE;YAChD,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC;SAC/B,CAAC,CAAC;QACH,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC","sourcesContent":["/**\n * Soft-fail Lakebase cache storage for AppKit's persistent cache.\n *\n * AppKit's `PersistentStorage.initialize()` runs DDL migrations and throws on\n * any step failure. With `cache.strictPersistence: true` that throw makes\n * `CacheManager` silently disable the cache. This wraps the same storage,\n * still runs its migrations, but logs a failed step instead of throwing so a\n * usable table keeps serving.\n *\n * `PersistentStorage` is not on AppKit's public export map. The deep load is\n * lazy and best-effort: if the installed AppKit layout changes, this returns\n * `undefined` and `createApp` leaves AppKit on its default cache path.\n *\n * @module\n */\n\nimport { createRequire } from \"node:module\";\nimport { dirname, join } from \"node:path\";\nimport { createLakebasePool, getWorkspaceClient, type CacheConfig } from \"@databricks/appkit\";\nimport { error, log } from \"@dbx-tools/shared-core\";\n\nconst logger = log.logger(\"cache-storage\");\n\n/** Whether `LOG_LEVEL` is currently at or below debug. */\nfunction isDebugEnabled(): boolean {\n  return log.isLevelEnabled(\"debug\");\n}\n\ntype LakebasePool = ReturnType<typeof createLakebasePool>;\ntype CacheStorage = NonNullable<CacheConfig[\"storage\"]>;\n\n/** AppKit's internal persistent storage surface. */\ntype PersistentStorageBase = CacheStorage & {\n  initialize(): Promise<void>;\n  initialized: boolean;\n};\n\ntype PersistentStorageConstructor = new (\n  config: CacheConfig,\n  pool: LakebasePool,\n) => PersistentStorageBase;\n\nlet persistentStorageCtor: PersistentStorageConstructor | undefined | null = null;\n\n/**\n * Lazily resolve AppKit's internal `PersistentStorage` constructor. `null`\n * means the lookup already failed; `undefined` means not attempted yet.\n */\nfunction loadPersistentStorage(): PersistentStorageConstructor | undefined {\n  if (persistentStorageCtor !== null) {\n    return persistentStorageCtor;\n  }\n  try {\n    const require = createRequire(import.meta.url);\n    const modulePath = join(\n      dirname(require.resolve(\"@databricks/appkit\")),\n      \"cache/storage/persistent.js\",\n    );\n    const loaded = require(modulePath).PersistentStorage as\n      PersistentStorageConstructor | undefined;\n    if (typeof loaded !== \"function\") {\n      logger.debug(\"soft persistent cache skipped (PersistentStorage missing)\");\n      persistentStorageCtor = undefined;\n      return undefined;\n    }\n    persistentStorageCtor = loaded;\n    return loaded;\n  } catch (err) {\n    logger.debug(\"soft persistent cache skipped (PersistentStorage unavailable)\", {\n      error: error.errorMessage(err),\n    });\n    persistentStorageCtor = undefined;\n    return undefined;\n  }\n}\n\n/** Soften `initialize()` so a migration failure is logged, not thrown. */\nfunction softenInitialize(storage: PersistentStorageBase): void {\n  const originalInitialize = storage.initialize.bind(storage);\n  storage.initialize = async () => {\n    try {\n      await originalInitialize();\n    } catch (err) {\n      if (isDebugEnabled()) {\n        logger.error(\"persistent cache migration failed\", err);\n      } else {\n        logger.warn(\"persistent cache migration failed\", {\n          error: error.errorMessage(err),\n        });\n      }\n      storage.initialized = true;\n    }\n  };\n}\n\n/**\n * Build a soft-fail Lakebase cache storage when a pool can be created and\n * AppKit's PersistentStorage can be loaded. Returns `undefined` otherwise so\n * AppKit can fall through to its normal cache path.\n */\nexport async function createSoftPersistentStorage(\n  cache: CacheConfig | undefined,\n): Promise<CacheStorage | undefined> {\n  const PersistentStorage = loadPersistentStorage();\n  if (!PersistentStorage) {\n    return undefined;\n  }\n\n  let pool: LakebasePool | undefined;\n  try {\n    pool = createLakebasePool({ workspaceClient: getWorkspaceClient({}) });\n    const storage = new PersistentStorage(cache ?? {}, pool);\n    softenInitialize(storage);\n    if (!(await storage.healthCheck())) {\n      await storage.close().catch(() => {});\n      return undefined;\n    }\n    await storage.initialize();\n    return storage;\n  } catch (err) {\n    logger.debug(\"soft persistent cache unavailable\", {\n      error: error.errorMessage(err),\n    });\n    if (pool) {\n      await pool.end().catch(() => {});\n    }\n    return undefined;\n  }\n}\n"]}
|
package/lib/src/appkit.d.ts
CHANGED
|
@@ -1,6 +1,22 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
2
|
+
* AppKit runtime glue: the auto-configuring `createApp` drop-in, plus the
|
|
3
|
+
* per-request execution context helpers and types derived from it.
|
|
4
|
+
*
|
|
5
|
+
* `createApp` runs dbx-tools auto-configuration, then delegates to AppKit's own
|
|
6
|
+
* `createApp` with the same arguments and the same typed plugin-export map.
|
|
7
|
+
* Drop it in as a one-for-one replacement:
|
|
8
|
+
*
|
|
9
|
+
* ```ts
|
|
10
|
+
* import { lakebase, server } from "@databricks/appkit";
|
|
11
|
+
* import { appkit } from "@dbx-tools/appkit";
|
|
12
|
+
*
|
|
13
|
+
* await appkit.createApp({ plugins: [server(), lakebase()] });
|
|
14
|
+
* ```
|
|
15
|
+
*
|
|
16
|
+
* Auto-configuration runs BEFORE delegating so plugins see a fully populated
|
|
17
|
+
* `process.env` during their synchronous `setup()`. Lakebase Postgres runs when
|
|
18
|
+
* a `lakebase` plugin is present, or when {@link AutoConfigureMode} is set
|
|
19
|
+
* explicitly on the config object.
|
|
4
20
|
*
|
|
5
21
|
* `getExecutionContext()` is AppKit's own accessor for the OBO-scoped workspace
|
|
6
22
|
* client + request metadata; the wrappers here make it safe to call outside a
|
|
@@ -10,7 +26,79 @@
|
|
|
10
26
|
*
|
|
11
27
|
* @module
|
|
12
28
|
*/
|
|
13
|
-
import { getExecutionContext } from "@databricks/appkit";
|
|
29
|
+
import { createApp as appkitCreateApp, getExecutionContext } from "@databricks/appkit";
|
|
30
|
+
import type { PluginMap } from "@databricks/appkit/dist/shared/src/plugin";
|
|
31
|
+
import { type Interceptor } from "./interceptor.ts";
|
|
32
|
+
import { type LakebaseConnection } from "./lakebase-resolver.ts";
|
|
33
|
+
type AppKitCreateAppConfig = NonNullable<Parameters<typeof appkitCreateApp>[0]>;
|
|
34
|
+
type AppKitPlugins = NonNullable<AppKitCreateAppConfig["plugins"]>;
|
|
35
|
+
/**
|
|
36
|
+
* What auto-configuration does before AppKit boots.
|
|
37
|
+
*
|
|
38
|
+
* - `"provision"`: resolve the Lakebase connection into `process.env`, then
|
|
39
|
+
* grant the AppKit cache schema to the connecting role.
|
|
40
|
+
* - `"env"`: resolve the Lakebase connection into `process.env` only.
|
|
41
|
+
*
|
|
42
|
+
* Omit it to get `"provision"` gated on a `lakebase` plugin being registered;
|
|
43
|
+
* set it explicitly to run regardless of the plugin list, or pass `false` to
|
|
44
|
+
* skip auto-configuration entirely.
|
|
45
|
+
*
|
|
46
|
+
* Set it EXPLICITLY on an app that has no `lakebase()` plugin but still wants
|
|
47
|
+
* AppKit's PERSISTENT cache. AppKit picks Lakebase for `CacheManager` only when
|
|
48
|
+
* `createLakebasePool()` can build a pool, and that reads `LAKEBASE_ENDPOINT` /
|
|
49
|
+
* `PGHOST` / `PGDATABASE` straight from `process.env` - so without this step the
|
|
50
|
+
* cache silently falls back to in-memory, and anything it holds (a session
|
|
51
|
+
* signing key, a one-time code) is lost on restart. `"env"` is the right mode
|
|
52
|
+
* there: the app SP cannot grant on the cache schema anyway.
|
|
53
|
+
*/
|
|
54
|
+
export type AutoConfigureMode = "env" | "provision";
|
|
55
|
+
/** AppKit's `createApp` config plus the dbx-tools auto-configuration switch. */
|
|
56
|
+
export type CreateAppConfig<T extends AppKitPlugins = AppKitPlugins> = Omit<AppKitCreateAppConfig, "plugins" | "onPluginsReady"> & {
|
|
57
|
+
plugins?: T;
|
|
58
|
+
onPluginsReady?: (appkit: PluginMap<T>) => void | Promise<void>;
|
|
59
|
+
/** Auto-configuration to run before AppKit boots. Defaults to `"provision"`. */
|
|
60
|
+
autoConfigure?: AutoConfigureMode | false;
|
|
61
|
+
/**
|
|
62
|
+
* One or many {@link Interceptor}s handed an {@link InterceptorContext} once
|
|
63
|
+
* auto-configuration has computed the env. Each receives the resolved env, an
|
|
64
|
+
* AppKit-lifecycle hook, and `bindProcess` for concurrently-style supervision -
|
|
65
|
+
* see `./interceptor`. The tunnel is the primary consumer.
|
|
66
|
+
*/
|
|
67
|
+
interceptor?: Interceptor | Interceptor[];
|
|
68
|
+
};
|
|
69
|
+
/**
|
|
70
|
+
* Run enabled auto-configuration steps without calling AppKit's `createApp`.
|
|
71
|
+
*
|
|
72
|
+
* Lakebase Postgres resolves when {@link CreateAppConfig.autoConfigure} is set
|
|
73
|
+
* explicitly or a `lakebase` plugin is listed in `config.plugins`. `signal`
|
|
74
|
+
* cancels the resolution; it is combined with an internal boot timeout either
|
|
75
|
+
* way.
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* import { appkit } from "@dbx-tools/appkit";
|
|
79
|
+
*
|
|
80
|
+
* // Populate PGHOST / PGDATABASE / LAKEBASE_ENDPOINT without booting AppKit.
|
|
81
|
+
* await appkit.autoConfigure({ autoConfigure: "env" });
|
|
82
|
+
*/
|
|
83
|
+
export declare function autoConfigure<T extends AppKitPlugins>(config?: CreateAppConfig<T>, signal?: AbortSignal): Promise<LakebaseConnection | undefined>;
|
|
84
|
+
/**
|
|
85
|
+
* Auto-configuring drop-in for AppKit's `createApp`: same config, same typed
|
|
86
|
+
* plugin-export map, with {@link autoConfigure} run first.
|
|
87
|
+
*
|
|
88
|
+
* When {@link CreateAppConfig.interceptor}s are given, each is invoked with an
|
|
89
|
+
* {@link InterceptorContext} AFTER auto-configuration computes the env and BEFORE
|
|
90
|
+
* AppKit boots - so an interceptor can read the resolved connection, register
|
|
91
|
+
* lifecycle handlers, and `bindProcess` a child. A hidden {@link lifecycleBridge}
|
|
92
|
+
* plugin is injected so those `onLifecycle` handlers fire on the genuine AppKit
|
|
93
|
+
* events; it has no exports, so the returned {@link PluginMap} is unchanged.
|
|
94
|
+
*
|
|
95
|
+
* @example
|
|
96
|
+
* import { lakebase, server } from "@databricks/appkit";
|
|
97
|
+
* import { appkit } from "@dbx-tools/appkit";
|
|
98
|
+
*
|
|
99
|
+
* const app = await appkit.createApp({ plugins: [server(), lakebase()] });
|
|
100
|
+
*/
|
|
101
|
+
export declare function createApp<T extends AppKitPlugins>(config?: CreateAppConfig<T>): Promise<PluginMap<T>>;
|
|
14
102
|
/**
|
|
15
103
|
* The AppKit per-request execution context returned by `getExecutionContext()`
|
|
16
104
|
* - the OBO-scoped workspace client plus the surrounding request metadata.
|
|
@@ -49,3 +137,4 @@ export declare function tryGetExecutionContext(): ExecutionContextLike | undefin
|
|
|
49
137
|
* const client = appkit.tryGetExecutionContext()?.client;
|
|
50
138
|
*/
|
|
51
139
|
export declare function ensureInitialized(): Promise<void>;
|
|
140
|
+
export {};
|