fix: create embedder nginx endpoint#86
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @NotYuSheng, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request integrates the embedder_service into the application's Nginx reverse proxy setup. The primary goal is to centralize external access to the embedder service through Nginx, aligning its deployment and routing with other existing services in the system.
Highlights
- Nginx Proxy Configuration: Configured Nginx to act as a reverse proxy for the
embedder_service, routing requests from the/embedder/path to the internal service. - Docker Compose Updates: Modified
docker-compose.ymlto remove direct external port exposure for theembedder_serviceand added it to Nginx'sdepends_onlist to ensure proper service startup order. - FastAPI Root Path Adjustment: Updated the
embedder_service's FastAPI application to use/embedderas its root path, which is necessary for correct routing when accessed via the Nginx proxy. - Environment Variable Addition: Introduced a new environment variable,
EMBEDDER_URL, innginx/example.envto specify the internal network address of the embedder service for Nginx.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request correctly configures an NGINX endpoint for the embedder_service, making it accessible through the reverse proxy. The changes in docker-compose.yml, the FastAPI application, and NGINX configuration are consistent and well-aligned. I've suggested one improvement for the NGINX configuration to include standard proxy headers, which is a best practice for providing more request context to the upstream service.
| } | ||
|
|
||
| location /embedder/ { | ||
| proxy_pass ${EMBEDDER_URL}/; |
There was a problem hiding this comment.
It's a good practice to forward headers from the proxy to the upstream service. This allows the application to have context about the original request, such as the client's IP address. This is crucial for logging, security, and general debugging.
I recommend adding standard proxy headers like X-Forwarded-For, X-Forwarded-Proto, X-Real-IP, and Host.
For consistency, you might consider applying this to the other location blocks in this file as well.
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_pass ${EMBEDDER_URL}/;
No description provided.