@webiny/api 0.0.0-unstable.9e825fd5fb → 0.0.0-unstable.aa00eecd97

package/Benchmark.d.ts

@@ -1,4 +1,4 @@
-import { Benchmark as BenchmarkInterface, BenchmarkEnableOnCallable, BenchmarkMeasurement, BenchmarkOutputCallable, BenchmarkRuns } from "./types";
+import { Benchmark as BenchmarkInterface, BenchmarkEnableOnCallable, BenchmarkMeasurement, BenchmarkMeasureOptions, BenchmarkOutputCallable, BenchmarkRuns } from "./types";
 export declare class Benchmark implements BenchmarkInterface {
     readonly measurements: BenchmarkMeasurement[];
     private outputDone;
@@ -9,7 +9,6 @@ export declare class Benchmark implements BenchmarkInterface {
     private readonly onOutputCallables;
     private state;
     get elapsed(): number;
-    constructor();
     enableOn(cb: BenchmarkEnableOnCallable): void;
     onOutput(cb: BenchmarkOutputCallable): void;
     enable(): void;
@@ -17,10 +16,10 @@ export declare class Benchmark implements BenchmarkInterface {
     /**
      * When running the output, we need to reverse the callables array, so that the last one added is the first one executed.
      *
-     * The first one is our built-in console.log output, which we want to be the last one executed - and we need to stop output if user wants to end it.
+     * The last one is our built-in console.log output.
      */
     output(): Promise<void>;
-    measure<T = any>(name: string, cb: () => Promise<T>): Promise<T>;
+    measure<T = any>(options: BenchmarkMeasureOptions | string, cb: () => Promise<T>): Promise<T>;
     private getIsAlreadyRunning;
     private startRunning;
     private endRunning;

package/Benchmark.js

@@ -6,17 +6,22 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.Benchmark = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var _types = require("./types");
 var BenchmarkState;
 (function (BenchmarkState) {
   BenchmarkState["DISABLED"] = "disabled";
   BenchmarkState["ENABLED"] = "enabled";
   BenchmarkState["UNDETERMINED"] = "undetermined";
 })(BenchmarkState || (BenchmarkState = {}));
+const createDefaultOutputCallable = () => {
+  return async ({
+    benchmark
+  }) => {
+    console.log(`Benchmark total time elapsed: ${benchmark.elapsed}ms`);
+    console.log("Benchmark measurements:");
+    console.log(benchmark.measurements);
+  };
+};
 class Benchmark {
-  get elapsed() {
-    return this.totalElapsed;
-  }
   constructor() {
     (0, _defineProperty2.default)(this, "measurements", []);
     (0, _defineProperty2.default)(this, "outputDone", false);
@@ -26,15 +31,9 @@ class Benchmark {
     (0, _defineProperty2.default)(this, "enableOnCallables", []);
     (0, _defineProperty2.default)(this, "onOutputCallables", []);
     (0, _defineProperty2.default)(this, "state", BenchmarkState.UNDETERMINED);
-    /**
-     * The default output is to the console.
-     * This one is executed after all other user defined outputs.
-     */
-    this.onOutputCallables.push(async () => {
-      console.log(`Benchmark total time elapsed: ${this.elapsed}ms`);
-      console.log("Benchmark measurements:");
-      console.log(this.measurements);
-    });
+  }
+  get elapsed() {
+    return this.totalElapsed;
   }
   enableOn(cb) {
     this.enableOnCallables.push(cb);
@@ -52,7 +51,7 @@ class Benchmark {
   /**
    * When running the output, we need to reverse the callables array, so that the last one added is the first one executed.
    *
-   * The first one is our built-in console.log output, which we want to be the last one executed - and we need to stop output if user wants to end it.
+   * The last one is our built-in console.log output.
    */
   async output() {
     /**
@@ -61,21 +60,25 @@ class Benchmark {
     if (this.outputDone || this.measurements.length === 0) {
       return;
     }
-    const callables = this.onOutputCallables.reverse();
+    const callables = [...this.onOutputCallables].reverse();
+    callables.push(createDefaultOutputCallable());
     for (const cb of callables) {
-      const result = await cb(this);
-      if (result === _types.BenchmarkOutputCallableResponse.BREAK) {
+      const result = await cb({
+        benchmark: this,
+        stop: () => "stop"
+      });
+      if (result === "stop") {
         return;
       }
     }
     this.outputDone = true;
   }
-  async measure(name, cb) {
+  async measure(options, cb) {
     const enabled = await this.getIsEnabled();
     if (!enabled) {
       return cb();
     }
-    const measurement = this.startMeasurement(name);
+    const measurement = this.startMeasurement(options);
     const isAlreadyRunning = this.getIsAlreadyRunning();
     this.startRunning();
     try {
@@ -83,7 +86,7 @@ class Benchmark {
     } finally {
       const measurementEnded = this.stopMeasurement(measurement);
       this.measurements.push(measurementEnded);
-      this.addRun(measurementEnded.name);
+      this.addRun(measurementEnded);
       /**
        * Only add to total time if this run is not a child of another run.
        * And then end running.
@@ -122,7 +125,8 @@ class Benchmark {
   addElapsed(measurement) {
     this.totalElapsed = this.totalElapsed + measurement.elapsed;
   }
-  addRun(name) {
+  addRun(measurement) {
+    const name = `${measurement.category}#${measurement.name}`;
     if (!this.runs[name]) {
       this.runs[name] = 0;
     }
@@ -131,9 +135,12 @@ class Benchmark {
   setState(state) {
     this.state = state;
   }
-  startMeasurement(name) {
+  startMeasurement(options) {
+    const name = typeof options === "string" ? options : options.name;
+    const category = typeof options === "string" ? "webiny" : options.category;
     return {
       name,
+      category,
       start: new Date(),
       memoryStart: process.memoryUsage().heapUsed
     };
@@ -144,6 +151,7 @@ class Benchmark {
     const elapsed = end.getTime() - measurement.start.getTime();
     return {
       name: measurement.name,
+      category: measurement.category,
       start: measurement.start,
       end,
       elapsed,

package/Benchmark.js.map

@@ -1 +1 @@
-{"version":3,"names":["BenchmarkState","Benchmark","elapsed","totalElapsed","constructor","UNDETERMINED","onOutputCallables","push","console","log","measurements","enableOn","cb","enableOnCallables","onOutput","enable","setState","ENABLED","disable","DISABLED","output","outputDone","length","callables","reverse","result","BenchmarkOutputCallableResponse","BREAK","measure","name","enabled","getIsEnabled","measurement","startMeasurement","isAlreadyRunning","getIsAlreadyRunning","startRunning","measurementEnded","stopMeasurement","addRun","addElapsed","endRunning","state","runs","start","Date","memoryStart","process","memoryUsage","heapUsed","end","memoryEnd","getTime","memory"],"sources":["Benchmark.ts"],"sourcesContent":["import {\n    Benchmark as BenchmarkInterface,\n    BenchmarkEnableOnCallable,\n    BenchmarkMeasurement,\n    BenchmarkOutputCallable,\n    BenchmarkOutputCallableResponse,\n    BenchmarkRuns\n} from \"~/types\";\n\nenum BenchmarkState {\n    DISABLED = \"disabled\",\n    ENABLED = \"enabled\",\n    UNDETERMINED = \"undetermined\"\n}\n\ninterface BenchmarkMeasurementStart extends Pick<BenchmarkMeasurement, \"name\" | \"start\"> {\n    memoryStart: number;\n}\n\nexport class Benchmark implements BenchmarkInterface {\n    public readonly measurements: BenchmarkMeasurement[] = [];\n\n    private outputDone = false;\n    private isAlreadyRunning = false;\n    private totalElapsed = 0;\n    public readonly runs: BenchmarkRuns = {};\n    private readonly enableOnCallables: BenchmarkEnableOnCallable[] = [];\n    private readonly onOutputCallables: BenchmarkOutputCallable[] = [];\n    private state: BenchmarkState = BenchmarkState.UNDETERMINED;\n\n    public get elapsed(): number {\n        return this.totalElapsed;\n    }\n\n    public constructor() {\n        /**\n         * The default output is to the console.\n         * This one is executed after all other user defined outputs.\n         */\n        this.onOutputCallables.push(async () => {\n            console.log(`Benchmark total time elapsed: ${this.elapsed}ms`);\n            console.log(\"Benchmark measurements:\");\n            console.log(this.measurements);\n        });\n    }\n\n    public enableOn(cb: BenchmarkEnableOnCallable): void {\n        this.enableOnCallables.push(cb);\n    }\n\n    public onOutput(cb: BenchmarkOutputCallable): void {\n        this.onOutputCallables.push(cb);\n    }\n\n    public enable(): void {\n        this.setState(BenchmarkState.ENABLED);\n    }\n\n    public disable(): void {\n        this.setState(BenchmarkState.DISABLED);\n    }\n\n    /**\n     * When running the output, we need to reverse the callables array, so that the last one added is the first one executed.\n     *\n     * The first one is our built-in console.log output, which we want to be the last one executed - and we need to stop output if user wants to end it.\n     */\n    public async output(): Promise<void> {\n        /**\n         * No point in outputting more than once or if no measurements were made.\n         */\n        if (this.outputDone || this.measurements.length === 0) {\n            return;\n        }\n        const callables = this.onOutputCallables.reverse();\n        for (const cb of callables) {\n            const result = await cb(this);\n            if (result === BenchmarkOutputCallableResponse.BREAK) {\n                return;\n            }\n        }\n        this.outputDone = true;\n    }\n\n    public async measure<T = any>(name: string, cb: () => Promise<T>): Promise<T> {\n        const enabled = await this.getIsEnabled();\n        if (!enabled) {\n            return cb();\n        }\n        const measurement = this.startMeasurement(name);\n        const isAlreadyRunning = this.getIsAlreadyRunning();\n        this.startRunning();\n        try {\n            return await cb();\n        } finally {\n            const measurementEnded = this.stopMeasurement(measurement);\n            this.measurements.push(measurementEnded);\n            this.addRun(measurementEnded.name);\n            /**\n             * Only add to total time if this run is not a child of another run.\n             * And then end running.\n             */\n            if (!isAlreadyRunning) {\n                this.addElapsed(measurementEnded);\n                this.endRunning();\n            }\n        }\n    }\n\n    private getIsAlreadyRunning(): boolean {\n        return this.isAlreadyRunning;\n    }\n    private startRunning(): void {\n        this.isAlreadyRunning = true;\n    }\n    private endRunning(): void {\n        this.isAlreadyRunning = false;\n    }\n\n    private async getIsEnabled(): Promise<boolean> {\n        if (this.state === BenchmarkState.ENABLED) {\n            return true;\n        } else if (this.state === BenchmarkState.DISABLED) {\n            return false;\n        }\n\n        for (const cb of this.enableOnCallables) {\n            const result = await cb();\n            if (result) {\n                this.enable();\n                return true;\n            }\n        }\n        this.disable();\n        return false;\n    }\n\n    private addElapsed(measurement: Pick<BenchmarkMeasurement, \"elapsed\">): void {\n        this.totalElapsed = this.totalElapsed + measurement.elapsed;\n    }\n\n    private addRun(name: string): void {\n        if (!this.runs[name]) {\n            this.runs[name] = 0;\n        }\n        this.runs[name]++;\n    }\n\n    private setState(state: BenchmarkState): void {\n        this.state = state;\n    }\n\n    private startMeasurement(name: string): BenchmarkMeasurementStart {\n        return {\n            name,\n            start: new Date(),\n            memoryStart: process.memoryUsage().heapUsed\n        };\n    }\n\n    private stopMeasurement(measurement: BenchmarkMeasurementStart): BenchmarkMeasurement {\n        const end = new Date();\n        const memoryEnd = process.memoryUsage().heapUsed;\n        const elapsed = end.getTime() - measurement.start.getTime();\n        return {\n            name: measurement.name,\n            start: measurement.start,\n            end,\n            elapsed,\n            memory: memoryEnd - measurement.memoryStart\n        };\n    }\n}\n"],"mappings":";;;;;;;;AAAA;AAOiB,IAEZA,cAAc;AAAA,WAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;AAAA,GAAdA,cAAc,KAAdA,cAAc;AAUZ,MAAMC,SAAS,CAA+B;EAWjD,IAAWC,OAAO,GAAW;IACzB,OAAO,IAAI,CAACC,YAAY;EAC5B;EAEOC,WAAW,GAAG;IAAA,oDAdkC,EAAE;IAAA,kDAEpC,KAAK;IAAA,wDACC,KAAK;IAAA,oDACT,CAAC;IAAA,4CACc,CAAC,CAAC;IAAA,yDAC0B,EAAE;IAAA,yDACJ,EAAE;IAAA,6CAClCJ,cAAc,CAACK,YAAY;IAOvD;AACR;AACA;AACA;IACQ,IAAI,CAACC,iBAAiB,CAACC,IAAI,CAAC,YAAY;MACpCC,OAAO,CAACC,GAAG,CAAE,iCAAgC,IAAI,CAACP,OAAQ,IAAG,CAAC;MAC9DM,OAAO,CAACC,GAAG,CAAC,yBAAyB,CAAC;MACtCD,OAAO,CAACC,GAAG,CAAC,IAAI,CAACC,YAAY,CAAC;IAClC,CAAC,CAAC;EACN;EAEOC,QAAQ,CAACC,EAA6B,EAAQ;IACjD,IAAI,CAACC,iBAAiB,CAACN,IAAI,CAACK,EAAE,CAAC;EACnC;EAEOE,QAAQ,CAACF,EAA2B,EAAQ;IAC/C,IAAI,CAACN,iBAAiB,CAACC,IAAI,CAACK,EAAE,CAAC;EACnC;EAEOG,MAAM,GAAS;IAClB,IAAI,CAACC,QAAQ,CAAChB,cAAc,CAACiB,OAAO,CAAC;EACzC;EAEOC,OAAO,GAAS;IACnB,IAAI,CAACF,QAAQ,CAAChB,cAAc,CAACmB,QAAQ,CAAC;EAC1C;;EAEA;AACJ;AACA;AACA;AACA;EACI,MAAaC,MAAM,GAAkB;IACjC;AACR;AACA;IACQ,IAAI,IAAI,CAACC,UAAU,IAAI,IAAI,CAACX,YAAY,CAACY,MAAM,KAAK,CAAC,EAAE;MACnD;IACJ;IACA,MAAMC,SAAS,GAAG,IAAI,CAACjB,iBAAiB,CAACkB,OAAO,EAAE;IAClD,KAAK,MAAMZ,EAAE,IAAIW,SAAS,EAAE;MACxB,MAAME,MAAM,GAAG,MAAMb,EAAE,CAAC,IAAI,CAAC;MAC7B,IAAIa,MAAM,KAAKC,sCAA+B,CAACC,KAAK,EAAE;QAClD;MACJ;IACJ;IACA,IAAI,CAACN,UAAU,GAAG,IAAI;EAC1B;EAEA,MAAaO,OAAO,CAAUC,IAAY,EAAEjB,EAAoB,EAAc;IAC1E,MAAMkB,OAAO,GAAG,MAAM,IAAI,CAACC,YAAY,EAAE;IACzC,IAAI,CAACD,OAAO,EAAE;MACV,OAAOlB,EAAE,EAAE;IACf;IACA,MAAMoB,WAAW,GAAG,IAAI,CAACC,gBAAgB,CAACJ,IAAI,CAAC;IAC/C,MAAMK,gBAAgB,GAAG,IAAI,CAACC,mBAAmB,EAAE;IACnD,IAAI,CAACC,YAAY,EAAE;IACnB,IAAI;MACA,OAAO,MAAMxB,EAAE,EAAE;IACrB,CAAC,SAAS;MACN,MAAMyB,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAACN,WAAW,CAAC;MAC1D,IAAI,CAACtB,YAAY,CAACH,IAAI,CAAC8B,gBAAgB,CAAC;MACxC,IAAI,CAACE,MAAM,CAACF,gBAAgB,CAACR,IAAI,CAAC;MAClC;AACZ;AACA;AACA;MACY,IAAI,CAACK,gBAAgB,EAAE;QACnB,IAAI,CAACM,UAAU,CAACH,gBAAgB,CAAC;QACjC,IAAI,CAACI,UAAU,EAAE;MACrB;IACJ;EACJ;EAEQN,mBAAmB,GAAY;IACnC,OAAO,IAAI,CAACD,gBAAgB;EAChC;EACQE,YAAY,GAAS;IACzB,IAAI,CAACF,gBAAgB,GAAG,IAAI;EAChC;EACQO,UAAU,GAAS;IACvB,IAAI,CAACP,gBAAgB,GAAG,KAAK;EACjC;EAEA,MAAcH,YAAY,GAAqB;IAC3C,IAAI,IAAI,CAACW,KAAK,KAAK1C,cAAc,CAACiB,OAAO,EAAE;MACvC,OAAO,IAAI;IACf,CAAC,MAAM,IAAI,IAAI,CAACyB,KAAK,KAAK1C,cAAc,CAACmB,QAAQ,EAAE;MAC/C,OAAO,KAAK;IAChB;IAEA,KAAK,MAAMP,EAAE,IAAI,IAAI,CAACC,iBAAiB,EAAE;MACrC,MAAMY,MAAM,GAAG,MAAMb,EAAE,EAAE;MACzB,IAAIa,MAAM,EAAE;QACR,IAAI,CAACV,MAAM,EAAE;QACb,OAAO,IAAI;MACf;IACJ;IACA,IAAI,CAACG,OAAO,EAAE;IACd,OAAO,KAAK;EAChB;EAEQsB,UAAU,CAACR,WAAkD,EAAQ;IACzE,IAAI,CAAC7B,YAAY,GAAG,IAAI,CAACA,YAAY,GAAG6B,WAAW,CAAC9B,OAAO;EAC/D;EAEQqC,MAAM,CAACV,IAAY,EAAQ;IAC/B,IAAI,CAAC,IAAI,CAACc,IAAI,CAACd,IAAI,CAAC,EAAE;MAClB,IAAI,CAACc,IAAI,CAACd,IAAI,CAAC,GAAG,CAAC;IACvB;IACA,IAAI,CAACc,IAAI,CAACd,IAAI,CAAC,EAAE;EACrB;EAEQb,QAAQ,CAAC0B,KAAqB,EAAQ;IAC1C,IAAI,CAACA,KAAK,GAAGA,KAAK;EACtB;EAEQT,gBAAgB,CAACJ,IAAY,EAA6B;IAC9D,OAAO;MACHA,IAAI;MACJe,KAAK,EAAE,IAAIC,IAAI,EAAE;MACjBC,WAAW,EAAEC,OAAO,CAACC,WAAW,EAAE,CAACC;IACvC,CAAC;EACL;EAEQX,eAAe,CAACN,WAAsC,EAAwB;IAClF,MAAMkB,GAAG,GAAG,IAAIL,IAAI,EAAE;IACtB,MAAMM,SAAS,GAAGJ,OAAO,CAACC,WAAW,EAAE,CAACC,QAAQ;IAChD,MAAM/C,OAAO,GAAGgD,GAAG,CAACE,OAAO,EAAE,GAAGpB,WAAW,CAACY,KAAK,CAACQ,OAAO,EAAE;IAC3D,OAAO;MACHvB,IAAI,EAAEG,WAAW,CAACH,IAAI;MACtBe,KAAK,EAAEZ,WAAW,CAACY,KAAK;MACxBM,GAAG;MACHhD,OAAO;MACPmD,MAAM,EAAEF,SAAS,GAAGnB,WAAW,CAACc;IACpC,CAAC;EACL;AACJ;AAAC"}
+{"version":3,"names":["BenchmarkState","createDefaultOutputCallable","benchmark","console","log","elapsed","measurements","Benchmark","UNDETERMINED","totalElapsed","enableOn","cb","enableOnCallables","push","onOutput","onOutputCallables","enable","setState","ENABLED","disable","DISABLED","output","outputDone","length","callables","reverse","result","stop","measure","options","enabled","getIsEnabled","measurement","startMeasurement","isAlreadyRunning","getIsAlreadyRunning","startRunning","measurementEnded","stopMeasurement","addRun","addElapsed","endRunning","state","name","category","runs","start","Date","memoryStart","process","memoryUsage","heapUsed","end","memoryEnd","getTime","memory"],"sources":["Benchmark.ts"],"sourcesContent":["import {\n    Benchmark as BenchmarkInterface,\n    BenchmarkEnableOnCallable,\n    BenchmarkMeasurement,\n    BenchmarkMeasureOptions,\n    BenchmarkOutputCallable,\n    BenchmarkRuns\n} from \"~/types\";\n\nenum BenchmarkState {\n    DISABLED = \"disabled\",\n    ENABLED = \"enabled\",\n    UNDETERMINED = \"undetermined\"\n}\n\ninterface BenchmarkMeasurementStart\n    extends Pick<BenchmarkMeasurement, \"name\" | \"category\" | \"start\"> {\n    memoryStart: number;\n}\n\nconst createDefaultOutputCallable = (): BenchmarkOutputCallable => {\n    return async ({ benchmark }) => {\n        console.log(`Benchmark total time elapsed: ${benchmark.elapsed}ms`);\n        console.log(\"Benchmark measurements:\");\n        console.log(benchmark.measurements);\n    };\n};\n\nexport class Benchmark implements BenchmarkInterface {\n    public readonly measurements: BenchmarkMeasurement[] = [];\n\n    private outputDone = false;\n    private isAlreadyRunning = false;\n    private totalElapsed = 0;\n    public readonly runs: BenchmarkRuns = {};\n    private readonly enableOnCallables: BenchmarkEnableOnCallable[] = [];\n    private readonly onOutputCallables: BenchmarkOutputCallable[] = [];\n    private state: BenchmarkState = BenchmarkState.UNDETERMINED;\n\n    public get elapsed(): number {\n        return this.totalElapsed;\n    }\n\n    public enableOn(cb: BenchmarkEnableOnCallable): void {\n        this.enableOnCallables.push(cb);\n    }\n\n    public onOutput(cb: BenchmarkOutputCallable): void {\n        this.onOutputCallables.push(cb);\n    }\n\n    public enable(): void {\n        this.setState(BenchmarkState.ENABLED);\n    }\n\n    public disable(): void {\n        this.setState(BenchmarkState.DISABLED);\n    }\n\n    /**\n     * When running the output, we need to reverse the callables array, so that the last one added is the first one executed.\n     *\n     * The last one is our built-in console.log output.\n     */\n    public async output(): Promise<void> {\n        /**\n         * No point in outputting more than once or if no measurements were made.\n         */\n        if (this.outputDone || this.measurements.length === 0) {\n            return;\n        }\n        const callables = [...this.onOutputCallables].reverse();\n        callables.push(createDefaultOutputCallable());\n        for (const cb of callables) {\n            const result = await cb({\n                benchmark: this,\n                stop: () => \"stop\"\n            });\n            if (result === \"stop\") {\n                return;\n            }\n        }\n        this.outputDone = true;\n    }\n\n    public async measure<T = any>(\n        options: BenchmarkMeasureOptions | string,\n        cb: () => Promise<T>\n    ): Promise<T> {\n        const enabled = await this.getIsEnabled();\n        if (!enabled) {\n            return cb();\n        }\n        const measurement = this.startMeasurement(options);\n        const isAlreadyRunning = this.getIsAlreadyRunning();\n        this.startRunning();\n        try {\n            return await cb();\n        } finally {\n            const measurementEnded = this.stopMeasurement(measurement);\n            this.measurements.push(measurementEnded);\n            this.addRun(measurementEnded);\n            /**\n             * Only add to total time if this run is not a child of another run.\n             * And then end running.\n             */\n            if (!isAlreadyRunning) {\n                this.addElapsed(measurementEnded);\n                this.endRunning();\n            }\n        }\n    }\n\n    private getIsAlreadyRunning(): boolean {\n        return this.isAlreadyRunning;\n    }\n    private startRunning(): void {\n        this.isAlreadyRunning = true;\n    }\n    private endRunning(): void {\n        this.isAlreadyRunning = false;\n    }\n\n    private async getIsEnabled(): Promise<boolean> {\n        if (this.state === BenchmarkState.ENABLED) {\n            return true;\n        } else if (this.state === BenchmarkState.DISABLED) {\n            return false;\n        }\n\n        for (const cb of this.enableOnCallables) {\n            const result = await cb();\n            if (result) {\n                this.enable();\n                return true;\n            }\n        }\n        this.disable();\n        return false;\n    }\n\n    private addElapsed(measurement: Pick<BenchmarkMeasurement, \"elapsed\">): void {\n        this.totalElapsed = this.totalElapsed + measurement.elapsed;\n    }\n\n    private addRun(measurement: Pick<BenchmarkMeasurement, \"name\" | \"category\">): void {\n        const name = `${measurement.category}#${measurement.name}`;\n        if (!this.runs[name]) {\n            this.runs[name] = 0;\n        }\n        this.runs[name]++;\n    }\n\n    private setState(state: BenchmarkState): void {\n        this.state = state;\n    }\n\n    private startMeasurement(options: BenchmarkMeasureOptions | string): BenchmarkMeasurementStart {\n        const name = typeof options === \"string\" ? options : options.name;\n        const category = typeof options === \"string\" ? \"webiny\" : options.category;\n        return {\n            name,\n            category,\n            start: new Date(),\n            memoryStart: process.memoryUsage().heapUsed\n        };\n    }\n\n    private stopMeasurement(measurement: BenchmarkMeasurementStart): BenchmarkMeasurement {\n        const end = new Date();\n        const memoryEnd = process.memoryUsage().heapUsed;\n        const elapsed = end.getTime() - measurement.start.getTime();\n        return {\n            name: measurement.name,\n            category: measurement.category,\n            start: measurement.start,\n            end,\n            elapsed,\n            memory: memoryEnd - measurement.memoryStart\n        };\n    }\n}\n"],"mappings":";;;;;;;;IASKA,cAAc;AAAA,WAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;AAAA,GAAdA,cAAc,KAAdA,cAAc;AAWnB,MAAMC,2BAA2B,GAAG,MAA+B;EAC/D,OAAO,OAAO;IAAEC;EAAU,CAAC,KAAK;IAC5BC,OAAO,CAACC,GAAG,CAAE,iCAAgCF,SAAS,CAACG,OAAQ,IAAG,CAAC;IACnEF,OAAO,CAACC,GAAG,CAAC,yBAAyB,CAAC;IACtCD,OAAO,CAACC,GAAG,CAACF,SAAS,CAACI,YAAY,CAAC;EACvC,CAAC;AACL,CAAC;AAEM,MAAMC,SAAS,CAA+B;EAAA;IAAA,oDACM,EAAE;IAAA,kDAEpC,KAAK;IAAA,wDACC,KAAK;IAAA,oDACT,CAAC;IAAA,4CACc,CAAC,CAAC;IAAA,yDAC0B,EAAE;IAAA,yDACJ,EAAE;IAAA,6CAClCP,cAAc,CAACQ,YAAY;EAAA;EAE3D,IAAWH,OAAO,GAAW;IACzB,OAAO,IAAI,CAACI,YAAY;EAC5B;EAEOC,QAAQ,CAACC,EAA6B,EAAQ;IACjD,IAAI,CAACC,iBAAiB,CAACC,IAAI,CAACF,EAAE,CAAC;EACnC;EAEOG,QAAQ,CAACH,EAA2B,EAAQ;IAC/C,IAAI,CAACI,iBAAiB,CAACF,IAAI,CAACF,EAAE,CAAC;EACnC;EAEOK,MAAM,GAAS;IAClB,IAAI,CAACC,QAAQ,CAACjB,cAAc,CAACkB,OAAO,CAAC;EACzC;EAEOC,OAAO,GAAS;IACnB,IAAI,CAACF,QAAQ,CAACjB,cAAc,CAACoB,QAAQ,CAAC;EAC1C;;EAEA;AACJ;AACA;AACA;AACA;EACI,MAAaC,MAAM,GAAkB;IACjC;AACR;AACA;IACQ,IAAI,IAAI,CAACC,UAAU,IAAI,IAAI,CAAChB,YAAY,CAACiB,MAAM,KAAK,CAAC,EAAE;MACnD;IACJ;IACA,MAAMC,SAAS,GAAG,CAAC,GAAG,IAAI,CAACT,iBAAiB,CAAC,CAACU,OAAO,EAAE;IACvDD,SAAS,CAACX,IAAI,CAACZ,2BAA2B,EAAE,CAAC;IAC7C,KAAK,MAAMU,EAAE,IAAIa,SAAS,EAAE;MACxB,MAAME,MAAM,GAAG,MAAMf,EAAE,CAAC;QACpBT,SAAS,EAAE,IAAI;QACfyB,IAAI,EAAE,MAAM;MAChB,CAAC,CAAC;MACF,IAAID,MAAM,KAAK,MAAM,EAAE;QACnB;MACJ;IACJ;IACA,IAAI,CAACJ,UAAU,GAAG,IAAI;EAC1B;EAEA,MAAaM,OAAO,CAChBC,OAAyC,EACzClB,EAAoB,EACV;IACV,MAAMmB,OAAO,GAAG,MAAM,IAAI,CAACC,YAAY,EAAE;IACzC,IAAI,CAACD,OAAO,EAAE;MACV,OAAOnB,EAAE,EAAE;IACf;IACA,MAAMqB,WAAW,GAAG,IAAI,CAACC,gBAAgB,CAACJ,OAAO,CAAC;IAClD,MAAMK,gBAAgB,GAAG,IAAI,CAACC,mBAAmB,EAAE;IACnD,IAAI,CAACC,YAAY,EAAE;IACnB,IAAI;MACA,OAAO,MAAMzB,EAAE,EAAE;IACrB,CAAC,SAAS;MACN,MAAM0B,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAACN,WAAW,CAAC;MAC1D,IAAI,CAAC1B,YAAY,CAACO,IAAI,CAACwB,gBAAgB,CAAC;MACxC,IAAI,CAACE,MAAM,CAACF,gBAAgB,CAAC;MAC7B;AACZ;AACA;AACA;MACY,IAAI,CAACH,gBAAgB,EAAE;QACnB,IAAI,CAACM,UAAU,CAACH,gBAAgB,CAAC;QACjC,IAAI,CAACI,UAAU,EAAE;MACrB;IACJ;EACJ;EAEQN,mBAAmB,GAAY;IACnC,OAAO,IAAI,CAACD,gBAAgB;EAChC;EACQE,YAAY,GAAS;IACzB,IAAI,CAACF,gBAAgB,GAAG,IAAI;EAChC;EACQO,UAAU,GAAS;IACvB,IAAI,CAACP,gBAAgB,GAAG,KAAK;EACjC;EAEA,MAAcH,YAAY,GAAqB;IAC3C,IAAI,IAAI,CAACW,KAAK,KAAK1C,cAAc,CAACkB,OAAO,EAAE;MACvC,OAAO,IAAI;IACf,CAAC,MAAM,IAAI,IAAI,CAACwB,KAAK,KAAK1C,cAAc,CAACoB,QAAQ,EAAE;MAC/C,OAAO,KAAK;IAChB;IAEA,KAAK,MAAMT,EAAE,IAAI,IAAI,CAACC,iBAAiB,EAAE;MACrC,MAAMc,MAAM,GAAG,MAAMf,EAAE,EAAE;MACzB,IAAIe,MAAM,EAAE;QACR,IAAI,CAACV,MAAM,EAAE;QACb,OAAO,IAAI;MACf;IACJ;IACA,IAAI,CAACG,OAAO,EAAE;IACd,OAAO,KAAK;EAChB;EAEQqB,UAAU,CAACR,WAAkD,EAAQ;IACzE,IAAI,CAACvB,YAAY,GAAG,IAAI,CAACA,YAAY,GAAGuB,WAAW,CAAC3B,OAAO;EAC/D;EAEQkC,MAAM,CAACP,WAA4D,EAAQ;IAC/E,MAAMW,IAAI,GAAI,GAAEX,WAAW,CAACY,QAAS,IAAGZ,WAAW,CAACW,IAAK,EAAC;IAC1D,IAAI,CAAC,IAAI,CAACE,IAAI,CAACF,IAAI,CAAC,EAAE;MAClB,IAAI,CAACE,IAAI,CAACF,IAAI,CAAC,GAAG,CAAC;IACvB;IACA,IAAI,CAACE,IAAI,CAACF,IAAI,CAAC,EAAE;EACrB;EAEQ1B,QAAQ,CAACyB,KAAqB,EAAQ;IAC1C,IAAI,CAACA,KAAK,GAAGA,KAAK;EACtB;EAEQT,gBAAgB,CAACJ,OAAyC,EAA6B;IAC3F,MAAMc,IAAI,GAAG,OAAOd,OAAO,KAAK,QAAQ,GAAGA,OAAO,GAAGA,OAAO,CAACc,IAAI;IACjE,MAAMC,QAAQ,GAAG,OAAOf,OAAO,KAAK,QAAQ,GAAG,QAAQ,GAAGA,OAAO,CAACe,QAAQ;IAC1E,OAAO;MACHD,IAAI;MACJC,QAAQ;MACRE,KAAK,EAAE,IAAIC,IAAI,EAAE;MACjBC,WAAW,EAAEC,OAAO,CAACC,WAAW,EAAE,CAACC;IACvC,CAAC;EACL;EAEQb,eAAe,CAACN,WAAsC,EAAwB;IAClF,MAAMoB,GAAG,GAAG,IAAIL,IAAI,EAAE;IACtB,MAAMM,SAAS,GAAGJ,OAAO,CAACC,WAAW,EAAE,CAACC,QAAQ;IAChD,MAAM9C,OAAO,GAAG+C,GAAG,CAACE,OAAO,EAAE,GAAGtB,WAAW,CAACc,KAAK,CAACQ,OAAO,EAAE;IAC3D,OAAO;MACHX,IAAI,EAAEX,WAAW,CAACW,IAAI;MACtBC,QAAQ,EAAEZ,WAAW,CAACY,QAAQ;MAC9BE,KAAK,EAAEd,WAAW,CAACc,KAAK;MACxBM,GAAG;MACH/C,OAAO;MACPkD,MAAM,EAAEF,SAAS,GAAGrB,WAAW,CAACgB;IACpC,CAAC;EACL;AACJ;AAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webiny/api",
-	"version": "0.0.0-unstable.9e825fd5fb",
+	"version": "0.0.0-unstable.aa00eecd97",
 	"main": "index.js",
 	"repository": {
 		"type": "git",
@@ -13,17 +13,17 @@
 	"license": "MIT",
 	"dependencies": {
 		"@babel/runtime": "7.20.13",
-		"@webiny/plugins": "0.0.0-unstable.9e825fd5fb"
+		"@webiny/plugins": "0.0.0-unstable.aa00eecd97"
 	},
 	"devDependencies": {
-		"@babel/cli": "^7.19.3",
-		"@babel/core": "^7.19.3",
-		"@babel/preset-env": "^7.19.4",
-		"@babel/preset-typescript": "^7.18.6",
-		"@webiny/cli": "^0.0.0-unstable.9e825fd5fb",
-		"@webiny/project-utils": "^0.0.0-unstable.9e825fd5fb",
-		"rimraf": "^3.0.2",
-		"ttypescript": "^1.5.13",
+		"@babel/cli": "7.20.7",
+		"@babel/core": "7.20.12",
+		"@babel/preset-env": "7.20.2",
+		"@babel/preset-typescript": "7.18.6",
+		"@webiny/cli": "0.0.0-unstable.aa00eecd97",
+		"@webiny/project-utils": "0.0.0-unstable.aa00eecd97",
+		"rimraf": "3.0.2",
+		"ttypescript": "1.5.15",
 		"typescript": "4.7.4"
 	},
 	"publishConfig": {
@@ -34,5 +34,5 @@
 		"build": "yarn webiny run build",
 		"watch": "yarn webiny run watch"
 	},
-	"gitHead": "9e825fd5fb3c021691acbaee6c5fd925f5f5de4d"
+	"gitHead": "aa00eecd97d16da9bdb0581f33d491487ce43ce9"
 }

package/types.d.ts

@@ -4,6 +4,7 @@ export interface BenchmarkRuns {
 }
 export interface BenchmarkMeasurement {
     name: string;
+    category: string;
     start: Date;
     end: Date;
     elapsed: number;
@@ -12,11 +13,16 @@ export interface BenchmarkMeasurement {
 export interface BenchmarkEnableOnCallable {
     (): Promise<boolean>;
 }
-export declare enum BenchmarkOutputCallableResponse {
-    BREAK = "break"
+export interface BenchmarkOutputCallableParams {
+    benchmark: Benchmark;
+    stop: () => "stop";
 }
 export interface BenchmarkOutputCallable {
-    (benchmark: Benchmark): Promise<BenchmarkOutputCallableResponse | undefined | null | void>;
+    (params: BenchmarkOutputCallableParams): Promise<"stop" | undefined | null | void>;
+}
+export interface BenchmarkMeasureOptions {
+    name: string;
+    category: string;
 }
 export interface Benchmark {
     elapsed: number;
@@ -25,7 +31,7 @@ export interface Benchmark {
     output: () => Promise<void>;
     onOutput: (cb: BenchmarkOutputCallable) => void;
     enableOn: (cb: BenchmarkEnableOnCallable) => void;
-    measure: <T = any>(name: string, cb: () => Promise<T>) => Promise<T>;
+    measure: <T = any>(options: BenchmarkMeasureOptions | string, cb: () => Promise<T>) => Promise<T>;
     enable: () => void;
     disable: () => void;
 }

package/types.js

@@ -2,10 +2,4 @@
 
 Object.defineProperty(exports, "__esModule", {
   value: true
-});
-exports.BenchmarkOutputCallableResponse = void 0;
-let BenchmarkOutputCallableResponse;
-exports.BenchmarkOutputCallableResponse = BenchmarkOutputCallableResponse;
-(function (BenchmarkOutputCallableResponse) {
-  BenchmarkOutputCallableResponse["BREAK"] = "break";
-})(BenchmarkOutputCallableResponse || (exports.BenchmarkOutputCallableResponse = BenchmarkOutputCallableResponse = {}));
+});

package/types.js.map

@@ -1 +1 @@
-{"version":3,"names":["BenchmarkOutputCallableResponse"],"sources":["types.ts"],"sourcesContent":["import { PluginsContainer } from \"@webiny/plugins\";\n\nexport interface BenchmarkRuns {\n    [key: string]: number;\n}\n\nexport interface BenchmarkMeasurement {\n    name: string;\n    start: Date;\n    end: Date;\n    elapsed: number;\n    memory: number;\n}\n\nexport interface BenchmarkEnableOnCallable {\n    (): Promise<boolean>;\n}\n\nexport enum BenchmarkOutputCallableResponse {\n    BREAK = \"break\"\n}\n\nexport interface BenchmarkOutputCallable {\n    (benchmark: Benchmark): Promise<BenchmarkOutputCallableResponse | undefined | null | void>;\n}\n\nexport interface Benchmark {\n    elapsed: number;\n    runs: BenchmarkRuns;\n    measurements: BenchmarkMeasurement[];\n    output: () => Promise<void>;\n    onOutput: (cb: BenchmarkOutputCallable) => void;\n    enableOn: (cb: BenchmarkEnableOnCallable) => void;\n    measure: <T = any>(name: string, cb: () => Promise<T>) => Promise<T>;\n    enable: () => void;\n    disable: () => void;\n}\n\n/**\n * The main context which is constructed on every request.\n * All other contexts should extend or augment this one.\n */\nexport interface Context {\n    plugins: PluginsContainer;\n    args: any;\n    readonly WEBINY_VERSION: string;\n    /**\n     * Not to be used outside of Webiny internal code.\n     * @internal\n     */\n    hasResult: () => boolean;\n    /**\n     * Not to be used outside of Webiny internal code.\n     * @internal\n     *\n     * @private\n     */\n    _result?: any;\n    /**\n     * Not to be used outside of Webiny internal code.\n     * @internal\n     */\n    setResult: (value: any) => void;\n    /**\n     * Not to be used outside of Webiny internal code.\n     * @internal\n     */\n    getResult: () => void;\n    /**\n     * Wait for property to be defined on the object and then execute the callable.\n     * In case of multiple objects defined, wait for all of them.\n     */\n    waitFor: <T extends Context = Context>(\n        obj: string[] | string,\n        cb: (context: T) => void\n    ) => void;\n\n    benchmark: Benchmark;\n}\n"],"mappings":";;;;;;IAkBYA,+BAA+B;AAAA;AAAA,WAA/BA,+BAA+B;EAA/BA,+BAA+B;AAAA,GAA/BA,+BAA+B,+CAA/BA,+BAA+B"}
+{"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import { PluginsContainer } from \"@webiny/plugins\";\n\nexport interface BenchmarkRuns {\n    [key: string]: number;\n}\n\nexport interface BenchmarkMeasurement {\n    name: string;\n    category: string;\n    start: Date;\n    end: Date;\n    elapsed: number;\n    memory: number;\n}\n\nexport interface BenchmarkEnableOnCallable {\n    (): Promise<boolean>;\n}\n\nexport interface BenchmarkOutputCallableParams {\n    benchmark: Benchmark;\n    stop: () => \"stop\";\n}\nexport interface BenchmarkOutputCallable {\n    (params: BenchmarkOutputCallableParams): Promise<\"stop\" | undefined | null | void>;\n}\nexport interface BenchmarkMeasureOptions {\n    name: string;\n    category: string;\n}\nexport interface Benchmark {\n    elapsed: number;\n    runs: BenchmarkRuns;\n    measurements: BenchmarkMeasurement[];\n    output: () => Promise<void>;\n    onOutput: (cb: BenchmarkOutputCallable) => void;\n    enableOn: (cb: BenchmarkEnableOnCallable) => void;\n    measure: <T = any>(\n        options: BenchmarkMeasureOptions | string,\n        cb: () => Promise<T>\n    ) => Promise<T>;\n    enable: () => void;\n    disable: () => void;\n}\n\n/**\n * The main context which is constructed on every request.\n * All other contexts should extend or augment this one.\n */\nexport interface Context {\n    plugins: PluginsContainer;\n    args: any;\n    readonly WEBINY_VERSION: string;\n    /**\n     * Not to be used outside of Webiny internal code.\n     * @internal\n     */\n    hasResult: () => boolean;\n    /**\n     * Not to be used outside of Webiny internal code.\n     * @internal\n     *\n     * @private\n     */\n    _result?: any;\n    /**\n     * Not to be used outside of Webiny internal code.\n     * @internal\n     */\n    setResult: (value: any) => void;\n    /**\n     * Not to be used outside of Webiny internal code.\n     * @internal\n     */\n    getResult: () => void;\n    /**\n     * Wait for property to be defined on the object and then execute the callable.\n     * In case of multiple objects defined, wait for all of them.\n     */\n    waitFor: <T extends Context = Context>(\n        obj: string[] | string,\n        cb: (context: T) => void\n    ) => void;\n\n    benchmark: Benchmark;\n}\n"],"mappings":""}