@flink-app/test-utils 0.12.1-alpha.2 → 0.12.1-alpha.4

package/dist/http.d.ts

@@ -1,15 +1,30 @@
 import { FlinkApp, FlinkResponse } from "@flink-app/flink";
 export type HttpOpts = {
+    /***
+     * Optional query string
+     */
     qs?: {
         [x: string]: string | string[];
     };
+    /**
+     * Optional headers
+     */
     headers?: {
         [x: string]: string;
     };
+    /**
+     * Optional user object to be used for authentication.
+     *
+     * An auth plugin must be set in the app for this to work. Most likely the auth plugin
+     * is a mock auth plugin in test scenarios.
+     */
+    user?: any & {
+        roles: string[];
+    };
 };
 /**
  * Initializes test flink app.
- * Should be invoked prior to using test HTTP methods.
+ * Must be invoked prior to using test HTTP methods.
  */
 export declare function init(_app: FlinkApp<any>, host?: string): void;
 export declare function get<Res = any>(path: string, opts?: HttpOpts): Promise<FlinkResponse<Res>>;

package/dist/http.js

@@ -62,7 +62,7 @@ var gotOpts = {
 };
 /**
  * Initializes test flink app.
- * Should be invoked prior to using test HTTP methods.
+ * Must be invoked prior to using test HTTP methods.
  */
 function init(_app, host) {
     if (host === void 0) { host = "localhost"; }
@@ -72,14 +72,17 @@ function init(_app, host) {
 exports.init = init;
 function get(path_1) {
     return __awaiter(this, arguments, void 0, function (path, opts) {
-        var res;
+        var headers, res;
         if (opts === void 0) { opts = {}; }
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
                     validateApp();
-                    return [4 /*yield*/, got_1.default.get(getUrl(path, opts.qs), __assign(__assign({}, gotOpts), { headers: opts.headers }))];
+                    return [4 /*yield*/, setAuthHeader(opts.user, opts.headers)];
                 case 1:
+                    headers = _a.sent();
+                    return [4 /*yield*/, got_1.default.get(getUrl(path, opts.qs), __assign(__assign({}, gotOpts), { headers: headers }))];
+                case 2:
                     res = _a.sent();
                     return [2 /*return*/, __assign({ status: res.statusCode }, res.body)];
             }
@@ -89,16 +92,27 @@ function get(path_1) {
 exports.get = get;
 function post(path_1, body_1) {
     return __awaiter(this, arguments, void 0, function (path, body, opts) {
-        var res;
+        var headers, res, err_1;
         if (opts === void 0) { opts = {}; }
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
                     validateApp();
-                    return [4 /*yield*/, got_1.default.post(getUrl(path, opts.qs), __assign(__assign({}, gotOpts), { body: body, headers: opts.headers }))];
+                    return [4 /*yield*/, setAuthHeader(opts.user, opts.headers)];
                 case 1:
+                    headers = _a.sent();
+                    _a.label = 2;
+                case 2:
+                    _a.trys.push([2, 4, , 5]);
+                    return [4 /*yield*/, got_1.default.post(getUrl(path, opts.qs), __assign(__assign({}, gotOpts), { body: body, headers: headers }))];
+                case 3:
                     res = _a.sent();
                     return [2 /*return*/, __assign({ status: res.statusCode }, res.body)];
+                case 4:
+                    err_1 = _a.sent();
+                    console.error(err_1);
+                    throw err_1;
+                case 5: return [2 /*return*/];
             }
         });
     });
@@ -106,14 +120,17 @@ function post(path_1, body_1) {
 exports.post = post;
 function put(path_1, body_1) {
     return __awaiter(this, arguments, void 0, function (path, body, opts) {
-        var res;
+        var headers, res;
         if (opts === void 0) { opts = {}; }
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
                     validateApp();
-                    return [4 /*yield*/, got_1.default.put(getUrl(path, opts.qs), __assign(__assign({}, gotOpts), { body: body, headers: opts.headers }))];
+                    return [4 /*yield*/, setAuthHeader(opts.user, opts.headers)];
                 case 1:
+                    headers = _a.sent();
+                    return [4 /*yield*/, got_1.default.put(getUrl(path, opts.qs), __assign(__assign({}, gotOpts), { body: body, headers: headers }))];
+                case 2:
                     res = _a.sent();
                     return [2 /*return*/, __assign({ status: res.statusCode }, res.body)];
             }
@@ -123,14 +140,17 @@ function put(path_1, body_1) {
 exports.put = put;
 function del(path_1) {
     return __awaiter(this, arguments, void 0, function (path, opts) {
-        var res;
+        var headers, res;
         if (opts === void 0) { opts = {}; }
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
                     validateApp();
-                    return [4 /*yield*/, got_1.default.delete(getUrl(path, opts.qs), __assign(__assign({}, gotOpts), { headers: opts.headers }))];
+                    return [4 /*yield*/, setAuthHeader(opts.user, opts.headers)];
                 case 1:
+                    headers = _a.sent();
+                    return [4 /*yield*/, got_1.default.delete(getUrl(path, opts.qs), __assign(__assign({}, gotOpts), { headers: headers }))];
+                case 2:
                     res = _a.sent();
                     return [2 /*return*/, __assign({ status: res.statusCode }, res.body)];
             }
@@ -149,3 +169,24 @@ function getUrl(path, queryString) {
     }
     return baseUrl + path;
 }
+function setAuthHeader(user, headers) {
+    return __awaiter(this, void 0, void 0, function () {
+        var token;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (!user)
+                        return [2 /*return*/, headers];
+                    headers = headers || {};
+                    if (!app.auth) {
+                        throw new Error("Auth plugin not set, cannot use user option");
+                    }
+                    return [4 /*yield*/, app.auth.createToken(user, user.roles || [])];
+                case 1:
+                    token = _a.sent();
+                    headers["Authorization"] = "Bearer ".concat(token);
+                    return [2 /*return*/, headers];
+            }
+        });
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@flink-app/test-utils",
-    "version": "0.12.1-alpha.2",
+    "version": "0.12.1-alpha.4",
     "description": "Test utils for Flink",
     "scripts": {
         "test": "echo \"Error: no test specified\"",
@@ -20,7 +20,7 @@
         "qs": "^6.7.0"
     },
     "devDependencies": {
-        "@flink-app/flink": "^0.12.1-alpha.2",
+        "@flink-app/flink": "^0.12.1-alpha.4",
         "@types/express": "^4.17.12",
         "@types/got": "^9.6.12",
         "@types/node": "22.13.10",
@@ -30,5 +30,5 @@
         "tsc-watch": "^4.2.9",
         "typescript": "5.4.5"
     },
-    "gitHead": "b5be77c75e10067c81e0ecab8716b30f99833b83"
+    "gitHead": "8f06a4ab98e7179322d36546756d4305fd196f5a"
 }

package/src/http.ts

@@ -12,13 +12,26 @@ const gotOpts: GotJSONOptions = {
 };
 
 export type HttpOpts = {
+    /***
+     * Optional query string
+     */
     qs?: { [x: string]: string | string[] };
+    /**
+     * Optional headers
+     */
     headers?: { [x: string]: string };
+    /**
+     * Optional user object to be used for authentication.
+     *
+     * An auth plugin must be set in the app for this to work. Most likely the auth plugin
+     * is a mock auth plugin in test scenarios.
+     */
+    user?: any & { roles: string[] };
 };
 
 /**
  * Initializes test flink app.
- * Should be invoked prior to using test HTTP methods.
+ * Must be invoked prior to using test HTTP methods.
  */
 export function init(_app: FlinkApp<any>, host = "localhost") {
     app = _app;
@@ -27,9 +40,12 @@ export function init(_app: FlinkApp<any>, host = "localhost") {
 
 export async function get<Res = any>(path: string, opts: HttpOpts = {}): Promise<FlinkResponse<Res>> {
     validateApp();
+
+    const headers = await setAuthHeader(opts.user, opts.headers);
+
     const res = await got.get(getUrl(path, opts.qs), {
         ...gotOpts,
-        headers: opts.headers,
+        headers,
     });
     return {
         status: res.statusCode,
@@ -39,24 +55,35 @@ export async function get<Res = any>(path: string, opts: HttpOpts = {}): Promise
 
 export async function post<Req = any, Res = any>(path: string, body: Req, opts: HttpOpts = {}): Promise<FlinkResponse<Res>> {
     validateApp();
-    const res = await got.post(getUrl(path, opts.qs), {
-        ...gotOpts,
-        body: body as any,
-        headers: opts.headers,
-    });
 
-    return {
-        status: res.statusCode,
-        ...res.body,
-    };
+    const headers = await setAuthHeader(opts.user, opts.headers);
+
+    try {
+        const res = await got.post(getUrl(path, opts.qs), {
+            ...gotOpts,
+            body: body as any,
+            headers,
+        });
+
+        return {
+            status: res.statusCode,
+            ...res.body,
+        };
+    } catch (err) {
+        console.error(err);
+        throw err;
+    }
 }
 
 export async function put<Req = any, Res = any>(path: string, body: Req, opts: HttpOpts = {}): Promise<FlinkResponse<Res>> {
     validateApp();
+
+    const headers = await setAuthHeader(opts.user, opts.headers);
+
     const res = await got.put(getUrl(path, opts.qs), {
         ...gotOpts,
         body: body as any,
-        headers: opts.headers,
+        headers,
     });
     return {
         status: res.statusCode,
@@ -66,9 +93,12 @@ export async function put<Req = any, Res = any>(path: string, body: Req, opts: H
 
 export async function del<Res = any>(path: string, opts: HttpOpts = {}): Promise<FlinkResponse<Res>> {
     validateApp();
+
+    const headers = await setAuthHeader(opts.user, opts.headers);
+
     const res = await got.delete(getUrl(path, opts.qs), {
         ...gotOpts,
-        headers: opts.headers,
+        headers,
     });
     return {
         status: res.statusCode,
@@ -88,3 +118,16 @@ function getUrl(path: string, queryString?: HttpOpts["qs"]) {
     }
     return baseUrl + path;
 }
+
+async function setAuthHeader(user?: any, headers?: HttpOpts["headers"]) {
+    if (!user) return headers;
+
+    headers = headers || {};
+
+    if (!app.auth) {
+        throw new Error("Auth plugin not set, cannot use user option");
+    }
+    const token = await app.auth.createToken(user, user.roles || []);
+    headers["Authorization"] = `Bearer ${token}`;
+    return headers;
+}