Project

Profile

Help

Story #5184

Provide identifier within sync task progress_reports

Added by jsherril@redhat.com 3 months ago. Updated 19 days ago.

Status:
MODIFIED
Priority:
Normal
Category:
API
Sprint/Milestone:
-
Start date:
Due date:
% Done:

100%

Platform Release:
Blocks Release:
Backwards Incompatible:
No
Groomed:
Yes
Sprint Candidate:
Yes
Tags:
Katello-P3
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:
Sprint 60

Description

Problem

Currently the progress reports on a sync task look like this:

      progress_reports:
      - message: Downloading Metadata
        state: running
        total: 10
        done: 5
        suffix:
      - message: Downloading Artifacts
        state: running
        total: 10
        done: 5
        suffix:
      - message: Associating Content
        state: running
        total: 10
        done: 5
        suffix:

when trying to parse these, we have to use the 'message' field which is english text. This text is internationalized and could be different system, to system, or if a user changes their language settings post installation.

It would be better if there was some 'key' that we could use such as 'associate.content' that we could be assured would never change or be affected by internationalization.

Solution

Add a required field to ProgressReport named code that stores a 36 character long string. The intent of this string is that it identifies that type of progress report. It's different than the pk of the progress report which is different between two runs of the same task. This ID would be the same for all runs of that task code. It would not be internationalized.

36 is chosen in case the user wants to store UUIDs in this field.

Associated revisions

History

#1 Updated by bmbouter 3 months ago

  • Tracker changed from Issue to Story
  • Subject changed from provide identifier within sync task progress_reports to Provide identifier within sync task progress_reports
  • Description updated (diff)
  • % Done set to 0

#2 Updated by bmbouter 3 months ago

  • Description updated (diff)

Updating to code after some IRC discussion w/ @daviddavis

#3 Updated by daviddavis 3 months ago

  • Groomed changed from No to Yes
  • Sprint Candidate changed from No to Yes

#4 Updated by rchan 2 months ago

  • Sprint set to Sprint 57

#5 Updated by rchan about 2 months ago

  • Sprint changed from Sprint 57 to Sprint 58

#6 Updated by fabricio.aguiar about 1 month ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to fabricio.aguiar

#8 Updated by rchan about 1 month ago

  • Sprint changed from Sprint 58 to Sprint 59

#9 Updated by Anonymous about 1 month ago

  • Status changed from POST to MODIFIED
  • % Done changed from 0 to 100

#10 Updated by daviddavis about 1 month ago

  • Status changed from MODIFIED to POST

#11 Updated by rchan 19 days ago

  • Sprint changed from Sprint 59 to Sprint 60

#12 Updated by fabricio.aguiar 19 days ago

  • Status changed from POST to MODIFIED

Please register to edit this issue

Also available in: Atom PDF