@flink-app/test-utils 0.2.0-beta.14 → 0.2.0-beta.17

package/dist/http.d.ts

@@ -0,0 +1,33 @@
+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.
+ * 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>>;
+export declare function post<Req = any, Res = any>(path: string, body: Req, opts?: HttpOpts): Promise<FlinkResponse<Res>>;
+export declare function put<Req = any, Res = any>(path: string, body: Req, opts?: HttpOpts): Promise<FlinkResponse<Res>>;
+export declare function del<Res = any>(path: string, opts?: HttpOpts): Promise<FlinkResponse<Res>>;

package/dist/http.js

@@ -0,0 +1,192 @@
+"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;
+    return g = { next: verb(0), "throw": verb(1), "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 };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.del = exports.put = exports.post = exports.get = exports.init = void 0;
+var got_1 = __importDefault(require("got"));
+var qs_1 = __importDefault(require("qs"));
+var app;
+var baseUrl;
+var gotOpts = {
+    throwHttpErrors: false,
+    json: true,
+    retry: 0,
+};
+/**
+ * Initializes test flink app.
+ * Must be invoked prior to using test HTTP methods.
+ */
+function init(_app, host) {
+    if (host === void 0) { host = "localhost"; }
+    app = _app;
+    baseUrl = "http://".concat(host, ":").concat(app.port);
+}
+exports.init = init;
+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*/, 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)];
+            }
+        });
+    });
+}
+exports.get = get;
+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*/, 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_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*/, 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)];
+            }
+        });
+    });
+}
+exports.put = put;
+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*/, 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)];
+            }
+        });
+    });
+}
+exports.del = del;
+function validateApp() {
+    if (!app) {
+        throw new Error("App not initialized, run `init(app)` prior to invoking get/post/put/del");
+    }
+}
+function getUrl(path, queryString) {
+    if (queryString) {
+        return baseUrl + path + "?" + qs_1.default.stringify(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/mocks.d.ts

@@ -0,0 +1,20 @@
+import { FlinkAuthPlugin, FlinkRequest } from "@flink-app/flink";
+interface TestFlinkRequest<T, P, Q> extends Omit<Partial<FlinkRequest<T, P, Q>>, "body" | "params" | "query"> {
+    body?: T;
+    params?: P;
+    query?: Q;
+}
+/**
+ * Creates a mocked FlinkRequest object where only essential properties are required.
+ * Will convert req body to JSON to ensure the body is a plain object.
+ * @param req
+ * @returns
+ */
+export declare function mockReq<T, P, Q>(req?: TestFlinkRequest<T, P, Q>): FlinkRequest<T, P, Q>;
+/**
+ * Auth plugin used for testing handlers.
+ * Will allow all requests.
+ * @returns
+ */
+export declare function noOpAuthPlugin(): FlinkAuthPlugin;
+export {};

package/dist/mocks.js

@@ -0,0 +1,84 @@
+"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;
+    return g = { next: verb(0), "throw": verb(1), "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.noOpAuthPlugin = exports.mockReq = void 0;
+/**
+ * Creates a mocked FlinkRequest object where only essential properties are required.
+ * Will convert req body to JSON to ensure the body is a plain object.
+ * @param req
+ * @returns
+ */
+function mockReq(req) {
+    var aMockReq = __assign({ get: function (headerName) { var _a; return (_a = req === null || req === void 0 ? void 0 : req.headers) === null || _a === void 0 ? void 0 : _a[headerName]; } }, (req || {}));
+    if (!req) {
+        return aMockReq;
+    }
+    req.body = req.body ? JSON.parse(JSON.stringify(req.body)) : undefined;
+    req.query = req.query || {};
+    req.params = req.params ? JSON.parse(JSON.stringify(req.params)) : {};
+    return aMockReq;
+}
+exports.mockReq = mockReq;
+/**
+ * Auth plugin used for testing handlers.
+ * Will allow all requests.
+ * @returns
+ */
+function noOpAuthPlugin() {
+    var _this = this;
+    return {
+        authenticateRequest: function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
+            return [2 /*return*/, true];
+        }); }); },
+        createToken: function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
+            return [2 /*return*/, "mock-token"];
+        }); }); },
+    };
+}
+exports.noOpAuthPlugin = noOpAuthPlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flink-app/test-utils",
-  "version": "0.2.0-beta.14",
+  "version": "0.2.0-beta.17",
   "description": "Test utils for Flink",
   "scripts": {
     "test": "echo \"Error: no test specified\"",
@@ -19,7 +19,7 @@
     "qs": "^6.7.0"
   },
   "devDependencies": {
-    "@flink-app/flink": "^0.2.0-beta.14",
+    "@flink-app/flink": "^0.2.0-beta.17",
     "@types/express": "^4.17.12",
     "@types/got": "^9.6.12",
     "@types/node": "^15.6.2",
@@ -29,5 +29,5 @@
     "tsc-watch": "^4.2.9",
     "typescript": "^4.2.4"
   },
-  "gitHead": "c8fde9f75a276c70273cb76fbf1ae6cac5c9c77f"
+  "gitHead": "76e4647bd059afadeb0070e9392c61e01a494de9"
 }