Merge branch 'main' into brendan/decouple-offline-anonymous-access

Author: brendan-kellam

CHANGELOG.md

@@ -8,7 +8,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Changed
-- [EE] Decoupled offline-license anonymous access from the seat cap. Anonymous access is now controlled by an explicit `anonymousAccess` field on the license key instead of being implied by an unlimited (uncapped) seat count. [#1349](https://github.com/sourcebot-dev/sourcebot/pull/1349)
+- Decoupled offline-license anonymous access from the seat cap. [#1349](https://github.com/sourcebot-dev/sourcebot/pull/1349)
+
+### Added
+- Recorded service ping history locally and added a "Download usage report" button to the offline license settings page, so offline deployments can export their usage and send it to us. [#1348](https://github.com/sourcebot-dev/sourcebot/pull/1348)
 
 ### Fixed
 - Upgraded `@grpc/grpc-js` to `^1.14.4`. [#1315](https://github.com/sourcebot-dev/sourcebot/pull/1315)

packages/db/prisma/migrations/20260618210032_add_service_ping_event_table/migration.sql

@@ -0,0 +1,12 @@
+-- CreateTable
+CREATE TABLE "ServicePingEvent" (
+    "id" TEXT NOT NULL,
+    "payload" JSONB NOT NULL,
+    "createdAt" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "orgId" INTEGER NOT NULL,
+
+    CONSTRAINT "ServicePingEvent_pkey" PRIMARY KEY ("id")
+);
+
+-- AddForeignKey
+ALTER TABLE "ServicePingEvent" ADD CONSTRAINT "ServicePingEvent_orgId_fkey" FOREIGN KEY ("orgId") REFERENCES "Org"("id") ON DELETE CASCADE ON UPDATE CASCADE;

packages/db/prisma/schema.prisma

@@ -318,6 +318,7 @@ model Org {
   mcpServers McpServer[]
 
   license License?
+  servicePingEvents ServicePingEvent[]
 }
 
 model License {
@@ -358,6 +359,15 @@ model License {
   updatedAt         DateTime @updatedAt
 }
 
+model ServicePingEvent {
+  id String @id @default(cuid())
+  payload Json
+  createdAt DateTime @default(now())
+
+  org   Org @relation(fields: [orgId], references: [id], onDelete: Cascade)
+  orgId Int
+}
+
 enum OrgRole {
   OWNER
   MEMBER

packages/shared/src/entitlements.ts

@@ -128,10 +128,18 @@ const getValidOnlineLicense = (_license: License | null): License | null => {
     return null;
 }
 
+export const isValidOfflineLicenseActive = (): boolean => {
+    return getValidOfflineLicense() !== null;
+}
+
+export const isValidOnlineLicenseActive = (_license: License | null): boolean => {
+    return getValidOnlineLicense(_license) !== null;
+}
+
 export const isValidLicenseActive = (_license: License | null): boolean => {
     return (
-        getValidOfflineLicense() !== null ||
-        getValidOnlineLicense(_license) !== null
+        isValidOfflineLicenseActive() ||
+        isValidOnlineLicenseActive(_license)
     );
 }
 

packages/shared/src/index.server.ts

@@ -6,6 +6,8 @@ export {
     getEntitlements as _getEntitlements,
     isAnonymousAccessAvailable as _isAnonymousAccessAvailable,
     isValidLicenseActive as _isValidLicenseActive,
+    isValidOfflineLicenseActive,
+    isValidOnlineLicenseActive as _isValidOnlineLicenseActive,
     getSeatCap,
     getOfflineLicenseMetadata,
     STALE_ONLINE_LICENSE_THRESHOLD_MS,

packages/web/src/app/(app)/settings/license/actions.ts

@@ -0,0 +1,30 @@
+'use server';
+
+import { sew } from "@/middleware/sew";
+import { withAuth } from "@/middleware/withAuth";
+import { withMinimumOrgRole } from "@/middleware/withMinimumOrgRole";
+import { OrgRole } from "@sourcebot/db";
+import { ServiceError } from "@/lib/serviceError";
+
+export interface ServicePingHistoryEntry {
+    createdAt: string;
+    payload: unknown;
+}
+
+// Returns the recorded Service Ping history so offline deployments can export
+// it and send it back to us out-of-band (they can't reach Lighthouse directly).
+export const getServicePingHistory = async (): Promise<ServicePingHistoryEntry[] | ServiceError> => sew(() =>
+    withAuth(async ({ org, role, prisma }) =>
+        withMinimumOrgRole(role, OrgRole.OWNER, async () => {
+            const events = await prisma.servicePingEvent.findMany({
+                where: { orgId: org.id },
+                orderBy: { createdAt: 'asc' },
+            });
+
+            return events.map((event) => ({
+                createdAt: event.createdAt.toISOString(),
+                payload: event.payload,
+            }));
+        })
+    )
+);

packages/web/src/app/(app)/settings/license/downloadServicePingHistoryButton.tsx

@@ -0,0 +1,61 @@
+'use client';
+
+import { useCallback, useState } from "react";
+import { Download } from "lucide-react";
+import { LoadingButton } from "@/components/ui/loading-button";
+import { useToast } from "@/components/hooks/use-toast";
+import { isServiceError } from "@/lib/utils";
+import { getServicePingHistory } from "./actions";
+
+export function DownloadServicePingHistoryButton() {
+    const [isLoading, setIsLoading] = useState(false);
+    const { toast } = useToast();
+
+    const handleDownload = useCallback(async () => {
+        setIsLoading(true);
+        try {
+            const result = await getServicePingHistory();
+
+            if (isServiceError(result)) {
+                toast({
+                    description: "Failed to export service ping history. Please try again.",
+                    variant: "destructive",
+                });
+                return;
+            }
+
+            if (result.length === 0) {
+                toast({
+                    description: "No service ping history has been recorded yet.",
+                });
+                return;
+            }
+
+            const blob = new Blob([JSON.stringify(result, null, 2)], {
+                type: "application/json",
+            });
+            const url = URL.createObjectURL(blob);
+            const anchor = document.createElement("a");
+            anchor.href = url;
+            anchor.download = `${new Date().toISOString().slice(0, 10)}-usage-history.json`;
+            document.body.appendChild(anchor);
+            anchor.click();
+            document.body.removeChild(anchor);
+            URL.revokeObjectURL(url);
+        } finally {
+            setIsLoading(false);
+        }
+    }, [toast]);
+
+    return (
+        <LoadingButton
+            variant="outline"
+            size="sm"
+            onClick={handleDownload}
+            loading={isLoading}
+        >
+            {!isLoading && <Download className="h-3.5 w-3.5" />}
+            Download usage report
+        </LoadingButton>
+    );
+}

packages/web/src/app/(app)/settings/license/offlineLicenseCard.tsx

@@ -1,6 +1,7 @@
 import type { OfflineLicenseMetadata } from "@sourcebot/shared";
 import { Badge } from "@/components/ui/badge";
 import { SettingsCard } from "../components/settingsCard";
+import { DownloadServicePingHistoryButton } from "./downloadServicePingHistoryButton";
 
 interface OfflineLicenseCardProps {
     license: OfflineLicenseMetadata;
@@ -15,34 +16,47 @@ export function OfflineLicenseCard({ license, isExpired }: OfflineLicenseCardPro
 
     return (
         <SettingsCard>
-            <div className="flex items-center justify-between gap-6">
-                <div className="flex flex-col gap-1">
-                    <div className="flex items-center gap-2">
-                        <p className="font-medium">Enterprise plan</p>
-                        {isExpired && (
-                            <Badge variant="outline" className="border-destructive/30 text-destructive">
-                                Expired
-                            </Badge>
-                        )}
-                    </div>
-                    <div className="flex items-center gap-2 text-xs text-muted-foreground mt-0.5">
-                        <code className="font-mono">{truncatedId}</code>
+            <div className="flex flex-col gap-4">
+                <div className="flex items-center justify-between gap-6">
+                    <div className="flex flex-col gap-1">
+                        <div className="flex items-center gap-2">
+                            <p className="font-medium">Enterprise plan</p>
+                            {isExpired && (
+                                <Badge variant="outline" className="border-destructive/30 text-destructive">
+                                    Expired
+                                </Badge>
+                            )}
+                        </div>
+                        <div className="flex items-center gap-2 text-xs text-muted-foreground mt-0.5">
+                            <code className="font-mono">{truncatedId}</code>
+                        </div>
                     </div>
-                </div>
-                <div className="flex items-center gap-12">
-                    {license.seats !== undefined && (
+                    <div className="flex items-center gap-12">
+                        {license.seats !== undefined && (
+                            <div className="flex flex-col items-end">
+                                <p className="text-xs text-muted-foreground">Billed seats</p>
+                                <p className="text-sm">{license.seats}</p>
+                            </div>
+                        )}
                         <div className="flex flex-col items-end">
-                            <p className="text-xs text-muted-foreground">Billed seats</p>
-                            <p className="text-sm">{license.seats}</p>
+                            <p className="text-xs text-muted-foreground">
+                                {isExpired ? "Expired on" : "Expires on"}
+                            </p>
+                            <p className="text-sm">{formatDate(expiryDate)}</p>
                         </div>
-                    )}
-                    <div className="flex flex-col items-end">
-                        <p className="text-xs text-muted-foreground">
-                            {isExpired ? "Expired on" : "Expires on"}
-                        </p>
-                        <p className="text-sm">{formatDate(expiryDate)}</p>
                     </div>
                 </div>
+                <div className="flex items-center justify-between gap-6 border-t border-border pt-4">
+                    <p className="text-xs text-muted-foreground">
+                        Your instance doesn&apos;t report usage automatically. Usage data must be
+                        manually sent to{" "}
+                        <a href="mailto:ar@sourcebot.dev" className="text-primary hover:underline">
+                            ar@sourcebot.dev
+                        </a>
+                        .
+                    </p>
+                    <DownloadServicePingHistoryButton />
+                </div>
             </div>
         </SettingsCard>
     );

packages/web/src/features/billing/servicePing.ts

@@ -2,7 +2,13 @@ import { existsSync } from "fs";
 import { SINGLE_TENANT_ORG_ID } from "@/lib/constants";
 import { isServiceError } from "@/lib/utils";
 import { __unsafePrisma } from "@/prisma";
-import { createLogger, decryptActivationCode, env, SOURCEBOT_VERSION } from "@sourcebot/shared";
+import {
+    createLogger,
+    decryptActivationCode,
+    env,
+    SOURCEBOT_VERSION,
+    isValidOfflineLicenseActive
+} from "@sourcebot/shared";
 import { client } from "./client";
 import { ServicePingRequest } from "./types";
 import { ServiceErrorException } from "@/lib/serviceError";
@@ -83,6 +89,13 @@ export const syncWithLighthouse = async (orgId: number) => {
         ...(activationCode && { activationCode }),
     };
 
+    await recordServicePingInDB(orgId, payload);
+
+    if (isValidOfflineLicenseActive()) {
+        logger.debug('Skipping service ping: active offline license detected.');
+        return;
+    }
+
     const response = await client.ping(payload);
     if (isServiceError(response)) {
         logger.error(`Service ping failed:\n ${JSON.stringify(response, null, 2)}`)
@@ -172,3 +185,21 @@ const inferDeploymentType = (): string => {
     }
     return 'other';
 };
+
+const recordServicePingInDB = async (orgId: number, payload: ServicePingRequest) => {
+    // Strip the activation code before persisting.
+    const { activationCode: _activationCode, ...sanitizedPayload } = payload;
+
+    try {
+        await __unsafePrisma.servicePingEvent.create({
+            data: {
+                orgId,
+                payload: sanitizedPayload,
+            },
+        });
+    } catch (error) {
+        // Recording the ping is best-effort: a failure here must not prevent
+        // the actual ping from being sent to Lighthouse.
+        logger.error(`Failed to record service ping in database:\n ${error}`);
+    }
+};