1016225 - [Collection App] Build time Collection configuration

Status: RESOLVED FIXED

(Firefox OS Graveyard :: Gaia, defect)

Description

[Amir Nissim (:amirn)]

Allow partners to specify a list of Collections which will be preinstalled on the device.

Comment 1

[Marcelino Veiga Tuimil [:sonmarce]]

It should be aligned with bug 1006172, so that configuration files of vertical homescreen can include a number of smart collections

Comment 2

[Amir Nissim (:amirn)]

Cristian, can you take this?

Comment 3

[Cristian Rodriguez (:crdlc)]

Maybe it can be done by Carmen or Albert in their tasks about builds

Comment 4

[Albert [:albert]]

I already added collections in the patch of bug 1016928

Comment 5

[Cristian Rodriguez (:crdlc)]

BTW what do we need here?

1. Manifests to represent the collections pre-installed under "shared" like:

https://github.com/mozilla-b2g/gaia/tree/master/apps/homescreen/collections

2. In build time we have to iterate those manifests in order to generate a JSON file with the info

Two scenarios:

* "Homescreen app" loads the JSON to populate the collection datastore with that info

or 

* "FTU app" opens "Collection app" to load the JSON to populate the collection datastore with that info

Comment 6

[Cristian Rodriguez (:crdlc)]

From my point of view

1) Collection manifests and icons under "Collection" app (like the old homescreen has currently)
2) In build time of "Collection" app we have to create the JSON file with the descriptors
3) When the homescreen is launched, via IAC, we have to send a message to "Collection" app like "configure"
4) When "Collection" app receives this message, it loads the JSON file and populate the datastore (if it was not populated before for sure)
5) "Collection" app sends a message "ready" and "Homescreen app" could read the datastore to recover names and icons for collection pre-installed

Suggestions? ideas?

Comment 7

[Cristian Rodriguez (:crdlc)]

or the FTE instead of Homescreen could send the message "configure"

Comment 8

[Carmen Jimenez Cabezas]

Talked about this out of line

Comment 9

[Kevin Grandon :kgrandon]

I'm not sure if a collection manifest is really all that valuable, but in any case it seems like it should be part of the collections app if necessary. I also feel like we should take the same approach as: https://bugzilla.mozilla.org/show_bug.cgi?id=1017069#c9

We should probably either do this in some startup task after upgrade. Either within the same homescreen origin, or through some cross-app handler after upgrade.

Comment 10

[Cristian Rodriguez (:crdlc)]

We have to split in three pieces thought:

--- First bug - Build time ---

* Collection app needs details about each smart collection that could be added to FFOS (name, providerId, icon path, icon resource, ...) In the past, we had stored this info here https://github.com/mozilla-b2g/gaia/tree/master/apps/homescreen/collections. If this info continues being completely needed we have to copy these resources to collection app.

* Obviously, all this info should be translated to a JSON file in built time in order to collection app can consume it

--- Second bug - Collection App starting ---

* Collection app needs to know what smart collections are available with all their info (name, providerId, icon path,...)

* We have to implement a library like CollectionInfo.get(id) and CollectionInfo.getAll() based on indexedDB where we will be able to ask for details.

var tv = CollectionInfo.get(providerId or ...);
tv.name, tv.icon, tv.id.....

* The fist time what collection app is launched, indexedDB will be empty and we have to load the JSON file in order to populate this one

--- Third bug - Pre-installed collections & Datastore ---

* Which collections are pre-installed?

This is configured by OEMs in the homescreens.json

* .. So we have to extract these set of collections from this file in Collection app build time.

* The first time when users are upgrading devices from 1.x to 2.0, behind scene in the FTE, we can send a message via IAC to Collection app saying "configure", "init" or how we want :). In that point, the collection app loads the info of pre-installed collections generated in build time and populates the datastore.

---

Ran, Amir, Kevin, Carmen, Albert:

Any concern, doubt or misunderstanding from my side?, do you miss something?

Ran or Amir, are details of collections the same than 1.5?

https://github.com/mozilla-b2g/gaia/tree/master/apps/homescreen/collections

Comment 11

[Amir Nissim (:amirn)]

- first part - 
I think it is ok to start with copying everything we already have in homescreen1 and later we can clean up what is not needed. Please also include the new icons and backgrounds in:
https://github.com/mozilla-b2g/gaia/pull/16343/files
https://github.com/mozilla-b2g/gaia/pull/18123/files

I had to back these out just now because of the large increase in the homescreen size (bug 1019321) so I am not sure what is the correct way to include these assets.

- second part - 
maybe we can use `CollectionDatabase` for that?
https://github.com/mozilla-b2g/gaia/blob/master/shared/js/collections_database.js#L237

can we skip indexDB? - load the json and save directly to Datastore?

- third part - 
let's start with the same pre-installed collections as in homescreen1 (social, games, music, showbiz)
https://github.com/mozilla-b2g/gaia/blob/master/apps/homescreen/build/default-homescreens.json#L8


