简介
maxymiser-workflow 是一个基于 Node.js 的 npm 包,用于在 Maxymiser 中进行 A/B 测试和多变量测试的自动化任务。该包可以让前端开发者更加方便地在 Maxymiser 平台进行测试以及测试结果的生成和报告。
安装
要使用 maxymiser-workflow,你需要在本地安装 Node.js。然后,使用以下命令在你的项目中安装 maxymiser-workflow:
npm install maxymiser-workflow --save-dev
快速上手
步骤一:设置 Maxymiser API 凭证
在使用 maxymiser-workflow 之前,你需要准备 Maxymiser API 凭证。在 Maxymiser 控制台中,你可以生成这些凭证。
凭证包括一个客户端 ID、一个客户端密码、一个应用程序 ID、一个应用程序密码和一个租户 ID。请让这些凭证保持私密,只在你的项目中使用。
步骤二:创建一个配置文件
在你的项目目录中,创建一个名为 maxymiser.config.js
的文件。该文件应包括以下内容:
-- -------------------- ---- ------- -------------- - - ------------ - --------- ----------------- ------------- --------------------- -------------- ---------------------- ------------------ -------------------------- --------- ----------------- -- ------ - - ----- ----- ------ ------------ ----- ------------- ----------- - - ----- ---------- --- ----- ----- ------------- --------------- -- - ----- ---------- --- ----- ----- ------------- --- -- -- -- -- --
在上述代码中,你需要将 YOUR_CLIENT_ID
、YOUR_CLIENT_SECRET
、YOUR_APPLICATION_ID
、YOUR_APPLICATION_SECRET
和 YOUR_TENANT_ID
替换为你从 Maxymiser 获取的凭证。
tests
数组包括你想要进行的测试。每个测试应该包括名称、描述和变量。每个变量应该包括名称、ajax 标记和依赖项列表,以确保需要特定脚本时能正确引入。
步骤三:执行任务
当你完成了配置文件后,执行以下命令启动测试:
npx maxymiser-workflow
该命令将自动启动测试并生成测试数据以及报告文件。
高级配置
maxymiser-workflow 还提供了许多高级配置选项,以便你更好地控制测试的细节。
使用不同的 Maxymiser API 版本
你可以在配置文件中指定 Maxymiser API 的版本:
-- -------------------- ---- ------- -------------- - - ----------- ------- ------------ - --------- ----------------- ------------- --------------------- -------------- ---------------------- ------------------ -------------------------- --------- ----------------- -- -- --- --
支持的 API 版本包括 v1.0
和 v2.0
。默认值为 v1.0
。
设置请求超时时间
你可以在配置文件中指定请求超时时间:
-- -------------------- ---- ------- -------------- - - -------- ----- ------------ - --------- ----------------- ------------- --------------------- -------------- ---------------------- ------------------ -------------------------- --------- ----------------- -- -- --- --
默认超时时间为 30000
毫秒。
自定义 Maxymiser API 地址
你可以在配置文件中指定 Maxymiser API 的地址:
-- -------------------- ---- ------- -------------- - - ------------ ------------------------------ ------------ - --------- ----------------- ------------- --------------------- -------------- ---------------------- ------------------ -------------------------- --------- ----------------- -- -- --- --
默认情况下,该地址为 https://api.maxymiser.com
。
示例代码
下面是一个示例,用于切换两种不同的样式表:
-- -------------------- ---- ------- ----- ------- - - ---- - ----------------- ---- - -- ----- ---------- - - ---- - ----------------- ----- - -- -------------- - - ------------ - --------- ----------------- ------------- --------------------- -------------- ---------------------- ------------------ -------------------------- --------- ----------------- -- ------ - - ----- ---- ---------- ------- ------------ ----- --- ---------- ------- ----------- - - ----- ------- ----- ------ ------------- --- --------- ---------- - ----- ----- - -------------------------------- ---------- - ----------- ---------------------------------------------------- --------------------------------- -- ----------- ---------- - ------------------------------------------------ -- - -- ---------------- -- -------- - --------------- - --- -- -- - ----- ---------- ----- ------ ------------- --- --------- ---------- - ----- ----- - -------------------------------- ---------- - ----------- ------------------------------------------------------- --------------------------------- -- ----------- ---------- - ------------------------------------------------ -- - -- ---------------- -- ----------- - --------------- - --- -- -- -- -- -- --
在上述示例中,我们创建了一个可以切换背景颜色的测试。测试包括两个变量:Test
和 Control
。每个变量都包括一个 activate
函数和一个 deactivate
函数。在 activate
函数中,我们将动态创建一个样式表,并将其附加到文档头部。在 deactivate
函数中,我们将删除刚刚创建的样式表。
使用 maxymiser-workflow,我们可以轻松地在 Maxymiser 平台上测试该样式表的两种不同颜色,并生成测试报告。
结论
maxymiser-workflow 是一个方便的 npm 包,用于管理在 Maxymiser 平台上进行的 A/B 测试和多变量测试。它提供了丰富的配置选项和示例代码,让您可以更轻松地设置和运行测试。通过使用 maxymiser-workflow,您可以获得有益的测试结果和报告,为您的项目带来更好的用户体验。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/61439