jojo/services/convert/action.go
Andreas Ahlenstorf 92863bb103 feat: expose run_id in ...actions/runners/jobs endpoint (#12480)
Include `run_id` in the responses emitted by all `...actions/runners/jobs` endpoints. Helps with correlating pending jobs with other jobs and the runs they belong to.

## Checklist

The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. All work and communication must conform to Forgejo's [AI Agreement](https://codeberg.org/forgejo/governance/src/branch/main/AIAgreement.md). 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 for Go changes

(can be removed for JavaScript changes)

- I added test coverage for Go changes...
  - [x] in their respective `*_test.go` for unit tests.
  - [x] in the `tests/integration` directory if it involves interactions with a live Forgejo server.
- I ran...
  - [x] `make pr-go` before pushing

### Tests for JavaScript changes

(can be removed for Go changes)

- 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

- [x] This change will be noticed by a Forgejo user or admin (feature, bug fix, performance, etc.). I suggest to include a release note for this change.
- [ ] This change is not visible to a Forgejo user or admin (refactor, dependency upgrade, etc.). I think there is no need to add a release note for this change.

*The decision if the pull request will be shown in the release notes is up to the mergers / release team.*

The content of the `release-notes/<pull request number>.md` file will serve as the basis for the release notes. If the file does not exist, the title of the pull request will be used instead.

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/12480
Reviewed-by: Mathieu Fenniak <mfenniak@noreply.codeberg.org>
2026-05-09 02:31:03 +02:00

85 lines
2.6 KiB
Go

// Copyright 2025 The Forgejo Authors. All rights reserved.
// SPDX-License-Identifier: GPL-3.0-or-later
package convert
import (
"context"
actions_model "forgejo.org/models/actions"
access_model "forgejo.org/models/perm/access"
user_model "forgejo.org/models/user"
api "forgejo.org/modules/structs"
)
// ToActionRun convert actions_model.User to api.ActionRun
// the run needs all attributes loaded
func ToActionRun(ctx context.Context, run *actions_model.ActionRun, doer *user_model.User) *api.ActionRun {
if run == nil {
return nil
}
permissionInRepo, _ := access_model.GetUserRepoPermission(ctx, run.Repo, doer)
return &api.ActionRun{
ID: run.ID,
Title: run.Title,
Repo: ToRepo(ctx, run.Repo, permissionInRepo),
WorkflowID: run.WorkflowID,
Index: run.Index,
TriggerUser: ToUser(ctx, run.TriggerUser, doer),
ScheduleID: run.ScheduleID,
PrettyRef: run.PrettyRef(),
IsRefDeleted: run.IsRefDeleted,
CommitSHA: run.CommitSHA,
IsForkPullRequest: run.IsForkPullRequest,
NeedApproval: run.NeedApproval,
ApprovedBy: run.ApprovedBy,
Event: run.Event.Event(),
EventPayload: run.EventPayload,
TriggerEvent: run.TriggerEvent,
Status: run.Status.String(),
Started: run.Started.AsTime(),
Stopped: run.Stopped.AsTime(),
Created: run.Created.AsTime(),
Updated: run.Updated.AsTime(),
Duration: run.Duration(),
HTMLURL: run.HTMLURL(),
}
}
// ToActionArtifact converts an AggregatedArtifact to an API ActionArtifact.
// repoAPIURL is the API URL prefix for the repository (e.g. from Repository.APIURL()).
func ToActionArtifact(repoAPIURL string, art *actions_model.AggregatedArtifact) *api.ActionArtifact {
return &api.ActionArtifact{
ID: art.ID,
Name: art.ArtifactName,
SizeInBytes: art.FileSize,
ArchiveDownloadURL: art.APIDownloadURL(repoAPIURL),
Expired: art.Status == actions_model.ArtifactStatusExpired,
RunID: art.RunID,
CreatedAt: art.CreatedUnix.AsTime(),
UpdatedAt: art.UpdatedUnix.AsTime(),
ExpiresAt: art.ExpiredUnix.AsTime(),
}
}
func ToActionRunJob(job *actions_model.ActionRunJob) *api.ActionRunJob {
if job == nil {
return nil
}
return &api.ActionRunJob{
ID: job.ID,
RunID: job.RunID,
Attempt: job.Attempt,
Handle: job.Handle,
RepoID: job.RepoID,
OwnerID: job.OwnerID,
Name: job.Name,
Needs: job.Needs,
RunsOn: job.RunsOn,
TaskID: job.TaskID,
Status: job.Status.String(),
}
}