// jshint multistr: true
// jshint esversion: 6

// holds elements relevant for live stream, live log and serial output
// (populated in initLivelogAndTerminal() and initLivestream())
var liveViewElements = [];

// holds elements relevant for live log and serial output
// (initialized in initLivelogAndTerminal())
var logElements;

// Reload broken thumbnails (that didn't exist yet when being requested) every 7th time
function reloadBrokenThumbnails(force) {
  if (!force && testStatus.img_reload_time++ % 7 !== 0) {
    return;
  }
  $('.links img').each(function () {
    if (this.naturalWidth >= 1) {
      return;
    }
    if (!this.retries) {
      this.retries = 0;
    }
    if (this.retries <= 3) {
      this.retries++;
      this.src = this.src.split('?')[0] + '?' + Date.now();
    }
  });
}

// Update global variable testStatus
function updateTestStatus(newStatus) {
  // handle state transitions
  const currentState = testStatus.state;
  const newState = newStatus.state;
  const stateChanged = newStatus.state !== currentState;
  testStatus.workerid = newStatus.workerid;
  if (stateChanged) {
    handleJobStateTransition(currentState, newState, newStatus.result);
  }

  // skip further updating (which is only relevant once the job is running)
  if (newState !== 'running' && newState !== 'uploading' && newState !== 'done') {
    return;
  }

  // skip if details and live tabs have not been loaded yet
  if (!tabConfiguration.live.hasContents) {
    console.log('Skipping test status update; details and running tabs have not been loaded yet');
    return;
  }

  reloadBrokenThumbnails();

  // skip further updating if the state and the currently running module didn't change and there
  // are no details for the currently running module are available
  // note: use of '==' (rather than '===') makes a difference here to consider null and undefined as equal
  if (
    !stateChanged &&
    testStatus.running == newStatus.running &&
    !developerMode.detailsForCurrentModuleUploaded &&
    !testStatus.textDataMissing
  ) {
    return;
  }

  const detailsTab = tabConfiguration.details;
  if (!detailsTab.panelElement) {
    detailsTab.panelElement = document.getElementById('details');
  }

  // redraw module list if a new module have been started
  fetch(detailsTab.panelElement.dataset.src)
    .then(response => {
      if (!response.ok) throw `Server returned ${response.status}: ${response.statusText}`;
      return response.json();
    })
    .then(data => {
      if (typeof data !== 'object') {
        console.log('No details for current job available.');
        return;
      }
      const snippets = data.snippets;
      if (typeof snippets !== 'object') {
        console.log('No snippets for current job available.');
        return;
      }

      // show embedded logfile (autoinst-log.txt) if there are no test modules are available and skip further processing
      const modules = data.modules;
      if (!Array.isArray(modules)) {
        if (typeof snippets.header === 'string') {
          detailsTab.panelElement.innerHTML = snippets.header;
          loadEmbeddedLogFiles();
        }
        return;
      }

      // update module selection for developer mode if new modules appeared
      const moduleSelect = document.getElementById('developer-pause-at-module');
      if (moduleSelect && moduleSelect.dataset.moduleCount != modules.length) {
        // remove previous options
        let child = moduleSelect.firstChild;
        while (child) {
          const nextSibling = child.nextSibling;
          if (child.id !== 'developer-no-module') {
            moduleSelect.removeChild(child);
          }
          child = nextSibling;
        }
        // insert new options
        let currentCategory = null;
        let currentOptgroup = null;
        modules.forEach(function (module) {
          if (!module.name) {
            return;
          }
          if (module.category && module.category !== currentCategory) {
            currentOptgroup = document.createElement('optgroup');
            currentCategory = currentOptgroup.label = module.category;
            moduleSelect.appendChild(currentOptgroup);
          }
          const option = document.createElement('option');
          option.appendChild(document.createTextNode(module.name));
          (currentOptgroup || moduleSelect).appendChild(option);
        });
        moduleSelect.dataset.moduleCount = modules.length;
        updateModuleSelection($(moduleSelect).find('option'), developerMode.currentModuleIndex);
      }

      // handle case when results table has not been created yet or no modules are present yet
      const resultsTable = document.getElementById('results');
      if (!resultsTable || !Array.from(resultsTable.tBodies).find(tbody => tbody.rows.length > 0)) {
        detailsTab.renderContents(data);
        detailsTab.hasContents = true;
        testStatus.running = newStatus.running;
        updateDeveloperMode();
        return;
      }

      // update existing results table
      const previewContainer = document.getElementById('preview_container_out');
      const resultCells = resultsTable.getElementsByClassName('result');
      testStatus.textDataMissing = false;
      modules.forEach(function (module, moduleIndex) {
        const resultCell = resultCells[moduleIndex];
        if (!resultCell) {
          return;
        }
        // re-render only test modules when the result is so far unknown (but the result is now known) or running
        const resultClassList = resultCell.classList;
        if (resultClassList.contains('resultunknown')) {
          if (!module.result || module.result === 'none') {
            return;
          }
        } else if (!resultClassList.contains('resultrunning') && !resultClassList.contains('textdatamissing')) {
          return;
        }
        // detach the preview container if it is contained by the row to be relaced
        const resultRow = resultCell.parentNode;
        if ($.contains(resultRow, previewContainer)) {
          previewContainer.style.display = 'none';
          document.body.appendChild(previewContainer);
        }
        // actually update the row
        resultRow.replaceWith(renderModuleRow(module, snippets));
      });

      testStatus.running = newStatus.running;
      developerMode.detailsForCurrentModuleUploaded = false;
      updateDeveloperMode();

      // reload broken thumbnails one last time
      if (newState === 'done') {
        reloadBrokenThumbnails(true);
      }
    })
    .catch(error => {
      console.log('ERROR: modlist fail');
      console.error(error);
    });
}

