@flink-app/test-utils 0.12.1-alpha.0 → 0.12.1-alpha.10

package/dist/http.d.ts

@@ -1,15 +1,30 @@
 import { FlinkApp, FlinkResponse } from "@flink-app/flink";
-export declare type HttpOpts = {
+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

@@ -25,7 +25,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        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]) {
@@ -62,24 +62,27 @@ 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"; }
     app = _app;
-    baseUrl = "http://" + host + ":" + app.port;
+    baseUrl = "http://".concat(host, ":").concat(app.port);
 }
 exports.init = init;
-function get(path, opts) {
-    if (opts === void 0) { opts = {}; }
-    return __awaiter(this, void 0, void 0, function () {
-        var res;
+function get(path_1) {
+    return __awaiter(this, arguments, void 0, function (path, opts) {
+        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)];
             }
@@ -87,33 +90,47 @@ function get(path, opts) {
     });
 }
 exports.get = get;
-function post(path, body, opts) {
-    if (opts === void 0) { opts = {}; }
-    return __awaiter(this, void 0, void 0, function () {
-        var res;
+function post(path_1, body_1) {
+    return __awaiter(this, arguments, void 0, function (path, body, opts) {
+        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*/];
             }
         });
     });
 }
 exports.post = post;
-function put(path, body, opts) {
-    if (opts === void 0) { opts = {}; }
-    return __awaiter(this, void 0, void 0, function () {
-        var res;
+function put(path_1, body_1) {
+    return __awaiter(this, arguments, void 0, function (path, body, opts) {
+        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)];
             }
@@ -121,16 +138,19 @@ function put(path, body, opts) {
     });
 }
 exports.put = put;
-function del(path, opts) {
-    if (opts === void 0) { opts = {}; }
-    return __awaiter(this, void 0, void 0, function () {
-        var res;
+function del(path_1) {
+    return __awaiter(this, arguments, void 0, function (path, opts) {
+        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/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/mocks.js

@@ -25,7 +25,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        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]) {

package/package.json

@@ -1,10 +1,10 @@
 {
     "name": "@flink-app/test-utils",
-    "version": "0.12.1-alpha.0",
+    "version": "0.12.1-alpha.10",
     "description": "Test utils for Flink",
     "scripts": {
         "test": "echo \"Error: no test specified\"",
-        "prepublish": "tsc",
+        "prepare": "tsc",
         "build": "tsc",
         "watch": "tsc-watch"
     },
@@ -20,15 +20,15 @@
         "qs": "^6.7.0"
     },
     "devDependencies": {
-        "@flink-app/flink": "^0.12.1-alpha.0",
+        "@flink-app/flink": "^0.12.1-alpha.10",
         "@types/express": "^4.17.12",
         "@types/got": "^9.6.12",
-        "@types/node": "^15.6.2",
+        "@types/node": "22.13.10",
         "jasmine-spec-reporter": "^7.0.0",
         "nodemon": "^2.0.7",
         "ts-node": "^9.1.1",
         "tsc-watch": "^4.2.9",
-        "typescript": "^4.2.4"
+        "typescript": "5.4.5"
     },
-    "gitHead": "7f6e32aa896f5cade313f3c5133c756fc5391ce8"
+    "gitHead": "d4019c3af70673f27db4df55d56ba3728e75745e"
 }

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;
+}