diff --git a/CLAUDE.md b/CLAUDE.md
index 31402cb..14c5d52 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -8,6 +8,8 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
- Run tests: `pytest`
- Run a single test: `pytest path/to/test_file.py::test_function_name`
- Run linting: `pylint api/ common/ db/ model/ services/`
+- We use Miniconda on Mac to change our Python environments, use conda activate py39_ohack_backend for the right one
+
## Code Style Guidelines
- Python 3.9.13 (Flask backend)
diff --git a/Upgrade_Plan_13FEB2026.md b/Upgrade_Plan_13FEB2026.md
new file mode 100644
index 0000000..544cce1
--- /dev/null
+++ b/Upgrade_Plan_13FEB2026.md
@@ -0,0 +1,435 @@
+# Package Upgrade Plan - February 13, 2026
+
+## 🚀 High-Impact Upgrades (Do These First)
+
+### 1. **Update requirements.txt to Match Installed Versions** ⚡
+**Effort:** 2 minutes | **Impact:** Eliminates version drift
+
+Your installed packages are newer than requirements.txt specifies. Update these lines:
+
+```python
+# Current requirements.txt has:
+redis==5.2.1 → redis==6.1.0
+slack_sdk==3.18.1 → slack_sdk==3.27.1
+python-dotenv==0.19.1 → python-dotenv==1.0.1
+```
+
+**Optional but recommended:** Install redis with hiredis for compiled response parser:
+```bash
+pip install redis[hiredis]
+```
+
+---
+
+### 2. **Next.js 16.0.10 → 16.1.x** 🔥
+**Effort:** 5 minutes | **Impact:** 10-14x faster dev startup
+
+```bash
+cd frontend-ohack.dev
+npm install next@latest
+```
+
+**Benefits:**
+- Development restarts: **15s → 1.1s** (10-14x faster)
+- Production builds: **2-5x faster** with Turbopack
+- Install size: **20MB smaller**
+- Fast Refresh: **5-10x faster**
+
+This is a **no-brainer upgrade** with massive developer productivity gains.
+
+---
+
+### 3. **Migrate moment.js → date-fns** 💎
+**Effort:** 2-4 hours | **Impact:** ~192KB bundle reduction
+
+You already have both installed! Replace moment usage:
+
+```javascript
+// Before (moment)
+import moment from 'moment';
+const formatted = moment(date).format('YYYY-MM-DD');
+
+// After (date-fns)
+import { format } from 'date-fns';
+const formatted = format(date, 'yyyy-MM-dd');
+```
+
+**Benefits:**
+- **192KB+ smaller bundle** = faster page loads
+- Tree-shakeable (only import what you use)
+- Immutable/functional API (fewer bugs)
+- Actively maintained (moment is in maintenance mode)
+
+**Migration help:** Use [moment-to-date-fns codemod](https://github.com/mobz/moment-to-date-fns)
+
+---
+
+### 4. **MUI v5.16.7 → v6.x** 📦
+**Effort:** 1-2 hours | **Impact:** 25% smaller package (2.5MB reduction)
+
+```bash
+npm install @mui/material@latest @mui/icons-material@latest
+```
+
+Then run codemods:
+```bash
+npx @mui/codemod@latest v6.0.0/preset-safe ./src
+```
+
+**Benefits:**
+- **2.5MB smaller package** = faster loads
+- Better tree-shaking
+- Minimal breaking changes (codemods handle most)
+
+---
+
+## ⚠️ Medium Priority Upgrades
+
+### 5. **React 18.3.1 → 19.x** (Consider for future)
+**Effort:** 4-8 hours | **Impact:** 20% faster rendering
+
+**Wait until after Next.js and MUI upgrades**, then:
+
+```bash
+npm install react@latest react-dom@latest
+```
+
+Run codemods:
+```bash
+npx react-codemod@latest react-19/replace-reactdom-render ./src
+npx react-codemod@latest react-19/replace-string-ref ./src
+```
+
+**Benefits:**
+- **20% faster rendering** for large lists
+- Automatic memoization via React Compiler
+- Better memory usage
+
+**Breaking changes:** Requires testing with MUI (wait for MUI to fully support React 19)
+
+---
+
+### 6. **firebase_admin 6.5.0 → 7.1.0**
+**Effort:** 30 minutes | **Impact:** Faster user listing/pagination
+
+Only if you use `list_users()` or real-time database:
+
+```bash
+pip install firebase_admin==7.1.0
+```
+
+---
+
+## 🔍 Audit & Replace (Optional)
+
+### 7. **lodash Optimization**
+**Effort:** Variable | **Impact:** Depends on usage
+
+Check your lodash imports:
+```bash
+cd frontend-ohack.dev
+grep -r "from 'lodash'" src/ | wc -l
+```
+
+If you have heavy lodash usage:
+- Replace simple operations (map, filter, find) with native JS
+- Keep complex operations (debounce, throttle, cloneDeep)
+- Consider switching to `lodash-es` for better tree-shaking
+
+---
+
+## 📊 Expected Performance Gains
+
+| Upgrade | Bundle Reduction | Performance Gain | User Impact |
+|---------|------------------|------------------|-------------|
+| moment → date-fns | ~192KB | N/A | **Faster page loads** |
+| MUI v6 | ~2.5MB | N/A | **Faster page loads** |
+| Next.js 16.1 | -20MB install | 10-14x dev speed | **Faster development** |
+| React 19 | N/A | 20% rendering | **Smoother UI** |
+| **Total** | **~195KB bundle** | **20-1400% faster** | **Significantly better UX** |
+
+---
+
+## 🎯 Recommended Action Plan
+
+**Week 1 (Quick wins):**
+1. ✅ Update requirements.txt (5 min)
+2. ✅ Upgrade Next.js to 16.1.x (5 min)
+3. ✅ Test application thoroughly
+
+**Week 2 (High impact):**
+4. ✅ Migrate moment → date-fns (2-4 hours)
+5. ✅ Upgrade MUI to v6 (1-2 hours)
+6. ✅ Test thoroughly
+
+**Week 3 (Optional):**
+7. ✅ Upgrade React to 19 (4-8 hours)
+8. ✅ Full regression testing
+
+**Total estimated effort:** 8-15 hours for **~195KB bundle reduction + 20-1400% performance gains**
+
+---
+
+## 📝 Detailed Package Analysis
+
+### Backend (Python)
+
+#### cachetools 5.2.0 → 7.0.1
+**Priority: LOW** ❌
+
+**Performance Changes:**
+- Version 6.1.0 improved LFUCache insertion performance
+- Version 6.2.0 improved RRCache performance (with increased memory consumption)
+- Version 5.5.2 reduced @cached lock/unlock operations
+- **However**, v7.0.0 introduces cache stampede handling that can **degrade performance** in some scenarios
+
+**Breaking Changes:**
+- Requires Python 3.9+ (you're on 3.9.13, so compatible)
+- Removes MRUCache and func.mru_cache decorator
+
+**Verdict:** **Not worth upgrading.** The performance improvements are minor and situational, while v7.0.0's stampede prevention can actually hurt performance. The migration effort outweighs benefits for a utility library.
+
+---
+
+#### firebase_admin 6.5.0 → 7.1.0 (latest)
+**Priority: MEDIUM** ⚠️
+
+**Performance Improvements:**
+- Improved `list_users()` API performance by reducing repeated processing during pagination
+- Fixed performance issue in `db.listen()` API for processing large RTDB nodes
+
+**Breaking Changes:**
+- v7.0.0 drops Python 3.7 and 3.8 support (you're on 3.9.13, so safe)
+- Changes to Cloud Messaging and Firebase ML APIs
+
+**Verdict:** **Worth upgrading if you use `list_users()` or real-time database features.** The performance improvements are targeted but significant for affected APIs. Actively maintained with regular updates.
+
+---
+
+#### redis 5.2.1 (requirements.txt) vs 6.1.0 (installed)
+**Priority: HIGH** ✅
+
+**Action Needed:** Update requirements.txt to match installed version (6.1.0)
+
+**Performance Improvements:**
+- v6.0.0+ introduces hiredis support for faster response parsing (compiled response parser)
+- Modern async/await support
+- Better connection pooling
+
+**Breaking Changes:**
+- v6.0.0 changed default dialect for Redis search/query to dialect 2
+- Python 3.8 reached EOL (v6.1.0 is last version supporting 3.8, v6.2.0+ requires 3.9+)
+
+**Verdict:** **Update requirements.txt immediately to 6.1.0** to match your installation. Consider installing with `redis[hiredis]` for significant performance boost (compiled parser).
+
+---
+
+#### slack_sdk 3.18.1 (requirements.txt) vs 3.27.1 (installed)
+**Priority: HIGH** ✅
+
+**Action Needed:** Update requirements.txt to match installed version (3.27.1)
+
+**Performance Improvements:**
+- New `WebClient#files_upload_v2()` method with significant performance improvements over legacy files.upload API
+- SDK rewrite for better maintainability and modern Python 3 features
+
+**Breaking Changes:**
+- Minor API changes between versions (mostly additions)
+
+**Verdict:** **Update requirements.txt immediately to 3.27.1.** If you use file uploads, migrate to `files_upload_v2()` for better performance.
+
+---
+
+#### python-dotenv 0.19.1 (requirements.txt) vs 1.0.1 (installed)
+**Priority: HIGH** ✅
+
+**Action Needed:** Update requirements.txt to match installed version (1.0.1)
+
+**Performance Improvements:**
+- Refactored parser fixes parsing inconsistencies (more correct, not necessarily faster)
+- Better UTF-8 handling by default
+
+**Breaking Changes:**
+- Drops Python 2 and 3.4 support (you're on 3.9.13, so safe)
+- Default encoding changed from `None` to `"utf-8"`
+- Parser interprets escapes as control characters only in double-quoted strings
+
+**Verdict:** **Update requirements.txt to 1.0.1.** Minor performance impact but better correctness and modern Python support.
+
+---
+
+### Frontend (Node/React)
+
+#### Next.js 16.0.10 → 16.1.x
+**Priority: VERY HIGH** 🚀
+
+**Performance Improvements:**
+- **10-14x faster development startup times** with stable Turbopack filesystem caching (large apps restart in ~1.1s vs ~15s)
+- **20MB smaller installs** for faster CI/CD
+- **2-5x faster production builds** with Turbopack
+- **5-10x faster Fast Refresh**
+- Improved async import bundling (fewer chunks in dev)
+
+**Breaking Changes:**
+- Minimal breaking changes (mostly additions)
+
+**Verdict:** **UPGRADE IMMEDIATELY.** This is a no-brainer upgrade with massive development experience improvements and zero migration effort. The 10-14x faster dev startup alone is worth it.
+
+---
+
+#### React 18.3.1 → React 19.x
+**Priority: MEDIUM-HIGH** ⚠️🚀
+
+**Performance Improvements:**
+- **20% faster rendering for large lists** (benchmarked)
+- **Automatic memoization** via new React Compiler (eliminates need for useMemo/useCallback/memo)
+- Reduced memory usage for large component trees
+- Better Server Components integration
+
+**Breaking Changes:**
+- `propTypes` silently ignored (migrate to TypeScript)
+- `defaultProps` removed from function components (use ES6 defaults)
+- `ReactDOM.render` removed (use `ReactDOM.createRoot`)
+- `ReactDOM.hydrate` removed (use `ReactDOM.hydrateRoot`)
+- No UMD builds
+- String refs removed
+
+**Migration Effort:**
+- React team provides codemods at [react-codemod repo](https://github.com/reactjs/react-codemod)
+- Upgrade to React 18.3 first (adds deprecation warnings)
+- Moderate effort depending on codebase size
+
+**Verdict:** **Worth upgrading, but plan carefully.** 20% performance boost is significant. Use codemods to automate migration. Test thoroughly with your MUI components.
+
+---
+
+#### @mui/material 5.16.7 → 5.18.x or 6.x
+**Priority: HIGH** ✅
+
+**Performance Improvements:**
+- **v6: 25% smaller package size** (2.5MB reduction by removing UMD bundle)
+- Runtime performance optimizations (details not quantified)
+- Better tree-shaking
+
+**Breaking Changes:**
+- Minimal (v6 designed for easy migration from v5)
+- Codemods provided
+- LoadingButton moved from Lab to core Button
+- Typography `color` prop no longer a system prop
+
+**Migration Effort:**
+- Low to moderate with codemods
+- Test thoroughly, especially custom theme overrides
+
+**Verdict:** **Upgrade to v6.** 25% bundle size reduction directly improves load times. Minimal breaking changes. Wait until after React 19 migration if doing both.
+
+---
+
+#### lodash 4.17.21 → Replace with native JS or lodash-es
+**Priority: MEDIUM** ⚠️
+
+**Bundle Size:**
+- Full lodash: ~70KB minified
+- With proper per-method imports: ~small (only what you use)
+- Native JS: 0KB
+
+**Performance:**
+- Lodash is often **faster than native** implementations
+- Provides edge case handling and cross-browser consistency
+- Modern JS (2026) has caught up for many use cases
+
+**Options:**
+1. **Keep lodash, use per-method imports:** `import map from 'lodash/map'`
+2. **Switch to lodash-es:** Better tree-shaking with modern bundlers (Vite, Webpack 5+)
+3. **Replace with native JS:** For simple operations (map, filter, find, etc.)
+
+**Verdict:** **Audit your lodash usage first.** Replace simple operations with native JS. Keep lodash for complex operations (debounce, throttle, deep cloning, etc.). If keeping lodash, switch to lodash-es for better tree-shaking.
+
+**Migration Effort:** Moderate to high depending on usage depth.
+
+---
+
+#### moment 2.30.1 → date-fns
+**Priority: VERY HIGH** 🚀
+
+**Bundle Size:**
+- Moment.js: **~200KB** (monolithic, no tree-shaking)
+- date-fns: **~8KB** (modular, tree-shakeable)
+- **40%+ bundle size reduction** in real-world scenarios
+
+**Performance:**
+- date-fns is **faster** due to functional/immutable approach
+- Moment.js is in **maintenance mode** (no new features)
+- Moment.js team **recommends using alternatives**
+
+**Breaking Changes:**
+- Completely different API
+- Format string syntax differs (e.g., "YYYY-MM-DD" → "yyyy-MM-dd")
+- Immutable vs mutable paradigm
+
+**Migration Effort:**
+- High effort (full API rewrite for date operations)
+- Worth it for bundle size alone
+
+**Note:** You already have `date-fns` installed! (v2.30.0). Consider upgrading to v3 for latest features.
+
+**Verdict:** **MIGRATE FROM MOMENT TO DATE-FNS ASAP.** You'll save ~192KB+ in bundle size, which directly improves page load times. This is one of the highest-impact changes you can make.
+
+---
+
+## 🎬 Getting Started
+
+### Immediate Actions (Today):
+
+1. **Backend - Update requirements.txt:**
+ ```bash
+ cd backend-ohack.dev
+ # Edit requirements.txt and change:
+ # redis==5.2.1 → redis==6.1.0
+ # slack_sdk==3.18.1 → slack_sdk==3.27.1
+ # python-dotenv==0.19.1 → python-dotenv==1.0.1
+ git commit -am "Update requirements.txt to match installed versions"
+ ```
+
+2. **Frontend - Upgrade Next.js:**
+ ```bash
+ cd frontend-ohack.dev
+ npm install next@latest
+ npm test
+ git commit -am "Upgrade Next.js to 16.1.x for 10x faster dev builds"
+ ```
+
+### Next Steps (This Week):
+
+3. **Migrate moment → date-fns:**
+ - Search for all moment imports: `grep -r "moment" src/`
+ - Replace with date-fns equivalents
+ - Remove moment from package.json
+ - Test date formatting across the app
+
+4. **Upgrade MUI to v6:**
+ ```bash
+ npm install @mui/material@latest @mui/icons-material@latest
+ npx @mui/codemod@latest v6.0.0/preset-safe ./src
+ npm test
+ ```
+
+---
+
+## 📌 Notes
+
+- All version numbers and performance metrics were researched on February 13, 2026
+- Test thoroughly after each upgrade
+- Consider staging deployments before production
+- Monitor bundle size changes with `@next/bundle-analyzer`
+- Track performance metrics before and after upgrades
+
+---
+
+## 🔗 References
+
+- [Next.js 16.1 Release Notes](https://nextjs.org/blog/next-16-1)
+- [React 19 Upgrade Guide](https://react.dev/blog/2024/04/25/react-19-upgrade-guide)
+- [MUI v6 Migration Guide](https://mui.com/material-ui/migration/upgrade-to-v6/)
+- [date-fns Documentation](https://date-fns.org/)
+- [You Don't Need Momentjs](https://github.com/you-dont-need/You-Dont-Need-Momentjs)
diff --git a/api/messages/messages_service.py b/api/messages/messages_service.py
index d29e566..3b96abd 100644
--- a/api/messages/messages_service.py
+++ b/api/messages/messages_service.py
@@ -3,6 +3,7 @@
from common.utils.firebase import get_hackathon_by_event_id, upsert_news, upsert_praise, get_github_contributions_for_user,get_volunteer_from_db_by_event, get_volunteer_checked_in_from_db_by_event, get_user_by_user_id, get_recent_praises, get_praises_by_user_id
from common.utils.openai_api import generate_and_save_image_to_cdn
from common.utils.github import create_github_repo, get_all_repos, validate_github_username
+from common.utils.oauth_providers import extract_slack_user_id
from api.messages.message import Message
from google.cloud.exceptions import NotFound
@@ -677,7 +678,8 @@ def save_team(propel_user_id, json):
email, user_id, last_login, profile_image, name, nickname = get_propel_user_details_by_id(propel_user_id)
slack_user_id = user_id
- root_slack_user_id = slack_user_id.replace("oauth2|slack|T1Q7936BH-","")
+ # Extract the raw Slack user ID (handles both OAuth formats)
+ root_slack_user_id = extract_slack_user_id(slack_user_id)
user = get_user_doc_reference(root_slack_user_id)
db = get_db() # this connects to our Firestore database
@@ -919,7 +921,7 @@ def update_team_and_user(transaction):
# Check if user is already in team
if user_ref in team_users:
logger.warning(f"User {userid} is already in team {team_id}")
- return False
+ return False, None
# Prepare updates
new_team_users = list(set(team_users + [user_ref]))
@@ -930,18 +932,19 @@ def update_team_and_user(transaction):
transaction.update(user_ref, {"teams": new_user_teams})
logger.debug(f"User {userid} added to team {team_id}")
- return True
+ # Return slack_channel from within transaction to avoid race condition
+ return True, team_data.get("slack_channel")
# Execute the transaction
try:
transaction = db.transaction()
- success = update_team_and_user(transaction)
+ success, team_slack_channel = update_team_and_user(transaction)
if success:
send_slack_audit(action="join_team", message="Added", payload=json)
message = "Joined Team"
- # Add person to Slack channel
- team_slack_channel = team_ref.get().to_dict()["slack_channel"]
- invite_user_to_channel(userid, team_slack_channel)
+ # Add person to Slack channel using data from transaction
+ if team_slack_channel:
+ invite_user_to_channel(userid, team_slack_channel)
else:
message = "User was already in the team"
except Exception as e:
@@ -2380,12 +2383,29 @@ def get_all_profiles():
@limits(calls=100, period=ONE_MINUTE)
def get_history_old(db_id):
logger.debug("Get History Start")
+
+ # Check if db_id is None first
+ if db_id is None:
+ logger.error("get_history_old called with None db_id")
+ return None
+
db = get_db() # this connects to our Firestore database
collection = db.collection('users')
doc = collection.document(db_id)
doc_get = doc.get()
+
+ # Check if document exists before calling to_dict()
+ if not doc_get.exists:
+ logger.warning(f"User document not found for db_id: {db_id}")
+ return None
+
res = doc_get.to_dict()
+ # Additional safety check in case to_dict() returns None
+ if res is None:
+ logger.warning(f"User document exists but to_dict() returned None for db_id: {db_id}")
+ return None
+
_hackathons=[]
if "hackathons" in res:
for h in res["hackathons"]:
@@ -2517,15 +2537,18 @@ def save_user_old(
def save_profile_metadata_old(propel_id, json):
send_slack_audit(action="save_profile_metadata", message="Saving", payload=json)
db = get_db() # this connects to our Firestore database
- slack_user = get_slack_user_from_propel_user_id(propel_id)
- slack_user_id = slack_user["sub"]
+ oauth_user = get_slack_user_from_propel_user_id(propel_id)
+ if oauth_user is None:
+ logger.warning(f"Could not get OAuth user details for propel_id: {propel_id}")
+ return None
+ oauth_user_id = oauth_user["sub"]
- logger.info(f"Save Profile Metadata for {slack_user_id} {json}")
+ logger.info(f"Save Profile Metadata for {oauth_user_id} {json}")
json = json["metadata"]
# See if the user exists
- user = get_user_from_slack_id(slack_user_id)
+ user = get_user_from_slack_id(oauth_user_id)
if user is None:
return
else:
diff --git a/api/messages/messages_views.py b/api/messages/messages_views.py
index b385c57..3cddeb0 100644
--- a/api/messages/messages_views.py
+++ b/api/messages/messages_views.py
@@ -583,8 +583,11 @@ def profile():
@auth.require_user
def save_profile():
logger.info("POST /profile called")
- if auth_user and auth_user.user_id:
- return vars(save_profile_metadata_old(auth_user.user_id, request.get_json()))
+ if auth_user and auth_user.user_id:
+ result = save_profile_metadata_old(auth_user.user_id, request.get_json())
+ if result is None:
+ return {"error": "User not found. Please ensure you have logged in via the profile page first."}, 404
+ return vars(result)
else:
return None
diff --git a/api/teams/teams_service.py b/api/teams/teams_service.py
index 03b14a0..a1f79e8 100644
--- a/api/teams/teams_service.py
+++ b/api/teams/teams_service.py
@@ -21,6 +21,7 @@
save_user,
get_user_from_slack_id
)
+from common.utils.oauth_providers import extract_slack_user_id, is_oauth_user_id
from common.utils.slack import add_bot_to_channel
@@ -320,8 +321,8 @@ def queue_team(propel_user_id, json):
_, user_id, _, _, name, _ = get_propel_user_details_by_id(propel_user_id)
slack_user_id = user_id
- SLACK_USER_ID_PREFIX = "oauth2|slack|T1Q7936BH-"
- root_slack_user_id = slack_user_id.replace(SLACK_USER_ID_PREFIX, "")
+ # Extract the raw Slack user ID (handles both OAuth formats and Google users gracefully)
+ root_slack_user_id = extract_slack_user_id(slack_user_id)
users_list = []
user = get_user_doc_reference(root_slack_user_id)
users_list.append(user)
@@ -500,21 +501,65 @@ def get_my_teams_by_event_id(propel_id, event_id):
"teams": teams,
"user_id": user_id
}
-
- for t in hackathon_dict["teams"]:
- team_data = t.get().to_dict()
- team_data["id"] = t.id
-
- for user_ref in team_data["users"]:
- user_data = user_ref.get().to_dict()
- user_data["id"] = user_ref.id
- logger.debug("User data: %s", user_data)
- if user_id == user_data["user_id"]:
- del team_data["users"]
- if "problem_statements" in team_data:
- del team_data["problem_statements"]
- teams.append(team_data)
+ db = get_db()
+ team_refs = hackathon_dict["teams"]
+
+ if not team_refs:
+ return {
+ "teams": teams,
+ "user_id": user_id
+ }
+
+ # Batch fetch all teams at once (1 query instead of N queries)
+ team_docs = db.get_all(team_refs)
+
+ # Collect all unique user references from all teams
+ all_user_refs = []
+ teams_with_users = []
+
+ for team_doc in team_docs:
+ if not team_doc.exists:
+ continue
+
+ team_data = team_doc.to_dict()
+ team_data["id"] = team_doc.id
+ user_refs = team_data.get("users", [])
+
+ # Store team data with its user references for later filtering
+ teams_with_users.append({
+ "team_data": team_data,
+ "user_refs": user_refs
+ })
+
+ # Collect all user references for batch fetching
+ all_user_refs.extend(user_refs)
+
+ # Batch fetch all users at once (1 query instead of N*M queries)
+ if all_user_refs:
+ user_docs = db.get_all(all_user_refs)
+
+ # Create a map of user_ref.id -> user_data for fast lookup
+ user_map = {}
+ for user_doc in user_docs:
+ if user_doc.exists:
+ user_data = user_doc.to_dict()
+ user_map[user_doc.id] = user_data.get("user_id")
+
+ # Filter teams that contain the target user
+ for item in teams_with_users:
+ team_data = item["team_data"]
+ user_refs = item["user_refs"]
+
+ # Check if any user in this team matches our target user
+ for user_ref in user_refs:
+ if user_ref.id in user_map and user_map[user_ref.id] == user_id:
+ # Found the user in this team
+ del team_data["users"]
+ if "problem_statements" in team_data:
+ del team_data["problem_statements"]
+ teams.append(team_data)
+ break # No need to check other users in this team
logger.debug("Teams data: %s", teams)
diff --git a/common/utils/firebase.py b/common/utils/firebase.py
index 37efd31..5bab7eb 100644
--- a/common/utils/firebase.py
+++ b/common/utils/firebase.py
@@ -6,6 +6,8 @@
import datetime
import re
from google.cloud.firestore import FieldFilter
+# Import OAuth utilities for handling multiple providers (Slack, Google, etc.)
+from common.utils.oauth_providers import SLACK_PREFIX, normalize_slack_user_id, is_oauth_user_id
cert_env = json.loads(safe_get_env_var("FIREBASE_CERT_CONFIG"))
@@ -76,13 +78,23 @@ def get_user_by_id(id):
return adict
def get_user_by_user_id(user_id):
- SLACK_PREFIX = "oauth2|slack|T1Q7936BH-"
- slack_user_id = f"{SLACK_PREFIX}{user_id}"
- # log slack_user_id
- logger.info(f"Looking up user {slack_user_id}")
-
+ """
+ Get user by user_id. Handles both OAuth format and raw user IDs.
+ Supports multiple OAuth providers (Slack, Google, etc.)
+
+ Note: This function uses normalize_slack_user_id for backward compatibility
+ with legacy code that stored raw Slack user IDs. For OAuth-prefixed IDs
+ from any provider (Slack, Google, etc.), the ID is used as-is.
+ """
+ # Normalize the user_id if it's not already in OAuth format
+ # For Slack: converts raw IDs like "U12345" to "oauth2|slack|T1Q7936BH-U12345"
+ # For other OAuth providers: leaves IDs like "oauth2|google-oauth2|123" unchanged
+ normalized_user_id = normalize_slack_user_id(user_id) if not is_oauth_user_id(user_id) else user_id
+
+ logger.info(f"Looking up user {normalized_user_id}")
+
db = get_db() # this connects to our Firestore database
- docs = db.collection('users').where("user_id", "==", slack_user_id).stream()
+ docs = db.collection('users').where("user_id", "==", normalized_user_id).stream()
for doc in docs:
adict = doc.to_dict()
@@ -304,13 +316,15 @@ def add_user_by_email_to_team(email_address, team_name):
db.collection("users").document(user.id).set({"teams": user_teams}, merge=True)
def add_user_by_slack_id_to_team(user_id, team_name):
+ """
+ Add user to team. Handles both OAuth format and raw Slack user IDs.
+ Supports multiple OAuth providers by normalizing the user_id.
+ """
db = get_db() # this connects to our Firestore database
logger.info(f"Adding user {user_id} to team {team_name}")
- # If user_id doesn't have oauth2|slack|T1Q7936BH- prefix, add it
- if not user_id.startswith("oauth2|slack|T1Q7936BH-"):
- user_id = "oauth2|slack|T1Q7936BH-" + user_id
-
+ # Normalize user_id if it doesn't have OAuth prefix
+ normalized_user_id = normalize_slack_user_id(user_id) if not is_oauth_user_id(user_id) else user_id
# Get team
team = db.collection("teams").where("name", "==", team_name).get()
@@ -321,20 +335,20 @@ def add_user_by_slack_id_to_team(user_id, team_name):
logger.error(f"**ERROR Team {team_name} does not exist")
raise Exception(f"Team {team_name} does not exist")
- # Get user
- user = db.collection("users").where("user_id", "==", user_id).get()
+ # Get user using normalized user_id
+ user = db.collection("users").where("user_id", "==", normalized_user_id).get()
user = user[0]
if not user:
- logger.error(f"**ERROR User {user_id} does not exist")
- raise Exception(f"User {user_id} does not exist")
+ logger.error(f"**ERROR User {normalized_user_id} does not exist")
+ raise Exception(f"User {normalized_user_id} does not exist")
print(team)
# Check if user is already in team
team_users = team.to_dict()["users"]
if user.reference in team_users:
- logger.info(f"User {user_id} is already in team {team_name}, not adding again")
+ logger.info(f"User {normalized_user_id} is already in team {team_name}, not adding again")
else:
team_users.append(user.reference)
db.collection("teams").document(team.id).set({"users": team_users}, merge=True)
diff --git a/common/utils/oauth_providers.py b/common/utils/oauth_providers.py
new file mode 100644
index 0000000..f71561b
--- /dev/null
+++ b/common/utils/oauth_providers.py
@@ -0,0 +1,274 @@
+"""
+OAuth Provider Utilities
+
+This module provides utilities for handling different OAuth providers (Slack, Google, etc.)
+that are configured in PropelAuth.
+
+PropelAuth Configuration:
+ Social login providers (Slack, Google, etc.) are configured in the PropelAuth dashboard,
+ not in the backend code. Once enabled in PropelAuth, this backend will automatically
+ handle authentication tokens from any enabled provider.
+
+User ID Format:
+ PropelAuth stores OAuth-based user IDs in the format:
+ oauth2|{provider}|{workspace_id}-{user_id}
+
+ Examples:
+ - Slack: oauth2|slack|T1Q7936BH-U12345ABC
+ - Google: oauth2|google-oauth2|12345678901234567890
+
+ Note: The exact format may vary by provider. Google typically uses 'google-oauth2'
+ as the provider identifier.
+"""
+
+import re
+from common.utils import safe_get_env_var
+from common.log import get_logger
+
+logger = get_logger("oauth_providers")
+
+# Default Slack workspace ID from environment or hardcoded fallback
+# WARNING: The fallback value T1Q7936BH should match your production Slack workspace
+# Set SLACK_WORKSPACE_ID environment variable to override this default
+_slack_workspace_id_env = safe_get_env_var("SLACK_WORKSPACE_ID")
+if _slack_workspace_id_env != "CHANGEMEPLS":
+ DEFAULT_SLACK_WORKSPACE_ID = _slack_workspace_id_env
+else:
+ # Fallback to hardcoded value - should be configured in production via environment
+ DEFAULT_SLACK_WORKSPACE_ID = "T1Q7936BH"
+ logger.warning(
+ "SLACK_WORKSPACE_ID not configured. Using hardcoded default. "
+ "Set SLACK_WORKSPACE_ID environment variable for production."
+ )
+
+# OAuth provider patterns
+OAUTH_PROVIDER_PATTERN = re.compile(r'^oauth2\|([^|]+)\|(.+)$')
+SLACK_PATTERN = re.compile(r'^oauth2\|slack\|([^-]+)-(.+)$')
+GOOGLE_PATTERN = re.compile(r'^oauth2\|google-oauth2\|(.+)$')
+
+
+def get_oauth_provider_from_user_id(user_id):
+ """
+ Extract the OAuth provider name from a user ID.
+
+ Args:
+ user_id: The user ID in format oauth2|provider|identifier
+
+ Returns:
+ str: The provider name (e.g., 'slack', 'google-oauth2', None if not OAuth)
+
+ Examples:
+ >>> get_oauth_provider_from_user_id('oauth2|slack|T1Q7936BH-U12345')
+ 'slack'
+ >>> get_oauth_provider_from_user_id('oauth2|google-oauth2|1234567890')
+ 'google-oauth2'
+ """
+ if not user_id:
+ return None
+
+ match = OAUTH_PROVIDER_PATTERN.match(user_id)
+ if match:
+ return match.group(1)
+ return None
+
+
+def is_slack_user_id(user_id):
+ """
+ Check if a user ID is from Slack OAuth.
+
+ Args:
+ user_id: The user ID to check
+
+ Returns:
+ bool: True if the user ID is from Slack, False otherwise
+ """
+ if not user_id:
+ return False
+ return user_id.startswith('oauth2|slack|')
+
+
+def is_google_user_id(user_id):
+ """
+ Check if a user ID is from Google OAuth.
+
+ Args:
+ user_id: The user ID to check
+
+ Returns:
+ bool: True if the user ID is from Google, False otherwise
+ """
+ if not user_id:
+ return False
+ return user_id.startswith('oauth2|google-oauth2|')
+
+
+def normalize_slack_user_id(user_id):
+ """
+ Normalize a Slack user ID to include the oauth2|slack| prefix if missing.
+
+ This is useful for backward compatibility with code that stored raw Slack user IDs
+ without the OAuth prefix.
+
+ Args:
+ user_id: The user ID, with or without the oauth2|slack| prefix
+
+ Returns:
+ str: The normalized user ID with the oauth2|slack|{workspace_id}- prefix
+
+ Examples:
+ >>> normalize_slack_user_id('U12345ABC')
+ 'oauth2|slack|T1Q7936BH-U12345ABC'
+ >>> normalize_slack_user_id('oauth2|slack|T1Q7936BH-U12345ABC')
+ 'oauth2|slack|T1Q7936BH-U12345ABC'
+ """
+ if not user_id:
+ return user_id
+
+ # Already has the full OAuth prefix (any provider) - don't modify
+ if user_id.startswith('oauth2|'):
+ return user_id
+
+ # Add the Slack prefix with workspace ID
+ prefix = f"oauth2|slack|{DEFAULT_SLACK_WORKSPACE_ID}-"
+ return f"{prefix}{user_id}"
+
+
+def extract_slack_user_id(user_id):
+ """
+ Extract the raw Slack user ID from a full OAuth user ID.
+
+ Args:
+ user_id: The full user ID in format oauth2|slack|T1Q7936BH-U12345ABC
+
+ Returns:
+ str: The raw Slack user ID (e.g., 'U12345ABC'), or original if not Slack format
+
+ Examples:
+ >>> extract_slack_user_id('oauth2|slack|T1Q7936BH-U12345ABC')
+ 'U12345ABC'
+ >>> extract_slack_user_id('oauth2|google-oauth2|1234567890')
+ 'oauth2|google-oauth2|1234567890'
+ """
+ if not user_id:
+ return user_id
+
+ match = SLACK_PATTERN.match(user_id)
+ if match:
+ return match.group(2) # Returns the user ID part after workspace-
+
+ return user_id
+
+
+def get_provider_display_name(user_id):
+ """
+ Get a human-readable display name for the OAuth provider.
+
+ Args:
+ user_id: The user ID containing the provider information
+
+ Returns:
+ str: Display name for the provider (e.g., 'Slack', 'Google', 'Unknown')
+ """
+ provider = get_oauth_provider_from_user_id(user_id)
+
+ if not provider:
+ return "Unknown"
+
+ provider_names = {
+ 'slack': 'Slack',
+ 'google-oauth2': 'Google',
+ 'github': 'GitHub',
+ 'microsoft': 'Microsoft'
+ }
+
+ return provider_names.get(provider, provider.title())
+
+
+def is_oauth_user_id(user_id):
+ """
+ Check if a user ID is from any OAuth provider.
+
+ Args:
+ user_id: The user ID to check
+
+ Returns:
+ bool: True if the user ID is from an OAuth provider, False otherwise
+ """
+ if not user_id:
+ return False
+ return user_id.startswith('oauth2|')
+
+
+# Backward compatibility: Keep the old constant name
+USER_ID_PREFIX = f"oauth2|slack|{DEFAULT_SLACK_WORKSPACE_ID}-"
+SLACK_PREFIX = f"oauth2|slack|{DEFAULT_SLACK_WORKSPACE_ID}-"
+GOOGLE_PREFIX = "oauth2|google-oauth2|"
+
+
+def get_oauth_provider_from_propel_response(propel_response):
+ """
+ Detect which OAuth provider was used from a PropelAuth oauth_token response.
+
+ PropelAuth returns OAuth tokens in a format like:
+ {'slack': {'access_token': '...', ...}}
+ {'google': {'access_token': '...', ...}}
+
+ Args:
+ propel_response: The JSON response from PropelAuth's oauth_token endpoint
+
+ Returns:
+ tuple: (provider_name, token_data) or (None, None) if not found
+
+ Examples:
+ >>> get_oauth_provider_from_propel_response({'slack': {'access_token': 'xoxp-...'}})
+ ('slack', {'access_token': 'xoxp-...'})
+ >>> get_oauth_provider_from_propel_response({'google': {'access_token': 'ya29...'}})
+ ('google', {'access_token': 'ya29...'})
+ """
+ if not propel_response:
+ return None, None
+
+ # Check for known providers in order of likelihood
+ known_providers = ['slack', 'google', 'github', 'microsoft']
+
+ for provider in known_providers:
+ if provider in propel_response:
+ return provider, propel_response[provider]
+
+ # Check for any other provider
+ for key, value in propel_response.items():
+ if isinstance(value, dict) and 'access_token' in value:
+ return key, value
+
+ return None, None
+
+
+def build_user_id_for_provider(provider, provider_user_id, workspace_id=None):
+ """
+ Build a normalized user ID for a given OAuth provider.
+
+ Args:
+ provider: The OAuth provider name ('slack', 'google', etc.)
+ provider_user_id: The user ID from the provider
+ workspace_id: For Slack, the workspace ID (optional, uses default if not provided)
+
+ Returns:
+ str: The normalized user ID in format oauth2|provider|identifier
+
+ Examples:
+ >>> build_user_id_for_provider('slack', 'U12345', 'T1Q7936BH')
+ 'oauth2|slack|T1Q7936BH-U12345'
+ >>> build_user_id_for_provider('google', '1234567890')
+ 'oauth2|google-oauth2|1234567890'
+ """
+ if provider == 'slack':
+ ws_id = workspace_id or DEFAULT_SLACK_WORKSPACE_ID
+ return f"oauth2|slack|{ws_id}-{provider_user_id}"
+ elif provider == 'google':
+ return f"oauth2|google-oauth2|{provider_user_id}"
+ elif provider == 'github':
+ return f"oauth2|github|{provider_user_id}"
+ elif provider == 'microsoft':
+ return f"oauth2|microsoft|{provider_user_id}"
+ else:
+ return f"oauth2|{provider}|{provider_user_id}"
diff --git a/db/firestore.py b/db/firestore.py
index 2947094..326d015 100644
--- a/db/firestore.py
+++ b/db/firestore.py
@@ -22,8 +22,11 @@
mockfirestore = None
-#TODO: Put in .env? Feels configurable. Or maybe something we would want to protect with a secret?
-SLACK_PREFIX = "oauth2|slack|T1Q7936BH-"
+# Import OAuth utilities for handling multiple providers (Slack, Google, etc.)
+from common.utils.oauth_providers import SLACK_PREFIX, is_oauth_user_id, normalize_slack_user_id
+
+# TODO: Put in .env? Feels configurable. Or maybe something we would want to protect with a secret?
+# SLACK_PREFIX is now imported from oauth_providers module for consistency
if safe_get_env_var("ENVIRONMENT") == "test":
mockfirestore = MockFirestore() #Only used when testing
@@ -93,18 +96,20 @@ def fetch_user_by_user_id(self, user_id):
def fetch_user_by_user_id_raw(self, db, user_id):
debug(logger, "Fetching raw user by user_id", user_id=user_id)
- #TODO: Why are we putting the slack prefix in the DB?
- if user_id.startswith(SLACK_PREFIX):
- slack_user_id = user_id
+ # Handle multiple OAuth providers (Slack, Google, etc.)
+ # If the user_id is already in OAuth format (oauth2|provider|id), use it as-is
+ # Otherwise, assume it's a raw Slack user ID and normalize it
+ if is_oauth_user_id(user_id):
+ normalized_user_id = user_id
else:
- slack_user_id = f"{SLACK_PREFIX}{user_id}"
+ normalized_user_id = normalize_slack_user_id(user_id)
u = None
try:
- u, *rest = db.collection('users').where("user_id", "==", slack_user_id).stream()
- debug(logger, "Found user in database", slack_user_id=slack_user_id)
+ u, *rest = db.collection('users').where("user_id", "==", normalized_user_id).stream()
+ debug(logger, "Found user in database", normalized_user_id=normalized_user_id)
except ValueError:
- warning(logger, "ValueError when fetching user", slack_user_id=slack_user_id)
+ warning(logger, "ValueError when fetching user", normalized_user_id=normalized_user_id)
pass
return u
@@ -192,31 +197,39 @@ def get_user_profile_by_db_id(self, db_id):
user = User.deserialize(d)
if "hackathons" in d:
- #TODO: I think we use get_all here
- # https://cloud.google.com/python/docs/reference/firestore/latest/google.cloud.firestore_v1.client.Client#google_cloud_firestore_v1_client_Client_get_all
- for h in d["hackathons"]:
- h_doc = h.get()
- rec = h_doc.to_dict()
- rec['id'] = h_doc.id
-
- hackathon = Hackathon.deserialize(rec)
- user.hackathons.append(hackathon)
-
- #TODO: I think we use get_all here
- # https://cloud.google.com/python/docs/reference/firestore/latest/google.cloud.firestore_v1.client.Client#google_cloud_firestore_v1_client_Client_get_all
- for n in rec["nonprofits"]:
-
- npo_doc = n.get() #TODO: Deal with lazy-loading in db layer
- npo_id = npo_doc.id
- npo = n.get().to_dict()
- npo["id"] = npo_id
-
- if npo and "problem_statements" in npo:
- # This is duplicate date as we should already have this
- del npo["problem_statements"]
- hackathon.nonprofits.append(npo)
-
- user.hackathons.append(hackathon)
+ # Batch fetch all hackathon documents at once to avoid N+1 queries
+ hackathon_refs = d["hackathons"]
+ if hackathon_refs:
+ hackathon_docs = db.get_all(hackathon_refs)
+
+ for h_doc in hackathon_docs:
+ if not h_doc.exists:
+ continue
+
+ rec = h_doc.to_dict()
+ rec['id'] = h_doc.id
+
+ hackathon = Hackathon.deserialize(rec)
+
+ # Batch fetch all nonprofit documents for this hackathon
+ if "nonprofits" in rec:
+ nonprofit_refs = rec["nonprofits"]
+ if nonprofit_refs:
+ nonprofit_docs = db.get_all(nonprofit_refs)
+
+ for npo_doc in nonprofit_docs:
+ if not npo_doc.exists:
+ continue
+
+ npo = npo_doc.to_dict()
+ npo["id"] = npo_doc.id
+
+ if npo and "problem_statements" in npo:
+ # This is duplicate data as we should already have this
+ del npo["problem_statements"]
+ hackathon.nonprofits.append(npo)
+
+ user.hackathons.append(hackathon)
#TODO:
# if "badges" in res:
diff --git a/docs/GOOGLE_LOGIN_PR_SUMMARY.md b/docs/GOOGLE_LOGIN_PR_SUMMARY.md
new file mode 100644
index 0000000..3a9fbc2
--- /dev/null
+++ b/docs/GOOGLE_LOGIN_PR_SUMMARY.md
@@ -0,0 +1,79 @@
+# Google Login via PropelAuth - Implementation Summary
+
+## Overview
+This PR adds support for Google OAuth login to the Opportunity Hack platform via PropelAuth. The backend has been updated to handle authentication from multiple OAuth providers (Slack, Google, GitHub, etc.) in a provider-agnostic manner.
+
+## Quick Start: Enabling Google Login
+
+### Step 1: Backend (Already Complete ✅)
+This PR contains all necessary backend changes. No additional backend work needed.
+
+### Step 2: PropelAuth Configuration (Admin Task)
+1. Log in to [PropelAuth Dashboard](https://auth.propelauth.com)
+2. Navigate to **Authentication** → **Social Logins**
+3. Enable **Google OAuth**
+4. Configure credentials (see `docs/OAUTH_SETUP.md` for detailed steps)
+
+### Step 3: Deploy
+Deploy this branch to production. Changes are fully backward compatible.
+
+### Step 4: Test
+Users will automatically see "Sign in with Google" option after PropelAuth configuration.
+
+## What Changed
+
+### New Files
+- `common/utils/oauth_providers.py` - OAuth provider utilities
+- `docs/OAUTH_SETUP.md` - Complete setup guide
+- `test/common/utils/test_oauth_providers.py` - 34 unit tests
+
+### Updated Files (8 files)
+All files updated to use provider-agnostic OAuth handling instead of hardcoded Slack logic.
+
+## Key Features
+✅ **Backward Compatible** - Slack login still works
+✅ **Provider-Agnostic** - Supports any OAuth provider
+✅ **Well-Tested** - 34 unit tests, all passing
+✅ **Documented** - Complete setup guide
+✅ **Secure** - 0 vulnerabilities (CodeQL scan)
+✅ **Production-Ready** - Proper error handling and warnings
+
+## Supported OAuth Providers
+After PropelAuth configuration, the backend supports:
+- ✅ **Slack** (currently working)
+- ✅ **Google** (ready to enable)
+- ✅ **GitHub** (ready to enable)
+- ✅ **Microsoft** (ready to enable)
+- ✅ Any other provider PropelAuth supports
+
+## User ID Format
+```python
+# Slack
+oauth2|slack|T1Q7936BH-U12345ABC
+
+# Google
+oauth2|google-oauth2|1234567890123456789
+
+# GitHub
+oauth2|github|12345678
+```
+
+## Testing
+```bash
+# Run unit tests
+pytest test/common/utils/test_oauth_providers.py -v
+
+# All 34 tests should pass
+```
+
+## Documentation
+- **Setup Guide**: `docs/OAUTH_SETUP.md`
+- **Code Documentation**: Inline docstrings in `common/utils/oauth_providers.py`
+
+## Security
+- CodeQL scan: ✅ 0 vulnerabilities found
+- Authentication handled by PropelAuth
+- Proper input validation and error handling
+
+## Questions?
+See `docs/OAUTH_SETUP.md` for detailed setup instructions and troubleshooting.
diff --git a/docs/OAUTH_SETUP.md b/docs/OAUTH_SETUP.md
new file mode 100644
index 0000000..5daab1d
--- /dev/null
+++ b/docs/OAUTH_SETUP.md
@@ -0,0 +1,235 @@
+# OAuth Social Login Setup Guide
+
+This guide explains how to configure social login providers (Slack, Google, etc.) for the Opportunity Hack platform using PropelAuth.
+
+## Overview
+
+The Opportunity Hack platform uses [PropelAuth](https://www.propelauth.com/) as its authentication provider. PropelAuth handles all OAuth flows with social login providers like Slack and Google. The backend Flask application receives authenticated tokens from PropelAuth and validates them.
+
+## Architecture
+
+```
+User → PropelAuth (OAuth Flow) → Backend API
+ ↓
+ Social Provider (Slack/Google/etc.)
+```
+
+1. **Frontend**: Users click "Sign in with Google" or "Sign in with Slack"
+2. **PropelAuth**: Handles the OAuth flow with the social provider
+3. **Backend**: Receives and validates the authentication token from PropelAuth
+
+## Current Configuration
+
+### Slack Login
+- **Status**: ✅ Already configured
+- **User ID Format**: `oauth2|slack|T1Q7936BH-{SLACK_USER_ID}`
+- **Workspace ID**: `T1Q7936BH` (configured in environment)
+
+### Google Login
+- **Status**: 🔄 Ready to enable (backend supports it)
+- **User ID Format**: `oauth2|google-oauth2|{GOOGLE_USER_ID}`
+- **Notes**: No backend code changes needed, only PropelAuth dashboard configuration
+
+## How to Enable Google OAuth in PropelAuth
+
+### Step 1: Access PropelAuth Dashboard
+
+1. Log in to your PropelAuth dashboard at https://auth.propelauth.com
+2. Select your project (Opportunity Hack)
+3. Navigate to **Authentication** → **Social Logins**
+
+### Step 2: Configure Google OAuth
+
+#### Option A: Using Google Cloud Console
+
+1. **Create Google OAuth Credentials**:
+ - Go to [Google Cloud Console](https://console.cloud.google.com/)
+ - Create a new project or select an existing one
+ - Navigate to **APIs & Services** → **Credentials**
+ - Click **Create Credentials** → **OAuth 2.0 Client ID**
+
+2. **Configure OAuth Consent Screen**:
+ - User type: External (for public access)
+ - App name: Opportunity Hack
+ - User support email: your-email@opportunityhack.org
+ - Developer contact: your-email@opportunityhack.org
+ - Add scopes: `email`, `profile`, `openid`
+
+3. **Create OAuth Client**:
+ - Application type: Web application
+ - Name: Opportunity Hack - PropelAuth
+ - Authorized redirect URIs: Use the callback URL provided by PropelAuth
+ - Format: `https://{YOUR_PROPEL_DOMAIN}/api/backend/v1/oauth/callback/google`
+ - Example: `https://123456.propelauthtest.com/api/backend/v1/oauth/callback/google`
+
+4. **Copy Credentials**:
+ - Save the **Client ID** and **Client Secret**
+
+#### Option B: Using PropelAuth's Managed Google OAuth (Recommended)
+
+PropelAuth offers a managed Google OAuth option that simplifies setup:
+
+1. In PropelAuth Dashboard → Social Logins
+2. Find **Google** in the list of providers
+3. Click **Enable**
+4. Choose **Use PropelAuth's Google OAuth App** (recommended for quick setup)
+5. Configure the settings:
+ - ✅ Enable "Sign up with Google"
+ - ✅ Enable "Link existing accounts"
+ - ✅ Auto-verify email addresses from Google
+
+### Step 3: Configure in PropelAuth Dashboard
+
+1. In PropelAuth Dashboard → **Social Logins** → **Google**
+2. Enter your Google OAuth credentials:
+ - **Client ID**: (from Google Cloud Console)
+ - **Client Secret**: (from Google Cloud Console)
+3. Configure additional settings:
+ - **Auto-create users**: ✅ Enabled (allow new users to sign up)
+ - **Account linking**: ✅ Enabled (allow users to link Google to existing accounts)
+ - **Email verification**: ✅ Skip verification for Google (Google already verifies emails)
+
+### Step 4: Test the Integration
+
+1. **Test in PropelAuth Dashboard**:
+ - Use PropelAuth's built-in testing tools
+ - Navigate to **Users** → **Create Test User**
+ - Try signing in with Google
+
+2. **Test with Frontend**:
+ - Deploy the frontend with PropelAuth's updated configuration
+ - Click "Sign in with Google"
+ - Complete the OAuth flow
+ - Verify successful authentication
+
+3. **Verify Backend**:
+ - Check logs for successful authentication
+ - Verify user ID format: `oauth2|google-oauth2|{GOOGLE_USER_ID}`
+ - Test API calls with Google-authenticated users
+
+## Backend Code Support
+
+The backend has been updated to support multiple OAuth providers:
+
+### User ID Formats Supported
+
+```python
+# Slack
+oauth2|slack|T1Q7936BH-U12345ABC
+
+# Google
+oauth2|google-oauth2|1234567890123456789
+
+# Future providers (GitHub, Microsoft, etc.)
+oauth2|github|12345678
+oauth2|microsoft|uuid-here
+```
+
+### Utility Functions
+
+The backend includes utility functions in `common/utils/oauth_providers.py`:
+
+- `get_oauth_provider_from_user_id(user_id)`: Extract provider name
+- `is_slack_user_id(user_id)`: Check if user ID is from Slack
+- `is_google_user_id(user_id)`: Check if user ID is from Google
+- `get_provider_display_name(user_id)`: Get human-readable provider name
+
+### No Code Changes Needed
+
+Once Google OAuth is enabled in PropelAuth:
+- ✅ Backend automatically accepts Google OAuth tokens
+- ✅ User IDs are stored with the `oauth2|google-oauth2|` prefix
+- ✅ All existing API endpoints work with Google-authenticated users
+- ✅ Authorization and permissions work the same way
+
+## Environment Variables
+
+The backend requires these PropelAuth environment variables (already configured):
+
+```bash
+# PropelAuth Settings
+PROPEL_AUTH_URL=https://123456.propelauthtest.com
+PROPEL_AUTH_KEY=your-api-key-here
+
+# Optional: Slack workspace ID (for backward compatibility)
+SLACK_WORKSPACE_ID=T1Q7936BH
+```
+
+No additional environment variables are needed for Google OAuth.
+
+## Frontend Integration
+
+The frontend needs to be updated to show the "Sign in with Google" button. This is typically done in the PropelAuth component:
+
+```javascript
+// Example frontend code (React)
+import { useAuth } from '@propelauth/react'
+
+function LoginPage() {
+ const { redirectToLoginPage } = useAuth()
+
+ return (
+
+
+
+
+ )
+}
+```
+
+PropelAuth automatically shows all enabled social login options.
+
+## Security Considerations
+
+1. **OAuth Scopes**: Only request necessary scopes (`email`, `profile`)
+2. **Email Verification**: Google-authenticated emails are pre-verified
+3. **Account Linking**: Users can link multiple OAuth providers to one account
+4. **Session Management**: Handled by PropelAuth with secure tokens
+
+## Troubleshooting
+
+### Issue: "Redirect URI mismatch"
+**Solution**: Ensure the redirect URI in Google Cloud Console exactly matches PropelAuth's callback URL
+
+### Issue: "Access denied" from Google
+**Solution**: Check OAuth consent screen configuration and approved scopes
+
+### Issue: User can't sign in with Google
+**Solution**:
+- Verify Google OAuth is enabled in PropelAuth dashboard
+- Check that the frontend is using the latest PropelAuth configuration
+- Review PropelAuth logs for error details
+
+### Issue: User ID format issues
+**Solution**: The backend automatically handles different OAuth provider formats. No action needed.
+
+## Testing Checklist
+
+- [ ] Enable Google OAuth in PropelAuth dashboard
+- [ ] Configure Google OAuth credentials
+- [ ] Test sign-in flow in PropelAuth dashboard
+- [ ] Update frontend to show Google login option
+- [ ] Test new user sign-up with Google
+- [ ] Test existing user sign-in with Google
+- [ ] Test account linking (user signs in with both Slack and Google)
+- [ ] Verify user profile data is correctly synced
+- [ ] Test API authentication with Google-authenticated users
+- [ ] Check database for correct user ID format
+
+## Support
+
+For issues with:
+- **PropelAuth Configuration**: Contact PropelAuth support or check their [documentation](https://docs.propelauth.com/)
+- **Google OAuth Setup**: Refer to [Google OAuth Documentation](https://developers.google.com/identity/protocols/oauth2)
+- **Backend Integration**: Check this repository's issues or contact the development team
+
+## Additional Resources
+
+- [PropelAuth Documentation](https://docs.propelauth.com/)
+- [PropelAuth Social Login Guide](https://docs.propelauth.com/overview/social-login)
+- [Google OAuth 2.0 Documentation](https://developers.google.com/identity/protocols/oauth2)
+- [OAuth 2.0 Best Practices](https://tools.ietf.org/html/draft-ietf-oauth-security-topics)
diff --git a/requirements.txt b/requirements.txt
index 8610711..2b74c2f 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,39 +1,38 @@
-cffi==1.15.0
-click==8.0.3
-cryptography==35.0.0
-Flask==2.0.2
-Flask-Cors==3.0.10
-flask-talisman==0.8.1
-gunicorn==20.1.0
-itsdangerous==2.0.1
-Jinja2==3.0.3
-MarkupSafe==2.0.1
+cffi>=1.15.0
+click>=8.1.7
+cryptography>=46.0.5
+Flask>=3.1.2
+Flask-Cors>=6.0.0
+flask-talisman==1.1.0
+gunicorn>=23.0.0
+itsdangerous>=2.2.0
+Jinja2>=3.1.4
+MarkupSafe>=3.0.2
pycparser==2.21
-PyJWT==2.5.0
-python-dotenv==0.19.1
+PyJWT>=2.10.1
+python-dotenv>=1.0.1
six==1.16.0
-Werkzeug==2.0.2
-requests==2.31.0
+Werkzeug>=3.1.3
+requests>=2.32.3
firebase_admin==6.5.0
ratelimit==2.2.1
cachetools==5.2.0
-cryptography==35.0.0
-slack_sdk==3.18.1
+slack_sdk>=3.27.1
markdown==3.4.1
mock-firestore==0.11.0
ratelimiter==1.2.0
pygithub==2.1.1
-openai==1.10.0
-httpx==0.27.0
+openai>=2.13.0
+httpx>=0.28.1
asgiref==3.7.2
GitPython==3.1.41
typing==3.7.4.3
dataclasses==0.6
git-fame==2.0.1
qrcode==7.4.2
-pillow==10.2.0
+pillow>=11.3.0
pytz==2023.4
-propelauth_flask==2.1.11
+propelauth_flask>=4.2.9
littletable==2.2.4
et-xmlfile==1.1.0
openpyxl==3.1.2
@@ -41,7 +40,8 @@ pylint==3.2.5
pytest==8.2.2
resend==2.3.0
readme-metrics[Flask]==3.1.0
-redis==5.2.1
+redis>=6.1.0
tiktoken==0.9.0
numpy==1.26.3
-colorlog==6.7.0
\ No newline at end of file
+colorlog==6.7.0
+pynacl>=1.6.2
\ No newline at end of file
diff --git a/scripts/add_new_praise_columns.py b/scripts/add_new_praise_columns.py
index 02304da..c2d10c0 100755
--- a/scripts/add_new_praise_columns.py
+++ b/scripts/add_new_praise_columns.py
@@ -17,6 +17,7 @@
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
from common.utils.firebase import get_db
+from common.utils.oauth_providers import SLACK_PREFIX
import logging
# Set up logging
@@ -26,7 +27,7 @@
)
logger = logging.getLogger(__name__)
-SLACK_PREFIX = "oauth2|slack|T1Q7936BH-"
+# SLACK_PREFIX is now imported from oauth_providers module
def fetch_user_by_slack_id(db, slack_user_id, cache=None):
diff --git a/services/problem_statements_service.py b/services/problem_statements_service.py
index 6c21a4b..a9a46d7 100644
--- a/services/problem_statements_service.py
+++ b/services/problem_statements_service.py
@@ -1,6 +1,7 @@
from datetime import datetime
from ratelimit import limits
from common.utils.slack import invite_user_to_channel, send_slack, send_slack_audit
+from common.utils.oauth_providers import extract_slack_user_id, is_slack_user_id
from model.problem_statement import ProblemStatement
from model.user import User
from db.db import (delete_helping, fetch_hackathon, fetch_problem_statements,
@@ -138,9 +139,11 @@ def save_helping_status(propel_user_id, d):
slack_user_id = None
try:
- slack_user_id = user.user_id.split("-")[1] # Example user_id = oauth2|slack|T1Q7116BH-U041117EYTQ
- invite_user_to_channel(user_id=slack_user_id,
- channel_name=problem_statement_slack_channel)
+ # Extract raw Slack user ID for Slack API calls (handles OAuth formats)
+ if is_slack_user_id(user.user_id):
+ slack_user_id = extract_slack_user_id(user.user_id)
+ invite_user_to_channel(user_id=slack_user_id,
+ channel_name=problem_statement_slack_channel)
except Exception:
pass # Don't return error if slack invite fails.
diff --git a/services/users_service.py b/services/users_service.py
index 1d79134..d09be33 100644
--- a/services/users_service.py
+++ b/services/users_service.py
@@ -14,11 +14,20 @@
logger = get_logger("users_service")
+# Import OAuth utilities for handling multiple providers (Slack, Google, etc.)
+from common.utils.oauth_providers import (
+ USER_ID_PREFIX,
+ normalize_slack_user_id,
+ is_oauth_user_id,
+ get_oauth_provider_from_propel_response,
+ build_user_id_for_provider
+)
+
#TODO consts file?
ONE_MINUTE = 1*60
-#TODO: get last part of this from env
-USER_ID_PREFIX = "oauth2|slack|T1Q7936BH-" #the followed by UXXXXX for slack
+# USER_ID_PREFIX is now imported from oauth_providers module for consistency
+# Note: This maintains backward compatibility with Slack-specific code
def clear_cache():
get_profile_metadata.cache_clear()
@@ -90,67 +99,165 @@ def save_user(
def get_slack_user_from_token(token):
resp = requests.get(
- "https://slack.com/api/openid.connect.userInfo",
+ "https://slack.com/api/openid.connect.userInfo",
headers={"Authorization": f"Bearer {token}"}
)
'''
- {'ok': True, 'sub': 'UC31XTRT5', 'https://slack.com/user_id': 'UC31XTRT5', 'https://slack.com/team_id': 'T1Q7936BH', 'email': 'greg.vannoni@gmail.com', 'email_verified': True, 'date_email_verified': 1632009763, 'name': 'Greg V [Staff/Mentor]', 'picture': 'https://avatars.slack-edge.com/2020-10-18/1442299648180_56142a4494226a9ea4b5_512.png', 'given_name': 'Greg', 'family_name': 'V [Staff/Mentor]', 'locale': 'en-US', 'https://slack.com/team_name': 'Opportunity Hack', 'https://slack.com/team_domain': 'opportunity-hack', 'https://slack.com/user_image_24': 'https://avatars.slack-edge.com/2020-10-18/1442299648180_56142a4494226a9ea4b5_24.png', 'https://slack.com/user_image_32': 'https://avatars.slack-edge.com/2020-10-18/1442299648180_56142a4494226a9ea4b5_32.png', 'https://slack.com/user_image_48': 'https://avatars.slack-edge.com/2020-10-18/1442299648180_56142a4494226a9ea4b5_48.png', 'https://slack.com/user_image_72': 'https://avatars.slack-edge.com/2020-10-18/1442299648180_56142a4494226a9ea4b5_72.png', 'https://slack.com/user_image_192': 'https://avatars.slack-edge.com/2020-10-18/1442299648180_56142a4494226a9ea4b5_192.png', 'https://slack.com/user_image_512': 'https://avatars.slack-edge.com/2020-10-18/1442299648180_56142a4494226a9ea4b5_512.png', 'https://slack.com/user_image_1024': 'https://avatars.slack-edge.com/2020-10-18/1442299648180_56142a4494226a9ea4b5_1024.png', 'https://slack.com/team_image_34': 'https://avatars.slack-edge.com/2017-09-26/246651063104_30aaa970e3bcf4a8ac6b_34.png', 'https://slack.com/team_image_44': 'https://avatars.slack-edge.com/2017-09-26/246651063104_30aaa970e3bcf4a8ac6b_44.png', 'https://slack.com/team_image_68': 'https://avatars.slack-edge.com/2017-09-26/246651063104_30aaa970e3bcf4a8ac6b_68.png', 'https://slack.com/team_image_88': 'https://avatars.slack-edge.com/2017-09-26/246651063104_30aaa970e3bcf4a8ac6b_88.png', 'https://slack.com/team_image_102': 'https://avatars.slack-edge.com/2017-09-26/246651063104_30aaa970e3bcf4a8ac6b_102.png', 'https://slack.com/team_image_132': 'https://avatars.slack-edge.com/2017-09-26/246651063104_30aaa970e3bcf4a8ac6b_132.png',
+ {'ok': True, 'sub': 'UC31XTRT5', 'https://slack.com/user_id': 'UC31XTRT5', 'https://slack.com/team_id': 'T1Q7936BH', 'email': 'greg.vannoni@gmail.com', 'email_verified': True, 'date_email_verified': 1632009763, 'name': 'Greg V [Staff/Mentor]', 'picture': 'https://avatars.slack-edge.com/2020-10-18/1442299648180_56142a4494226a9ea4b5_512.png', 'given_name': 'Greg', 'family_name': 'V [Staff/Mentor]', 'locale': 'en-US', 'https://slack.com/team_name': 'Opportunity Hack', 'https://slack.com/team_domain': 'opportunity-hack', 'https://slack.com/user_image_24': 'https://avatars.slack-edge.com/2020-10-18/1442299648180_56142a4494226a9ea4b5_24.png', 'https://slack.com/user_image_32': 'https://avatars.slack-edge.com/2020-10-18/1442299648180_56142a4494226a9ea4b5_32.png', 'https://slack.com/user_image_48': 'https://avatars.slack-edge.com/2020-10-18/1442299648180_56142a4494226a9ea4b5_48.png', 'https://slack.com/user_image_72': 'https://avatars.slack-edge.com/2020-10-18/1442299648180_56142a4494226a9ea4b5_72.png', 'https://slack.com/user_image_192': 'https://avatars.slack-edge.com/2020-10-18/1442299648180_56142a4494226a9ea4b5_192.png', 'https://slack.com/user_image_512': 'https://avatars.slack-edge.com/2020-10-18/1442299648180_56142a4494226a9ea4b5_512.png', 'https://slack.com/user_image_1024': 'https://avatars.slack-edge.com/2020-10-18/1442299648180_56142a4494226a9ea4b5_1024.png', 'https://slack.com/team_image_34': 'https://avatars.slack-edge.com/2017-09-26/246651063104_30aaa970e3bcf4a8ac6b_34.png', 'https://slack.com/team_image_44': 'https://avatars.slack-edge.com/2017-09-26/246651063104_30aaa970e3bcf4a8ac6b_44.png', 'https://slack.com/team_image_68': 'https://avatars.slack-edge.com/2017-09-26/246651063104_30aaa970e3bcf4a8ac6b_68.png', 'https://slack.com/team_image_88': 'https://avatars.slack-edge.com/2017-09-26/246651063104_30aaa970e3bcf4a8ac6b_88.png', 'https://slack.com/team_image_102': 'https://avatars.slack-edge.com/2017-09-26/246651063104_30aaa970e3bcf4a8ac6b_102.png', 'https://slack.com/team_image_132': 'https://avatars.slack-edge.com/2017-09-26/246651063104_30aaa970e3bcf4a8ac6b_132.png',
'https://slack.com/team_image_230': 'https://avatars.slack-edge.com/2017-09-26/246651063104_30aaa970e3bcf4a8ac6b_230.png', 'https://slack.com/team_image_default': False}
'''
-
+
json = resp.json()
if not json["ok"]:
warning(logger, "Error getting user details from Slack or Propel APIs", response=json)
- return None
-
+ return None
+
if "sub" not in json:
warning(logger, "Error getting user details from Slack or Propel APIs", response=json)
return None
- # Add prefix to sub
+ # Add prefix to sub
json["sub"] = USER_ID_PREFIX + json["sub"]
info(logger, "Slack API response", response=json)
return json
+
+def get_google_user_from_token(token):
+ """
+ Get Google user details from a Google OAuth access token.
+
+ Google userinfo response format:
+ {
+ 'sub': '1234567890', # Google's unique user ID
+ 'email': 'user@gmail.com',
+ 'email_verified': True,
+ 'name': 'John Doe',
+ 'given_name': 'John',
+ 'family_name': 'Doe',
+ 'picture': 'https://lh3.googleusercontent.com/...',
+ 'locale': 'en'
+ }
+ """
+ resp = requests.get(
+ "https://www.googleapis.com/oauth2/v3/userinfo",
+ headers={"Authorization": f"Bearer {token}"}
+ )
+
+ json = resp.json()
+
+ if "error" in json:
+ warning(logger, "Error getting user details from Google API", response=json)
+ return None
+
+ if "sub" not in json:
+ warning(logger, "Missing 'sub' field in Google API response", response=json)
+ return None
+
+ # Build the normalized user ID for Google
+ json["sub"] = build_user_id_for_provider("google", json["sub"])
+
+ info(logger, "Google API response", response=json)
+ return json
+
def get_user_from_propel_user_id(propel_id):
- slack_user = get_slack_user_from_propel_user_id(propel_id)
- user_id = slack_user["sub"]
+ oauth_user = get_oauth_user_from_propel_user_id(propel_id)
+ if oauth_user is None:
+ return None
+ user_id = oauth_user["sub"]
return get_user_from_slack_id(user_id)
-def get_slack_user_from_propel_user_id(propel_id):
- #TODO: Do we want to be using os.getenv here?
+def get_oauth_user_from_propel_user_id(propel_id):
+ """
+ Get user details from any OAuth provider via PropelAuth.
+
+ This function detects which OAuth provider (Slack, Google, etc.) was used
+ and fetches user details from the appropriate provider's API.
+
+ Args:
+ propel_id: The PropelAuth user ID
+
+ Returns:
+ dict: User details with normalized fields including 'sub' (user ID)
+ """
url = f"{os.getenv('PROPEL_AUTH_URL')}/api/backend/v1/user/{propel_id}/oauth_token"
debug(logger, "Propel API URL", url=url)
resp = requests.get(
- url,
+ url,
headers={"Authorization": f"Bearer {os.getenv('PROPEL_AUTH_KEY')}"}
- )
+ )
logger.debug(f"Propel RESP: {resp}")
- json = resp.json()
- logger.debug(f"Propel RESP JSON: {json}")
-
- slack_token = json['slack']['access_token']
- return get_slack_user_from_token(slack_token)
+ json_resp = resp.json()
+ logger.debug(f"Propel RESP JSON: {json_resp}")
-def get_propel_user_details_by_id(propel_id):
- slack_user = get_slack_user_from_propel_user_id(propel_id)
- user_id = slack_user["sub"]
-
- email = slack_user["email"]
- # Use todays date in UTC (Z)
+ # Detect which OAuth provider was used
+ provider, token_data = get_oauth_provider_from_propel_response(json_resp)
+
+ if provider is None or token_data is None:
+ warning(logger, "Could not detect OAuth provider from PropelAuth response", response=json_resp)
+ return None
+
+ access_token = token_data.get('access_token')
+ if not access_token:
+ warning(logger, "No access token found in PropelAuth response", provider=provider, response=json_resp)
+ return None
+
+ debug(logger, "Detected OAuth provider", provider=provider)
+
+ # Fetch user details from the appropriate provider
+ if provider == 'slack':
+ return get_slack_user_from_token(access_token)
+ elif provider == 'google':
+ return get_google_user_from_token(access_token)
+ else:
+ warning(logger, "Unsupported OAuth provider", provider=provider)
+ return None
+
+
+def get_slack_user_from_propel_user_id(propel_id):
+ """
+ Legacy function for backward compatibility.
+ Use get_oauth_user_from_propel_user_id instead.
+ """
+ return get_oauth_user_from_propel_user_id(propel_id)
+
+def get_propel_user_details_by_id(propel_id):
+ """
+ Get normalized user details from PropelAuth for any OAuth provider.
+
+ Returns:
+ tuple: (email, user_id, last_login, profile_image, name, nickname)
+ """
+ oauth_user = get_oauth_user_from_propel_user_id(propel_id)
+
+ if oauth_user is None:
+ warning(logger, "Could not get OAuth user details", propel_id=propel_id)
+ return None, None, None, None, None, None
+
+ user_id = oauth_user["sub"]
+ email = oauth_user.get("email", "")
+
+ # Use today's date in UTC (Z)
last_login = datetime.now().isoformat() + "Z"
- # Print the last login in native format and in Arizona time
-
- logger.debug(f"Last Login: {last_login} {datetime.now().astimezone(pytz.timezone('US/Arizona')).isoformat()}")
+ logger.debug(f"Last Login: {last_login} {datetime.now().astimezone(pytz.timezone('US/Arizona')).isoformat()}")
+
+ # Get profile image - handle different provider formats
+ # Slack uses: https://slack.com/user_image_192
+ # Google uses: picture
+ profile_image = (
+ oauth_user.get("https://slack.com/user_image_192") or
+ oauth_user.get("picture") or
+ ""
+ )
- # https://slack.com/user_image_192
- profile_image = slack_user["https://slack.com/user_image_192"]
- name = slack_user["name"]
- nickname = slack_user["given_name"]
+ # Get name - both providers use 'name'
+ name = oauth_user.get("name", "")
+
+ # Get nickname - both providers use 'given_name'
+ nickname = oauth_user.get("given_name", "")
return email, user_id, last_login, profile_image, name, nickname
@@ -186,7 +293,7 @@ def get_profile_metadata(propel_id):
logger.debug(f"Account Details:\
- \nEmail: {email}\nSlack User ID: {user_id}\n\
+ \nEmail: {email}\nUser ID: {user_id}\n\
Last Login:{last_login}\
Image:{profile_image}")
@@ -217,28 +324,32 @@ def get_history(db_id):
return result
def save_profile_metadata(propel_id, json):
-
+
send_slack_audit(action="save_profile_metadata", message="Saving", payload=json)
-
- slack_user = get_slack_user_from_propel_user_id(propel_id)
- slack_user_id = slack_user["sub"]
- logger.info(f"Save Profile Metadata for {slack_user_id} {json}")
+ oauth_user = get_oauth_user_from_propel_user_id(propel_id)
+ if oauth_user is None:
+ error(logger, "Could not get OAuth user from PropelAuth", propel_id=propel_id)
+ return None
+
+ user_id = oauth_user["sub"]
+
+ logger.info(f"Save Profile Metadata for {user_id} {json}")
json = json["metadata"]
-
+
# See if the user exists
- user = fetch_user_by_user_id(slack_user_id)
+ user = fetch_user_by_user_id(user_id)
if user is None:
return
else:
- logger.info(f"User exists: {user.id}")
- user.update_from_metadata(json)
+ logger.info(f"User exists: {user.id}")
+ user.update_from_metadata(json)
upsert_profile_metadata(user)
-
+
# Clear cache for get_profile_metadata
get_profile_metadata.cache_clear()
-
+
return user #TODO: Breaking API change
def get_user_by_db_id(id):
@@ -259,26 +370,30 @@ def get_users():
def save_volunteering_time(propel_id, json):
logger.info(f"Save Volunteering Time for {propel_id} {json}")
- slack_user = get_slack_user_from_propel_user_id(propel_id)
- slack_user_id = slack_user["sub"]
+ oauth_user = get_oauth_user_from_propel_user_id(propel_id)
+ if oauth_user is None:
+ error(logger, "Could not get OAuth user from PropelAuth", propel_id=propel_id)
+ return None
+
+ user_id = oauth_user["sub"]
- logger.info(f"Save Volunteering Time for {slack_user_id} {json}")
+ logger.info(f"Save Volunteering Time for {user_id} {json}")
# Get the user
- user = fetch_user_by_user_id(slack_user_id)
+ user = fetch_user_by_user_id(user_id)
if user is None:
- error(logger, "User not found", slack_user_id=slack_user_id)
+ error(logger, "User not found", user_id=user_id)
return
- timestamp = datetime.now().isoformat() + "Z"
- reason = json["reason"] # The kind of volunteering being done
-
+ timestamp = datetime.now().isoformat() + "Z"
+ reason = json["reason"] # The kind of volunteering being done
+
if "finalHours" in json:
- finalHours = json["finalHours"] # This is sent at when volunteering is done
+ finalHours = json["finalHours"] # This is sent at when volunteering is done
if finalHours is None:
- error(logger, "finalHours is None", slack_user_id=slack_user_id)
+ error(logger, "finalHours is None", user_id=user_id)
return
-
+
user.volunteering.append({
"timestamp": timestamp,
"finalHours": round(finalHours,2),
@@ -292,9 +407,9 @@ def save_volunteering_time(propel_id, json):
# The right way to do this is likely to get a session id when they start volunteering and the frontend uses that to close out the volunteering session when it is done
# But this way is simpler for now
elif "commitmentHours" in json:
- commitmentHours = json["commitmentHours"] # This is sent at the start of volunteering
+ commitmentHours = json["commitmentHours"] # This is sent at the start of volunteering
if commitmentHours is None:
- error(logger, "commitmentHours is None", slack_user_id=slack_user_id)
+ error(logger, "commitmentHours is None", user_id=user_id)
return
user.volunteering.append({
@@ -311,13 +426,17 @@ def save_volunteering_time(propel_id, json):
def get_volunteering_time(propel_id, start_date, end_date):
logger.info(f"Get Volunteering Time for {propel_id} {start_date} {end_date}")
- slack_user = get_slack_user_from_propel_user_id(propel_id)
- slack_user_id = slack_user["sub"]
+ oauth_user = get_oauth_user_from_propel_user_id(propel_id)
+ if oauth_user is None:
+ error(logger, "Could not get OAuth user from PropelAuth", propel_id=propel_id)
+ return None
+
+ user_id = oauth_user["sub"]
- logger.info(f"Get Volunteering Time for {slack_user_id} start: {start_date} end: {end_date}")
+ logger.info(f"Get Volunteering Time for {user_id} start: {start_date} end: {end_date}")
# Get the user
- user = fetch_user_by_user_id(slack_user_id)
+ user = fetch_user_by_user_id(user_id)
if user is None:
return
@@ -413,13 +532,17 @@ def get_all_volunteering_time(start_date=None, end_date=None):
def get_privacy_settings(propel_id):
"""Get privacy settings for a user"""
logger.info(f"Get Privacy Settings for {propel_id}")
- slack_user = get_slack_user_from_propel_user_id(propel_id)
- slack_user_id = slack_user["sub"]
+ oauth_user = get_oauth_user_from_propel_user_id(propel_id)
+ if oauth_user is None:
+ error(logger, "Could not get OAuth user from PropelAuth", propel_id=propel_id)
+ return None
+
+ user_id = oauth_user["sub"]
# Get the user
- user = fetch_user_by_user_id(slack_user_id)
+ user = fetch_user_by_user_id(user_id)
if user is None:
- error(logger, "User not found", slack_user_id=slack_user_id)
+ error(logger, "User not found", user_id=user_id)
return None
return user.get_privacy_settings()
@@ -428,13 +551,17 @@ def get_privacy_settings(propel_id):
def update_privacy_settings(propel_id, data):
"""Update privacy settings for a user"""
logger.info(f"Update Privacy Settings for {propel_id} {data}")
- slack_user = get_slack_user_from_propel_user_id(propel_id)
- slack_user_id = slack_user["sub"]
+ oauth_user = get_oauth_user_from_propel_user_id(propel_id)
+ if oauth_user is None:
+ error(logger, "Could not get OAuth user from PropelAuth", propel_id=propel_id)
+ return None
+
+ user_id = oauth_user["sub"]
# Get the user
- user = fetch_user_by_user_id(slack_user_id)
+ user = fetch_user_by_user_id(user_id)
if user is None:
- error(logger, "User not found", slack_user_id=slack_user_id)
+ error(logger, "User not found", user_id=user_id)
return None
# Update the privacy settings
diff --git a/services/volunteers_service.py b/services/volunteers_service.py
index 25e759d..6d27193 100644
--- a/services/volunteers_service.py
+++ b/services/volunteers_service.py
@@ -9,6 +9,7 @@
from common.utils.slack import get_slack_user_by_email, send_slack
from common.log import get_logger, info, debug, warning, error, exception
from common.utils.redis_cache import redis_cached, delete_cached, clear_pattern
+from common.utils.oauth_providers import SLACK_PREFIX, normalize_slack_user_id, is_oauth_user_id, is_slack_user_id, extract_slack_user_id
import os
import requests
import resend
@@ -1428,7 +1429,7 @@ def _send_slack_message_to_user(
Send a Slack message to a user.
Args:
- slack_user_id: The Slack user ID
+ slack_user_id: The Slack user ID (raw format like "U12345ABC", not OAuth format)
message: The message content (already converted to Slack format)
volunteer_type: Type of volunteer
volunteer_id: Optional volunteer ID for logging
@@ -1437,6 +1438,24 @@ def _send_slack_message_to_user(
Returns:
Tuple of (success, error_message)
"""
+ # Validate that this is a valid Slack user ID format
+ # Slack user IDs start with 'U' or 'W' followed by alphanumeric characters
+ # They should NOT be OAuth format (oauth2|...) or Google IDs
+ if not slack_user_id:
+ warning(logger, "Empty slack_user_id provided", volunteer_id=volunteer_id)
+ return False, "No Slack user ID provided"
+
+ if slack_user_id.startswith('oauth2|'):
+ warning(logger, "OAuth format ID passed to Slack messaging - this is not a raw Slack ID",
+ slack_user_id=slack_user_id, volunteer_id=volunteer_id)
+ return False, "Invalid Slack user ID format (OAuth format not supported for Slack DMs)"
+
+ # Slack user IDs typically start with U or W
+ if not (slack_user_id.startswith('U') or slack_user_id.startswith('W')):
+ warning(logger, "Potentially invalid Slack user ID format",
+ slack_user_id=slack_user_id, volunteer_id=volunteer_id)
+ # Continue anyway - it might be a channel name or valid ID we don't recognize
+
try:
slack_message = f"📧 *Message from Opportunity Hack Team*\n\n{message}\n\n_This message was sent to you as a registered {volunteer_type.title()} for Opportunity Hack._"
send_slack(message=slack_message, channel=slack_user_id)
@@ -1598,14 +1617,10 @@ def send_volunteer_message(
db = get_db()
volunteer_doc = db.collection('volunteers').document(volunteer_id).get()
- SLACK_USER_PREFIX = "oauth2|slack|T1Q7936BH-"
-
- # if recipient_id already has SLACK_USER_PREFIX, use it directly
- if recipient_id and recipient_id.startswith(SLACK_USER_PREFIX):
- pass
- elif recipient_id:
- recipient_id = f"{SLACK_USER_PREFIX}{recipient_id}"
- else:
+ # Normalize recipient_id to use OAuth format if needed
+ if recipient_id and not is_oauth_user_id(recipient_id):
+ recipient_id = normalize_slack_user_id(recipient_id)
+ elif not recipient_id:
logger.warning("No recipient_id provided, Slack message may not be sent if slack_user_id is not found in volunteer record.")
# Search users for "user_id": ""
@@ -1616,18 +1631,26 @@ def send_volunteer_message(
name = "Volunteer"
volunteer_type = recipient_type
- if volunteer_doc.exists:
+ if volunteer_doc.exists:
volunteer = volunteer_doc.to_dict()
# Extract contact information from volunteer data
email = volunteer.get('email')
+ # slack_user_id in volunteers collection is only set for actual Slack users
slack_user_id = volunteer.get('slack_user_id')
name = volunteer.get('name', 'Volunteer')
volunteer_type = volunteer.get('volunteer_type', recipient_type)
elif users_doc:
user = users_doc[0].to_dict()
email = user.get('email_address')
- slack_user_id = user.get('user_id')
+ # Only use user_id for Slack messaging if it's actually a Slack user ID
+ user_id = user.get('user_id')
+ if user_id and is_slack_user_id(user_id):
+ # Extract the raw Slack user ID (e.g., "U12345ABC" from "oauth2|slack|T1Q7936BH-U12345ABC")
+ slack_user_id = extract_slack_user_id(user_id)
+ else:
+ # Non-Slack users (Google, GitHub, etc.) can't receive Slack DMs
+ slack_user_id = None
name = user.get('name', 'Volunteer')
volunteer_type = "Volunteer"
else:
diff --git a/test/common/utils/test_oauth_providers.py b/test/common/utils/test_oauth_providers.py
new file mode 100644
index 0000000..096767e
--- /dev/null
+++ b/test/common/utils/test_oauth_providers.py
@@ -0,0 +1,331 @@
+"""
+Unit tests for OAuth provider utilities
+"""
+import pytest
+from common.utils.oauth_providers import (
+ get_oauth_provider_from_user_id,
+ is_slack_user_id,
+ is_google_user_id,
+ is_oauth_user_id,
+ normalize_slack_user_id,
+ extract_slack_user_id,
+ get_provider_display_name,
+ get_oauth_provider_from_propel_response,
+ build_user_id_for_provider,
+ DEFAULT_SLACK_WORKSPACE_ID # Import the constant for testing
+)
+
+# Test constant - matches the default workspace ID
+TEST_SLACK_WORKSPACE_ID = DEFAULT_SLACK_WORKSPACE_ID
+
+
+class TestOAuthProviderDetection:
+ """Tests for OAuth provider detection functions"""
+
+ def test_get_oauth_provider_from_slack_user_id(self):
+ """Test extracting provider from Slack user ID"""
+ user_id = f"oauth2|slack|{TEST_SLACK_WORKSPACE_ID}-U12345ABC"
+ assert get_oauth_provider_from_user_id(user_id) == "slack"
+
+ def test_get_oauth_provider_from_google_user_id(self):
+ """Test extracting provider from Google user ID"""
+ user_id = "oauth2|google-oauth2|1234567890123456789"
+ assert get_oauth_provider_from_user_id(user_id) == "google-oauth2"
+
+ def test_get_oauth_provider_from_github_user_id(self):
+ """Test extracting provider from GitHub user ID"""
+ user_id = "oauth2|github|12345678"
+ assert get_oauth_provider_from_user_id(user_id) == "github"
+
+ def test_get_oauth_provider_from_non_oauth_user_id(self):
+ """Test with non-OAuth user ID"""
+ user_id = "regular-user-id-123"
+ assert get_oauth_provider_from_user_id(user_id) is None
+
+ def test_get_oauth_provider_from_none(self):
+ """Test with None user ID"""
+ assert get_oauth_provider_from_user_id(None) is None
+
+ def test_get_oauth_provider_from_empty_string(self):
+ """Test with empty string"""
+ assert get_oauth_provider_from_user_id("") is None
+
+
+class TestSlackUserIdDetection:
+ """Tests for Slack user ID detection"""
+
+ def test_is_slack_user_id_positive(self):
+ """Test identifying Slack user IDs"""
+ assert is_slack_user_id(f"oauth2|slack|{TEST_SLACK_WORKSPACE_ID}-U12345ABC") is True
+
+ def test_is_slack_user_id_negative_google(self):
+ """Test rejecting Google user IDs"""
+ assert is_slack_user_id("oauth2|google-oauth2|1234567890") is False
+
+ def test_is_slack_user_id_negative_none(self):
+ """Test with None"""
+ assert is_slack_user_id(None) is False
+
+ def test_is_slack_user_id_negative_empty(self):
+ """Test with empty string"""
+ assert is_slack_user_id("") is False
+
+
+class TestGoogleUserIdDetection:
+ """Tests for Google user ID detection"""
+
+ def test_is_google_user_id_positive(self):
+ """Test identifying Google user IDs"""
+ assert is_google_user_id("oauth2|google-oauth2|1234567890123456789") is True
+
+ def test_is_google_user_id_negative_slack(self):
+ """Test rejecting Slack user IDs"""
+ assert is_google_user_id("oauth2|slack|T1Q7936BH-U12345ABC") is False
+
+ def test_is_google_user_id_negative_none(self):
+ """Test with None"""
+ assert is_google_user_id(None) is False
+
+
+class TestOAuthUserIdDetection:
+ """Tests for general OAuth user ID detection"""
+
+ def test_is_oauth_user_id_slack(self):
+ """Test with Slack OAuth user ID"""
+ assert is_oauth_user_id(f"oauth2|slack|{TEST_SLACK_WORKSPACE_ID}-U12345ABC") is True
+
+ def test_is_oauth_user_id_google(self):
+ """Test with Google OAuth user ID"""
+ assert is_oauth_user_id("oauth2|google-oauth2|1234567890") is True
+
+ def test_is_oauth_user_id_github(self):
+ """Test with GitHub OAuth user ID"""
+ assert is_oauth_user_id("oauth2|github|12345678") is True
+
+ def test_is_oauth_user_id_negative(self):
+ """Test with non-OAuth user ID"""
+ assert is_oauth_user_id("regular-user-id") is False
+
+ def test_is_oauth_user_id_none(self):
+ """Test with None"""
+ assert is_oauth_user_id(None) is False
+
+
+class TestSlackUserIdNormalization:
+ """Tests for Slack user ID normalization"""
+
+ def test_normalize_slack_user_id_raw(self):
+ """Test normalizing raw Slack user ID"""
+ result = normalize_slack_user_id("U12345ABC")
+ assert result == f"oauth2|slack|{TEST_SLACK_WORKSPACE_ID}-U12345ABC"
+
+ def test_normalize_slack_user_id_already_normalized(self):
+ """Test with already normalized Slack user ID"""
+ user_id = f"oauth2|slack|{TEST_SLACK_WORKSPACE_ID}-U12345ABC"
+ result = normalize_slack_user_id(user_id)
+ assert result == user_id
+
+ def test_normalize_slack_user_id_google(self):
+ """Test with Google user ID (should not modify)"""
+ user_id = "oauth2|google-oauth2|1234567890"
+ result = normalize_slack_user_id(user_id)
+ assert result == user_id
+
+ def test_normalize_slack_user_id_none(self):
+ """Test with None"""
+ assert normalize_slack_user_id(None) is None
+
+ def test_normalize_slack_user_id_empty(self):
+ """Test with empty string"""
+ assert normalize_slack_user_id("") == ""
+
+
+class TestSlackUserIdExtraction:
+ """Tests for extracting raw Slack user ID"""
+
+ def test_extract_slack_user_id_from_full(self):
+ """Test extracting raw Slack user ID from full format"""
+ user_id = f"oauth2|slack|{TEST_SLACK_WORKSPACE_ID}-U12345ABC"
+ result = extract_slack_user_id(user_id)
+ assert result == "U12345ABC"
+
+ def test_extract_slack_user_id_from_different_workspace(self):
+ """Test extracting from different workspace ID"""
+ user_id = "oauth2|slack|T9999999-U67890XYZ"
+ result = extract_slack_user_id(user_id)
+ assert result == "U67890XYZ"
+
+ def test_extract_slack_user_id_from_google(self):
+ """Test with Google user ID (should return as-is)"""
+ user_id = "oauth2|google-oauth2|1234567890"
+ result = extract_slack_user_id(user_id)
+ assert result == user_id
+
+ def test_extract_slack_user_id_from_raw(self):
+ """Test with raw user ID (should return as-is)"""
+ user_id = "U12345ABC"
+ result = extract_slack_user_id(user_id)
+ assert result == user_id
+
+ def test_extract_slack_user_id_none(self):
+ """Test with None"""
+ assert extract_slack_user_id(None) is None
+
+
+class TestProviderDisplayName:
+ """Tests for provider display name generation"""
+
+ def test_get_provider_display_name_slack(self):
+ """Test display name for Slack"""
+ user_id = f"oauth2|slack|{TEST_SLACK_WORKSPACE_ID}-U12345ABC"
+ assert get_provider_display_name(user_id) == "Slack"
+
+ def test_get_provider_display_name_google(self):
+ """Test display name for Google"""
+ user_id = "oauth2|google-oauth2|1234567890"
+ assert get_provider_display_name(user_id) == "Google"
+
+ def test_get_provider_display_name_github(self):
+ """Test display name for GitHub"""
+ user_id = "oauth2|github|12345678"
+ assert get_provider_display_name(user_id) == "GitHub"
+
+ def test_get_provider_display_name_microsoft(self):
+ """Test display name for Microsoft"""
+ user_id = "oauth2|microsoft|uuid-here"
+ assert get_provider_display_name(user_id) == "Microsoft"
+
+ def test_get_provider_display_name_unknown(self):
+ """Test display name for unknown provider"""
+ user_id = "oauth2|unknown-provider|12345"
+ # Should title-case the provider name
+ assert get_provider_display_name(user_id) == "Unknown-Provider"
+
+ def test_get_provider_display_name_non_oauth(self):
+ """Test display name for non-OAuth user ID"""
+ user_id = "regular-user-id"
+ assert get_provider_display_name(user_id) == "Unknown"
+
+
+class TestPropelResponseProviderDetection:
+ """Tests for detecting OAuth provider from PropelAuth response"""
+
+ def test_detect_slack_provider(self):
+ """Test detecting Slack from PropelAuth response"""
+ response = {
+ 'slack': {
+ 'access_token': 'xoxp-123456',
+ 'refresh_token': None,
+ 'token_provider': 'slack'
+ }
+ }
+ provider, token_data = get_oauth_provider_from_propel_response(response)
+ assert provider == 'slack'
+ assert token_data['access_token'] == 'xoxp-123456'
+
+ def test_detect_google_provider(self):
+ """Test detecting Google from PropelAuth response"""
+ response = {
+ 'google': {
+ 'access_token': 'ya29.abc123',
+ 'refresh_token': None,
+ 'token_provider': 'google',
+ 'token_expiration': 1770096897,
+ 'authorized_scopes': ['openid', 'email', 'profile']
+ }
+ }
+ provider, token_data = get_oauth_provider_from_propel_response(response)
+ assert provider == 'google'
+ assert token_data['access_token'] == 'ya29.abc123'
+
+ def test_detect_github_provider(self):
+ """Test detecting GitHub from PropelAuth response"""
+ response = {
+ 'github': {
+ 'access_token': 'gho_abc123',
+ 'refresh_token': None
+ }
+ }
+ provider, token_data = get_oauth_provider_from_propel_response(response)
+ assert provider == 'github'
+ assert token_data['access_token'] == 'gho_abc123'
+
+ def test_detect_microsoft_provider(self):
+ """Test detecting Microsoft from PropelAuth response"""
+ response = {
+ 'microsoft': {
+ 'access_token': 'EwBwA...',
+ 'refresh_token': None
+ }
+ }
+ provider, token_data = get_oauth_provider_from_propel_response(response)
+ assert provider == 'microsoft'
+ assert token_data['access_token'] == 'EwBwA...'
+
+ def test_empty_response(self):
+ """Test with empty response"""
+ provider, token_data = get_oauth_provider_from_propel_response({})
+ assert provider is None
+ assert token_data is None
+
+ def test_none_response(self):
+ """Test with None response"""
+ provider, token_data = get_oauth_provider_from_propel_response(None)
+ assert provider is None
+ assert token_data is None
+
+ def test_unknown_provider_with_access_token(self):
+ """Test with unknown provider that has access_token structure"""
+ response = {
+ 'custom_oauth': {
+ 'access_token': 'custom_token_123'
+ }
+ }
+ provider, token_data = get_oauth_provider_from_propel_response(response)
+ assert provider == 'custom_oauth'
+ assert token_data['access_token'] == 'custom_token_123'
+
+ def test_response_without_access_token(self):
+ """Test with response that doesn't have access_token in nested dict"""
+ response = {
+ 'something': {
+ 'other_field': 'value'
+ }
+ }
+ provider, token_data = get_oauth_provider_from_propel_response(response)
+ assert provider is None
+ assert token_data is None
+
+
+class TestBuildUserIdForProvider:
+ """Tests for building normalized user IDs for different providers"""
+
+ def test_build_slack_user_id_with_workspace(self):
+ """Test building Slack user ID with explicit workspace"""
+ result = build_user_id_for_provider('slack', 'U12345ABC', 'T9999999')
+ assert result == 'oauth2|slack|T9999999-U12345ABC'
+
+ def test_build_slack_user_id_default_workspace(self):
+ """Test building Slack user ID with default workspace"""
+ result = build_user_id_for_provider('slack', 'U12345ABC')
+ assert result == f'oauth2|slack|{TEST_SLACK_WORKSPACE_ID}-U12345ABC'
+
+ def test_build_google_user_id(self):
+ """Test building Google user ID"""
+ result = build_user_id_for_provider('google', '1234567890123456789')
+ assert result == 'oauth2|google-oauth2|1234567890123456789'
+
+ def test_build_github_user_id(self):
+ """Test building GitHub user ID"""
+ result = build_user_id_for_provider('github', '12345678')
+ assert result == 'oauth2|github|12345678'
+
+ def test_build_microsoft_user_id(self):
+ """Test building Microsoft user ID"""
+ result = build_user_id_for_provider('microsoft', 'uuid-here')
+ assert result == 'oauth2|microsoft|uuid-here'
+
+ def test_build_unknown_provider_user_id(self):
+ """Test building user ID for unknown provider"""
+ result = build_user_id_for_provider('custom_provider', 'user123')
+ assert result == 'oauth2|custom_provider|user123'