zcatalyst-cli 1.17.5 → 1.18.0-beta.0

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

@@ -0,0 +1,173 @@
+"use strict";
+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 __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _TunnelServer_contextMap, _TunnelServer_server, _TunnelServer_destroyer, _TunnelServer_repel, _TunnelServer_projectId;
+Object.defineProperty(exports, "__esModule", { value: true });
+const express_1 = __importDefault(require("express"));
+const runtime_store_1 = __importDefault(require("../../runtime-store"));
+const error_1 = __importDefault(require("../../error"));
+const logger_1 = require("../../util_modules/logger");
+const port_resolver_1 = __importDefault(require("../../port-resolver"));
+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");
+class TunnelServer {
+    constructor(repel) {
+        _TunnelServer_contextMap.set(this, {});
+        _TunnelServer_server.set(this, void 0);
+        _TunnelServer_destroyer.set(this, void 0);
+        _TunnelServer_repel.set(this, void 0);
+        _TunnelServer_projectId.set(this, (0, project_1.getProjectId)());
+        __classPrivateFieldSet(this, _TunnelServer_repel, repel, "f");
+    }
+    startServer() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const tunnelPortOpt = Number.parseInt(runtime_store_1.default.get('context.port.tunnel'));
+            if (Number.isNaN(tunnelPortOpt)) {
+                return;
+            }
+            const port = yield port_resolver_1.default.getFreePort(tunnelPortOpt).catch((e) => (0, logger_1.debug)(e));
+            if (!port || tunnelPortOpt !== port) {
+                throw new error_1.default(`Port unavailable ${tunnelPortOpt}`, {
+                    exit: 1,
+                    errorId: 'TUNNEL-1',
+                    arg: [ansi_colors_1.bold.red(tunnelPortOpt + ''), (0, ansi_colors_1.bold)('--tunnel')]
+                });
+            }
+            const app = (0, express_1.default)();
+            app.use(express_1.default.json());
+            app.all('/', (req, res) => __awaiter(this, void 0, void 0, function* () {
+                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]
+                        : (() => {
+                            if (__classPrivateFieldGet(this, _TunnelServer_projectId, "f") !== body.function_details.project_id) {
+                                res.status(403);
+                                res.send();
+                                __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();
+                                __classPrivateFieldGet(this, _TunnelServer_repel, "f").write('[STATUS]');
+                                __classPrivateFieldGet(this, _TunnelServer_repel, "f").write('FORBIDDEN');
+                                return;
+                            }
+                            const namedFn = __classPrivateFieldGet(this, _TunnelServer_contextMap, "f")[body.function_details.function_name];
+                            if (namedFn) {
+                                return namedFn;
+                            }
+                            res.status(404);
+                            res.send();
+                            __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)();
+                    if (!target) {
+                        return;
+                    }
+                    const fnData = typeof body.function_data === 'string'
+                        ? JSON.parse(body.function_data)
+                        : body.function_data;
+                    target.call(false)(fnData);
+                    const errorHandler = (e) => {
+                        res.status(500);
+                        res.send();
+                        (0, logger_1.debug)('Target error: ' + e);
+                    };
+                    target.once('error', errorHandler);
+                    const response = yield new Promise((resolve, reject) => {
+                        target.once('response', (response) => {
+                            target.removeListener('error', errorHandler);
+                            if (!response.Status && !response.status) {
+                                return reject(response);
+                            }
+                            resolve(response);
+                        });
+                    });
+                    response.ContentType && res.setHeader('Content-Type', response.ContentType);
+                    res.status(response.status || 200);
+                    res.send(response.responseBody);
+                }
+                catch (e) {
+                    res.status(500);
+                    res.send();
+                    (0, logger_1.debug)(e);
+                }
+            }));
+            return new Promise((res, rej) => {
+                try {
+                    __classPrivateFieldSet(this, _TunnelServer_server, app.listen(port, 'localhost', () => {
+                        __classPrivateFieldGet(this, _TunnelServer_repel, "f").write();
+                        __classPrivateFieldGet(this, _TunnelServer_repel, "f").write((0, ansi_colors_1.bold)('Tunneling server running on port: ' + (0, ansi_colors_1.green)(port + '')));
+                        res();
+                    }), "f");
+                    __classPrivateFieldSet(this, _TunnelServer_destroyer, new server_1.ConnectionDestroyer(__classPrivateFieldGet(this, _TunnelServer_server, "f")), "f");
+                    __classPrivateFieldGet(this, _TunnelServer_server, "f").on('error', (err) => {
+                        throw new error_1.default('Tunneling server error', {
+                            original: err,
+                            exit: 2
+                        });
+                    });
+                }
+                catch (er) {
+                    rej(new error_1.default('Unable to start the tunneling server', {
+                        exit: 2,
+                        original: er
+                    }));
+                }
+            });
+        });
+    }
+    addContext(name, target) {
+        if (!__classPrivateFieldGet(this, _TunnelServer_server, "f")) {
+            return this;
+        }
+        __classPrivateFieldGet(this, _TunnelServer_contextMap, "f")[name] = target;
+        return this;
+    }
+    stopServer() {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!__classPrivateFieldGet(this, _TunnelServer_server, "f")) {
+                return;
+            }
+            return (_a = __classPrivateFieldGet(this, _TunnelServer_destroyer, "f")) === null || _a === void 0 ? void 0 : _a.destroy();
+        });
+    }
+}
+exports.default = TunnelServer;
+_TunnelServer_contextMap = new WeakMap(), _TunnelServer_server = new WeakMap(), _TunnelServer_destroyer = new WeakMap(), _TunnelServer_repel = new WeakMap(), _TunnelServer_projectId = new WeakMap();

