BackstopJS中通过onBefore.js注入全局变量的正确方法

在自动化测试过程中，我们经常需要控制页面加载前的环境变量，比如禁用Cookie弹窗等。本文将以BackstopJS为例，详细介绍如何在页面加载前正确注入全局变量。

常见误区与问题分析

许多开发者会尝试在BackstopJS的onBefore.js脚本中使用page.addScriptTag()方法来注入变量，例如：

await page.addScriptTag({content: 'var UC_UI_SUPPRESS_CMP_DISPLAY = true;'});

这种方法看似合理，但实际上存在一个关键问题：注入时机过晚。当页面自身的脚本开始执行时，这个变量尚未被定义，导致无法达到预期效果。

根本原因

问题的核心在于脚本注入的时机：

1. addScriptTag是在页面开始加载后注入脚本
2. 页面自身的脚本（特别是内联脚本）会在页面加载初期就执行
3. 当页面脚本检查变量时，我们的注入代码尚未执行

正确解决方案：evaluateOnNewDocument

Puppeteer提供了evaluateOnNewDocument方法，它能够在页面创建时、任何脚本执行前就注入我们的代码：

module.exports = async (page, scenario) => {
  await page.evaluateOnNewDocument(() => {
    window.UC_UI_SUPPRESS_CMP_DISPLAY = true;
  });
};

这种方法之所以有效，是因为：

1. 它在页面框架初始化后立即执行
2. 执行时机早于任何页面脚本
3. 确保变量在页面脚本需要时已经存在

替代方案：removeSelectors

对于简单的UI元素控制，BackstopJS还提供了更直接的解决方案。在配置文件中使用removeSelectors属性可以直接移除指定的DOM元素：

"scenarios": [
  {
    "removeSelectors": [".cookie-banner"]
  }
]

这种方法适用于不需要复杂逻辑控制的简单场景。

最佳实践建议

1. 对于需要在脚本执行前设置的全局变量，优先使用evaluateOnNewDocument
2. 对于简单的UI元素控制，考虑使用removeSelectors
3. 始终在onReady.js中添加验证代码，确认变量设置成功
4. 对于复杂的场景，可能需要结合多种方法

通过理解这些技术细节，开发者可以更精准地控制测试环境，确保自动化测试的稳定性和可靠性。