All files / ima/page/renderer ClientPageRenderer.js

75.32% Statements 58/77
40.91% Branches 9/22
77.78% Functions 14/18
75.32% Lines 58/77
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310          3x                                         13x             13x               13x               13x             6x 6x 6x   6x 1x 1x 1x     6x     6x   6x 5x 5x 5x     6x 6x   6x                         5x 5x 5x   5x 5x   5x     5x 5x   5x                         1x                                                       4x 4x   4x                                                                     3x           3x 3x 3x   3x           3x                                     1x 1x   1x 1x   1x     1x       1x                   1x   1x 1x 1x                   1x     1x                               1x     1x                               1x     1x                   3x  
// @client-side
 
import ns from '../../namespace';
import AbstractPageRenderer from './AbstractPageRenderer';
 
ns.namespace('ima.page.renderer');
 
/**
 * Client-side page renderer. The renderer attempts to reuse the markup sent by
 * server if possible.
 */
export default class ClientPageRenderer extends AbstractPageRenderer {
  /**
	 * Initializes the client-side page renderer.
	 *
	 * @param {PageRendererFactory} factory Factory for receive $Utils to view.
	 * @param {vendor.$Helper} Helper The IMA.js helper methods.
	 * @param {vendor.ReactDOM} ReactDOM React framework instance to use to
	 *        render the page on the client side.
	 * @param {Object<string, *>} settings The application setting for the
	 *        current application environment.
	 * @param {Window} window Helper for manipulating the global object
	 *        ({@code window}) regardless of the client/server-side
	 *        environment.
	 */
  constructor(factory, Helper, ReactDOM, settings, window) {
    super(factory, Helper, ReactDOM, settings);
 
    /**
		 * Flag signalling that the page is being rendered for the first time.
		 *
		 * @type {boolean}
		 */
    this._firstTime = true;
 
    /**
		 * Helper for manipulating the global object ({@code window})
		 * regardless of the client/server-side environment.
		 *
		 * @type {Window}
		 */
    this._window = window;
 
    /**
		 * The HTML element containing the current application view for the
		 * current route.
		 *
		 * @type {?HTMLElement}
		 */
    this._viewContainer = null;
  }
 
  /**
	 * @inheritdoc
	 */
  mount(controller, view, pageResources, routeOptions) {
    let separatedData = this._separatePromisesAndValues(pageResources);
    let defaultPageState = separatedData.values;
    let loadedPromises = separatedData.promises;
 
    if (!this._firstTime) {
      controller.setState(defaultPageState);
      this._renderToDOM(controller, view, routeOptions);
      this._patchPromisesToState(controller, loadedPromises);
    }
 
    return this._Helper
      .allPromiseHash(loadedPromises)
      .then(fetchedResources => {
        let pageState = Object.assign({}, defaultPageState, fetchedResources);
 
        if (this._firstTime) {
          controller.setState(pageState);
          this._renderToDOM(controller, view, routeOptions);
          this._firstTime = false;
        }
 
        controller.setMetaParams(pageState);
        this._updateMetaAttributes(controller.getMetaManager());
 
        return {
          content: null,
          status: controller.getHttpStatus(),
          pageState
        };
      })
      .catch(error => this._handleError(error));
  }
 
  /**
	 * @inheritdoc
	 */
  update(controller, resourcesUpdate) {
    let separatedData = this._separatePromisesAndValues(resourcesUpdate);
    let defaultPageState = separatedData.values;
    let updatedPromises = separatedData.promises;
 
    controller.setState(defaultPageState);
    this._patchPromisesToState(controller, updatedPromises);
 
    return this._Helper
      .allPromiseHash(updatedPromises)
      .then(fetchedResources => {
        controller.setMetaParams(controller.getState());
        this._updateMetaAttributes(controller.getMetaManager());
 
        return {
          content: null,
          status: controller.getHttpStatus(),
          pageState: Object.assign({}, defaultPageState, fetchedResources)
        };
      })
      .catch(error => this._handleError(error));
  }
 
  /**
	 * @inheritdoc
	 */
  unmount() {
    Iif (this._reactiveView) {
      this._ReactDOM.unmountComponentAtNode(this._viewContainer);
      this._reactiveView = null;
    }
  }
 
  /**
	 * Show error to console in $Debug mode and re-throw that error
	 * for other error handler.
	 *
	 * @param {Error} error
	 * @throws {Error} Re-throws the handled error.
	 */
  _handleError(error) {
    if ($Debug) {
      console.error('Render Error:', error);
    }
 
    throw error;
  }
 
