-
Notifications
You must be signed in to change notification settings - Fork 554
/
LiveBlogCurrentPage.scala
301 lines (255 loc) · 10.1 KB
/
LiveBlogCurrentPage.scala
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
package model
import model.liveblog.BodyBlock.{KeyEvent, SummaryEvent}
import model.liveblog.{Blocks, BodyBlock}
case class LiveBlogCurrentPage(
currentPage: PageReference,
pagination: Option[N1Pagination],
pinnedBlock: Option[BodyBlock],
)
// Extends normal Pages due to the need for pagination and since-last-seen logic on
object LiveBlogCurrentPage {
def apply(
pageSize: Int,
blocks: Blocks,
range: BlockRange,
filterKeyEvents: Boolean,
topicResult: Option[TopicResult],
): Option[LiveBlogCurrentPage] = {
range match {
case CanonicalLiveBlog | TopicsLiveBlog => firstPage(pageSize, blocks, filterKeyEvents, topicResult)
case PageWithBlock(isRequestedBlock) =>
findPageWithBlock(pageSize, blocks.body, isRequestedBlock, filterKeyEvents, topicResult)
case SinceBlockId(blockId) => updates(blocks, SinceBlockId(blockId), filterKeyEvents, topicResult)
case ArticleBlocks => None
case GenericFallback => None
case _ => None
}
}
// filters newer blocks out of the list
def updates(
blocks: Blocks,
sinceBlockId: SinceBlockId,
filterKeyEvents: Boolean,
topicResult: Option[TopicResult],
): Option[LiveBlogCurrentPage] = {
val bodyBlocks = blocks.requestedBodyBlocks.get(sinceBlockId.around).toSeq.flatMap { bodyBlocks =>
val onlyBlocksAfterLastUpdated = bodyBlocks.takeWhile(_.id != sinceBlockId.lastUpdate)
applyFilters(onlyBlocksAfterLastUpdated, filterKeyEvents, topicResult)
}
Some(
LiveBlogCurrentPage(FirstPage(bodyBlocks, filterKeyEvents, topicResult), None, None),
) // just pretend to be the first page, it'll be ignored
}
// turns the slimmed down (to save bandwidth) capi response into a first page model object
def firstPage(
pageSize: Int,
blocks: Blocks,
filterKeyEvents: Boolean,
topicResult: Option[TopicResult],
): Option[LiveBlogCurrentPage] = {
val (maybeRequestedBodyBlocks, blockCount, oldestPageBlockId) =
extractFirstPageBlocks(blocks, filterKeyEvents, topicResult)
val remainder = blockCount % pageSize
val numPages = blockCount / pageSize
maybeRequestedBodyBlocks.map { requestedBodyBlocks =>
val (firstPageBlocks, startOfSecondPageBlocks) = requestedBodyBlocks.splitAt(remainder + pageSize)
val olderPage = startOfSecondPageBlocks.headOption.map { block =>
BlockPage(blocks = Nil, blockId = block.id, pageNumber = 2, filterKeyEvents, topicResult)
}
val oldestPage = oldestPageBlockId map { blockId =>
BlockPage(blocks = Nil, blockId = blockId, pageNumber = numPages, filterKeyEvents, topicResult)
}
val pinnedBlocks = blocks.requestedBodyBlocks.get(CanonicalLiveBlog.pinned)
val pinnedBlock = pinnedBlocks.flatMap(_.headOption)
val blocksToDisplay = removeFirstBlockIfPinned(firstPageBlocks, pinnedBlock)
val pinnedBlockRenamed = pinnedBlock.map(renamePinnedBlock)
val pagination = {
if (blockCount > firstPageBlocks.size)
Some(
N1Pagination(
newest = None,
newer = None,
oldest = oldestPage,
older = olderPage,
numberOfPages = numPages,
),
)
else None
}
LiveBlogCurrentPage(FirstPage(blocksToDisplay, filterKeyEvents, topicResult), pagination, pinnedBlockRenamed)
}
}
private def extractFirstPageBlocks(
blocks: Blocks,
filterKeyEvents: Boolean,
topicResult: Option[TopicResult],
) = {
if (filterKeyEvents) {
getKeyEventsBlocks(blocks)
} else if (topicResult.isDefined) {
getTopicBlocks(blocks, topicResult.get)
} else {
getStandardBlocks(blocks)
}
}
private def isTopicBlock(topic: TopicResult)(bodyBlock: BodyBlock): Boolean = {
topic.blocks.contains(bodyBlock.id)
}
private def filterBlocksByTopic(blocks: Seq[BodyBlock], topic: TopicResult) = {
blocks.filter(isTopicBlock(topic)).sortBy(_.publishedCreatedTimestamp).reverse
}
private def getTopicBlocks(
blocks: Blocks,
topic: TopicResult,
): (Option[Seq[BodyBlock]], Int, Option[String]) = {
val bodyBlocks = blocks.body
val filteredBodyBlocks = filterBlocksByTopic(bodyBlocks, topic)
(Some(filteredBodyBlocks), filteredBodyBlocks.length, filteredBodyBlocks.lastOption.map(_.id))
}
private def getStandardBlocks(blocks: Blocks): (Option[Seq[BodyBlock]], Int, Option[String]) = {
val firstPageBlocks = blocks.requestedBodyBlocks.get(CanonicalLiveBlog.firstPage)
val oldestPageBlockId =
blocks.requestedBodyBlocks.get(CanonicalLiveBlog.oldestPage) flatMap (_.headOption.map(_.id))
(firstPageBlocks, blocks.totalBodyBlocks, oldestPageBlockId)
}
private def getKeyEventsBlocks(blocks: Blocks) = {
val keyEventsAndSummaries = for {
keyEvents <- blocks.requestedBodyBlocks.get(CanonicalLiveBlog.timeline)
summaries <- blocks.requestedBodyBlocks.get(CanonicalLiveBlog.summary)
} yield {
(keyEvents ++ summaries).sortBy(_.publishedCreatedTimestamp).reverse
}
val keyEventsAndSummariesCount = keyEventsAndSummaries.getOrElse(Seq.empty).size
val oldestPageBlockId = keyEventsAndSummaries.flatMap(_.lastOption map (_.id))
(keyEventsAndSummaries, keyEventsAndSummariesCount, oldestPageBlockId)
}
private def removeFirstBlockIfPinned(firstPageBlocks: Seq[BodyBlock], pinnedBlock: Option[BodyBlock]) = {
firstPageBlocks match {
case firstBlock +: otherBlocks if pinnedBlock.contains(firstBlock) => otherBlocks
case _ => firstPageBlocks
}
}
// turns a full capi blocks list into a page model of the page with a specific block in it
def findPageWithBlock(
pageSize: Int,
blocks: Seq[BodyBlock],
isRequestedBlock: String,
filterKeyEvents: Boolean,
topicResult: Option[TopicResult],
): Option[LiveBlogCurrentPage] = {
val pinnedBlock = blocks.find(_.attributes.pinned).map(renamePinnedBlock)
val filteredBlocks = applyFilters(blocks, filterKeyEvents, topicResult)
val (mainPageBlocks, restPagesBlocks) = getPages(pageSize, filteredBlocks)
val newestPage = FirstPage(mainPageBlocks, filterKeyEvents, topicResult)
val pages = newestPage :: restPagesBlocks.zipWithIndex
.map {
case (page, index) =>
// page number is index + 2 to account for first page and 0 based index
BlockPage(blocks = page, blockId = page.head.id, pageNumber = index + 2, filterKeyEvents, topicResult)
}
val oldestPage = pages.lastOption.getOrElse(newestPage)
val endedPages = None :: (pages.map(Some.apply) :+ None)
def hasRequestedBlock(page: LiveBlogCurrentPage): Boolean = {
page.currentPage.blocks.exists(_.id == isRequestedBlock)
}
endedPages
.sliding(3)
.toList
.map {
case List(newerPage, Some(currentPage), olderPage) =>
val isNewestPage = newestPage.equals(currentPage)
LiveBlogCurrentPage(
currentPage = currentPage,
pagination =
if (pages.length > 1)
Some(
N1Pagination(
newest = if (isNewestPage) None else Some(newestPage),
newer = newerPage,
oldest = if (oldestPage.equals(currentPage)) None else Some(oldestPage),
older = olderPage,
numberOfPages = pages.length,
),
)
else None,
if (isNewestPage) pinnedBlock else None,
)
}
.find(hasRequestedBlock)
}
private def renamePinnedBlock(pinnedBlock: BodyBlock): BodyBlock = {
pinnedBlock.copy(id = s"${pinnedBlock.id}-pinned")
}
private def applyFilters(
blocks: Seq[BodyBlock],
filterKeyEvents: Boolean,
topicResult: Option[TopicResult],
) = {
if (filterKeyEvents) {
blocks.filter(block => block.eventType == KeyEvent || block.eventType == SummaryEvent)
} else if (topicResult.isDefined) {
filterBlocksByTopic(blocks, topicResult.get)
} else {
blocks
}
}
// returns the pages, newest at the end, newest at the start
private def getPages[B](pageSize: Int, blocks: Seq[B]): (Seq[B], List[Seq[B]]) = {
val length = blocks.size
val remainder = length % pageSize
val (main, rest) = blocks.splitAt(remainder + pageSize)
(main, rest.grouped(pageSize).toList)
}
}
sealed trait PageReference {
def blocks: Seq[BodyBlock]
def suffix: String
def pageNumber: Int
def isArchivePage: Boolean
def buildQueryParam(topicResult: Option[TopicResult]) = {
topicResult match {
case Some(value) => s"&topics=${value.`type`}:${value.name}"
case None => ""
}
}
}
case class N1Pagination(
newest: Option[PageReference],
newer: Option[PageReference],
oldest: Option[PageReference],
older: Option[PageReference],
numberOfPages: Int,
)
case class FirstPage(blocks: Seq[BodyBlock], filterKeyEvents: Boolean, topicResult: Option[TopicResult])
extends PageReference {
val suffix = s"?filterKeyEvents=$filterKeyEvents${buildQueryParam(topicResult)}"
val pageNumber = 1
val isArchivePage = false
}
case class BlockPage(
blocks: Seq[BodyBlock],
blockId: String,
pageNumber: Int,
filterKeyEvents: Boolean,
topicResult: Option[TopicResult],
) extends PageReference {
val suffix = s"?page=with:block-$blockId&filterKeyEvents=$filterKeyEvents${buildQueryParam(topicResult)}"
val isArchivePage = true
}
object LatestBlock {
def apply(maybeBlocks: Option[Blocks]): Option[String] = {
maybeBlocks.flatMap { blocks =>
blocks.requestedBodyBlocks.getOrElse(CanonicalLiveBlog.firstPage, blocks.body).headOption.map(_.id)
}
}
}
object LatestKeyBlock {
def apply(maybeBlocks: Option[Blocks]): Option[String] = {
maybeBlocks.flatMap { blocks =>
blocks.requestedBodyBlocks
.getOrElse(CanonicalLiveBlog.firstPage, blocks.body)
.find(block => block.eventType == KeyEvent || block.eventType == SummaryEvent)
.map(_.id)
}
}
}