function updateStatus() {
  // prevent status updates when window.enableStatusUpdates is set by test environment
  if (window.enableStatusUpdates !== undefined && !window.enableStatusUpdates) {
    return;
  }

  fetch(testStatus.status_url)
    .then(response => {
      if (!response.ok) throw `Server returned ${response.status}: ${response.statusText}`;
      return response.json();
    })
    .then(status => {
      updateTestStatus(status);
      // continue polling for job state updates until the job state is done
      if (testStatus.state !== 'done') {
        setTimeout(updateStatus, 5000);
      }
    })
    .catch(error => {
      console.error(error);
      setTimeout(reloadPage, 5000);
    });
}

/********* LIVE LOG *********/

// global vars for livelog
var scrolldown;

// scrolls to bottom of live log (if enabled)
function scrollToBottomOfLiveLog() {
  if (!scrolldown) {
    return;
  }
  const livelog = document.getElementById('livelog');
  livelog.scrollTop = livelog.scrollHeight;
}

function removeDataListener(elem) {
  if (elem.eventSource) {
    elem.eventSource.removeEventListener('message', elem.eventCallback);
    elem.eventSource.close();
    elem.eventSource = undefined;
  }
}

function addDataListener(elem, callback) {
  // ensure any previously added event source is removed
  removeDataListener(elem);

  // define callback function for response of OpenQA::Shared::Controller::Running::streamtext
  if (!elem.eventCallback) {
    elem.eventCallback = function (event) {
      // define max size of the live log
      // note: If not preventing the livelog from becoming too long the page would become unresponsive at a
      //       certain length.
      var maxLiveLogLength = 50 * 1024;

      var firstElement = elem[0];
      var currentData = firstElement.innerHTML;
      var newData = ansiToHtml(JSON.parse(event.data)[0]);
      var newLength = currentData.length + newData.length;

      // append if not exceeding the limit; otherwise cut the front
      if (newLength < maxLiveLogLength) {
        firstElement.innerHTML += newData;
      } else {
        var catData = currentData + newData;
        var newStartIndex = newLength - maxLiveLogLength;

        // discard one (probably) partial line (in accordance with OpenQA::Shared::Controller::Running::streamtext)
        for (; newStartIndex < catData.length && catData[newStartIndex] !== '\n'; ++newStartIndex);

        firstElement.innerHTML = catData.substr(newStartIndex);
      }
      if (callback) {
        callback();
      }
    };
  }

  // add new event source and add listener
  elem.eventSource = new EventSource(elem.data('url'));
  elem.eventSource.addEventListener('message', elem.eventCallback, false);
}

function initLivelogAndTerminal() {
  // init scrolldown for live log
  const scrolldownCheckbox = document.getElementById('scrolldown');
  scrolldownCheckbox.checked = scrolldown = true;
  scrolldownCheckbox.onchange = function () {
    scrolldown = this.checked;
    scrollToBottomOfLiveLog();
  };

  // find log elements
  logElements = [
    {
      panel: $('#live-log-panel'),
      log: $('#livelog'),
      callback: scrollToBottomOfLiveLog
    },
    {
      panel: $('#live-terminal-panel'),
      log: $('#liveterminal')
    }
  ];

  // enable expanding/collapsing live log/terminal
  $.each(logElements, function (index, value) {
    liveViewElements.push(value);
    value.panel.bodyVisible = false;
    value.panel.find('.card-header').on('click', function () {
      // toggle visibility
      var body = value.panel.find('.card-body');
      body.toggle(200);
      value.panel.bodyVisible = !value.panel.bodyVisible;

      // toggle receiving updates
      if (value.panel.bodyVisible) {
        addDataListener(value.log, value.callback);

        // scroll to bottom of panel when expanding
        $('html,body').animate({
          scrollTop: value.panel.offset().top + value.panel.height()
        });
      } else {
        removeDataListener(value.log);
      }
    });
  });
}

// global vars for livestream
var last_event;

// loads a data-url img into a canvas
function loadCanvas(canvas, dataURL) {
  var context = canvas.getContext('2d');

  // load image from data URL
  var scrn = new Image();
  scrn.onload = function () {
    canvas.width = this.width;
    canvas.height = this.height;
    context.clearRect(0, 0, this.width, this.width);
    context.drawImage(this, 0, 0);

    // hide loading animation after the first image is loaded
    document.getElementById('liveview-loading').style.display = 'none';
  };
  scrn.src = dataURL;
}

function initLivestream() {
  // setup callback for livestream
  const livestream = document.getElementById('livestream');
  const servicePortDelta = Number.parseInt(document.getElementById('developer-panel').dataset.servicePortDelta);
  const url = makeUrlAbsolute(livestream.dataset.url, servicePortDelta);
  livestream.dataset.url = url;
  const elements = $(livestream);
  elements.eventCallback = function (event) {
    loadCanvas(livestream, event.data);
    last_event = event;
  };
  liveViewElements.push({log: elements});
}

