@modern-js/runtime 1.3.5 → 1.4.2

package/dist/js/modern/ssr/index.node.js

@@ -0,0 +1,78 @@
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+/* eslint-disable @typescript-eslint/no-var-requires */
+
+/* eslint-disable @typescript-eslint/no-require-imports */
+import path from 'path';
+import { registerPrefetch } from '@modern-js/runtime-core';
+import { isBrowser } from "../common";
+import prefetch from "./prefetch";
+import { formatServer } from "./utils";
+const registeredApps = new WeakSet();
+
+const plugin = () => ({
+  name: '@modern-js/plugin-ssr',
+  setup: () => {
+    return {
+      server: async ({
+        App,
+        context
+      }) => {
+        if (!registeredApps.has(App)) {
+          registerPrefetch(App, _context => prefetch(App, _context));
+          registeredApps.add(App);
+        }
+
+        if (!isBrowser()) {
+          const html = await require("./serverRender").render(context, (context === null || context === void 0 ? void 0 : context.ssrContext.distDir) || path.join(process.cwd(), 'dist'), App);
+          return html;
+        }
+
+        return null;
+      },
+
+      init({
+        context
+      }, next) {
+        const {
+          request
+        } = context.ssrContext;
+        context.ssrContext.request = formatServer(request);
+        return next({
+          context
+        });
+      },
+
+      pickContext: ({
+        context,
+        pickedContext
+      }, next) => {
+        const {
+          request,
+          response
+        } = context === null || context === void 0 ? void 0 : context.ssrContext;
+        const {
+          initialData
+        } = context;
+        return next({
+          context,
+          pickedContext: _objectSpread(_objectSpread({}, pickedContext), {}, {
+            initialData,
+            request,
+            response
+          })
+        });
+      }
+    };
+  }
+});
+
+export default plugin;
+export * from "./react";
+/* eslint-enable @typescript-eslint/no-require-imports */
+
+/* eslint-enable @typescript-eslint/no-var-requires */

package/dist/js/modern/ssr/prefetch.js

@@ -0,0 +1,58 @@
+import path from 'path';
+import fs from 'fs';
+import { renderToStaticMarkup } from 'react-dom/server';
+import { run } from '@modern-js/utils/ssr';
+import { LOADABLE_STATS_FILE } from '@modern-js/utils/constants';
+import { ChunkExtractor } from '@loadable/server'; // todo: SSRContext
+
+import { jsx as _jsx } from "react/jsx-runtime";
+
+const prefetch = async (App, context) => run(context.ssrContext.request.headers, async () => {
+  var _context$store;
+
+  const {
+    ssrContext
+  } = context;
+  const loadablefile = path.resolve(ssrContext.distDir, LOADABLE_STATS_FILE);
+
+  if (fs.existsSync(loadablefile)) {
+    const extractor = new ChunkExtractor({
+      statsFile: path.resolve(ssrContext.distDir, LOADABLE_STATS_FILE),
+      entrypoints: [ssrContext.entryName].filter(Boolean)
+    });
+    renderToStaticMarkup(extractor.collectChunks( /*#__PURE__*/_jsx(App, {
+      context: context
+    })));
+  } else {
+    renderToStaticMarkup( /*#__PURE__*/_jsx(App, {
+      context: context
+    }));
+  }
+
+  if (!context.loaderManager.hasPendingLoaders()) {
+    return {
+      initialData: context.initialData,
+      i18nData: context.__i18nData__
+    };
+  }
+
+  const loadersData = await context.loaderManager.awaitPendingLoaders();
+  Object.keys(loadersData).forEach(id => {
+    const data = loadersData[id];
+
+    if (data._error) {
+      ssrContext.logger.error('App Prefetch Loader', data._error);
+      ssrContext.metrics.emitCounter('app.prefetch.loader.error', 1);
+      delete data._error;
+    }
+  });
+  return {
+    loadersData,
+    initialData: context.initialData,
+    i18nData: context.__i18nData__,
+    // todo: move to plugin state
+    storeState: context === null || context === void 0 ? void 0 : (_context$store = context.store) === null || _context$store === void 0 ? void 0 : _context$store.getState()
+  };
+});
+
+export default prefetch;

package/dist/js/modern/ssr/react/index.js

@@ -0,0 +1,2 @@
+export { PreRender } from "./prerender";
+export { NoSSR } from "./nossr";

package/dist/js/modern/ssr/react/nossr/index.js

