@flink-app/flink 0.4.6 → 0.4.7

package/dist/src/FlinkApp.d.ts

@@ -107,6 +107,11 @@ export interface FlinkOptions {
          */
         enabled?: boolean;
     };
+    /**
+     * If true, the HTTP server will be disabled.
+     * Only useful when starting a Flink app for testing purposes.
+     */
+    disableHttpServer?: boolean;
 }
 export interface HandlerConfig {
     schema?: {
@@ -145,6 +150,7 @@ export declare class FlinkApp<C extends FlinkContext> {
     private routingConfigured;
     private jsonOptions?;
     private schedulingOptions?;
+    private disableHttpServer;
     private repos;
     /**
      * Internal cache used to track registered handlers and potentially any overlapping routes

package/dist/src/FlinkApp.js

@@ -93,6 +93,7 @@ var FlinkApp = /** @class */ (function () {
         this.debug = false;
         this.plugins = [];
         this.routingConfigured = false;
+        this.disableHttpServer = false;
         this.repos = {};
         /**
          * Internal cache used to track registered handlers and potentially any overlapping routes
@@ -108,6 +109,7 @@ var FlinkApp = /** @class */ (function () {
         this.auth = opts.auth;
         this.jsonOptions = opts.jsonOptions || { limit: "1mb" };
         this.schedulingOptions = opts.scheduling;
+        this.disableHttpServer = !!opts.disableHttpServer;
     }
     Object.defineProperty(FlinkApp.prototype, "ctx", {
         get: function () {
@@ -146,13 +148,18 @@ var FlinkApp = /** @class */ (function () {
                         if (this.isSchedulingEnabled) {
                             this.scheduler = new toad_scheduler_1.ToadScheduler();
                         }
-                        this.expressApp = express_1.default();
-                        this.expressApp.use(cors_1.default(this.corsOpts));
-                        this.expressApp.use(body_parser_1.default.json(this.jsonOptions));
-                        this.expressApp.use(function (req, res, next) {
-                            req.reqId = uuid_1.v4();
-                            next();
-                        });
+                        else {
+                            FlinkLog_1.log.info("🚫 Scheduling is disabled");
+                        }
+                        if (!this.disableHttpServer) {
+                            this.expressApp = express_1.default();
+                            this.expressApp.use(cors_1.default(this.corsOpts));
+                            this.expressApp.use(body_parser_1.default.json(this.jsonOptions));
+                            this.expressApp.use(function (req, res, next) {
+                                req.reqId = uuid_1.v4();
+                                next();
+                            });
+                        }
                         _i = 0, _b = this.plugins;
                         _c.label = 3;
                     case 3:
@@ -196,15 +203,23 @@ var FlinkApp = /** @class */ (function () {
                         // Register 404 with slight delay to allow all manually added routes to be added
                         // TODO: Is there a better solution to force this handler to always run last?
                         setTimeout(function () {
-                            _this.expressApp.use(function (req, res, next) {
-                                res.status(404).json(FlinkErrors_1.notFound());
-                            });
+                            if (!_this.disableHttpServer) {
+                                _this.expressApp.use(function (req, res, next) {
+                                    res.status(404).json(FlinkErrors_1.notFound());
+                                });
+                            }
                             _this.routingConfigured = true;
                         });
-                        (_a = this.expressApp) === null || _a === void 0 ? void 0 : _a.listen(this.port, function () {
-                            FlinkLog_1.log.fontColorLog("magenta", "\u26A1\uFE0F HTTP server '" + _this.name + "' is running and waiting for connections on " + _this.port);
-                            _this.started = true;
-                        });
+                        if (this.disableHttpServer) {
+                            FlinkLog_1.log.info("🚧 HTTP server is disabled, but flink app is running");
+                            this.started = true;
+                        }
+                        else {
+                            (_a = this.expressApp) === null || _a === void 0 ? void 0 : _a.listen(this.port, function () {
+                                FlinkLog_1.log.fontColorLog("magenta", "\u26A1\uFE0F HTTP server '" + _this.name + "' is running and waiting for connections on " + _this.port);
+                                _this.started = true;
+                            });
+                        }
                         return [2 /*return*/, this];
                 }
             });
@@ -258,13 +273,15 @@ var FlinkApp = /** @class */ (function () {
         this.handlers.push(handlerConfig);
         var routeProps = handlerConfig.routeProps, _a = handlerConfig.schema, schema = _a === void 0 ? {} : _a;
         var method = routeProps.method;
-        var app = this.expressApp;
         if (!method) {
             FlinkLog_1.log.error("Route " + routeProps.path + " is missing http method");
         }
         if (method) {
             var methodAndRoute_1 = method.toUpperCase() + " " + routeProps.path;
-            app[method](routeProps.path, function (req, res) { return __awaiter(_this, void 0, void 0, function () {
+            if (this.disableHttpServer) {
+                return;
+            }
+            this.expressApp[method](routeProps.path, function (req, res) { return __awaiter(_this, void 0, void 0, function () {
                 var validate, valid, data, handlerRes, err_1, validate, valid;
                 return __generator(this, function (_a) {
                     switch (_a.label) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@flink-app/flink",
-    "version": "0.4.6",
+    "version": "0.4.7",
     "description": "Typescript only framework for creating REST-like APIs on top of Express and mongodb",
     "types": "dist/src/index.d.ts",
     "main": "dist/src/index.js",
@@ -65,5 +65,5 @@
         "rimraf": "^3.0.2",
         "ts-node": "^9.1.1"
     },
-    "gitHead": "fc4e2f5febd2b8594d3ade42beb4e85eb7ada4ed"
+    "gitHead": "b565d5987e08ba3aba3653325e935e6c56cab24c"
 }

package/src/FlinkApp.ts

@@ -162,6 +162,12 @@ export interface FlinkOptions {
         //      */
         //     autoAssignCollection?: string;
     };
+
+    /**
+     * If true, the HTTP server will be disabled.
+     * Only useful when starting a Flink app for testing purposes.
+     */
+    disableHttpServer?: boolean;
 }
 
 export interface HandlerConfig {
@@ -203,6 +209,7 @@ export class FlinkApp<C extends FlinkContext> {
     private routingConfigured = false;
     private jsonOptions?: OptionsJson;
     private schedulingOptions?: FlinkOptions["scheduling"];
+    private disableHttpServer = false;
 
     private repos: { [x: string]: FlinkRepo<C> } = {};
 
@@ -224,6 +231,7 @@ export class FlinkApp<C extends FlinkContext> {
         this.auth = opts.auth;
         this.jsonOptions = opts.jsonOptions || { limit: "1mb" };
         this.schedulingOptions = opts.scheduling;
+        this.disableHttpServer = !!opts.disableHttpServer;
     }
 
     get ctx() {
@@ -253,18 +261,22 @@ export class FlinkApp<C extends FlinkContext> {
 
         if (this.isSchedulingEnabled) {
             this.scheduler = new ToadScheduler();
+        } else {
+            log.info("🚫 Scheduling is disabled");
         }
 
-        this.expressApp = express();
+        if (!this.disableHttpServer) {
+            this.expressApp = express();
 
-        this.expressApp.use(cors(this.corsOpts));
+            this.expressApp.use(cors(this.corsOpts));
 
-        this.expressApp.use(bodyParser.json(this.jsonOptions));
+            this.expressApp.use(bodyParser.json(this.jsonOptions));
 
-        this.expressApp.use((req, res, next) => {
-            req.reqId = v4();
-            next();
-        });
+            this.expressApp.use((req, res, next) => {
+                req.reqId = v4();
+                next();
+            });
+        }
 
         // TODO: Add better more fine grained control when plugins are initialized, i.e. in what order
 
@@ -301,18 +313,24 @@ export class FlinkApp<C extends FlinkContext> {
         // Register 404 with slight delay to allow all manually added routes to be added
         // TODO: Is there a better solution to force this handler to always run last?
         setTimeout(() => {
-            this.expressApp!.use((req, res, next) => {
-                res.status(404).json(notFound());
-            });
+            if (!this.disableHttpServer) {
+                this.expressApp!.use((req, res, next) => {
+                    res.status(404).json(notFound());
+                });
+            }
 
             this.routingConfigured = true;
         });
 
-        this.expressApp?.listen(this.port, () => {
-            log.fontColorLog("magenta", `⚡️ HTTP server '${this.name}' is running and waiting for connections on ${this.port}`);
-
+        if (this.disableHttpServer) {
+            log.info("🚧 HTTP server is disabled, but flink app is running");
             this.started = true;
-        });
+        } else {
+            this.expressApp?.listen(this.port, () => {
+                log.fontColorLog("magenta", `⚡️ HTTP server '${this.name}' is running and waiting for connections on ${this.port}`);
+                this.started = true;
+            });
+        }
 
         return this;
     }
@@ -381,7 +399,6 @@ export class FlinkApp<C extends FlinkContext> {
 
         const { routeProps, schema = {} } = handlerConfig;
         const { method } = routeProps;
-        const app = this.expressApp!;
 
         if (!method) {
             log.error(`Route ${routeProps.path} is missing http method`);
@@ -390,7 +407,11 @@ export class FlinkApp<C extends FlinkContext> {
         if (method) {
             const methodAndRoute = `${method.toUpperCase()} ${routeProps.path}`;
 
-            app[method](routeProps.path, async (req, res) => {
+            if (this.disableHttpServer) {
+                return;
+            }
+
+            this.expressApp![method](routeProps.path, async (req, res) => {
                 if (routeProps.permissions) {
                     if (!(await this.authenticate(req, routeProps.permissions))) {
                         return res.status(401).json(unauthorized());