datagrok-tools 4.7.4 → 4.7.5

package/bin/commands/help.js

@@ -8,10 +8,10 @@ var HELP = "\nUsage: grok <command>\n\nDatagrok's package management tool\n\nCom
 var HELP_ADD = "\nUsage: grok add <entity> <name>\n\nAdd an object template to your package:\n\ngrok add app <name>\ngrok add connection <name>\ngrok add detector <semantic-type-name>\ngrok add function [tag] <name>\ngrok add query <name>\ngrok add script [tag] <language> <name>\ngrok add view <name>\ngrok add viewer <name>\ngrok add tests\n\nPlease note that entity names may only include letters and numbers\n\nSupported languages for scripts:\njavascript, julia, node, octave, python, r\n\nAvailable tags:\npanel, init\n";
 var HELP_API = "\nUsage: grok api\n\nCreate wrapper functions for package scripts and queries\n";
 var HELP_CONFIG = "\nUsage: grok config\n\nCreate or update a configuration file\n\nOptions:\n[--reset] [--server] [--alias] [--key]\n\n--reset     Restore the default config file template\n--server    Use to add a server to the config (`grok config add --alias alias --server url --key key`)\n--alias     Use in conjunction with the `server` option to set the server name\n--key       Use in conjunction with the `server` option to set the developer key\n--default   Use in conjunction with the `server` option to set the added server as default\n";
-var HELP_CREATE = "\nUsage: grok create [name]\n\nCreate a package:\n\ngrok create         Create a package in the current working directory\ngrok create <name>  Create a package in a folder with the specified name\n\nPlease note that the package name may only include letters, numbers, underscores, or hyphens\n\nOptions:\n[--eslint] [--ide] [--js|--ts] [--jest]\n\n--eslint    Add a configuration for eslint\n--ide       Add an IDE-specific configuration for debugging (vscode)\n--js        Create a JavaScript package\n--ts        Create a TypeScript package (default)\n--jest      Add a configuration for jest\n";
+var HELP_CREATE = "\nUsage: grok create [name]\n\nCreate a package:\n\ngrok create         Create a package in the current working directory\ngrok create <name>  Create a package in a folder with the specified name\n\nPlease note that the package name may only include letters, numbers, underscores, or hyphens\n\nOptions:\n[--eslint] [--ide] [--js|--ts]\n\n--eslint    Add a configuration for eslint\n--ide       Add an IDE-specific configuration for debugging (vscode)\n--js        Create a JavaScript package\n--ts        Create a TypeScript package (default)\n";
 var HELP_PUBLISH = "\nUsage: grok publish [host]\n\nUpload a package\n\nOptions:\n[--build|--rebuild] [--debug|--release] [--key] [--suffix]\n\nRunning `grok publish` is the same as running `grok publish defaultHost --build --debug`\n";
 var HELP_CHECK = "\nUsage: grok check\n\nOptions:\n[--dir]\n\n--dir       Check all packages in a specified directory\n\nCheck package content (function signatures, import statements of external modules, etc.)\n";
-var HELP_TEST = "\nUsage: grok test\n\nOptions:\n[--host] [--csv]\n\n--host       Host alias as in the config file\n--csv        Save the test report in a CSV file\n\nRun package tests\n\nSee instructions:\nhttps://datagrok.ai/help/develop/how-to/test-packages#local-testing\n";
+var HELP_TEST = "\nUsage: grok test\n\nOptions:\n[--host] [--csv]\n\n--host           Host alias as in the config file\n--csv            Save the test report in a CSV file\n--gui            Launch graphical interface (non-headless mode)\n--skip-build     Skip the package build step\n--skip-publish   Skip the package publication step\n\nRun package tests\n\nSee instructions:\nhttps://datagrok.ai/help/develop/how-to/test-packages#local-testing\n";
 var HELP_LINK = "\nUsage: grok link\n\nLink `datagrok-api` and libraries for local development\n";
 var HELP_UNLINK = "\nUsage: grok unlink\n\nRevert `grok link`\n";
 var HELP_MIGRATE = "\nUsage: grok migrate\n\nSwitch to `grok` tools by copying your keys to the config\nfile and converting your scripts in the `package.json` file\n";

package/bin/commands/test.js