@@ -0,0 +1,13 @@
+import React, { useEffect, useState } from 'react';
+let csr = false;
+export const NoSSR = props => {
+  const [isMounted, setMounted] = useState(csr);
+  useEffect(() => {
+    csr = true;
+    setMounted(true);
+  });
+  const {
+    children
+  } = props;
+  return /*#__PURE__*/React.createElement(React.Fragment, null, isMounted ? children : null);
+};

package/dist/js/modern/ssr/react/prerender/index.js

@@ -0,0 +1,104 @@
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+import withSideEffect from 'react-side-effect';
+import React, { createElement } from 'react';
+import { getOutermostProperty, aggKeysFromPropsList, exist, aggMatchesFromPropsList } from "./util";
+const PROP_NAMES = {
+  INTERVAL: 'interval',
+  STALE_LIMIT: 'staleLimit',
+  LEVEL: 'level',
+  INCLUDES: 'includes',
+  EXCLUDES: 'excludes',
+  FALLBACK: 'fallback',
+  MATCHES: 'matches'
+};
+
+const handleClientStateChange = () => {// not used
+};
+
+const mapStateOnServer = reduceProps => {
+  const defaultProps = {
+    interval: 10,
+    staleLimit: false,
+    level: 0,
+    includes: null,
+    excludes: null,
+    fallback: false,
+    matches: null
+  };
+  return Object.keys(defaultProps).reduce((props, key) => {
+    const propKey = key;
+    const reduceProp = reduceProps[propKey];
+    let nextProps = props;
+
+    if (exist(reduceProp)) {
+      nextProps = _objectSpread(_objectSpread({}, props), {}, {
+        [propKey]: reduceProp
+      });
+    }
+
+    return nextProps;
+  }, defaultProps);
+};
+
+const reducePropsToState = propsList => {
+  const reduceProps = {
+    interval: getOutermostProperty(propsList, PROP_NAMES.INTERVAL),
+    staleLimit: getOutermostProperty(propsList, PROP_NAMES.STALE_LIMIT),
+    level: getOutermostProperty(propsList, PROP_NAMES.LEVEL),
+    includes: aggKeysFromPropsList(propsList, PROP_NAMES.INCLUDES),
+    excludes: aggKeysFromPropsList(propsList, PROP_NAMES.EXCLUDES),
+    fallback: getOutermostProperty(propsList, PROP_NAMES.FALLBACK),
+    matches: aggMatchesFromPropsList(propsList, PROP_NAMES.MATCHES)
+  };
+  return reduceProps;
+};
+
+function factory(Component) {
+  class Spr extends React.Component {
+    static set canUseDOM(canUseDOM) {
+      Component.canUseDOM = canUseDOM;
+    }
+
+    static get canUseDOM() {
+      return Component.canUseDOM;
+    }
+
+    verify() {
+      return true;
+    }
+
+    render() {
+      const newProps = _objectSpread({}, this.props);
+
+      const validate = this.verify();
+
+      if (!validate) {
+        throw new Error('invalid props, check usage');
+      }
+
+      return /*#__PURE__*/createElement(Component, _objectSpread({}, newProps));
+    }
+
+  }
+
+  _defineProperty(Spr, "peek", Component.peek);
+
+  _defineProperty(Spr, "rewind", Component.rewind);
+
+  _defineProperty(Spr, "config", () => {
+    const mappedState = Component.rewind();
+    return mappedState;
+  });
+
+  return Spr;
+}
+
+const NullComponent = () => null;
+
+const SprSideEffects = withSideEffect(reducePropsToState, handleClientStateChange, mapStateOnServer)(NullComponent);
+export const PreRender = factory(SprSideEffects);

package/dist/js/modern/ssr/react/prerender/util.js

