Reflect page title in document title

components/portal/main/main_service_spec.js

@@ -0,0 +1,117 @@
+/*
+ * Licensed to Apereo under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work
+ * for additional information regarding copyright ownership.
+ * Apereo licenses this file to you 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 the following location:
+ *
+ *   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.
+ */
+'use strict';
+/* eslint-env node */
+/* global inject */
+define(['angular-mocks', 'portal'], function() {
+    describe('mainService', function() {
+        var service;
+
+        var loginSilentUrl;
+        var httpBackend;
+
+        var $document;
+        var $scope;
+        var NAMES;
+
+        beforeEach(function() {
+          module('portal');
+        });
+
+        beforeEach(inject(function(
+          _mainService_, _$httpBackend_,
+          _$document_, _$rootScope_,
+          SERVICE_LOC, MESSAGES, APP_FLAGS, _NAMES_
+        ) {
+          $scope = _$rootScope_.$new();
+          service = _mainService_;
+          $document = _$document_;
+          httpBackend = _$httpBackend_;
+          NAMES = _NAMES_;
+          loginSilentUrl = APP_FLAGS.loginOnLoad;
+
+          if (loginSilentUrl) {
+            httpBackend.whenGET(loginSilentUrl)
+            .respond({'status': 'success', 'username': 'admin'});
+          }
+
+          httpBackend.whenGET(SERVICE_LOC.sessionInfo).respond();
+        }));
+
+        it('should set title to MyUW'
+        + 'when MyUW is both portal name and app name '
+        + 'and there is no page name', function() {
+          // setup
+          NAMES.title = 'MyUW';
+          $scope.portal.theme.title = 'MyUW';
+
+          // test
+          service.setTitle();
+
+          expect($document[0].title).toEqual('MyUW');
+
+          httpBackend.flush();
+        });
+
+        it('should set title to STAR | MyUW '
+        + 'when STAR is app name and MyUW is portal name '
+        + 'and there is no page name', function() {
+          // setup
+          NAMES.title = 'STAR';
+          $scope.portal.theme.title = 'MyUW';
+
+          // test
+          service.setTitle();
+
+          expect($document[0].title).toEqual('STAR | MyUW');
+
+          httpBackend.flush();
+        });
+
+        it('should set title to Timesheets | STAR | MyUW '
+        + 'when STAR is app name and MyUW is portal name '
+        + 'and Timesheets is page name', function() {
+          // setup
+          NAMES.title = 'STAR';
+          $scope.portal.theme.title = 'MyUW';
+
+          // test
+          service.setTitle('Timesheets');
+
+          expect($document[0].title).toEqual('Timesheets | STAR | MyUW');
+
+          httpBackend.flush();
+        });
+
+        it('should set title to Notifications | MyUW '
+        + 'when MyUW is app name and MyUW is portal name '
+        + 'and Notifications is page name', function() {
+          // setup
+          NAMES.title = 'MyUW';
+          $scope.portal.theme.title = 'MyUW';
+
+          // test
+          service.setTitle('Notifications');
+
+          expect($document[0].title).toEqual('Notifications | MyUW');
+
+          httpBackend.flush();
+        });
+    });
+});

components/portal/main/services.js

@@ -64,20 +64,78 @@ define(['angular'], function(angular) {
     };
 
       /**
-       * set the frame title using theme
+       * set the window title
+       *
+       * results in title
+       * page-title | app-title | portal-title (in an application), or
+       * page-title | portal-title (if the app has same name as the portal), or
+       * app-title | portal-title (if page name unknown or redundant)
+       * portal-title (if page name unknown or redundant and app name redundant)
+       *
+       * Examples:
+       * "Timesheets | STAR Time Entry | MyUW" ,
+       * for the Timesheets page in an app named "STAR Time Entry" in
+       * a portal named "MyUW", or
+       *
+       * "Notifications | MyUW",
+       * for the notifications page in an app named "MyUW" in
+       * a portal named "MyUW".
+       *
+       * "STAR Time Entry | MyUW"
+       * in an app named "STAR Time Entry" in a portal named "MyUW"
+       * when the page name is unspecified.
+       *
+       * "MyUW"
+       * in an app named "MyUW" in a portal named "MyUW"
+       * when the page name is unspecified.
        */
-      function setTitle() {
-        var frameTitle = '';
-        if ($rootScope.portal && $rootScope.portal.theme) {
-          frameTitle = $rootScope.portal.theme.title;
-          if (frameTitle !== NAMES.title && !APP_FLAGS.isWeb) {
-            frameTitle = ' | ' + frameTitle;
-          } else {
-            // since frame title equals the title in NAMES lets not duplicate it
-            frameTitle = '';
+      function setTitle(pageTitle) {
+        var windowTitle = ''; // we finally set the window title to this.
+
+        // first, gather pieces of the desired window title
+
+        var portalTitle = ''; // the name of the portal if we can determine it
+        var appTitle = ''; // the name of the app
+
+        if ($rootScope.portal && $rootScope.portal.theme &&
+              $rootScope.portal.theme.title) {
+          // there's an active theme with a title.
+          // consider that title the name of the portal
+          portalTitle = $rootScope.portal.theme.title;
+        }
+
+        appTitle = NAMES.title;
+
+        // assemble the window title from the gathered pieces,
+        // starting from the end of the window title and working back to the
+        // beginning.
+
+        // if the portal has a name, end the window title with that
+        // (if the portal lacks a name, portalTitle is still empty string)
+        windowTitle = portalTitle;
+
+        // if the app name differs from the portal, prepend it.
+        // if it's the same name, omit it to avoid silly redundancy like
+        // "MyUW | MyUW"
+        if (appTitle !== portalTitle) {
+          // if the windowTitle already has content, first add a separator
+          if (windowTitle !== '') {
+            windowTitle = ' | ' + windowTitle;
+          }
+          windowTitle = appTitle + windowTitle;
+        }
+
+        // if there's a page name not redundant with the app name, prepend it.
+        if (pageTitle && pageTitle !== '' && pageTitle !== appTitle) {
+          // if the windowTitle already has content, first add a separator
+          if (windowTitle !== '') {
+            windowTitle = ' | ' + windowTitle;
           }
+          windowTitle = pageTitle + windowTitle;
         }
-        $document[0].title = NAMES.title + frameTitle;
+
+        // finally, use the built up windowTitle
+        $document[0].title = windowTitle;
       }
 
     return {