Run now dialog improvements by Calvinp · Pull Request #977 · HubSpot/Singularity

Calvinp · 2016-03-29T18:33:37Z

This makes big changes to the run now dialog UX, and even bigger changes behind the scenes to enable this.

UX improvements

Fix a bug in which the run now button didn't work when clicked from the pending tasks page
The checkbox to automatically tail logs has been converted into radio buttons. The options are stay on the request's page (previous default behavior), tail logs, or browse to the task's page (new default option and what will be selected for you the first time you refresh after this is merged)
These radio buttons will remember your previous choice and default you to that choice
If you don't have automatically tail logs selected, the input box to specify a file to tail will be disabled
The input box to specify a file to tail will have 'service.log' filled in for you. If you write in something else, it will from then on fill that in for you instead. It uses local storage for this.
If you're automatically tailing logs, and the poller detects that the task you're polling is in a terminal state but the log you're looking for doesn't exist yet, it will give a more descriptive message in the popup.
Fix a bug in which the global constant defining the task poller timeout was completely ignored, and the timeout was instead set to one minute. But the user was told that the constant (5 minutes) was used, so it appeared to the user as if they had somehow lost 4 minutes of their life watching the poller.
Fix a bug in which the command line args weren't populated from localStorage
Change the command line args to populate from the last task run that request instead of localStorage

Behind the scenes UI changes

The code for the run now dialog was a huge mess riddled with bugs. This makes most of that better.
The promptRerun function in the request model has been vanquished. Instead, promptRun takes an optional task parameter, and if that parameter is specified it reruns the given task.
The logic to start the poller to automatically tail logs is now implemented by promptRun. It used to be that the caller would need to open the autotailer, and several callers didn't. So the autotailer wouldn't work if the task run button was pressed in certain places.
The poller to automatically detect when a task exists and its files exist totail logs has been enhanced. Now it takes a pollingType variable. If this type is 'autoTail', it does what it used to do. If it's 'browse-to-sandbox', it will instead direct you to a task's page when the task starts. It has been renamed from AutoTailer to TaskPoller, which is a much more accurate name for what it does. Several of its supporting templates have also been renamed. Many internal methods and variables have also been renamed. Unfortunately, with all the renamed variables, the diff is so different that Git wasn't able to detect that this is a rename - instead believing that these are all new files.
The poller also now uses runId to track a task rather than watching for a reset event, which sometimes missed certain tasks.

Backend change

@ssalinas added an API for retrieving running tasks by run id.

…alog on submit if we're tracking the task

…ow run from request.promptRun rather than each time that function is called.

…ges to the poller that directed to the log tailer to enable this without absurd duplication of code

zdhickman · 2016-03-29T18:38:28Z

+            commands = if lastCommands? then lastCommands[lastCommands.length - 1] else []
        vex.dialog.prompt
-            message: "<h3>Run Task</h3>"
+            message: "<h3>#{if task then 'Rer' else 'R'}un Task</h3>"


nothing wrong with this logically, but for the sake of clarity in the code, maybe:

#{if task then 'Rerun' else 'Run'} Task

ssalinas · 2016-03-29T19:01:53Z

-                $('#filename').val localStorage.getItem('taskRunRedirectFilename')
-                $('#autoTail').prop 'checked', (localStorage.getItem('taskRunAutoTail') is 'on')
+                taskRunAfterStart = localStorage.getItem('taskRunAfterStart')
+                $('#filename').val localStorage.getItem('taskRunRedirectFilename') or 'service.log'


service.log is a very internal thing for us, if not using our executor the log file will be stdout or some other file. I believe we have this already somewhere, but there should be a configurable default log file we can put here instead

It remembers your previous choice and puts it in there, so it might be ok to not actually have any default.

Oh, I got that from the placeholder text, which is currently 'e.g. service.log'. But that's a constant, not configurable atm.

Ok, the configuration exists and is now being used.

…Path

Calvinp · 2016-03-30T13:09:16Z

-<p><label class='label-light'><input id="autoTail" name="autoTail" type="checkbox"> Wait for task to start, then start tailing:</label></p>
+<strong>After triggering the run:</strong>
+<p>
+    <label class='label-light'><input id="stay-on-request-page" name="afterStart" type="radio" value="stay-on-request-page"> Stay on this request's page</label>


I'm going to take out the word "request's" here because the dialog can be accessed from pages other than just a request page.

ssalinas · 2016-03-30T19:02:17Z

+                message: "<h3>#{if task then 'Rerun' else 'Run'} Task</h3>"
+                input: runTemplate
+                    id: @get "id"
+                    prefix: @localStorageCommandLineInputKeyPrefix


do we still need this prefix if we aren't using localStorage for populating args anymore?

Nope! It's gone.

…e arg population has been nuked

ssalinas · 2016-03-30T19:09:45Z

                setTimeout ( => @trigger 'refreshrequest'), 2500
+        if taskId
+            task = new TaskHistory {taskId}
+            task.fetch()


we already have the task history fetched on this page, is there not a way we can use the data we already have?

Unfortunately, that's not inherently true. While it is true if you're running from the individual request's page, you may also be running the request from the list of requests page, or from the pending tasks page.

Edited to clarify

ssalinas · 2016-03-31T13:06:12Z

