@shuvi/service 1.0.29 → 1.0.30

package/lib/analysis/index.d.ts

@@ -1,5 +1,11 @@
-import { IPluginContext, Telemetry } from '../core';
+import { IPluginContext } from '../core';
+import { RecordObject, TelemetryEvent } from '@shuvi/reporters';
+interface Telemetry {
+    record(events: TelemetryEvent | TelemetryEvent[]): Promise<RecordObject>;
+    flush(): Promise<void>;
+}
 export declare const analysis: ({ context, telemetry }: {
     context: IPluginContext;
-    telemetry: Telemetry;
+    telemetry?: Telemetry | undefined;
 }) => Promise<void>;
+export {};

package/lib/core/api.d.ts

@@ -1,4 +1,3 @@
-import { Telemetry as TelemetryImpl, RecordObject, TelemetryEvent } from '@shuvi/telemetry';
 import { FileOptionWithId } from '../project';
 import { Bundler } from '../bundler';
 import { ServerPluginInstance } from '../server';
@@ -13,17 +12,12 @@ interface IApiOPtions {
     plugins?: IPluginConfig[];
     presets?: IPresetConfig[];
     normalizePlatformConfig?: (rawConfig: ShuviConfig) => ShuviConfig;
-    telemetry?: TelemetryImpl;
 }
 interface ServerConfigs {
     serverPlugins: ServerPluginInstance[];
     getMiddlewares: IPlatformContent['getMiddlewares'];
     getMiddlewaresBeforeDevMiddlewares: IPlatformContent['getMiddlewaresBeforeDevMiddlewares'];
 }
