feat: implement comprehensive local development environment with PR #169 website integration#188
Conversation
Add comprehensive local development environment with Flask server, CORS support, and user-friendly startup process. Complete PR #169 vision with minimal dependencies and production-ready local testing. Key additions: - deployment/local/simple_server.py: Flask server with health checks and CORS - deployment/local/start-simple.sh: Automated startup with dependency management - deployment/local/requirements-simple.txt: Minimal Flask + CORS dependencies - README.md: Updated local development instructions 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Update README.md with comprehensive local development instructions including the new Flask development server for website testing with CORS support. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Reviewer's GuideIntroduces a standalone Flask-based local development server with CORS configuration, health checks, and security measures; adds an automated startup script with minimal dependencies; integrates the sophisticated website demo assets from PR #169; and updates documentation to guide the new local development workflow. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Warning Rate limit exceeded@uelkerd has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 28 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (2)
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughIntroduces a minimal local development server setup: adds a Flask-based static file server, a startup shell script to install dependencies and launch it, a minimal requirements file, and textual updates to README. Includes health endpoint, CORS handling, index/static routes, and environment validation. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant Dev as Developer
participant Sh as start-simple.sh
participant Pip as pip
participant Py as python3
participant Srv as simple_server.py (Flask)
Dev->>Sh: Execute start-simple.sh
Sh->>Sh: Validate directory, Python, requirements file
Sh->>Pip: Install requirements (user or venv)
Sh->>Sh: Determine PORT, warn if in use
Sh->>Py: Run python3 simple_server.py --port PORT
Py->>Srv: Initialize Flask app
Srv->>Srv: validate_environment(), configure CORS
note right of Srv: Routes: /, /<file>, /health<br/>Errors: 404, 500 (JSON)
Dev-->>Srv: Access http://host:PORT/
sequenceDiagram
autonumber
participant Client
participant Flask as Flask App
participant FS as Website Directory
Client->>Flask: GET /
alt index.html exists
Flask->>FS: Read index.html
FS-->>Flask: File contents
Flask-->>Client: 200 HTML (+CORS if allowed)
else missing
Flask-->>Client: 404 JSON
end
Client->>Flask: GET /<path>
Flask->>Flask: Security check (within WEBSITE_DIR)
alt Allowed and file exists
Flask->>FS: Read file
FS-->>Flask: Contents
Flask-->>Client: 200 (+CORS if allowed)
else
Flask-->>Client: 404 JSON
end
Client->>Flask: GET /health
Flask-->>Client: 200 JSON (status, dir, mode, pages)
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary of ChangesHello @uelkerd, 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 establishes a robust local development environment for the SAMO Deep Learning project. It enables developers to easily run a local web server that hosts the project's interactive website, complete with advanced features like emotion detection and voice transcription, and seamlessly test it against live Cloud Run APIs. This setup significantly enhances the development and testing workflow by providing a self-contained, production-like environment on a local machine. Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 Limitations & Feedback Gemini Code Assist 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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
|
There was a problem hiding this comment.
Pull Request Overview
This PR implements a comprehensive local development environment that enables testing the website against production APIs. The changes combine a sophisticated website interface from PR #169 with a Flask-based local development server that handles CORS and static file serving.
- Adds Flask-based development server with CORS support for cross-origin testing
- Integrates sophisticated website files featuring DeBERTa v3 Large emotion detection
- Provides automated startup scripts and minimal dependency management for easy local development
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| deployment/local/start-simple.sh | Automated startup script with dependency management and user-friendly output |
| deployment/local/simple_server.py | Flask server with CORS, security validation, and comprehensive error handling |
| deployment/local/requirements-simple.txt | Minimal dependency specification for the local development server |
| README.md | Updated documentation with local development instructions and usage examples |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
Here's the code health analysis summary for commits Analysis Summary
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey there - I've reviewed your changes and they look great!
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location> `deployment/local/simple_server.py:78-85` </location>
<code_context>
+ file_path = WEBSITE_DIR / filename
+
+ # Security check: ensure file is within website directory
+ file_path.resolve().relative_to(WEBSITE_DIR.resolve())
+
+ if file_path.is_file():
</code_context>
<issue_to_address>
**🚨 suggestion (security):** Consider handling symlink traversal for static file serving.
Symlinks within the website directory could expose files outside the intended scope. Consider restricting symlink serving or clarifying the expected behavior.
```suggestion
# Restrict serving symlinks for security
if file_path.is_symlink():
return jsonify({
"error": "Symlinks are not allowed",
"file": filename,
"path": str(file_path)
}), 403
if file_path.is_file():
return send_file(file_path)
else:
return jsonify({
"error": "File not found",
"file": filename,
"path": str(file_path)
}), 404
```
</issue_to_address>
### Comment 2
<location> `deployment/local/start-simple.sh:54-19` </location>
<code_context>
+PORT="${PORT:-8000}"
+
+# Check if port is available
+if command -v netstat >/dev/null 2>&1; then
+ if netstat -an | grep -q ":$PORT "; then
+ echo "⚠️ Warning: Port $PORT appears to be in use"
+ echo "You can set a different port with: PORT=8001 $0"
+ fi
+fi
+
</code_context>
<issue_to_address>
**suggestion:** Port availability check may not work on all platforms.
Since netstat may not be present or consistent across all operating systems, consider adding lsof or ss as alternatives, or clarify in documentation that this check may not be universally reliable.
Suggested implementation:
```
# Check if port is available (tries netstat, lsof, or ss; may not be universally reliable)
```
```
if command -v netstat >/dev/null 2>&1; then
if netstat -an | grep -q ":$PORT "; then
echo "⚠️ Warning: Port $PORT appears to be in use"
echo "You can set a different port with: PORT=8001 $0"
fi
elif command -v lsof >/dev/null 2>&1; then
if lsof -iTCP:"$PORT" -sTCP:LISTEN -Pn | grep -q LISTEN; then
echo "⚠️ Warning: Port $PORT appears to be in use"
echo "You can set a different port with: PORT=8001 $0"
fi
elif command -v ss >/dev/null 2>&1; then
if ss -ltn | grep -q ":$PORT "; then
echo "⚠️ Warning: Port $PORT appears to be in use"
echo "You can set a different port with: PORT=8001 $0"
fi
else
echo "ℹ️ Port availability check skipped: no suitable tool (netstat, lsof, ss) found."
fi
```
</issue_to_address>
### Comment 3
<location> `deployment/local/simple_server.py:167` </location>
<code_context>
def main():
"""Main entry point."""
parser = argparse.ArgumentParser(description="SAMO Local Development Server")
parser.add_argument("--port", type=int, default=int(os.getenv("PORT", 8000)),
help="Port to run the server on (default: 8000)")
parser.add_argument("--host", default="127.0.0.1",
help="Host to bind to (default: 127.0.0.1)")
parser.add_argument("--debug", action="store_true",
help="Enable debug mode")
args = parser.parse_args()
print("🚀 SAMO Local Development Server")
print("=" * 40)
# Validate environment
if not validate_environment():
sys.exit(1)
print(f"📁 Serving files from: {WEBSITE_DIR}")
print(f"🌐 Server URL: http://{args.host}:{args.port}")
print(f"🔗 Direct links:")
print(f" • Main page: http://{args.host}:{args.port}/")
# List available HTML files
html_files = list(WEBSITE_DIR.glob("*.html"))
for html_file in html_files:
if html_file.name != "index.html":
print(f" • {html_file.stem.title()}: http://{args.host}:{args.port}/{html_file.name}")
print(f"🏥 Health check: http://{args.host}:{args.port}/health")
print("\nPress Ctrl+C to stop the server")
print("=" * 40)
try:
app.run(
host=args.host,
port=args.port,
debug=args.debug,
threaded=True
)
except KeyboardInterrupt:
print("\n👋 Server stopped by user")
except Exception as e:
print(f"❌ Server error: {e}")
sys.exit(1)
</code_context>
<issue_to_address>
**suggestion (code-quality):** Replace f-string with no interpolated values with string ([`remove-redundant-fstring`](https://docs.sourcery.ai/Reference/Default-Rules/refactorings/remove-redundant-fstring/))
```suggestion
print("🔗 Direct links:")
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive local development environment, including a lightweight Flask server, an automated startup script, and the necessary dependencies. The changes are well-implemented and significantly improve the local development workflow. The Flask server includes good security practices like CORS configuration and path traversal protection. The startup script is user-friendly, handling dependency installation and providing helpful output. I have one suggestion to simplify the file-serving logic in simple_server.py to make it more idiomatic and maintainable. Overall, this is a solid contribution.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
README.md(16 hunks)deployment/local/requirements-simple.txt(1 hunks)deployment/local/simple_server.py(1 hunks)deployment/local/start-simple.sh(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
60-60: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
68-68: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
74-74: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
82-82: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
89-89: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
270-270: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
276-276: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
283-283: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
373-373: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🪛 GitHub Check: CodeQL
deployment/local/simple_server.py
[failure] 76-76: Uncontrolled data used in path expression
This path depends on a user-provided value.
[failure] 78-78: Uncontrolled data used in path expression
This path depends on a user-provided value.
[failure] 79-79: Uncontrolled data used in path expression
This path depends on a user-provided value.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Sourcery review
- Add symlink traversal protection to static file serving - Improve port availability check for cross-platform compatibility (netstat, lsof, ss) - Remove redundant f-string formatting - Fix PORT environment variable validation to handle non-integer values gracefully Security: Prevents serving symlinks that could expose files outside website directory Reliability: Better port checking across different operating systems Code quality: Cleaner string formatting and robust error handling
- Combine serve_index and serve_file functions into single function - Use Flask's built-in send_from_directory for better security and maintainability - Leverage Flask's built-in path traversal protection - Reduce code complexity and improve readability The send_from_directory function provides the same security protections against path traversal attacks while being more idiomatic Flask code.
- Prefix unused error parameters with underscore to indicate intentional non-use - Fixes PYL-W0613 linting warnings for not_found and server_error functions - Maintains Flask error handler signature requirements while indicating unused args This follows Python best practices for unused parameters in callback functions.
- Fix FLK-E128 formatting issues in argument parser - Align help text continuation lines with proper visual indentation - Improve code readability and comply with flake8 standards This ensures consistent indentation for multi-line function arguments.
- Break long lines to comply with 88-character limit - Extract URL construction to separate variable for readability - Simplify available_files logic in 404 error handler - Improve code formatting and maintainability This ensures compliance with flake8 line length standards.
- Break long comment line to comply with 79-character docstring limit - Improve readability by splitting comment across multiple lines - Maintains same information while following style guidelines This ensures compliance with flake8 docstring formatting standards.
Summary
Complete implementation of local development environment combining:
Key Features
🚀 Local Development Server
🎨 Sophisticated Website Integration
📁 Files Added/Modified
Local Development Infrastructure:
deployment/local/simple_server.py- Flask server with CORS and securitydeployment/local/start-simple.sh- User-friendly startup automationdeployment/local/requirements-simple.txt- Minimal dependenciesREADME.md- Updated local development instructionsWebsite Files (from PR #169):
website/index.html- Sophisticated homepage with inline CSSwebsite/comprehensive-demo.html- Interactive demo with DeBERTa v3 Largewebsite/css/comprehensive-demo.css- Advanced demo stylingwebsite/js/comprehensive-demo.js- Main demo functionalitywebsite/js/config.js- Configuration managementwebsite/js/demo-initialization.js- Demo initializationwebsite/js/layout-manager.js- Layout state managementwebsite/js/voice-recorder.js- Voice recording capabilitywebsite/favicon.ico- Professional faviconUsage
Technical Implementation
Testing Completed
✅ Local server starts correctly and serves website files
✅ Health endpoint returns proper JSON response
✅ Main page loads with sophisticated dark theme design
✅ Comprehensive demo loads with DeBERTa v3 Large integration
✅ All JavaScript and CSS files load without errors
✅ Production GitHub Pages deployment remains functional
🤖 Generated with Claude Code
Summary by Sourcery
Implement a comprehensive local development environment by adding a lightweight Flask server, an automated startup script, and minimal requirements, alongside the integrated website files from PR #169 featuring interactive DeBERTa-powered demos.
New Features:
Documentation:
Summary by CodeRabbit
New Features
Documentation