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
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\JobQueue\Jobs;
use MediaWiki\JobQueue\Job;
use MediaWiki\JobQueue\JobSpecification;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\Page\PageLookup;
use MediaWiki\Page\PageRecord;
use MediaWiki\Page\ParserOutputAccess;
use MediaWiki\Parser\ParserOptions;
use MediaWiki\Parser\Parsoid\Config\SiteConfig as ParsoidSiteConfig;
use MediaWiki\Revision\RevisionLookup;
use MediaWiki\Revision\SlotRecord;
use Psr\Log\LoggerInterface;
/**
* @ingroup JobQueue
* @internal
* @since 1.40
*/
class ParsoidCachePrewarmJob extends Job {
private LoggerInterface $logger;
private ParserOutputAccess $parserOutputAccess;
private PageLookup $pageLookup;
private RevisionLookup $revisionLookup;
private ParsoidSiteConfig $parsoidSiteConfig;
/**
* @param array $params
* @param ParserOutputAccess $parserOutputAccess
* @param PageLookup $pageLookup
* @param RevisionLookup $revisionLookup
* @param ParsoidSiteConfig $parsoidSiteConfig
*/
public function __construct(
array $params,
ParserOutputAccess $parserOutputAccess,
PageLookup $pageLookup,
RevisionLookup $revisionLookup,
ParsoidSiteConfig $parsoidSiteConfig
) {
parent::__construct( 'parsoidCachePrewarm', $params );
// TODO: find a way to inject the logger
$this->logger = LoggerFactory::getInstance( 'ParsoidCachePrewarmJob' );
$this->parserOutputAccess = $parserOutputAccess;
$this->pageLookup = $pageLookup;
$this->revisionLookup = $revisionLookup;
$this->parsoidSiteConfig = $parsoidSiteConfig;
}
/**
* @param int $revisionId
* @param PageRecord $page
* @param array $params Additional options for the job. Known keys:
* - causeAction: Indicate what action caused the job to be scheduled. Used for monitoring.
* - options: Flags to be passed to ParserOutputAccess:getParserOutput.
* May be set to ParserOutputAccess::OPT_FORCE_PARSE to force a parsing even if there
* already is cached output.
*
* @return JobSpecification
*/
public static function newSpec(
int $revisionId,
PageRecord $page,
array $params = []
): JobSpecification {
$pageId = $page->getId();
$pageTouched = $page->getTouched();
$params += [ 'options' => 0 ];
$params += self::newRootJobParams(
"parsoidCachePrewarm:$pageId:$revisionId:$pageTouched:{$params['options']}"
);
$opts = [ 'removeDuplicates' => true ];
return new JobSpecification(
'parsoidCachePrewarm',
[
'revId' => $revisionId,
'pageId' => $pageId,
'page_touched' => $pageTouched,
] + $params,
$opts
);
}
private function doParsoidCacheUpdate() {
$page = $this->pageLookup->getPageById( $this->params['pageId'] );
$revId = $this->params['revId'];
if ( $page === null ) {
// This happens when the page got deleted in the meantime.
$this->logger->info( "Page with ID {$this->params['pageId']} not found" );
return;
}
if ( $page->getLatest() !== $revId ) {
$this->logger->info(
'ParsoidCachePrewarmJob: The ID of the new revision does not match the page\'s current revision ID'
);
return;
}
$rev = $this->revisionLookup->getRevisionById( $revId );
if ( !$rev ) {
return;
}
$parserOpts = ParserOptions::newFromAnon();
$parserOpts->setUseParsoid();
$renderReason = $this->params['causeAction'] ?? $this->command;
$parserOpts->setRenderReason( $renderReason );
$mainSlot = $rev->getSlot( SlotRecord::MAIN );
if ( !$this->parsoidSiteConfig->supportsContentModel( $mainSlot->getModel() ) ) {
$this->logger->debug( __METHOD__ . ': Parsoid does not support content model ' . $mainSlot->getModel() );
return;
}
$this->logger->debug( __METHOD__ . ': generating Parsoid output' );
// We may get the OPT_FORCE_PARSE flag this way
$options = $this->params['options'] ?? 0;
// getParserOutput() will write to ParserCache.
$status = $this->parserOutputAccess->getParserOutput(
$page,
$parserOpts,
$rev,
$options
);
if ( !$status->isOK() ) {
$this->logger->error( __METHOD__ . ': Parsoid error', [
'errors' => $status->getErrors(),
'page' => $page->getDBkey(),
'rev' => $rev->getId(),
] );
}
}
public function run() {
$this->doParsoidCacheUpdate();
return true;
}
}
/** @deprecated class alias since 1.44 */
class_alias( ParsoidCachePrewarmJob::class, 'ParsoidCachePrewarmJob' );
|
