[N3] firebase auth and update apis by 1jeanpaul1 · Pull Request #5 · FridgeFinder/CFM_Notification

1jeanpaul1 · 2025-12-13T11:05:50Z

Description

Changes Authorization from cognito to firebase
Adds missing APIs
Adds API Docs
Adds Email and Push Notification flow
When User is in User Service, Notification are also deleted - triggered by event bridge

API Docs: https://fridgefinder.github.io/CFM_Notification/

API

Base URLs:

Dev: https://notifications-api-dev.communityfridgefinder.com
Staging: https://notifications-api-staging.communityfridgefinder.com
Prod: https://notifications-api-prod.communityfridgefinder.com

Authentication: All endpoints (except health check) require Firebase JWT token in Authorization: Bearer <token> header.

Endpoints

Get Notification for Specific Fridge

`GET /v1/users/{user_id}/fridge-notifications/{fridge_id}`

Retrieve notification preferences for a specific fridge.

Path Parameters:

user_id (string, required) - Firebase User ID (must match authenticated user)
fridge_id (string, required) - Unique fridge identifier

Success Response (200):

{
  "userId": "abc123xyz456def789",
  "fridgeId": "fridge_123abc",
  "contactTypePreferences": {
    "email": {
      "good": true,
      ...
    }
  },
  "createdAt": "2025-12-13T10:30:45.123Z",
  "updatedAt": "2025-12-13T15:20:30.456Z"
}

Create Notification Preferences

`POST /v1/users/{user_id}/fridge-notifications/{fridge_id}`

Create new notification preferences for a fridge.

Path Parameters:

user_id (string, required) - Firebase User ID (must match authenticated user)
fridge_id (string, required) - Unique fridge identifier

Request Body:

{
  "contactTypePreferences": {
    "email": {
      "good": true,
      ...
    },
    "device": {
      "good": false,
      ...
    }
  }
}

Success Response (201):

{
  "userId": "abc123xyz456def789",
  "fridgeId": "fridge_123abc",
  "contactTypePreferences": {
    "email": {
      "good": true,
      ...
    },
    "device": {
      "good": false,
      ...
    }
  },
  "createdAt": "2025-12-13T10:30:45.123Z",
  "updatedAt": "2025-12-13T10:30:45.123Z"
}

Update Notification Preferences

`PATCH /v1/users/{user_id}/fridge-notifications/{fridge_id}`

Update existing notification preferences for a fridge.

Path Parameters:

user_id (string, required) - Firebase User ID (must match authenticated user)
fridge_id (string, required) - Unique fridge identifier

Request Body:

{
  "contactTypePreferences": {
    "email": {
      "good": false,
      ...
    },
    "device": {
      "good": true,
      ...
    }
  }
}

Success Response (200):

{
  "userId": "abc123xyz456def789",
  "fridgeId": "fridge_123abc",
  "contactTypePreferences": {
    "email": {
      "good": false,
      ...
    },
    "device": {
      "good": true,
      ...
    }
  },
  "createdAt": "2025-12-13T10:30:45.123Z",
  "updatedAt": "2025-12-13T16:45:22.789Z"
}

Get All User Notifications

`GET /v1/users/{user_id}/fridge-notifications`

Retrieve all notification preferences for a user.

Path Parameters:

user_id (string, required) - Firebase User ID (must match authenticated user)

Success Response (200):

{
  "data": [
    {
      "userId": "abc123xyz456def789",
      "fridgeId": "fridge_123abc",
      "contactTypePreferences": {
        "email": {
          "good": true,
          "dirty": true,
          "outOfOrder": true,
          "notAtLocation": false,
          "ghost": false,
          "foodLevel0": true,
          "foodLevel1": false,
          "foodLevel2": false,
          "foodLevel3": false
        },
        "device": {
          "good": false,
          ...
        }
      },
      "createdAt": "2025-12-13T10:30:45.123Z",
      "updatedAt": "2025-12-13T15:20:30.456Z"
    }
  ],
  "count": 1
}

Delete Notification Preferences

`DELETE /v1/users/{user_id}/fridge-notifications/{fridge_id}`

Remove notification preferences for a specific fridge.

Path Parameters:

user_id (string, required) - Firebase User ID (must match authenticated user)
fridge_id (string, required) - Unique fridge identifier

Success Response (204):

No content (empty response body)

Error Responses

All errors follow a standardized format with an error object containing a code and message.

Error Response Structure

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message"
  }
}

Error Examples

400 Bad Request - Validation Error

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Input validation failed"
  }
}

404 Not Found

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Notification preference not found"
  }
}

409 Conflict

{
  "error": {
    "code": "ALREADY_EXISTS",
    "message": "Notification preference already exists for this user and fridge"
  }
}

500 Internal Server Error

{
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "An unexpected error occurred"
  }
}

401 Unauthorized

{
  "message": "Unauthorized"
}

401 errors are returned from API Gateway if JWT token is not valid

1jeanpaul1 · 2025-12-13T11:39:14Z

