1950555 - Introduce a use case wrapper to consolidate the use cases in HomeActivity#load

Status: RESOLVED FIXED

(Firefox for Android :: Homepage, task, P3)

Description

[Gabriel Luong [:gl] (ΦωΦ)]

HomeActivity#openToBrowserAndLoad is an use case with a lot of different consumers (Searchfox) that handles the action of loading a search term or URL in the browser and navigating to the Browser screen.

As part of Homepage as a New Tab, we are looking to take advantage of this to centralized all actions around loading the provided URL or search term in a tab with HomeActivity#load except we would want to open within the the current tab instead of a new tab as part of the new navigation model. This allows us to have a single use case for handling this action and can ensure the behaviour is consistent throughout the application.

As part of this bug, we are refactoring HomeActivity#load to utilize the existing of UseCases patterns so that we can move the logic away from the HomeActivity (Rationale: Separation of Concerns from Activity and Fragment). This new use case will be a wrapper around the existing search and session use cases that are invoked by load(), and serves as the decision tree between loading a URL or search term depending on the parameters that are provided.

This initial refactor will allow us to more easily add unit testing of the HomeActivity#load functionality ensuring that we have appropriate test coverage for this important action.

The long term goal here would be to completely remove the usage of HomeActivity#openToBrowserAndLoad in favour of the new UseCases introduced here and navigation would be handle in their respective controller or navigation middleware. However, we will not be looking to remove all the usages in this initial refactor and subsequent followup bugs will be filed.

The task here is to do the following:

• Refactors the use cases usage in HomeActivity#load into a centralized UseCases wrapper.
• Migrate an existing consumer of HomeActivity#openToBrowserAndLoad to the new UseCases wrapper.

Comment 1

[Gabriel Luong [:gl] (ΦωΦ)]

Attachment: Bug 1950555 - Part 1: Refactor `HomeActivity#load` to simplify getting the `private` boolean value

Comment 2

[Gabriel Luong [:gl] (ΦωΦ)]

Attachment: Bug 1950555 - Part 2: Introduce a FenixBrowserUseCases wrapper to consolidate the use cases in HomeActivity#load

• Refactors the use cases usage in HomeActivity#load into a centralized UseCases wrapper.
• This allows for unit testing and provides a starting point for moving the HomeActivity#openBrowserAndLoad logic out of the HomeActivity.

Comment 3

[Gabriel Luong [:gl] (ΦωΦ)]

Attachment: Bug 1950555 - Part 3: Refactor `HomeActivity.load` profiler marker into FenixBrowserUseCases#loadUrlOrSearch

Comment 4

[Gabriel Luong [:gl] (ΦωΦ)]

Attachment: Bug 1950555 - Part 4: Refactor `HomeActivity.openToBrowserAndLoad` usage to `FenixBrowserUseCases.loadUrlOrSearch` in SearchDialogController

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/e3d14b08be0e
Part 1: Refactor `HomeActivity#load` to simplify getting the `private` boolean value r=android-reviewers,pollymce

Comment 6

[Serban Stanca [:SerbanS]]

https://hg.mozilla.org/mozilla-central/rev/e3d14b08be0e

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/c13202fe302c
Part 2: Introduce a FenixBrowserUseCases wrapper to consolidate the use cases in HomeActivity#load r=android-reviewers,pollymce
https://hg.mozilla.org/integration/autoland/rev/279d443870f3
Part 3: Refactor `HomeActivity.load` profiler marker into FenixBrowserUseCases#loadUrlOrSearch r=android-reviewers,jonalmeida
https://hg.mozilla.org/integration/autoland/rev/7e20ee359025
Part 4: Refactor `HomeActivity.openToBrowserAndLoad` usage to `FenixBrowserUseCases.loadUrlOrSearch` in SearchDialogController r=android-reviewers,pollymce

Comment 8

[Atila Butkovits]

Backed out for causing Fenix failures.

Backout link: https://hg.mozilla.org/integration/autoland/rev/8e7e2ea9dd4a4596b2ba9973ad9aa9812c2f832d

Push with failures: https://treeherder.mozilla.org/jobs?repo=autoland&resultStatus=testfailed%2Cbusted%2Cexception%2Cretry%2Cusercancel&revision=7e20ee359025d37ec75e7a87d7b98ff58b10b172&selectedTaskRun=IY17wmWBTlapAmJkwoR0Vw.0

Failure log: https://treeherder.mozilla.org/logviewer?job_id=501002576&repo=autoland&lineNumber=25589

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/eb2c3644f040
Part 2: Introduce a FenixBrowserUseCases wrapper to consolidate the use cases in HomeActivity#load r=android-reviewers,pollymce
https://hg.mozilla.org/integration/autoland/rev/dd6c1b9e56fe
Part 3: Refactor `HomeActivity.load` profiler marker into FenixBrowserUseCases#loadUrlOrSearch r=android-reviewers,jonalmeida
https://hg.mozilla.org/integration/autoland/rev/8bef67ab32b6
Part 4: Refactor `HomeActivity.openToBrowserAndLoad` usage to `FenixBrowserUseCases.loadUrlOrSearch` in SearchDialogController r=android-reviewers,pollymce

Comment 10

[Cosmin Sabou [:CosminS]]

Relanded this, for the fenix failures Bug 1956618 was filed.

Comment 11

[Norisz Fay [:noriszfay]]

https://hg.mozilla.org/mozilla-central/rev/eb2c3644f040
https://hg.mozilla.org/mozilla-central/rev/dd6c1b9e56fe
https://hg.mozilla.org/mozilla-central/rev/8bef67ab32b6