web: Fix the config negotation between self-hosted and the extension

[danielhjacobs]

No description provided.

[danielhjacobs]

Comment is here to facilitate discussion. Start discussing below. This has come up before. Site owners have come out against it, mainly arguing against showSwfDownload being able to be changed by end-users. However, it is true that end users can usually just check the network tab, making this just a convenience method.

[n0samu]

The extension config taking precedence is fine with me 👍

[danielhjacobs]

See the new getter.

[danielhjacobs]

The idea here, much like explicitOptions, is to only set these options if autostart is not the default (false), so if a self-hosted config sets autoplay to "on", for example, it's not ignored when the extension is used.

[danielhjacobs]

This is not important if the self-hosted config takes precedence over the extension toggles as is currently the case.

[danielhjacobs]

loadedConfig needs to be able to change after load in the event that load is run either before the extension loads or before a self-hosted script that sets window.RufflePlayer.config runs.

[danielhjacobs]

Two separate configs, one for the extension and the other for self-hosted, ensures the values of one can not override the values of the other. We can ensure the values in the extension don't override the values of self-hosted without a separate config, as we control the way the values in the extension config are set. However, we can not do the same in reverse, as we can't dictate how self-hosted config values are set.

[danielhjacobs]

window.RufflePlayer.config is now explicitly the self-hosted config.

[Dinnerbone]

I've thought about this before, and never added it because it just didn't feel right. Today looking at it in code, I'm still a little hesitant.

I think I'd prefer something like ruffle.configs as an array of configs + a new field "priority", where the existing config is an implicit entry at prio 0. We build loadedConfig by iterating the configs and merging them - sorted by prio ascending.

We can then in the extension have some things that don't override the websites wishes (insert with low prio), and some that do (insert with high prio). Log level absolutely should change the log level, but "download swf" is the only debatable one afaik.

Websites like the wayback machine can then also use this to better give their preferences without a website replacing their wishes. Assuming, of course, a website doesn't just blindly go RufflePlayer.configs = []. We should only document it in the tsdocs and give proper usage guidelines.
(Ofc the same issue is present with this pr - someone could just RufflePlayer.extensionConfig = {} too... or just RufflePlayer = {})

[torokati44]

but "download swf" is the only debatable one afaik.

The browser is still the user agent. You host it publicly, I can access it. If I can access it to play it, my browser will store it anyway in it's cache, so if I want to, I will keep it to myself. No need/point to make it unnecessary complicated by me having to open the network tab in the developer tools or whatever...