@teamscale/javascript-instrumenter 0.0.1-beta.9 → 0.1.0-beta.3

package/dist/src/instrumenter/WebToolkit.js

@@ -0,0 +1,147 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isGwtBundle = exports.determineGwtFileUid = exports.loadInputSourceMapsGwt = exports.extractGwtCallInfos = exports.determineSymbolMapsDir = void 0;
+const path_1 = __importDefault(require("path"));
+const FileSystem_1 = require("./FileSystem");
+const types_1 = require("@babel/types");
+const parser_1 = require("@babel/parser");
+const commons_1 = require("@cqse/commons");
+/**
+ * There are different places where a 'symbolMaps' folder can be:
+ * (1) within the `WEB-INF` folder (`WEB-INF/deploy/<module-name>/symbolMaps`)
+ * or (2) it can be a sibling of the parent `deferredjs` folder.
+ *
+ * @param taskFile - Path to the JS bundle file to start searching from.
+ */
+function determineSymbolMapsDir(taskFile) {
+    const symbolMapDirs = [];
+    let webInfDir = null;
+    const pathComponents = path_1.default.resolve(taskFile).split(path_1.default.sep);
+    for (let i = pathComponents.length - 2; i >= 0; i--) {
+        const fullDirPath = pathComponents.slice(0, i).join(path_1.default.sep);
+        const webInfDirCandidate = path_1.default.join(fullDirPath, 'WEB-INF');
+        if ((0, FileSystem_1.isExistingDirectory)(webInfDirCandidate)) {
+            webInfDir = webInfDirCandidate;
+        }
+        const symbolMapDirCandidate = path_1.default.join(fullDirPath, 'symbolMaps');
+        if ((0, FileSystem_1.isExistingDirectory)(symbolMapDirCandidate)) {
+            symbolMapDirs.push(symbolMapDirCandidate);
+        }
+    }
+    if (webInfDir != null) {
+        (0, FileSystem_1.findSubFolders)(webInfDir, 'symbolMaps').forEach(dir => symbolMapDirs.push(dir));
+    }
+    return symbolMapDirs;
+}
+exports.determineSymbolMapsDir = determineSymbolMapsDir;
+function expressionToString(expression) {
+    if ((0, types_1.isMemberExpression)(expression) && (0, types_1.isExpression)(expression.property)) {
+        return `${expressionToString(expression.object)}.${expressionToString(expression.property)}`;
+    }
+    else if ((0, types_1.isIdentifier)(expression)) {
+        return expression.name;
+    }
+    throw new commons_1.IllegalArgumentException('Type of expression not yet supported.');
+}
+function extractQualifiedFunctionName(call) {
+    if ((0, types_1.isMemberExpression)(call.callee) || (0, types_1.isIdentifier)(call.callee)) {
+        return expressionToString(call.callee);
+    }
+    throw new commons_1.IllegalArgumentException('Type of callee not yet supported.');
+}
+/**
+ * Extract the GWT function calls from the GWT bundle. These function calls
+ * do have the actual application code as arguments.
+ *
+ * Examples of `bundleContent` (without the double quotes):
+ * 		"showcase.onScriptDownloaded(["var $wnd =  .....  __gwtModuleFunction.__moduleStartupDone($gwt.permProps);\n//# sourceURL=showcase-0.js\n"]);"
+ * 	    "$wnd.showcase.runAsyncCallback3("function bc(a){Wb((Ze(),Xe),a) ..... nZ5b(El)(3);\n//# sourceURL=showcase-3.js\n")
+ */
+function extractGwtCallInfos(bundleContent) {
+    const ast = (0, parser_1.parse)(bundleContent);
+    if (ast.program.body.length === 0) {
+        return null;
+    }
+    if (!(0, types_1.isExpressionStatement)(ast.program.body[0])) {
+        return null;
+    }
+    const call = ast.program.body[0].expression;
+    if (!(0, types_1.isCallExpression)(call)) {
+        return null;
+    }
+    const qualifiedFunctionName = extractQualifiedFunctionName(call);
+    const firstArgument = call.arguments[0];
+    if ((0, types_1.isArrayExpression)(firstArgument)) {
+        const codeArguments = [];
+        for (const element of firstArgument.elements) {
+            if ((0, types_1.isStringLiteral)(element)) {
+                codeArguments.push(element.value);
+            }
+            else {
+                throw new Error(`Did expect only string arguments in the call of "${qualifiedFunctionName}".`);
+            }
+        }
+        return { codeArguments, functionName: qualifiedFunctionName, codeAsArrayArgument: true };
+    }
+    else if ((0, types_1.isStringLiteral)(firstArgument)) {
+        const codeArgument = firstArgument.value;
+        return { codeArguments: [codeArgument], functionName: qualifiedFunctionName, codeAsArrayArgument: false };
+    }
+    return null;
+}
+exports.extractGwtCallInfos = extractGwtCallInfos;
+/**
+ * Load the source map for the given GWT bundle.
+ */
+function loadInputSourceMapsGwt(taskFile, bundleFile) {
+    // taskFile:
+    //    war/stockwatcher/E2C1FB09E006E0A2420123D036967150.cache.js
+    //    war/showcase/deferredjs/28F63AD125178AAAB80993C11635D26F/5.cache.js
+    const mapDirs = determineSymbolMapsDir(taskFile);
+    const fileNumberMatcher = /sourceURL=(.*)-(\d+).js(\\n)*\s*$/;
+    const mapModules = bundleFile.codeArguments.map(code => {
+        const matches = fileNumberMatcher.exec(code);
+        if (!matches) {
+            return ['', -1];
+        }
+        return [matches[1], Number.parseInt(matches[2])];
+    });
+    const sourceMapFiles = mapModules.map(module => {
+        for (const mapDir of mapDirs) {
+            const mapFileCandidate = `${mapDir}/${bundleFile.fragmentId}_sourceMap${module[1]}.json`;
+            if ((0, FileSystem_1.isExistingFile)(mapFileCandidate)) {
+                return mapFileCandidate;
+            }
+        }
+        return undefined;
+    });
+    return sourceMapFiles.map(file => {
+        if (file) {
+            return (0, FileSystem_1.sourceMapFromMapFile)(file);
+        }
+        return undefined;
+    });
+}
+exports.loadInputSourceMapsGwt = loadInputSourceMapsGwt;
+/**
+ * Determine the ID of the given GWT bundle file.
+ */
+function determineGwtFileUid(filename) {
+    const fileUidMatcher = /.*([0-9A-Fa-f]{32}).*/;
+    const uidMatches = fileUidMatcher.exec(filename);
+    if (!uidMatches || uidMatches.length < 2) {
+        return undefined;
+    }
+    return uidMatches[1];
+}
+exports.determineGwtFileUid = determineGwtFileUid;
+/**
+ * Is the given bundle a GWT bundle?
+ */
+function isGwtBundle(bundle) {
+    return bundle.type === 'gwt';
+}
+exports.isGwtBundle = isGwtBundle;

