notifications_settings --> notifications_config

Author: andrii-i

jupyter_scheduler/orm.py

@@ -98,7 +98,7 @@ class Job(CommonColumns, Base):
     url = Column(String(256), default=generate_jobs_url)
     pid = Column(Integer)
     idempotency_token = Column(String(256))
-    notifications_settings = Column(JsonType(1024), nullable=True)
+    notifications_config = Column(JsonType(1024), nullable=True)
 
 
 class JobDefinition(CommonColumns, Base):
@@ -109,7 +109,7 @@ class JobDefinition(CommonColumns, Base):
     url = Column(String(256), default=generate_job_definitions_url)
     create_time = Column(Integer, default=get_utc_timestamp)
     active = Column(Boolean, default=True)
-    notifications_settings = Column(JsonType(1024), nullable=True)
+    notifications_config = Column(JsonType(1024), nullable=True)
 
 
 def create_tables(db_url, drop_tables=False):

src/components/notification-detail.tsx renamed to src/components/notifications-config-detail.tsx

@@ -3,7 +3,7 @@ import React from 'react';
 import { Card, CardContent, Stack, FormLabel } from '@mui/material';
 import { useTranslator } from '../hooks';
 import { Scheduler } from '../handler';
-import { LabeledValue } from '../components/labeled-value';
+import { LabeledValue } from './labeled-value';
 
 type INotificationsConfigItemProps = {
   label: string;
@@ -31,7 +31,7 @@ function NotificationsConfigItem(props: INotificationsConfigItemProps) {
   );
 }
 
