@microsoft/metrics-ts 0.0.1

package/.eslintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["../eslint-config"],
+};

package/.prettierrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  ...require("../prettier-config"),
+};

package/LICENSE

@@ -0,0 +1,23 @@
+Microsoft Teams Framework (TeamsFx)
+
+Copyright (c) Microsoft Corporation.
+
+MIT License
+
+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/build/capability/index.d.ts

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

package/build/capability/index.d.ts.map

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

package/build/capability/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MSTimer = void 0;
+var timer_1 = require("./timer");
+Object.defineProperty(exports, "MSTimer", { enumerable: true, get: function () { return timer_1.MSTimer; } });
+//# sourceMappingURL=index.js.map

package/build/capability/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/capability/index.ts"],"names":[],"mappings":";;;AAAA,iCAAkC;AAAzB,gGAAA,OAAO,OAAA"}

package/build/capability/timer.d.ts

@@ -0,0 +1,2 @@
+export declare const MSTimer: (fn: string) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+//# sourceMappingURL=timer.d.ts.map

package/build/capability/timer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"timer.d.ts","sourceRoot":"","sources":["../../src/capability/timer.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,OAAO,OAAQ,MAAM,cAGhB,GAAG,eAAe,MAAM,cAAc,kBAAkB,uBAqEzE,CAAC"}

package/build/capability/timer.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MSTimer = void 0;
+/**
+ * Timer - measures call-rate of a function and the distribution of the duration of all calls
+ */
+const perf_hooks_1 = require("perf_hooks");
+const rawData_1 = require("../rawData");
+const tracing_1 = require("../tracing");
+const writer_1 = require("../writer");
+/**
+ * TODO: allow cutomization
+ * all in millsecond
+ */
+const fast = 1;
+const normal = 20;
+const MSTimer = (fn) => {
+    /* eslint-disable  @typescript-eslint/no-explicit-any */
+    /* eslint-disable  @typescript-eslint/explicit-module-boundary-types */
+    return (target, propertyKey, descriptor) => {
+        const originalMethod = descriptor.value;
+        /**
+         * get essential properties
+         */
+        const data = {
+            traceId: (0, tracing_1.traceId)(),
+            file: fn,
+            class: target.constructor.name,
+            method: originalMethod.name,
+            timestamp: Date.now(),
+        };
+        if (originalMethod.constructor.name === "AsyncFunction") {
+            descriptor.value = async function (...args) {
+                data.args = args;
+                const start = perf_hooks_1.performance.now();
+                const result = await originalMethod.apply(this, args);
+                const end = perf_hooks_1.performance.now();
+                const duration = end - start;
+                let severity;
+                if (duration > normal) {
+                    severity = rawData_1.TimerSeverity.Slow;
+                }
+                else if (duration > fast) {
+                    severity = rawData_1.TimerSeverity.Normal;
+                }
+                else {
+                    severity = rawData_1.TimerSeverity.Fast;
+                }
+                const timerData = {
+                    duration: duration,
+                    severity: severity,
+                };
+                data.timer = timerData;
+                await (0, writer_1.appendOutput)(data);
+                return result;
+            };
+        }
+        else {
+            descriptor.value = function (...args) {
+                data.args = args;
+                const start = perf_hooks_1.performance.now();
+                const result = originalMethod.apply(this, args);
+                const end = perf_hooks_1.performance.now();
+                const duration = end - start;
+                let severity;
+                if (duration > normal) {
+                    severity = rawData_1.TimerSeverity.Slow;
+                }
+                else if (duration > fast) {
+                    severity = rawData_1.TimerSeverity.Normal;
+                }
+                else {
+                    severity = rawData_1.TimerSeverity.Fast;
+                }
+                const timerData = {
+                    duration: duration,
+                    severity: severity,
+                };
+                data.timer = timerData;
+                (0, writer_1.appendOutputSync)(data);
+                return result;
+            };
+        }
+        return descriptor;
+    };
+};
+exports.MSTimer = MSTimer;
+//# sourceMappingURL=timer.js.map

