@shuvi/service 1.0.7 → 1.0.8

package/lib/analysis/events/build.d.ts

@@ -0,0 +1,35 @@
+declare type EventBuildOptimized = {
+    durationInSeconds: number;
+    totalPageCount: number;
+    hasTestPages: boolean;
+    hasStatic404: boolean;
+    middlewareCount: number;
+    totalLoaderCount: number;
+    useTypeScript: boolean;
+};
+export declare function eventBuildOptimize(routePaths: string[], event: Omit<EventBuildOptimized, 'totalPageCount' | 'hasTestPages'>): {
+    eventName: string;
+    payload: EventBuildOptimized;
+};
+declare type EventPackageDetected = {
+    eventName: string;
+    payload: {
+        packageName: string;
+        packageVersion: string;
+    };
+};
+export declare function eventPackageDetected(dir: string): Promise<Array<EventPackageDetected>>;
+export declare const EVENT_BUILD_FEATURE_USAGE = "SHUVI_BUILD_FEATURE_USAGE";
+export declare type Feature = 'shuvi/lightningCss' | 'shuvi/webpack-dll' | 'swcPlugins' | 'swcModularizeImports' | 'swcRemoveConsole' | 'swcReactRemoveProperties' | 'swcJsxImportSource' | 'swcStyledComponents' | 'swcEmotion' | 'swcExperimentalDecorators' | 'swcEmitDecoratorMetadata';
+export declare type EventBuildFeatureUsage = {
+    featureName: Feature;
+    invocationCount: number;
+};
+export declare function eventBuildFeatureUsage({ compiler, experimental }: {
+    compiler: Record<string, any> | undefined;
+    experimental: Record<string, any> | undefined;
+}): Array<{
+    eventName: string;
+    payload: EventBuildFeatureUsage;
+}>;
+export {};

package/lib/analysis/events/build.js

@@ -0,0 +1,98 @@
+"use strict";
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.eventBuildFeatureUsage = exports.EVENT_BUILD_FEATURE_USAGE = exports.eventPackageDetected = exports.eventBuildOptimize = void 0;
+const find_up_1 = __importDefault(require("find-up"));
+const REGEXP_DIRECTORY_TESTS = /[\\/]__(tests|mocks)__[\\/]/i;
+const REGEXP_FILE_TEST = /\.(?:spec|test)\.[^.]+$/i;
+const EVENT_BUILD_OPTIMIZED = 'SHUVI_BUILD_OPTIMIZED';
+function eventBuildOptimize(routePaths, event) {
+    return {
+        eventName: EVENT_BUILD_OPTIMIZED,
+        payload: Object.assign(Object.assign({}, event), { totalPageCount: routePaths.filter(path => /page\..*/i.test(path)).length, hasTestPages: routePaths.some(path => REGEXP_DIRECTORY_TESTS.test(path) || REGEXP_FILE_TEST.test(path)) })
+    };
+}
+exports.eventBuildOptimize = eventBuildOptimize;
+const EVENT_PACKAGE_DETECTED = 'SHUVI_PACKAGE_DETECTED';
+function eventPackageDetected(dir) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const packageJsonPath = yield (0, find_up_1.default)('package.json', { cwd: dir });
+            if (!packageJsonPath) {
+                return [];
+            }
+            const { dependencies = {}, devDependencies = {} } = require(packageJsonPath);
+            const deps = Object.assign(Object.assign({}, devDependencies), dependencies);
+            return Object.keys(deps).reduce((events, plugin) => {
+                const version = deps[plugin];
+                // Don't add deps without a version set
+                if (!version) {
+                    return events;
+                }
+                events.push({
+                    eventName: EVENT_PACKAGE_DETECTED,
+                    payload: {
+                        packageName: plugin,
+                        packageVersion: version
+                    }
+                });
+                return events;
+            }, []);
+        }
+        catch (_) {
+            return [];
+        }
+    });
+}
+exports.eventPackageDetected = eventPackageDetected;
+exports.EVENT_BUILD_FEATURE_USAGE = 'SHUVI_BUILD_FEATURE_USAGE';
+const BUILD_FEATURES = [
+    'shuvi/lightningCss',
+    'shuvi/webpack-dll',
+    'swcPlugins',
+    'swcModularizeImports',
+    'swcRemoveConsole',
+    'swcReactRemoveProperties',
+    'swcJsxImportSource',
+    'swcStyledComponents',
+    'swcEmotion',
+    'swcExperimentalDecorators',
+    'swcEmitDecoratorMetadata'
+];
+function eventBuildFeatureUsage({ compiler, experimental }) {
+    var _a;
+    const buildFeaturesMap = new Map([
+        ['shuvi/lightningCss', !!(experimental === null || experimental === void 0 ? void 0 : experimental.lightningCss)],
+        ['shuvi/webpack-dll', !!(experimental === null || experimental === void 0 ? void 0 : experimental.preBundle)],
+        ['swcPlugins', !!((_a = experimental === null || experimental === void 0 ? void 0 : experimental.swcPlugins) === null || _a === void 0 ? void 0 : _a.length)],
+        ['swcModularizeImports', !!(experimental === null || experimental === void 0 ? void 0 : experimental.modularizeImports)],
+        ['swcRemoveConsole', !!(compiler === null || compiler === void 0 ? void 0 : compiler.removeConsole)],
+        ['swcReactRemoveProperties', !!(compiler === null || compiler === void 0 ? void 0 : compiler.reactRemoveProperties)],
+        ['swcJsxImportSource', !!(compiler === null || compiler === void 0 ? void 0 : compiler.jsxImportSource)],
+        ['swcStyledComponents', !!(compiler === null || compiler === void 0 ? void 0 : compiler.styledComponents)],
+        ['swcEmotion', !!(compiler === null || compiler === void 0 ? void 0 : compiler.emotion)],
+        ['swcExperimentalDecorators', !!(compiler === null || compiler === void 0 ? void 0 : compiler.experimentalDecorators)],
+        ['swcEmitDecoratorMetadata', !!(compiler === null || compiler === void 0 ? void 0 : compiler.emitDecoratorMetadata)]
+    ].filter(Boolean));
+    return BUILD_FEATURES.map(featureName => {
+        return {
+            eventName: exports.EVENT_BUILD_FEATURE_USAGE,
+            payload: {
+                featureName,
+                invocationCount: buildFeaturesMap.get(featureName) ? 1 : 0
+            }
+        };
+    });
+}
+exports.eventBuildFeatureUsage = eventBuildFeatureUsage;

