[Headless SSR Proxy] Fix shape of config object #979
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
…Config.ts and changed the shape of ProxyConfig interaface. Implemented the new LayoutServiceData in the sitecore-jss-proxy/index.ts and added the type Error to replyWithError arg.
…less-ssr-experience-edge and create-sitecore-jss/node-headless-ssr-proxy templates about the use of .env files.
illiakovalenko
requested changes
Apr 13, 2022
There was a problem hiding this comment.
Looks good! See one comment below
@ambrauer Can you also look at the PR, please? You asked to add changes to the README.md, good point
| @@ -75,7 +75,7 @@ export interface ProxyConfig { | |||
| /** Responses from the proxy greater than this size (in bytes) are rejected. */ | |||
| maxResponseSizeBytes?: number; | |||
| /** The require'd server.bundle.js file from your pre-built JSS app */ | |||
| serverBundle: { | |||
| serverBundle?: { | |||
There was a problem hiding this comment.
Make it required, and fix unit tests
ambrauer
reviewed
Apr 13, 2022
| | `DEFAULT_LANGUAGE` | The JSS app's default language. Used to determine language context in case language is not specified in request URL. | | ||
| | `PORT` | Optional. Port which will be used when start sample. Default can be seen in [config.js](./config.js). | | ||
|
|
||
| These environment variables can be set in the .env file located in the root of the app. |
There was a problem hiding this comment.
Let's put this into the statement above the table (it might get lost down here). Something like:
"The following environment variables can be set to configure the proxy instead of modifying config.js. You can use the .env file located in the root of the app or set these directly in the environment (for example, in containers)."
ambrauer
reviewed
Apr 13, 2022
| @@ -45,6 +46,8 @@ The following environment variables can be set to configure the proxy instead of | |||
| | `SITECORE_PATH_REWRITE_EXCLUDE_ROUTES` | Optional. Pipe-separated list of absolute paths that should not be rendered through SSR. Defaults can be seen in [config.js](./config.js). | | |||
| | `SITECORE_ENABLE_DEBUG` | Optional. Writes verbose request info to stdout for debugging. Defaults to `false`. | | |||
|
|
|||
| These environment variables can be set in the .env file located in the root of the app. | |||
There was a problem hiding this comment.
Same here (put into statement above the table).
… we provide to test (now it's typed and has serverBundle property). Adjusted the description for environment variables
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.
Description / Motivation
Testing Details
Types of changes