@@ -0,0 +1,99 @@
+const REQUEST_META = ['header', 'query'];
+export const getInnermostProperty = function getInnermostProperty(propsList, propName) {
+  for (let i = propsList.length - 1; i >= 0; i--) {
+    const props = propsList[i];
+
+    if (props.hasOwnProperty(propName)) {
+      return props[propName];
+    }
+  }
+
+  return null;
+};
+export const getOutermostProperty = function getOutermostProperty(propsList, propName) {
+  for (const props of propsList) {
+    if (props.hasOwnProperty(propName)) {
+      return props[propName];
+    }
+  }
+
+  return null;
+};
+export const aggKeysFromPropsList = function aggKeysFromPropsList(propsList, propName) {
+  const initResult = REQUEST_META.reduce((result, next) => {
+    const key = next;
+    result[key] = [];
+    return result;
+  }, {});
+  const res = propsList.filter(props => usefulObject(props[propName])).reduce((result, next) => {
+    REQUEST_META.forEach(key => {
+      const prop = next[propName];
+
+      if (prop !== null && prop !== void 0 && prop.hasOwnProperty(key) && usefulArray(prop[key])) {
+        result[key] = unique(result[key].concat(prop[key]));
+      }
+    });
+    return result;
+  }, initResult);
+  return REQUEST_META.reduce((result, next) => {
+    var _result$key;
+
+    const key = next;
+
+    if (result[key] && ((_result$key = result[key]) === null || _result$key === void 0 ? void 0 : _result$key.length) === 0) {
+      delete result[key];
+    }
+
+    return result;
+  }, res);
+};
+export const aggMatchesFromPropsList = function aggMatchesFromPropsList(propsList, propName) {
+  const initResult = REQUEST_META.reduce((result, next) => {
+    const key = next;
+    result[key] = {};
+    return result;
+  }, {});
+  const res = propsList.filter(props => usefulObject(props[propName])).reduce((result, next) => {
+    REQUEST_META.forEach(key => {
+      const prop = next[propName]; // 这边目前是浅拷贝，越后渲染优先级越高
+
+      if (prop !== null && prop !== void 0 && prop.hasOwnProperty(key) && usefulObject(prop[key])) {
+        result[key] = Object.assign(result[key], prop[key]);
+      }
+    });
+    return result;
+  }, initResult);
+  return REQUEST_META.reduce((result, next) => {
+    const key = next;
+
+    if (result[key] && Object.keys(result[key]).length === 0) {
+      delete result[key];
+    }
+
+    return result;
+  }, res);
+};
+
+function unique(arr) {
+  return Array.from(new Set(arr));
+}
+
+function usefulObject(target) {
+  if (!exist(target)) {
+    return false;
+  }
+
+  return target.constructor === Object && Object.keys(target).length > 0;
+}
+
+function usefulArray(target) {
+  if (!exist(target)) {
+    return false;
+  }
+
+  return Array.isArray(target) && target.length > 0;
+}
+
+export function exist(target) {
+  return target != null;
+}

package/dist/js/modern/ssr/serverRender/entry.js

