@modern-js/types 2.28.0 → 2.29.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @modern-js/types
 
+## 2.29.0
+
+### Minor Changes
+
+- cba7675: feat: add a server reporter that report server cost, logger about error, info etc.
+  feat: 添加一个 server 端 reporter，来报告 server 端耗时，报错等
+
 ## 2.28.0
 
 ### Patch Changes

package/package.json

@@ -15,7 +15,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.28.0",
+  "version": "2.29.0",
   "types": "./index.d.ts",
   "exports": {
     ".": {
@@ -45,8 +45,8 @@
     "http-proxy-middleware": "^2.0.4",
     "jest": "^29",
     "type-fest": "2.15.0",
-    "@scripts/build": "2.28.0",
-    "@scripts/jest-config": "2.28.0"
+    "@scripts/jest-config": "2.29.0",
+    "@scripts/build": "2.29.0"
   },
   "sideEffects": false,
   "publishConfig": {

package/server/context.d.ts

@@ -1,7 +1,7 @@
 import { IncomingMessage, ServerResponse, IncomingHttpHeaders } from 'http';
 import qs from 'querystring';
 import type { SSRMode } from 'common';
-import { Metrics, Logger } from './utils';
+import { Metrics, Logger, Reporter, ServerTiming } from './utils';
 
 export interface ModernServerContext {
   req: IncomingMessage;
@@ -14,6 +14,10 @@ export interface ModernServerContext {
 
   metrics: Metrics;
 
+  reporter: Reporter;
+
+  serverTiming: ServerTiming;
+
   setParams: (params: Record<string, string>) => void;
 
   getReqHeader: (key: string) => void;
@@ -86,6 +90,8 @@ export type BaseSSRServerContext = {
       tags: Record<string, unknown> = {},
     ) => void;
   };
+  reporter: Reporter;
+  serverTiming: ServerTiming;
   cacheConfig?: any;
 
   enableUnsafeCtx?: boolean;

package/server/hook.d.ts

@@ -1,4 +1,5 @@
 import { IncomingMessage, ServerResponse, IncomingHttpHeaders } from 'http';
+import { Reporter } from './utils';
 
 export type CookieAPI = {
   /**
@@ -35,6 +36,7 @@ export type HookContext = {
   response: ModernResponse;
   request: ModernRequest;
   logger: Logger;
+  reporter?: Reporter;
   metrics?: Metrics;
 };
 

package/server/utils.d.ts

@@ -19,6 +19,40 @@ export type Logger = {
   log: LoggerFunction;
 };
 
+export interface ServerTiming {
+  addServeTiming: (name: string, dur: number, decs?: string) => this;
+}
+
+export type Reporter = {
+  sessionId?: string;
+  userId?: string;
+  client?: any;
+
+  init: (payload: { match: any }) => void | Promise<void>;
+
+  reportError: (
+    content: string,
+    e: Error,
+    extra?: Record<string, string | number>,
+  ) => void;
+
+  reportTiming: (
+    name: string,
+    value: number,
+    extra?: Record<string, string>,
+  ) => void;
+
+  reportInfo: (
+    content: string,
+    extra?: Record<string, string | number>,
+  ) => void;
+
+  reportWarn: (
+    content: string,
+    extra?: Record<string, string | number>,
+  ) => void;
+};
+
 export type NextFunction = () => void;
 
 export type ProxyDetail = ProxyOptions & {