Skip to content

fix(ui): improve traceback window usability #3438

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

Open
Ipsita-Mondal-30 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(ui): improve traceback window usability #3438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 39 additions & 0 deletions luigi/static/visualiser/css/luigi.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,3 +238,42 @@ span.status-icon {
.popover{
max-width: 100% !important;
}

#errorModal .modal-error-traceback {
width: 90vw;
max-width: 90vw;
}

#errorModal.error-modal-expanded .modal-error-traceback {
width: 98vw;
max-width: 98vw;
margin: 1vh auto;
}

#errorModal.error-modal-expanded .modal-content {
min-height: 96vh;
}

#errorModal .traceback-modal-actions {
margin-bottom: 8px;
}

#errorModal .traceback-section-label {
font-weight: 600;
margin: 8px 0 4px;
}

#errorModal .traceback-content,
#errorModal .rerun-command {
max-height: 35vh;
user-select: text;
-webkit-user-select: text;
white-space: pre-wrap;
word-break: break-word;
overflow: auto;
}

#errorModal.error-modal-expanded .traceback-content,
#errorModal.error-modal-expanded .rerun-command {
max-height: 42vh;
}
16 changes: 10 additions & 6 deletions luigi/static/visualiser/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<title>Luigi Task Visualiser</title>
<link href="css/luigi.css" rel="stylesheet">
<link href="css/luigi.css?v=traceback-ui-2" rel="stylesheet">
<script src="lib/jquery-1.10.0.min.js"></script>
<link href="lib/bootstrap3/css/bootstrap.min.css" rel="stylesheet">
<link href="lib/bootstrap3/css/bootstrap-theme.min.css" rel="stylesheet">
Expand All @@ -19,7 +19,7 @@
<script src="js/util.js"></script>
<script src="js/luigi.js"></script>
<script src="js/graph.js"></script>
<script src="js/visualiserApp.js"></script>
<script src="js/visualiserApp.js?v=traceback-ui-2"></script>
<script src="js/tipsy.js"></script>
<script src="lib/jquery.slimscroll.min.js"></script>
<script src="lib/AdminLTE/js/app.min.js"></script>
Expand Down Expand Up @@ -47,16 +47,20 @@
</div>
</script>
<script type="text/template" name="errorTemplate">
<div class="modal-dialog">
<div class="modal-dialog modal-lg modal-error-traceback">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
<h4 class="modal-title" id="myModalLabel">Traceback for {{displayName}}</h4>
</div>
<div class="modal-body">
<pre class="pre-scrollable">{{error}}</pre>
Command to re-run:
<pre class="pre-scrollable">luigi --module {{taskModule}} {{taskFamily}} {{taskParams}}</pre>
<div class="traceback-modal-actions">
<button type="button" class="btn btn-default btn-sm" id="toggleErrorModalSize">Expand</button>
</div>
<div class="traceback-section-label">Runtime error:</div>
<pre class="pre-scrollable traceback-content js-select-on-open" tabindex="0">{{error}}</pre>
<div class="traceback-section-label">Command to re-run:</div>
<pre class="pre-scrollable rerun-command js-select-on-open" tabindex="0">luigi --module {{taskModule}} {{taskFamily}} {{taskParams}}</pre>
</div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
Expand Down
46 changes: 44 additions & 2 deletions luigi/static/visualiser/js/visualiserApp.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,8 +328,50 @@ function visualiserApp(luigi) {
if (data.taskParams) {
data.taskParams = Object.entries(data.taskParams).map(([k,v]) => `--${k.replace(/_/g, '-')} ${JSON.stringify(v)}`).join(" ");
}
$("#errorModal").empty().append(renderTemplate("errorTemplate", data));
$("#errorModal").modal({});
var $errorModal = $("#errorModal");
$errorModal.addClass("error-modal-expanded");
$errorModal.empty().append(renderTemplate("errorTemplate", data));

$errorModal.on("click", "#toggleErrorModalSize", function () {
var expanded = $errorModal.toggleClass("error-modal-expanded").hasClass("error-modal-expanded");
$(this).text(expanded ? "Shrink" : "Expand");
});

$errorModal.on("shown.bs.modal", function () {
$errorModal.find("#toggleErrorModalSize").text("Shrink");
$errorModal.find(".js-select-on-open").first().focus();
});

// Keep Ctrl/Cmd+A scoped to the focused traceback block.
$errorModal.on("keydown", ".js-select-on-open", function (event) {
if ((event.ctrlKey || event.metaKey) && (event.key === "a" || event.key === "A")) {
var selection = window.getSelection();
var range = document.createRange();
range.selectNodeContents(this);
selection.removeAllRanges();
selection.addRange(range);
event.preventDefault();
}
});

// If focus is elsewhere in the modal, Ctrl/Cmd+A should still target traceback text.
$errorModal.on("keydown", function (event) {
if ((event.ctrlKey || event.metaKey) && (event.key === "a" || event.key === "A")) {
if (!$(event.target).closest(".js-select-on-open").length) {
var tracebackElement = $errorModal.find(".traceback-content").get(0);
if (tracebackElement) {
var selection = window.getSelection();
var range = document.createRange();
range.selectNodeContents(tracebackElement);
selection.removeAllRanges();
selection.addRange(range);
event.preventDefault();
}
}
}
});

$errorModal.modal({});
}

function showStatusMessage(data) {
Expand Down
Loading