Desktop — Firefox Pocket Integration

Note: Please note that information is still being added to this page.

Ownership

Developer contacts: ---

QA Lead: Andrei Vaida, :avaida on IRC

Status

Overview

[LANDED] Nightly 40: first landed, disabled by default
[ON TRACK] Aurora 39: ---
[ON TRACK] Beta 38: ---
[ON TRACK] Release 38: ---

Risk analysis

Event	Probability	Impact	Current situation	Mitigation steps
Users that have the Pocket add-on already installed are not handled properly after updating to a Pocket-integrated Firefox build.	probable	high	---	Periodical regression testing covers this area.
Users that have the Pocket social media service already installed are not handled properly after updating to a Pocket-integrated Firefox build.	probable	high	---	Periodical regression testing covers this area.
User fails to log into Pocket using the FxA sign-in flow.	probable	high	---	Periodical regression testing covers this area.
Page fails to be saved to Pocket.	probable	high	---	Periodical regression testing covers this area.
Saved page fails to be opened from Pocket.	probable	high	---	Periodical regression testing covers this area.
Reader View fails to display pages saved to Pocket.	probable	high	---	Periodical regression testing covers this area.

Summary

Context

The features made available by this integration:

Save to Pocket button in the toolbar
Open Pocket item from the bookmarks menu
Save to Pocket button in the context menu
FxA sign-in for Pocket
Save to Pocket button from Reader View's controls
UI tour
Reader View aesthetic to align with what Pocket is currently offering

Enabling the feature

Pocket is available starting with Firefox 40 and it can be enabled by setting the following pref to true:

browser.pocket.enabled

A hostname is also required to ensure Pocket's functionality, that's being done through the following pref:

browser.pocket.hostname

References

The Pocket toolbar panel mock is available here.
A design mock depicting a few Pocket flows is available here
A design mock showing confirmation panel's variations and states is available here.
A design mock showing the bookmarks menu entry is available here.

Test cases

Overview

A few of the targeted scenarios

As a user, I can log into Pocket with an existing Firefox Account, so that I can start using the feature without having to create a new set of credentials.
As a user, I can log into Pocket with an existing Pocket account, so that I can start using the feature without having to create a new set of credentials.
As a user, I can log into Pocket with a new Firefox Account, so that I can start using Pocket.
As a user, I can log into Pocket with a new Pocket account, so that I can start using Pocket.
~~As a user, I can save a page to Pocket by clicking the dedicated Pocket button from the Location Bar~~.

↳ UPDATE 2015-04-28: there won't be a dedicated Pocket button in the Location Bar, at least for now

As a user, I can save a page to Pocket by clicking the dedicated Pocket button from the controls available in Reader View.
As a user, I can save a page to Pocket by clicking the dedicated Pocket option from the context menu.
As a user, I can view the items saved to Pocket from the dedicated Pocket entry available in the bookmarks menu.
As a user, I can start using Pocket on an older profile that already has it installed as an add-on.
As a user, I can start using Pocket on an older profile that already has it installed via Social API.
~~As a user, I can remove a page from Pocket using the dedicated Pocket button from the Location Bar~~.

↳ UPDATE 2015-04-28: there won't be a dedicated Pocket button in the Location Bar, at least for now

As a user, I can remove a page from Pocket using the dedicated Pocket entry from the bookmarks menu.
~~As a user, I can remove a page from Pocket using the dedicated Pocket option from the context menu~~.

↳ UPDATE 2015-04-28: the only option available in the context menu will be to save a page to Pocket, NOT to remove it

As a user, I can be notified in a friendly way if my connection or the Pocket servers are down.

Draft test suites:

[IN PROGRESS] Smoke and Regression Test Suites

MozTrap test suites:

[ON TRACK] Smoke Test Suite
[ON TRACK] Regression Test Suite

Bug work

Tracking bugs

[META] Bug 1155467 - [meta] Firefox Pocket integration

see this bug's dependency tree

[META] Bug 1157495 - [meta] Pocket quality and test eng tasks

see this bug's dependency tree

[META] Bug 1157492 - [meta] Pocket integration metrics tracking

see this bug's dependency tree

Bug triage +/- for verification

[QE-VERIFY+] Bug 1155523 - Implement rough first-pass at Pocket toolbar button UI
[QE-VERIFY+] Bug 1155517 - Change Reader View to have a "Save Page to Pocket" button instead of "Add To Reader List"
[QE-VERIFY+] Bug 1155518 - Implement "Save to Pocket" context menu item
[QE-VERIFY+] Bug 1155519 - Add "View Pocket Items" menuitem to the bookmarks menu
[QE-VERIFY-] Bug 1155520 - Add telemetry for Pocket integration
[QE-VERIFY-] Bug 1158289 - Optimize Reader View's line length to have between 45 and 75 characters
[QE-VERIFY+] Bug 1158281 - Match Pocket's Reader View Sepia Theme

Bug fix verification

[VERI] Bug 1155523 - Implement rough first-pass at Pocket toolbar button UI

↳ 2015-04-30: partial functionality confirmed fixed on 40.0a1, across platforms

[VERI] Bug 1156878 - Send a request to the server when clicking the Pocket toolbar button

↳ 2015-04-30: confirmed fixed on 40.0a1, across platforms