Merge pull request #1508 from jeff-phillips-18/tour

Merged by openshift-bot

Author: OpenShift Bot

app/scripts/controllers/landingPage.js

@@ -3,18 +3,32 @@
 angular.module('openshiftConsole')
   .controller('LandingPageController',
               function($scope,
+                       $rootScope,
                        AuthService,
                        Catalog,
                        Constants,
                        Navigate,
                        NotificationsService,
-                       RecentlyViewedServiceItems) {
+                       RecentlyViewedServiceItems,
+                       GuidedTourService,
+                       $timeout,
+                       $routeParams,
+                       $location) {
+    var tourConfig = _.get(Constants, 'GUIDED_TOURS.landing_page_tour');
+    var tourEnabled = tourConfig && tourConfig.enabled && tourConfig.steps;
+
     $scope.saasOfferings = Constants.SAAS_OFFERINGS;
 
     $scope.viewMembership = function(project) {
       Navigate.toProjectMembership(project.metadata.name);
     };
 
+    if (tourEnabled) {
+      $scope.startGuidedTour = function (onDone) {
+        GuidedTourService.startTour(tourConfig.steps, onDone);
+      };
+    }
+
     // Currently this is the only page showing notifications, clear any that came previous pages.
     // Once all pages show notifications this should be removed.
     NotificationsService.clearNotifications();
@@ -39,6 +53,7 @@ angular.module('openshiftConsole')
       var includeTemplates = !_.get(Constants, 'ENABLE_TECH_PREVIEW_FEATURE.template_service_broker');
       Catalog.getCatalogItems(includeTemplates).then(function(items) {
         $scope.catalogItems = items;
+        dataLoaded();
       });
     });
 
@@ -47,4 +62,33 @@ angular.module('openshiftConsole')
       // add the item to recently-viewed. No-op if the dialog is not open.
       addTemplateToRecentlyViewed();
     });
+
+    function dataLoaded() {
+      if (!tourEnabled) {
+        return;
+      }
+
+      if ($routeParams.startTour) {
+        $timeout(function() {
+          $scope.startGuidedTour(resetRouteParams);
+        }, 500);
+      } else if (_.get(tourConfig, 'auto_launch')) {
+        // Check if this is the first time this user has visited the home page, if so launch the tour
+        var viewedHomePageKey = "openshift/viewedHomePage/" + $rootScope.user.metadata.name;
+        if (localStorage.getItem(viewedHomePageKey) !== 'true') {
+          $timeout(function() {
+            localStorage.setItem(viewedHomePageKey, 'true');
+            $scope.startGuidedTour();
+          }, 500);
+        }
+      }
+    }
+
+    function resetRouteParams() {
+      // Reset the route params in the next digest cycle
+      $timeout(function() {
+        $location.replace();
+        $location.search('startTour', null);
+      });
+    }
   });

app/scripts/extensions/nav/helpDropdown.js

@@ -6,19 +6,38 @@ angular.module('openshiftConsole')
   .run(function(extensionRegistry) {
     extensionRegistry
       .add('nav-help-dropdown', function() {
-        return [
+        var options = [];
+        options.push(
           {
             type: 'dom',
             node: '<li><a target="_blank" href="{{\'default\' | helpLink}}">Documentation</a></li>'
-          },
+          }
+        );
+
+        if (_.get(window, 'OPENSHIFT_CONSTANTS.ENABLE_TECH_PREVIEW_FEATURE.service_catalog_landing_page')) {
+          var tourConfig = _.get(window, 'OPENSHIFT_CONSTANTS.GUIDED_TOURS.landing_page_tour');
+          if (tourConfig && tourConfig.enabled && tourConfig.steps) {
+            options.push(
+              {
+                type: 'dom',
+                node: '<li><a href="./?startTour=true">Tour Home Page</a></li>'
+              }
+            );
+          }
+        }
+
+        options.push(
           {
             type: 'dom',
             node: '<li><a href="command-line">Command Line Tools</a></li>'
-          },
+          }
+        );
+        options.push(
           {
             type: 'dom',
             node: '<li><a href="about">About</a></li>'
           }
-        ];
-      });
+        );
+        return options;
+      })
   });

app/views/landing-page.html

@@ -22,7 +22,7 @@
               <services-view catalog-items="catalogItems" base-project-url="project"></services-view>
             </landingbody>
             <landingside>
-              <projects-summary base-project-url="project" projects-url="projects" view-edit-membership="viewMembership" catalog-items="catalogItems"></projects-summary>
+              <projects-summary base-project-url="project" projects-url="projects" start-tour="startGuidedTour" view-edit-membership="viewMembership" catalog-items="catalogItems"></projects-summary>
             </landingside>
           </landing-page>
         </div><!-- /middle-content -->

dist/scripts/scripts.js

@@ -4652,25 +4652,43 @@ _.set(this, "selectedTab.networking", !0), b(this);
 }
 }
 };