package/dist/src/main.js

@@ -7,6 +7,7 @@ App_1.App.run()
     .then(result => {
     console.log('Instrumentation finished.');
     console.log(`\tInstrumented: ${result.translated}`);
+    console.log(`\tExcluded: ${result.excluded}`);
     console.log(`\tInstrumented from cache: ${result.translatedFromCache}`);
     console.log(`\tAlready instrumented: ${result.alreadyInstrumented}`);
     console.log(`\tUnsupported: ${result.unsupported}`);

package/dist/vaccine.js

@@ -1 +1 @@
-(()=>{var x=Object.create;var h=Object.defineProperty;var A=Object.getOwnPropertyDescriptor;var y=Object.getOwnPropertyNames;var $=Object.getPrototypeOf,I=Object.prototype.hasOwnProperty;var j=e=>h(e,"__esModule",{value:!0});var g=(e,n)=>()=>(n||e((n={exports:{}}).exports,n),n.exports);var G=(e,n,t)=>{if(n&&typeof n=="object"||typeof n=="function")for(let o of y(n))!I.call(e,o)&&o!=="default"&&h(e,o,{get:()=>n[o],enumerable:!(t=A(n,o))||t.enumerable});return e},b=e=>G(j(h(e!=null?x($(e)):{},"default",e&&e.__esModule&&"default"in e?{get:()=>e.default,enumerable:!0}:{value:e,enumerable:!0})),e);var k=g((K,C)=>{C.exports=!1});var O=g(()=>{});function f(e){let n=new Blob([e],{type:"text/javascript"}),t=URL.createObjectURL(n),o=new Worker(t);return URL.revokeObjectURL(t),o}function p(){return f('var n=class{constructor(t){this.cachedMessages=[];this.url=t,this.socket=this.createSocket()}createSocket(){let t=new WebSocket(this.url);return t.onopen=()=>this.onopen(),t.onclose=()=>this.onclose(),t}onclose(){this.socket=this.createSocket()}onopen(){this.cachedMessages.forEach(t=>this.socket.send(t)),this.cachedMessages=[]}send(t){this.socket.readyState===WebSocket.OPEN?this.socket.send(t):this.cachedMessages.push(t)}};var o;(function(e){e.MESSAGE_TYPE_SOURCEMAP="s",e.MESSAGE_TYPE_COVERAGE="c"})(o||(o={}));var C=20,p=1e3,a=class{constructor(t,e){this.milliseconds=t;this.onCountedToZero=e;this.timerHandle=null}restartCountdown(){this.stopCountdown(),this.timerHandle=self.setTimeout(()=>{this.stopCountdown(),this.onCountedToZero()},this.milliseconds)}stopCountdown(){this.timerHandle!==null&&(self.clearTimeout(this.timerHandle),this.timerHandle=null)}},r=class{constructor(t){this.socket=t,this.cachedCoveredPositions=new Map,this.numberOfCachedPositions=0,this.flushCountdown=new a(p,()=>this.flush())}add(t){let e=t.split(":");if(e.length!==3)return;let[c,u,l]=e,i=this.cachedCoveredPositions.get(c);i||(i=new Set,this.cachedCoveredPositions.set(c,i)),i.add(`${u}:${l}`),this.numberOfCachedPositions+=1,this.flushCountdown.restartCountdown(),this.numberOfCachedPositions>=C&&this.flush()}flush(){this.numberOfCachedPositions!==0&&(this.flushCountdown.stopCountdown(),this.cachedCoveredPositions.forEach((t,e)=>{this.socket.send(`${o.MESSAGE_TYPE_COVERAGE} ${e} ${Array.from(t).join(" ")}`)}),this.cachedCoveredPositions=new Map,this.numberOfCachedPositions=0)}};console.log("Starting coverage forwarding worker.");var h=new n("ws://$REPORT_TO_HOST:$REPORT_TO_PORT/socket"),d=new r(h);onmessage=s=>{let t=s.data;t.startsWith(o.MESSAGE_TYPE_SOURCEMAP)?h.send(t):t==="unload"?d.flush():d.add(t)};\n')}function u(){return c()}function E(){return typeof window!="undefined"}function c(){return window}function m(e,n){let t=u()[e];return t||(t=n,u()[e]=t),t}var L="s",S=class{constructor(n,t){this.coverageObj=n;this.path=t}get(n,t,o){let r=n[t];return r!==Object(r)?r:w(this.coverageObj,r,[...this.path,t])}set(n,t,o){let r=[...this.path,t];if(r[0]===L){let i=this.coverageObj.hash,s=this.coverageObj.statementMap[r[1]].start;u()._$Bc(i,s.line,s.column)}return!0}};function w(e,n,t){return new Proxy(n,new S(e,t))}var _=b(k());function U(e){if(!(typeof WorkerGlobalScope=="function"&&self instanceof WorkerGlobalScope)){if(typeof window.addEventListener!="function")return;window.addEventListener("beforeunload",function(){e()},!0),window.addEventListener("unload",function(){e()},!0)}}var M={add:U};var P=b(O()),D=_.default?P.default:M,d=new Set,T=!1;function H(){T||(T=!0,D.add(B))}function W(e){if(H(),typeof e!="function")throw new Error("Listener is no function");d.add(e);var n={remove:function(){return d.delete(e)},run:function(){return d.delete(e),e()}};return n}function B(){var e=[];return d.forEach(function(n){e.push(n()),d.delete(n)}),Promise.all(e)}var l;(function(t){t.MESSAGE_TYPE_SOURCEMAP="s",t.MESSAGE_TYPE_COVERAGE="c"})(l||(l={}));var R=m("__TS_AGENT",{});function v(){return R._$BcWorker}function Y(e){return R._$BcWorker=e,e}u().makeCoverageInterceptor=function(e){let n=e.hash;if(!v()){let t=Y(new p);(function(){let r=function(i){let s=c()[i];c()[i]=function(...a){if(t.postMessage("unload"),s)return s.apply(this,a)},E()&&Object.defineProperty(c(),i,{get:function(){return s},set:function(a){s=a}})};r("onunload"),r("onbeforeunload"),W(()=>t.postMessage("unload"))})()}return function(){let o=m("sentMaps",new Set);e.inputSourceMap&&(o.has(e.path)||(v().postMessage(`${l.MESSAGE_TYPE_SOURCEMAP} ${n}:${JSON.stringify(e.inputSourceMap)}`),o.add(e.path)))}(),function(){let o=new Set;u()._$Bc=(r,i,s)=>{let a=`${r}:${i}:${s}`;o.has(a)||(v().postMessage(a),o.add(a))}}(),w(e,e,[])};})();
+"use strict";(()=>{function c(t){let n=new Blob([t],{type:"text/javascript"}),e=URL.createObjectURL(n),o=new Worker(e);return URL.revokeObjectURL(e),o}function l(){return c('var r=class{constructor(e){this.cachedMessages=[];this.url=e,this.socket=this.createSocket()}createSocket(){let e=new WebSocket(this.url);return e.onopen=()=>this.onopen(),e.onclose=()=>this.onclose(),e}onclose(){this.socket=this.createSocket()}onopen(){console.log("Connection to Coverage Collector established."),this.cachedMessages.forEach(e=>this.socket.send(e)),this.cachedMessages=[]}send(e){this.socket.readyState===WebSocket.OPEN?this.socket.send(e):(this.cachedMessages.push(e),this.cachedMessages.length%500===0&&console.log(`More than ${this.cachedMessages.length} messages are queued to be sent.`))}};var i=class{constructor(e,t){this.milliseconds=e;this.onCountedToZero=t;this.timerHandle=null}restartCountdown(){this.stopCountdown(),this.timerHandle=self.setTimeout(()=>{this.stopCountdown(),this.onCountedToZero()},this.milliseconds)}stopCountdown(){this.timerHandle!==null&&(self.clearTimeout(this.timerHandle),this.timerHandle=null)}};var d=20,l=1e3,u="c",a=class{constructor(e){this.socket=e,this.cachedCoveredRanges=new Map,this.numberOfCachedPositions=0,this.flushCountdown=new i(l,()=>this.flush())}addRanges(e,t){let s=this.cachedCoveredRanges.get(e);s||(s={lines:[]},this.cachedCoveredRanges.set(e,s)),t.lines.forEach(n=>s.lines.push(n)),this.numberOfCachedPositions+=1,this.flushCountdown.restartCountdown(),this.numberOfCachedPositions>=d&&this.flush()}arrayToLineCov(e){if(e.length%2!==0)throw new Error("Unexpected length of input data.");let t=[];for(let s=0;s<e.length;s=s+2){let n=e[s],c=e[s+1];n===c?t.push(`${n}`):t.push(`${n}-${c}`)}return t.join(";")}flush(){if(this.numberOfCachedPositions===0)return;this.flushCountdown.stopCountdown();let e=[];this.cachedCoveredRanges.forEach((t,s)=>{e.push(`@${s}`),e.push(this.arrayToLineCov(t.lines))}),this.socket.send(`${u} ${e.join(";")}`),this.cachedCoveredRanges.clear(),this.numberOfCachedPositions=0}};console.log("Starting coverage forwarding worker.");var g=new r("$REPORT_TO_URL/socket"),h=new a(g);onmessage=o=>{if(Array.isArray(o.data)){let[e,t]=o.data;h.addRanges(e,t)}else o.data==="unload"?h.flush():console.error(`No handler for message: ${o.data}`)};\n')}function u(){return h()}function h(){return window}function d(t,n){let e=u()[t];return e||(e=n,u()[t]=e),e}function f(t,n){let e=new Map;function o(r){let s=e.get(r);return s||(s={lines:[]},e.set(r,s),s)}function i(r,s,C){o(r).lines.push(s,C)}function a(){n(e),e.clear()}return setInterval(()=>a(),t),{putLineCoverage:i,flush:a}}var g=d("__TS_AGENT",{});function p(){return g._$BcWorker}function w(t){return g._$BcWorker=t,t}var v=f(250,t=>{for(let n of t.entries())p().postMessage(n)});u()._$l=v.putLineCoverage;if(!p()){let t=w(new l);(function(){let e=()=>{v.flush(),t.postMessage("unload")},o=function(a,r){r&&r.addEventListener(a,e,{capture:!0})},i=h();o("blur",i),o("unload",i),o("visibilitychange",i),o("beforeunload",i)})()}})();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@teamscale/javascript-instrumenter",
-  "version": "0.0.1-beta.9",
-  "description": "Istanbul-based coverage instrumenter with coverage forwarding via WebSockets",
+  "version": "0.1.0-beta.3",
+  "description": "JavaScript coverage instrumenter with coverage forwarding to a collector process",
   "main": "dist/src/main.js",
   "bin": "dist/src/main.js",
   "types": "dist/src/main.d.ts",
@@ -11,57 +11,63 @@
     "type": "git",
     "url": "https://github.com/cqse/teamscale-javascript-profiler.git"
   },
-  "scripts": {
-    "clean": "rimraf dist tsconfig.tsbuildinfo",
-    "build": "tsc --project tsconfig.json && node esbuild.mjs",
-    "instrumenter": "node dist/src/main.js",
-    "test": "yarn build && NODE_OPTIONS='--experimental-vm-modules' jest --forceExit --coverage --silent=true --detectOpenHandles"
-  },
   "files": [
     "dist/**/*"
   ],
   "devDependencies": {
-    "@babel/core": "^7.14.0",
-    "@babel/plugin-transform-modules-commonjs": "^7.15.4",
-    "@babel/preset-env": "^7.14.1",
-    "@types/async": "^3.2.6",
-    "@types/convert-source-map": "^1.5.1",
-    "@types/glob": "^7.1.3",
-    "@types/istanbul-lib-instrument": "^1.7.4",
-    "@types/jest": "^27.0.1",
-    "@types/mkdirp": "^1.0.1",
-    "@types/node": "^15.0.1",
-    "@types/source-map": "^0.5.7",
-    "@types/ws": "^7.4.4",
-    "babel-jest": "^27.2.0",
-    "esbuild": "^0.13.3",
+    "@babel/core": "^7.23.7",
+    "@babel/plugin-transform-modules-commonjs": "^7.23.3",
+    "@babel/preset-env": "^7.23.8",
+    "@types/argparse": "^2.0.14",
+    "@types/async": "^3.2.24",
+    "@types/babel__generator": "^7.6.8",
+    "@types/babel__traverse": "^7.20.5",
+    "@types/bunyan": "^1.8.11",
+    "@types/convert-source-map": "^2.0.3",
+    "@types/glob": "^8.1.0",
+    "@types/istanbul-lib-instrument": "^1.7.7",
+    "@types/jest": "^29.5.11",
+    "@types/node": "^20.11.0",
+    "@types/ws": "^8.5.10",
+    "babel-jest": "^29.7.0",
+    "esbuild": "^0.19.11",
     "esbuild-plugin-inline-worker": "^0.1.1",
-    "jest": "^27.2.0",
-    "rimraf": "^3.0.2",
-    "ts-jest": "^27.0.5",
-    "ts-node": "^10.2.1",
-    "tslib": "^2.2.0",
-    "typescript": "^4.4.3"
+    "jest": "^29.7.0",
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.6.2",
+    "typescript": "^5.3.3"
   },
   "dependencies": {
-    "@cqse/commons": "^0.0.1-beta.1",
-    "@types/micromatch": "^4.0.2",
+    "@cqse/commons": "0.1.0-beta.2",
+    "@babel/generator": "^7.23.6",
+    "@babel/parser": "^7.23.6",
+    "@babel/traverse": "^7.23.7",
+    "@babel/types": "^7.23.6",
+    "@types/micromatch": "^4.0.6",
     "argparse": "^2.0.1",
-    "async": "^3.2.0",
-    "convert-source-map": "^1.7.0",
-    "foreground-child": "^2.0.0",
-    "glob": "^7.1.7",
-    "istanbul-lib-instrument": "^4.0.0",
-    "micromatch": "4.0.4",
-    "mkdirp": "^1.0.4",
-    "nyc": "^15.1.0",
-    "source-map": "0.6.1",
+    "async": "^3.2.5",
+    "bunyan": "^1.8.15",
+    "convert-source-map": "^2.0.0",
+    "foreground-child": "^3.1.1",
+    "glob": "^10.3.10",
+    "micromatch": "4.0.5",
+    "mkdirp": "^3.0.1",
+    "source-map": "0.7.4",
     "typescript-optional": "^2.0.1",
-    "unload": "^2.2.0",
-    "web-worker": "^1.0.0",
-    "winston": "^3.3.3"
+    "unload": "^2.4.1",
+    "web-worker": "^1.3.0",
+    "@teamscale/lib-instrument": "0.1.0-beta.3"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "clean": "rimraf dist tsconfig.tsbuildinfo",
+    "build": "tsc --project tsconfig.json && pnpm buildVaccine",
+    "buildVaccine": "node esbuild.mjs",
+    "instrumenter": "node dist/src/main.js",
+    "test": "pnpm build && NODE_OPTIONS='--experimental-vm-modules --max-old-space-size=8192' jest --forceExit --coverage --silent=true --detectOpenHandles"
   }
-}
+}