解决Electron-Builder中使用Azure Trusted Signing时的文件路径问题

问题背景

在使用Electron-Builder构建Windows应用程序时，开发者JuanIrache尝试通过自定义签名脚本集成Azure Trusted Signing服务时遇到了一个棘手的问题。尽管签名脚本在手动执行时工作正常，但在通过electron-builder自动执行时却报出"File not found"错误。

问题现象

开发者配置了如下构建配置：

"build": {
  "win": {
    "target": "nsis",
    "sign": "./scripts/sign.js"
  }
}

签名脚本内容如下：

exports.default = async function ({ path }) {
  const c = `path/to/signtool.exe sign -v -debug -fd SHA256 -tr http://timestamp.acs.microsoft.com -td SHA256 -dlib path/to/Azure.CodeSigning.Dlib.dll  -dmdf ./signMetadata.json "${path}"`;
  
  try {
    const out = execSync(c, { stdio: 'inherit' });
    console.log(out);
  } catch (error) {
    console.error(error);
  }
};

当通过electron-builder执行时，报错：

SignTool Error: File not found: path/to/signable/file.exe

问题分析

1. 表面现象：错误信息显示无法找到待签名的文件，但实际上文件路径是正确的。

2. 关键发现：

   • 手动执行完全相同的命令可以成功
   • 在脚本中使用existsSync检查文件存在性时，文件确实存在
   • 错误信息可能具有误导性

3. 根本原因：问题实际上出在脚本中其他相对路径的引用上，特别是./signMetadata.json和path/to/Azure.CodeSigning.Dlib.dll这两个文件路径。当通过electron-builder执行时，工作目录可能与预期不同，导致相对路径解析失败。

解决方案

1. 使用绝对路径：将所有文件引用改为绝对路径，确保无论从哪个目录执行都能正确定位文件。

2. 路径规范化：使用Node.js的path模块处理路径，确保跨平台兼容性。

修改后的脚本示例：

const path = require('path');
const { execSync } = require('child_process');

exports.default = async function ({ path: fileToSign }) {
  // 使用绝对路径
  const signtoolPath = path.resolve('path/to/signtool.exe');
  const dlibPath = path.resolve('path/to/Azure.CodeSigning.Dlib.dll');
  const metadataPath = path.resolve('path/to/signMetadata.json');
  
  const command = `"${signtoolPath}" sign -v -debug -fd SHA256 -tr http://timestamp.acs.microsoft.com -td SHA256 -dlib "${dlibPath}" -dmdf "${metadataPath}" "${fileToSign}"`;
  
  try {
    const out = execSync(command, { stdio: 'inherit' });
    console.log(out);
  } catch (error) {
    console.error('签名失败:', error);
    throw error; // 抛出错误以便electron-builder能够捕获
  }
};

最佳实践建议

1. 路径处理：在构建脚本中始终使用绝对路径，避免相对路径带来的不确定性。

2. 错误处理：完善错误处理逻辑，提供更清晰的错误信息，便于问题定位。

3. 调试技巧：在脚本中添加调试信息，打印当前工作目录和完整命令，便于排查问题。

4. 环境验证：在脚本开始时验证所有依赖文件的存在性，提前发现问题。

5. 跨平台考虑：使用Node.js的path模块处理路径分隔符，确保脚本在不同操作系统上的兼容性。

总结

在Electron-Builder中使用自定义签名脚本时，路径处理是需要特别注意的关键点。特别是当脚本被不同执行上下文调用时，工作目录可能发生变化，导致相对路径解析失败。通过使用绝对路径和Node.js的path模块，可以确保脚本在各种环境下都能可靠工作。这个案例也提醒我们，错误信息有时会具有误导性，需要全面检查所有可能的失败点。