Skip to content

/auk

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.

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

Show Status of Collection Progress in Collections Window #270

Closed
greebie opened this Issue Mar 5, 2019 · 9 comments

Comments

Assignees

@ruebot ruebot

Labels
Background jobs Rails enhancement ux
Projects
None yet
Milestone
No milestone
4 participants
@greebie @ruebot @SamFritz @ianmilligan1
@greebie
Copy link
Contributor

greebie commented Mar 5, 2019

Is your feature request related to a problem? Please describe.

When I updated a collection, it was hard to tell whether the job was sent to queue. Currently, the interface only offers information about the time the job finished. This potentially means, that I would not be sure if my request went through and therefore I may continue to request updates, despite the request all ready being processed.

Describe the solution you'd like
Provide a status indicator in the collections window to show where in the jobs process the collection has been provided.

image

For example, a column could be included that says "in queue" if the job is being queued up, "downloading" if the warcs are being downloaded, "analyzing" if the spark jobs are being run and "complete" if the data has been completed.

Describe alternatives you've considered
The status quo is that the status is provided through email.

@ruebot ruebot self-assigned this Mar 5, 2019

@ruebot ruebot added enhancement Background jobs ux Rails labels Mar 5, 2019

@ruebot

This comment has been minimized.

Sign in to view
Copy link
Member

ruebot commented Mar 6, 2019

Here is what I have:

screenshot_2019-03-05 nick ruest s collections archives unleashed

It queries the delayed job table, and returns:

  • Downloading if the queue name is download
  • nothing if the queue name is 'cleanup'
  • Analyzing if it is any of the other queue names
  • nothing if it is not queued

Question 1: Is "Queue" ok for a column name? It might not convey exactly what we're going for.
Question 2: Is the just saying "Downloading" or "Analyzing" fine? Seed jobs aren't relevant here, and the other jobs are either part of the analysis, or saving the warcs for a day or so before deleting.
@SamFritz

This comment has been minimized.

Sign in to view
Copy link
Member

SamFritz commented Mar 6, 2019

This is great @ruebot!

Thoughts on the questions you've posed:

  1. Would "status" work?
  2. I think both of those work perfectly! Is it possible to have something like a "complete" indicator (once everything is done)? Having a final status would allow users to se a difference between collections that still need to be analyzed, and those that have derivatives ready, otherwise the field will be blank if that collection is neither at the downloading or analyzing stage (correct?)
@ruebot

This comment has been minimized.

Sign in to view
Copy link
Member

ruebot commented Mar 6, 2019

  1. Sure. Depends on if we want to change the next column over.
  2. Compete indicator is basically inferred the date in the next column is the next column over.

If we want to add completed, we'll need to add a bit more logic to the first column, and we should probably change the "Analyzed" column to "Date Analyzed".

ruebot added a commit to ruebot/auk that referenced this issue Mar 6, 2019

@ruebot
Add job status column; resolve archivesunleashed#270. 
- Add helper method to get job status
- Update view to show status
- Set Slack notifications to only run in production
Verified
This commit was signed with a verified signature.
@ruebot ruebot Nick Ruest
GPG key ID: 417FAF1A0E1080CD Learn about signing commits
2f24349
@ianmilligan1

This comment has been minimized.

Sign in to view
Copy link
Member

ianmilligan1 commented Mar 6, 2019

Echoing @SamFritz - this looks great. I think "status" works well. I think "Downloading" and "Analyzing" work well as good buckets, and I don't think we want to get more granular than that.

If it is a trivial amount of logic to add "Completed," maybe that's good just to give another visual indicator to our users. But if it isn't, I think the "Analyzed" column certainly implies that the analysis is complete.
@greebie

This comment has been minimized.

Sign in to view
Copy link
Contributor Author

greebie commented Mar 6, 2019

This works really well. I like "status" over queue as well. Only suggestion is whether we want to find font-awesome icons to replace the text (keeping accessibility and other considerations in mind).

Excellent job and turn-around on this, @ruebot. Thanks.
@ruebot

This comment has been minimized.

Sign in to view
Copy link
Member

ruebot commented Mar 6, 2019

If we're good with this, I'll commit and push.

screenshot_2019-03-06 nick ruest s collections archives unleashed
@ianmilligan1

This comment has been minimized.

Sign in to view
Copy link
Member

ianmilligan1 commented Mar 6, 2019

Looks great to me! Thanks @ruebot.
@SamFritz

This comment has been minimized.

Sign in to view
Copy link
Member

SamFritz commented Mar 6, 2019

wow! That looks great @ruebot
@greebie

This comment has been minimized.

Sign in to view
Copy link
Contributor Author

greebie commented Mar 6, 2019

Great!

@ruebot ruebot closed this in 6da2791 Mar 6, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.