build.js 10.5 KB
Newer Older
1
/* eslint-disable func-names, space-before-function-paren, no-var, prefer-rest-params, wrap-iife, no-use-before-define, no-param-reassign, quotes, yoda, no-else-return, consistent-return, comma-dangle, object-shorthand, prefer-template, one-var, one-var-declaration-per-line, no-unused-vars, max-len, vars-on-top */
2 3
/* global Breakpoints */

4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
var bind = function(fn, me) { return function() { return fn.apply(me, arguments); }; };
var AUTO_SCROLL_OFFSET = 75;
var DOWN_BUILD_TRACE = '#down-build-trace';

window.Build = (function() {
  Build.timeout = null;

  Build.state = null;

  function Build(options) {
    options = options || $('.js-build-options').data();
    this.pageUrl = options.pageUrl;
    this.buildUrl = options.buildUrl;
    this.buildStatus = options.buildStatus;
    this.state = options.logState;
    this.buildStage = options.buildStage;
    this.updateDropdown = bind(this.updateDropdown, this);
    this.$document = $(document);
    this.$body = $('body');
    this.$buildTrace = $('#build-trace');
    this.$autoScrollContainer = $('.autoscroll-container');
    this.$autoScrollStatus = $('#autoscroll-status');
    this.$autoScrollStatusText = this.$autoScrollStatus.find('.status-text');
    this.$upBuildTrace = $('#up-build-trace');
    this.$downBuildTrace = $(DOWN_BUILD_TRACE);
    this.$scrollTopBtn = $('#scroll-top');
    this.$scrollBottomBtn = $('#scroll-bottom');
    this.$buildRefreshAnimation = $('.js-build-refresh');

    clearTimeout(Build.timeout);
    // Init breakpoint checker
    this.bp = Breakpoints.get();

    this.initSidebar();
    this.$buildScroll = $('#js-build-scroll');

    this.populateJobs(this.buildStage);
    this.updateStageDropdownText(this.buildStage);
    this.sidebarOnResize();

    this.$document.off('click', '.js-sidebar-build-toggle').on('click', '.js-sidebar-build-toggle', this.sidebarOnClick.bind(this));
    this.$document.off('click', '.stage-item').on('click', '.stage-item', this.updateDropdown);
    this.$document.on('scroll', this.initScrollMonitor.bind(this));
    $(window).off('resize.build').on('resize.build', this.sidebarOnResize.bind(this));
    $('a', this.$buildScroll).off('click.stepTrace').on('click.stepTrace', this.stepTrace);
    this.updateArtifactRemoveDate();
    if ($('#build-trace').length) {
      this.getInitialBuildTrace();
      this.initScrollButtonAffix();
Fatih Acet's avatar
Fatih Acet committed
53
    }
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
    this.invokeBuildTrace();
  }

  Build.prototype.initSidebar = function() {
    this.$sidebar = $('.js-build-sidebar');
    this.$sidebar.niceScroll();
    this.$document.off('click', '.js-sidebar-build-toggle').on('click', '.js-sidebar-build-toggle', this.toggleSidebar);
  };

  Build.prototype.location = function() {
    return window.location.href.split("#")[0];
  };

  Build.prototype.invokeBuildTrace = function() {
    var continueRefreshStatuses = ['running', 'pending'];
    // Continue to update build trace when build is running or pending
    if (continueRefreshStatuses.indexOf(this.buildStatus) !== -1) {
      // Check for new build output if user still watching build page
      // Only valid for runnig build when output changes during time
      Build.timeout = setTimeout((function(_this) {
        return function() {
          if (_this.location() === _this.pageUrl) {
            return _this.getBuildTrace();
77
          }
78 79 80 81 82 83 84 85 86
        };
      })(this), 4000);
    }
  };

  Build.prototype.getInitialBuildTrace = function() {
    var removeRefreshStatuses = ['success', 'failed', 'canceled', 'skipped'];

    return $.ajax({
87
      url: this.pageUrl + "/trace.json",
88 89
      dataType: 'json',
      success: function(buildData) {
90
        $('.js-build-output').html(buildData.html);
91
        gl.utils.setCiStatusFavicon(`${this.pageUrl}/status.json`);
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
        if (window.location.hash === DOWN_BUILD_TRACE) {
          $("html,body").scrollTop(this.$buildTrace.height());
        }
        if (removeRefreshStatuses.indexOf(buildData.status) !== -1) {
          this.$buildRefreshAnimation.remove();
          return this.initScrollMonitor();
        }
      }.bind(this)
    });
  };

  Build.prototype.getBuildTrace = function() {
    return $.ajax({
      url: this.pageUrl + "/trace.json?state=" + (encodeURIComponent(this.state)),
      dataType: "json",
      success: (function(_this) {
        return function(log) {
          var pageUrl;

          if (log.state) {
            _this.state = log.state;
113
          }
114 115 116 117 118 119
          _this.invokeBuildTrace();
          if (log.status === "running") {
            if (log.append) {
              $('.js-build-output').append(log.html);
            } else {
              $('.js-build-output').html(log.html);
Fatih Acet's avatar
Fatih Acet committed
120
            }
121 122 123 124 125
            return _this.checkAutoscroll();
          } else if (log.status !== _this.buildStatus) {
            pageUrl = _this.pageUrl;
            if (_this.$autoScrollStatus.data('state') === 'enabled') {
              pageUrl += DOWN_BUILD_TRACE;
Fatih Acet's avatar
Fatih Acet committed
126 127
            }

128 129 130 131 132 133 134 135 136 137 138
            return gl.utils.visitUrl(pageUrl);
          }
        };
      })(this)
    });
  };

  Build.prototype.checkAutoscroll = function() {
    if (this.$autoScrollStatus.data("state") === "enabled") {
      return $("html,body").scrollTop(this.$buildTrace.height());
    }
Kushal Pandya's avatar
Kushal Pandya committed
139

140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
    // Handle a situation where user started new build
    // but never scrolled a page
    if (!this.$scrollTopBtn.is(':visible') &&
        !this.$scrollBottomBtn.is(':visible') &&
        !gl.utils.isInViewport(this.$downBuildTrace.get(0))) {
      this.$scrollBottomBtn.show();
    }
  };

  Build.prototype.initScrollButtonAffix = function() {
    // Hide everything initially
    this.$scrollTopBtn.hide();
    this.$scrollBottomBtn.hide();
    this.$autoScrollContainer.hide();
  };

  // Page scroll listener to detect if user has scrolling page
  // and handle following cases
  // 1) User is at Top of Build Log;
  //      - Hide Top Arrow button
  //      - Show Bottom Arrow button
  //      - Disable Autoscroll and hide indicator (when build is running)
  // 2) User is at Bottom of Build Log;
  //      - Show Top Arrow button
  //      - Hide Bottom Arrow button
  //      - Enable Autoscroll and show indicator (when build is running)
  // 3) User is somewhere in middle of Build Log;
  //      - Show Top Arrow button
  //      - Show Bottom Arrow button
  //      - Disable Autoscroll and hide indicator (when build is running)
  Build.prototype.initScrollMonitor = function() {
    if (!gl.utils.isInViewport(this.$upBuildTrace.get(0)) && !gl.utils.isInViewport(this.$downBuildTrace.get(0))) {
      // User is somewhere in middle of Build Log

      this.$scrollTopBtn.show();

      if (this.buildStatus === 'success' || this.buildStatus === 'failed') { // Check if Build is completed
        this.$scrollBottomBtn.show();
      } else if (this.$buildRefreshAnimation.is(':visible') && !gl.utils.isInViewport(this.$buildRefreshAnimation.get(0))) {
179
        this.$scrollBottomBtn.show();
180 181 182
      } else {
        this.$scrollBottomBtn.hide();
      }
183

184 185
      // Hide Autoscroll Status Indicator
      if (this.$scrollBottomBtn.is(':visible')) {
186 187
        this.$autoScrollContainer.hide();
        this.$autoScrollStatusText.removeClass('animate');
188
      } else {
189
        this.$autoScrollContainer.css({ top: this.$body.outerHeight() - AUTO_SCROLL_OFFSET }).show();
190
        this.$autoScrollStatusText.addClass('animate');
191 192 193
      }
    } else if (gl.utils.isInViewport(this.$upBuildTrace.get(0)) && !gl.utils.isInViewport(this.$downBuildTrace.get(0))) {
      // User is at Top of Build Log
Kushal Pandya's avatar
Kushal Pandya committed
194

195 196
      this.$scrollTopBtn.hide();
      this.$scrollBottomBtn.show();
197

198 199 200 201 202
      this.$autoScrollContainer.hide();
      this.$autoScrollStatusText.removeClass('animate');
    } else if ((!gl.utils.isInViewport(this.$upBuildTrace.get(0)) && gl.utils.isInViewport(this.$downBuildTrace.get(0))) ||
               (this.$buildRefreshAnimation.is(':visible') && gl.utils.isInViewport(this.$buildRefreshAnimation.get(0)))) {
      // User is at Bottom of Build Log
203

204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
      this.$scrollTopBtn.show();
      this.$scrollBottomBtn.hide();

      // Show and Reposition Autoscroll Status Indicator
      this.$autoScrollContainer.css({ top: this.$body.outerHeight() - AUTO_SCROLL_OFFSET }).show();
      this.$autoScrollStatusText.addClass('animate');
    } else if (gl.utils.isInViewport(this.$upBuildTrace.get(0)) && gl.utils.isInViewport(this.$downBuildTrace.get(0))) {
      // Build Log height is small

      this.$scrollTopBtn.hide();
      this.$scrollBottomBtn.hide();

      // Hide Autoscroll Status Indicator
      this.$autoScrollContainer.hide();
      this.$autoScrollStatusText.removeClass('animate');
    }

    if (this.buildStatus === "running" || this.buildStatus === "pending") {
      // Check if Refresh Animation is in Viewport and enable Autoscroll, disable otherwise.
      this.$autoScrollStatus.data("state", gl.utils.isInViewport(this.$buildRefreshAnimation.get(0)) ? 'enabled' : 'disabled');
    }
  };

  Build.prototype.shouldHideSidebarForViewport = function() {
    var bootstrapBreakpoint;
    bootstrapBreakpoint = this.bp.getBreakpointSize();
    return bootstrapBreakpoint === 'xs' || bootstrapBreakpoint === 'sm';
  };

  Build.prototype.toggleSidebar = function(shouldHide) {
    var shouldShow = typeof shouldHide === 'boolean' ? !shouldHide : undefined;
    this.$buildScroll.toggleClass('sidebar-expanded', shouldShow)
      .toggleClass('sidebar-collapsed', shouldHide);
    this.$sidebar.toggleClass('right-sidebar-expanded', shouldShow)
      .toggleClass('right-sidebar-collapsed', shouldHide);
  };

  Build.prototype.sidebarOnResize = function() {
    this.toggleSidebar(this.shouldHideSidebarForViewport());
  };

  Build.prototype.sidebarOnClick = function() {
    if (this.shouldHideSidebarForViewport()) this.toggleSidebar();
  };

  Build.prototype.updateArtifactRemoveDate = function() {
    var $date, date;
    $date = $('.js-artifacts-remove');
    if ($date.length) {
      date = $date.text();
      return $date.text(gl.utils.timeFor(new Date(date.replace(/([0-9]+)-([0-9]+)-([0-9]+)/g, '$1/$2/$3')), ' '));
    }
  };

  Build.prototype.populateJobs = function(stage) {
    $('.build-job').hide();
    $('.build-job[data-stage="' + stage + '"]').show();
  };

  Build.prototype.updateStageDropdownText = function(stage) {
    $('.stage-selection').text(stage);
  };

  Build.prototype.updateDropdown = function(e) {
    e.preventDefault();
    var stage = e.currentTarget.text;
    this.updateStageDropdownText(stage);
    this.populateJobs(stage);
  };

  Build.prototype.stepTrace = function(e) {
    var $currentTarget;
    e.preventDefault();
    $currentTarget = $(e.currentTarget);
    $.scrollTo($currentTarget.attr('href'), {
      offset: 0
    });
  };

  return Build;
})();