+    foodLevel2: bool
+    foodLevel3: bool
+
+class ContactTypePreferencesModel(BaseModel):


I think notifications could be laid out something like this in the future on web and mobile

on web:
if user clicks on phone -> redirects them to download mobile app
if user clicks on email -> updates user preference

note: The only notification that I can think of that would be email specific: Weekly/Monthly Digest which emails the user monthly stats about the fridge (not included yet)

Preliminary design

…ployment

1jeanpaul1 · 2025-12-13T12:06:50Z

+          Authorizers:
+            FirebaseAuthorizer:
+              JwtConfiguration:
+                issuer: !Sub "https://securetoken.google.com/${FirebaseProjectId}"


firebase auth

1jeanpaul1 · 2025-12-13T12:08:00Z

+  ##    DynamoDB Tables    ##
+  ##########################
+
+  UserFridgeNotificationsTable:


Hash/PrimaryKey: userId
Range: fridgeId

1jeanpaul1 · 2026-01-24T08:41:08Z

+        Unsubscribe: {base_url}/unsubscribe?token=eyJhbGciOiJ
+        """
+
+        ses.send_email(


Email Notification Preview
TODO: Add Mobile App links once launched on app stores

TODO: add app links

1jeanpaul1 · 2026-01-24T08:43:31Z

+            token=fcm_token,
+        )
+
+        response = messaging.send(message)


Tested on firebase web fcmtoken

TODO: confirm messagin

1jeanpaul1 · 2026-01-24T10:44:44Z

API Docs: https://fridgefinder.github.io/CFM_Notification/

TODO: Review and Approve by others

1jeanpaul1 · 2026-01-24T10:56:18Z

+    email: Optional[FridgePreferencesModel] = None
+    device: Optional[FridgePreferencesModel] = None
+
+class UserFridgeNotificationModel(BaseModel):


Reviewer: Confirm fields and structure

mansoorsiddiqui

Good progress on the restructure. Left a few comments inline — the bigger picture stuff is around cross-service coupling and making sure we have a path to decouple the direct DB reads.

Cross-service concerns:

The stream processor reads directly from the user table — schema changes in the user service could silently break notifications. I know there's a note about making this an API call — just want to make sure we're tracking it.
Old tests were deleted but no new tests added. The new code has non-trivial logic (preference merging, condition mapping, stream processing) — are we planning to add tests in a follow-up? Would feel a lot more comfortable merging if at least the model and service layer had coverage.
Error codes use NOT_FOUND, ALREADY_EXISTS here vs USER_NOT_FOUND, USER_ALREADY_EXISTS in the user service. Should we align?

mansoorsiddiqui · 2026-02-18T21:07:47Z

+logger.setLevel(logging.INFO)
+
+# Initialize Firebase when module is loaded
+initialize_firebase()


initialize_firebase() runs at module load time. If this fails (bad credentials, network blip during cold start), the entire Lambda container is toast — every invocation will fail until AWS recycles it. Can we wrap this in a try/except, or do lazy init on first invocation?

if this fails the lambda will do periodic retries until successful or 24 hours go by, though maybe I should decrease that time.

are you suggesting to silently fail if firebase doesn't initialize? So that emails go through at least?

mansoorsiddiqui · 2026-02-18T21:07:47Z

+  push:
+    branches:
+      - main
+      - N3_JP


Same as the user service PR — N3_JP branch is still in the trigger list. Remove before merging.

yes will remove before merging

1jeanpaul1 · 2026-03-09T04:36:18Z

@mansoorsiddiqui

The stream processor reads directly from the user table — schema changes in the user service could silently break notifications. I know there's a note about making this an API call — just want to make sure we're tracking it.

Yes, the plan it to make it an API call. I think we have enough time now so I'll implement

Old tests were deleted but no new tests added. The new code has non-trivial logic (preference merging, condition mapping, stream processing) — are we planning to add tests in a follow-up? Would feel a lot more comfortable merging if at least the model and service layer had coverage.

Yes sorry should've left a comment, was waiting on review before adding tests. I'll add them now, thank you :)

Error codes use NOT_FOUND, ALREADY_EXISTS here vs USER_NOT_FOUND, USER_ALREADY_EXISTS in the user service. Should we align?

Yes, thank you for catching :)

1jeanpaul1 temporarily deployed to github-pages December 13, 2025 11:07 — with GitHub Actions Inactive

1jeanpaul1 temporarily deployed to github-pages December 13, 2025 11:27 — with GitHub Actions Inactive

1jeanpaul1 temporarily deployed to github-pages December 13, 2025 11:27 — with GitHub Pages Inactive

1jeanpaul1 commented Dec 13, 2025

View reviewed changes

1jeanpaul1 force-pushed the N3_JP branch from ab30c88 to 18cd7a4 Compare December 13, 2025 11:47

1jeanpaul1 temporarily deployed to github-pages December 13, 2025 11:47 — with GitHub Actions Inactive

1jeanpaul1 temporarily deployed to github-pages December 13, 2025 11:47 — with GitHub Pages Inactive

N3: Add Firebase auth, DELETE endpoint, API docs, and GitHub Pages de…

a10a89c

…ployment

1jeanpaul1 force-pushed the N3_JP branch from 18cd7a4 to a10a89c Compare December 13, 2025 11:54

1jeanpaul1 temporarily deployed to github-pages December 13, 2025 11:54 — with GitHub Actions Inactive

1jeanpaul1 temporarily deployed to github-pages December 13, 2025 11:54 — with GitHub Pages Inactive

1jeanpaul1 commented Dec 13, 2025

View reviewed changes

1jeanpaul1 changed the title ~~[N3] add firebase auth and update apis and add docs~~ [N3] firebase auth and update apis Dec 13, 2025

N3 minor fixes

bdac10c

1jeanpaul1 temporarily deployed to github-pages December 14, 2025 00:43 — with GitHub Pages Inactive

N3 update patch api to only partially update preferences

2bb99e1

1jeanpaul1 temporarily deployed to github-pages December 14, 2025 02:18 — with GitHub Pages Inactive

N3 update openapi yaml with more examples for patch

04c777c

1jeanpaul1 temporarily deployed to github-pages December 14, 2025 02:27 — with GitHub Actions Inactive

1jeanpaul1 temporarily deployed to github-pages December 14, 2025 02:27 — with GitHub Pages Inactive

N3 add event based user notification prefence deletions

4615e96

1jeanpaul1 temporarily deployed to github-pages January 2, 2026 06:34 — with GitHub Pages Inactive

N3 process push/email notification

a40e33a

1jeanpaul1 temporarily deployed to github-pages January 24, 2026 07:46 — with GitHub Actions Inactive

1jeanpaul1 temporarily deployed to github-pages January 24, 2026 07:46 — with GitHub Pages Inactive

N3 fix email notification url

3d59b02

1jeanpaul1 temporarily deployed to github-pages January 24, 2026 08:37 — with GitHub Pages Inactive

1jeanpaul1 commented Jan 24, 2026

View reviewed changes

N3 add html email

8047ebf

1jeanpaul1 temporarily deployed to github-pages January 24, 2026 10:35 — with GitHub Pages Inactive

1jeanpaul1 commented Jan 24, 2026

View reviewed changes

mansoorsiddiqui reviewed Feb 18, 2026

View reviewed changes

1jeanpaul1 added 4 commits March 29, 2026 18:55

N3 update layers, simplified api response

c8a62b3

N3 add unit tests

dfebc9f

N3 add concurrent modification check on patch

7f94013

N3 update gitignore

1721430

1jeanpaul1 temporarily deployed to github-pages March 30, 2026 00:06 — with GitHub Actions Inactive

1jeanpaul1 temporarily deployed to github-pages March 30, 2026 00:07 — with GitHub Pages Inactive

N3 update http response to handle None body

140425b

1jeanpaul1 temporarily deployed to github-pages March 30, 2026 00:40 — with GitHub Pages Inactive

N3 update http_response signature

26d6d2c

1jeanpaul1 temporarily deployed to github-pages March 30, 2026 00:42 — with GitHub Pages Inactive

N3 add pagination note to list_by_fridge

87be688

1jeanpaul1 temporarily deployed to github-pages March 30, 2026 00:47 — with GitHub Pages Inactive

N3 update default FridgePreference param

bb07652

1jeanpaul1 deployed to github-pages April 27, 2026 06:32 — with GitHub Pages View deployment

Conversation

1jeanpaul1 commented Dec 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

API

Endpoints

Get Notification for Specific Fridge

GET /v1/users/{user_id}/fridge-notifications/{fridge_id}

Create Notification Preferences

POST /v1/users/{user_id}/fridge-notifications/{fridge_id}

Update Notification Preferences

PATCH /v1/users/{user_id}/fridge-notifications/{fridge_id}

Get All User Notifications

GET /v1/users/{user_id}/fridge-notifications

Delete Notification Preferences

DELETE /v1/users/{user_id}/fridge-notifications/{fridge_id}

Error Responses

Error Response Structure

Error Examples

400 Bad Request - Validation Error

404 Not Found

409 Conflict

500 Internal Server Error

401 Unauthorized

Uh oh!

1jeanpaul1 Dec 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

1jeanpaul1 Jan 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mansoorsiddiqui left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

1jeanpaul1 commented Mar 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

1jeanpaul1 commented Dec 13, 2025 •

edited

Loading

`GET /v1/users/{user_id}/fridge-notifications/{fridge_id}`

`POST /v1/users/{user_id}/fridge-notifications/{fridge_id}`

`PATCH /v1/users/{user_id}/fridge-notifications/{fridge_id}`

`GET /v1/users/{user_id}/fridge-notifications`

`DELETE /v1/users/{user_id}/fridge-notifications/{fridge_id}`

1jeanpaul1 Dec 13, 2025 •

edited

Loading

1jeanpaul1 Jan 24, 2026 •

edited

Loading