From 088c9ff7876e230aa20be3d494e960a16b63f20f Mon Sep 17 00:00:00 2001 From: Siddharth474 Date: Thu, 19 Nov 2026 23:46:38 +0530 Subject: [PATCH 1/2] feat(web): add dismissible in-app GitHub star nudge after successful actions --- .../campaigns/schedule-campaign.tsx | 2 + .../domains/[domainId]/send-test-mail.tsx | 2 + apps/web/src/components/FeedbackDialog.tsx | 6 + apps/web/src/editor-dependencies.unit.test.ts | 3 +- apps/web/src/lib/star-nudge.ts | 66 +++++++++ apps/web/src/lib/star-nudge.unit.test.ts | 127 ++++++++++++++++++ 6 files changed, 205 insertions(+), 1 deletion(-) create mode 100644 apps/web/src/lib/star-nudge.ts create mode 100644 apps/web/src/lib/star-nudge.unit.test.ts diff --git a/apps/web/src/app/(dashboard)/campaigns/schedule-campaign.tsx b/apps/web/src/app/(dashboard)/campaigns/schedule-campaign.tsx index 3d34980d8..48918353f 100644 --- a/apps/web/src/app/(dashboard)/campaigns/schedule-campaign.tsx +++ b/apps/web/src/app/(dashboard)/campaigns/schedule-campaign.tsx @@ -23,6 +23,7 @@ import { Calendar } from "@usesend/ui/src/calendar"; import { Campaign } from "@prisma/client"; import { format } from "date-fns"; import { Spinner } from "@usesend/ui/src/spinner"; +import { triggerStarNudge } from "~/lib/star-nudge"; export const ScheduleCampaign: React.FC<{ campaign: Partial & { id: string }; @@ -82,6 +83,7 @@ export const ScheduleCampaign: React.FC<{ setError(null); toast.success("Campaign scheduled"); onScheduled?.(); + triggerStarNudge(); }, onError: (error) => { setError(error.message || "Failed to schedule campaign"); diff --git a/apps/web/src/app/(dashboard)/domains/[domainId]/send-test-mail.tsx b/apps/web/src/app/(dashboard)/domains/[domainId]/send-test-mail.tsx index 4fb1a3657..0c14a0754 100644 --- a/apps/web/src/app/(dashboard)/domains/[domainId]/send-test-mail.tsx +++ b/apps/web/src/app/(dashboard)/domains/[domainId]/send-test-mail.tsx @@ -6,6 +6,7 @@ import React from "react"; import { toast } from "@usesend/ui/src/toaster"; import { SendHorizonal } from "lucide-react"; import type { DomainWithDnsRecords } from "~/types/domain"; +import { triggerStarNudge } from "~/lib/star-nudge"; // Removed dialog and example code. Clicking the button now sends the email directly. export const SendTestMail: React.FC<{ domain: DomainWithDnsRecords }> = ({ @@ -25,6 +26,7 @@ export const SendTestMail: React.FC<{ domain: DomainWithDnsRecords }> = ({ onSuccess: () => { utils.domain.domains.invalidate(); toast.success(`Test email sent`); + triggerStarNudge(); }, onError: (err) => { toast.error(err.message || "Failed to send test email"); diff --git a/apps/web/src/components/FeedbackDialog.tsx b/apps/web/src/components/FeedbackDialog.tsx index a2b31c9a8..fb2700901 100644 --- a/apps/web/src/components/FeedbackDialog.tsx +++ b/apps/web/src/components/FeedbackDialog.tsx @@ -32,6 +32,7 @@ import { useForm } from "react-hook-form"; import { z } from "zod"; import { api } from "~/trpc/react"; +import { FEEDBACK_ACTIVE_SESSION_KEY } from "~/lib/star-nudge"; const FeedbackSchema = z.object({ message: z.string().trim().min(1, "Feedback is required").max(2000), @@ -73,6 +74,11 @@ export function FeedbackDialog({ trigger }: { trigger?: ReactNode }) { function handleOpenChange(nextOpen: boolean) { setOpen(nextOpen); + if (nextOpen && typeof window !== "undefined") { + try { + sessionStorage.setItem(FEEDBACK_ACTIVE_SESSION_KEY, "true"); + } catch {} + } if (!nextOpen) { form.reset(); } diff --git a/apps/web/src/editor-dependencies.unit.test.ts b/apps/web/src/editor-dependencies.unit.test.ts index 2c79c382b..9fb3fd04a 100644 --- a/apps/web/src/editor-dependencies.unit.test.ts +++ b/apps/web/src/editor-dependencies.unit.test.ts @@ -15,7 +15,8 @@ import { describe, expect, it } from "vitest"; const SINGLE_COPY = ["prosemirror-model", "prosemirror-state", "prosemirror-transform", "prosemirror-view"]; function lockfileVersions(lockfile: string, name: string) { - const packages = lockfile.slice(lockfile.indexOf("\npackages:\n"), lockfile.indexOf("\nsnapshots:\n")); + const normalized = lockfile.replace(/\r\n/g, "\n"); + const packages = normalized.slice(normalized.indexOf("\npackages:\n"), normalized.indexOf("\nsnapshots:\n")); const escaped = name.replace(/[.*+?^${}()|[\]\\/]/g, "\\$&"); const pattern = new RegExp(`^ '?${escaped}@([^:'(]+)'?:`, "gm"); return [...packages.matchAll(pattern)].map((match) => match[1]); diff --git a/apps/web/src/lib/star-nudge.ts b/apps/web/src/lib/star-nudge.ts new file mode 100644 index 000000000..22fe0e992 --- /dev/null +++ b/apps/web/src/lib/star-nudge.ts @@ -0,0 +1,66 @@ +import { toast } from "@usesend/ui/src/toaster"; + +export const STAR_NUDGE_STORAGE_KEY = "usesend:star-nudge-dismissed"; +export const FEEDBACK_ACTIVE_SESSION_KEY = "usesend:feedback-active"; +export const GITHUB_REPO_URL = "https://github.com/usesend/usesend"; + +export function isStarNudgeDismissed(): boolean { + if (typeof window === "undefined") return true; + try { + return localStorage.getItem(STAR_NUDGE_STORAGE_KEY) === "true"; + } catch { + return true; + } +} + +export function dismissStarNudge(): void { + if (typeof window === "undefined") return; + try { + localStorage.setItem(STAR_NUDGE_STORAGE_KEY, "true"); + } catch { + // Graceful fallback for restricted storage environments + } +} + +export function triggerStarNudge(delayMs = 1500): void { + if (isStarNudgeDismissed()) return; + + if (typeof window !== "undefined") { + try { + if (sessionStorage.getItem(FEEDBACK_ACTIVE_SESSION_KEY) === "true") { + return; + } + } catch { + // Ignore sessionStorage errors + } + } + + window.setTimeout(() => { + if (isStarNudgeDismissed()) return; + + toast("Enjoying useSend?", { + description: + "It's open source — a star on GitHub helps others find it! ⭐", + duration: 10000, + action: { + label: "Star on GitHub", + onClick: () => { + dismissStarNudge(); + window.open(GITHUB_REPO_URL, "_blank", "noopener,noreferrer"); + }, + }, + cancel: { + label: "Not now", + onClick: () => { + dismissStarNudge(); + }, + }, + onDismiss: () => { + dismissStarNudge(); + }, + onAutoClose: () => { + dismissStarNudge(); + }, + }); + }, delayMs); +} diff --git a/apps/web/src/lib/star-nudge.unit.test.ts b/apps/web/src/lib/star-nudge.unit.test.ts new file mode 100644 index 000000000..19fe0fec6 --- /dev/null +++ b/apps/web/src/lib/star-nudge.unit.test.ts @@ -0,0 +1,127 @@ +import { describe, it, expect, beforeEach, vi, afterEach } from "vitest"; +import { + isStarNudgeDismissed, + dismissStarNudge, + triggerStarNudge, + STAR_NUDGE_STORAGE_KEY, + FEEDBACK_ACTIVE_SESSION_KEY, + GITHUB_REPO_URL, +} from "./star-nudge"; +import { toast } from "@usesend/ui/src/toaster"; + +vi.mock("@usesend/ui/src/toaster", () => ({ + toast: vi.fn(), +})); + +describe("star-nudge utility", () => { + let localStorageMock: Record = {}; + let sessionStorageMock: Record = {}; + let windowOpenSpy = vi.fn(); + + beforeEach(() => { + localStorageMock = {}; + sessionStorageMock = {}; + windowOpenSpy = vi.fn(); + + vi.useFakeTimers(); + + vi.stubGlobal("localStorage", { + getItem: vi.fn((key: string) => localStorageMock[key] ?? null), + setItem: vi.fn((key: string, value: string) => { + localStorageMock[key] = value; + }), + removeItem: vi.fn((key: string) => { + delete localStorageMock[key]; + }), + }); + + vi.stubGlobal("sessionStorage", { + getItem: vi.fn((key: string) => sessionStorageMock[key] ?? null), + setItem: vi.fn((key: string, value: string) => { + sessionStorageMock[key] = value; + }), + removeItem: vi.fn((key: string) => { + delete sessionStorageMock[key]; + }), + }); + + vi.stubGlobal("window", { + open: windowOpenSpy, + setTimeout: (fn: () => void, ms?: number) => setTimeout(fn, ms), + clearTimeout: (id: any) => clearTimeout(id), + }); + + vi.clearAllMocks(); + }); + + afterEach(() => { + vi.useRealTimers(); + vi.unstubAllGlobals(); + }); + + it("returns false for isStarNudgeDismissed when storage is empty", () => { + expect(isStarNudgeDismissed()).toBe(false); + }); + + it("returns true for isStarNudgeDismissed when already marked dismissed", () => { + localStorageMock[STAR_NUDGE_STORAGE_KEY] = "true"; + expect(isStarNudgeDismissed()).toBe(true); + }); + + it("dismissStarNudge writes true to localStorage", () => { + dismissStarNudge(); + expect(localStorageMock[STAR_NUDGE_STORAGE_KEY]).toBe("true"); + expect(isStarNudgeDismissed()).toBe(true); + }); + + it("triggerStarNudge does not trigger toast if already dismissed", () => { + localStorageMock[STAR_NUDGE_STORAGE_KEY] = "true"; + + triggerStarNudge(500); + vi.advanceTimersByTime(600); + + expect(toast).not.toHaveBeenCalled(); + }); + + it("triggerStarNudge does not trigger toast if feedback is active in session", () => { + sessionStorageMock[FEEDBACK_ACTIVE_SESSION_KEY] = "true"; + + triggerStarNudge(500); + vi.advanceTimersByTime(600); + + expect(toast).not.toHaveBeenCalled(); + }); + + it("triggerStarNudge shows toast after specified delay when eligible", () => { + triggerStarNudge(1000); + expect(toast).not.toHaveBeenCalled(); + + vi.advanceTimersByTime(1000); + expect(toast).toHaveBeenCalledTimes(1); + + const toastCall = (toast as any).mock.calls[0]; + expect(toastCall[0]).toBe("Enjoying useSend?"); + expect(toastCall[1]).toMatchObject({ + action: expect.objectContaining({ label: "Star on GitHub" }), + cancel: expect.objectContaining({ label: "Not now" }), + }); + + // Test clicking Star on GitHub action + toastCall[1].action.onClick(); + expect(windowOpenSpy).toHaveBeenCalledWith( + GITHUB_REPO_URL, + "_blank", + "noopener,noreferrer" + ); + expect(localStorageMock[STAR_NUDGE_STORAGE_KEY]).toBe("true"); + }); + + it("clicking cancel in toast marks nudge dismissed", () => { + triggerStarNudge(500); + vi.advanceTimersByTime(500); + + const toastCall = (toast as any).mock.calls[0]; + toastCall[1].cancel.onClick(); + expect(localStorageMock[STAR_NUDGE_STORAGE_KEY]).toBe("true"); + }); +}); From 6dde4916b8563492b2436f2a66b0f529a78cc52a Mon Sep 17 00:00:00 2001 From: Siddharth474 Date: Fri, 20 Nov 2026 01:06:05 +0530 Subject: [PATCH 2/2] fix(web): recheck feedback session eligibility before showing star toast --- apps/web/src/lib/star-nudge.ts | 25 ++++++++++++------------ apps/web/src/lib/star-nudge.unit.test.ts | 20 +++++++++++++++++++ 2 files changed, 33 insertions(+), 12 deletions(-) diff --git a/apps/web/src/lib/star-nudge.ts b/apps/web/src/lib/star-nudge.ts index 22fe0e992..b04bfdb3e 100644 --- a/apps/web/src/lib/star-nudge.ts +++ b/apps/web/src/lib/star-nudge.ts @@ -1,6 +1,7 @@ import { toast } from "@usesend/ui/src/toaster"; export const STAR_NUDGE_STORAGE_KEY = "usesend:star-nudge-dismissed"; +const STAR_NUDGE_TOAST_ID = "usesend-star-nudge"; export const FEEDBACK_ACTIVE_SESSION_KEY = "usesend:feedback-active"; export const GITHUB_REPO_URL = "https://github.com/usesend/usesend"; @@ -22,23 +23,23 @@ export function dismissStarNudge(): void { } } -export function triggerStarNudge(delayMs = 1500): void { - if (isStarNudgeDismissed()) return; - - if (typeof window !== "undefined") { - try { - if (sessionStorage.getItem(FEEDBACK_ACTIVE_SESSION_KEY) === "true") { - return; - } - } catch { - // Ignore sessionStorage errors - } +export function isFeedbackActive(): boolean { + if (typeof window === "undefined") return false; + try { + return sessionStorage.getItem(FEEDBACK_ACTIVE_SESSION_KEY) === "true"; + } catch { + return false; } +} + +export function triggerStarNudge(delayMs = 1500): void { + if (isStarNudgeDismissed() || isFeedbackActive()) return; window.setTimeout(() => { - if (isStarNudgeDismissed()) return; + if (isStarNudgeDismissed() || isFeedbackActive()) return; toast("Enjoying useSend?", { + id: STAR_NUDGE_TOAST_ID, description: "It's open source — a star on GitHub helps others find it! ⭐", duration: 10000, diff --git a/apps/web/src/lib/star-nudge.unit.test.ts b/apps/web/src/lib/star-nudge.unit.test.ts index 19fe0fec6..76b470617 100644 --- a/apps/web/src/lib/star-nudge.unit.test.ts +++ b/apps/web/src/lib/star-nudge.unit.test.ts @@ -2,6 +2,7 @@ import { describe, it, expect, beforeEach, vi, afterEach } from "vitest"; import { isStarNudgeDismissed, dismissStarNudge, + isFeedbackActive, triggerStarNudge, STAR_NUDGE_STORAGE_KEY, FEEDBACK_ACTIVE_SESSION_KEY, @@ -92,6 +93,25 @@ describe("star-nudge utility", () => { expect(toast).not.toHaveBeenCalled(); }); + it("isFeedbackActive returns false by default and true when flagged", () => { + expect(isFeedbackActive()).toBe(false); + sessionStorageMock[FEEDBACK_ACTIVE_SESSION_KEY] = "true"; + expect(isFeedbackActive()).toBe(true); + }); + + it("triggerStarNudge does not trigger toast if feedback opens during the delay", () => { + triggerStarNudge(1000); + + // Feedback opens at 400ms, while timer is pending + vi.advanceTimersByTime(400); + sessionStorageMock[FEEDBACK_ACTIVE_SESSION_KEY] = "true"; + + // Advance past the remaining time + vi.advanceTimersByTime(700); + + expect(toast).not.toHaveBeenCalled(); + }); + it("triggerStarNudge shows toast after specified delay when eligible", () => { triggerStarNudge(1000); expect(toast).not.toHaveBeenCalled();