canvas_sync 0.16.4 → 0.21.0

data/lib/canvas_sync/job_batches/sidekiq/web/batches_assets/css/styles.less

@@ -0,0 +1,182 @@
+
+@color-green: #25c766;
+@color-darkred: #8f0000;
+@color-red: #e03963;
+@color-yellow: #c4c725;
+
+.code-wrap.batch-context .args-extended {
+    white-space: pre;
+
+    .key {
+        white-space: pre-wrap;
+        margin-left: 2em;
+        text-indent: -2em;
+        display: inline-block;
+    }
+
+    .own {
+        color: @color-green;
+    }
+}
+
+
+.batch-tree {
+    .status-block {
+        .tree-stat {
+            margin: 0 4px;
+    
+            &.pending {
+                color: @color-yellow;
+            }
+            &.failed {
+                color: @color-red;
+            }
+            &.dead {
+                color: @color-darkred;
+            }
+            &.success {
+                color: @color-green;
+            }
+            &.total {
+    
+            }
+        }
+    }
+
+    .text-inactive {
+        color: darken(#fff, 35%);
+        font-size: 80%;
+    }
+
+    .tree-header {
+        position: relative;
+
+        .status-block {
+            position: absolute;
+            bottom: 0;
+            width: 100%;
+
+            margin-right: 8px;
+            font-size: 90%;
+            text-align: right;
+
+            .tree-stat {
+                font-style: italic;
+            }
+        }
+    }
+
+    .tree-entry {
+        > .header {
+            display: flex;
+            align-items: center;
+
+            .header-inner {
+                padding: 4px 0;
+                border-bottom: 1px dashed white;
+                display: flex;
+                align-items: center;
+                flex: 1;
+            }
+
+            &:hover {
+                background-color: rgba(0,0,0,0.20);
+                border-radius: 3px;
+            }
+
+            .row-toggle {
+                width: 16px;
+                height: 16px;
+                text-align: center;
+                align-self: center;
+                border-radius: 50%;
+                border: 1px solid #999;
+                text-decoration: none;
+                margin: 0 4px;
+                font-size: 16px;
+                line-height: 15px;
+
+                &.not_applicable {
+                    opacity: 0;
+                    pointer-events: none;
+                }
+            }
+
+            .main {
+                flex: 1;
+                display: flex;
+                align-items: baseline;
+
+                .bid {
+                    font-family: monospace;
+                    padding: 3px 6px;
+                    background: rgba(0,0,0,0.2);
+                    border-radius: 3px;
+                    font-size: 12px;
+                    margin: 0 12px 0 0;
+
+                    &:hover {
+                        .bid-goto {
+                            display: inline-block;
+                            padding: 0 0 0 4px;
+                            font-size: 200%;
+                            line-height: 10px;
+                            vertical-align: sub;
+                            text-decoration: dotted;
+                        }
+                    }
+
+                    .bid-goto {
+                        display: none;
+                    }
+                }
+            }
+
+            .goto-link {
+                margin: 0 8px;
+                display: inline-block;
+                height: 16px;
+                font-size: 90%;
+                border-bottom: 1px dotted white;
+            }
+
+            .status-label {
+                font-family: monospace;
+                padding: 3px 6px;
+                background: rgba(0,0,0,0.2);
+                border-radius: 3px;
+                font-size: 12px;
+                margin: 0 12px 0 0;
+
+                &.deleted {
+                    background: #99999933;
+                }
+                &.failed, &.complete {
+                    background: #99000033;
+                }
+                &.success {
+                    background: #00990033;
+                }
+            }
+
+            .status-block {
+                width: 12em;
+                text-align: center;
+            }
+        }
+
+        > .subitems {
+            padding-left: 16px;
+
+            >.load-more {
+                padding: 4px 0;
+                text-align: center;
+                border-bottom: 1px dashed white;
+                a {
+                    border-bottom: 1px dotted white;
+                    text-decoration: none;
+                }
+            }
+        }
+    }
+}

data/lib/canvas_sync/job_batches/sidekiq/web/batches_assets/js/batch_tree.js

@@ -0,0 +1,108 @@
+import { h, Component, render } from 'https://unpkg.com/preact?module';
+import htm from 'https://unpkg.com/htm?module';
+import { root_url } from './util.js';
+
+// Initialize htm with Preact
+const html = htm.bind(h);
+
+const StatusBlock = (props) => html`
+  <div class="status-block ${props.class || ''}">
+    ${props.title && props.title + ':'}
+    <span class="tree-stat pending">${props.pending_count}</span>
+    |
+    <span class="tree-stat failed">${props.failed_count}</span>
+    |
+    <span class="tree-stat dead">${props.dead_count}</span>
+    |
+    <span class="tree-stat success">${props.successful_count}</span>
+    /
+    <span class="tree-stat total">${props.total_count}</span>
+  </div>
+`
+
+class TreeLevel extends Component {
+  get bid() {
+    return this.props.data.bid;
+  }
+
+  get batch() {
+    return this.props.data;
+  }
+
+  load_more = async (event) => {
+    event.preventDefault();
+    const l = this.batch.batches.items.length;
+    const resp = await fetch(`${root_url}batches/${this.bid}/tree?slice=${l}:${l + 5 - 1}`)
+    const result = await resp.json()
+    const newEntries = result.batches.items;
+    for (let ent of newEntries) {
+      this.batch.batches.items.push(ent)
+    }
+    this.forceUpdate()
+  }
+
+  toggle = (event) => {
+    event.preventDefault();
+    this.setState({ collapsed: !this.state.collapsed })
+  }
+
+  render() {
+    const { data: bd } = this.props;
+
+    let sub_entries = [];
+    let sub_batches = bd.batches.items;
+    for (let b of sub_batches) {
+      sub_entries.push(html`<${TreeLevel} data=${b} />`)
+    }
+
+    let fully_loaded = !(sub_batches.length < bd.batches.total_count);
+
+    const load_more_elem = html`<div class="load-more">
+      ${sub_entries.length} / ${bd.batches.total_count} Items Loaded - <a href="#" onClick=${this.load_more}>Load More</a>
+    </div>`
+
+    return html`<div class="tree-entry tree-batch">
+      <div class="header">
+        <a class="row-toggle ${!bd.batches.total_count && 'not_applicable'}" onClick=${this.toggle} href="#">
+          ${this.state.collapsed ? '+' : '-'}
+        </a>
+
+        <div class="header-inner">
+          <div class="main">
+            <span class="bid">
+              ${bd.bid}
+              <a class="bid-goto" href="${root_url}batches/${bd.bid}">⇢</a>
+            </span>
+            ${bd.description || (bd.status == 'deleted' && html`<i class="text-inactive">Deleted</i>`) || html`<i class="text-inactive">No Description</i>`}
+          </div>
+
+          <span class="status-label ${bd.status}">${bd.status}</span>
+
+          ${bd.status != 'deleted' && html`
+            <${StatusBlock} class="job-status" title="Jobs" ...${bd.jobs} />
+            <${StatusBlock} class="batch-status" title="Batches" ...${bd.batches} />
+          `}
+        </div>
+      </div>
+
+      <div class="subitems ${this.state.collapsed ? 'hidden' : ''}">
+        ${sub_entries}
+        ${!fully_loaded && load_more_elem}
+      </div>
+    </div>`
+  }
+}
+
+class TreeRoot extends Component {
+  render() {
+    const tree_data = JSON.parse(document.querySelector('#batch-tree #initial-data').innerHTML);
+    return html`
+      <div class="tree-header">
+        <${StatusBlock} pending_count="pending" failed_count="failed" dead_count="dead" successful_count="successful" total_count="total" />
+      </div>
+      <${TreeLevel} data=${tree_data} />
+    `;
+  }
+}
+
+render(html`<${TreeRoot} />`, document.querySelector('#batch-tree'));

data/lib/canvas_sync/job_batches/sidekiq/web/batches_assets/js/util.js

@@ -0,0 +1,2 @@
+
+export const root_url = (document.querySelector('meta[name="sidekiq-baseurl"]')).content;

data/lib/canvas_sync/job_batches/sidekiq/web/helpers.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module CanvasSync::JobBatches::Sidekiq
+  module Web
+    module Helpers
+      VIEW_PATH    = File.expand_path("../web/views", __dir__)
+
+      module_function
+
+      def get_template(name)
+        File.open(File.join(VIEW_PATH, "#{name}.erb")).read
+      end
+
+      def drain_zset(key)
+        items, _ = CanvasSync::JobBatches::Batch.redis do |r|
+          r.multi do |r|
+            r.zrange(key, 0, -1)
+            r.zremrangebyrank(key, 0, -1)
+          end
+        end
+        yield items
+      end
+
+      def safe_relative_time(time)
+        time = parse_time(time)
+        relative_time(time)
+      end
+
+      def parse_time(time)
+        case time
+        when Time
+          time
+        when Integer, Float
+          Time.at(time)
+        else
+          Time.parse(time.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/canvas_sync/job_batches/sidekiq/web/views/_batch_tree.erb

@@ -0,0 +1,6 @@
+
+<div id="batch-tree" class="batch-tree">
+    <script id="initial-data" type="application/json"><%= @tree_data.to_json %></script>
+</div>
+
+<script type="module" src="<%= root_path %>batches_assets/js/batch_tree.js"></script>

data/lib/canvas_sync/job_batches/sidekiq/web/views/_batches_table.erb

@@ -0,0 +1,44 @@
+<table class="table table-striped table-bordered table-hover">
+    <thead>
+        <tr>
+            <th rowspan="2"><%= t('Started') %></th>
+            <th rowspan="2"><%= t('BID') %></th>
+            <th rowspan="2"><%= t('Description') %></th>
+
+            <th colspan="5"><%= t('Jobs') %></th>
+            <th colspan="4"><%= t('Sub-Batches') %></th>
+        </tr>
+        <tr>
+            <th><%= t('Pending') %></th>
+            <th><%= t('Failed') %></th>
+            <th><%= t('Dead') %></th>
+            <th><%= t('Complete') %></th>
+            <th><%= t('Total') %></th>
+
+            <th><%= t('Pending') %></th>
+            <th><%= t('Failed') %></th>
+            <th><%= t('Success') %></th>
+            <th><%= t('Total') %></th>
+        </tr>
+    </thead>
+
+    <% batches.each do |batch| %>
+        <% status = CanvasSync::JobBatches::Batch::Status.new(batch) %>
+        <tr>
+            <td><%= safe_relative_time(batch.created_at.to_f) %></th>
+            <td><a href="<%= root_path %>batches/<%= batch.bid %>"><%= batch.bid %></a></td>
+            <td><%= batch.description %></th>
+
+            <td><%= status.pending %></th>
+            <td><%= status.failures %></th>
+            <td><%= status.dead %></th>
+            <td><%= status.completed_count %></th>
+            <td><%= status.job_count %></th>
+
+            <td><%= status.child_count - status.successful_children_count %></th>
+            <td><%= status.failed_children_count %></th>
+            <td><%= status.successful_children_count %></th>
+            <td><%= status.child_count %></th>
+        </tr>
+    <% end %>
+</table>

data/lib/canvas_sync/job_batches/sidekiq/web/views/_common.erb

@@ -0,0 +1,13 @@
+
+<% add_to_head do %>
+    <meta name="sidekiq-baseurl" content="<%= root_path %>" />
+    <% if dev_mode? %>
+        <link href="<%= root_path %>batches_assets/css/styles.less" media="screen" rel="stylesheet/less" type="text/css" />
+        <script async type="text/javascript" src="https://unpkg.com/less@4.1.1/dist/less.js" data-async="true"></script>
+    <% else %>
+        <link href="<%= root_path %>batches_assets/css/styles.less" media="screen" rel="stylesheet/less" type="text/css" />
+        <script async type="text/javascript" src="https://unpkg.com/less@4.1.1/dist/less.js" data-async="true"></script>
+        <%# TODO: Pre-compile LESS %>
+        <!-- <link href="<%= root_path %>batches_assets/css/styles.css" media="screen" rel="stylesheet" type="text/css" /> -->
+    <% end %>
+<% end %>

data/lib/canvas_sync/job_batches/sidekiq/web/views/_jobs_table.erb

@@ -0,0 +1,21 @@
+<table class="table table-striped table-bordered table-hover">
+    <thead>
+        <tr>
+            <th><%= t('JID') %></th>
+            <th><%= t('Job Class') %></th>
+            <th><%= t('Parameters') %></th>
+        </tr>
+    </thead>
+
+    <% @jobs.each do |job_desc| %>
+        <tr>
+            <td><%= job_desc[:jid] %></td>
+            <td><%= job_desc['job'] %></td>
+            <td>
+                <code class="code-wrap">
+                    <div class="args-extended"><%= job_desc['parameters'].to_json  %></div>
+                </code>
+            </td>
+        </tr>
+    <% end %>
+</table>

data/lib/canvas_sync/job_batches/sidekiq/web/views/_pagination.erb

@@ -0,0 +1,26 @@
+
+<% if @total_size > @count %>
+  <ul class="pagination pull-right flip">
+    <% _page_key = defined?(page_key) ? page_key.to_s : 'page' %>
+
+    <li class="<%= 'disabled' if @current_page == 1 %>">
+      <a href="<%= url %>?<%= _page_key %>=1">&laquo;</a>
+    </li>
+    <% if @current_page > 1 %>
+      <li>
+        <a href="<%= url %>?<%= (qparams(page: @current_page - 1) || '').gsub('page', _page_key) %>"><%= @current_page - 1 %></a>
+      </li>
+    <% end %>
+    <li class="disabled">
+      <a href="<%= url %>?<%= (qparams(page: @current_page) || '').gsub('page', _page_key) %>"><%= @current_page %></a>
+    </li>
+    <% if @total_size > @current_page * @count %>
+      <li>
+        <a href="<%= url %>?<%= (qparams(page: @current_page + 1) || '').gsub('page', _page_key) %>"><%= @current_page + 1 %></a>
+      </li>
+    <% end %>
+    <li class="<%= 'disabled' if @total_size <= @current_page * @count %>">
+      <a href="<%= url %>?<%= (qparams(page: (@total_size.to_f / @count).ceil) || '').gsub('page', _page_key) %>">&raquo;</a>
+    </li>
+  </ul>
+<% end %>

data/lib/canvas_sync/job_batches/sidekiq/web/views/batch.erb

@@ -0,0 +1,81 @@
+<%= erb get_template(:_common) %>
+
+<h3><%= t('Batch') %></h3>
+<% status = CanvasSync::JobBatches::Batch::Status.new(@batch) %>
+
+<div class="table_container">
+    <table class="table table-striped table-bordered table-white table-hover">
+        <tbody>
+            <tr>
+                <th colspan="2" scope=row><%= t('Batch') %></td>
+                <td><%= @batch.bid %></td>
+            </tr>
+            <tr>
+                <th colspan="2" scope=row><%= t('Parent') %></td>
+                <td>
+                    <% if @batch.parent_bid.present? %>
+                        <a href="<%= root_path %>batches/<%= @batch.parent_bid %>"><%= @batch.parent_bid %></a>
+                    <% else %>
+                        ROOT
+                    <% end %>
+                </td>
+            </tr>
+            <tr>
+                <th colspan="2" scope=row><%= t('Started') %></td>
+                <td><%= safe_relative_time(@batch.created_at.to_f) %></td>
+            </tr>
+            <tr>
+                <th colspan="2" scope=row><%= t('Description') %></td>
+                <td><%= @batch.description %></td>
+            </tr>
+            <tr>
+                <th colspan="2" scope=row><%= t('Context') %></td>
+                <td>
+                    <code class="code-wrap batch-context">
+                        <div class="args-extended"><%= format_context(@batch) %></div>
+                    </code>
+                </td>
+            </tr>
+        </tbody>
+    </table>
+</div>
+
+<header class="row">
+    <div class="col-sm-5">
+        <h3>
+            <%= t('Child Batches') %>
+        </h3>
+    </div>
+</header>
+
+<%= erb get_template(:_batch_tree), locals: { } %>
+
+<header class="row">
+    <div class="col-sm-5">
+        <h3>
+            <%= t('Jobs') %>
+            <i>(Queued and Current)</i>
+        </h3>
+    </div>
+    <%
+        @current_page = @current_jobs_page
+        @total_size = @total_jobs_size
+    %>
+    <% if @jobs.any? && @total_size > @count.to_i %>
+        <div class="col-sm-4">
+            <%= erb get_template(:_pagination), locals: { url: "#{root_path}batches/#{@batch.bid}", page_key: :job_page } %>
+        </div>
+    <% end %>
+</header>
+
+<% if @jobs.any? %>
+<div class="table_container">
+    <%= erb get_template(:_jobs_table), locals: { jobs: @jobs } %>
+</div>
+<% end %>
+
+<form class="form-horizontal" action="<%= root_path %>batches/<%= @batch.bid %>" method="post">
+    <%= csrf_tag %>
+    <a class="btn btn-default" href="<%= root_path %>batches"><%= t('GoBack') %></a>
+    <input class="btn btn-danger" type="submit" name="delete" value="<%= t('Delete') %>" data-confirm="<%= t('AreYouSure') %>" />
+</form>

data/lib/canvas_sync/job_batches/sidekiq/web/views/batches.erb

@@ -0,0 +1,23 @@
+<header class="row">
+    <div class="col-sm-5">
+        <h3>
+            <%= t('Batches') %>
+        </h3>
+    </div>
+    <% if @batches.any? && @total_size > @count.to_i %>
+        <div class="col-sm-4">
+            <%= erb get_template(:_pagination), locals: { url: "#{root_path}batches" } %>
+        </div>
+    <% end %>
+</header>
+
+<% if @batches.any? %>
+<div class="table_container">
+    <%= erb get_template(:_batches_table), locals: { batches: @batches } %>
+</div>
+<% end %>
+
+<form action="<%= root_path %>batches/all" method="post">
+    <%= csrf_tag %>
+    <input class="btn btn-danger btn-xs pull-right flip" type="submit" name="delete" value="<%= t('DeleteAll') %>" data-confirm="<%= t('AreYouSure') %>" />
+</form>