summaryrefslogtreecommitdiffstats
path: root/mobile/android/geckoview/src/androidTest/java/org/mozilla/geckoview/test/HistoryDelegateTest.kt
blob: a4ec7c3139f9528fab8a7f121c407dc18c240cf6 (plain)
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
/* -*- Mode: Java; c-basic-offset: 4; tab-width: 4; indent-tabs-mode: nil; -*-
 * Any copyright is dedicated to the Public Domain.
   http://creativecommons.org/publicdomain/zero/1.0/ */

package org.mozilla.geckoview.test

import androidx.test.ext.junit.runners.AndroidJUnit4
import androidx.test.filters.MediumTest
import org.hamcrest.Matchers.* // ktlint-disable no-wildcard-imports
import org.junit.Assume.assumeThat
import org.junit.Ignore
import org.junit.Test
import org.junit.runner.RunWith
import org.mozilla.geckoview.GeckoResult
import org.mozilla.geckoview.GeckoSession
import org.mozilla.geckoview.GeckoSession.HistoryDelegate
import org.mozilla.geckoview.test.rule.GeckoSessionTestRule.AssertCalled
import org.mozilla.geckoview.test.util.UiThreadUtils

@RunWith(AndroidJUnit4::class)
@MediumTest
class HistoryDelegateTest : BaseSessionTest() {
    companion object {
        // Keep in sync with the styles in `LINKS_HTML_PATH`.
        const val UNVISITED_COLOR = "rgb(0, 0, 255)"
        const val VISITED_COLOR = "rgb(255, 0, 0)"
    }

    @Test fun getVisited() {
        val testUri = createTestUrl(LINKS_HTML_PATH)
        sessionRule.delegateDuringNextWait(object : GeckoSession.HistoryDelegate {
            @AssertCalled(count = 1)
            override fun onVisited(
                session: GeckoSession,
                url: String,
                lastVisitedURL: String?,
                flags: Int,
            ): GeckoResult<Boolean>? {
                assertThat("Should pass visited URL", url, equalTo(testUri))
                assertThat("Should not pass last visited URL", lastVisitedURL, nullValue())
                assertThat(
                    "Should set visit flags",
                    flags,
                    equalTo(GeckoSession.HistoryDelegate.VISIT_TOP_LEVEL),
                )
                return GeckoResult.fromValue(true)
            }

            @AssertCalled(count = 1)
            override fun getVisited(
                session: GeckoSession,
                urls: Array<String>,
            ): GeckoResult<BooleanArray>? {
                val expected = arrayOf(
                    "https://mozilla.org/",
                    "https://getfirefox.com/",
                    "https://bugzilla.mozilla.org/",
                    "https://testpilot.firefox.com/",
                    "https://accounts.firefox.com/",
                )
                assertThat(
                    "Should pass URLs to check",
                    urls.sorted(),
                    equalTo(expected.sorted()),
                )

                val visits = BooleanArray(urls.size, {
                    when (urls[it]) {
                        "https://mozilla.org/", "https://testpilot.firefox.com/" -> true
                        else -> false
                    }
                })
                return GeckoResult.fromValue(visits)
            }
        })

        // Since `getVisited` is called asynchronously after the page loads, we
        // can't use `waitForPageStop` here.
        mainSession.loadUri(testUri)
        mainSession.waitUntilCalled(
            GeckoSession.HistoryDelegate::class,
            "onVisited",
            "getVisited",
        )

        // Sometimes link changes are not applied immediately, wait for a little bit
        UiThreadUtils.waitForCondition({
            mainSession.getLinkColor("#mozilla") == VISITED_COLOR
        }, sessionRule.env.defaultTimeoutMillis)

        assertThat(
            "Mozilla should be visited",
            mainSession.getLinkColor("#mozilla"),
            equalTo(VISITED_COLOR),
        )

        assertThat(
            "Test Pilot should be visited",
            mainSession.getLinkColor("#testpilot"),
            equalTo(VISITED_COLOR),
        )

        assertThat(
            "Bugzilla should be unvisited",
            mainSession.getLinkColor("#bugzilla"),
            equalTo(UNVISITED_COLOR),
        )
    }

