Skip to content

fix(ui): download button in workflow library downloads wrong workflow #7715

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 28, 2025
Merged
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
1 change: 1 addition & 0 deletions invokeai/frontend/web/public/locales/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -921,6 +921,7 @@
"currentImage": "Current Image",
"currentImageDescription": "Displays the current image in the Node Editor",
"downloadWorkflow": "Download Workflow JSON",
"downloadWorkflowError": "Error downloading workflow",
"edge": "Edge",
"edit": "Edit",
"editMode": "Edit in Workflow Editor",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import dateFormat, { masks } from 'dateformat';
import { selectWorkflowId } from 'features/nodes/store/workflowSlice';
import { useDeleteWorkflow } from 'features/workflowLibrary/components/DeleteLibraryWorkflowConfirmationAlertDialog';
import { useLoadWorkflow } from 'features/workflowLibrary/components/LoadWorkflowConfirmationAlertDialog';
import { useDownloadWorkflow } from 'features/workflowLibrary/hooks/useDownloadWorkflow';
import { useDownloadWorkflowById } from 'features/workflowLibrary/hooks/useDownloadWorkflowById';
import type { MouseEvent } from 'react';
import { useCallback, useMemo, useState } from 'react';
import { useTranslation } from 'react-i18next';
Expand All @@ -30,7 +30,7 @@ export const WorkflowListItem = ({ workflow }: { workflow: WorkflowRecordListIte
}, []);

const workflowId = useAppSelector(selectWorkflowId);
const downloadWorkflow = useDownloadWorkflow();
const { downloadWorkflow, isLoading: isLoadingDownloadWorkflow } = useDownloadWorkflowById();
const shareWorkflow = useShareWorkflow();
const deleteWorkflow = useDeleteWorkflow();
const loadWorkflow = useLoadWorkflow();
Expand Down Expand Up @@ -71,9 +71,9 @@ export const WorkflowListItem = ({ workflow }: { workflow: WorkflowRecordListIte
(e: MouseEvent<HTMLButtonElement>) => {
e.stopPropagation();
setIsHovered(false);
downloadWorkflow();
downloadWorkflow(workflow.workflow_id);
},
[downloadWorkflow]
[downloadWorkflow, workflow.workflow_id]
);

return (
Expand Down Expand Up @@ -144,6 +144,7 @@ export const WorkflowListItem = ({ workflow }: { workflow: WorkflowRecordListIte
aria-label={t('workflows.download')}
onClick={handleClickDownload}
icon={<PiDownloadSimpleBold />}
isLoading={isLoadingDownloadWorkflow}
/>
</Tooltip>
{!!projectUrl && workflow.workflow_id && workflow.category !== 'user' && (
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import { MenuItem } from '@invoke-ai/ui-library';
import { useDownloadWorkflow } from 'features/workflowLibrary/hooks/useDownloadWorkflow';
import { useDownloadCurrentlyLoadedWorkflow } from 'features/workflowLibrary/hooks/useDownloadCurrentlyLoadedWorkflow';
import { memo } from 'react';
import { useTranslation } from 'react-i18next';
import { PiDownloadSimpleBold } from 'react-icons/pi';

const DownloadWorkflowMenuItem = () => {
const { t } = useTranslation();
const downloadWorkflow = useDownloadWorkflow();
const downloadWorkflow = useDownloadCurrentlyLoadedWorkflow();

return (
<MenuItem as="button" icon={<PiDownloadSimpleBold />} onClick={downloadWorkflow}>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { $builtWorkflow } from 'features/nodes/hooks/useWorkflowWatcher';
import { workflowDownloaded } from 'features/workflowLibrary/store/actions';
import { useCallback } from 'react';

export const useDownloadWorkflow = () => {
export const useDownloadCurrentlyLoadedWorkflow = () => {
const dispatch = useAppDispatch();

const downloadWorkflow = useCallback(() => {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
import { useAppDispatch } from 'app/store/storeHooks';
import { toast } from 'features/toast/toast';
import { workflowDownloaded } from 'features/workflowLibrary/store/actions';
import { useCallback } from 'react';
import { useTranslation } from 'react-i18next';
import { useLazyGetWorkflowQuery } from 'services/api/endpoints/workflows';

export const useDownloadWorkflowById = () => {
const { t } = useTranslation();
const dispatch = useAppDispatch();
const [trigger, query] = useLazyGetWorkflowQuery();

const toastError = useCallback(() => {
toast({ status: 'error', description: t('nodes.downloadWorkflowError') });
}, [t]);

const downloadWorkflow = useCallback(
async (workflowId: string) => {
try {
const { data } = await trigger(workflowId);
if (!data) {
toastError();
return;
}
const { workflow } = data;
const blob = new Blob([JSON.stringify(workflow, null, 2)]);
const a = document.createElement('a');
a.href = URL.createObjectURL(blob);
a.download = `${workflow.name || 'My Workflow'}.json`;
document.body.appendChild(a);
a.click();
a.remove();
dispatch(workflowDownloaded());
} catch {
toastError();
}
},
[dispatch, toastError, trigger]
);

return { downloadWorkflow, isLoading: query.isLoading };
};