Compare commits
	
		
			48 Commits
		
	
	
		
			fix-plan-g
			...
			v1.6.0
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 
						 | 
					7d86244898 | ||
| 
						 | 
					3e9b567fce | ||
| 
						 | 
					6f51de85db | ||
| 
						 | 
					f202ae19cb | ||
| 
						 | 
					668bd75025 | ||
| 
						 | 
					e6e07cf959 | ||
| 
						 | 
					2f8431905f | ||
| 
						 | 
					23aba14dfe | ||
| 
						 | 
					b0fa955914 | ||
| 
						 | 
					98207a3e0d | ||
| 
						 | 
					26b81345f2 | ||
| 
						 | 
					ac2034b243 | ||
| 
						 | 
					351848ad56 | ||
| 
						 | 
					cbac495f93 | ||
| 
						 | 
					15ef5b7623 | ||
| 
						 | 
					46c7ac944f | ||
| 
						 | 
					aa4bfab462 | ||
| 
						 | 
					f5cbb37e5a | ||
| 
						 | 
					8d9079984a | ||
| 
						 | 
					41783d8939 | ||
| 
						 | 
					441ad58fe7 | ||
| 
						 | 
					06a6a3f773 | ||
| 
						 | 
					52fab78625 | ||
| 
						 | 
					5eb6c15959 | ||
| 
						 | 
					ce8c31cfa4 | ||
| 
						 | 
					d80c0eef8e | ||
| 
						 | 
					55829dcf05 | ||
| 
						 | 
					d78956327c | ||
| 
						 | 
					4a0728a55b | ||
| 
						 | 
					2e1d57aa8c | ||
| 
						 | 
					1c2b0678be | ||
| 
						 | 
					6f810add43 | ||
| 
						 | 
					12727adb16 | ||
| 
						 | 
					9da750c3bb | ||
| 
						 | 
					176226ddef | ||
| 
						 | 
					acea18fa70 | ||
| 
						 | 
					d1656f8561 | ||
| 
						 | 
					87751e882c | ||
| 
						 | 
					dff393a714 | ||
| 
						 | 
					fd9c9aee03 | ||
| 
						 | 
					59bf981fb0 | ||
| 
						 | 
					4bbdac759f | ||
| 
						 | 
					13fe7509de | ||
| 
						 | 
					6fd8f6cd43 | ||
| 
						 | 
					6375ecda34 | ||
| 
						 | 
					d232dacc65 | ||
| 
						 | 
					59946e89ef | ||
| 
						 | 
					d75c4b4049 | 
@@ -182,7 +182,7 @@ The following guidelines are provided for anyone contributing source code to the
 | 
			
		||||
1. Avoid the use of "magic" values.
 | 
			
		||||
   eg.
 | 
			
		||||
   ```JavaScript
 | 
			
		||||
   Const UNAUTHORIZED = 401
 | 
			
		||||
   const UNAUTHORIZED = 401;
 | 
			
		||||
   if (responseCode === UNAUTHORIZED)
 | 
			
		||||
   ```
 | 
			
		||||
   is preferable to
 | 
			
		||||
 
 | 
			
		||||
@@ -131,10 +131,10 @@
 | 
			
		||||
                        }
 | 
			
		||||
                    ],
 | 
			
		||||
                    // maximum recent bounds to retain in conductor history
 | 
			
		||||
                    records: 10,
 | 
			
		||||
                    records: 10
 | 
			
		||||
                    // maximum duration between start and end bounds
 | 
			
		||||
                    // for utc-based time systems this is in milliseconds
 | 
			
		||||
                    limit: ONE_DAY
 | 
			
		||||
                    // limit: ONE_DAY
 | 
			
		||||
                },
 | 
			
		||||
                {
 | 
			
		||||
                    name: "Realtime",
 | 
			
		||||
 
 | 
			
		||||
@@ -86,7 +86,7 @@ module.exports = (config) => {
 | 
			
		||||
            reports: ['html', 'lcovonly', 'text-summary'],
 | 
			
		||||
            thresholds: {
 | 
			
		||||
                global: {
 | 
			
		||||
                    lines: 65
 | 
			
		||||
                    lines: 66
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        },
 | 
			
		||||
 
 | 
			
		||||
@@ -1,6 +1,6 @@
 | 
			
		||||
{
 | 
			
		||||
  "name": "openmct",
 | 
			
		||||
  "version": "1.4.1-SNAPSHOT",
 | 
			
		||||
  "version": "1.6.0",
 | 
			
		||||
  "description": "The Open MCT core platform",
 | 
			
		||||
  "dependencies": {},
 | 
			
		||||
  "devDependencies": {
 | 
			
		||||
 
 | 
			
		||||
@@ -143,8 +143,8 @@ define([
 | 
			
		||||
                            "$window"
 | 
			
		||||
                        ],
 | 
			
		||||
                        "group": "windowing",
 | 
			
		||||
                        "cssClass": "icon-new-window",
 | 
			
		||||
                        "priority": "preferred"
 | 
			
		||||
                        "priority": 10,
 | 
			
		||||
                        "cssClass": "icon-new-window"
 | 
			
		||||
                    }
 | 
			
		||||
                ],
 | 
			
		||||
                "runs": [
 | 
			
		||||
 
 | 
			
		||||
@@ -139,7 +139,9 @@ define([
 | 
			
		||||
                        ],
 | 
			
		||||
                        "description": "Edit",
 | 
			
		||||
                        "category": "view-control",
 | 
			
		||||
                        "cssClass": "major icon-pencil"
 | 
			
		||||
                        "cssClass": "major icon-pencil",
 | 
			
		||||
                        "group": "action",
 | 
			
		||||
                        "priority": 10
 | 
			
		||||
                    },
 | 
			
		||||
                    {
 | 
			
		||||
                        "key": "properties",
 | 
			
		||||
@@ -150,6 +152,8 @@ define([
 | 
			
		||||
                        "implementation": PropertiesAction,
 | 
			
		||||
                        "cssClass": "major icon-pencil",
 | 
			
		||||
                        "name": "Edit Properties...",
 | 
			
		||||
                        "group": "action",
 | 
			
		||||
                        "priority": 10,
 | 
			
		||||
                        "description": "Edit properties of this object.",
 | 
			
		||||
                        "depends": [
 | 
			
		||||
                            "dialogService"
 | 
			
		||||
 
 | 
			
		||||
@@ -20,12 +20,12 @@
 | 
			
		||||
 at runtime from the About dialog for additional information.
 | 
			
		||||
-->
 | 
			
		||||
<div class="c-object-label"
 | 
			
		||||
     ng-class="{ 'is-missing': model.status === 'missing' }"
 | 
			
		||||
     ng-class="{ 'is-status--missing': model.status === 'missing' }"
 | 
			
		||||
>
 | 
			
		||||
    <div class="c-object-label__type-icon {{type.getCssClass()}}"
 | 
			
		||||
         ng-class="{ 'l-icon-link':location.isLink() }"
 | 
			
		||||
    >
 | 
			
		||||
        <span class="is-missing__indicator" title="This item is missing"></span>
 | 
			
		||||
        <span class="is-status__indicator" title="This item is missing or suspect"></span>
 | 
			
		||||
    </div>
 | 
			
		||||
    <div class='c-object-label__name'>{{model.name}}</div>
 | 
			
		||||
</div>
 | 
			
		||||
 
 | 
			
		||||
@@ -21,32 +21,24 @@
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
define([
 | 
			
		||||
    "./src/actions/MoveAction",
 | 
			
		||||
    "./src/actions/CopyAction",
 | 
			
		||||
    "./src/actions/LinkAction",
 | 
			
		||||
    "./src/actions/SetPrimaryLocationAction",
 | 
			
		||||
    "./src/services/LocatingCreationDecorator",
 | 
			
		||||
    "./src/services/LocatingObjectDecorator",
 | 
			
		||||
    "./src/policies/CopyPolicy",
 | 
			
		||||
    "./src/policies/CrossSpacePolicy",
 | 
			
		||||
    "./src/policies/MovePolicy",
 | 
			
		||||
    "./src/capabilities/LocationCapability",
 | 
			
		||||
    "./src/services/MoveService",
 | 
			
		||||
    "./src/services/LinkService",
 | 
			
		||||
    "./src/services/CopyService",
 | 
			
		||||
    "./src/services/LocationService"
 | 
			
		||||
], function (
 | 
			
		||||
    MoveAction,
 | 
			
		||||
    CopyAction,
 | 
			
		||||
    LinkAction,
 | 
			
		||||
    SetPrimaryLocationAction,
 | 
			
		||||
    LocatingCreationDecorator,
 | 
			
		||||
    LocatingObjectDecorator,
 | 
			
		||||
    CopyPolicy,
 | 
			
		||||
    CrossSpacePolicy,
 | 
			
		||||
    MovePolicy,
 | 
			
		||||
    LocationCapability,
 | 
			
		||||
    MoveService,
 | 
			
		||||
    LinkService,
 | 
			
		||||
    CopyService,
 | 
			
		||||
    LocationService
 | 
			
		||||
@@ -60,41 +52,14 @@ define([
 | 
			
		||||
            "configuration": {},
 | 
			
		||||
            "extensions": {
 | 
			
		||||
                "actions": [
 | 
			
		||||
                    {
 | 
			
		||||
                        "key": "move",
 | 
			
		||||
                        "name": "Move",
 | 
			
		||||
                        "description": "Move object to another location.",
 | 
			
		||||
                        "cssClass": "icon-move",
 | 
			
		||||
                        "category": "contextual",
 | 
			
		||||
                        "implementation": MoveAction,
 | 
			
		||||
                        "depends": [
 | 
			
		||||
                            "policyService",
 | 
			
		||||
                            "locationService",
 | 
			
		||||
                            "moveService"
 | 
			
		||||
                        ]
 | 
			
		||||
                    },
 | 
			
		||||
                    {
 | 
			
		||||
                        "key": "copy",
 | 
			
		||||
                        "name": "Duplicate",
 | 
			
		||||
                        "description": "Duplicate object to another location.",
 | 
			
		||||
                        "cssClass": "icon-duplicate",
 | 
			
		||||
                        "category": "contextual",
 | 
			
		||||
                        "implementation": CopyAction,
 | 
			
		||||
                        "depends": [
 | 
			
		||||
                            "$log",
 | 
			
		||||
                            "policyService",
 | 
			
		||||
                            "locationService",
 | 
			
		||||
                            "copyService",
 | 
			
		||||
                            "dialogService",
 | 
			
		||||
                            "notificationService"
 | 
			
		||||
                        ]
 | 
			
		||||
                    },
 | 
			
		||||
                    {
 | 
			
		||||
                        "key": "link",
 | 
			
		||||
                        "name": "Create Link",
 | 
			
		||||
                        "description": "Create Link to object in another location.",
 | 
			
		||||
                        "cssClass": "icon-link",
 | 
			
		||||
                        "category": "contextual",
 | 
			
		||||
                        "group": "action",
 | 
			
		||||
                        "priority": 7,
 | 
			
		||||
                        "implementation": LinkAction,
 | 
			
		||||
                        "depends": [
 | 
			
		||||
                            "policyService",
 | 
			
		||||
@@ -135,10 +100,6 @@ define([
 | 
			
		||||
                    {
 | 
			
		||||
                        "category": "action",
 | 
			
		||||
                        "implementation": CopyPolicy
 | 
			
		||||
                    },
 | 
			
		||||
                    {
 | 
			
		||||
                        "category": "action",
 | 
			
		||||
                        "implementation": MovePolicy
 | 
			
		||||
                    }
 | 
			
		||||
                ],
 | 
			
		||||
                "capabilities": [
 | 
			
		||||
@@ -154,17 +115,6 @@ define([
 | 
			
		||||
                    }
 | 
			
		||||
                ],
 | 
			
		||||
                "services": [
 | 
			
		||||
                    {
 | 
			
		||||
                        "key": "moveService",
 | 
			
		||||
                        "name": "Move Service",
 | 
			
		||||
                        "description": "Provides a service for moving objects",
 | 
			
		||||
                        "implementation": MoveService,
 | 
			
		||||
                        "depends": [
 | 
			
		||||
                            "openmct",
 | 
			
		||||
                            "linkService",
 | 
			
		||||
                            "$q"
 | 
			
		||||
                        ]
 | 
			
		||||
                    },
 | 
			
		||||
                    {
 | 
			
		||||
                        "key": "linkService",
 | 
			
		||||
                        "name": "Link Service",
 | 
			
		||||
 
 | 
			
		||||
@@ -1,168 +0,0 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
define(
 | 
			
		||||
    ['./AbstractComposeAction', './CancelError'],
 | 
			
		||||
    function (AbstractComposeAction, CancelError) {
 | 
			
		||||
 | 
			
		||||
        /**
 | 
			
		||||
         * The CopyAction is available from context menus and allows a user to
 | 
			
		||||
         * deep copy an object to another location of their choosing.
 | 
			
		||||
         *
 | 
			
		||||
         * @implements {Action}
 | 
			
		||||
         * @constructor
 | 
			
		||||
         * @memberof platform/entanglement
 | 
			
		||||
         */
 | 
			
		||||
        function CopyAction(
 | 
			
		||||
            $log,
 | 
			
		||||
            policyService,
 | 
			
		||||
            locationService,
 | 
			
		||||
            copyService,
 | 
			
		||||
            dialogService,
 | 
			
		||||
            notificationService,
 | 
			
		||||
            context
 | 
			
		||||
        ) {
 | 
			
		||||
            this.dialog = undefined;
 | 
			
		||||
            this.notification = undefined;
 | 
			
		||||
            this.dialogService = dialogService;
 | 
			
		||||
            this.notificationService = notificationService;
 | 
			
		||||
            this.$log = $log;
 | 
			
		||||
            //Extend the behaviour of the Abstract Compose Action
 | 
			
		||||
            AbstractComposeAction.call(
 | 
			
		||||
                this,
 | 
			
		||||
                policyService,
 | 
			
		||||
                locationService,
 | 
			
		||||
                copyService,
 | 
			
		||||
                context,
 | 
			
		||||
                "Duplicate",
 | 
			
		||||
                "To a Location"
 | 
			
		||||
            );
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        CopyAction.prototype = Object.create(AbstractComposeAction.prototype);
 | 
			
		||||
 | 
			
		||||
        /**
 | 
			
		||||
         * Updates user about progress of copy. Should not be invoked by
 | 
			
		||||
         * client code under any circumstances.
 | 
			
		||||
         *
 | 
			
		||||
         * @private
 | 
			
		||||
         * @param phase
 | 
			
		||||
         * @param totalObjects
 | 
			
		||||
         * @param processed
 | 
			
		||||
         */
 | 
			
		||||
        CopyAction.prototype.progress = function (phase, totalObjects, processed) {
 | 
			
		||||
            /*
 | 
			
		||||
             Copy has two distinct phases. In the first phase a copy plan is
 | 
			
		||||
             made in memory. During this phase of execution, the user is
 | 
			
		||||
             shown a blocking 'modal' dialog.
 | 
			
		||||
 | 
			
		||||
             In the second phase, the copying is taking place, and the user
 | 
			
		||||
             is shown non-invasive banner notifications at the bottom of the screen.
 | 
			
		||||
             */
 | 
			
		||||
            if (phase.toLowerCase() === 'preparing' && !this.dialog) {
 | 
			
		||||
                this.dialog = this.dialogService.showBlockingMessage({
 | 
			
		||||
                    title: "Preparing to copy objects",
 | 
			
		||||
                    hint: "Do not navigate away from this page or close this browser tab while this message is displayed.",
 | 
			
		||||
                    unknownProgress: true,
 | 
			
		||||
                    severity: "info"
 | 
			
		||||
                });
 | 
			
		||||
            } else if (phase.toLowerCase() === "copying") {
 | 
			
		||||
                if (this.dialog) {
 | 
			
		||||
                    this.dialog.dismiss();
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                if (!this.notification) {
 | 
			
		||||
                    this.notification = this.notificationService
 | 
			
		||||
                        .notify({
 | 
			
		||||
                            title: "Copying objects",
 | 
			
		||||
                            unknownProgress: false,
 | 
			
		||||
                            severity: "info"
 | 
			
		||||
                        });
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                this.notification.model.progress = (processed / totalObjects) * 100;
 | 
			
		||||
                this.notification.model.title = ["Copied ", processed, "of ",
 | 
			
		||||
                    totalObjects, "objects"].join(" ");
 | 
			
		||||
            }
 | 
			
		||||
        };
 | 
			
		||||
 | 
			
		||||
        /**
 | 
			
		||||
         * Executes the CopyAction. The CopyAction uses the default behaviour of
 | 
			
		||||
         * the AbstractComposeAction, but extends it to support notification
 | 
			
		||||
         * updates of progress on copy.
 | 
			
		||||
         */
 | 
			
		||||
        CopyAction.prototype.perform = function () {
 | 
			
		||||
            var self = this;
 | 
			
		||||
 | 
			
		||||
            function success(domainObject) {
 | 
			
		||||
                var domainObjectName = domainObject.model.name;
 | 
			
		||||
 | 
			
		||||
                self.notification.dismiss();
 | 
			
		||||
                self.notificationService.info(domainObjectName + " copied successfully.");
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            function error(errorDetails) {
 | 
			
		||||
                // No need to notify user of their own cancellation
 | 
			
		||||
                if (errorDetails instanceof CancelError) {
 | 
			
		||||
                    return;
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                var errorDialog,
 | 
			
		||||
                    errorMessage = {
 | 
			
		||||
                        title: "Error copying objects.",
 | 
			
		||||
                        severity: "error",
 | 
			
		||||
                        hint: errorDetails.message,
 | 
			
		||||
                        minimized: true, // want the notification to be minimized initially (don't show banner)
 | 
			
		||||
                        options: [{
 | 
			
		||||
                            label: "OK",
 | 
			
		||||
                            callback: function () {
 | 
			
		||||
                                errorDialog.dismiss();
 | 
			
		||||
                            }
 | 
			
		||||
                        }]
 | 
			
		||||
                    };
 | 
			
		||||
 | 
			
		||||
                self.dialog.dismiss();
 | 
			
		||||
                if (self.notification) {
 | 
			
		||||
                    self.notification.dismiss(); // Clear the progress notification
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                self.$log.error("Error copying objects. ", errorDetails);
 | 
			
		||||
                //Show a minimized notification of error for posterity
 | 
			
		||||
                self.notificationService.notify(errorMessage);
 | 
			
		||||
                //Display a blocking message
 | 
			
		||||
                errorDialog = self.dialogService.showBlockingMessage(errorMessage);
 | 
			
		||||
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            function notification(details) {
 | 
			
		||||
                self.progress(details.phase, details.totalObjects, details.processed);
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            return AbstractComposeAction.prototype.perform.call(this)
 | 
			
		||||
                .then(success, error, notification);
 | 
			
		||||
        };
 | 
			
		||||
 | 
			
		||||
        CopyAction.appliesTo = AbstractComposeAction.appliesTo;
 | 
			
		||||
 | 
			
		||||
        return CopyAction;
 | 
			
		||||
    }
 | 
			
		||||
);
 | 
			
		||||
@@ -1,104 +0,0 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
define(
 | 
			
		||||
    function () {
 | 
			
		||||
        /**
 | 
			
		||||
         * MoveService provides an interface for moving objects from one
 | 
			
		||||
         * location to another.  It also provides a method for determining if
 | 
			
		||||
         * an object can be copied to a specific location.
 | 
			
		||||
         * @constructor
 | 
			
		||||
         * @memberof platform/entanglement
 | 
			
		||||
         * @implements {platform/entanglement.AbstractComposeService}
 | 
			
		||||
         */
 | 
			
		||||
        function MoveService(openmct, linkService) {
 | 
			
		||||
            this.openmct = openmct;
 | 
			
		||||
            this.linkService = linkService;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        MoveService.prototype.validate = function (object, parentCandidate) {
 | 
			
		||||
            var currentParent = object
 | 
			
		||||
                .getCapability('context')
 | 
			
		||||
                .getParent();
 | 
			
		||||
 | 
			
		||||
            if (!parentCandidate || !parentCandidate.getId) {
 | 
			
		||||
                return false;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            if (parentCandidate.getId() === currentParent.getId()) {
 | 
			
		||||
                return false;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            if (parentCandidate.getId() === object.getId()) {
 | 
			
		||||
                return false;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            if (parentCandidate.getModel().composition.indexOf(object.getId()) !== -1) {
 | 
			
		||||
                return false;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            return this.openmct.composition.checkPolicy(
 | 
			
		||||
                parentCandidate.useCapability('adapter'),
 | 
			
		||||
                object.useCapability('adapter')
 | 
			
		||||
            );
 | 
			
		||||
        };
 | 
			
		||||
 | 
			
		||||
        MoveService.prototype.perform = function (object, parentObject) {
 | 
			
		||||
            function relocate(objectInNewContext) {
 | 
			
		||||
                var newLocationCapability = objectInNewContext
 | 
			
		||||
                        .getCapability('location'),
 | 
			
		||||
                    oldLocationCapability = object
 | 
			
		||||
                        .getCapability('location');
 | 
			
		||||
 | 
			
		||||
                if (!newLocationCapability
 | 
			
		||||
                        || !oldLocationCapability) {
 | 
			
		||||
                    return;
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                if (oldLocationCapability.isOriginal()) {
 | 
			
		||||
                    return newLocationCapability.setPrimaryLocation(
 | 
			
		||||
                        newLocationCapability
 | 
			
		||||
                            .getContextualLocation()
 | 
			
		||||
                    );
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            if (!this.validate(object, parentObject)) {
 | 
			
		||||
                throw new Error(
 | 
			
		||||
                    "Tried to move objects without validating first."
 | 
			
		||||
                );
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            return this.linkService
 | 
			
		||||
                .perform(object, parentObject)
 | 
			
		||||
                .then(relocate)
 | 
			
		||||
                .then(function () {
 | 
			
		||||
                    return object
 | 
			
		||||
                        .getCapability('action')
 | 
			
		||||
                        .perform('remove', true);
 | 
			
		||||
                });
 | 
			
		||||
        };
 | 
			
		||||
 | 
			
		||||
        return MoveService;
 | 
			
		||||
    }
 | 
			
		||||
);
 | 
			
		||||
 | 
			
		||||
@@ -1,243 +0,0 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
define(
 | 
			
		||||
    [
 | 
			
		||||
        '../../src/actions/CopyAction',
 | 
			
		||||
        '../services/MockCopyService',
 | 
			
		||||
        '../DomainObjectFactory'
 | 
			
		||||
    ],
 | 
			
		||||
    function (CopyAction, MockCopyService, domainObjectFactory) {
 | 
			
		||||
 | 
			
		||||
        describe("Copy Action", function () {
 | 
			
		||||
 | 
			
		||||
            var copyAction,
 | 
			
		||||
                policyService,
 | 
			
		||||
                locationService,
 | 
			
		||||
                locationServicePromise,
 | 
			
		||||
                copyService,
 | 
			
		||||
                context,
 | 
			
		||||
                selectedObject,
 | 
			
		||||
                selectedObjectContextCapability,
 | 
			
		||||
                currentParent,
 | 
			
		||||
                newParent,
 | 
			
		||||
                notificationService,
 | 
			
		||||
                notification,
 | 
			
		||||
                dialogService,
 | 
			
		||||
                mockDialog,
 | 
			
		||||
                mockLog,
 | 
			
		||||
                abstractComposePromise,
 | 
			
		||||
                domainObject = {model: {name: "mockObject"}},
 | 
			
		||||
                progress = {
 | 
			
		||||
                    phase: "copying",
 | 
			
		||||
                    totalObjects: 10,
 | 
			
		||||
                    processed: 1
 | 
			
		||||
                };
 | 
			
		||||
 | 
			
		||||
            beforeEach(function () {
 | 
			
		||||
                policyService = jasmine.createSpyObj(
 | 
			
		||||
                    'policyService',
 | 
			
		||||
                    ['allow']
 | 
			
		||||
                );
 | 
			
		||||
                policyService.allow.and.returnValue(true);
 | 
			
		||||
 | 
			
		||||
                selectedObjectContextCapability = jasmine.createSpyObj(
 | 
			
		||||
                    'selectedObjectContextCapability',
 | 
			
		||||
                    [
 | 
			
		||||
                        'getParent'
 | 
			
		||||
                    ]
 | 
			
		||||
                );
 | 
			
		||||
 | 
			
		||||
                selectedObject = domainObjectFactory({
 | 
			
		||||
                    name: 'selectedObject',
 | 
			
		||||
                    model: {
 | 
			
		||||
                        name: 'selectedObject'
 | 
			
		||||
                    },
 | 
			
		||||
                    capabilities: {
 | 
			
		||||
                        context: selectedObjectContextCapability
 | 
			
		||||
                    }
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                currentParent = domainObjectFactory({
 | 
			
		||||
                    name: 'currentParent'
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                selectedObjectContextCapability
 | 
			
		||||
                    .getParent
 | 
			
		||||
                    .and.returnValue(currentParent);
 | 
			
		||||
 | 
			
		||||
                newParent = domainObjectFactory({
 | 
			
		||||
                    name: 'newParent'
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                locationService = jasmine.createSpyObj(
 | 
			
		||||
                    'locationService',
 | 
			
		||||
                    [
 | 
			
		||||
                        'getLocationFromUser'
 | 
			
		||||
                    ]
 | 
			
		||||
                );
 | 
			
		||||
 | 
			
		||||
                locationServicePromise = jasmine.createSpyObj(
 | 
			
		||||
                    'locationServicePromise',
 | 
			
		||||
                    [
 | 
			
		||||
                        'then'
 | 
			
		||||
                    ]
 | 
			
		||||
                );
 | 
			
		||||
 | 
			
		||||
                abstractComposePromise = jasmine.createSpyObj(
 | 
			
		||||
                    'abstractComposePromise',
 | 
			
		||||
                    [
 | 
			
		||||
                        'then'
 | 
			
		||||
                    ]
 | 
			
		||||
                );
 | 
			
		||||
 | 
			
		||||
                abstractComposePromise.then.and.callFake(function (success, error, notify) {
 | 
			
		||||
                    notify(progress);
 | 
			
		||||
                    success(domainObject);
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                locationServicePromise.then.and.callFake(function (callback) {
 | 
			
		||||
                    callback(newParent);
 | 
			
		||||
 | 
			
		||||
                    return abstractComposePromise;
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                locationService
 | 
			
		||||
                    .getLocationFromUser
 | 
			
		||||
                    .and.returnValue(locationServicePromise);
 | 
			
		||||
 | 
			
		||||
                dialogService = jasmine.createSpyObj('dialogService',
 | 
			
		||||
                    ['showBlockingMessage']
 | 
			
		||||
                );
 | 
			
		||||
 | 
			
		||||
                mockDialog = jasmine.createSpyObj("dialog", ["dismiss"]);
 | 
			
		||||
                dialogService.showBlockingMessage.and.returnValue(mockDialog);
 | 
			
		||||
 | 
			
		||||
                notification = jasmine.createSpyObj('notification',
 | 
			
		||||
                    ['dismiss', 'model']
 | 
			
		||||
                );
 | 
			
		||||
 | 
			
		||||
                notificationService = jasmine.createSpyObj('notificationService',
 | 
			
		||||
                    ['notify', 'info']
 | 
			
		||||
                );
 | 
			
		||||
 | 
			
		||||
                notificationService.notify.and.returnValue(notification);
 | 
			
		||||
 | 
			
		||||
                mockLog = jasmine.createSpyObj('log', ['error']);
 | 
			
		||||
 | 
			
		||||
                copyService = new MockCopyService();
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            describe("with context from context-action", function () {
 | 
			
		||||
                beforeEach(function () {
 | 
			
		||||
                    context = {
 | 
			
		||||
                        domainObject: selectedObject
 | 
			
		||||
                    };
 | 
			
		||||
 | 
			
		||||
                    copyAction = new CopyAction(
 | 
			
		||||
                        mockLog,
 | 
			
		||||
                        policyService,
 | 
			
		||||
                        locationService,
 | 
			
		||||
                        copyService,
 | 
			
		||||
                        dialogService,
 | 
			
		||||
                        notificationService,
 | 
			
		||||
                        context
 | 
			
		||||
                    );
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("initializes happily", function () {
 | 
			
		||||
                    expect(copyAction).toBeDefined();
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                describe("when performed it", function () {
 | 
			
		||||
                    beforeEach(function () {
 | 
			
		||||
                        spyOn(copyAction, 'progress').and.callThrough();
 | 
			
		||||
                        copyAction.perform();
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    it("prompts for location", function () {
 | 
			
		||||
                        expect(locationService.getLocationFromUser)
 | 
			
		||||
                            .toHaveBeenCalledWith(
 | 
			
		||||
                                "Duplicate selectedObject To a Location",
 | 
			
		||||
                                "Duplicate To",
 | 
			
		||||
                                jasmine.any(Function),
 | 
			
		||||
                                currentParent
 | 
			
		||||
                            );
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    it("waits for location and handles cancellation by user", function () {
 | 
			
		||||
                        expect(locationServicePromise.then)
 | 
			
		||||
                            .toHaveBeenCalledWith(jasmine.any(Function), jasmine.any(Function));
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    it("copies object to selected location", function () {
 | 
			
		||||
                        locationServicePromise
 | 
			
		||||
                            .then
 | 
			
		||||
                            .calls.mostRecent()
 | 
			
		||||
                            .args[0](newParent);
 | 
			
		||||
 | 
			
		||||
                        expect(copyService.perform)
 | 
			
		||||
                            .toHaveBeenCalledWith(selectedObject, newParent);
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    it("notifies the user of progress", function () {
 | 
			
		||||
                        expect(notificationService.info).toHaveBeenCalled();
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    it("notifies the user with name of object copied", function () {
 | 
			
		||||
                        expect(notificationService.info)
 | 
			
		||||
                            .toHaveBeenCalledWith("mockObject copied successfully.");
 | 
			
		||||
                    });
 | 
			
		||||
                });
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            describe("with context from drag-drop", function () {
 | 
			
		||||
                beforeEach(function () {
 | 
			
		||||
                    context = {
 | 
			
		||||
                        selectedObject: selectedObject,
 | 
			
		||||
                        domainObject: newParent
 | 
			
		||||
                    };
 | 
			
		||||
 | 
			
		||||
                    copyAction = new CopyAction(
 | 
			
		||||
                        mockLog,
 | 
			
		||||
                        policyService,
 | 
			
		||||
                        locationService,
 | 
			
		||||
                        copyService,
 | 
			
		||||
                        dialogService,
 | 
			
		||||
                        notificationService,
 | 
			
		||||
                        context
 | 
			
		||||
                    );
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("initializes happily", function () {
 | 
			
		||||
                    expect(copyAction).toBeDefined();
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("performs copy immediately", function () {
 | 
			
		||||
                    copyAction.perform();
 | 
			
		||||
                    expect(copyService.perform)
 | 
			
		||||
                        .toHaveBeenCalledWith(selectedObject, newParent);
 | 
			
		||||
                });
 | 
			
		||||
            });
 | 
			
		||||
        });
 | 
			
		||||
    }
 | 
			
		||||
);
 | 
			
		||||
@@ -1,178 +0,0 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
define(
 | 
			
		||||
    [
 | 
			
		||||
        '../../src/actions/MoveAction',
 | 
			
		||||
        '../services/MockMoveService',
 | 
			
		||||
        '../DomainObjectFactory'
 | 
			
		||||
    ],
 | 
			
		||||
    function (MoveAction, MockMoveService, domainObjectFactory) {
 | 
			
		||||
 | 
			
		||||
        describe("Move Action", function () {
 | 
			
		||||
 | 
			
		||||
            var moveAction,
 | 
			
		||||
                policyService,
 | 
			
		||||
                locationService,
 | 
			
		||||
                locationServicePromise,
 | 
			
		||||
                moveService,
 | 
			
		||||
                context,
 | 
			
		||||
                selectedObject,
 | 
			
		||||
                selectedObjectContextCapability,
 | 
			
		||||
                currentParent,
 | 
			
		||||
                newParent;
 | 
			
		||||
 | 
			
		||||
            beforeEach(function () {
 | 
			
		||||
                policyService = jasmine.createSpyObj(
 | 
			
		||||
                    'policyService',
 | 
			
		||||
                    ['allow']
 | 
			
		||||
                );
 | 
			
		||||
                policyService.allow.and.returnValue(true);
 | 
			
		||||
 | 
			
		||||
                selectedObjectContextCapability = jasmine.createSpyObj(
 | 
			
		||||
                    'selectedObjectContextCapability',
 | 
			
		||||
                    [
 | 
			
		||||
                        'getParent'
 | 
			
		||||
                    ]
 | 
			
		||||
                );
 | 
			
		||||
 | 
			
		||||
                selectedObject = domainObjectFactory({
 | 
			
		||||
                    name: 'selectedObject',
 | 
			
		||||
                    model: {
 | 
			
		||||
                        name: 'selectedObject'
 | 
			
		||||
                    },
 | 
			
		||||
                    capabilities: {
 | 
			
		||||
                        context: selectedObjectContextCapability
 | 
			
		||||
                    }
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                currentParent = domainObjectFactory({
 | 
			
		||||
                    name: 'currentParent'
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                selectedObjectContextCapability
 | 
			
		||||
                    .getParent
 | 
			
		||||
                    .and.returnValue(currentParent);
 | 
			
		||||
 | 
			
		||||
                newParent = domainObjectFactory({
 | 
			
		||||
                    name: 'newParent'
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                locationService = jasmine.createSpyObj(
 | 
			
		||||
                    'locationService',
 | 
			
		||||
                    [
 | 
			
		||||
                        'getLocationFromUser'
 | 
			
		||||
                    ]
 | 
			
		||||
                );
 | 
			
		||||
 | 
			
		||||
                locationServicePromise = jasmine.createSpyObj(
 | 
			
		||||
                    'locationServicePromise',
 | 
			
		||||
                    [
 | 
			
		||||
                        'then'
 | 
			
		||||
                    ]
 | 
			
		||||
                );
 | 
			
		||||
 | 
			
		||||
                locationService
 | 
			
		||||
                    .getLocationFromUser
 | 
			
		||||
                    .and.returnValue(locationServicePromise);
 | 
			
		||||
 | 
			
		||||
                moveService = new MockMoveService();
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            describe("with context from context-action", function () {
 | 
			
		||||
                beforeEach(function () {
 | 
			
		||||
                    context = {
 | 
			
		||||
                        domainObject: selectedObject
 | 
			
		||||
                    };
 | 
			
		||||
 | 
			
		||||
                    moveAction = new MoveAction(
 | 
			
		||||
                        policyService,
 | 
			
		||||
                        locationService,
 | 
			
		||||
                        moveService,
 | 
			
		||||
                        context
 | 
			
		||||
                    );
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("initializes happily", function () {
 | 
			
		||||
                    expect(moveAction).toBeDefined();
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                describe("when performed it", function () {
 | 
			
		||||
                    beforeEach(function () {
 | 
			
		||||
                        moveAction.perform();
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    it("prompts for location", function () {
 | 
			
		||||
                        expect(locationService.getLocationFromUser)
 | 
			
		||||
                            .toHaveBeenCalledWith(
 | 
			
		||||
                                "Move selectedObject To a New Location",
 | 
			
		||||
                                "Move To",
 | 
			
		||||
                                jasmine.any(Function),
 | 
			
		||||
                                currentParent
 | 
			
		||||
                            );
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    it("waits for location and handles cancellation by user", function () {
 | 
			
		||||
                        expect(locationServicePromise.then)
 | 
			
		||||
                            .toHaveBeenCalledWith(jasmine.any(Function), jasmine.any(Function));
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    it("moves object to selected location", function () {
 | 
			
		||||
                        locationServicePromise
 | 
			
		||||
                            .then
 | 
			
		||||
                            .calls.mostRecent()
 | 
			
		||||
                            .args[0](newParent);
 | 
			
		||||
 | 
			
		||||
                        expect(moveService.perform)
 | 
			
		||||
                            .toHaveBeenCalledWith(selectedObject, newParent);
 | 
			
		||||
                    });
 | 
			
		||||
                });
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            describe("with context from drag-drop", function () {
 | 
			
		||||
                beforeEach(function () {
 | 
			
		||||
                    context = {
 | 
			
		||||
                        selectedObject: selectedObject,
 | 
			
		||||
                        domainObject: newParent
 | 
			
		||||
                    };
 | 
			
		||||
 | 
			
		||||
                    moveAction = new MoveAction(
 | 
			
		||||
                        policyService,
 | 
			
		||||
                        locationService,
 | 
			
		||||
                        moveService,
 | 
			
		||||
                        context
 | 
			
		||||
                    );
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("initializes happily", function () {
 | 
			
		||||
                    expect(moveAction).toBeDefined();
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("performs move immediately", function () {
 | 
			
		||||
                    moveAction.perform();
 | 
			
		||||
                    expect(moveService.perform)
 | 
			
		||||
                        .toHaveBeenCalledWith(selectedObject, newParent);
 | 
			
		||||
                });
 | 
			
		||||
            });
 | 
			
		||||
        });
 | 
			
		||||
    }
 | 
			
		||||
);
 | 
			
		||||
@@ -1,124 +0,0 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
define([
 | 
			
		||||
    '../../src/policies/MovePolicy',
 | 
			
		||||
    '../DomainObjectFactory'
 | 
			
		||||
], function (MovePolicy, domainObjectFactory) {
 | 
			
		||||
 | 
			
		||||
    describe("MovePolicy", function () {
 | 
			
		||||
        var testMetadata,
 | 
			
		||||
            testContext,
 | 
			
		||||
            mockDomainObject,
 | 
			
		||||
            mockParent,
 | 
			
		||||
            mockParentType,
 | 
			
		||||
            mockType,
 | 
			
		||||
            mockAction,
 | 
			
		||||
            policy;
 | 
			
		||||
 | 
			
		||||
        beforeEach(function () {
 | 
			
		||||
            var mockContextCapability =
 | 
			
		||||
                    jasmine.createSpyObj('context', ['getParent']);
 | 
			
		||||
 | 
			
		||||
            mockType =
 | 
			
		||||
                jasmine.createSpyObj('type', ['hasFeature']);
 | 
			
		||||
            mockParentType =
 | 
			
		||||
                jasmine.createSpyObj('parent-type', ['hasFeature']);
 | 
			
		||||
 | 
			
		||||
            testMetadata = {};
 | 
			
		||||
 | 
			
		||||
            mockDomainObject = domainObjectFactory({
 | 
			
		||||
                capabilities: {
 | 
			
		||||
                    context: mockContextCapability,
 | 
			
		||||
                    type: mockType
 | 
			
		||||
                }
 | 
			
		||||
            });
 | 
			
		||||
            mockParent = domainObjectFactory({
 | 
			
		||||
                capabilities: {
 | 
			
		||||
                    type: mockParentType
 | 
			
		||||
                }
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            mockContextCapability.getParent.and.returnValue(mockParent);
 | 
			
		||||
 | 
			
		||||
            mockType.hasFeature.and.callFake(function (feature) {
 | 
			
		||||
                return feature === 'creation';
 | 
			
		||||
            });
 | 
			
		||||
            mockParentType.hasFeature.and.callFake(function (feature) {
 | 
			
		||||
                return feature === 'creation';
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            mockAction = jasmine.createSpyObj('action', ['getMetadata']);
 | 
			
		||||
            mockAction.getMetadata.and.returnValue(testMetadata);
 | 
			
		||||
 | 
			
		||||
            testContext = { domainObject: mockDomainObject };
 | 
			
		||||
 | 
			
		||||
            policy = new MovePolicy();
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        describe("for move actions", function () {
 | 
			
		||||
            beforeEach(function () {
 | 
			
		||||
                testMetadata.key = 'move';
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            describe("when an object is non-modifiable", function () {
 | 
			
		||||
                beforeEach(function () {
 | 
			
		||||
                    mockType.hasFeature.and.returnValue(false);
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("disallows the action", function () {
 | 
			
		||||
                    expect(policy.allow(mockAction, testContext)).toBe(false);
 | 
			
		||||
                });
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            describe("when a parent is non-modifiable", function () {
 | 
			
		||||
                beforeEach(function () {
 | 
			
		||||
                    mockParentType.hasFeature.and.returnValue(false);
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("disallows the action", function () {
 | 
			
		||||
                    expect(policy.allow(mockAction, testContext)).toBe(false);
 | 
			
		||||
                });
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            describe("when an object and its parent are modifiable", function () {
 | 
			
		||||
                it("allows the action", function () {
 | 
			
		||||
                    expect(policy.allow(mockAction, testContext)).toBe(true);
 | 
			
		||||
                });
 | 
			
		||||
            });
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        describe("for other actions", function () {
 | 
			
		||||
            beforeEach(function () {
 | 
			
		||||
                testMetadata.key = 'foo';
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            it("simply allows the action", function () {
 | 
			
		||||
                expect(policy.allow(mockAction, testContext)).toBe(true);
 | 
			
		||||
                mockType.hasFeature.and.returnValue(false);
 | 
			
		||||
                expect(policy.allow(mockAction, testContext)).toBe(true);
 | 
			
		||||
                mockParentType.hasFeature.and.returnValue(false);
 | 
			
		||||
                expect(policy.allow(mockAction, testContext)).toBe(true);
 | 
			
		||||
            });
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
});
 | 
			
		||||
@@ -1,96 +0,0 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
define(
 | 
			
		||||
    function () {
 | 
			
		||||
 | 
			
		||||
        /**
 | 
			
		||||
         * MockMoveService provides the same interface as the moveService,
 | 
			
		||||
         * returning promises where it would normally do so.  At it's core,
 | 
			
		||||
         * it is a jasmine spy object, but it also tracks the promises it
 | 
			
		||||
         * returns and provides shortcut methods for resolving those promises
 | 
			
		||||
         * synchronously.
 | 
			
		||||
         *
 | 
			
		||||
         * Usage:
 | 
			
		||||
         *
 | 
			
		||||
         * ```javascript
 | 
			
		||||
         * var moveService = new MockMoveService();
 | 
			
		||||
         *
 | 
			
		||||
         * // validate is a standard jasmine spy.
 | 
			
		||||
         * moveService.validate.and.returnValue(true);
 | 
			
		||||
         * var isValid = moveService.validate(object, parentCandidate);
 | 
			
		||||
         * expect(isValid).toBe(true);
 | 
			
		||||
         *
 | 
			
		||||
         * // perform returns promises and tracks them.
 | 
			
		||||
         * var whenCopied = jasmine.createSpy('whenCopied');
 | 
			
		||||
         * moveService.perform(object, parentObject).then(whenCopied);
 | 
			
		||||
         * expect(whenCopied).not.toHaveBeenCalled();
 | 
			
		||||
         * moveService.perform.calls.mostRecent().resolve('someArg');
 | 
			
		||||
         * expect(whenCopied).toHaveBeenCalledWith('someArg');
 | 
			
		||||
         * ```
 | 
			
		||||
         */
 | 
			
		||||
        function MockMoveService() {
 | 
			
		||||
            // track most recent call of a function,
 | 
			
		||||
            // perform automatically returns
 | 
			
		||||
            var mockMoveService = jasmine.createSpyObj(
 | 
			
		||||
                'MockMoveService',
 | 
			
		||||
                [
 | 
			
		||||
                    'validate',
 | 
			
		||||
                    'perform'
 | 
			
		||||
                ]
 | 
			
		||||
            );
 | 
			
		||||
 | 
			
		||||
            mockMoveService.perform.and.callFake(() => {
 | 
			
		||||
                var performPromise,
 | 
			
		||||
                    callExtensions,
 | 
			
		||||
                    spy;
 | 
			
		||||
 | 
			
		||||
                performPromise = jasmine.createSpyObj(
 | 
			
		||||
                    'performPromise',
 | 
			
		||||
                    ['then']
 | 
			
		||||
                );
 | 
			
		||||
 | 
			
		||||
                callExtensions = {
 | 
			
		||||
                    promise: performPromise,
 | 
			
		||||
                    resolve: function (resolveWith) {
 | 
			
		||||
                        performPromise.then.calls.all().forEach(function (call) {
 | 
			
		||||
                            call.args[0](resolveWith);
 | 
			
		||||
                        });
 | 
			
		||||
                    }
 | 
			
		||||
                };
 | 
			
		||||
 | 
			
		||||
                spy = mockMoveService.perform;
 | 
			
		||||
 | 
			
		||||
                Object.keys(callExtensions).forEach(function (key) {
 | 
			
		||||
                    spy.calls.mostRecent()[key] = callExtensions[key];
 | 
			
		||||
                    spy.calls.all()[spy.calls.count() - 1][key] = callExtensions[key];
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                return performPromise;
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            return mockMoveService;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        return MockMoveService;
 | 
			
		||||
    }
 | 
			
		||||
);
 | 
			
		||||
@@ -1,260 +0,0 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
define(
 | 
			
		||||
    [
 | 
			
		||||
        '../../src/services/MoveService',
 | 
			
		||||
        '../services/MockLinkService',
 | 
			
		||||
        '../DomainObjectFactory',
 | 
			
		||||
        '../ControlledPromise'
 | 
			
		||||
    ],
 | 
			
		||||
    function (
 | 
			
		||||
        MoveService,
 | 
			
		||||
        MockLinkService,
 | 
			
		||||
        domainObjectFactory,
 | 
			
		||||
        ControlledPromise
 | 
			
		||||
    ) {
 | 
			
		||||
 | 
			
		||||
        xdescribe("MoveService", function () {
 | 
			
		||||
 | 
			
		||||
            var moveService,
 | 
			
		||||
                policyService,
 | 
			
		||||
                object,
 | 
			
		||||
                objectContextCapability,
 | 
			
		||||
                currentParent,
 | 
			
		||||
                parentCandidate,
 | 
			
		||||
                linkService;
 | 
			
		||||
 | 
			
		||||
            beforeEach(function () {
 | 
			
		||||
                objectContextCapability = jasmine.createSpyObj(
 | 
			
		||||
                    'objectContextCapability',
 | 
			
		||||
                    [
 | 
			
		||||
                        'getParent'
 | 
			
		||||
                    ]
 | 
			
		||||
                );
 | 
			
		||||
 | 
			
		||||
                object = domainObjectFactory({
 | 
			
		||||
                    name: 'object',
 | 
			
		||||
                    id: 'a',
 | 
			
		||||
                    capabilities: {
 | 
			
		||||
                        context: objectContextCapability,
 | 
			
		||||
                        type: { type: 'object' }
 | 
			
		||||
                    }
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                currentParent = domainObjectFactory({
 | 
			
		||||
                    name: 'currentParent',
 | 
			
		||||
                    id: 'b'
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                objectContextCapability.getParent.and.returnValue(currentParent);
 | 
			
		||||
 | 
			
		||||
                parentCandidate = domainObjectFactory({
 | 
			
		||||
                    name: 'parentCandidate',
 | 
			
		||||
                    model: { composition: [] },
 | 
			
		||||
                    id: 'c',
 | 
			
		||||
                    capabilities: {
 | 
			
		||||
                        type: { type: 'parentCandidate' }
 | 
			
		||||
                    }
 | 
			
		||||
                });
 | 
			
		||||
                policyService = jasmine.createSpyObj(
 | 
			
		||||
                    'policyService',
 | 
			
		||||
                    ['allow']
 | 
			
		||||
                );
 | 
			
		||||
                linkService = new MockLinkService();
 | 
			
		||||
                policyService.allow.and.returnValue(true);
 | 
			
		||||
                moveService = new MoveService(policyService, linkService);
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            describe("validate", function () {
 | 
			
		||||
                var validate;
 | 
			
		||||
 | 
			
		||||
                beforeEach(function () {
 | 
			
		||||
                    validate = function () {
 | 
			
		||||
                        return moveService.validate(object, parentCandidate);
 | 
			
		||||
                    };
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("does not allow an invalid parent", function () {
 | 
			
		||||
                    parentCandidate = undefined;
 | 
			
		||||
                    expect(validate()).toBe(false);
 | 
			
		||||
                    parentCandidate = {};
 | 
			
		||||
                    expect(validate()).toBe(false);
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("does not allow moving to current parent", function () {
 | 
			
		||||
                    parentCandidate.id = currentParent.id = 'xyz';
 | 
			
		||||
                    expect(validate()).toBe(false);
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("does not allow moving to self", function () {
 | 
			
		||||
                    object.id = parentCandidate.id = 'xyz';
 | 
			
		||||
                    expect(validate()).toBe(false);
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("does not allow moving to the same location", function () {
 | 
			
		||||
                    object.id = 'abc';
 | 
			
		||||
                    parentCandidate.model.composition = ['abc'];
 | 
			
		||||
                    expect(validate()).toBe(false);
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                describe("defers to policyService", function () {
 | 
			
		||||
 | 
			
		||||
                    it("calls policy service with correct args", function () {
 | 
			
		||||
                        validate();
 | 
			
		||||
                        expect(policyService.allow).toHaveBeenCalledWith(
 | 
			
		||||
                            "composition",
 | 
			
		||||
                            parentCandidate,
 | 
			
		||||
                            object
 | 
			
		||||
                        );
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    it("and returns false", function () {
 | 
			
		||||
                        policyService.allow.and.returnValue(false);
 | 
			
		||||
                        expect(validate()).toBe(false);
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    it("and returns true", function () {
 | 
			
		||||
                        policyService.allow.and.returnValue(true);
 | 
			
		||||
                        expect(validate()).toBe(true);
 | 
			
		||||
                    });
 | 
			
		||||
                });
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            describe("perform", function () {
 | 
			
		||||
 | 
			
		||||
                var actionCapability,
 | 
			
		||||
                    locationCapability,
 | 
			
		||||
                    locationPromise,
 | 
			
		||||
                    newParent,
 | 
			
		||||
                    moveResult;
 | 
			
		||||
 | 
			
		||||
                beforeEach(function () {
 | 
			
		||||
                    newParent = parentCandidate;
 | 
			
		||||
 | 
			
		||||
                    actionCapability = jasmine.createSpyObj(
 | 
			
		||||
                        'actionCapability',
 | 
			
		||||
                        ['perform']
 | 
			
		||||
                    );
 | 
			
		||||
 | 
			
		||||
                    locationCapability = jasmine.createSpyObj(
 | 
			
		||||
                        'locationCapability',
 | 
			
		||||
                        [
 | 
			
		||||
                            'isOriginal',
 | 
			
		||||
                            'setPrimaryLocation',
 | 
			
		||||
                            'getContextualLocation'
 | 
			
		||||
                        ]
 | 
			
		||||
                    );
 | 
			
		||||
 | 
			
		||||
                    locationPromise = new ControlledPromise();
 | 
			
		||||
                    locationCapability.setPrimaryLocation
 | 
			
		||||
                        .and.returnValue(locationPromise);
 | 
			
		||||
 | 
			
		||||
                    object = domainObjectFactory({
 | 
			
		||||
                        name: 'object',
 | 
			
		||||
                        capabilities: {
 | 
			
		||||
                            action: actionCapability,
 | 
			
		||||
                            location: locationCapability,
 | 
			
		||||
                            context: objectContextCapability,
 | 
			
		||||
                            type: { type: 'object' }
 | 
			
		||||
                        }
 | 
			
		||||
                    });
 | 
			
		||||
                    moveResult = moveService.perform(object, newParent);
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("links object to newParent", function () {
 | 
			
		||||
                    expect(linkService.perform).toHaveBeenCalledWith(
 | 
			
		||||
                        object,
 | 
			
		||||
                        newParent
 | 
			
		||||
                    );
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("returns a promise", function () {
 | 
			
		||||
                    expect(moveResult.then).toEqual(jasmine.any(Function));
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("waits for result of link", function () {
 | 
			
		||||
                    expect(linkService.perform.calls.mostRecent().promise.then)
 | 
			
		||||
                        .toHaveBeenCalledWith(jasmine.any(Function));
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("throws an error when performed on invalid inputs", function () {
 | 
			
		||||
                    function perform() {
 | 
			
		||||
                        moveService.perform(object, newParent);
 | 
			
		||||
                    }
 | 
			
		||||
 | 
			
		||||
                    spyOn(moveService, "validate");
 | 
			
		||||
                    moveService.validate.and.returnValue(true);
 | 
			
		||||
                    expect(perform).not.toThrow();
 | 
			
		||||
                    moveService.validate.and.returnValue(false);
 | 
			
		||||
                    expect(perform).toThrow();
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                describe("when moving an original", function () {
 | 
			
		||||
                    beforeEach(function () {
 | 
			
		||||
                        locationCapability.getContextualLocation
 | 
			
		||||
                            .and.returnValue('new-location');
 | 
			
		||||
                        locationCapability.isOriginal.and.returnValue(true);
 | 
			
		||||
                        linkService.perform.calls.mostRecent().promise.resolve();
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    it("updates location", function () {
 | 
			
		||||
                        expect(locationCapability.setPrimaryLocation)
 | 
			
		||||
                            .toHaveBeenCalledWith('new-location');
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    describe("after location update", function () {
 | 
			
		||||
                        beforeEach(function () {
 | 
			
		||||
                            locationPromise.resolve();
 | 
			
		||||
                        });
 | 
			
		||||
 | 
			
		||||
                        it("removes object from parent without user warning dialog", function () {
 | 
			
		||||
                            expect(actionCapability.perform)
 | 
			
		||||
                                .toHaveBeenCalledWith('remove', true);
 | 
			
		||||
                        });
 | 
			
		||||
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                describe("when moving a link", function () {
 | 
			
		||||
                    beforeEach(function () {
 | 
			
		||||
                        locationCapability.isOriginal.and.returnValue(false);
 | 
			
		||||
                        linkService.perform.calls.mostRecent().promise.resolve();
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    it("does not update location", function () {
 | 
			
		||||
                        expect(locationCapability.setPrimaryLocation)
 | 
			
		||||
                            .not
 | 
			
		||||
                            .toHaveBeenCalled();
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    it("removes object from parent without user warning dialog", function () {
 | 
			
		||||
                        expect(actionCapability.perform)
 | 
			
		||||
                            .toHaveBeenCalledWith('remove', true);
 | 
			
		||||
                    });
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
            });
 | 
			
		||||
        });
 | 
			
		||||
    }
 | 
			
		||||
);
 | 
			
		||||
@@ -47,6 +47,8 @@ define([
 | 
			
		||||
                            "implementation": ExportAsJSONAction,
 | 
			
		||||
                            "category": "contextual",
 | 
			
		||||
                            "cssClass": "icon-export",
 | 
			
		||||
                            "group": "json",
 | 
			
		||||
                            "priority": 2,
 | 
			
		||||
                            "depends": [
 | 
			
		||||
                                "openmct",
 | 
			
		||||
                                "exportService",
 | 
			
		||||
@@ -61,6 +63,8 @@ define([
 | 
			
		||||
                            "implementation": ImportAsJSONAction,
 | 
			
		||||
                            "category": "contextual",
 | 
			
		||||
                            "cssClass": "icon-import",
 | 
			
		||||
                            "group": "json",
 | 
			
		||||
                            "priority": 2,
 | 
			
		||||
                            "depends": [
 | 
			
		||||
                                "exportService",
 | 
			
		||||
                                "identifierService",
 | 
			
		||||
 
 | 
			
		||||
@@ -32,7 +32,8 @@
 | 
			
		||||
    function indexItem(id, model) {
 | 
			
		||||
        indexedItems.push({
 | 
			
		||||
            id: id,
 | 
			
		||||
            name: model.name.toLowerCase()
 | 
			
		||||
            name: model.name.toLowerCase(),
 | 
			
		||||
            type: model.type
 | 
			
		||||
        });
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -125,13 +125,12 @@ define([
 | 
			
		||||
     * @param topic the topicService.
 | 
			
		||||
     */
 | 
			
		||||
    GenericSearchProvider.prototype.indexOnMutation = function (topic) {
 | 
			
		||||
        var mutationTopic = topic('mutation'),
 | 
			
		||||
            provider = this;
 | 
			
		||||
        let mutationTopic = topic('mutation');
 | 
			
		||||
 | 
			
		||||
        mutationTopic.listen(function (mutatedObject) {
 | 
			
		||||
            var editor = mutatedObject.getCapability('editor');
 | 
			
		||||
        mutationTopic.listen(mutatedObject => {
 | 
			
		||||
            let editor = mutatedObject.getCapability('editor');
 | 
			
		||||
            if (!editor || !editor.inEditContext()) {
 | 
			
		||||
                provider.index(
 | 
			
		||||
                this.index(
 | 
			
		||||
                    mutatedObject.getId(),
 | 
			
		||||
                    mutatedObject.getModel()
 | 
			
		||||
                );
 | 
			
		||||
@@ -262,6 +261,7 @@ define([
 | 
			
		||||
                return {
 | 
			
		||||
                    id: hit.item.id,
 | 
			
		||||
                    model: hit.item.model,
 | 
			
		||||
                    type: hit.item.type,
 | 
			
		||||
                    score: hit.matchCount
 | 
			
		||||
                };
 | 
			
		||||
            });
 | 
			
		||||
 
 | 
			
		||||
@@ -41,7 +41,8 @@
 | 
			
		||||
        indexedItems.push({
 | 
			
		||||
            id: id,
 | 
			
		||||
            vector: vector,
 | 
			
		||||
            model: model
 | 
			
		||||
            model: model,
 | 
			
		||||
            type: model.type
 | 
			
		||||
        });
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										14
									
								
								src/MCT.js
									
									
									
									
									
								
							
							
						
						
									
										14
									
								
								src/MCT.js
									
									
									
									
									
								
							@@ -46,6 +46,8 @@ define([
 | 
			
		||||
    './api/Branding',
 | 
			
		||||
    './plugins/licenses/plugin',
 | 
			
		||||
    './plugins/remove/plugin',
 | 
			
		||||
    './plugins/move/plugin',
 | 
			
		||||
    './plugins/duplicate/plugin',
 | 
			
		||||
    'vue'
 | 
			
		||||
], function (
 | 
			
		||||
    EventEmitter,
 | 
			
		||||
@@ -73,6 +75,8 @@ define([
 | 
			
		||||
    BrandingAPI,
 | 
			
		||||
    LicensesPlugin,
 | 
			
		||||
    RemoveActionPlugin,
 | 
			
		||||
    MoveActionPlugin,
 | 
			
		||||
    DuplicateActionPlugin,
 | 
			
		||||
    Vue
 | 
			
		||||
) {
 | 
			
		||||
    /**
 | 
			
		||||
@@ -242,7 +246,11 @@ define([
 | 
			
		||||
 | 
			
		||||
        this.overlays = new OverlayAPI.default();
 | 
			
		||||
 | 
			
		||||
        this.contextMenu = new api.ContextMenuRegistry();
 | 
			
		||||
        this.menus = new api.MenuAPI(this);
 | 
			
		||||
 | 
			
		||||
        this.actions = new api.ActionsAPI(this);
 | 
			
		||||
 | 
			
		||||
        this.status = new api.StatusAPI(this);
 | 
			
		||||
 | 
			
		||||
        this.router = new ApplicationRouter();
 | 
			
		||||
 | 
			
		||||
@@ -259,6 +267,8 @@ define([
 | 
			
		||||
        this.install(LegacyIndicatorsPlugin());
 | 
			
		||||
        this.install(LicensesPlugin.default());
 | 
			
		||||
        this.install(RemoveActionPlugin.default());
 | 
			
		||||
        this.install(MoveActionPlugin.default());
 | 
			
		||||
        this.install(DuplicateActionPlugin.default());
 | 
			
		||||
        this.install(this.plugins.FolderView());
 | 
			
		||||
        this.install(this.plugins.Tabs());
 | 
			
		||||
        this.install(ImageryPlugin.default());
 | 
			
		||||
@@ -271,6 +281,8 @@ define([
 | 
			
		||||
        this.install(this.plugins.URLTimeSettingsSynchronizer());
 | 
			
		||||
        this.install(this.plugins.NotificationIndicator());
 | 
			
		||||
        this.install(this.plugins.NewFolderAction());
 | 
			
		||||
        this.install(this.plugins.ViewDatumAction());
 | 
			
		||||
        this.install(this.plugins.ObjectInterceptors());
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    MCT.prototype = Object.create(EventEmitter.prototype);
 | 
			
		||||
 
 | 
			
		||||
@@ -35,5 +35,5 @@ export default function LegacyActionAdapter(openmct, legacyActions) {
 | 
			
		||||
 | 
			
		||||
    legacyActions.filter(contextualCategoryOnly)
 | 
			
		||||
        .map(LegacyAction => new LegacyContextMenuAction(openmct, LegacyAction))
 | 
			
		||||
        .forEach(openmct.contextMenu.registerAction);
 | 
			
		||||
        .forEach(openmct.actions.register);
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -31,6 +31,8 @@ export default class LegacyContextMenuAction {
 | 
			
		||||
        this.description = LegacyAction.definition.description;
 | 
			
		||||
        this.cssClass = LegacyAction.definition.cssClass;
 | 
			
		||||
        this.LegacyAction = LegacyAction;
 | 
			
		||||
        this.group = LegacyAction.definition.group;
 | 
			
		||||
        this.priority = LegacyAction.definition.priority;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    invoke(objectPath) {
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										189
									
								
								src/api/actions/ActionCollection.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										189
									
								
								src/api/actions/ActionCollection.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,189 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
import EventEmitter from 'EventEmitter';
 | 
			
		||||
import _ from 'lodash';
 | 
			
		||||
 | 
			
		||||
class ActionCollection extends EventEmitter {
 | 
			
		||||
    constructor(applicableActions, objectPath, view, openmct, skipEnvironmentObservers) {
 | 
			
		||||
        super();
 | 
			
		||||
 | 
			
		||||
        this.applicableActions = applicableActions;
 | 
			
		||||
        this.openmct = openmct;
 | 
			
		||||
        this.objectPath = objectPath;
 | 
			
		||||
        this.view = view;
 | 
			
		||||
        this.skipEnvironmentObservers = skipEnvironmentObservers;
 | 
			
		||||
        this.objectUnsubscribes = [];
 | 
			
		||||
 | 
			
		||||
        let debounceOptions = {
 | 
			
		||||
            leading: false,
 | 
			
		||||
            trailing: true
 | 
			
		||||
        };
 | 
			
		||||
 | 
			
		||||
        this._updateActions = _.debounce(this._updateActions.bind(this), 150, debounceOptions);
 | 
			
		||||
        this._update = _.debounce(this._update.bind(this), 150, debounceOptions);
 | 
			
		||||
 | 
			
		||||
        if (!skipEnvironmentObservers) {
 | 
			
		||||
            this._observeObjectPath();
 | 
			
		||||
            this.openmct.editor.on('isEditing', this._updateActions);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        this._initializeActions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    disable(actionKeys) {
 | 
			
		||||
        actionKeys.forEach(actionKey => {
 | 
			
		||||
            if (this.applicableActions[actionKey]) {
 | 
			
		||||
                this.applicableActions[actionKey].isDisabled = true;
 | 
			
		||||
            }
 | 
			
		||||
        });
 | 
			
		||||
        this._update();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    enable(actionKeys) {
 | 
			
		||||
        actionKeys.forEach(actionKey => {
 | 
			
		||||
            if (this.applicableActions[actionKey]) {
 | 
			
		||||
                this.applicableActions[actionKey].isDisabled = false;
 | 
			
		||||
            }
 | 
			
		||||
        });
 | 
			
		||||
        this._update();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    hide(actionKeys) {
 | 
			
		||||
        actionKeys.forEach(actionKey => {
 | 
			
		||||
            if (this.applicableActions[actionKey]) {
 | 
			
		||||
                this.applicableActions[actionKey].isHidden = true;
 | 
			
		||||
            }
 | 
			
		||||
        });
 | 
			
		||||
        this._update();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    show(actionKeys) {
 | 
			
		||||
        actionKeys.forEach(actionKey => {
 | 
			
		||||
            if (this.applicableActions[actionKey]) {
 | 
			
		||||
                this.applicableActions[actionKey].isHidden = false;
 | 
			
		||||
            }
 | 
			
		||||
        });
 | 
			
		||||
        this._update();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    destroy() {
 | 
			
		||||
        super.removeAllListeners();
 | 
			
		||||
 | 
			
		||||
        if (!this.skipEnvironmentObservers) {
 | 
			
		||||
            this.objectUnsubscribes.forEach(unsubscribe => {
 | 
			
		||||
                unsubscribe();
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            this.openmct.editor.off('isEditing', this._updateActions);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        this.emit('destroy', this.view);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    getVisibleActions() {
 | 
			
		||||
        let actionsArray = Object.keys(this.applicableActions);
 | 
			
		||||
        let visibleActions = [];
 | 
			
		||||
 | 
			
		||||
        actionsArray.forEach(actionKey => {
 | 
			
		||||
            let action = this.applicableActions[actionKey];
 | 
			
		||||
 | 
			
		||||
            if (!action.isHidden) {
 | 
			
		||||
                visibleActions.push(action);
 | 
			
		||||
            }
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        return visibleActions;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    getStatusBarActions() {
 | 
			
		||||
        let actionsArray = Object.keys(this.applicableActions);
 | 
			
		||||
        let statusBarActions = [];
 | 
			
		||||
 | 
			
		||||
        actionsArray.forEach(actionKey => {
 | 
			
		||||
            let action = this.applicableActions[actionKey];
 | 
			
		||||
 | 
			
		||||
            if (action.showInStatusBar && !action.isDisabled && !action.isHidden) {
 | 
			
		||||
                statusBarActions.push(action);
 | 
			
		||||
            }
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        return statusBarActions;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    getActionsObject() {
 | 
			
		||||
        return this.applicableActions;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    _update() {
 | 
			
		||||
        this.emit('update', this.applicableActions);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    _observeObjectPath() {
 | 
			
		||||
        let actionCollection = this;
 | 
			
		||||
 | 
			
		||||
        function updateObject(oldObject, newObject) {
 | 
			
		||||
            Object.assign(oldObject, newObject);
 | 
			
		||||
 | 
			
		||||
            actionCollection._updateActions();
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        this.objectPath.forEach(object => {
 | 
			
		||||
            if (object) {
 | 
			
		||||
                let unsubscribe = this.openmct.objects.observe(object, '*', updateObject.bind(this, object));
 | 
			
		||||
 | 
			
		||||
                this.objectUnsubscribes.push(unsubscribe);
 | 
			
		||||
            }
 | 
			
		||||
        });
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    _initializeActions() {
 | 
			
		||||
        Object.keys(this.applicableActions).forEach(key => {
 | 
			
		||||
            this.applicableActions[key].callBack = () => {
 | 
			
		||||
                return this.applicableActions[key].invoke(this.objectPath, this.view);
 | 
			
		||||
            };
 | 
			
		||||
        });
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    _updateActions() {
 | 
			
		||||
        let newApplicableActions = this.openmct.actions._applicableActions(this.objectPath, this.view);
 | 
			
		||||
 | 
			
		||||
        this.applicableActions = this._mergeOldAndNewActions(this.applicableActions, newApplicableActions);
 | 
			
		||||
        this._initializeActions();
 | 
			
		||||
        this._update();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    _mergeOldAndNewActions(oldActions, newActions) {
 | 
			
		||||
        let mergedActions = {};
 | 
			
		||||
        Object.keys(newActions).forEach(key => {
 | 
			
		||||
            if (oldActions[key]) {
 | 
			
		||||
                mergedActions[key] = oldActions[key];
 | 
			
		||||
            } else {
 | 
			
		||||
                mergedActions[key] = newActions[key];
 | 
			
		||||
            }
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        return mergedActions;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
export default ActionCollection;
 | 
			
		||||
							
								
								
									
										225
									
								
								src/api/actions/ActionCollectionSpec.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										225
									
								
								src/api/actions/ActionCollectionSpec.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,225 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
import ActionCollection from './ActionCollection';
 | 
			
		||||
import { createOpenMct, resetApplicationState } from '../../utils/testing';
 | 
			
		||||
 | 
			
		||||
describe('The ActionCollection', () => {
 | 
			
		||||
    let openmct;
 | 
			
		||||
    let actionCollection;
 | 
			
		||||
    let mockApplicableActions;
 | 
			
		||||
    let mockObjectPath;
 | 
			
		||||
    let mockView;
 | 
			
		||||
 | 
			
		||||
    beforeEach(() => {
 | 
			
		||||
        openmct = createOpenMct();
 | 
			
		||||
        mockObjectPath = [
 | 
			
		||||
            {
 | 
			
		||||
                name: 'mock folder',
 | 
			
		||||
                type: 'fake-folder',
 | 
			
		||||
                identifier: {
 | 
			
		||||
                    key: 'mock-folder',
 | 
			
		||||
                    namespace: ''
 | 
			
		||||
                }
 | 
			
		||||
            },
 | 
			
		||||
            {
 | 
			
		||||
                name: 'mock parent folder',
 | 
			
		||||
                type: 'fake-folder',
 | 
			
		||||
                identifier: {
 | 
			
		||||
                    key: 'mock-parent-folder',
 | 
			
		||||
                    namespace: ''
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        ];
 | 
			
		||||
        mockView = {
 | 
			
		||||
            getViewContext: () => {
 | 
			
		||||
                return {
 | 
			
		||||
                    onlyAppliesToTestCase: true
 | 
			
		||||
                };
 | 
			
		||||
            }
 | 
			
		||||
        };
 | 
			
		||||
        mockApplicableActions = {
 | 
			
		||||
            'test-action-object-path': {
 | 
			
		||||
                name: 'Test Action Object Path',
 | 
			
		||||
                key: 'test-action-object-path',
 | 
			
		||||
                cssClass: 'test-action-object-path',
 | 
			
		||||
                description: 'This is a test action for object path',
 | 
			
		||||
                group: 'action',
 | 
			
		||||
                priority: 9,
 | 
			
		||||
                appliesTo: (objectPath) => {
 | 
			
		||||
                    if (objectPath.length) {
 | 
			
		||||
                        return objectPath[0].type === 'fake-folder';
 | 
			
		||||
                    }
 | 
			
		||||
 | 
			
		||||
                    return false;
 | 
			
		||||
                },
 | 
			
		||||
                invoke: () => {
 | 
			
		||||
                }
 | 
			
		||||
            },
 | 
			
		||||
            'test-action-view': {
 | 
			
		||||
                name: 'Test Action View',
 | 
			
		||||
                key: 'test-action-view',
 | 
			
		||||
                cssClass: 'test-action-view',
 | 
			
		||||
                description: 'This is a test action for view',
 | 
			
		||||
                group: 'action',
 | 
			
		||||
                priority: 9,
 | 
			
		||||
                showInStatusBar: true,
 | 
			
		||||
                appliesTo: (objectPath, view = {}) => {
 | 
			
		||||
                    if (view.getViewContext) {
 | 
			
		||||
                        let viewContext = view.getViewContext();
 | 
			
		||||
 | 
			
		||||
                        return viewContext.onlyAppliesToTestCase;
 | 
			
		||||
                    }
 | 
			
		||||
 | 
			
		||||
                    return false;
 | 
			
		||||
                },
 | 
			
		||||
                invoke: () => {
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        };
 | 
			
		||||
 | 
			
		||||
        actionCollection = new ActionCollection(mockApplicableActions, mockObjectPath, mockView, openmct);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    afterEach(() => {
 | 
			
		||||
        actionCollection.destroy();
 | 
			
		||||
        resetApplicationState(openmct);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("disable method invoked with action keys", () => {
 | 
			
		||||
        it("marks those actions as isDisabled", () => {
 | 
			
		||||
            let actionKey = 'test-action-object-path';
 | 
			
		||||
            let actionsObject = actionCollection.getActionsObject();
 | 
			
		||||
            let action = actionsObject[actionKey];
 | 
			
		||||
 | 
			
		||||
            expect(action.isDisabled).toBeFalsy();
 | 
			
		||||
 | 
			
		||||
            actionCollection.disable([actionKey]);
 | 
			
		||||
            actionsObject = actionCollection.getActionsObject();
 | 
			
		||||
            action = actionsObject[actionKey];
 | 
			
		||||
 | 
			
		||||
            expect(action.isDisabled).toBeTrue();
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("enable method invoked with action keys", () => {
 | 
			
		||||
        it("marks the isDisabled property as false", () => {
 | 
			
		||||
            let actionKey = 'test-action-object-path';
 | 
			
		||||
 | 
			
		||||
            actionCollection.disable([actionKey]);
 | 
			
		||||
 | 
			
		||||
            let actionsObject = actionCollection.getActionsObject();
 | 
			
		||||
            let action = actionsObject[actionKey];
 | 
			
		||||
 | 
			
		||||
            expect(action.isDisabled).toBeTrue();
 | 
			
		||||
 | 
			
		||||
            actionCollection.enable([actionKey]);
 | 
			
		||||
            actionsObject = actionCollection.getActionsObject();
 | 
			
		||||
            action = actionsObject[actionKey];
 | 
			
		||||
 | 
			
		||||
            expect(action.isDisabled).toBeFalse();
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("hide method invoked with action keys", () => {
 | 
			
		||||
        it("marks those actions as isHidden", () => {
 | 
			
		||||
            let actionKey = 'test-action-object-path';
 | 
			
		||||
            let actionsObject = actionCollection.getActionsObject();
 | 
			
		||||
            let action = actionsObject[actionKey];
 | 
			
		||||
 | 
			
		||||
            expect(action.isHidden).toBeFalsy();
 | 
			
		||||
 | 
			
		||||
            actionCollection.hide([actionKey]);
 | 
			
		||||
            actionsObject = actionCollection.getActionsObject();
 | 
			
		||||
            action = actionsObject[actionKey];
 | 
			
		||||
 | 
			
		||||
            expect(action.isHidden).toBeTrue();
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("show method invoked with action keys", () => {
 | 
			
		||||
        it("marks the isHidden property as false", () => {
 | 
			
		||||
            let actionKey = 'test-action-object-path';
 | 
			
		||||
 | 
			
		||||
            actionCollection.hide([actionKey]);
 | 
			
		||||
 | 
			
		||||
            let actionsObject = actionCollection.getActionsObject();
 | 
			
		||||
            let action = actionsObject[actionKey];
 | 
			
		||||
 | 
			
		||||
            expect(action.isHidden).toBeTrue();
 | 
			
		||||
 | 
			
		||||
            actionCollection.show([actionKey]);
 | 
			
		||||
            actionsObject = actionCollection.getActionsObject();
 | 
			
		||||
            action = actionsObject[actionKey];
 | 
			
		||||
 | 
			
		||||
            expect(action.isHidden).toBeFalse();
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("getVisibleActions method", () => {
 | 
			
		||||
        it("returns an array of non hidden actions", () => {
 | 
			
		||||
            let action1Key = 'test-action-object-path';
 | 
			
		||||
            let action2Key = 'test-action-view';
 | 
			
		||||
 | 
			
		||||
            actionCollection.hide([action1Key]);
 | 
			
		||||
 | 
			
		||||
            let visibleActions = actionCollection.getVisibleActions();
 | 
			
		||||
 | 
			
		||||
            expect(Array.isArray(visibleActions)).toBeTrue();
 | 
			
		||||
            expect(visibleActions.length).toEqual(1);
 | 
			
		||||
            expect(visibleActions[0].key).toEqual(action2Key);
 | 
			
		||||
 | 
			
		||||
            actionCollection.show([action1Key]);
 | 
			
		||||
            visibleActions = actionCollection.getVisibleActions();
 | 
			
		||||
 | 
			
		||||
            expect(visibleActions.length).toEqual(2);
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("getStatusBarActions method", () => {
 | 
			
		||||
        it("returns an array of non disabled, non hidden statusBar actions", () => {
 | 
			
		||||
            let action2Key = 'test-action-view';
 | 
			
		||||
 | 
			
		||||
            let statusBarActions = actionCollection.getStatusBarActions();
 | 
			
		||||
 | 
			
		||||
            expect(Array.isArray(statusBarActions)).toBeTrue();
 | 
			
		||||
            expect(statusBarActions.length).toEqual(1);
 | 
			
		||||
            expect(statusBarActions[0].key).toEqual(action2Key);
 | 
			
		||||
 | 
			
		||||
            actionCollection.disable([action2Key]);
 | 
			
		||||
            statusBarActions = actionCollection.getStatusBarActions();
 | 
			
		||||
 | 
			
		||||
            expect(statusBarActions.length).toEqual(0);
 | 
			
		||||
 | 
			
		||||
            actionCollection.enable([action2Key]);
 | 
			
		||||
            statusBarActions = actionCollection.getStatusBarActions();
 | 
			
		||||
 | 
			
		||||
            expect(statusBarActions.length).toEqual(1);
 | 
			
		||||
            expect(statusBarActions[0].key).toEqual(action2Key);
 | 
			
		||||
 | 
			
		||||
            actionCollection.hide([action2Key]);
 | 
			
		||||
            statusBarActions = actionCollection.getStatusBarActions();
 | 
			
		||||
 | 
			
		||||
            expect(statusBarActions.length).toEqual(0);
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
});
 | 
			
		||||
							
								
								
									
										144
									
								
								src/api/actions/ActionsAPI.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										144
									
								
								src/api/actions/ActionsAPI.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,144 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
import EventEmitter from 'EventEmitter';
 | 
			
		||||
import ActionCollection from './ActionCollection';
 | 
			
		||||
import _ from 'lodash';
 | 
			
		||||
 | 
			
		||||
class ActionsAPI extends EventEmitter {
 | 
			
		||||
    constructor(openmct) {
 | 
			
		||||
        super();
 | 
			
		||||
 | 
			
		||||
        this._allActions = {};
 | 
			
		||||
        this._actionCollections = new WeakMap();
 | 
			
		||||
        this._openmct = openmct;
 | 
			
		||||
 | 
			
		||||
        this._groupOrder = ['windowing', 'undefined', 'view', 'action', 'json'];
 | 
			
		||||
 | 
			
		||||
        this.register = this.register.bind(this);
 | 
			
		||||
        this.get = this.get.bind(this);
 | 
			
		||||
        this._applicableActions = this._applicableActions.bind(this);
 | 
			
		||||
        this._updateCachedActionCollections = this._updateCachedActionCollections.bind(this);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    register(actionDefinition) {
 | 
			
		||||
        this._allActions[actionDefinition.key] = actionDefinition;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    get(objectPath, view) {
 | 
			
		||||
        if (view) {
 | 
			
		||||
 | 
			
		||||
            return this._getCachedActionCollection(objectPath, view) || this._newActionCollection(objectPath, view, true);
 | 
			
		||||
        } else {
 | 
			
		||||
 | 
			
		||||
            return this._newActionCollection(objectPath, view, true);
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    updateGroupOrder(groupArray) {
 | 
			
		||||
        this._groupOrder = groupArray;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    _get(objectPath, view) {
 | 
			
		||||
        let actionCollection = this._newActionCollection(objectPath, view);
 | 
			
		||||
 | 
			
		||||
        this._actionCollections.set(view, actionCollection);
 | 
			
		||||
        actionCollection.on('destroy', this._updateCachedActionCollections);
 | 
			
		||||
 | 
			
		||||
        return actionCollection;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    _getCachedActionCollection(objectPath, view) {
 | 
			
		||||
        let cachedActionCollection = this._actionCollections.get(view);
 | 
			
		||||
 | 
			
		||||
        return cachedActionCollection;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    _newActionCollection(objectPath, view, skipEnvironmentObservers) {
 | 
			
		||||
        let applicableActions = this._applicableActions(objectPath, view);
 | 
			
		||||
 | 
			
		||||
        return new ActionCollection(applicableActions, objectPath, view, this._openmct, skipEnvironmentObservers);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    _updateCachedActionCollections(key) {
 | 
			
		||||
        if (this._actionCollections.has(key)) {
 | 
			
		||||
            let actionCollection = this._actionCollections.get(key);
 | 
			
		||||
            actionCollection.off('destroy', this._updateCachedActionCollections);
 | 
			
		||||
 | 
			
		||||
            this._actionCollections.delete(key);
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    _applicableActions(objectPath, view) {
 | 
			
		||||
        let actionsObject = {};
 | 
			
		||||
 | 
			
		||||
        let keys = Object.keys(this._allActions).filter(key => {
 | 
			
		||||
            let actionDefinition = this._allActions[key];
 | 
			
		||||
 | 
			
		||||
            if (actionDefinition.appliesTo === undefined) {
 | 
			
		||||
                return true;
 | 
			
		||||
            } else {
 | 
			
		||||
                return actionDefinition.appliesTo(objectPath, view);
 | 
			
		||||
            }
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        keys.forEach(key => {
 | 
			
		||||
            let action = _.clone(this._allActions[key]);
 | 
			
		||||
 | 
			
		||||
            actionsObject[key] = action;
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        return actionsObject;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    _groupAndSortActions(actionsArray) {
 | 
			
		||||
        if (!Array.isArray(actionsArray) && typeof actionsArray === 'object') {
 | 
			
		||||
            actionsArray = Object.keys(actionsArray).map(key => actionsArray[key]);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        let actionsObject = {};
 | 
			
		||||
        let groupedSortedActionsArray = [];
 | 
			
		||||
 | 
			
		||||
        function sortDescending(a, b) {
 | 
			
		||||
            return b.priority - a.priority;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        actionsArray.forEach(action => {
 | 
			
		||||
            if (actionsObject[action.group] === undefined) {
 | 
			
		||||
                actionsObject[action.group] = [action];
 | 
			
		||||
            } else {
 | 
			
		||||
                actionsObject[action.group].push(action);
 | 
			
		||||
            }
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        this._groupOrder.forEach(group => {
 | 
			
		||||
            let groupArray = actionsObject[group];
 | 
			
		||||
 | 
			
		||||
            if (groupArray) {
 | 
			
		||||
                groupedSortedActionsArray.push(groupArray.sort(sortDescending));
 | 
			
		||||
            }
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        return groupedSortedActionsArray;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
export default ActionsAPI;
 | 
			
		||||
							
								
								
									
										153
									
								
								src/api/actions/ActionsAPISpec.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										153
									
								
								src/api/actions/ActionsAPISpec.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,153 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
import ActionsAPI from './ActionsAPI';
 | 
			
		||||
import { createOpenMct, resetApplicationState } from '../../utils/testing';
 | 
			
		||||
import ActionCollection from './ActionCollection';
 | 
			
		||||
 | 
			
		||||
describe('The Actions API', () => {
 | 
			
		||||
    let openmct;
 | 
			
		||||
    let actionsAPI;
 | 
			
		||||
    let mockAction;
 | 
			
		||||
    let mockObjectPath;
 | 
			
		||||
    let mockObjectPathAction;
 | 
			
		||||
    let mockViewContext1;
 | 
			
		||||
 | 
			
		||||
    beforeEach(() => {
 | 
			
		||||
        openmct = createOpenMct();
 | 
			
		||||
        actionsAPI = new ActionsAPI(openmct);
 | 
			
		||||
        mockObjectPathAction = {
 | 
			
		||||
            name: 'Test Action Object Path',
 | 
			
		||||
            key: 'test-action-object-path',
 | 
			
		||||
            cssClass: 'test-action-object-path',
 | 
			
		||||
            description: 'This is a test action for object path',
 | 
			
		||||
            group: 'action',
 | 
			
		||||
            priority: 9,
 | 
			
		||||
            appliesTo: (objectPath) => {
 | 
			
		||||
                if (objectPath.length) {
 | 
			
		||||
                    return objectPath[0].type === 'fake-folder';
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                return false;
 | 
			
		||||
            },
 | 
			
		||||
            invoke: () => {
 | 
			
		||||
            }
 | 
			
		||||
        };
 | 
			
		||||
        mockAction = {
 | 
			
		||||
            name: 'Test Action View',
 | 
			
		||||
            key: 'test-action-view',
 | 
			
		||||
            cssClass: 'test-action-view',
 | 
			
		||||
            description: 'This is a test action for view',
 | 
			
		||||
            group: 'action',
 | 
			
		||||
            priority: 9,
 | 
			
		||||
            appliesTo: (objectPath, view = {}) => {
 | 
			
		||||
                if (view.getViewContext) {
 | 
			
		||||
                    let viewContext = view.getViewContext();
 | 
			
		||||
 | 
			
		||||
                    return viewContext.onlyAppliesToTestCase;
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                return false;
 | 
			
		||||
            },
 | 
			
		||||
            invoke: () => {
 | 
			
		||||
            }
 | 
			
		||||
        };
 | 
			
		||||
        mockObjectPath = [
 | 
			
		||||
            {
 | 
			
		||||
                name: 'mock folder',
 | 
			
		||||
                type: 'fake-folder',
 | 
			
		||||
                identifier: {
 | 
			
		||||
                    key: 'mock-folder',
 | 
			
		||||
                    namespace: ''
 | 
			
		||||
                }
 | 
			
		||||
            },
 | 
			
		||||
            {
 | 
			
		||||
                name: 'mock parent folder',
 | 
			
		||||
                type: 'fake-folder',
 | 
			
		||||
                identifier: {
 | 
			
		||||
                    key: 'mock-parent-folder',
 | 
			
		||||
                    namespace: ''
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        ];
 | 
			
		||||
        mockViewContext1 = {
 | 
			
		||||
            getViewContext: () => {
 | 
			
		||||
                return {
 | 
			
		||||
                    onlyAppliesToTestCase: true
 | 
			
		||||
                };
 | 
			
		||||
            }
 | 
			
		||||
        };
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    afterEach(() => {
 | 
			
		||||
        resetApplicationState(openmct);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("register method", () => {
 | 
			
		||||
        it("adds action to ActionsAPI", () => {
 | 
			
		||||
            actionsAPI.register(mockAction);
 | 
			
		||||
 | 
			
		||||
            let actionCollection = actionsAPI.get(mockObjectPath, mockViewContext1);
 | 
			
		||||
            let action = actionCollection.getActionsObject()[mockAction.key];
 | 
			
		||||
 | 
			
		||||
            expect(action.key).toEqual(mockAction.key);
 | 
			
		||||
            expect(action.name).toEqual(mockAction.name);
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("get method", () => {
 | 
			
		||||
        beforeEach(() => {
 | 
			
		||||
            actionsAPI.register(mockAction);
 | 
			
		||||
            actionsAPI.register(mockObjectPathAction);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("returns an ActionCollection when invoked with an objectPath only", () => {
 | 
			
		||||
            let actionCollection = actionsAPI.get(mockObjectPath);
 | 
			
		||||
            let instanceOfActionCollection = actionCollection instanceof ActionCollection;
 | 
			
		||||
 | 
			
		||||
            expect(instanceOfActionCollection).toBeTrue();
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("returns an ActionCollection when invoked with an objectPath and view", () => {
 | 
			
		||||
            let actionCollection = actionsAPI.get(mockObjectPath, mockViewContext1);
 | 
			
		||||
            let instanceOfActionCollection = actionCollection instanceof ActionCollection;
 | 
			
		||||
 | 
			
		||||
            expect(instanceOfActionCollection).toBeTrue();
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("returns relevant actions when invoked with objectPath only", () => {
 | 
			
		||||
            let actionCollection = actionsAPI.get(mockObjectPath);
 | 
			
		||||
            let action = actionCollection.getActionsObject()[mockObjectPathAction.key];
 | 
			
		||||
 | 
			
		||||
            expect(action.key).toEqual(mockObjectPathAction.key);
 | 
			
		||||
            expect(action.name).toEqual(mockObjectPathAction.name);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("returns relevant actions when invoked with objectPath and view", () => {
 | 
			
		||||
            let actionCollection = actionsAPI.get(mockObjectPath, mockViewContext1);
 | 
			
		||||
            let action = actionCollection.getActionsObject()[mockAction.key];
 | 
			
		||||
 | 
			
		||||
            expect(action.key).toEqual(mockAction.key);
 | 
			
		||||
            expect(action.name).toEqual(mockAction.name);
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
});
 | 
			
		||||
@@ -28,9 +28,10 @@ define([
 | 
			
		||||
    './telemetry/TelemetryAPI',
 | 
			
		||||
    './indicators/IndicatorAPI',
 | 
			
		||||
    './notifications/NotificationAPI',
 | 
			
		||||
    './contextMenu/ContextMenuAPI',
 | 
			
		||||
    './Editor'
 | 
			
		||||
 | 
			
		||||
    './Editor',
 | 
			
		||||
    './menu/MenuAPI',
 | 
			
		||||
    './actions/ActionsAPI',
 | 
			
		||||
    './status/StatusAPI'
 | 
			
		||||
], function (
 | 
			
		||||
    TimeAPI,
 | 
			
		||||
    ObjectAPI,
 | 
			
		||||
@@ -39,8 +40,10 @@ define([
 | 
			
		||||
    TelemetryAPI,
 | 
			
		||||
    IndicatorAPI,
 | 
			
		||||
    NotificationAPI,
 | 
			
		||||
    ContextMenuAPI,
 | 
			
		||||
    EditorAPI
 | 
			
		||||
    EditorAPI,
 | 
			
		||||
    MenuAPI,
 | 
			
		||||
    ActionsAPI,
 | 
			
		||||
    StatusAPI
 | 
			
		||||
) {
 | 
			
		||||
    return {
 | 
			
		||||
        TimeAPI: TimeAPI,
 | 
			
		||||
@@ -51,6 +54,8 @@ define([
 | 
			
		||||
        IndicatorAPI: IndicatorAPI,
 | 
			
		||||
        NotificationAPI: NotificationAPI.default,
 | 
			
		||||
        EditorAPI: EditorAPI,
 | 
			
		||||
        ContextMenuRegistry: ContextMenuAPI.default
 | 
			
		||||
        MenuAPI: MenuAPI.default,
 | 
			
		||||
        ActionsAPI: ActionsAPI.default,
 | 
			
		||||
        StatusAPI: StatusAPI.default
 | 
			
		||||
    };
 | 
			
		||||
});
 | 
			
		||||
 
 | 
			
		||||
@@ -1,24 +0,0 @@
 | 
			
		||||
<template>
 | 
			
		||||
<div class="c-menu">
 | 
			
		||||
    <ul>
 | 
			
		||||
        <li
 | 
			
		||||
            v-for="action in actions"
 | 
			
		||||
            :key="action.name"
 | 
			
		||||
            :class="action.cssClass"
 | 
			
		||||
            :title="action.description"
 | 
			
		||||
            @click="action.invoke(objectPath)"
 | 
			
		||||
        >
 | 
			
		||||
            {{ action.name }}
 | 
			
		||||
        </li>
 | 
			
		||||
        <li v-if="actions.length === 0">
 | 
			
		||||
            No actions defined.
 | 
			
		||||
        </li>
 | 
			
		||||
    </ul>
 | 
			
		||||
</div>
 | 
			
		||||
</template>
 | 
			
		||||
 | 
			
		||||
<script>
 | 
			
		||||
export default {
 | 
			
		||||
    inject: ['actions', 'objectPath']
 | 
			
		||||
};
 | 
			
		||||
</script>
 | 
			
		||||
@@ -1,159 +0,0 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
import ContextMenuComponent from './ContextMenu.vue';
 | 
			
		||||
import Vue from 'vue';
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * The ContextMenuAPI allows the addition of new context menu actions, and for the context menu to be launched from
 | 
			
		||||
 * custom HTML elements.
 | 
			
		||||
 * @interface ContextMenuAPI
 | 
			
		||||
 * @memberof module:openmct
 | 
			
		||||
 */
 | 
			
		||||
class ContextMenuAPI {
 | 
			
		||||
    constructor() {
 | 
			
		||||
        this._allActions = [];
 | 
			
		||||
        this._activeContextMenu = undefined;
 | 
			
		||||
 | 
			
		||||
        this._hideActiveContextMenu = this._hideActiveContextMenu.bind(this);
 | 
			
		||||
        this.registerAction = this.registerAction.bind(this);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Defines an item to be added to context menus. Allows specification of text, appearance, and behavior when
 | 
			
		||||
     * selected. Applicabilioty can be restricted by specification of an `appliesTo` function.
 | 
			
		||||
     *
 | 
			
		||||
     * @interface ContextMenuAction
 | 
			
		||||
     * @memberof module:openmct
 | 
			
		||||
     * @property {string} name the human-readable name of this view
 | 
			
		||||
     * @property {string} description a longer-form description (typically
 | 
			
		||||
     *           a single sentence or short paragraph) of this kind of view
 | 
			
		||||
     * @property {string} cssClass the CSS class to apply to labels for this
 | 
			
		||||
     *           view (to add icons, for instance)
 | 
			
		||||
     * @property {string} key unique key to identify the context menu action
 | 
			
		||||
     *           (used in custom context menu eg table rows, to identify which actions to include)
 | 
			
		||||
     * @property {boolean} hideInDefaultMenu optional flag to hide action from showing in the default context menu (tree item)
 | 
			
		||||
     */
 | 
			
		||||
    /**
 | 
			
		||||
     * @method appliesTo
 | 
			
		||||
     * @memberof module:openmct.ContextMenuAction#
 | 
			
		||||
     * @param {DomainObject[]} objectPath the path of the object that the context menu has been invoked on.
 | 
			
		||||
     * @returns {boolean} true if the action applies to the objects specified in the 'objectPath', otherwise false.
 | 
			
		||||
     */
 | 
			
		||||
    /**
 | 
			
		||||
     * Code to be executed when the action is selected from a context menu
 | 
			
		||||
     * @method invoke
 | 
			
		||||
     * @memberof module:openmct.ContextMenuAction#
 | 
			
		||||
     * @param {DomainObject[]} objectPath the path of the object to invoke the action on.
 | 
			
		||||
     */
 | 
			
		||||
    /**
 | 
			
		||||
     * @param {ContextMenuAction} actionDefinition
 | 
			
		||||
     */
 | 
			
		||||
    registerAction(actionDefinition) {
 | 
			
		||||
        this._allActions.push(actionDefinition);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * @private
 | 
			
		||||
     */
 | 
			
		||||
    _showContextMenuForObjectPath(objectPath, x, y, actionsToBeIncluded) {
 | 
			
		||||
 | 
			
		||||
        let applicableActions = this._allActions.filter((action) => {
 | 
			
		||||
 | 
			
		||||
            if (actionsToBeIncluded) {
 | 
			
		||||
                if (action.appliesTo === undefined && actionsToBeIncluded.includes(action.key)) {
 | 
			
		||||
                    return true;
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                return action.appliesTo(objectPath, actionsToBeIncluded) && actionsToBeIncluded.includes(action.key);
 | 
			
		||||
            } else {
 | 
			
		||||
                if (action.appliesTo === undefined) {
 | 
			
		||||
                    return true;
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                return action.appliesTo(objectPath) && !action.hideInDefaultMenu;
 | 
			
		||||
            }
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        if (this._activeContextMenu) {
 | 
			
		||||
            this._hideActiveContextMenu();
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        this._activeContextMenu = this._createContextMenuForObject(objectPath, applicableActions);
 | 
			
		||||
        this._activeContextMenu.$mount();
 | 
			
		||||
        document.body.appendChild(this._activeContextMenu.$el);
 | 
			
		||||
 | 
			
		||||
        let position = this._calculatePopupPosition(x, y, this._activeContextMenu.$el);
 | 
			
		||||
        this._activeContextMenu.$el.style.left = `${position.x}px`;
 | 
			
		||||
        this._activeContextMenu.$el.style.top = `${position.y}px`;
 | 
			
		||||
 | 
			
		||||
        document.addEventListener('click', this._hideActiveContextMenu);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * @private
 | 
			
		||||
     */
 | 
			
		||||
    _calculatePopupPosition(eventPosX, eventPosY, menuElement) {
 | 
			
		||||
        let menuDimensions = menuElement.getBoundingClientRect();
 | 
			
		||||
        let overflowX = (eventPosX + menuDimensions.width) - document.body.clientWidth;
 | 
			
		||||
        let overflowY = (eventPosY + menuDimensions.height) - document.body.clientHeight;
 | 
			
		||||
 | 
			
		||||
        if (overflowX > 0) {
 | 
			
		||||
            eventPosX = eventPosX - overflowX;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        if (overflowY > 0) {
 | 
			
		||||
            eventPosY = eventPosY - overflowY;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        return {
 | 
			
		||||
            x: eventPosX,
 | 
			
		||||
            y: eventPosY
 | 
			
		||||
        };
 | 
			
		||||
    }
 | 
			
		||||
    /**
 | 
			
		||||
     * @private
 | 
			
		||||
     */
 | 
			
		||||
    _hideActiveContextMenu() {
 | 
			
		||||
        document.removeEventListener('click', this._hideActiveContextMenu);
 | 
			
		||||
        document.body.removeChild(this._activeContextMenu.$el);
 | 
			
		||||
        this._activeContextMenu.$destroy();
 | 
			
		||||
        this._activeContextMenu = undefined;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * @private
 | 
			
		||||
     */
 | 
			
		||||
    _createContextMenuForObject(objectPath, actions) {
 | 
			
		||||
        return new Vue({
 | 
			
		||||
            components: {
 | 
			
		||||
                ContextMenu: ContextMenuComponent
 | 
			
		||||
            },
 | 
			
		||||
            provide: {
 | 
			
		||||
                actions: actions,
 | 
			
		||||
                objectPath: objectPath
 | 
			
		||||
            },
 | 
			
		||||
            template: '<ContextMenu></ContextMenu>'
 | 
			
		||||
        });
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
export default ContextMenuAPI;
 | 
			
		||||
							
								
								
									
										68
									
								
								src/api/menu/MenuAPI.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										68
									
								
								src/api/menu/MenuAPI.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,68 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
import Menu from './menu.js';
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * The MenuAPI allows the addition of new context menu actions, and for the context menu to be launched from
 | 
			
		||||
 * custom HTML elements.
 | 
			
		||||
 * @interface MenuAPI
 | 
			
		||||
 * @memberof module:openmct
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
class MenuAPI {
 | 
			
		||||
    constructor(openmct) {
 | 
			
		||||
        this.openmct = openmct;
 | 
			
		||||
 | 
			
		||||
        this.showMenu = this.showMenu.bind(this);
 | 
			
		||||
        this._clearMenuComponent = this._clearMenuComponent.bind(this);
 | 
			
		||||
        this._showObjectMenu = this._showObjectMenu.bind(this);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    showMenu(x, y, actions, onDestroy) {
 | 
			
		||||
        if (this.menuComponent) {
 | 
			
		||||
            this.menuComponent.dismiss();
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        let options = {
 | 
			
		||||
            x,
 | 
			
		||||
            y,
 | 
			
		||||
            actions,
 | 
			
		||||
            onDestroy
 | 
			
		||||
        };
 | 
			
		||||
 | 
			
		||||
        this.menuComponent = new Menu(options);
 | 
			
		||||
        this.menuComponent.once('destroy', this._clearMenuComponent);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    _clearMenuComponent() {
 | 
			
		||||
        this.menuComponent = undefined;
 | 
			
		||||
        delete this.menuComponent;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    _showObjectMenu(objectPath, x, y, actionsToBeIncluded) {
 | 
			
		||||
        let applicableActions = this.openmct.actions._groupedAndSortedObjectActions(objectPath, actionsToBeIncluded);
 | 
			
		||||
 | 
			
		||||
        this.showMenu(x, y, applicableActions);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
export default MenuAPI;
 | 
			
		||||
							
								
								
									
										134
									
								
								src/api/menu/MenuAPISpec.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										134
									
								
								src/api/menu/MenuAPISpec.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,134 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
import MenuAPI from './MenuAPI';
 | 
			
		||||
import Menu from './menu';
 | 
			
		||||
import { createOpenMct, resetApplicationState } from '../../utils/testing';
 | 
			
		||||
 | 
			
		||||
describe ('The Menu API', () => {
 | 
			
		||||
    let openmct;
 | 
			
		||||
    let menuAPI;
 | 
			
		||||
    let actionsArray;
 | 
			
		||||
    let x;
 | 
			
		||||
    let y;
 | 
			
		||||
    let result;
 | 
			
		||||
    let onDestroy;
 | 
			
		||||
 | 
			
		||||
    beforeEach(() => {
 | 
			
		||||
        openmct = createOpenMct();
 | 
			
		||||
        menuAPI = new MenuAPI(openmct);
 | 
			
		||||
        actionsArray = [
 | 
			
		||||
            {
 | 
			
		||||
                name: 'Test Action 1',
 | 
			
		||||
                cssClass: 'test-css-class-1',
 | 
			
		||||
                description: 'This is a test action',
 | 
			
		||||
                callBack: () => {
 | 
			
		||||
                    result = 'Test Action 1 Invoked';
 | 
			
		||||
                }
 | 
			
		||||
            },
 | 
			
		||||
            {
 | 
			
		||||
                name: 'Test Action 2',
 | 
			
		||||
                cssClass: 'test-css-class-2',
 | 
			
		||||
                description: 'This is a test action',
 | 
			
		||||
                callBack: () => {
 | 
			
		||||
                    result = 'Test Action 2 Invoked';
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        ];
 | 
			
		||||
        x = 8;
 | 
			
		||||
        y = 16;
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    afterEach(() => {
 | 
			
		||||
        resetApplicationState(openmct);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("showMenu method", () => {
 | 
			
		||||
        it("creates an instance of Menu when invoked", () => {
 | 
			
		||||
            menuAPI.showMenu(x, y, actionsArray);
 | 
			
		||||
 | 
			
		||||
            expect(menuAPI.menuComponent).toBeInstanceOf(Menu);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        describe("creates a menu component", () => {
 | 
			
		||||
            let menuComponent;
 | 
			
		||||
            let vueComponent;
 | 
			
		||||
 | 
			
		||||
            beforeEach(() => {
 | 
			
		||||
                onDestroy = jasmine.createSpy('onDestroy');
 | 
			
		||||
 | 
			
		||||
                menuAPI.showMenu(x, y, actionsArray, onDestroy);
 | 
			
		||||
                vueComponent = menuAPI.menuComponent.component;
 | 
			
		||||
                menuComponent = document.querySelector(".c-menu");
 | 
			
		||||
 | 
			
		||||
                spyOn(vueComponent, '$destroy');
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            it("renders a menu component in the expected x and y coordinates", () => {
 | 
			
		||||
                let boundingClientRect = menuComponent.getBoundingClientRect();
 | 
			
		||||
                let left = boundingClientRect.left;
 | 
			
		||||
                let top = boundingClientRect.top;
 | 
			
		||||
 | 
			
		||||
                expect(left).toEqual(x);
 | 
			
		||||
                expect(top).toEqual(y);
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            it("with all the actions passed in", () => {
 | 
			
		||||
                expect(menuComponent).toBeDefined();
 | 
			
		||||
 | 
			
		||||
                let listItems = menuComponent.children[0].children;
 | 
			
		||||
 | 
			
		||||
                expect(listItems.length).toEqual(actionsArray.length);
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            it("with click-able menu items, that will invoke the correct callBacks", () => {
 | 
			
		||||
                let listItem1 = menuComponent.children[0].children[0];
 | 
			
		||||
 | 
			
		||||
                listItem1.click();
 | 
			
		||||
 | 
			
		||||
                expect(result).toEqual("Test Action 1 Invoked");
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            it("dismisses the menu when action is clicked on", () => {
 | 
			
		||||
                let listItem1 = menuComponent.children[0].children[0];
 | 
			
		||||
 | 
			
		||||
                listItem1.click();
 | 
			
		||||
 | 
			
		||||
                let menu = document.querySelector('.c-menu');
 | 
			
		||||
 | 
			
		||||
                expect(menu).toBeNull();
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            it("invokes the destroy method when menu is dismissed", () => {
 | 
			
		||||
                document.body.click();
 | 
			
		||||
 | 
			
		||||
                expect(vueComponent.$destroy).toHaveBeenCalled();
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            it("invokes the onDestroy callback if passed in", () => {
 | 
			
		||||
                document.body.click();
 | 
			
		||||
 | 
			
		||||
                expect(onDestroy).toHaveBeenCalled();
 | 
			
		||||
            });
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
});
 | 
			
		||||
							
								
								
									
										52
									
								
								src/api/menu/components/Menu.vue
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										52
									
								
								src/api/menu/components/Menu.vue
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,52 @@
 | 
			
		||||
<template>
 | 
			
		||||
<div class="c-menu">
 | 
			
		||||
    <ul v-if="actions.length && actions[0].length">
 | 
			
		||||
        <template
 | 
			
		||||
            v-for="(actionGroups, index) in actions"
 | 
			
		||||
        >
 | 
			
		||||
            <li
 | 
			
		||||
                v-for="action in actionGroups"
 | 
			
		||||
                :key="action.name"
 | 
			
		||||
                :class="[action.cssClass, action.isDisabled ? 'disabled' : '']"
 | 
			
		||||
                :title="action.description"
 | 
			
		||||
                @click="action.callBack"
 | 
			
		||||
            >
 | 
			
		||||
                {{ action.name }}
 | 
			
		||||
            </li>
 | 
			
		||||
            <div
 | 
			
		||||
                v-if="index !== actions.length - 1"
 | 
			
		||||
                :key="index"
 | 
			
		||||
                class="c-menu__section-separator"
 | 
			
		||||
            >
 | 
			
		||||
            </div>
 | 
			
		||||
            <li
 | 
			
		||||
                v-if="actionGroups.length === 0"
 | 
			
		||||
                :key="index"
 | 
			
		||||
            >
 | 
			
		||||
                No actions defined.
 | 
			
		||||
            </li>
 | 
			
		||||
        </template>
 | 
			
		||||
    </ul>
 | 
			
		||||
 | 
			
		||||
    <ul v-else>
 | 
			
		||||
        <li
 | 
			
		||||
            v-for="action in actions"
 | 
			
		||||
            :key="action.name"
 | 
			
		||||
            :class="action.cssClass"
 | 
			
		||||
            :title="action.description"
 | 
			
		||||
            @click="action.callBack"
 | 
			
		||||
        >
 | 
			
		||||
            {{ action.name }}
 | 
			
		||||
        </li>
 | 
			
		||||
        <li v-if="actions.length === 0">
 | 
			
		||||
            No actions defined.
 | 
			
		||||
        </li>
 | 
			
		||||
    </ul>
 | 
			
		||||
</div>
 | 
			
		||||
</template>
 | 
			
		||||
 | 
			
		||||
<script>
 | 
			
		||||
export default {
 | 
			
		||||
    inject: ['actions']
 | 
			
		||||
};
 | 
			
		||||
</script>
 | 
			
		||||
							
								
								
									
										94
									
								
								src/api/menu/menu.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										94
									
								
								src/api/menu/menu.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,94 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
import EventEmitter from 'EventEmitter';
 | 
			
		||||
import MenuComponent from './components/Menu.vue';
 | 
			
		||||
import Vue from 'vue';
 | 
			
		||||
 | 
			
		||||
class Menu extends EventEmitter {
 | 
			
		||||
    constructor(options) {
 | 
			
		||||
        super();
 | 
			
		||||
 | 
			
		||||
        this.options = options;
 | 
			
		||||
 | 
			
		||||
        this.component = new Vue({
 | 
			
		||||
            provide: {
 | 
			
		||||
                actions: options.actions
 | 
			
		||||
            },
 | 
			
		||||
            components: {
 | 
			
		||||
                MenuComponent
 | 
			
		||||
            },
 | 
			
		||||
            template: '<menu-component />'
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        if (options.onDestroy) {
 | 
			
		||||
            this.once('destroy', options.onDestroy);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        this.dismiss = this.dismiss.bind(this);
 | 
			
		||||
        this.show = this.show.bind(this);
 | 
			
		||||
 | 
			
		||||
        this.show();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    dismiss() {
 | 
			
		||||
        this.emit('destroy');
 | 
			
		||||
        document.body.removeChild(this.component.$el);
 | 
			
		||||
        document.removeEventListener('click', this.dismiss);
 | 
			
		||||
        this.component.$destroy();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    show() {
 | 
			
		||||
        this.component.$mount();
 | 
			
		||||
        document.body.appendChild(this.component.$el);
 | 
			
		||||
 | 
			
		||||
        let position = this._calculatePopupPosition(this.options.x, this.options.y, this.component.$el);
 | 
			
		||||
 | 
			
		||||
        this.component.$el.style.left = `${position.x}px`;
 | 
			
		||||
        this.component.$el.style.top = `${position.y}px`;
 | 
			
		||||
 | 
			
		||||
        document.addEventListener('click', this.dismiss);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * @private
 | 
			
		||||
     */
 | 
			
		||||
    _calculatePopupPosition(eventPosX, eventPosY, menuElement) {
 | 
			
		||||
        let menuDimensions = menuElement.getBoundingClientRect();
 | 
			
		||||
        let overflowX = (eventPosX + menuDimensions.width) - document.body.clientWidth;
 | 
			
		||||
        let overflowY = (eventPosY + menuDimensions.height) - document.body.clientHeight;
 | 
			
		||||
 | 
			
		||||
        if (overflowX > 0) {
 | 
			
		||||
            eventPosX = eventPosX - overflowX;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        if (overflowY > 0) {
 | 
			
		||||
            eventPosY = eventPosY - overflowY;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        return {
 | 
			
		||||
            x: eventPosX,
 | 
			
		||||
            y: eventPosY
 | 
			
		||||
        };
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
export default Menu;
 | 
			
		||||
							
								
								
									
										66
									
								
								src/api/objects/InterceptorRegistry.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										66
									
								
								src/api/objects/InterceptorRegistry.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,66 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
export default class InterceptorRegistry {
 | 
			
		||||
    /**
 | 
			
		||||
     * A InterceptorRegistry maintains the definitions for different interceptors that may be invoked on domain objects.
 | 
			
		||||
     * @interface InterceptorRegistry
 | 
			
		||||
     * @memberof module:openmct
 | 
			
		||||
     */
 | 
			
		||||
    constructor() {
 | 
			
		||||
        this.interceptors = [];
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * @interface InterceptorDef
 | 
			
		||||
     * @property {function} appliesTo function that determines if this interceptor should be called for the given identifier/object
 | 
			
		||||
     * @property {function} invoke function that transforms the provided domain object and returns the transformed domain object
 | 
			
		||||
     * @property {function} priority the priority for this interceptor. A higher number returned has more weight than a lower number
 | 
			
		||||
     * @memberof module:openmct InterceptorRegistry#
 | 
			
		||||
     */
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Register a new object interceptor.
 | 
			
		||||
     *
 | 
			
		||||
     * @param {module:openmct.InterceptorDef} interceptorDef the interceptor to add
 | 
			
		||||
     * @method addInterceptor
 | 
			
		||||
     * @memberof module:openmct.InterceptorRegistry#
 | 
			
		||||
     */
 | 
			
		||||
    addInterceptor(interceptorDef) {
 | 
			
		||||
        //TODO: sort by priority
 | 
			
		||||
        this.interceptors.push(interceptorDef);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Retrieve all interceptors applicable to a domain object.
 | 
			
		||||
     * @method getInterceptors
 | 
			
		||||
     * @returns [module:openmct.InterceptorDef] the registered interceptors for this identifier/object
 | 
			
		||||
     * @memberof module:openmct.InterceptorRegistry#
 | 
			
		||||
     */
 | 
			
		||||
    getInterceptors(identifier, object) {
 | 
			
		||||
        return this.interceptors.filter(interceptor => {
 | 
			
		||||
            return typeof interceptor.appliesTo === 'function'
 | 
			
		||||
                && interceptor.appliesTo(identifier, object);
 | 
			
		||||
        });
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										0
									
								
								src/api/objects/InterceptorRegistrySpec.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										0
									
								
								src/api/objects/InterceptorRegistrySpec.js
									
									
									
									
									
										Normal file
									
								
							@@ -26,6 +26,7 @@ define([
 | 
			
		||||
    './MutableObject',
 | 
			
		||||
    './RootRegistry',
 | 
			
		||||
    './RootObjectProvider',
 | 
			
		||||
    './InterceptorRegistry',
 | 
			
		||||
    'EventEmitter'
 | 
			
		||||
], function (
 | 
			
		||||
    _,
 | 
			
		||||
@@ -33,6 +34,7 @@ define([
 | 
			
		||||
    MutableObject,
 | 
			
		||||
    RootRegistry,
 | 
			
		||||
    RootObjectProvider,
 | 
			
		||||
    InterceptorRegistry,
 | 
			
		||||
    EventEmitter
 | 
			
		||||
) {
 | 
			
		||||
 | 
			
		||||
@@ -48,6 +50,7 @@ define([
 | 
			
		||||
        this.rootRegistry = new RootRegistry();
 | 
			
		||||
        this.rootProvider = new RootObjectProvider.default(this.rootRegistry);
 | 
			
		||||
        this.cache = {};
 | 
			
		||||
        this.interceptorRegistry = new InterceptorRegistry.default();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -177,6 +180,10 @@ define([
 | 
			
		||||
 | 
			
		||||
        return objectPromise.then(result => {
 | 
			
		||||
            delete this.cache[keystring];
 | 
			
		||||
            const interceptors = this.listGetInterceptors(identifier, result);
 | 
			
		||||
            interceptors.forEach(interceptor => {
 | 
			
		||||
                result = interceptor.invoke(identifier, result);
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            return result;
 | 
			
		||||
        });
 | 
			
		||||
@@ -312,6 +319,27 @@ define([
 | 
			
		||||
        });
 | 
			
		||||
    };
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Register an object interceptor that transforms a domain object requested via module:openmct.ObjectAPI.get
 | 
			
		||||
     * The domain object will be transformed after it is retrieved from the persistence store
 | 
			
		||||
     * The domain object will be transformed only if the interceptor is applicable to that domain object as defined by the InterceptorDef
 | 
			
		||||
     *
 | 
			
		||||
     * @param {module:openmct.InterceptorDef} interceptorDef the interceptor definition to add
 | 
			
		||||
     * @method addGetInterceptor
 | 
			
		||||
     * @memberof module:openmct.InterceptorRegistry#
 | 
			
		||||
     */
 | 
			
		||||
    ObjectAPI.prototype.addGetInterceptor = function (interceptorDef) {
 | 
			
		||||
        this.interceptorRegistry.addInterceptor(interceptorDef);
 | 
			
		||||
    };
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Retrieve the interceptors for a given domain object.
 | 
			
		||||
     * @private
 | 
			
		||||
     */
 | 
			
		||||
    ObjectAPI.prototype.listGetInterceptors = function (identifier, object) {
 | 
			
		||||
        return this.interceptorRegistry.getInterceptors(identifier, object);
 | 
			
		||||
    };
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Uniquely identifies a domain object.
 | 
			
		||||
     *
 | 
			
		||||
 
 | 
			
		||||
@@ -63,12 +63,51 @@ describe("The Object API", () => {
 | 
			
		||||
    describe("The get function", () => {
 | 
			
		||||
        describe("when a provider is available", () => {
 | 
			
		||||
            let mockProvider;
 | 
			
		||||
            let mockInterceptor;
 | 
			
		||||
            let anotherMockInterceptor;
 | 
			
		||||
            let notApplicableMockInterceptor;
 | 
			
		||||
            beforeEach(() => {
 | 
			
		||||
                mockProvider = jasmine.createSpyObj("mock provider", [
 | 
			
		||||
                    "get"
 | 
			
		||||
                ]);
 | 
			
		||||
                mockProvider.get.and.returnValue(Promise.resolve(mockDomainObject));
 | 
			
		||||
 | 
			
		||||
                mockInterceptor = jasmine.createSpyObj("mock interceptor", [
 | 
			
		||||
                    "appliesTo",
 | 
			
		||||
                    "invoke"
 | 
			
		||||
                ]);
 | 
			
		||||
                mockInterceptor.appliesTo.and.returnValue(true);
 | 
			
		||||
                mockInterceptor.invoke.and.callFake((identifier, object) => {
 | 
			
		||||
                    return Object.assign({
 | 
			
		||||
                        changed: true
 | 
			
		||||
                    }, object);
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                anotherMockInterceptor = jasmine.createSpyObj("another mock interceptor", [
 | 
			
		||||
                    "appliesTo",
 | 
			
		||||
                    "invoke"
 | 
			
		||||
                ]);
 | 
			
		||||
                anotherMockInterceptor.appliesTo.and.returnValue(true);
 | 
			
		||||
                anotherMockInterceptor.invoke.and.callFake((identifier, object) => {
 | 
			
		||||
                    return Object.assign({
 | 
			
		||||
                        alsoChanged: true
 | 
			
		||||
                    }, object);
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                notApplicableMockInterceptor = jasmine.createSpyObj("not applicable mock interceptor", [
 | 
			
		||||
                    "appliesTo",
 | 
			
		||||
                    "invoke"
 | 
			
		||||
                ]);
 | 
			
		||||
                notApplicableMockInterceptor.appliesTo.and.returnValue(false);
 | 
			
		||||
                notApplicableMockInterceptor.invoke.and.callFake((identifier, object) => {
 | 
			
		||||
                    return Object.assign({
 | 
			
		||||
                        shouldNotBeChanged: true
 | 
			
		||||
                    }, object);
 | 
			
		||||
                });
 | 
			
		||||
                objectAPI.addProvider(TEST_NAMESPACE, mockProvider);
 | 
			
		||||
                objectAPI.addGetInterceptor(mockInterceptor);
 | 
			
		||||
                objectAPI.addGetInterceptor(anotherMockInterceptor);
 | 
			
		||||
                objectAPI.addGetInterceptor(notApplicableMockInterceptor);
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            it("Caches multiple requests for the same object", () => {
 | 
			
		||||
@@ -78,6 +117,15 @@ describe("The Object API", () => {
 | 
			
		||||
                objectAPI.get(mockDomainObject.identifier);
 | 
			
		||||
                expect(mockProvider.get.calls.count()).toBe(1);
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            it("applies any applicable interceptors", () => {
 | 
			
		||||
                expect(mockDomainObject.changed).toBeUndefined();
 | 
			
		||||
                objectAPI.get(mockDomainObject.identifier).then((object) => {
 | 
			
		||||
                    expect(object.changed).toBeTrue();
 | 
			
		||||
                    expect(object.alsoChanged).toBeTrue();
 | 
			
		||||
                    expect(object.shouldNotBeChanged).toBeUndefined();
 | 
			
		||||
                });
 | 
			
		||||
            });
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
});
 | 
			
		||||
 
 | 
			
		||||
@@ -22,6 +22,7 @@ class OverlayAPI {
 | 
			
		||||
                this.dismissLastOverlay();
 | 
			
		||||
            }
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -127,6 +128,7 @@ class OverlayAPI {
 | 
			
		||||
 | 
			
		||||
        return progressDialog;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
export default OverlayAPI;
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										67
									
								
								src/api/status/StatusAPI.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										67
									
								
								src/api/status/StatusAPI.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,67 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
import EventEmitter from 'EventEmitter';
 | 
			
		||||
 | 
			
		||||
export default class StatusAPI extends EventEmitter {
 | 
			
		||||
    constructor(openmct) {
 | 
			
		||||
        super();
 | 
			
		||||
 | 
			
		||||
        this._openmct = openmct;
 | 
			
		||||
        this._statusCache = {};
 | 
			
		||||
 | 
			
		||||
        this.get = this.get.bind(this);
 | 
			
		||||
        this.set = this.set.bind(this);
 | 
			
		||||
        this.observe = this.observe.bind(this);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    get(identifier) {
 | 
			
		||||
        let keyString = this._openmct.objects.makeKeyString(identifier);
 | 
			
		||||
 | 
			
		||||
        return this._statusCache[keyString];
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    set(identifier, value) {
 | 
			
		||||
        let keyString = this._openmct.objects.makeKeyString(identifier);
 | 
			
		||||
 | 
			
		||||
        this._statusCache[keyString] = value;
 | 
			
		||||
        this.emit(keyString, value);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    delete(identifier) {
 | 
			
		||||
        let keyString = this._openmct.objects.makeKeyString(identifier);
 | 
			
		||||
 | 
			
		||||
        this._statusCache[keyString] = undefined;
 | 
			
		||||
        this.emit(keyString, undefined);
 | 
			
		||||
        delete this._statusCache[keyString];
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    observe(identifier, callback) {
 | 
			
		||||
        let key = this._openmct.objects.makeKeyString(identifier);
 | 
			
		||||
 | 
			
		||||
        this.on(key, callback);
 | 
			
		||||
 | 
			
		||||
        return () => {
 | 
			
		||||
            this.off(key, callback);
 | 
			
		||||
        };
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										85
									
								
								src/api/status/StatusAPISpec.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										85
									
								
								src/api/status/StatusAPISpec.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,85 @@
 | 
			
		||||
import StatusAPI from './StatusAPI.js';
 | 
			
		||||
import { createOpenMct, resetApplicationState } from '../../utils/testing';
 | 
			
		||||
 | 
			
		||||
describe("The Status API", () => {
 | 
			
		||||
    let statusAPI;
 | 
			
		||||
    let openmct;
 | 
			
		||||
    let identifier;
 | 
			
		||||
    let status;
 | 
			
		||||
    let status2;
 | 
			
		||||
    let callback;
 | 
			
		||||
 | 
			
		||||
    beforeEach(() => {
 | 
			
		||||
        openmct = createOpenMct();
 | 
			
		||||
        statusAPI = new StatusAPI(openmct);
 | 
			
		||||
        identifier = {
 | 
			
		||||
            namespace: "test-namespace",
 | 
			
		||||
            key: "test-key"
 | 
			
		||||
        };
 | 
			
		||||
        status = "test-status";
 | 
			
		||||
        status2 = 'test-status-deux';
 | 
			
		||||
        callback = jasmine.createSpy('callback', (statusUpdate) => statusUpdate);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    afterEach(() => {
 | 
			
		||||
        resetApplicationState(openmct);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("set function", () => {
 | 
			
		||||
        it("sets status for identifier", () => {
 | 
			
		||||
            statusAPI.set(identifier, status);
 | 
			
		||||
 | 
			
		||||
            let resultingStatus = statusAPI.get(identifier);
 | 
			
		||||
 | 
			
		||||
            expect(resultingStatus).toEqual(status);
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("get function", () => {
 | 
			
		||||
        it("returns status for identifier", () => {
 | 
			
		||||
            statusAPI.set(identifier, status2);
 | 
			
		||||
 | 
			
		||||
            let resultingStatus = statusAPI.get(identifier);
 | 
			
		||||
 | 
			
		||||
            expect(resultingStatus).toEqual(status2);
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("delete function", () => {
 | 
			
		||||
        it("deletes status for identifier", () => {
 | 
			
		||||
            statusAPI.set(identifier, status);
 | 
			
		||||
 | 
			
		||||
            let resultingStatus = statusAPI.get(identifier);
 | 
			
		||||
            expect(resultingStatus).toEqual(status);
 | 
			
		||||
 | 
			
		||||
            statusAPI.delete(identifier);
 | 
			
		||||
            resultingStatus = statusAPI.get(identifier);
 | 
			
		||||
 | 
			
		||||
            expect(resultingStatus).toBeUndefined();
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("observe function", () => {
 | 
			
		||||
 | 
			
		||||
        it("allows callbacks to be attached to status set and delete events", () => {
 | 
			
		||||
            let unsubscribe = statusAPI.observe(identifier, callback);
 | 
			
		||||
            statusAPI.set(identifier, status);
 | 
			
		||||
 | 
			
		||||
            expect(callback).toHaveBeenCalledWith(status);
 | 
			
		||||
 | 
			
		||||
            statusAPI.delete(identifier);
 | 
			
		||||
 | 
			
		||||
            expect(callback).toHaveBeenCalledWith(undefined);
 | 
			
		||||
            unsubscribe();
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("returns a unsubscribe function", () => {
 | 
			
		||||
            let unsubscribe = statusAPI.observe(identifier, callback);
 | 
			
		||||
            unsubscribe();
 | 
			
		||||
 | 
			
		||||
            statusAPI.set(identifier, status);
 | 
			
		||||
 | 
			
		||||
            expect(callback).toHaveBeenCalledTimes(0);
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
});
 | 
			
		||||
@@ -21,12 +21,14 @@
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
define([
 | 
			
		||||
    '../../plugins/displayLayout/CustomStringFormatter',
 | 
			
		||||
    './TelemetryMetadataManager',
 | 
			
		||||
    './TelemetryValueFormatter',
 | 
			
		||||
    './DefaultMetadataProvider',
 | 
			
		||||
    'objectUtils',
 | 
			
		||||
    'lodash'
 | 
			
		||||
], function (
 | 
			
		||||
    CustomStringFormatter,
 | 
			
		||||
    TelemetryMetadataManager,
 | 
			
		||||
    TelemetryValueFormatter,
 | 
			
		||||
    DefaultMetadataProvider,
 | 
			
		||||
@@ -142,6 +144,17 @@ define([
 | 
			
		||||
        this.valueFormatterCache = new WeakMap();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Return Custom String Formatter
 | 
			
		||||
     *
 | 
			
		||||
     * @param {Object} valueMetadata valueMetadata for given telemetry object
 | 
			
		||||
     * @param {string} format custom formatter string (eg: %.4f, <s etc.)
 | 
			
		||||
     * @returns {CustomStringFormatter}
 | 
			
		||||
     */
 | 
			
		||||
    TelemetryAPI.prototype.customStringFormatter = function (valueMetadata, format) {
 | 
			
		||||
        return new CustomStringFormatter.default(this.openmct, valueMetadata, format);
 | 
			
		||||
    };
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Return true if the given domainObject is a telemetry object.  A telemetry
 | 
			
		||||
     * object is any object which has telemetry metadata-- regardless of whether
 | 
			
		||||
@@ -400,6 +413,17 @@ define([
 | 
			
		||||
        return _.sortBy(options, sortKeys);
 | 
			
		||||
    };
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * @private
 | 
			
		||||
     */
 | 
			
		||||
    TelemetryAPI.prototype.getFormatService = function () {
 | 
			
		||||
        if (!this.formatService) {
 | 
			
		||||
            this.formatService = this.openmct.$injector.get('formatService');
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        return this.formatService;
 | 
			
		||||
    };
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get a value formatter for a given valueMetadata.
 | 
			
		||||
     *
 | 
			
		||||
@@ -407,19 +431,27 @@ define([
 | 
			
		||||
     */
 | 
			
		||||
    TelemetryAPI.prototype.getValueFormatter = function (valueMetadata) {
 | 
			
		||||
        if (!this.valueFormatterCache.has(valueMetadata)) {
 | 
			
		||||
            if (!this.formatService) {
 | 
			
		||||
                this.formatService = this.openmct.$injector.get('formatService');
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            this.valueFormatterCache.set(
 | 
			
		||||
                valueMetadata,
 | 
			
		||||
                new TelemetryValueFormatter(valueMetadata, this.formatService)
 | 
			
		||||
                new TelemetryValueFormatter(valueMetadata, this.getFormatService())
 | 
			
		||||
            );
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        return this.valueFormatterCache.get(valueMetadata);
 | 
			
		||||
    };
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get a value formatter for a given key.
 | 
			
		||||
     * @param {string} key
 | 
			
		||||
     *
 | 
			
		||||
     * @returns {Format}
 | 
			
		||||
     */
 | 
			
		||||
    TelemetryAPI.prototype.getFormatter = function (key) {
 | 
			
		||||
        const formatMap = this.getFormatService().formatMap;
 | 
			
		||||
 | 
			
		||||
        return formatMap[key];
 | 
			
		||||
    };
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get a format map of all value formatters for a given piece of telemetry
 | 
			
		||||
     * metadata.
 | 
			
		||||
 
 | 
			
		||||
@@ -44,6 +44,7 @@
 | 
			
		||||
<script>
 | 
			
		||||
 | 
			
		||||
const CONTEXT_MENU_ACTIONS = [
 | 
			
		||||
    'viewDatumAction',
 | 
			
		||||
    'viewHistoricalData',
 | 
			
		||||
    'remove'
 | 
			
		||||
];
 | 
			
		||||
@@ -129,6 +130,7 @@ export default {
 | 
			
		||||
            let limit;
 | 
			
		||||
 | 
			
		||||
            if (this.shouldUpdate(newTimestamp)) {
 | 
			
		||||
                this.datum = datum;
 | 
			
		||||
                this.timestamp = newTimestamp;
 | 
			
		||||
                this.value = this.formats[this.valueKey].format(datum);
 | 
			
		||||
                limit = this.limitEvaluator.evaluate(datum, this.valueMetadata);
 | 
			
		||||
@@ -175,8 +177,25 @@ export default {
 | 
			
		||||
            this.resetValues();
 | 
			
		||||
            this.timestampKey = timeSystem.key;
 | 
			
		||||
        },
 | 
			
		||||
        getView() {
 | 
			
		||||
            return {
 | 
			
		||||
                getViewContext: () => {
 | 
			
		||||
                    return {
 | 
			
		||||
                        viewHistoricalData: true,
 | 
			
		||||
                        viewDatumAction: true,
 | 
			
		||||
                        getDatum: () => {
 | 
			
		||||
                            return this.datum;
 | 
			
		||||
                        }
 | 
			
		||||
                    };
 | 
			
		||||
                }
 | 
			
		||||
            };
 | 
			
		||||
        },
 | 
			
		||||
        showContextMenu(event) {
 | 
			
		||||
            this.openmct.contextMenu._showContextMenuForObjectPath(this.currentObjectPath, event.x, event.y, CONTEXT_MENU_ACTIONS);
 | 
			
		||||
            let actionCollection = this.openmct.actions.get(this.currentObjectPath, this.getView());
 | 
			
		||||
            let allActions = actionCollection.getActionsObject();
 | 
			
		||||
            let applicableActions = CONTEXT_MENU_ACTIONS.map(key => allActions[key]);
 | 
			
		||||
 | 
			
		||||
            this.openmct.menus.showMenu(event.x, event.y, applicableActions);
 | 
			
		||||
        },
 | 
			
		||||
        resetValues() {
 | 
			
		||||
            this.value = '---';
 | 
			
		||||
 
 | 
			
		||||
@@ -19,342 +19,352 @@
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
import AutoflowTabularPlugin from './AutoflowTabularPlugin';
 | 
			
		||||
import AutoflowTabularConstants from './AutoflowTabularConstants';
 | 
			
		||||
import $ from 'zepto';
 | 
			
		||||
import DOMObserver from './dom-observer';
 | 
			
		||||
import {
 | 
			
		||||
    createOpenMct,
 | 
			
		||||
    resetApplicationState,
 | 
			
		||||
    spyOnBuiltins
 | 
			
		||||
} from 'utils/testing';
 | 
			
		||||
 | 
			
		||||
define([
 | 
			
		||||
    './AutoflowTabularPlugin',
 | 
			
		||||
    './AutoflowTabularConstants',
 | 
			
		||||
    '../../MCT',
 | 
			
		||||
    'zepto',
 | 
			
		||||
    './dom-observer'
 | 
			
		||||
], function (AutoflowTabularPlugin, AutoflowTabularConstants, MCT, $, DOMObserver) {
 | 
			
		||||
    describe("AutoflowTabularPlugin", function () {
 | 
			
		||||
        let testType;
 | 
			
		||||
        let testObject;
 | 
			
		||||
        let mockmct;
 | 
			
		||||
describe("AutoflowTabularPlugin", () => {
 | 
			
		||||
    let testType;
 | 
			
		||||
    let testObject;
 | 
			
		||||
    let mockmct;
 | 
			
		||||
 | 
			
		||||
        beforeEach(function () {
 | 
			
		||||
            testType = "some-type";
 | 
			
		||||
            testObject = { type: testType };
 | 
			
		||||
            mockmct = new MCT();
 | 
			
		||||
            spyOn(mockmct.composition, 'get');
 | 
			
		||||
            spyOn(mockmct.objectViews, 'addProvider');
 | 
			
		||||
            spyOn(mockmct.telemetry, 'getMetadata');
 | 
			
		||||
            spyOn(mockmct.telemetry, 'getValueFormatter');
 | 
			
		||||
            spyOn(mockmct.telemetry, 'limitEvaluator');
 | 
			
		||||
            spyOn(mockmct.telemetry, 'request');
 | 
			
		||||
            spyOn(mockmct.telemetry, 'subscribe');
 | 
			
		||||
    beforeEach(() => {
 | 
			
		||||
        testType = "some-type";
 | 
			
		||||
        testObject = { type: testType };
 | 
			
		||||
        mockmct = createOpenMct();
 | 
			
		||||
        spyOn(mockmct.composition, 'get');
 | 
			
		||||
        spyOn(mockmct.objectViews, 'addProvider');
 | 
			
		||||
        spyOn(mockmct.telemetry, 'getMetadata');
 | 
			
		||||
        spyOn(mockmct.telemetry, 'getValueFormatter');
 | 
			
		||||
        spyOn(mockmct.telemetry, 'limitEvaluator');
 | 
			
		||||
        spyOn(mockmct.telemetry, 'request');
 | 
			
		||||
        spyOn(mockmct.telemetry, 'subscribe');
 | 
			
		||||
 | 
			
		||||
            const plugin = new AutoflowTabularPlugin({ type: testType });
 | 
			
		||||
            plugin(mockmct);
 | 
			
		||||
        const plugin = new AutoflowTabularPlugin({ type: testType });
 | 
			
		||||
        plugin(mockmct);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    afterEach(() => {
 | 
			
		||||
        resetApplicationState(mockmct);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it("installs a view provider", () => {
 | 
			
		||||
        expect(mockmct.objectViews.addProvider).toHaveBeenCalled();
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("installs a view provider which", () => {
 | 
			
		||||
        let provider;
 | 
			
		||||
 | 
			
		||||
        beforeEach(() => {
 | 
			
		||||
            provider =
 | 
			
		||||
                mockmct.objectViews.addProvider.calls.mostRecent().args[0];
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("installs a view provider", function () {
 | 
			
		||||
            expect(mockmct.objectViews.addProvider).toHaveBeenCalled();
 | 
			
		||||
        it("applies its view to the type from options", () => {
 | 
			
		||||
            expect(provider.canView(testObject)).toBe(true);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        describe("installs a view provider which", function () {
 | 
			
		||||
            let provider;
 | 
			
		||||
        it("does not apply to other types", () => {
 | 
			
		||||
            expect(provider.canView({ type: 'foo' })).toBe(false);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
            beforeEach(function () {
 | 
			
		||||
                provider =
 | 
			
		||||
                    mockmct.objectViews.addProvider.calls.mostRecent().args[0];
 | 
			
		||||
            });
 | 
			
		||||
        describe("provides a view which", () => {
 | 
			
		||||
            let testKeys;
 | 
			
		||||
            let testChildren;
 | 
			
		||||
            let testContainer;
 | 
			
		||||
            let testHistories;
 | 
			
		||||
            let mockComposition;
 | 
			
		||||
            let mockMetadata;
 | 
			
		||||
            let mockEvaluator;
 | 
			
		||||
            let mockUnsubscribes;
 | 
			
		||||
            let callbacks;
 | 
			
		||||
            let view;
 | 
			
		||||
            let domObserver;
 | 
			
		||||
 | 
			
		||||
            it("applies its view to the type from options", function () {
 | 
			
		||||
                expect(provider.canView(testObject)).toBe(true);
 | 
			
		||||
            });
 | 
			
		||||
            function waitsForChange() {
 | 
			
		||||
                return new Promise(function (resolve) {
 | 
			
		||||
                    window.requestAnimationFrame(resolve);
 | 
			
		||||
                });
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            it("does not apply to other types", function () {
 | 
			
		||||
                expect(provider.canView({ type: 'foo' })).toBe(false);
 | 
			
		||||
            });
 | 
			
		||||
            function emitEvent(mockEmitter, type, event) {
 | 
			
		||||
                mockEmitter.on.calls.all().forEach((call) => {
 | 
			
		||||
                    if (call.args[0] === type) {
 | 
			
		||||
                        call.args[1](event);
 | 
			
		||||
                    }
 | 
			
		||||
                });
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            describe("provides a view which", function () {
 | 
			
		||||
                let testKeys;
 | 
			
		||||
                let testChildren;
 | 
			
		||||
                let testContainer;
 | 
			
		||||
                let testHistories;
 | 
			
		||||
                let mockComposition;
 | 
			
		||||
                let mockMetadata;
 | 
			
		||||
                let mockEvaluator;
 | 
			
		||||
                let mockUnsubscribes;
 | 
			
		||||
                let callbacks;
 | 
			
		||||
                let view;
 | 
			
		||||
                let domObserver;
 | 
			
		||||
            beforeEach((done) => {
 | 
			
		||||
                callbacks = {};
 | 
			
		||||
 | 
			
		||||
                function waitsForChange() {
 | 
			
		||||
                    return new Promise(function (resolve) {
 | 
			
		||||
                        window.requestAnimationFrame(resolve);
 | 
			
		||||
                spyOnBuiltins(['requestAnimationFrame']);
 | 
			
		||||
                window.requestAnimationFrame.and.callFake((callBack) => {
 | 
			
		||||
                    callBack();
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                testObject = { type: 'some-type' };
 | 
			
		||||
                testKeys = ['abc', 'def', 'xyz'];
 | 
			
		||||
                testChildren = testKeys.map((key) => {
 | 
			
		||||
                    return {
 | 
			
		||||
                        identifier: {
 | 
			
		||||
                            namespace: "test",
 | 
			
		||||
                            key: key
 | 
			
		||||
                        },
 | 
			
		||||
                        name: "Object " + key
 | 
			
		||||
                    };
 | 
			
		||||
                });
 | 
			
		||||
                testContainer = $('<div>')[0];
 | 
			
		||||
                domObserver = new DOMObserver(testContainer);
 | 
			
		||||
 | 
			
		||||
                testHistories = testKeys.reduce((histories, key, index) => {
 | 
			
		||||
                    histories[key] = {
 | 
			
		||||
                        key: key,
 | 
			
		||||
                        range: index + 10,
 | 
			
		||||
                        domain: key + index
 | 
			
		||||
                    };
 | 
			
		||||
 | 
			
		||||
                    return histories;
 | 
			
		||||
                }, {});
 | 
			
		||||
 | 
			
		||||
                mockComposition =
 | 
			
		||||
                    jasmine.createSpyObj('composition', ['load', 'on', 'off']);
 | 
			
		||||
                mockMetadata =
 | 
			
		||||
                    jasmine.createSpyObj('metadata', ['valuesForHints']);
 | 
			
		||||
 | 
			
		||||
                mockEvaluator = jasmine.createSpyObj('evaluator', ['evaluate']);
 | 
			
		||||
                mockUnsubscribes = testKeys.reduce((map, key) => {
 | 
			
		||||
                    map[key] = jasmine.createSpy('unsubscribe-' + key);
 | 
			
		||||
 | 
			
		||||
                    return map;
 | 
			
		||||
                }, {});
 | 
			
		||||
 | 
			
		||||
                mockmct.composition.get.and.returnValue(mockComposition);
 | 
			
		||||
                mockComposition.load.and.callFake(() => {
 | 
			
		||||
                    testChildren.forEach(emitEvent.bind(null, mockComposition, 'add'));
 | 
			
		||||
 | 
			
		||||
                    return Promise.resolve(testChildren);
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                mockmct.telemetry.getMetadata.and.returnValue(mockMetadata);
 | 
			
		||||
                mockmct.telemetry.getValueFormatter.and.callFake((metadatum) => {
 | 
			
		||||
                    const mockFormatter = jasmine.createSpyObj('formatter', ['format']);
 | 
			
		||||
                    mockFormatter.format.and.callFake((datum) => {
 | 
			
		||||
                        return datum[metadatum.hint];
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    return mockFormatter;
 | 
			
		||||
                });
 | 
			
		||||
                mockmct.telemetry.limitEvaluator.and.returnValue(mockEvaluator);
 | 
			
		||||
                mockmct.telemetry.subscribe.and.callFake((obj, callback) => {
 | 
			
		||||
                    const key = obj.identifier.key;
 | 
			
		||||
                    callbacks[key] = callback;
 | 
			
		||||
 | 
			
		||||
                    return mockUnsubscribes[key];
 | 
			
		||||
                });
 | 
			
		||||
                mockmct.telemetry.request.and.callFake((obj, request) => {
 | 
			
		||||
                    const key = obj.identifier.key;
 | 
			
		||||
 | 
			
		||||
                    return Promise.resolve([testHistories[key]]);
 | 
			
		||||
                });
 | 
			
		||||
                mockMetadata.valuesForHints.and.callFake((hints) => {
 | 
			
		||||
                    return [{ hint: hints[0] }];
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                view = provider.view(testObject);
 | 
			
		||||
                view.show(testContainer);
 | 
			
		||||
 | 
			
		||||
                return done();
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            afterEach(() => {
 | 
			
		||||
                domObserver.destroy();
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            it("populates its container", () => {
 | 
			
		||||
                expect(testContainer.children.length > 0).toBe(true);
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            describe("when rows have been populated", () => {
 | 
			
		||||
                function rowsMatch() {
 | 
			
		||||
                    const rows = $(testContainer).find(".l-autoflow-row").length;
 | 
			
		||||
 | 
			
		||||
                    return rows === testChildren.length;
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                function emitEvent(mockEmitter, type, event) {
 | 
			
		||||
                    mockEmitter.on.calls.all().forEach(function (call) {
 | 
			
		||||
                        if (call.args[0] === type) {
 | 
			
		||||
                            call.args[1](event);
 | 
			
		||||
                        }
 | 
			
		||||
                    });
 | 
			
		||||
                it("shows one row per child object", () => {
 | 
			
		||||
                    return domObserver.when(rowsMatch);
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                // it("adds rows on composition change", () => {
 | 
			
		||||
                //     const child = {
 | 
			
		||||
                //         identifier: {
 | 
			
		||||
                //             namespace: "test",
 | 
			
		||||
                //             key: "123"
 | 
			
		||||
                //         },
 | 
			
		||||
                //         name: "Object 123"
 | 
			
		||||
                //     };
 | 
			
		||||
                //     testChildren.push(child);
 | 
			
		||||
                //     emitEvent(mockComposition, 'add', child);
 | 
			
		||||
 | 
			
		||||
                //     return domObserver.when(rowsMatch);
 | 
			
		||||
                // });
 | 
			
		||||
 | 
			
		||||
                it("removes rows on composition change", () => {
 | 
			
		||||
                    const child = testChildren.pop();
 | 
			
		||||
                    emitEvent(mockComposition, 'remove', child.identifier);
 | 
			
		||||
 | 
			
		||||
                    return domObserver.when(rowsMatch);
 | 
			
		||||
                });
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            it("removes subscriptions when destroyed", () => {
 | 
			
		||||
                testKeys.forEach((key) => {
 | 
			
		||||
                    expect(mockUnsubscribes[key]).not.toHaveBeenCalled();
 | 
			
		||||
                });
 | 
			
		||||
                view.destroy();
 | 
			
		||||
                testKeys.forEach((key) => {
 | 
			
		||||
                    expect(mockUnsubscribes[key]).toHaveBeenCalled();
 | 
			
		||||
                });
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            it("provides a button to change column width", () => {
 | 
			
		||||
                const initialWidth = AutoflowTabularConstants.INITIAL_COLUMN_WIDTH;
 | 
			
		||||
                const nextWidth =
 | 
			
		||||
                    initialWidth + AutoflowTabularConstants.COLUMN_WIDTH_STEP;
 | 
			
		||||
 | 
			
		||||
                expect($(testContainer).find('.l-autoflow-col').css('width'))
 | 
			
		||||
                    .toEqual(initialWidth + 'px');
 | 
			
		||||
 | 
			
		||||
                $(testContainer).find('.change-column-width').click();
 | 
			
		||||
 | 
			
		||||
                function widthHasChanged() {
 | 
			
		||||
                    const width = $(testContainer).find('.l-autoflow-col').css('width');
 | 
			
		||||
 | 
			
		||||
                    return width !== initialWidth + 'px';
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                beforeEach(function () {
 | 
			
		||||
                    callbacks = {};
 | 
			
		||||
 | 
			
		||||
                    testObject = { type: 'some-type' };
 | 
			
		||||
                    testKeys = ['abc', 'def', 'xyz'];
 | 
			
		||||
                    testChildren = testKeys.map(function (key) {
 | 
			
		||||
                        return {
 | 
			
		||||
                            identifier: {
 | 
			
		||||
                                namespace: "test",
 | 
			
		||||
                                key: key
 | 
			
		||||
                            },
 | 
			
		||||
                            name: "Object " + key
 | 
			
		||||
                        };
 | 
			
		||||
                return domObserver.when(widthHasChanged)
 | 
			
		||||
                    .then(() => {
 | 
			
		||||
                        expect($(testContainer).find('.l-autoflow-col').css('width'))
 | 
			
		||||
                            .toEqual(nextWidth + 'px');
 | 
			
		||||
                    });
 | 
			
		||||
                    testContainer = $('<div>')[0];
 | 
			
		||||
                    domObserver = new DOMObserver(testContainer);
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
                    testHistories = testKeys.reduce(function (histories, key, index) {
 | 
			
		||||
                        histories[key] = {
 | 
			
		||||
                            key: key,
 | 
			
		||||
                            range: index + 10,
 | 
			
		||||
                            domain: key + index
 | 
			
		||||
                        };
 | 
			
		||||
            it("subscribes to all child objects", () => {
 | 
			
		||||
                testKeys.forEach((key) => {
 | 
			
		||||
                    expect(callbacks[key]).toEqual(jasmine.any(Function));
 | 
			
		||||
                });
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
                        return histories;
 | 
			
		||||
                    }, {});
 | 
			
		||||
            it("displays historical telemetry", () => {
 | 
			
		||||
                function rowTextDefined() {
 | 
			
		||||
                    return $(testContainer).find(".l-autoflow-item").filter(".r").text() !== "";
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                    mockComposition =
 | 
			
		||||
                        jasmine.createSpyObj('composition', ['load', 'on', 'off']);
 | 
			
		||||
                    mockMetadata =
 | 
			
		||||
                        jasmine.createSpyObj('metadata', ['valuesForHints']);
 | 
			
		||||
 | 
			
		||||
                    mockEvaluator = jasmine.createSpyObj('evaluator', ['evaluate']);
 | 
			
		||||
                    mockUnsubscribes = testKeys.reduce(function (map, key) {
 | 
			
		||||
                        map[key] = jasmine.createSpy('unsubscribe-' + key);
 | 
			
		||||
 | 
			
		||||
                        return map;
 | 
			
		||||
                    }, {});
 | 
			
		||||
 | 
			
		||||
                    mockmct.composition.get.and.returnValue(mockComposition);
 | 
			
		||||
                    mockComposition.load.and.callFake(function () {
 | 
			
		||||
                        testChildren.forEach(emitEvent.bind(null, mockComposition, 'add'));
 | 
			
		||||
 | 
			
		||||
                        return Promise.resolve(testChildren);
 | 
			
		||||
                return domObserver.when(rowTextDefined).then(() => {
 | 
			
		||||
                    testKeys.forEach((key, index) => {
 | 
			
		||||
                        const datum = testHistories[key];
 | 
			
		||||
                        const $cell = $(testContainer).find(".l-autoflow-row").eq(index).find(".r");
 | 
			
		||||
                        expect($cell.text()).toEqual(String(datum.range));
 | 
			
		||||
                    });
 | 
			
		||||
                });
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
                    mockmct.telemetry.getMetadata.and.returnValue(mockMetadata);
 | 
			
		||||
                    mockmct.telemetry.getValueFormatter.and.callFake(function (metadatum) {
 | 
			
		||||
                        const mockFormatter = jasmine.createSpyObj('formatter', ['format']);
 | 
			
		||||
                        mockFormatter.format.and.callFake(function (datum) {
 | 
			
		||||
                            return datum[metadatum.hint];
 | 
			
		||||
                        });
 | 
			
		||||
 | 
			
		||||
                        return mockFormatter;
 | 
			
		||||
                    });
 | 
			
		||||
                    mockmct.telemetry.limitEvaluator.and.returnValue(mockEvaluator);
 | 
			
		||||
                    mockmct.telemetry.subscribe.and.callFake(function (obj, callback) {
 | 
			
		||||
                        const key = obj.identifier.key;
 | 
			
		||||
                        callbacks[key] = callback;
 | 
			
		||||
 | 
			
		||||
                        return mockUnsubscribes[key];
 | 
			
		||||
                    });
 | 
			
		||||
                    mockmct.telemetry.request.and.callFake(function (obj, request) {
 | 
			
		||||
                        const key = obj.identifier.key;
 | 
			
		||||
 | 
			
		||||
                        return Promise.resolve([testHistories[key]]);
 | 
			
		||||
                    });
 | 
			
		||||
                    mockMetadata.valuesForHints.and.callFake(function (hints) {
 | 
			
		||||
                        return [{ hint: hints[0] }];
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    view = provider.view(testObject);
 | 
			
		||||
                    view.show(testContainer);
 | 
			
		||||
 | 
			
		||||
                    return waitsForChange();
 | 
			
		||||
            it("displays incoming telemetry", () => {
 | 
			
		||||
                const testData = testKeys.map((key, index) => {
 | 
			
		||||
                    return {
 | 
			
		||||
                        key: key,
 | 
			
		||||
                        range: index * 100,
 | 
			
		||||
                        domain: key + index
 | 
			
		||||
                    };
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                afterEach(function () {
 | 
			
		||||
                    domObserver.destroy();
 | 
			
		||||
                testData.forEach((datum) => {
 | 
			
		||||
                    callbacks[datum.key](datum);
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("populates its container", function () {
 | 
			
		||||
                    expect(testContainer.children.length > 0).toBe(true);
 | 
			
		||||
                return waitsForChange().then(() => {
 | 
			
		||||
                    testData.forEach((datum, index) => {
 | 
			
		||||
                        const $cell = $(testContainer).find(".l-autoflow-row").eq(index).find(".r");
 | 
			
		||||
                        expect($cell.text()).toEqual(String(datum.range));
 | 
			
		||||
                    });
 | 
			
		||||
                });
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
                describe("when rows have been populated", function () {
 | 
			
		||||
                    function rowsMatch() {
 | 
			
		||||
                        const rows = $(testContainer).find(".l-autoflow-row").length;
 | 
			
		||||
 | 
			
		||||
                        return rows === testChildren.length;
 | 
			
		||||
                    }
 | 
			
		||||
 | 
			
		||||
                    it("shows one row per child object", function () {
 | 
			
		||||
                        return domObserver.when(rowsMatch);
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    it("adds rows on composition change", function () {
 | 
			
		||||
                        const child = {
 | 
			
		||||
                            identifier: {
 | 
			
		||||
                                namespace: "test",
 | 
			
		||||
                                key: "123"
 | 
			
		||||
                            },
 | 
			
		||||
                            name: "Object 123"
 | 
			
		||||
                        };
 | 
			
		||||
                        testChildren.push(child);
 | 
			
		||||
                        emitEvent(mockComposition, 'add', child);
 | 
			
		||||
 | 
			
		||||
                        return domObserver.when(rowsMatch);
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    it("removes rows on composition change", function () {
 | 
			
		||||
                        const child = testChildren.pop();
 | 
			
		||||
                        emitEvent(mockComposition, 'remove', child.identifier);
 | 
			
		||||
 | 
			
		||||
                        return domObserver.when(rowsMatch);
 | 
			
		||||
            it("updates classes for limit violations", () => {
 | 
			
		||||
                const testClass = "some-limit-violation";
 | 
			
		||||
                mockEvaluator.evaluate.and.returnValue({ cssClass: testClass });
 | 
			
		||||
                testKeys.forEach((key) => {
 | 
			
		||||
                    callbacks[key]({
 | 
			
		||||
                        range: 'foo',
 | 
			
		||||
                        domain: 'bar'
 | 
			
		||||
                    });
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("removes subscriptions when destroyed", function () {
 | 
			
		||||
                    testKeys.forEach(function (key) {
 | 
			
		||||
                        expect(mockUnsubscribes[key]).not.toHaveBeenCalled();
 | 
			
		||||
                    });
 | 
			
		||||
                    view.destroy();
 | 
			
		||||
                    testKeys.forEach(function (key) {
 | 
			
		||||
                        expect(mockUnsubscribes[key]).toHaveBeenCalled();
 | 
			
		||||
                return waitsForChange().then(() => {
 | 
			
		||||
                    testKeys.forEach((datum, index) => {
 | 
			
		||||
                        const $cell = $(testContainer).find(".l-autoflow-row").eq(index).find(".r");
 | 
			
		||||
                        expect($cell.hasClass(testClass)).toBe(true);
 | 
			
		||||
                    });
 | 
			
		||||
                });
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
                it("provides a button to change column width", function () {
 | 
			
		||||
                    const initialWidth = AutoflowTabularConstants.INITIAL_COLUMN_WIDTH;
 | 
			
		||||
                    const nextWidth =
 | 
			
		||||
                        initialWidth + AutoflowTabularConstants.COLUMN_WIDTH_STEP;
 | 
			
		||||
            it("automatically flows to new columns", () => {
 | 
			
		||||
                const rowHeight = AutoflowTabularConstants.ROW_HEIGHT;
 | 
			
		||||
                const sliderHeight = AutoflowTabularConstants.SLIDER_HEIGHT;
 | 
			
		||||
                const count = testKeys.length;
 | 
			
		||||
                const $container = $(testContainer);
 | 
			
		||||
                let promiseChain = Promise.resolve();
 | 
			
		||||
 | 
			
		||||
                    expect($(testContainer).find('.l-autoflow-col').css('width'))
 | 
			
		||||
                        .toEqual(initialWidth + 'px');
 | 
			
		||||
                function columnsHaveAutoflowed() {
 | 
			
		||||
                    const itemsHeight = $container.find('.l-autoflow-items').height();
 | 
			
		||||
                    const availableHeight = itemsHeight - sliderHeight;
 | 
			
		||||
                    const availableRows = Math.max(Math.floor(availableHeight / rowHeight), 1);
 | 
			
		||||
                    const columns = Math.ceil(count / availableRows);
 | 
			
		||||
 | 
			
		||||
                    $(testContainer).find('.change-column-width').click();
 | 
			
		||||
                    return $container.find('.l-autoflow-col').length === columns;
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                    function widthHasChanged() {
 | 
			
		||||
                        const width = $(testContainer).find('.l-autoflow-col').css('width');
 | 
			
		||||
 | 
			
		||||
                        return width !== initialWidth + 'px';
 | 
			
		||||
                    }
 | 
			
		||||
 | 
			
		||||
                    return domObserver.when(widthHasChanged)
 | 
			
		||||
                        .then(function () {
 | 
			
		||||
                            expect($(testContainer).find('.l-autoflow-col').css('width'))
 | 
			
		||||
                                .toEqual(nextWidth + 'px');
 | 
			
		||||
                        });
 | 
			
		||||
                $container.find('.abs').css({
 | 
			
		||||
                    position: 'absolute',
 | 
			
		||||
                    left: '0px',
 | 
			
		||||
                    right: '0px',
 | 
			
		||||
                    top: '0px',
 | 
			
		||||
                    bottom: '0px'
 | 
			
		||||
                });
 | 
			
		||||
                $container.css({ position: 'absolute' });
 | 
			
		||||
 | 
			
		||||
                it("subscribes to all child objects", function () {
 | 
			
		||||
                    testKeys.forEach(function (key) {
 | 
			
		||||
                        expect(callbacks[key]).toEqual(jasmine.any(Function));
 | 
			
		||||
                    });
 | 
			
		||||
                $container.appendTo(document.body);
 | 
			
		||||
 | 
			
		||||
                function setHeight(height) {
 | 
			
		||||
                    $container.css('height', height + 'px');
 | 
			
		||||
 | 
			
		||||
                    return domObserver.when(columnsHaveAutoflowed);
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                for (let height = 0; height < rowHeight * count * 2; height += rowHeight / 2) {
 | 
			
		||||
                    // eslint-disable-next-line no-invalid-this
 | 
			
		||||
                    promiseChain = promiseChain.then(setHeight.bind(this, height));
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                return promiseChain.then(() => {
 | 
			
		||||
                    $container.remove();
 | 
			
		||||
                });
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
                it("displays historical telemetry", function () {
 | 
			
		||||
                    function rowTextDefined() {
 | 
			
		||||
                        return $(testContainer).find(".l-autoflow-item").filter(".r").text() !== "";
 | 
			
		||||
                    }
 | 
			
		||||
 | 
			
		||||
                    return domObserver.when(rowTextDefined).then(function () {
 | 
			
		||||
                        testKeys.forEach(function (key, index) {
 | 
			
		||||
                            const datum = testHistories[key];
 | 
			
		||||
                            const $cell = $(testContainer).find(".l-autoflow-row").eq(index).find(".r");
 | 
			
		||||
                            expect($cell.text()).toEqual(String(datum.range));
 | 
			
		||||
                        });
 | 
			
		||||
                    });
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("displays incoming telemetry", function () {
 | 
			
		||||
                    const testData = testKeys.map(function (key, index) {
 | 
			
		||||
                        return {
 | 
			
		||||
                            key: key,
 | 
			
		||||
                            range: index * 100,
 | 
			
		||||
                            domain: key + index
 | 
			
		||||
                        };
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    testData.forEach(function (datum) {
 | 
			
		||||
                        callbacks[datum.key](datum);
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    return waitsForChange().then(function () {
 | 
			
		||||
                        testData.forEach(function (datum, index) {
 | 
			
		||||
                            const $cell = $(testContainer).find(".l-autoflow-row").eq(index).find(".r");
 | 
			
		||||
                            expect($cell.text()).toEqual(String(datum.range));
 | 
			
		||||
                        });
 | 
			
		||||
                    });
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("updates classes for limit violations", function () {
 | 
			
		||||
                    const testClass = "some-limit-violation";
 | 
			
		||||
                    mockEvaluator.evaluate.and.returnValue({ cssClass: testClass });
 | 
			
		||||
                    testKeys.forEach(function (key) {
 | 
			
		||||
                        callbacks[key]({
 | 
			
		||||
                            range: 'foo',
 | 
			
		||||
                            domain: 'bar'
 | 
			
		||||
                        });
 | 
			
		||||
                    });
 | 
			
		||||
 | 
			
		||||
                    return waitsForChange().then(function () {
 | 
			
		||||
                        testKeys.forEach(function (datum, index) {
 | 
			
		||||
                            const $cell = $(testContainer).find(".l-autoflow-row").eq(index).find(".r");
 | 
			
		||||
                            expect($cell.hasClass(testClass)).toBe(true);
 | 
			
		||||
                        });
 | 
			
		||||
                    });
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("automatically flows to new columns", function () {
 | 
			
		||||
                    const rowHeight = AutoflowTabularConstants.ROW_HEIGHT;
 | 
			
		||||
                    const sliderHeight = AutoflowTabularConstants.SLIDER_HEIGHT;
 | 
			
		||||
                    const count = testKeys.length;
 | 
			
		||||
                    const $container = $(testContainer);
 | 
			
		||||
                    let promiseChain = Promise.resolve();
 | 
			
		||||
 | 
			
		||||
                    function columnsHaveAutoflowed() {
 | 
			
		||||
                        const itemsHeight = $container.find('.l-autoflow-items').height();
 | 
			
		||||
                        const availableHeight = itemsHeight - sliderHeight;
 | 
			
		||||
                        const availableRows = Math.max(Math.floor(availableHeight / rowHeight), 1);
 | 
			
		||||
                        const columns = Math.ceil(count / availableRows);
 | 
			
		||||
 | 
			
		||||
                        return $container.find('.l-autoflow-col').length === columns;
 | 
			
		||||
                    }
 | 
			
		||||
 | 
			
		||||
                    $container.find('.abs').css({
 | 
			
		||||
                        position: 'absolute',
 | 
			
		||||
                        left: '0px',
 | 
			
		||||
                        right: '0px',
 | 
			
		||||
                        top: '0px',
 | 
			
		||||
                        bottom: '0px'
 | 
			
		||||
                    });
 | 
			
		||||
                    $container.css({ position: 'absolute' });
 | 
			
		||||
 | 
			
		||||
                    $container.appendTo(document.body);
 | 
			
		||||
 | 
			
		||||
                    function setHeight(height) {
 | 
			
		||||
                        $container.css('height', height + 'px');
 | 
			
		||||
 | 
			
		||||
                        return domObserver.when(columnsHaveAutoflowed);
 | 
			
		||||
                    }
 | 
			
		||||
 | 
			
		||||
                    for (let height = 0; height < rowHeight * count * 2; height += rowHeight / 2) {
 | 
			
		||||
                        // eslint-disable-next-line no-invalid-this
 | 
			
		||||
                        promiseChain = promiseChain.then(setHeight.bind(this, height));
 | 
			
		||||
                    }
 | 
			
		||||
 | 
			
		||||
                    return promiseChain.then(function () {
 | 
			
		||||
                        $container.remove();
 | 
			
		||||
                    });
 | 
			
		||||
                });
 | 
			
		||||
 | 
			
		||||
                it("loads composition exactly once", function () {
 | 
			
		||||
                    const testObj = testChildren.pop();
 | 
			
		||||
                    emitEvent(mockComposition, 'remove', testObj.identifier);
 | 
			
		||||
                    testChildren.push(testObj);
 | 
			
		||||
                    emitEvent(mockComposition, 'add', testObj);
 | 
			
		||||
                    expect(mockComposition.load.calls.count()).toEqual(1);
 | 
			
		||||
                });
 | 
			
		||||
            it("loads composition exactly once", () => {
 | 
			
		||||
                const testObj = testChildren.pop();
 | 
			
		||||
                emitEvent(mockComposition, 'remove', testObj.identifier);
 | 
			
		||||
                testChildren.push(testObj);
 | 
			
		||||
                emitEvent(mockComposition, 'add', testObj);
 | 
			
		||||
                expect(mockComposition.load.calls.count()).toEqual(1);
 | 
			
		||||
            });
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
 
 | 
			
		||||
@@ -23,6 +23,7 @@
 | 
			
		||||
export default class ClearDataAction {
 | 
			
		||||
    constructor(openmct, appliesToObjects) {
 | 
			
		||||
        this.name = 'Clear Data for Object';
 | 
			
		||||
        this.key = 'clear-data-action';
 | 
			
		||||
        this.description = 'Clears current data for object, unsubscribes and resubscribes to data';
 | 
			
		||||
        this.cssClass = 'icon-clear-data';
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -53,7 +53,7 @@ define([
 | 
			
		||||
                openmct.indicators.add(indicator);
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            openmct.contextMenu.registerAction(new ClearDataAction.default(openmct, appliesToObjects));
 | 
			
		||||
            openmct.actions.register(new ClearDataAction.default(openmct, appliesToObjects));
 | 
			
		||||
        };
 | 
			
		||||
    };
 | 
			
		||||
});
 | 
			
		||||
 
 | 
			
		||||
@@ -26,12 +26,12 @@ import ClearDataAction from '../clearDataAction.js';
 | 
			
		||||
describe('When the Clear Data Plugin is installed,', function () {
 | 
			
		||||
    const mockObjectViews = jasmine.createSpyObj('objectViews', ['emit']);
 | 
			
		||||
    const mockIndicatorProvider = jasmine.createSpyObj('indicators', ['add']);
 | 
			
		||||
    const mockContextMenuProvider = jasmine.createSpyObj('contextMenu', ['registerAction']);
 | 
			
		||||
    const mockActionsProvider = jasmine.createSpyObj('actions', ['register']);
 | 
			
		||||
 | 
			
		||||
    const openmct = {
 | 
			
		||||
        objectViews: mockObjectViews,
 | 
			
		||||
        indicators: mockIndicatorProvider,
 | 
			
		||||
        contextMenu: mockContextMenuProvider,
 | 
			
		||||
        actions: mockActionsProvider,
 | 
			
		||||
        install: function (plugin) {
 | 
			
		||||
            plugin(this);
 | 
			
		||||
        }
 | 
			
		||||
@@ -51,7 +51,7 @@ describe('When the Clear Data Plugin is installed,', function () {
 | 
			
		||||
    it('Clear Data context menu action is installed', function () {
 | 
			
		||||
        openmct.install(ClearDataActionPlugin([]));
 | 
			
		||||
 | 
			
		||||
        expect(mockContextMenuProvider.registerAction).toHaveBeenCalled();
 | 
			
		||||
        expect(mockActionsProvider.register).toHaveBeenCalled();
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it('clear data action emits a clearData event when invoked', function () {
 | 
			
		||||
 
 | 
			
		||||
@@ -75,7 +75,8 @@ export default class Condition extends EventEmitter {
 | 
			
		||||
            return;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        if (this.isTelemetryUsed(datum.id)) {
 | 
			
		||||
        // if all the criteria in this condition have no telemetry, we want to force the condition result to evaluate
 | 
			
		||||
        if (this.hasNoTelemetry() || this.isTelemetryUsed(datum.id)) {
 | 
			
		||||
 | 
			
		||||
            this.criteria.forEach(criterion => {
 | 
			
		||||
                if (this.isAnyOrAllTelemetry(criterion)) {
 | 
			
		||||
@@ -93,6 +94,12 @@ export default class Condition extends EventEmitter {
 | 
			
		||||
        return (criterion.telemetry && (criterion.telemetry === 'all' || criterion.telemetry === 'any'));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    hasNoTelemetry() {
 | 
			
		||||
        return this.criteria.every((criterion) => {
 | 
			
		||||
            return !this.isAnyOrAllTelemetry(criterion) && criterion.telemetry === '';
 | 
			
		||||
        });
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    isTelemetryUsed(id) {
 | 
			
		||||
        return this.criteria.some(criterion => {
 | 
			
		||||
            return this.isAnyOrAllTelemetry(criterion) || criterion.telemetryObjectIdAsString === id;
 | 
			
		||||
@@ -250,10 +257,17 @@ export default class Condition extends EventEmitter {
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    getTriggerDescription() {
 | 
			
		||||
        return {
 | 
			
		||||
            conjunction: TRIGGER_CONJUNCTION[this.trigger],
 | 
			
		||||
            prefix: `${TRIGGER_LABEL[this.trigger]}: `
 | 
			
		||||
        };
 | 
			
		||||
        if (this.trigger) {
 | 
			
		||||
            return {
 | 
			
		||||
                conjunction: TRIGGER_CONJUNCTION[this.trigger],
 | 
			
		||||
                prefix: `${TRIGGER_LABEL[this.trigger]}: `
 | 
			
		||||
            };
 | 
			
		||||
        } else {
 | 
			
		||||
            return {
 | 
			
		||||
                conjunction: '',
 | 
			
		||||
                prefix: ''
 | 
			
		||||
            };
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    requestLADConditionResult() {
 | 
			
		||||
 
 | 
			
		||||
@@ -79,6 +79,17 @@ export default class ConditionManager extends EventEmitter {
 | 
			
		||||
        delete this.subscriptions[id];
 | 
			
		||||
        delete this.telemetryObjects[id];
 | 
			
		||||
        this.removeConditionTelemetryObjects();
 | 
			
		||||
 | 
			
		||||
        //force re-computation of condition set result as we might be in a state where
 | 
			
		||||
        // there is no telemetry datum coming in for a while or at all.
 | 
			
		||||
        let latestTimestamp = getLatestTimestamp(
 | 
			
		||||
            {},
 | 
			
		||||
            {},
 | 
			
		||||
            this.timeSystems,
 | 
			
		||||
            this.openmct.time.timeSystem()
 | 
			
		||||
        );
 | 
			
		||||
        this.updateConditionResults({id: id});
 | 
			
		||||
        this.updateCurrentCondition(latestTimestamp);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    initialize() {
 | 
			
		||||
@@ -336,14 +347,17 @@ export default class ConditionManager extends EventEmitter {
 | 
			
		||||
        let timestamp = {};
 | 
			
		||||
        timestamp[timeSystemKey] = normalizedDatum[timeSystemKey];
 | 
			
		||||
 | 
			
		||||
        this.updateConditionResults(normalizedDatum);
 | 
			
		||||
        this.updateCurrentCondition(timestamp);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    updateConditionResults(normalizedDatum) {
 | 
			
		||||
        //We want to stop when the first condition evaluates to true.
 | 
			
		||||
        this.conditions.some((condition) => {
 | 
			
		||||
            condition.updateResult(normalizedDatum);
 | 
			
		||||
 | 
			
		||||
            return condition.result === true;
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        this.updateCurrentCondition(timestamp);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    updateCurrentCondition(timestamp) {
 | 
			
		||||
 
 | 
			
		||||
@@ -86,6 +86,7 @@ export default class StyleRuleManager extends EventEmitter {
 | 
			
		||||
    updateObjectStyleConfig(styleConfiguration) {
 | 
			
		||||
        if (!styleConfiguration || !styleConfiguration.conditionSetIdentifier) {
 | 
			
		||||
            this.initialize(styleConfiguration || {});
 | 
			
		||||
            this.applyStaticStyle();
 | 
			
		||||
            this.destroy();
 | 
			
		||||
        } else {
 | 
			
		||||
            let isNewConditionSet = !this.conditionSetIdentifier
 | 
			
		||||
@@ -158,7 +159,6 @@ export default class StyleRuleManager extends EventEmitter {
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    destroy() {
 | 
			
		||||
        this.applyStaticStyle();
 | 
			
		||||
        if (this.stopProvidingTelemetry) {
 | 
			
		||||
            this.stopProvidingTelemetry();
 | 
			
		||||
            delete this.stopProvidingTelemetry;
 | 
			
		||||
 
 | 
			
		||||
@@ -31,7 +31,6 @@
 | 
			
		||||
            v-model="expanded"
 | 
			
		||||
            class="c-tree__item__view-control"
 | 
			
		||||
            :enabled="hasChildren"
 | 
			
		||||
            :propagate="false"
 | 
			
		||||
        />
 | 
			
		||||
        <div class="c-tree__item__label c-object-label">
 | 
			
		||||
            <div
 | 
			
		||||
 
 | 
			
		||||
@@ -22,6 +22,7 @@
 | 
			
		||||
 | 
			
		||||
import { createOpenMct, resetApplicationState } from "utils/testing";
 | 
			
		||||
import ConditionPlugin from "./plugin";
 | 
			
		||||
import stylesManager from '@/ui/inspector/styles/StylesManager';
 | 
			
		||||
import StylesView from "./components/inspector/StylesView.vue";
 | 
			
		||||
import Vue from 'vue';
 | 
			
		||||
import {getApplicableStylesForItem} from "./utils/styleUtils";
 | 
			
		||||
@@ -402,7 +403,8 @@ describe('the plugin', function () {
 | 
			
		||||
            component = new Vue({
 | 
			
		||||
                provide: {
 | 
			
		||||
                    openmct: openmct,
 | 
			
		||||
                    selection: selection
 | 
			
		||||
                    selection: selection,
 | 
			
		||||
                    stylesManager
 | 
			
		||||
                },
 | 
			
		||||
                el: viewContainer,
 | 
			
		||||
                components: {
 | 
			
		||||
 
 | 
			
		||||
@@ -64,9 +64,16 @@ define([
 | 
			
		||||
                            components: {
 | 
			
		||||
                                AlphanumericFormatView: AlphanumericFormatView.default
 | 
			
		||||
                            },
 | 
			
		||||
                            template: '<alphanumeric-format-view></alphanumeric-format-view>'
 | 
			
		||||
                            template: '<alphanumeric-format-view ref="alphanumericFormatView"></alphanumeric-format-view>'
 | 
			
		||||
                        });
 | 
			
		||||
                    },
 | 
			
		||||
                    getViewContext() {
 | 
			
		||||
                        if (component) {
 | 
			
		||||
                            return component.$refs.alphanumericFormatView.getViewContext();
 | 
			
		||||
                        } else {
 | 
			
		||||
                            return {};
 | 
			
		||||
                        }
 | 
			
		||||
                    },
 | 
			
		||||
                    destroy: function () {
 | 
			
		||||
                        component.$destroy();
 | 
			
		||||
                        component = undefined;
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										38
									
								
								src/plugins/displayLayout/CustomStringFormatter.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										38
									
								
								src/plugins/displayLayout/CustomStringFormatter.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,38 @@
 | 
			
		||||
import printj from 'printj';
 | 
			
		||||
 | 
			
		||||
export default class CustomStringFormatter {
 | 
			
		||||
    constructor(openmct, valueMetadata, itemFormat) {
 | 
			
		||||
        this.openmct = openmct;
 | 
			
		||||
 | 
			
		||||
        this.itemFormat = itemFormat;
 | 
			
		||||
        this.valueMetadata = valueMetadata;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    format(datum) {
 | 
			
		||||
        if (!this.itemFormat) {
 | 
			
		||||
            return;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        if (!this.itemFormat.startsWith('&')) {
 | 
			
		||||
            return printj.sprintf(this.itemFormat, datum[this.valueMetadata.key]);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        try {
 | 
			
		||||
            const key = this.itemFormat.slice(1);
 | 
			
		||||
            const customFormatter = this.openmct.telemetry.getFormatter(key);
 | 
			
		||||
            if (!customFormatter) {
 | 
			
		||||
                throw new Error('Custom Formatter not found');
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            return customFormatter.format(datum[this.valueMetadata.key]);
 | 
			
		||||
        } catch (e) {
 | 
			
		||||
            console.error(e);
 | 
			
		||||
 | 
			
		||||
            return datum[this.valueMetadata.key];
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    setFormat(itemFormat) {
 | 
			
		||||
        this.itemFormat = itemFormat;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										82
									
								
								src/plugins/displayLayout/CustomStringFormatterSpec.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										82
									
								
								src/plugins/displayLayout/CustomStringFormatterSpec.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,82 @@
 | 
			
		||||
import CustomStringFormatter from './CustomStringFormatter';
 | 
			
		||||
import { createOpenMct, resetApplicationState } from 'utils/testing';
 | 
			
		||||
 | 
			
		||||
const CUSTOM_FORMATS = [
 | 
			
		||||
    {
 | 
			
		||||
        key: 'sclk',
 | 
			
		||||
        format: (value) => 2 * value
 | 
			
		||||
    },
 | 
			
		||||
    {
 | 
			
		||||
        key: 'lts',
 | 
			
		||||
        format: (value) => 3 * value
 | 
			
		||||
    }
 | 
			
		||||
];
 | 
			
		||||
 | 
			
		||||
const valueMetadata = {
 | 
			
		||||
    key: "sin",
 | 
			
		||||
    name: "Sine",
 | 
			
		||||
    unit: "Hz",
 | 
			
		||||
    formatString: "%0.2f",
 | 
			
		||||
    hints: {
 | 
			
		||||
        range: 1,
 | 
			
		||||
        priority: 3
 | 
			
		||||
    },
 | 
			
		||||
    source: "sin"
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
const datum = {
 | 
			
		||||
    name: "1 Sine Wave Generator",
 | 
			
		||||
    utc: 1603930354000,
 | 
			
		||||
    yesterday: 1603843954000,
 | 
			
		||||
    sin: 0.587785209686822,
 | 
			
		||||
    cos: -0.8090170253297632
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
describe('CustomStringFormatter', function () {
 | 
			
		||||
    let element;
 | 
			
		||||
    let child;
 | 
			
		||||
    let openmct;
 | 
			
		||||
    let customStringFormatter;
 | 
			
		||||
 | 
			
		||||
    beforeEach((done) => {
 | 
			
		||||
        openmct = createOpenMct();
 | 
			
		||||
 | 
			
		||||
        element = document.createElement('div');
 | 
			
		||||
        child = document.createElement('div');
 | 
			
		||||
        element.appendChild(child);
 | 
			
		||||
        CUSTOM_FORMATS.forEach(openmct.telemetry.addFormat.bind({openmct}));
 | 
			
		||||
        openmct.on('start', done);
 | 
			
		||||
        openmct.startHeadless();
 | 
			
		||||
 | 
			
		||||
        spyOn(openmct.telemetry, 'getFormatter');
 | 
			
		||||
        openmct.telemetry.getFormatter.and.callFake((key) => CUSTOM_FORMATS.find(d => d.key === key));
 | 
			
		||||
 | 
			
		||||
        customStringFormatter = new CustomStringFormatter(openmct, valueMetadata);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    afterEach(() => {
 | 
			
		||||
        return resetApplicationState(openmct);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it('adds custom format sclk', () => {
 | 
			
		||||
        const format = openmct.telemetry.getFormatter('sclk');
 | 
			
		||||
        expect(format.key).toEqual('sclk');
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it('adds custom format lts', () => {
 | 
			
		||||
        const format = openmct.telemetry.getFormatter('lts');
 | 
			
		||||
        expect(format.key).toEqual('lts');
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it('returns correct value for custom format sclk', () => {
 | 
			
		||||
        customStringFormatter.setFormat('&sclk');
 | 
			
		||||
        const value = customStringFormatter.format(datum, valueMetadata);
 | 
			
		||||
        expect(datum.sin * 2).toEqual(value);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it('returns correct value for custom format lts', () => {
 | 
			
		||||
        customStringFormatter.setFormat('<s');
 | 
			
		||||
        const value = customStringFormatter.format(datum, valueMetadata);
 | 
			
		||||
        expect(datum.sin * 3).toEqual(value);
 | 
			
		||||
    });
 | 
			
		||||
});
 | 
			
		||||
							
								
								
									
										34
									
								
								src/plugins/displayLayout/actions/CopyToClipboardAction.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										34
									
								
								src/plugins/displayLayout/actions/CopyToClipboardAction.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,34 @@
 | 
			
		||||
import clipboard from '@/utils/clipboard';
 | 
			
		||||
 | 
			
		||||
export default class CopyToClipboardAction {
 | 
			
		||||
    constructor(openmct) {
 | 
			
		||||
        this.openmct = openmct;
 | 
			
		||||
 | 
			
		||||
        this.cssClass = 'icon-duplicate';
 | 
			
		||||
        this.description = 'Copy value to clipboard';
 | 
			
		||||
        this.group = "action";
 | 
			
		||||
        this.key = 'copyToClipboard';
 | 
			
		||||
        this.name = 'Copy to Clipboard';
 | 
			
		||||
        this.priority = 1;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    invoke(objectPath, view = {}) {
 | 
			
		||||
        const viewContext = view.getViewContext && view.getViewContext();
 | 
			
		||||
        const formattedValue = viewContext.formattedValueForCopy();
 | 
			
		||||
 | 
			
		||||
        clipboard.updateClipboard(formattedValue)
 | 
			
		||||
            .then(() => {
 | 
			
		||||
                this.openmct.notifications.info(`Success : copied '${formattedValue}' to clipboard `);
 | 
			
		||||
            })
 | 
			
		||||
            .catch(() => {
 | 
			
		||||
                this.openmct.notifications.error(`Failed : to copy '${formattedValue}' to clipboard `);
 | 
			
		||||
            });
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    appliesTo(objectPath, view = {}) {
 | 
			
		||||
        let viewContext = view.getViewContext && view.getViewContext();
 | 
			
		||||
 | 
			
		||||
        return viewContext && viewContext.formattedValueForCopy
 | 
			
		||||
            && typeof viewContext.formattedValueForCopy === 'function';
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -142,14 +142,18 @@ export default {
 | 
			
		||||
            this.domainObject = domainObject;
 | 
			
		||||
            this.currentObjectPath = [this.domainObject].concat(this.objectPath.slice());
 | 
			
		||||
            this.$nextTick(() => {
 | 
			
		||||
                let childContext = this.$refs.objectFrame.getSelectionContext();
 | 
			
		||||
                childContext.item = domainObject;
 | 
			
		||||
                childContext.layoutItem = this.item;
 | 
			
		||||
                childContext.index = this.index;
 | 
			
		||||
                this.context = childContext;
 | 
			
		||||
                this.removeSelectable = this.openmct.selection.selectable(
 | 
			
		||||
                    this.$el, this.context, this.immediatelySelect || this.initSelect);
 | 
			
		||||
                delete this.immediatelySelect;
 | 
			
		||||
                let reference = this.$refs.objectFrame;
 | 
			
		||||
 | 
			
		||||
                if (reference) {
 | 
			
		||||
                    let childContext = this.$refs.objectFrame.getSelectionContext();
 | 
			
		||||
                    childContext.item = domainObject;
 | 
			
		||||
                    childContext.layoutItem = this.item;
 | 
			
		||||
                    childContext.index = this.index;
 | 
			
		||||
                    this.context = childContext;
 | 
			
		||||
                    this.removeSelectable = this.openmct.selection.selectable(
 | 
			
		||||
                        this.$el, this.context, this.immediatelySelect || this.initSelect);
 | 
			
		||||
                    delete this.immediatelySelect;
 | 
			
		||||
                }
 | 
			
		||||
            });
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 
 | 
			
		||||
@@ -30,18 +30,15 @@
 | 
			
		||||
>
 | 
			
		||||
    <div
 | 
			
		||||
        v-if="domainObject"
 | 
			
		||||
        class="u-style-receiver c-telemetry-view"
 | 
			
		||||
        :class="{
 | 
			
		||||
            styleClass,
 | 
			
		||||
            'is-missing': domainObject.status === 'missing'
 | 
			
		||||
        }"
 | 
			
		||||
        class="c-telemetry-view u-style-receiver"
 | 
			
		||||
        :class="[statusClass]"
 | 
			
		||||
        :style="styleObject"
 | 
			
		||||
        :data-font-size="item.fontSize"
 | 
			
		||||
        :data-font="item.font"
 | 
			
		||||
        @contextmenu.prevent="showContextMenu"
 | 
			
		||||
    >
 | 
			
		||||
        <div class="is-missing__indicator"
 | 
			
		||||
             title="This item is missing"
 | 
			
		||||
        <div class="is-status__indicator"
 | 
			
		||||
             :title="`This item is ${status}`"
 | 
			
		||||
        ></div>
 | 
			
		||||
        <div
 | 
			
		||||
            v-if="showLabel"
 | 
			
		||||
@@ -74,12 +71,12 @@
 | 
			
		||||
 | 
			
		||||
<script>
 | 
			
		||||
import LayoutFrame from './LayoutFrame.vue';
 | 
			
		||||
import printj from 'printj';
 | 
			
		||||
import conditionalStylesMixin from "../mixins/objectStyles-mixin";
 | 
			
		||||
import { getDefaultNotebook } from '@/plugins/notebook/utils/notebook-storage.js';
 | 
			
		||||
 | 
			
		||||
const DEFAULT_TELEMETRY_DIMENSIONS = [10, 5];
 | 
			
		||||
const DEFAULT_POSITION = [1, 1];
 | 
			
		||||
const CONTEXT_MENU_ACTIONS = ['viewHistoricalData'];
 | 
			
		||||
const CONTEXT_MENU_ACTIONS = ['copyToClipboard', 'copyToNotebook', 'viewHistoricalData'];
 | 
			
		||||
 | 
			
		||||
export default {
 | 
			
		||||
    makeDefinition(openmct, gridSize, domainObject, position) {
 | 
			
		||||
@@ -129,13 +126,18 @@ export default {
 | 
			
		||||
    },
 | 
			
		||||
    data() {
 | 
			
		||||
        return {
 | 
			
		||||
            currentObjectPath: undefined,
 | 
			
		||||
            datum: undefined,
 | 
			
		||||
            formats: undefined,
 | 
			
		||||
            domainObject: undefined,
 | 
			
		||||
            currentObjectPath: undefined
 | 
			
		||||
            formats: undefined,
 | 
			
		||||
            viewKey: `alphanumeric-format-${Math.random()}`,
 | 
			
		||||
            status: ''
 | 
			
		||||
        };
 | 
			
		||||
    },
 | 
			
		||||
    computed: {
 | 
			
		||||
        statusClass() {
 | 
			
		||||
            return (this.status) ? `is-status--${this.status}` : '';
 | 
			
		||||
        },
 | 
			
		||||
        showLabel() {
 | 
			
		||||
            let displayMode = this.item.displayMode;
 | 
			
		||||
 | 
			
		||||
@@ -169,7 +171,11 @@ export default {
 | 
			
		||||
        valueMetadata() {
 | 
			
		||||
            return this.datum && this.metadata.value(this.item.value);
 | 
			
		||||
        },
 | 
			
		||||
        valueFormatter() {
 | 
			
		||||
        formatter() {
 | 
			
		||||
            if (this.item.format) {
 | 
			
		||||
                return this.customStringformatter;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            return this.formats[this.item.value];
 | 
			
		||||
        },
 | 
			
		||||
        telemetryValue() {
 | 
			
		||||
@@ -177,11 +183,7 @@ export default {
 | 
			
		||||
                return;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            if (this.item.format) {
 | 
			
		||||
                return printj.sprintf(this.item.format, this.datum[this.valueMetadata.key]);
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            return this.valueFormatter && this.valueFormatter.format(this.datum);
 | 
			
		||||
            return this.formatter && this.formatter.format(this.datum);
 | 
			
		||||
        },
 | 
			
		||||
        telemetryClass() {
 | 
			
		||||
            if (!this.datum) {
 | 
			
		||||
@@ -213,9 +215,13 @@ export default {
 | 
			
		||||
        this.openmct.objects.get(this.item.identifier)
 | 
			
		||||
            .then(this.setObject);
 | 
			
		||||
        this.openmct.time.on("bounds", this.refreshData);
 | 
			
		||||
 | 
			
		||||
        this.status = this.openmct.status.get(this.item.identifier);
 | 
			
		||||
        this.removeStatusListener = this.openmct.status.observe(this.item.identifier, this.setStatus);
 | 
			
		||||
    },
 | 
			
		||||
    destroyed() {
 | 
			
		||||
        this.removeSubscription();
 | 
			
		||||
        this.removeStatusListener();
 | 
			
		||||
 | 
			
		||||
        if (this.removeSelectable) {
 | 
			
		||||
            this.removeSelectable();
 | 
			
		||||
@@ -224,6 +230,13 @@ export default {
 | 
			
		||||
        this.openmct.time.off("bounds", this.refreshData);
 | 
			
		||||
    },
 | 
			
		||||
    methods: {
 | 
			
		||||
        formattedValueForCopy() {
 | 
			
		||||
            const timeFormatterKey = this.openmct.time.timeSystem().key;
 | 
			
		||||
            const timeFormatter = this.formats[timeFormatterKey];
 | 
			
		||||
            const unit = this.unit ? ` ${this.unit}` : '';
 | 
			
		||||
 | 
			
		||||
            return `At ${timeFormatter.format(this.datum)} ${this.domainObject.name} had a value of ${this.telemetryValue}${unit}`;
 | 
			
		||||
        },
 | 
			
		||||
        requestHistoricalData() {
 | 
			
		||||
            let bounds = this.openmct.time.bounds();
 | 
			
		||||
            let options = {
 | 
			
		||||
@@ -261,12 +274,26 @@ export default {
 | 
			
		||||
                this.requestHistoricalData(this.domainObject);
 | 
			
		||||
            }
 | 
			
		||||
        },
 | 
			
		||||
        getView() {
 | 
			
		||||
            return {
 | 
			
		||||
                getViewContext: () => {
 | 
			
		||||
                    return {
 | 
			
		||||
                        viewHistoricalData: true,
 | 
			
		||||
                        formattedValueForCopy: this.formattedValueForCopy
 | 
			
		||||
                    };
 | 
			
		||||
                }
 | 
			
		||||
            };
 | 
			
		||||
        },
 | 
			
		||||
        setObject(domainObject) {
 | 
			
		||||
            this.domainObject = domainObject;
 | 
			
		||||
            this.keyString = this.openmct.objects.makeKeyString(domainObject.identifier);
 | 
			
		||||
            this.metadata = this.openmct.telemetry.getMetadata(this.domainObject);
 | 
			
		||||
            this.limitEvaluator = this.openmct.telemetry.limitEvaluator(this.domainObject);
 | 
			
		||||
            this.formats = this.openmct.telemetry.getFormatMap(this.metadata);
 | 
			
		||||
 | 
			
		||||
            const valueMetadata = this.metadata.value(this.item.value);
 | 
			
		||||
            this.customStringformatter = this.openmct.telemetry.customStringFormatter(valueMetadata, this.item.format);
 | 
			
		||||
 | 
			
		||||
            this.requestHistoricalData();
 | 
			
		||||
            this.subscribeToObject();
 | 
			
		||||
 | 
			
		||||
@@ -286,10 +313,37 @@ export default {
 | 
			
		||||
            delete this.immediatelySelect;
 | 
			
		||||
        },
 | 
			
		||||
        updateTelemetryFormat(format) {
 | 
			
		||||
            this.customStringformatter.setFormat(format);
 | 
			
		||||
 | 
			
		||||
            this.$emit('formatChanged', this.item, format);
 | 
			
		||||
        },
 | 
			
		||||
        showContextMenu(event) {
 | 
			
		||||
            this.openmct.contextMenu._showContextMenuForObjectPath(this.currentObjectPath, event.x, event.y, CONTEXT_MENU_ACTIONS);
 | 
			
		||||
        async getContextMenuActions() {
 | 
			
		||||
            const defaultNotebook = getDefaultNotebook();
 | 
			
		||||
            const domainObject = defaultNotebook && await this.openmct.objects.get(defaultNotebook.notebookMeta.identifier);
 | 
			
		||||
            const actionCollection = this.openmct.actions.get(this.currentObjectPath, this.getView());
 | 
			
		||||
            const actionsObject = actionCollection.getActionsObject();
 | 
			
		||||
 | 
			
		||||
            let copyToNotebookAction = actionsObject.copyToNotebook;
 | 
			
		||||
 | 
			
		||||
            if (defaultNotebook) {
 | 
			
		||||
                const defaultPath = domainObject && `${domainObject.name} - ${defaultNotebook.section.name} - ${defaultNotebook.page.name}`;
 | 
			
		||||
                copyToNotebookAction.name = `Copy to Notebook ${defaultPath}`;
 | 
			
		||||
            } else {
 | 
			
		||||
                actionsObject.copyToNotebook = undefined;
 | 
			
		||||
                delete actionsObject.copyToNotebook;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            return CONTEXT_MENU_ACTIONS.map(actionKey => {
 | 
			
		||||
                return actionsObject[actionKey];
 | 
			
		||||
            }).filter(action => action !== undefined);
 | 
			
		||||
        },
 | 
			
		||||
        async showContextMenu(event) {
 | 
			
		||||
            const contextMenuActions = await this.getContextMenuActions();
 | 
			
		||||
 | 
			
		||||
            this.openmct.menus.showMenu(event.x, event.y, contextMenuActions);
 | 
			
		||||
        },
 | 
			
		||||
        setStatus(status) {
 | 
			
		||||
            this.status = status;
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
};
 | 
			
		||||
 
 | 
			
		||||
@@ -7,7 +7,6 @@
 | 
			
		||||
        flex: 1 1 auto;
 | 
			
		||||
        display: flex;
 | 
			
		||||
        flex-direction: row;
 | 
			
		||||
       // justify-content: center;
 | 
			
		||||
        align-items: center;
 | 
			
		||||
        overflow: hidden;
 | 
			
		||||
        padding: $interiorMargin;
 | 
			
		||||
@@ -27,14 +26,13 @@
 | 
			
		||||
        border: 1px solid transparent;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @include isMissing($absPos: true);
 | 
			
		||||
 | 
			
		||||
    .is-missing__indicator {
 | 
			
		||||
    .is-status__indicator {
 | 
			
		||||
        position: absolute;
 | 
			
		||||
        top: 0;
 | 
			
		||||
        left: 0;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    &.is-missing {
 | 
			
		||||
    &[class*='is-status'] {
 | 
			
		||||
        border: $borderMissing;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -26,9 +26,12 @@ import objectUtils from 'objectUtils';
 | 
			
		||||
import DisplayLayoutType from './DisplayLayoutType.js';
 | 
			
		||||
import DisplayLayoutToolbar from './DisplayLayoutToolbar.js';
 | 
			
		||||
import AlphaNumericFormatViewProvider from './AlphanumericFormatViewProvider.js';
 | 
			
		||||
import CopyToClipboardAction from './actions/CopyToClipboardAction';
 | 
			
		||||
 | 
			
		||||
export default function DisplayLayoutPlugin(options) {
 | 
			
		||||
    return function (openmct) {
 | 
			
		||||
        openmct.actions.register(new CopyToClipboardAction(openmct));
 | 
			
		||||
 | 
			
		||||
        openmct.objectViews.addProvider({
 | 
			
		||||
            key: 'layout.view',
 | 
			
		||||
            canView: function (domainObject) {
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										159
									
								
								src/plugins/duplicate/DuplicateAction.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										159
									
								
								src/plugins/duplicate/DuplicateAction.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,159 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
import DuplicateTask from './DuplicateTask';
 | 
			
		||||
 | 
			
		||||
export default class DuplicateAction {
 | 
			
		||||
    constructor(openmct) {
 | 
			
		||||
        this.name = 'Duplicate';
 | 
			
		||||
        this.key = 'duplicate';
 | 
			
		||||
        this.description = 'Duplicate this object.';
 | 
			
		||||
        this.cssClass = "icon-duplicate";
 | 
			
		||||
        this.group = "action";
 | 
			
		||||
        this.priority = 7;
 | 
			
		||||
 | 
			
		||||
        this.openmct = openmct;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    async invoke(objectPath) {
 | 
			
		||||
        let duplicationTask = new DuplicateTask(this.openmct);
 | 
			
		||||
        let originalObject = objectPath[0];
 | 
			
		||||
        let parent = objectPath[1];
 | 
			
		||||
        let userInput = await this.getUserInput(originalObject, parent);
 | 
			
		||||
        let newParent = userInput.location;
 | 
			
		||||
        let inNavigationPath = this.inNavigationPath(originalObject);
 | 
			
		||||
 | 
			
		||||
        // legacy check
 | 
			
		||||
        if (this.isLegacyDomainObject(newParent)) {
 | 
			
		||||
            newParent = await this.convertFromLegacy(newParent);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        // if editing, save
 | 
			
		||||
        if (inNavigationPath && this.openmct.editor.isEditing()) {
 | 
			
		||||
            this.openmct.editor.save();
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        // duplicate
 | 
			
		||||
        let newObject = await duplicationTask.duplicate(originalObject, newParent);
 | 
			
		||||
        this.updateNameCheck(newObject, userInput.name);
 | 
			
		||||
 | 
			
		||||
        return;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    async getUserInput(originalObject, parent) {
 | 
			
		||||
        let dialogService = this.openmct.$injector.get('dialogService');
 | 
			
		||||
        let dialogForm = this.getDialogForm(originalObject, parent);
 | 
			
		||||
        let formState = {
 | 
			
		||||
            name: originalObject.name
 | 
			
		||||
        };
 | 
			
		||||
        let userInput = await dialogService.getUserInput(dialogForm, formState);
 | 
			
		||||
 | 
			
		||||
        return userInput;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    updateNameCheck(object, name) {
 | 
			
		||||
        if (object.name !== name) {
 | 
			
		||||
            this.openmct.objects.mutate(object, 'name', name);
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    inNavigationPath(object) {
 | 
			
		||||
        return this.openmct.router.path
 | 
			
		||||
            .some(objectInPath => this.openmct.objects.areIdsEqual(objectInPath.identifier, object.identifier));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    getDialogForm(object, parent) {
 | 
			
		||||
        return {
 | 
			
		||||
            name: "Duplicate Item",
 | 
			
		||||
            sections: [
 | 
			
		||||
                {
 | 
			
		||||
                    rows: [
 | 
			
		||||
                        {
 | 
			
		||||
                            key: "name",
 | 
			
		||||
                            control: "textfield",
 | 
			
		||||
                            name: "Name",
 | 
			
		||||
                            pattern: "\\S+",
 | 
			
		||||
                            required: true,
 | 
			
		||||
                            cssClass: "l-input-lg"
 | 
			
		||||
                        },
 | 
			
		||||
                        {
 | 
			
		||||
                            name: "location",
 | 
			
		||||
                            cssClass: "grows",
 | 
			
		||||
                            control: "locator",
 | 
			
		||||
                            validate: this.validate(object, parent),
 | 
			
		||||
                            key: 'location'
 | 
			
		||||
                        }
 | 
			
		||||
                    ]
 | 
			
		||||
                }
 | 
			
		||||
            ]
 | 
			
		||||
        };
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    validate(object, currentParent) {
 | 
			
		||||
        return (parentCandidate) => {
 | 
			
		||||
            let currentParentKeystring = this.openmct.objects.makeKeyString(currentParent.identifier);
 | 
			
		||||
            let parentCandidateKeystring = this.openmct.objects.makeKeyString(parentCandidate.getId());
 | 
			
		||||
            let objectKeystring = this.openmct.objects.makeKeyString(object.identifier);
 | 
			
		||||
 | 
			
		||||
            if (!parentCandidate || !currentParentKeystring) {
 | 
			
		||||
                return false;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            if (parentCandidateKeystring === objectKeystring) {
 | 
			
		||||
                return false;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            return this.openmct.composition.checkPolicy(
 | 
			
		||||
                parentCandidate.useCapability('adapter'),
 | 
			
		||||
                object
 | 
			
		||||
            );
 | 
			
		||||
        };
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    isLegacyDomainObject(domainObject) {
 | 
			
		||||
        return domainObject.getCapability !== undefined;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    async convertFromLegacy(legacyDomainObject) {
 | 
			
		||||
        let objectContext = legacyDomainObject.getCapability('context');
 | 
			
		||||
        let domainObject = await this.openmct.objects.get(objectContext.domainObject.id);
 | 
			
		||||
 | 
			
		||||
        return domainObject;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    appliesTo(objectPath) {
 | 
			
		||||
        let parent = objectPath[1];
 | 
			
		||||
        let parentType = parent && this.openmct.types.get(parent.type);
 | 
			
		||||
        let child = objectPath[0];
 | 
			
		||||
        let childType = child && this.openmct.types.get(child.type);
 | 
			
		||||
        let locked = child.locked ? child.locked : parent && parent.locked;
 | 
			
		||||
 | 
			
		||||
        if (locked) {
 | 
			
		||||
            return false;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        return childType
 | 
			
		||||
            && childType.definition.creatable
 | 
			
		||||
            && parentType
 | 
			
		||||
            && parentType.definition.creatable
 | 
			
		||||
            && Array.isArray(parent.composition);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										273
									
								
								src/plugins/duplicate/DuplicateTask.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										273
									
								
								src/plugins/duplicate/DuplicateTask.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,273 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
import uuid from 'uuid';
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * This class encapsulates the process of  duplicating/copying a domain object
 | 
			
		||||
 * and all of its children.
 | 
			
		||||
 *
 | 
			
		||||
 * @param {DomainObject} domainObject The object to duplicate
 | 
			
		||||
 * @param {DomainObject} parent The new location of the cloned object tree
 | 
			
		||||
 * @param {src/plugins/duplicate.DuplicateService~filter} filter
 | 
			
		||||
 *        a function used to filter out objects from
 | 
			
		||||
 *        the cloning process
 | 
			
		||||
 * @constructor
 | 
			
		||||
 */
 | 
			
		||||
export default class DuplicateTask {
 | 
			
		||||
 | 
			
		||||
    constructor(openmct) {
 | 
			
		||||
        this.domainObject = undefined;
 | 
			
		||||
        this.parent = undefined;
 | 
			
		||||
        this.firstClone = undefined;
 | 
			
		||||
        this.filter = undefined;
 | 
			
		||||
        this.persisted = 0;
 | 
			
		||||
        this.clones = [];
 | 
			
		||||
        this.idMap = {};
 | 
			
		||||
 | 
			
		||||
        this.openmct = openmct;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Execute the duplicate/copy task with the objects provided.
 | 
			
		||||
     * @returns {promise} Which will resolve with a clone of the object
 | 
			
		||||
     * once complete.
 | 
			
		||||
     */
 | 
			
		||||
    async duplicate(domainObject, parent, filter) {
 | 
			
		||||
        this.domainObject = domainObject;
 | 
			
		||||
        this.parent = parent;
 | 
			
		||||
        this.namespace = parent.identifier.namespace;
 | 
			
		||||
        this.filter = filter || this.isCreatable;
 | 
			
		||||
 | 
			
		||||
        await this.buildDuplicationPlan();
 | 
			
		||||
        await this.persistObjects();
 | 
			
		||||
        await this.addClonesToParent();
 | 
			
		||||
 | 
			
		||||
        return this.firstClone;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Will build a graph of an object and all of its child objects in
 | 
			
		||||
     * memory
 | 
			
		||||
     * @private
 | 
			
		||||
     * @param domainObject The original object to be copied
 | 
			
		||||
     * @param parent The parent of the original object to be copied
 | 
			
		||||
     * @returns {Promise} resolved with an array of clones of the models
 | 
			
		||||
     * of the object tree being copied. Duplicating is done in a bottom-up
 | 
			
		||||
     * fashion, so that the last member in the array is a clone of the model
 | 
			
		||||
     * object being copied. The clones are all full composed with
 | 
			
		||||
     * references to their own children.
 | 
			
		||||
     */
 | 
			
		||||
    async buildDuplicationPlan() {
 | 
			
		||||
        let domainObjectClone = await this.duplicateObject(this.domainObject);
 | 
			
		||||
 | 
			
		||||
        if (domainObjectClone !== this.domainObject) {
 | 
			
		||||
            domainObjectClone.location = this.getKeyString(this.parent);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        this.firstClone = domainObjectClone;
 | 
			
		||||
 | 
			
		||||
        return;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Will persist a list of {@link objectClones}. It will persist all
 | 
			
		||||
     * simultaneously, irrespective of order in the list. This may
 | 
			
		||||
     * result in automatic request batching by the browser.
 | 
			
		||||
     */
 | 
			
		||||
    async persistObjects() {
 | 
			
		||||
        let initialCount = this.clones.length;
 | 
			
		||||
        let dialog = this.openmct.overlays.progressDialog({
 | 
			
		||||
            progressPerc: 0,
 | 
			
		||||
            message: `Duplicating ${initialCount} objects.`,
 | 
			
		||||
            iconClass: 'info',
 | 
			
		||||
            title: 'Duplicating'
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        let clonesDone = Promise.all(this.clones.map((clone) => {
 | 
			
		||||
            let percentPersisted = Math.ceil(100 * (++this.persisted / initialCount));
 | 
			
		||||
            let message = `Duplicating ${initialCount - this.persisted} objects.`;
 | 
			
		||||
 | 
			
		||||
            dialog.updateProgress(percentPersisted, message);
 | 
			
		||||
 | 
			
		||||
            return this.openmct.objects.save(clone);
 | 
			
		||||
        }));
 | 
			
		||||
 | 
			
		||||
        await clonesDone;
 | 
			
		||||
 | 
			
		||||
        dialog.dismiss();
 | 
			
		||||
        this.openmct.notifications.info(`Duplicated ${this.persisted} objects.`);
 | 
			
		||||
 | 
			
		||||
        return;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Will add a list of clones to the specified parent's composition
 | 
			
		||||
     */
 | 
			
		||||
    async addClonesToParent() {
 | 
			
		||||
        let parentComposition = this.openmct.composition.get(this.parent);
 | 
			
		||||
        await parentComposition.load();
 | 
			
		||||
        parentComposition.add(this.firstClone);
 | 
			
		||||
 | 
			
		||||
        return;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * A recursive function that will perform a bottom-up duplicate of
 | 
			
		||||
     * the object tree with originalObject at the root. Recurses to
 | 
			
		||||
     * the farthest leaf, then works its way back up again,
 | 
			
		||||
     * cloning objects, and composing them with their child clones
 | 
			
		||||
     * as it goes
 | 
			
		||||
     * @private
 | 
			
		||||
     * @returns {DomainObject} If the type of the original object allows for
 | 
			
		||||
     * duplication, then a duplicate of the object, otherwise the object
 | 
			
		||||
     * itself (to allow linking to non duplicatable objects).
 | 
			
		||||
     */
 | 
			
		||||
    async duplicateObject(originalObject) {
 | 
			
		||||
        // Check if the creatable (or other passed in filter).
 | 
			
		||||
        if (this.filter(originalObject)) {
 | 
			
		||||
            let clone = this.cloneObjectModel(originalObject);
 | 
			
		||||
            let composeesCollection = this.openmct.composition.get(originalObject);
 | 
			
		||||
            let composees;
 | 
			
		||||
 | 
			
		||||
            if (composeesCollection) {
 | 
			
		||||
                composees = await composeesCollection.load();
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            return this.duplicateComposees(clone, composees);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        // Not creatable, creating a link, no need to iterate children
 | 
			
		||||
        return originalObject;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Given an array of objects composed by a parent, clone them, then
 | 
			
		||||
     * add them to the parent.
 | 
			
		||||
     * @private
 | 
			
		||||
     * @returns {*}
 | 
			
		||||
     */
 | 
			
		||||
    async duplicateComposees(clonedParent, composees = []) {
 | 
			
		||||
        let idMappings = [];
 | 
			
		||||
        let allComposeesDuplicated = composees.reduce(async (previousPromise, nextComposee) => {
 | 
			
		||||
            await previousPromise;
 | 
			
		||||
 | 
			
		||||
            let clonedComposee = await this.duplicateObject(nextComposee);
 | 
			
		||||
 | 
			
		||||
            if (clonedComposee) {
 | 
			
		||||
                idMappings.push({
 | 
			
		||||
                    newId: clonedComposee.identifier,
 | 
			
		||||
                    oldId: nextComposee.identifier
 | 
			
		||||
                });
 | 
			
		||||
                this.composeChild(clonedComposee, clonedParent, clonedComposee !== nextComposee);
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            return;
 | 
			
		||||
        }, Promise.resolve());
 | 
			
		||||
 | 
			
		||||
        await allComposeesDuplicated;
 | 
			
		||||
 | 
			
		||||
        clonedParent = this.rewriteIdentifiers(clonedParent, idMappings);
 | 
			
		||||
        this.clones.push(clonedParent);
 | 
			
		||||
 | 
			
		||||
        return clonedParent;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Update identifiers in a cloned object model (or part of
 | 
			
		||||
     * a cloned object model) to reflect new identifiers after
 | 
			
		||||
     * duplicating.
 | 
			
		||||
     * @private
 | 
			
		||||
     */
 | 
			
		||||
    rewriteIdentifiers(clonedParent, childIdMappings) {
 | 
			
		||||
        for (let { newId, oldId } of childIdMappings) {
 | 
			
		||||
            let newIdKeyString = this.openmct.objects.makeKeyString(newId);
 | 
			
		||||
            let oldIdKeyString = this.openmct.objects.makeKeyString(oldId);
 | 
			
		||||
 | 
			
		||||
            // regex replace keystrings
 | 
			
		||||
            clonedParent = JSON.stringify(clonedParent).replace(new RegExp(oldIdKeyString, 'g'), newIdKeyString);
 | 
			
		||||
 | 
			
		||||
            // parse reviver to replace identifiers
 | 
			
		||||
            clonedParent = JSON.parse(clonedParent, (key, value) => {
 | 
			
		||||
                if (Object.prototype.hasOwnProperty.call(value, 'key')
 | 
			
		||||
                    && Object.prototype.hasOwnProperty.call(value, 'namespace')
 | 
			
		||||
                    && value.key === oldId.key
 | 
			
		||||
                    && value.namespace === oldId.namespace) {
 | 
			
		||||
                    return newId;
 | 
			
		||||
                } else {
 | 
			
		||||
                    return value;
 | 
			
		||||
                }
 | 
			
		||||
            });
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        return clonedParent;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    composeChild(child, parent, setLocation) {
 | 
			
		||||
        parent.composition.push(child.identifier);
 | 
			
		||||
 | 
			
		||||
        //If a location is not specified, set it.
 | 
			
		||||
        if (setLocation && child.location === undefined) {
 | 
			
		||||
            let parentKeyString = this.getKeyString(parent);
 | 
			
		||||
            child.location = parentKeyString;
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    getTypeDefinition(domainObject, definition) {
 | 
			
		||||
        let typeDefinitions = this.openmct.types.get(domainObject.type).definition;
 | 
			
		||||
 | 
			
		||||
        return typeDefinitions[definition] || false;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    cloneObjectModel(domainObject) {
 | 
			
		||||
        let clone = JSON.parse(JSON.stringify(domainObject));
 | 
			
		||||
        let identifier = {
 | 
			
		||||
            key: uuid(),
 | 
			
		||||
            namespace: this.namespace // set to NEW parent's namespace
 | 
			
		||||
        };
 | 
			
		||||
 | 
			
		||||
        if (clone.modified || clone.persisted || clone.location) {
 | 
			
		||||
            clone.modified = undefined;
 | 
			
		||||
            clone.persisted = undefined;
 | 
			
		||||
            clone.location = undefined;
 | 
			
		||||
            delete clone.modified;
 | 
			
		||||
            delete clone.persisted;
 | 
			
		||||
            delete clone.location;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        if (clone.composition) {
 | 
			
		||||
            clone.composition = [];
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        clone.identifier = identifier;
 | 
			
		||||
 | 
			
		||||
        return clone;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    getKeyString(domainObject) {
 | 
			
		||||
        return this.openmct.objects.makeKeyString(domainObject.identifier);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    isCreatable(domainObject) {
 | 
			
		||||
        return this.getTypeDefinition(domainObject, 'creatable');
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										28
									
								
								src/plugins/duplicate/plugin.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										28
									
								
								src/plugins/duplicate/plugin.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,28 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2019, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
import DuplicateAction from "./DuplicateAction";
 | 
			
		||||
 | 
			
		||||
export default function () {
 | 
			
		||||
    return function (openmct) {
 | 
			
		||||
        openmct.actions.register(new DuplicateAction(openmct));
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										157
									
								
								src/plugins/duplicate/pluginSpec.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										157
									
								
								src/plugins/duplicate/pluginSpec.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,157 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
import DuplicateActionPlugin from './plugin.js';
 | 
			
		||||
import DuplicateAction from './DuplicateAction.js';
 | 
			
		||||
import DuplicateTask from './DuplicateTask.js';
 | 
			
		||||
import {
 | 
			
		||||
    createOpenMct,
 | 
			
		||||
    resetApplicationState,
 | 
			
		||||
    getMockObjects
 | 
			
		||||
} from 'utils/testing';
 | 
			
		||||
 | 
			
		||||
describe("The Duplicate Action plugin", () => {
 | 
			
		||||
 | 
			
		||||
    let openmct;
 | 
			
		||||
    let duplicateTask;
 | 
			
		||||
    let childObject;
 | 
			
		||||
    let parentObject;
 | 
			
		||||
    let anotherParentObject;
 | 
			
		||||
 | 
			
		||||
    // this setups up the app
 | 
			
		||||
    beforeEach((done) => {
 | 
			
		||||
        openmct = createOpenMct();
 | 
			
		||||
 | 
			
		||||
        childObject = getMockObjects({
 | 
			
		||||
            objectKeyStrings: ['folder'],
 | 
			
		||||
            overwrite: {
 | 
			
		||||
                folder: {
 | 
			
		||||
                    name: "Child Folder",
 | 
			
		||||
                    identifier: {
 | 
			
		||||
                        namespace: "",
 | 
			
		||||
                        key: "child-folder-object"
 | 
			
		||||
                    }
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }).folder;
 | 
			
		||||
        parentObject = getMockObjects({
 | 
			
		||||
            objectKeyStrings: ['folder'],
 | 
			
		||||
            overwrite: {
 | 
			
		||||
                folder: {
 | 
			
		||||
                    name: "Parent Folder",
 | 
			
		||||
                    composition: [childObject.identifier]
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }).folder;
 | 
			
		||||
        anotherParentObject = getMockObjects({
 | 
			
		||||
            objectKeyStrings: ['folder'],
 | 
			
		||||
            overwrite: {
 | 
			
		||||
                folder: {
 | 
			
		||||
                    name: "Another Parent Folder"
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }).folder;
 | 
			
		||||
 | 
			
		||||
        let objectGet = openmct.objects.get.bind(openmct.objects);
 | 
			
		||||
        spyOn(openmct.objects, 'get').and.callFake((identifier) => {
 | 
			
		||||
            let obj = [childObject, parentObject, anotherParentObject].find((ob) => ob.identifier.key === identifier.key);
 | 
			
		||||
 | 
			
		||||
            if (!obj) {
 | 
			
		||||
                // not one of the mocked objs, callthrough basically
 | 
			
		||||
                return objectGet(identifier);
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            return Promise.resolve(obj);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        spyOn(openmct.composition, 'get').and.callFake((domainObject) => {
 | 
			
		||||
            return {
 | 
			
		||||
                load: async () => {
 | 
			
		||||
                    let obj = [childObject, parentObject, anotherParentObject].find((ob) => ob.identifier.key === domainObject.identifier.key);
 | 
			
		||||
                    let children = [];
 | 
			
		||||
 | 
			
		||||
                    if (obj) {
 | 
			
		||||
                        for (let i = 0; i < obj.composition.length; i++) {
 | 
			
		||||
                            children.push(await openmct.objects.get(obj.composition[i]));
 | 
			
		||||
                        }
 | 
			
		||||
                    }
 | 
			
		||||
 | 
			
		||||
                    return Promise.resolve(children);
 | 
			
		||||
                },
 | 
			
		||||
                add: (child) => {
 | 
			
		||||
                    domainObject.composition.push(child.identifier);
 | 
			
		||||
                }
 | 
			
		||||
            };
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        // already installed by default, but never hurts, just adds to context menu
 | 
			
		||||
        openmct.install(DuplicateActionPlugin());
 | 
			
		||||
 | 
			
		||||
        openmct.on('start', done);
 | 
			
		||||
        openmct.startHeadless();
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    afterEach(() => {
 | 
			
		||||
        resetApplicationState(openmct);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it("should be defined", () => {
 | 
			
		||||
        expect(DuplicateActionPlugin).toBeDefined();
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("when moving an object to a new parent", () => {
 | 
			
		||||
 | 
			
		||||
        beforeEach(async (done) => {
 | 
			
		||||
            duplicateTask = new DuplicateTask(openmct);
 | 
			
		||||
            await duplicateTask.duplicate(parentObject, anotherParentObject);
 | 
			
		||||
            done();
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("the duplicate child object's name (when not changing) should be the same as the original object", async () => {
 | 
			
		||||
            let duplicatedObjectIdentifier = anotherParentObject.composition[0];
 | 
			
		||||
            let duplicatedObject = await openmct.objects.get(duplicatedObjectIdentifier);
 | 
			
		||||
            let duplicateObjectName = duplicatedObject.name;
 | 
			
		||||
 | 
			
		||||
            expect(duplicateObjectName).toEqual(parentObject.name);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("the duplicate child object's identifier should be new", () => {
 | 
			
		||||
            let duplicatedObjectIdentifier = anotherParentObject.composition[0];
 | 
			
		||||
 | 
			
		||||
            expect(duplicatedObjectIdentifier.key).not.toEqual(parentObject.identifier.key);
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("when a new name is provided for the duplicated object", () => {
 | 
			
		||||
        const NEW_NAME = 'New Name';
 | 
			
		||||
 | 
			
		||||
        beforeEach(() => {
 | 
			
		||||
            duplicateTask = new DuplicateAction(openmct);
 | 
			
		||||
            duplicateTask.updateNameCheck(parentObject, NEW_NAME);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("the name is updated", () => {
 | 
			
		||||
            let childName = parentObject.name;
 | 
			
		||||
            expect(childName).toEqual(NEW_NAME);
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
});
 | 
			
		||||
@@ -1,11 +1,10 @@
 | 
			
		||||
<template>
 | 
			
		||||
<a
 | 
			
		||||
    class="l-grid-view__item c-grid-item"
 | 
			
		||||
    :class="{
 | 
			
		||||
    :class="[{
 | 
			
		||||
        'is-alias': item.isAlias === true,
 | 
			
		||||
        'is-missing': item.model.status === 'missing',
 | 
			
		||||
        'c-grid-item--unknown': item.type.cssClass === undefined || item.type.cssClass.indexOf('unknown') !== -1
 | 
			
		||||
    }"
 | 
			
		||||
    }, statusClass]"
 | 
			
		||||
    :href="objectLink"
 | 
			
		||||
>
 | 
			
		||||
    <div
 | 
			
		||||
@@ -27,8 +26,8 @@
 | 
			
		||||
        </div>
 | 
			
		||||
    </div>
 | 
			
		||||
    <div class="c-grid-item__controls">
 | 
			
		||||
        <div class="is-missing__indicator"
 | 
			
		||||
             title="This item is missing"
 | 
			
		||||
        <div class="is-status__indicator"
 | 
			
		||||
             :title="`This item is ${status}`"
 | 
			
		||||
        ></div>
 | 
			
		||||
        <div
 | 
			
		||||
            class="icon-people"
 | 
			
		||||
@@ -46,9 +45,10 @@
 | 
			
		||||
<script>
 | 
			
		||||
import contextMenuGesture from '../../../ui/mixins/context-menu-gesture';
 | 
			
		||||
import objectLink from '../../../ui/mixins/object-link';
 | 
			
		||||
import statusListener from './status-listener';
 | 
			
		||||
 | 
			
		||||
export default {
 | 
			
		||||
    mixins: [contextMenuGesture, objectLink],
 | 
			
		||||
    mixins: [contextMenuGesture, objectLink, statusListener],
 | 
			
		||||
    props: {
 | 
			
		||||
        item: {
 | 
			
		||||
            type: Object,
 | 
			
		||||
 
 | 
			
		||||
@@ -1,25 +1,27 @@
 | 
			
		||||
<template>
 | 
			
		||||
<tr
 | 
			
		||||
    class="c-list-item"
 | 
			
		||||
    :class="{ 'is-alias': item.isAlias === true }"
 | 
			
		||||
    :class="{
 | 
			
		||||
        'is-alias': item.isAlias === true
 | 
			
		||||
    }"
 | 
			
		||||
    @click="navigate"
 | 
			
		||||
>
 | 
			
		||||
    <td class="c-list-item__name">
 | 
			
		||||
        <a
 | 
			
		||||
            ref="objectLink"
 | 
			
		||||
            class="c-object-label"
 | 
			
		||||
            :class="{ 'is-missing': item.model.status === 'missing' }"
 | 
			
		||||
            :class="[statusClass]"
 | 
			
		||||
            :href="objectLink"
 | 
			
		||||
        >
 | 
			
		||||
            <div
 | 
			
		||||
                class="c-object-label__type-icon c-list-item__type-icon"
 | 
			
		||||
                class="c-object-label__type-icon c-list-item__name__type-icon"
 | 
			
		||||
                :class="item.type.cssClass"
 | 
			
		||||
            >
 | 
			
		||||
                <span class="is-missing__indicator"
 | 
			
		||||
                      title="This item is missing"
 | 
			
		||||
                <span class="is-status__indicator"
 | 
			
		||||
                      :title="`This item is ${status}`"
 | 
			
		||||
                ></span>
 | 
			
		||||
            </div>
 | 
			
		||||
            <div class="c-object-label__name c-list-item__name">{{ item.model.name }}</div>
 | 
			
		||||
            <div class="c-object-label__name c-list-item__name__name">{{ item.model.name }}</div>
 | 
			
		||||
        </a>
 | 
			
		||||
    </td>
 | 
			
		||||
    <td class="c-list-item__type">
 | 
			
		||||
@@ -39,9 +41,10 @@
 | 
			
		||||
import moment from 'moment';
 | 
			
		||||
import contextMenuGesture from '../../../ui/mixins/context-menu-gesture';
 | 
			
		||||
import objectLink from '../../../ui/mixins/object-link';
 | 
			
		||||
import statusListener from './status-listener';
 | 
			
		||||
 | 
			
		||||
export default {
 | 
			
		||||
    mixins: [contextMenuGesture, objectLink],
 | 
			
		||||
    mixins: [contextMenuGesture, objectLink, statusListener],
 | 
			
		||||
    props: {
 | 
			
		||||
        item: {
 | 
			
		||||
            type: Object,
 | 
			
		||||
 
 | 
			
		||||
@@ -1,121 +0,0 @@
 | 
			
		||||
/******************************* GRID ITEMS */
 | 
			
		||||
.c-grid-item {
 | 
			
		||||
    // Mobile-first
 | 
			
		||||
    @include button($bg: $colorItemBg, $fg: $colorItemFg);
 | 
			
		||||
    cursor: pointer;
 | 
			
		||||
    display: flex;
 | 
			
		||||
    padding: $interiorMarginLg;
 | 
			
		||||
 | 
			
		||||
    &__type-icon {
 | 
			
		||||
        filter: $colorKeyFilter;
 | 
			
		||||
        flex: 0 0 $gridItemMobile;
 | 
			
		||||
        font-size: floor($gridItemMobile / 2);
 | 
			
		||||
        margin-right: $interiorMarginLg;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    &.is-alias {
 | 
			
		||||
        // Object is an alias to an original.
 | 
			
		||||
        [class*='__type-icon'] {
 | 
			
		||||
            @include isAlias();
 | 
			
		||||
            color: $colorIconAliasForKeyFilter;
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    &__details {
 | 
			
		||||
        display: flex;
 | 
			
		||||
        flex-flow: column nowrap;
 | 
			
		||||
        flex: 1 1 auto;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    &__name {
 | 
			
		||||
        @include ellipsize();
 | 
			
		||||
        color: $colorItemFg;
 | 
			
		||||
        @include headerFont(1.2em);
 | 
			
		||||
        margin-bottom: $interiorMarginSm;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    &__metadata {
 | 
			
		||||
        color: $colorItemFgDetails;
 | 
			
		||||
        font-size: 0.9em;
 | 
			
		||||
 | 
			
		||||
        body.mobile & {
 | 
			
		||||
            [class*='__item-count'] {
 | 
			
		||||
                &:before {
 | 
			
		||||
                    content: ' - ';
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    &__controls {
 | 
			
		||||
        color: $colorItemFgDetails;
 | 
			
		||||
        flex: 0 0 64px;
 | 
			
		||||
        font-size: 1.2em;
 | 
			
		||||
        display: flex;
 | 
			
		||||
        align-items: center;
 | 
			
		||||
        justify-content: flex-end;
 | 
			
		||||
 | 
			
		||||
        > * + * {
 | 
			
		||||
            margin-left: $interiorMargin;
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    body.desktop & {
 | 
			
		||||
        $transOutMs: 300ms;
 | 
			
		||||
        flex-flow: column nowrap;
 | 
			
		||||
        transition: background $transOutMs ease-in-out;
 | 
			
		||||
 | 
			
		||||
        &:hover {
 | 
			
		||||
            background: $colorItemBgHov;
 | 
			
		||||
            transition: $transIn;
 | 
			
		||||
 | 
			
		||||
            .c-grid-item__type-icon {
 | 
			
		||||
                filter: $colorKeyFilterHov;
 | 
			
		||||
                transform: scale(1);
 | 
			
		||||
                transition: $transInBounce;
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        > * {
 | 
			
		||||
            margin: 0; // Reset from mobile
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        &__controls {
 | 
			
		||||
            align-items: start;
 | 
			
		||||
            flex: 0 0 auto;
 | 
			
		||||
            order: 1;
 | 
			
		||||
            .c-info-button,
 | 
			
		||||
            .c-pointer-icon { display: none; }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        &__type-icon {
 | 
			
		||||
            flex: 1 1 auto;
 | 
			
		||||
            font-size: floor($gridItemDesk / 3);
 | 
			
		||||
            margin: $interiorMargin 22.5% $interiorMargin * 3 22.5%;
 | 
			
		||||
            order: 2;
 | 
			
		||||
            transform: scale(0.9);
 | 
			
		||||
            transform-origin: center;
 | 
			
		||||
            transition: all $transOutMs ease-in-out;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        &__details {
 | 
			
		||||
            flex: 0 0 auto;
 | 
			
		||||
            justify-content: flex-end;
 | 
			
		||||
            order: 3;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        &__metadata {
 | 
			
		||||
            display: flex;
 | 
			
		||||
 | 
			
		||||
            &__type {
 | 
			
		||||
                flex: 1 1 auto;
 | 
			
		||||
                @include ellipsize();
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            &__item-count {
 | 
			
		||||
                opacity: 0.7;
 | 
			
		||||
                flex: 0 0 auto;
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -43,9 +43,20 @@
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    &.is-missing {
 | 
			
		||||
        @include isMissing();
 | 
			
		||||
    &.is-status--notebook-default {
 | 
			
		||||
        .is-status__indicator {
 | 
			
		||||
            display: block;
 | 
			
		||||
 | 
			
		||||
            &:before {
 | 
			
		||||
                color: $colorFilter;
 | 
			
		||||
                content: $glyph-icon-notebook-page;
 | 
			
		||||
                font-family: symbolsfont;
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    &[class*='is-status--missing'],
 | 
			
		||||
    &[class*='is-status--suspect']{
 | 
			
		||||
        [class*='__type-icon'],
 | 
			
		||||
        [class*='__details'] {
 | 
			
		||||
            opacity: $opacityMissing;
 | 
			
		||||
 
 | 
			
		||||
@@ -1,11 +1,19 @@
 | 
			
		||||
/******************************* LIST ITEM */
 | 
			
		||||
.c-list-item {
 | 
			
		||||
    &__type-icon {
 | 
			
		||||
    &__name__type-icon {
 | 
			
		||||
        color: $colorItemTreeIcon;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    &__name {
 | 
			
		||||
    &__name__name {
 | 
			
		||||
        @include ellipsize();
 | 
			
		||||
 | 
			
		||||
        a & {
 | 
			
		||||
            color: $colorItemFg;
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    &:not(.c-list-item__name) {
 | 
			
		||||
        color: $colorItemFgDetails;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    &.is-alias {
 | 
			
		||||
 
 | 
			
		||||
@@ -28,9 +28,5 @@
 | 
			
		||||
        padding-top: $p;
 | 
			
		||||
        padding-bottom: $p;
 | 
			
		||||
        width: 25%;
 | 
			
		||||
 | 
			
		||||
        &:not(.c-list-item__name) {
 | 
			
		||||
            color: $colorItemFgDetails;
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										33
									
								
								src/plugins/folderView/components/status-listener.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										33
									
								
								src/plugins/folderView/components/status-listener.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,33 @@
 | 
			
		||||
export default {
 | 
			
		||||
    inject: ['openmct'],
 | 
			
		||||
    props: {
 | 
			
		||||
        item: {
 | 
			
		||||
            type: Object,
 | 
			
		||||
            required: true
 | 
			
		||||
        }
 | 
			
		||||
    },
 | 
			
		||||
    computed: {
 | 
			
		||||
        statusClass() {
 | 
			
		||||
            return (this.status) ? `is-status--${this.status}` : '';
 | 
			
		||||
        }
 | 
			
		||||
    },
 | 
			
		||||
    data() {
 | 
			
		||||
        return {
 | 
			
		||||
            status: ''
 | 
			
		||||
        };
 | 
			
		||||
    },
 | 
			
		||||
    methods: {
 | 
			
		||||
        setStatus(status) {
 | 
			
		||||
            this.status = status;
 | 
			
		||||
        }
 | 
			
		||||
    },
 | 
			
		||||
    mounted() {
 | 
			
		||||
        let identifier = this.item.model.identifier;
 | 
			
		||||
 | 
			
		||||
        this.status = this.openmct.status.get(identifier);
 | 
			
		||||
        this.removeStatusListener = this.openmct.status.observe(identifier, this.setStatus);
 | 
			
		||||
    },
 | 
			
		||||
    destroyed() {
 | 
			
		||||
        this.removeStatusListener();
 | 
			
		||||
    }
 | 
			
		||||
};
 | 
			
		||||
@@ -25,6 +25,8 @@ export default class GoToOriginalAction {
 | 
			
		||||
        this.name = 'Go To Original';
 | 
			
		||||
        this.key = 'goToOriginal';
 | 
			
		||||
        this.description = 'Go to the original unlinked instance of this object';
 | 
			
		||||
        this.group = 'action';
 | 
			
		||||
        this.priority = 4;
 | 
			
		||||
 | 
			
		||||
        this._openmct = openmct;
 | 
			
		||||
    }
 | 
			
		||||
 
 | 
			
		||||
@@ -23,6 +23,6 @@ import GoToOriginalAction from './goToOriginalAction';
 | 
			
		||||
 | 
			
		||||
export default function () {
 | 
			
		||||
    return function (openmct) {
 | 
			
		||||
        openmct.contextMenu.registerAction(new GoToOriginalAction(openmct));
 | 
			
		||||
        openmct.actions.register(new GoToOriginalAction(openmct));
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -36,7 +36,7 @@
 | 
			
		||||
        <div class="c-imagery__main-image__bg"
 | 
			
		||||
             :class="{'paused unnsynced': isPaused,'stale':false }"
 | 
			
		||||
        >
 | 
			
		||||
            <div class="c-imagery__main-image__image"
 | 
			
		||||
            <div class="c-imagery__main-image__image js-imageryView-image"
 | 
			
		||||
                 :style="{
 | 
			
		||||
                     'background-image': imageUrl ? `url(${imageUrl})` : 'none',
 | 
			
		||||
                     'filter': `brightness(${filters.brightness}%) contrast(${filters.contrast}%)`
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										306
									
								
								src/plugins/imagery/pluginSpec.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										306
									
								
								src/plugins/imagery/pluginSpec.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,306 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
import ImageryPlugin from './plugin.js';
 | 
			
		||||
import Vue from 'vue';
 | 
			
		||||
import {
 | 
			
		||||
    createOpenMct,
 | 
			
		||||
    resetApplicationState,
 | 
			
		||||
    simulateKeyEvent
 | 
			
		||||
} from 'utils/testing';
 | 
			
		||||
 | 
			
		||||
const ONE_MINUTE = 1000 * 60;
 | 
			
		||||
const TEN_MINUTES = ONE_MINUTE * 10;
 | 
			
		||||
const MAIN_IMAGE_CLASS = '.js-imageryView-image';
 | 
			
		||||
const NEW_IMAGE_CLASS = '.c-imagery__age.c-imagery--new';
 | 
			
		||||
const REFRESH_CSS_MS = 500;
 | 
			
		||||
 | 
			
		||||
function getImageInfo(doc) {
 | 
			
		||||
    let imageElement = doc.querySelectorAll(MAIN_IMAGE_CLASS)[0];
 | 
			
		||||
    let timestamp = imageElement.dataset.openmctImageTimestamp;
 | 
			
		||||
    let identifier = imageElement.dataset.openmctObjectKeystring;
 | 
			
		||||
    let url = imageElement.style.backgroundImage;
 | 
			
		||||
 | 
			
		||||
    return {
 | 
			
		||||
        timestamp,
 | 
			
		||||
        identifier,
 | 
			
		||||
        url
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
function isNew(doc) {
 | 
			
		||||
    let newIcon = doc.querySelectorAll(NEW_IMAGE_CLASS);
 | 
			
		||||
 | 
			
		||||
    return newIcon.length !== 0;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
function generateTelemetry(start, count) {
 | 
			
		||||
    let telemetry = [];
 | 
			
		||||
 | 
			
		||||
    for (let i = 1, l = count + 1; i < l; i++) {
 | 
			
		||||
        let stringRep = i + 'minute';
 | 
			
		||||
        let logo = 'images/logo-openmct.svg';
 | 
			
		||||
 | 
			
		||||
        telemetry.push({
 | 
			
		||||
            "name": stringRep + " Imagery",
 | 
			
		||||
            "utc": start + (i * ONE_MINUTE),
 | 
			
		||||
            "url": location.host + '/' + logo + '?time=' + stringRep,
 | 
			
		||||
            "timeId": stringRep
 | 
			
		||||
        });
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    return telemetry;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
describe("The Imagery View Layout", () => {
 | 
			
		||||
    const imageryKey = 'example.imagery';
 | 
			
		||||
    const START = Date.now();
 | 
			
		||||
    const COUNT = 10;
 | 
			
		||||
 | 
			
		||||
    let openmct;
 | 
			
		||||
    let imageryPlugin;
 | 
			
		||||
    let parent;
 | 
			
		||||
    let child;
 | 
			
		||||
    let timeFormat = 'utc';
 | 
			
		||||
    let bounds = {
 | 
			
		||||
        start: START - TEN_MINUTES,
 | 
			
		||||
        end: START
 | 
			
		||||
    };
 | 
			
		||||
    let imageTelemetry = generateTelemetry(START - TEN_MINUTES, COUNT);
 | 
			
		||||
    let imageryObject = {
 | 
			
		||||
        identifier: {
 | 
			
		||||
            namespace: "",
 | 
			
		||||
            key: "imageryId"
 | 
			
		||||
        },
 | 
			
		||||
        name: "Example Imagery",
 | 
			
		||||
        type: "example.imagery",
 | 
			
		||||
        location: "parentId",
 | 
			
		||||
        modified: 0,
 | 
			
		||||
        persisted: 0,
 | 
			
		||||
        telemetry: {
 | 
			
		||||
            values: [
 | 
			
		||||
                {
 | 
			
		||||
                    "name": "Image",
 | 
			
		||||
                    "key": "url",
 | 
			
		||||
                    "format": "image",
 | 
			
		||||
                    "hints": {
 | 
			
		||||
                        "image": 1,
 | 
			
		||||
                        "priority": 3
 | 
			
		||||
                    },
 | 
			
		||||
                    "source": "url"
 | 
			
		||||
                },
 | 
			
		||||
                {
 | 
			
		||||
                    "name": "Name",
 | 
			
		||||
                    "key": "name",
 | 
			
		||||
                    "source": "name",
 | 
			
		||||
                    "hints": {
 | 
			
		||||
                        "priority": 0
 | 
			
		||||
                    }
 | 
			
		||||
                },
 | 
			
		||||
                {
 | 
			
		||||
                    "name": "Time",
 | 
			
		||||
                    "key": "utc",
 | 
			
		||||
                    "format": "utc",
 | 
			
		||||
                    "hints": {
 | 
			
		||||
                        "domain": 2,
 | 
			
		||||
                        "priority": 1
 | 
			
		||||
                    },
 | 
			
		||||
                    "source": "utc"
 | 
			
		||||
                },
 | 
			
		||||
                {
 | 
			
		||||
                    "name": "Local Time",
 | 
			
		||||
                    "key": "local",
 | 
			
		||||
                    "format": "local-format",
 | 
			
		||||
                    "hints": {
 | 
			
		||||
                        "domain": 1,
 | 
			
		||||
                        "priority": 2
 | 
			
		||||
                    },
 | 
			
		||||
                    "source": "local"
 | 
			
		||||
                }
 | 
			
		||||
            ]
 | 
			
		||||
        }
 | 
			
		||||
    };
 | 
			
		||||
 | 
			
		||||
    // this setups up the app
 | 
			
		||||
    beforeEach((done) => {
 | 
			
		||||
        const appHolder = document.createElement('div');
 | 
			
		||||
        appHolder.style.width = '640px';
 | 
			
		||||
        appHolder.style.height = '480px';
 | 
			
		||||
 | 
			
		||||
        openmct = createOpenMct();
 | 
			
		||||
 | 
			
		||||
        parent = document.createElement('div');
 | 
			
		||||
        child = document.createElement('div');
 | 
			
		||||
        parent.appendChild(child);
 | 
			
		||||
 | 
			
		||||
        spyOn(openmct.telemetry, 'request').and.returnValue(Promise.resolve([]));
 | 
			
		||||
 | 
			
		||||
        imageryPlugin = new ImageryPlugin();
 | 
			
		||||
        openmct.install(imageryPlugin);
 | 
			
		||||
 | 
			
		||||
        spyOn(openmct.objects, 'get').and.returnValue(Promise.resolve({}));
 | 
			
		||||
 | 
			
		||||
        openmct.time.timeSystem(timeFormat, {
 | 
			
		||||
            start: 0,
 | 
			
		||||
            end: 4
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        openmct.on('start', done);
 | 
			
		||||
        openmct.startHeadless(appHolder);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    afterEach(() => {
 | 
			
		||||
        return resetApplicationState(openmct);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it("should provide an imagery view only for imagery producing objects", () => {
 | 
			
		||||
        let applicableViews = openmct.objectViews.get(imageryObject);
 | 
			
		||||
        let imageryView = applicableViews.find(
 | 
			
		||||
            viewProvider => viewProvider.key === imageryKey
 | 
			
		||||
        );
 | 
			
		||||
 | 
			
		||||
        expect(imageryView).toBeDefined();
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("imagery view", () => {
 | 
			
		||||
        let applicableViews;
 | 
			
		||||
        let imageryViewProvider;
 | 
			
		||||
        let imageryView;
 | 
			
		||||
 | 
			
		||||
        beforeEach(async (done) => {
 | 
			
		||||
            let telemetryRequestResolve;
 | 
			
		||||
            let telemetryRequestPromise = new Promise((resolve) => {
 | 
			
		||||
                telemetryRequestResolve = resolve;
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            openmct.telemetry.request.and.callFake(() => {
 | 
			
		||||
                telemetryRequestResolve(imageTelemetry);
 | 
			
		||||
 | 
			
		||||
                return telemetryRequestPromise;
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            openmct.time.clock('local', {
 | 
			
		||||
                start: bounds.start,
 | 
			
		||||
                end: bounds.end + 100
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            applicableViews = openmct.objectViews.get(imageryObject);
 | 
			
		||||
            imageryViewProvider = applicableViews.find(viewProvider => viewProvider.key === imageryKey);
 | 
			
		||||
            imageryView = imageryViewProvider.view(imageryObject);
 | 
			
		||||
            imageryView.show(child);
 | 
			
		||||
 | 
			
		||||
            await telemetryRequestPromise;
 | 
			
		||||
            await Vue.nextTick();
 | 
			
		||||
 | 
			
		||||
            return done();
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("on mount should show the the most recent image", () => {
 | 
			
		||||
            const imageInfo = getImageInfo(parent);
 | 
			
		||||
 | 
			
		||||
            expect(imageInfo.url.indexOf(imageTelemetry[COUNT - 1].timeId)).not.toEqual(-1);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("should show the clicked thumbnail as the main image", async () => {
 | 
			
		||||
            const target = imageTelemetry[5].url;
 | 
			
		||||
            parent.querySelectorAll(`img[src='${target}']`)[0].click();
 | 
			
		||||
            await Vue.nextTick();
 | 
			
		||||
            const imageInfo = getImageInfo(parent);
 | 
			
		||||
 | 
			
		||||
            expect(imageInfo.url.indexOf(imageTelemetry[5].timeId)).not.toEqual(-1);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("should show that an image is new", async (done) => {
 | 
			
		||||
            await Vue.nextTick();
 | 
			
		||||
 | 
			
		||||
            // used in code, need to wait to the 500ms here too
 | 
			
		||||
            setTimeout(() => {
 | 
			
		||||
                const imageIsNew = isNew(parent);
 | 
			
		||||
 | 
			
		||||
                expect(imageIsNew).toBeTrue();
 | 
			
		||||
                done();
 | 
			
		||||
            }, REFRESH_CSS_MS);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("should show that an image is not new", async (done) => {
 | 
			
		||||
            const target = imageTelemetry[2].url;
 | 
			
		||||
            parent.querySelectorAll(`img[src='${target}']`)[0].click();
 | 
			
		||||
 | 
			
		||||
            await Vue.nextTick();
 | 
			
		||||
 | 
			
		||||
            // used in code, need to wait to the 500ms here too
 | 
			
		||||
            setTimeout(() => {
 | 
			
		||||
                const imageIsNew = isNew(parent);
 | 
			
		||||
 | 
			
		||||
                expect(imageIsNew).toBeFalse();
 | 
			
		||||
                done();
 | 
			
		||||
            }, REFRESH_CSS_MS);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("should navigate via arrow keys", async () => {
 | 
			
		||||
            let keyOpts = {
 | 
			
		||||
                element: parent.querySelector('.c-imagery'),
 | 
			
		||||
                key: 'ArrowLeft',
 | 
			
		||||
                keyCode: 37,
 | 
			
		||||
                type: 'keyup'
 | 
			
		||||
            };
 | 
			
		||||
 | 
			
		||||
            simulateKeyEvent(keyOpts);
 | 
			
		||||
 | 
			
		||||
            await Vue.nextTick();
 | 
			
		||||
 | 
			
		||||
            const imageInfo = getImageInfo(parent);
 | 
			
		||||
 | 
			
		||||
            expect(imageInfo.url.indexOf(imageTelemetry[COUNT - 2].timeId)).not.toEqual(-1);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("should navigate via numerous arrow keys", async () => {
 | 
			
		||||
            let element = parent.querySelector('.c-imagery');
 | 
			
		||||
            let type = 'keyup';
 | 
			
		||||
            let leftKeyOpts = {
 | 
			
		||||
                element,
 | 
			
		||||
                type,
 | 
			
		||||
                key: 'ArrowLeft',
 | 
			
		||||
                keyCode: 37
 | 
			
		||||
            };
 | 
			
		||||
            let rightKeyOpts = {
 | 
			
		||||
                element,
 | 
			
		||||
                type,
 | 
			
		||||
                key: 'ArrowRight',
 | 
			
		||||
                keyCode: 39
 | 
			
		||||
            };
 | 
			
		||||
 | 
			
		||||
            // left thrice
 | 
			
		||||
            simulateKeyEvent(leftKeyOpts);
 | 
			
		||||
            simulateKeyEvent(leftKeyOpts);
 | 
			
		||||
            simulateKeyEvent(leftKeyOpts);
 | 
			
		||||
            // right once
 | 
			
		||||
            simulateKeyEvent(rightKeyOpts);
 | 
			
		||||
 | 
			
		||||
            await Vue.nextTick();
 | 
			
		||||
 | 
			
		||||
            const imageInfo = getImageInfo(parent);
 | 
			
		||||
 | 
			
		||||
            expect(imageInfo.url.indexOf(imageTelemetry[COUNT - 3].timeId)).not.toEqual(-1);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
    });
 | 
			
		||||
});
 | 
			
		||||
@@ -20,40 +20,21 @@
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
define(
 | 
			
		||||
    ['./AbstractComposeAction'],
 | 
			
		||||
    function (AbstractComposeAction) {
 | 
			
		||||
 | 
			
		||||
        /**
 | 
			
		||||
         * The MoveAction is available from context menus and allows a user to
 | 
			
		||||
         * move an object to another location of their choosing.
 | 
			
		||||
         *
 | 
			
		||||
         * @implements {Action}
 | 
			
		||||
         * @constructor
 | 
			
		||||
         * @memberof platform/entanglement
 | 
			
		||||
         */
 | 
			
		||||
        function MoveAction(policyService, locationService, moveService, context) {
 | 
			
		||||
            AbstractComposeAction.apply(
 | 
			
		||||
                this,
 | 
			
		||||
                [policyService, locationService, moveService, context, "Move"]
 | 
			
		||||
            );
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        MoveAction.prototype = Object.create(AbstractComposeAction.prototype);
 | 
			
		||||
 | 
			
		||||
        MoveAction.appliesTo = function (context) {
 | 
			
		||||
            var applicableObject =
 | 
			
		||||
                context.selectedObject || context.domainObject;
 | 
			
		||||
 | 
			
		||||
            if (applicableObject && applicableObject.model.locked) {
 | 
			
		||||
                return false;
 | 
			
		||||
export default function MissingObjectInterceptor(openmct) {
 | 
			
		||||
    openmct.objects.addGetInterceptor({
 | 
			
		||||
        appliesTo: (identifier, domainObject) => {
 | 
			
		||||
            return identifier.key !== 'mine';
 | 
			
		||||
        },
 | 
			
		||||
        invoke: (identifier, object) => {
 | 
			
		||||
            if (object === undefined) {
 | 
			
		||||
                return {
 | 
			
		||||
                    identifier,
 | 
			
		||||
                    type: 'unknown',
 | 
			
		||||
                    name: 'Missing: ' + openmct.objects.makeKeyString(identifier)
 | 
			
		||||
                };
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            return Boolean(applicableObject
 | 
			
		||||
                && applicableObject.hasCapability('context'));
 | 
			
		||||
        };
 | 
			
		||||
 | 
			
		||||
        return MoveAction;
 | 
			
		||||
    }
 | 
			
		||||
);
 | 
			
		||||
 | 
			
		||||
            return object;
 | 
			
		||||
        }
 | 
			
		||||
    });
 | 
			
		||||
}
 | 
			
		||||
@@ -20,44 +20,24 @@
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
define([], function () {
 | 
			
		||||
export default function MyItemsInterceptor(openmct) {
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Disallow moves when either the parent or the child are not
 | 
			
		||||
     * modifiable by users.
 | 
			
		||||
     * @constructor
 | 
			
		||||
     * @implements {Policy}
 | 
			
		||||
     * @memberof platform/entanglement
 | 
			
		||||
     */
 | 
			
		||||
    function MovePolicy() {
 | 
			
		||||
    }
 | 
			
		||||
    openmct.objects.addGetInterceptor({
 | 
			
		||||
        appliesTo: (identifier, domainObject) => {
 | 
			
		||||
            return identifier.key === 'mine';
 | 
			
		||||
        },
 | 
			
		||||
        invoke: (identifier, object) => {
 | 
			
		||||
            if (object === undefined) {
 | 
			
		||||
                return {
 | 
			
		||||
                    identifier,
 | 
			
		||||
                    "name": "My Items",
 | 
			
		||||
                    "type": "folder",
 | 
			
		||||
                    "composition": [],
 | 
			
		||||
                    "location": "ROOT"
 | 
			
		||||
                };
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
    function parentOf(domainObject) {
 | 
			
		||||
        var context = domainObject.getCapability('context');
 | 
			
		||||
 | 
			
		||||
        return context && context.getParent();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    function allowMutation(domainObject) {
 | 
			
		||||
        var type = domainObject && domainObject.getCapability('type');
 | 
			
		||||
 | 
			
		||||
        return Boolean(type && type.hasFeature('creation'));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    function selectedObject(context) {
 | 
			
		||||
        return context.selectedObject || context.domainObject;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    MovePolicy.prototype.allow = function (action, context) {
 | 
			
		||||
        var key = action.getMetadata().key;
 | 
			
		||||
 | 
			
		||||
        if (key === 'move') {
 | 
			
		||||
            return allowMutation(selectedObject(context))
 | 
			
		||||
                && allowMutation(parentOf(selectedObject(context)));
 | 
			
		||||
            return object;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        return true;
 | 
			
		||||
    };
 | 
			
		||||
 | 
			
		||||
    return MovePolicy;
 | 
			
		||||
});
 | 
			
		||||
    });
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										9
									
								
								src/plugins/interceptors/plugin.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										9
									
								
								src/plugins/interceptors/plugin.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,9 @@
 | 
			
		||||
import missingObjectInterceptor from "./missingObjectInterceptor";
 | 
			
		||||
import myItemsInterceptor from "./myItemsInterceptor";
 | 
			
		||||
 | 
			
		||||
export default function plugin() {
 | 
			
		||||
    return function install(openmct) {
 | 
			
		||||
        myItemsInterceptor(openmct);
 | 
			
		||||
        missingObjectInterceptor(openmct);
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										114
									
								
								src/plugins/localTimeSystem/pluginSpec.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										114
									
								
								src/plugins/localTimeSystem/pluginSpec.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,114 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
 | 
			
		||||
import {
 | 
			
		||||
    createOpenMct,
 | 
			
		||||
    resetApplicationState
 | 
			
		||||
} from 'utils/testing';
 | 
			
		||||
 | 
			
		||||
describe("The local time", () => {
 | 
			
		||||
    const LOCAL_FORMAT_KEY = 'local-format';
 | 
			
		||||
    const LOCAL_SYSTEM_KEY = 'local';
 | 
			
		||||
    const JUNK = "junk";
 | 
			
		||||
    const TIMESTAMP = -14256000000;
 | 
			
		||||
    const DATESTRING = '1969-07-20 12:00:00.000 am';
 | 
			
		||||
    let openmct;
 | 
			
		||||
 | 
			
		||||
    beforeEach((done) => {
 | 
			
		||||
 | 
			
		||||
        openmct = createOpenMct();
 | 
			
		||||
 | 
			
		||||
        openmct.install(openmct.plugins.LocalTimeSystem());
 | 
			
		||||
 | 
			
		||||
        openmct.on('start', done);
 | 
			
		||||
        openmct.startHeadless();
 | 
			
		||||
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    afterEach(() => {
 | 
			
		||||
        return resetApplicationState(openmct);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("system", function () {
 | 
			
		||||
 | 
			
		||||
        let localTimeSystem;
 | 
			
		||||
 | 
			
		||||
        beforeEach(() => {
 | 
			
		||||
            localTimeSystem = openmct.time.timeSystem(LOCAL_SYSTEM_KEY, {
 | 
			
		||||
                start: 0,
 | 
			
		||||
                end: 4
 | 
			
		||||
            });
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("is installed", () => {
 | 
			
		||||
            let timeSystems = openmct.time.getAllTimeSystems();
 | 
			
		||||
            let local = timeSystems.find(ts => ts.key === LOCAL_SYSTEM_KEY);
 | 
			
		||||
 | 
			
		||||
            expect(local).not.toEqual(-1);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("can be set to be the main time system", () => {
 | 
			
		||||
            expect(openmct.time.timeSystem().key).toBe(LOCAL_SYSTEM_KEY);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("uses the local-format time format", () => {
 | 
			
		||||
            expect(localTimeSystem.timeFormat).toBe(LOCAL_FORMAT_KEY);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("is UTC based", () => {
 | 
			
		||||
            expect(localTimeSystem.isUTCBased).toBe(true);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("defines expected metadata", () => {
 | 
			
		||||
            expect(localTimeSystem.key).toBe(LOCAL_SYSTEM_KEY);
 | 
			
		||||
            expect(localTimeSystem.name).toBeDefined();
 | 
			
		||||
            expect(localTimeSystem.cssClass).toBeDefined();
 | 
			
		||||
            expect(localTimeSystem.durationFormat).toBeDefined();
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("formatter can be obtained from the telemetry API and", () => {
 | 
			
		||||
 | 
			
		||||
        let localTimeFormatter;
 | 
			
		||||
        let dateString;
 | 
			
		||||
        let timeStamp;
 | 
			
		||||
 | 
			
		||||
        beforeEach(() => {
 | 
			
		||||
            localTimeFormatter = openmct.telemetry.getFormatter(LOCAL_FORMAT_KEY);
 | 
			
		||||
            dateString = localTimeFormatter.format(TIMESTAMP);
 | 
			
		||||
            timeStamp = localTimeFormatter.parse(DATESTRING);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("will format a timestamp in local time format", () => {
 | 
			
		||||
            expect(localTimeFormatter.format(TIMESTAMP)).toBe(dateString);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("will parse an local time Date String into milliseconds", () => {
 | 
			
		||||
            expect(localTimeFormatter.parse(DATESTRING)).toBe(timeStamp);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("will validate correctly", () => {
 | 
			
		||||
            expect(localTimeFormatter.validate(DATESTRING)).toBe(true);
 | 
			
		||||
            expect(localTimeFormatter.validate(JUNK)).toBe(false);
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
});
 | 
			
		||||
							
								
								
									
										169
									
								
								src/plugins/move/MoveAction.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										169
									
								
								src/plugins/move/MoveAction.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,169 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
export default class MoveAction {
 | 
			
		||||
    constructor(openmct) {
 | 
			
		||||
        this.name = 'Move';
 | 
			
		||||
        this.key = 'move';
 | 
			
		||||
        this.description = 'Move this object from its containing object to another object.';
 | 
			
		||||
        this.cssClass = "icon-move";
 | 
			
		||||
        this.group = "action";
 | 
			
		||||
        this.priority = 7;
 | 
			
		||||
 | 
			
		||||
        this.openmct = openmct;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    async invoke(objectPath) {
 | 
			
		||||
        let object = objectPath[0];
 | 
			
		||||
        let inNavigationPath = this.inNavigationPath(object);
 | 
			
		||||
        let oldParent = objectPath[1];
 | 
			
		||||
        let dialogService = this.openmct.$injector.get('dialogService');
 | 
			
		||||
        let dialogForm = this.getDialogForm(object, oldParent);
 | 
			
		||||
        let userInput = await dialogService.getUserInput(dialogForm, { name: object.name });
 | 
			
		||||
 | 
			
		||||
        // if we need to update name
 | 
			
		||||
        if (object.name !== userInput.name) {
 | 
			
		||||
            this.openmct.objects.mutate(object, 'name', userInput.name);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        let parentContext = userInput.location.getCapability('context');
 | 
			
		||||
        let newParent = await this.openmct.objects.get(parentContext.domainObject.id);
 | 
			
		||||
 | 
			
		||||
        if (inNavigationPath && this.openmct.editor.isEditing()) {
 | 
			
		||||
            this.openmct.editor.save();
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        this.addToNewParent(object, newParent);
 | 
			
		||||
        this.removeFromOldParent(oldParent, object);
 | 
			
		||||
 | 
			
		||||
        if (inNavigationPath) {
 | 
			
		||||
            let newObjectPath = await this.openmct.objects.getOriginalPath(object.identifier);
 | 
			
		||||
            let root = await this.openmct.objects.getRoot();
 | 
			
		||||
            let rootChildCount = root.composition.length;
 | 
			
		||||
 | 
			
		||||
            // if not multiple root children, remove root from path
 | 
			
		||||
            if (rootChildCount < 2) {
 | 
			
		||||
                newObjectPath.pop(); // remove ROOT
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            this.navigateTo(newObjectPath);
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    inNavigationPath(object) {
 | 
			
		||||
        return this.openmct.router.path
 | 
			
		||||
            .some(objectInPath => this.openmct.objects.areIdsEqual(objectInPath.identifier, object.identifier));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    navigateTo(objectPath) {
 | 
			
		||||
        let urlPath = objectPath.reverse()
 | 
			
		||||
            .map(object => this.openmct.objects.makeKeyString(object.identifier))
 | 
			
		||||
            .join("/");
 | 
			
		||||
 | 
			
		||||
        window.location.href = '#/browse/' + urlPath;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    addToNewParent(child, newParent) {
 | 
			
		||||
        let newParentKeyString = this.openmct.objects.makeKeyString(newParent.identifier);
 | 
			
		||||
        let compositionCollection = this.openmct.composition.get(newParent);
 | 
			
		||||
 | 
			
		||||
        this.openmct.objects.mutate(child, 'location', newParentKeyString);
 | 
			
		||||
        compositionCollection.add(child);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    removeFromOldParent(parent, child) {
 | 
			
		||||
        let compositionCollection = this.openmct.composition.get(parent);
 | 
			
		||||
 | 
			
		||||
        compositionCollection.remove(child);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    getDialogForm(object, parent) {
 | 
			
		||||
        return {
 | 
			
		||||
            name: "Move Item",
 | 
			
		||||
            sections: [
 | 
			
		||||
                {
 | 
			
		||||
                    rows: [
 | 
			
		||||
                        {
 | 
			
		||||
                            key: "name",
 | 
			
		||||
                            control: "textfield",
 | 
			
		||||
                            name: "Folder Name",
 | 
			
		||||
                            pattern: "\\S+",
 | 
			
		||||
                            required: true,
 | 
			
		||||
                            cssClass: "l-input-lg"
 | 
			
		||||
                        },
 | 
			
		||||
                        {
 | 
			
		||||
                            name: "location",
 | 
			
		||||
                            control: "locator",
 | 
			
		||||
                            validate: this.validate(object, parent),
 | 
			
		||||
                            key: 'location'
 | 
			
		||||
                        }
 | 
			
		||||
                    ]
 | 
			
		||||
                }
 | 
			
		||||
            ]
 | 
			
		||||
        };
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    validate(object, currentParent) {
 | 
			
		||||
        return (parentCandidate) => {
 | 
			
		||||
            let currentParentKeystring = this.openmct.objects.makeKeyString(currentParent.identifier);
 | 
			
		||||
            let parentCandidateKeystring = this.openmct.objects.makeKeyString(parentCandidate.getId());
 | 
			
		||||
            let objectKeystring = this.openmct.objects.makeKeyString(object.identifier);
 | 
			
		||||
 | 
			
		||||
            if (!parentCandidateKeystring || !currentParentKeystring) {
 | 
			
		||||
                return false;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            if (parentCandidateKeystring === currentParentKeystring) {
 | 
			
		||||
                return false;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            if (parentCandidateKeystring === objectKeystring) {
 | 
			
		||||
                return false;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            if (parentCandidate.getModel().composition.indexOf(objectKeystring) !== -1) {
 | 
			
		||||
                return false;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            return this.openmct.composition.checkPolicy(
 | 
			
		||||
                parentCandidate.useCapability('adapter'),
 | 
			
		||||
                object
 | 
			
		||||
            );
 | 
			
		||||
        };
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    appliesTo(objectPath) {
 | 
			
		||||
        let parent = objectPath[1];
 | 
			
		||||
        let parentType = parent && this.openmct.types.get(parent.type);
 | 
			
		||||
        let child = objectPath[0];
 | 
			
		||||
        let childType = child && this.openmct.types.get(child.type);
 | 
			
		||||
 | 
			
		||||
        if (child.locked || (parent && parent.locked)) {
 | 
			
		||||
            return false;
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        return parentType
 | 
			
		||||
            && parentType.definition.creatable
 | 
			
		||||
            && childType
 | 
			
		||||
            && childType.definition.creatable
 | 
			
		||||
            && Array.isArray(parent.composition);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										28
									
								
								src/plugins/move/plugin.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										28
									
								
								src/plugins/move/plugin.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,28 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
import MoveAction from "./MoveAction";
 | 
			
		||||
 | 
			
		||||
export default function () {
 | 
			
		||||
    return function (openmct) {
 | 
			
		||||
        openmct.actions.register(new MoveAction(openmct));
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										110
									
								
								src/plugins/move/pluginSpec.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										110
									
								
								src/plugins/move/pluginSpec.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,110 @@
 | 
			
		||||
/*****************************************************************************
 | 
			
		||||
 * Open MCT, Copyright (c) 2014-2020, United States Government
 | 
			
		||||
 * as represented by the Administrator of the National Aeronautics and Space
 | 
			
		||||
 * Administration. All rights reserved.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT is licensed 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
 | 
			
		||||
 * 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.
 | 
			
		||||
 *
 | 
			
		||||
 * Open MCT includes source code licensed under additional open source
 | 
			
		||||
 * licenses. See the Open Source Licenses file (LICENSES.md) included with
 | 
			
		||||
 * this source code distribution or the Licensing information page available
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
import MoveActionPlugin from './plugin.js';
 | 
			
		||||
import MoveAction from './MoveAction.js';
 | 
			
		||||
import {
 | 
			
		||||
    createOpenMct,
 | 
			
		||||
    resetApplicationState,
 | 
			
		||||
    getMockObjects
 | 
			
		||||
} from 'utils/testing';
 | 
			
		||||
 | 
			
		||||
describe("The Move Action plugin", () => {
 | 
			
		||||
 | 
			
		||||
    let openmct;
 | 
			
		||||
    let moveAction;
 | 
			
		||||
    let childObject;
 | 
			
		||||
    let parentObject;
 | 
			
		||||
    let anotherParentObject;
 | 
			
		||||
 | 
			
		||||
    // this setups up the app
 | 
			
		||||
    beforeEach((done) => {
 | 
			
		||||
        const appHolder = document.createElement('div');
 | 
			
		||||
        appHolder.style.width = '640px';
 | 
			
		||||
        appHolder.style.height = '480px';
 | 
			
		||||
 | 
			
		||||
        openmct = createOpenMct();
 | 
			
		||||
 | 
			
		||||
        childObject = getMockObjects({
 | 
			
		||||
            objectKeyStrings: ['folder'],
 | 
			
		||||
            overwrite: {
 | 
			
		||||
                folder: {
 | 
			
		||||
                    name: "Child Folder",
 | 
			
		||||
                    identifier: {
 | 
			
		||||
                        namespace: "",
 | 
			
		||||
                        key: "child-folder-object"
 | 
			
		||||
                    }
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }).folder;
 | 
			
		||||
        parentObject = getMockObjects({
 | 
			
		||||
            objectKeyStrings: ['folder'],
 | 
			
		||||
            overwrite: {
 | 
			
		||||
                folder: {
 | 
			
		||||
                    name: "Parent Folder",
 | 
			
		||||
                    composition: [childObject.identifier]
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }).folder;
 | 
			
		||||
        anotherParentObject = getMockObjects({
 | 
			
		||||
            objectKeyStrings: ['folder'],
 | 
			
		||||
            overwrite: {
 | 
			
		||||
                folder: {
 | 
			
		||||
                    name: "Another Parent Folder"
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }).folder;
 | 
			
		||||
 | 
			
		||||
        // already installed by default, but never hurts, just adds to context menu
 | 
			
		||||
        openmct.install(MoveActionPlugin());
 | 
			
		||||
 | 
			
		||||
        openmct.on('start', done);
 | 
			
		||||
        openmct.startHeadless(appHolder);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    afterEach(() => {
 | 
			
		||||
        resetApplicationState(openmct);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it("should be defined", () => {
 | 
			
		||||
        expect(MoveActionPlugin).toBeDefined();
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    describe("when moving an object to a new parent and removing from the old parent", () => {
 | 
			
		||||
 | 
			
		||||
        beforeEach(() => {
 | 
			
		||||
            moveAction = new MoveAction(openmct);
 | 
			
		||||
            moveAction.addToNewParent(childObject, anotherParentObject);
 | 
			
		||||
            moveAction.removeFromOldParent(parentObject, childObject);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("the child object's identifier should be in the new parent's composition", () => {
 | 
			
		||||
            let newParentChild = anotherParentObject.composition[0];
 | 
			
		||||
            expect(newParentChild).toEqual(childObject.identifier);
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("the child object's identifier should be removed from the old parent's composition", () => {
 | 
			
		||||
            let oldParentComposition = parentObject.composition;
 | 
			
		||||
            expect(oldParentComposition.length).toEqual(0);
 | 
			
		||||
        });
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
});
 | 
			
		||||
@@ -28,6 +28,8 @@ export default class NewFolderAction {
 | 
			
		||||
        this.key = 'newFolder';
 | 
			
		||||
        this.description = 'Create a new folder';
 | 
			
		||||
        this.cssClass = 'icon-folder-new';
 | 
			
		||||
        this.group = "action";
 | 
			
		||||
        this.priority = 9;
 | 
			
		||||
 | 
			
		||||
        this._openmct = openmct;
 | 
			
		||||
        this._dialogForm = {
 | 
			
		||||
 
 | 
			
		||||
@@ -23,6 +23,6 @@ import NewFolderAction from './newFolderAction';
 | 
			
		||||
 | 
			
		||||
export default function () {
 | 
			
		||||
    return function (openmct) {
 | 
			
		||||
        openmct.contextMenu.registerAction(new NewFolderAction(openmct));
 | 
			
		||||
        openmct.actions.register(new NewFolderAction(openmct));
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -40,9 +40,7 @@ describe("the plugin", () => {
 | 
			
		||||
        openmct.on('start', done);
 | 
			
		||||
        openmct.startHeadless();
 | 
			
		||||
 | 
			
		||||
        newFolderAction = openmct.contextMenu._allActions.filter(action => {
 | 
			
		||||
            return action.key === 'newFolder';
 | 
			
		||||
        })[0];
 | 
			
		||||
        newFolderAction = openmct.actions._allActions.newFolder;
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    afterEach(() => {
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										40
									
								
								src/plugins/notebook/actions/CopyToNotebookAction.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										40
									
								
								src/plugins/notebook/actions/CopyToNotebookAction.js
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,40 @@
 | 
			
		||||
import { getDefaultNotebook } from '../utils/notebook-storage';
 | 
			
		||||
import { addNotebookEntry } from '../utils/notebook-entries';
 | 
			
		||||
 | 
			
		||||
export default class CopyToNotebookAction {
 | 
			
		||||
    constructor(openmct) {
 | 
			
		||||
        this.openmct = openmct;
 | 
			
		||||
 | 
			
		||||
        this.cssClass = 'icon-duplicate';
 | 
			
		||||
        this.description = 'Copy value to notebook as an entry';
 | 
			
		||||
        this.group = "action";
 | 
			
		||||
        this.key = 'copyToNotebook';
 | 
			
		||||
        this.name = 'Copy to Notebook';
 | 
			
		||||
        this.priority = 1;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    copyToNotebook(entryText) {
 | 
			
		||||
        const notebookStorage = getDefaultNotebook();
 | 
			
		||||
        this.openmct.objects.get(notebookStorage.notebookMeta.identifier)
 | 
			
		||||
            .then(domainObject => {
 | 
			
		||||
                addNotebookEntry(this.openmct, domainObject, notebookStorage, null, entryText);
 | 
			
		||||
 | 
			
		||||
                const defaultPath = `${domainObject.name} - ${notebookStorage.section.name} - ${notebookStorage.page.name}`;
 | 
			
		||||
                const msg = `Saved to Notebook ${defaultPath}`;
 | 
			
		||||
                this.openmct.notifications.info(msg);
 | 
			
		||||
            });
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    invoke(objectPath, view = {}) {
 | 
			
		||||
        let viewContext = view.getViewContext && view.getViewContext();
 | 
			
		||||
 | 
			
		||||
        this.copyToNotebook(viewContext.formattedValueForCopy());
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    appliesTo(objectPath, view = {}) {
 | 
			
		||||
        let viewContext = view.getViewContext && view.getViewContext();
 | 
			
		||||
 | 
			
		||||
        return viewContext && viewContext.formattedValueForCopy
 | 
			
		||||
            && typeof viewContext.formattedValueForCopy === 'function';
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -24,12 +24,12 @@
 | 
			
		||||
                 :default-section-id="defaultSectionId"
 | 
			
		||||
                 :domain-object="internalDomainObject"
 | 
			
		||||
                 :page-title="internalDomainObject.configuration.pageTitle"
 | 
			
		||||
                 :pages="pages"
 | 
			
		||||
                 :section-title="internalDomainObject.configuration.sectionTitle"
 | 
			
		||||
                 :sections="sections"
 | 
			
		||||
                 :selected-section="selectedSection"
 | 
			
		||||
                 :sidebar-covers-entries="sidebarCoversEntries"
 | 
			
		||||
                 @updatePage="updatePage"
 | 
			
		||||
                 @updateSection="updateSection"
 | 
			
		||||
                 @pagesChanged="pagesChanged"
 | 
			
		||||
                 @sectionsChanged="sectionsChanged"
 | 
			
		||||
                 @toggleNav="toggleNav"
 | 
			
		||||
        />
 | 
			
		||||
        <div class="c-notebook__page-view">
 | 
			
		||||
@@ -111,7 +111,7 @@ import Search from '@/ui/components/search.vue';
 | 
			
		||||
import SearchResults from './SearchResults.vue';
 | 
			
		||||
import Sidebar from './Sidebar.vue';
 | 
			
		||||
import { clearDefaultNotebook, getDefaultNotebook, setDefaultNotebook, setDefaultNotebookSection, setDefaultNotebookPage } from '../utils/notebook-storage';
 | 
			
		||||
import { DEFAULT_CLASS, addNotebookEntry, createNewEmbed, getNotebookEntries } from '../utils/notebook-entries';
 | 
			
		||||
import { addNotebookEntry, createNewEmbed, getNotebookEntries, mutateObject } from '../utils/notebook-entries';
 | 
			
		||||
import objectUtils from 'objectUtils';
 | 
			
		||||
 | 
			
		||||
import { throttle } from 'lodash';
 | 
			
		||||
@@ -220,19 +220,17 @@ export default {
 | 
			
		||||
                return s;
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            this.updateSection({ sections });
 | 
			
		||||
            this.sectionsChanged({ sections });
 | 
			
		||||
            this.throttledSearchItem('');
 | 
			
		||||
        },
 | 
			
		||||
        createNotebookStorageObject() {
 | 
			
		||||
            const notebookMeta = {
 | 
			
		||||
                name: this.internalDomainObject.name,
 | 
			
		||||
                identifier: this.internalDomainObject.identifier
 | 
			
		||||
            };
 | 
			
		||||
            const page = this.getSelectedPage();
 | 
			
		||||
            const section = this.getSelectedSection();
 | 
			
		||||
 | 
			
		||||
            return {
 | 
			
		||||
                domainObject: this.internalDomainObject,
 | 
			
		||||
                notebookMeta,
 | 
			
		||||
                section,
 | 
			
		||||
                page
 | 
			
		||||
@@ -309,7 +307,7 @@ export default {
 | 
			
		||||
                return null;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            return this.openmct.objects.get(oldNotebookStorage.notebookMeta.identifier).then(d => d);
 | 
			
		||||
            return this.openmct.objects.get(oldNotebookStorage.notebookMeta.identifier);
 | 
			
		||||
        },
 | 
			
		||||
        getPage(section, id) {
 | 
			
		||||
            return section.pages.find(p => p.id === id);
 | 
			
		||||
@@ -379,9 +377,6 @@ export default {
 | 
			
		||||
 | 
			
		||||
            return this.sections.find(section => section.isSelected);
 | 
			
		||||
        },
 | 
			
		||||
        mutateObject(key, value) {
 | 
			
		||||
            this.openmct.objects.mutate(this.internalDomainObject, key, value);
 | 
			
		||||
        },
 | 
			
		||||
        navigateToSectionPage() {
 | 
			
		||||
            const { pageId, sectionId } = this.openmct.router.getParams();
 | 
			
		||||
            if (!pageId || !sectionId) {
 | 
			
		||||
@@ -398,7 +393,7 @@ export default {
 | 
			
		||||
                return s;
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            this.updateSection({ sections });
 | 
			
		||||
            this.sectionsChanged({ sections });
 | 
			
		||||
        },
 | 
			
		||||
        newEntry(embed = null) {
 | 
			
		||||
            this.search = '';
 | 
			
		||||
@@ -411,19 +406,30 @@ export default {
 | 
			
		||||
        orientationChange() {
 | 
			
		||||
            this.formatSidebar();
 | 
			
		||||
        },
 | 
			
		||||
        pagesChanged({ pages = [], id = null}) {
 | 
			
		||||
            const selectedSection = this.getSelectedSection();
 | 
			
		||||
            if (!selectedSection) {
 | 
			
		||||
                return;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            selectedSection.pages = pages;
 | 
			
		||||
            const sections = this.sections.map(section => {
 | 
			
		||||
                if (section.id === selectedSection.id) {
 | 
			
		||||
                    section = selectedSection;
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                return section;
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            this.sectionsChanged({ sections });
 | 
			
		||||
            this.updateDefaultNotebookPage(pages, id);
 | 
			
		||||
        },
 | 
			
		||||
        removeDefaultClass(domainObject) {
 | 
			
		||||
            if (!domainObject) {
 | 
			
		||||
                return;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            const classList = domainObject.classList || [];
 | 
			
		||||
            const index = classList.indexOf(DEFAULT_CLASS);
 | 
			
		||||
            if (!classList.length || index < 0) {
 | 
			
		||||
                return;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            classList.splice(index, 1);
 | 
			
		||||
            this.openmct.objects.mutate(domainObject, 'classList', classList);
 | 
			
		||||
            this.openmct.status.delete(domainObject.identifier);
 | 
			
		||||
        },
 | 
			
		||||
        searchItem(input) {
 | 
			
		||||
            this.search = input;
 | 
			
		||||
@@ -434,18 +440,20 @@ export default {
 | 
			
		||||
        async updateDefaultNotebook(notebookStorage) {
 | 
			
		||||
            const defaultNotebookObject = await this.getDefaultNotebookObject();
 | 
			
		||||
            if (!defaultNotebookObject) {
 | 
			
		||||
                setDefaultNotebook(this.openmct, notebookStorage);
 | 
			
		||||
                setDefaultNotebook(this.openmct, notebookStorage, this.internalDomainObject);
 | 
			
		||||
            } else if (objectUtils.makeKeyString(defaultNotebookObject.identifier) !== objectUtils.makeKeyString(notebookStorage.notebookMeta.identifier)) {
 | 
			
		||||
                this.removeDefaultClass(defaultNotebookObject);
 | 
			
		||||
                setDefaultNotebook(this.openmct, notebookStorage);
 | 
			
		||||
                setDefaultNotebook(this.openmct, notebookStorage, this.internalDomainObject);
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            if (this.defaultSectionId.length === 0 || this.defaultSectionId !== notebookStorage.section.id) {
 | 
			
		||||
            if (this.defaultSectionId && this.defaultSectionId.length === 0 || this.defaultSectionId !== notebookStorage.section.id) {
 | 
			
		||||
                this.defaultSectionId = notebookStorage.section.id;
 | 
			
		||||
                setDefaultNotebookSection(notebookStorage.section);
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            if (this.defaultPageId.length === 0 || this.defaultPageId !== notebookStorage.page.id) {
 | 
			
		||||
            if (this.defaultPageId && this.defaultPageId.length === 0 || this.defaultPageId !== notebookStorage.page.id) {
 | 
			
		||||
                this.defaultPageId = notebookStorage.page.id;
 | 
			
		||||
                setDefaultNotebookPage(notebookStorage.page);
 | 
			
		||||
            }
 | 
			
		||||
        },
 | 
			
		||||
        updateDefaultNotebookPage(pages, id) {
 | 
			
		||||
@@ -509,29 +517,11 @@ export default {
 | 
			
		||||
            const notebookEntries = configuration.entries || {};
 | 
			
		||||
            notebookEntries[this.selectedSection.id][this.selectedPage.id] = entries;
 | 
			
		||||
 | 
			
		||||
            this.mutateObject('configuration.entries', notebookEntries);
 | 
			
		||||
            mutateObject(this.openmct, this.internalDomainObject, 'configuration.entries', notebookEntries);
 | 
			
		||||
        },
 | 
			
		||||
        updateInternalDomainObject(domainObject) {
 | 
			
		||||
            this.internalDomainObject = domainObject;
 | 
			
		||||
        },
 | 
			
		||||
        updatePage({ pages = [], id = null}) {
 | 
			
		||||
            const selectedSection = this.getSelectedSection();
 | 
			
		||||
            if (!selectedSection) {
 | 
			
		||||
                return;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            selectedSection.pages = pages;
 | 
			
		||||
            const sections = this.sections.map(section => {
 | 
			
		||||
                if (section.id === selectedSection.id) {
 | 
			
		||||
                    section = selectedSection;
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                return section;
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            this.updateSection({ sections });
 | 
			
		||||
            this.updateDefaultNotebookPage(pages, id);
 | 
			
		||||
        },
 | 
			
		||||
        updateParams(sections) {
 | 
			
		||||
            const selectedSection = sections.find(s => s.isSelected);
 | 
			
		||||
            if (!selectedSection) {
 | 
			
		||||
@@ -555,8 +545,8 @@ export default {
 | 
			
		||||
                pageId
 | 
			
		||||
            });
 | 
			
		||||
        },
 | 
			
		||||
        updateSection({ sections, id = null }) {
 | 
			
		||||
            this.mutateObject('configuration.sections', sections);
 | 
			
		||||
        sectionsChanged({ sections, id = null }) {
 | 
			
		||||
            mutateObject(this.openmct, this.internalDomainObject, 'configuration.sections', sections);
 | 
			
		||||
 | 
			
		||||
            this.updateParams(sections);
 | 
			
		||||
            this.updateDefaultNotebookSection(sections, id);
 | 
			
		||||
 
 | 
			
		||||
@@ -118,7 +118,7 @@ export default {
 | 
			
		||||
            painterroInstance.show(this.embed.snapshot.src);
 | 
			
		||||
        },
 | 
			
		||||
        changeLocation() {
 | 
			
		||||
            const link = this.embed.historicLink;
 | 
			
		||||
            const hash = this.embed.historicLink;
 | 
			
		||||
 | 
			
		||||
            const bounds = this.openmct.time.bounds();
 | 
			
		||||
            const isTimeBoundChanged = this.embed.bounds.start !== bounds.start
 | 
			
		||||
@@ -143,8 +143,9 @@ export default {
 | 
			
		||||
                this.openmct.notifications.alert(message);
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            const url = new URL(link);
 | 
			
		||||
            window.location.href = url.hash;
 | 
			
		||||
            const relativeHash = hash.slice(hash.indexOf('#'));
 | 
			
		||||
            const url = new URL(relativeHash, `${location.protocol}//${location.host}${location.pathname}`);
 | 
			
		||||
            window.location.hash = url.hash;
 | 
			
		||||
        },
 | 
			
		||||
        formatTime(unixTime, timeFormat) {
 | 
			
		||||
            return Moment.utc(unixTime).format(timeFormat);
 | 
			
		||||
 
 | 
			
		||||
@@ -1,35 +1,23 @@
 | 
			
		||||
<template>
 | 
			
		||||
<div class="c-menu-button c-ctrl-wrapper c-ctrl-wrapper--menus-left">
 | 
			
		||||
    <button
 | 
			
		||||
        class="c-button--menu icon-notebook"
 | 
			
		||||
        class="c-icon-button c-button--menu icon-camera"
 | 
			
		||||
        title="Take a Notebook Snapshot"
 | 
			
		||||
        @click="setNotebookTypes"
 | 
			
		||||
        @click.stop="toggleMenu"
 | 
			
		||||
        @click.stop.prevent="showMenu"
 | 
			
		||||
    >
 | 
			
		||||
        <span class="c-button__label"></span>
 | 
			
		||||
        <span
 | 
			
		||||
            title="Take Notebook Snapshot"
 | 
			
		||||
            class="c-icon-button__label"
 | 
			
		||||
        >
 | 
			
		||||
            Snapshot
 | 
			
		||||
        </span>
 | 
			
		||||
    </button>
 | 
			
		||||
    <div
 | 
			
		||||
        v-show="showMenu"
 | 
			
		||||
        class="c-menu"
 | 
			
		||||
    >
 | 
			
		||||
        <ul>
 | 
			
		||||
            <li
 | 
			
		||||
                v-for="(type, index) in notebookTypes"
 | 
			
		||||
                :key="index"
 | 
			
		||||
                :class="type.cssClass"
 | 
			
		||||
                :title="type.name"
 | 
			
		||||
                @click="snapshot(type)"
 | 
			
		||||
            >
 | 
			
		||||
                {{ type.name }}
 | 
			
		||||
            </li>
 | 
			
		||||
        </ul>
 | 
			
		||||
    </div>
 | 
			
		||||
</div>
 | 
			
		||||
</template>
 | 
			
		||||
 | 
			
		||||
<script>
 | 
			
		||||
import Snapshot from '../snapshot';
 | 
			
		||||
import { getDefaultNotebook } from '../utils/notebook-storage';
 | 
			
		||||
import { getDefaultNotebook, validateNotebookStorageObject } from '../utils/notebook-storage';
 | 
			
		||||
import { NOTEBOOK_DEFAULT, NOTEBOOK_SNAPSHOT } from '../notebook-constants';
 | 
			
		||||
 | 
			
		||||
export default {
 | 
			
		||||
@@ -56,55 +44,59 @@ export default {
 | 
			
		||||
    },
 | 
			
		||||
    data() {
 | 
			
		||||
        return {
 | 
			
		||||
            notebookSnapshot: null,
 | 
			
		||||
            notebookTypes: [],
 | 
			
		||||
            showMenu: false
 | 
			
		||||
            notebookSnapshot: undefined,
 | 
			
		||||
            notebookTypes: []
 | 
			
		||||
        };
 | 
			
		||||
    },
 | 
			
		||||
    mounted() {
 | 
			
		||||
        this.notebookSnapshot = new Snapshot(this.openmct);
 | 
			
		||||
        validateNotebookStorageObject();
 | 
			
		||||
        this.getDefaultNotebookObject();
 | 
			
		||||
 | 
			
		||||
        document.addEventListener('click', this.hideMenu);
 | 
			
		||||
    },
 | 
			
		||||
    destroyed() {
 | 
			
		||||
        document.removeEventListener('click', this.hideMenu);
 | 
			
		||||
        this.notebookSnapshot = new Snapshot(this.openmct);
 | 
			
		||||
        this.setDefaultNotebookStatus();
 | 
			
		||||
    },
 | 
			
		||||
    methods: {
 | 
			
		||||
        setNotebookTypes() {
 | 
			
		||||
            const notebookTypes = [];
 | 
			
		||||
        async getDefaultNotebookObject() {
 | 
			
		||||
            const defaultNotebook = getDefaultNotebook();
 | 
			
		||||
            const defaultNotebookObject = defaultNotebook && await this.openmct.objects.get(defaultNotebook.notebookMeta.identifier);
 | 
			
		||||
 | 
			
		||||
            if (defaultNotebook) {
 | 
			
		||||
                const domainObject = defaultNotebook.domainObject;
 | 
			
		||||
            return defaultNotebookObject;
 | 
			
		||||
        },
 | 
			
		||||
        async showMenu(event) {
 | 
			
		||||
            const notebookTypes = [];
 | 
			
		||||
            const elementBoundingClientRect = this.$el.getBoundingClientRect();
 | 
			
		||||
            const x = elementBoundingClientRect.x;
 | 
			
		||||
            const y = elementBoundingClientRect.y + elementBoundingClientRect.height;
 | 
			
		||||
 | 
			
		||||
                if (domainObject.location) {
 | 
			
		||||
                    const defaultPath = `${domainObject.name} - ${defaultNotebook.section.name} - ${defaultNotebook.page.name}`;
 | 
			
		||||
            const defaultNotebookObject = await this.getDefaultNotebookObject();
 | 
			
		||||
            if (defaultNotebookObject) {
 | 
			
		||||
                const name = defaultNotebookObject.name;
 | 
			
		||||
 | 
			
		||||
                    notebookTypes.push({
 | 
			
		||||
                        cssClass: 'icon-notebook',
 | 
			
		||||
                        name: `Save to Notebook ${defaultPath}`,
 | 
			
		||||
                        type: NOTEBOOK_DEFAULT
 | 
			
		||||
                    });
 | 
			
		||||
                }
 | 
			
		||||
                const defaultNotebook = getDefaultNotebook();
 | 
			
		||||
                const sectionName = defaultNotebook.section.name;
 | 
			
		||||
                const pageName = defaultNotebook.page.name;
 | 
			
		||||
                const defaultPath = `${name} - ${sectionName} - ${pageName}`;
 | 
			
		||||
 | 
			
		||||
                notebookTypes.push({
 | 
			
		||||
                    cssClass: 'icon-notebook',
 | 
			
		||||
                    name: `Save to Notebook ${defaultPath}`,
 | 
			
		||||
                    callBack: () => {
 | 
			
		||||
                        return this.snapshot(NOTEBOOK_DEFAULT);
 | 
			
		||||
                    }
 | 
			
		||||
                });
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            notebookTypes.push({
 | 
			
		||||
                cssClass: 'icon-notebook',
 | 
			
		||||
                cssClass: 'icon-camera',
 | 
			
		||||
                name: 'Save to Notebook Snapshots',
 | 
			
		||||
                type: NOTEBOOK_SNAPSHOT
 | 
			
		||||
                callBack: () => {
 | 
			
		||||
                    return this.snapshot(NOTEBOOK_SNAPSHOT);
 | 
			
		||||
                }
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            this.notebookTypes = notebookTypes;
 | 
			
		||||
            this.openmct.menus.showMenu(x, y, notebookTypes);
 | 
			
		||||
        },
 | 
			
		||||
        toggleMenu() {
 | 
			
		||||
            this.showMenu = !this.showMenu;
 | 
			
		||||
        },
 | 
			
		||||
        hideMenu() {
 | 
			
		||||
            this.showMenu = false;
 | 
			
		||||
        },
 | 
			
		||||
        snapshot(notebook) {
 | 
			
		||||
            this.hideMenu();
 | 
			
		||||
 | 
			
		||||
        snapshot(notebookType) {
 | 
			
		||||
            this.$nextTick(() => {
 | 
			
		||||
                const element = document.querySelector('.c-overlay__contents')
 | 
			
		||||
                    || document.getElementsByClassName('l-shell__main-container')[0];
 | 
			
		||||
@@ -122,8 +114,17 @@ export default {
 | 
			
		||||
                    openmct: this.openmct
 | 
			
		||||
                };
 | 
			
		||||
 | 
			
		||||
                this.notebookSnapshot.capture(snapshotMeta, notebook.type, element);
 | 
			
		||||
                this.notebookSnapshot.capture(snapshotMeta, notebookType, element);
 | 
			
		||||
            });
 | 
			
		||||
        },
 | 
			
		||||
        setDefaultNotebookStatus() {
 | 
			
		||||
            let defaultNotebookObject = getDefaultNotebook();
 | 
			
		||||
 | 
			
		||||
            if (defaultNotebookObject && defaultNotebookObject.notebookMeta) {
 | 
			
		||||
                let notebookIdentifier = defaultNotebookObject.notebookMeta.identifier;
 | 
			
		||||
 | 
			
		||||
                this.openmct.status.set(notebookIdentifier, 'notebook-default');
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
};
 | 
			
		||||
 
 | 
			
		||||
@@ -4,7 +4,7 @@
 | 
			
		||||
        <div class="l-browse-bar__start">
 | 
			
		||||
            <div class="l-browse-bar__object-name--w">
 | 
			
		||||
                <div class="l-browse-bar__object-name c-object-label">
 | 
			
		||||
                    <div class="c-object-label__type-icon icon-notebook"></div>
 | 
			
		||||
                    <div class="c-object-label__type-icon icon-camera"></div>
 | 
			
		||||
                    <div class="c-object-label__name">
 | 
			
		||||
                        Notebook Snapshots
 | 
			
		||||
                        <span v-if="snapshots.length"
 | 
			
		||||
 
 | 
			
		||||
@@ -1,5 +1,5 @@
 | 
			
		||||
<template>
 | 
			
		||||
<div class="c-indicator c-indicator--clickable icon-notebook"
 | 
			
		||||
<div class="c-indicator c-indicator--clickable icon-camera"
 | 
			
		||||
     :class="[
 | 
			
		||||
         { 's-status-off': snapshotCount === 0 },
 | 
			
		||||
         { 's-status-on': snapshotCount > 0 },
 | 
			
		||||
 
 | 
			
		||||
@@ -66,14 +66,10 @@ export default {
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    },
 | 
			
		||||
    data() {
 | 
			
		||||
        return {
 | 
			
		||||
        };
 | 
			
		||||
    },
 | 
			
		||||
    methods: {
 | 
			
		||||
        deletePage(id) {
 | 
			
		||||
            const selectedSection = this.sections.find(s => s.isSelected);
 | 
			
		||||
            const page = this.pages.filter(p => p.id !== id);
 | 
			
		||||
            const page = this.pages.find(p => p.id !== id);
 | 
			
		||||
            deleteNotebookEntries(this.openmct, this.domainObject, selectedSection, page);
 | 
			
		||||
 | 
			
		||||
            const selectedPage = this.pages.find(p => p.isSelected);
 | 
			
		||||
 
 | 
			
		||||
@@ -53,10 +53,6 @@ export default {
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    },
 | 
			
		||||
    data() {
 | 
			
		||||
        return {
 | 
			
		||||
        };
 | 
			
		||||
    },
 | 
			
		||||
    methods: {
 | 
			
		||||
        deleteSection(id) {
 | 
			
		||||
            const section = this.sections.find(s => s.id === id);
 | 
			
		||||
 
 | 
			
		||||
@@ -18,7 +18,7 @@
 | 
			
		||||
                               :domain-object="domainObject"
 | 
			
		||||
                               :sections="sections"
 | 
			
		||||
                               :section-title="sectionTitle"
 | 
			
		||||
                               @updateSection="updateSection"
 | 
			
		||||
                               @updateSection="sectionsChanged"
 | 
			
		||||
            />
 | 
			
		||||
        </div>
 | 
			
		||||
    </div>
 | 
			
		||||
@@ -48,7 +48,7 @@
 | 
			
		||||
                            :sidebar-covers-entries="sidebarCoversEntries"
 | 
			
		||||
                            :page-title="pageTitle"
 | 
			
		||||
                            @toggleNav="toggleNav"
 | 
			
		||||
                            @updatePage="updatePage"
 | 
			
		||||
                            @updatePage="pagesChanged"
 | 
			
		||||
            />
 | 
			
		||||
        </div>
 | 
			
		||||
    </div>
 | 
			
		||||
@@ -85,13 +85,6 @@ export default {
 | 
			
		||||
                return {};
 | 
			
		||||
            }
 | 
			
		||||
        },
 | 
			
		||||
        pages: {
 | 
			
		||||
            type: Array,
 | 
			
		||||
            required: true,
 | 
			
		||||
            default() {
 | 
			
		||||
                return [];
 | 
			
		||||
            }
 | 
			
		||||
        },
 | 
			
		||||
        pageTitle: {
 | 
			
		||||
            type: String,
 | 
			
		||||
            default() {
 | 
			
		||||
@@ -122,9 +115,16 @@ export default {
 | 
			
		||||
        return {
 | 
			
		||||
        };
 | 
			
		||||
    },
 | 
			
		||||
    computed: {
 | 
			
		||||
        pages() {
 | 
			
		||||
            const selectedSection = this.sections.find(section => section.isSelected);
 | 
			
		||||
 | 
			
		||||
            return selectedSection && selectedSection.pages || [];
 | 
			
		||||
        }
 | 
			
		||||
    },
 | 
			
		||||
    watch: {
 | 
			
		||||
        pages(newpages) {
 | 
			
		||||
            if (!newpages.length) {
 | 
			
		||||
        pages(newPages) {
 | 
			
		||||
            if (!newPages.length) {
 | 
			
		||||
                this.addPage();
 | 
			
		||||
            }
 | 
			
		||||
        },
 | 
			
		||||
@@ -141,55 +141,79 @@ export default {
 | 
			
		||||
    },
 | 
			
		||||
    methods: {
 | 
			
		||||
        addPage() {
 | 
			
		||||
            const newPage = this.createNewPage();
 | 
			
		||||
            const pages = this.addNewPage(newPage);
 | 
			
		||||
 | 
			
		||||
            this.pagesChanged({
 | 
			
		||||
                pages,
 | 
			
		||||
                id: newPage.id
 | 
			
		||||
            });
 | 
			
		||||
        },
 | 
			
		||||
        addSection() {
 | 
			
		||||
            const newSection = this.createNewSection();
 | 
			
		||||
            const sections = this.addNewSection(newSection);
 | 
			
		||||
 | 
			
		||||
            this.sectionsChanged({
 | 
			
		||||
                sections,
 | 
			
		||||
                id: newSection.id
 | 
			
		||||
            });
 | 
			
		||||
        },
 | 
			
		||||
        addNewPage(page) {
 | 
			
		||||
            const pages = this.pages.map(p => {
 | 
			
		||||
                p.isSelected = false;
 | 
			
		||||
 | 
			
		||||
                return p;
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            return pages.concat(page);
 | 
			
		||||
        },
 | 
			
		||||
        addNewSection(section) {
 | 
			
		||||
            const sections = this.sections.map(s => {
 | 
			
		||||
                s.isSelected = false;
 | 
			
		||||
 | 
			
		||||
                return s;
 | 
			
		||||
            });
 | 
			
		||||
 | 
			
		||||
            return sections.concat(section);
 | 
			
		||||
        },
 | 
			
		||||
        createNewPage() {
 | 
			
		||||
            const pageTitle = this.pageTitle;
 | 
			
		||||
            const id = uuid();
 | 
			
		||||
            const page = {
 | 
			
		||||
 | 
			
		||||
            return {
 | 
			
		||||
                id,
 | 
			
		||||
                isDefault: false,
 | 
			
		||||
                isSelected: true,
 | 
			
		||||
                name: `Unnamed ${pageTitle}`,
 | 
			
		||||
                pageTitle
 | 
			
		||||
            };
 | 
			
		||||
 | 
			
		||||
            this.pages.forEach(p => p.isSelected = false);
 | 
			
		||||
            const pages = this.pages.concat(page);
 | 
			
		||||
 | 
			
		||||
            this.updatePage({
 | 
			
		||||
                pages,
 | 
			
		||||
                id
 | 
			
		||||
            });
 | 
			
		||||
        },
 | 
			
		||||
        addSection() {
 | 
			
		||||
        createNewSection() {
 | 
			
		||||
            const sectionTitle = this.sectionTitle;
 | 
			
		||||
            const id = uuid();
 | 
			
		||||
            const section = {
 | 
			
		||||
            const page = this.createNewPage();
 | 
			
		||||
            const pages = [page];
 | 
			
		||||
 | 
			
		||||
            return {
 | 
			
		||||
                id,
 | 
			
		||||
                isDefault: false,
 | 
			
		||||
                isSelected: true,
 | 
			
		||||
                name: `Unnamed ${sectionTitle}`,
 | 
			
		||||
                pages: [],
 | 
			
		||||
                pages,
 | 
			
		||||
                sectionTitle
 | 
			
		||||
            };
 | 
			
		||||
 | 
			
		||||
            this.sections.forEach(s => s.isSelected = false);
 | 
			
		||||
            const sections = this.sections.concat(section);
 | 
			
		||||
 | 
			
		||||
            this.updateSection({
 | 
			
		||||
                sections,
 | 
			
		||||
                id
 | 
			
		||||
            });
 | 
			
		||||
        },
 | 
			
		||||
        toggleNav() {
 | 
			
		||||
            this.$emit('toggleNav');
 | 
			
		||||
        },
 | 
			
		||||
        updatePage({ pages, id }) {
 | 
			
		||||
            this.$emit('updatePage', {
 | 
			
		||||
        pagesChanged({ pages, id }) {
 | 
			
		||||
            this.$emit('pagesChanged', {
 | 
			
		||||
                pages,
 | 
			
		||||
                id
 | 
			
		||||
            });
 | 
			
		||||
        },
 | 
			
		||||
        updateSection({ sections, id }) {
 | 
			
		||||
            this.$emit('updateSection', {
 | 
			
		||||
        sectionsChanged({ sections, id }) {
 | 
			
		||||
            this.$emit('sectionsChanged', {
 | 
			
		||||
                sections,
 | 
			
		||||
                id
 | 
			
		||||
            });
 | 
			
		||||
 
 | 
			
		||||
@@ -1,3 +1,4 @@
 | 
			
		||||
import CopyToNotebookAction from './actions/CopyToNotebookAction';
 | 
			
		||||
import Notebook from './components/Notebook.vue';
 | 
			
		||||
import NotebookSnapshotIndicator from './components/NotebookSnapshotIndicator.vue';
 | 
			
		||||
import SnapshotContainer from './snapshot-container';
 | 
			
		||||
@@ -13,6 +14,8 @@ export default function NotebookPlugin() {
 | 
			
		||||
 | 
			
		||||
        installed = true;
 | 
			
		||||
 | 
			
		||||
        openmct.actions.register(new CopyToNotebookAction(openmct));
 | 
			
		||||
 | 
			
		||||
        const notebookType = {
 | 
			
		||||
            name: 'Notebook',
 | 
			
		||||
            description: 'Create and save timestamped notes with embedded object snapshots.',
 | 
			
		||||
 
 | 
			
		||||
@@ -139,7 +139,7 @@ describe("Notebook plugin:", () => {
 | 
			
		||||
        let drawerElement;
 | 
			
		||||
 | 
			
		||||
        function clickSnapshotIndicator() {
 | 
			
		||||
            const indicator = element.querySelector('.icon-notebook');
 | 
			
		||||
            const indicator = element.querySelector('.icon-camera');
 | 
			
		||||
            const button = indicator.querySelector('button');
 | 
			
		||||
            const clickEvent = createMouseEvent('click');
 | 
			
		||||
 | 
			
		||||
@@ -157,8 +157,11 @@ describe("Notebook plugin:", () => {
 | 
			
		||||
 | 
			
		||||
        afterAll(() => {
 | 
			
		||||
            snapshotIndicator.remove();
 | 
			
		||||
            snapshotIndicator = undefined;
 | 
			
		||||
 | 
			
		||||
            if (drawerElement) {
 | 
			
		||||
                drawerElement.remove();
 | 
			
		||||
                drawerElement = undefined;
 | 
			
		||||
            }
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
@@ -185,10 +188,8 @@ describe("Notebook plugin:", () => {
 | 
			
		||||
            classes = drawerElement.classList;
 | 
			
		||||
            const isExpandedAfterFirstClick = classes.contains('is-expanded');
 | 
			
		||||
 | 
			
		||||
            const success = isExpandedBefore === false
 | 
			
		||||
                && isExpandedAfterFirstClick === true;
 | 
			
		||||
 | 
			
		||||
            expect(success).toBe(true);
 | 
			
		||||
            expect(isExpandedBefore).toBeFalse();
 | 
			
		||||
            expect(isExpandedAfterFirstClick).toBeTrue();
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("snapshots container does not have class isExpanded", () => {
 | 
			
		||||
@@ -203,11 +204,9 @@ describe("Notebook plugin:", () => {
 | 
			
		||||
            classes = drawerElement.classList;
 | 
			
		||||
            const isExpandedAfterSecondClick = classes.contains('is-expanded');
 | 
			
		||||
 | 
			
		||||
            const success = isExpandedBefore === false
 | 
			
		||||
                && isExpandedAfterFirstClick === true
 | 
			
		||||
                && isExpandedAfterSecondClick === false;
 | 
			
		||||
 | 
			
		||||
            expect(success).toBe(true);
 | 
			
		||||
            expect(isExpandedBefore).toBeFalse();
 | 
			
		||||
            expect(isExpandedAfterFirstClick).toBeTrue();
 | 
			
		||||
            expect(isExpandedAfterSecondClick).toBeFalse();
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        it("show notebook snapshots container text", () => {
 | 
			
		||||
 
 | 
			
		||||
@@ -7,15 +7,14 @@ export default class Snapshot {
 | 
			
		||||
    constructor(openmct) {
 | 
			
		||||
        this.openmct = openmct;
 | 
			
		||||
        this.snapshotContainer = new SnapshotContainer(openmct);
 | 
			
		||||
        this.exportImageService = openmct.$injector.get('exportImageService');
 | 
			
		||||
        this.dialogService = openmct.$injector.get('dialogService');
 | 
			
		||||
 | 
			
		||||
        this.capture = this.capture.bind(this);
 | 
			
		||||
        this._saveSnapShot = this._saveSnapShot.bind(this);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    capture(snapshotMeta, notebookType, domElement) {
 | 
			
		||||
        this.exportImageService.exportPNGtoSRC(domElement, 's-status-taking-snapshot')
 | 
			
		||||
        const exportImageService = this.openmct.$injector.get('exportImageService');
 | 
			
		||||
        exportImageService.exportPNGtoSRC(domElement, 's-status-taking-snapshot')
 | 
			
		||||
            .then(function (blob) {
 | 
			
		||||
                const reader = new window.FileReader();
 | 
			
		||||
                reader.readAsDataURL(blob);
 | 
			
		||||
@@ -49,7 +48,7 @@ export default class Snapshot {
 | 
			
		||||
            .then(domainObject => {
 | 
			
		||||
                addNotebookEntry(this.openmct, domainObject, notebookStorage, embed);
 | 
			
		||||
 | 
			
		||||
                const defaultPath = `${domainObject.name} > ${notebookStorage.section.name} > ${notebookStorage.page.name}`;
 | 
			
		||||
                const defaultPath = `${domainObject.name} - ${notebookStorage.section.name} - ${notebookStorage.page.name}`;
 | 
			
		||||
                const msg = `Saved to Notebook ${defaultPath}`;
 | 
			
		||||
                this._showNotification(msg);
 | 
			
		||||
            });
 | 
			
		||||
 
 | 
			
		||||
@@ -1,6 +1,6 @@
 | 
			
		||||
import objectLink from '../../../ui/mixins/object-link';
 | 
			
		||||
 | 
			
		||||
export const DEFAULT_CLASS = 'is-notebook-default';
 | 
			
		||||
export const DEFAULT_CLASS = 'notebook-default';
 | 
			
		||||
const TIME_BOUNDS = {
 | 
			
		||||
    START_BOUND: 'tc.startBound',
 | 
			
		||||
    END_BOUND: 'tc.endBound',
 | 
			
		||||
@@ -8,6 +8,29 @@ const TIME_BOUNDS = {
 | 
			
		||||
    END_DELTA: 'tc.endDelta'
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
export function addEntryIntoPage(notebookStorage, entries, entry) {
 | 
			
		||||
    const defaultSection = notebookStorage.section;
 | 
			
		||||
    const defaultPage = notebookStorage.page;
 | 
			
		||||
    if (!defaultSection || !defaultPage) {
 | 
			
		||||
        return;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    const newEntries = JSON.parse(JSON.stringify(entries));
 | 
			
		||||
    let section = newEntries[defaultSection.id];
 | 
			
		||||
    if (!section) {
 | 
			
		||||
        newEntries[defaultSection.id] = {};
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    let page = newEntries[defaultSection.id][defaultPage.id];
 | 
			
		||||
    if (!page) {
 | 
			
		||||
        newEntries[defaultSection.id][defaultPage.id] = [];
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    newEntries[defaultSection.id][defaultPage.id].push(entry);
 | 
			
		||||
 | 
			
		||||
    return newEntries;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
export function getHistoricLinkInFixedMode(openmct, bounds, historicLink) {
 | 
			
		||||
    if (historicLink.includes('tc.mode=fixed')) {
 | 
			
		||||
        return historicLink;
 | 
			
		||||
@@ -38,35 +61,6 @@ export function getHistoricLinkInFixedMode(openmct, bounds, historicLink) {
 | 
			
		||||
    return params.join('&');
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
export function getNotebookDefaultEntries(notebookStorage, domainObject) {
 | 
			
		||||
    if (!notebookStorage || !domainObject) {
 | 
			
		||||
        return null;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    const defaultSection = notebookStorage.section;
 | 
			
		||||
    const defaultPage = notebookStorage.page;
 | 
			
		||||
    if (!defaultSection || !defaultPage) {
 | 
			
		||||
        return null;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    const configuration = domainObject.configuration;
 | 
			
		||||
    const entries = configuration.entries || {};
 | 
			
		||||
 | 
			
		||||
    let section = entries[defaultSection.id];
 | 
			
		||||
    if (!section) {
 | 
			
		||||
        section = {};
 | 
			
		||||
        entries[defaultSection.id] = section;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    let page = entries[defaultSection.id][defaultPage.id];
 | 
			
		||||
    if (!page) {
 | 
			
		||||
        page = [];
 | 
			
		||||
        entries[defaultSection.id][defaultPage.id] = [];
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    return entries[defaultSection.id][defaultPage.id];
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
export function createNewEmbed(snapshotMeta, snapshot = '') {
 | 
			
		||||
    const {
 | 
			
		||||
        bounds,
 | 
			
		||||
@@ -103,7 +97,7 @@ export function createNewEmbed(snapshotMeta, snapshot = '') {
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
export function addNotebookEntry(openmct, domainObject, notebookStorage, embed = null) {
 | 
			
		||||
export function addNotebookEntry(openmct, domainObject, notebookStorage, embed = null, entryText = '') {
 | 
			
		||||
    if (!openmct || !domainObject || !notebookStorage) {
 | 
			
		||||
        return;
 | 
			
		||||
    }
 | 
			
		||||
@@ -120,24 +114,25 @@ export function addNotebookEntry(openmct, domainObject, notebookStorage, embed =
 | 
			
		||||
        ? [embed]
 | 
			
		||||
        : [];
 | 
			
		||||
 | 
			
		||||
    const defaultEntries = getNotebookDefaultEntries(notebookStorage, domainObject);
 | 
			
		||||
    const id = `entry-${date}`;
 | 
			
		||||
    defaultEntries.push({
 | 
			
		||||
    const entry = {
 | 
			
		||||
        id,
 | 
			
		||||
        createdOn: date,
 | 
			
		||||
        text: '',
 | 
			
		||||
        text: entryText,
 | 
			
		||||
        embeds
 | 
			
		||||
    });
 | 
			
		||||
    };
 | 
			
		||||
 | 
			
		||||
    addDefaultClass(domainObject);
 | 
			
		||||
    openmct.objects.mutate(domainObject, 'configuration.entries', entries);
 | 
			
		||||
    const newEntries = addEntryIntoPage(notebookStorage, entries, entry);
 | 
			
		||||
 | 
			
		||||
    addDefaultClass(domainObject, openmct);
 | 
			
		||||
    openmct.objects.mutate(domainObject, 'configuration.entries', newEntries);
 | 
			
		||||
 | 
			
		||||
    return id;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
export function getNotebookEntries(domainObject, selectedSection, selectedPage) {
 | 
			
		||||
    if (!domainObject || !selectedSection || !selectedPage) {
 | 
			
		||||
        return null;
 | 
			
		||||
        return;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    const configuration = domainObject.configuration;
 | 
			
		||||
@@ -145,12 +140,12 @@ export function getNotebookEntries(domainObject, selectedSection, selectedPage)
 | 
			
		||||
 | 
			
		||||
    let section = entries[selectedSection.id];
 | 
			
		||||
    if (!section) {
 | 
			
		||||
        return null;
 | 
			
		||||
        return;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    let page = entries[selectedSection.id][selectedPage.id];
 | 
			
		||||
    if (!page) {
 | 
			
		||||
        return null;
 | 
			
		||||
        return;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    return entries[selectedSection.id][selectedPage.id];
 | 
			
		||||
@@ -196,14 +191,13 @@ export function deleteNotebookEntries(openmct, domainObject, selectedSection, se
 | 
			
		||||
 | 
			
		||||
    delete entries[selectedSection.id][selectedPage.id];
 | 
			
		||||
 | 
			
		||||
    openmct.objects.mutate(domainObject, 'configuration.entries', entries);
 | 
			
		||||
    mutateObject(openmct, domainObject, 'configuration.entries', entries);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
function addDefaultClass(domainObject) {
 | 
			
		||||
    const classList = domainObject.classList || [];
 | 
			
		||||
    if (classList.includes(DEFAULT_CLASS)) {
 | 
			
		||||
        return;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    classList.push(DEFAULT_CLASS);
 | 
			
		||||
export function mutateObject(openmct, object, key, value) {
 | 
			
		||||
    openmct.objects.mutate(object, key, value);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
function addDefaultClass(domainObject, openmct) {
 | 
			
		||||
    openmct.status.set(domainObject.identifier, DEFAULT_CLASS);
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -20,16 +20,9 @@
 | 
			
		||||
 * at runtime from the About dialog for additional information.
 | 
			
		||||
 *****************************************************************************/
 | 
			
		||||
import * as NotebookEntries from './notebook-entries';
 | 
			
		||||
import { createOpenMct, spyOnBuiltins, resetApplicationState } from 'utils/testing';
 | 
			
		||||
import { createOpenMct, resetApplicationState } from 'utils/testing';
 | 
			
		||||
 | 
			
		||||
const notebookStorage = {
 | 
			
		||||
    domainObject: {
 | 
			
		||||
        name: 'notebook',
 | 
			
		||||
        identifier: {
 | 
			
		||||
            namespace: '',
 | 
			
		||||
            key: 'test-notebook'
 | 
			
		||||
        }
 | 
			
		||||
    },
 | 
			
		||||
    notebookMeta: {
 | 
			
		||||
        name: 'notebook',
 | 
			
		||||
        identifier: {
 | 
			
		||||
@@ -121,7 +114,6 @@ describe('Notebook Entries:', () => {
 | 
			
		||||
    beforeEach(done => {
 | 
			
		||||
        openmct = createOpenMct();
 | 
			
		||||
        window.localStorage.setItem('notebook-storage', null);
 | 
			
		||||
        spyOnBuiltins(['mutate'], openmct.objects);
 | 
			
		||||
 | 
			
		||||
        done();
 | 
			
		||||
    });
 | 
			
		||||
@@ -137,24 +129,16 @@ describe('Notebook Entries:', () => {
 | 
			
		||||
        expect(entries.length).toEqual(0);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it('addNotebookEntry mutates object', () => {
 | 
			
		||||
    it('addNotebookEntry adds entry', (done) => {
 | 
			
		||||
        const unlisten = openmct.objects.observe(notebookDomainObject, '*', (object) => {
 | 
			
		||||
            const entries = NotebookEntries.getNotebookEntries(notebookDomainObject, selectedSection, selectedPage);
 | 
			
		||||
 | 
			
		||||
            expect(entries.length).toEqual(1);
 | 
			
		||||
            done();
 | 
			
		||||
            unlisten();
 | 
			
		||||
        });
 | 
			
		||||
 | 
			
		||||
        NotebookEntries.addNotebookEntry(openmct, notebookDomainObject, notebookStorage);
 | 
			
		||||
 | 
			
		||||
        expect(openmct.objects.mutate).toHaveBeenCalled();
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it('addNotebookEntry adds entry', () => {
 | 
			
		||||
        NotebookEntries.addNotebookEntry(openmct, notebookDomainObject, notebookStorage);
 | 
			
		||||
        const entries = NotebookEntries.getNotebookEntries(notebookDomainObject, selectedSection, selectedPage);
 | 
			
		||||
 | 
			
		||||
        expect(entries.length).toEqual(1);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it('getEntryPosById returns valid position', () => {
 | 
			
		||||
        const entryId = NotebookEntries.addNotebookEntry(openmct, notebookDomainObject, notebookStorage);
 | 
			
		||||
        const position = NotebookEntries.getEntryPosById(entryId, notebookDomainObject, selectedSection, selectedPage);
 | 
			
		||||
 | 
			
		||||
        expect(position).toEqual(0);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it('getEntryPosById returns valid position', () => {
 | 
			
		||||
@@ -174,22 +158,13 @@ describe('Notebook Entries:', () => {
 | 
			
		||||
        expect(success).toBe(true);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it('deleteNotebookEntries mutates object', () => {
 | 
			
		||||
        openmct.objects.mutate.calls.reset();
 | 
			
		||||
 | 
			
		||||
        NotebookEntries.addNotebookEntry(openmct, notebookDomainObject, notebookStorage);
 | 
			
		||||
        NotebookEntries.deleteNotebookEntries(openmct, notebookDomainObject, selectedSection, selectedPage);
 | 
			
		||||
 | 
			
		||||
        expect(openmct.objects.mutate).toHaveBeenCalledTimes(2);
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it('deleteNotebookEntries deletes correct entry', () => {
 | 
			
		||||
    it('deleteNotebookEntries deletes correct page entries', () => {
 | 
			
		||||
        NotebookEntries.addNotebookEntry(openmct, notebookDomainObject, notebookStorage);
 | 
			
		||||
        NotebookEntries.addNotebookEntry(openmct, notebookDomainObject, notebookStorage);
 | 
			
		||||
 | 
			
		||||
        NotebookEntries.deleteNotebookEntries(openmct, notebookDomainObject, selectedSection, selectedPage);
 | 
			
		||||
        const afterEntries = NotebookEntries.getNotebookEntries(notebookDomainObject, selectedSection, selectedPage);
 | 
			
		||||
 | 
			
		||||
        expect(afterEntries).toEqual(null);
 | 
			
		||||
        expect(afterEntries).toEqual(undefined);
 | 
			
		||||
    });
 | 
			
		||||
});
 | 
			
		||||
 
 | 
			
		||||
@@ -1,13 +1,12 @@
 | 
			
		||||
import objectUtils from 'objectUtils';
 | 
			
		||||
 | 
			
		||||
const NOTEBOOK_LOCAL_STORAGE = 'notebook-storage';
 | 
			
		||||
let currentNotebookObject = null;
 | 
			
		||||
let currentNotebookObjectIdentifier = null;
 | 
			
		||||
let unlisten = null;
 | 
			
		||||
 | 
			
		||||
function defaultNotebookObjectChanged(newDomainObject) {
 | 
			
		||||
    if (newDomainObject.location !== null) {
 | 
			
		||||
        currentNotebookObject = newDomainObject;
 | 
			
		||||
        const notebookStorage = getDefaultNotebook();
 | 
			
		||||
        notebookStorage.domainObject = newDomainObject;
 | 
			
		||||
        saveDefaultNotebook(notebookStorage);
 | 
			
		||||
        currentNotebookObjectIdentifier = newDomainObject.identifier;
 | 
			
		||||
 | 
			
		||||
        return;
 | 
			
		||||
    }
 | 
			
		||||
@@ -20,10 +19,9 @@ function defaultNotebookObjectChanged(newDomainObject) {
 | 
			
		||||
    clearDefaultNotebook();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
function observeDefaultNotebookObject(openmct, notebookStorage) {
 | 
			
		||||
    const domainObject = notebookStorage.domainObject;
 | 
			
		||||
    if (currentNotebookObject
 | 
			
		||||
            && currentNotebookObject.identifier.key === domainObject.identifier.key) {
 | 
			
		||||
function observeDefaultNotebookObject(openmct, notebookMeta, domainObject) {
 | 
			
		||||
    if (currentNotebookObjectIdentifier
 | 
			
		||||
            && objectUtils.makeKeyString(currentNotebookObjectIdentifier) === objectUtils.makeKeyString(notebookMeta.identifier)) {
 | 
			
		||||
        return;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
@@ -32,7 +30,7 @@ function observeDefaultNotebookObject(openmct, notebookStorage) {
 | 
			
		||||
        unlisten = null;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    unlisten = openmct.objects.observe(notebookStorage.domainObject, '*', defaultNotebookObjectChanged);
 | 
			
		||||
    unlisten = openmct.objects.observe(domainObject, '*', defaultNotebookObjectChanged);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
function saveDefaultNotebook(notebookStorage) {
 | 
			
		||||
@@ -40,7 +38,7 @@ function saveDefaultNotebook(notebookStorage) {
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
export function clearDefaultNotebook() {
 | 
			
		||||
    currentNotebookObject = null;
 | 
			
		||||
    currentNotebookObjectIdentifier = null;
 | 
			
		||||
    window.localStorage.setItem(NOTEBOOK_LOCAL_STORAGE, null);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@@ -50,8 +48,8 @@ export function getDefaultNotebook() {
 | 
			
		||||
    return JSON.parse(notebookStorage);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
export function setDefaultNotebook(openmct, notebookStorage) {
 | 
			
		||||
    observeDefaultNotebookObject(openmct, notebookStorage);
 | 
			
		||||
export function setDefaultNotebook(openmct, notebookStorage, domainObject) {
 | 
			
		||||
    observeDefaultNotebookObject(openmct, notebookStorage.notebookMeta, domainObject);
 | 
			
		||||
    saveDefaultNotebook(notebookStorage);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@@ -67,3 +65,24 @@ export function setDefaultNotebookPage(page) {
 | 
			
		||||
    notebookStorage.page = page;
 | 
			
		||||
    saveDefaultNotebook(notebookStorage);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
export function validateNotebookStorageObject() {
 | 
			
		||||
    const notebookStorage = getDefaultNotebook();
 | 
			
		||||
 | 
			
		||||
    let valid = false;
 | 
			
		||||
    if (notebookStorage) {
 | 
			
		||||
        Object.entries(notebookStorage).forEach(([key, value]) => {
 | 
			
		||||
            const validKey = key !== undefined && key !== null;
 | 
			
		||||
            const validValue = value !== undefined && value !== null;
 | 
			
		||||
            valid = validKey && validValue;
 | 
			
		||||
        });
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    if (valid) {
 | 
			
		||||
        return notebookStorage;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    console.warn('Invalid Notebook object, clearing default notebook storage');
 | 
			
		||||
 | 
			
		||||
    clearDefaultNotebook();
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -23,14 +23,15 @@
 | 
			
		||||
import * as NotebookStorage from './notebook-storage';
 | 
			
		||||
import { createOpenMct, resetApplicationState } from 'utils/testing';
 | 
			
		||||
 | 
			
		||||
const domainObject = {
 | 
			
		||||
    name: 'notebook',
 | 
			
		||||
    identifier: {
 | 
			
		||||
        namespace: '',
 | 
			
		||||
        key: 'test-notebook'
 | 
			
		||||
    }
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
const notebookStorage = {
 | 
			
		||||
    domainObject: {
 | 
			
		||||
        name: 'notebook',
 | 
			
		||||
        identifier: {
 | 
			
		||||
            namespace: '',
 | 
			
		||||
            key: 'test-notebook'
 | 
			
		||||
        }
 | 
			
		||||
    },
 | 
			
		||||
    notebookMeta: {
 | 
			
		||||
        name: 'notebook',
 | 
			
		||||
        identifier: {
 | 
			
		||||
@@ -82,7 +83,7 @@ describe('Notebook Storage:', () => {
 | 
			
		||||
    });
 | 
			
		||||
 | 
			
		||||
    it('has correct notebookstorage on setDefaultNotebook', () => {
 | 
			
		||||
        NotebookStorage.setDefaultNotebook(openmct, notebookStorage);
 | 
			
		||||
        NotebookStorage.setDefaultNotebook(openmct, notebookStorage, domainObject);
 | 
			
		||||
        const defaultNotebook = NotebookStorage.getDefaultNotebook();
 | 
			
		||||
 | 
			
		||||
        expect(JSON.stringify(defaultNotebook)).toBe(JSON.stringify(notebookStorage));
 | 
			
		||||
@@ -98,7 +99,7 @@ describe('Notebook Storage:', () => {
 | 
			
		||||
            sectionTitle: 'Section'
 | 
			
		||||
        };
 | 
			
		||||
 | 
			
		||||
        NotebookStorage.setDefaultNotebook(openmct, notebookStorage);
 | 
			
		||||
        NotebookStorage.setDefaultNotebook(openmct, notebookStorage, domainObject);
 | 
			
		||||
        NotebookStorage.setDefaultNotebookSection(section);
 | 
			
		||||
 | 
			
		||||
        const defaultNotebook = NotebookStorage.getDefaultNotebook();
 | 
			
		||||
@@ -115,7 +116,7 @@ describe('Notebook Storage:', () => {
 | 
			
		||||
            pageTitle: 'Page'
 | 
			
		||||
        };
 | 
			
		||||
 | 
			
		||||
        NotebookStorage.setDefaultNotebook(openmct, notebookStorage);
 | 
			
		||||
        NotebookStorage.setDefaultNotebook(openmct, notebookStorage, domainObject);
 | 
			
		||||
        NotebookStorage.setDefaultNotebookPage(page);
 | 
			
		||||
 | 
			
		||||
        const defaultNotebook = NotebookStorage.getDefaultNotebook();
 | 
			
		||||
 
 | 
			
		||||
Some files were not shown because too many files have changed in this diff Show More
		Reference in New Issue
	
	Block a user