package/build/capability/timer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timer.js","sourceRoot":"","sources":["../../src/capability/timer.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,2CAAyC;AACzC,wCAAkE;AAClE,wCAAqC;AACrC,sCAA2D;AAE3D;;;GAGG;AACH,MAAM,IAAI,GAAG,CAAC,CAAC;AACf,MAAM,MAAM,GAAG,EAAE,CAAC;AAEX,MAAM,OAAO,GAAG,CAAC,EAAU,EAAE,EAAE;IACpC,wDAAwD;IACxD,uEAAuE;IACvE,OAAO,CAAC,MAAW,EAAE,WAAmB,EAAE,UAA8B,EAAE,EAAE;QAC1E,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC;;WAEG;QACH,MAAM,IAAI,GAAe;YACvB,OAAO,EAAE,IAAA,iBAAO,GAAE;YAClB,IAAI,EAAE,EAAE;YACR,KAAK,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI;YAC9B,MAAM,EAAE,cAAc,CAAC,IAAI;YAC3B,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;SACtB,CAAC;QAEF,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,KAAK,eAAe,EAAE;YACvD,UAAU,CAAC,KAAK,GAAG,KAAK,WAAW,GAAG,IAAW;gBAC/C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;gBAEjB,MAAM,KAAK,GAAG,wBAAW,CAAC,GAAG,EAAE,CAAC;gBAChC,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACtD,MAAM,GAAG,GAAG,wBAAW,CAAC,GAAG,EAAE,CAAC;gBAC9B,MAAM,QAAQ,GAAG,GAAG,GAAG,KAAK,CAAC;gBAC7B,IAAI,QAAuB,CAAC;gBAC5B,IAAI,QAAQ,GAAG,MAAM,EAAE;oBACrB,QAAQ,GAAG,uBAAa,CAAC,IAAI,CAAC;iBAC/B;qBAAM,IAAI,QAAQ,GAAG,IAAI,EAAE;oBAC1B,QAAQ,GAAG,uBAAa,CAAC,MAAM,CAAC;iBACjC;qBAAM;oBACL,QAAQ,GAAG,uBAAa,CAAC,IAAI,CAAC;iBAC/B;gBACD,MAAM,SAAS,GAAc;oBAC3B,QAAQ,EAAE,QAAQ;oBAClB,QAAQ,EAAE,QAAQ;iBACnB,CAAC;gBAEF,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;gBAEvB,MAAM,IAAA,qBAAY,EAAC,IAAI,CAAC,CAAC;gBACzB,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC;SACH;aAAM;YACL,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAW;gBACzC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;gBAEjB,MAAM,KAAK,GAAG,wBAAW,CAAC,GAAG,EAAE,CAAC;gBAChC,MAAM,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAChD,MAAM,GAAG,GAAG,wBAAW,CAAC,GAAG,EAAE,CAAC;gBAC9B,MAAM,QAAQ,GAAG,GAAG,GAAG,KAAK,CAAC;gBAC7B,IAAI,QAAuB,CAAC;gBAC5B,IAAI,QAAQ,GAAG,MAAM,EAAE;oBACrB,QAAQ,GAAG,uBAAa,CAAC,IAAI,CAAC;iBAC/B;qBAAM,IAAI,QAAQ,GAAG,IAAI,EAAE;oBAC1B,QAAQ,GAAG,uBAAa,CAAC,MAAM,CAAC;iBACjC;qBAAM;oBACL,QAAQ,GAAG,uBAAa,CAAC,IAAI,CAAC;iBAC/B;gBACD,MAAM,SAAS,GAAc;oBAC3B,QAAQ,EAAE,QAAQ;oBAClB,QAAQ,EAAE,QAAQ;iBACnB,CAAC;gBAEF,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;gBAEvB,IAAA,yBAAgB,EAAC,IAAI,CAAC,CAAC;gBACvB,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC;SACH;QACD,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC,CAAC;AAxEW,QAAA,OAAO,WAwElB"}

package/build/index.d.ts

@@ -0,0 +1,4 @@
+import { default as transformer } from "./transformer";
+export * from "./capability";
+export default transformer;
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,eAAe,CAAC;AAEvD,cAAc,cAAc,CAAC;AAE7B,eAAe,WAAW,CAAC"}

package/build/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const transformer_1 = tslib_1.__importDefault(require("./transformer"));
+tslib_1.__exportStar(require("./capability"), exports);
+exports.default = transformer_1.default;
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,wEAAuD;AAEvD,uDAA6B;AAE7B,kBAAe,qBAAW,CAAC"}

package/build/rawData.d.ts

@@ -0,0 +1,19 @@
+export interface tracePoint {
+    traceId: string;
+    file: string;
+    class: string;
+    timestamp: number;
+    method: string;
+    args?: any;
+    timer?: timerData;
+}
+export declare enum TimerSeverity {
+    Fast = "fast",
+    Normal = "normal",
+    Slow = "slow"
+}
+export interface timerData {
+    duration: number;
+    severity: TimerSeverity;
+}
+//# sourceMappingURL=rawData.d.ts.map