function disableLivestream() {
  const livestreamElement = liveViewElements[liveViewElements.length - 1];
  if (livestreamElement && livestreamElement.log.attr('id') === 'livestream') {
    removeDataListener(livestreamElement.log);
    liveViewElements.pop();
  }
  document.getElementById('canholder').remove();
}

// does further initialization for jobs which are not done (and therefore the status might still change)
function setupRunning(jobid, status_url) {
  handleJobStateTransition(undefined, testStatus.state, testStatus.result);
  testStatus.jobid = jobid;
  testStatus.status_url = status_url;
  updateStatus();
}

function refreshInfoPanel() {
  const infoPanel = document.getElementById('info_box');
  fetch(infoPanel.dataset.src)
    .then(response => {
      if (!response.ok) throw `Server returned ${response.status}: ${response.statusText}`;
      return response.text();
    })
    .then(response => {
      infoPanel.innerHTML = response;
      const infoBoxContent = document.getElementById('info-box-content');
      if (!infoBoxContent) {
        return;
      }
      // update favicon, class of info panel, timeago and popover elements
      document.getElementById('favicon-16').href = infoBoxContent.dataset['faviconUrl-16'];
      document.getElementById('favicon-svg').href = infoBoxContent.dataset.faviconUrlSvg;
      setInfoPanelClassName(testStatus.state, testStatus.result);
      const infoBoxJQuery = $(infoBoxContent);
      infoBoxJQuery.find('.timeago').timeago();
      infoBoxJQuery.find('[data-bs-toggle="popover"]').popover({html: true});
      setupResultButtons();
    })
    .catch(error => {
      console.error(error);
      addFlash(
        'danger',
        `Unable to update the info panel: ${error}` +
          ' <a class="btn btn-primary" href="javascript: refreshInfoPanel();">Retry</a>'
      );
    });
}

function handleJobStateTransition(oldJobState, newJobState, newJobResult) {
  testStatus.state = newJobState;
  testStatus.result = newJobResult;

  // show the live tab by default for running jobs (instead of details)
  if (newJobState === 'running') {
    // avoid overriding explicitly specified tab/step
    if (!location.hash || location.hash === '#') {
      $("[href='#live']").tab('show');
    } else {
      // ensure the live tab is loaded even when not showing it initially because it is needed to
      // process the test status updates
      activateTab('live');
    }
    // load contents of the details tab as well as it is updated continuously while the test is running
    activateTab('details');
  }
  // go back from the live tab to the details tab if job is done
  if (newJobState === 'done' && tabConfiguration.live.isActive) {
    $("[href='#details']").tab('show');
  }
  // disable the developer mode and livestream (but *not* livelog) if the job is not running anymore
  if (oldJobState === 'running') {
    disableDeveloperMode();
  }

  // add/remove tabs to show only tabs relevant for the current job state
  showRelevantTabNavElements();

  // update info panel (on top of the page)
  if (oldJobState === undefined) {
    setInfoPanelClassName(testStatus.state, testStatus.result); // just set the class on initial page load
  } else {
    refreshInfoPanel();
  }
}

// starts consuming streams for live stream, live log and serial output
// (called when live view tab is shown)
function resumeLiveView() {
  $.each(liveViewElements, function (index, value) {
    // skip streams which are shown in an expandible panel which is currently collapsed
    if (value.panel && !value.panel.bodyVisible) {
      return;
    }
    addDataListener(value.log, value.callback);
  });
}

// stops consuming streams for live stream, live log and serial output
// (called when any tab except the live view tab is shown)
function pauseLiveView() {
  $.each(liveViewElements, function (index, value) {
    removeDataListener(value.log);
  });
}

//
// developer mode
//

