web: add in-app feedback widget and usage events by InfinityBowman · Pull Request #527 · InfinityBowman/corates

InfinityBowman · 2026-07-06T20:51:21Z

Closes #525

Summary

Adds an in-app feedback widget for early-access users plus a small usage-analytics pass. No new vendors: feedback is stored in D1 and emailed via the existing contact queue, bug reports link to existing Sentry session replays, and usage tracking extends the self-hosted Plausible custom events.

Feedback widget

feedback table (migration 0004) with FeedbackId brand; status column (new/reviewed) is dormant until a triage view is needed.
submitFeedback server function following the contact pattern: auth middleware, Zod validation, insert, notification email. No rate-limiting infra - a single COUNT on the feedback table caps submissions at 5/user/hour purely to protect the notification inbox. Email failure after insert is logged, not surfaced, since the feedback is already saved.
FeedbackDialog mounted once in the root layout, opened via a new feedbackStore: Bug/Idea/Other chips, textarea, success state with auto-close. Auto-captures route, user agent, viewport; bug reports silently attach the Sentry replay id (disclosed in small print).
Entry points: "Give feedback" in the AppNavbar user dropdown, and the EarlyAccessBanner feedback text is now a real link (opens the dialog when signed in, routes to /contact when signed out on public pages).

Analytics

track(event, props) util wrapping window.plausible; the Window type declaration moved out of CreateLocalChecklist.tsx and existing call sites migrated.
New events: Project:Created, Checklist:Created (project checklist action funnel), Checklist:Completed (reconciled checklist finalized), Collaborator:Invited (email/direct prop), Feedback:Submitted (category prop).
No Signup event: user counts are already in the admin dashboard and a client-side event would miss OAuth signups.

Testing

6 new server tests for submitFeedback (storage, context handling, email-failure tolerance, hourly cap, cap window, per-user isolation); full suite green (329 tests).
Typecheck and lint clean across the workspace; production build succeeds.
Manually smoke-tested locally: migration applied, dialog works from both entry points.

Summary by CodeRabbit

New Features
- Added an in-app feedback dialog available from the app shell and navbar.
- Users can send feedback with categories like bug, idea, or other, and include optional context.
- Feedback now shows a success or error state after submission.
Bug Fixes
- Feedback submissions are now rate-limited per user to reduce spam.
- Feedback content is saved even if notification delivery fails.

…h per-user hourly email guard, dialog with bug/idea/other categories and Sentry replay id on bug reports, navbar dropdown and early-access banner entry points, track() util wrapping plausible with Project/Checklist/Collaborator/Feedback events Closes #525

cursor · 2026-07-06T20:51:27Z

Bugbot is not enabled for your account, so this pull request was not reviewed.

Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs.

coderabbitai · 2026-07-06T20:52:04Z

📝 Walkthrough

Walkthrough

This PR introduces an in-app feedback feature: a feedback database table with migration, a validated server function enforcing per-user hourly rate limits and sending notification emails, a FeedbackDialog UI wired to a Zustand store, and entry points from the navbar and banner. It also adds a shared track() analytics helper replacing direct window.plausible calls across several components, plus minor unrelated formatting tweaks.

Changes

In-app Feedback Feature

Layer / File(s)	Summary
Feedback data model and migration `packages/db/src/schema.ts`, `packages/shared/src/ids.ts`, `packages/web/migrations/0004_lying_frog_thor.sql`, `packages/web/migrations/meta/0004_snapshot.json`, `packages/web/migrations/meta/_journal.json`, `packages/web/src/__tests__/server/helpers.ts`, `packages/web/src/__tests__/server/migration-sql.js`	Adds a `FeedbackId` branded type, `feedback` Drizzle table with FK/index and inferred types, matching SQL migration, full snapshot/journal entries, and updates test DB fixtures.
Feedback submission server function `packages/web/src/server/functions/feedback.functions.ts`, `packages/web/src/server/functions/feedback.server.ts`, `packages/web/src/config/sentry.ts`	Adds a validated, auth-guarded `submitFeedback` server function enforcing an hourly per-user rate limit, inserting rows, sending notification emails, and a `getSentryReplayId()` helper for bug reports.
Feedback store and dialog UI `packages/web/src/stores/feedbackStore.ts`, `packages/web/src/components/feedback/FeedbackDialog.tsx`	Adds a Zustand `useFeedbackStore` and a `FeedbackDialog` component with category selection, submission flow, success/error states, and analytics tracking.
Feedback dialog entry points `packages/web/src/components/EarlyAccessBanner.tsx`, `packages/web/src/components/layout/AppNavbar.tsx`, `packages/web/src/routes/__root.tsx`	Wires the banner and navbar dropdown to open the feedback dialog, and mounts `FeedbackDialog` in the root layout.
Feedback server tests `packages/web/src/server/functions/__tests__/feedback.server.test.ts`	Adds tests covering storage, email notification, missing context, email failure resilience, and per-user hourly rate limiting.