package/build/rawData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rawData.d.ts","sourceRoot":"","sources":["../src/rawData.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAGhB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB;AAED,oBAAY,aAAa;IACvB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,IAAI,SAAS;CACd;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,aAAa,CAAC;CACzB"}

package/build/rawData.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimerSeverity = void 0;
+var TimerSeverity;
+(function (TimerSeverity) {
+    TimerSeverity["Fast"] = "fast";
+    TimerSeverity["Normal"] = "normal";
+    TimerSeverity["Slow"] = "slow";
+})(TimerSeverity = exports.TimerSeverity || (exports.TimerSeverity = {}));
+//# sourceMappingURL=rawData.js.map

package/build/rawData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rawData.js","sourceRoot":"","sources":["../src/rawData.ts"],"names":[],"mappings":";;;AAaA,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,8BAAa,CAAA;IACb,kCAAiB,CAAA;IACjB,8BAAa,CAAA;AACf,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB"}

package/build/reporter/index.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=index.d.ts.map

package/build/reporter/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/reporter/index.ts"],"names":[],"mappings":""}

package/build/reporter/index.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=index.js.map

package/build/reporter/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/reporter/index.ts"],"names":[],"mappings":""}

package/build/reporter/json.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=json.d.ts.map

package/build/reporter/json.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../../src/reporter/json.ts"],"names":[],"mappings":""}

package/build/reporter/json.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=json.js.map

package/build/reporter/json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.js","sourceRoot":"","sources":["../../src/reporter/json.ts"],"names":[],"mappings":""}

package/build/tracing.d.ts

@@ -0,0 +1,5 @@
+/**
+ * TODO: make it safe
+ */
+export declare function traceId(): string;
+//# sourceMappingURL=tracing.d.ts.map

package/build/tracing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracing.d.ts","sourceRoot":"","sources":["../src/tracing.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,wBAAgB,OAAO,IAAI,MAAM,CAQhC"}

package/build/tracing.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.traceId = void 0;
+const process_1 = require("process");
+const uuid_1 = require("uuid");
+/**
+ * TODO: make it safe
+ */
+function traceId() {
+    if (process_1.env.METAOS_TRACE_ID) {
+        return process_1.env.METAOS_TRACE_ID;
+    }
+    else {
+        const traceId = (0, uuid_1.v4)();
+        process_1.env.METAOS_TRACE_ID = traceId;
+        return traceId;
+    }
+}
+exports.traceId = traceId;
+//# sourceMappingURL=tracing.js.map

package/build/tracing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracing.js","sourceRoot":"","sources":["../src/tracing.ts"],"names":[],"mappings":";;;AAAA,qCAA8B;AAC9B,+BAAoC;AAEpC;;GAEG;AACH,SAAgB,OAAO;IACrB,IAAI,aAAG,CAAC,eAAe,EAAE;QACvB,OAAO,aAAG,CAAC,eAAe,CAAC;KAC5B;SAAM;QACL,MAAM,OAAO,GAAG,IAAA,SAAM,GAAE,CAAC;QACzB,aAAG,CAAC,eAAe,GAAG,OAAO,CAAC;QAC9B,OAAO,OAAO,CAAC;KAChB;AACH,CAAC;AARD,0BAQC"}

package/build/transformer.d.ts

@@ -0,0 +1,16 @@
+import typescript from "typescript";
+/**
+ * unused right now.
+ */
+export declare enum Reporter {
+    Json = "json"
+}
+export declare enum Capability {
+    Timer = "timer"
+}
+export interface PluginConfig {
+    capabilities?: Capability[];
+    reporters?: Reporter[];
+}
+export default function (program: typescript.Program, config?: PluginConfig): (ctx: typescript.TransformationContext) => (sourceFile: typescript.SourceFile) => typescript.SourceFile;
+//# sourceMappingURL=transformer.d.ts.map

package/build/transformer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transformer.d.ts","sourceRoot":"","sources":["../src/transformer.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,YAAY,CAAC;AAEpC;;GAEG;AACH,oBAAY,QAAQ;IAClB,IAAI,SAAS;CACd;AAED,oBAAY,UAAU;IACpB,KAAK,UAAU;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,YAAY,CAAC,EAAE,UAAU,EAAE,CAAC;IAC5B,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,YAAY,SAC5D,WAAW,qBAAqB,kBACvB,WAAW,UAAU,2BAwF5C"}

