Skip to content

docs: update README with Auth0 setup and error handling improvements #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
healthkowshik wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update README with Auth0 setup and error handling improvements #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,17 +144,25 @@ See [healthion-web/README.md](healthion-web/README.md) for setup instructions.

During implementation, we encountered several challenges worth documenting:

### 1. 🔑 API Key Configuration
### 1. 🔐 Auth0 Setup
**Problem:** CORS errors or "Unknown host" when clicking Sign In.

**Solution:** In Auth0 Dashboard:
1. Create a **Single Page Application** → copy Domain and Client ID
2. Add `http://localhost:5173` to **Allowed Callback URLs**, **Allowed Logout URLs**, and **Allowed Web Origins**
3. Set `VITE_AUTH0_DOMAIN` to domain only (e.g., `dev-xxx.us.auth0.com`), not a full URL

### 2. 🔑 API Key Configuration
**Problem:** 401 Unauthorized errors when creating users in Open Wearables.

**Solution:** Ensure `OPEN_WEARABLES_API_KEY` is correctly set and restart Docker containers to load new environment variables.

### 2. 🔇 Silent Error Handling
### 3. 🔇 Silent Error Handling
**Problem:** Errors from Open Wearables were being caught and silently ignored, making debugging difficult.

**Solution:** Added explicit `OpenWearablesConfigurationError` exception and improved logging. Return HTTP 503 when Open Wearables is not configured.

### 3. 👥 Duplicate Users (Race Condition)
### 4. 👥 Duplicate Users (Race Condition)
**Problem:** Multiple simultaneous requests to authenticate created duplicate users in Open Wearables (5+ accounts for the same email).

**Cause:** Each concurrent request checked if user exists, got `None`, and created a new user - all before any creation completed.
Expand Down