create preferencesStorage.js

[zepumph]

From phetsims/chipper#1042 (comment), @jessegreenberg and I want to create a way to store preferences with localStorage when possible.

We discussed how to do this for quite some time, with a few options.

1. We could have preferencesStorage be more like a model for all preferences Properties, and initialize it with those Properties. Then the "view" could use preferencesStorage.xProperty in its components. We didn't like this because it seemed like a code smell to have to have all preferences Properties in the same file. There are a bunch of types of Properties for preferences. Audio/General/voicing/visual etc. In the view these are modular, so why cram them all into the same file in the model?
2. We could have preferencesStorage just hard coded to mutate the same Properties that the view does. This duplicates these Properties, and is harder to maintain.
3. What we would like to do: Create preferencesStorage.register() which is called within the preferences UI to mark a Property as something that should support this local storage feature.

Good luck us!

[zepumph]

Another nice part about our strategy is that we can gracefully add in what we want to support as we go. From phetsims/chipper#1042 all I care about most is the three voicing levels checkboxes and the speech rate. That is where I will begin with this experiementation.

[zepumph]

Note that we have to try catch that localStorage is supported, like https://github.com/phetsims/phet-io-wrappers/blob/361a103ffac5d317d28bd9077fe8019cad72ffc1/playback/js/loadSessions.js#L323-L339

[zepumph]

@jessegreenberg, here is a start. Can you review, and also think/add any others that you may be wanting here.

Should we add this to phetmarks?

[zepumph]

There seems to be something still out of sync here. I'm unsure what it is. I'll keep taking a look. Perhaps preferencesStrorage.register cannot be so "late" in the startup sequence: in the view where used in the Preferences panel. I'll see what the trouble is first though.

[zepumph]

There seems to be something still out of sync here. I'm unsure what it is. I'll keep taking a look. Perhaps preferencesStrorage.register cannot be so "late" in the startup sequence: in the view where used in the Preferences panel. I'll see what the trouble is first though.

This is caused because the PreferencesDialog is created lazily, thus the PreferencesStorage registration is also done lazily. @jessegreenberg, I think we may need to create a more central, "model-like" spot to register the preferences we have. Then pass that object to the view. What do you think?

[zepumph]

@jessegreenberg and I discussed this, and we feel like creating a more base-level "PreferencesModel" is the way to go. This will house all the Properties used by the view so that the view doesn't sprinkle in dependencies. It also allows for a single place where PreferencesStorage can register Properties. This seems much more prudent to me.

We discussed briefly the though of just creating the dialog on startup, but didn't like forcing that to support PreferencesStorage. It also didn't seem very MVC.

We will refactor in #743, and then come back here to register things.

[zepumph]

@jessegreenberg will let me know when this is ready for further work.

[zepumph]

Added rate and pitch above to greatly increase my productivity while testing. It adds to the list that would be refactored into a PreferencesModel, but not too horribly I think.

[zepumph]

Added interactiveHighlights property above.

I have made some progress in #743, it would be good to touch base with @jessegreenberg in this issue to see if he ever uses ?preferencesStorage, and what he would like to see improved on it.

[zepumph]

Ok. I updated this to house more Properties that PreferencesModel supports. Please review. Is there anything else you'd like here?

[jessegreenberg]

This is great, thank you! I am loving this feature. There was a TODO that I just removed about where to put PreferencesStorage.register calls. I think now that we only have PreferencesModel they are great where they are.

Ready to close?

[zepumph]

I wonder if we should add any more to preferencesStorage? Also I wonder if customPreferences properties that are getting linked should be stored here. Perhaps via an option? I'll take a look.

[zepumph]

I'm wondering if we can figure out a way to combine the function to link phet-io elements and register for preferences storage. I'll think about it.