891729 - [User Story] Wallpaper Runtime Customization by SIM

Status: VERIFIED FIXED

(Firefox OS Graveyard :: Gaia::System, defect)

Description

[Peter Dolanjski [:pdol]]

User Story:

As an OEM, of the superset of wallpapers that I ship with the build, I want to be able to specify which wallpaper should be shown on the device based on the MNC/MCC setting from the SIM card inserted during the First Run Experience in order to target customizations to locales without needing to use separate builds.


Acceptance Criteria:

1. If a certain wallpaper is specified to be used for an MNC/MCC combination, and a SIM card with that MNC/MCC combination is in the device during the First Run Experience, the wallpaper used on the device homescreen is that specified wallpaper.
2. If no SIM card is inserted during the First Run Experience, the specified default wallpaper is used on the device homescreen.
3. If no SIM card is inserted during the First Run Experience, and no default wallpaper is specified, the Mozilla defined default wallpaper is used on the homescreen.

Comment 1

[Marina Rodríguez [:mai]]

Attachment: Patch - v2 - Wallpaper customization by SIM

WIP pending json location and unit test

Comment 2

[Marina Rodríguez [:mai]]

Create Attachment #798489 [details] [diff] that implements the required functionality. 

The variant.json file is a proposal to reuse for other variant settings bugs (For example, Bug 891730 - [User Story] Ringtone Runtime Customization by SIM).

Francisco, would you mind to take a look to the patch?
What do you think?

Comment 3

[Candice Serran (:cserran)]

ALBERTO CRESPELL PEREZ changed story state to started in Pivotal Tracker

Comment 4

[Kyle Machulis [:qdot] [:kmachulis] (INACTIVE)]

So I looked over the variant.json file. A couple of things:

- We've got a variant file for loading some settings, shared/resources/apn.json. We'll probably want this to look like that, which just means making both the mnc and mcc keys instead of just passing a string in.
- We'll probably also want to put this file in gaia/shared/resources instead of directly in the FTU app.

I'd been talking to aus about actually making a single variant file loader class that we could use for both apn and the media/other resource file, this looks like it's getting closer to that idea.

Comment 5

[Kyle Machulis [:qdot] [:kmachulis] (INACTIVE)]

Also just posted a message to the dev-systemsfe list about whether we want to use settings or ICCManager for getting the MCC/MNC, since we only care about the value at app initialization. That will inform how we implement integration tests for this.

Comment 6

[Marina Rodríguez [:mai]]

Hi,
- We placed the file in the FTU app because it is the only place where that information is used. I think it's less confusing, because the wallpaper has a default build value. But I don't mind change the locaction file.
- The format of the json file it's the same that is used for similar user story, because I don't find another standar format(Bug 893800). I agree with you, I think it's important define a standard for this kind of files.

Comment 7

[Kyle Machulis [:qdot] [:kmachulis] (INACTIVE)]

(In reply to marina rodríguez [:mai] from comment #6)
> Hi,
> - We placed the file in the FTU app because it is the only place where that
> information is used. I think it's less confusing, because the wallpaper has
> a default build value. But I don't mind change the locaction file.

That makes sense, since unlike apn.json we probably aren't expecting to keep all customization settings per carrier in the main gaia repo. We may be able to leave it like it is, though the important part is that we update the MDN Customization page once this is all figured out, since that's what OEMs will be looking at.

> - The format of the json file it's the same that is used for similar user
> story, because I don't find another standar format(Bug 893800). I agree with
> you, I think it's important define a standard for this kind of files.

Only reason I brought this up is because we have the apn.json file, as well as code to access it, in gaia already. Might be best to just keep all of those formats the same. It's really not too far off from what's in this bug or bug 893800, just uses 2 keys instead of 1.

Comment 8

[Marina Rodríguez [:mai]]

Comment on attachment 798489 [details] [diff] [review]
Patch - v2 - Wallpaper customization by SIM

I updated the attachment including missing unit test.
Ready for review.

Comment 9

[Francisco Jordano [:arcturus] [:francisco]]

Comment on attachment 798489 [details] [diff] [review]
Patch - v2 - Wallpaper customization by SIM

Comments on github.

Mainly would like to have separate configuration files for mcc/mnc, think about a way of adding them during build time if possible as well.

Would like to have separated the code for reading the files and the code that actually perform the actions.

A part from that, the code for handling the Icc it's looking pretty good, great job Marina, really good one.

F.

Comment 10

[Jason Smith [:jsmith]]

This was deemed as a strongly desired feature, not a must have. I don't see why this would block the release.

Peter - What do you think?

Comment 11

[Marina Rodríguez [:mai]]

Comment on attachment 798489 [details] [diff] [review]
Patch - v2 - Wallpaper customization by SIM

Sorry for the delay,
Regards,
Mai

Comment 12

[Francisco Jordano [:arcturus] [:francisco]]

Comment on attachment 798489 [details] [diff] [review]
Patch - v2 - Wallpaper customization by SIM

Nice work!

This is just what I was looking for :)

Great work.

Comment 13

[Francisco Jordano [:arcturus] [:francisco]]

Landed:

https://github.com/mozilla-b2g/gaia/commit/4884724f9541e0e25d8a26ba8279dfce3204ae2b

Thanks all for the work!

Comment 14

[Candice Serran (:cserran)]

Noemi Freire changed story state to finished in Pivotal Tracker

Comment 15

[Candice Serran (:cserran)]

ALBERTO CRESPELL PEREZ changed story state to delivered in Pivotal Tracker

Comment 16

[Candice Serran (:cserran)]

ALBERTO CRESPELL PEREZ changed story state to accepted in Pivotal Tracker

Comment 17

[Jason Smith [:jsmith]]