@@ -37,7 +37,7 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 
 function test(args) {
   var options = Object.keys(args).slice(1);
-  var commandOptions = ['host', 'csv'];
+  var commandOptions = ['host', 'csv', 'gui', 'skip-build', 'skip-publish'];
   var nArgs = args['_'].length;
   var curDir = process.cwd();
 
@@ -45,7 +45,7 @@ function test(args) {
 
   var confPath = _path["default"].join(grokDir, 'config.yaml');
 
-  if (nArgs > 1 || options.length > 2 || options.length > 0 && !options.every(function (op) {
+  if (nArgs > 1 || options.length > commandOptions.length || options.length > 0 && !options.every(function (op) {
     return commandOptions.includes(op);
   })) return false;
 
@@ -88,181 +88,203 @@ function test(args) {
     return false;
   }
 
-  color.info("Building package...");
-  (0, _child_process.exec)('npm run build', function (err, stdout, stderr) {
-    if (err) {
-      console.log(stdout);
-      throw err;
-    } else {
-      console.log(stdout);
-      color.warn(stderr);
-    }
+  if (args['skip-build']) {
+    if (args['skip-publish']) test();else publish(test);
+  } else {
+    build(args['skip-publish'] ? test : function () {
+      return publish(test);
+    });
+  }
+
+  function build(callback) {
+    (0, _child_process.exec)('npm run build', function (err, stdout, stderr) {
+      color.info("Building package...");
 
-    color.info("Publishing package \"".concat(process.env.TARGET_PACKAGE, "\" to ").concat(process.env.HOST, "..."));
+      if (err) {
+        console.log(stdout);
+        throw err;
+      } else {
+        console.log(stdout);
+        color.warn(stderr);
+      }
+
+      callback();
+    });
+  }
+
+  function publish(callback) {
     (0, _child_process.exec)("grok publish ".concat(process.platform === 'win32' ? '%HOST%' : '${HOST}'), function (err, stdout, stderr) {
+      color.info("Publishing package \"".concat(process.env.TARGET_PACKAGE, "\" to ").concat(process.env.HOST, "..."));
       if (err) throw err;else {
         console.log(stdout);
         color.warn(stderr);
       }
-      color.info('Starting tests...');
-      var P_START_TIMEOUT = 3600000;
-      var browser;
-      var page;
-
-      function init(timeout) {
-        return testUtils.runWithTimeout(timeout, /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee() {
-          var out;
-          return _regenerator["default"].wrap(function _callee$(_context) {
-            while (1) {
-              switch (_context.prev = _context.next) {
-                case 0:
-                  _context.next = 2;
-                  return testUtils.getBrowserPage(_puppeteer["default"]);
-
-                case 2:
-                  out = _context.sent;
-                  browser = out.browser;
-                  page = out.page;
-                  return _context.abrupt("return", 'Initialization completed.');
-
-                case 6:
-                case "end":
-                  return _context.stop();
-              }
-            }
-          }, _callee);
-        })));
-      }
+      callback();
+    });
+  }
 
-      function runTest(timeout) {
-        return testUtils.runWithTimeout(timeout, /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2() {
-          var _process$env$TARGET_P;
-
-          var targetPackage, r;
-          return _regenerator["default"].wrap(function _callee2$(_context2) {
-            while (1) {
-              switch (_context2.prev = _context2.next) {
-                case 0:
-                  targetPackage = (_process$env$TARGET_P = process.env.TARGET_PACKAGE) !== null && _process$env$TARGET_P !== void 0 ? _process$env$TARGET_P : '#{PACKAGE_NAMESPACE}';
-                  console.log("Testing ".concat(targetPackage, " package...\n"));
-                  _context2.next = 4;
-                  return page.evaluate(function (targetPackage) {
-                    return new Promise(function (resolve, reject) {
-                      window.grok.functions.eval(targetPackage + ':test()').then(function (df) {
-                        var failed = false;
-                        var skipReport = '';
-                        var passReport = '';
-                        var failReport = '';
-
-                        if (df == null) {
-                          failed = true;
-                          failReport = 'Fail reason: No package tests found';
-                          resolve({
-                            failReport: failReport,
-                            skipReport: skipReport,
-                            passReport: passReport,
-                            failed: failed
-                          });
-                        }
+  function test() {
+    color.info('Starting tests...');
+    var P_START_TIMEOUT = 3600000;
+    var browser;
+    var page;
+
+    function init(timeout) {
+      var params = Object.assign({}, testUtils.defaultLaunchParameters);
+      if (args.gui) params['headless'] = false;
+      return testUtils.runWithTimeout(timeout, /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee() {
+        var out;
+        return _regenerator["default"].wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                _context.next = 2;
+                return testUtils.getBrowserPage(_puppeteer["default"], params);
 
-                        var cStatus = df.columns.byName('success');
-                        var cSkipped = df.columns.byName('skipped');
-                        var cMessage = df.columns.byName('result');
-                        var cCat = df.columns.byName('category');
-                        var cName = df.columns.byName('name');
-                        var cTime = df.columns.byName('ms');
-
-                        for (var i = 0; i < df.rowCount; i++) {
-                          if (cStatus.get(i)) {
-                            if (cSkipped.get(i)) {
-                              skipReport += "Test result : Skipped : ".concat(cTime.get(i), " : ").concat(targetPackage, ".").concat(cCat.get(i), ".").concat(cName.get(i), " : ").concat(cMessage.get(i), "\n");
-                            } else {
-                              passReport += "Test result : Success : ".concat(cTime.get(i), " : ").concat(targetPackage, ".").concat(cCat.get(i), ".").concat(cName.get(i), " : ").concat(cMessage.get(i), "\n");
-                            }
-                          } else {
-                            failed = true;
-                            failReport += "Test result : Failed : ".concat(cTime.get(i), " : ").concat(targetPackage, ".").concat(cCat.get(i), ".").concat(cName.get(i), " : ").concat(cMessage.get(i), "\n");
-                          }
-                        }
+              case 2:
+                out = _context.sent;
+                browser = out.browser;
+                page = out.page;
+                return _context.abrupt("return", 'Initialization completed.');
 
-                        var csv = df.toCsv();
+              case 6:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee);
+      })));
+    }
+
+    function runTest(timeout) {
+      return testUtils.runWithTimeout(timeout, /*#__PURE__*/(0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2() {
+        var _process$env$TARGET_P;
+
+        var targetPackage, r;
+        return _regenerator["default"].wrap(function _callee2$(_context2) {
+          while (1) {
+            switch (_context2.prev = _context2.next) {
+              case 0:
+                targetPackage = (_process$env$TARGET_P = process.env.TARGET_PACKAGE) !== null && _process$env$TARGET_P !== void 0 ? _process$env$TARGET_P : '#{PACKAGE_NAMESPACE}';
+                console.log("Testing ".concat(targetPackage, " package...\n"));
+                _context2.next = 4;
+                return page.evaluate(function (targetPackage) {
+                  return new Promise(function (resolve, reject) {
+                    window.grok.functions.eval(targetPackage + ':test()').then(function (df) {
+                      var failed = false;
+                      var skipReport = '';
+                      var passReport = '';
+                      var failReport = '';
+
+                      if (df == null) {
+                        failed = true;
+                        failReport = 'Fail reason: No package tests found';
                         resolve({
                           failReport: failReport,
                           skipReport: skipReport,
                           passReport: passReport,
-                          failed: failed,
-                          csv: csv
+                          failed: failed
                         });
-                      })["catch"](function (e) {
-                        return reject(e);
+                      }
+
+                      var cStatus = df.columns.byName('success');
+                      var cSkipped = df.columns.byName('skipped');
+                      var cMessage = df.columns.byName('result');
+                      var cCat = df.columns.byName('category');
+                      var cName = df.columns.byName('name');
+                      var cTime = df.columns.byName('ms');
+
+                      for (var i = 0; i < df.rowCount; i++) {
+                        if (cStatus.get(i)) {
+                          if (cSkipped.get(i)) {
+                            skipReport += "Test result : Skipped : ".concat(cTime.get(i), " : ").concat(targetPackage, ".").concat(cCat.get(i), ".").concat(cName.get(i), " : ").concat(cMessage.get(i), "\n");
+                          } else {
+                            passReport += "Test result : Success : ".concat(cTime.get(i), " : ").concat(targetPackage, ".").concat(cCat.get(i), ".").concat(cName.get(i), " : ").concat(cMessage.get(i), "\n");
+                          }
+                        } else {
+                          failed = true;
+                          failReport += "Test result : Failed : ".concat(cTime.get(i), " : ").concat(targetPackage, ".").concat(cCat.get(i), ".").concat(cName.get(i), " : ").concat(cMessage.get(i), "\n");
+                        }
+                      }
+
+                      var csv = df.toCsv();
+                      resolve({
+                        failReport: failReport,
+                        skipReport: skipReport,
+                        passReport: passReport,
+                        failed: failed,
+                        csv: csv
                       });
+                    })["catch"](function (e) {
+                      return reject(e);
                     });
-                  }, targetPackage);
+                  });
+                }, targetPackage);
 
-                case 4:
-                  r = _context2.sent;
-                  return _context2.abrupt("return", r);
+              case 4:
+                r = _context2.sent;
+                return _context2.abrupt("return", r);
 
-                case 6:
-                case "end":
-                  return _context2.stop();
-              }
+              case 6:
+              case "end":
+                return _context2.stop();
             }
-          }, _callee2);
-        })));
-      }
-
-      (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee3() {
-        var initMessage, r;
-        return _regenerator["default"].wrap(function _callee3$(_context3) {
-          while (1) {
-            switch (_context3.prev = _context3.next) {
-              case 0:
-                _context3.next = 2;
-                return init(P_START_TIMEOUT);
+          }
+        }, _callee2);
+      })));
+    }
 
-              case 2:
-                initMessage = _context3.sent;
-                console.log(initMessage);
-                _context3.next = 6;
-                return runTest(7200000);
+    (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee3() {
+      var initMessage, r;
+      return _regenerator["default"].wrap(function _callee3$(_context3) {
+        while (1) {
+          switch (_context3.prev = _context3.next) {
+            case 0:
+              _context3.next = 2;
+              return init(P_START_TIMEOUT);
 
-              case 6:
-                r = _context3.sent;
+            case 2:
+              initMessage = _context3.sent;
+              console.log(initMessage);
+              _context3.next = 6;
+              return runTest(7200000);
 
-                if (r.csv && args.csv) {
-                  _fs["default"].writeFileSync(_path["default"].join(curDir, 'test-report.csv'), r.csv, 'utf8');
+            case 6:
+              r = _context3.sent;
 
-                  color.info('Saved `test-report.csv`\n');
-                }
+              if (r.csv && args.csv) {
+                _fs["default"].writeFileSync(_path["default"].join(curDir, 'test-report.csv'), r.csv, 'utf8');
 
-                if (r.passReport) console.log(r.passReport);
-                if (r.skipReport) console.log(r.skipReport);
+                color.info('Saved `test-report.csv`\n');
+              }
 
-                if (r.failed) {
-                  console.log(r.failReport);
-                  color.fail('Tests failed.');
-                } else {
-                  color.success('Tests passed.');
-                } //@ts-ignore
+              if (r.passReport) console.log(r.passReport);
+              if (r.skipReport) console.log(r.skipReport);
 
+              if (r.failed) {
+                console.log(r.failReport);
+                color.fail('Tests failed.');
+              } else {
+                color.success('Tests passed.');
+              } //@ts-ignore
 
-                if (!(browser != null)) {
-                  _context3.next = 14;
-                  break;
-                }
 
+              if (!(browser != null)) {
                 _context3.next = 14;
-                return browser.close();
+                break;
+              }
 
-              case 14:
-              case "end":
-                return _context3.stop();
-            }
+              _context3.next = 14;
+              return browser.close();
+
+            case 14:
+            case "end":
+              return _context3.stop();
           }
-        }, _callee3);
-      }))();
-    });
-  });
+        }
+      }, _callee3);
+    }))();
+  }
+
   return true;
 }

