feat(dashboard): re run activity item #7459
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,61 +1,74 @@ | ||
| import { IActivityJob } from '@novu/shared'; | ||
| import { motion } from 'motion/react'; | ||
| import { RiMemoriesFill, RiPlayCircleLine, RiRouteFill } from 'react-icons/ri'; | ||
| import { Tooltip, TooltipContent, TooltipTrigger } from '../primitives/tooltip'; | ||
|
|
||
| import { useEnvironment } from '@/context/environment/hooks'; | ||
| import { useTriggerWorkflow } from '@/hooks/use-trigger-workflow'; | ||
| import { useTelemetry } from '../../hooks/use-telemetry'; | ||
| import { TelemetryEvent } from '../../utils/telemetry'; | ||
| import { cn } from '../../utils/ui'; | ||
| import { CompactButton } from '../primitives/button-compact'; | ||
| import { InlineToast } from '../primitives/inline-toast'; | ||
| import { Skeleton } from '../primitives/skeleton'; | ||
| import { showErrorToast, showSuccessToast } from '../primitives/sonner-helpers'; | ||
| import { ActivityJobItem } from './activity-job-item'; | ||
| import { ActivityOverview } from './components/activity-overview'; | ||
| import { useActivityByTransaction, useActivityPolling } from './hooks'; | ||
|
|
||
| export interface ActivityPanelProps { | ||
| activityId?: string; | ||
| transactionId?: string; | ||
| onActivitySelect: (activityId: string) => void; | ||
| headerClassName?: string; | ||
| overviewHeaderClassName?: string; | ||
| } | ||
|
|
||
| export function ActivityPanel({ | ||
| activityId, | ||
| transactionId: initialTransactionId, | ||
| onActivitySelect, | ||
| headerClassName, | ||
| overviewHeaderClassName, | ||
| }: ActivityPanelProps) { | ||
| const track = useTelemetry(); | ||
| const { isLoadingTransaction, setTransactionId } = useActivityByTransaction({ | ||
| transactionId: initialTransactionId, | ||
| onActivityFound: onActivitySelect, | ||
| }); | ||
|
|
||
| const { activity, isPending, error } = useActivityPolling({ | ||
| activityId, | ||
| }); | ||
|
|
||
| const { currentEnvironment } = useEnvironment(); | ||
|
Comment on lines
26
to
+43
There was a problem hiding this comment. Moved the logic of fetching and refetching by transaction id to the activity panel to allow initializing by either activityId or transaction id There was a problem hiding this comment. Can you please elaborate on why do we need to do both? The transaction is identified by transactionID, so I think we can just use that. There was a problem hiding this comment. When vieweing an item from the activity feed, we want to view a specific activityId, transacitonId is used in cases of a re-trigger, and also from the test workflow sidebar. As a trigger can potentially generate multiple activity ids, when testing we assume it generates one and just take the first. There was a problem hiding this comment. I see. Let's continue here. My suggestion is to work with the notification list (activity feed) page as the main resource and the selected notification (details of a run). If not mistaken, the transactionId for the rerun should be available in the selected notification resource. |
||
| const { triggerWorkflow, isPending: isRerunning } = useTriggerWorkflow(); | ||
|
|
||
| const handleRerun = async () => { | ||
| if (!activity || !currentEnvironment) return; | ||
|
|
||
| try { | ||
| track(TelemetryEvent.RE_RUN_WORKFLOW, { | ||
| name: activity.template?.name, | ||
| }); | ||
|
|
||
| const { data } = await triggerWorkflow({ | ||
| name: activity.template?.triggers[0].identifier || '', | ||
| payload: activity.payload || {}, | ||
| to: activity.subscriber?.subscriberId || '', | ||
| }); | ||
|
|
||
| showSuccessToast('Workflow triggered successfully', 'bottom-right'); | ||
|
|
||
| if (data?.transactionId) { | ||
| setTransactionId(data.transactionId); | ||
| } | ||
| } catch (e: any) { | ||
| showErrorToast(e.message || 'Failed to trigger workflow'); | ||
| } | ||
| }; | ||
|
|
||
| if (isPending || isLoadingTransaction) { | ||
| return ( | ||
| <motion.div initial={{ opacity: 0 }} animate={{ opacity: 1 }} transition={{ delay: 0.1 }}> | ||
| <LoadingSkeleton /> | ||
|
|
@@ -95,6 +108,22 @@ export function ActivityPanel({ | |
| <span className="text-foreground-950 text-sm font-medium"> | ||
| {activity.template?.name || 'Deleted workflow'} | ||
| </span> | ||
|
|
||
| {activity.template?.name && ( | ||
| <Tooltip> | ||
| <TooltipTrigger asChild> | ||
| <CompactButton | ||
| icon={RiMemoriesFill} | ||
| size="md" | ||
| variant="ghost" | ||
| className="ml-auto" | ||
| onClick={handleRerun} | ||
| isLoading={isRerunning} | ||
| /> | ||
| </TooltipTrigger> | ||
| <TooltipContent>Rerun this workflow again with the same payload and recipients</TooltipContent> | ||
| </Tooltip> | ||
| )} | ||
| </div> | ||
| <ActivityOverview activity={activity} /> | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| export * from './use-activity-by-transaction'; | ||
| export * from './use-activity-polling'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| import { useFetchActivities } from '@/hooks/use-fetch-activities'; | ||
| import { useEffect, useState } from 'react'; | ||
|
|
||
| interface UseActivityByTransactionProps { | ||
| transactionId?: string; | ||
| onActivityFound: (activityId: string) => void; | ||
| } | ||
|
|
||
| export function useActivityByTransaction({ | ||
|
There was a problem hiding this comment. This hook is needed to correct a misalignment in the dashboard's Activity Feed. The current notification item, So, it's unclear if we rerun based on transactionID or Notification ID. 
My suggestion is to use the Having said that, I suggest changing the URL schema to There was a problem hiding this comment. Sorry, but I do not entirely follow your suggestion. The re run uses the current notification entity, and performs a trigger using the same payload and recipient properties as the previous trigger. useActivityByTransactionId is just a refactor I did that encapsulates the fetch activities given a specific transactionId, this happens in 2 cases:
|
||
| transactionId: initialTransactionId, | ||
| onActivityFound, | ||
| }: UseActivityByTransactionProps) { | ||
| const [transactionId, setTransactionId] = useState<string | undefined>(initialTransactionId); | ||
|
|
||
| const { activities } = useFetchActivities( | ||
| { | ||
| filters: transactionId ? { transactionId } : undefined, | ||
| }, | ||
| { | ||
| enabled: !!transactionId, | ||
| refetchInterval: transactionId ? 1000 : false, | ||
| } | ||
| ); | ||
|
|
||
| useEffect(() => { | ||
| if (!activities?.length || !transactionId) return; | ||
|
|
||
| const newActivityId = activities[0]._id; | ||
| if (newActivityId) { | ||
| onActivityFound(newActivityId); | ||
| setTransactionId(undefined); | ||
| } | ||
| }, [activities, transactionId, onActivityFound]); | ||
|
|
||
| return { | ||
| isLoadingTransaction: transactionId && !activities?.[0]?._id, | ||
| setTransactionId, | ||
| }; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| import { JobStatusEnum } from '@novu/shared'; | ||
| import { useQueryClient } from '@tanstack/react-query'; | ||
| import { useEffect, useState } from 'react'; | ||
|
|
||
| import { useEnvironment } from '@/context/environment/hooks'; | ||
| import { useFetchActivity } from '@/hooks/use-fetch-activity'; | ||
| import { QueryKeys } from '@/utils/query-keys'; | ||
|
|
||
| interface UseActivityPollingProps { | ||
| activityId?: string; | ||
| } | ||
|
|
||
| export function useActivityPolling({ activityId }: UseActivityPollingProps) { | ||
| const queryClient = useQueryClient(); | ||
| const [shouldRefetch, setShouldRefetch] = useState(true); | ||
| const { currentEnvironment } = useEnvironment(); | ||
|
|
||
| const { activity, isPending, error } = useFetchActivity( | ||
| { activityId: activityId ?? '' }, | ||
| { | ||
| refetchInterval: shouldRefetch ? 1000 : false, | ||
| } | ||
| ); | ||
|
|
||
| useEffect(() => { | ||
| if (!activity) return; | ||
|
|
||
| const isPending = activity.jobs?.some( | ||
| (job) => | ||
| job.status === JobStatusEnum.PENDING || | ||
| job.status === JobStatusEnum.QUEUED || | ||
| job.status === JobStatusEnum.RUNNING || | ||
| job.status === JobStatusEnum.DELAYED | ||
| ); | ||
|
|
||
| setShouldRefetch(isPending || !activity?.jobs?.length); | ||
|
|
||
| queryClient.invalidateQueries({ | ||
| queryKey: [QueryKeys.fetchActivity, currentEnvironment?._id, activityId], | ||
| }); | ||
| }, [activity, queryClient, currentEnvironment, activityId]); | ||
|
|
||
| return { | ||
|
There was a problem hiding this comment. Nit picky: return all the results from |
||
| activity, | ||
| isPending, | ||
| error, | ||
| }; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed clipping of the date badge on long text