datagrok-tools 4.13.66 → 4.13.68

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Datagrok-tools changelog
 
+## 4.13.67 (2025-03-26)
+
+### Features
+
+* Updated grok link:
+*   Excluded diff-grok from linking
+*   Added verbose option
+*   Updated help
+
 ## 4.13.66 (2025-03-21)
 
 ### Features

package/README.md

@@ -106,7 +106,9 @@ For more information on configuring connections, refer to the [Connections](http
   (applies the same options as `create`).
 - `test` runs package tests. First, it builds a package and publishes it (these
   steps can be skipped with flags `--skip-build` and `--skip-publish`
-  correspondingly).
+  correspondingly). Also, it can be used to debug tests by using(`gui` and `debug` flags).
+- `testall` runs tests from the packages directory. It works similarly to `test`, but this function allows tests to run 
+  from different packages in a specified order.
 
   ```shell
   cd <package-name>
@@ -122,19 +124,20 @@ For more information on configuring connections, refer to the [Connections](http
   instructions](https://datagrok.ai/help/develop/how-to/test-packages#local-testing).
 
   Table with all available flags:
-  | Flag           | Description                                                               |
-  |----------------|---------------------------------------------------------------------------|
-  | catchUnhandled | Whether or not to catch unhandled exceptions during tests                 |
-  | category       | Runs tests of a specific category                                         |
-  | csv            | Saves tests run results as a CSV file in the package folder               |
-  | gui            | Disables the headless browser mode                                        |
-  | host           | Specify server alias                                                      |
-  | record         | Records the test execution process in mp4 format                          |
-  | report         | Sends a report on test results                                            |
-  | skip-build     | Skips package build step                                                  |
-  | skip-publish   | Skips package publish step                                                |
-  | verbose        | Prints detailed information about passed and skipped tests in the console |
-  | platform       | Runs only platform tests (applicable for ApiTests package only)           |
-  | core           | Runs package & core tests (applicable  for DevTools package only)         |
+  | Flag           | Description                                                                                                                           |
+  |----------------|---------------------------------------------------------------------------------------------------------------------------------------|
+  | catchUnhandled | Whether or not to catch unhandled exceptions during tests                                                                             |
+  | category       | Runs tests of a specific category                                                                                                     |
+  | csv            | Saves tests run results as a CSV file in the package folder                                                                           |
+  | gui            | Disables the headless browser mode                                                                                                    |
+  | host           | Specify server alias                                                                                                                  |
+  | record         | Records the test execution process in mp4 format                                                                                      |
+  | report         | Sends a report on test results                                                                                                        |
+  | skip-build     | Skips package build step                                                                                                              |
+  | skip-publish   | Skips package publish step                                                                                                            |
+  | verbose        | Prints detailed information about passed and skipped tests in the console                                                             |
+  | platform       | Runs only platform tests (applicable for ApiTests package only)                                                                       |
+  | core           | Runs package & core tests & autotests                                                                                                 |
+  | debug          | Sets a debug breakpoint before each test execution, allowing you to debug the test. Only works in `gui` mode                          |
 
 - `link` command is used for public plugins development to link `datagrok-api` and libraries.

package/bin/commands/help.js

@@ -14,7 +14,7 @@ var HELP_PUBLISH = "\nUsage: grok publish [host]\n\nUpload a package\n\nOptions:
 var HELP_CHECK = "\nUsage: grok check\n\nOptions:\n[-r | --recursive]\n\n--recursive       Check all packages in the current directory\n\nCheck package content (function signatures, import statements of external modules, etc.)\n";
 var HELP_TEST = "\nUsage: grok test\n\nOptions:\n[--package] [--category] [--test] [--host] [--csv] [--gui] [--skip-build] [--skip-publish] [--link] [--catchUnhandled] [--report] [--record] [--verbose] [--platform] [--benchmark] [--stress-test] --[debug]\n\n--package           Specify a package name to run tests for\n--category          Specify a category name to run tests for\n--test              Specify a test name to run \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--debug             Enables debug point on tests run (useless without gui mode) \n--catchUnhandled    Catch unhandled exceptions during test execution (default=true)\n--report            Report failed tests to audit, notifies package author (default=false)\n--skip-build        Skip the package build step\n--skip-publish      Skip the package publication step\n--link  \t          Link the package to local utils\n--record            Records the test execution process in mp4 format\n--verbose           Prints detailed information about passed and skipped tests in the console\n--platform          Runs only platform tests (applicable for ApiTests package only)\n--core              Runs package & auto tests & core tests (core tests run only from DevTools package)\n--benchmark   \t    Runs tests in benchmark mode\n--stress-test       Runs shuffled stress-test only\n \nRun package tests\n\nSee instructions:\nhttps://datagrok.ai/help/develop/how-to/test-packages#local-testing\n";
 var HELP_TESTALL = "\nUsage: grok testall\n\nOptions:\n[--packages] [--host] [--csv] [--gui] [--skip-build] [--skip-publish] [--link-package] [--catchUnhandled] [--report] [--record] [--verbose] [--benchmark] [--stress-test] [--order] [--tags] [--testRepeat] [--browsers-count] [--debug]\n\n--packages          Specify a packages names to run tests for\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--debug             Enables debug point on tests run (useless without gui mode) \n--catchUnhandled    Catch unhandled exceptions during test execution (default=true)\n--report            Report failed tests to audit, notifies packages author (default=false)\n--skip-build        Skip the packages build step\n--skip-publish      Skip the packages publication step\n--link-package  \t  Link the packages to local utils\n--record            Records the test execution process in mp4 format\n--verbose           Prints detailed information about passed and skipped tests in the console\n--core              Runs packages & core tests (applicable  for DevTools packages only)\n--benchmark   \t    Runs tests in benchmark mode\n--stress-test       Runs shuffled stress-test only\n--order             Specify order for tests invocation\n--tags              Filter tests by tag name for run\n--testRepeat        Set amount of tests repeats\n--browsers-count      Set amount of browsers for tests run\n\nRun tests of all or specified packages \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_LINK = "\nUsage: grok link\n\nLink `datagrok-api` and libraries for local development\n\nOptions:\n--dev               Links also dev dependencies\n--verbose           Prints detailed information about linked packages  \n";
 
 // const HELP_MIGRATE = `
 // Usage: grok migrate

