Add offline reports

This commit is contained in:
Carlos Monastyrski
2025-09-01 18:50:54 -03:00
parent 01fba20872
commit 4063cf5294
12 changed files with 571 additions and 5 deletions
+15 -1
View File
@@ -8,9 +8,11 @@ import { adminQueryKeys, adminStandaloneKeys } from "./queries";
import {
RootKeyEncryptionStrategy,
TCreateAdminUserDTO,
TGenerateUsageReportDTO,
TInvalidateCacheDTO,
TServerConfig,
TUpdateServerConfigDTO
TUpdateServerConfigDTO,
TUsageReportResponse
} from "./types";
export const useCreateAdminUser = () => {
@@ -193,3 +195,15 @@ export const useInvalidateCache = () => {
}
});
};
export const useGenerateUsageReport = () => {
return useMutation<TUsageReportResponse, object, TGenerateUsageReportDTO>({
mutationFn: async (dto) => {
const { data } = await apiRequest.post<TUsageReportResponse>(
"/api/v1/admin/usage-report/generate",
dto
);
return data;
}
});
};
+11
View File
@@ -53,6 +53,7 @@ export type TServerConfig = {
fipsEnabled: boolean;
envOverrides?: Record<string, string>;
paramsFolderSecretDetectionEnabled: boolean;
isOfflineUsageReportsEnabled: boolean;
};
export type TUpdateServerConfigDTO = {
@@ -142,3 +143,13 @@ export interface TGetEnvOverrides {
fields: { key: string; value: string; hasEnvEntry: boolean; description?: string }[];
};
}
export type TGenerateUsageReportDTO = {
periodDays?: number;
};
export type TUsageReportResponse = {
filename: string;
csvContent: string;
signature: string;
};
@@ -2,11 +2,13 @@ import { Helmet } from "react-helmet";
import { useTranslation } from "react-i18next";
import { PageHeader } from "@app/components/v2";
import { useGetServerConfig } from "@app/hooks/api/admin";
import { GeneralPageForm } from "./components";
import { GeneralPageForm, UsageReportSection } from "./components";
export const GeneralPage = () => {
const { t } = useTranslation();
const { data: serverConfig } = useGetServerConfig();
return (
<div className="h-full bg-bunker-800">
@@ -19,7 +21,10 @@ export const GeneralPage = () => {
title="General"
description="Manage general settings for your Infisical instance."
/>
<GeneralPageForm />
<div className="space-y-6">
<GeneralPageForm />
{serverConfig?.isOfflineUsageReportsEnabled && <UsageReportSection />}
</div>
</div>
</div>
</div>
@@ -0,0 +1,89 @@
import { useState } from "react";
import { useForm } from "react-hook-form";
import { faDownload, faFileAlt, faSpinner } from "@fortawesome/free-solid-svg-icons";
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
import { zodResolver } from "@hookform/resolvers/zod";
import { z } from "zod";
import { createNotification } from "@app/components/notifications";
import { Button, Card, CardTitle } from "@app/components/v2";
import { apiRequest } from "@app/config/request";
const formSchema = z.object({});
type TUsageReportForm = z.infer<typeof formSchema>;
export const UsageReportSection = () => {
const [isGenerating, setIsGenerating] = useState(false);
const {
handleSubmit,
formState: { isSubmitting }
} = useForm<TUsageReportForm>({
resolver: zodResolver(formSchema)
});
const downloadFile = (content: string, filename: string, mimeType: string = "text/csv") => {
const blob = new Blob([content], { type: mimeType });
const url = window.URL.createObjectURL(blob);
const link = document.createElement("a");
link.href = url;
link.download = filename;
document.body.appendChild(link);
link.click();
document.body.removeChild(link);
window.URL.revokeObjectURL(url);
};
const onSubmit = async () => {
try {
setIsGenerating(true);
const response = await apiRequest.post("/api/v1/admin/usage-report/generate", {});
const { csvContent, filename } = response.data;
downloadFile(csvContent, filename, "text/csv");
createNotification({
text: `Usage report downloaded: "${filename}"`,
type: "success"
});
} catch (error) {
console.error("Failed to generate usage report:", error);
createNotification({
text: "Failed to generate usage report. Please try again.",
type: "error"
});
} finally {
setIsGenerating(false);
}
};
const isLoading = isSubmitting || isGenerating;
return (
<Card className="p-6">
<CardTitle className="mb-4 flex items-center gap-3">
<FontAwesomeIcon icon={faFileAlt} />
Offline Usage Reports
</CardTitle>
<div className="mb-4 text-sm text-gray-400">
Generate tamper-proof, cryptographically signed usage reports to ensure offline license
compliance and accurate billing verification. Reports capture user counts, machine
identities, project details, and secrets metadata, providing a secure and verifiable audit
trail.
</div>
<form onSubmit={handleSubmit(onSubmit)} className="space-y-4">
<Button
type="submit"
isLoading={isLoading}
leftIcon={<FontAwesomeIcon icon={isLoading ? faSpinner : faDownload} />}
>
{isLoading ? "Generating..." : "Generate Report"}
</Button>
</form>
</Card>
);
};
@@ -1 +1,2 @@
export { GeneralPageForm } from "./GeneralPageForm";
export { UsageReportSection } from "./UsageReportSection";