commands-api.js

/*
 * Copyright 2017 SideeX committers
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */
import browser from "webextension-polyfill";
import TargetSelector from "./targetSelector";
import Selenium from "./selenium-api";
import BrowserBot from "./selenium-browserbot";
import { locatorBuilders } from "./record";

export const selenium = new Selenium(BrowserBot.createForWindow(window));
let contentSideexTabId = window.contentSideexTabId;
let targetSelector;

function doCommands(request, sender, sendResponse) {
  if (request.commands) {
    if (request.commands == "waitPreparation") {
      selenium["doWaitPreparation"]("", selenium.preprocessParameter(""));
      sendResponse({});
    } else if (request.commands == "prePageWait") {
      selenium["doPrePageWait"]("", selenium.preprocessParameter(""));
      sendResponse({ new_page: window.sideex_new_page });
    } else if (request.commands == "pageWait") {
      selenium["doPageWait"]("", selenium.preprocessParameter(""));
      sendResponse({ page_done: window.sideex_page_done });
    } else if (request.commands == "ajaxWait") {
      selenium["doAjaxWait"]("", selenium.preprocessParameter(""));
      sendResponse({ ajax_done: window.sideex_ajax_done });
    } else if (request.commands == "domWait") {
      selenium["doDomWait"]("", selenium.preprocessParameter(""));
      sendResponse({ dom_time: window.sideex_new_page });
    } else if (isConditinal(request.commands)) {
      executeConditional(request, sendResponse);
    } else {
      const upperCase = request.commands.charAt(0).toUpperCase() + request.commands.slice(1);
      if (selenium["do" + upperCase] != null) {
        try {
          document.body.setAttribute("SideeXPlayingFlag", true);
          let returnValue = selenium["do"+upperCase](request.target,selenium.preprocessParameter(request.value));
          if (returnValue instanceof Promise) {
            // The command is a asynchronous function
            returnValue.then(function() {
              // Asynchronous command completed successfully
              document.body.removeAttribute("SideeXPlayingFlag");
              sendResponse({result: "success"});
            }).catch(function(reason) {
              // Asynchronous command failed
              document.body.removeAttribute("SideeXPlayingFlag");
              sendResponse({result: reason});
            });
          } else {
            // Synchronous command completed successfully
            document.body.removeAttribute("SideeXPlayingFlag");
            sendResponse({result: "success"});
          }
        } catch(e) {
          // Synchronous command failed
          document.body.removeAttribute("SideeXPlayingFlag");
          sendResponse({result: e.message});
        }
      } else {
        sendResponse({ result: "Unknown command: " + request.commands });
      }
    }

    //do every command need giving sideex id
    if (contentSideexTabId === -1) {
      contentSideexTabId = request.mySideexTabId;
    }
    return true;
  }
  if (request.selectMode) {
    if (request.selecting) {
      targetSelector = new TargetSelector(function (element, win) {
        if (element && win) {
          const target = locatorBuilders.buildAll(element);
          locatorBuilders.detach();
          if (target != null && target instanceof Array) {
            if (target) {
              //self.editor.treeView.updateCurrentCommand('targetCandidates', target);
              browser.runtime.sendMessage({
                selectTarget: true,
                target: target
              });
            }
          }
        }
        targetSelector = null;
      }, function () {
        browser.runtime.sendMessage({
          cancelSelectTarget: true
        });
      });

    } else {
      if (targetSelector) {
        targetSelector.cleanup();
        targetSelector = null;
        return;
      }
    }
  }
}

function isConditinal(commandName) {
  return ["if", "while"].includes(commandName);
}

function executeConditional(request, sendResponse) {

  const upperCase = request.commands.charAt(0).toUpperCase() + request.commands.slice(1);
  if (selenium["do" + upperCase] != null) {
    try {
      document.body.setAttribute("SideeXPlayingFlag", true);
      let returnValue = selenium["do"+upperCase](request.target,selenium.preprocessParameter(request.value));
      // conditional command executed!
      if (returnValue) {
        document.body.removeAttribute("SideeXPlayingFlag");
        sendResponse({result: "truthy"});
      } else {
        document.body.removeAttribute("SideeXPlayingFlag");
        sendResponse({result: "falsy"});
      }
    } catch(e) {
      // Synchronous command failed
      document.body.removeAttribute("SideeXPlayingFlag");
      sendResponse({result: e.message});
    }
  } else {
    sendResponse({ result: "Unknown command: " + request.commands });
  }

}

if (!window._listener) {
  window._listener = doCommands;
  browser.runtime.onMessage.addListener(doCommands);
}