    @Ignore // disable test on debug for frequent failures Bug 1544169
    @Test
    fun onHistoryStateChange() {
        mainSession.loadTestPath(HELLO_HTML_PATH)

        sessionRule.waitUntilCalled(object : HistoryDelegate {
            @AssertCalled(count = 1)
            override fun onHistoryStateChange(session: GeckoSession, state: GeckoSession.HistoryDelegate.HistoryList) {
                assertThat(
                    "History should have one entry",
                    state.size,
                    equalTo(1),
                )
                assertThat(
                    "URLs should match",
                    state[state.currentIndex].uri,
                    endsWith(HELLO_HTML_PATH),
                )
                assertThat(
                    "History index should be 0",
                    state.currentIndex,
                    equalTo(0),
                )
            }
        })

        mainSession.loadTestPath(HELLO2_HTML_PATH)

        sessionRule.waitUntilCalled(object : HistoryDelegate {
            @AssertCalled(count = 1)
            override fun onHistoryStateChange(session: GeckoSession, state: GeckoSession.HistoryDelegate.HistoryList) {
                assertThat(
                    "History should have two entries",
                    state.size,
                    equalTo(2),
                )
                assertThat(
                    "URLs should match",
                    state[state.currentIndex].uri,
                    endsWith(HELLO2_HTML_PATH),
                )
                assertThat(
                    "History index should be 1",
                    state.currentIndex,
                    equalTo(1),
                )
            }
        })

        mainSession.goBack()

        sessionRule.waitUntilCalled(object : HistoryDelegate {
            @AssertCalled(count = 1)
            override fun onHistoryStateChange(session: GeckoSession, state: GeckoSession.HistoryDelegate.HistoryList) {
                assertThat(
                    "History should have two entries",
                    state.size,
                    equalTo(2),
                )
                assertThat(
                    "URLs should match",
                    state[state.currentIndex].uri,
                    endsWith(HELLO_HTML_PATH),
                )
                assertThat(
                    "History index should be 0",
                    state.currentIndex,
                    equalTo(0),
                )
            }
        })

        mainSession.goForward()

        sessionRule.waitUntilCalled(object : HistoryDelegate {
            @AssertCalled(count = 1)
            override fun onHistoryStateChange(session: GeckoSession, state: GeckoSession.HistoryDelegate.HistoryList) {
                assertThat(
                    "History should have two entries",
                    state.size,
                    equalTo(2),
                )
                assertThat(
                    "URLs should match",
                    state[state.currentIndex].uri,
                    endsWith(HELLO2_HTML_PATH),
                )
                assertThat(
                    "History index should be 1",
                    state.currentIndex,
                    equalTo(1),
                )
            }
        })

        mainSession.gotoHistoryIndex(0)

        sessionRule.waitUntilCalled(object : HistoryDelegate {
            @AssertCalled(count = 1)
            override fun onHistoryStateChange(session: GeckoSession, state: GeckoSession.HistoryDelegate.HistoryList) {
                assertThat(
                    "History should have two entries",
                    state.size,
                    equalTo(2),
                )
                assertThat(
                    "URLs should match",
                    state[state.currentIndex].uri,
                    endsWith(HELLO_HTML_PATH),
                )
                assertThat(
                    "History index should be 1",
                    state.currentIndex,
                    equalTo(0),
                )
            }
        })

        mainSession.gotoHistoryIndex(1)

        sessionRule.waitUntilCalled(object : HistoryDelegate {
            @AssertCalled(count = 1)
            override fun onHistoryStateChange(session: GeckoSession, state: GeckoSession.HistoryDelegate.HistoryList) {
                assertThat(
                    "History should have two entries",
                    state.size,
                    equalTo(2),
                )
                assertThat(
                    "URLs should match",
                    state[state.currentIndex].uri,
                    endsWith(HELLO2_HTML_PATH),
                )
                assertThat(
                    "History index should be 1",
                    state.currentIndex,
                    equalTo(1),
                )
            }
        })
    }

    @Test fun onHistoryStateChangeSavingState() {
        // TODO: Bug 1648158
        assumeThat(sessionRule.env.isFission, equalTo(false))

        // This is a smaller version of the above test, in the hopes to minimize race conditions
        mainSession.loadTestPath(HELLO_HTML_PATH)

        sessionRule.waitUntilCalled(object : HistoryDelegate {
            @AssertCalled(count = 1)
            override fun onHistoryStateChange(session: GeckoSession, state: GeckoSession.HistoryDelegate.HistoryList) {
                assertThat(
                    "History should have one entry",
                    state.size,
                    equalTo(1),
                )
                assertThat(
                    "URLs should match",
                    state[state.currentIndex].uri,
                    endsWith(HELLO_HTML_PATH),
                )
                assertThat(
                    "History index should be 0",
                    state.currentIndex,
                    equalTo(0),
                )
            }
        })

        mainSession.loadTestPath(HELLO2_HTML_PATH)

        sessionRule.waitUntilCalled(object : HistoryDelegate {
            @AssertCalled(count = 1)
            override fun onHistoryStateChange(session: GeckoSession, state: GeckoSession.HistoryDelegate.HistoryList) {
                assertThat(
                    "History should have two entries",
                    state.size,
                    equalTo(2),
                )
                assertThat(
                    "URLs should match",
                    state[state.currentIndex].uri,
                    endsWith(HELLO2_HTML_PATH),
                )
                assertThat(
                    "History index should be 1",
                    state.currentIndex,
                    equalTo(1),
                )
            }
        })
    }
}