Marina - I'm trying to update the reference customization for allowing testing of wallpaper SIM customization. Can you provide a sample list.json under wallpapers that showcases the syntax of this customization?

Comment 18

[Marina Rodríguez [:mai]]

Attachment: sample.json for wallpaper

This user history is updating in https://bugzilla.mozilla.org/show_bug.cgi?id=917740 - Update file format of customization files based on MCC/MNC

Comment 19

[Jason Smith [:jsmith]]

(In reply to marina rodríguez [:mai] from comment #18)
> Created attachment 809009 [details]
> sample.json for wallpaper
> 
> This user history is updating in
> https://bugzilla.mozilla.org/show_bug.cgi?id=917740 - Update file format of
> customization files based on MCC/MNC

Okay - so I see the name of the file is 214-007.json. Where would this be stored in a customization directory? In other words, say I was going to add this file to https://github.com/yurenju/gaia-distribution-sample. Where would it go?

Comment 20

[Jason Smith [:jsmith]]

(In reply to Jason Smith [:jsmith] from comment #19)
> (In reply to marina rodríguez [:mai] from comment #18)
> > Created attachment 809009 [details]
> > sample.json for wallpaper
> > 
> > This user history is updating in
> > https://bugzilla.mozilla.org/show_bug.cgi?id=917740 - Update file format of
> > customization files based on MCC/MNC
> 
> Okay - so I see the name of the file is 214-007.json. Where would this be
> stored in a customization directory? In other words, say I was going to add
> this file to https://github.com/yurenju/gaia-distribution-sample. Where
> would it go?

Reuben clarified this in IRC. He says I need to generate a file with <MCC>-<MNC>.json that points to other relevant files like the attachment demonstrates. Something like:

214-02.json which contains:

{
   "wallpaper" : "test.jpg"
}

That should result in preloading support contacts for the MCC = 214, MNC = 02 SIM.

Comment 21

[Jason Smith [:jsmith]]

This isn't related to the apps feature for sim customizations, not removing that bug from the blocking list.

Comment 22

[Jason Smith [:jsmith]]

While doing testing of other customizations, I went ahead and verified this on trunk through the following sanity use cases:

- Default customization
- Adding SIM post default customization applied
- T-Mobile US SIM customization
- Switching SIM post T-Mobile SIM customization applied
- AT&T US SIM customization

Comment 23

[rafael.marquez]

I'm testing this user story and I have problems configuring the default wallpaper.

Can anyone tell me where to configure the default wallpaper?
Can anyone tell me where to configure the default wallpaper mozilla?

I am following these steps:

1. edit the file "firefoxos-gaia-testsbuild/wallpapers/list.json",  indicating the name of the image that I want by default on the device. (the picture is located in  "firefoxos-gaia-testsbuild/wallpapers")

2. Delete the directory "profile" of the repository Gaia

3. Execute the command "GAIA_DISTRIBUTION_DIR=/home/tel056/firefoxos-gaia-testsbuild  PRODUCTION=1 make reset-gaia"


After finishing the FTE without SIM inserted. The default image loaded is not the configured in the file list.json

Comment 24

[Jason Smith [:jsmith]]

Rafael - If you look here:

https://github.com/mozilla/qa-testcase-data/tree/gh-pages/customization/reference

It includes sample test cases using wallpapers in variants. Specifically in variant.json you'll notice:

      "wallpaper": "tmobileus/tmobileus_wallpaper.png"

Which allows specification of a wallpaper for MCC/MNC variant.

A default wallpaper when no SIM is specified in list.json in wallpapers as the first item in the list:

default.png

The other wallpapers included in that list are included as extra wallpapers in the build.

Comment 25

[rafael.marquez]

Case 1."If no SIM card is inserted during the First Run Experience, the specified default wallpaper is used on the device homescreen."

My list.json file:
cat list.json
[
  "customize3.png",
  "FXOS_Blue_Mountains.png",
  "FXOS_Cherry_Blossoms.png",
  "FXOS_Dusk_Flowers.png",
  "FXOS_Golden_Grass.png",
  "FXOS_Orange_Mountains.png",
  "FXOS_Shadows.png",
  "FXOS_Sunset_Field.png",
  "FXOS_Sunset_Grains.png",
  "FXOS_Techno_Wave.png",
  "FXOS_Water_Drops.png"
]

The content of the wallpapers folder:
customize3.png  list.json 

The default wallpaper should be customize3.png, but at the end of the FTE appears another different wallpaper.

Have you tried to change the default image before verifying the US? Have you test the US in 1.2 branch?


Case 2. "If no SIM card is inserted during the First Run Experience, and no default wallpaper is specified, the Mozilla defined default wallpaper is used on the homescreen"

I still have the same questions:
I do not know as not specifying a default wallpaper.
I do not know specify the default mozilla wallpaper .

Comment 26

[Jason Smith [:jsmith]]

For case 1:

* Where is list.json located?
* I did try changing the default image with my test customization on master & 1.2 - worked fine for me with my repository. If you try building with my test customization, does it work for you?

Note - it might help if you send me a zip file containing your test customization over email. That way, I can help debug this more directly on my side.

For case 2:

I think that use case is referring to the workflow of when a customization includes no default wallpaper. It's exactly the same of what you see right now when you use daily builds without a customization repository - it's the default wallpaper you see when you flash a nightly build.

For specifying the mozilla defined wallpaper - it's likely defined somewhere in the Gaia repository directly, but I don't know where. I'd ask one of the developers on how that's specified.

Comment 27

[Jason Smith [:jsmith]]

https://moztrap.mozilla.org/manage/cases/?pagenumber=1&pagesize=20&sortfield=created_on&sortdirection=desc&filter-tag=2339&filter-productversion=103