datagrok-tools 4.11.0 → 4.11.2

package/bin/commands/help.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.help = void 0;
 var HELP = "\nUsage: grok <command>\n\nDatagrok's package management tool\n\nCommands:\n    add       Add an object template\n    api       Create wrapper functions\n    check     Check package content (function signatures, etc.)\n    config    Create and manage config files\n    create    Create a package\n    init      Modify a package template\n    link      Link `datagrok-api` and libraries for local development\n    publish   Upload a package\n    test      Run package tests\n\nTo get help on a particular command, use:\n    grok <command> --help\n\nRead more about the package development workflow:\nhttps://datagrok.ai/help/develop/develop\n";
 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_INIT = "\nUsage: grok init\n\nModify a package template by adding config files for linters, IDE, etc.\n\nOptions:\n[--eslint] [--ide] [--test] [--ts]\n\n--eslint    Add a configuration for eslint\n--ide       Add an IDE-specific configuration for debugging (vscode)\n--test      Add tests support (TypeScript packages only)\n--ts        Convert a JavaScript package to TypeScript\n";
+var HELP_INIT = "\nUsage: grok init\n\nModify a package template by adding config files for linters, IDE, etc.\n\nOptions:\n[--eslint] [--ide] [--test] [--ts] [--git]\n\n--eslint    Add a configuration for eslint\n--ide       Add an IDE-specific configuration for debugging (vscode)\n--test      Add tests support (TypeScript packages only)\n--ts        Convert a JavaScript package to TypeScript\n--git       Configure GIT and install commit linting tools.\n            Read more: https://datagrok.ai/help/develop/advanced/git-policy\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] [-k | --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] [--test]\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--test      Add tests support (TypeScript packages only)\n";

package/bin/commands/init.js

@@ -10,6 +10,7 @@ var _fs = _interopRequireDefault(require("fs"));
 var _os = _interopRequireDefault(require("os"));
 var _path = _interopRequireDefault(require("path"));
 var _jsYaml = _interopRequireDefault(require("js-yaml"));
+var _child_process = require("child_process");
 var utils = _interopRequireWildcard(require("../utils/utils"));
 var color = _interopRequireWildcard(require("../utils/color-utils"));
 var _configValidator = require("../validators/config-validator");
@@ -26,8 +27,8 @@ var packageJsonPath = _path["default"].join(curDir, 'package.json');
 var tsConfigPath = _path["default"].join(curDir, 'tsconfig.json');
 var webpackConfigPath = _path["default"].join(curDir, 'webpack.config.js');
 var templateDir = _path["default"].join(_path["default"].dirname(_path["default"].dirname(__dirname)), 'package-template');
