1006172 - [User Story] [Home2] Customization of vertical homescreen

Status: RESOLVED FIXED

(Firefox OS Graveyard :: Gaia::Homescreen, defect, P1)

Description

[Kevin Grandon :kgrandon]

We need a flexible build script for the vertical homescreen which will handle the default positions for icons, dividers, and smart collections when we have them. Currently we parse mozApps and BookmarksDatabase if we have no local indexedDB, and just save results in the order that we get them. We need to do something closer to the current homescreen where we can specify the position and page of each icon. I think in the end there will be the following item types:

- Application
- Bookmark
- Divider
- Smart Collection

We had talked about re-using the same build scripts from the current homescreen, but the concept of dividers does not translate over easily. Perhaps there is some room for some code and utilities to go into the shared/ folder though.

I'm unfortunately not too happy with the current code to populate the initial indexedDB, so we may want to rewrite it. It was a rush job for the user test. Here are some files of interest.

Application source, imports applications from mozApps and listens to install/uninstall events: https://github.com/mozilla-b2g/gaia/blob/e3bf21177e0a993d97c460317c2bb632fcdae3f9/dev_apps/home2/js/sources/application.js

Bookmark source, imports bookmarks from BookmarksDatabase and listens to events: https://github.com/mozilla-b2g/gaia/blob/e3bf21177e0a993d97c460317c2bb632fcdae3f9/dev_apps/home2/js/sources/bookmark.js

Item store, where we load/save data from: https://github.com/mozilla-b2g/gaia/blob/e3bf21177e0a993d97c460317c2bb632fcdae3f9/dev_apps/home2/js/stores/item.js

And this is where the ItemStore picks up items if the database is empty: https://github.com/mozilla-b2g/gaia/blob/e3bf21177e0a993d97c460317c2bb632fcdae3f9/dev_apps/home2/js/stores/item.js#L51

The detail property of each object is what we essentially use as a write/read protocol to spin up/save grid objects: https://github.com/mozilla-b2g/gaia/blob/e3bf21177e0a993d97c460317c2bb632fcdae3f9/dev_apps/home2/js/grid/icon.js#L18

Comment 1

[Marcelino Veiga Tuimil [:sonmarce]]

I have just re-read the wireframes and they are not very detailed yet about grid customization and the equivalence with old homescreen. But, if I understood well, I think we can match some concepts from old homescreen:

  * Dividers are used to group applications, so in some way they are similar to old horizontally switching screens
  * My favorites would be at the very beginning, so apps until first divider could be like old dock

With this equivalence it would be possible to switch between old and new homescreens, keeping most of the grid configuration

What do you think?

Comment 2

[Kevin Grandon :kgrandon]

It would be possible to use the same initial data to import into the vertical homescreen, but we're not going to be able to have code that maintains grid state across the application. So while a user might be able to switch between the two and have some similarity between groups and pages, this would not last if they started installing apps or moving icons around.

I don't have a preference as to whether or not we try to use the same data as the existing homescreen, or create a new format for it. I think UX had some concerns that pages might not map exactly to sections though.

Comment 3

[Marcelino Veiga Tuimil [:sonmarce]]

Rewritten as a draft user story, so we can start implementation while details are discussed

Comment 4

[Marcelino Veiga Tuimil [:sonmarce]]

Rewritten user story to take into account we will only have vertical homescreen (no way to go back to former horizontal homescreen), and also adding details about customization procedure (doing the best to match behavior of former horizontal homescreen)

Comment 5

[Tony Chung [:tchung]]

Assigning to Rafael from TEF to own customization of vertical homescreen testing.

Comment 6

[Carmen Jimenez Cabezas]

Attachment: Add initial configuration processing to vertical homescreen

Comment 7

[Francis Djabri [:djabber]]

Passing this on to Jacqueline if any UX input is needed.

Comment 8

[Kevin Grandon :kgrandon]

Comment on attachment 8429581 [details] [review]
Add initial configuration processing to vertical homescreen

Hey Carmen, this is looking really good! I left a few nitpicks on github, nothing that would block the review though.

I have not yet tested on a device - can you provide me a copy of init.json that you used? Or should I wait for bug 1016928 to be done? In any case, I don't think we should have a final R+ until we have the system in place to generate init.json, or alternatively we could check in a hard-coded one with this patch if you prefer to land earlier.

Comment 9

[Marcelino Veiga Tuimil [:sonmarce]]

No UX feedback required at this moment, as it was discussed offline

Comment 10

[Kevin Grandon :kgrandon]

Comment on attachment 8429581 [details] [review]
Add initial configuration processing to vertical homescreen

I've done a bunch of testing and I haven't found anything obviously broken. my only complaint is that I think we should have a different store class for SvApps Vs Items, with the logic split appropriately between two different files. In this case we would need a third db.js file to handle upgrading, etc. If you are feeling adventurous you can do this now, or I can handle in a follow-up.

Please feel free to rebase and land. There are some conflicts, but they should not be too bad to resolve. Thanks for your hard work on this!

Comment 11

[Carmen Jimenez Cabezas]

https://github.com/mozilla-b2g/gaia/commit/e33061348a5134923252a8bddc835000e4fcfa9c
r=kgrandon

Comment 12

[Kevin Grandon :kgrandon]

Mass modify - set status-b2g-v2.0 fixed for fixed bugs under vertical homescreen dependency tree.

Comment 13

[Marcelino Veiga Tuimil [:sonmarce]]

Updated acceptance criteria to match final implementation