Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 | 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 13x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 3x 3x 3x 1x 1x 2x 2x 1x 1x 1x 1x 2x 126x 126x 126x 126x 126x 126x 126x 126x 126x 4x 4x 4x 4x 4x 126x 126x 126x 126x 126x 126x 126x 2x 126x 126x 126x 126x 126x 126x 126x 126x 3x 126x 126x 126x 126x 126x 126x 126x 126x 126x 2x 2x 2x 2x 2x 2x 2x 2x 2x 126x 126x 126x 126x 126x 126x 126x 126x 3x 126x 126x 126x 126x 126x 126x 126x 126x 2x 126x 126x 126x 126x 126x 126x 126x 126x 126x 6x 6x 6x 6x 6x 6x 35x 35x 35x 35x 31x 31x 4x 4x 4x 10x 10x 10x 4x 4x 4x 6x 126x 126x 126x 126x 126x 126x 126x 126x 2x 2x 2x 2x 2x 2x 126x 126x 126x 126x 126x 126x 17x 17x 17x 17x 17x 17x 17x 126x 126x 126x 126x 126x 126x 126x 126x 2x 2x 126x 126x 126x 126x 126x 126x 5x 126x 126x 126x 126x 126x 126x 126x 126x 126x 3x 1x 1x 3x 126x 126x 126x 126x 126x 126x 126x 1x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 126x 126x 126x 126x 126x 126x 126x 126x 126x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 13x 13x 13x 2x 2x 11x 11x 13x 7x 7x 4x 4x 4x 4x 4x 4x 10x 3x 3x 3x 4x 4x 4x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 10x 10x 10x 10x 10x 1x 10x 1x 1x 9x 9x 9x 9x 9x 9x 10x 1x 1x 8x 8x 8x 15x 14x 15x 1x 1x 8x 8x 8x 8x 8x 8x 8x 10x 10x 7x 7x 7x 1x 1x 1x 1x 1x 1x 1x 5x 5x 5x 10x 5x 5x 10x 2x 2x 2x 2x 2x 2x 10x 8x 15x 15x 15x 15x 8x 10x 10x 10x 10x 15x 10x 10x 10x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 6x 6x 6x 6x 6x 6x 6x 3x 3x 3x 3x 3x 3x 3x 3x 2x 3x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 3x 3x 1x 1x 1x 1x 1x 3x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 2x 2x 5x 5x 5x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 1x 1x 126x 126x 126x 126x 126x 126x 126x 126x 4x 1x 1x 3x 3x 3x 5x 1x 1x 1x 4x 4x 4x 3x 3x 3x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 4x 4x 4x 4x 1x 1x 3x 3x 4x 3x 3x 3x 3x 4x 1x 1x 2x 2x 2x 2x 2x 2x 2x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 3x 3x 3x 3x 3x 3x 3x 3x 3x 1x 1x 3x 2x 2x 2x 2x 2x 2x 3x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 5x 5x 5x 5x 2x 2x 5x 5x 5x 5x 5x 5x 5x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 5x 5x 5x 5x 5x 5x 5x 1x 1x 5x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 5x 5x 5x 5x 5x 1x 1x 4x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 126x 6x 6x 6x 6x 6x 6x 1x 1x 5x 5x 6x 2x 2x 3x 3x 126x 126x 126x 126x 126x 126x 126x 2x 126x 126x 126x 126x 126x 126x 126x 1x 1x 126x 126x 126x 126x | /*!
* WikiLambda Vue editor: Abstract Wikipedia Pinia store
*
* @copyright 2020– Abstract Wikipedia team; see AUTHORS.txt
* @license MIT
*/
'use strict';
const Constants = require( '../../Constants.js' );
const { fetchAbstractWikiSection, saveAbstractWikiContent, runAbstractWikiFragment } = require( '../../utils/apiUtils.js' );
const { extractZIDs } = require( '../../utils/schemata.js' );
const { buildAbstractWikiTitle } = require( '../../utils/urlUtils.js' );
const { extractWikidataItemIds, isWikidataQid } = require( '../../utils/wikidataUtils.js' );
const { canonicalToHybrid, hybridToCanonical } = require( '../../utils/schemata.js' );
const { isValidZidFormat } = require( '../../utils/typeUtils.js' );
const { sha256, stabilize } = require( '../../utils/miscUtils.js' );
/* Time (ms) between processing jobs in the queue */
const FRAGMENT_QUEUE_TIMEOUT = 2000;
/* Initial delay (ms) before the first retry; subsequent retries use exponential backoff */
const INITIAL_RETRY_DELAY = 2000;
/* Multiplier applied to the retry delay between successive retries */
const RETRY_BACKOFF_FACTOR = 2;
/* Maximum times to try each fragment */
const MAX_FRAGMENT_RETRIES = 3;
const abstractWikiStore = {
state: {
/**
* State of the fragment preview, indexed by a hashed
* representation of the fragment and the render language.
*
* Contains properties that describe the status of the render:
*
* fragments[ `${ sha256(fragment) }:${ langZid }` ] = {
* "isLoading":false,
* "isPending":false,
* "isDirty":false,
* "hasError":false,
* "error":null,
* "html":"<p>Rendered fragment.</p>",
* "retryCount":0
* }
*/
fragments: {},
fragmentPromises: {},
sectionHashes: {},
qid: undefined,
highlight: undefined,
previewLanguageZid: undefined,
suggestedHtmlFunctions: [],
fragmentQueue: [],
queueRunning: false
},
getters: {
/**
* Returns the Abstract Wiki content Id
*
* @param {Object} state
* @return {string}
*/
getAbstractWikiId: function ( state ) {
return state.qid;
},
/**
* Returns the Abstract Wiki sections with UI metadata.
*
* Each section includes:
* - `qid`: section Wikidata QID
* - `isLede`: whether it is the lede section
* - `labelData`: local label payload for display
* - `fragmentsPath`: dot-path to the section's fragments in the stored object
*
* @return {Array|undefined}
*/
getAbstractContentSections: function () {
const sectionsPath = [ Constants.STORED_OBJECTS.ABSTRACT, Constants.ABSTRACT_WIKI_SECTIONS ];
const sections = this.getZObjectByKeyPath( sectionsPath );
if ( !sections ) {
return undefined;
}
return Object.keys( sections ).map( ( qid ) => Object.assign( {
qid,
isLede: qid === Constants.ABSTRACT_WIKI_SECTION_LEDE,
labelData: this.getItemLabelData( qid ),
fragmentsPath: [ ...sectionsPath, qid, Constants.ABSTRACT_WIKI_SECTION_FRAGMENTS ].join( '.' )
}, sections[ qid ] ) );
},
/**
* Returns the list of fragment hashes for a given section,
* or empty array if not initialized.
*
* @param {Object} state
* @return {Function}
*/
getAbstractSectionHashes: function ( state ) {
/**
* @param {string} sectionQid
* @return {Array}
*/
return ( sectionQid ) => state.sectionHashes[ sectionQid ] || [];
},
/**
* Returns the name of the Abstract Wiki Content primary namespace
*
* @return {string}
*/
getAbstractWikipediaNamespace: function () {
return mw.config.get( 'wgWikiLambdaAbstractPrimaryNamespace' );
},
/**
* Returns the language ZID to use for the preview block.
*
* @param {Object} state
* @return {string|undefined}
*/
getPreviewLanguageZid: function ( state ) {
return state.previewLanguageZid || this.getUserLangZid;
},
/**
* Returns the cached value of the Abstract Wiki Content fragment preview,
* given its key path and a language.
*
* @param {Object} state
* @return {Function}
*/
getFragmentPreview: function ( state ) {
/**
* @param {string} fragmentHash
* @param {string} langZid
* @return {Object|undefined}
*/
return ( fragmentHash, langZid ) => {
const fragmentKey = `${ fragmentHash }:${ langZid }`;
return state.fragments[ fragmentKey ];
};
},
/**
* Returns the keyPath of the highlighted fragment
*
* @param {Object} state
* @return {string}
*/
getHighlightedFragment: function ( state ) {
return state.highlight;
},
/**
* Returns the array with suggested html functions
*
* @param {Object} state
* @return {Array}
*/
getSuggestedHtmlFunctions: function ( state ) {
return state.suggestedHtmlFunctions;
},
/**
* Given a section Qid and a language Zid, returns how many fragments
* are either missing or returned a pending state.
*
* @param {Object} state
* @return {Function}
*/
getPendingCount: function ( state ) {
/**
* @param {string} sectionQid
* @param {string} language
* @return {number}
*/
return ( sectionQid, language ) => {
const hashes = state.sectionHashes[ sectionQid ] || [];
// No fragments, not pending
if ( hashes.length === 0 ) {
return false;
}
// Filter pending (or missing) fragments
const pending = hashes.filter( ( hash ) => {
const fragmentKey = `${ hash }:${ language }`;
const fragment = state.fragments[ fragmentKey ];
return !fragment || fragment.isPending;
} );
return pending.length;
};
},
/**
* Given a section Qid and a language Zid, returns true if any of the
* section fragments is either missing or returned a pending state.
*
* @return {Function}
*/
isSectionPending: function () {
/**
* @param {string} sectionQid
* @param {string} language
* @return {boolean}
*/
return ( sectionQid, language ) => this.getPendingCount( sectionQid, language ) > 0;
},
/**
* @param {Object} state
* @return {Function}
*/
isLanguageSeen: function ( state ) {
/**
* @param {string} language
* @return {boolean}
*/
return ( language ) => Object.keys( state.fragments )
.some( ( key ) => key.split( ':' )[ 1 ] === language );
}
},
actions: {
/**
* Sets the Abstract Wiki content Id in the store and inside the Abstract Content json
*
* @param {string} qid
*/
setAbstractWikiId: function ( qid ) {
this.qid = qid;
this.jsonObject[ Constants.STORED_OBJECTS.ABSTRACT ][ Constants.ABSTRACT_WIKI_QID ] = qid;
},
/**
* @param {string} sectionQid
* @param {Array} sectionHashes
*/
setAbstractSectionHashes: function ( sectionQid, sectionHashes ) {
this.sectionHashes[ sectionQid ] = sectionHashes;
},
/**
* Targetted setter for sectionQid,hashIndex with the new fragmentHash
*
* @param {string} sectionQid
* @param {number} hashIndex
* @param {string} fragmentHash
*/
setAbstractFragmentHash: function ( sectionQid, hashIndex, fragmentHash ) {
if ( !this.sectionHashes[ sectionQid ] ) {
this.sectionHashes[ sectionQid ] = [];
}
this.sectionHashes[ sectionQid ][ hashIndex ] = fragmentHash;
},
/**
* Sets the language Zid used for rendering the Abstract preview.
*
* @param {string} zid
*/
setPreviewLanguageZid: function ( zid ) {
this.previewLanguageZid = zid;
},
/**
* Initializes the store for reading or editing an Abstract Content page,
* given the values passed down through mw.config.
*
* The config values we need are:
* * Subpage or qid url param: this.getWikilambdaConfig.title
* * String with Json content for the AW page: this.getWikilambdaConfig.content
*
* After storing the data, we gather all Wikifunctions and Wikidata object IDs
* and we fetch them from their respective remote services so that we can:
* * Labelize the page title and the sections (Wikidata Item Ids)
* * Labelize the function calls that generate fragments (Wikifunctions ZObject Ids)
*
* @return {Promise}
*/
initializeAbstractWikiContent: function () {
const { content: wikilambdaContent, title } = this.getWikilambdaConfig;
const content = JSON.parse( wikilambdaContent );
// Transform ZObject fragments from canonical to hybrid
for ( const qid in content[ Constants.ABSTRACT_WIKI_SECTIONS ] ) {
const section = content[ Constants.ABSTRACT_WIKI_SECTIONS ][ qid ];
section[ Constants.ABSTRACT_WIKI_SECTION_FRAGMENTS ] = canonicalToHybrid(
section[ Constants.ABSTRACT_WIKI_SECTION_FRAGMENTS ]
);
}
this.setJsonObject( {
namespace: Constants.STORED_OBJECTS.ABSTRACT,
zobject: content
} );
this.setAbstractWikiId( title );
// Initialize hashes for all fragments for all sections
const hashPromises = [];
for ( const qid in content[ Constants.ABSTRACT_WIKI_SECTIONS ] ) {
const section = content[ Constants.ABSTRACT_WIKI_SECTIONS ][ qid ];
const fragments = section[ Constants.ABSTRACT_WIKI_SECTION_FRAGMENTS ].slice( 1 );
const fragmentHashPromises = fragments.map( ( fragment ) => (
sha256( JSON.stringify( stabilize( fragment ) ) ) ) );
const sectionHashPromise = Promise.all( fragmentHashPromises ).then( ( hashes ) => {
this.setAbstractSectionHashes( qid, hashes );
} );
hashPromises.push( sectionHashPromise );
}
// Initialize suggested fragment functions. Configured via CommunityConfiguration
// (see MediaWiki:AbstractWikiSuggestedWikifunctions.json; T394410) and exposed
// server-side in onMakeGlobalVariablesScript. The schema pattern-validates each
// entry at save time; the filter here is defence in depth.
const suggestedZids = ( mw.config.get( 'wgWikiLambdaAbstractSuggestions' ) || [] )
.filter( ( item ) => isValidZidFormat( item ) );
this.setSuggestedHtmlFunctions( suggestedZids );
// Prefetch mentioned zids in content (async)
const zids = extractZIDs( content );
this.fetchZids( { zids: [ ...zids, ...suggestedZids ] } );
// Prefetch mentioned qids in content (async);
// if creating a new Abstract Article, also the page title qid
const qids = extractWikidataItemIds( content );
if ( isWikidataQid( title ) ) {
qids.push( title );
}
this.fetchItems( { ids: [ ... new Set( qids ) ] } );
// Set page as initialized when all the hashing is done
return Promise.all( hashPromises ).then( () => {
this.setInitialized( true );
} );
},
/**
* Validates the current Abstract Wiki content before submission.
* Does not stop publish, but shows error states for empty references,
* giving the editor the chance of fixing them, but allowing publish
* in case the issues are unrelated to the current changes.
*
* Checks:
* * Abstract content does not have any empty references
*
* @return {boolean}
*/
validateAbstractWikiContent: function () {
// Check for empty Z9K1 references, display as error, fail validation
const emptyReferences = this.getEmptyReferencesKeyPaths( Constants.STORED_OBJECTS.ABSTRACT );
emptyReferences.forEach( ( keyPath ) => {
this.setError( {
errorId: keyPath,
errorMessageKey: 'wikilambda-empty-reference-warning',
errorType: Constants.ERROR_TYPES.ERROR
} );
} );
return true;
},
/**
* Submits a valid Abstract Wiki Content object for creation/edit
*
* @param {Object} payload
* @param {string} payload.summary
* @return {Promise}
*/
submitAbstractWikiContent: function ( { summary } ) {
// Build title with primary namespace and qid
const title = buildAbstractWikiTitle( this.getAbstractWikipediaNamespace, this.qid );
// Build content from stored object
const content = JSON.parse( JSON.stringify(
this.getZObjectByKeyPath( [ Constants.STORED_OBJECTS.ABSTRACT ] )
) );
// Transform ZObject fragments from hybrid to canonical
for ( const qid in content[ Constants.ABSTRACT_WIKI_SECTIONS ] ) {
const section = content[ Constants.ABSTRACT_WIKI_SECTIONS ][ qid ];
section[ Constants.ABSTRACT_WIKI_SECTION_FRAGMENTS ] = hybridToCanonical(
section[ Constants.ABSTRACT_WIKI_SECTION_FRAGMENTS ]
);
}
return saveAbstractWikiContent( {
title,
content,
summary
} );
},
// Section processing
// ==================
/**
* Returns the subset of fragment keys and fragments that still need
* to be requested. In view mode, returns all keys with no fragments
* (the server uses persisted data). In edit mode, skips fragments
* that are already fully retrieved.
*
* @param {Array} keys
* @param {Array} fragments
* @param {string} language
* @return {Array} tuple of [ neededKeys, neededFragments ]
*/
onlyNeededFragments: function ( keys, fragments, language ) {
// For view mode, we query without fragments and keep all
// original keys
if ( this.getViewMode ) {
return [ keys, undefined ];
}
// For edit mode, if the language was never seen, we return everything (canonicalized)
if ( !this.isLanguageSeen( language ) ) {
return [ keys, fragments.map( ( f ) => hybridToCanonical( f ) ) ];
}
const neededKeys = [];
const neededFragments = [];
// For every key, if the fragment doesnt exist or is pending, mark it as needed
keys.forEach( ( key, index ) => {
if ( !this.fragments[ key ] || this.fragments[ key ].isPending ) {
neededKeys.push( key );
neededFragments.push( hybridToCanonical( fragments[ index ] ) );
}
} );
return [ neededKeys, neededFragments ];
},
/**
* Fetches all the fragments for a given topic/section/language in their current
* stored state (success, failure, or pending).
*
* Keeps track of the promise indexed by all the involved fragment hashes, so that
* it stops any individual fragment requests while the whole section one is flying.
*
* @param {Object} payload
* @param {string} payload.topic
* @param {string} payload.section
* @param {Array} payload.fragments
* @param {Object} payload.fragmentHashes
* @param {string} payload.language
* @param {string} payload.date
* @return {Promise}
*/
fetchSectionPreview: async function ( payload ) {
const { section, language, fragments = [], fragmentHashes = [] } = payload;
// If we are in view mode and the language is already fully fetched, do nothing
if ( this.getViewMode &&
this.isLanguageSeen( language ) &&
!this.isSectionPending( section, language )
) {
return;
}
// Get only the stuff we need to get
const fragmentKeys = fragmentHashes.map( ( hash ) => `${ hash }:${ language }` );
const [ neededKeys, neededFragments ] = this.onlyNeededFragments( fragmentKeys, fragments, language );
// If after the filtering we are down to nothing, exit early
if ( neededKeys.length === 0 ) {
return;
}
// Set fragments as loading, without overwriting whatever data is available
neededKeys.forEach( ( key ) => {
if ( !this.fragments[ key ] ) {
this.fragments[ key ] = { isLoading: true };
} else if ( this.fragments[ key ].isPending ) {
this.fragments[ key ].isLoading = true;
}
} );
const sectionPromise = fetchAbstractWikiSection( {
topic: payload.topic,
date: payload.date,
section,
language,
fragments: neededFragments ? JSON.stringify( neededFragments ) : undefined
} ).then( ( data ) => {
// renderedFragments must have the same length as fragments
const renderedFragments = data[ section ] || [];
if ( neededKeys.length !== renderedFragments.length ) {
this.setError( {
errorId: payload.sectionPath,
errorType: Constants.ERROR_TYPES.ERROR,
errorMessageKey: 'apierror-abstractwiki_fetch_section-bad-fragments'
} );
return;
}
// Iterate over all fragment calls and send to processFragmentResponse
neededKeys.forEach( ( fragmentKey, index ) => {
this.processFragmentResponse( fragmentKey, renderedFragments[ index ] );
} );
} ).catch( ( /* ApiError */ error ) => {
this.setError( {
errorId: payload.sectionPath,
errorType: Constants.ERROR_TYPES.ERROR,
errorMessage: error.message
} );
} ).finally( () => {
neededKeys.forEach( ( fragmentKey ) => {
// Unset all the promises
this.fragmentPromises[ fragmentKey ] = undefined;
// Unset all isLoading (if any was left due to api error)
this.fragments[ fragmentKey ].isLoading = false;
} );
} );
// Store this promise for all involved fragment hashes, to avoid duplication
neededKeys.forEach( ( fragmentKey ) => {
this.fragmentPromises[ fragmentKey ] = sectionPromise;
} );
return sectionPromise;
},
/**
* Processes all the possible fragment values received from both the
* abstractwiki_fetch_section and abstractwiki_run_fragment APIs.
* The possible fragment values are:
* * Success:
* - success: true
* - value: html blob
* * Pending:
* - success: true
* - pending: true
* - value: pending html blob
* * Error:
* - success: false
* - value:
* - msg: apierror-abstractwiki_run_fragment-returned-zerror
* - httpStatusCode: 400
* - zerror: { ... }
* - params: [ 'Z528' ]
*
* @param {string} fragmentKey
* @param {Object} result
* @param {Function} job
*/
processFragmentResponse: function ( fragmentKey, result, job = null ) {
// Extract language from fragmentKey (hash:language)
const language = fragmentKey.split( ':' )[ 1 ];
// Initialize payload for the setter
const fragmentPayload = { language };
if ( result && result.pending ) {
// Handle pending fragment:
// ========================
// Queue retry if possible
const fragmentStatus = this.fragments[ fragmentKey ];
// If reached max retries or no job to queue, set fragment as pending and stop trying
const noRetry = !job || !fragmentStatus || fragmentStatus.retryCount === undefined;
if ( noRetry || ++fragmentStatus.retryCount >= MAX_FRAGMENT_RETRIES ) {
fragmentPayload.isPending = true;
} else {
// Else, queue retry with exponential backoff to avoid stampeding
// the server. retryCount has just been incremented, so the first
// retry (retryCount === 1) waits INITIAL_RETRY_DELAY, the second
// waits INITIAL_RETRY_DELAY * RETRY_BACKOFF_FACTOR, and so on.
const backoffDelay = INITIAL_RETRY_DELAY *
Math.pow( RETRY_BACKOFF_FACTOR, fragmentStatus.retryCount - 1 );
setTimeout( () => {
this.enqueueFragmentPreview( job );
}, backoffDelay );
// After retry is queued, we exit without running the setter
return;
}
} else if ( result && result.success ) {
// Handle successful fragment:
// ==========================
fragmentPayload.html = result.value;
fragmentPayload.isPending = false;
} else {
// Handle failed fragment:
// =======================
// This handler a fragment with success=false and stored failure information.
// In case the error comes from a different layer (e.g. API failure), it should
// be handled in the request catch blocks.
const error = { type: Constants.ERROR_TYPES.ERROR, retry: false };
if ( result && result.value && result.value.msg ) {
// Predictable fragment failure information contains msg and params with zid
error.code = result.value.msg;
error.zid = ( Array.isArray( result.value.params ) && result.value.params[ 0 ] ) ?
result.value.params[ 0 ] : '';
// Fetch in case it's a zid;
// fetchZids discards the item if not valid, so no need to guard here
this.fetchZids( { zids: [ error.zid ] } );
} else {
// Undefined error message if no msg provided:
error.text = mw.message( 'apierror-abstractwiki_run_fragment-unknown-error' ).text();
}
fragmentPayload.error = error;
}
// Set final rendered fragment
this.setRenderedFragment( fragmentKey, fragmentPayload );
},
// Fragment processing
// ===================
/**
* Adds a new job to the fragment preview request queue,
* and resumes the action to process the jobs in the queue.
*
* @param {Function} job
*/
enqueueFragmentPreview: function ( job ) {
this.fragmentQueue.push( job );
this.processFragmentQueue();
},
/**
* Initializes the processing of the fragment rendering
* jobs pending in the queue. It runs one job every FRAGMENT_QUEUE_TIMEOUT
* miliseconds. Once there are no more jobs in the queue, it sets queueRunning
* flag to false.
*/
processFragmentQueue() {
if ( this.queueRunning ) {
return;
}
this.queueRunning = true;
const processNextJob = () => {
if ( this.fragmentQueue.length === 0 ) {
this.queueRunning = false;
return;
}
const nextJob = this.fragmentQueue.shift();
nextJob();
setTimeout( processNextJob, FRAGMENT_QUEUE_TIMEOUT );
};
processNextJob();
},
/**
* Call the API to render the Abstract Wiki fragment and
* store the response in the state
*
* @param {Object} payload
* @param {string} payload.fragmentHash
* @param {string} payload.qid
* @param {string} payload.language
* @param {string} payload.date
* @param {Object} payload.fragment
*/
renderFragmentPreview: function ( payload ) {
const fragmentKey = `${ payload.fragmentHash }:${ payload.language }`;
// Fragment request in flight, exit
if ( this.fragmentPromises[ fragmentKey ] ) {
return;
}
// Fragment not initialized yet: set initial object for key
if ( !( fragmentKey in this.fragments ) ) {
this.fragments[ fragmentKey ] = { retryCount: 0 };
}
const fragmentStatus = this.fragments[ fragmentKey ];
// If fragment is already generated or request ongoing, exit
if ( fragmentStatus.isLoading ) {
return;
}
// Else, initiate rendering call
fragmentStatus.isLoading = true;
// Build request job and enqueue it
const job = () => this.requestFragmentPreview( payload, job );
this.enqueueFragmentPreview( job );
},
/**
* @param {Object} payload
* @param {string} payload.fragmentHash
* @param {string} payload.qid
* @param {string} payload.language
* @param {string} payload.date
* @param {Object} payload.fragment
* @param {Function} job
* @return {Promise}
*/
requestFragmentPreview: function ( payload, job ) {
const { language } = payload;
const fragmentKey = `${ payload.fragmentHash }:${ language }`;
return runAbstractWikiFragment( {
language,
qid: payload.qid,
date: payload.date,
fragment: payload.fragment
} ).then( ( data ) => {
// Processes both successful and failed fragments
this.processFragmentResponse( fragmentKey, data, job );
} ).catch( ( /* ApiError */ error ) => {
const errorPayload = {
type: Constants.ERROR_TYPES.ERROR,
retry: ( error.httpStatus === 500 || error.httpStatus === 503 ),
text: error.messageOrFallback( 'apierror-abstractwiki_run_fragment-unknown-error' )
};
this.setRenderedFragment( fragmentKey, { error: errorPayload } );
} );
},
/**
* Save fragment rendered output and dirty/loading status in the state
*
* @param {string} key
* @param {Object} payload
* @param {string|undefined} payload.html
* @param {boolean|undefined} payload.isPending
* @param {boolean|undefined} payload.isLoading
* @param {Object|undefined} payload.error
* @param {string|null} payload.error.text
* @param {string|null} payload.error.code
* @param {string|null} payload.error.zid
* @param {string|null} payload.error.type
*/
setRenderedFragment: function ( key, payload ) {
const { html = '', error, isLoading = false, isPending = false } = payload;
// Initialize payload if it doesn't exist
if ( !( key in this.fragments ) ) {
this.fragments[ key ] = { retryCount: 0 };
}
this.fragments[ key ].error = error || null;
this.fragments[ key ].html = !error ? html : '';
this.fragments[ key ].isPending = isPending;
this.fragments[ key ].isLoading = isLoading;
this.fragments[ key ].hasError = !!error;
},
/**
* Inserts a blank or given hash into the sectionHashes structure
* for a given fragment keyPath. The fragment index in the path is
* padded by the benjamin item, while the elements in the hash array
* aren't; so the fragment with the path ended in `fragments.2`
* corresponds to the second fragment, and hence second hash in the list
* (index=1).
*
* E.g. When given the keyPath `abstractwiki.sections.Q1.fragments.2`
* It will insert a given or blank element at sectionHashes[ 'Q1' ][ 1 ]
*
* @param {string} keyPath
* @param {string|undefined} hash
*/
insertHashAtKeyPath: function ( keyPath, hash = null ) {
const parts = keyPath.split( '.' );
const sectionQid = parts[ 2 ];
// index in the path is benjamin-padded, decrement for the hash index:
const index = parseInt( parts[ parts.length - 1 ] ) - 1;
// Initialize hashes for this section if they don't exist
if ( !this.sectionHashes[ sectionQid ] ) {
this.sectionHashes[ sectionQid ] = [];
}
this.sectionHashes[ sectionQid ].splice( index, 0, hash );
},
/**
* Removes a hash from the sectionHashes structure for a given fragment keyPath.
*
* E.g. When given the keyPath `abstractwiki.sections.Q1.fragments.2`
* It will remove the element at sectionHashes[ 'Q1' ][ 1 ] and shift
*
* @param {string} keyPath
*/
deleteHashAtKeyPath: function ( keyPath ) {
const parts = keyPath.split( '.' );
const sectionQid = parts[ 2 ];
const index = parseInt( parts[ parts.length - 1 ] ) - 1;
if ( !this.sectionHashes[ sectionQid ] ) {
return;
}
this.sectionHashes[ sectionQid ].splice( index, 1 );
},
/**
* Swaps a hash in the sectionHashes structure with the adjacent
* element at the given offset.
*
* E.g. When given the keyPath `abstractwiki.sections.Q1.fragments.2`
* and offset -1, it will swap sectionHashes[ 'Q1' ][ 1 ] with [ 0 ]
*
* @param {string} keyPath
* @param {number} offset -1 or 1
*/
swapHashAtKeyPath: function ( keyPath, offset ) {
const parts = keyPath.split( '.' );
const sectionQid = parts[ 2 ];
const index = parseInt( parts[ parts.length - 1 ] ) - 1;
const hashes = this.sectionHashes[ sectionQid ];
if ( !hashes ) {
return;
}
const swapIndex = index + offset;
if ( swapIndex < 0 || swapIndex >= hashes.length ) {
return;
}
[ hashes[ index ], hashes[ swapIndex ] ] = [ hashes[ swapIndex ], hashes[ index ] ];
},
/**
* Set a given fragment keyPath as highlighted
*
* @param {string|undefined} keyPath
*/
setHighlightedFragment: function ( keyPath ) {
this.highlight = keyPath;
},
/**
* Sets a list of zids as suggested functions that return HTML fragments
*
* @param {Array} zids
*/
setSuggestedHtmlFunctions: function ( zids ) {
this.suggestedHtmlFunctions = zids;
}
}
};
module.exports = abstractWikiStore;
|