// define state for developer mode
var developerMode = {
  // state of the page elements and the web socket connection to web UI
  develWsUrl: undefined, // URL for developer session web socket connection
  statusOnlyWsUrl: undefined, // URL for status-only web socket connection
  servicePortDelta: undefined, // delta from web UI port on which to directly connect to livehandler
  wsConnection: undefined, // current WebSocket object
  hasWsError: false, // whether an web socket error occurred (cleared when we finally receive a message from os-autoinst)
  useDeveloperWsRoute: undefined, // whether the developer web socket route is used
  isConnected: false, // whether connected to any web socket route
  badConfiguration: false, // whether there's a bad/unrecoverable configuration issue so it makes no sense to continue re-connecting
  ownSession: false, // whether the development session belongs to us
  panelExpanded: false, // whether the panel is supposed to be expanded
  panelActuallyExpanded: false, // whether the panel is currently expanded
  panelExplicitelyCollapsed: false, // whether the panel has been explicitly collapsed since the page has been opened
  reconnectAttempts: 0, // number of (re)connect attempts (reset to 0 when we finally receive a message from os-autoinst)
  currentModuleIndex: undefined, // the index of the current module

  // state of the test execution (comes from os-autoinst cmd srv through the openQA ws proxy)
  currentModule: undefined, // name of the current module, eg. "installation-welcome"
  moduleToPauseAt: undefined, // name of the module to pause at, eg. "installation-welcome"
  pauseOnScreenMismatch: undefined, // 'assert_screen' (to pause on assert_screen timeout) or 'check_screen' (to pause on assert/check_screen timeout)
  pauseOnNextCommand: undefined, // whether to pause on the next command (current command *not* affected, eg. *no* timeouts skipped or failures suppressed)
  isPaused: undefined, // if paused the reason why as a string; otherwise something which evaluates to false
  currentApiFunction: undefined, // the currently executed API function (eg. assert_screen)
  currentApiFunctionArgs: '', // arguments of the currently executed API function (eg. assert_screen)
  outstandingImagesToUpload: undefined, // number of images which still need to be uploaded by the worker
  outstandingFilesToUpload: undefined, // number of other files which still need to be uploaded by the worker
  uploadingUpToCurrentModule: undefined, // whether the worker will upload up to the current module (happens when paused in the middle of a module)
  detailsForCurrentModuleUploaded: false, // whether new test details for the currently running module have been uploaded
  stoppingTestExecution: undefined, // if the test execution is being stopped the reason for that; otherwise undefined

  // state of development session (comes from the openQA ws proxy)
  develSessionDeveloper: undefined, // name of the user in possession the development session
  develSessionStartedAt: undefined, // time stamp when the development session was created
  develSessionTabCount: undefined, // number of open web socket connections by the developer

  // returns whether we're currently connecting
  isConnecting: function () {
    return !this.badConfiguration && !this.isConnected && !this.stoppingTestExecution;
  },

  // returns whether there's a development session but it doesn't belong to us
  lockedByOtherDeveloper: function () {
    return this.develSessionDeveloper && !this.ownSession && !this.stoppingTestExecution;
  },

  // returns whether the needle editor is ready
  // (results for the current module must have been uploaded yet)
  needleEditorReady: function () {
    return (
      this.isPaused &&
      this.uploadingUpToCurrentModule &&
      this.outstandingImagesToUpload === 0 &&
      this.outstandingFilesToUpload === 0
    );
  },

  // returns whether it is possible to skip the timeout
  canSkipTimeout: function () {
    return (
      this.ownSession &&
      !this.isPaused &&
      (this.currentApiFunction === 'assert_screen' || this.currentApiFunction === 'check_screen')
    );
  },

  // returns whether all specified properties/functions evaluate to true
  allTrue: function (propertyNames) {
    return propertyNames.split(',').every(propertyName => {
      const prop = this[propertyName];
      return typeof prop === 'function' ? prop.apply(this) : prop;
    });
  }
};

// updates the developer mode if initialized (update panel, ensure connected)
function updateDeveloperMode() {
  if (!window.developerPanelInitialized) {
    return;
  }
  updateDeveloperPanel();
  if (!developerMode.wsConnection) {
    setupWebsocketConnection();
  }
}

// initializes the developer panel
function setupDeveloperPanel() {
  // skip if already initialized
  if (window.developerPanelInitialized) {
    return;
  }
  window.developerPanelInitialized = true;

  var panel = $('#developer-panel');
  var flashMessages = document.getElementById('developer-flash-messages');

  // set overall status variables
  developerMode.ownUserId = panel.data('own-user-id');
  developerMode.isAccessible = panel.data('is-accessible'); // actually assigns a boolean (and not eg. the string 'false')

  // find URLs for web socket connections
  developerMode.develWsUrl = panel.data('developer-url');
  developerMode.statusOnlyWsUrl = panel.data('status-only-url');
  developerMode.servicePortDelta = panel.data('service-port-delta');

  // setup toggle for body
  var panelHeader = panel.find('.card-header');
  if (developerMode.isAccessible) {
    panelHeader.on('click', function (event) {
      // skip if flash message clicked
      if ($.contains(flashMessages, event.target)) {
        return;
      }

      // toggle visibility of body
      var panelBody = panel.find('.card-body');
      developerMode.panelExpanded = !developerMode.panelExpanded;
      developerMode.panelActuallyExpanded = developerMode.panelExpanded;
      if (!developerMode.panelExpanded) {
        developerMode.panelExplicitelyCollapsed = true;
      }
      panelBody.toggle(200);
    });
  } else {
    panelHeader.css('cursor', 'default');
  }

  // ensure help popover doesn't toggle
  const popover = panel.find('.help_popover');
  popover.popover({html: true});
  popover.on('click', function (event) {
    event.stopPropagation();
  });

  // add handler for static form elements
  document.getElementById('developer-pause-on-mismatch').onchange = handlePauseOnMismatchSelected;
  document.getElementById('developer-pause-on-next-command').onchange = handlePauseOnNextCommandToggled;
  document.getElementById('developer-pause-on-failure').onchange = handlePauseOnFailureToggled;

  updateDeveloperPanel();
  setupWebsocketConnection();
}

// hides the specified options up to the specified index
function updateModuleSelection(moduleToPauseAtOptions, moduleIndex) {
  for (var i = 0; i <= moduleIndex; ++i) {
    var optionElement = moduleToPauseAtOptions[i];
    var optgroupElement = optionElement.parentNode;
    if (!optgroupElement || optgroupElement.nodeName !== 'OPTGROUP') {
      continue;
    }
    optionElement.style.display = 'none';
    if (optgroupElement.lastElementChild.isEqualNode(optionElement)) {
      optgroupElement.style.display = 'none';
    }
  }
}

