Labs/Jetpack/Release Notes/1.14 - Revision history

Wbamberg at 23:43, 26 March 2013

2013-03-26T23:43:48Z

← Older revision		Revision as of 23:43, 26 March 2013
Line 1:		Line 1:
	~~{{draft\|}}~~

	== About ==		== About ==

Wbamberg at 21:08, 26 March 2013

2013-03-26T21:08:35Z

← Older revision		Revision as of 21:08, 26 March 2013
Line 12:		Line 12:
	* [https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/addon-sdk-1.14.zip addon-sdk-1.14.zip]		* [https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/addon-sdk-1.14.zip addon-sdk-1.14.zip]

	Then unpack the archive, open the <tt>addon-sdk-1.~~13.1~~/README.txt</tt> file, and follow its instructions.		Then unpack the archive, open the <tt>addon-sdk-1.14/README.txt</tt> file, and follow its instructions.

	== Major Changes Since 1.13 ==		== Major Changes Since 1.13 ==

Wbamberg: /* Per-window private-browsing */

2013-03-26T21:05:45Z

Per-window private-browsing

← Older revision		Revision as of 21:05, 26 March 2013
Line 18:		Line 18:
	=== Per-window private-browsing ===		=== Per-window private-browsing ===
	This release of the SDK adds support for per-window private-browsing. See the [https://addons.mozilla.org/en-US/developers/docs/sdk/1.14/modules/sdk/private-browsing.html private-browsing API documentation] and [https://blog.mozilla.org/addons/2013/02/26/per-window-private-browsing-and-the-add-on-sdk/ this blog post] for more details.		This release of the SDK adds support for per-window private-browsing. See the [https://addons.mozilla.org/en-US/developers/docs/sdk/1.14/modules/sdk/private-browsing.html private-browsing API documentation] and [https://blog.mozilla.org/addons/2013/02/26/per-window-private-browsing-and-the-add-on-sdk/ this blog post] for more details.

			If your add-on uses private browsing and is built with an earlier version of the SDK, it must be repacked with this version to be usable on Firefox 20. We are aiming to automate repacks of as many add-ons as possible, and will contact the authors of AMO-hosted add-ons to let them know if they need to repack.

			Due to a platform bug, if you update your code to use the new private browsing APIs (rather than just repack your code with the new SDK version), then your add-on will not be able to use the panel module.

	=== Unique IDs for tabs ===		=== Unique IDs for tabs ===

Wbamberg: /* Known Issues */

2013-03-26T21:03:22Z

Known Issues

← Older revision		Revision as of 21:03, 26 March 2013
Line 38:		Line 38:

	Can't load content from "data" directory into an iframe. Reported on the forum: https://forums.mozilla.org/addons/viewtopic.php?f=27&t=11689 - it's not possible to load content from an HTML file in an add-on's data directory into an iframe.		Can't load content from "data" directory into an iframe. Reported on the forum: https://forums.mozilla.org/addons/viewtopic.php?f=27&t=11689 - it's not possible to load content from an HTML file in an add-on's data directory into an iframe.

	~~'''[https://bugzilla.mozilla.org/show_bug.cgi?id=804935 Bug 804935]'''~~

	~~"TypeError: window.tabs is undefined" when opening a tab, in some circumstances.~~

	'''[https://bugzilla.mozilla.org/show_bug.cgi?id=785914 Bug 785914]'''		'''[https://bugzilla.mozilla.org/show_bug.cgi?id=785914 Bug 785914]'''

	The Google Analytics script does not register page views made using SDK objects such as panel and page-worker, because cookies are set incorrectly.		The Google Analytics script does not register page views made using SDK objects such as panel and page-worker, because cookies are set incorrectly.

	~~'''[https://bugzilla.mozilla.org/show_bug.cgi?id=752775 Bug 752775]'''~~

	~~Use of the deprecated global <code>postMessage()</code> function in a content script will give the error "ReferenceError: console is not defined".~~

	~~'''[https://bugzilla.mozilla.org/show_bug.cgi?id=731074 Bug 731074]'''~~

	console.log() calls from a script included in a panel's HTML (as in this example: https://builder.addons.mozilla.org/addon/1042246/latest/) don't work: nothing is logged, either to the terminal console or the web console.

	'''[https://bugzilla.mozilla.org/show_bug.cgi?id=717183 Bug 717183]'''		'''[https://bugzilla.mozilla.org/show_bug.cgi?id=717183 Bug 717183]'''
Line 102:		Line 90:

	When a user removes a widget from the toolbar its <code>detach</code> event does not get sent.		When a user removes a widget from the toolbar its <code>detach</code> event does not get sent.

	~~''' [https://bugzilla.mozilla.org/show_bug.cgi?id=661884 Bug 661884] '''~~

	~~Selection events for a page are not sent if the page did not fully load (for example, because the user stopped the page loading).~~

	''' [https://bugzilla.mozilla.org/show_bug.cgi?id=556562 Bug 556562]'''		''' [https://bugzilla.mozilla.org/show_bug.cgi?id=556562 Bug 556562]'''

Wbamberg at 21:02, 26 March 2013

2013-03-26T21:02:29Z

← Older revision		Revision as of 21:02, 26 March 2013
Line 4:		Line 4:

	The Add-on SDK is a software development kit that provides a set of tools and APIs for building, testing, and packaging Firefox add-ons.		The Add-on SDK is a software development kit that provides a set of tools and APIs for building, testing, and packaging Firefox add-ons.

	~~This is a [https://wiki.mozilla.org/Labs/Jetpack/Release_Notes/1.13.1#Hotfix_updates_to_1.13 hotfix release that updates 1.13].~~

	== Installation ==		== Installation ==
Line 11:		Line 9:
	Obtain the SDK in your favorite compression format:		Obtain the SDK in your favorite compression format:

	* [https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/addon-sdk-1.~~13.1~~.tar.gz addon-sdk-1.~~13.1~~.tar.gz]		* [https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/addon-sdk-1.14.tar.gz addon-sdk-1.14.tar.gz]
	* [https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/addon-sdk-1.~~13.1~~.zip addon-sdk-1.~~13.1~~.zip]		* [https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/addon-sdk-1.14.zip addon-sdk-1.14.zip]

	Then unpack the archive, open the <tt>addon-sdk-1.13.1/README.txt</tt> file, and follow its instructions.		Then unpack the archive, open the <tt>addon-sdk-1.13.1/README.txt</tt> file, and follow its instructions.

	~~== Hotfix updates to 1.13 ==~~		== Major Changes Since 1.13 ==

	~~The 1.13.1 release is a hotfix release that replaces the [[Labs/Jetpack/Release_Notes/1.13\|1.13 release]]. It includes the following extra fixes:~~

	* {{bug\|836318}}: reverted context menu items in sub-menus to display by default as they did in 1.12
	* {{bug\|832401}}: fixed an issue where certain combinations of add-ons could result in an extra separator in the context menu
	* {{bug\|834754}}: fixed a logged error from the selection module
	* {{bug\|836061}}: fixed simple-storage and other modules when run against Firefox 21

	== Major Changes Since 1.~~12 ==~~

	~~=== Context-menu rewrite =~~==

	~~We've rewritten the context-menu module, bringing the code up to date and fixing a number of bugs, including:~~

	* {{bug\|769709}}
	* {{bug\|700733}}
	* {{bug\|714914}}
	* {{bug\|700733}}
	* {{bug\|721849}}
	* {{bug\|729843}}
	* {{bug\|748743}}
	* {{bug\|757802}}
	* {{bug\|784611}}
	* {{bug\|800965}}
	* {{bug\|824482}}

	=== ~~Translators key supported in package.json~~ ===		=== Per-window private-browsing ===
			This release of the SDK adds support for per-window private-browsing. See the [https://addons.mozilla.org/en-US/developers/docs/sdk/1.14/modules/sdk/private-browsing.html private-browsing API documentation] and [https://blog.mozilla.org/addons/2013/02/26/per-window-private-browsing-and-the-add-on-sdk/ this blog post] for more details.

	The package.json now enables an add-on author to list the translators of an add-on, and these are translated into [https://developer.mozilla.org/en/docs/Install_Manifests#translator "translator" elements in the add-on's install manifest]. Thanks to community contributor [https://github.com/CIAvash CIAvash] for ~~this.~~		=== Unique IDs for tabs ===

	~~=== <strike>Unique IDs for tabs</strike> ===~~		Tabs now have a unique ID: {{bug\|795645}}.

	~~<strike>Tabs now have a unique ID: {{bug\|795645}}.</strike>~~		=== Bug fixes ===

	'~~'This feature was originally announced as being~~ in ~~the 1~~.13.~~1 release, but actually won't be available until the 1~~.~~14 release~~.''		Many bug fixes, including:
			* [https://bugzilla.mozilla.org/show_bug.cgi?id=731074 Bug 731074 - console.log not working from a panel's script]
			* [https://bugzilla.mozilla.org/show_bug.cgi?id=752775 Bug 752775 - "ReferenceError: console is not defined" with deprecated postMessage() usage in a content script]
			* [https://bugzilla.mozilla.org/show_bug.cgi?id=661884 Bug 661884 - Selection events occur only after (successful!) page load]
			* [https://bugzilla.mozilla.org/show_bug.cgi?id=804935 Bug 804935 - TypeError: window.tabs is undefined]

	== Known Issues ==		== Known Issues ==

Wbamberg: Created page with "{{draft|}} == About == The Add-on SDK is a software development kit that provides a set of tools and APIs for building, testing, and packaging Firefox add-ons. This is a [h..."

2013-03-26T20:53:41Z

Created page with "{{draft|}} == About == The Add-on SDK is a software development kit that provides a set of tools and APIs for building, testing, and packaging Firefox add-ons. This is a [h..."

New page

{{draft|}}

== About ==

The Add-on SDK is a software development kit that provides a set of tools and APIs for building, testing, and packaging Firefox add-ons.

This is a [https://wiki.mozilla.org/Labs/Jetpack/Release_Notes/1.13.1#Hotfix_updates_to_1.13 hotfix release that updates 1.13].

== Installation ==

Obtain the SDK in your favorite compression format:

* [https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/addon-sdk-1.13.1.tar.gz addon-sdk-1.13.1.tar.gz]
* [https://ftp.mozilla.org/pub/mozilla.org/labs/jetpack/addon-sdk-1.13.1.zip addon-sdk-1.13.1.zip]

Then unpack the archive, open the <tt>addon-sdk-1.13.1/README.txt</tt> file, and follow its instructions.

== Hotfix updates to 1.13 ==

The 1.13.1 release is a hotfix release that replaces the [[Labs/Jetpack/Release_Notes/1.13|1.13 release]]. It includes the following extra fixes:

* {{bug|836318}}: reverted context menu items in sub-menus to display by default as they did in 1.12
* {{bug|832401}}: fixed an issue where certain combinations of add-ons could result in an extra separator in the context menu
* {{bug|834754}}: fixed a logged error from the selection module
* {{bug|836061}}: fixed simple-storage and other modules when run against Firefox 21

== Major Changes Since 1.12 ==

=== Context-menu rewrite ===

We've rewritten the context-menu module, bringing the code up to date and fixing a number of bugs, including:

* {{bug|769709}}
* {{bug|700733}}
* {{bug|714914}}
* {{bug|700733}}
* {{bug|721849}}
* {{bug|729843}}
* {{bug|748743}}
* {{bug|757802}}
* {{bug|784611}}
* {{bug|800965}}
* {{bug|824482}}

=== Translators key supported in package.json ===

The package.json now enables an add-on author to list the translators of an add-on, and these are translated into [https://developer.mozilla.org/en/docs/Install_Manifests#translator "translator" elements in the add-on's install manifest]. Thanks to community contributor [https://github.com/CIAvash CIAvash] for this.

=== <strike>Unique IDs for tabs</strike> ===

<strike>Tabs now have a unique ID: {{bug|795645}}.</strike>

''This feature was originally announced as being in the 1.13.1 release, but actually won't be available until the 1.14 release.''

== Known Issues ==

See the [https://bugzilla.mozilla.org/buglist.cgi?order=Bug%20Number&bug_status=__open__&product=Add-on%20SDK complete list of known issues and requests for enhancement]. We've listed some of the issues you're most likely to encounter separately below.

'''[https://bugzilla.mozilla.org/show_bug.cgi?id=820213 Bug 820213]'''

Can't load content from "data" directory into an iframe. Reported on the forum: https://forums.mozilla.org/addons/viewtopic.php?f=27&t=11689 - it's not possible to load content from an HTML file in an add-on's data directory into an iframe.

'''[https://bugzilla.mozilla.org/show_bug.cgi?id=804935 Bug 804935]'''

"TypeError: window.tabs is undefined" when opening a tab, in some circumstances.

'''[https://bugzilla.mozilla.org/show_bug.cgi?id=785914 Bug 785914]'''

The Google Analytics script does not register page views made using SDK objects such as panel and page-worker, because cookies are set incorrectly.

'''[https://bugzilla.mozilla.org/show_bug.cgi?id=752775 Bug 752775]'''

Use of the deprecated global <code>postMessage()</code> function in a content script will give the error "ReferenceError: console is not defined".

'''[https://bugzilla.mozilla.org/show_bug.cgi?id=731074 Bug 731074]'''

console.log() calls from a script included in a panel's HTML (as in this example: https://builder.addons.mozilla.org/addon/1042246/latest/) don't work: nothing is logged, either to the terminal console or the web console.

'''[https://bugzilla.mozilla.org/show_bug.cgi?id=717183 Bug 717183]'''

Specified panel width ignored when Firefox is maximized.

'''[https://bugzilla.mozilla.org/show_bug.cgi?id=714181 Bug 714181]'''

Access to Full Screen API blocked from context-menu API.

'''[https://bugzilla.mozilla.org/show_bug.cgi?id=726796 Bug 726796]'''

<code>passwords.search()</code> function "crashes" with some profiles.

'''[https://bugzilla.mozilla.org/show_bug.cgi?id=667817 Bug 667817]'''

If you change location in a content script using:
<code>
window.location="http://mozilla.org";
</code>
Nothing happens, instead, `location` attribute is just replaced by a string.

'''[https://bugzilla.mozilla.org/show_bug.cgi?id=689215 Bug 689215]'''

The tab array is not reordered to match the on-screen order of the tabs after a tab move event takes place.

'''[https://bugzilla.mozilla.org/show_bug.cgi?id=663048 Bug 663048]'''

The SDK will give an error if your package name contains spaces or Unicode characters.

''' [https://bugzilla.mozilla.org/show_bug.cgi?id=627432 Bug 627432] '''

If your add-on stores data using the [https://addons.mozilla.org/en-US/developers/docs/sdk/1.0/packages/addon-kit/docs/simple-storage.html simple-storage] API, the data is not cleaned up when your add-on is uninstalled.

''' [https://bugzilla.mozilla.org/show_bug.cgi?id=571049 Bug 571049] '''

If an add-on is uninstalled while it's disabled, it's not notified of uninstall. If the add-on needs to do some special cleanup on uninstall, like removing persistent storage such as a file, this won't be possible if it has been disabled.

''' [https://bugzilla.mozilla.org/show_bug.cgi?id=660862 Bug 660862] '''

By default, widgets are placed on the add-on bar, and given a height to match the height of that bar. If the user moves the widget to a different toolbar, and that toolbar has a different height, the widget's height is not updated accordingly.

''' [https://bugzilla.mozilla.org/show_bug.cgi?id=660857 Bug 660857] '''

A widget containing HTML content gets no icon in the [http://support.mozilla.com/en-US/kb/how-do-i-customize-toolbars Customize Toolbar Window].

''' [https://bugzilla.mozilla.org/show_bug.cgi?id=660860 Bug 660860] '''

When a user removes a widget from the toolbar its <code>detach</code> event does not get sent.

''' [https://bugzilla.mozilla.org/show_bug.cgi?id=661884 Bug 661884] '''

Selection events for a page are not sent if the page did not fully load (for example, because the user stopped the page loading).

''' [https://bugzilla.mozilla.org/show_bug.cgi?id=556562 Bug 556562]'''

If you have copy of mozrunner installed on your system, the <code>cfx test</code> command may not work correctly.

There is a [https://bugzilla.mozilla.org/show_bug.cgi?id=556562#c6 workaround] for this.

== Feedback and Bug Reports ==

We'd love to hear any feedback you have regarding this release! You can post it to the [http://groups.google.com/group/mozilla-labs-jetpack discussion group] or [https://bugzilla.mozilla.org/enter_bug.cgi?product=Add-on%20SDK report a bug].