j1_template 2019.4.8 → 2019.4.10

data/lib/starter_web/assets/themes/j1/adapter/js/octokit.js

@@ -72,8 +72,7 @@ j1.adapter['octokit'] = (function (j1, window) {
 
   {% comment %} Global variables
   ------------------------------------------------------------------------------ {% endcomment %}
-  var environment               = '{{environment}}'; // Set environment
-  var state                     = 'not_started';
+  var environment               = '{{environment}}';
   var moduleOptions             = {};
   var cookie_names              = j1.getCookieNames();
   var cookie_user_session_name  = cookie_names.user_session;
@@ -100,46 +99,47 @@ j1.adapter['octokit'] = (function (j1, window) {
       // Load  module DEFAULTS|CONFIG
       moduleOptions = $.extend({}, {{webhook_options | replace: '=>', ':' | replace: 'nil', '""'}});
 
+      if (j1.checkUserAgent('IE') || j1.checkUserAgent('Edge')) {
+        moduleOptions.enabled = false;
+        logger.warn('Browser does not support Server Side Events (SSE)');
+        logger.warn('WebHooks disabled');
+      }
+
       if ( moduleOptions.enabled ) {
         logger.info('WebHooks enabled, run initialization');
 
-        // Initialize WebHooks if page is FULLY initialized
-        var pageLoaded = setInterval(function() {
-          if ( j1.getState() == 'finished') {
-            // clear interval checking
-            clearInterval(pageLoaded);        
-
-            // Set|Log status
-            state = 'initialize';
-            logger.info('state: ' + state);
-            logger.info('Module is being initialized');
-
-            // Load webhook modals
-            $.when( j1.xhrLoadData('j1.adapter.octokit', moduleOptions))
-            .then (function (success) {
-              if (success) {
-                // Run initializers if webhook modals are LOADED
-                var dataLoaded = setInterval(function() {
-                  if ( j1.adapter.octokit.getState() == 'finished') {
-                    // clear interval checking
-                    clearInterval(dataLoaded);
-                    logger.info('Loading modal HTML data finished');
-                    // Run initializers        
-                    j1.core.octokit.init(moduleOptions);
-                    j1.adapter.octokit.eventHandler(moduleOptions);
-                  }
-                }, 25); // END 'dataLoaded'
-              } else {
-                logger.error('Loading modal HTML data failed');
-                state = j1.adapter.octokit.getState();
-                logger.info('state: ' + state);
+        _this.setState('started');
+        logger.info('state: ' + _this.getState());
+        logger.info('module is being initialized');
+
+        // Load webhook modals
+        logger.info('loading HTML data for modals');
+        $.when (j1.xhrDATA('j1.adapter.octokit', moduleOptions , 'data_loaded'))
+        .then (function (success) {
+          if (success) {
+            // Run initializers if webhook modals are LOADED
+            var dependencies_met_modals_loaded = setInterval(function() {
+              if ( j1.adapter.octokit.getState() == 'data_loaded') {
+                logger.info('loading data completed');
+                // Run initializers
+                j1.core.octokit.init(moduleOptions);
+                j1.adapter.octokit.eventHandler(moduleOptions);
+                _this.setState('finished');
+                logger.info('state: ' + _this.getState());
+                // clear interval checking
+                clearInterval(dependencies_met_modals_loaded);
               }
-            });
-
-          } // END if getState 'finished'
-        }, 25); // END 'pageLoaded'
+            }, 25); // END 'dataLoaded'
+          } else {
+            _this.setState('finished');
+            logger.info('state: ' + _this.getState());
+            logger.error('Loading modal HTML data failed');
+          }
+        });
         return true;
       } else {
+        _this.setState('finished');
+        logger.info('state: ' + _this.getState());
         logger.info('WebHooks disabled. Initialization skipped');
         return false;
       } // END if moduleOptions enabled
@@ -174,22 +174,22 @@ j1.adapter['octokit'] = (function (j1, window) {
           if (this.id === 'acceptGitPullButton') {
             logger.info('User clicked acceptGitPullButton');
 
-            $.when( j1.xhrAPI('http://localhost:41001/git?request=pull') )
-              .then( function ( response ) {
-                json_message = JSON.stringify(response, undefined, 2);
+            $.when (j1.xhrAPI('http://localhost:41001/git?request=pull'))
+            .then (function (response) {
+              json_message = JSON.stringify(response, undefined, 2);
 
-                logText = 'Response received: ' + json_message;
-                logger.info(logText);
-              
-                if ( response.status === 'success' ) {                
-                  $('#gitPullSuccess').find('.pull-message').html(response.response);
-                  $('#gitPullSuccess').modal('show');
-                }
+              logText = 'Response received: ' + json_message;
+              logger.info(logText);
+
+              if ( response.status === 'success' ) {
+                $('#gitPullSuccess').find('.pull-message').html(response.response);
+                $('#gitPullSuccess').modal('show');
+              }
 
             });
 
-            // false == prevent further event propagation (bubble up) 
-            // like preventDefault()                
+            // false == prevent further event propagation (bubble up)
+            // like preventDefault()
             return false;
           }
 
@@ -197,7 +197,7 @@ j1.adapter['octokit'] = (function (j1, window) {
           // ---------------------------------------------------------------
           if (this.id === 'declineGitPullButton') {
             logger.info('User clicked declineGitPullButton');
-        
+
             return false;
           }
 
@@ -212,7 +212,7 @@ j1.adapter['octokit'] = (function (j1, window) {
             //   message.type    = 'command'
             //   message.action  = 'pull'
             //   message.text    = 'Run Git pull'
-            // 
+            //
             //   j1.sendMessage( 'j1.adapter.octokit', 'j1.core.octokit', message );
             // }
 
@@ -238,11 +238,11 @@ j1.adapter['octokit'] = (function (j1, window) {
 
           // Autohide modal if configured
           if ( options.commit_detection.modal_commit_detected.autohide) {
-            var modalTimeOut = setInterval(function() {
+            var timeout = setInterval(function() {
               $('#webhookCommitDetected').modal('hide');
               logger.info('Hide modal on timeout');
               // clear interval checking
-              clearInterval(modalTimeOut);
+              clearInterval(timeout);
             }, options.commit_detection.modal_commit_detected.autohidden);
           }
 
@@ -256,25 +256,25 @@ j1.adapter['octokit'] = (function (j1, window) {
 
       // Register pre/post events for modal 'gitPullSuccess'
       // -------------------------------------------------------------------
-      $(document).on('shown.bs.modal','#gitPullSuccess', 
+      $(document).on('shown.bs.modal','#gitPullSuccess',
         function () {
           logger.info('Display gitPullSuccess');
 
           // Autohide modal if configured
           if ( options.commit_detection.modal_pull_response.autohide) {
-            var modalTimeOut = setInterval(function() {
+            var timeout = setInterval(function() {
               $('#gitPullSuccess').modal('hide');
               logger.info('Hide modal on timeout');
               // clear interval checking
-              clearInterval(modalTimeOut);
+              clearInterval(timeout);
             }, options.commit_detection.modal_pull_response.autohidden);
           }
 
       }); // END shown modal 'gitPullSuccess'
 
-      $(document).on('hidden.bs.modal','#gitPullSuccess', 
-        function () {    
-                      
+      $(document).on('hidden.bs.modal','#gitPullSuccess',
+        function () {
+
           logger.info('Post processing on gitPullSuccess');
 
           if ( options.utility_server.npm_client.enabled ) {
@@ -283,7 +283,7 @@ j1.adapter['octokit'] = (function (j1, window) {
             // -------------------------------------------------------------
             message.type    = 'command'
             message.action  = 'built'
-            message.text    = 'Run NPM built'              
+            message.text    = 'Run NPM built'
             j1.sendMessage( 'j1.adapter.octokit', 'j1.core.octokit', message );
           }
         }
@@ -292,24 +292,24 @@ j1.adapter['octokit'] = (function (j1, window) {
 
       // Register pre/post events for modal 'npmScriptSuccess'
       // -------------------------------------------------------------------
-      $(document).on('shown.bs.modal','#npmScriptSuccess', 
+      $(document).on('shown.bs.modal','#npmScriptSuccess',
         function () {
           logger.info('Display npmScriptSuccess');
 
           // Autohide modal if configured
           if ( options.commit_detection.modal_pull_response.autohide) {
-            var modalTimeOut = setInterval(function() {
+            var timeout = setInterval(function() {
               $('#npmScriptSuccess').modal('hide');
               logger.info('Hide modal on timeout');
               // clear interval checking
-              clearInterval(modalTimeOut);
+              clearInterval(timeout);
             }, options.commit_detection.modal_pull_response.autohidden);
           }
 
       }); // END shown modal 'npmScriptSuccess'
 
-      $(document).on('hidden.bs.modal','#npmScriptSuccess', 
-        function () {                              
+      $(document).on('hidden.bs.modal','#npmScriptSuccess',
+        function () {
           logger.info('Post processing on npmScriptSuccess');
       }); // END hidden modal 'npmScriptSuccess'
 
@@ -323,9 +323,9 @@ j1.adapter['octokit'] = (function (j1, window) {
     // messageHandler
     // Manage messages send from other J1 modules
     // -------------------------------------------------------------------------
-    messageHandler: function ( sender, message ) {  
-      var json_message = JSON.stringify(message, undefined, 2);  
-  
+    messageHandler: function ( sender, message ) {
+      var json_message = JSON.stringify(message, undefined, 2);
+
       logText = 'Received message from ' + sender + ': ' + json_message;
       logger.debug(logText);
 
@@ -336,7 +336,9 @@ j1.adapter['octokit'] = (function (j1, window) {
       // -----------------------------------------------------------------------
       //  Command message (action), type 'module_initialized'
       if ( message.type === 'command' && message.action === 'module_initialized' ) {
-        _this.setState('finished');
+        //
+        // Place handling of command|action here
+        //
         logger.info(message.text);
       }
 
@@ -348,22 +350,22 @@ j1.adapter['octokit'] = (function (j1, window) {
         logText = 'Processing message from ' + sender + ', type: ' + message.type + ', action: ' + message.action;
         logger.info(logText);
 
-        $.when( j1.xhrAPI(url) )
-          .then( function( response ) {
-            json_message = JSON.stringify(response, undefined, 2);
+        $.when (j1.xhrAPI(url))
+        .then (function(response) {
+          json_message = JSON.stringify(response, undefined, 2);
 
-            logText = 'Response from xhrAPI received: ' + json_message;
-            logger.info(logText);
+          logText = 'Response from xhrAPI received: ' + json_message;
+          logger.info(logText);
 
-            if ( response.status === 'success' ) {                 
-              $('#gitPullSuccess').find('.pull-message').html(response.response);
-              $('#gitPullSuccess').modal('show');
-            }
+          if ( response.status === 'success' ) {
+            $('#gitPullSuccess').find('.pull-message').html(response.response);
+            $('#gitPullSuccess').modal('show');
+          }
 
-            if ( response.status === 'failed' ) {                 
-              $('#requestFailed').find('.pull-message').html(response.response + response.error);
-              $('#requestFailed').modal('show');
-            }
+          if ( response.status === 'failed' ) {
+            $('#requestFailed').find('.pull-message').html(response.response + response.error);
+            $('#requestFailed').modal('show');
+          }
         });
       } // ENDIF message action 'pull'
 
@@ -376,23 +378,22 @@ j1.adapter['octokit'] = (function (j1, window) {
         logText = 'Processing message from ' + sender + ', type: ' + message.type + ', action: ' + message.action;
         logger.info(logText);
 
-        $.when( j1.xhrAPI(url) )
-          .then( function( response ) {
-            json_message = JSON.stringify(response, undefined, 2);
+        $.when (j1.xhrAPI(url))
+        .then (function(response) {
+          json_message = JSON.stringify(response, undefined, 2);
 
-            logText = 'Response from xhrAPI received: ' + json_message;
-            logger.info(logText);
-                          
-            if ( response.status === 'success' ) {                 
-              $('#npmScriptSuccess').find('.pull-message').html(response.response);
-              $('#npmScriptSuccess').modal('show');
-            }
+          logText = 'Response from xhrAPI received: ' + json_message;
+          logger.info(logText);
 
-            if ( response.status === 'failed' ) {                 
-              $('#requestFailed').find('.pull-message').html(response.response + response.error);
-              $('#requestFailed').modal('show');
-            }
+          if ( response.status === 'success' ) {
+            $('#npmScriptSuccess').find('.pull-message').html(response.response);
+            $('#npmScriptSuccess').modal('show');
+          }
 
+          if ( response.status === 'failed' ) {
+            $('#requestFailed').find('.pull-message').html(response.response + response.error);
+            $('#requestFailed').modal('show');
+          }
         });
       } // END message action 'pull'
 
@@ -407,14 +408,14 @@ j1.adapter['octokit'] = (function (j1, window) {
     //  Set the current (processing) state of the module
     // -------------------------------------------------------------------------
     setState: function ( stat ) {
-      state = stat;
+      j1.adapter.octokit.state = stat;
     }, // END setState
 
     // -------------------------------------------------------------------------
     //  Returns the current (processing) state of the module
     // -------------------------------------------------------------------------
     getState: function () {
-      return state;
+      return j1.adapter.octokit.state;
     } // END state
 
   }; // END return
@@ -424,4 +425,4 @@ j1.adapter['octokit'] = (function (j1, window) {
 {% endcapture %}
 
 {{ cache | strip_empty_lines }}
-{% assign cache = nil %}
+{% assign cache = nil %}

data/lib/starter_web/assets/themes/j1/adapter/js/scroller.js

@@ -78,7 +78,6 @@ j1.adapter['scroller'] = (function (j1, window) {
   {% comment %} Set global variables
   ------------------------------------------------------------------------------ {% endcomment %}
   var environment   = '{{environment}}';
-  var state         = 'not_started';
   var moduleOptions = {};
   var _this;
   var logger;
@@ -93,14 +92,16 @@ j1.adapter['scroller'] = (function (j1, window) {
     // Initializer
     // -------------------------------------------------------------------------
     init: function () {
+      // initialize state flag
+      j1.adapter.scroller.state = 'pending';
 
       {% comment %} Set global variables
       -------------------------------------------------------------------------- {% endcomment %}
       _this   = j1.adapter.scroller;
       logger  = log4javascript.getLogger('j1.adapter.scroller');
 
-      state = 'started';
-      logger.info('state: ' + state);
+      _this.setState('started');
+      logger.info('state: ' + _this.getState());
       logger.info('Module is being initialized');
 
       SmoothScroll({
@@ -119,9 +120,8 @@ j1.adapter['scroller'] = (function (j1, window) {
         excluded:               {{ smooth_scroll_options.excluded | json }},
       });
 
-      state = 'finished';
-      logger.info('state: ' + state);
-      logger.info("SmoothScroll initialized successfully");
+      _this.setState('finished');
+      logger.info('state: ' + _this.getState());
 
       return true;
     }, // END init
@@ -130,9 +130,9 @@ j1.adapter['scroller'] = (function (j1, window) {
     // messageHandler: MessageHandler for J1 NAV module
     // Manage messages (paylods) send from other J1 modules
     // -------------------------------------------------------------------------
-    messageHandler: function ( sender, message ) {  
-      var json_message = JSON.stringify(message, undefined, 2);  
-  
+    messageHandler: function ( sender, message ) {
+      var json_message = JSON.stringify(message, undefined, 2);
+
       logText = 'Received message from ' + sender + ': ' + json_message;
       logger.debug(logText);
 
@@ -140,7 +140,9 @@ j1.adapter['scroller'] = (function (j1, window) {
       //  Process commands|actions
       // -----------------------------------------------------------------------
       if ( message.type === 'command' && message.action === 'module_initialized' ) {
-        _this.setState('finished');
+        //
+        // Place handling of command|action here
+        //
         logger.info(message.text);
       }
 
@@ -152,17 +154,19 @@ j1.adapter['scroller'] = (function (j1, window) {
     }, // END messageHandler
 
     // -------------------------------------------------------------------------
-    //  Set the current (processing) state of the module
+    // setState
+    // Set the current (processing) state of the module
     // -------------------------------------------------------------------------
-    setState: function ( stat ) {
-      state = stat;
+    setState: function (stat) {
+      j1.adapter.scroller.state = stat;
     }, // END setState
 
     // -------------------------------------------------------------------------
-    //  Returns the current (processing) state of the module
+    // getState
+    // Returns the current (processing) state of the module
     // -------------------------------------------------------------------------
     getState: function () {
-      return state;
+      return j1.adapter.scroller.state;
     } // END state
 
   }; // END return

data/lib/starter_web/assets/themes/j1/adapter/js/searcher.js

@@ -73,11 +73,10 @@ j1.adapter['searcher'] = (function (j1, window) {
 
   {% comment %} Set global variables
   ------------------------------------------------------------------------------ {% endcomment %}
-  var environment   = '{{environment}}'; // Set environment
-  var state         = 'not_started';
+  var environment   = '{{environment}}';
   var moduleOptions = {};
   var _this;
-  var logger; 
+  var logger;
   var logText;
 
   // ---------------------------------------------------------------------------
@@ -89,6 +88,8 @@ j1.adapter['searcher'] = (function (j1, window) {
     // Initializer
     // -------------------------------------------------------------------------
     init: function (options) {
+      // initialize state flag
+      j1.adapter.searcher.state = 'pending';
 
       // -----------------------------------------------------------------------
       // Default module settings
@@ -101,20 +102,20 @@ j1.adapter['searcher'] = (function (j1, window) {
       {% comment %} Set global variables
       -------------------------------------------------------------------------- {% endcomment %}
       _this   = j1.adapter.searcher;
-      logger  = log4javascript.getLogger('j1.adapter.searcher'); 
+      logger  = log4javascript.getLogger('j1.adapter.searcher');
 
       {% comment %} Load module config from yml data
       -------------------------------------------------------------------------- {% endcomment %}
       // Load  module DEFAULTS|CONFIG
       moduleOptions = $.extend({}, {{jekyll_search_options | replace: '=>', ':' | replace: 'nil', '""'}});
 
-      if ( typeof settings !== 'undefined') { 
+      if ( typeof settings !== 'undefined') {
         moduleOptions = j1.mergeData( moduleOptions, settings );
-      }            
+      }
 
       if (moduleOptions.enabled) {
-        state   = 'started';
-        logger.info('state: ' + state);
+        _this.setState('started');
+        logger.info('state: ' + _this.getState());
         logger.info('Module is being initialized');
 
         var jekyllSearch = SimpleJekyllSearch({
@@ -129,23 +130,15 @@ j1.adapter['searcher'] = (function (j1, window) {
           exclude:              moduleOptions.search_exlude,
           noResultsText:        moduleOptions.no_results_text
         });
+
+        _this.setState('finished');
+        logger.info('state: ' + _this.getState());
       } else {
-        // var delayLog = setInterval(function() {
-        //   if ( j1.getState() === 'finished' ) {
-            state   = 'disabled';
-            logger.info('state: ' + state);
-            logger.info("J1 QuickSearch disabled");
-
-            // clear interval checking
-        //     clearInterval(delayLog);
-        //   } // END Manage cookie consent dialog
-        // }, 50); // END setInterval
+        _this.setState('finished');
+        logger.info('state: ' + _this.getState());
+        logger.info("module disabled");
       }
 
-      // state = 'finished';
-      // logger.info("Jekyll Search initialized successfully");
-      // logger.info('state: ' + state); // Set|Log status
-
       return true;
     }, // END init
 
@@ -153,9 +146,9 @@ j1.adapter['searcher'] = (function (j1, window) {
     // messageHandler: MessageHandler for J1 CookieConsent module
     // Manage messages send from other J1 modules
     // -------------------------------------------------------------------------
-    messageHandler: function ( sender, message ) {  
-      var json_message = JSON.stringify(message, undefined, 2);  
-  
+    messageHandler: function ( sender, message ) {
+      var json_message = JSON.stringify(message, undefined, 2);
+
       logText = 'Received message from ' + sender + ': ' + json_message;
       logger.info(logText);
 
@@ -163,7 +156,9 @@ j1.adapter['searcher'] = (function (j1, window) {
       //  Process commands|actions
       // -----------------------------------------------------------------------
       if ( message.type === 'command' && message.action === 'module_initialized' ) {
-        _this.setState('finished');
+        //
+        // Place handling of command|action here
+        //
         logger.info(message.text);
       }
 
@@ -175,17 +170,19 @@ j1.adapter['searcher'] = (function (j1, window) {
     }, // END messageHandler
 
     // -------------------------------------------------------------------------
-    //  Set the current (processing) state of the module
+    // setState
+    // Set the current (processing) state of the module
     // -------------------------------------------------------------------------
     setState: function ( stat ) {
-      state = stat;
+      j1.adapter.searcher.state = stat;
     }, // END setState
 
     // -------------------------------------------------------------------------
-    //  Returns the current (processing) state of the module
+    // getState
+    // Returns the current (processing) state of the module
     // -------------------------------------------------------------------------
     getState: function () {
-      return state;
+      return j1.adapter.searcher.state;
     } // END state
 
   }; // END return