Analytics Tracking Pass

Layer / File(s)	Summary
Analytics helper module `packages/web/src/lib/analytics.ts`	Adds a typed `window.plausible` global and the `track()` helper function.
Analytics instrumentation across features `packages/web/src/components/checklist/CreateLocalChecklist.tsx`, `.../LocalChecklistView.tsx`, `packages/web/src/components/project/CreateProjectModal.tsx`, `.../overview-tab/AddMemberModal.tsx`, `.../reconcile-tab/ReconciliationWrapper.tsx`, `packages/web/src/project/actions.ts`	Replaces `window.plausible` calls with `track()` and adds new tracking calls for project creation, collaborator invitation, checklist completion, and checklist creation.

Estimated code review effort: 3 (Moderate) | ~30 minutes

Sequence Diagram(s)

sequenceDiagram
  participant User
  participant FeedbackDialog
  participant submitFeedback
  participant Database
  participant EmailQueue

  User->>FeedbackDialog: select category, enter message, submit
  FeedbackDialog->>submitFeedback: submit(category, message, context)
  submitFeedback->>Database: count recent submissions (last hour)
  Database-->>submitFeedback: submission count
  alt limit exceeded
    submitFeedback-->>FeedbackDialog: throw rate-limit error
    FeedbackDialog-->>User: show error state
  else within limit
    submitFeedback->>Database: insert feedback row
    submitFeedback->>EmailQueue: send notification email
    submitFeedback-->>FeedbackDialog: success response
    FeedbackDialog-->>User: show success state, auto-close
  end

Estimated code review effort

Estimated code review effort: 3 (Moderate) | ~30 minutes

Poem

A rabbit hops with feedback in tow,
"Bug or idea?" — pick one and go!
A table, a dialog, an email in flight,
Rate-limited hops keep the inbox light.
Plausible tracks each click and each cheer —
Hooray for feedback, the rabbit's ear!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Out of Scope Changes check	⚠️ Warning	The PR also changes unrelated files, including formatting-only edits and a subscription index addition that aren't part of the feedback/analytics scope.	Remove unrelated formatting-only edits and the subscription index change, leaving only feedback and analytics work tied to the issue.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main change: adding an in-app feedback widget and related usage events.
Linked Issues check	✅ Passed	The PR covers the feedback dialog, D1 storage/email flow, context capture, replay IDs, entry points, and the requested analytics events.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch feedback-widget

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 2

🧹 Nitpick comments (2)

packages/web/src/server/functions/feedback.server.ts (1)
70-71: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Type-unsafe env cast.

