washpost/fusion-cache-proxy

PageBuilder Engine (Fusion)

https://github.com/WPMedia/fusion/actions/workflows/run-tests.yml/badge.svg?event=push](https://github.com/WPMedia/fusion/actions/workflows/run-tests.yml) https://github.com/WPMedia/fusion/actions/workflows/build-deploy.yml/badge.svg?event=push](https://github.com/WPMedia/fusion/actions/workflows/build-deploy.yml)

PageBuilder Engine 是一个服务端+客户端渲染引擎，设计用于由多个独立页面组成、且这些页面共享少量可能频繁变化的模板的网站。

必需：GitHub Token

由于 PageBuilder Engine 依赖私有 @wpmedia 作用域的包，您必须在许多安装或构建步骤中设置环境变量 GITHUB_TOKEN。确保该令牌至少启用了 read_packages 权限，并且已通过 WPMedia SSO 授权。

• GitHub 令牌在您的 https://github.com/settings/tokens 中管理
• 有关生成 GitHub 令牌的更多信息，请参见 https://docs.github.com/en/enterprise-server@3.6/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token
• 有关通过 SSO 授权 GitHub 令牌的更多信息，请参见 https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on

版本控制

PageBuilder Engine 使用单个 master 分支生成软件的多个版本，这些版本除了运行的 Node 版本外完全相同。这旨在简化客户的升级过程，因为客户通常因主要版本发布中可能存在的破坏性代码和配置变更而不愿升级。为确保前后兼容性，所有自动化测试均针对所有受支持和即将支持的 Node 版本运行。

由于各个 Engine 版本的次要和补丁版本并不总是对齐，它们的版本可以单独递增。此过程通过 @changesets/cli 包管理，该包对 .versions 文件夹中的虚拟包进行操作。每个虚拟包对应一个受支持的 Engine 版本，版本号在 GitHub Actions CI 流程中自动计算和分配。

• 注意：有关如何维护虚拟包的技术信息，请阅读 .versions/README.md。

合并到 master 分支将触发正式生产版本，前提是（且仅当）仓库中没有变更集文件。如果检测到变更集文件，则会触发 canary 版本。

本地运行 Engine

您可以直接从该仓库运行 Engine，或使用 https://github.com/wpmedia/fusion-cli%E3%80%82%E4%B8%A4%E8%80%85%E7%9A%84%E8%AE%BE%E7%BD%AE%E6%9C%89%E6%89%80%E4%B8%8D%E5%90%8C%EF%BC%8C%E4%BD%86%E9%80%9A%E8%BF%87%E6%9C%80%E5%B0%91%E7%9A%84%E9%85%8D%E7%BD%AE%E5%8F%AF%E5%AE%9E%E7%8E%B0%E7%9B%B8%E5%90%8C%E7%9A%84%E8%BF%90%E8%A1%8C%E6%97%B6%E7%BB%93%E6%9E%9C%E3%80%82%E4%BB%A5%E4%B8%8B%E6%AD%A5%E9%AA%A4%E6%8F%8F%E8%BF%B0%E5%A6%82%E4%BD%95%E4%BB%8E%E8%AF%A5%E4%BB%93%E5%BA%93%E8%BF%90%E8%A1%8C Engine：

0. 下载 Docker（需要 docker-compose）
1. 从根目录 ~/fusion 运行 npm i
2. 运行 npm run start:admin

测试

单元测试使用 Jest，将混合使用从根 package.json 安装的包和从每个镜像（engine、resolver 等）内的 package.json 文件安装的包。如果遇到意外错误，请确保在每个文件夹中运行 npm i。

架构

路由

Engine 中的路由涉及两个主要组件：

• origin
• https://github.com/WPMedia/pagebuilder-resolver/blob/main/resolver/README.md

第三个组件是 https://github.com/WPMedia/pagebuilder-resolver/blob/main/resolver-generator/README.md%EF%BC%8C%E5%BD%93%E5%9C%A8 PageBuilder UI 中修改 Resolver 时，它会创建 resolver Lambda，但不执行任何实际路由。

Engine

Fusion engine 包含核心渲染功能。

• engine

管理界面（Admin）

Fusion 管理界面当前构建于 https://github.com/wpmedia/pb-web/tree/fusion-admin 的 fusion-admin 分支。

管理界面为最终用户提供网站内容管理功能。最终目标是用 pb-admin 替换 pb-web。

• https://github.com/wpmedia/pb-admin

开发者体验

Engine 开发者体验主要包括：

• 文档
• https://github.com/wpmedia/fusion-cli

指标

以下是 Fusion 组件发出的可用指标列表

Fusion Origin

Fusion Cache Proxy

Fusion Engine

发布

PageBuilder Engine 发布记录在 此处的 Confluence（内部），并在 此处的 ALC 向客户公开显示。

有关发布新 Engine 版本的详细信息，请参见 ./documentation/maintainers/PUBLISH.md。

构建服务器

使用构建服务器发布

1. 确保通过 AnyConnect 连接 ***
2. 访问 [***]
3. 确保您的分支包含 Jenkinsfile（见下文示例）

groovy
pipeline {
    agent any

    stages {
        stage('Hello') {
            steps {
                echo 'Hello from repo branch'
            }
        }
    }
}

4. 在分支上提交并推送。
5. 在 Jenkins 多流水线选项中查看您的分支。每次推送时，每个分支名称将有自己的流水线运行。

SSH 连接到构建服务器

前提条件：要通过 SSH 连接到构建服务器，您需要 pem 证书。请向 engine 团队成员索取。

1. （只需执行一次）通过运行 chmod 400 [pem 文件路径] 为您的 pem 文件添加 400 权限
2. 连接到 Arc 的 Cisco ***
3. 打开终端
4. ssh -i [pem 文件路径] centos@10.72.240.113
5. 以下命令授予您对 Jenkins 镜像的标准访问权限。如果需要对 Jenkins 镜像的 root 访问权限，请跳至步骤 5。 docker exec -ti jenkins bash
6. 如果需要对镜像的 root 访问权限（例如安装包），运行以下命令：

sudo docker exec -it --user root jenkins bash
/data/jenkins/
/var/jenkins_home