-export function NotificationsConfigDetails(
+export function NotificationsConfigDetail(
   props: INotificationsConfigDetailsProps
 ): JSX.Element {
   const trans = useTranslator('jupyterlab');

src/components/notification-config.tsx renamed to src/components/notifications-config.tsx

@@ -23,19 +23,6 @@ type NotificationsConfigProps = {
   handleModelChange: (model: ICreateJobModel) => void;
 };
 
-type NotificationEventsSelectProps = {
-  id: string;
-  availableEvents: string[];
-  selectChange: (e: SelectChangeEvent<string>) => void;
-  disabled: boolean;
-};
-
-type SelectedEventsChipsProps = {
-  selectedEvents: string[];
-  deleteSelectedEvent: (eventToDelete: string) => () => void;
-  disabled: boolean;
-};
-
 export function NotificationsConfig(
   props: NotificationsConfigProps
 ): JSX.Element | null {
@@ -169,15 +156,15 @@ export function NotificationsConfig(
       />
       <NotificationEventsSelect
         id={props.id}
-        availableEvents={props.notificationEvents.filter(
+        value={props.notificationEvents.filter(
           e => !selectedEvents.includes(e)
         )}
-        selectChange={selectChange}
+        onChange={selectChange}
         disabled={!enableNotification}
       />
       <SelectedEventsChips
-        selectedEvents={selectedEvents}
-        deleteSelectedEvent={deleteSelectedEvent}
+        value={selectedEvents}
+        onChange={deleteSelectedEvent}
         disabled={!enableNotification}
       />
       <FormControlLabel
@@ -194,6 +181,13 @@ export function NotificationsConfig(
   );
 }
 
+type NotificationEventsSelectProps = {
+  id: string;
+  value: string[];
+  onChange: (e: SelectChangeEvent<string>) => void;
+  disabled: boolean;
+};
+
 function NotificationEventsSelect(props: NotificationEventsSelectProps) {
   const trans = useTranslator('jupyterlab');
   const label = trans.__('Notification Events');
@@ -208,10 +202,10 @@ function NotificationEventsSelect(props: NotificationEventsSelectProps) {
         labelId={labelId}
         id={props.id}
         label={label}
-        onChange={props.selectChange}
+        onChange={props.onChange}
         disabled={props.disabled}
       >
-        {props.availableEvents.map(e => (
+        {props.value.map(e => (
           <MenuItem key={e} value={e}>
             {e}
           </MenuItem>
@@ -221,15 +215,21 @@ function NotificationEventsSelect(props: NotificationEventsSelectProps) {
   );
 }
 
+type SelectedEventsChipsProps = {
+  value: string[];
+  onChange: (eventToDelete: string) => () => void;
+  disabled: boolean;
+};
+
 function SelectedEventsChips(props: SelectedEventsChipsProps) {
   return (
     <Cluster gap={3} justifyContent="flex-start">
-      {props.selectedEvents.map(e => (
+      {props.value.map(e => (
         <Chip
           key={e}
           label={e}
           variant="outlined"
-          onDelete={props.deleteSelectedEvent(e)}
+          onDelete={props.onChange(e)}
           disabled={props.disabled}
         />
       ))}

src/handler.ts

@@ -363,7 +363,7 @@ export namespace Scheduler {
     compute_type?: string;
     schedule?: string;
     timezone?: string;
-    notifications_settings?: INotificationsConfig;
+    notifications_config?: INotificationsConfig;
   }
 
   export interface IUpdateJobDefinition {
@@ -372,7 +372,7 @@ export namespace Scheduler {
     timezone?: string;
     active?: boolean;
     input_uri?: string;
-    notifications_settings?: INotificationsConfig;
+    notifications_config?: INotificationsConfig;
   }
 
   export interface IDescribeJobDefinition {
@@ -391,7 +391,7 @@ export namespace Scheduler {
     create_time: number;
     update_time: number;
     active: boolean;
-    notifications_settings?: INotificationsConfig;
+    notifications_config?: INotificationsConfig;
   }
 
   export interface IEmailNotifications {
@@ -424,7 +424,7 @@ export namespace Scheduler {
     output_filename_template?: string;
     output_formats?: string[];
     compute_type?: string;
-    notifications_settings?: INotificationsConfig;
+    notifications_config?: INotificationsConfig;
   }
 
   export interface ICreateJobFromDefinition {
@@ -473,7 +473,7 @@ export namespace Scheduler {
     start_time?: number;
     end_time?: number;
     downloaded: boolean;
-    notifications_settings?: INotificationsConfig;
+    notifications_config?: INotificationsConfig;
   }
 
   export interface ICreateJobResponse {

src/mainviews/create-job.tsx

@@ -11,7 +11,7 @@ import { Cluster } from '../components/cluster';
 import { ComputeTypePicker } from '../components/compute-type-picker';
 import { CreateScheduleOptions } from '../components/create-schedule-options';
 import { EnvironmentPicker } from '../components/environment-picker';
-import { NotificationsConfig } from '../components/notification-config';
+import { NotificationsConfig } from '../components/notifications-config';
 import {
   OutputFormatPicker,
   outputFormatsForEnvironment
@@ -337,7 +337,7 @@ export function CreateJob(props: ICreateJobProps): JSX.Element {
     }
 
     if (props.model.notificationsConfig?.enableNotification) {
-      jobOptions.notifications_settings = {
+      jobOptions.notifications_config = {
         send_to: props.model.notificationsConfig.sendTo ?? [],
         events: props.model.notificationsConfig.selectedEvents ?? [],
         include_output: props.model.notificationsConfig.includeOutput ?? false
@@ -392,7 +392,7 @@ export function CreateJob(props: ICreateJobProps): JSX.Element {
     }
 
     if (props.model.notificationsConfig?.enableNotification) {
-      jobDefinitionOptions.notifications_settings = {
+      jobDefinitionOptions.notifications_config = {
         send_to: props.model.notificationsConfig.sendTo ?? [],
         events: props.model.notificationsConfig.selectedEvents ?? [],
         include_output: props.model.notificationsConfig.includeOutput ?? false

src/mainviews/detail-view/job-definition.tsx

@@ -23,7 +23,7 @@ import {
 } from '../../components/labeled-value';
 import { JupyterFrontEnd } from '@jupyterlab/application';
 import { ListJobsTable } from '../list-jobs';
-import { NotificationsConfigDetails } from '../../components/notification-detail';
+import { NotificationsConfigDetail } from '../../components/notifications-config-detail';
 import { Scheduler as SchedulerTokens } from '../../tokens';
 import { SchedulerService } from '../../handler';
 import { timestampLocalize } from './job-detail';
@@ -290,7 +290,7 @@ export function JobDefinition(props: IJobDefinitionProps): JSX.Element {
       {JobDefinition}
       {JobsList}
       {props.model.notificationsConfig && (
-        <NotificationsConfigDetails
+        <NotificationsConfigDetail
           notificationsConfig={props.model.notificationsConfig}
         />
       )}

src/mainviews/detail-view/job-detail.tsx

@@ -23,7 +23,7 @@ import {
 } from '../../components/labeled-value';
 import { JobFileLink } from '../../components/job-file-link';
 import { JupyterFrontEnd } from '@jupyterlab/application';
-import { NotificationsConfigDetails } from '../../components/notification-detail';
+import { NotificationsConfigDetail } from '../../components/notifications-config-detail';
 import { Scheduler, SchedulerService } from '../../handler';
 import { Scheduler as SchedulerTokens } from '../../tokens';
 import { useEventLogger, useTranslator } from '../../hooks';
@@ -353,7 +353,7 @@ export function JobDetail(props: IJobDetailProps): JSX.Element {
       {CoreOptions}
       {Parameters}
       {props.model.notificationsConfig && (
-        <NotificationsConfigDetails
+        <NotificationsConfigDetail
           notificationsConfig={props.model.notificationsConfig}
         />
       )}

src/model.ts

@@ -396,7 +396,7 @@ export function convertDescribeJobtoJobDetail(
     startTime: describeJob.start_time,
     endTime: describeJob.end_time,
     downloaded: describeJob.downloaded,
-    notificationsConfig: describeJob.notifications_settings
+    notificationsConfig: describeJob.notifications_config
   };
 }
 
@@ -425,7 +425,7 @@ export function convertDescribeDefinitiontoDefinition(
     updateTime: describeDefinition.update_time,
     schedule: describeDefinition.schedule,
     timezone: describeDefinition.timezone,
-    notificationsConfig: describeDefinition.notifications_settings
+    notificationsConfig: describeDefinition.notifications_config
   };
 }