ansible/awx

Jobs canceled before starting should not show a "finished" time

Open

#3,988 opened on Jun 3, 2019

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (13,071 stars) (3,333 forks)batch import
Hacktoberfestcomponent:apigood first issuetype:bug

Description

ISSUE TYPE
  • Bug Report
SUMMARY

Confusing UI if you cancel a job while it is still in "pending" state, caused by API behavior.

ENVIRONMENT
  • AWX version: 4.0.0
  • AWX install method: openshift, minishift, docker on linux, docker for mac, boot2docker
  • Ansible version: X.Y.Z
  • Operating System:
  • Web Browser:
STEPS TO REPRODUCE

Launch a job that is blocked by some other job, so it remains in "pending" (or send to an instance group with no capacity), and then cancel it.

EXPECTED RESULTS

Mostly null fields related to started, finished, etc.

The job never started and never finished.

ACTUAL RESULTS

The UI shows that the job finished, see 7844

Screen Shot 2019-06-03 at 8 50 50 AM

ADDITIONAL INFORMATION

Caused by the API fields.

    "scm_type": "git",
    "scm_url": "https://github.com/ansible/test-playbooks.git",
    "scm_branch": "",
    "scm_clean": false,
    "scm_delete_on_update": false,
    "credential": null,
    "timeout": 0,
    "unified_job_template": 3838,
    "launch_type": "manual",
    "status": "canceled",
    "failed": true,
    "started": null,
    "finished": "2019-06-03T12:39:05.272329Z",
    "elapsed": 0.0,
    "job_args": "",
    "job_cwd": "",
    "job_env": {},
    "job_explanation": "",
    "execution_node": "",
    "result_traceback": "",
    "event_processing_finished": true,
    "project": 3838,
    "job_type": "check",

Expectation is that the finished field should remain null.

Previously @ryanpetrello made the suggestion

Seems like if we really wanted to have accurate data, we'd want another column to record the "canceled_on" datestamp.

This issue also makes the argument for an independent field to track canceled time. (but we may prefer to track that as a separate enhancement)

Contributor guide

Tech stack
pythondjangorest api
Domain
backendfrontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
AWX job lifecycleDjango REST framework
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue is that the API returns a non null 'finished' timestamp for jobs that were canceled before starting. The fix likely involves modifying the job model or serializer to set 'finished' to null when a job is canceled in 'pending' state. The suggestion of adding a separate 'canceled on' field is also mentioned. Start by examining the job model in awx/main/models/jobs.py and the serializer in awx/api/serializers.py. Check the logic that sets the finished field during cancellation. Additionally, review the UI component that displays the finished time to ensure it handles null values correctly.