  /**
	 * Patch promise values to controller state.
	 *
	 * @param {ControllerDecorator} controller
	 * @param {Object<string, Promise<*>>} patchedPromises
	 */
  _patchPromisesToState(controller, patchedPromises) {
    for (let resourceName of Object.keys(patchedPromises)) {
      patchedPromises[resourceName]
        .then(resource => {
          controller.setState({
            [resourceName]: resource
          });
        })
        .catch(error => this._handleError(error));
    }
  }
 
  /**
	 * Renders the current route to DOM.
	 *
	 * @param {ControllerDecorator} controller
	 * @param {function(new: React.Component)} view
	 * @param {{
	 *          onlyUpdate: (
	 *            boolean|
	 *            function(
	 *              (string|function(new: Controller, ...*)),
	 *              (
	 *                string|
	 *                function(
	 *                  new: React.Component,
	 *                  Object<string, *>,
	 *                  ?Object<string, *>
	 *                )
	 *              )
	 *            ): boolean
	 *          ),
	 *          autoScroll: boolean,
	 *          allowSPA: boolean,
	 *          documentView: ?function(new: AbstractDocumentView),
	 *          managedRootView: ?function(new: React.Component)
	 *        }} routeOptions The current route options.
	 */
  _renderToDOM(controller, view, routeOptions) {
    let reactElementView = this._getWrappedPageView(
      controller,
      view,
      routeOptions
    );
 
    let documentView = this._getDocumentView(routeOptions);
    let masterElementId = documentView.masterElementId;
    this._viewContainer = this._window.getElementById(masterElementId);
 
    Iif (this._viewContainer && this._viewContainer.children.length) {
      this._reactiveView = this._ReactDOM.hydrate(
        reactElementView,
        this._viewContainer
      );
    } else {
      this._reactiveView = this._ReactDOM.render(
        reactElementView,
        this._viewContainer
      );
    }
  }
 
  /**
	 * Separate promises and values from provided data map. Values will be use
	 * for default page state. Promises will be patched to state after their
	 * resolve.
	 *
	 * @param {Object<string, *>} dataMap A map of data.
	 * @return {{
	 *           promises: Object<string, Promise<*>>,
	 *           values: Object<string, *>
	 *         }} Return separated promises and other values.
	 */
  _separatePromisesAndValues(dataMap) {
    let promises = {};
    let values = {};
 
    for (let field of Object.keys(dataMap)) {
      let value = dataMap[field];
 
      Iif (value instanceof Promise) {
        promises[field] = value;
      } else {
        values[field] = value;
      }
    }
 
    return { promises, values };
  }
 
  /**
	 * Updates the title and the contents of the meta elements used for SEO.
	 *
	 * @param {MetaManager} metaManager meta attributes storage providing the
	 *        new values for page meta elements and title.
	 */
  _updateMetaAttributes(metaManager) {
    this._window.setTitle(metaManager.getTitle());
 
    this._updateMetaNameAttributes(metaManager);
    this._updateMetaPropertyAttributes(metaManager);
    this._updateMetaLinkAttributes(metaManager);
  }
 
  /**
	 * Updates the contents of the generic meta elements used for SEO.
	 *
	 * @param {MetaManager} metaManager meta attributes storage providing the
	 *        new values for page meta elements and title.
	 */
  _updateMetaNameAttributes(metaManager) {
    let metaTagKey = null;
    let metaTag;
 
    for (metaTagKey of metaManager.getMetaNames()) {
      metaTag = this._window.querySelector(`meta[name="${metaTagKey}"]`);
 
      if (metaTag) {
        metaTag.content = metaManager.getMetaName(metaTagKey);
      }
    }
  }
 
  /**
	 * Updates the contents of the specialized meta elements used for SEO.
	 *
	 * @param {MetaManager} metaManager meta attributes storage providing the
	 *        new values for page meta elements and title.
	 */
  _updateMetaPropertyAttributes(metaManager) {
    let metaTagKey = null;
    let metaTag;
 
    for (metaTagKey of metaManager.getMetaProperties()) {
      metaTag = this._window.querySelector(`meta[property="${metaTagKey}"]`);
 
      if (metaTag) {
        metaTag.content = metaManager.getMetaProperty(metaTagKey);
      }
    }
  }
 
  /**
	 * Updates the href of the specialized link elements used for SEO.
	 *
	 * @param {MetaManager} metaManager meta attributes storage providing the
	 *        new values for page meta elements and title.
	 */
  _updateMetaLinkAttributes(metaManager) {
    let linkTagKey = null;
    let linkTag;
 
    for (linkTagKey of metaManager.getLinks()) {
      linkTag = this._window.querySelector(`link[rel="${linkTagKey}"]`);
 
      if (linkTag && linkTag.href) {
        linkTag.href = metaManager.getLink(linkTagKey);
      }
    }
  }
}
 
ns.ima.page.renderer.ClientPageRenderer = ClientPageRenderer;