// updates the developer panel, must be called after modifying developerMode
function updateDeveloperPanel() {
  // hide/show elements according to data-hidden and data-visible attributes
  var developerModeElements = $('.developer-mode-element');
  developerModeElements.each(function (index) {
    var element = $(this);
    var visibleOn = element.data('visible-on');
    var hiddenOn = element.data('hidden-on');
    var hide = (hiddenOn && developerMode.allTrue(hiddenOn)) || (visibleOn && !developerMode.allTrue(visibleOn));
    if (hide) {
      element.hide();
      element.tooltip('hide');
    } else if (element.hasClass('btn')) {
      element.css('display', 'inline-block');
    } else {
      element.show();
    }
  });

  // set panel visibility
  var panel = $('#developer-panel');
  if (!testStatus.running) {
    // hide entire panel if test is not running anymore
    panel.hide();
    return;
  }
  panel.show();

  // expand the controls if the test is paused (unless previously manually collapsed)
  if (developerMode.ownSession && developerMode.isPaused && !developerMode.panelExplicitelyCollapsed) {
    developerMode.panelExpanded = true;
  }

  // toggle panel body if its current state doesn't match developerMode.panelExpanded
  var panelBody = panel.find('.card-body');
  if (developerMode.panelExpanded !== developerMode.panelActuallyExpanded) {
    developerMode.panelActuallyExpanded = developerMode.panelExpanded;
    panelBody.toggle(200);
  }

  // find modules and determine the index of the current module
  var moduleToPauseAtSelect = $('#developer-pause-at-module');
  var moduleToPauseAtOptions = moduleToPauseAtSelect.find('option');
  var modules = moduleToPauseAtOptions
    .map(function () {
      var option = $(this);
      var category = option.parent('optgroup').attr('label');
      return category ? category + '-' + option.val() : option.val();
    })
    .get();
  var currentModuleIndex = modules.indexOf(developerMode.currentModule);

  // hide modules which have already been executed when the current module index has changed
  if (developerMode.currentModuleIndex !== currentModuleIndex) {
    updateModuleSelection(moduleToPauseAtOptions, (developerMode.currentModuleIndex = currentModuleIndex));
  }

  // determine whether the module to pause at is still ahead
  var toPauseAtIndex = modules.indexOf(developerMode.moduleToPauseAt);
  if (toPauseAtIndex < 0) {
    toPauseAtIndex = 0;
  }
  var moduleToPauseAtStillAhead = developerMode.moduleToPauseAt && toPauseAtIndex > currentModuleIndex;

  // update status info
  var statusInfo = 'running';
  var statusAppendix = '';
  if (developerMode.stoppingTestExecution) {
    statusInfo = 'stopping';
  } else if (developerMode.badConfiguration) {
    statusInfo = 'configuration issue';
  } else if (developerMode.isPaused) {
    statusInfo = 'paused';
    if (developerMode.currentModule) {
      statusInfo += ' at module: ' + developerMode.currentModule;
    }
    if (developerMode.outstandingImagesToUpload || developerMode.outstandingFilesToUpload) {
      statusInfo += ', uploading results';
    }
    statusAppendix = 'reason: ' + developerMode.isPaused;
  } else if (moduleToPauseAtStillAhead) {
    statusInfo = 'will pause at module: ' + developerMode.moduleToPauseAt;
    if (developerMode.currentModule) {
      statusAppendix = 'currently at: ' + developerMode.currentModule;
      if (developerMode.currentApiFunction) {
        statusAppendix += ', ' + developerMode.currentApiFunction;
        if (developerMode.currentApiFunctionArgs) {
          statusAppendix += ' ' + developerMode.currentApiFunctionArgs;
        }
      }
    }
  } else if (developerMode.currentModule) {
    statusInfo = 'current module: ' + developerMode.currentModule;
    if (developerMode.currentApiFunction) {
      statusAppendix += 'at ' + developerMode.currentApiFunction;
      if (developerMode.currentApiFunctionArgs) {
        statusAppendix += ' ' + developerMode.currentApiFunctionArgs;
      }
    }
  }
  if (!developerMode.badConfiguration && developerMode.currentApiFunction) {
    $('#developer-current-api-function').text('(' + developerMode.isPaused + ')');
  }
  $('#developer-status-info').text(statusInfo);
  $('#developer-status-appendix').text(statusAppendix);

  // update session info
  var sessionInfoElement = $('#developer-session-info');
  var sessionInfo;
  if (developerMode.develSessionDeveloper) {
    sessionInfo = 'owned by ' + developerMode.develSessionDeveloper + ' (';
    sessionInfoElement.text(sessionInfo);

    var timeagoElement = $(
      '<abbr class="timeago" title="' +
        developerMode.develSessionStartedAt +
        ' Z">' +
        developerMode.develSessionStartedAt +
        '</abbr>'
    );
    sessionInfoElement.append(timeagoElement);
    timeagoElement.timeago();

    var tabsOpenInfo =
      ', developer has ' +
      developerMode.develSessionTabCount +
      (developerMode.develSessionTabCount == 1 ? ' tab' : ' tabs') +
      ' open)';
    sessionInfoElement.append(document.createTextNode(tabsOpenInfo));

    var globalSessionInfoElement = $('#developer-global-session-info:hidden');
    if (globalSessionInfoElement.length) {
      globalSessionInfoElement.text('Developer session has been opened by ' + developerMode.develSessionDeveloper);
      globalSessionInfoElement.show();
    }
  } else if (!developerMode.badConfiguration) {
    sessionInfo = 'regular test execution';
    if (developerMode.isAccessible && !developerMode.panelExpanded) {
      sessionInfo += ' - click to expand';
    }
    sessionInfoElement.text(sessionInfo);
  }

  // update form elements
  // -> skip if the test hasn't been locked by anybody so far and we're just showing the form initially
  if (!developerMode.ownSession && !developerMode.develSessionDeveloper && developerMode.panelExpanded) {
    return;
  }
  // -> update module to pause at
  if (moduleToPauseAtSelect.length) {
    // update module to pause at and ensure handler is registered (element might be replaced in updateTestStatus())
    var selectElement = moduleToPauseAtSelect[0];
    selectElement.selectedIndex = toPauseAtIndex;
    if (!selectElement.handlerRegistered) {
      selectElement.onchange = handleModuleToPauseAtSelected;
      selectElement.handlerRegistered = true;
    }
  }
  // -> update whether the test will pause on assert screen timeout
  var pauseOnMismatchSelect = document.getElementById('developer-pause-on-mismatch');
  if (developerMode.pauseOnScreenMismatch === 'assert_screen') {
    pauseOnMismatchSelect.selectedIndex = 1; // "assert_screen timeout" option
  } else if (developerMode.pauseOnScreenMismatch === 'check_screen') {
    pauseOnMismatchSelect.selectedIndex = 2; // "assert_screen and check_screen timeout" option
  } else if (developerMode.pauseOnScreenMismatch === false) {
    pauseOnMismatchSelect.selectedIndex = 0; // "Fail on mismatch as usual" option
  }
  // -> update whether to pause at the next command
  if (developerMode.pauseOnNextCommand !== undefined) {
    $('#developer-pause-on-next-command').prop('checked', developerMode.pauseOnNextCommand);
  }
  // -> update whether to pause on failure
  if (developerMode.pauseOnFailure !== undefined) {
    $('#developer-pause-on-failure').prop('checked', developerMode.pauseOnFailure);
  }
}

