Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DEVPROD-2731 Update task.status field to reflect a tasks original status #8585

Merged
merged 8 commits into from
Jan 8, 2025
Merged

DEVPROD-2731 Update task.status field to reflect a tasks original status #8585

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d3e5339
Update status to reflect a tasks original status
khelif96 Dec 26, 2024
f0122f1
Update tests
khelif96 Dec 26, 2024
d433393
Update graphql/schema/types/task.graphql
khelif96 Jan 7, 2025
6a4bf95
Merge branch 'main' into DEVPROD-2731-2
khelif96 Jan 7, 2025
7909a9a
Merge branch 'DEVPROD-2731-2' of github.com:khelif96/evergreen into D…
khelif96 Jan 7, 2025
0e9efeb
Update integration tests
khelif96 Jan 7, 2025
747c020
Update task status fields to displayStatus in JSON results
khelif96 Jan 8, 2025
84daa27
Add comment
khelif96 Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions gqlgen.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,8 +460,6 @@ models:
resolver: true
spawnHostLink:
resolver: true
status:
resolver: true
isPerfPluginEnabled:
resolver: true
project:
Expand Down
49 changes: 8 additions & 41 deletions graphql/generated.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 8 additions & 3 deletions graphql/schema/types/task.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ type Task {
activatedTime: Time
ami: String
annotation: Annotation
"""
This is a base task's display status.
"""
baseStatus: String
baseTask: Task
blocked: Boolean!
Expand All @@ -73,6 +76,9 @@ type Task {
details: TaskEndDetail
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is just a sanity checking question, but does anything need to be done to usages of baseStatus or are we OK there?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nothing needs to change to accomplish the goal of the ticket. I added a comment to clarify that it represents the displayStatus.

dispatchTime: Time
displayName: String!
"""
This is a task's display status and is what is commonly used on the UI.
"""
displayStatus: String!
displayOnly: Boolean
displayTask: Task
Expand Down Expand Up @@ -111,10 +117,9 @@ type Task {
spawnHostLink: String
startTime: Time
"""
This is a task's display status and is what is commonly used on the UI.
In future releases this will be migrated to represent the original status of the task
This is a task's original status. It is the status stored in the database, and is distinct from the displayStatus.
"""
status: String! @deprecated(reason: "use displayStatus instead. Status will be migrated to reflect the original status")
status: String!
tags: [String!]!
taskGroup: String
taskGroupMaxHosts: Int
Expand Down
5 changes: 0 additions & 5 deletions graphql/task_resolver.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -557,11 +557,6 @@ func (r *taskResolver) SpawnHostLink(ctx context.Context, obj *restModel.APITask
return nil, nil
}

// Status is the resolver for the status field.
func (r *taskResolver) Status(ctx context.Context, obj *restModel.APITask) (string, error) {
return *obj.DisplayStatus, nil
}

// TaskLogs is the resolver for the taskLogs field.
func (r *taskResolver) TaskLogs(ctx context.Context, obj *restModel.APITask) (*TaskLogs, error) {
canView := hasLogViewPermission(ctx, obj)
Expand Down
2 changes: 1 addition & 1 deletion graphql/tests/mutation/overrideTaskDependencies/queries/no_permissions.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ mutation{
overrideTaskDependencies(taskId: "no_permissions"){
id
execution
status
displayStatus
dependsOn {
name
metStatus
Expand Down
2 changes: 1 addition & 1 deletion graphql/tests/mutation/overrideTaskDependencies/queries/override_task_dependencies.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ mutation{
overrideTaskDependencies(taskId: "t1"){
id
execution
status
displayStatus
dependsOn {
name
metStatus
Expand Down
7 changes: 5 additions & 2 deletions graphql/tests/mutation/overrideTaskDependencies/results.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"overrideTaskDependencies": {
"id": "t1",
"execution": 0,
"status": "will-run",
"displayStatus": "will-run",
"dependsOn": [
{
"name": "a dep",
Expand All @@ -27,7 +27,10 @@
"errors": [
{
"message": "user 'regular_user' does not have permission to 'edit tasks' for the project 'evergreen'",
"path": ["overrideTaskDependencies", "taskId"],
"path": [
"overrideTaskDependencies",
"taskId"
],
"extensions": {
"code": "FORBIDDEN"
}
Expand Down
2 changes: 1 addition & 1 deletion graphql/tests/mutation/restartTask/queries/error_invalid_task_id.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
mutation {
restartTask(taskId: "nonexistent", failedOnly: false) {
status
displayStatus
id
}
}
2 changes: 1 addition & 1 deletion graphql/tests/mutation/restartTask/queries/no_permissions.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
mutation {
restartTask(taskId: "no_permissions", failedOnly: false) {
status
displayStatus
id
}
}
2 changes: 1 addition & 1 deletion graphql/tests/mutation/restartTask/queries/success.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
mutation {
restartTask(taskId: "task1", failedOnly: false) {
status
displayStatus
id
}
}
4 changes: 2 additions & 2 deletions graphql/tests/mutation/restartTask/queries/success_failed_only.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
mutation {
restartTask(taskId: "task3", failedOnly: true) {
id
status
displayStatus
executionTasksFull {
id
status
displayStatus
}
}
}
27 changes: 20 additions & 7 deletions graphql/tests/mutation/restartTask/results.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,12 @@
{
"query_file": "success.graphql",
"result": {
"data": { "restartTask": { "status": "will-run", "id": "task1" } }
"data": {
"restartTask": {
"displayStatus": "will-run",
"id": "task1"
}
}
}
},
{
Expand All @@ -12,8 +17,13 @@
"errors": [
{
"message": "finding project for task 'nonexistent': task not found",
"path": ["restartTask", "taskId"],
"extensions": { "code": "RESOURCE_NOT_FOUND" }
"path": [
"restartTask",
"taskId"
],
"extensions": {
"code": "RESOURCE_NOT_FOUND"
}
}
],
"data": null
Expand All @@ -25,15 +35,15 @@
"data": {
"restartTask": {
"id": "task3",
"status": "will-run",
"displayStatus": "will-run",
"executionTasksFull": [
{
"id": "execution_task_1",
"status": "will-run"
"displayStatus": "will-run"
},
{
"id": "execution_task_2",
"status": "success"
"displayStatus": "success"
}
]
}
Expand All @@ -48,7 +58,10 @@
"errors": [
{
"message": "user 'regular_user' does not have permission to 'edit tasks' for the project 'evergreen'",
"path": ["restartTask", "taskId"],
"path": [
"restartTask",
"taskId"
],
"extensions": {
"code": "FORBIDDEN"
}
Expand Down
2 changes: 1 addition & 1 deletion graphql/tests/mutation/scheduleUndispatchedBaseTasks/queries/generated_tasks.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ mutation {
scheduleUndispatchedBaseTasks(versionId: "5e4ff3abe3c3317e352062e5") {
id
execution
status
displayStatus
}
}
2 changes: 1 addition & 1 deletion graphql/tests/mutation/scheduleUndispatchedBaseTasks/queries/no_permissions.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ mutation {
scheduleUndispatchedBaseTasks(versionId: "9e4ff3abe3c3317e352062e4") {
id
execution
status
displayStatus
}
}
2 changes: 1 addition & 1 deletion graphql/tests/mutation/scheduleUndispatchedBaseTasks/queries/successful_restart.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ mutation {
scheduleUndispatchedBaseTasks(versionId: "spruce_5e4ff3abe3c3317e352062e4") {
id
execution
status
displayStatus
}
}
6 changes: 3 additions & 3 deletions graphql/tests/mutation/scheduleUndispatchedBaseTasks/results.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
{
"id": "base-task-2",
"execution": 0,
"status": "will-run"
"displayStatus": "will-run"
}
]
}
Expand All @@ -22,12 +22,12 @@
{
"id": "base_generated_task",
"execution": 0,
"status": "will-run"
"displayStatus": "will-run"
},
{
"id": "base_generator_task",
"execution": 0,
"status": "will-run"
"displayStatus": "will-run"
}
]
}
Expand Down
2 changes: 1 addition & 1 deletion graphql/tests/task/annotation/queries/annotation.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ query {
taskId: "evergreen_ubuntu1604_test_db_patch_5e823e1f28baeaa22ae00823d83e03082cd148ab_5e4ff3abe3c3317e352062e4_20_02_21_15_13_48"
execution: 0
) {
status
displayStatus
annotation {
taskId
taskExecution
Expand Down
2 changes: 1 addition & 1 deletion graphql/tests/task/annotation/results.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"result": {
"data": {
"task": {
"status": "known-issue",
"displayStatus": "known-issue",
"annotation": {
"taskId": "evergreen_ubuntu1604_test_db_patch_5e823e1f28baeaa22ae00823d83e03082cd148ab_5e4ff3abe3c3317e352062e4_20_02_21_15_13_48",
"taskExecution": 0,
Expand Down
2 changes: 1 addition & 1 deletion graphql/tests/task/displayStatus/results.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"result": {
"data": {
"task": {
"status": "known-issue",
"status": "failed",
"displayStatus": "known-issue"
}
}
Expand Down
2 changes: 1 addition & 1 deletion graphql/tests/version/tasks/queries/all_params.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
blocked
buildVariant
displayName
status
displayStatus
}
count
}
Expand Down
2 changes: 1 addition & 1 deletion graphql/tests/version/tasks/queries/execution_tasks.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
id
executionTasksFull {
id
status
displayStatus
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion graphql/tests/version/tasks/queries/filter_by_base_status.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
baseStatus
baseTask {
id
status
displayStatus
}
displayName
}
Expand Down
2 changes: 1 addition & 1 deletion graphql/tests/version/tasks/queries/filter_by_status.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
data {
id
displayName
status
displayStatus
}
count
}
Expand Down
2 changes: 1 addition & 1 deletion graphql/tests/version/tasks/queries/filter_by_status_multiple.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
tasks(options: { statuses: ["failed", "success"] }) {
data {
id
status
displayStatus
}
count
}
Expand Down
Loading
Loading