This repository has been archived by the owner on Feb 20, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
243 additions
and
100 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
107 changes: 107 additions & 0 deletions
107
app/src/main/java/org/mozilla/fenix/migration/MigrationStatusAdapter.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| /* This Source Code Form is subject to the terms of the Mozilla Public | ||
| * License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ | ||
|
|
||
| package org.mozilla.fenix.migration | ||
|
|
||
| import android.graphics.Rect | ||
| import android.view.LayoutInflater | ||
| import android.view.View | ||
| import android.view.ViewGroup | ||
| import androidx.annotation.Px | ||
| import androidx.core.view.isInvisible | ||
| import androidx.recyclerview.widget.DiffUtil | ||
| import androidx.recyclerview.widget.ListAdapter | ||
| import androidx.recyclerview.widget.RecyclerView | ||
| import kotlinx.android.synthetic.main.migration_list_item.view.* | ||
| import mozilla.components.support.migration.Migration | ||
| import mozilla.components.support.migration.MigrationResults | ||
| import org.mozilla.fenix.R | ||
|
|
||
| internal data class MigrationItem( | ||
| val migration: Migration, | ||
| val status: Boolean = false | ||
| ) | ||
|
|
||
| // These are the only items we want to show migrating in the UI. | ||
| internal val whiteList = linkedMapOf( | ||
| Migration.Settings to R.string.settings_title, | ||
| Migration.History to R.string.preferences_sync_history, | ||
| Migration.Bookmarks to R.string.preferences_sync_bookmarks, | ||
| Migration.Logins to R.string.migration_text_passwords | ||
| ) | ||
|
|
||
| internal class MigrationStatusAdapter : | ||
| ListAdapter<MigrationItem, MigrationStatusAdapter.ViewHolder>(DiffCallback) { | ||
|
|
||
| override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): ViewHolder { | ||
| val view = LayoutInflater.from(parent.context) | ||
| .inflate(R.layout.migration_list_item, parent, false) | ||
|
|
||
| return ViewHolder(view) | ||
| } | ||
|
|
||
| override fun onBindViewHolder(holder: ViewHolder, position: Int) { | ||
| holder.bind(getItem(position)) | ||
| } | ||
|
|
||
| /** | ||
| * Filter the [results] to only include items in [whiteList] and update the adapter. | ||
| */ | ||
| fun updateData(results: MigrationResults) { | ||
| val itemList = whiteList.keys.map { | ||
| if (results.containsKey(it)) { | ||
| MigrationItem(it, results.getValue(it).success) | ||
| } else { | ||
| MigrationItem(it) | ||
| } | ||
| } | ||
| submitList(itemList) | ||
| } | ||
|
|
||
| class ViewHolder(view: View) : RecyclerView.ViewHolder(view) { | ||
| private val context = view.context | ||
| private val title = view.migration_item_name | ||
| private val status = view.migration_status_image | ||
|
|
||
| fun bind(item: MigrationItem) { | ||
| // Get the resource ID for the item. | ||
| val migrationText = whiteList[item.migration]?.let { | ||
| context.getString(it) | ||
| }.orEmpty() | ||
| title.text = migrationText | ||
| status.isInvisible = !item.status | ||
| status.contentDescription = context.getString(R.string.migration_icon_description) | ||
| } | ||
| } | ||
|
|
||
| private object DiffCallback : DiffUtil.ItemCallback<MigrationItem>() { | ||
|
|
||
| override fun areItemsTheSame(oldItem: MigrationItem, newItem: MigrationItem) = | ||
| oldItem.migration.javaClass.simpleName == newItem.migration.javaClass.simpleName | ||
|
|
||
| override fun areContentsTheSame(oldItem: MigrationItem, newItem: MigrationItem) = | ||
| oldItem.migration.javaClass.simpleName == newItem.migration.javaClass.simpleName && | ||
| oldItem.status == newItem.status | ||
| } | ||
| } | ||
|
|
||
| internal class MigrationStatusItemDecoration( | ||
| @Px private val spacing: Int | ||
| ) : RecyclerView.ItemDecoration() { | ||
|
|
||
| override fun getItemOffsets( | ||
| outRect: Rect, | ||
| view: View, | ||
| parent: RecyclerView, | ||
| state: RecyclerView.State | ||
| ) { | ||
| val position = parent.getChildViewHolder(view).adapterPosition | ||
| val itemCount = state.itemCount | ||
|
|
||
| outRect.left = spacing | ||
| outRect.right = spacing | ||
| outRect.top = spacing | ||
| outRect.bottom = if (position == itemCount - 1) spacing else 0 | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
59 changes: 59 additions & 0 deletions
59
app/src/test/java/org/mozilla/fenix/migration/MigrationStatusAdapterTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| /* This Source Code Form is subject to the terms of the Mozilla Public | ||
| * License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ | ||
|
|
||
| package org.mozilla.fenix.migration | ||
|
|
||
| import android.view.View | ||
| import android.widget.FrameLayout | ||
| import kotlinx.android.synthetic.main.migration_list_item.view.* | ||
| import mozilla.components.support.migration.Migration | ||
| import mozilla.components.support.migration.MigrationRun | ||
| import mozilla.components.support.test.robolectric.testContext | ||
| import org.junit.Assert.assertEquals | ||
| import org.junit.Before | ||
| import org.junit.Test | ||
| import org.junit.runner.RunWith | ||
| import org.mozilla.fenix.helpers.FenixRobolectricTestRunner | ||
|
|
||
| @RunWith(FenixRobolectricTestRunner::class) | ||
| class MigrationStatusAdapterTest { | ||
|
|
||
| private lateinit var adapter: MigrationStatusAdapter | ||
|
|
||
| @Before | ||
| fun setup() { | ||
| adapter = MigrationStatusAdapter() | ||
| } | ||
|
|
||
| @Test | ||
| fun `getItemCount should return the number of items in whitelist`() { | ||
| assertEquals(0, adapter.itemCount) | ||
|
|
||
| adapter.updateData(mapOf( | ||
| Migration.Addons to MigrationRun(0, success = true), | ||
| Migration.Settings to MigrationRun(0, success = true), | ||
| Migration.Bookmarks to MigrationRun(0, success = false) | ||
| )) | ||
| assertEquals(4, adapter.itemCount) | ||
| } | ||
|
|
||
| @Test | ||
| fun `creates and binds viewholder`() { | ||
| adapter.updateData(mapOf( | ||
| Migration.History to MigrationRun(0, success = true) | ||
| )) | ||
|
|
||
| val holder1 = adapter.createViewHolder(FrameLayout(testContext), 0) | ||
| val holder2 = adapter.createViewHolder(FrameLayout(testContext), 0) | ||
| adapter.bindViewHolder(holder1, 0) | ||
| adapter.bindViewHolder(holder2, 1) | ||
|
|
||
| assertEquals("Settings", holder1.itemView.migration_item_name.text) | ||
| assertEquals(View.INVISIBLE, holder1.itemView.migration_status_image.visibility) | ||
|
|
||
| assertEquals("History", holder2.itemView.migration_item_name.text) | ||
| assertEquals(View.VISIBLE, holder2.itemView.migration_status_image.visibility) | ||
| assertEquals("Migration completed", holder2.itemView.migration_status_image.contentDescription) | ||
| } | ||
| } |
70 changes: 70 additions & 0 deletions
70
app/src/test/java/org/mozilla/fenix/migration/MigrationTelemetryListenerTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| /* This Source Code Form is subject to the terms of the Mozilla Public | ||
| * License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ | ||
|
|
||
| package org.mozilla.fenix.migration | ||
|
|
||
| import io.mockk.MockKAnnotations | ||
| import io.mockk.impl.annotations.MockK | ||
| import io.mockk.verify | ||
| import io.mockk.verifyOrder | ||
| import kotlinx.coroutines.ExperimentalCoroutinesApi | ||
| import kotlinx.coroutines.test.TestCoroutineDispatcher | ||
| import kotlinx.coroutines.test.runBlockingTest | ||
| import mozilla.components.support.base.log.logger.Logger | ||
| import mozilla.components.support.migration.state.MigrationAction | ||
| import mozilla.components.support.migration.state.MigrationStore | ||
| import mozilla.components.support.test.ext.joinBlocking | ||
| import mozilla.components.support.test.rule.MainCoroutineRule | ||
| import org.junit.Before | ||
| import org.junit.Rule | ||
| import org.junit.Test | ||
| import org.mozilla.fenix.components.metrics.Event | ||
| import org.mozilla.fenix.components.metrics.MetricController | ||
|
|
||
| @ExperimentalCoroutinesApi | ||
| class MigrationTelemetryListenerTest { | ||
|
|
||
| private val testDispatcher = TestCoroutineDispatcher() | ||
|
|
||
| @get:Rule | ||
| val coroutinesTestRule = MainCoroutineRule(testDispatcher) | ||
|
|
||
| @MockK(relaxed = true) private lateinit var metrics: MetricController | ||
| @MockK(relaxed = true) private lateinit var logger: Logger | ||
| private lateinit var store: MigrationStore | ||
| private lateinit var listener: MigrationTelemetryListener | ||
|
|
||
| @Before | ||
| fun setup() { | ||
| MockKAnnotations.init(this) | ||
| store = MigrationStore() | ||
| listener = MigrationTelemetryListener( | ||
| metrics = metrics, | ||
| store = store, | ||
| logger = logger | ||
| ) | ||
| } | ||
|
|
||
| @Test | ||
| fun `progress state is logged`() = testDispatcher.runBlockingTest { | ||
| listener.start() | ||
| store.dispatch(MigrationAction.Started).joinBlocking() | ||
| store.dispatch(MigrationAction.Completed).joinBlocking() | ||
| store.dispatch(MigrationAction.Clear).joinBlocking() | ||
|
|
||
| verifyOrder { | ||
| logger.debug("Migration state: MIGRATING") | ||
| logger.debug("Migration state: COMPLETED") | ||
| logger.debug("Migration state: NONE") | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun `metrics are logged when migration is completed`() = testDispatcher.runBlockingTest { | ||
| listener.start() | ||
| store.dispatch(MigrationAction.Completed).joinBlocking() | ||
|
|
||
| verify { metrics.track(Event.FennecToFenixMigrated) } | ||
| } | ||
| } |