Firefox/Projects/Action based on update xml after app update: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
(Created page with '== Summary == After app update perform action based upon the update metadata. == Current Status == App update work almost complete. Front end work in progress. AUS work will b…')
 
 
(45 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Summary ==
== Pitch ==


After app update perform action based upon the update metadata.
Instead of just opening a web page after an update Firefox should be able to perform an action based upon the update's metadata. For example, after an update the user can be presented with a notification asking them to join the Firefox Facebook group along with the ability to navigate to the Firefox Facebook group.


== Current Status ==
== Goals ==


App update work almost complete.
* Provide the ability to perform actions after app update based on an attribute in the update xml.
Front end work in progress.
* Have app specific free form attributes in the update xml saved locally to be used by the Firefox frontend. The current uses for these attributes are custom actions and localized strings for the UI.
AUS work will be started soon.
* Add mochitest chrome tests for testing the app update side. This has the additional benefit of testing the majority of the app update UI.
 
== Non Goals ==
 
* Creation of the process for acquiring / applying localized strings to the update xml.
 
== Status ==
 
* Client side LANDED (on trunk) - AUS side TBD
* project lead: rs
* project members: nthomas (aus)
* app update implementation rev 1 landed - <s>{{bug|530872}}</s>
* app update implementation rev 2 landed (new feature request 3/1/10) - <s>{{bug|549969}}</s>
* frontend landed - <s>{{bug|538331}}</s>
* AUS work hasn't started - {{bug|459972}}
* tracking bugs:
** <s>{{bug|530872}}</s> - app.update.url params / update.xml cleanup and addition of a custom string property for apps
** <s>{{bug|549969}}</s> - Add ability to save xml attributes from update xml that app update doesn't care about
** <s>{{bug|538331}}</s> - On update perform action based upon the update metadata
** {{bug|459972}} - Add new attributes to the update snippets (releng)


== Next Steps ==
== Timeline / Milestones ==


* Request review on the app update patches in {{bug|530872}}.
* 2010/03 - app update first revision - client backend - completed.
* ddahl to finish patches on the front end work {{bug|538331}}.
* 2010/03 - app update second revision - free form update xml attributes implemented in the client backend - completed.
* 2010/04 - Firefox frontend - completed.
* 2010/04 - AUS - TBD.


== Related Bugs ==  
== Delivery Requirements ==


{{bug|530872}} - app.update.url params / update.xml cleanup and addition of a custom string property for apps
* Backport to 1.9.2 and 1.9.1
{{bug|538331}} - On update perform action based upon the update metadata


== Team ==
== Constraints ==


*'''App Update work''': rs
* AUS implementation
*'''Firefox front end work''': ddahl
* No perf impact
*'''AUS work''': nthomas


== Designs ==
== Dependencies ==


The update xml will provide a custom attribute named extra1. The value if extra1 will be set in the app.update.extra1 preference which can then be used by Firefox to determine that an update has just been applied and perform the action specified in the value. After the value of this preference is read Firefox should delete the preference to prevent performing the action again on the next launch.
* ?
# undefined = extra1 was not specified in the update snippet. I think this should just be the current action.
# silent = do nothing
# openURL = open a url. This should be the current action using the pref containing the url
# openURL http://etc. = open the url specified after the space.
# showNotification = show the notification bar. The url should be the url contained in the current action pref.
# showNotification http://etc. = show the notification bar with the url specified after the space.
# showAlert = show an alert. The url should be the url contained in the current action pref.
# showAlert http://etc. = show an alert with the url specified after the space.


== Goals/Use Cases ==
== Testing ==


* Provide the ability to perform actions after app update based on an attribute in the update xml.
* App update has mochitest chrome tests and xpcshell tests for the app update changes.
* Firefox will have mochitest chrome tests for the frontend changes.
* A security review is likely required for this feature.


== Non Goals ==
== Related Projects ==


* TBD
* None

Latest revision as of 03:00, 7 April 2010

Pitch

Instead of just opening a web page after an update Firefox should be able to perform an action based upon the update's metadata. For example, after an update the user can be presented with a notification asking them to join the Firefox Facebook group along with the ability to navigate to the Firefox Facebook group.

Goals

  • Provide the ability to perform actions after app update based on an attribute in the update xml.
  • Have app specific free form attributes in the update xml saved locally to be used by the Firefox frontend. The current uses for these attributes are custom actions and localized strings for the UI.
  • Add mochitest chrome tests for testing the app update side. This has the additional benefit of testing the majority of the app update UI.

Non Goals

  • Creation of the process for acquiring / applying localized strings to the update xml.

Status

  • Client side LANDED (on trunk) - AUS side TBD
  • project lead: rs
  • project members: nthomas (aus)
  • app update implementation rev 1 landed - bug 530872
  • app update implementation rev 2 landed (new feature request 3/1/10) - bug 549969
  • frontend landed - bug 538331
  • AUS work hasn't started - bug 459972
  • tracking bugs:
    • bug 530872 - app.update.url params / update.xml cleanup and addition of a custom string property for apps
    • bug 549969 - Add ability to save xml attributes from update xml that app update doesn't care about
    • bug 538331 - On update perform action based upon the update metadata
    • bug 459972 - Add new attributes to the update snippets (releng)

Timeline / Milestones

  • 2010/03 - app update first revision - client backend - completed.
  • 2010/03 - app update second revision - free form update xml attributes implemented in the client backend - completed.
  • 2010/04 - Firefox frontend - completed.
  • 2010/04 - AUS - TBD.

Delivery Requirements

  • Backport to 1.9.2 and 1.9.1

Constraints

  • AUS implementation
  • No perf impact

Dependencies

  • ?

Testing

  • App update has mochitest chrome tests and xpcshell tests for the app update changes.
  • Firefox will have mochitest chrome tests for the frontend changes.
  • A security review is likely required for this feature.

Related Projects

  • None
Retrieved from "https://wiki.mozilla.org/index.php?title=Firefox/Projects/Action_based_on_update_xml_after_app_update&oldid=213928"