+            "#{ config.apiRoot }/history/request/#{ @requestId }/run/#{ @runId }"
+        else
+            # Currently the above URL is the ONLY place to fetch this model.
+            # If you don't have access to request ID and run ID use the TaskHistory


once we have the taskId, we can also fetch this using that. I know the main use case with be by runId, but just wanted to clarify

When you fetch by taskId, you get a different model as a response. That gives back a SingularityTaskHistory (which is the TaskHistory model in the UI), wheras searching by runId returns a SingularityTaskIdHistory (Which is this model in the UI). In a roundabout way, you can use Task Search to search out this model by taskId, but then you'd be fetching the collection rather than the model.

…ssage to tell user to ignore expected http 404 error

…rrect file; Text box for file to tail is disabled, not hidden, when a different box is clicked

…rowse to task sandbox' checked

…g tasks page

…e pending tasks page" This reverts commit 857c495. It broke the build

Calvin Pomerantz added 7 commits March 24, 2016 15:42

Merge branch 'master' into run-now-dialog-improvements

dd62b3a

Run now dialog options UI implemented but they don't yet do anything

ad41a24

Create a runId in the UI (rather than let the API do it) in runNow di…

713a5bd

…alog on submit if we're tracking the task

Fix for run now button broken for pending tasks. Also Autotailer is n…

3c247cb

…ow run from request.promptRun rather than each time that function is called.

Add ability to open up a task's page once it starts running. Big chan…

ae8e2d6

…ges to the poller that directed to the log tailer to enable this without absurd duplication of code

Merge branch 'master' into run-now-dialog-improvements

7d2f421

Browse to sandbox by default

02cf54d

zdhickman reviewed Mar 29, 2016
View reviewed changes

Clearer code for displaying 'Run' or 'Rerun'

715e18b

ssalinas reviewed Mar 29, 2016
View reviewed changes

Calvin Pomerantz added 2 commits March 29, 2016 15:08

Better wording for browse to sandbox option

741e82e

Default filename for run now is now the name of config.runningTaskLog…

174069f

…Path

Calvinp added the hs_staging label Mar 30, 2016

Calvinp reviewed Mar 30, 2016
View reviewed changes

Calvin Pomerantz added 5 commits March 30, 2016 09:14

Change wording of 'stay on page' option to take out the word 'request'

9c8af8e

Change wording of 'stay on page' option to take out the word 'request'

150b47a

Fix task poller timeout constant ignored bug

0ff49d6

Fix awkward wording

f847347

Autopopulate command line args from last run task if not rerunning

ed894db

ssalinas reviewed Mar 30, 2016
View reviewed changes

We don't need the prefix parameter since the localStorage command lin…

a14b879

…e arg population has been nuked

ssalinas reviewed Mar 30, 2016
View reviewed changes

Poll for historical tasks by runId instead of by reset event

43a6966

ssalinas reviewed Mar 31, 2016
View reviewed changes

Calvin Pomerantz and others added 3 commits March 31, 2016 09:44

Better calculation of minutes to milliseconds for timeout; Smaller me…

096a89b

…ssage to tell user to ignore expected http 404 error

draft of endpoint to fetch active task by runId

688d659

Poll for running tasks like for completed tasks

481785f

Calvin Pomerantz added 5 commits March 31, 2016 16:50

Detects if task has entered terminal state and will never have the co…

2dd46b8

…rrect file; Text box for file to tail is disabled, not hidden, when a different box is clicked

No fun allowed in user messages

7f7e5db

Better message for task in terminal state and file not found

acbc6a9

Bug fix

eb0c767

Fix bug that caused file to revert to undefined after running with 'b…

74c161f

…rowse to task sandbox' checked

Calvinp added the hs_qa label Apr 1, 2016

ssalinas modified the milestone: 0.4.12 Apr 1, 2016

Calvin Pomerantz added 3 commits April 1, 2016 14:47

Re-fix bug that prevented run now dialog from opening from the pendin…

857c495

…g tasks page

Revert "Re-fix bug that prevented run now dialog from opening from th…

40a0895

…e pending tasks page" This reverts commit 857c495. It broke the build

This should actually fix the run now button on the scheduled tasks page

3e1e910

Calvinp added the hs_stable label Apr 4, 2016

Fix bug that was stopping autotailer from loading

9e22341

ssalinas merged commit 5ad8737 into master Apr 5, 2016

ssalinas deleted the run-now-dialog-improvements branch April 5, 2016 15:28

ssalinas removed hs_qa labels Apr 5, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Run now dialog improvements#977

Run now dialog improvements#977
ssalinas merged 29 commits into
masterfrom
run-now-dialog-improvements

Calvinp commented Mar 29, 2016

Uh oh!

zdhickman Mar 29, 2016

Uh oh!

ssalinas Mar 29, 2016

Uh oh!

Calvinp Mar 29, 2016

Uh oh!

Calvinp Mar 29, 2016

Uh oh!

Calvinp Mar 29, 2016

Uh oh!

Calvinp Mar 30, 2016

Uh oh!

ssalinas Mar 30, 2016

Uh oh!

Calvinp Mar 30, 2016

Uh oh!

ssalinas Mar 30, 2016

Uh oh!

Calvinp Mar 30, 2016

Uh oh!

ssalinas Mar 31, 2016

Uh oh!

Calvinp Mar 31, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

Calvinp commented Mar 29, 2016

UX improvements

Behind the scenes UI changes

Backend change

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants