washpost/fusion-engine

engine 镜像文档

概述

engine是Fusion架构的核心渲染组件，以Lambda形式存在。它接收包含可渲染组件（如React组件）及相关内容的Rendering对象，将这些组件与内容融合后生成HTML。同时，engine支持通过将生成的HTML写入S3实现多种缓存模式，使Fusion源可以优先或作为备份提供该HTML内容。

核心功能与特性

核心渲染能力

• 处理包含可渲染组件（如React组件）和相关内容的Rendering对象，执行融合逻辑生成HTML。

缓存机制

• 支持多种缓存模式，通过将生成的HTML写入S3，使Fusion源能够优先提供或作为备份提供HTML内容。

依赖支持

• 主要依赖：AWS DynamoDB（用于持久化组织特定的渲染配置）、React（默认渲染器，同时支持Handlebars等其他模板引擎）、@arc-fusion/prop-types（Fusion自定义属性类型）。
• 本地开发依赖：Mongo（替代DynamoDB，与engine一同在Docker容器中运行）。
• 监控依赖：生产环境中集成AWS ***（生成服务地图和追踪）、Datadog（自定义指标监控）。

部署说明

engine Lambda为单租户模式，通过https://github.com/wpmedia/maestro%E8%BF%9B%E8%A1%8C%E9%83%A8%E7%BD%B2%E3%80%82%E9%83%A8%E7%BD%B2%E8%BF%87%E7%A8%8B%E4%B8%AD%EF%BC%8CMaestro%E4%BC%9A%E6%89%93%E5%8C%85%E5%89%8D%E7%AB%AF%E7%BB%84%E4%BB%B6%EF%BC%88%E7%A7%B0%E4%B8%BAFeature Pack）和核心engine代码，使Fusion能够生成静态HTML。

路由说明

公共API（Public API）

Fusion提供公共HTTP端点，详细描述见https://github.com/WPMedia/fusion/blob/master/documentation/api/http/API.md%EF%BC%8C%E4%B8%BB%E8%A6%81%E5%8C%85%E6%8B%AC%EF%BC%9A

• https://github.com/WPMedia/fusion/blob/master/documentation/api/http/API.md#assets
• https://github.com/WPMedia/fusion/blob/master/documentation/api/http/API.md#content
• https://github.com/WPMedia/fusion/blob/master/documentation/api/http/API.md#rendering
• https://github.com/WPMedia/fusion/blob/master/documentation/api/http/API.md#resources

管理API（Admin API）

以下路由专为PageBuilder Admin UI设计：

Configs

Configs描述PageBuilder Admin中可用的组件，为只读路由，返回JSON格式数据：

• GET /configs/chains
• GET /configs/features
• GET /configs/layouts
• GET /configs/output-types
• GET /configs/content/schemas
• GET /configs/content/sources

Resolvers

Resolvers由PageBuilder Admin发布，包含所有解析器的payload。该路由用于将JSON上传至S3，触发resolver-generator重建resolver Lambda：

• POST /resolvers

Properties

Site Properties是站点特定的值，可在bundle中任何位置访问，本质上替代PageBuilder Classic中的Runtime Properties：

• GET /properties

Webpack集成

engine Lambda中包含Webpack，在Rendering对象发布时被调用，用于编译相关资源。

目录结构

部署后的目录结构如下：

/opt/
  engine/
    bundle/
      build/                    <-- 仅服务端编译的bundle代码
        components/
          combinations/
          output-types/
          fusion.json
        content/
          schemas/
          sources/
          fusion.json
        properties.js
      dist/                     <-- 服务端和客户端的编译bundle代码
        components/
          combinations/
        configs/
          components/
            chains/
            features/
            layouts/
            output-types/
          content/
            schemas/
            sources/
        engine/
          admin.js
          polyfill.js
          preview.js
          react.js
        stats.json              <-- webpack统计输出（仅本地开发）
        calls.json              <-- 请求追踪输出（仅本地开发）
      generated/                <-- 动态生成的src文件，作为webpack入口点
        components/
          combinations/
        properties.js
      linked_modules/           <-- 动态映射卷，支持`npm link`
      node_modules/             <-- 在docker镜像中构建的bundle模块，用于缓存优化
      src/                      <-- 实际的bundle仓库
    environment/                <-- Lambda读取的环境变量
    lib/                        <-- fusion engine源代码
    node_modules/               <-- fusion engine模块
    src/
      index.js                  <-- serverless和AWS Lambda调用的入口文件
    webpack/                    <-- webpack配置，在Compiler Lambda上执行
    stages/
    static/                     <-- webpack静态产物（仅本地开发）

注意：

1. 使用/opt目录是为可能使用的lambda layers做准备。
2. 不要将build/或dist/放在bundle/下，以避免运行时bundle模块优先于engine版本。