Mobile/Fennec/Android/CommonTips - Revision history

Gbrown: /* Lint */

2018-08-01T16:53:08Z

Lint

← Older revision		Revision as of 16:53, 1 August 2018
Line 51:		Line 51:
	** Good comments are useful and clear even for someone reading a particular area of code for the first time		** Good comments are useful and clear even for someone reading a particular area of code for the first time
	* Avoid using single-letter variables in almost all cases - it makes code harder to read		* Avoid using single-letter variables in almost all cases - it makes code harder to read

	~~=== Lint ===~~
	~~We provide some support for linting tools. See [[Mobile/Fennec/Android/Lint]] for a list of linting tools we support and expect to be run.~~

	== Strings==		== Strings==

Gasolin: update java path

2016-08-03T01:39:32Z

update java path

← Older revision		Revision as of 01:39, 3 August 2016
Line 9:		Line 9:
	Of particular interest to most new contributors will be:		Of particular interest to most new contributors will be:

	mobile/android/base/BrowserApp.java # the main Android activity that starts when you open Fennec		mobile/android/base/java/org/mozilla/gecko/BrowserApp.java # the main Android activity that starts when you open Fennec
	mobile/android/chrome/content/browser.js # the main JavaScript file that controls Gecko to make it do what we want		mobile/android/chrome/content/browser.js # the main JavaScript file that controls Gecko to make it do what we want

Mcomella: /* Coding Style */

2016-04-13T21:26:16Z

Coding Style

