Merge pull request #272 from nasa/open120

[Actions] Avoid suppression of context menus

platform/core/bundle.json

@@ -97,7 +97,7 @@
                 "provides": "actionService",
                 "type": "provider",
                 "implementation": "actions/ActionProvider.js",
-                "depends": [ "actions[]" ]
+                "depends": [ "actions[]", "$log" ]
             },
             {
                 "provides": "actionService",

platform/core/src/actions/ActionProvider.js

@@ -39,9 +39,11 @@ define(
          * @imeplements {ActionService}
          * @constructor
          */
-        function ActionProvider(actions) {
+        function ActionProvider(actions, $log) {
             var self = this;
 
+            this.$log = $log;
+
             // Build up look-up tables
             this.actions = actions;
             this.actionsByKey = {};
@@ -74,6 +76,7 @@ define(
             var context = (actionContext || {}),
                 category = context.category,
                 key = context.key,
+                $log = this.$log,
                 candidates;
 
             // Instantiate an action; invokes the constructor and
@@ -103,12 +106,31 @@ define(
             // appliesTo method of given actions (if defined), and
             // instantiate those applicable actions.
             function createIfApplicable(actions, context) {
-                return (actions || []).filter(function (Action) {
-                    return Action.appliesTo ?
-                        Action.appliesTo(context) : true;
-                }).map(function (Action) {
-                    return instantiateAction(Action, context);
-                });
+                function isApplicable(Action) {
+                    return Action.appliesTo ? Action.appliesTo(context) : true;
+                }
+
+                function instantiate(Action) {
+                    try {
+                        return instantiateAction(Action, context);
+                    } catch (e) {
+                        $log.error([
+                            "Could not instantiate action",
+                            Action.key,
+                            "due to:",
+                            e.message
+                        ].join(" "));
+                        return undefined;
+                    }
+                }
+
+                function isDefined(action) {
+                    return action !== undefined;
+                }
+
+                return (actions || []).filter(isApplicable)
+                    .map(instantiate)
+                    .filter(isDefined);
             }
 
             // Match actions to the provided context by comparing "key"

platform/core/test/actions/ActionProviderSpec.js

@@ -30,7 +30,8 @@ define(
         "use strict";
 
         describe("The action provider", function () {
-            var actions,
+            var mockLog,
+                actions,
                 actionProvider;
 
             function SimpleAction() {
@@ -62,6 +63,10 @@ define(
             MetadataAction.key = "metadata";
 
             beforeEach(function () {
+                mockLog = jasmine.createSpyObj(
+                    '$log',
+                    ['error', 'warn', 'info', 'debug']
+                );
                 actions = [
                     SimpleAction,
                     CategorizedAction,
@@ -137,6 +142,42 @@ define(
                 expect(provided[0].getMetadata()).toEqual("custom metadata");
             });
 
+            describe("when actions throw errors during instantiation", function () {
+                var errorText,
+                    provided;
+
+                beforeEach(function () {
+                    errorText = "some error text";
+
+                    function BadAction() {
+                        throw new Error(errorText);
+                    }
+
+                    provided = new ActionProvider(
+                        [ SimpleAction, BadAction ],
+                        mockLog
+                    ).getActions();
+                });
+
+                it("logs an error", function () {
+                    expect(mockLog.error)
+                        .toHaveBeenCalledWith(jasmine.any(String));
+                });
+
+                it("reports the error's message", function () {
+                    expect(
+                        mockLog.error.mostRecentCall.args[0].indexOf(errorText)
+                    ).not.toEqual(-1);
+                });
+
+                it("still provides valid actions", function () {
+                    expect(provided.length).toEqual(1);
+                    expect(provided[0].perform()).toEqual("simple");
+                });
+
+            });
+
+
         });
     }
-);
+);