@modern-js/plugin-proxy 1.1.1 → 1.2.2

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @modern-js/plugin-proxy
 
+## 1.2.2
+
+### Patch Changes
+
+- 83166714: change .npmignore
+- Updated dependencies [83166714]
+- Updated dependencies [c3de9882]
+- Updated dependencies [33ff48af]
+  - @modern-js/core@1.3.2
+  - @modern-js/utils@1.2.2
+
+## 1.2.1
+
+### Patch Changes
+
+- e2d3a575: fix extending core config interface
+- e2d3a575: fix extending core config interface
+- Updated dependencies [823809c6]
+- Updated dependencies [4584cc04]
+- Updated dependencies [7c19fd94]
+  - @modern-js/utils@1.2.1
+  - @modern-js/core@1.3.1
+
+## 1.2.0
+
+### Minor Changes
+
+- cfe11628: Make Modern.js self bootstraping
+
+### Patch Changes
+
+- f6932de7: fix proxy bin error
+- bc87647d: fix: terminate whistle proxy when exiting the process
+- Updated dependencies [2da09c69]
+- Updated dependencies [fc71e36f]
+- Updated dependencies [c3d46ee4]
+- Updated dependencies [cfe11628]
+  - @modern-js/utils@1.2.0
+  - @modern-js/core@1.3.0
+
 ## 1.1.1
 
 ### Patch Changes

package/dist/js/modern/index.js

@@ -2,6 +2,7 @@ import { createPlugin, useAppContext, useResolvedConfigContext } from '@modern-j
 import { PLUGIN_SCHEMAS } from '@modern-js/utils';
 import { createProxyRule } from "./utils/createProxyRule";
 import WhistleProxy from "./utils/whistleProxy";
