Skip to content

Open source alternative to Semrush and Ahrefs

Start a rank check at once when a domain is added to rank tracking (EVE-258) (#656)

Carter Smith5adcfb66a729
diff --git a/src/client/features/rank-tracking/AddKeywordsPanel.tsx b/src/client/features/rank-tracking/AddKeywordsPanel.tsx
index 70817718..b3bf5fac 100644
--- a/src/client/features/rank-tracking/AddKeywordsPanel.tsx
+++ b/src/client/features/rank-tracking/AddKeywordsPanel.tsx
@@ -14,7 +14,11 @@ export function AddKeywordsPanel({
}: {
configId: string;
projectId: string;
- onSuccess: (result: { added: number; checkTriggered: boolean }) => void;
+ onSuccess: (result: {
+ added: number;
+ checkTriggered: boolean;
+ checkScheduledSoon: boolean;
+ }) => void;
onCancel: () => void;
}) {
const [keywordInput, setKeywordInput] = useState("");
diff --git a/src/client/features/rank-tracking/RankTrackingDomainDetail.tsx b/src/client/features/rank-tracking/RankTrackingDomainDetail.tsx
index 4e8b1eea..85c77585 100644
--- a/src/client/features/rank-tracking/RankTrackingDomainDetail.tsx
+++ b/src/client/features/rank-tracking/RankTrackingDomainDetail.tsx
@@ -127,6 +127,7 @@ export function RankTrackingDomainDetail({
const handleKeywordsAdded = (result: {
added: number;
checkTriggered: boolean;
+ checkScheduledSoon: boolean;
}) => {
void queryClient.invalidateQueries({
queryKey: ["rankTrackingCostEstimate", projectId, config.id],
@@ -142,7 +143,9 @@ export function RankTrackingDomainDetail({
toast.success(
`${result.added} keyword${result.added !== 1 ? "s" : ""} added`,
);
- if (!result.checkTriggered && result.added > 0) {
+ if (result.checkScheduledSoon) {
+ toast.info("The scheduled check within the hour covers these keywords");
+ } else if (!result.checkTriggered && result.added > 0) {
toast.info("Use 'Check Now' to check these keywords");
}
};
diff --git a/src/server/features/rank-tracking/services/RankTrackingService.test.ts b/src/server/features/rank-tracking/services/RankTrackingService.test.ts
index 95137b85..1927bd9d 100644
--- a/src/server/features/rank-tracking/services/RankTrackingService.test.ts
+++ b/src/server/features/rank-tracking/services/RankTrackingService.test.ts
@@ -8,12 +8,23 @@ const mocks = vi.hoisted(() => ({
getConfigsForProject: vi.fn(),
createConfig: vi.fn(),
updateConfig: vi.fn(),
+ getKeywordCountsForConfigs: vi.fn(),
+ getKeywordsForConfig: vi.fn(),
+ tryCreateRun: vi.fn(),
+ startWorkflow: vi.fn(),
+ isHosted: vi.fn(),
+ customerHasPaidPlan: vi.fn(),
}));
-vi.mock("cloudflare:workers", () => ({ env: {} }));
+vi.mock("cloudflare:workers", () => ({
+ env: { RANK_CHECK_WORKFLOW: { create: mocks.startWorkflow } },
+}));
vi.mock("@/server/lib/runtime-env", () => ({
getRequiredEnvValue: () => Promise.resolve("basic-key"),
- isHostedServerAuthMode: () => Promise.resolve(false),
+ isHostedServerAuthMode: mocks.isHosted,
+}));
+vi.mock("@/server/billing/subscription", () => ({
+ customerHasPaidPlan: mocks.customerHasPaidPlan,
}));
vi.mock("@/server/lib/dataforseo", () => ({ createDataforseoClient: vi.fn() }));
vi.mock(
@@ -290,3 +301,83 @@ describe("RankTrackingService.updateConfig schedule", () => {
expect(mocks.updateConfig).not.toHaveBeenCalled();
});
});
+
+const minutesFromNow = (minutes: number) =>
+ new Date(Date.now() + minutes * 60_000).toISOString();
+
+describe("RankTrackingService.triggerAutoCheck", () => {
+ const input = {
+ configId: "config_archived",
+ projectId: "project_1",
+ billingCustomer: {
+ userId: "user_1",
+ userEmail: "[email protected]",
+ organizationId: "org_1",
+ projectId: "project_1",
+ },
+ };
+
+ beforeEach(() => {
+ mocks.getKeywordCountsForConfigs.mockResolvedValue(
+ new Map([["config_archived", 2]]),
+ );
+ mocks.getKeywordsForConfig.mockResolvedValue([
+ { id: "kw_1" },
+ { id: "kw_2" },
+ ]);
+ mocks.tryCreateRun.mockResolvedValue(true);
+ mocks.isHosted.mockResolvedValue(false);
+ });
+
+ it("starts a check when the scheduled check is more than an hour away", async () => {
+ mocks.getConfigById.mockResolvedValue({
+ ...archivedConfig,
+ nextCheckAt: minutesFromNow(61),
+ });
+
+ await expect(
+ RankTrackingService.triggerAutoCheck(input),
+ ).resolves.toMatchObject({ ok: true });
+ expect(mocks.startWorkflow).toHaveBeenCalledTimes(1);
+ });
+
+ it("leaves the keywords to a scheduled check due within the hour", async () => {
+ mocks.getConfigById.mockResolvedValue({
+ ...archivedConfig,
+ nextCheckAt: minutesFromNow(59),
+ });
+
+ await expect(RankTrackingService.triggerAutoCheck(input)).resolves.toEqual({
+ ok: false,
+ reason: "scheduled_soon",
+ });
+ expect(mocks.startWorkflow).not.toHaveBeenCalled();
+ });
+
+ it("refuses a free plan before promising a scheduled check", async () => {
+ mocks.isHosted.mockResolvedValue(true);
+ mocks.customerHasPaidPlan.mockResolvedValue(false);
+ mocks.getConfigById.mockResolvedValue({
+ ...archivedConfig,
+ nextCheckAt: minutesFromNow(59),
+ });
+
+ await expect(
+ RankTrackingService.triggerAutoCheck(input),
+ ).rejects.toMatchObject({ code: "PAYMENT_REQUIRED" });
+ });
+
+ it("starts nothing for a domain without keywords", async () => {
+ mocks.getConfigById.mockResolvedValue({
+ ...archivedConfig,
+ nextCheckAt: null,
+ });
+ mocks.getKeywordCountsForConfigs.mockResolvedValue(new Map());
+
+ await expect(RankTrackingService.triggerAutoCheck(input)).resolves.toEqual({
+ ok: false,
+ reason: "no_keywords",
+ });
+ expect(mocks.startWorkflow).not.toHaveBeenCalled();
+ });
+});
diff --git a/src/server/features/rank-tracking/services/RankTrackingService.ts b/src/server/features/rank-tracking/services/RankTrackingService.ts
index 58e69338..8e39bd26 100644
--- a/src/server/features/rank-tracking/services/RankTrackingService.ts
+++ b/src/server/features/rank-tracking/services/RankTrackingService.ts
@@ -296,6 +296,39 @@ async function triggerCheck(input: {
});
}
+// A scheduled check this close covers the same keywords, so an automatic
+// check now would bill the customer twice within the hour.
+const AUTO_CHECK_SCHEDULE_WINDOW_MS = 60 * 60_000;
+
+// The check that follows adding a domain or keywords, as opposed to the user
+// pressing "Check Now" — so it yields to an imminent scheduled check.
+async function triggerAutoCheck(input: {
+ configId: string;
+ projectId: string;
+ billingCustomer: BillingCustomerContext;
+ keywordIds?: string[];
+}): Promise<
+ | RankCheckTriggerResult
+ | { ok: false; reason: "scheduled_soon" | "no_keywords" }
+> {
+ const config = await getValidatedConfig(input.configId, input.projectId);
+ const msUntilScheduled = config.nextCheckAt
+ ? new Date(config.nextCheckAt).getTime() - Date.now()
+ : Infinity;
+ if (msUntilScheduled <= AUTO_CHECK_SCHEDULE_WINDOW_MS) {
+ // A free plan must not be told to wait for a scheduled check that the
+ // scheduler will skip. The other path checks access in triggerCheck.
+ await requireRankCheckAccess(input.billingCustomer.organizationId);
+ return { ok: false, reason: "scheduled_soon" };
+ }
+ // A brand-new domain has no keywords yet; a re-added archived one keeps its.
+ const counts = await RankTrackingRepository.getKeywordCountsForConfigs([
+ config.id,
+ ]);
+ if (!counts.get(config.id)) return { ok: false, reason: "no_keywords" };
+ return triggerCheck(input);
+}
+
async function getLatestRun(configId: string, projectId: string) {
await getValidatedConfig(configId, projectId);
const run = await RankTrackingRepository.getLatestRunForConfig(configId);
@@ -457,6 +490,7 @@ export const RankTrackingService = {
addKeywords: RankTrackingKeywordService.addKeywords,
removeKeywords: RankTrackingKeywordService.removeKeywords,
triggerCheck,
+ triggerAutoCheck,
getLatestRun,
estimateCost: RankTrackingKeywordService.estimateCost,
refreshKeywordMetrics,
diff --git a/src/serverFunctions/rank-tracking.ts b/src/serverFunctions/rank-tracking.ts
index 3f0012b5..8574067a 100644
--- a/src/serverFunctions/rank-tracking.ts
+++ b/src/serverFunctions/rank-tracking.ts
@@ -86,6 +86,14 @@ export const createRankTrackingConfig = createServerFn({ method: "POST" })
scheduleTime: data.scheduleTime,
});
+ // Re-adding an archived domain keeps its keywords, and the keyword step
+ // then adds nothing new — so this is the only place its check can start.
+ await runAutoCheck({
+ configId: result.id,
+ projectId: context.projectId,
+ billingCustomer: context,
+ });
+
waitUntil(
captureServerEvent({
distinctId: context.userId,
@@ -186,6 +194,21 @@ function logAutoActionFailure(action: string, err: unknown) {
}
}
+async function runAutoCheck(
+ input: Parameters<typeof RankTrackingService.triggerAutoCheck>[0],
+) {
+ try {
+ const result = await RankTrackingService.triggerAutoCheck(input);
+ if (!result.ok && result.reason !== "no_keywords") {
+ console.info("[rank-tracking] auto-check skipped: %s", result.reason);
+ }
+ return result;
+ } catch (err) {
+ logAutoActionFailure("auto-check", err);
+ return null;
+ }
+}
+
export const addTrackingKeywords = createServerFn({ method: "POST" })
.middleware(requireProjectContext)
.validator(addKeywordsSchema)
@@ -198,26 +221,15 @@ export const addTrackingKeywords = createServerFn({ method: "POST" })
data.matchCase,
);
- let checkTriggered = false;
- if (result.addedIds.length > 0) {
- try {
- const triggerResult = await RankTrackingService.triggerCheck({
- configId: data.configId,
- projectId: context.projectId,
- billingCustomer: context,
- keywordIds: result.addedIds,
- });
- checkTriggered = triggerResult.ok;
- if (!triggerResult.ok) {
- console.info(
- "[rank-tracking] auto-check skipped: %s",
- triggerResult.reason,
- );
- }
- } catch (err) {
- logAutoActionFailure("auto-check", err);
- }
- }
+ const autoCheck =
+ result.addedIds.length > 0
+ ? await runAutoCheck({
+ configId: data.configId,
+ projectId: context.projectId,
+ billingCustomer: context,
+ keywordIds: result.addedIds,
+ })
+ : null;
// Fetch keyword metrics (awaited so they're in the DB before client re-fetches)
if (result.added > 0) {
@@ -232,7 +244,12 @@ export const addTrackingKeywords = createServerFn({ method: "POST" })
}
}
- return { ...result, checkTriggered };
+ return {
+ ...result,
+ checkTriggered: autoCheck?.ok ?? false,
+ checkScheduledSoon:
+ autoCheck?.ok === false && autoCheck.reason === "scheduled_soon",
+ };
});
export const removeTrackingKeywords = createServerFn({ method: "POST" })