// submits the selected module to pause at if it has changed
function handleModuleToPauseAtSelected() {
  // skip if not owning development session or moduleToPauseAt is unknown
  if (!developerMode.ownSession || developerMode.moduleToPauseAt === undefined) {
    return;
  }

  // determine the selected module including the category, eg. "installation-welcome"
  var selectedModuleOption = $('#developer-pause-at-module').find('option:selected');
  var category = selectedModuleOption.parent('optgroup').attr('label');
  var selectedModuleName = null;
  if (category) {
    selectedModuleName = category + '-' + selectedModuleOption.text();
  }
  if (selectedModuleName !== developerMode.moduleToPauseAt) {
    sendWsCommand({
      cmd: 'set_pause_at_test',
      name: selectedModuleName
    });
  }
}

function handlePauseOnMismatchSelected() {
  // skip if not owning development session or pauseOnScreenMismatch is unknown
  if (!developerMode.ownSession || developerMode.pauseOnScreenMismatch === undefined) {
    return;
  }

  var selectedValue = $('#developer-pause-on-mismatch').val();
  var pauseOn;
  switch (selectedValue) {
    case 'fail':
      pauseOn = null;
      break;
    case 'check_screen':
    case 'assert_screen':
      pauseOn = selectedValue;
      break;
  }
  sendWsCommand({
    cmd: 'set_pause_on_screen_mismatch',
    pause_on: pauseOn
  });
}

function handleBooleanBehaviorSwitchToggled(developerModeProperty, command, checkboxId) {
  // send command only if owning development session and property is known
  if (developerMode.ownSession && developerMode[developerModeProperty] !== undefined) {
    sendWsCommand({cmd: command, flag: document.getElementById(checkboxId).checked});
  }
}

function handlePauseOnNextCommandToggled() {
  handleBooleanBehaviorSwitchToggled(
    'pauseOnNextCommand',
    'set_pause_on_next_command',
    'developer-pause-on-next-command'
  );
}

function handlePauseOnFailureToggled() {
  handleBooleanBehaviorSwitchToggled('pauseOnFailure', 'set_pause_on_failure', 'developer-pause-on-failure');
}

// submits the selected values which differ from the server's state
function submitCurrentSelection() {
  handleModuleToPauseAtSelected();
  handlePauseOnMismatchSelected();
  handlePauseOnNextCommandToggled();
  handlePauseOnFailureToggled();
}

// ensures the websocket connection is closed
function closeWebsocketConnection() {
  if (developerMode.wsConnection) {
    developerMode.wsConnection.close();
    developerMode.wsConnection = undefined;
  }
  developerMode.isConnected = false;
}

function clearLivehandlerFlashMessages() {
  if (!window.uniqueFlashMessages) {
    return;
  }

  for (var id in window.uniqueFlashMessages) {
    if (id === 'unable_to_pare_livehandler_reply' || id.indexOf('ws_proxy_error-') === 0) {
      window.uniqueFlashMessages[id].remove();
      delete window.uniqueFlashMessages[id];
    }
  }
}

function handleWebsocketConnectionOpened(wsConnection) {
  if (wsConnection !== developerMode.wsConnection) {
    return;
  }

  // update state
  developerMode.isConnected = true;
  developerMode.ownSession = developerMode.useDeveloperWsRoute;

  // sync the current selection if the test is running and it is our session
  // note: the check for testStatus.running is important - otherwise we might override existing
  //       configuration with the form defaults
  if (testStatus.running && developerMode.ownSession) {
    submitCurrentSelection();
  }

  clearLivehandlerFlashMessages();

  updateDeveloperPanel();
}

