environments: nop mode reports no planned changes

未关闭 适合新手
#1,135 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 2 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
78/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
github, javascript
领域
backend, devtools

调研方向

从 lib/plugins/environments.js 中的 add()、update()、remove() 以及 issue 提到的 sync() 返回路径开始。阅读 issue 中描述的失败测试,并追踪其 NopCommand 结果如何到达 lib/settings.js 中的 Settings.appendToResults()。当测试在 nop 模式下看到一个操作消息为 "Delete environment" 的 NopCommand 时,即为完成。

由索引模型根据 Issue 内容生成。

描述

Problem Description

What is actually happening

In nop (dry-run) mode, the environments plugin reports none of its planned changes, so dry-run PR checks never show environment changes. sync() resolves to [undefined].

add(), update() and remove() await this.nopifyRequest(...) but don't return the result, so resArray collects undefined. sync() also returns resArray without waiting for the pending changes. Settings.appendToResults() then drops the falsy entries, so nothing about environments reaches the dry-run output.

What is the expected behavior

The dry-run results include the planned environment changes, for example "Delete environment" for an environment that is no longer in the config.

Error output, if available

There's no runtime error. Output of the failing unit test below:

✕ BUG: sync() in nop mode returns the planned DELETE environment as a NopCommand
  Expected value: "Delete environment"
  Received array: []
Steps to reproduce

Repo my-org/my-repo has environments test and prod. Open a PR on the admin repo that changes settings.yml to:

environments:
  - name: prod

The dry-run check shows nothing about deleting test.

Code references
Failing test

Fails on 3.0.0 and on main-enterprise.

it('BUG: sync() in nop mode returns the planned DELETE environment as a NopCommand', async () => {
  const github = mockGithub({ prod: { api: apiEnv('prod') }, old: { api: apiEnv('old') } })
  const plugin = new Environments(true, github, { owner: org, repo }, [{ name: 'prod' }], log, [])
  const res = await plugin.sync()
  const commands = [res].flat(3).filter(x => x instanceof NopCommand)
  expect(commands.map(c => c.action.msg)).toContain('Delete environment')
})
Suggested fix

Return the nopifyRequest results from add/update/remove, and await Promise.all(changes) before returning resArray in nop mode.

This is separate from #1133: fixing the additive check there doesn't change what nop mode reports.

Context

Are you using the hosted instance of probot/settings or running your own?

Running our own. I reproduced this with unit tests against the code, using a mocked GitHub API, so it doesn't depend on how the app is deployed.

If running your own instance, are you using it with github.com or GitHub Enterprise?

Not relevant here: the reproduction uses a mocked API, and the code path is the same for both.

Version of probot/settings

safe-settings 3.0.0 (a9a1f366ad6a738b55682d346d94f8d6c4893b09), and main-enterprise at e19444e0d69de050ba55d0262b71fcd8a98edfef.

Version of GitHub Enterprise

N/A

Test helpers (mocks)
/* eslint-disable no-undef */
// Reproductions for reported Environments plugin bugs. Tests assert the
// CORRECT behaviour; the ones marked "BUG" fail against the current code.
const { when } = require('jest-when')
const Environments = require('../../../../lib/plugins/environments')
const Settings = require('../../../../lib/settings')
const NopCommand = require('../../../../lib/nopcommand')

const org = 'my-org'
const repo = 'my-repo'
const DELETE_ENV = 'DELETE /repos/:org/:repo/environments/:environment_name'
const PUT_ENV = 'PUT /repos/:org/:repo/environments/:environment_name'
const POST_RULE = 'POST /repos/:org/:repo/environments/:environment_name/deployment_protection_rules'
const DELETE_RULE = 'DELETE /repos/:org/:repo/environments/:environment_name/deployment_protection_rules/:rule_id'
const DELETE_VAR = 'DELETE /repos/:org/:repo/environments/:environment_name/variables/:variable_name'

// GitHub API shape of GET /repos/{owner}/{repo}/environments entries.
function apiEnv (name, { waitTimer, reviewers, preventSelfReview, branchPolicy = null } = {}) {
  const protectionRules = []
  if (waitTimer) protectionRules.push({ id: 1, type: 'wait_timer', wait_timer: waitTimer })
  if (reviewers) {
    protectionRules.push({
      id: 2,
      type: 'required_reviewers',
      prevent_self_review: !!preventSelfReview,
      reviewers: reviewers.map(r => ({ type: r.type, reviewer: { id: r.id } }))
    })
  }
  return { name, protection_rules: protectionRules, deployment_branch_policy: branchPolicy }
}

// existing: { [envName]: { api, variables: [{name,value}], rules: [{id, app: {id}}] } }
function mockGithub (existing) {
  const github = {
    request: jest.fn(() => Promise.resolve({})),
    paginate: jest.fn().mockResolvedValue([])
  }
  when(github.request)
    .calledWith('GET /repos/:org/:repo/environments', { org, repo })
    .mockResolvedValue({ data: { environments: Object.values(existing).map(e => e.api) } })
  for (const [name, e] of Object.entries(existing)) {
    when(github.request)
      .calledWith('GET /repos/:org/:repo/environments/:environment_name/deployment_protection_rules', { org, repo, environment_name: name })
      .mockResolvedValue({ data: { total_count: (e.rules || []).length, custom_deployment_protection_rules: e.rules || [] } })
    when(github.paginate)
      .calledWith('GET /repos/{owner}/{repo}/environments/{environment_name}/variables', expect.objectContaining({ environment_name: name }), expect.any(Function))
      .mockResolvedValue(e.variables || [])
  }
  return github
}

function writeCalls (github) {
  return github.request.mock.calls
    .filter(([route]) => !route.startsWith('GET '))
    .map(([route, opts]) => ({ route, opts }))
}

const log = { debug: jest.fn(), info: jest.fn(), warn: jest.fn(), error: jest.fn() }
主要语言
JavaScript
星标
942
派生
238
PR 合并指标
30 天内没有已合并 PR

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

github-community-projects/safe-settings 的其他 Issue

查看 github-community-projects/safe-settings 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。