@@ -0,0 +1,179 @@
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+import path from 'path';
+import { LOADABLE_STATS_FILE } from '@modern-js/utils/constants';
+import React from 'react';
+import ReactDomServer from 'react-dom/server';
+import serialize from 'serialize-javascript';
+import ReactHelmet from 'react-helmet';
+import { toFragments } from "./template";
+import { RenderLevel } from "./type";
+import helmetReplace from "./helmet";
+import { reduce } from "./reduce";
+import * as loadableRenderer from "./loadable";
+import * as styledComponentRenderer from "./styledComponent";
+import { time } from "./measure";
+
+const buildTemplateData = (context, data, renderLevel) => {
+  const {
+    request
+  } = context;
+  return {
+    data,
+    context: {
+      request: {
+        params: request.params,
+        query: request.query,
+        pathname: request.pathname,
+        host: request.host,
+        url: request.url,
+        headers: request.headers,
+        cookieMap: request.cookieMap
+      }
+    },
+    renderLevel
+  };
+};
+
+export default class Entry {
+  constructor(options) {
+    _defineProperty(this, "entryName", void 0);
+
+    _defineProperty(this, "result", void 0);
+
+    _defineProperty(this, "metrics", void 0);
+
+    _defineProperty(this, "logger", void 0);
+
+    _defineProperty(this, "App", void 0);
+
+    _defineProperty(this, "fragments", void 0);
+
+    const {
+      ctx
+    } = options;
+    const {
+      entryName,
+      template: templateHTML
+    } = ctx;
+    this.fragments = toFragments(templateHTML);
+    this.entryName = entryName;
+    this.App = options.App;
+    this.metrics = ctx.metrics;
+    this.logger = ctx.logger;
+    this.result = {
+      renderLevel: RenderLevel.CLIENT_RENDER,
+      html: '',
+      chunksMap: {
+        js: '',
+        css: ''
+      }
+    };
+  }
+
+  async renderToHtml(context) {
+    const {
+      ssrContext
+    } = context;
+
+    if (ssrContext.redirection.url) {
+      return '';
+    }
+
+    const prefetchData = await this.prefetch(context);
+
+    if (ssrContext.redirection.url) {
+      return '';
+    }
+
+    if (this.result.renderLevel >= RenderLevel.SERVER_PREFETCH) {
+      this.result.html = this.renderToString(context);
+    }
+
+    if (ssrContext.redirection.url) {
+      return '';
+    }
+
+    let html = '';
+    const templateData = buildTemplateData(ssrContext, prefetchData, this.result.renderLevel);
+    const SSRData = this.getSSRDataScript(templateData);
+
+    for (const fragment of this.fragments) {
+      if (fragment.isVariable && fragment.content === 'SSRDataScript') {
+        html += fragment.getValue(SSRData);
+      } else {
+        html += fragment.getValue(this.result);
+      }
+    }
+
+    const helmetData = ReactHelmet.renderStatic();
+    return helmetData ? helmetReplace(html, helmetData) : html;
+  }
+
+  async prefetch(context) {
+    const {
+      App: {
+        prefetch
+      }
+    } = this;
+    let prefetchData;
+    const end = time();
+
+    try {
+      prefetchData = prefetch ? await prefetch(context) : null;
+      this.result.renderLevel = RenderLevel.SERVER_PREFETCH;
+      const prefetchCost = end();
+      this.logger.debug(`App Prefetch cost = %d ms`, prefetchCost);
+      this.metrics.emitTimer('app.prefetch.cost', prefetchCost);
+    } catch (e) {
+      this.result.renderLevel = RenderLevel.CLIENT_RENDER;
+      this.logger.error('App Prefetch Render', e);
+      this.metrics.emitCounter('app.prefetch.render.error', 1);
+    }
+
+    return prefetchData || {};
+  }
+
+  renderToString(context) {
+    let html = '';
+    const end = time();
+    const {
+      ssrContext
+    } = context;
+
+    try {
+      const App = /*#__PURE__*/React.createElement(this.App, {
+        context: Object.assign(context, {
+          ssr: true
+        })
+      }); // Todo render Hook
+
+      const renderContext = {
+        loadableManifest: path.resolve(ssrContext.distDir, LOADABLE_STATS_FILE),
+        result: this.result,
+        entryName: this.entryName
+      };
+      html = reduce(App, renderContext, [styledComponentRenderer.toHtml, loadableRenderer.toHtml, jsx => ReactDomServer.renderToString(jsx)]);
+      const cost = end();
+      this.logger.debug('App Render To HTML cost = %d ms', cost);
+      this.metrics.emitTimer('app.render.html.cost', cost);
+      this.result.renderLevel = RenderLevel.SERVER_RENDER;
+    } catch (e) {
+      this.logger.error('App Render To HTML', e);
+      this.metrics.emitCounter('app.render.html.error', 1);
+    }
+
+    return html;
+  }
+
+  getSSRDataScript(templateData) {
+    return {
+      SSRDataScript: `
+        <script>window._SSR_DATA = ${serialize(templateData, {
+        isJSON: true
+      })}</script>
+      `
+    };
+  }
+
+}

package/dist/js/modern/ssr/serverRender/helmet.js

@@ -0,0 +1,46 @@
+// 用于 react-helmet 正则替换
+const RE_HTML_ATTR = /<html[^>]*>/;
+const RE_BODY_ATTR = /<body[^>]*>/;
+const RE_LAST_IN_HEAD = /<\/head>/;
+const RE_TITLE = /<title[^>]*>([\s\S\n\r]*?)<\/title>/g;
+const TEST_TITLE_CONTENT = /(?<=<title[^>]*>)([\s\S\n\r]*?)([.|\S])([\s\S\n\r]*?)(?=<\/title>)/g; // 通过 react-helmet 修改模板
+
+export default function helmet(content, helmetData) {
+  let result = content;
+  const bodyAttributes = helmetData.bodyAttributes.toString();
+
+  if (bodyAttributes) {
+    result = result.replace(RE_BODY_ATTR, `<body ${bodyAttributes}>`);
+  }
+
+  const htmlAttributes = helmetData.htmlAttributes.toString();
+
+  if (htmlAttributes) {
+    result = result.replace(RE_HTML_ATTR, `<html ${htmlAttributes}>`);
+  }
+
+  const base = helmetData.base.toString();
+  const link = helmetData.link.toString();
+  const meta = helmetData.meta.toString();
+  const noscript = helmetData.noscript.toString();
+  const script = helmetData.script.toString();
+  const style = helmetData.style.toString();
+  const title = helmetData.title.toString(); // 如果模板中存在 title，且 helmetData title 有内容则做替换
+
+  const existTitle = RE_TITLE.test(content);
+
+  if (TEST_TITLE_CONTENT.test(title.trim()) && existTitle) {
+    result = result.replace(RE_TITLE, title);
+  }
+
+  return result.replace(RE_LAST_IN_HEAD, `
+    ${base}
+    ${link}
+    ${meta}
+    ${noscript}
+    ${script}
+    ${style}
+    ${existTitle ? '' : title}
+    </head>
+  `);
+}

