Fix #2031 Trigger notification if a map is an old one asking for updating it

docma-config.json

@@ -137,6 +137,7 @@
             "web/client/reducers/search.js",
 
             "web/client/epics/index.jsdoc",
+            "web/client/epics/automapupdate.js",
             "web/client/epics/cookies.js",
             "web/client/epics/fullscreen.js",
             "web/client/epics/globeswitcher.js",
@@ -157,6 +158,7 @@
           "jsapi": "web/client/jsapi/MapStore2.js",
             "plugins": [
                 "web/client/plugins/index.jsdoc",
+                "web/client/plugins/AutoMapUpdate.jsx",
                 "web/client/plugins/BackgroundSelector.jsx",
                 "web/client/plugins/BackgroundSwitcher.jsx",
                 "web/client/plugins/DrawerMenu.jsx",

web/client/actions/__tests__/notifications-test.js

@@ -17,7 +17,8 @@ var {
     error,
     info,
     hide,
-    clear
+    clear,
+    dispatchAction
 } = require('../notifications');
 
 describe('Test correctness of the notifications actions', () => {
@@ -66,6 +67,15 @@ describe('Test correctness of the notifications actions', () => {
         expect(action.level).toBe('info');
         expect(action.uid).toExist();
     });
+    it('dispatchAction', () => {
+        const customAction = () => {
+            return {
+                type: 'CUSTOM_ACTION'
+            };
+        };
+        const action = dispatchAction(customAction);
+        expect(action().type).toBe('CUSTOM_ACTION');
+    });
 
 
 });

web/client/actions/config.js

@@ -93,4 +93,4 @@ function loadMapInfo(url, mapId) {
 }
 module.exports = {MAP_CONFIG_LOADED, MAP_CONFIG_LOAD_ERROR,
     MAP_INFO_LOAD_START, MAP_INFO_LOADED, MAP_INFO_LOAD_ERROR,
-    loadMapConfig, loadMapInfo, configureMap, configureError};
+    loadMapConfig, loadMapInfo, configureMap, configureError, mapInfoLoaded};

web/client/actions/notifications.js

@@ -90,6 +90,15 @@ function clear() {
     };
 }
 
+/**
+ * Dispatch a custom action on callback
+ * @memberof actions.notifications
+ * @returns {object}     action
+ */
+function dispatchAction(action) {
+    return action;
+}
+
 /**
  * actions for notifications
  * @name notifications
@@ -105,5 +114,6 @@ module.exports = {
     error,
     info,
     hide,
-    clear
+    clear,
+    dispatchAction
 };

web/client/actions/security.js

@@ -13,6 +13,7 @@ const AuthenticationAPI = require('../api/GeoStoreDAO');
 const SecurityUtils = require('../utils/SecurityUtils');
 
 const {loadMaps} = require('./maps');
+const {loadMapInfo} = require('./config');
 const ConfigUtils = require('../utils/ConfigUtils');
 
 const LOGIN_SUBMIT = 'LOGIN_SUBMIT';
@@ -67,10 +68,15 @@ function logoutWithReload() {
 }
 
 function login(username, password) {
-    return (dispatch) => {
-        AuthenticationAPI.login(username, password).then((response) => {
+    return (dispatch, state) => {
+        return AuthenticationAPI.login(username, password).then((response) => {
             dispatch(loginSuccess(response, username, password, AuthenticationAPI.authProviderName));
             dispatch(loadMaps(false, ConfigUtils.getDefaults().initialMapFilter || "*"));
+            let s = state();
+            let id = s.map && s.map.present && s.map.present.mapId;
+            if (id) {
+                dispatch(loadMapInfo(ConfigUtils.getConfigProp("geoStoreUrl") + "extjs/resource/" + id, id));
+            }
         }).catch((e) => {
             dispatch(loginFail(e));
         });

web/client/components/misc/progressbars/OverlayProgressBar/OverlayProgressBar.jsx

@@ -0,0 +1,51 @@
+const PropTypes = require('prop-types');
+/*
+ * Copyright 2017, GeoSolutions Sas.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree.
+*/
+
+const React = require('react');
+const {ProgressBar, Col, Row} = require('react-bootstrap');
+const Message = require('../../../../components/I18N/Message');
+require('./css/overlayprogressbar.css');
+
+class OverlayProgressBar extends React.Component {
+    static propTypes = {
+        loading: PropTypes.bool,
+        count: PropTypes.number,
+        length: PropTypes.number,
+        label: PropTypes.string,
+        unit: PropTypes.string
+    };
+
+    static defaultProps = {
+        loading: false,
+        count: 0,
+        length: 0,
+        label: 'autorefresh.updating',
+        unit: 'autorefresh.layers'
+    };
+
+    render() {
+        return this.props.loading ? (
+            <div className="overlay-spinner-container">
+                <div>
+                    <Row>
+                        <Col xs="12" className="text-center overlay-spinner-label"><h3><Message msgId={this.props.label}/></h3></Col>
+                    </Row>
+                    <Row>
+                        <Col xs="12"><ProgressBar active now={100 * this.props.count / this.props.length} /></Col>
+                    </Row>
+                    <Row>
+                        <Col xs="12" className="text-center overlay-spinner-label"><h3>{this.props.count + ' '} <Message msgId="autorefresh.of"/>{ ' ' + this.props.length + ' '}<Message msgId={this.props.unit}/></h3></Col>
+                    </Row>
+                </div>
+            </div>
+        ) : null;
+    }
+}
+
+module.exports = OverlayProgressBar;