-export interface Telemetry {
-    record(events: TelemetryEvent | TelemetryEvent[]): Promise<RecordObject>;
-    flush(): Promise<void>;
-}
 declare class Api {
     private _inited;
     private _cwd;
@@ -39,8 +33,6 @@ declare class Api {
     private _config;
     private _plugins;
     private _presets;
-    private _telemetryImpl?;
-    private _telemetry;
     private _platform?;
     private _normalizePlatformConfig?;
     private _serverConfigs;
@@ -49,13 +41,12 @@ declare class Api {
     private _pluginContext;
     /** will be included by @shuvi/swc-loader */
     private _runtimePluginDirs;
-    constructor({ cwd, mode, config, configFile, presets, plugins, phase, platform, normalizePlatformConfig, telemetry }: IApiOPtions);
+    constructor({ cwd, mode, config, configFile, presets, plugins, phase, platform, normalizePlatformConfig }: IApiOPtions);
     get cwd(): string;
     get mode(): IServiceMode;
     get pluginManager(): import("@shuvi/hook").HookManager<import("./plugin").PluginHooks, IPluginContext>;
     get pluginContext(): IPluginContext;
     get serverConfigs(): ServerConfigs;
-    get telemetry(): Telemetry;
     init(): Promise<void>;
     getBundler(): Promise<Bundler>;
     get assetPublicPath(): string;

package/lib/core/api.js

@@ -40,7 +40,6 @@ const hook_1 = require("@shuvi/hook");
 const deepmerge_1 = require("@shuvi/utils/deepmerge");
 const string_1 = require("@shuvi/utils/string");
 const logger_1 = __importDefault(require("@shuvi/utils/logger"));
-const trace_1 = require("@shuvi/trace");
 const rimraf_1 = __importDefault(require("rimraf"));
 const path = __importStar(require("path"));
 const project_1 = require("../project");
@@ -56,7 +55,7 @@ const webpack_watch_wait_for_file_builder_plugin_1 = __importDefault(require("..
 const config_2 = require("../config");
 const ServiceModes = ['development', 'production'];
 class Api {
-    constructor({ cwd, mode, config, configFile, presets, plugins, phase, platform, normalizePlatformConfig, telemetry }) {
+    constructor({ cwd, mode, config, configFile, presets, plugins, phase, platform, normalizePlatformConfig }) {
         this._inited = false;
         this._plugins = [];
         this._presets = [];
@@ -71,7 +70,6 @@ class Api {
         this._customConfig = config || {};
         this._customPresets = presets || [];
         this._customPlugins = plugins || [];
-        this._telemetryImpl = telemetry;
         this._pluginManager = (0, plugin_1.getManager)();
         this._pluginManager.clear();
         this._projectBuilder = new project_1.ProjectBuilder();
@@ -92,28 +90,6 @@ class Api {
     get serverConfigs() {
         return this._serverConfigs;
     }
-    get telemetry() {
-        if (!this._telemetry) {
-            this._telemetry = {
-                record: (events) => {
-                    if (!this._telemetryImpl) {
-                        return Promise.resolve({
-                            isFulfilled: true,
-                            isRejected: true
-                        });
-                    }
-                    return this._telemetryImpl.record(events);
-                },
-                flush: () => {
-                    if (!this._telemetryImpl) {
-                        return Promise.resolve();
-                    }
-                    return this._telemetryImpl.flush();
-                }
-            };
-        }
-        return this._telemetry;
-    }
     init() {
         return __awaiter(this, void 0, void 0, function* () {
             if (this._inited) {
@@ -201,9 +177,6 @@ class Api {
             platformPresetRuntimeFiles.forEach(file => {
                 this.addInternalRuntimeFile(file);
             });
-            (0, trace_1.setGlobal)('buildDir', this._paths.buildDir);
-            (0, trace_1.setGlobal)('phase', constants_1.PHASE_DEVELOPMENT_SERVER);
-            (0, trace_1.setGlobal)('telemetry', this._telemetryImpl);
             this._inited = true;
         });
     }
@@ -401,8 +374,7 @@ function getApi(options = {}) {
             platform: options.platform,
             presets: options.presets,
             plugins: options.plugins,
-            normalizePlatformConfig: options.normalizePlatformConfig,
-            telemetry: options.telemetry
+            normalizePlatformConfig: options.normalizePlatformConfig
         });
         try {
             yield api.init();

package/lib/core/index.d.ts

@@ -1,4 +1,4 @@
-export type { Api, Telemetry } from './api';
+export type { Api } from './api';
 export { getApi } from './api';
 export { resolvePlugin } from './getPlugins';
 export * from './apiTypes';

package/lib/index.d.ts

@@ -4,4 +4,4 @@ export { Bundler } from './bundler';
 export { ProjectBuilder } from './project';
 export { analysis } from './analysis';
 export { IShuviServer, ShuviRequest, ShuviResponse, IServerPluginContext, ShuviRequestHandler, ServerPluginConstructor, ServerPluginInstance, IServerMiddleware, createShuviServer, createServerPlugin, createServerPluginBefore, createServerPluginAfter } from './server';
-export { Api, Telemetry, IPaths, ShuviConfig, IServicePhase, IServiceMode, IPluginConfig, IPresetConfig, PresetFunction, IPresetContent, NormalizedShuviConfig, IPluginContext, IPlatform, IPlatformContent, CorePluginConstructor, CorePluginInstance, getApi, createPlugin, createPluginBefore, createPluginAfter, ResolvedPlugin } from './core';
+export { Api, IPaths, ShuviConfig, IServicePhase, IServiceMode, IPluginConfig, IPresetConfig, PresetFunction, IPresetContent, NormalizedShuviConfig, IPluginContext, IPlatform, IPlatformContent, CorePluginConstructor, CorePluginInstance, getApi, createPlugin, createPluginBefore, createPluginAfter, ResolvedPlugin } from './core';

package/lib/server/middlewares/dev/hotMiddleware.js

@@ -9,7 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebpackHotMiddleware = void 0;
 const module_replace_plugin_1 = __importDefault(require("@shuvi/toolpack/lib/webpack/plugins/module-replace-plugin"));
 const constants_1 = require("@shuvi/shared/constants");
-const trace_1 = require("@shuvi/trace");
+const trace_1 = require("../../../trace");
 //@ts-ignore
 const package_json_1 = __importDefault(require("../../../../package.json"));
 const modulesActivity = new Map();
@@ -35,7 +35,6 @@ class WebpackHotMiddleware {
             this.latestStats = statsResult;
             this.publishStats('built', this.latestStats);
             // Ensure traces are flushed after each compile in development mode
-            (0, trace_1.flushAllTraces)();
         };
         this.onHMR = (client) => {
             if (this.closed)
@@ -63,8 +62,8 @@ class WebpackHotMiddleware {
                         case 'client-hmr-latency': {
                             traceChild = {
                                 name: parsedData.event,
-                                startTime: BigInt(parsedData.startTime) * BigInt(1000 * 1000),
-                                endTime: BigInt(parsedData.endTime) * BigInt(1000 * 1000)
+                                startTime: parsedData.startTime,
+                                endTime: parsedData.endTime
                             };
                             break;
                         }
@@ -72,8 +71,8 @@ class WebpackHotMiddleware {
                             break;
                         }
                     }
-                    if (traceChild) {
-                        this.hotMiddlewareSpan.manualTraceChild(traceChild.name, traceChild.startTime || process.hrtime.bigint(), traceChild.endTime || process.hrtime.bigint(), Object.assign({}, traceChild.attrs));
+                    if (traceChild && traceChild.startTime && traceChild.endTime) {
+                        this.hotMiddlewareSpan.manualTraceChild(traceChild.name, traceChild.startTime, traceChild.endTime, Object.assign({}, traceChild.attrs));
                     }
                 }
                 catch (_) { }
@@ -117,7 +116,7 @@ class WebpackHotMiddleware {
         });
         // Ensure the hotMiddlewareSpan is flushed immediately as it's the parentSpan for all processing
         // of the current `shuvi dev` invocation.
-        this.hotMiddlewareSpan.stop();
+        // this.hotMiddlewareSpan.stop();
     }
     updateModuleActivity(matchRoutes, page) {
         if (matchRoutes.length < 1 || !page)

package/lib/server/plugin.d.ts

@@ -1,9 +1,14 @@
 import { IPluginInstance, IPluginHandlers, HookMap } from '@shuvi/hook';
 import { IPluginContext } from '../core';
 import { CustomServerPluginHooks } from './pluginTypes';
+import { Span } from '../trace';
 export * from './pluginTypes';
 export interface IServerPluginContext extends IPluginContext {
     serverPluginRunner: PluginManager['runner'];
+    traces: {
+        serverCreateAppTrace: Span;
+        serverRequestTrace: Span;
+    };
 }
 export declare type PluginManager = ReturnType<typeof getManager>;
 export declare type PluginRunner = PluginManager['runner'];

package/lib/server/plugin.js

@@ -18,6 +18,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.initServerPlugins = exports.createServerPluginAfter = exports.createServerPlugin = exports.createServerPluginBefore = exports.getManager = void 0;
 const hook_1 = require("@shuvi/hook");
 const plugins_1 = require("@shuvi/shared/plugins");
+const trace_1 = require("@shuvi/shared/constants/trace");
+const trace_2 = require("../trace");
 __exportStar(require("./pluginTypes"), exports);
 const listen = (0, hook_1.createAsyncParallelHook)();
 const internalHooks = {
@@ -27,7 +29,13 @@ const getManager = () => (0, hook_1.createHookManager)(internalHooks);
 exports.getManager = getManager;
 _a = (0, plugins_1.createPluginCreator)(), exports.createServerPluginBefore = _a.createPluginBefore, exports.createServerPlugin = _a.createPlugin, exports.createServerPluginAfter = _a.createPluginAfter;
 const initServerPlugins = (manager, serverPlugins, pluginContext) => {
-    const serverContext = Object.assign({ serverPluginRunner: manager.runner }, pluginContext);
+    const serverContext = Object.assign({
+        serverPluginRunner: manager.runner,
+        traces: {
+            serverCreateAppTrace: (0, trace_2.trace)(trace_1.SERVER_CREATE_APP.name),
+            serverRequestTrace: (0, trace_2.trace)(trace_1.SERVER_REQUEST.name)
+        }
+    }, pluginContext);
     manager.setContext(serverContext);
     serverPlugins.forEach(plugin => {
         manager.usePlugin(plugin);

package/lib/server/shuviServer.js

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShuviServer = void 0;
+const trace_1 = require("@shuvi/shared/constants/trace");
 const string_1 = require("@shuvi/utils/string");
 const serverMiddleware_1 = require("./serverMiddleware");
 const http_server_1 = require("./http-server");
@@ -39,6 +40,9 @@ class ShuviServer {
         return __awaiter(this, void 0, void 0, function* () {
             const { _serverContext: context, _server: server } = this;
             server.use(((req, resp, next) => {
+                context.traces.serverRequestTrace
+                    .traceChild(trace_1.SERVER_REQUEST.events.SHUVI_SERVER_HANDLE_REQUEST_START.name)
+                    .stop();
                 this._normalizeReq(req);
                 this._normalizeResp(resp);
                 next();

package/lib/trace/index.d.ts

@@ -0,0 +1,33 @@
+import type { SpanId, Reporter } from '@shuvi/shared/reporter';
+export declare enum SpanStatus {
+    Started = 0,
+    Stopped = 1
+}
+export declare let reporter: Reporter | undefined;
+export declare function setReporter(r: Reporter): void;
+export declare class Span {
+    private _name;
+    private _id;
+    private _parentId?;
+    private _attrs;
+    private _status;
+    private _now;
+    private _start;
+    constructor({ name, parentId, attrs, startTime }: {
+        name: string;
+        parentId?: SpanId;
+        startTime?: number;
+        attrs?: Record<string, any>;
+    });
+    get status(): SpanStatus;
+    stop(stopTime?: number): void;
+    traceChild(name: string, attrs?: Object): Span;
+    manualTraceChild(name: string, startTime: number, stopTime: number, attrs?: Object): void;
+    setAttribute(key: string, value: any): void;
+    setAttributes(attrs: Record<string, any>): void;
+    traceFn<T>(fn: (span: Span) => T): T;
+    traceAsyncFn<T>(fn: (span: Span) => T | Promise<T>): Promise<T>;
+}
+export declare const trace: (name: string, parentId?: SpanId, attrs?: {
+    [key: string]: string;
+} | undefined) => Span;

package/lib/trace/index.js

@@ -0,0 +1,114 @@
+"use strict";
+// This package 'trace' is a modified version of the Next.js that can be found here:
+// https://github.com/vercel/next.js/tree/canary/packages/next/src/trace
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.trace = exports.Span = exports.setReporter = exports.reporter = exports.SpanStatus = void 0;
+let count = 0;
+const getId = () => {
+    count++;
+    return count;
+};
+// eslint typescript has a bug with TS enums
+/* eslint-disable no-shadow */
+var SpanStatus;
+(function (SpanStatus) {
+    SpanStatus[SpanStatus["Started"] = 0] = "Started";
+    SpanStatus[SpanStatus["Stopped"] = 1] = "Stopped";
+})(SpanStatus = exports.SpanStatus || (exports.SpanStatus = {}));
+exports.reporter = undefined;
+function setReporter(r) {
+    if (exports.reporter) {
+        throw new Error('Reporter already set !');
+        return;
+    }
+    exports.reporter = r;
+}
+exports.setReporter = setReporter;
+class Span {
+    constructor({ name, parentId, attrs, startTime }) {
+        this._name = name;
+        this._parentId = parentId;
+        this._attrs = attrs ? Object.assign({}, attrs) : {};
+        this._status = SpanStatus.Started;
+        this._id = getId();
+        const now = Date.now();
+        this._start = startTime || now;
+        // Capturing current datetime as additional metadata for external reconstruction.
+        this._now = now;
+    }
+    get status() {
+        return this._status;
+    }
+    // Durations are reported as microseconds.
+    // of something like Date.now(), which reports in milliseconds.
+    // Additionally, ~285 years can be safely represented as microseconds as
+    // a float64 in both JSON and JavaScript.
+    stop(stopTime) {
+        if (!exports.reporter) {
+            return;
+        }
+        const end = stopTime || Date.now();
+        const duration = end - this._start;
+        this._status = SpanStatus.Stopped;
+        if (duration > Number.MAX_SAFE_INTEGER) {
+            console.warn(`Duration is too long to express as float64: ${duration}`);
+        }
+        (0, exports.reporter)({
+            timestamp: this._now,
+            name: this._name,
+            duration,
+            startTime: this._start,
+            endTime: end,
+            id: this._id,
+            parentId: this._parentId,
+            attrs: this._attrs
+        });
+    }
+    traceChild(name, attrs) {
+        return new Span({ name, parentId: this._id, attrs });
+    }
+    manualTraceChild(name, startTime, stopTime, attrs) {
+        const span = new Span({ name, parentId: this._id, attrs, startTime });
+        span.stop(stopTime);
+    }
+    setAttribute(key, value) {
+        this._attrs[key] = String(value);
+    }
+    setAttributes(attrs) {
+        Object.keys(attrs).forEach(key => {
+            this.setAttribute(key, attrs[key]);
+        });
+    }
+    traceFn(fn) {
+        try {
+            return fn(this);
+        }
+        finally {
+            this.stop();
+        }
+    }
+    traceAsyncFn(fn) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield fn(this);
+            }
+            finally {
+                this.stop();
+            }
+        });
+    }
+}
+exports.Span = Span;
+const trace = (name, parentId, attrs) => {
+    return new Span({ name, parentId, attrs });
+};
+exports.trace = trace;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shuvi/service",
-  "version": "1.0.29",
+  "version": "1.0.30",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/shuvijs/shuvi.git",
@@ -29,15 +29,14 @@
     "@babel/generator": "7.14.5",
     "@babel/parser": "7.14.7",
     "@babel/traverse": "7.14.7",
-    "@shuvi/hook": "1.0.29",
-    "@shuvi/router": "1.0.29",
-    "@shuvi/runtime": "1.0.29",
-    "@shuvi/shared": "1.0.29",
-    "@shuvi/toolpack": "1.0.29",
-    "@shuvi/utils": "1.0.29",
-    "@shuvi/error-overlay": "1.0.29",
-    "@shuvi/telemetry": "1.0.29",
-    "@shuvi/trace": "1.0.29",
+    "@shuvi/hook": "1.0.30",
+    "@shuvi/router": "1.0.30",
+    "@shuvi/runtime": "1.0.30",
+    "@shuvi/shared": "1.0.30",
+    "@shuvi/toolpack": "1.0.30",
+    "@shuvi/utils": "1.0.30",
+    "@shuvi/error-overlay": "1.0.30",
+    "@shuvi/reporters": "1.0.30",
     "commander": "5.1.0",
     "comment-json": "4.2.2",
     "cross-spawn": "7.0.3",