function handleWebsocketConnectionClosed(wsConnection) {
  if (wsConnection !== developerMode.wsConnection) {
    return;
  }
  console.log('Connection to livehandler lost');

  // update state
  developerMode.wsConnection = undefined;
  developerMode.isConnected = false;
  developerMode.panelExpanded = false;
  developerMode.useDeveloperWsRoute = false;
  developerMode.ownSession = false;
  updateDeveloperPanel();

  // skip reconnect if test is just not running (anymore)
  if (!testStatus.running || developerMode.stoppingTestExecution) {
    return;
  }

  // reconnect instantly in first connection error
  if (developerMode.reconnectAttempts === 0) {
    setupWebsocketConnection();
  } else {
    // otherwise try to reconnect every 2 seconds
    setTimeout(function () {
      setupWebsocketConnection();
    }, 2000);
  }
}

function addLivehandlerFlash(status, id, text) {
  text +=
    '<p><hr>For troubleshooting, checkout the <a href="https://open.qa/docs/#debugdevelmode" \
    target="blank">documentation about debugging the developer mode setup</a>.</p>';
  addUniqueFlash(status, id, text, $('#developer-flash-messages'));
}

function handleMessageFromWebsocketConnection(wsConnection, msg) {
  if (wsConnection !== developerMode.wsConnection) {
    return;
  }

  // parse the message JSON
  if (!msg.data) {
    return;
  }
  console.log('Received message via ws proxy: ' + msg.data);
  var dataObj;
  try {
    dataObj = JSON.parse(msg.data);
  } catch (ex) {
    console.log('Unable to parse JSON from ws proxy: ' + msg.data);
    addLivehandlerFlash(
      'danger',
      'unable_to_pare_livehandler_reply',
      '<strong>Unable to parse reply from livehandler daemon.</strong>'
    );
    return;
  }

  processWsCommand(dataObj);
}

function setupWebsocketConnection() {
  // ensure previously opened connections are closed
  closeWebsocketConnection();

  // give up re-connecting if there's a configuration issue we can not recover from
  if (developerMode.badConfiguration) {
    return;
  }

  var url;
  // determine ws URL
  if (developerMode.isAccessible && developerMode.useDeveloperWsRoute) {
    // use route for developer (establishing a developer session)
    developerMode.useDeveloperWsRoute = true;
    url = developerMode.develWsUrl;
  } else {
    // use route for regular user (receiving only status information)
    developerMode.useDeveloperWsRoute = false;
    url = developerMode.statusOnlyWsUrl;
  }
  url = makeWsUrlAbsolute(url, developerMode.servicePortDelta);

  // establish ws connection
  console.log('Establishing ws connection to ' + url);
  developerMode.reconnectAttempts += 1;
  var wsConnection = new WebSocket(url);
  wsConnection.onopen = function () {
    handleWebsocketConnectionOpened(wsConnection);
  };
  wsConnection.onerror = function (error) {
    if (wsConnection !== developerMode.wsConnection) {
      return;
    }

    // set the error flag
    developerMode.hasWsError = true;
  };
  wsConnection.onclose = function () {
    handleWebsocketConnectionClosed(wsConnection);
  };
  wsConnection.onmessage = function (msg) {
    handleMessageFromWebsocketConnection(wsConnection, msg);
  };

  developerMode.wsConnection = wsConnection;
}

function handlePausedMessage(value, wholeMessage) {
  developerMode.isPaused = wholeMessage.paused ? wholeMessage.reason || 'unknown' : wholeMessage.test_execution_paused;
  developerMode.onFailure =
    developerMode.isPaused &&
    (developerMode.isPaused.startsWith('test died: ') || developerMode.isPaused.includes(' failed: '));
}

// define mapping of backend messages to status variables
var messageToStatusVariable = [
  {
    msg: 'test_execution_paused',
    action: handlePausedMessage
  },
  {
    msg: 'paused',
    action: handlePausedMessage
  },
  {
    msg: 'pause_test_name',
    statusVar: 'moduleToPauseAt'
  },
  {
    msg: 'set_pause_at_test',
    statusVar: 'moduleToPauseAt'
  },
  {
    msg: 'pause_on_screen_mismatch',
    statusVar: 'pauseOnScreenMismatch'
  },
  {
    msg: 'set_pause_on_screen_mismatch',
    statusVar: 'pauseOnScreenMismatch'
  },
  {
    msg: 'pause_on_next_command',
    statusVar: 'pauseOnNextCommand'
  },
  {
    msg: 'set_pause_on_next_command',
    statusVar: 'pauseOnNextCommand'
  },
  {
    msg: 'pause_on_failure',
    statusVar: 'pauseOnFailure'
  },
  {
    msg: 'set_pause_on_failure',
    statusVar: 'pauseOnFailure'
  },
  {
    msg: 'current_test_full_name',
    statusVar: 'currentModule'
  },
  {
    msg: 'developer_id',
    action: function (value) {
      developerMode.ownSession = developerMode.ownUserId && developerMode.ownUserId == value;
    }
  },
  {
    msg: 'developer_name',
    statusVar: 'develSessionDeveloper'
  },
  {
    msg: 'developer_session_started_at',
    statusVar: 'develSessionStartedAt'
  },
  {
    msg: 'developer_session_tab_count',
    statusVar: 'develSessionTabCount'
  },
  {
    msg: 'developer_session_is_yours',
    statusVar: 'ownSession'
  },
  {
    msg: 'resume_test_execution',
    action: function () {
      developerMode.isPaused = developerMode.onFailure = false;
    }
  },
  {
    msg: 'outstanding_images',
    statusVar: 'outstandingImagesToUpload'
  },
  {
    msg: 'outstanding_files',
    statusVar: 'outstandingFilesToUpload'
  },
  {
    msg: 'upload_up_to_current_module',
    statusVar: 'uploadingUpToCurrentModule'
  },
  {
    msg: 'current_api_function',
    statusVar: 'currentApiFunction',
    action: function (value, data) {
      developerMode.currentApiFunctionArgs = '';
      if ((value === 'assert_screen' || value === 'check_screen') && data.check_screen) {
        developerMode.currentApiFunctionArgs = data.check_screen.mustmatch;
      }
    }
  },
  {
    msg: 'stopping_test_execution',
    statusVar: 'stoppingTestExecution'
  }
];

