All files / src/hooks/notifications notificationSubscriptions.ts

67.14% Statements 47/70
100% Branches 10/10
50% Functions 10/20
74% Lines 37/50

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161                                                                                                                          47439x     47439x 596x 85912x         21698x     21698x 356x 33645x         47439x     47439x 9x 85127x         46400x     46400x 6x 83049x         20659x     20659x   20769x         20659x     20659x 26x 20769x         20659x     20659x 4x 20769x         20659x     20659x 10x 20769x         20659x     20659x   20769x         20659x     20659x   20769x        
import { ReadyState } from "react-use-websocket";
import { TaskRead } from "@/api/apiStore.gen.ts";
import {
  NotificationMessageType,
  useNotificationConnection,
} from "@/hooks/notifications/useNotificationConnection.ts";
 
export type BuildStateSolvedProperty = {
  id: number;
  name: string;
  value: number | number[];
  unit: string;
  unknown_units?: boolean;
};
 
export type BuildStateCompletionNotification = {
  context: {
    flowsheet_id: number;
    stream_id: number;
    task_id?: number | null;
    property_set_id?: number | null;
    request_version?: number | null;
  };
  status: "success" | "error";
  properties?: BuildStateSolvedProperty[] | null;
  error?: string | null;
  failure_kind?: "idaes-error" | "delivery-failure" | null;
};
 
export type ResultSummaryCalculationError = {
  message: string;
  cause: string;
  simulation_object_id?: number | null;
  result_key?: string | null;
  property_value_id?: number | null;
};
 
export type ResultSummaryCalculatingNotification = {
  scenario_id: number;
  simulation_object_ids: number[];
  source_task_id: number;
};
 
export type ResultSummaryAvailableNotification = {
  scenario_id: number;
  simulation_object_id: number;
  source_task_id: number;
  errors: ResultSummaryCalculationError[];
};
 
export type ResultSummaryFailedNotification = {
  scenario_id: number;
  simulation_object_id: number;
  source_task_id: number;
  errors: ResultSummaryCalculationError[];
};
 
export type AutoRevisionSkippedActiveTasksNotification = {
  task_id: number;
};
 
export function useTaskCompletedSubscription(
  onMessage: (message: TaskRead) => void,
): ReadyState {
  const { readyState } = useNotificationConnection((message) => {
    onMessage(message as TaskRead);
  }, NotificationMessageType.TASK_COMPLETED);
 
  return readyState;
}
 
export function useTaskUpdatedSubscription(
  onMessage: (message: TaskRead) => void,
): ReadyState {
  const { readyState } = useNotificationConnection((message) => {
    onMessage(message as TaskRead);
  }, NotificationMessageType.TASK_UPDATED);
 
  return readyState;
}
 
export function useTaskCancelledSubscription(
  onMessage: (message: TaskRead) => void,
): ReadyState {
  const { readyState } = useNotificationConnection((message) => {
    onMessage(message as TaskRead);
  }, NotificationMessageType.TASK_CANCELLED);
 
  return readyState;
}
 
export function useTaskCancellingSubscription(
  onMessage: (message: TaskRead) => void,
): ReadyState {
  const { readyState } = useNotificationConnection((message) => {
    onMessage(message as TaskRead);
  }, NotificationMessageType.TASK_CANCELLING);
 
  return readyState;
}
 
export function useTaskChildrenCancelledSubscription(
  onMessage: (message: TaskRead) => void,
): ReadyState {
  const { readyState } = useNotificationConnection((message) => {
    onMessage(message as TaskRead);
  }, NotificationMessageType.TASK_CHILDREN_CANCELLED);
 
  return readyState;
}
 
export function useBuildStateCompletedSubscription(
  onMessage: (message: BuildStateCompletionNotification) => void,
): ReadyState {
  const { readyState } = useNotificationConnection((message) => {
    onMessage(message as BuildStateCompletionNotification);
  }, NotificationMessageType.BUILD_STATE_COMPLETED);
 
  return readyState;
}
 
export function useResultSummaryCalculatingSubscription(
  onMessage: (message: ResultSummaryCalculatingNotification) => void,
): ReadyState {
  const { readyState } = useNotificationConnection((message) => {
    onMessage(message as ResultSummaryCalculatingNotification);
  }, NotificationMessageType.RESULT_SUMMARY_CALCULATING);
 
  return readyState;
}
 
export function useResultSummaryAvailableSubscription(
  onMessage: (message: ResultSummaryAvailableNotification) => void,
): ReadyState {
  const { readyState } = useNotificationConnection((message) => {
    onMessage(message as ResultSummaryAvailableNotification);
  }, NotificationMessageType.RESULT_SUMMARY_AVAILABLE);
 
  return readyState;
}
 
export function useResultSummaryFailedSubscription(
  onMessage: (message: ResultSummaryFailedNotification) => void,
): ReadyState {
  const { readyState } = useNotificationConnection((message) => {
    onMessage(message as ResultSummaryFailedNotification);
  }, NotificationMessageType.RESULT_SUMMARY_FAILED);
 
  return readyState;
}
 
export function useAutoRevisionSkippedActiveTasksSubscription(
  onMessage: (message: AutoRevisionSkippedActiveTasksNotification) => void,
): ReadyState {
  const { readyState } = useNotificationConnection((message) => {
    onMessage(message as AutoRevisionSkippedActiveTasksNotification);
  }, NotificationMessageType.AUTO_REVISION_SKIPPED_ACTIVE_TASKS);
 
  return readyState;
}