package/build/transformer.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Capability = exports.Reporter = void 0;
+const tslib_1 = require("tslib");
+const typescript_1 = tslib_1.__importDefault(require("typescript"));
+/**
+ * unused right now.
+ */
+var Reporter;
+(function (Reporter) {
+    Reporter["Json"] = "json";
+})(Reporter = exports.Reporter || (exports.Reporter = {}));
+var Capability;
+(function (Capability) {
+    Capability["Timer"] = "timer";
+})(Capability = exports.Capability || (exports.Capability = {}));
+function default_1(program, config) {
+    return (ctx) => {
+        return (sourceFile) => {
+            let capabilities = [Capability.Timer];
+            if (config && config.capabilities) {
+                capabilities = config.capabilities;
+            }
+            const myLib = "@microsoft/metrics-ts";
+            const myNamespace = "metrics_9527";
+            /**
+             * find source file node and add "import" statements
+             * TODO: check imports,
+             * @see {@link https://stackoverflow.com/questions/67723545/how-to-update-or-insert-to-import-using-typescript-compiler-api}
+             * TODO: can't trans to commonjs is there's no import statement of source file.
+             * TODO: make import name unique
+             */
+            function sourfileVisitor(node) {
+                if (typescript_1.default.isSourceFile(node)) {
+                    return ctx.factory.updateSourceFile(node, [
+                        ctx.factory.createImportDeclaration(undefined /** decorators */, undefined /** modifiers */, ctx.factory.createImportClause(false, undefined /** name */, ctx.factory.createNamespaceImport(ctx.factory.createIdentifier(myNamespace))), ctx.factory.createStringLiteral(myLib)),
+                        ...sourceFile.statements,
+                    ]);
+                }
+                return typescript_1.default.visitEachChild(node, sourfileVisitor, ctx);
+            }
+            /**
+             * find all methods and add metrics decorators for them
+             */
+            function methodVisitor(node) {
+                if (typescript_1.default.isMethodDeclaration(node)) {
+                    /**
+                     * create metric decorator for function declaration
+                     */
+                    const metricsDecorators = [];
+                    for (const cap of capabilities) {
+                        metricsDecorators.push(ctx.factory.createDecorator(ctx.factory.createCallExpression(ctx.factory.createIdentifier(`${myNamespace}.${cap}`), undefined, [])));
+                    }
+                    /**
+                     * aggragate existing decorators with new decorators
+                     */
+                    let decorators;
+                    if (node.decorators) {
+                        decorators = [...node.decorators, ...metricsDecorators];
+                    }
+                    else {
+                        decorators = metricsDecorators;
+                    }
+                    /**
+                     * just update decorators, keep everything else.
+                     */
+                    return ctx.factory.updateMethodDeclaration(node, decorators, node.modifiers, node.asteriskToken, node.name, node.questionToken, node.typeParameters, node.parameters, node.type, node.body);
+                }
+                return typescript_1.default.visitEachChild(node, methodVisitor, ctx);
+            }
+            sourceFile = typescript_1.default.visitNode(sourceFile, sourfileVisitor);
+            return typescript_1.default.visitNode(sourceFile, methodVisitor);
+        };
+    };
+}
+exports.default = default_1;
+//# sourceMappingURL=transformer.js.map