// handles messages received via web socket connection
function processWsCommand(obj) {
  var somethingChanged = false;
  var what = obj.what;
  var data = obj.data;
  var category;
  if (data) {
    category = data.category;
  }

  switch (obj.type) {
    case 'error':
      // handle errors

      // ignore connection errors if there's no running module according to OpenQA::Shared::Controller::Running::status
      // or the test execution is stopped
      if ((!testStatus.running || developerMode.stoppingTestExecution) && category === 'cmdsrv-connection') {
        console.log('ignoring error from ws proxy: ' + what);
        break;
      }
      if (category === 'bad-configuration') {
        developerMode.badConfiguration = true;
        somethingChanged = true;
      }

      console.log('Error from ws proxy: ' + what);
      addLivehandlerFlash('danger', 'ws_proxy_error-' + what, '<p>' + what + '</p>');
      break;
    case 'info':
      // map info message to internal status variables
      switch (what) {
        case 'cmdsrvmsg':
        case 'upload progress':
          // reset error state
          developerMode.reconnectAttempts = 0;
          developerMode.hasWsError = false;

          // handle messages from os-autoinst command server
          $.each(messageToStatusVariable, function (index, msgToStatusValue) {
            var msg = msgToStatusValue.msg;
            if (!(msg in data)) {
              return;
            }
            var statusVar = msgToStatusValue.statusVar;
            var value = data[msg];
            if (statusVar) {
              developerMode[statusVar] = value;
            }
            var action = msgToStatusValue.action;
            if (action) {
              action(value, data);
            }
            somethingChanged = true;
          });

          break;
      }

      // handle specific info messages
      switch (what) {
        case 'upload progress':
          if (
            developerMode.uploadingUpToCurrentModule &&
            developerMode.outstandingImagesToUpload === 0 &&
            developerMode.outstandingFilesToUpload === 0
          ) {
            // receiving an upload progress event with these values means the upload
            // has been concluded
            // -> set flag so the next updateTestStatus() will request these details
            developerMode.detailsForCurrentModuleUploaded = true;
          }
          break;
      }

      // handle update of the VNC argument
      var vncArg = data?.vnc_arg;
      if (typeof vncArg === 'string' && vncArg !== developerMode.vncArg) {
        developerMode.vncArg = vncArg;
        somethingChanged = true;
        Array.from(document.getElementsByClassName('vnc-arg')).forEach(e => {
          e.textContent = vncArg;
        });
      }

      break;
  }

  if (somethingChanged) {
    // check whether the development session is ours to change to the proxy with write-access
    if (!developerMode.useDeveloperWsRoute && developerMode.ownSession) {
      developerMode.useDeveloperWsRoute = true;
      setupWebsocketConnection();
    }
    updateDeveloperPanel();
  }
}

// sends a command via web sockets to the web UI which will pass it to os-autoinst
function sendWsCommand(obj) {
  if (!developerMode.wsConnection) {
    console.log('Attempt to send something via ws proxy but not connected.');
    addLivehandlerFlash(
      'danger',
      'try_to_send_but_not_connected',
      '<strong>Internal error:</strong><p>Attempt to send something via web socket proxy but not connected.</p>'
    );
    return;
  }
  var objAsString = JSON.stringify(obj);
  console.log('Sending message via ws proxy: ' + objAsString);
  developerMode.wsConnection.send(objAsString);
}

// resumes the test execution (if currently paused)
function resumeTestExecution(ignoreFailure) {
  sendWsCommand({cmd: 'resume_test_execution', options: {ignore_failure: ignoreFailure}});
}

// sets the timeout of the currently ongoing assert/check_screen to zero
function skipTimeout() {
  sendWsCommand({
    cmd: 'set_assert_screen_timeout',
    timeout: 0
  });
}

// starts the developer session (if not already done yet)
function startDeveloperSession() {
  if (!developerMode.useDeveloperWsRoute) {
    developerMode.useDeveloperWsRoute = true;
    setupWebsocketConnection();
  }
}

// quits the developer session (will cancel the job)
function quitDeveloperSession() {
  if (!developerMode.useDeveloperWsRoute) {
    return;
  }
  developerMode.useDeveloperWsRoute = undefined;
  developerMode.panelExplicitelyCollapsed = true;
  developerMode.panelExpanded = false;
  updateDeveloperPanel();
  sendWsCommand({cmd: 'quit_development_session'});
}

function disableDeveloperMode() {
  // ensure none of the developer mode functions are called anymore
  window.developerPanelInitialized = false;
  if (window.developerMode !== undefined && developerMode.wsConnection !== undefined) {
    developerMode.wsConnection.close();
    developerMode.wsConnection = undefined; // this skips all ws handlers and effectively disables reconnects all element updates
  }

  // remove developer mode elements from the page
  const developerPanel = document.getElementById('developer-panel');
  if (developerPanel) {
    developerPanel.remove();
  }
}

// vim: set sw=4 et:
