tests/phpunit/includes/jobqueue/jobs/ParsoidCachePrewarmJobTest.php

   1 <?php
   2
   3 use MediaWiki\Config\ServiceOptions;
   4 use MediaWiki\MediaWikiServices;
   5 use MediaWiki\OutputTransform\Stages\RenderDebugInfo;
   6 use MediaWiki\Page\PageIdentity;
   7 use MediaWiki\Page\PageIdentityValue;
   8 use MediaWiki\Page\PageRecord;
   9 use MediaWiki\Parser\ParserOptions;
  10 use Psr\Log\NullLogger;
  11 use Wikimedia\TestingAccessWrapper;
  12
  13 /**
  14  * @group JobQueue
  15  * @group Database
  16  *
  17  * @license GPL-2.0-or-later
  18  */
  19 class ParsoidCachePrewarmJobTest extends MediaWikiIntegrationTestCase {
  20
  21         private const NON_JOB_QUEUE_EDIT = 'parsoid edit not executed by job queue';
  22         private const JOB_QUEUE_EDIT = 'parsoid edit executed by job queue';
  23
  24         private function getPageIdentity( PageRecord $page ): PageIdentityValue {
  25                 return PageIdentityValue::localIdentity(
  26                         $page->getId(),
  27                         $page->getNamespace(),
  28                         $page->getDBkey()
  29                 );
  30         }
  31
  32         private function getPageRecord( PageIdentity $page ): PageRecord {
  33                 return $this->getServiceContainer()->getPageStore()
  34                         ->getPageByReference( $page );
  35         }
  36
  37         /**
  38          * @covers \ParsoidCachePrewarmJob::doParsoidCacheUpdate
  39          * @covers \ParsoidCachePrewarmJob::newSpec
  40          * @covers \ParsoidCachePrewarmJob::run
  41          */
  42         public function testRun() {
  43                 $page = $this->getExistingTestPage( 'ParsoidPrewarmJob' )->toPageRecord();
  44                 $rev1 = $this->editPage( $page, self::NON_JOB_QUEUE_EDIT )->getNewRevision();
  45
  46                 $parsoidPrewarmJob = new ParsoidCachePrewarmJob(
  47                         [ 'revId' => $rev1->getId(), 'pageId' => $page->getId() ],
  48                         $this->getServiceContainer()->getParserOutputAccess(),
  49                         $this->getServiceContainer()->getPageStore(),
  50                         $this->getServiceContainer()->getRevisionLookup(),
  51                         $this->getServiceContainer()->getParsoidSiteConfig()
  52                 );
  53
  54                 // NOTE: calling ->run() will not run the job scheduled in the queue but will
  55                 //       instead call doParsoidCacheUpdate() directly. Will run the job and assert
  56                 //       below.
  57                 $execStatus = $parsoidPrewarmJob->run();
  58                 $this->assertTrue( $execStatus );
  59
  60                 $popts = ParserOptions::newFromAnon();
  61                 $popts->setUseParsoid();
  62                 $parsoidOutput = $this->getServiceContainer()->getParserOutputAccess()->getCachedParserOutput(
  63                         $this->getPageRecord( $this->getPageIdentity( $page ) ),
  64                         $popts,
  65                         $rev1
  66                 );
  67
  68                 // Ensure we have the parsoid output in parser cache as an HTML document
  69                 $this->assertStringContainsString( '<html', $parsoidOutput->getRawText() );
  70                 $this->assertStringContainsString( self::NON_JOB_QUEUE_EDIT, $parsoidOutput->getRawText() );
  71
  72                 $rev2 = $this->editPage( $page, self::JOB_QUEUE_EDIT )->getNewRevision();
  73                 // Post-edit, reset all services!
  74                 // ParserOutputAccess has a localCache which can incorrectly return stale
  75                 // content for the previous revision! Resetting ensures that ParsoidCachePrewarmJob
  76                 // gets a fresh copy of ParserOutputAccess.
  77                 $this->resetServices();
  78
  79                 $parsoidPrewarmJob = new ParsoidCachePrewarmJob(
  80                         [ 'revId' => $rev2->getId(), 'pageId' => $page->getId(), 'causeAction' => 'just for testing' ],
  81                         $this->getServiceContainer()->getParserOutputAccess(),
  82                         $this->getServiceContainer()->getPageStore(),
  83                         $this->getServiceContainer()->getRevisionLookup(),
  84                         $this->getServiceContainer()->getParsoidSiteConfig()
  85                 );
  86
  87                 $jobQueueGroup = $this->getServiceContainer()->getJobQueueGroup();
  88                 $jobQueueGroup->get( $parsoidPrewarmJob->getType() )->delete();
  89                 $jobQueueGroup->push( $parsoidPrewarmJob );
  90
  91                 // At this point, we have 1 job scheduled for this job type.
  92                 $this->assertSame( 1, $jobQueueGroup->getQueueSizes()['parsoidCachePrewarm'] );
  93
  94                 // doParsoidCacheUpdate() now with a job queue instead of calling directly.
  95                 $this->runJobs( [ 'maxJobs' => 1 ], [ 'type' => 'parsoidCachePrewarm' ] );
  96
  97                 // At this point, we have 0 jobs scheduled for this job type.
  98                 $this->assertSame( 0, $jobQueueGroup->getQueueSizes()['parsoidCachePrewarm'] );
  99
 100                 $parsoidOutput = $this->getServiceContainer()->getParserOutputAccess()->getCachedParserOutput(
 101                         $this->getPageRecord( $this->getPageIdentity( $page ) ),
 102                         $popts,
 103                         $rev2
 104                 );
 105
 106                 // Ensure we have the parsoid output in parser cache as an HTML document
 107                 $this->assertStringContainsString( '<html', $parsoidOutput->getRawText() );
 108                 $this->assertStringContainsString( self::JOB_QUEUE_EDIT, $parsoidOutput->getRawText() );
 109
 110                 $services = MediaWikiServices::getInstance();
 111                 $servicesOptions = new ServiceOptions(
 112                         RenderDebugInfo::CONSTRUCTOR_OPTIONS, $services->getMainConfig()
 113                 );
 114                 $rdi = TestingAccessWrapper::newFromObject(
 115                         new RenderDebugInfo( $servicesOptions, new NullLogger(), $services->getHookContainer() )
 116                 );
 117                 // Check that the causeAction was looped through as the render reason
 118                 $this->assertStringContainsString(
 119                         'triggered because: just for testing',
 120                         $rdi->debugInfo( $parsoidOutput )
 121                 );
 122         }
 123
 124         /**
 125          * @covers \ParsoidCachePrewarmJob::newSpec
 126          */
 127         public function testEnqueueSpec() {
 128                 $page = $this->getExistingTestPage( 'ParsoidPrewarmJob' )->toPageRecord();
 129                 $rev1 = $this->editPage( $page, self::NON_JOB_QUEUE_EDIT )->getNewRevision();
 130
 131                 $parsoidPrewarmSpec = ParsoidCachePrewarmJob::newSpec(
 132                         $rev1->getId(), $page,
 133                 );
 134
 135                 $this->assertSame( 'parsoidCachePrewarm', $parsoidPrewarmSpec->getType(), 'getType' );
 136
 137                 $dedupeInfo = $parsoidPrewarmSpec->getDeduplicationInfo();
 138                 $this->assertTrue( $dedupeInfo['params']['rootJobIsSelf'] );
 139                 $this->assertSame( $page->getTouched(), $dedupeInfo['params']['page_touched'] );
 140                 $this->assertSame( $rev1->getId(), $dedupeInfo['params']['revId'] );
 141                 $this->assertSame( $page->getId(), $dedupeInfo['params']['pageId'] );
 142
 143                 $jobQueueGroup = $this->getServiceContainer()->getJobQueueGroup();
 144                 $jobQueueGroup->get( $parsoidPrewarmSpec->getType() )->delete();
 145
 146                 $jobQueueGroup->push( $parsoidPrewarmSpec );
 147
 148                 // At this point, we have 1 job scheduled for this job type.
 149                 $this->assertSame( 1, $jobQueueGroup->getQueueSizes()['parsoidCachePrewarm'] );
 150
 151                 // Push again times, deduplication should apply!
 152                 $jobQueueGroup->push( $parsoidPrewarmSpec );
 153                 $jobQueueGroup->push( $parsoidPrewarmSpec );
 154
 155                 // We should still have just 1 job scheduled for this job type.
 156                 $this->assertSame( 1, $jobQueueGroup->getQueueSizes()['parsoidCachePrewarm'] );
 157         }
 158
 159 }