package/build/transformer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transformer.js","sourceRoot":"","sources":["../src/transformer.ts"],"names":[],"mappings":";;;;AAAA,oEAAoC;AAEpC;;GAEG;AACH,IAAY,QAEX;AAFD,WAAY,QAAQ;IAClB,yBAAa,CAAA;AACf,CAAC,EAFW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAEnB;AAED,IAAY,UAEX;AAFD,WAAY,UAAU;IACpB,6BAAe,CAAA;AACjB,CAAC,EAFW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAErB;AAOD,mBAAyB,OAA2B,EAAE,MAAqB;IACzE,OAAO,CAAC,GAAqC,EAAE,EAAE;QAC/C,OAAO,CAAC,UAAiC,EAAE,EAAE;YAC3C,IAAI,YAAY,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACtC,IAAI,MAAM,IAAI,MAAM,CAAC,YAAY,EAAE;gBACjC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;aACpC;YAED,MAAM,KAAK,GAAG,uBAAuB,CAAC;YACtC,MAAM,WAAW,GAAG,cAAc,CAAC;YACnC;;;;;;eAMG;YACH,SAAS,eAAe,CAAC,IAAqB;gBAC5C,IAAI,oBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;oBACjC,OAAO,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAA6B,EAAE;wBACjE,GAAG,CAAC,OAAO,CAAC,uBAAuB,CACjC,SAAS,CAAC,iBAAiB,EAC3B,SAAS,CAAC,gBAAgB,EAC1B,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAC5B,KAAK,EACL,SAAS,CAAC,WAAW,EACrB,GAAG,CAAC,OAAO,CAAC,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC,CAC7E,EACD,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,KAAK,CAAC,CACvC;wBACD,GAAG,UAAU,CAAC,UAAU;qBACzB,CAAC,CAAC;iBACJ;gBACD,OAAO,oBAAU,CAAC,cAAc,CAAC,IAAI,EAAE,eAAe,EAAE,GAAG,CAAC,CAAC;YAC/D,CAAC;YAED;;eAEG;YACH,SAAS,aAAa,CAAC,IAAqB;gBAC1C,IAAI,oBAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE;oBACxC;;uBAEG;oBACH,MAAM,iBAAiB,GAAG,EAAE,CAAC;oBAC7B,KAAK,MAAM,GAAG,IAAI,YAAY,EAAE;wBAC9B,iBAAiB,CAAC,IAAI,CACpB,GAAG,CAAC,OAAO,CAAC,eAAe,CACzB,GAAG,CAAC,OAAO,CAAC,oBAAoB,CAC9B,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,GAAG,WAAW,IAAI,GAAG,EAAE,CAAC,EACrD,SAAS,EACT,EAAE,CACH,CACF,CACF,CAAC;qBACH;oBAED;;uBAEG;oBACH,IAAI,UAAkC,CAAC;oBACvC,IAAI,IAAI,CAAC,UAAU,EAAE;wBACnB,UAAU,GAAG,CAAC,GAAG,IAAI,CAAC,UAAU,EAAE,GAAG,iBAAiB,CAAC,CAAC;qBACzD;yBAAM;wBACL,UAAU,GAAG,iBAAiB,CAAC;qBAChC;oBAED;;uBAEG;oBACH,OAAO,GAAG,CAAC,OAAO,CAAC,uBAAuB,CACxC,IAAI,EACJ,UAAU,EACV,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,IAAI,CACV,CAAC;iBACH;gBACD,OAAO,oBAAU,CAAC,cAAc,CAAC,IAAI,EAAE,aAAa,EAAE,GAAG,CAAC,CAAC;YAC7D,CAAC;YAED,UAAU,GAAG,oBAAU,CAAC,SAAS,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;YAC/D,OAAO,oBAAU,CAAC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;QACzD,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AA1FD,4BA0FC"}

package/build/writer.d.ts

@@ -0,0 +1,4 @@
+import { tracePoint } from "./rawData";
+export declare function appendOutput(data: tracePoint): Promise<void>;
+export declare function appendOutputSync(data: tracePoint): void;
+//# sourceMappingURL=writer.d.ts.map

package/build/writer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"writer.d.ts","sourceRoot":"","sources":["../src/writer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAQvC,wBAAsB,YAAY,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAKlE;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI,CAKvD"}

package/build/writer.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.appendOutputSync = exports.appendOutput = void 0;
+const path_1 = require("path");
+const fs_extra_1 = require("fs-extra");
+const os_1 = require("os");
+const fs_1 = require("fs");
+const metricsFolder = (0, path_1.join)((0, os_1.tmpdir)(), ".metrics");
+const metricsFile = (0, path_1.join)(metricsFolder, "output.txt");
+async function appendOutput(data) {
+    await (0, fs_extra_1.ensureDir)(metricsFolder);
+    await (0, fs_extra_1.ensureFile)(metricsFile);
+    await (0, fs_extra_1.appendFile)(metricsFile, JSON.stringify(data) + os_1.EOL);
+    return;
+}
+exports.appendOutput = appendOutput;
+function appendOutputSync(data) {
+    (0, fs_extra_1.ensureDirSync)(metricsFolder);
+    (0, fs_extra_1.ensureFileSync)(metricsFile);
+    (0, fs_1.appendFileSync)(metricsFile, JSON.stringify(data) + os_1.EOL);
+    return;
+}
+exports.appendOutputSync = appendOutputSync;
+//# sourceMappingURL=writer.js.map