package/lib/analysis/events/index.d.ts

@@ -0,0 +1 @@
+export * from './build';

package/lib/analysis/events/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./build"), exports);

package/lib/analysis/index.js

@@ -39,10 +39,11 @@ exports.analysis = void 0;
 const path = __importStar(require("path"));
 const fs = __importStar(require("fs"));
 const logger_1 = __importDefault(require("@shuvi/utils/lib/logger"));
-const events_1 = require("@shuvi/telemetry/lib/events");
+const events_1 = require("./events");
 const recursiveReaddir_1 = require("@shuvi/utils/lib/recursiveReaddir");
 const typescript_1 = require("../bundler/typescript");
 const analysis = ({ context, telemetry }) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
     if (!telemetry || !context) {
         return;
     }
@@ -67,6 +68,12 @@ const analysis = ({ context, telemetry }) => __awaiter(void 0, void 0, void 0, f
         .filter(loader => loader.startsWith('import')).length;
     const { useTypeScript } = (0, typescript_1.getJavaScriptInfo)();
     const analysisEnd = process.hrtime(analysisBegin);
+    const packageDetectedEvents = yield (0, events_1.eventPackageDetected)(context.paths.rootDir);
+    telemetry.record(packageDetectedEvents);
+    telemetry.record((0, events_1.eventBuildFeatureUsage)({
+        compiler: (_a = context.config) === null || _a === void 0 ? void 0 : _a.compiler,
+        experimental: (_b = context.config) === null || _b === void 0 ? void 0 : _b.experimental
+    }));
     telemetry.record((0, events_1.eventBuildOptimize)(routePaths, {
         durationInSeconds: analysisEnd[0],
         hasStatic404,

package/lib/core/api.d.ts

@@ -22,6 +22,7 @@ interface ServerConfigs {
 }
 export interface Telemetry {
     record(events: TelemetryEvent | TelemetryEvent[]): Promise<RecordObject>;
+    flush(): Promise<void>;
 }
 declare class Api {
     private _inited;

package/lib/core/api.js

@@ -102,6 +102,12 @@ class Api {
                         });
                     }
                     return this._telemetryImpl.record(events);
+                },
+                flush: () => {
+                    if (!this._telemetryImpl) {
+                        return Promise.resolve();
+                    }
+                    return this._telemetryImpl.flush();
                 }
             };
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shuvi/service",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/shuvijs/shuvi.git",
@@ -29,14 +29,14 @@
     "@babel/generator": "7.14.5",
     "@babel/parser": "7.14.7",
     "@babel/traverse": "7.14.7",
-    "@shuvi/hook": "1.0.7",
-    "@shuvi/router": "1.0.7",
-    "@shuvi/runtime": "1.0.7",
-    "@shuvi/shared": "1.0.7",
-    "@shuvi/toolpack": "1.0.7",
-    "@shuvi/utils": "1.0.7",
-    "@shuvi/error-overlay": "1.0.7",
-    "@shuvi/telemetry": "1.0.7",
+    "@shuvi/hook": "1.0.8",
+    "@shuvi/router": "1.0.8",
+    "@shuvi/runtime": "1.0.8",
+    "@shuvi/shared": "1.0.8",
+    "@shuvi/toolpack": "1.0.8",
+    "@shuvi/utils": "1.0.8",
+    "@shuvi/error-overlay": "1.0.8",
+    "@shuvi/telemetry": "1.0.8",
     "commander": "5.1.0",
     "comment-json": "4.2.2",
     "cross-spawn": "7.0.3",
@@ -48,7 +48,8 @@
     "send": "0.17.1",
     "ws": "8.2.3",
     "dotenv": "16.0.3",
-    "dotenv-expand": "9.0.0"
+    "dotenv-expand": "9.0.0",
+    "find-up": "4.1.0"
   },
   "devDependencies": {
     "@babel/types": "7.12.11",