(env as unknown as Record<string, string | undefined>).CONTACT_EMAIL bypasses the Cloudflare Env typing entirely. Consider extending the generated Env type with CONTACT_EMAIL so this reads as env.CONTACT_EMAIL with proper typing.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@packages/web/src/server/functions/feedback.server.ts` around lines 70 - 71,
The contact email lookup in feedback.server.ts is using a type-unsafe double
cast on env, bypassing the Cloudflare Env typing. Update the generated Env type
to include CONTACT_EMAIL and then read it directly through the
feedback.server.ts logic in the contactEmail assignment, so the function uses
env.CONTACT_EMAIL with proper typing and keeps the fallback value.
packages/web/src/__tests__/server/migration-sql.js (1)
263-276: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Feedback table/index design looks solid.

FK cascade on userId and the composite (userId, createdAt) index correctly support the per-user hourly rate-limit COUNT query described in the PR objectives.

Separately: this hunk also folds in an unrelated subscription_referenceId_incomplete_uidx partial index into the same migration as the feedback table. Not blocking, but worth confirming that was intentional (e.g., a hotfix bundled in) rather than accidental migration-file conflation.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@packages/web/src/__tests__/server/migration-sql.js` around lines 263 - 276,
The feedback table and index changes look fine, but this migration hunk also
includes the unrelated subscription_referenceId_incomplete_uidx partial index.
Review the migration SQL assembly in migration-sql.js and confirm whether that
subscription index belongs in the same migration as the feedback table; if not,
move it to the correct migration or separate hunk so the feedback schema change
stays isolated.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@packages/web/src/components/feedback/FeedbackDialog.tsx`:
- Around line 45-76: The pending submission in FeedbackDialog can still update
state after the dialog has been dismissed, causing stale sent state to leak into
a later session. Add a submission/session guard in handleSubmit and
handleOpenChange so closing the dialog invalidates any in-flight request before
it resolves. Use a ref-based submission id in FeedbackDialog, increment it when
starting submit and again inside handleOpenChange(false), then only run the
success path (setFormState('sent') and the auto-close timeout) if the id still
matches.

In `@packages/web/src/server/functions/feedback.server.ts`:
- Around line 35-52: The rate-limit logic in feedback.server.ts is non-atomic
because the existing count() query and db.insert(feedback) run as separate
steps, so concurrent requests can both pass MAX_SUBMISSIONS_PER_HOUR. Update the
submit flow in the feedback server function to use an atomic per-user guard or
serialization approach around the recent submission check and insert, keeping
the existing symbols db, feedback, recentCount, MAX_SUBMISSIONS_PER_HOUR, and
throwDomainError in view while changing the implementation so only one
submission decision can happen at a time for a user.

---

Nitpick comments:
In `@packages/web/src/__tests__/server/migration-sql.js`:
- Around line 263-276: The feedback table and index changes look fine, but this
migration hunk also includes the unrelated
subscription_referenceId_incomplete_uidx partial index. Review the migration SQL
assembly in migration-sql.js and confirm whether that subscription index belongs
in the same migration as the feedback table; if not, move it to the correct
migration or separate hunk so the feedback schema change stays isolated.

In `@packages/web/src/server/functions/feedback.server.ts`:
- Around line 70-71: The contact email lookup in feedback.server.ts is using a
type-unsafe double cast on env, bypassing the Cloudflare Env typing. Update the
generated Env type to include CONTACT_EMAIL and then read it directly through
the feedback.server.ts logic in the contactEmail assignment, so the function
uses env.CONTACT_EMAIL with proper typing and keeps the fallback value.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8fd351e3-5ec7-4cdb-8cad-af03606d4b6b

📥 Commits

Reviewing files that changed from the base of the PR and between f0ed62a and 2141602.

📒 Files selected for processing (28)

packages/db/src/schema.ts
packages/shared/src/ids.ts
packages/web/migrations/0004_lying_frog_thor.sql
packages/web/migrations/meta/0004_snapshot.json
packages/web/migrations/meta/_journal.json
packages/web/src/__tests__/server/helpers.ts
packages/web/src/__tests__/server/migration-sql.js
packages/web/src/components/EarlyAccessBanner.tsx
packages/web/src/components/checklist/CreateLocalChecklist.tsx
packages/web/src/components/checklist/LocalChecklistView.tsx
packages/web/src/components/checklist/ROB2Checklist/ScoringSummary.tsx
packages/web/src/components/checklist/ROBINSIChecklist/ScoringSummary.tsx
packages/web/src/components/dashboard/ContactPrompt.tsx
packages/web/src/components/feedback/FeedbackDialog.tsx
packages/web/src/components/layout/AppNavbar.tsx
packages/web/src/components/project/CreateProjectModal.tsx
packages/web/src/components/project/overview-tab/AddMemberModal.tsx
packages/web/src/components/project/reconcile-tab/ReconciliationWrapper.tsx
packages/web/src/config/sentry.ts
packages/web/src/lib/analytics.ts
packages/web/src/lib/devPdfPool.ts
packages/web/src/project/actions.ts
packages/web/src/routes/__root.tsx
packages/web/src/server/functions/__tests__/feedback.server.test.ts
packages/web/src/server/functions/feedback.functions.ts
packages/web/src/server/functions/feedback.server.ts
packages/web/src/stores/feedbackStore.ts
packages/workers/src/lib/mock-templates.ts

💤 Files with no reviewable changes (2)

packages/web/src/components/checklist/ROB2Checklist/ScoringSummary.tsx
packages/web/src/components/checklist/ROBINSIChecklist/ScoringSummary.tsx

📜 Review details

⏰ Context from checks skipped due to timeout. (1)

GitHub Check: checks

🧰 Additional context used

📓 Path-based instructions (9)

**/*