package/build/writer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"writer.js","sourceRoot":"","sources":["../src/writer.ts"],"names":[],"mappings":";;;AAAA,+BAA4B;AAE5B,uCAA4F;AAC5F,2BAAiC;AACjC,2BAAoC;AAEpC,MAAM,aAAa,GAAG,IAAA,WAAI,EAAC,IAAA,WAAM,GAAE,EAAE,UAAU,CAAC,CAAC;AACjD,MAAM,WAAW,GAAG,IAAA,WAAI,EAAC,aAAa,EAAE,YAAY,CAAC,CAAC;AAE/C,KAAK,UAAU,YAAY,CAAC,IAAgB;IACjD,MAAM,IAAA,oBAAS,EAAC,aAAa,CAAC,CAAC;IAC/B,MAAM,IAAA,qBAAU,EAAC,WAAW,CAAC,CAAC;IAC9B,MAAM,IAAA,qBAAU,EAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,QAAG,CAAC,CAAC;IAC1D,OAAO;AACT,CAAC;AALD,oCAKC;AAED,SAAgB,gBAAgB,CAAC,IAAgB;IAC/C,IAAA,wBAAa,EAAC,aAAa,CAAC,CAAC;IAC7B,IAAA,yBAAc,EAAC,WAAW,CAAC,CAAC;IAC5B,IAAA,mBAAc,EAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,QAAG,CAAC,CAAC;IACxD,OAAO;AACT,CAAC;AALD,4CAKC"}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@microsoft/metrics-ts",
+  "version": "0.0.1",
+  "description": "Add metrics without intruding source code",
+  "keywords": [
+    "Metrics"
+  ],
+  "author": "Long Hao<haolong@microsoft.com>",
+  "homepage": "https://github.com/OfficeDev/TeamsFx#readme",
+  "license": "MIT",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/OfficeDev/TeamsFx.git"
+  },
+  "scripts": {
+    "build": "rimraf build && npx tsc -p ./",
+    "format-check": "echo test",
+    "check-sensitive": "npx eslint --plugin 'no-secrets' --cache --ignore-pattern 'package.json' --ignore-pattern 'package-lock.json'",
+    "precommit": "npm run check-sensitive && lint-staged",
+    "lint": "eslint \"**/*.ts\"",
+    "lint:staged": "lint-staged"
+  },
+  "bugs": {
+    "url": "https://github.com/OfficeDev/TeamsFx/issues"
+  },
+  "devDependencies": {
+    "@istanbuljs/nyc-config-typescript": "^1.0.1",
+    "@types/chai": "^4.2.21",
+    "@types/mocha": "^8.2.3",
+    "@types/node": "^16.0.0",
+    "@types/uuid": "^8.3.4",
+    "@typescript-eslint/eslint-plugin": "^4.19.0",
+    "@typescript-eslint/parser": "^4.19.0",
+    "chai": "^4.3.4",
+    "eslint": "^7.22.0",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-no-secrets": "^0.8.9",
+    "eslint-plugin-prettier": "^4.0.0",
+    "lint-staged": "^10.5.4",
+    "mocha": "^9.2.1",
+    "nyc": "^15.1.0",
+    "prettier": "^2.4.1",
+    "ts-node": "^10.1.0",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0",
+    "ttypescript": "^1.5.13",
+    "typescript": "^4.3.5"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "lint-staged": {
+    "*.{js,jsx,css,ts,tsx}": [
+      "npx eslint --cache --fix --quiet"
+    ]
+  },
+  "dependencies": {
+    "uuid": "^8.3.2"
+  },
+  "gitHead": "e30209b171c59985670db2c18425689c7c21b58a"
+}

package/sample/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "transformer-sample",
+  "version": "0.0.1",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "license": "MIT",
+  "scripts": {
+    "build": "npx ttsc -p ."
+  },
+  "devDependencies": {
+    "@microsoft/metrics-ts": "file:../",
+    "ts-node": "^10.8.1",
+    "@types/node": "^16.0.0",
+    "ttypescript": "^1.5.13",
+    "typescript": "^4.3.5"
+  }
+}

package/sample/src/index.ts

@@ -0,0 +1,31 @@
+import * as path123 from "path";
+import { timer } from "@microsoft/metrics-ts";
+
+function delay(ms: number) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+class Foo {
+  @timer()
+  bar() {
+    const r = this.baz();
+    console.log(r);
+    console.log(r.indexOf(0));
+  }
+
+  @timer()
+  baz(): number[] {
+    path123.join("a", "b");
+    return [1];
+  }
+
+  @timer()
+  async buz(arg: string, arg2: any) {
+    await delay(1000);
+    this.bar();
+  }
+}
+
+process.env.METAOS_TRACE_ID = "123";
+const f = new Foo();
+f.buz("Hello World!", { a: 1 }).then();