package/lib/shell/index.js

@@ -27,7 +27,10 @@ const http_functions_1 = __importDefault(require("./dependencies/http-functions"
 const local_function_1 = __importDefault(require("./dependencies/local-function"));
 const prepare_1 = __importDefault(require("./prepare"));
 const fn_watcher_1 = __importDefault(require("../fn-watcher"));
+const tunnel_server_1 = __importDefault(require("./dependencies/tunnel-server"));
+const endpoints_1 = require("../endpoints");
 exports.default = () => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
     const replServer = new repl_server_1.default({
         prompt: 'functions > ',
         writer: (output) => {
@@ -44,6 +47,7 @@ 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]);
@@ -55,6 +59,10 @@ exports.default = () => __awaiter(void 0, void 0, void 0, function* () {
                     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;
         });
@@ -65,6 +73,33 @@ exports.default = () => __awaiter(void 0, void 0, void 0, function* () {
             });
         }
         replServer.start();
+        yield tunnelServer.startServer();
+        const tunnelUrl = runtime_store_1.default.get('context.fn_shell.enable_tunnel', undefined);
+        const _tunnelAPI = yield (0, endpoints_1.tunnelAPI)();
+        if (tunnelUrl) {
+            try {
+                yield _tunnelAPI.enableTunnel(typeof tunnelUrl === 'string' ? tunnelUrl : undefined);
+            }
+            catch (er) {
+                const _er = error_1.default.getErrorInstance(er);
+                !replServer.closed && replServer.close();
+                yield tunnelServer.stopServer();
+                if (_er.status === 400) {
+                    const data = (_a = _er.context) === null || _a === void 0 ? void 0 : _a.body.data;
+                    throw new error_1.default('Unable to enable tunnel: ' + _er.message, {
+                        exit: 1,
+                        original: _er,
+                        errorId: 'SHELL-IDX-2',
+                        arg: [ansi_colors_1.italic.red(data.message + ''), ansi_colors_1.italic.red(data.error_code + '')]
+                    });
+                }
+                throw new error_1.default('Unable to enable tunnel: ' + _er.message, {
+                    exit: 2,
+                    original: _er
+                });
+            }
+            replServer.write(ansi_colors_1.green.bold('Tunneling enabled'));
+        }
         const watchOpt = (0, option_1.getOptionValue)('watch');
         if (watchOpt === true) {
             (0, logger_js_1.info)();
@@ -75,7 +110,8 @@ exports.default = () => __awaiter(void 0, void 0, void 0, function* () {
                 yield (0, fn_watcher_1.default)(target);
             }
             const localFn = new local_function_1.default(replServer, target);
-            replServer.setContext(target.name, localFn.call);
+            replServer.setContext(target.name, localFn.call());
+            tunnelServer.addContext(target.id || target.name, localFn);
             target.localFn = localFn;
         })));
         if (runtime_store_1.default.get('context.port.http.' + constants_1.FN_TYPE.basic, false)) {
@@ -83,6 +119,23 @@ exports.default = () => __awaiter(void 0, void 0, void 0, function* () {
         }
         yield replServer.wait();
         yield httpServer.stop();
+        yield tunnelServer.stopServer().finally(() => __awaiter(void 0, void 0, void 0, function* () {
+            if (!tunnelUrl) {
+                return;
+            }
+            try {
+                const tunnelDetails = yield _tunnelAPI.getTunnel();
+                if (tunnelDetails.tunnel_status === 'Enabled') {
+                    yield _tunnelAPI.disableTunnel();
+                    (0, logger_js_1.info)();
+                    (0, logger_js_1.info)(ansi_colors_1.green.bold('Tunneling disabled'));
+                }
+            }
+            catch (er) {
+                (0, logger_js_1.error)('Error disabling the tunnel');
+                (0, logger_js_1.debug)(er);
+            }
+        }));
         yield Promise.all(targets.map((target) => __awaiter(void 0, void 0, void 0, function* () {
             if (target.localFn) {
                 return target.localFn.shutdown();
@@ -94,6 +147,7 @@ exports.default = () => __awaiter(void 0, void 0, void 0, function* () {
         (0, logger_js_1.success)('shell complete');
     }
     catch (e) {
+        !replServer.closed && replServer.close();
         yield Promise.all([
             fs_1.ASYNC.deleteDir((0, path_1.join)(projectRoot, constants_1.FOLDERNAME.build)).catch(),
             httpServer ? httpServer.stop() : undefined

package/lib/util_modules/constants/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ENVPATH = exports.RUNTIME = exports.IAC = exports.PLUGIN = exports.ORIGIN = exports.TEMPLATE = exports.SCOPE = exports.REMOTE_REF = exports.REGEX = exports.REFERENCE = exports.PLACEHOLDER = exports.INTEG = exports.FOLDERNAME = exports.FN_TYPE = exports.DC_TYPE = exports.FILENAME = exports.EVENT_SOURCE = exports.EVENT_REF = exports.DEFAULT = exports.CLIQ = exports.AUTH = exports.APIG_RULES = void 0;
+exports.NEEDED_SCOPES = exports.ENVPATH = exports.RUNTIME = exports.IAC = exports.PLUGIN = exports.ORIGIN = exports.TEMPLATE = exports.SCOPE = exports.REMOTE_REF = exports.REGEX = exports.REFERENCE = exports.PLACEHOLDER = exports.INTEG = exports.FOLDERNAME = exports.FN_TYPE = exports.DC_TYPE = exports.FILENAME = exports.EVENT_SOURCE = exports.EVENT_REF = exports.DEFAULT = exports.CLIQ = exports.AUTH = exports.APIG_RULES = void 0;
 var apig_rules_1 = require("./lib/apig-rules");
 Object.defineProperty(exports, "APIG_RULES", { enumerable: true, get: function () { return __importDefault(apig_rules_1).default; } });
 var auth_1 = require("./lib/auth");
@@ -48,3 +48,5 @@ var runtime_1 = require("./lib/runtime");
 Object.defineProperty(exports, "RUNTIME", { enumerable: true, get: function () { return __importDefault(runtime_1).default; } });
 var env_path_1 = require("./lib/env-path");
 Object.defineProperty(exports, "ENVPATH", { enumerable: true, get: function () { return __importDefault(env_path_1).default; } });
+var needed_scopes_1 = require("./lib/needed-scopes");
+Object.defineProperty(exports, "NEEDED_SCOPES", { enumerable: true, get: function () { return __importDefault(needed_scopes_1).default; } });

package/lib/util_modules/constants/lib/needed-scopes.js

@@ -0,0 +1,52 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const scopes_1 = __importDefault(require("./scopes"));
+exports.default = Object.freeze({
+    SERVE: [
+        scopes_1.default.api_read,
+        scopes_1.default.apig_read,
+        scopes_1.default.segment,
+        scopes_1.default.cache_read,
+        scopes_1.default.cache_create,
+        scopes_1.default.cache_delete,
+        scopes_1.default.projects,
+        scopes_1.default.cron,
+        scopes_1.default.zcql,
+        scopes_1.default.project_user_read,
+        scopes_1.default.project_user_create,
+        scopes_1.default.project_user_delete,
+        scopes_1.default.project_user_update,
+        scopes_1.default.email_send,
+        scopes_1.default.datastore,
+        scopes_1.default.row,
+        scopes_1.default.column,
+        scopes_1.default.bulk_create,
+        scopes_1.default.bulk_read,
+        scopes_1.default.folders,
+        scopes_1.default.file_create,
+        scopes_1.default.file_read,
+        scopes_1.default.file_delete,
+        scopes_1.default.functions,
+        scopes_1.default.functions_execution,
+        scopes_1.default.event_listeners,
+        scopes_1.default.event_produce,
+        scopes_1.default.security_read,
+        scopes_1.default.security_update,
+        scopes_1.default.notification_mobile,
+        scopes_1.default.notification_web,
+        scopes_1.default.search_read,
+        scopes_1.default.zia,
+        scopes_1.default.quick_ml,
+        scopes_1.default.pdf_shot,
+        scopes_1.default.dataverse,
+        scopes_1.default.circuits_exe_delete,
+        scopes_1.default.circuits_exe_read,
+        scopes_1.default.circuits_execute,
+        scopes_1.default.appsail_read,
+        scopes_1.default.nosql_table,
+        scopes_1.default.nosql_rows
+    ]
+});

package/lib/util_modules/constants/lib/scopes.js

@@ -27,12 +27,15 @@ exports.default = Object.freeze({
     project_user_create: 'ZohoCatalyst.projects.users.CREATE',
     project_user_delete: 'ZohoCatalyst.projects.users.DELETE',
     project_user_update: 'ZohoCatalyst.projects.users.UPDATE',
+    custom_token_generation: 'ZohoCatalyst.authentication.CREATE',
     email_send: 'ZohoCatalyst.email.CREATE',
     datastore: 'ZohoCatalyst.tables.ALL',
     row: 'ZohoCatalyst.tables.rows.ALL',
     column: 'ZohoCatalyst.tables.columns.ALL',
     bulk_read: 'ZohoCatalyst.tables.bulk.READ',
     bulk_create: 'ZohoCatalyst.tables.bulk.CREATE',
+    nosql_table: 'ZohoCatalyst.nosql.READ',
+    nosql_rows: 'ZohoCatalyst.nosql.rows.ALL',
     folders: 'ZohoCatalyst.folders.ALL',
     file_create: 'ZohoCatalyst.files.CREATE',
     file_read: 'ZohoCatalyst.files.READ',
@@ -58,6 +61,8 @@ exports.default = Object.freeze({
     appsail_create: 'ZohoCatalyst.appsail.Create',
     appsail_update: 'ZohoCatalyst.appsail.Update',
     appsail_delete: 'ZohoCatalyst.appsail.Delete',
+    tunneling_read: 'ZohoCatalyst.tunneling.READ',
+    tunneling_update: 'ZohoCatalyst.tunneling.UPDATE',
     iam_profile: 'AaaServer.profile.READ',
     stratus_create: 'Stratus.sdkop.CREATE',
     stratus_read: 'Stratus.sdkop.READ'

package/lib/util_modules/constants/lib/urls.js

@@ -34,6 +34,13 @@ class URL {
         }
         return URL._app.replace('.com', dc.ext);
     }
+    static get appSailDomain() {
+        const dc = (0, dc_js_1.getActiveDCType)();
+        if (dc === undefined) {
+            return URL._appSailDomain;
+        }
+        return URL._appSailDomain.replace('.com', dc.ext);
+    }
     static get catalystStatic() {
         const dc = (0, dc_js_1.getActiveDCType)();
         if (dc === undefined) {
@@ -59,6 +66,7 @@ exports.default = URL;
 URL._auth = (0, env_js_1.envOverride)('CATALYST_AUTH_URL', 'https://accounts.zoho.com');
 URL._admin = (0, env_js_1.envOverride)('CATALYST_ADMIN_URL', 'https://api.catalyst.zoho.com');
 URL._app = (0, env_js_1.envOverride)('CATALYST_APP_URL', 'https://catalystserverless.com');
+URL._appSailDomain = (0, env_js_1.envOverride)('CATALYST_APPSAIL_URL', 'https://catalystappsail.com');
 URL._zohoStatic = (0, env_js_1.envOverride)('ZOHO_STATIC', 'https://www.zoho.com/catalyst');
 URL._console = (0, env_js_1.envOverride)('CATALYST_CONSOLE_URL', 'https://console.catalyst.zoho.com');
 URL.zohoCDN = (0, env_js_1.envOverride)('ZOHO_CDN', 'https://static.zohocdn.com');

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "zcatalyst-cli",
-	"version": "1.17.5",
+	"version": "1.18.0-beta.0",
 	"description": "Command Line Tool for CATALYST",
 	"main": "./lib/index.js",
 	"bin": {
@@ -71,7 +71,7 @@
 		"@types/jest": "^27.4.1",
 		"@types/lodash": "^4.14.182",
 		"@types/minimatch": "^5.1.2",
-		"@types/node": "^17.0.25",
+		"@types/node": "^20.12.7",
 		"@types/request": "^2.48.8",
 		"@types/semver": "^7.3.9",
 		"@types/update-notifier": "^5.1.0",
@@ -87,7 +87,7 @@
 		"npm-run-all": "^4.1.5",
 		"prettier": "^2.6.2",
 		"ts-jest": "^27.1.4",
-		"typescript": "^4.6.3"
+		"typescript": "^4.9.5"
 	},
 	"scripts": {
 		"build": "gulp build",