@searchspring/snap-profiler 0.20.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Searchspring
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,148 @@
+# Snap Profiler
+
+<a href="https://www.npmjs.com/package/@searchspring/snap-profiler"><img alt="NPM Status" src="https://img.shields.io/npm/v/@searchspring/snap-profiler.svg?style=flat"></a>
+
+A utility for recording how long something takes to complete. `Profiler` is used in finding API response, component rendering and Middleware execution times.
+
+
+## Dependency
+
+Snap Profiler is a dependency of [@searchspring/snap-controller](https://github.com/searchspring/snap/tree/main/packages/snap-controller) <a href="https://www.npmjs.com/package/@searchspring/snap-controller"><img alt="NPM Status" src="https://img.shields.io/npm/v/@searchspring/snap-controller.svg?style=flat"></a>
+
+## Installation
+
+```bash
+npm install --save @searchspring/snap-profiler
+```
+
+## Import
+```typescript
+import { Profiler } from '@searchspring/snap-profiler';
+```
+
+
+<h2 id="Profiler">Profiler</h2>
+An optional `namespace` can be passed to the Profiler constructor for profile organization.
+
+```typescript
+import { Profiler } from '@searchspring/snap-profiler';
+
+const profiler = new Profiler('namespace');
+```
+
+### `setNamespace` method
+Programatically set the namespace after construction.
+
+```typescript
+import { Profiler } from '@searchspring/snap-profiler';
+
+const profiler = new Profiler();
+
+profiler.setNamespace('namespace');
+```
+
+### `create` method
+Create a new profile.
+
+```typescript
+import { Profiler } from '@searchspring/snap-profiler';
+
+const profiler = new Profiler();
+
+const searchProfile = profiler.create({ 
+	type: 'event', 
+	name: 'search', 
+	context: params
+}: ProfileDetails);
+```
+
+```typescript
+type ProfileDetails<T> = { 
+	type: string; 
+	name: string; 
+	context: T;
+}
+```
+
+Returns an instance of `Profile`. 
+
+
+<h2 id="Profile">Profile</h2>
+
+`Profile` is not an exported member of the Snap Profiler package. It is only returned in the Profiler `create` method.
+
+### `start` method
+
+This will start the profiler timer.
+
+```typescript
+searchProfile.start();
+```
+
+### `stop` method
+This will stop the profiler timer.
+
+```typescript
+searchProfile.stop();
+```
+
+### `namespace` property
+Profile namespace that was set using the `Profiler` constructor or the `setNamespace` method.
+
+```typescript
+console.log(`namespace: ${searchProfile.namespace}`);
+```
+
+### `type` property
+Profile type that was set in the `create` method `ProfileDetails` parameters.
+
+```typescript
+console.log(`type: ${searchProfile.type}`);
+```
+
+### `name` property
+Profile name that was set in the `create` method `ProfileDetails` parameters.
+
+```typescript
+console.log(`name: ${searchProfile.name}`);
+```
+
+### `context` property
+Profile context that was set in the `create` method `ProfileDetails` parameters. The context is used to provide additional details regarding the profile. A search profile would likely contain the request parameters amoung other things.
+
+```typescript
+console.log(`context: ${searchProfile.context}`);
+```
+
+### `status` property
+Profile status. The default value is `pending`.
+
+The value will change to `started` when the `start` method is invoked and to `finished` when the `stop` method is invoked.
+
+```typescript
+console.log(`context: ${searchProfile.status}`);
+```
+
+### `time` property
+Profile time object is of type `ProfileTime`:
+
+```typescript
+type ProfileTime = {
+	date: number;
+	begin: number;
+	end: number;
+	run: number;
+};
+```
+
+`ProfileTime.date` - set to `Date.now()` when `start` method is invoked.
+
+`ProfileTime.begin` - set to `window.performance.now()` when `start` method is invoked.
+
+`ProfileTime.end` - set to `window.performance.now()` when `stop` method is invoked.
+
+`ProfileTime.run` - set to the total running time in milliseconds between when the `start` and `stop` methods have been invoked.
+
+
+## Logging profiles
+It is recommended to using the Snap Logger's `profile` method to log Snap Profiles as it provides a clean output for easy parsing.

package/dist/cjs/Profiler.d.ts

@@ -0,0 +1,31 @@
+declare type ProfileDetails<T> = {
+    type: string;
+    name: string;
+    context: T;
+};
+export declare class Profiler {
+    namespace: string;
+    profiles: Profile<any>[];
+    constructor(namespace?: string);
+    setNamespace(namespace: string): void;
+    create<T>({ type, name, context }: ProfileDetails<T>): Profile<T>;
+}
+declare type ProfileTime = {
+    date: number;
+    begin: number;
+    end: number;
+    run: number;
+};
+declare class Profile<T> {
+    namespace: string;
+    type: string;
+    name: string;
+    context: T;
+    status: string;
+    time: ProfileTime;
+    constructor(namespace: string, { type, name, context }: ProfileDetails<T>);
+    start(): Profile<T>;
+    stop(): Profile<T>;
+}
+export {};
+//# sourceMappingURL=Profiler.d.ts.map

package/dist/cjs/Profiler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Profiler.d.ts","sourceRoot":"","sources":["../../src/Profiler.ts"],"names":[],"mappings":"AAAA,aAAK,cAAc,CAAC,CAAC,IAAI;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,CAAC,CAAA;CAAE,CAAC;AAEpE,qBAAa,QAAQ;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBAEpB,SAAS,CAAC,EAAE,MAAM;IAKvB,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAMrC,MAAM,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAUxE;AAED,aAAK,WAAW,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,cAAM,OAAO,CAAC,CAAC;IACP,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,CAAC,CAAC;IACX,MAAM,SAAa;IACnB,IAAI,EAAE,WAAW,CAKtB;gBAEU,SAAS,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;IAOlE,KAAK,IAAI,OAAO,CAAC,CAAC,CAAC;IAWnB,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC;CAWzB"}

package/dist/cjs/Profiler.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Profiler = void 0;
+var Profiler = /** @class */ (function () {
+    function Profiler(namespace) {
+        this.namespace = namespace;
+        this.profiles = [];
+    }
+    Profiler.prototype.setNamespace = function (namespace) {
+        if (!this.namespace) {
+            this.namespace = namespace;
+        }
+    };
+    Profiler.prototype.create = function (_a) {
+        var type = _a.type, name = _a.name, context = _a.context;
+        if (!name) {
+            throw new Error('Profile name is required.');
+        }
+        var profile = new Profile(this.namespace, { type: type, name: name, context: context });
+        this.profiles.push(profile);
+        return profile;
+    };
+    return Profiler;
+}());
+exports.Profiler = Profiler;
+var Profile = /** @class */ (function () {
+    function Profile(namespace, _a) {
+        var type = _a.type, name = _a.name, context = _a.context;
+        this.status = 'pending';
+        this.time = {
+            date: undefined,
+            begin: undefined,
+            end: undefined,
+            run: undefined,
+        };
+        this.namespace = namespace;
+        this.type = type;
+        this.name = name;
+        this.context = context;
+    }
+    Profile.prototype.start = function () {
+        if (!this.time.begin) {
+            this.time.date = Date.now();
+            this.time.begin = window.performance.now();
+            this.status = 'started';
+        }
+        return this;
+    };
+    Profile.prototype.stop = function () {
+        if (!this.time.end) {
+            this.time.date = Date.now();
+            this.time.end = window.performance.now();
+            this.time.run = +(this.time.end - this.time.begin).toFixed(3);
+            this.status = 'finished';
+        }
+        return this;
+    };
+    return Profile;
+}());

package/dist/cjs/index.d.ts

@@ -0,0 +1,2 @@
+export { Profiler } from './Profiler';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC"}

package/dist/cjs/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Profiler = void 0;
+var Profiler_1 = require("./Profiler");
+Object.defineProperty(exports, "Profiler", { enumerable: true, get: function () { return Profiler_1.Profiler; } });

package/dist/esm/Profiler.d.ts

@@ -0,0 +1,31 @@
+declare type ProfileDetails<T> = {
+    type: string;
+    name: string;
+    context: T;
+};
+export declare class Profiler {
+    namespace: string;
+    profiles: Profile<any>[];
+    constructor(namespace?: string);
+    setNamespace(namespace: string): void;
+    create<T>({ type, name, context }: ProfileDetails<T>): Profile<T>;
+}
+declare type ProfileTime = {
+    date: number;
+    begin: number;
+    end: number;
+    run: number;
+};
+declare class Profile<T> {
+    namespace: string;
+    type: string;
+    name: string;
+    context: T;
+    status: string;
+    time: ProfileTime;
+    constructor(namespace: string, { type, name, context }: ProfileDetails<T>);
+    start(): Profile<T>;
+    stop(): Profile<T>;
+}
+export {};
+//# sourceMappingURL=Profiler.d.ts.map

package/dist/esm/Profiler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Profiler.d.ts","sourceRoot":"","sources":["../../src/Profiler.ts"],"names":[],"mappings":"AAAA,aAAK,cAAc,CAAC,CAAC,IAAI;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,CAAC,CAAA;CAAE,CAAC;AAEpE,qBAAa,QAAQ;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBAEpB,SAAS,CAAC,EAAE,MAAM;IAKvB,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAMrC,MAAM,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAUxE;AAED,aAAK,WAAW,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,cAAM,OAAO,CAAC,CAAC;IACP,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,CAAC,CAAC;IACX,MAAM,SAAa;IACnB,IAAI,EAAE,WAAW,CAKtB;gBAEU,SAAS,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;IAOlE,KAAK,IAAI,OAAO,CAAC,CAAC,CAAC;IAWnB,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC;CAWzB"}

package/dist/esm/Profiler.js

@@ -0,0 +1,51 @@
+export class Profiler {
+    constructor(namespace) {
+        this.namespace = namespace;
+        this.profiles = [];
+    }
+    setNamespace(namespace) {
+        if (!this.namespace) {
+            this.namespace = namespace;
+        }
+    }
+    create({ type, name, context }) {
+        if (!name) {
+            throw new Error('Profile name is required.');
+        }
+        const profile = new Profile(this.namespace, { type, name, context });
+        this.profiles.push(profile);
+        return profile;
+    }
+}
+class Profile {
+    constructor(namespace, { type, name, context }) {
+        this.status = 'pending';
+        this.time = {
+            date: undefined,
+            begin: undefined,
+            end: undefined,
+            run: undefined,
+        };
+        this.namespace = namespace;
+        this.type = type;
+        this.name = name;
+        this.context = context;
+    }
+    start() {
+        if (!this.time.begin) {
+            this.time.date = Date.now();
+            this.time.begin = window.performance.now();
+            this.status = 'started';
+        }
+        return this;
+    }
+    stop() {
+        if (!this.time.end) {
+            this.time.date = Date.now();
+            this.time.end = window.performance.now();
+            this.time.run = +(this.time.end - this.time.begin).toFixed(3);
+            this.status = 'finished';
+        }
+        return this;
+    }
+}

package/dist/esm/index.d.ts

@@ -0,0 +1,2 @@
+export { Profiler } from './Profiler';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1 @@
+export { Profiler } from './Profiler';

package/package.json

@@ -0,0 +1,27 @@
+{
+	"name": "@searchspring/snap-profiler",
+	"version": "0.20.0",
+	"description": "Snap Profiler",
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"author": "Searchspring",
+	"license": "MIT",
+	"repository": "https://github.com/searchspring/snap",
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"build": "rm -rf ./dist && tsc && tsc -p tsconfig.cjs.json",
+		"build:docs": "typedoc --out docs src/index.ts",
+		"dev": "tsc --watch",
+		"format": "prettier --write 'src/**/*.{js,jsx,ts,tsx}'",
+		"lint": "eslint 'src/**/*.{js,jsx,ts,tsx}'",
+		"test": "jest",
+		"test:watch": "jest --watch"
+	},
+	"sideEffects": false,
+	"files": [
+		"dist/**/*"
+	],
+	"gitHead": "122405b27b497c7bb6a189c30535fdc197bc3ef0"
+}