← Older revision		Revision as of 21:26, 13 April 2016
Line 37:		Line 37:

	The Java style follow the [https://developer.mozilla.org/en-US/docs/Developer_Guide/Coding_Style#Java_practices Mozilla Coding Style].		The Java style follow the [https://developer.mozilla.org/en-US/docs/Developer_Guide/Coding_Style#Java_practices Mozilla Coding Style].

			You can run `./mach gradle checkstyle` to automatically catch some style issues locally.

	==== Common nits in Reviews ====		==== Common nits in Reviews ====

Mcomella: /* Test the class to query via the ContentResolver */

2016-03-05T01:28:06Z

Test the class to query via the ContentResolver

← Older revision		Revision as of 01:28, 5 March 2016
Line 146:		Line 146:
	====Test the class to query via the ContentResolver====		====Test the class to query via the ContentResolver====
	*Add to the test method you previously wrote in <tt>testBrowserProvider</tt>. Follow <tt>TestInsertUrlAnnotations</tt> for an extensible pattern.		*Add to the test method you previously wrote in <tt>testBrowserProvider</tt>. Follow <tt>TestInsertUrlAnnotations</tt> for an extensible pattern.

			====Next steps====
			You probably want an <tt>update</tt> and <tt>delete</tt> method too... get to it! :P

	=== Updating search engine icons ===		=== Updating search engine icons ===

Mcomella: /* Test insertions via BrowserProvider */

2016-03-05T01:25:34Z

Test insertions via BrowserProvider

← Older revision		Revision as of 01:25, 5 March 2016
Line 130:		Line 130:

	====Test insertions via BrowserProvider====		====Test insertions via BrowserProvider====
	Add a <tt>TestInsert extends TestCase</tt> class with a <tt>test</tt> method. Insert a value, query, and make sure you receive what you think you should! ~~Pattern match other tests here~~.		Add a <tt>TestInsert extends TestCase</tt> class with a <tt>test</tt> method. Insert a value, query, and make sure you receive what you think you should! <tt>TestInsertUrlAnnotations</tt> should provide a guide on how to write an extensible test that allows you to more easily test additions later on in this guide.
	*Register your test to be run in <tt>TestBrowserProvider.setUp</tt>		*Register your test to be run in <tt>TestBrowserProvider.setUp</tt>

Mcomella: /* Test the class to query via the ContentResolver */

2016-03-05T01:24:28Z

Test the class to query via the ContentResolver

← Older revision		Revision as of 01:24, 5 March 2016
Line 145:		Line 145:

	====Test the class to query via the ContentResolver====		====Test the class to query via the ContentResolver====
			*Add to the test method you previously wrote in <tt>testBrowserProvider</tt>. Follow <tt>TestInsertUrlAnnotations</tt> for an extensible pattern.

	=== Updating search engine icons ===		=== Updating search engine icons ===

Mcomella: /* Add a class to abstract querying your table from within Fennec */

2016-03-05T01:23:17Z

Add a class to abstract querying your table from within Fennec

← Older revision		Revision as of 01:23, 5 March 2016
Line 143:		Line 143:
	Add <tt>Stub implements <your-interface></tt> to <tt>StubBrowserDB</tt> and have the implementation do nothing. Construct your <tt>Stub*</tt> with your member variable declaration and add the getter.		Add <tt>Stub implements <your-interface></tt> to <tt>StubBrowserDB</tt> and have the implementation do nothing. Construct your <tt>Stub*</tt> with your member variable declaration and add the getter.
	*Don't forget to add your new files to <tt>moz.build</tt>		*Don't forget to add your new files to <tt>moz.build</tt>

			====Test the class to query via the ContentResolver====

	=== Updating search engine icons ===		=== Updating search engine icons ===

Mcomella: /* Prepare migration tests */

2016-03-05T01:21:38Z

Prepare migration tests

← Older revision		Revision as of 01:21, 5 March 2016
Line 117:		Line 117:
	To follow along with code, see [https://bugzilla.mozilla.org/show_bug.cgi?id=1250707 Bug 1250707].		To follow along with code, see [https://bugzilla.mozilla.org/show_bug.cgi?id=1250707 Bug 1250707].
	==== Prepare migration tests ====		==== Prepare migration tests ====
	*Capture a current version of the database (before your changes!) with some browsing data from your device using the Copy Profile add-on. Put this in <tt>mobile/android/tests/browser/robocop/assets/browser_db_upgrade/v<#>.db</tt>. It is used to test your upgrade changes in <tt>testBrowserDatabaseHelperUpgrades</tt>		*Capture a current version of the database (before your changes!) with some browsing data from your device using the Copy Profile add-on. Put this in <tt>mobile/android/tests/browser/robocop/assets/browser_db_upgrade/v<#>.db</tt>. It is used to test your upgrade changes in <tt>testBrowserDatabaseHelperUpgrades</tt>. The test should automatically pick up your new version.

	====Create the table and query & insert via BrowserProvider====		====Create the table and query & insert via BrowserProvider====

Mcomella: /* Init migration tests */

2016-03-05T01:21:20Z

Init migration tests

← Older revision		Revision as of 01:21, 5 March 2016
Line 116:		Line 116:
	=== Add a new table to browser.db ===		=== Add a new table to browser.db ===
	To follow along with code, see [https://bugzilla.mozilla.org/show_bug.cgi?id=1250707 Bug 1250707].		To follow along with code, see [https://bugzilla.mozilla.org/show_bug.cgi?id=1250707 Bug 1250707].
	==== ~~Init~~ migration tests ====		==== Prepare migration tests ====
	*Capture a current version of the database (before your changes!) with some browsing data from your device using the Copy Profile add-on. Put this in <tt>mobile/android/tests/browser/robocop/assets/browser_db_upgrade/v<#>.db</tt>. It is used to test your upgrade changes in <tt>testBrowserDatabaseHelperUpgrades</tt>		*Capture a current version of the database (before your changes!) with some browsing data from your device using the Copy Profile add-on. Put this in <tt>mobile/android/tests/browser/robocop/assets/browser_db_upgrade/v<#>.db</tt>. It is used to test your upgrade changes in <tt>testBrowserDatabaseHelperUpgrades</tt>

Mcomella: /* Add a class to abstract querying your table from within Fennec */

2016-03-05T01:21:02Z

Add a class to abstract querying your table from within Fennec

← Older revision		Revision as of 01:21, 5 March 2016
Line 134:		Line 134:

	====Add a class to abstract querying your table from within Fennec====		====Add a class to abstract querying your table from within Fennec====
	So instead of accessing the content provider directly, you can call, <tt>YourTable.insert(url, title);</tt>. Alternatively, add these methods directly to <tt>LocalBrowserDB</tt> & friends if your queries overlap the queries there or share data (e.g. table join).		So instead of accessing the content provider directly, you can call, <tt>YourTable.insert(url, title);</tt>.
	*
			Alternatively, add these methods directly to <tt>LocalBrowserDB</tt> & friends if your queries overlap the queries there or share data (e.g. table join). This method won't be discussed here.
			Add a new interface for your class in <tt>omg.db</tt>. It should contain an <tt>insert</tt> method with a <tt>ContentResolver</tt> arg and whatever else you want to insert. This method will likely need <tt>@RobocopTarget</tt>
			Add a class implementing this interface. The current pattern for the class name is <tt>Local</tt> (like <tt>LocalBrowserDB</tt>). The insert method should use the <tt>ContentResolver</tt> to talk insert via the <tt>BrowserProvider</tt> methods you previously implemented.
			*Add a <tt>getTableName</tt> method to the <tt>BrowserDB</tt> interface. It will like need <tt>@RobocopTarget</tt>.
			*Construct your class in the constructor of <tt>LocalBrowserDB</tt> and store it in a member variable. Add the implementation of your getter from above (also <tt>@RobocopTarget</tt>).
			Add <tt>Stub implements <your-interface></tt> to <tt>StubBrowserDB</tt> and have the implementation do nothing. Construct your <tt>Stub*</tt> with your member variable declaration and add the getter.
	*Don't forget to add your new files to <tt>moz.build</tt>		*Don't forget to add your new files to <tt>moz.build</tt>