web/client/components/misc/progressbars/OverlayProgressBar/__test__/OverlayProgressBar-test.jsx

@@ -0,0 +1,41 @@
+/*
+* Copyright 2017, GeoSolutions Sas.
+* All rights reserved.
+*
+* This source code is licensed under the BSD-style license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+const expect = require('expect');
+
+const React = require('react');
+const ReactDOM = require('react-dom');
+const OverlayProgressBar = require('../OverlayProgressBar');
+
+describe("test the OverlayProgressBar", () => {
+    beforeEach((done) => {
+        document.body.innerHTML = '<div id="container"></div>';
+        setTimeout(done);
+    });
+
+    afterEach((done) => {
+        ReactDOM.unmountComponentAtNode(document.getElementById("container"));
+        document.body.innerHTML = '';
+        setTimeout(done);
+    });
+
+    it('test OverlayProgressBar starts loading', () => {
+        const overlayProgressBar = ReactDOM.render(<OverlayProgressBar loading/>, document.getElementById("container"));
+        expect(overlayProgressBar).toExist();
+        const node = ReactDOM.findDOMNode(overlayProgressBar);
+        expect(node.children.length).toBe(1);
+    });
+
+    it('test OverlayProgressBar stops loading', () => {
+        const overlayProgressBar = ReactDOM.render(<OverlayProgressBar loading={false}/>, document.getElementById("container"));
+        expect(overlayProgressBar).toExist();
+        const node = ReactDOM.findDOMNode(overlayProgressBar);
+        expect(node).toBe(null);
+    });
+
+});

web/client/components/misc/progressbars/OverlayProgressBar/css/overlayprogressbar.css

@@ -0,0 +1,20 @@
+.overlay-spinner-container  {
+    position: absolute;
+    top: 0;
+    left: 0;
+    width: 100%;
+    height: 100%;
+    z-index: 9998;
+    background-color: rgba(0, 0, 0, 0.5);
+    display: flex;
+    align-items: center;
+    justify-content: center;
+}
+
+.overlay-spinner-container > div {
+    width: 80%;
+}
+
+.overlay-spinner-label {
+    color: #fff;
+}

web/client/components/notifications/NotificationContainer.jsx

@@ -34,7 +34,8 @@ var LocaleUtils = require('../../utils/LocaleUtils');
 class NotificationContainer extends React.Component {
     static propTypes = {
         notifications: PropTypes.array,
-        onRemove: PropTypes.func
+        onRemove: PropTypes.func,
+        onDispatch: PropTypes.func
     };
 
     static contextTypes = {
@@ -43,7 +44,8 @@ class NotificationContainer extends React.Component {
 
     static defaultProps = {
         notifications: [],
-        onRemove: () => {}
+        onRemove: () => {},
+        onDispatch: () => {}
     };
 
     componentDidMount() {
@@ -81,7 +83,8 @@ class NotificationContainer extends React.Component {
                   title: LocaleUtils.getMessageById(this.context.messages, notification.title) || notification.title,
                   message: LocaleUtils.getMessageById(this.context.messages, notification.message) || notification.message,
                   action: notification.action && {
-                      label: LocaleUtils.getMessageById(this.context.messages, notification.action.label) || notification.action.label
+                      label: LocaleUtils.getMessageById(this.context.messages, notification.action.label) || notification.action.label,
+                      callback: notification.action.dispatch ? () => { this.props.onDispatch(notification.action.dispatch); } : notification.action.callback
                   },
                   onRemove: () => {
                       this.props.onRemove(notification.uid);

web/client/epics/__tests__/automapupdate-test.js

@@ -0,0 +1,79 @@
+/*
+ * Copyright 2017, GeoSolutions Sas.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+var expect = require('expect');
+
+const configureMockStore = require('redux-mock-store').default;
+const {createEpicMiddleware, combineEpics } = require('redux-observable');
+const {configureMap, mapInfoLoaded} = require('../../actions/config');
+const {SHOW_NOTIFICATION} = require('../../actions/notifications');
+
+const {manageAutoMapUpdate} = require('../automapupdate');
+const rootEpic = combineEpics(manageAutoMapUpdate);
+const epicMiddleware = createEpicMiddleware(rootEpic);
+const mockStore = configureMockStore([epicMiddleware]);
+
+describe('autorefresh Epics', () => {
+    let store;
+    beforeEach(() => {
+        store = mockStore();
+    });
+
+    afterEach(() => {
+        epicMiddleware.replaceEpic(rootEpic);
+    });
+
+    it('refreshes map', (done) => {
+
+        let configuration = configureMap({}, "id");
+
+        let information = mapInfoLoaded({
+            canEdit: true
+        }, "id");
+
+        store.dispatch(configuration);
+        store.dispatch(information);
+
+        setTimeout( () => {
+            try {
+                const actions = store.getActions();
+                expect(actions.length).toBe(3);
+                expect(actions[2].type).toBe(SHOW_NOTIFICATION);
+            } catch (e) {
+                return done(e);
+            }
+            done();
+        }, 500);
+
+    });
+
+    it('refreshes map without login', (done) => {
+
+        let configuration = configureMap({
+            version: 2
+        }, "id");
+
+        let information = mapInfoLoaded({
+            canEdit: true
+        }, "id");
+
+        store.dispatch(configuration);
+        store.dispatch(information);
+
+        setTimeout( () => {
+            try {
+                const actions = store.getActions();
+                expect(actions.length).toBe(2);
+            } catch (e) {
+                return done(e);
+            }
+            done();
+        }, 500);
+
+    });
+});

web/client/epics/automapupdate.js

@@ -0,0 +1,72 @@
+/*
+ * Copyright 2017, GeoSolutions Sas.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree.
+*/
+const Rx = require('rxjs');
+const {refreshLayers, LAYERS_REFRESHED, LAYERS_REFRESH_ERROR} = require('../actions/layers');
+const {MAP_CONFIG_LOADED, MAP_INFO_LOADED} = require('../actions/config');
+const {warning, success} = require('../actions/notifications');
+const {toggleControl} = require('../actions/controls');
+
+/**
+ * When map has been loaded, it sends a notification if the version is less than 2 and users has write permission.
+ * @param {external:Observable} action$ manages `MAP_CONFIG_LOADED` and `MAP_INFO_LOADED`.
+ * @memberof epics.automapupdate
+ * @return {external:Observable}
+ */
+
+const manageAutoMapUpdate = action$ =>
+    action$.ofType(MAP_CONFIG_LOADED)
+        .switchMap((mapConfigLoaded) =>
+            action$.ofType(MAP_INFO_LOADED)
+                .switchMap((mapInfoLoaded) => {
+                    const version = mapConfigLoaded.config && mapConfigLoaded.config.version || 1;
+                    const canEdit = mapInfoLoaded.info && mapInfoLoaded.info.canEdit || false;
+                    let layers = mapConfigLoaded.config && mapConfigLoaded.config.map && mapConfigLoaded.config.map.layers && mapConfigLoaded.config.map.layers.filter((l) => l.type === 'wms' && l.group !== 'background') || [];
+                    const options = {bbox: true, search: true, dimensions: true, title: true};
+                    return version < 2 && canEdit ?
+                        Rx.Observable.of(warning({
+                            title: "notification.warning",
+                            message: "notification.updateOldMap",
+                            action: {
+                                label: "notification.update",
+                                dispatch: refreshLayers(layers, options)
+                            },
+                            autoDismiss: 12,
+                            position: "tc"
+                        })).concat(
+                            action$.ofType(LAYERS_REFRESHED, LAYERS_REFRESH_ERROR)
+                                .bufferCount(layers.length)
+                                .switchMap((refreshed) => {
+                                    const errors = refreshed.filter((l) => l.type === LAYERS_REFRESH_ERROR);
+                                    const notification = errors.length > 0 ?
+                                        warning({
+                                            title: "notification.warning",
+                                            message: "notification.warningSaveUpdatedMap",
+                                            autoDismiss: 6,
+                                            position: "tc"
+                                        })
+                                        :
+                                        success({
+                                            title: "notification.success",
+                                            message: "notification.saveUpdatedMap",
+                                            autoDismiss: 6,
+                                            position: "tc"
+                                        });
+                                    return Rx.Observable.of(notification, toggleControl('save'));
+                                }))
+                    : Rx.Observable.empty();
+                }));
+
+/**
+ * Epics for update old map
+ * @name epics.automapupdate
+ * @type {Object}
+ */
+
+module.exports = {
+    manageAutoMapUpdate
+};