environments: nop mode reports no planned changes
I maintainer di solito rispondono entro 2 giorni
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 78/100
- Tipo di issue
- Bug
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- github, javascript
Direzione di ricerca
Inizia in lib/plugins/environments.js, in add(), update(), remove() e nel percorso di ritorno di sync() menzionato nell’issue. Leggi il test non riuscito descritto nell’issue e segui il percorso dei suoi risultati NopCommand fino a Settings.appendToResults() in lib/settings.js. Il lavoro è concluso quando il test vede un NopCommand il cui messaggio di azione è "Delete environment" in modalità nop.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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() }
- Lingua principale
- JavaScript
- Stelle
- 942
- Fork
- 238
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.
- Include un Dockerfile o un file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di github-community-projects/safe-settings
-
Teams: teams with organization-role access show up as deletionsForse già presa @TovaBecker l’ha presa 1 giorno fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 83/100
github-community-projects/safe-settings#1144 ·
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
github-community-projects/safe-settings#1143 ·
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
github-community-projects/safe-settings#1134 ·
I maintainer di solito rispondono entro 2 giorni
-
environments: additive_plugins is ignored, undeclared environments are deletedForse già presa @yaunj l’ha presa 12 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
github-community-projects/safe-settings#1133 ·
I maintainer di solito rispondono entro 2 giorni
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
github-community-projects/safe-settings#1130 ·
I maintainer di solito rispondono entro 2 giorni
Tutte le issue di github-community-projects/safe-settings
Issue simili
-
Bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
Ionaru/easy-markdown-editor#657 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 66/100
TMHSDigital/Free-Game-Dev-Assets#320 ·
I maintainer di solito rispondono entro 1 giorno
-
area:webapp bug finding
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
Long working directory path draws over the Console pane's buttons when the Console has no other tabsApertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 87/100
ossf/wg-best-practices-os-developers#1209 ·
I maintainer di solito rispondono entro 1 giorno