Azure DevOps API创建PR后立即完成失败问题求助

我尝试创建新的Azure DevOps（ADO）Pull Request并立即完成（用于单元测试），但发现创建后直接执行完成操作时没有效果；如果在PR创建与完成步骤间添加1秒超时，则可以正常执行。

测试代码如下：

// CREATE PR
const prRequestUrl = `https://system:${personalAccessToken}@dev.azure.com/${organization}/${project}/_apis/git/repositories/${repo}/pullRequests?api-version=7.0`;
const prRequestBody = {
  sourceRefName: 'refs/heads/source',
  targetRefName: 'refs/heads/target',
  title: 'PR title',
  description: 'PR description',
};
const prData = (await axios.post(prRequestUrl, prRequestBody)).data;

// This fixes the issue
// await new Promise((resolve) => setTimeout(resolve, 1000));

// COMPLETE PR
const approvePrRequestUrl = `https://system:${personalAccessToken}@dev.azure.com/${organization}/${project}/_apis/git/repositories/${repo}/pullRequests/${prData.pullRequestId}/?api-version=7.0`;
const approvePrRequestBody = {
  lastMergeSourceCommit: prData.lastMergeSourceCommit,
  completionOptions: {
    deleteSourceBranch: false,
  },
  status: 'completed',
};
await axios.patch(
  approvePrRequestUrl,
  approvePrRequestBody
);

原因分析 #

这是因为ADO的PR创建是异步后台处理流程：虽然POST请求会立即返回PR的基础信息（比如pullRequestId），但后台此时还没完成PR的全部初始化工作——包括分支差异计算、状态同步、权限校验、PR内部状态机初始化等。

如果此时直接调用PATCH请求修改PR状态为completed，后台还未准备好接收这个操作，请求会被静默忽略或者处理失败，导致看起来没有效果。添加1秒超时相当于给后台留足了初始化时间，所以操作能正常执行。

解决方法 #

不要依赖固定超时（不可靠，不同环境下初始化时间可能波动），改用轮询检查PR的状态，确认PR已经处于active状态（即初始化完成）后，再执行完成操作：

修改后的代码示例：

// CREATE PR
const prRequestUrl = `https://system:${personalAccessToken}@dev.azure.com/${organization}/${project}/_apis/git/repositories/${repo}/pullRequests?api-version=7.0`;
const prRequestBody = {
  sourceRefName: 'refs/heads/source',
  targetRefName: 'refs/heads/target',
  title: 'PR title',
  description: 'PR description',
};
const prData = (await axios.post(prRequestUrl, prRequestBody)).data;

// 轮询等待PR初始化完成（状态变为active）
const waitForPrReady = async (prId) => {
  const checkUrl = `https://system:${personalAccessToken}@dev.azure.com/${organization}/${project}/_apis/git/repositories/${repo}/pullRequests/${prId}?api-version=7.0`;
  const maxRetries = 20; // 避免无限轮询，设置最大重试次数
  let retryCount = 0;

  while (retryCount < maxRetries) {
    const response = await axios.get(checkUrl);
    const currentStatus = response.data.status;
    
    if (currentStatus === 'active') {
      break;
    }
    
    retryCount++;
    await new Promise(resolve => setTimeout(resolve, 200)); // 每200毫秒检查一次
  }

  if (retryCount >= maxRetries) {
    throw new Error('PR初始化超时，未能进入active状态');
  }
};
await waitForPrReady(prData.pullRequestId);

// COMPLETE PR
const approvePrRequestUrl = `https://system:${personalAccessToken}@dev.azure.com/${organization}/${project}/_apis/git/repositories/${repo}/pullRequests/${prData.pullRequestId}/?api-version=7.0`;
const approvePrRequestBody = {
  lastMergeSourceCommit: prData.lastMergeSourceCommit,
  completionOptions: {
    deleteSourceBranch: false,
  },
  status: 'completed',
};
await axios.patch(approvePrRequestUrl, approvePrRequestBody);

说明 #

轮询方案的优势：

• 可靠性更高：适配不同环境下的后台处理速度（比如ADO服务器负载高时，初始化时间会变长）
• 避免不必要的等待：PR初始化完成后立即执行下一步，不会浪费固定超时的等待时间
• 有容错机制：通过最大重试次数避免无限循环

内容的提问来源于stack exchange，提问作者Odd One Out