@dbx-tools/appkit-mastra 0.5.1 → 0.6.0
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 +22 -7
- package/index.ts +4 -1
- package/lib/index.d.ts +4 -1
- package/lib/index.js +3 -1
- package/lib/src/config.d.ts +33 -0
- package/lib/src/config.js +6 -1
- package/lib/src/identity.d.ts +80 -0
- package/lib/src/identity.js +95 -0
- package/lib/src/plugin.d.ts +22 -0
- package/lib/src/plugin.js +40 -8
- package/lib/src/server.d.ts +20 -2
- package/lib/src/server.js +32 -13
- package/lib/tsconfig.tsbuildinfo +1 -1
- package/package.json +9 -9
- package/src/config.ts +39 -0
- package/src/identity.ts +110 -0
- package/src/plugin.ts +40 -7
- package/src/server.ts +50 -12
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Which Databricks identity a chat turn's workspace calls run as.
|
|
3
|
+
*
|
|
4
|
+
* Every Databricks call a turn makes - the `/serving-endpoints` catalogue the
|
|
5
|
+
* model picker reads, Genie suggestions, `ask_genie`, and the Statement
|
|
6
|
+
* Execution fetch behind a `[data:<id>]` embed - goes through the workspace
|
|
7
|
+
* client on the ambient AppKit execution context. That context is user-scoped
|
|
8
|
+
* (OBO) whenever the plugin enters `asUser(req)` and the app's service principal
|
|
9
|
+
* otherwise, so ONE decision - do we enter that scope for this request - moves
|
|
10
|
+
* every call site together. This module owns that decision.
|
|
11
|
+
*
|
|
12
|
+
* Why the option exists: OBO requires the caller to be a member of the
|
|
13
|
+
* WORKSPACE, not merely of the Databricks account. An app shared with an
|
|
14
|
+
* account-level group can therefore be opened by someone whose OBO token is
|
|
15
|
+
* perfectly valid but whose every workspace call fails with `Unauthorized
|
|
16
|
+
* access to Org: <workspace-id>`, and granting workspace membership is not
|
|
17
|
+
* always available - a workspace caps membership far below the size of a large
|
|
18
|
+
* account's user group. The app's own service principal already holds the Genie
|
|
19
|
+
* / warehouse / serving / Unity Catalog grants the app was deployed with, and
|
|
20
|
+
* works for every caller.
|
|
21
|
+
*
|
|
22
|
+
* The two modes, from `config.genieIdentity` (env: {@link IDENTITY_ENV}):
|
|
23
|
+
*
|
|
24
|
+
* - `"user"` (default): always OBO. Calls are attributed per user and Genie /
|
|
25
|
+
* Unity Catalog row filters apply per user. Correct whenever every caller is
|
|
26
|
+
* a workspace member. This is the historical behavior, so the option is
|
|
27
|
+
* purely additive - an app that never sets it is unchanged.
|
|
28
|
+
* - `"service-principal"`: always the app service principal. Needs no OBO
|
|
29
|
+
* scopes and works for any caller who can open the app, at the cost of
|
|
30
|
+
* per-user attribution in Genie / Unity Catalog.
|
|
31
|
+
*
|
|
32
|
+
* What `"service-principal"` does NOT change is WHO the turn belongs to. The
|
|
33
|
+
* memory thread's `resourceId`, the per-user cache namespace, and the user
|
|
34
|
+
* metadata on traces still come from the forwarded request headers, so two
|
|
35
|
+
* account users sharing the service principal's data access still get separate
|
|
36
|
+
* conversations and cannot read each other's threads or cached charts. Only the
|
|
37
|
+
* Databricks credential is shared.
|
|
38
|
+
*
|
|
39
|
+
* @module
|
|
40
|
+
*/
|
|
41
|
+
import { ConfigurationError } from "@databricks/appkit";
|
|
42
|
+
import { string } from "@dbx-tools/shared-core";
|
|
43
|
+
/** Environment fallback for `config.genieIdentity`. */
|
|
44
|
+
export const IDENTITY_ENV = "MASTRA_GENIE_IDENTITY";
|
|
45
|
+
/** Every accepted {@link MastraIdentityMode}. */
|
|
46
|
+
export const IDENTITY_MODES = ["user", "service-principal"];
|
|
47
|
+
/**
|
|
48
|
+
* Default mode. `"user"` keeps OBO the only identity unless an app opts in, so
|
|
49
|
+
* adopting this option can never silently widen an existing app's data access.
|
|
50
|
+
*/
|
|
51
|
+
export const DEFAULT_IDENTITY_MODE = "user";
|
|
52
|
+
/**
|
|
53
|
+
* Resolve the configured mode: explicit plugin config, then {@link IDENTITY_ENV},
|
|
54
|
+
* then {@link DEFAULT_IDENTITY_MODE}.
|
|
55
|
+
*
|
|
56
|
+
* An unrecognized value throws rather than falling back, since falling back
|
|
57
|
+
* would silently keep serving OBO - and the 500s it produces - to exactly the
|
|
58
|
+
* callers the option was set to accommodate.
|
|
59
|
+
*/
|
|
60
|
+
export function resolveIdentityMode(configured) {
|
|
61
|
+
const raw = string.trimToNull(configured) ?? string.trimToNull(process.env[IDENTITY_ENV]);
|
|
62
|
+
if (raw === null)
|
|
63
|
+
return DEFAULT_IDENTITY_MODE;
|
|
64
|
+
const mode = raw.toLowerCase();
|
|
65
|
+
if (!IDENTITY_MODES.includes(mode)) {
|
|
66
|
+
throw new ConfigurationError(`genieIdentity must be one of ${IDENTITY_MODES.join(" | ")} (env: ${IDENTITY_ENV})`, { context: { field: "genieIdentity", envVar: IDENTITY_ENV, received: raw } });
|
|
67
|
+
}
|
|
68
|
+
return mode;
|
|
69
|
+
}
|
|
70
|
+
/** Header Databricks Apps forward the signed-in user's id on. */
|
|
71
|
+
export const USER_ID_HEADER = "x-forwarded-user";
|
|
72
|
+
/** Header Databricks Apps forward the signed-in user's email on. */
|
|
73
|
+
export const USER_EMAIL_HEADER = "x-forwarded-email";
|
|
74
|
+
/**
|
|
75
|
+
* The forwarded user id on `req`, or `undefined`. Used to attribute a turn to
|
|
76
|
+
* the real caller in `service-principal` mode, where the Databricks client is
|
|
77
|
+
* the app SP but memory / cache / traces must still key off the user.
|
|
78
|
+
*/
|
|
79
|
+
export function requestUserId(req) {
|
|
80
|
+
return string.trimToNull(req.header(USER_ID_HEADER)) ?? undefined;
|
|
81
|
+
}
|
|
82
|
+
/** The forwarded user email on `req`, or `undefined`. */
|
|
83
|
+
export function requestUserEmail(req) {
|
|
84
|
+
return string.trimToNull(req.header(USER_EMAIL_HEADER)) ?? undefined;
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Whether this request should run its Databricks calls as the app service
|
|
88
|
+
* principal rather than OBO. `"service-principal"` always does; `"user"` never
|
|
89
|
+
* does. The request is accepted for symmetry and to leave room for
|
|
90
|
+
* request-scoped policy later; it is unused today.
|
|
91
|
+
*/
|
|
92
|
+
export function useServicePrincipal(mode, _req) {
|
|
93
|
+
return mode === "service-principal";
|
|
94
|
+
}
|
|
95
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"identity.js","sourceRoot":"","sources":["../../src/identity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAMhD,uDAAuD;AACvD,MAAM,CAAC,MAAM,YAAY,GAAG,uBAAuB,CAAC;AAEpD,iDAAiD;AACjD,MAAM,CAAC,MAAM,cAAc,GAAkC,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;AAE3F;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAuB,MAAM,CAAC;AAEhE;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAAC,UAA8B;IAChE,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;IAC1F,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,qBAAqB,CAAC;IAC/C,MAAM,IAAI,GAAG,GAAG,CAAC,WAAW,EAAwB,CAAC;IACrD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,kBAAkB,CAC1B,gCAAgC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,YAAY,GAAG,EACnF,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,EAAE,EAAE,CAC7E,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,iEAAiE;AACjE,MAAM,CAAC,MAAM,cAAc,GAAG,kBAAkB,CAAC;AAEjD,oEAAoE;AACpE,MAAM,CAAC,MAAM,iBAAiB,GAAG,mBAAmB,CAAC;AAErD;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,GAAoB;IAChD,OAAO,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,IAAI,SAAS,CAAC;AACpE,CAAC;AAED,yDAAyD;AACzD,MAAM,UAAU,gBAAgB,CAAC,GAAoB;IACnD,OAAO,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,IAAI,SAAS,CAAC;AACvE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAwB,EAAE,IAAsB;IAClF,OAAO,IAAI,KAAK,mBAAmB,CAAC;AACtC,CAAC","sourcesContent":["/**\n * Which Databricks identity a chat turn's workspace calls run as.\n *\n * Every Databricks call a turn makes - the `/serving-endpoints` catalogue the\n * model picker reads, Genie suggestions, `ask_genie`, and the Statement\n * Execution fetch behind a `[data:<id>]` embed - goes through the workspace\n * client on the ambient AppKit execution context. That context is user-scoped\n * (OBO) whenever the plugin enters `asUser(req)` and the app's service principal\n * otherwise, so ONE decision - do we enter that scope for this request - moves\n * every call site together. This module owns that decision.\n *\n * Why the option exists: OBO requires the caller to be a member of the\n * WORKSPACE, not merely of the Databricks account. An app shared with an\n * account-level group can therefore be opened by someone whose OBO token is\n * perfectly valid but whose every workspace call fails with `Unauthorized\n * access to Org: <workspace-id>`, and granting workspace membership is not\n * always available - a workspace caps membership far below the size of a large\n * account's user group. The app's own service principal already holds the Genie\n * / warehouse / serving / Unity Catalog grants the app was deployed with, and\n * works for every caller.\n *\n * The two modes, from `config.genieIdentity` (env: {@link IDENTITY_ENV}):\n *\n *   - `\"user\"` (default): always OBO. Calls are attributed per user and Genie /\n *     Unity Catalog row filters apply per user. Correct whenever every caller is\n *     a workspace member. This is the historical behavior, so the option is\n *     purely additive - an app that never sets it is unchanged.\n *   - `\"service-principal\"`: always the app service principal. Needs no OBO\n *     scopes and works for any caller who can open the app, at the cost of\n *     per-user attribution in Genie / Unity Catalog.\n *\n * What `\"service-principal\"` does NOT change is WHO the turn belongs to. The\n * memory thread's `resourceId`, the per-user cache namespace, and the user\n * metadata on traces still come from the forwarded request headers, so two\n * account users sharing the service principal's data access still get separate\n * conversations and cannot read each other's threads or cached charts. Only the\n * Databricks credential is shared.\n *\n * @module\n */\n\nimport { ConfigurationError } from \"@databricks/appkit\";\nimport { string } from \"@dbx-tools/shared-core\";\nimport type express from \"express\";\n\n/** Identity a chat turn's Databricks calls run as. See the module docs. */\nexport type MastraIdentityMode = \"user\" | \"service-principal\";\n\n/** Environment fallback for `config.genieIdentity`. */\nexport const IDENTITY_ENV = \"MASTRA_GENIE_IDENTITY\";\n\n/** Every accepted {@link MastraIdentityMode}. */\nexport const IDENTITY_MODES: readonly MastraIdentityMode[] = [\"user\", \"service-principal\"];\n\n/**\n * Default mode. `\"user\"` keeps OBO the only identity unless an app opts in, so\n * adopting this option can never silently widen an existing app's data access.\n */\nexport const DEFAULT_IDENTITY_MODE: MastraIdentityMode = \"user\";\n\n/**\n * Resolve the configured mode: explicit plugin config, then {@link IDENTITY_ENV},\n * then {@link DEFAULT_IDENTITY_MODE}.\n *\n * An unrecognized value throws rather than falling back, since falling back\n * would silently keep serving OBO - and the 500s it produces - to exactly the\n * callers the option was set to accommodate.\n */\nexport function resolveIdentityMode(configured: string | undefined): MastraIdentityMode {\n  const raw = string.trimToNull(configured) ?? string.trimToNull(process.env[IDENTITY_ENV]);\n  if (raw === null) return DEFAULT_IDENTITY_MODE;\n  const mode = raw.toLowerCase() as MastraIdentityMode;\n  if (!IDENTITY_MODES.includes(mode)) {\n    throw new ConfigurationError(\n      `genieIdentity must be one of ${IDENTITY_MODES.join(\" | \")} (env: ${IDENTITY_ENV})`,\n      { context: { field: \"genieIdentity\", envVar: IDENTITY_ENV, received: raw } },\n    );\n  }\n  return mode;\n}\n\n/** Header Databricks Apps forward the signed-in user's id on. */\nexport const USER_ID_HEADER = \"x-forwarded-user\";\n\n/** Header Databricks Apps forward the signed-in user's email on. */\nexport const USER_EMAIL_HEADER = \"x-forwarded-email\";\n\n/**\n * The forwarded user id on `req`, or `undefined`. Used to attribute a turn to\n * the real caller in `service-principal` mode, where the Databricks client is\n * the app SP but memory / cache / traces must still key off the user.\n */\nexport function requestUserId(req: express.Request): string | undefined {\n  return string.trimToNull(req.header(USER_ID_HEADER)) ?? undefined;\n}\n\n/** The forwarded user email on `req`, or `undefined`. */\nexport function requestUserEmail(req: express.Request): string | undefined {\n  return string.trimToNull(req.header(USER_EMAIL_HEADER)) ?? undefined;\n}\n\n/**\n * Whether this request should run its Databricks calls as the app service\n * principal rather than OBO. `\"service-principal\"` always does; `\"user\"` never\n * does. The request is accepted for symmetry and to leave room for\n * request-scoped policy later; it is unused today.\n */\nexport function useServicePrincipal(mode: MastraIdentityMode, _req?: express.Request): boolean {\n  return mode === \"service-principal\";\n}\n"]}
|
package/lib/src/plugin.d.ts
CHANGED
|
@@ -103,6 +103,12 @@ export declare class MastraPlugin extends Plugin<MastraPluginConfig> {
|
|
|
103
103
|
* {@link buildAgentAndServer} and registered on the Mastra instance.
|
|
104
104
|
*/
|
|
105
105
|
private mcp;
|
|
106
|
+
/**
|
|
107
|
+
* Resolved {@link MastraIdentityMode}: the identity the chat path's Databricks
|
|
108
|
+
* calls run as. Read once at setup so an invalid `genieIdentity` fails the app
|
|
109
|
+
* boot rather than the first request, and so every request agrees.
|
|
110
|
+
*/
|
|
111
|
+
private identityMode;
|
|
106
112
|
/**
|
|
107
113
|
* Dedicated service-principal Lakebase pool backing Mastra memory /
|
|
108
114
|
* storage. Built once in {@link buildAgentAndServer} (outside any
|
|
@@ -112,6 +118,22 @@ export declare class MastraPlugin extends Plugin<MastraPluginConfig> {
|
|
|
112
118
|
*/
|
|
113
119
|
private servicePrincipalPool;
|
|
114
120
|
setup(): Promise<void>;
|
|
121
|
+
/**
|
|
122
|
+
* The plugin instance the chat path's Databricks calls should run through for
|
|
123
|
+
* `req`, honoring {@link identityMode}.
|
|
124
|
+
*
|
|
125
|
+
* In `"user"` mode (the default) this is `this.asUser(req)` - AppKit's own
|
|
126
|
+
* proxy that runs every call inside `runInUserContext`, so `getExecutionContext()`
|
|
127
|
+
* returns the caller's OBO client, exactly as before this option existed. In
|
|
128
|
+
* `"service-principal"` mode it is `this` unwrapped, so the same methods run in
|
|
129
|
+
* the ambient service context and `getExecutionContext()` returns the app
|
|
130
|
+
* service principal's client - the same "just don't enter `asUser`" pattern
|
|
131
|
+
* AppKit's own service-context calls use. One helper covers every workspace
|
|
132
|
+
* call the chat path makes (serving catalogue, Genie suggestions, `ask_genie`
|
|
133
|
+
* via the dispatched agent turn, statement fetch, feedback), so the identity
|
|
134
|
+
* decision lives in one place.
|
|
135
|
+
*/
|
|
136
|
+
private scopedSelf;
|
|
115
137
|
/**
|
|
116
138
|
* When the `lakebase` plugin is registered, auto-enable `storage`
|
|
117
139
|
* and `memory` unless the caller opted out explicitly (`false` or a
|