fix: don't duplicate commit status records on workflows with empty name (#10678)

Fixes #10671.

Cleanup for the inflated number of records in this table will come in a near future change.

## Checklist

The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org).

### Tests

- I added test coverage for Go changes...
  - [x] in their respective `*_test.go` for unit tests.
  - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server.
- I added test coverage for JavaScript changes...
  - [ ] in `web_src/js/*.test.js` if it can be unit tested.
  - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)).

### Documentation

- [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change.
- [x] I did not document these changes and I do not expect someone else to do it.

### Release notes

- [ ] I do not want this change to show in the release notes.
- [x] I want the title to show in the release notes with a link to this pull request.
- [ ] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title.

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/10678
Reviewed-by: Michael Kriese <michael.kriese@gmx.de>
Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net>
Co-committed-by: Mathieu Fenniak <mathieu@fenniak.net>
This commit is contained in:
Mathieu Fenniak 2026-01-02 19:02:10 +01:00 committed by Mathieu Fenniak
parent fa5a52b983
commit 8f63ee9a94
4 changed files with 100 additions and 1 deletions

View file

@ -0,0 +1,25 @@
-
id: 900
title: "update actions"
repo_id: 4
owner_id: 1
workflow_id: "artifact.yaml"
index: 200
trigger_user_id: 1
ref: "refs/heads/master"
commit_sha: "c7cd3cd144e6d23c9d6f3d07e52b2c1a956e0338"
event: "push"
is_fork_pull_request: false
status: 1
started: 1683636528
stopped: 1683636626
created: 1683636108
updated: 1683636626
need_approval: false
approved_by: 0
event_payload: |
{
"head_commit": {
"id": "c7cd3cd144e6d23c9d6f3d07e52b2c1a956e0338"
}
}

View file

@ -0,0 +1,26 @@
-
id: 400
run_id: 900
repo_id: 4
owner_id: 1
commit_sha: c7cd3cd144e6d23c9d6f3d07e52b2c1a956e0338
is_fork_pull_request: false
name: job_2
attempt: 1
job_id: job_2
task_id: 47
status: 7 # blocked
started: 1683636528
stopped: 1683636626
workflow_payload: |
"on":
push:
jobs:
produce-artifacts:
name: produce-artifacts
runs-on: docker
steps:
- run: echo "OK!"
strategy:
matrix:
color: red

View file

@ -8,6 +8,7 @@ import (
"errors"
"fmt"
"path"
"strings"
actions_model "forgejo.org/models/actions"
"forgejo.org/models/db"
@ -94,7 +95,8 @@ func createCommitStatus(ctx context.Context, job *actions_model.ActionRunJob) er
state := toCommitStatus(job.Status)
if statuses, _, err := git_model.GetLatestCommitStatus(ctx, repo.ID, sha, db.ListOptionsAll); err == nil {
for _, v := range statuses {
if v.Context == ctxname {
// TrimSpace(ctxname) to match stored value which is trimmed in `git.NewCommitStatus`
if v.Context == strings.TrimSpace(ctxname) {
if v.State == state {
// no need to update
return nil

View file

@ -7,9 +7,14 @@ import (
"testing"
actions_model "forgejo.org/models/actions"
git_model "forgejo.org/models/git"
"forgejo.org/models/unittest"
"forgejo.org/modules/cache"
"forgejo.org/modules/structs"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"xorm.io/builder"
)
func TestCreateCommitStatus_IncompleteMatrix(t *testing.T) {
@ -36,3 +41,44 @@ func TestCreateCommitStatus_IncompleteMatrix(t *testing.T) {
err = createCommitStatus(t.Context(), job)
require.NoError(t, err)
}
func TestCreateCommitStatus_AvoidsDuplicates(t *testing.T) {
defer unittest.OverrideFixtures("services/actions/TestCreateCommitStatus")()
require.NoError(t, unittest.PrepareTestDatabase())
cache.Init()
job := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunJob{ID: 400})
targetCommitStatusFilter := builder.Eq{"repo_id": 4, "sha": job.CommitSHA}
// Begin with 0 commit statuses
assert.Equal(t, 0, unittest.GetCount(t, &git_model.CommitStatus{}, targetCommitStatusFilter))
err := createCommitStatus(t.Context(), job)
require.NoError(t, err)
// Should have 1 commit status now with one createCommitStatus call
assert.Equal(t, 1, unittest.GetCount(t, &git_model.CommitStatus{}, targetCommitStatusFilter))
status := unittest.AssertExistsAndLoadBean(t, &git_model.CommitStatus{}, targetCommitStatusFilter)
assert.EqualValues(t, 4, status.RepoID)
assert.Equal(t, structs.CommitStatusState("pending"), status.State)
assert.Equal(t, "c7cd3cd144e6d23c9d6f3d07e52b2c1a956e0338", status.SHA)
assert.Equal(t, "/user5/repo4/actions/runs/200/jobs/0", status.TargetURL)
assert.Equal(t, "Blocked by required conditions", status.Description)
assert.Equal(t, "39c46bc9f0f68e0dcfbb59118e12778fa095b066", status.ContextHash)
assert.Equal(t, "/ job_2 (push)", status.Context) // This test is intended to cover the runName = "" case, which trims whitespace in this context string -- don't change it in the future
// No status change, but createCommitStatus invoked again
err = createCommitStatus(t.Context(), job)
require.NoError(t, err)
// Should have just the same 1 commit status since the context & state was unchanged.
assert.Equal(t, 1, unittest.GetCount(t, &git_model.CommitStatus{}, targetCommitStatusFilter))
// Update job status & create new commit status
job.Status = actions_model.StatusSuccess
err = createCommitStatus(t.Context(), job)
require.NoError(t, err)
// Should have 2 commit statuses now
assert.Equal(t, 2, unittest.GetCount(t, &git_model.CommitStatus{}, targetCommitStatusFilter))
}