@teamscale/javascript-instrumenter 0.0.1-beta.2 → 0.0.1-beta.9

package/README.md

@@ -52,7 +52,7 @@ or
 There are several options to run the Instrumenter. For example, via `yarn` by running
 
 ```
-yarn instrument
+yarn instrumenter
 ```
 
 or via `npx` by running
@@ -74,24 +74,17 @@ the file must contain source-map information, or the source-map file
 must be placed along with the source file in the same directory.
 
 ```
-yarn run --inplace ./the/path/to/the/file.js
+yarn instrumenter --inplace ./the/path/to/the/file.js
 ```
 
 ```
-yarn run --inplace ./the/path/to/the/file.js --source-map ./the/path/to/the/source.map
+yarn instrumenter --inplace ./the/path/to/the/file.js --source-map ./the/path/to/the/source.map
 ```
 
 ```
-yarn run ./the/path/to/the/file.js --to ./the/file/path/to/write/to.js
+yarn instrumenter ./the/path/to/the/file.js --to ./the/file/path/to/write/to.js
 ```
 
-### Instrumenting all JavaScript Files in a Folder
-
-We think that dealing with sets of files, in particular including or excluding
-files that match particular file masks should be done by other tools.
-In a UNIX environment, you should consider using `find` with corresponding
-filters and an `-exec` argument to run the instrumenter.
-
 ### Integration with Testing Frameworks
 
 This is planned work: Provide a Babel plugin that provides a code transformation

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@teamscale/javascript-instrumenter",
-    "version": "0.0.1-beta.2",
+    "version": "0.0.1-beta.9",
     "description": "Istanbul-based coverage instrumenter with coverage forwarding via WebSockets",
     "main": "dist/src/main.js",
     "bin": "dist/src/main.js",
@@ -14,7 +14,7 @@
     "scripts": {
         "clean": "rimraf dist tsconfig.tsbuildinfo",
         "build": "tsc --project tsconfig.json && node esbuild.mjs",
-        "instrument": "node dist/src/main.js",
+        "instrumenter": "node dist/src/main.js",
         "test": "yarn build && NODE_OPTIONS='--experimental-vm-modules' jest --forceExit --coverage --silent=true --detectOpenHandles"
     },
     "files": [

package/dist/src/App.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"App.d.ts","sourceRoot":"","sources":["../../src/App.ts"],"names":[],"mappings":"AACA,OAAO,EAAuB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAGtE,OAAO,EAAE,uBAAuB,EAAe,MAAM,4BAA4B,CAAC;AAGlF,OAAgB,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAG1C;;GAEG;AACH,qBAAa,GAAG;IACf;;;OAGG;WACiB,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;IAa9C;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IA6B1B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IAa1B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAS/B;;;;;OAKG;WACW,qBAAqB,CAAC,MAAM,EAAE,uBAAuB,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAO1G,OAAO,CAAC,MAAM,CAAC,yBAAyB;IAIxC,OAAO,CAAC,MAAM,CAAC,kBAAkB;CAajC"}
+{"version":3,"file":"App.d.ts","sourceRoot":"","sources":["../../src/App.ts"],"names":[],"mappings":"AACA,OAAO,EAAuB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAGtE,OAAO,EAAE,uBAAuB,EAAe,MAAM,4BAA4B,CAAC;AAGlF,OAAgB,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAG1C;;GAEG;AACH,qBAAa,GAAG;IACf;;;OAGG;WACiB,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;IAa9C;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IAgC1B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IAa1B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAS/B;;;;;OAKG;WACW,qBAAqB,CAAC,MAAM,EAAE,uBAAuB,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAO1G,OAAO,CAAC,MAAM,CAAC,yBAAyB;IAIxC,OAAO,CAAC,MAAM,CAAC,kBAAkB;CAajC"}

package/dist/src/App.js

@@ -57,10 +57,13 @@ class App {
             description: 'Instrumenter of the Teamscale JavaScript Profiler'
         });
         parser.add_argument('-v', '--version', { action: 'version', version: package_json_1.version });
