environments: nop mode reports no planned changes
Maintainer thường phản hồi trong vòng 2 ngày
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức phù hợp với người mới
- 78/100
- Loại issue
- Lỗi
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- github, javascript
Hướng nghiên cứu
Bắt đầu tại lib/plugins/environments.js, ở add(), update(), remove() và đường trả về của sync() được nhắc đến trong issue. Đọc bài kiểm thử thất bại được mô tả trong issue và lần theo cách các kết quả NopCommand của nó đến Settings.appendToResults() trong lib/settings.js. Hoàn thành khi bài kiểm thử thấy một NopCommand có thông báo hành động là "Delete environment" ở chế độ nop.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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
remove(): lib/plugins/environments.js#L317-L321sync()return: #L377-L378- Results collected and falsy entries dropped: lib/settings.js#L2150-L2153, #L3173
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() }
- Ngôn ngữ chính
- JavaScript
- Star
- 942
- Fork
- 238
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Chuẩn bị môi trường
Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.
- Có Dockerfile hoặc tệp Docker Compose
- Không có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của github-community-projects/safe-settings
-
Teams: teams with organization-role access show up as deletionsCó thể đã có người làm @TovaBecker đã nhận 1 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 83/100
github-community-projects/safe-settings#1144 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
github-community-projects/safe-settings#1143 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
github-community-projects/safe-settings#1134 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
environments: additive_plugins is ignored, undeclared environments are deletedCó thể đã có người làm @yaunj đã nhận 12 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
github-community-projects/safe-settings#1133 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
Latest Release should be updated to include the minimun node that remediates cve-2026-111497Đang mởbug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 64/100
github-community-projects/safe-settings#1130 ·
Maintainer thường phản hồi trong vòng 2 ngày
Tất cả issue của github-community-projects/safe-settings
Issue tương tự
-
priority: low server testing
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
blamechris/chroxy#9277 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
[MCP]: page snapshots in .playwright-mcp/ are not git-ignored (.playwright-cli/ is, since #42318)Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
microsoft/playwright#44289 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
Ionaru/easy-markdown-editor#657 ·
-
[source] Camera Blocking StageĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 66/100
TMHSDigital/Free-Game-Dev-Assets#320 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
area:webapp bug finding
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Maintainer thường phản hồi trong vòng 1 ngày