datagrok-tools 6.7.9 → 6.7.10

package/bin/utils/test-utils.js

@@ -16,6 +16,7 @@ exports.getToken = getToken;
 exports.getWebUrl = getWebUrl;
 exports.getWebUrlFromPage = getWebUrlFromPage;
 exports.isPackageOnServer = isPackageOnServer;
+exports.isPackageU2Usage = isPackageU2Usage;
 exports.loadPackage = loadPackage;
 exports.loadPackages = loadPackages;
 exports.loadTestsList = loadTestsList;
@@ -159,6 +160,36 @@ function getDevKey(hostKey) {
     key
   };
 }
+const U2_USAGE = 'u2 usage:';
+/** The u2 usage mode a package built on u2 or ems is tested in: a misuse throws, unless `U2_STRICT` says otherwise
+ * (`report` logs each one as a `u2 usage:` line and the run does not fail on them). */
+const U2_MODE = process.env.U2_STRICT ?? 'throw';
+
+/** Whether a `u2 usage:` line the page logged fails the run: the package is tested with u2 strict. */
+function failsOnU2Usage() {
+  return U2_MODE !== 'report' && usesU2(process.cwd());
+}
+
+/** Whether a `u2 usage:` line is the tested package's: a stack frame it carries is in the package's bundle
+ * (`…/files/<package>/…`), or it carries none to tell. A line whose frames are all in other bundles is another
+ * package's misuse, reported but not failed on. */
+function isPackageU2Usage(line, packageName) {
+  const frames = line.match(/https?:\/\/[^\s()]+/g) ?? [];
+  const bundle = `/files/${packageName?.toLowerCase()}/`;
+  return packageName === undefined || frames.length === 0 || frames.some(f => f.toLowerCase().includes(bundle));
+}
+function usesU2(packageDir) {
+  try {
+    const json = JSON.parse(_fs.default.readFileSync(_path.default.join(packageDir, 'package.json'), 'utf-8'));
+    const deps = {
+      ...json.dependencies,
+      ...json.devDependencies
+    };
+    return '@datagrok-libraries/u2' in deps || '@datagrok-libraries/ems' in deps;
+  } catch {
+    return false;
+  }
+}
 function appendUrlParams(url, extraParams) {
   if (!extraParams) return url;
   return url + (url.includes('?') ? '&' : '?') + extraParams;
@@ -194,6 +225,9 @@ async function getBrowserPage(puppeteer, params = defaultLaunchParameters, urlPa
     height: 1080
   });
   page.setDefaultNavigationTimeout(0);
+  if (usesU2(process.cwd())) await page.evaluateOnNewDocument(mode => {
+    globalThis.__U2_STRICT__ = mode;
+  }, U2_MODE);
   await page.goto(`${url}/oauth/`);
   await page.browser().setCookie({
     name: 'auth',
@@ -537,6 +571,16 @@ function printBrowsersResult(browserResult, verbose = false) {
     console.log('Skipped tests: ' + (browserResult?.skippedAmount ?? 0));
     console.log('Failed tests:  ' + (browserResult?.failedAmount ?? 0));
   }
+  const own = browserResult.u2Usage?.filter(l => isPackageU2Usage(l, process.env.TARGET_PACKAGE)) ?? [];
+  const others = browserResult.u2Usage?.filter(l => !own.includes(l)) ?? [];
+  if (own.length) {
+    color.warn(failsOnU2Usage() ? `${own.length} u2 usage error(s) caught on the page (the run fails):` : `${own.length} u2 usage report(s), in report mode (the run does not fail on them):`);
+    for (const line of own) color.warn(`  ${line}`);
+  }
+  if (others.length) {
+    color.warn(`${others.length} u2 usage line(s) from other packages' code (the run does not fail on them):`);
+    for (const line of others) color.warn(`  ${line}`);
+  }
   if (browserResult.failed) {
     if (browserResult.verboseFailed === 'Package not found') color.fail('Tests not found');else color.fail('Tests failed.');
   } else color.success('Tests passed.');
@@ -860,6 +904,11 @@ async function runBrowser(testExecutionData, browserOptions, browsersId, testInv
     // Subscribe to page console events for modern output formatting
     // On retry, old listeners were removed so we need to re-attach
     page.on('console', msg => reporter.onLine(msg.text()));
+    const u2Usage = [];
+    page.on('console', msg => {
+      const text = msg.text();
+      if (text.includes(U2_USAGE) && !u2Usage.includes(text)) u2Usage.push(text);
+    });
     const testingResults = await page.evaluate((testData, options) => {
       if (options.benchmark) window.DG.Test.isInBenchmark = true;
       if (options.reproduce) window.DG.Test.isReproducing = true;
@@ -918,12 +967,14 @@ async function runBrowser(testExecutionData, browserOptions, browsersId, testInv
     // Return browser session for potential reuse
     return {
       ...testingResults,
+      failed: testingResults.failed || failsOnU2Usage() && u2Usage.some(l => isPackageU2Usage(l, process.env.TARGET_PACKAGE)),
       browserSession: browserOptions.keepBrowserOpen ? {
         browser,
         page,
         webUrl
       } : undefined,
-      modernOutput: reporter.modernOutput
+      modernOutput: reporter.modernOutput,
+      u2Usage
     };
   }, testInvocationTimeout);
 }
@@ -938,7 +989,8 @@ async function mergeBrowsersResults(browsersResults) {
     failedAmount: browsersResults[0].failedAmount,
     csv: browsersResults[0].csv,
     error: '',
-    modernOutput: browsersResults.some(r => r.modernOutput)
+    modernOutput: browsersResults.some(r => r.modernOutput),
+    u2Usage: [...new Set(browsersResults.flatMap(r => r.u2Usage ?? []))]
   };
   for (const browsersResult of browsersResults) {
     if (mergedResult.csv === browsersResult.csv) continue;

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/datagrok-ai/public.git"
   },
-  "version": "6.7.9",
+  "version": "6.7.10",
   "description": "Utility to upload and publish packages to Datagrok",
   "homepage": "https://github.com/datagrok-ai/public/tree/master/tools#readme",
   "engines": {

package/plugins/func-gen-plugin.js

@@ -202,8 +202,8 @@ class FuncGeneratorPlugin {
       this._checkPackageFileForDecoratorsExport(packageFilePath);
       // Uncommment to add obvious import/export
       // this._writeToPackageFile(packageFilePath, genImports, genExports);
+      api({_: ['api']});
     });
-    api({_: ['api']});
   }
 
   _addNodeData(

package/vitest.config.mts

@@ -1,9 +1,12 @@
 import {defineConfig} from 'vitest/config';
 
 export default defineConfig({
+  // Babel writes each .js beside its .ts in bin/: tests must load the sources, and one copy of each module.
+  resolve: {extensions: ['.ts', '.mts', '.mjs', '.js', '.jsx', '.tsx', '.json']},
   test: {
     projects: [
       {
+        extends: true,
         test: {
           name: 'unit',
           environment: 'node',
@@ -12,6 +15,7 @@ export default defineConfig({
         },
       },
       {
+        extends: true,
         test: {
           name: 'integration',
           environment: 'node',