package/bin/utils/test-utils.js

@@ -7,6 +7,7 @@ var _typeof = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.defaultLaunchParameters = void 0;
 exports.getBrowserPage = getBrowserPage;
 exports.getDevKey = getDevKey;
 exports.getToken = getToken;
@@ -37,6 +38,12 @@ var grokDir = _path["default"].join(_os["default"].homedir(), '.grok');
 
 var confPath = _path["default"].join(grokDir, 'config.yaml');
 
+var defaultLaunchParameters = {
+  args: ['--disable-dev-shm-usage', '--disable-features=site-per-process'],
+  ignoreHTTPSErrors: true
+};
+exports.defaultLaunchParameters = defaultLaunchParameters;
+
 function getToken(_x, _x2) {
   return _getToken.apply(this, arguments);
 }
@@ -151,93 +158,98 @@ function _getBrowserPage() {
   _getBrowserPage = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee4(puppeteer) {
     var _process$env$HOST;
 
-    var url, cfg, key, token, browser, page;
+    var params,
+        url,
+        cfg,
+        key,
+        token,
+        browser,
+        page,
+        _args4 = arguments;
     return _regenerator["default"].wrap(function _callee4$(_context4) {
       while (1) {
         switch (_context4.prev = _context4.next) {
           case 0:
+            params = _args4.length > 1 && _args4[1] !== undefined ? _args4[1] : defaultLaunchParameters;
             url = (_process$env$HOST = process.env.HOST) !== null && _process$env$HOST !== void 0 ? _process$env$HOST : '';
             cfg = getDevKey(url);
             url = cfg.url;
             key = cfg.key;
-            _context4.next = 6;
+            _context4.next = 7;
             return getToken(url, key);
 
-          case 6:
+          case 7:
             token = _context4.sent;
-            _context4.next = 9;
+            _context4.next = 10;
             return getWebUrl(url, token);
 
-          case 9:
+          case 10:
             url = _context4.sent;
             console.log("Using web root: ".concat(url));
-            _context4.next = 13;
-            return puppeteer.launch({
-              args: ['--disable-dev-shm-usage', '--disable-features=site-per-process'],
-              ignoreHTTPSErrors: true
-            });
+            _context4.next = 14;
+            return puppeteer.launch(params);
 
-          case 13:
+          case 14:
             browser = _context4.sent;
-            _context4.next = 16;
+            _context4.next = 17;
             return browser.newPage();
 
-          case 16:
+          case 17:
             page = _context4.sent;
-            _context4.next = 19;
+            _context4.next = 20;
             return page.setDefaultNavigationTimeout(0);
 
-          case 19:
-            _context4.next = 21;
+          case 20:
+            _context4.next = 22;
             return page["goto"]("".concat(url, "/oauth/"));
 
-          case 21:
-            _context4.next = 23;
+          case 22:
+            _context4.next = 24;
             return page.setCookie({
               name: 'auth',
               value: token
             });
 
-          case 23:
-            _context4.next = 25;
+          case 24:
+            _context4.next = 26;
             return page.evaluate(function (token) {
               window.localStorage.setItem('auth', token);
             }, token);
 
-          case 25:
-            _context4.next = 27;
+          case 26:
+            _context4.next = 28;
             return page["goto"](url);
 
-          case 27:
-            _context4.prev = 27;
-            _context4.next = 30;
+          case 28:
+            _context4.prev = 28;
+            _context4.next = 31;
             return page.waitForFunction(function () {
               return document.querySelector('.grok-preloader') == null;
             }, {
               timeout: 3600000
             });
 
-          case 30:
-            _context4.next = 35;
+          case 31:
+            _context4.next = 36;
             break;
 
-          case 32:
-            _context4.prev = 32;
-            _context4.t0 = _context4["catch"](27);
+          case 33:
+            _context4.prev = 33;
+            _context4.t0 = _context4["catch"](28);
             throw _context4.t0;
 
-          case 35:
+          case 36:
             return _context4.abrupt("return", {
               browser: browser,
               page: page
             });
 
-          case 36:
+          case 37:
           case "end":
             return _context4.stop();
         }
       }
-    }, _callee4, null, [[27, 32]]);
+    }, _callee4, null, [[28, 33]]);
   }));
   return _getBrowserPage.apply(this, arguments);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datagrok-tools",
-  "version": "4.7.4",
+  "version": "4.7.5",
   "description": "Utility to upload and publish packages to Datagrok",
   "homepage": "https://github.com/datagrok-ai/public/tree/master/tools#readme",
   "dependencies": {