package/bin/commands/link.js

@@ -17,6 +17,7 @@ function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol
 function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; } /* eslint-disable valid-jsdoc */
 var repositoryDirNameRegex = new RegExp(_path["default"].join('1', '2')[1] + 'public$');
+var excludedPackages = ['@datagrok/diff-grok'];
 var curDir = process.cwd();
 var devMode = false;
 var repositoryDir = curDir;
@@ -26,6 +27,7 @@ while (_path["default"].dirname(repositoryDir) !== repositoryDir) {
   if (repositoryDirNameRegex.test(repositoryDir)) break;
   repositoryDir = _path["default"].dirname(repositoryDir);
 }
+var verbose = false;
 var apiDir = _path["default"].join(repositoryDir, 'js-api');
 var libDir = _path["default"].join(repositoryDir, 'libraries');
 var packageDir = _path["default"].join(repositoryDir, 'packages');
@@ -37,19 +39,21 @@ function link(_x) {
 }
 function _link() {
   _link = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee(args) {
+    var _args$verbose;
     return _regenerator["default"].wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
+          verbose = (_args$verbose = args.verbose) !== null && _args$verbose !== void 0 ? _args$verbose : false;
           localPackageDependencies = [];
           packagesToLink = new Set();
           if (args.dev !== undefined) devMode = args.dev;
           collectPackagesData(curDir);
-          _context.next = 6;
+          _context.next = 7;
           return linkPackages();
-        case 6:
+        case 7:
           console.log('Package linked');
           return _context.abrupt("return", true);
-        case 8:
+        case 9:
         case "end":
           return _context.stop();
       }
@@ -95,79 +99,101 @@ function linkPackages() {
 }
 function _linkPackages() {
   _linkPackages = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2() {
-    var anyChanges, mapElements, _iterator, _step, element, names;
+    var anyChanges, _iterator, _step, _element, mapElements, _iterator2, _step2, element, names;
     return _regenerator["default"].wrap(function _callee2$(_context2) {
       while (1) switch (_context2.prev = _context2.next) {
         case 0:
           anyChanges = true;
-        case 1:
+          _iterator = _createForOfIteratorHelper(excludedPackages);
+          try {
+            for (_iterator.s(); !(_step = _iterator.n()).done;) {
+              _element = _step.value;
+              packagesToLink["delete"](_element);
+            }
+          } catch (err) {
+            _iterator.e(err);
+          } finally {
+            _iterator.f();
+          }
+          if (verbose) {
+            console.log('Packages to link:');
+            console.log(localPackageDependencies);
+          }
+        case 4:
           if (!(anyChanges && packagesToLink.size > 0)) {
-            _context2.next = 31;
+            _context2.next = 37;
             break;
           }
           anyChanges = false;
           mapElements = localPackageDependencies.filter(function (x) {
             return x.dependencies.every(function (i) {
               return !packagesToLink.has(i);
-            }) && packagesToLink.has(x.name);
+            }) && packagesToLink.has(x.name) && !excludedPackages.includes(x.name);
           });
-          _iterator = _createForOfIteratorHelper(mapElements);
-          _context2.prev = 5;
-          _iterator.s();
-        case 7:
-          if ((_step = _iterator.n()).done) {
-            _context2.next = 19;
+          if (!(mapElements.length === 0)) {
+            _context2.next = 9;
+            break;
+          }
+          return _context2.abrupt("break", 37);
+        case 9:
+          _iterator2 = _createForOfIteratorHelper(mapElements);
+          _context2.prev = 10;
+          _iterator2.s();
+        case 12:
+          if ((_step2 = _iterator2.n()).done) {
+            _context2.next = 25;
             break;
           }
-          element = _step.value;
-          _context2.next = 11;
+          element = _step2.value;
+          if (verbose) console.log("Package ".concat(element.name, " linked"));
+          _context2.next = 17;
           return (0, _utils.runScript)("npm install", element.packagePath);
-        case 11:
-          _context2.next = 13;
+        case 17:
+          _context2.next = 19;
           return (0, _utils.runScript)("npm link ".concat(element.dependencies.join(' ')), element.packagePath);
-        case 13:
-          _context2.next = 15;
+        case 19:
+          _context2.next = 21;
           return (0, _utils.runScript)("npm link", element.packagePath);
-        case 15:
+        case 21:
           packagesToLink["delete"](element.name);
           anyChanges = true;
-        case 17:
-          _context2.next = 7;
+        case 23:
+          _context2.next = 12;
           break;
-        case 19:
-          _context2.next = 24;
+        case 25:
+          _context2.next = 30;
           break;
-        case 21:
-          _context2.prev = 21;
-          _context2.t0 = _context2["catch"](5);
-          _iterator.e(_context2.t0);
-        case 24:
-          _context2.prev = 24;
-          _iterator.f();
-          return _context2.finish(24);
         case 27:
+          _context2.prev = 27;
+          _context2.t0 = _context2["catch"](10);
+          _iterator2.e(_context2.t0);
+        case 30:
+          _context2.prev = 30;
+          _iterator2.f();
+          return _context2.finish(30);
+        case 33:
           if (!(anyChanges === false)) {
-            _context2.next = 29;
+            _context2.next = 35;
             break;
           }
           throw new Error("There is loop with next packages: ".concat(JSON.stringify(Array.from(packagesToLink)).toString()));
-        case 29:
-          _context2.next = 1;
+        case 35:
+          _context2.next = 4;
           break;
-        case 31:
+        case 37:
           names = localPackageDependencies.map(function (x) {
             return x.name;
           });
-          _context2.next = 34;
+          _context2.next = 40;
           return (0, _utils.runScript)("npm install", curDir);
-        case 34:
-          _context2.next = 36;
+        case 40:
+          _context2.next = 42;
           return (0, _utils.runScript)("npm link ".concat(names.join(' ')), curDir);
-        case 36:
+        case 42:
         case "end":
           return _context2.stop();
       }
-    }, _callee2, null, [[5, 21, 24, 27]]);
+    }, _callee2, null, [[10, 27, 30, 33]]);
   }));
   return _linkPackages.apply(this, arguments);
 }