package/dist/js/modern/ssr/serverRender/index.js

@@ -0,0 +1,29 @@
+import { RuntimeContext } from '@modern-js/runtime-core';
+import { run } from '@modern-js/utils/ssr';
+import { PreRender } from "../react/prerender";
+import SSREntry from "./entry";
+import { time } from "./measure";
+export const render = async (ctx, _ = process.cwd(), App) => {
+  const {
+    ssrContext
+  } = ctx;
+  return run(ssrContext.request.headers, async () => {
+    const entry = new SSREntry({
+      ctx: ssrContext,
+      App
+    });
+    entry.metrics.emitCounter('app.visit.count', 1);
+    const end = time();
+    const html = await entry.renderToHtml(ctx);
+    const cost = end();
+    entry.logger.info('App Render Total cost = %d ms', cost);
+    entry.metrics.emitTimer('app.render.cost', cost);
+    const cacheConfig = PreRender.config();
+
+    if (cacheConfig) {
+      ctx.ssrContext.cacheConfig = cacheConfig;
+    }
+
+    return html;
+  });
+};

package/dist/js/modern/ssr/serverRender/loadable.js

@@ -0,0 +1,48 @@
+import path from 'path';
+import { ChunkExtractor } from '@loadable/server';
+
+function getLoadableScripts(extractor) {
+  const check = scripts => (scripts || '').includes('__LOADABLE_REQUIRED_CHUNKS___ext');
+
+  const scripts = extractor.getScriptTags();
+
+  if (!check(scripts)) {
+    return '';
+  }
+
+  return scripts.split('</script>') // 前两个 script为 loadable 必须的 script
+  .slice(0, 2).map(i => `${i}</script>`).join('');
+}
+
+export const toHtml = (jsx, renderer, next) => {
+  const {
+    loadableManifest,
+    result: {
+      chunksMap
+    }
+  } = renderer;
+
+  if (!loadableManifest || chunksMap.js) {
+    return next(jsx);
+  }
+
+  const extractor = new ChunkExtractor({
+    statsFile: loadableManifest,
+    entrypoints: [renderer.entryName]
+  });
+  const html = next(extractor.collectChunks(jsx));
+  const chunks = extractor.getChunkAssets(extractor.chunks);
+  chunksMap.js = (chunksMap.js || '') + getLoadableScripts(extractor);
+
+  for (const v of chunks) {
+    const fileType = path.extname(v.url).slice(1);
+
+    if (fileType === 'js') {
+      chunksMap[fileType] += `<script src="${v.url}"></script>`;
+    } else if (fileType === 'css') {
+      chunksMap[fileType] += `<link href="${v.url}" rel="stylesheet" />`;
+    }
+  }
+
+  return html;
+};

package/dist/js/modern/ssr/serverRender/measure.js

@@ -0,0 +1,11 @@
+const getLatency = hrtime => {
+  const [s, ns] = process.hrtime(hrtime);
+  return s * 1e3 + ns / 1e6;
+};
+
+export const time = () => {
+  const hrtime = process.hrtime();
+  return () => {
+    return getLatency(hrtime);
+  };
+};

package/dist/js/modern/ssr/serverRender/reduce.js

@@ -0,0 +1,7 @@
+export function reduce(jsx, renderer, middleware) {
+  let index = 0;
+
+  const createNext = () => App => middleware[index++](App, renderer, createNext());
+
+  return createNext()(jsx);
+}

package/dist/js/modern/ssr/serverRender/styledComponent.js

@@ -0,0 +1,8 @@
+import { ServerStyleSheet } from '@modern-js/runtime-core/styled';
+export const toHtml = (jsx, renderer, next) => {
+  const sheet = new ServerStyleSheet();
+  const html = next(sheet.collectStyles(jsx));
+  const css = sheet.getStyleTags();
+  renderer.result.chunksMap.css += css;
+  return html;
+};