mirror of https://github.com/buster-so/buster.git
Add download functionality for metric files and enhance UI warning component
- Introduced a new API method to download metric files. - Updated MetricDataTruncatedWarning component to include a download button for large datasets. - Passed metricId as a prop to MetricDataTruncatedWarning for download functionality. - Improved user experience by providing feedback during the download process.
This commit is contained in:
parent
e5481bc30a
commit
c3107e1113
|
@ -14,11 +14,12 @@ import type {
|
||||||
MetricDataResponse,
|
MetricDataResponse,
|
||||||
GetMetricResponse,
|
GetMetricResponse,
|
||||||
UpdateMetricResponse,
|
UpdateMetricResponse,
|
||||||
ShareUpdateResponse
|
ShareUpdateResponse,
|
||||||
|
MetricDownloadResponse
|
||||||
} from '@buster/server-shared/metrics';
|
} from '@buster/server-shared/metrics';
|
||||||
import type { ShareDeleteRequest, ShareUpdateRequest } from '@buster/server-shared/share';
|
import type { ShareDeleteRequest, ShareUpdateRequest } from '@buster/server-shared/share';
|
||||||
import { serverFetch } from '@/api/createServerInstance';
|
import { serverFetch } from '@/api/createServerInstance';
|
||||||
import { mainApi } from '../instances';
|
import { mainApi, mainApiV2 } from '../instances';
|
||||||
import { SharePostRequest } from '@buster/server-shared/share';
|
import { SharePostRequest } from '@buster/server-shared/share';
|
||||||
|
|
||||||
export const getMetric = async (params: GetMetricRequest): Promise<GetMetricResponse> => {
|
export const getMetric = async (params: GetMetricRequest): Promise<GetMetricResponse> => {
|
||||||
|
@ -104,3 +105,10 @@ export const updateMetricShare = async ({
|
||||||
.put<ShareUpdateResponse>(`/metric_files/${id}/sharing`, params)
|
.put<ShareUpdateResponse>(`/metric_files/${id}/sharing`, params)
|
||||||
.then((res) => res.data);
|
.then((res) => res.data);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// Download metric file
|
||||||
|
export const downloadMetricFile = async (id: string): Promise<MetricDownloadResponse> => {
|
||||||
|
return mainApiV2
|
||||||
|
.get<MetricDownloadResponse>(`/metric_files/${id}/download`)
|
||||||
|
.then((res) => res.data);
|
||||||
|
};
|
||||||
|
|
|
@ -1,21 +1,61 @@
|
||||||
import React from 'react';
|
import React, { useState } from 'react';
|
||||||
import { Text } from '@/components/ui/typography';
|
import { Text } from '@/components/ui/typography';
|
||||||
|
import { Button } from '@/components/ui/buttons';
|
||||||
|
import { Download4 } from '@/components/ui/icons';
|
||||||
import { cn } from '@/lib/classMerge';
|
import { cn } from '@/lib/classMerge';
|
||||||
|
import { downloadMetricFile } from '@/api/buster_rest/metrics/requests';
|
||||||
|
|
||||||
interface MetricDataTruncatedWarningProps {
|
interface MetricDataTruncatedWarningProps {
|
||||||
className?: string;
|
className?: string;
|
||||||
|
metricId: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export const MetricDataTruncatedWarning: React.FC<MetricDataTruncatedWarningProps> = ({
|
export const MetricDataTruncatedWarning: React.FC<MetricDataTruncatedWarningProps> = ({
|
||||||
className
|
className,
|
||||||
|
metricId
|
||||||
}) => {
|
}) => {
|
||||||
|
const [isDownloading, setIsDownloading] = useState(false);
|
||||||
|
|
||||||
|
const handleDownload = async () => {
|
||||||
|
try {
|
||||||
|
setIsDownloading(true);
|
||||||
|
|
||||||
|
// Call the API to get the download URL
|
||||||
|
const response = await downloadMetricFile(metricId);
|
||||||
|
|
||||||
|
// Simply navigate to the download URL
|
||||||
|
// The response-content-disposition header will force a download
|
||||||
|
window.location.href = response.downloadUrl;
|
||||||
|
|
||||||
|
} catch (error) {
|
||||||
|
console.error('Failed to download metric file:', error);
|
||||||
|
// You might want to show an error toast here
|
||||||
|
} finally {
|
||||||
|
// Add a small delay before removing loading state since download happens async
|
||||||
|
setTimeout(() => {
|
||||||
|
setIsDownloading(false);
|
||||||
|
}, 1000);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div
|
<div
|
||||||
className={cn('bg-background flex flex-col space-y-1 rounded border p-4 shadow', className)}>
|
className={cn('bg-background flex items-center justify-between rounded border p-4 shadow', className)}>
|
||||||
<Text className="font-medium">This request returned more than 5,000 records</Text>
|
<div className="flex flex-col space-y-1">
|
||||||
<Text size="xs" variant="secondary">
|
<Text className="font-medium">This request returned more than 5,000 records</Text>
|
||||||
If you need more than that, please contact your data admin.
|
<Text size="xs" variant="secondary">
|
||||||
</Text>
|
To see all records, you'll need to download the results.
|
||||||
|
</Text>
|
||||||
|
</div>
|
||||||
|
<Button
|
||||||
|
onClick={handleDownload}
|
||||||
|
loading={isDownloading}
|
||||||
|
variant="default"
|
||||||
|
className="ml-4"
|
||||||
|
prefix={<Download4 />}
|
||||||
|
>
|
||||||
|
Download
|
||||||
|
</Button>
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
};
|
};
|
|
@ -108,7 +108,7 @@ export const MetricViewChart: React.FC<{
|
||||||
/>
|
/>
|
||||||
</MetricViewChartCard>
|
</MetricViewChartCard>
|
||||||
|
|
||||||
{!!metricData?.has_more_records && <MetricDataTruncatedWarning />}
|
{!!metricData?.has_more_records && <MetricDataTruncatedWarning metricId={metricId} />}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<AnimatePresenceWrapper show={showEvaluation}>
|
<AnimatePresenceWrapper show={showEvaluation}>
|
||||||
|
|
Loading…
Reference in New Issue