xhs-mp-compiler-cli 1.2.0 → 1.3.0

package/dist/compiler.js

@@ -107,6 +107,10 @@ class AbstractCompiler extends stream_1.EventEmitter {
                 }
                 return;
             }
+            if (method === 'debugger') {
+                console.log(`[debugger]:`, ...(data.data || []));
+                return;
+            }
             this.emit(method, data);
         };
         this.call = (method, data) => new Promise((resolve, reject) => {

package/dist/index.d.ts

@@ -36,6 +36,7 @@ type ICompilePkgsConfig = ICompileBaseConfig & {
 };
 type ICompileBuildConfig = ICompileBaseConfig & {
     entryType: string;
+    mpUploadOptions?: ICompileAndZipOptions | false;
 };
 export interface ICompileAndZipOptions {
     entryType: string;

package/dist/index.js

@@ -228,7 +228,7 @@ class Compiler extends events_1.default {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
             try {
-                const { entryType, compressJs, enableSourcemap, enableV2, enableV1, enableVDom } = config;
+                const { entryType, compressJs, enableSourcemap, enableV2, enableV1, enableVDom, mpUploadOptions } = config;
                 this.emit('compile-project-start');
                 (_a = this.logger) === null || _a === void 0 ? void 0 : _a.log('Compile project...');
                 const compilerImpl = this.getComilerImpl(entryType);
@@ -237,7 +237,8 @@ class Compiler extends events_1.default {
                     enableSourcemap,
                     enableV2,
                     enableV1,
-                    enableVDom
+                    enableVDom,
+                    mpUploadOptions,
                 });
                 this.emit('compile-project-done');
                 (_b = this.logger) === null || _b === void 0 ? void 0 : _b.log('Compile project done');
@@ -283,7 +284,8 @@ class Compiler extends events_1.default {
                     enableSourcemap,
                     enableV2,
                     enableV1,
-                    enableVDom
+                    enableVDom,
+                    mpUploadOptions: this.project.appMode === constant_config_1.MiniMode.miniprogram && opts
                 };
                 // 编译
                 this.emit('compile-and-zip-status', { status: 'build-start' });

package/dist/packs/index.d.ts

@@ -2,12 +2,14 @@ import { Compilation, RawSource, CopyPatterns, Config, ConcatSource, MPPackSetti
 import { Configuration, WebpackError, library, LoaderContext } from 'webpack';
 import type { Project } from 'xhs-mp-project';
 import { IStart } from '../types';
+import { FeatureReporter } from 'xhs-mp-utils';
 export type ICompilation = any;
 export type ICompiler = any;
 export type ILoaderContext = LoaderContext<any> & {
     _compiler: {
         project: Project;
         packSetting: MPPackSetting;
+        reporter: FeatureReporter.IReporter;
     };
 };
 export { Compilation, RawSource, ConcatSource, CopyPatterns, Config, Configuration, WebpackError, library, LoaderContext };

package/dist/packs/mp-pack/index.js

@@ -7,12 +7,15 @@ exports.createCompiler = void 0;
 const presets_1 = require("../../presets");
 const path_1 = __importDefault(require("path"));
 const xhs_mp_pack_1 = require("xhs-mp-pack");
+const apm_1 = require("../../utils/apm");
 const createCompiler = (startConfig) => {
     const { action, enableDevServer } = startConfig;
     const mppack = new xhs_mp_pack_1.MPPack(startConfig);
     const compilerOptions = {
         project: mppack.project,
-        packSetting: mppack.packSetting
+        packSetting: mppack.packSetting,
+        // 注入apm模块
+        reporter: (0, apm_1.createReporter)(mppack.project, startConfig.mpUploadOptions)
     };
     const mpPackConfigs = (0, presets_1.createConfigs)(compilerOptions);
     mpPackConfigs.forEach(config => {

package/dist/packs/webpack/index.js

@@ -14,6 +14,7 @@ const presets_1 = require("../../presets");
 const xhs_mp_project_1 = require("xhs-mp-project");
 const xhs_mp_pack_1 = require("xhs-mp-pack");
 const webpack_1 = require("./webpack");
+const apm_1 = require("../../utils/apm");
 // 防御编程
 const handleVersion = (startConfig) => {
     let { action, enableV1 = true, enableV2 = false, enableVDom = false } = startConfig;
@@ -32,7 +33,7 @@ const handleVersion = (startConfig) => {
     };
 };
 const formatCompilerConfig = startConfig => {
-    const { projectPath, action, tsConfigPath, platform, extJsonPath, compressJs = false, enableSourcemap = false } = startConfig;
+    const { projectPath, action, tsConfigPath, platform, extJsonPath, compressJs = false, enableSourcemap = false, mpUploadOptions = false } = startConfig;
     const { enableV1, enableV2, enableVDom } = handleVersion(startConfig);
     const distDir = startConfig.distDir || path_1.default.join(process.cwd(), 'dist');
     process.env.__platform = platform;
@@ -61,7 +62,8 @@ const formatCompilerConfig = startConfig => {
         enableSourcemap,
         enableV1,
         enableV2,
-        enableVDom
+        enableVDom,
+        mpUploadOptions,
     };
     return config;
 };
@@ -74,7 +76,9 @@ const createCompiler = (startConfig) => {
     const mppackSetting = new xhs_mp_pack_1.MPPackSetting(project, startConfig);
     const compilerOptions = {
         project: project,
-        packSetting: mppackSetting
+        packSetting: mppackSetting,
+        // 注入apm模块
+        reporter: (0, apm_1.createReporter)(project, startConfig.mpUploadOptions)
     };
     const webpackConfig = (0, presets_1.createConfigs)(compilerOptions);
     webpackConfig.forEach(config => {

package/dist/presets/plugins/InjectorPlugin.js

@@ -6,9 +6,10 @@ class InjectorPlugin {
         this.options = options;
     }
     apply(compiler) {
-        const { project, packSetting } = this.options;
+        const { project, packSetting, reporter } = this.options;
         compiler.project = project;
         compiler.packSetting = packSetting;
+        compiler.reporter = reporter;
     }
 }
 exports.InjectorPlugin = InjectorPlugin;

package/dist/types/index.d.ts

@@ -1,5 +1,6 @@
 import type { MPPackSetting } from "xhs-mp-pack";
 import type { Project } from "xhs-mp-project";
+import { FeatureReporter } from 'xhs-mp-utils';
 export declare enum ENV {
     development = 0,
     production = 1
@@ -84,8 +85,9 @@ export interface ICompilerConfig {
     enableV1?: boolean;
     enableV2?: boolean;
     enableVDom?: boolean;
+    mpUploadOptions?: any;
 }
-type CliPick = 'projectPath' | 'distDir' | 'watch' | 'tsConfigPath' | 'extJsonPath' | 'cacheDirectory' | 'compressJs' | 'enableSourcemap' | 'enableV1' | 'enableV2' | 'enableVDom';
+type CliPick = 'projectPath' | 'distDir' | 'watch' | 'tsConfigPath' | 'extJsonPath' | 'cacheDirectory' | 'compressJs' | 'enableSourcemap' | 'enableV1' | 'enableV2' | 'enableVDom' | 'mpUploadOptions';
 export interface IStart extends Pick<ICompilerConfig, CliPick> {
     packMode?: 'webpack' | 'mp-pack';
     /**
@@ -114,5 +116,6 @@ export type IPresetOptions = {
     project: Project;
     packSetting: MPPackSetting;
     otherSetting?: any;
+    reporter?: FeatureReporter.IReporter;
 };
 export {};

package/dist/utils/apm/index.d.ts

@@ -0,0 +1,18 @@
+import { APM, FeatureReporter } from 'xhs-mp-utils';
+import { Project } from 'xhs-mp-project';
+import type { ICompileAndZipOptions } from '../..';
+/**
+ * 上报过程中，除去 WebComponent 因为标签种类有很多需要上报多次之外，其余的项目维度上均只上报一次
+ */
+declare class Reporter implements FeatureReporter.IReporter {
+    private apm;
+    constructor(apm: APM);
+    reportThirdFramework(name: FeatureReporter.ThirdFramework): void;
+    reportMlFeature(feature: FeatureReporter.ML): void;
+    reportMlWebComponent(value: string): void;
+    reportJSONComponent(name: FeatureReporter.JSONComponent): void;
+    reportStyleIsolation(value: string): void;
+    reportJSONApp(name: FeatureReporter.JSONApp): void;
+}
+export declare function createReporter(project: Project, option: ICompileAndZipOptions): Reporter | undefined;
+export {};

package/dist/utils/apm/index.js

@@ -0,0 +1,181 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createReporter = void 0;
+const xhs_mp_utils_1 = require("xhs-mp-utils");
+const pkg = require('../../../package.json');
+function debug(...data) {
+    return;
+    // return process.send?.(JSON.stringify({ method: 'debugger', data }))
+}
+const cacheMap = {};
+function once(target, key, descriptor) {
+    const originalMethod = descriptor.value;
+    descriptor.value = function (...args) {
+        try {
+            const argsStr = JSON.stringify(args);
+            if (cacheMap[key + argsStr])
+                return;
+            cacheMap[key + argsStr] = true;
+            debug(key, ...args);
+            return originalMethod.apply(this, args);
+        }
+        catch (error) {
+            console.error(`call ${key} error`, error.message);
+        }
+    };
+    return descriptor;
+}
+// const APMKEY = 'test_cli_apm'
+const APMKEY = 'xhsmp_compiler_basic_ability';
+/**
+ * 上报过程中，除去 WebComponent 因为标签种类有很多需要上报多次之外，其余的项目维度上均只上报一次
+ */
+class Reporter {
+    constructor(apm) {
+        this.apm = apm;
+    }
+    reportThirdFramework(name) {
+        var _a, _b;
+        (_b = (_a = this.apm) === null || _a === void 0 ? void 0 : _a.report) === null || _b === void 0 ? void 0 : _b.call(_a, APMKEY, {
+            type: xhs_mp_utils_1.FeatureReporter.MODULE.thirdFramework,
+            name,
+        });
+    }
+    reportMlFeature(feature) {
+        var _a, _b;
+        (_b = (_a = this.apm) === null || _a === void 0 ? void 0 : _a.report) === null || _b === void 0 ? void 0 : _b.call(_a, APMKEY, {
+            type: xhs_mp_utils_1.FeatureReporter.MODULE.ml,
+            name: feature
+        });
+    }
+    reportMlWebComponent(value) {
+        var _a, _b;
+        (_b = (_a = this.apm) === null || _a === void 0 ? void 0 : _a.report) === null || _b === void 0 ? void 0 : _b.call(_a, APMKEY, {
+            type: xhs_mp_utils_1.FeatureReporter.MODULE.ml,
+            name: xhs_mp_utils_1.FeatureReporter.ML.WebComponent,
+            value,
+        });
+    }
+    // 在reporter 创建阶段即可根据传入project信息进行上报
+    reportJSONComponent(name) {
+        var _a, _b;
+        (_b = (_a = this.apm) === null || _a === void 0 ? void 0 : _a.report) === null || _b === void 0 ? void 0 : _b.call(_a, APMKEY, {
+            type: xhs_mp_utils_1.FeatureReporter.MODULE.componentJSON,
+            name,
+        });
+    }
+    reportStyleIsolation(value) {
+        var _a, _b;
+        (_b = (_a = this.apm) === null || _a === void 0 ? void 0 : _a.report) === null || _b === void 0 ? void 0 : _b.call(_a, APMKEY, {
+            type: xhs_mp_utils_1.FeatureReporter.MODULE.componentJSON,
+            name: xhs_mp_utils_1.FeatureReporter.JSONComponent.styleIsolation,
+            value,
+        });
+    }
+    reportJSONApp(name) {
+        var _a, _b;
+        (_b = (_a = this.apm) === null || _a === void 0 ? void 0 : _a.report) === null || _b === void 0 ? void 0 : _b.call(_a, APMKEY, {
+            type: xhs_mp_utils_1.FeatureReporter.MODULE.appJSON,
+            name,
+        });
+    }
+}
+__decorate([
+    once
+], Reporter.prototype, "reportThirdFramework", null);
+__decorate([
+    once
+], Reporter.prototype, "reportMlFeature", null);
+__decorate([
+    once
+], Reporter.prototype, "reportMlWebComponent", null);
+__decorate([
+    once
+], Reporter.prototype, "reportJSONComponent", null);
+__decorate([
+    once
+], Reporter.prototype, "reportStyleIsolation", null);
+__decorate([
+    once
+], Reporter.prototype, "reportJSONApp", null);
+function isObject(t) {
+    return t != null && typeof t === 'object';
+}
+function isEmpty(t) {
+    if (Array.isArray(t)) {
+        return t.length === 0;
+    }
+    if (isObject(t)) {
+        return Object.keys(t).length === 0;
+    }
+    return true;
+}
+function createReporter(project, option) {
+    var _a, _b, _c;
+    try {
+        const app_id = option === null || option === void 0 ? void 0 : option.upload_app_id;
+        if (!app_id) {
+            return;
+        }
+        const apm = new xhs_mp_utils_1.APM(`mp-compiler-${pkg.version}`);
+        (_a = apm === null || apm === void 0 ? void 0 : apm.setContext) === null || _a === void 0 ? void 0 : _a.call(apm, app_id, {
+            app_id,
+            app_name: app_id,
+            third_name: app_id,
+            page_key: '0',
+            app_env: 0,
+            app_type: 0,
+            bundle_version: ((_b = option === null || option === void 0 ? void 0 : option.pkgInfo) === null || _b === void 0 ? void 0 : _b.version) || '',
+            base_version: ((_c = project.projectJsonContent) === null || _c === void 0 ? void 0 : _c.libVersion) || ''
+        });
+        const reporter = new Reporter(apm);
+        function reportJSON() {
+            var _a, _b, _c, _d;
+            // 分包
+            if ((_a = project.getSubPackages()) === null || _a === void 0 ? void 0 : _a.length) {
+                reporter.reportJSONApp(xhs_mp_utils_1.FeatureReporter.JSONApp.subPackages);
+            }
+            // tabbar
+            if (!isEmpty((_b = project.appJSON) === null || _b === void 0 ? void 0 : _b.tabBar)) {
+                reporter.reportJSONApp(xhs_mp_utils_1.FeatureReporter.JSONApp.tabBar);
+            }
+            // 按需注入
+            if ((_c = project.appJSON) === null || _c === void 0 ? void 0 : _c.lazyCodeLoading) {
+                reporter.reportJSONApp(xhs_mp_utils_1.FeatureReporter.JSONApp.lazyCodeLoading);
+            }
+            // 预载
+            if (!isEmpty((_d = project.appJSON) === null || _d === void 0 ? void 0 : _d.preloadRule)) {
+                reporter.reportJSONApp(xhs_mp_utils_1.FeatureReporter.JSONApp.preloadRule);
+            }
+            const componentsMap = project.getComponentsMap();
+            if (!isEmpty(componentsMap)) {
+                // debug(componentsMap)
+                for (let key in componentsMap) {
+                    const style = componentsMap[key].styleIsolation;
+                    // 样式隔离类型
+                    if (style) {
+                        reporter.reportStyleIsolation(style);
+                    }
+                    // 占位组件
+                    const componentPlaceholder = componentsMap[key].componentPlaceholder;
+                    if (!isEmpty(componentPlaceholder)) {
+                        reporter.reportJSONComponent(xhs_mp_utils_1.FeatureReporter.JSONComponent.componentPlaceholder);
+                    }
+                }
+            }
+        }
+        // 延时上报
+        setTimeout(reportJSON);
+        return reporter;
+    }
+    catch (error) {
+        debug('[create reporter error]');
+    }
+}
+exports.createReporter = createReporter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xhs-mp-compiler-cli",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "xhs mp command tool.",
   "preferGlobal": true,
   "category": "esm",
@@ -82,11 +82,11 @@
     "webpack-bundle-analyzer": "^4.4.0",
     "webpack-chain": "^6.5.1",
     "webpack-sources": "^3.2.2",
-    "xhs-mp-compiler-ml-loader": "1.2.0",
+    "xhs-mp-compiler-ml-loader": "1.3.0",
     "xhs-mp-compiler-utils": "1.2.0",
     "xhs-mp-pack": "^1.2.0",
     "xhs-mp-project": "^1.2.0",
-    "xhs-mp-utils": "^1.2.0"
+    "xhs-mp-utils": "^1.3.0"
   },
   "devDependencies": {
     "@types/babel__generator": "7.6.3",