[B03983] Broadcast last event to in-progress Publishing box - eliminate the spinner

app/config/apiMapping.js

@@ -239,6 +239,11 @@ var apiMapping = {
             'method': 'types'
         }
     },
+    PublishingEvent: {
+      channel: '/channel/publishing',
+      lazy: true,
+      validations: false
+    },
     User: {
         channel: '/channel/user',
         instantiate: {

app/controllers/annotateController.js

@@ -1,4 +1,4 @@
-metadataTool.controller('AnnotateController', function ($controller, $location, $routeParams, $q, $scope, $timeout, AlertService, ControlledVocabularyRepo, DocumentRepo, ResourceRepo, StorageService, UserService, ProjectRepositoryRepo) {
+metadataTool.controller('AnnotateController', function ($controller, $location, $routeParams, $q, $scope, $timeout, AlertService, ControlledVocabularyRepo, DocumentRepo, ResourceRepo, StorageService, UserService, ProjectRepositoryRepo, PublishingEvent, ApiResponseActions, WsApi) {
 
     angular.extend(this, $controller('AbstractController', {
         $scope: $scope
@@ -18,6 +18,8 @@ metadataTool.controller('AnnotateController', function ($controller, $location,
 
     $scope.loadingText = "Loading...";
 
+    $scope.publishingEvents = [];
+
     var types = appConfig.contentMap;
 
     $q.all([documentPromise, resourcesPromise, ControlledVocabularyRepo.ready(), ProjectRepositoryRepo.ready()]).then(function (args) {
@@ -94,6 +96,10 @@ metadataTool.controller('AnnotateController', function ($controller, $location,
             });
         };
 
+        $scope.cannotPublish = function () {
+            return $scope.document.publishing === true;
+        };
+
         $scope.accept = function () {
             $scope.loadingText = "Accepting...";
             $scope.openModal('#pleaseWaitDialog');
@@ -107,9 +113,7 @@ metadataTool.controller('AnnotateController', function ($controller, $location,
 
         $scope.push = function () {
             $scope.loadingText = "Pushing document to registered repositories...";
-            $scope.openModal('#pleaseWaitDialog');
             $scope.document.push().then(function (data) {
-                $scope.closeModal();
                 $scope.action = 'view';
             });
         };
@@ -225,6 +229,26 @@ metadataTool.controller('AnnotateController', function ($controller, $location,
                 }
             }
         };
+
+        WsApi.listen("/channel/publishing/document/" + $scope.document.id).then(null, null, function (rawResponse) {
+            var response = angular.fromJson(rawResponse.body);
+
+            if (response.meta.action === "BROADCAST") {
+              if (response.payload.PublishingEvent) {
+                $scope.publishingEvents.unshift(response.payload.PublishingEvent);
+              }
+            }
+        });
+
+        DocumentRepo.listen([ApiResponseActions.UPDATE, ApiResponseActions.DELETE], function (response) {
+            if (response.meta.action === "UPDATE") {
+              if (response.payload && response.payload.Document && response.payload.Document.publishing === false && $scope.publishingEvents.length) {
+                $scope.publishingEvents.length = 0;
+              }
+            } else if (response.meta.action === "DELETE") {
+              $scope.publishingEvents.length = 0;
+            }
+        });
     });
 
 });

app/filters/logTypeClassFilter.js

@@ -0,0 +1,23 @@
+metadataTool.filter('logTypeClass', function () {
+    return function (type) {
+      var classes = type ? "log-type-" + type.toLowerCase() : "";
+
+      switch (type) {
+        case "ALERT":
+          classes += " alert alert-danger";
+          break;
+        case "WARNING":
+          classes += " alert alert-warning";
+          break;
+        case "ATTACHMENT":
+        case "CONNECTION":
+        case "ITEM":
+        case "MESSAGE":
+          break;
+        default:
+          return "";
+      }
+
+      return classes;
+    };
+});

app/index.html

@@ -238,6 +238,7 @@
 
   <!-- Filters -->
   <script src="filters/cantaloupeUrlFilter.js"></script>
+  <script src="filters/logTypeClassFilter.js"></script>
 
   <!-- Repos -->
   <script src="repo/abstractAppRepo.js"></script>
@@ -257,6 +258,7 @@
   <script src="model/resource.js"></script>
   <script src="model/project.js"></script>
   <script src="model/metadata.js"></script>
+  <script src="model/publishingEvent.js"></script>
   <script src="model/controlledVocabulary.js"></script>
   <script src="model/projectRepository.js"></script>
   <script src="model/projectSuggestor.js"></script>
@@ -296,4 +298,4 @@
 
 </body>
 
-</html>
+</html>

app/model/publishingEvent.js

@@ -0,0 +1,10 @@
+metadataTool.model("PublishingEvent", function PublishingEvent() {
+
+    return function PublishingEvent() {
+
+        // additional model methods and variables
+
+        return this;
+    };
+
+});

app/resources/styles/sass/app.scss

@@ -259,6 +259,46 @@ main footer {
   }
 }
 
+.panel-document-publishing.publishing-log {
+  .panel-body {
+    .log-items {
+      max-height: 100px;
+      overflow-y: auto;
+      vertical-align: super;
+
+      margin: 0px 0px 0px 0px;
+      padding-left: 0px;
+
+      .alert-warning,
+      .alert-danger {
+        font-weight: bold;
+      }
+
+      .log-item {
+        clear: both;
+
+        list-style-type: none;
+
+        padding: 2px 2px 2px 4px;
+        margin: 3px 2px;
+
+        .item-date {
+          float: right;
+          margin: 0px 10px;
+        }
+      }
+
+      .log-item:first-of-type {
+        margin-top: 0px;
+      }
+
+      .log-item:last-of-type {
+        margin-bottom: 0px;
+      }
+    }
+  }
+}
+
 .openseadragon-container {
   min-height: 675px;
 }

app/views/annotate.html

@@ -28,12 +28,15 @@
     <div ng-if="action === 'view' && document.status === 'Accepted' && !document.publishing && document.getProject().repositories.length > 0" class="panel panel-warning panel-document-publishing">
         <div class="panel-heading">This document is accepted but not published.</div>
         <div class="panel-body">
-            <button class="btn btn-success" ng-click="push()">Publish</button>
+            <button class="btn btn-success" ng-click="push()" ng-disabled="cannotPublish()">Publish</button>
         </div>
     </div>
-    <div ng-if="action === 'view' && document.status === 'Accepted' && document.publishing && document.getProject().repositories.length > 0" class="panel panel-warning panel-document-publishing">
+    <div ng-if="action === 'view' && document.getProject().repositories.length > 0 && document.publishing" class="panel panel-warning panel-document-publishing publishing-log">
         <div class="panel-heading">This document is pending publication.</div>
         <div class="panel-body">
+          <ol ng-if="publishingEvents.length" class="log-items" reversed>
+            <li ng-repeat="(key, log) in publishingEvents track by key" class="log-item {{log.type | logTypeClass}}"><span class="item-message">{{log.message}}</span><span class="item-date">{{log.timestamp | date: 'medium'}}</span></li>
+          </ol>
         </div>
     </div>
 

karma.conf.js

@@ -3,15 +3,14 @@ module.exports = function (config) {
 
         preprocessors: {
             "app/!(node_modules)/**/*.js": "coverage",
-            '**/*.html': ['ng-html2js']
+            "app/views/**/*.html": ["ng-html2js"]
         },
 
         reporters: ['progress', 'coverage'],
 
         basePath: './',
 
         files: [
-
             'app/config/appConfig.js',
             'app/config/apiMapping.js',
 
@@ -57,9 +56,11 @@ module.exports = function (config) {
 
             'app/directives/**/*.js',
 
+            'app/filters/**/*.js',
+
             'app/repo/**/*.js',
 
-            'app/services/**/*.js',
+            //'app/services/**/*.js',
 
             'app/model/**/*.js',
 
@@ -88,6 +89,11 @@ module.exports = function (config) {
             'karma-ng-html2js-preprocessor'
         ],
 
+        ngHtml2JsPreprocessor: {
+            stripPrefix: "app/",
+            moduleName: "templates"
+        },
+
         coverageReporter: {
             type: "lcov",
             dir: "coverage/"

tests/core/mocks/mockAbstractCoreRepo.js

@@ -45,6 +45,8 @@ var mockRepo = function (repoName, $q, mockModelCtor, mockDataArray) {
 
     repo.mock(mockDataArray);
 
+    repo.scaffold = {};
+
     repo.acceptChangesPending = function () {
     };
 
@@ -150,6 +152,30 @@ var mockRepo = function (repoName, $q, mockModelCtor, mockDataArray) {
         return filteredData;
     };
 
+    repo.getScaffold = function(defaults) {
+        var updatedScaffold = repo.scaffold;
+
+        if (!defaults) defaults = {};
+        angular.extend(updatedScaffold, defaults);
+
+        return updatedScaffold;
+    };
+
+    repo.isInScaffold = function(property) {
+        var propertyFound = false;
+        var scaffoldKeys = Object.keys(repo.scaffold);
+
+        for (var i in scaffoldKeys) {
+            var scaffoldProperty = scaffoldKeys[i];
+            if (scaffoldProperty === property) {
+                propertyFound = true;
+                break;
+            }
+        }
+
+        return propertyFound;
+    };
+
     repo.getContents = function () {
         return repo.mockCopy(repo.mockedList);
     };
@@ -189,7 +215,7 @@ var mockRepo = function (repoName, $q, mockModelCtor, mockDataArray) {
         return payloadPromise($q.defer());
     };
 
-    repo.ready = function () {
+    repo.ready = function() {
         return payloadPromise($q.defer(), mockDataArray);
     };