[Feat] Create settings route and class #48
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
taufiq
suggested changes
Dec 17, 2019
classes/Settings.js
Outdated
| }) | ||
| const { content: socialMediaResp, sha: socialMediaSha } = await socialMedia | ||
|
|
||
| return ({ configResp, socialMediaResp, configSha, socialMediaSha }) |
There was a problem hiding this comment.
I don't think we should dump the entire content of _config.yml and pass it to the frontend. Since some of the data in the .yml file is meant to be read only, we should just provide data that is sufficient for the frontend's settings page.
There was a problem hiding this comment.
Modified to transmit only relevant fields
classes/Settings.js
Outdated
| // update files | ||
| const newConfigContent = base64.encode(yaml.safeDump(configSettings)) | ||
| const newSocialMediaContent = base64.encode(yaml.safeDump(socialMediaSettings)) | ||
| await config.update(newConfigContent, configSha) |
There was a problem hiding this comment.
likewise when updating, I feel that the frontend should only send in selective fields and not the entire file content to the backend.
There was a problem hiding this comment.
Modified to receive only relevant fields
This commit limits the response being sent to the frontend to the relevant fields (title, favicon, resources_name, colors) from the config.yml file. It also modifies the code to receive these same fields and make updates to the config file as opposed to rewriting it completely. This commit also switches out the base64 library for the js-base64 library for the Settings file as we had some problems with encoding/decoding with this library in the past
|
Made changes so that only the relevant fields are transmitted - please remember to pull from the latest |
taufiq
approved these changes
Dec 18, 2019
harishv7
pushed a commit
that referenced
this pull request
Feb 17, 2023
* feat: add settings router to server file * feat: add OtherType file type to File class * feat: add GET settings route * feat: Create a separate Settings class * feat: Create a new POST method for settings route * fix: defer content decoding to frontend * refactor: remove unnecessary file type in File class * refactor: general cleanup * fix: retintroduce yaml package import * refactor: rename variables for clarity * feat: send and receive only fields that the frontend requires This commit limits the response being sent to the frontend to the relevant fields (title, favicon, resources_name, colors) from the config.yml file. It also modifies the code to receive these same fields and make updates to the config file as opposed to rewriting it completely. This commit also switches out the base64 library for the js-base64 library for the Settings file as we had some problems with encoding/decoding with this library in the past * feat: remove transmission of config sha to frontend
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.
Note
This PR is to be reviewed with PR#99 in the frontend.
Overview
This PR introduces the
settingsroute andSettingsclass which will retrieve the relevant settings information to be rendered in the frontend. The type of settings data falls into two classes:_config.yml)_data/social-media.yml)This PR resolves issue #15