@flink-app/test-utils 2.0.0-alpha.56 → 2.0.0-alpha.58

package/CHANGELOG.md

@@ -1,5 +1,56 @@
 # @flink-app/test-utils
 
+## 2.0.0-alpha.58
+
+## 2.0.0-alpha.57
+
+### Minor Changes
+
+-   ef7f495: Add AsyncLocalStorage for automatic user/permissions injection in tools
+
+    **New Features:**
+
+    -   Tools now receive `user` and `permissions` parameters automatically from AsyncLocalStorage
+    -   Declarative permissions in tool definitions - framework checks before execution
+    -   No more need for explicit `agent.withUser()` bindings
+    -   Context flows automatically: handler → agent → tools
+
+    **API Changes:**
+
+    -   `ToolExecutor.execute()` signature: `(input, overrides?)` instead of `(input, user?, permissions?)`
+    -   `FlinkTool` handler signature includes `user?` and `permissions?` parameters
+    -   Permission checking supports explicit permissions without requiring user object
+
+    **Testing:**
+
+    -   New test utilities: `withRequestContext()`, `createMockUser()`, `createMockRequestContext()`
+    -   Override support for unit testing: `execute(input, { user, permissions })`
+    -   13 new AsyncLocalStorage integration tests
+
+    **Developer Experience:**
+
+    ```typescript
+    // Before: Manual user passing
+    await agent.withUser(req.user).execute({ message: "..." });
+
+    // After: Automatic context flow
+    await agent.execute({ message: "..." });
+
+    // Tools with declarative permissions
+    export const Tool: FlinkToolProps = {
+        permissions: ["car:read"], // ✨ Checked by framework
+    };
+
+    const handler: FlinkTool<Ctx, In, Out> = async ({
+        input,
+        ctx,
+        user,
+        permissions, // ✨ Auto-injected
+    }) => {
+        // Permission already verified - just implement logic
+    };
+    ```
+
 ## 2.0.0-alpha.56
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./http";
 export * from "./mocks";
 export * from "./ai";
+export * from "./requestContext";

package/dist/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./http"), exports);
 __exportStar(require("./mocks"), exports);
 __exportStar(require("./ai"), exports);
+__exportStar(require("./requestContext"), exports);

package/dist/requestContext.d.ts

@@ -0,0 +1,22 @@
+import { RequestContext } from '@flink-app/flink';
+/**
+ * Create a mock request context for testing
+ */
+export declare function createMockRequestContext(overrides?: Partial<RequestContext>): RequestContext;
+/**
+ * Execute a function within a mocked request context
+ * Useful for testing tools and agents that use AsyncLocalStorage
+ *
+ * @example
+ * const result = await withRequestContext(
+ *     { user: { id: '123', username: 'test' }, reqId: 'req-123' },
+ *     async () => {
+ *         return await someTool.execute({ carId: 'car-1' });
+ *     }
+ * );
+ */
+export declare function withRequestContext<T>(context: Partial<RequestContext>, fn: () => T | Promise<T>): Promise<T>;
+/**
+ * Create a test user with common properties
+ */
+export declare function createMockUser(overrides?: any): any;

package/dist/requestContext.js

@@ -0,0 +1,86 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMockRequestContext = createMockRequestContext;
+exports.withRequestContext = withRequestContext;
+exports.createMockUser = createMockUser;
+var flink_1 = require("@flink-app/flink");
+/**
+ * Create a mock request context for testing
+ */
+function createMockRequestContext(overrides) {
+    return __assign({ reqId: "test-req-" + Math.random().toString(36).substring(7), timestamp: Date.now() }, overrides);
+}
+/**
+ * Execute a function within a mocked request context
+ * Useful for testing tools and agents that use AsyncLocalStorage
+ *
+ * @example
+ * const result = await withRequestContext(
+ *     { user: { id: '123', username: 'test' }, reqId: 'req-123' },
+ *     async () => {
+ *         return await someTool.execute({ carId: 'car-1' });
+ *     }
+ * );
+ */
+function withRequestContext(context, fn) {
+    return __awaiter(this, void 0, void 0, function () {
+        var fullContext;
+        return __generator(this, function (_a) {
+            fullContext = createMockRequestContext(context);
+            return [2 /*return*/, flink_1.requestContext.run(fullContext, fn)];
+        });
+    });
+}
+/**
+ * Create a test user with common properties
+ */
+function createMockUser(overrides) {
+    return __assign({ id: "user-" + Math.random().toString(36).substring(7), username: "testuser", email: "test@example.com" }, overrides);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flink-app/test-utils",
-  "version": "2.0.0-alpha.56",
+  "version": "2.0.0-alpha.58",
   "description": "Test utils for Flink",
   "author": "joel@frost.se",
   "license": "MIT",
@@ -23,7 +23,7 @@
     "jasmine-ts": "^0.3.3",
     "ts-node": "^10.9.2",
     "tsc-watch": "^4.2.9",
-    "@flink-app/flink": "2.0.0-alpha.56"
+    "@flink-app/flink": "2.0.0-alpha.58"
   },
   "gitHead": "4243e3b3cd6d4e1ca001a61baa8436bf2bbe4113",
   "scripts": {

package/src/index.ts

@@ -1,3 +1,4 @@
 export * from "./http";
 export * from "./mocks";
 export * from "./ai";
+export * from "./requestContext";

package/src/requestContext.ts

@@ -0,0 +1,44 @@
+import { RequestContext, requestContext } from '@flink-app/flink';
+
+/**
+ * Create a mock request context for testing
+ */
+export function createMockRequestContext(overrides?: Partial<RequestContext>): RequestContext {
+    return {
+        reqId: "test-req-" + Math.random().toString(36).substring(7),
+        timestamp: Date.now(),
+        ...overrides,
+    };
+}
+
+/**
+ * Execute a function within a mocked request context
+ * Useful for testing tools and agents that use AsyncLocalStorage
+ *
+ * @example
+ * const result = await withRequestContext(
+ *     { user: { id: '123', username: 'test' }, reqId: 'req-123' },
+ *     async () => {
+ *         return await someTool.execute({ carId: 'car-1' });
+ *     }
+ * );
+ */
+export async function withRequestContext<T>(
+    context: Partial<RequestContext>,
+    fn: () => T | Promise<T>
+): Promise<T> {
+    const fullContext = createMockRequestContext(context);
+    return requestContext.run(fullContext, fn);
+}
+
+/**
+ * Create a test user with common properties
+ */
+export function createMockUser(overrides?: any) {
+    return {
+        id: "user-" + Math.random().toString(36).substring(7),
+        username: "testuser",
+        email: "test@example.com",
+        ...overrides,
+    };
+}