Thank you very much Cristian :)

Comment 12

[Cristian Rodriguez (:crdlc)]

Inline

(In reply to Amir Nissim (Everything.me) from comment #11)
> - first part - 
> I think it is ok to start with copying everything we already have in
> homescreen1 and later we can clean up what is not needed. Please also
> include the new icons and backgrounds in:
> https://github.com/mozilla-b2g/gaia/pull/16343/files
> https://github.com/mozilla-b2g/gaia/pull/18123/files
> 
> I had to back these out just now because of the large increase in the
> homescreen size (bug 1019321) so I am not sure what is the correct way to
> include these assets.
> 
> - second part - 
> maybe we can use `CollectionDatabase` for that?
> https://github.com/mozilla-b2g/gaia/blob/master/shared/js/
> collections_database.js#L237
> 
> can we skip indexDB? - load the json and save directly to Datastore?

The datastore just stores collections already installed in the device (homescreens) and we need to stores in other place the info for all collections that could be added by users, right?

> 
> - third part - 
> let's start with the same pre-installed collections as in homescreen1
> (social, games, music, showbiz)
> https://github.com/mozilla-b2g/gaia/blob/master/apps/homescreen/build/
> default-homescreens.json#L8
> 
> 
> Thank you very much Cristian :)

Comment 13

[Amir Nissim (:amirn)]

(In reply to Cristian Rodriguez (:crdlc) from comment #12)
> The datastore just stores collections already installed in the device (homescreens) and we need to stores in other place the info for all collections that could be added by users, right?

right. but we can have the collection app load json > write to datastore.
am I missing something?

Comment 14

[Cristian Rodriguez (:crdlc)]

I think so or maybe I am wrong :) Let me explain

* indexedDB stores all data for collections which could be added to the homescreen

* datastore stores collections which are already added in homescreens

Comment 15

[Cristian Rodriguez (:crdlc)]

or maybe we could save this info in the datastore under another index

Comment 16

[Vivien Nicolas (:vingtetun) (:21) - (NOT reading bugmails, needinfo? please)]

(In reply to Cristian Rodriguez (:crdlc) from comment #5)
> BTW what do we need here?
> 
> 1. Manifests to represent the collections pre-installed under "shared" like:
> 
> https://github.com/mozilla-b2g/gaia/tree/master/apps/homescreen/collections
> 
> 2. In build time we have to iterate those manifests in order to generate a
> JSON file with the info
> 
> Two scenarios:
> 
> * "Homescreen app" loads the JSON to populate the collection datastore with
> that info
> 
> or 
> 
> * "FTU app" opens "Collection app" to load the JSON to populate the
> collection datastore with that info

I like the FTU app opens the collection app to load the JSON idea. It may opens more possibility in the future. For example the Collection app can have a UI to let the user choose some of the collection he wants based on some questions. This could be part of the FTU experience has a dedicated screen.

Comment 17

[Kevin Grandon :kgrandon]

It sounds like the main concern here is whether or not we need another indexedDB for collections - I'm under the impression that we don't, but maybe I'm mistaken. For pre-installed I think it makes sense that we go directly from JSON -> datastore after some upgrade event. 

I think we will only ever need to do this a single time (after upgrade), so I can't really see a reason to need another indexedDB.

Comment 18

[Cristian Rodriguez (:crdlc)]

(In reply to Kevin Grandon :kgrandon from comment #17)
> It sounds like the main concern here is whether or not we need another
> indexedDB for collections - I'm under the impression that we don't, but
> maybe I'm mistaken. For pre-installed I think it makes sense that we go
> directly from JSON -> datastore after some upgrade event. 

Pre-installed collections -> JSON -> datastore
Already added collections in previous versions -> Upgrade event -> Migrate to datastore 

> 
> I think we will only ever need to do this a single time (after upgrade), so
> I can't really see a reason to need another indexedDB.

Where is the info for all collections that ev.me shows in the combo? I mean tv, social, sports, showbiz, news, music, local, games, funny, etc.. It is defined as manifests in the collection app

All this data -> JSON -> indexedDB or datastore under another index or ...?

Comment 19

[Kevin Grandon :kgrandon]

(In reply to Cristian Rodriguez (:crdlc) from comment #18)
> Where is the info for all collections that ev.me shows in the combo? I mean
> tv, social, sports, showbiz, news, music, local, games, funny, etc.. It is
> defined as manifests in the collection app
> 
> All this data -> JSON -> indexedDB or datastore under another index or ...?

I believe this data comes back as an Eme API request. I'll let Ran/Amir weigh in more, but the code should be here: https://github.com/mozilla-b2g/gaia/blob/master/apps/collection/js/create_collection.js#L33

Comment 20

[Cristian Rodriguez (:crdlc)]

ok, that is useful only for pre-installed collections, I mean the local manifests. Perfect for me.

Comment 21

[Kevin Grandon :kgrandon]

All dependent bugs resolved.