mozilla/fennec-search

Stand-alone version of the search activity that is built with Firefox for Android.

This repo is no longer used for active development. To contribute to the Firefox search activity, please follow the normal Firefox for Android development process.

Fennec Search Activity

This is a stand-alone version of the search activity that is built with Firefox for Android. The main source code lives in mozilla-central, but this repo is a tool to make development easier.

Development happens in the Firefox for Android::Search Activity bugzilla component.

grunt

The Search Activity repository uses grunt tasks to integrate with a Mozilla source tree such as fx-team or mozilla-inbound. All grunt tasks take such a source tree specified either via a command line argument like --tree=PATH or via the environment variable MC.

Getting started with grunt

First, install node.js and npm using your OS-level package manager or similar. Then, in the Search Activity repository root directory, execute

$ npm install

You can check that grunt is working and the local dependencies are installed by executing grunt --help. You should see a list of available tasks, including a default task.

Grunt tasks

preprocess (default)

The default task, executed when you run grunt, is to preprocess the Android manifest and Android string resources. The inputs have the suffix .in and the outputs are written into the source tree. (This is so that gradle and Android Studio can find them without having additional paths specified. We might change this in future.)

clean

Delete all of the preprocessed outputs created by the preprocess task.

export

Copy the current Java source code, Android resources, string definitions, and Android manifest snippets to the Mozilla source tree provided. Does not copy any preprocessed outputs. (Preprocessed outputs must be created by the Mozilla source tree's build system at Fennec build time.) Use this to update your Mozilla source tree with the changes you've made in your local Search Activity repository.

fennec-search's Issues

Update `AndroidManifest.xml` to refer to full package name

It's not 100% clear how we'll integrate org.mozilla.search into Fennec, but we almost certainly will manually merge bits of the manifests together. That means that relative activity paths (like .Activity and .HistoryService) won't work, 'cuz they'll be resolved relative to the package name, which varies (like org.mozilla.firefox and org.mozilla.firefox_beta). These references will need to be absolute, like org.mozilla.search.Activity.

This ticket depends on #1.

Decide on and update code base to org.mozilla.* packages

My personal suggestion is for org.mozilla.search, but I'm open to suggestions. No matter what, com.mozilla.fennec.* is not in our future. This is mechanical, I expect, but needs to be done for landing in m-c.

/cc @EricEdens @liebovic

CODE_OF_CONDUCT.md file missing

As of January 1 2019, Mozilla requires that all GitHub projects include this CODE_OF_CONDUCT.md file in the project root. The file has two parts:

1. Required Text - All text under the headings Community Participation Guidelines and How to Report, are required, and should not be altered.
2. Optional Text - The Project Specific Etiquette heading provides a space to speak more specifically about ways people can work effectively and inclusively together. Some examples of those can be found on the Firefox Debugger project, and Common Voice. (The optional part is commented out in the raw template file, and will not be visible until you modify and uncomment that part.)

If you have any questions about this file, or Code of Conduct policies and procedures, please see Mozilla-GitHub-Standards or email [email protected].

(Message COC001)

Unused Field

fennec-search/app/src/external/java/org/mozilla/gecko/GeckoSharedPrefs.java

Line 36 in a8dab38

private static final EnumSet<Flags> disableMigrations = EnumSet.of(Flags.DISABLE_MIGRATIONS);

This field is never used.

Avoid using assets

This is a Fennec build not-handled-situation. You could put some of the dictionary in a raw resources, or hard-code it into Java.

com.mozilla.search.AUTO_COMPLETE_FRAGMENT

In Constants.java.

License fragment headers throughout

MPL for Java (part of Fennec), PD for test-only code.

https://github.com/mozilla-services/android-sync/blob/develop/tools/COPYRIGHT_MPL
https://github.com/mozilla-services/android-sync/blob/develop/tools/COPYRIGHT_PD

Move special `Configuration.java` properties into gradle-generated BuildConfig

I see that the gradle way of including build-time configuration is using BuildConfig. For a simple (documented!) example, see https://github.com/mozilla/MozStumbler/. They include API keys just like you want in gradle.properties and then generate BuildConfig.java from those properties. This project should follow suit; flag me for review.

Update android:minSdkVersion and :targetSdkVersion to match m-c

This is pretty simple, but I'd like this code to compile warning free (with -Xlint:all) before landing. You can use the WIP patches to see the warnings I'm seeing during the build. It will be best if the gradle and IDE configurations are the same as m-c, although that could be tricky.

No rule to make target `.project' when building fennec release

I'm building sources from http://hg.mozilla.org/releases/mozilla-release/ and get the following error:

make[5]: *** No rule to make target .project', needed by/Users/yu/Documents/projects/mozilla/Fennec/release/obj-arm-linux-androideabi/mobile/android/geckoview_library/.project'. Stop

My mozconfig looks like this:

ac_add_options --with-android-ndk="$HOME/Development/android-ndk-r8e"
ac_add_options --with-android-sdk="$HOME/Development/sdk/platforms/android-17"

ac_add_options --enable-application=mobile/android
ac_add_options --target=arm-linux-androideabi

ac_add_options --disable-tests
export MOZ_DISABLE_GECKOVIEW=1

last two options were added trying to troubleshoot.

I can build nightly sources with this mozconfig. I can also build release sources without mozconfig,
But I cannot build release Fennec for Android

HerHere is the build log:
https://justpaste.it/gv89

Don't use m prefix for member variables