@jaxolotl/wdclib

<!doctype html> <html lang="en"> <head> <title>Code coverage report for wdclib/SimulatorDispatcher.js</title> <meta charset="utf-8" /> <link rel="stylesheet" href="..\prettify.css" /> <link rel="stylesheet" href="..\base.css" /> <meta name="viewport" content="width=device-width, initial-scale=1"> <style type='text/css'> .coverage-summary .sorter { background-image: url(..\sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1> <a href="..\index.html">All files</a> / <a href="index.html">wdclib</a> SimulatorDispatcher.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 0% Statements 0/129 </div> <div class='fl pad1y space-right2'> 0% Branches 0/42 </div> <div class='fl pad1y space-right2'> 0% Functions 0/2 </div> <div class='fl pad1y space-right2'> 0% Lines 0/129 </div> </div> </div> <div class='status-line low'></div> <pre><table class="coverage"> <tr><td class="line-count quiet">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 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485</td><td class="line-coverage quiet">                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         </td><td class="text"><pre class="prettyprint lang-js">/* globals require */ import * as ApprovedOrigins from './ApprovedOrigins'; import { getBuildNumber } from './DevUtils/BuildNumber';   import deStringsMap from './resources/Shim_lib_resources_de-DE.json'; import enStringsMap from './resources/Shim_lib_resources_en-US.json'; import esStringsMap from './resources/Shim_lib_resources_es-ES.json'; import jaStringsMap from './resources/Shim_lib_resources_ja-JP.json'; import frStringsMap from './resources/Shim_lib_resources_fr-FR.json'; import koStringsMap from './resources/Shim_lib_resources_ko-KR.json'; import ptStringsMap from './resources/Shim_lib_resources_pt-BR.json'; import zhStringsMap from './resources/Shim_lib_resources_zh-CN.json';   // Required for IE & Edge which don't support endsWith // require('String.prototype.endsWith'); // now using babel-polyfill   const BUILD_NUMBER = getBuildNumber();   /** * Used for communicating between the simulator and web data connector. It does * this by passing messages between the WDC window and its parent window */ class SimulatorDispatcher {   /** * * @param {Object} globalObj - the global object to find tableau interfaces as well * as register events (usually window) */ constructor (globalObj) { this.globalObj = globalObj;   this._initMessageHandling(); this._initPublicInterface(); this._initPrivateInterface(); }   /** * @returns {Undefined} */ _initMessageHandling () { console.log('Initializing message handling');   this.globalObj.addEventListener('message', this._receiveMessage.bind(this), false); this.globalObj.document.addEventListener('DOMContentLoaded', this._onDomContentLoaded.bind(this)); }   /** * @returns {Undefined} */ _onDomContentLoaded () {   // Attempt to notify the simulator window that the WDC has loaded if (this.globalObj.parent !== window) { this.globalObj.parent.postMessage(this._buildMessagePayload('loaded'), '*'); }   if (this.globalObj.opener) { // Wrap in try/catch for older versions of IE try { this.globalObj.opener.postMessage(this._buildMessagePayload('loaded'), '*'); } catch (e) { console.warn('Some versions of IE may not accurately simulate the Web Data Connector. Please retry on a Webkit based browser'); } }   }   /** * @returns {Object} */ _packagePropertyValues () { let propValues = { 'connectionName': this.globalObj.tableau.connectionName, 'connectionData': this.globalObj.tableau.connectionData, 'password': this.globalObj.tableau.password, 'username': this.globalObj.tableau.username, 'usernameAlias': this.globalObj.tableau.usernameAlias, 'incrementalExtractColumn': this.globalObj.tableau.incrementalExtractColumn, 'versionNumber': this.globalObj.tableau.versionNumber, 'locale': this.globalObj.tableau.locale, 'authPurpose': this.globalObj.tableau.authPurpose, 'platformOS': this.globalObj.tableau.platformOS, 'platformVersion': this.globalObj.tableau.platformVersion, 'platformEdition': this.globalObj.tableau.platformEdition, 'platformBuildNumber': this.globalObj.tableau.platformBuildNumber }; return propValues; }   /** * * @param {Object} props * @returns {Undefined} */ _applyPropertyValues (props) { if (props) { this.globalObj.tableau.connectionName = props.connectionName; this.globalObj.tableau.connectionData = props.connectionData; this.globalObj.tableau.password = props.password; this.globalObj.tableau.username = props.username; this.globalObj.tableau.usernameAlias = props.usernameAlias; this.globalObj.tableau.incrementalExtractColumn = props.incrementalExtractColumn; this.globalObj.tableau.locale = props.locale; this.globalObj.tableau.language = props.locale; this.globalObj.tableau.authPurpose = props.authPurpose; this.globalObj.tableau.platformOS = props.platformOS; this.globalObj.tableau.platformVersion = props.platformVersion; this.globalObj.tableau.platformEdition = props.platformEdition; this.globalObj.tableau.platformBuildNumber = props.platformBuildNumber; } }   /** * * @param {String} msgName * @param {String} msgData * @param {String} props * @returns {String} */ _buildMessagePayload (msgName, msgData, props) {   let msgObj = { 'msgName': msgName, 'msgData': msgData, 'props': props, 'version': BUILD_NUMBER };   return JSON.stringify(msgObj); }   /** * * @param {*} msgName * @param {*} msgData * @returns {Undefined} */ _sendMessage (msgName, msgData) {   let messagePayload = this._buildMessagePayload(msgName, msgData, this._packagePropertyValues());   let wdcHandler;   try { // try to use webkit.messageHandlers but don't fail since we have a fallback wdcHandler = this.globalObj.webkit.messageHandlers.wdcHandler;   } catch (e) {   // wdcHandler not found on webkit.messageHandlers to post messagePayload // we might be on the simulator   }   // Check first to see if we have a wdcHandler defined on messageHandlers to post the message to if (wdcHandler) {   wdcHandler.postMessage(messagePayload);   } else if (!this._sourceWindow) {   throw new Error('Looks like the WDC is calling a tableau function before tableau.init() has been called.');   } else {   // Make sure we only post this info back to the source origin the user approved in _getWebSecurityWarningConfirm this._sourceWindow.postMessage(messagePayload, this._sourceOrigin);   } }   /** * * @param {String} payloadString * @returns {Object|null} */ _getPayloadObj (payloadString) { let payload;   try {   payload = JSON.parse(payloadString);   } catch (e) {   return null;   }   return payload; }   /** * @returns {Boolean} */ _getWebSecurityWarningConfirm () {   // Due to cross-origin security issues over https, we may not be able to retrieve _sourceWindow. // Use sourceOrigin instead. let origin = this._sourceOrigin; let Uri = require('jsuri'); // @todo review this let parsedOrigin = new Uri(origin); let hostName = parsedOrigin.host();   const SUPPORTED_HOSTS = ['localhost', 'tableau.github.io'];   if (SUPPORTED_HOSTS.indexOf(hostName) >= 0) { return true; }   // Whitelist Tableau domains if (hostName && hostName.endsWith('online.tableau.com')) { return true; }   let alreadyApprovedOrigins = ApprovedOrigins.getApprovedOrigins();   if (alreadyApprovedOrigins.indexOf(origin) >= 0) { // The user has already approved this origin, no need to ask again console.log(`Already approved the origin ${origin} , not asking again`); return true; }   let localizedWarningTitle = this._getLocalizedString('webSecurityWarning'); let completeWarningMsg = localizedWarningTitle + '\n\n' + hostName + '\n'; let isConfirmed = confirm(completeWarningMsg);   if (isConfirmed) { // Set a session cookie to mark that we've approved this already ApprovedOrigins.addApprovedOrigin(origin); }   return isConfirmed; }   /** * @returns {String} */ _getCurrentLocale () { // Use current browser's locale to get a localized warning message let currentBrowserLanguage = (navigator.language || navigator.userLanguage); let locale = currentBrowserLanguage ? currentBrowserLanguage.substring(0, 2) : 'en'; let supportedLocales = ['de', 'en', 'es', 'fr', 'ja', 'ko', 'pt', 'zh']; // can we move this to package json as we did with connectors?   // Fall back to English for other unsupported lanaguages if (supportedLocales.indexOf(locale) < 0) { locale = 'en'; }   return locale; }   /** * * @param {String} stringKey * @returns {String} */ _getLocalizedString (stringKey) { let locale = this._getCurrentLocale();   // Use static require here, otherwise webpack would generate a much bigger JS file // ( the increment in size is irrelevant, specially when minimized, moving to the top and import [JAX])   // let deStringsMap = require('json-loader!./resources/Shim_lib_resources_de-DE.json'); // let enStringsMap = require('json-loader!./resources/Shim_lib_resources_en-US.json'); // let esStringsMap = require('json-loader!./resources/Shim_lib_resources_es-ES.json'); // let jaStringsMap = require('json-loader!./resources/Shim_lib_resources_ja-JP.json'); // let frStringsMap = require('json-loader!./resources/Shim_lib_resources_fr-FR.json'); // let koStringsMap = require('json-loader!./resources/Shim_lib_resources_ko-KR.json'); // let ptStringsMap = require('json-loader!./resources/Shim_lib_resources_pt-BR.json'); // let zhStringsMap = require('json-loader!./resources/Shim_lib_resources_zh-CN.json');   let stringJsonMapByLocale = { 'de': deStringsMap, 'en': enStringsMap, 'es': esStringsMap, 'fr': frStringsMap, 'ja': jaStringsMap, 'ko': koStringsMap, 'pt': ptStringsMap, 'zh': zhStringsMap };   let localizedStringsJson = stringJsonMapByLocale[locale];   return localizedStringsJson[stringKey]; }   /** * * @param {Object} evt * @returns {Undefined} */ _receiveMessage (evt) { console.log('Received message!');   let wdc = this.globalObj._wdc;   if (!wdc) { throw new Error('No WDC registered. Did you forget to call tableau.registerConnector?'); }   let payloadObj = this._getPayloadObj(evt.data);   if (!payloadObj) { return; // This message is not needed for WDC }   if (!this._sourceWindow) { this._sourceWindow = evt.source; this._sourceOrigin = evt.origin; }   let msgData = payloadObj.msgData; this._applyPropertyValues(payloadObj.props);   switch (payloadObj.msgName) { case 'init': // Warn users about possible phinishing attacks if (!this._getWebSecurityWarningConfirm()) { window.close(); } else { this.globalObj.tableau.phase = msgData.phase; this.globalObj._tableau.triggerInitialization(); } break; case 'shutdown': this.globalObj._tableau.triggerShutdown(); break; case 'getSchema': this.globalObj._tableau.triggerSchemaGathering(); break; case 'getData': this.globalObj._tableau.triggerDataGathering(msgData.tablesAndIncrementValues); break; } }   /** * PUBLIC INTERFACE * @returns {Undefined} */ _initPublicInterface () { console.log('Initializing public interface');   this._submitCalled = false;   // Assign the public interface to this this.publicInterface = { abortForAuth: this._abortForAuth.bind(this), abortWithError: this._abortWithError.bind(this), addCrossOriginException: this._addCrossOriginException.bind(this), log: this._log.bind(this), reportProgress: this._reportProgress.bind(this), submit: this._submit.bind(this) }; }   /** * @see http://tableau.github.io/webdataconnector/docs/api_ref.html#webdataconnectorapi.tableau.abortforauth * * @param {String} msg * @returns {Undefined} */ _abortForAuth (msg) { this._sendMessage('abortForAuth', { 'msg': msg }); }   /** * @see http://tableau.github.io/webdataconnector/docs/api_ref.html#webdataconnectorapi.tableau.abortwitherror * * @param {String} msg * @returns {Undefined} */ _abortWithError (msg) { this._sendMessage('abortWithError', { 'errorMsg': msg }); }   /** * Missing documentation online, we need to add one * * @param {Array} destOriginList * @returns {Undefined} */ _addCrossOriginException (destOriginList) { // Don't bother passing this back to the simulator since there's nothing it can // do. Just call back to the WDC indicating that it worked console.log('Cross Origin Exception requested in the simulator. Pretending to work.');   // can we return a promise so we can listen for resolution instead of blindly wait? setTimeout(function () { this.globalObj._wdc.addCrossOriginExceptionCompleted(destOriginList); }.bind(this), 0); }   /** * @see http://tableau.github.io/webdataconnector/docs/api_ref.html#webdataconnectorapi.tableau.log * * @param {String} msg * @returns {Undefined} */ _log (msg) { this._sendMessage('log', { 'logMsg': msg }); }   /** * @see http://tableau.github.io/webdataconnector/docs/api_ref.html#webdataconnectorapi.tableau.reportProgress * * @param {String} progressMessage * @returns {Undefined} */ _reportProgress (progressMessage) { this._sendMessage('reportProgress', { 'progressMsg': progressMessage }); }