package/sample/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "module": "CommonJS",
+    "target": "es2017",
+    "outDir": "build",
+    "lib": ["es6", "dom.iterable", "dom"],
+    "allowJs": true,
+    "importHelpers": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "sourceMap": true,
+    "declarationMap": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "jsx": "react",
+    "declaration": true,
+    "plugins": [{ "transform": "@microsoft/metrics-ts", "capabilities": ["timer"]}]
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "**/tests/*"]
+}

package/src/capability/index.ts

@@ -0,0 +1 @@
+export { MSTimer } from "./timer";

package/src/capability/timer.ts

@@ -0,0 +1,88 @@
+/**
+ * Timer - measures call-rate of a function and the distribution of the duration of all calls
+ */
+import { performance } from "perf_hooks";
+import { timerData, TimerSeverity, tracePoint } from "../rawData";
+import { traceId } from "../tracing";
+import { appendOutput, appendOutputSync } from "../writer";
+
+/**
+ * TODO: allow cutomization
+ * all in millsecond
+ */
+const fast = 1;
+const normal = 20;
+
+export const MSTimer = (fn: string) => {
+  /* eslint-disable  @typescript-eslint/no-explicit-any */
+  /* eslint-disable  @typescript-eslint/explicit-module-boundary-types */
+  return (target: any, propertyKey: string, descriptor: PropertyDescriptor) => {
+    const originalMethod = descriptor.value;
+
+    /**
+     * get essential properties
+     */
+    const data: tracePoint = {
+      traceId: traceId(),
+      file: fn,
+      class: target.constructor.name,
+      method: originalMethod.name,
+      timestamp: Date.now(),
+    };
+
+    if (originalMethod.constructor.name === "AsyncFunction") {
+      descriptor.value = async function (...args: any[]) {
+        data.args = args;
+
+        const start = performance.now();
+        const result = await originalMethod.apply(this, args);
+        const end = performance.now();
+        const duration = end - start;
+        let severity: TimerSeverity;
+        if (duration > normal) {
+          severity = TimerSeverity.Slow;
+        } else if (duration > fast) {
+          severity = TimerSeverity.Normal;
+        } else {
+          severity = TimerSeverity.Fast;
+        }
+        const timerData: timerData = {
+          duration: duration,
+          severity: severity,
+        };
+
+        data.timer = timerData;
+
+        await appendOutput(data);
+        return result;
+      };
+    } else {
+      descriptor.value = function (...args: any[]) {
+        data.args = args;
+
+        const start = performance.now();
+        const result = originalMethod.apply(this, args);
+        const end = performance.now();
+        const duration = end - start;
+        let severity: TimerSeverity;
+        if (duration > normal) {
+          severity = TimerSeverity.Slow;
+        } else if (duration > fast) {
+          severity = TimerSeverity.Normal;
+        } else {
+          severity = TimerSeverity.Fast;
+        }
+        const timerData: timerData = {
+          duration: duration,
+          severity: severity,
+        };
+
+        data.timer = timerData;
+
+        appendOutputSync(data);
+        return result;
+      };
+    }
+    return descriptor;
+  };
+};

package/src/index.ts

@@ -0,0 +1,5 @@
+import { default as transformer } from "./transformer";
+
+export * from "./capability";
+
+export default transformer;

package/src/rawData.ts

@@ -0,0 +1,23 @@
+export interface tracePoint {
+  traceId: string;
+  //pspanId: number;
+  //spanId: number;
+  file: string;
+  class: string;
+  timestamp: number;
+  method: string;
+  /* eslint-disable  @typescript-eslint/no-explicit-any */
+  args?: any;
+  timer?: timerData;
+}
+
+export enum TimerSeverity {
+  Fast = "fast",
+  Normal = "normal",
+  Slow = "slow",
+}
+
+export interface timerData {
+  duration: number;
+  severity: TimerSeverity;
+}

package/src/tracing.ts

@@ -0,0 +1,15 @@
+import { env } from "process";
+import { v4 as uuidv4 } from "uuid";
+
+/**
+ * TODO: make it safe
+ */
+export function traceId(): string {
+  if (env.METAOS_TRACE_ID) {
+    return env.METAOS_TRACE_ID;
+  } else {
+    const traceId = uuidv4();
+    env.METAOS_TRACE_ID = traceId;
+    return traceId;
+  }
+}

package/src/transformer.ts

