Persistence Manager

client-app/src/Bootstrap.ts

@@ -10,6 +10,7 @@
 // App Services -- Import and Register
 //-----------------------------------------------------------------
 import {XH} from '@xh/hoist/core';
+import {PersistenceManagerModel} from '@xh/hoist/core/persist/persistenceManager';
 import {when} from '@xh/hoist/mobx';
 
 import {ContactService} from './examples/contact/svc/ContactService';
@@ -24,6 +25,7 @@ declare module '@xh/hoist/core' {
         gitHubService: GitHubService;
         portfolioService: PortfolioService;
         taskService: TaskService;
+        persistenceManagerModel: PersistenceManagerModel;
     }
     // @ts-ignore - Help IntelliJ recognize uses of injected service methods on the `XH` singleton.
     export const XH: XHApi;

client-app/src/examples/portfolio/AppModel.ts

@@ -1,4 +1,5 @@
-import {XH} from '@xh/hoist/core';
+import {managed, XH} from '@xh/hoist/core';
+import {PersistenceManagerModel} from '@xh/hoist/core/persist/persistenceManager';
 import {themeAppOption, sizingModeAppOption} from '@xh/hoist/desktop/cmp/appOption';
 import {Icon} from '@xh/hoist/icon';
 import {PortfolioService} from '../../core/svc/PortfolioService';
