feat: config as file, UI tweaks and refacto #52
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Created an InfoService to centralized the logic * Added an info icon
* share whiteboard info only on change and at specific frequency * front update to track nb user connected
* Also started a bit of config handling cleaning
* Config should be provided as Yaml file now * Other way to provide configuration are now deprectaed * The config format is checked agaist a schema with the json-schema standard * Tests are are added to the project (in the backend for config parsing)
* ease throttling of events accross the frontend
|
Thanks! Really create stuff! 🥳 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi, I am back with a new PR :)
It's mainly a follow-up to our discussions on #50 (comment).
Here are the changes:
Config as file
The biggest change of this PR is that the configuration is now handled through a config file. I have deprecated the previous ways of handling config.
I'd love your input regarding the naming I have chosen inside the config file.
With this new config handling, we can tweak new settings:
A user can provide his/her own config file to override the values in the default one.
The resulting config is validated against a
jsonSchema. (I've added tests for that)Websockets / backend
I have cleaned some handling of whiteboard related information (smallest screen resolution & number of user connected) and stored that in
WhiteboardServerSideInfo.The information in this class is broadcasted to the corresponding whiteboard regularly (setting available in the config).
Frontend Services
I've added new services in the frontend: InfoService, ConfigService and ThrottlingService; to centralize the related behaviors.
CI
Run the new (and future) tests in CI.
Refactoring
Switch to real private fields in the frontend (with
#-- ES2020) and getters (for read-only fields).Other
Required node version is now >= 12.