-        parser.add_argument('-i', '--in-place', { action: 'store_true' });
+        parser.add_argument('-i', '--in-place', {
+            action: 'store_true',
+            help: 'If set, the original files to instrument are replaced by their instrumented counterparts.'
+        });
         parser.add_argument('-d', '--debug', { action: 'store_true' });
         parser.add_argument('-o', '--to', {
-            help: 'Name of the file to write the instrumented version to.'
+            help: 'Path (directory or file name) to write the instrumented version to.'
         });
         parser.add_argument('-s', '--source-map', {
             help: 'External location of source-map files to consider.'

package/dist/vaccine.js

@@ -1,221 +1 @@
-(() => {
-  var __create = Object.create;
-  var __defProp = Object.defineProperty;
-  var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-  var __getOwnPropNames = Object.getOwnPropertyNames;
-  var __getProtoOf = Object.getPrototypeOf;
-  var __hasOwnProp = Object.prototype.hasOwnProperty;
-  var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
-  var __commonJS = (cb, mod) => function __require() {
-    return mod || (0, cb[Object.keys(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
-  };
-  var __reExport = (target, module, desc) => {
-    if (module && typeof module === "object" || typeof module === "function") {
-      for (let key of __getOwnPropNames(module))
-        if (!__hasOwnProp.call(target, key) && key !== "default")
-          __defProp(target, key, { get: () => module[key], enumerable: !(desc = __getOwnPropDesc(module, key)) || desc.enumerable });
-    }
-    return target;
-  };
-  var __toModule = (module) => {
-    return __reExport(__markAsModule(__defProp(module != null ? __create(__getProtoOf(module)) : {}, "default", module && module.__esModule && "default" in module ? { get: () => module.default, enumerable: true } : { value: module, enumerable: true })), module);
-  };
-
-  // ../../node_modules/detect-node/browser.js
-  var require_browser = __commonJS({
-    "../../node_modules/detect-node/browser.js"(exports, module) {
-      module.exports = false;
-    }
-  });
-
-  // (disabled):../../node_modules/unload/dist/es/node.js
-  var require_node = __commonJS({
-    "(disabled):../../node_modules/unload/dist/es/node.js"() {
-    }
-  });
-
-  // inline-worker:__inline-worker
-  function inlineWorker(scriptText) {
-    let blob = new Blob([scriptText], { type: "text/javascript" });
-    let url = URL.createObjectURL(blob);
-    let worker = new Worker(url);
-    URL.revokeObjectURL(url);
-    return worker;
-  }
-
-  // src/vaccine/worker/vaccine.worker.ts
-  function Worker2() {
-    return inlineWorker('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');
-  }
-
-  // src/vaccine/utils.ts
-  function universe() {
-    return getWindow();
-  }
-  function hasWindow() {
-    return typeof window !== "undefined";
-  }
-  function getWindow() {
-    return window;
-  }
-  function universeAttribute(attributeName, defaultValue) {
-    let result = universe()[attributeName];
-    if (!result) {
-      result = defaultValue;
-      universe()[attributeName] = result;
-    }
-    return result;
-  }
-
-  // src/vaccine/Interceptor.ts
-  var STATEMENT_COVERAGE_ID = "s";
-  var Interceptor = class {
-    constructor(coverageObj, path) {
-      this.coverageObj = coverageObj;
-      this.path = path;
-    }
-    get(target, prop, receiver) {
-      const value = target[prop];
-      if (value !== Object(value)) {
-        return value;
-      }
-      return makeProxy(this.coverageObj, value, [...this.path, prop]);
-    }
-    set(obj, prop, value) {
-      const fullPath = [...this.path, prop];
-      if (fullPath[0] === STATEMENT_COVERAGE_ID) {
-        const fileId = this.coverageObj.hash;
-        const start = this.coverageObj.statementMap[fullPath[1]].start;
-        universe()._$Bc(fileId, start.line, start.column);
-      }
-      return true;
-    }
-  };
-  function makeProxy(coverage, target, path) {
-    return new Proxy(target, new Interceptor(coverage, path));
-  }
-
-  // ../../node_modules/unload/dist/es/index.js
-  var import_detect_node = __toModule(require_browser());
-
-  // ../../node_modules/unload/dist/es/browser.js
-  function add(fn) {
-    if (typeof WorkerGlobalScope === "function" && self instanceof WorkerGlobalScope) {
-    } else {
-      if (typeof window.addEventListener !== "function")
-        return;
-      window.addEventListener("beforeunload", function() {
-        fn();
-      }, true);
-      window.addEventListener("unload", function() {
-        fn();
-      }, true);
-    }
-  }
-  var browser_default = {
-    add
-  };
-
-  // ../../node_modules/unload/dist/es/index.js
-  var import_node = __toModule(require_node());
-  var USE_METHOD = import_detect_node.default ? import_node.default : browser_default;
-  var LISTENERS = new Set();
-  var startedListening = false;
-  function startListening() {
-    if (startedListening)
-      return;
-    startedListening = true;
-    USE_METHOD.add(runAll);
-  }
-  function add2(fn) {
-    startListening();
-    if (typeof fn !== "function")
-      throw new Error("Listener is no function");
-    LISTENERS.add(fn);
-    var addReturn = {
-      remove: function remove() {
-        return LISTENERS["delete"](fn);
-      },
-      run: function run() {
-        LISTENERS["delete"](fn);
-        return fn();
-      }
-    };
-    return addReturn;
-  }
-  function runAll() {
-    var promises = [];
-    LISTENERS.forEach(function(fn) {
-      promises.push(fn());
-      LISTENERS["delete"](fn);
-    });
-    return Promise.all(promises);
-  }
-
-  // src/vaccine/protocol.ts
-  var ProtocolMessageTypes;
-  (function(ProtocolMessageTypes2) {
-    ProtocolMessageTypes2["MESSAGE_TYPE_SOURCEMAP"] = "s";
-    ProtocolMessageTypes2["MESSAGE_TYPE_COVERAGE"] = "c";
-  })(ProtocolMessageTypes || (ProtocolMessageTypes = {}));
-
-  // src/vaccine/main.ts
-  var globalAgentObject = universeAttribute("__TS_AGENT", {});
-  function getWorker() {
-    return globalAgentObject._$BcWorker;
-  }
-  function setWorker(worker) {
-    globalAgentObject._$BcWorker = worker;
-    return worker;
-  }
-  universe().makeCoverageInterceptor = function(coverage) {
-    const fileId = coverage.hash;
-    if (!getWorker()) {
-      const worker = setWorker(new Worker2());
-      (function handleUnloading() {
-        const protectWindowEvent = function(name) {
-          let wrappedHandler = getWindow()[name];
-          getWindow()[name] = function(...args) {
-            worker.postMessage("unload");
-            if (wrappedHandler) {
-              return wrappedHandler.apply(this, args);
-            }
-          };
-          if (hasWindow()) {
-            Object.defineProperty(getWindow(), name, {
-              get: function() {
-                return wrappedHandler;
-              },
-              set: function(newHandler) {
-                wrappedHandler = newHandler;
-              }
-            });
-          }
-        };
-        protectWindowEvent("onunload");
-        protectWindowEvent("onbeforeunload");
-        add2(() => worker.postMessage("unload"));
-      })();
-    }
-    (function sendSourceMaps() {
-      const sentMaps = universeAttribute("sentMaps", new Set());
-      if (coverage.inputSourceMap) {
-        if (!sentMaps.has(coverage.path)) {
-          getWorker().postMessage(`${ProtocolMessageTypes.MESSAGE_TYPE_SOURCEMAP} ${fileId}:${JSON.stringify(coverage.inputSourceMap)}`);
-          sentMaps.add(coverage.path);
-        }
-      }
-    })();
-    (function registerCoverageReporter() {
-      const reported = new Set();
-      universe()._$Bc = (fileId2, coveredLine, coveredColumn) => {
-        const coverageMessage = `${fileId2}:${coveredLine}:${coveredColumn}`;
-        if (!reported.has(coverageMessage)) {
-          getWorker().postMessage(coverageMessage);
-          reported.add(coverageMessage);
-        }
-      };
-    })();
-    return makeProxy(coverage, coverage, []);
-  };
-})();
+(()=>{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,[])};})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teamscale/javascript-instrumenter",
-  "version": "0.0.1-beta.2",
+  "version": "0.0.1-beta.9",
   "description": "Istanbul-based coverage instrumenter with coverage forwarding via WebSockets",
   "main": "dist/src/main.js",
   "bin": "dist/src/main.js",
@@ -14,7 +14,7 @@
   "scripts": {
     "clean": "rimraf dist tsconfig.tsbuildinfo",
     "build": "tsc --project tsconfig.json && node esbuild.mjs",
-    "instrument": "node dist/src/main.js",
+    "instrumenter": "node dist/src/main.js",
     "test": "yarn build && NODE_OPTIONS='--experimental-vm-modules' jest --forceExit --coverage --silent=true --detectOpenHandles"
   },
   "files": [