mirror of
https://github.com/nasa/openmct.git
synced 2024-12-21 06:03:08 +00:00
92737b43af
Changes how object mutation works behind the scenes in order to keep objects in sync automatically when their model changes. * The way that objects are mutated and observed has not changed, openmct.objects.mutate and openmct.objects.observe should still be used in the same way that they were before. * Behind the scenes, domain objects that are mutable are wrapped in a new MutableDomainObject that exposes mutator and observer functions that allow objects to be mutated in such a way that all instances can be kept in sync. * It is now possible to retrieve MutableDomainObjects from the API, instead of regular domain objects. These are automatically updated when mutation occurs on any instance of the object, replacing the need for "*" listeners. Note that the view API now provides objects in this form by default. Therefore, you do not need to do anything differently in views, the domain objects will just magically keep themselves up to date. * If for some reason you need to retrieve an object manually via openmct.objects.get (you should ask why you need to do this) and you want it to magically keep itself in sync, there is a new API function named openmct.objects.getMutable(identifier). Note that if you do this you will be responsible for the object's lifecycle. It relies on listeners which must be destroyed when the object is no longer needed, otherwise memory leaks will occur. You can destroy a MutableDomainObject and its (internal) listeners by calling openmct.objects.destroyMutable(mutableDomainObject). Any listeners created by calls to openmct.objects.observe need to be cleaned up separately. * If the composition of a MutableDomainObject is retrieved using the Composition API, all children will be returned as MutableDomainObjects automatically. Their lifecycle will be managed automatically, and is tied to the lifecycle of the parent. Any MutableDomainObject provided by the Open MCT framework itself (eg. provided to view providers by the View API, or from the composition API) will have its lifecycle managed by Open MCT, you don't need to worry destroying it.
86 lines
3.9 KiB
JavaScript
86 lines
3.9 KiB
JavaScript
/*****************************************************************************
|
|
* Open MCT, Copyright (c) 2014-2016, 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/PersistableCompositionPolicy"],
|
|
function (PersistableCompositionPolicy) {
|
|
describe("Persistable Composition policy", function () {
|
|
var objectAPI;
|
|
var mockOpenMCT;
|
|
var persistableCompositionPolicy;
|
|
var mockParent;
|
|
var mockChild;
|
|
var mockEditorCapability;
|
|
|
|
beforeEach(function () {
|
|
objectAPI = jasmine.createSpyObj('objectsAPI', [
|
|
'isPersistable',
|
|
'parseKeyString'
|
|
]);
|
|
|
|
mockOpenMCT = {
|
|
objects: objectAPI
|
|
};
|
|
mockParent = jasmine.createSpyObj('domainObject', [
|
|
'hasCapability',
|
|
'getCapability',
|
|
'getId'
|
|
]);
|
|
mockParent.hasCapability.and.returnValue(true);
|
|
mockParent.getId.and.returnValue('someNamespace:someId');
|
|
mockChild = {};
|
|
mockEditorCapability = jasmine.createSpyObj('domainObject', [
|
|
'isEditContextRoot'
|
|
]);
|
|
mockParent.getCapability.and.returnValue(mockEditorCapability);
|
|
persistableCompositionPolicy = new PersistableCompositionPolicy(mockOpenMCT);
|
|
});
|
|
|
|
//Parent
|
|
// - getCapability ('editor')
|
|
// - isEditContextRoot
|
|
// - openMct.objects.getProvider
|
|
|
|
it("Does not allow composition for objects that are not persistable", function () {
|
|
mockEditorCapability.isEditContextRoot.and.returnValue(false);
|
|
objectAPI.isPersistable.and.returnValue(true);
|
|
expect(persistableCompositionPolicy.allow(mockParent, mockChild)).toBe(true);
|
|
objectAPI.isPersistable.and.returnValue(false);
|
|
expect(persistableCompositionPolicy.allow(mockParent, mockChild)).toBe(false);
|
|
});
|
|
|
|
it("Always allows composition of objects in edit mode to support object creation", function () {
|
|
mockEditorCapability.isEditContextRoot.and.returnValue(true);
|
|
objectAPI.isPersistable.and.returnValue(true);
|
|
expect(persistableCompositionPolicy.allow(mockParent, mockChild)).toBe(true);
|
|
expect(objectAPI.isPersistable).not.toHaveBeenCalled();
|
|
|
|
mockEditorCapability.isEditContextRoot.and.returnValue(false);
|
|
objectAPI.isPersistable.and.returnValue(true);
|
|
expect(persistableCompositionPolicy.allow(mockParent, mockChild)).toBe(true);
|
|
expect(objectAPI.isPersistable).toHaveBeenCalled();
|
|
});
|
|
|
|
});
|
|
}
|
|
);
|