Refactoring tour code

Author: mdmintz

seleniumbase/core/style_sheet.py

@@ -118,7 +118,7 @@
 
 sh_style_test = (
     '''
-    let test_tour = new Shepherd.Tour({
+    var test_tour = new Shepherd.Tour({
       defaults: {
         classes: 'shepherd-theme-dark',
         scrollTo: true

seleniumbase/fixtures/base_case.py

@@ -720,40 +720,46 @@ def maximize_window(self):
 
     def add_css_link(self, css_link):
         script_to_add_css = (
-            """function injectCSS() {
+            """function injectCSS(css) {
                   var head = document.getElementsByTagName("head")[0];
                   var link = document.createElement("link");
                   link.rel = "stylesheet";
                   link.type = "text/css";
-                  link.href = "%s";
+                  link.href = css;
                   link.crossorigin = "anonymous";
                   head.appendChild(link);
                }
-               injectCSS();""")
+               injectCSS("%s");""")
+        css_link = self.__escape_quotes_if_needed(css_link)
         self.execute_script(script_to_add_css % css_link)
 
     def add_js_link(self, js_link):
         script_to_add_js = (
-            """function injectJS() {
+            """function injectJS(link) {
                   var head = document.getElementsByTagName("head")[0];
                   var script = document.createElement("script");
-                  script.src = "%s";
+                  script.src = link;
                   script.defer;
+                  script.type="text/javascript";
                   script.crossorigin = "anonymous";
                   script.onload = function() { null };
                   head.appendChild(script);
                }
-               injectJS();""")
+               injectJS("%s");""")
+        js_link = self.__escape_quotes_if_needed(js_link)
         self.execute_script(script_to_add_js % js_link)
 
     def add_css_style(self, css_style):
         add_css_style_script = (
-            '''var h = document.getElementsByTagName('head').item(0);'''
-            '''var s = document.createElement("style");'''
-            '''s.type = "text/css";'''
-            '''s.appendChild(document.createTextNode("%s"));'''
-            '''h.appendChild(s);''')
-        css_style = re.escape(css_style)
+            """function injectStyle(css) {
+                  var head = document.getElementsByTagName("head")[0];
+                  var style = document.createElement("style");
+                  style.type = "text/css";
+                  style.appendChild(document.createTextNode(css));
+                  head.appendChild(style);
+               }
+               injectStyle("%s");""")
+        css_style = css_style.replace('\n', '')
         css_style = self.__escape_quotes_if_needed(css_style)
         self.execute_script(add_css_style_script % css_style)
 
@@ -800,7 +806,11 @@ def activate_jquery(self):
             # jQuery is not currently defined. Let's proceed by defining it.
             pass
         jquery_js = constants.JQuery.MIN_JS
-        self.add_js_link(jquery_js)
+        activate_jquery_script = (
+            '''var script = document.createElement('script');'''
+            '''script.src = "%s";document.getElementsByTagName('head')[0]'''
+            '''.appendChild(script);''' % jquery_js)
+        self.execute_script(activate_jquery_script)
         for x in range(int(settings.MINI_TIMEOUT * 10.0)):
             # jQuery needs a small amount of time to activate.
             try:
@@ -966,8 +976,6 @@ def __activate_shepherd(self):
         sh_theme_sq_css = constants.Shepherd.THEME_SQ_CSS
         sh_theme_sq_dark_css = constants.Shepherd.THEME_SQ_DK_CSS
         tether_js = constants.Tether.MIN_JS
-        underscore_js = constants.Underscore.MIN_JS
-        backbone_js = constants.Backbone.MIN_JS
         spinner_css = constants.Messenger.SPINNER_CSS
 
         sh_style = style_sheet.sh_style_test
@@ -987,8 +995,6 @@ def __activate_shepherd(self):
             self.add_css_link(sh_theme_sq_css)
             self.add_css_link(sh_theme_sq_dark_css)
             self.add_js_link(tether_js)
-            self.add_js_link(underscore_js)
-            self.add_js_link(backbone_js)
             self.add_js_link(shepherd_js)
             time.sleep(0.1)
 
@@ -1085,7 +1091,7 @@ def create_shepherd_tour(self, name=None, theme=None):
         new_tour = (
             """
             // Shepherd Tour
-            let tour = new Shepherd.Tour({
+            var tour = new Shepherd.Tour({
                 defaults: {
                     classes: '%s',
                     scrollTo: true
@@ -1399,7 +1405,10 @@ def __play_shepherd_tour(self, name=None, interval=0):
         instructions = ""
         for tour_step in self._tour_steps[name]:
             instructions += tour_step
-        instructions += "tour.start();"
+        instructions += ("""
+            // Start the tour
+            tour.start();
+            $tour = tour;""")
 
         autoplay = False
         if interval and interval > 0:
@@ -1524,8 +1533,11 @@ def __play_bootstrap_tour(self, name=None, interval=0):
             // Start the tour
             tour.start();
 
-            $tour = tour;
-            $tour.restart();""")
+            // Fix timing issue by restarting tour immediately
+            tour.restart();
+
+            // Save for later
+            $tour = tour;""")
 
         if interval and interval > 0:
             if interval < 1:
@@ -1727,8 +1739,9 @@ def __play_introjs_tour(self, name=None, interval=0):
             intro.setOption("showStepNumbers", false);
             intro.setOption("showProgress", false);
             intro.start();
-            $intro = intro;
-            }
+            $tour = intro;
+            };
+            // Start the tour
             startIntro();
             """)
 
@@ -1774,7 +1787,7 @@ def __play_introjs_tour(self, name=None, interval=0):
                 time.sleep(0.01)
                 if self.browser != "firefox":
                     result = self.execute_script(
-                        "return $intro._currentStep")
+                        "return $tour._currentStep")
                 else:
                     self.wait_for_element_present(
                         ".introjs-tooltip", timeout=0.4)
@@ -1787,7 +1800,7 @@ def __play_introjs_tour(self, name=None, interval=0):
                 if autoplay:
                     try:
                         current_step = self.execute_script(
-                            "return $intro._currentStep")
+                            "return $tour._currentStep")
                     except Exception:
                         continue
                     if current_step != latest_step:
@@ -1797,10 +1810,10 @@ def __play_introjs_tour(self, name=None, interval=0):
                     now_ms = time.time() * 1000.0
                     if now_ms >= stop_ms:
                         if current_step == latest_step:
-                            self.execute_script("return $intro.nextStep()")
+                            self.execute_script("return $tour.nextStep()")
                             try:
                                 latest_step = self.execute_script(
-                                    "return $intro._currentStep")
+                                    "return $tour._currentStep")
                                 start_ms = time.time() * 1000.0
                                 stop_ms = start_ms + (interval * 1000.0)
                             except Exception:
@@ -1811,7 +1824,7 @@ def __play_introjs_tour(self, name=None, interval=0):
                     time.sleep(0.01)
                     if self.browser != "firefox":
                         result = self.execute_script(
-                            "return $intro._currentStep")
+                            "return $tour._currentStep")
                     else:
                         self.wait_for_element_present(
                             ".introjs-tooltip", timeout=0.4)