zcatalyst-cli 1.18.0-beta.1 → 1.18.0-beta.3

package/lib/shell/dependencies/tunnel-server.js

@@ -33,6 +33,7 @@ const server_1 = require("../../util_modules/server");
 const ansi_colors_1 = require("ansi-colors");
 const util_1 = require("util");
 const project_1 = require("../../util_modules/project");
+const endpoints_1 = require("../../endpoints");
 class TunnelServer {
     constructor(repel) {
         _TunnelServer_contextMap.set(this, {});
@@ -42,6 +43,29 @@ class TunnelServer {
         _TunnelServer_projectId.set(this, (0, project_1.getProjectId)());
         __classPrivateFieldSet(this, _TunnelServer_repel, repel, "f");
     }
+    isAsyncFn(fnType) {
+        switch (fnType) {
+            case 'cron':
+            case 'event':
+            case 'job': {
+                return true;
+            }
+        }
+        return false;
+    }
+    send(req, res, status = 200, data, contentType) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const body = req.body;
+            if (this.isAsyncFn(body.function_details.function_type)) {
+                const tunnelAPI = yield (0, endpoints_1.tunnelAPI)();
+                yield tunnelAPI.tunnelCallback(status, body.default, data);
+                return;
+            }
+            contentType && res.contentType(contentType);
+            res.status(status);
+            res.send(data);
+        });
+    }
     startServer() {
         return __awaiter(this, void 0, void 0, function* () {
             const tunnelPortOpt = Number.parseInt(runtime_store_1.default.get('context.port.tunnel'));
@@ -59,23 +83,33 @@ class TunnelServer {
             const app = (0, express_1.default)();
             app.use(express_1.default.json());
             app.all('/', (req, res) => __awaiter(this, void 0, void 0, function* () {
+                if (req.method !== 'POST') {
+                    res.status(200);
+                    res.send();
+                    return;
+                }
+                const body = req.body;
+                if (!body.function_details ||
+                    !body.function_data ||
+                    (body.function_details.function_type !== 'integration' && !body.default)) {
+                    res.status(400);
+                    res.send();
+                    __classPrivateFieldGet(this, _TunnelServer_repel, "f").write();
+                    __classPrivateFieldGet(this, _TunnelServer_repel, "f").write('Invalid tunnel request: ' + (0, util_1.inspect)(body));
+                    return;
+                }
+                if (this.isAsyncFn(body.function_details.function_type)) {
+                    res.status(200);
+                    res.send();
+                }
                 try {
-                    const body = req.body;
-                    if (!body.function_details || !body.function_data) {
-                        res.status(400);
-                        res.send();
-                        __classPrivateFieldGet(this, _TunnelServer_repel, "f").write();
-                        __classPrivateFieldGet(this, _TunnelServer_repel, "f").write('Invalid tunnel request: ' + (0, util_1.inspect)(body));
-                        return;
-                    }
                     __classPrivateFieldGet(this, _TunnelServer_repel, "f").write();
                     __classPrivateFieldGet(this, _TunnelServer_repel, "f").write((0, ansi_colors_1.bold)(`Received tunnel request from ${body.function_details.function_name}(${body.function_details.function_id})`));
                     const target = body.function_details.function_id in __classPrivateFieldGet(this, _TunnelServer_contextMap, "f")
                         ? __classPrivateFieldGet(this, _TunnelServer_contextMap, "f")[body.function_details.function_id]
-                        : (() => {
+                        : yield (() => __awaiter(this, void 0, void 0, function* () {
                             if (__classPrivateFieldGet(this, _TunnelServer_projectId, "f") !== body.function_details.project_id) {
-                                res.status(403);
-                                res.send();
+                                yield this.send(req, res, 403);
                                 __classPrivateFieldGet(this, _TunnelServer_repel, "f").write();
                                 __classPrivateFieldGet(this, _TunnelServer_repel, "f").write('Invalid access: the tunnel is trying to access the functions from a different project');
                                 __classPrivateFieldGet(this, _TunnelServer_repel, "f").write();
@@ -87,15 +121,14 @@ class TunnelServer {
                             if (namedFn) {
                                 return namedFn;
                             }
-                            res.status(404);
-                            res.send();
+                            yield this.send(req, res, 404);
                             __classPrivateFieldGet(this, _TunnelServer_repel, "f").write();
                             __classPrivateFieldGet(this, _TunnelServer_repel, "f").write(`The tunneled function ${(0, ansi_colors_1.bold)(body.function_details.function_name)} is not present in local project directory`);
                             __classPrivateFieldGet(this, _TunnelServer_repel, "f").write();
                             __classPrivateFieldGet(this, _TunnelServer_repel, "f").write('[STATUS]');
                             __classPrivateFieldGet(this, _TunnelServer_repel, "f").write('NOT_FOUND');
                             return;
-                        }).bind(this)();
+                        })).bind(this)();
                     if (!target) {
                         return;
                     }
@@ -103,11 +136,10 @@ class TunnelServer {
                         ? JSON.parse(body.function_data)
                         : body.function_data;
                     target.call(false)(fnData);
-                    const errorHandler = (e) => {
-                        res.status(500);
-                        res.send();
+                    const errorHandler = (e) => __awaiter(this, void 0, void 0, function* () {
+                        yield this.send(req, res, 500);
                         (0, logger_1.debug)('Target error: ' + e);
-                    };
+                    });
                     target.once('error', errorHandler);
                     const response = yield new Promise((resolve, reject) => {
                         target.once('response', (response) => {
@@ -118,13 +150,10 @@ class TunnelServer {
                             resolve(response);
                         });
                     });
-                    response.ContentType && res.setHeader('Content-Type', response.ContentType);
-                    res.status(response.status || 200);
-                    res.send(response.responseBody);
+                    yield this.send(req, res, response.status, response.responseBody, response.ContentType);
                 }
                 catch (e) {
-                    res.status(500);
-                    res.send();
+                    yield this.send(req, res, 500);
                     (0, logger_1.debug)(e);
                 }
             }));

package/lib/shell/index.js

@@ -49,35 +49,29 @@ exports.default = () => __awaiter(void 0, void 0, void 0, function* () {
     const httpServer = new http_functions_1.default({ repl: replServer });
     const tunnelServer = new tunnel_server_1.default(replServer);
     const projectRoot = runtime_store_1.default.get('project.root');
-    try {
-        yield (0, prepare_1.default)([
-            constants_1.FN_TYPE.basic,
-            constants_1.FN_TYPE.cron,
-            constants_1.FN_TYPE.event,
-            constants_1.FN_TYPE.integration,
-            constants_1.FN_TYPE.job
-        ]);
-        const targets = runtime_store_1.default
-            .get('context.functions.targets', [])
-            .filter((target) => {
-            if (!target.valid) {
-                (0, logger_js_1.warning)('target [' +
-                    target.name +
-                    '] is not a valid one reason : ' +
-                    target.failure_reason);
-                Array.isArray(target.compilationError) &&
-                    target.compilationError.forEach((er) => (0, logger_js_1.error)(er));
-                Array.isArray(target.compilationWarning) &&
-                    target.compilationWarning.forEach((warn) => (0, logger_js_1.warning)(warn));
-            }
-            return target.valid;
-        });
-        if (targets.length === 0) {
-            throw new error_1.default('No functions are ready for serving', {
-                exit: 0,
-                errorId: 'SHELL-IDX-1'
-            });
+    yield (0, prepare_1.default)([constants_1.FN_TYPE.basic, constants_1.FN_TYPE.cron, constants_1.FN_TYPE.event, constants_1.FN_TYPE.integration, constants_1.FN_TYPE.job]);
+    const targets = runtime_store_1.default
+        .get('context.functions.targets', [])
+        .filter((target) => {
+        if (!target.valid) {
+            (0, logger_js_1.warning)('target [' +
+                target.name +
+                '] is not a valid one reason : ' +
+                target.failure_reason);
+            Array.isArray(target.compilationError) &&
+                target.compilationError.forEach((er) => (0, logger_js_1.error)(er));
+            Array.isArray(target.compilationWarning) &&
+                target.compilationWarning.forEach((warn) => (0, logger_js_1.warning)(warn));
         }
+        return target.valid;
+    });
+    if (targets.length === 0) {
+        throw new error_1.default('No functions are ready for serving', {
+            exit: 0,
+            errorId: 'SHELL-IDX-1'
+        });
+    }
+    try {
         replServer.start();
         yield tunnelServer.startServer();
         const tunnelUrl = runtime_store_1.default.get('context.fn_shell.enable_tunnel', undefined);

package/lib/util_modules/config/lib/appsail.js

@@ -26,6 +26,8 @@ function validateConfig(source, configJson) {
             reason: 'Config file is empty'
         };
     }
+    const sourcePath = (0, path_1.join)((0, project_1.getProjectRoot)(), source);
+    configJson.raw.source_path = sourcePath;
     if (configJson.buildPath || configJson.build_path) {
         const buildPath = configJson.build_path || configJson.buildPath;
         if (!buildPath) {
@@ -34,14 +36,9 @@ function validateConfig(source, configJson) {
                 reason: 'Build Path not present'
             };
         }
-        const absolutePath = (0, path_1.isAbsolute)(buildPath) ? buildPath : (0, path_1.resolve)(source, buildPath);
-        if (!fs_1.SYNC.pathExists(absolutePath)) {
-            return {
-                valid: false,
-                reason: 'Build Path does not exists'
-            };
-        }
+        const absolutePath = (0, path_1.isAbsolute)(buildPath) ? buildPath : (0, path_1.resolve)(sourcePath, buildPath);
         configJson.build_path = absolutePath;
+        configJson.raw.build_path = buildPath;
     }
     if (configJson.catalyst_auth === true) {
         if (configJson.login_redirect === undefined) {
@@ -78,7 +75,11 @@ function raw(throwError = false) {
         }
         return;
     }
-    return config.get('appsail');
+    const appsailConfig = config.get('appsail');
+    return appsailConfig === null || appsailConfig === void 0 ? void 0 : appsailConfig.map((_conf) => {
+        _conf.source = (0, path_1.isAbsolute)(_conf.source) ? _conf.source : (0, path_1.normalize)(_conf.source);
+        return _conf;
+    });
 }
 exports.raw = raw;
 function getTargetDetails(name) {
@@ -123,6 +124,7 @@ function getAllTargetDetails(throwErr = true) {
             resArr.push(new Promise((res) => __awaiter(this, void 0, void 0, function* () {
                 try {
                     const configJson = yield fs_1.ASYNC.readJSONFile(catalystConfigPth);
+                    configJson && (configJson.raw = {});
                     const validity = validateConfig(target.source, configJson);
                     return res(Object.assign({ config: configJson, validity }, target));
                 }

package/lib/util_modules/fs/lib/async.js

@@ -99,8 +99,13 @@ function walk(dir, { filter = {
             const isEntryPthDir = entryPathStats.isDirectory() && !entryPathStats.isSymbolicLink();
             let excludeMatch = false;
             if (!(isEntryPthDir && !filter.excludeDir)) {
-                for (const glob of filter.exclude || []) {
-                    excludeMatch = excludeMatch || (0, minimatch_1.default)(entryPath, glob);
+                if (typeof filter.exclude === 'function') {
+                    excludeMatch = excludeMatch || (yield filter.exclude(entryPath));
+                }
+                else if (Array.isArray(filter.exclude)) {
+                    for (const glob of filter.exclude || []) {
+                        excludeMatch = excludeMatch || (0, minimatch_1.default)(entryPath, glob);
+                    }
                 }
             }
             if (excludeMatch) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "zcatalyst-cli",
-	"version": "1.18.0-beta.1",
+	"version": "1.18.0-beta.3",
 	"description": "Command Line Tool for CATALYST",
 	"main": "./lib/index.js",
 	"bin": {

package/templates/init/functions/java/job/sample.java

@@ -23,7 +23,7 @@ public class {{_CLASS_}} implements CatalystJobHandler {
 			}
 			LOGGER.log(Level.SEVERE, "Project Details " + request.getProjectDetails().toString());
 			ZCCache.getInstance().putCacheValue("JobSample", "Working", 1l);
-			LOGGER.log(Level.SEVERE, "Inserted SucessFully:)");
+			LOGGER.log(Level.SEVERE, "Inserted SuccessFully:)");
 		} catch (Exception e) {
 			LOGGER.log(Level.SEVERE, "Exception in Job Function", e);
 			return JOB_STATUS.FAILURE;

package/templates/init/functions/node/aio/sample.js

@@ -1,5 +1,12 @@
 'use strict';
 
+const { IncomingMessage, ServerResponse } = require("http");
+
+/**
+ * 
+ * @param {IncomingMessage} req 
+ * @param {ServerResponse} res 
+ */
 module.exports = (req, res) => {
 	var url = req.url;
 

package/templates/init/functions/node/bio/sample.js

@@ -1,3 +1,8 @@
+/**
+ * 
+ * @param {import('./types/basicio').Context} context 
+ * @param {import('./types/basicio').BasicIO} basicIO 
+ */
 module.exports = (context, basicIO) => {
 	/* 
         BASICIO FUNCTIONALITIES

package/templates/init/functions/node/bio/types/basicio.d.ts

@@ -0,0 +1,57 @@
+/**
+ * This is a utility file with the type declaration of the BasicIO function parameters
+ */
+
+/**
+ * Type of the BasicIO object. Contains the functional APIs of BasicIO
+ */
+export interface BasicIO {
+    /**
+     * Write to the BasicIO output
+     * @param value input string
+     * @returns 
+     */
+    write: (value: string) => void;
+    /**
+     * Set the BasicIO status code
+     * @param statusCode status code of BasicIO
+     * @returns 
+     */
+    setStatus: (statusCode: number) => void;
+    /**
+     * Get the input argument values of the BasicIO
+     * @param key argument name(key)
+     * @returns argument value as string
+     */
+    getArgument: (key: string) => string;
+    /**
+     * Get all input arguments
+     * @returns all arguments as key value pair
+     */
+    getAllArguments: () => Record<string, string>;
+}
+
+/**
+ * Type of the context object of the function
+ */
+export interface Context {
+    /**
+     * Contains catalyst auth headers (for internal use)
+     */
+    catalystHeaders: Record<string, string>;
+    /**
+     * To indicate the end of a function execution
+     * @returns 
+     */
+    close: () => void;
+    /**
+     * Fetch the remaining execution time of the function
+     * @returns remaining execution time in milliseconds
+     */
+    getRemainingExecutionTimeMs: () => number;
+    /**
+     * Fetch the maximum execution time of the function
+     * @returns maximum execution time in milliseconds
+     */
+    getMaxExecutionTimeMs: () => number;
+}

package/templates/init/functions/node/cron/sample.js

@@ -1,3 +1,8 @@
+/**
+ * 
+ * @param {import('./types/cron').CronDetails} cronDetails 
+ * @param {import('./types/cron').Context} context 
+ */
 module.exports = (cronDetails, context) => {
 	console.log('Hello from {{_MAIN_}}');
 

package/templates/init/functions/node/cron/types/cron.d.ts

@@ -0,0 +1,64 @@
+/**
+ * This is a utility file with the type declaration of the Cron function parameters
+ */
+
+/**
+ * Type of Cron Details object. Contains the details of the scheduled cron
+ */
+export interface CronDetails {
+    /**
+     * Get the input param value of the Cron function
+     * @returns input param value
+     */
+    getCronParam: () => string;
+    /**
+     * Get all input params of the Cron function
+     * @returns all input params as key value pairs
+     */ 
+    getAllCronParam: () => Record<string, string>;
+    /**
+     * Get the remaining execution count of the cron job
+     * @returns remaining execution count
+     */
+    getRemainingExecutionCount: () => number;
+    /**
+     * Get the details of the cron which executed the function
+     * @returns cron details
+     */
+    getCronDetails: () => Record<string, unknown>;
+    /**
+     * Get the current project details
+     * @returns project details
+     */
+    getProjectDetails: () => Record<string, unknown>;
+}
+
+/**
+ * Type of the Context object of the Cron function
+ */
+export interface Context {
+    /**
+     * Contains catalyst auth headers (for internal use)
+     */
+    catalystHeaders: Record<string, string>;
+    /**
+     * Close the Cron function with success response
+     * @returns 
+     */
+    closeWithSuccess: () => void;
+    /**
+     * Close the Cron function failure response
+     * @returns 
+     */
+    closeWithFailure: () => void;
+    /**
+     * Get the remaining execution time of the Cron function
+     * @returns remaining execution time in milliseconds
+     */
+    getRemainingExecutionTimeMs: () => number;
+    /**
+     * Get the maximum possible execution time of the Cron function
+     * @returns maximum possible execution time in milliseconds
+     */
+    getMaxExecutionTimeMs: () => number;
+}

package/templates/init/functions/node/event/sample.js

@@ -1,20 +1,23 @@
+/**
+ * 
+ * @param {import('./types/event').EventDetails} event 
+ * @param {import('./types/event').Context} context 
+ */
 module.exports = (event, context) => {
 	/* 
         EVENT FUNCTIONALITIES
     */
-	// const DATA = event.data; //event data
-	// const TIME = event.time; //event occured time
+	// const DATA = event.getData(); //event data
+	// const TIME = event.getTime(); //event occurred time
 
-	// const SOURCE_DETAILS = event.getSourceDetails(); //event source details
-	// const SOURCE_ACTION = SOURCE_DETAILS.action; //(insert | fetch | invoke ...)
-	// const SOURCE_TYPE = SOURCE_DETAILS.type; //(datastore | cache | queue ...)
-	// const SOURCE_ENTITY_ID = SOURCE_DETAILS.entityId; //if type is datastore then entity id is tableid
+	// const ACTION = event.getAction(); //(insert | fetch | invoke ...)
+	// const SOURCE = event.getSource(); //(datastore | cache | queue ...)
+	// const SOURCE_ENTITY_ID = event.getSourceEntityId(); //if type is datastore then entity id is tableid
 
-	// const SOURCE_BUS_DETAILS = SOURCE_DETAILS.getBusDetails(); //event bus details
+	// const SOURCE_BUS_DETAILS = event.getBusDetails(); //event bus details
 	// const SOURCE_BUS_ID = SOURCE_BUS_DETAILS.id; //event bus id
 
 	// const PROJECT_DETAILS = event.getProjectDetails(); //event project details
-	// const FUNCTION_DETAILS = event.getFunctionDetails(); //event function details
 
 	console.log('Hello from {{_MAIN_}}');
 

package/templates/init/functions/node/event/types/event.d.ts

@@ -0,0 +1,82 @@
+/**
+ * This is a utility file with the type declaration of the Event function parameters
+ */
+
+/**
+ * Type of Event Details object. Contains the details of the triggered Event
+ */
+export interface EventDetails {
+    /**
+     * Event data
+     */
+    data: Record<string, unknown>;
+    /**
+     * Time of the event
+     */
+    time: number;
+    /**
+     * Get the project details of the event function
+     * @returns project details
+     */
+    getProjectDetails: () => Record<string, unknown>;
+    /**
+     * Functional API to get the data of the event
+     * @returns event data
+     */
+    getData: () => Record<string, unknown>;
+    /**
+     * Functional API to get the time of the event
+     * @returns event time
+     */
+    getTime: () => number;
+    /**
+     * Get the action that triggered the event
+     * @returns action
+     */
+    getAction: () => string;
+    /**
+     * Get the source of the event
+     * @returns event source
+     */
+    getSource: () => string;
+    /**
+     * Get the Id of the entity that triggered the event
+     * @returns source entity's Id
+     */
+    getSourceEntityId: () => string;
+    /**
+     * Get the details of the event bus
+     * @returns event bus details
+     */
+    getEventBusDetails: () => Record<string, unknown>;
+}
+
+/**
+ * Type of the Context object of the Event function
+ */
+export interface Context {
+    /**
+     * Contains catalyst auth headers (for internal use)
+     */
+    catalystHeaders: Record<string, string>;
+    /**
+     * Close the Event function with success response
+     * @returns 
+     */
+    closeWithSuccess: () => void;
+    /**
+     * Close the Event function failure response
+     * @returns 
+     */
+    closeWithFailure: () => void;
+    /**
+     * Get the remaining execution time of the Event function
+     * @returns remaining execution time in milliseconds
+     */
+    getRemainingExecutionTimeMs: () => number;
+    /**
+     * Get the maximum possible execution time of the Event function
+     * @returns maximum possible execution time in milliseconds
+     */
+    getMaxExecutionTimeMs: () => number;
+}

package/templates/init/functions/node/job/sample.js

@@ -15,7 +15,6 @@ module.exports = (jobRequest, context) => {
 	const projectDetails = jobRequest.getProjectDetails(); // to get the current project details
 	const jobDetails = jobRequest.getJobDetails(); // to get the current job details
 	const jobMetaDetails = jobRequest.getJobMetaDetails(); // to get the current job's meta details
-	const jobpoolDetails = jobRequest.getJobpoolDetails(); // to get the current function job pool's details
 	const getJobCapacityAttributes = jobRequest.getJobCapacityAttributes(); // to get the current jobs capacity
 	const allJobParams = jobRequest.getAllJobParams(); // to get all the parameters supplied to the job function
 	const jobParam = jobRequest.getJobParam('key'); // to get the value of a particular parameter supplied to the job function

package/templates/init/functions/node/job/types/job.d.ts

@@ -18,10 +18,6 @@ export interface JobRequest {
      * @returns Meta details of the current job
      */
     getJobMetaDetails: () => Record<string, unknown>;
-    /**
-     * @returns Job pool details of the current job
-     */
-    getJobpoolDetails: () => Record<string, unknown>;
     /**
      * @returns Capacity attributes of the current job
      */

package/templates/init/functions/python/job/sample.py

@@ -11,7 +11,6 @@ def handler(job_request, context):
     job_details = job_request.get_job_details() # get the details of the current job
     project_details = job_request.get_project_details() # get the details of the current project
     job_meta_details = job_request.get_job_meta_details() # get the job meta of the current job
-    job_pool_details = job_request.get_job_pool_details() # get the current functions job pool details
     job_capacity_attributes = job_request.get_job_capacity_attributes() # get the current jobs capacity
     all_job_params = job_request.get_all_job_params() # get all the parameters supplied to the job function
     job_param = job_request.get_job_param('key') # get the value of a particular parameter supplied to the job function