@@ -10,10 +11,23 @@ export const PERSIST_DETAIL = {localStorageKey: 'portfolioAppDetailState'};
 export class AppModel extends BaseAppModel {
     static instance: AppModel;
 
+    @managed persistenceManagerModel;
+
     override async initAsync() {
         await super.initAsync();
         await XH.installServicesAsync(PortfolioService);
 
+        this.persistenceManagerModel = await PersistenceManagerModel.createAsync({
+            entity: {
+                name: 'PortfolioExample',
+                displayName: 'View'
+            },
+            canManageGlobal: () => XH.getUser().hasRole('GLOBAL_VIEW_MANAGER'),
+            persistWith: {prefKey: 'portfolioExample'},
+            enableDefault: true,
+            enableAutoSave: true
+        });
+
         this.addReaction({
             track: () => XH.webSocketService.connected,
             run: () => this.updateWebsocketAlertBanner()

client-app/src/examples/portfolio/GridPanel.ts

@@ -5,6 +5,7 @@ import {relativeTimestamp} from '@xh/hoist/cmp/relativetimestamp';
 import {refreshButton} from '@xh/hoist/desktop/cmp/button';
 import {groupingChooser} from '@xh/hoist/desktop/cmp/grouping';
 import {panel} from '@xh/hoist/desktop/cmp/panel';
+import {persistenceManager} from '@xh/hoist/desktop/cmp/persistenceManager';
 import {Icon} from '@xh/hoist/icon';
 import {GridPanelModel} from './GridPanelModel';
 import {PERSIST_MAIN} from './AppModel';
@@ -24,7 +25,7 @@ export const gridPanel = hoistCmp.factory({
             collapsedTitle,
             collapsedIcon: Icon.treeList(),
             compactHeader: true,
-            tbar: [groupingChooser({flex: 1, icon: Icon.treeList()})],
+            tbar: [persistenceManager(), groupingChooser({flex: 1, icon: Icon.treeList()})],
             item: grid({agOptions: {groupDefaultExpanded: 1}}),
             bbar: [
                 gridCountLabel({unit: 'position'}),

client-app/src/examples/portfolio/GridPanelModel.ts

@@ -1,16 +1,14 @@
 import {HoistModel, managed} from '@xh/hoist/core';
-import {bindable, makeObservable} from '@xh/hoist/mobx';
+import {action, bindable, makeObservable} from '@xh/hoist/mobx';
 import {GridModel, TreeStyle} from '@xh/hoist/cmp/grid';
-import {PERSIST_MAIN} from './AppModel';
 import {mktValCol, nameCol, pnlCol} from '../../core/columns';
 import {PortfolioPanelModel} from './PortfolioPanelModel';
 import {capitalize} from 'lodash';
 
 export class GridPanelModel extends HoistModel {
     @bindable loadTimestamp: number;
 
-    @managed
-    gridModel: GridModel;
+    @managed gridModel: GridModel;
 
     parentModel: PortfolioPanelModel;
 
@@ -22,16 +20,34 @@ export class GridPanelModel extends HoistModel {
         return this.parentModel.groupingChooserModel.value.map(it => capitalize(it)).join(' › ');
     }
 
-    constructor({parentModel}) {
+    constructor({persistWith, parentModel}) {
         super();
         makeObservable(this);
         this.parentModel = parentModel;
-        this.gridModel = this.createGridModel();
+        this.gridModel = this.createGridModel(persistWith);
     }
 
-    private createGridModel() {
+    @action
+    updateState(newState) {
+        const {gridModel} = this;
+        const gridPm = gridModel.persistenceModel;
+        gridPm.state = newState.portfolioGrid;
+
+        gridPm.updateGridColumns();
+        gridPm.updateGridSort();
+    }
+
+    async clearStateAsync() {
+        await this.gridModel.restoreDefaultsAsync({skipWarning: true});
+    }
+
+    //------------------
+    // Implementation
+    //------------------
+
+    private createGridModel(persistWith) {
         return new GridModel({
-            persistWith: PERSIST_MAIN,
+            persistWith: {path: 'portfolioGrid', ...persistWith},
             treeMode: true,
             treeStyle: TreeStyle.HIGHLIGHTS_AND_BORDERS,
             sortBy: 'pnl|desc|abs',

client-app/src/examples/portfolio/PortfolioPanel.ts

@@ -1,18 +1,20 @@
-import {hframe} from '@xh/hoist/cmp/layout';
+import {hframe, placeholder} from '@xh/hoist/cmp/layout';
 import {creates, hoistCmp} from '@xh/hoist/core';
 import {panel} from '@xh/hoist/desktop/cmp/panel';
 import {detailPanel} from './detail/DetailPanel';
 import {gridPanel} from './GridPanel';
 import {mapPanel} from './MapPanel';
 import {PortfolioPanelModel} from './PortfolioPanelModel';
 
-export const portfolioPanel = hoistCmp.factory({
+export const portfolioPanel = hoistCmp.factory<PortfolioPanelModel>({
     model: creates(PortfolioPanelModel),
 
-    render() {
+    render({model}) {
         return panel({
-            mask: 'onLoad',
-            items: [hframe(gridPanel(), mapPanel()), detailPanel()]
+            mask: [model.loadModel, model.initTask],
+            items: model.persistenceManagerModel
+                ? [hframe(gridPanel(), mapPanel()), detailPanel()]
+                : placeholder()
         });
     }
 });

client-app/src/examples/portfolio/PortfolioPanelModel.ts

@@ -1,33 +1,67 @@
-import {HoistModel, managed, XH} from '@xh/hoist/core';
+import {HoistModel, managed, TaskObserver, XH} from '@xh/hoist/core';
 import {Store} from '@xh/hoist/data';
+import {bindable, makeObservable, observable} from '@xh/hoist/mobx';
+import {logInfo} from '@xh/hoist/utils/js';
 import {GridPanelModel} from './GridPanelModel';
-import {round} from 'lodash';
+import {isNil, round} from 'lodash';
 import {GroupingChooserModel} from '@xh/hoist/cmp/grouping';
-import {PERSIST_MAIN} from './AppModel';
-import {waitFor} from '@xh/hoist/promise';
+import {wait, waitFor} from '@xh/hoist/promise';
 import {SECONDS} from '@xh/hoist/utils/datetime';
+import {DetailPanelModel} from './detail/DetailPanelModel';
+import {PersistenceManagerModel} from '@xh/hoist/core/persist/persistenceManager';
+import {AppModel} from './AppModel';
 
 export class PortfolioPanelModel extends HoistModel {
     @managed session;
 
-    @managed groupingChooserModel = this.createGroupingChooserModel();
+    @managed @observable.ref persistenceManagerModel: PersistenceManagerModel =
+        AppModel.instance.persistenceManagerModel;
+    @managed groupingChooserModel: GroupingChooserModel;
     @managed store = this.createStore();
-    @managed gridPanelModel = new GridPanelModel({parentModel: this});
+    @managed gridPanelModel: GridPanelModel;
+    @managed detailPanelModel: DetailPanelModel;
+
+    @bindable.ref initError: Error;
+
+    initTask = TaskObserver.trackAll();
+
+    get prefKey(): string {
+        return 'portfolioExample';
+    }
 
     get selectedPosition() {
         return this.gridPanelModel.selectedRecord;
     }
 
     constructor() {
         super();
+        makeObservable(this);
         const wsService = XH.webSocketService;
+
+        this.groupingChooserModel = this.createGroupingChooserModel();
+        this.detailPanelModel = this.createDetailPanelModel();
+        this.gridPanelModel = this.createGridPanelModel();
+
         this.addReaction({
             track: () => [this.groupingChooserModel.value, wsService.connected],
             run: () => this.loadAsync()
         });
+        this.addReaction({
+            track: () => this.selectedPosition,
+            run: position => {
+                this.detailPanelModel.positionId = position?.id ?? null;
+            },
+            debounce: 300
+        });
+        this.addReaction({
+            track: () => this.persistenceManagerModel.value,
+            run: value => this.onViewChangeAsync(value)
+        });
     }
 
     override async doLoadAsync(loadSpec) {
+        if (!this.groupingChooserModel) return;
+
         const wsService = XH.webSocketService,
             {store, groupingChooserModel, gridPanelModel} = this,
             dims = groupingChooserModel.value;
@@ -41,6 +75,7 @@ export class PortfolioPanelModel extends HoistModel {
         );
         if (loadSpec.isStale) return;
 
+        if (!dims) return;
         session = await XH.portfolioService.getLivePositionsAsync(dims, 'mainApp').catchDefault();
 
         store.loadData([session.initialPositions.root]);
@@ -76,10 +111,50 @@ export class PortfolioPanelModel extends HoistModel {
     }
 
     private createGroupingChooserModel() {
+        const {persistenceManagerModel} = this;
         return new GroupingChooserModel({
             dimensions: ['fund', 'model', 'region', 'sector', 'symbol', 'trader'],
             initialValue: ['region', 'sector', 'symbol'],
-            persistWith: PERSIST_MAIN
+            persistWith: {persistenceManagerModel},
+            allowEmpty: true
         });
     }
+
+    private createGridPanelModel() {
+        const {persistenceManagerModel} = this;
+        return new GridPanelModel({
+            persistWith: {persistenceManagerModel},
+            parentModel: this
+        });
+    }
+
+    private createDetailPanelModel() {
+        const {persistenceManagerModel} = this;
+        return new DetailPanelModel({
+            persistWith: {persistenceManagerModel},
+            parentModel: this
+        });
+    }
+
+    private async onViewChangeAsync(value) {
+        if (!this.groupingChooserModel) return;
+
+        const start = Date.now();
+
+        await wait(); // allow masking to start
+
+        if (isNil(value)) {
+            this.groupingChooserModel.setValue(['region', 'sector', 'symbol']);
+            await this.gridPanelModel.clearStateAsync();
+            await this.detailPanelModel.clearStateAsync();
+            return;
+        }
+
+        const {gridPanelModel, detailPanelModel, groupingChooserModel} = this;
+        groupingChooserModel.setValue(value.groupingChooser?.value ?? []);
+        gridPanelModel.updateState(value);
+        detailPanelModel.updateState(value);
+
+        logInfo(`Rebuilt view | took ${Date.now() - start}ms`, this);
+    }
 }

client-app/src/examples/portfolio/detail/DetailPanel.ts

@@ -1,13 +1,13 @@
 import {hframe, placeholder} from '@xh/hoist/cmp/layout';
-import {hoistCmp, creates} from '@xh/hoist/core';
+import {hoistCmp, uses} from '@xh/hoist/core';
 import {panel} from '@xh/hoist/desktop/cmp/panel';
 import {Icon} from '@xh/hoist/icon/Icon';
 import {chartsPanel} from './charts/ChartsPanel';
 import {DetailPanelModel} from './DetailPanelModel';
 import {ordersPanel} from './OrdersPanel';
 
 export const detailPanel = hoistCmp.factory({
-    model: creates(DetailPanelModel),
+    model: uses(DetailPanelModel),
 
     render({model}) {
         const {panelSizingModel, positionId} = model;

client-app/src/examples/portfolio/detail/DetailPanelModel.ts

@@ -1,15 +1,16 @@
-import {HoistModel, lookup, managed} from '@xh/hoist/core';
+import {HoistModel, managed} from '@xh/hoist/core';
 import {observable, makeObservable} from '@xh/hoist/mobx';
 import {PanelModel} from '@xh/hoist/desktop/cmp/panel';
+import {ChartsPanelModel} from './charts/ChartsPanelModel';
 import {OrdersPanelModel} from './OrdersPanelModel';
 import {PERSIST_DETAIL} from '../AppModel';
 import {PortfolioPanelModel} from '../PortfolioPanelModel';
 
 export class DetailPanelModel extends HoistModel {
     @observable positionId = null;
 
-    @lookup(PortfolioPanelModel) parentModel;
-    @managed ordersPanelModel = new OrdersPanelModel(this);
+    @managed ordersPanelModel: OrdersPanelModel;
+    @managed chartsPanelModel: ChartsPanelModel;
 
     @managed panelSizingModel = new PanelModel({
         defaultSize: 400,
@@ -20,22 +21,24 @@ export class DetailPanelModel extends HoistModel {
         persistWith: PERSIST_DETAIL
     });
 
+    parentModel: PortfolioPanelModel;
+
     get collapsed() {
         return this.panelSizingModel.collapsed;
     }
 
-    constructor() {
+    constructor({persistWith, parentModel}) {
         super();
         makeObservable(this);
+        this.parentModel = parentModel;
+        this.ordersPanelModel = new OrdersPanelModel({persistWith, parentModel: this});
+    }
+
+    updateState(newState) {
+        this.ordersPanelModel.updateState(newState);
     }
 
-    override onLinked() {
-        this.addReaction({
-            track: () => this.parentModel.selectedPosition,
-            run: position => {
-                this.positionId = position?.id ?? null;
-            },
-            debounce: 300
-        });
+    async clearStateAsync() {
+        await this.ordersPanelModel.clearStateAsync();
     }
 }

client-app/src/examples/portfolio/detail/OrdersPanel.ts

@@ -12,7 +12,6 @@ export const ordersPanel = hoistCmp.factory({
 
     render({model}) {
         const {positionId, loadModel} = model;
-
         return panel({
             title: `Orders: ${formatPositionId(positionId)}`,
             icon: Icon.edit(),