@@ -0,0 +1,109 @@
+import typescript from "typescript";
+
+/**
+ * unused right now.
+ */
+export enum Reporter {
+  Json = "json",
+}
+
+export enum Capability {
+  Timer = "timer",
+}
+
+export interface PluginConfig {
+  capabilities?: Capability[];
+  reporters?: Reporter[];
+}
+
+export default function (program: typescript.Program, config?: PluginConfig) {
+  return (ctx: typescript.TransformationContext) => {
+    return (sourceFile: typescript.SourceFile) => {
+      let capabilities = [Capability.Timer];
+      if (config && config.capabilities) {
+        capabilities = config.capabilities;
+      }
+
+      const myLib = "@microsoft/metrics-ts";
+      const myNamespace = "metrics_9527";
+      /**
+       * find source file node and add "import" statements
+       * TODO: check imports,
+       * @see {@link https://stackoverflow.com/questions/67723545/how-to-update-or-insert-to-import-using-typescript-compiler-api}
+       * TODO: can't trans to commonjs is there's no import statement of source file.
+       * TODO: make import name unique
+       */
+      function sourfileVisitor(node: typescript.Node): typescript.Node {
+        if (typescript.isSourceFile(node)) {
+          return ctx.factory.updateSourceFile(node as typescript.SourceFile, [
+            ctx.factory.createImportDeclaration(
+              undefined /** decorators */,
+              undefined /** modifiers */,
+              ctx.factory.createImportClause(
+                false,
+                undefined /** name */,
+                ctx.factory.createNamespaceImport(ctx.factory.createIdentifier(myNamespace))
+              ),
+              ctx.factory.createStringLiteral(myLib)
+            ),
+            ...sourceFile.statements,
+          ]);
+        }
+        return typescript.visitEachChild(node, sourfileVisitor, ctx);
+      }
+
+      /**
+       * find all methods and add metrics decorators for them
+       */
+      function methodVisitor(node: typescript.Node): typescript.Node {
+        if (typescript.isMethodDeclaration(node)) {
+          /**
+           * create metric decorator for function declaration
+           */
+          const metricsDecorators = [];
+          for (const cap of capabilities) {
+            metricsDecorators.push(
+              ctx.factory.createDecorator(
+                ctx.factory.createCallExpression(
+                  ctx.factory.createIdentifier(`${myNamespace}.${cap}`),
+                  undefined,
+                  []
+                )
+              )
+            );
+          }
+
+          /**
+           * aggragate existing decorators with new decorators
+           */
+          let decorators: typescript.Decorator[];
+          if (node.decorators) {
+            decorators = [...node.decorators, ...metricsDecorators];
+          } else {
+            decorators = metricsDecorators;
+          }
+
+          /**
+           * just update decorators, keep everything else.
+           */
+          return ctx.factory.updateMethodDeclaration(
+            node,
+            decorators,
+            node.modifiers,
+            node.asteriskToken,
+            node.name,
+            node.questionToken,
+            node.typeParameters,
+            node.parameters,
+            node.type,
+            node.body
+          );
+        }
+        return typescript.visitEachChild(node, methodVisitor, ctx);
+      }
+
+      sourceFile = typescript.visitNode(sourceFile, sourfileVisitor);
+      return typescript.visitNode(sourceFile, methodVisitor);
+    };
+  };
+}

package/src/writer.ts

@@ -0,0 +1,22 @@
+import { join } from "path";
+import { tracePoint } from "./rawData";
+import { appendFile, ensureDir, ensureDirSync, ensureFile, ensureFileSync } from "fs-extra";
+import { EOL, tmpdir } from "os";
+import { appendFileSync } from "fs";
+
+const metricsFolder = join(tmpdir(), ".metrics");
+const metricsFile = join(metricsFolder, "output.txt");
+
+export async function appendOutput(data: tracePoint): Promise<void> {
+  await ensureDir(metricsFolder);
+  await ensureFile(metricsFile);
+  await appendFile(metricsFile, JSON.stringify(data) + EOL);
+  return;
+}
+
+export function appendOutputSync(data: tracePoint): void {
+  ensureDirSync(metricsFolder);
+  ensureFileSync(metricsFile);
+  appendFileSync(metricsFile, JSON.stringify(data) + EOL);
+  return;
+}

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "module": "CommonJS",
+    "target": "es2017",
+    "outDir": "build",
+    "lib": ["es6"],
+    "allowJs": true,
+    "importHelpers": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "sourceMap": true,
+    "declarationMap": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "jsx": "react",
+    "declaration": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "tests", "sample"]
+}