+var options = ['ide', 'eslint', 'test', 'ts', 'git'];
 function init(args) {
-  var options = ['ide', 'eslint', 'test', 'ts'];
   var nOptions = Object.keys(args).length - 1;
   var nArgs = args['_'].length;
   if (nArgs > 1 || nOptions > options.length) {
@@ -54,7 +55,29 @@ function init(args) {
     }
     if (hasUnknownOpt) return false;
   }
-  if (!utils.isPackageDir(curDir)) {
+  if (args.git) {
+    (0, _child_process.exec)('git config --global pull.rebase false && ' + 'git config --global branch.master.rebase true && ' + 'git config --global branch.main.rebase true && ' + 'git config --global rebase.autostash true', function (err, stdout, stderr) {
+      color.info('Configuring rebase pull strategy...');
+      console.log('Read more: https://datagrok.ai/help/develop/advanced/git-policy');
+      if (err) throw err;else {
+        console.log(stderr, stdout);
+        color.success('GIT successfully configured\n');
+      }
+    });
+    (0, _child_process.exec)('npm install --location=global @commitlint/config-conventional @commitlint/cli', function (err, stdout, stderr) {
+      color.info('Installing @commitlint/config-conventional and @commitlint/cli...');
+      if (err) throw err;else console.log(stderr, stdout);
+    });
+    (0, _child_process.exec)('pip install pre-commit', function (err, stdout, stderr) {
+      color.info('Installing pre-commit...');
+      if (err) throw err;else console.log(stderr, stdout);
+      (0, _child_process.exec)('pre-commit install --install-hooks --hook-type pre-commit --hook-type commit-msg', function (err, stdout, stderr) {
+        color.info('Installing commit hooks...');
+        if (err) throw err;else console.log(stderr, stdout);
+      });
+    });
+  }
+  if (!utils.isPackageDir(curDir) && (args.ts || args.ide || args.eslint || args.test)) {
     color.error('File `package.json` not found. Run the command from the package directory');
     return false;
   }

package/bin/commands/test.js

@@ -13,6 +13,7 @@ var _fs = _interopRequireDefault(require("fs"));
 var _os = _interopRequireDefault(require("os"));
 var _path = _interopRequireDefault(require("path"));
 var _puppeteer = _interopRequireDefault(require("puppeteer"));
+var _puppeteerScreenRecorder = require("puppeteer-screen-recorder");
 var _jsYaml = _interopRequireDefault(require("js-yaml"));
 var utils = _interopRequireWildcard(require("../utils/utils"));
 var color = _interopRequireWildcard(require("../utils/color-utils"));
@@ -21,7 +22,7 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 function test(args) {
   var options = Object.keys(args).slice(1);
-  var commandOptions = ['host', 'csv', 'gui', 'catchUnhandled', 'report', 'skip-build', 'skip-publish', 'category'];
+  var commandOptions = ['host', 'csv', 'gui', 'catchUnhandled', 'report', 'skip-build', 'skip-publish', 'category', 'record'];
   var nArgs = args['_'].length;
   var curDir = process.cwd();
   var grokDir = _path["default"].join(_os["default"].homedir(), '.grok');
@@ -97,6 +98,7 @@ function test(args) {
     var P_START_TIMEOUT = 3600000;
     var browser;
     var page;
+    var recorder;
     function init(timeout) {
       var params = Object.assign({}, testUtils.defaultLaunchParameters);
       if (args.gui) params['headless'] = false;
@@ -113,18 +115,19 @@ function test(args) {
                 out = _context.sent;
                 browser = out.browser;
                 page = out.page;
-                _context.next = 11;
+                recorder = new _puppeteerScreenRecorder.PuppeteerScreenRecorder(page, testUtils.recorderConfig);
+                _context.next = 12;
                 break;
-              case 8:
-                _context.prev = 8;
+              case 9:
+                _context.prev = 9;
                 _context.t0 = _context["catch"](0);
                 throw _context.t0;
-              case 11:
+              case 12:
               case "end":
                 return _context.stop();
             }
           }
-        }, _callee, null, [[0, 8]]);
+        }, _callee, null, [[0, 9]]);
       })));
     }
     function runTest(timeout) {
@@ -136,9 +139,16 @@ function test(args) {
           while (1) {
             switch (_context2.prev = _context2.next) {
               case 0:
+                if (!options.record) {
+                  _context2.next = 3;
+                  break;
+                }
+                _context2.next = 3;
+                return recorder.start('./test-record.mp4');
+              case 3:
                 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;
+                _context2.next = 7;
                 return page.evaluate(function (targetPackage, options, testContext) {
                   return new Promise(function (resolve, reject) {
                     window.grok.functions.call("".concat(targetPackage, ":test"), {
@@ -190,10 +200,17 @@ function test(args) {
                     });
                   });
                 }, targetPackage, options, new testUtils.TestContext(options.catchUnhandled, options.report));
-              case 4:
+              case 7:
                 r = _context2.sent;
+                if (!options.record) {
+                  _context2.next = 11;
+                  break;
+                }
+                _context2.next = 11;
+                return recorder.stop();
+              case 11:
                 return _context2.abrupt("return", r);
-              case 6:
+              case 12:
               case "end":
                 return _context2.stop();
             }
@@ -224,7 +241,8 @@ function test(args) {
               return runTest(7200000, {
                 category: args.category,
                 catchUnhandled: args.catchUnhandled,
-                report: args.report
+                report: args.report,
+                record: args.record
               });
             case 12:
               r = _context3.sent;

package/bin/utils/test-utils.js

@@ -11,6 +11,7 @@ exports.getBrowserPage = getBrowserPage;
 exports.getDevKey = getDevKey;
 exports.getToken = getToken;
 exports.getWebUrl = getWebUrl;
+exports.recorderConfig = void 0;
 exports.runWithTimeout = runWithTimeout;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
@@ -256,4 +257,22 @@ var TestContext = function TestContext(catchUnhandled, report) {
   if (catchUnhandled !== undefined) this.catchUnhandled = catchUnhandled;
   if (report !== undefined) this.report = report;
 };
-exports.TestContext = TestContext;
+exports.TestContext = TestContext;
+var recorderConfig = {
+  followNewTab: true,
+  fps: 25,
+  ffmpeg_Path: null,
+  videoFrame: {
+    width: 1024,
+    height: 768
+  },
+  videoCrf: 18,
+  videoCodec: 'libx264',
+  videoPreset: 'ultrafast',
+  videoBitrate: 1000,
+  autopad: {
+    color: 'black'
+  },
+  aspectRatio: '4:3'
+};
+exports.recorderConfig = recorderConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datagrok-tools",
-  "version": "4.11.0",
+  "version": "4.11.2",
   "description": "Utility to upload and publish packages to Datagrok",
   "homepage": "https://github.com/datagrok-ai/public/tree/master/tools#readme",
   "dependencies": {
@@ -18,7 +18,8 @@
     "node-recursive-directory": "^1.2.0",
     "os": "^0.1.1",
     "path": "^0.12.7",
-    "puppeteer": "^20.3.0"
+    "puppeteer": "^20.3.0",
+    "puppeteer-screen-recorder": "^2.1.2"
   },
   "scripts": {
     "link": "npm link",