@shuvi/service 1.0.4 → 1.0.6

package/lib/analysis/index.d.ts

@@ -0,0 +1,5 @@
+import { IPluginContext, Telemetry } from '../core';
+export declare const analysis: ({ context, telemetry }: {
+    context: IPluginContext;
+    telemetry: Telemetry;
+}) => Promise<void>;

package/lib/analysis/index.js

@@ -0,0 +1,78 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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.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 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* () {
+    if (!telemetry || !context) {
+        return;
+    }
+    logger_1.default.info('Start collecting data...');
+    const analysisBegin = process.hrtime();
+    const routesExtensions = ['ts', 'tsx', 'js', 'jsx'];
+    const routePaths = yield (0, recursiveReaddir_1.recursiveReadDir)(context.paths.routesDir, {
+        filter: new RegExp(`\\.(?:${routesExtensions.join('|')})$`)
+    });
+    const middlewareCount = routePaths.filter(path => /middleware\..*/i.test(path)).length;
+    const srcDirFiles = yield fs.promises.readdir(context.paths.srcDir, {
+        encoding: 'utf-8'
+    });
+    const hasStatic404 = srcDirFiles.some(value => /error/i.test(value));
+    const pageLoadersPath = path.join(context.paths.appDir, '/files/page-loaders.js');
+    const pageLoadersFile = yield fs.promises.readFile(pageLoadersPath, {
+        encoding: 'utf8'
+    });
+    const totalLoaderCount = pageLoadersFile
+        .toString()
+        .split('\n')
+        .filter(loader => loader.startsWith('import')).length;
+    const { useTypeScript } = (0, typescript_1.getJavaScriptInfo)();
+    const analysisEnd = process.hrtime(analysisBegin);
+    telemetry.record((0, events_1.eventBuildOptimize)(routePaths, {
+        durationInSeconds: analysisEnd[0],
+        hasStatic404,
+        middlewareCount,
+        totalLoaderCount,
+        useTypeScript
+    }));
+});
+exports.analysis = analysis;

package/lib/core/api.d.ts

@@ -1,3 +1,4 @@
+import { Telemetry as TelemetryImpl, RecordObject, TelemetryEvent } from '@shuvi/telemetry';
 import { FileOption } from '../project';
 import { Bundler } from '../bundler';
 import { ServerPluginInstance } from '../server';
@@ -12,12 +13,16 @@ 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>;
+}
 declare class Api {
     private _inited;
     private _cwd;
@@ -33,6 +38,8 @@ declare class Api {
     private _config;
     private _plugins;
     private _presets;
+    private _telemetryImpl?;
+    private _telemetry;
     private _platform?;
     private _normalizePlatformConfig?;
     private _serverConfigs;
@@ -41,12 +48,13 @@ declare class Api {
     private _pluginContext;
     /** will be included by @shuvi/swc-loader */
     private _runtimePluginDirs;
-    constructor({ cwd, mode, config, configFile, presets, plugins, phase, platform, normalizePlatformConfig }: IApiOPtions);
+    constructor({ cwd, mode, config, configFile, presets, plugins, phase, platform, normalizePlatformConfig, telemetry }: IApiOPtions);
     get cwd(): string;
     get mode(): IServiceMode;
     get pluginManager(): import("@shuvi/hook/lib/hookGroup").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

@@ -55,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 }) {
+    constructor({ cwd, mode, config, configFile, presets, plugins, phase, platform, normalizePlatformConfig, telemetry }) {
         this._inited = false;
         this._plugins = [];
         this._presets = [];
@@ -70,6 +70,7 @@ 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();
@@ -90,6 +91,22 @@ 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);
+                }
+            };
+        }
+        return this._telemetry;
+    }
     init() {
         return __awaiter(this, void 0, void 0, function* () {
             if (this._inited) {
@@ -373,7 +390,8 @@ function getApi(options = {}) {
             platform: options.platform,
             presets: options.presets,
             plugins: options.plugins,
-            normalizePlatformConfig: options.normalizePlatformConfig
+            normalizePlatformConfig: options.normalizePlatformConfig,
+            telemetry: options.telemetry
         });
         try {
             yield api.init();

package/lib/core/index.d.ts

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

package/lib/index.d.ts

@@ -2,5 +2,6 @@ export * from './namespace';
 export * from './constants';
 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, IPaths, ShuviConfig, IServicePhase, IServiceMode, IPluginConfig, IPresetConfig, PresetFunction, IPresetContent, NormalizedShuviConfig, IPluginContext, IPlatform, IPlatformContent, CorePluginConstructor, CorePluginInstance, getApi, createPlugin, createPluginBefore, createPluginAfter, ResolvedPlugin } from './core';
+export { Api, Telemetry, IPaths, ShuviConfig, IServicePhase, IServiceMode, IPluginConfig, IPresetConfig, PresetFunction, IPresetContent, NormalizedShuviConfig, IPluginContext, IPlatform, IPlatformContent, CorePluginConstructor, CorePluginInstance, getApi, createPlugin, createPluginBefore, createPluginAfter, ResolvedPlugin } from './core';

package/lib/index.js

@@ -14,11 +14,13 @@ 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 });
-exports.createPluginAfter = exports.createPluginBefore = exports.createPlugin = exports.getApi = exports.createServerPluginAfter = exports.createServerPluginBefore = exports.createServerPlugin = exports.createShuviServer = exports.ProjectBuilder = void 0;
+exports.createPluginAfter = exports.createPluginBefore = exports.createPlugin = exports.getApi = exports.createServerPluginAfter = exports.createServerPluginBefore = exports.createServerPlugin = exports.createShuviServer = exports.analysis = exports.ProjectBuilder = void 0;
 __exportStar(require("./namespace"), exports);
 __exportStar(require("./constants"), exports);
 var project_1 = require("./project");
 Object.defineProperty(exports, "ProjectBuilder", { enumerable: true, get: function () { return project_1.ProjectBuilder; } });
+var analysis_1 = require("./analysis");
+Object.defineProperty(exports, "analysis", { enumerable: true, get: function () { return analysis_1.analysis; } });
 var server_1 = require("./server");
 Object.defineProperty(exports, "createShuviServer", { enumerable: true, get: function () { return server_1.createShuviServer; } });
 Object.defineProperty(exports, "createServerPlugin", { enumerable: true, get: function () { return server_1.createServerPlugin; } });

package/package.json

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