1291363 - [geckoview] Add new "geckoview" Gradle project

Status: RESOLVED FIXED

(GeckoView :: General, defect)

Description

[Nick Alexander :nalexander [he/him]]

The goal is to make a new "geckoview" Gradle project that compiles,
ships the minimal set of required resources (preferably none),
includes the Gecko libraries (libxul.so and friends), and can itself
be depended on by a "geckoview_example" project.  This Gradle project
will be, at first, a sibling to the existing "base" project.

The commit at
https://reviewboard.mozilla.org/r/60476/diff/1#0 shows how to do
this:

1) move geckoview sources out of mobile/android/base and into
   mobile/android/geckoview or similar.  It's possible to specify
   inclusion/exclusion to Gradle, but it's not easy; it's better to
   separate the two source trees, in preparation for Fennec itself to
   *compile* geckoview separately.  There's a shell script in that
   commit that should do this automatically.

2) update Fennec's moz.build to reference the new files (and Fennec's
   Gradle configuration).  See the commit.  Fennec's build will
   include the existing GeckoView files as usual.

3) add the new Gradle project.  Again, see the commit.

At this point, the new "geckoview" project will build a library (and,
at some point, an AAR file) that can be distributed independently of
Fennec.

Comment 1

[Nick Alexander :nalexander [he/him]]

Attachment: Bug 1291363 - Part 1: Move GeckoView sources into mobile/android/geckoview.

This is the first part only.  It moves Experiments out of util (just
for convenience) -- I would have liked to have moved WhatsNewReceiver
out of notifications as well, but it's referenced in
AndroidManifest.xml.in and I don't want to break that.

The set of files in GeckoView is slightly larger than what we really
want, but it's close to correct.  Future tickets will get things
compiling and trim the set of files down to size.  Hopefully we can
move notifications/, permissions/, and restrictions/ back to Fennec.

This is not technically required, but it's best to bulk move the files
up front and patch later, rather than jump through hoops to
distinguish the set of files in Gradle (and moz.build).

Review commit: https://reviewboard.mozilla.org/r/68770/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/68770/

Comment 2

[Sebastian Kaspari (:sebastian; :pocmo)]

Comment on attachment 8777149 [details]
Bug 1291363 - Part 1: Move GeckoView sources into mobile/android/geckoview.

https://reviewboard.mozilla.org/r/68770/#review65906

Comment 3

[Nick Alexander :nalexander [he/him]]

Comment on attachment 8777149 [details]
Bug 1291363 - Part 1: Move GeckoView sources into mobile/android/geckoview.

Landed in Bug 1291811 with sebastian's r+.

Comment 4

[Nick Alexander :nalexander [he/him]]

Attachment: Bug 1291363 - Add geckoview and geckoview_example Gradle projects.

We need to bump the Gradle Deps task, which fetches dependencies, to
include new test dependencies; and use freshly uploaded tooltool
archives (manually uploaded) containing the new test dependencies.

Review commit: https://reviewboard.mozilla.org/r/82806/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/82806/

Comment 5

[Nick Alexander :nalexander [he/him]]

Attachment: Bug 1291363 - Make Gradle and Gradle Artifacts builds produce GeckoView AAR.

We also include the example APK, since it will be helpful to be able
to regression test the example without downloading the AAR and
manually building the example with that AAR.

Review commit: https://reviewboard.mozilla.org/r/82808/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/82808/

Comment 6

[Nick Alexander :nalexander [he/him]]

sebastian, jchen: figure you two are in the best position to test building Fennec with this patch applied, and to test building geckoview{_exampe}, respectively.  The monkeying with the Gecko binaries is all to work around the |mach build| vs. |mach package| steps; see the comments in the new Gradle file.

chmanchester: you're here just to sanity check the TC changes.  Thanks!

Comment 7

[Chris Manchester (limited bugmail, email directly)]

Comment on attachment 8797212 [details]
Bug 1291363 - Make Gradle and Gradle Artifacts builds produce GeckoView AAR.

https://reviewboard.mozilla.org/r/82808/#review81542

I don't know these bits extremely well, but I sanity checked this is consistent with other stuff we're doing. If it works for you, it works for me.

Comment 8

[Sebastian Kaspari (:sebastian; :pocmo)]

Comment on attachment 8797211 [details]
Bug 1291363 - Add geckoview and geckoview_example Gradle projects.

https://reviewboard.mozilla.org/r/82806/#review82216

The code LGTM and I can build and run Fennec and the sample. I needed to build fennec (app:assembleLocalDebug) once before I could open the project in AS again though. (nit: Some of the test classes seem to only contain dummy/failing code and reviewboard shows some trailing whitespaces/tabs in the gradle files).

Comment 9

[(inactive) Jim Chen [:jchen] [:darchons]]

Comment on attachment 8797211 [details]
Bug 1291363 - Add geckoview and geckoview_example Gradle projects.

https://reviewboard.mozilla.org/r/82806/#review81824

::: mobile/android/geckoview_example/src/androidTest/java/org/mozilla/geckoview_example/GeckoViewActivityTest.java:32
(Diff revision 1)
> +    @Test
> +    public void testA() throws InterruptedException {
> +        onView(withId(R.id.gecko_view))
> +                .check(matches(isDisplayed()));
> +
> +        Assert.assertEquals(1, 2);

Hm?

::: mobile/android/geckoview_example/src/main/java/org/mozilla/geckoview_example/GeckoViewActivity.java:41
(Diff revision 1)
> +    protected void onStart() {
> +        super.onStart();
> +
> +        final GeckoProfile profile = GeckoProfile.get(getApplicationContext());
> +
> +        GeckoThread.init(profile, "chrome://browser/content/geckoview.xul", /* action */ null, /* debugging */ false);

Pass null for args. Specifying "chrome://browser/content/geckoview.xul" doesn't actually do anything.

::: mobile/android/geckoview_example/src/main/java/org/mozilla/geckoview_example/GeckoViewActivity.java:50
(Diff revision 1)
> +    private class MyGeckoViewChrome implements GeckoView.ChromeDelegate {
> +        @Override
> +        public void onReady(GeckoView view) {
> +            Log.i(LOGTAG, "Gecko is ready");
> +            // Inject a script that adds some code to the content window
> +            mGeckoView.importScript("resource://android/assets/script.js");

There's no script.js?

::: mobile/android/geckoview_example/src/main/java/org/mozilla/geckoview_example/GeckoViewActivity.java:105
(Diff revision 1)
> +            result.confirm();
> +        }
> +
> +        @Override
> +        public void onScriptMessage(GeckoView view, Bundle data, GeckoView.MessageResult result) {
> +        	Log.i(LOGTAG, "Got Script Message: " + data.toString());

These lines have a mixture of spaces and tabs.

Comment 10

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/fx-team/rev/5d8f137ee52e
Add geckoview and geckoview_example Gradle projects. r=jchen,sebastian
https://hg.mozilla.org/integration/fx-team/rev/80d979342a04
Make Gradle build produce GeckoView AAR. r=chmanchester

Comment 11

[Phil Ringnalda (:philor)]

https://hg.mozilla.org/mozilla-central/rev/5d8f137ee52e
https://hg.mozilla.org/mozilla-central/rev/80d979342a04