Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions apps/web/src/app/(dashboard)/campaigns/schedule-campaign.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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<Campaign> & { id: string };
Expand Down Expand Up @@ -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");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 }> = ({
Expand All @@ -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");
Expand Down
6 changes: 6 additions & 0 deletions apps/web/src/components/FeedbackDialog.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down Expand Up @@ -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();
}
Expand Down
3 changes: 2 additions & 1 deletion apps/web/src/editor-dependencies.unit.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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]);
Expand Down
67 changes: 67 additions & 0 deletions apps/web/src/lib/star-nudge.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
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";

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 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(() => {
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved
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,
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);
}
147 changes: 147 additions & 0 deletions apps/web/src/lib/star-nudge.unit.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
import { describe, it, expect, beforeEach, vi, afterEach } from "vitest";
import {
isStarNudgeDismissed,
dismissStarNudge,
isFeedbackActive,
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<string, string> = {};
let sessionStorageMock: Record<string, string> = {};
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("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();

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");
});
});