+let proxyServer;
 export default createPlugin(() => ({
   validateSchema() {
     return PLUGIN_SCHEMAS['@modern-js/plugin-proxy'];
@@ -17,20 +18,23 @@ export default createPlugin(() => ({
     } = useAppContext();
     /* eslint-enable react-hooks/rules-of-hooks */
 
-    if (!dev.proxy) {
+    if (!(dev !== null && dev !== void 0 && dev.proxy)) {
       return;
     }
 
     const rule = createProxyRule(internalDirectory, dev.proxy);
-    const proxyServer = new WhistleProxy({
+    proxyServer = new WhistleProxy({
       port: 8899,
       rule
     });
-    await proxyServer.start(); // TODO
-    // should exit proxy server before process exit
-    // api.on('process-exit', () => {
-    //   proxyServer.close();
-    // });
+    await proxyServer.start();
+  },
+
+  beforeExit() {
+    var _proxyServer;
+
+    // terminate whistle proxy
+    (_proxyServer = proxyServer) === null || _proxyServer === void 0 ? void 0 : _proxyServer.close();
   }
 
 }), {

package/dist/js/modern/utils/macCAManager.js

@@ -35,7 +35,7 @@ export const generateRootCA = () => new Promise((resolve, reject) => {
 
   fs.ensureDirSync(defaultCertDir);
   const stream = fs.createWriteStream(defaultRootCA);
-  http.get('http://127.0.0.1:8899/cgi-bin/rootca', response => {
+  http.get('http://localhost:8899/cgi-bin/rootca', response => {
     response.pipe(stream);
     stream.on('finish', () => {
       resolve(defaultRootCA);

package/dist/js/modern/utils/macProxyManager.js

@@ -16,7 +16,7 @@ const getNetworkType = () => {
 };
 
 export const enableGlobalProxy = (ip, port) => {
-  const networkType = getNetworkType(); // && networksetup -setproxybypassdomains ${networkType} 127.0.0.1 localhost
+  const networkType = getNetworkType(); // && networksetup -setproxybypassdomains ${networkType} localhost localhost
 
   execSync(`networksetup -setwebproxy ${networkType} ${ip} ${port}`);
   execSync(`networksetup -setsecurewebproxy ${networkType} ${ip} ${port}`);

package/dist/js/modern/utils/whistleProxy.js

@@ -39,14 +39,14 @@ export default class WhistleProxy {
     execSync(`${this.bin} start --certDir=${this.certDir} --port=${this.port}`);
     execSync(`${this.bin} use ${this.rule} --force`);
     await this.installRootCA();
-    enableGlobalProxy('127.0.0.1', this.port);
+    enableGlobalProxy('localhost', this.port);
     logger.info(`Proxy Server start on localhost:${this.port}\n`);
   }
 
   close() {
     execSync(`${this.bin} stop`);
     disableGlobalProxy();
-    logger.info(`Proxy Server has closed`);
+    logger.info(`Proxy Server has been closed`);
   }
 
 }

package/dist/js/node/index.js

@@ -15,6 +15,8 @@ var _whistleProxy = _interopRequireDefault(require("./utils/whistleProxy"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+let proxyServer;
+
 var _default = (0, _core.createPlugin)(() => ({
   validateSchema() {
     return _utils.PLUGIN_SCHEMAS['@modern-js/plugin-proxy'];
@@ -30,20 +32,23 @@ var _default = (0, _core.createPlugin)(() => ({
     } = (0, _core.useAppContext)();
     /* eslint-enable react-hooks/rules-of-hooks */
 
-    if (!dev.proxy) {
+    if (!(dev !== null && dev !== void 0 && dev.proxy)) {
       return;
     }
 
     const rule = (0, _createProxyRule.createProxyRule)(internalDirectory, dev.proxy);
-    const proxyServer = new _whistleProxy.default({
+    proxyServer = new _whistleProxy.default({
       port: 8899,
       rule
     });
-    await proxyServer.start(); // TODO
-    // should exit proxy server before process exit
-    // api.on('process-exit', () => {
-    //   proxyServer.close();
-    // });
+    await proxyServer.start();
+  },
+
+  beforeExit() {
+    var _proxyServer;
+
+    // terminate whistle proxy
+    (_proxyServer = proxyServer) === null || _proxyServer === void 0 ? void 0 : _proxyServer.close();
   }
 
 }), {

package/dist/js/node/utils/macCAManager.js

@@ -62,7 +62,7 @@ const generateRootCA = () => new Promise((resolve, reject) => {
 
   const stream = _utils.fs.createWriteStream(defaultRootCA);
 
-  _http.default.get('http://127.0.0.1:8899/cgi-bin/rootca', response => {
+  _http.default.get('http://localhost:8899/cgi-bin/rootca', response => {
     response.pipe(stream);
     stream.on('finish', () => {
       resolve(defaultRootCA);

package/dist/js/node/utils/macProxyManager.js

@@ -26,7 +26,7 @@ const getNetworkType = () => {
 };
 
 const enableGlobalProxy = (ip, port) => {
-  const networkType = getNetworkType(); // && networksetup -setproxybypassdomains ${networkType} 127.0.0.1 localhost
+  const networkType = getNetworkType(); // && networksetup -setproxybypassdomains ${networkType} localhost localhost
 
   (0, _execSync.default)(`networksetup -setwebproxy ${networkType} ${ip} ${port}`);
   (0, _execSync.default)(`networksetup -setsecurewebproxy ${networkType} ${ip} ${port}`);

package/dist/js/node/utils/whistleProxy.js

@@ -52,7 +52,7 @@ class WhistleProxy {
     (0, _execSync.default)(`${this.bin} start --certDir=${this.certDir} --port=${this.port}`);
     (0, _execSync.default)(`${this.bin} use ${this.rule} --force`);
     await this.installRootCA();
-    enableGlobalProxy('127.0.0.1', this.port);
+    enableGlobalProxy('localhost', this.port);
 
     _utils.logger.info(`Proxy Server start on localhost:${this.port}\n`);
   }
@@ -61,7 +61,7 @@ class WhistleProxy {
     (0, _execSync.default)(`${this.bin} stop`);
     disableGlobalProxy();
 
-    _utils.logger.info(`Proxy Server has closed`);
+    _utils.logger.info(`Proxy Server has been closed`);
   }
 
 }

package/dist/types/index.d.ts

@@ -4,8 +4,6 @@ export default _default;
 export declare type ProxyOptions = string | Record<string, string>;
 declare module '@modern-js/core' {
   interface DevConfig {
-    dev: {
-      proxy?: ProxyOptions;
-    };
+    proxy?: ProxyOptions;
   }
 }

package/jest.config.js

@@ -0,0 +1,8 @@
+const sharedConfig = require('@scripts/jest-config');
+
+/** @type {import('@jest/types').Config.InitialOptions} */
+module.exports = {
+  // eslint-disable-next-line node/no-unsupported-features/es-syntax
+  ...sharedConfig,
+  rootDir: __dirname,
+};

package/modern.config.js

@@ -1,10 +1,2 @@
 /** @type {import('@modern-js/module-tools').UserConfig} */
-module.exports = {
-  testing: {
-    jest: {
-      collectCoverage: true,
-      collectCoverageFrom: ['src/**/*.ts'],
-      coveragePathIgnorePatterns: ['/node_modules/'],
-    },
-  },
-};
+module.exports = {};

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.1.1",
+  "version": "1.2.2",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/js/node/index.js",
@@ -20,31 +20,33 @@
   "exports": {
     ".": {
       "node": {
+        "jsnext:source": "./src/index.ts",
         "import": "./dist/js/modern/index.js",
         "require": "./dist/js/node/index.js"
       },
       "default": "./dist/js/treeshaking/index.js"
     },
-    "./cli": "./dist/js/node/index.js"
-  },
-  "bin": {
-    "modern": "./bin/modern.js"
+    "./cli": {
+      "jsnext:source": "./src/index.ts",
+      "default": "./dist/js/node/index.js"
+    }
   },
   "dependencies": {
     "@babel/runtime": "^7",
-    "@modern-js/utils": "^1.1.2",
+    "@modern-js/utils": "^1.2.2",
     "whistle": "^2.7.18"
   },
   "devDependencies": {
     "@types/jest": "^26",
     "@types/node": "^14",
     "typescript": "^4",
-    "@modern-js/core": "^1.1.2",
-    "@modern-js/plugin-testing": "^1.1.0",
-    "@modern-js/module-tools": "^1.1.0"
+    "@modern-js/core": "^1.3.2",
+    "@scripts/build": "0.0.0",
+    "jest": "^27",
+    "@scripts/jest-config": "0.0.0"
   },
   "peerDependencies": {
-    "@modern-js/core": "^1.1.2"
+    "@modern-js/core": "^1.3.2"
   },
   "sideEffects": false,
   "modernConfig": {
@@ -54,11 +56,13 @@
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public"
+    "access": "public",
+    "types": "./dist/types/index.d.ts"
   },
   "scripts": {
     "new": "modern new",
     "build": "modern build",
-    "test": "modern test --passWithNoTests"
-  }
+    "test": "jest --passWithNoTests"
+  },
+  "readme": "\n<p align=\"center\">\n  <a href=\"https://modernjs.dev\" target=\"blank\"><img src=\"https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png\" width=\"300\" alt=\"Modern.js Logo\" /></a>\n</p>\n<p align=\"center\">\n现代 Web 工程体系\n  <br/>\n  <a href=\"https://modernjs.dev\" target=\"blank\">\n    modernjs.dev\n  </a>\n</p>\n<p align=\"center\">\n  The meta-framework suite designed from scratch for frontend-focused modern web development\n</p>\n\n# Introduction\n\n> The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.\n\n- [Modern.js: Hello, World!](https://zhuanlan.zhihu.com/p/426707646)\n\n## Getting Started\n\n- [Quick Start](https://modernjs.dev/docs/start)\n- [Guides](https://modernjs.dev/docs/guides)\n- [API References](https://modernjs.dev/docs/apis)\n\n## Contributing\n\n- [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md)\n"
 }

package/tests/.eslintrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  extends: ['@modern-js'],
+  parserOptions: {
+    project: require.resolve('./tsconfig.json'),
+  },
+};

package/tests/__snapshots__/cli.test.ts.snap

@@ -0,0 +1,19 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`plugin proxy test config 1`] = `Array []`;
+
+exports[`plugin proxy test schema 1`] = `
+Array [
+  Array [
+    Object {
+      "schema": Object {
+        "typeof": Array [
+          "string",
+          "object",
+        ],
+      },
+      "target": "dev.proxy",
+    },
+  ],
+]
+`;

package/tests/cli.test.ts

@@ -0,0 +1,39 @@
+import path from 'path';
+import { manager } from '@modern-js/core';
+import plugin from '../src';
+
+const root = path.normalize(path.resolve(__dirname, '../../../../'));
+expect.addSnapshotSerializer({
+  test: val =>
+    typeof val === 'string' &&
+    (val.includes('modern.js') ||
+      val.includes('node_modules') ||
+      val.includes(root)),
+  print: val =>
+    // eslint-disable-next-line no-nested-ternary
+    typeof val === 'string'
+      ? // eslint-disable-next-line no-nested-ternary
+        val.includes('node_modules')
+        ? `"${val.replace(/.+node_modules/, '')}"`
+        : val.includes('modern.js')
+        ? `"${val.replace(/.+modern\.js/, '')}"`
+        : `"${val.replace(root, '')}"`
+      : (val as string),
+});
+
+describe('plugin proxy test', () => {
+  it('schema', async () => {
+    const main = manager.clone().usePlugin(plugin);
+    const runner = await main.init();
+    const result = await runner.validateSchema();
+
+    expect(result).toMatchSnapshot();
+  });
+
+  it('config', async () => {
+    const main = manager.clone().usePlugin(plugin);
+    const runner = await main.init();
+    const result = await runner.config();
+    expect(result).toMatchSnapshot();
+  });
+});

package/tests/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "@modern-js/tsconfig/base",
+  "compilerOptions": {
+    "declaration": true,
+    "jsx": "preserve",
+    "baseUrl": ".",
+    "noEmit": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "isolatedModules": true,
+    "paths": {},
+    "types": ["node", "jest"]
+  }
+}

package/tsconfig.json

@@ -5,9 +5,7 @@
     "jsx": "preserve",
     "baseUrl": "./",
     "isolatedModules": true,
-    "paths": {
-      "@/*": ["./src/*"]
-    }
+    "paths": {}
   },
   "include": ["src"]
 }

package/src/index.ts

@@ -1,47 +0,0 @@
-import {
-  createPlugin,
-  useAppContext,
-  useResolvedConfigContext,
-} from '@modern-js/core';
-import { PLUGIN_SCHEMAS } from '@modern-js/utils';
-import { createProxyRule } from './utils/createProxyRule';
-import WhistleProxy from './utils/whistleProxy';
-
-export default createPlugin(
-  () => ({
-    validateSchema() {
-      return PLUGIN_SCHEMAS['@modern-js/plugin-proxy'];
-    },
-    async afterDev() {
-      /* eslint-disable react-hooks/rules-of-hooks */
-      const { dev } = useResolvedConfigContext();
-      const { internalDirectory } = useAppContext();
-      /* eslint-enable react-hooks/rules-of-hooks */
-
-      if (!(dev as any).proxy) {
-        return;
-      }
-
-      const rule = createProxyRule(internalDirectory, (dev as any).proxy);
-      const proxyServer = new WhistleProxy({ port: 8899, rule });
-      await proxyServer.start();
-
-      // TODO
-      // should exit proxy server before process exit
-      // api.on('process-exit', () => {
-      //   proxyServer.close();
-      // });
-    },
-  }),
-  { name: '@modern-js/plugin-proxy' },
-) as any;
-
-export type ProxyOptions = string | Record<string, string>;
-
-declare module '@modern-js/core' {
-  export interface DevConfig {
-    dev: {
-      proxy?: ProxyOptions;
-    };
-  }
-}

package/src/utils/createProxyRule.ts

@@ -1,50 +0,0 @@
-import path from 'path';
-import { logger, fs } from '@modern-js/utils';
-import type { ProxyOptions } from '..';
-
-interface ProxyRule {
-  pattern: string;
-  target: string;
-}
-
-const createWhistleProxyRule = (ruleDirectory: string, rules: ProxyRule[]) => {
-  const dest = path.resolve(ruleDirectory, 'proxy.rule.js');
-
-  let code = `/.*/ enable://intercept\n`;
-
-  for (const rule of rules) {
-    const { pattern, target } = rule;
-    code += `${pattern} ${target}\n`;
-  }
-
-  fs.outputFileSync(
-    dest,
-    `exports.name = 'modernjs proxy rule';\nexports.rules = \`${code}\`;`,
-  );
-  return dest;
-};
-
-export const createProxyRule = (
-  appDirectory: string,
-  proxyOptions: ProxyOptions,
-) => {
-  const rules = [];
-
-  if (proxyOptions && typeof proxyOptions === 'string') {
-    return proxyOptions;
-  }
-
-  if (typeof proxyOptions === 'object') {
-    for (const pattern of Object.keys(proxyOptions)) {
-      const target = proxyOptions[pattern];
-      if (!target || typeof target !== 'string') {
-        logger.error(`dev.proxy.${pattern} value should be string type`);
-        // eslint-disable-next-line no-process-exit
-        process.exit(1);
-      }
-      rules.push({ pattern, target });
-    }
-  }
-
-  return createWhistleProxyRule(appDirectory, rules);
-};

package/src/utils/execSync.ts

@@ -1,21 +0,0 @@
-import { execSync as nodeExecSync } from 'child_process';
-
-function execSync(cmd: string) {
-  let stdout;
-  let status = 0;
-  try {
-    stdout = nodeExecSync(cmd);
-  } catch (err: any) {
-    /* eslint-disable prefer-destructuring */
-    stdout = err.stdout;
-    status = err.status;
-    /* eslint-enable prefer-destructuring */
-  }
-
-  return {
-    stdout: stdout.toString(),
-    status,
-  };
-}
-
-export default execSync;

package/src/utils/macCAManager.ts

@@ -1,58 +0,0 @@
-import os from 'os';
-import http from 'http';
-import path from 'path';
-import { fs, logger } from '@modern-js/utils';
-import execSync from './execSync';
-
-const defaultCertDir = path.resolve(os.homedir(), './.whistle-proxy');
-export const defaultRootCA = path.resolve(defaultCertDir, './rootCA.crt');
-
-export const trustRootCA = () => {
-  logger.info(`please type the password to trust the https certificate`);
-  const { status } = execSync(
-    `sudo security add-trusted-cert -d -k /Library/Keychains/System.keychain ${defaultRootCA}`,
-  );
-  if (status === 0) {
-    logger.info('Root CA install, you are ready to intercept the https now');
-  } else {
-    logger.info('Failed to trust the root CA, please trust it manually');
-  }
-};
-
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-const isRootCATrusted = () => {
-  // current empty
-};
-
-export const isRootCAExists = () => {
-  if (fs.existsSync(defaultRootCA)) {
-    return true;
-  }
-  return false;
-};
-
-export const generateRootCA = () =>
-  new Promise((resolve, reject) => {
-    if (fs.existsSync(defaultRootCA)) {
-      fs.removeSync(defaultRootCA);
-    }
-
-    fs.ensureDirSync(defaultCertDir);
-    const stream = fs.createWriteStream(defaultRootCA);
-
-    http
-      .get('http://127.0.0.1:8899/cgi-bin/rootca', response => {
-        response.pipe(stream);
-        stream
-          .on('finish', () => {
-            resolve(defaultRootCA);
-          })
-          .on('error', err => {
-            reject(err);
-          });
-      })
-      .on('error', err => {
-        fs.unlink(defaultRootCA); // Delete the file
-        reject(err);
-      });
-  });

package/src/utils/macProxyManager.ts

@@ -1,31 +0,0 @@
-import execSync from './execSync';
-
-const networkTypes = ['Ethernet', 'Thunderbolt Ethernet', 'Wi-Fi'];
-
-const getNetworkType = () => {
-  // eslint-disable-next-line @typescript-eslint/prefer-for-of
-  for (let i = 0; i < networkTypes.length; i++) {
-    const type = networkTypes[i];
-    const result = execSync(`networksetup -getwebproxy ${type}`);
-
-    if (result.status === 0) {
-      return type;
-    }
-  }
-
-  throw new Error('Unknown network type');
-};
-
-export const enableGlobalProxy = (ip: string, port: string) => {
-  const networkType = getNetworkType();
-
-  // && networksetup -setproxybypassdomains ${networkType} 127.0.0.1 localhost
-  execSync(`networksetup -setwebproxy ${networkType} ${ip} ${port}`);
-  execSync(`networksetup -setsecurewebproxy ${networkType} ${ip} ${port}`);
-};
-
-export const disableGlobalProxy = () => {
-  const networkType = getNetworkType();
-  execSync(`networksetup -setwebproxystate ${networkType} off`);
-  execSync(`networksetup -setsecurewebproxystate ${networkType} off`);
-};

package/src/utils/whistleProxy.ts

@@ -1,67 +0,0 @@
-import path from 'path';
-import { logger } from '@modern-js/utils';
-import execSync from './execSync';
-import {
-  isRootCAExists,
-  generateRootCA,
-  defaultRootCA,
-  trustRootCA,
-} from './macCAManager';
-
-const { disableGlobalProxy, enableGlobalProxy } = require('./macProxyManager');
-
-interface ProxyConfig {
-  rule: string;
-  port: number;
-  // mode: 'pureProxy'|'debug'|'multiEnv'
-}
-
-export default class WhistleProxy {
-  private readonly rule: string;
-
-  private readonly port: number;
-
-  private readonly bin: string;
-
-  private readonly certDir: string;
-
-  constructor(config: ProxyConfig) {
-    this.rule = config.rule;
-    this.port = config.port;
-    // unused
-    // this.mode = config.mode; // pureProxy|debug|multiEnv
-    this.bin = path.resolve(
-      path.dirname(require.resolve('whistle')),
-      'bin/whistle.js',
-    );
-    this.certDir = path.dirname(defaultRootCA);
-  }
-
-  async installRootCA() {
-    try {
-      if (!isRootCAExists()) {
-        await generateRootCA();
-        trustRootCA();
-      }
-    } catch (err) {
-      this.close();
-      throw err;
-    }
-  }
-
-  async start() {
-    logger.info(`Starting the proxy server.....`);
-    execSync(`${this.bin} start --certDir=${this.certDir} --port=${this.port}`);
-    execSync(`${this.bin} use ${this.rule} --force`);
-    await this.installRootCA();
-
-    enableGlobalProxy('127.0.0.1', this.port);
-    logger.info(`Proxy Server start on localhost:${this.port}\n`);
-  }
-
-  close() {
-    execSync(`${this.bin} stop`);
-    disableGlobalProxy();
-    logger.info(`Proxy Server has closed`);
-  }
-}