-}), angular.module("openshiftConsole").controller("LandingPageController", [ "$scope", "AuthService", "Catalog", "Constants", "Navigate", "NotificationsService", "RecentlyViewedServiceItems", function(a, b, c, d, e, f, g) {
-a.saasOfferings = d.SAAS_OFFERINGS, a.viewMembership = function(a) {
-e.toProjectMembership(a.metadata.name);
-}, f.clearNotifications();
-var h = function() {
+}), angular.module("openshiftConsole").controller("LandingPageController", [ "$scope", "$rootScope", "AuthService", "Catalog", "Constants", "Navigate", "NotificationsService", "RecentlyViewedServiceItems", "GuidedTourService", "$timeout", "$routeParams", "$location", function(a, b, c, d, e, f, g, h, i, j, k, l) {
+function m() {
+if (p) if (k.startTour) j(function() {
+a.startGuidedTour(n);
+}, 500); else if (_.get(o, "auto_launch")) {
+var c = "openshift/viewedHomePage/" + b.user.metadata.name;
+"true" !== localStorage.getItem(c) && j(function() {
+localStorage.setItem(c, "true"), a.startGuidedTour();
+}, 500);
+}
+}
+function n() {
+j(function() {
+l.replace(), l.search("startTour", null);
+});
+}
+var o = _.get(e, "GUIDED_TOURS.landing_page_tour"), p = o && o.enabled && o.steps;
+a.saasOfferings = e.SAAS_OFFERINGS, a.viewMembership = function(a) {
+f.toProjectMembership(a.metadata.name);
+}, p && (a.startGuidedTour = function(a) {
+i.startTour(o.steps, a);
+}), g.clearNotifications();
+var q = function() {
 var b = _.get(a, "template.metadata.uid");
-b && g.addItem(b);
+b && h.addItem(b);
 };
 a.templateSelected = function(b) {
 a.template = b;
 }, a.templateDialogClosed = function() {
-h(), a.template = null;
-}, b.withUser().then(function() {
-var b = !_.get(d, "ENABLE_TECH_PREVIEW_FEATURE.template_service_broker");
-c.getCatalogItems(b).then(function(b) {
-a.catalogItems = b;
+q(), a.template = null;
+}, c.withUser().then(function() {
+var b = !_.get(e, "ENABLE_TECH_PREVIEW_FEATURE.template_service_broker");
+d.getCatalogItems(b).then(function(b) {
+a.catalogItems = b, m();
 });
 }), a.$on("$destroy", function() {
-h();
+q();
 });
 } ]), angular.module("openshiftConsole").controller("ProjectsController", [ "$scope", "$filter", "$location", "$route", "$timeout", "AlertMessageService", "AuthService", "DataService", "KeywordService", "Logger", "ProjectsService", function(a, b, c, d, e, f, g, h, i, j, k) {
 var l, m, n = [], o = [];
@@ -15612,16 +15630,24 @@ url:l
 } ]), hawtioPluginLoader.addModule(a);
 }(), angular.module("openshiftConsole").run([ "extensionRegistry", function(a) {
 a.add("nav-help-dropdown", function() {
-return [ {
+var a = [];
+if (a.push({
 type:"dom",
 node:'<li><a target="_blank" href="{{\'default\' | helpLink}}">Documentation</a></li>'
-}, {
+}), _.get(window, "OPENSHIFT_CONSTANTS.ENABLE_TECH_PREVIEW_FEATURE.service_catalog_landing_page")) {
+var b = _.get(window, "OPENSHIFT_CONSTANTS.GUIDED_TOURS.landing_page_tour");
+b && b.enabled && b.steps && a.push({
+type:"dom",
+node:'<li><a href="./?startTour=true">Tour Home Page</a></li>'
+});
+}
+return a.push({
 type:"dom",
 node:'<li><a href="command-line">Command Line Tools</a></li>'
-}, {
+}), a.push({
 type:"dom",
 node:'<li><a href="about">About</a></li>'
-} ];
+}), a;
 });
 } ]), angular.module("openshiftConsole").run([ "extensionRegistry", function(a) {
 a.add("nav-user-dropdown", function() {

dist/scripts/templates.js

@@ -10421,7 +10421,7 @@ angular.module('openshiftConsoleTemplates', []).run(['$templateCache', function(
     "<services-view catalog-items=\"catalogItems\" base-project-url=\"project\"></services-view>\n" +
     "</landingbody>\n" +
     "<landingside>\n" +
-    "<projects-summary base-project-url=\"project\" projects-url=\"projects\" view-edit-membership=\"viewMembership\" catalog-items=\"catalogItems\"></projects-summary>\n" +
+    "<projects-summary base-project-url=\"project\" projects-url=\"projects\" start-tour=\"startGuidedTour\" view-edit-membership=\"viewMembership\" catalog-items=\"catalogItems\"></projects-summary>\n" +
     "</landingside>\n" +
     "</landing-page>\n" +
     "</div>\n" +