add option to Include Output

Author: andrii-i

jupyter_scheduler/models.py

@@ -24,7 +24,7 @@ class Notification(BaseModel):
 
     send_to: List[str]
     events: List[NotificationEvent]
-    include_preview: bool = False
+    include_output: bool
 
 
 class RuntimeEnvironment(BaseModel):

src/components/notification-picker.tsx

@@ -2,6 +2,7 @@ import React, { useState, useCallback } from 'react';
 
 import { Cluster } from './cluster';
 import {
+  Checkbox,
   Chip,
   FormControl,
   FormControlLabel,
@@ -38,6 +39,9 @@ export function NotificationPicker({
   const [sendToInput, setSendToInput] = useState<string>(
     model.notification?.sendTo?.join(', ') || ''
   );
+  const [includeOutput, setIncludeOutput] = useState<boolean>(
+    model.notification?.includeOutput || false
+  );
 
   const enableNotificationChange = (e: React.ChangeEvent<HTMLInputElement>) => {
     const updatedEnableNotification = e.target.checked;
@@ -73,7 +77,7 @@ export function NotificationPicker({
     setSendToInput(e.target.value);
   }, []);
 
-  const handleBlur = useCallback(() => {
+  const blur = useCallback(() => {
     const emailArray = sendToInput
       .split(',')
       .map(email => email.trim())
@@ -82,16 +86,28 @@ export function NotificationPicker({
     modelChange({ ...model, notification: updatedNotification });
   }, [sendToInput, model, modelChange]);
 
-  const handleKeyDown = useCallback(
+  const keyDown = useCallback(
     (e: React.KeyboardEvent) => {
       if (e.key === 'Enter') {
         e.preventDefault();
-        handleBlur();
+        blur();
       }
     },
-    [handleBlur]
+    [blur]
   );
 
+  const includeOutputChange = (event: React.ChangeEvent<HTMLInputElement>) => {
+    const updatedValue = event.target.checked;
+    setIncludeOutput(updatedValue);
+    modelChange({
+      ...model,
+      notification: {
+        ...model.notification,
+        includeOutput: updatedValue
+      }
+    });
+  };
+
   const deleteSelectedEvent = useCallback(
     (eventToDelete: string) => () => {
       const updatedEvents = selectedEvents.filter(
@@ -122,15 +138,14 @@ export function NotificationPicker({
         }
         label={trans.__('Enable Notifications')}
       />
-
       <TextField
         label={trans.__('Send To')}
         value={sendToInput}
         name="sendTo"
         variant="outlined"
         onChange={sendToChange}
-        onBlur={handleBlur}
-        onKeyDown={handleKeyDown}
+        onBlur={blur}
+        onKeyDown={keyDown}
         disabled={!enableNotification}
       />
       <NotificationEventsSelect
@@ -146,6 +161,16 @@ export function NotificationPicker({
         deleteSelectedEvent={deleteSelectedEvent}
         disabled={!enableNotification}
       />
+      <FormControlLabel
+        control={
+          <Checkbox
+            checked={includeOutput}
+            onChange={includeOutputChange}
+            disabled={!enableNotification}
+          />
+        }
+        label={trans.__('Include Output')}
+      />
     </Stack>
   );
 }

src/handler.ts

@@ -404,7 +404,7 @@ export namespace Scheduler {
   export interface INotification {
     send_to: string[];
     events: string[];
-    include_preview: boolean;
+    include_output: boolean;
   }
 
   export interface ICreateJob {

src/mainviews/create-job.tsx

@@ -327,6 +327,14 @@ export function CreateJob(props: ICreateJobProps): JSX.Element {
       jobOptions.parameters = serializeParameters(props.model.parameters);
     }
 
+    if (props.model.notification?.enableNotification) {
+      jobOptions.notification = {
+        send_to: props.model.notification.sendTo ?? [],
+        events: props.model.notification.selectedEvents ?? [],
+        include_output: props.model.notification.includeOutput ?? false
+      };
+    }
+
     props.handleModelChange({
       ...props.model,
       createError: undefined,
@@ -374,6 +382,14 @@ export function CreateJob(props: ICreateJobProps): JSX.Element {
       );
     }
 
+    if (props.model.notification?.enableNotification) {
+      jobDefinitionOptions.notification = {
+        send_to: props.model.notification.sendTo ?? [],
+        events: props.model.notification.selectedEvents ?? [],
+        include_output: props.model.notification.includeOutput ?? false
+      };
+    }
+
     props.handleModelChange({
       ...props.model,
       createError: undefined,

src/model.ts

@@ -76,6 +76,7 @@ export type ModelWithScheduleFields = {
 
 export type Notification = {
   sendTo?: string[];
+  includeOutput?: boolean;
   enableNotification?: boolean;
   availableEvents?: string[];
   selectedEvents?: string[];