docs(service-bff): Bff trouble shooting guide #17178
Conversation
WalkthroughThe pull request introduces updates to the BFF (Backend for Frontend) service documentation. A new "Troubleshooting" section has been added to the Changes
Possibly related PRs
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (4)
apps/services/bff/TROUBLESHOOT_GUIDE.md (4)
1-4: Consider adding a table of contents for better navigation.For improved document navigation, especially as the guide grows, consider adding a table of contents after the title. This will help users quickly find relevant sections.
# BFF Service Troubleshooting Guide +## Table of Contents +- [Common Issues and Solutions](#common-issues-and-solutions) + - [Development Scripts](#development-scripts) + - [Setup and Dependencies](#setup-and-dependencies) + - [Redis Server](#redis-server) + - [Service Execution](#service-execution) + - [Platform-Specific Guidelines](#platform-specific-guidelines) ## Common Issues and Solutions
5-7: Improve clarity and formatting of the development script section.The instruction about script usage needs better formatting and grammar corrections.
-Make sure that you are running the `dev` script and not `start` script. For example when running the service portal you should run: - `yarn dev service-portal` and not `yarn start service-portal`. +Make sure that you are running the `dev` script and not the `start` script. For example, when running the service portal, you should run: + +```bash +yarn dev service-portal +``` + +Instead of: + +```bash +yarn start service-portal +```🧰 Tools
🪛 LanguageTool
[typographical] ~5-~5: After the expression ‘for example’ a comma is usually used.
Context: ...devscript and notstart` script. For example when running the service portal you sho...(COMMA_FOR_EXAMPLE)
15-19: Enhance Redis server section with clearer context.The Redis section needs better explanation of its purpose and proper grammar.
-Not necessary but a nice to have is to have Redis server running: +Running a Redis server is optional but recommended: + + - Redis is used for session management in the BFF service. + - To start a Redis server, run: + ```bash + yarn dev-services services-bff + ``` + - Without Redis, sessions will not persist between service restarts. - - Run `yarn dev-services services-bff` to start Redis server. - - This is necessary if you want the sessions to persist.🧰 Tools
🪛 LanguageTool
[uncategorized] ~15-~15: Possible missing comma found.
Context: ...he correct AWS account. - Not necessary but a nice to have is to have Redis server ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~15-~15: You might be missing the article “a” here.
Context: ...necessary but a nice to have is to have Redis server running: - Run `yarn dev-serv...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~17-~17: You might be missing the article “the” here.
Context: ...arn dev-services services-bff` to start Redis server. - This is necessary if you wa...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
32-37: Organize platform-specific instructions into clear sections.The platform-specific guidance needs better organization and formatting.
+## Platform-Specific Guidelines + +### Windows Users - If you are running the service on Windows, we recommend using [WSL2](https://docs.microsoft.com/en-us/windows/wsl/install) for running the services within the repo. - This is because all of the scripts generated by the `infra` package are not tested on Windows and may not work as expected. + The scripts generated by the `infra` package are not tested on Windows and may not work as expected. + +### macOS Users - On macOS, the AirPlay Receiver is listening on the same port as the Redis server, e.g. 7000. Either change the port or disable the AirPlay Receiver. + - To change Redis port: Edit the `dev-services` configuration + - To disable AirPlay: System Preferences → Sharing → Uncheck "AirPlay Receiver" + +## Last Resort +If you've tried all the above solutions without success: - If everything fails, then a good old computer restart might do the trick.🧰 Tools
🪛 LanguageTool
[style] ~33-~33: Consider removing “of” to be more concise
Context: ...ices within the repo. This is because all of the scripts generated by theinfrapackag...(ALL_OF_THE)
[style] ~33-~33: To make your text as clear as possible to all readers, do not use this foreign term. Possible alternatives are “below” or “further on” (in a document).
Context: ...use all of the scripts generated by theinfrapackage are not tested on Windows and ...(INFRA)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (2)
apps/services/bff/README.md(1 hunks)apps/services/bff/TROUBLESHOOT_GUIDE.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- apps/services/bff/README.md
🧰 Additional context used
📓 Path-based instructions (1)
apps/services/bff/TROUBLESHOOT_GUIDE.md (2)
Pattern apps/services/**/*: "Confirm that the code adheres to the following:
- NestJS architecture, including modules, services, and controllers.
- Dependency injection patterns and service encapsulation.
- Integration and unit testing coverage and practices."
Pattern apps/**/*: "Confirm that the code adheres to the following:
- NextJS best practices, including file structure, API routes, and static generation methods.
- Efficient state management and server-side rendering techniques.
- Optimal use of TypeScript for component and utility type safety."
🪛 LanguageTool
apps/services/bff/TROUBLESHOOT_GUIDE.md
[typographical] ~5-~5: After the expression ‘for example’ a comma is usually used.
Context: ...devscript and notstart` script. For example when running the service portal you sho...
(COMMA_FOR_EXAMPLE)
[grammar] ~11-~11: The word “login” is a noun. The verb is spelled with a white space.
Context: ...stall && yarn codegen`. - Make sure to login to the correct AWS account and region: ...
(NOUN_VERB_CONFUSION)
[grammar] ~13-~13: The word “login” is a noun. The verb is spelled with a white space.
Context: ...ws sso login --profile islandis-dev` to login to the correct AWS account. - Not nece...
(NOUN_VERB_CONFUSION)
[uncategorized] ~15-~15: Possible missing comma found.
Context: ...he correct AWS account. - Not necessary but a nice to have is to have Redis server ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~15-~15: You might be missing the article “a” here.
Context: ...necessary but a nice to have is to have Redis server running: - Run `yarn dev-serv...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~17-~17: You might be missing the article “the” here.
Context: ...arn dev-services services-bff` to start Redis server. - This is necessary if you wa...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~21-~21: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...lready be running a service like API. Lets take yarn dev application-system-form...
(AI_HYDRA_LEO_APOSTROPHE_S_XS)
[style] ~33-~33: Consider removing “of” to be more concise
Context: ...ices within the repo. This is because all of the scripts generated by the infra packag...
(ALL_OF_THE)
[style] ~33-~33: To make your text as clear as possible to all readers, do not use this foreign term. Possible alternatives are “below” or “further on” (in a document).
Context: ...use all of the scripts generated by the infra package are not tested on Windows and ...
(INFRA)
Datadog ReportAll test runs ✅ 98 Total Test Services: 0 Failed, 90 Passed Test ServicesThis report shows up to 10 services
🔻 Code Coverage Decreases vs Default Branch (2) |
Bff trouble shooting guide
Checklist:
Summary by CodeRabbit
New Features
Documentation