added new optional configurable organisation and state fields for ent…

backend/config/default.cjs

@@ -208,6 +208,11 @@ module.exports = {
     helpPopoverText: {
       manualEntryAccess: '',
     },
+
+    modelDetails: {
+      organisations: ['Example Organisation'],
+      states: ['Development', 'Review', 'Production'],
+    },
   },
 
   connectors: {

backend/src/migrations/014_add_organisation_and_state.ts

@@ -0,0 +1,10 @@
+import ModelModel from '../models/Model.js'
+
+export async function up() {
+  await ModelModel.updateMany({ organisation: { $exists: false } }, { $set: { organisation: '' } })
+  await ModelModel.updateMany({ state: { $exists: false } }, { $set: { state: '' } })
+}
+
+export async function down() {
+  /* NOOP */
+}

backend/src/models/Model.ts

@@ -51,6 +51,8 @@ export interface ModelInterface {
   id: string
 
   name: string
+  organisation: string
+  state: string
   kind: EntryKindKeys
   description: string
   card?: ModelCardInterface
@@ -73,8 +75,21 @@ export type ModelDoc = ModelInterface & Document<any, any, ModelInterface>
 const ModelSchema = new Schema<ModelInterface>(
   {
     id: { type: String, required: true, unique: true, index: true },
-
     name: { type: String, required: true },
+    organisation: {
+      type: String,
+      required: function () {
+        return typeof this['organisation'] === 'string' ? false : true
+      },
+      default: '',
+    },
+    state: {
+      type: String,
+      required: function () {
+        return typeof this['state'] === 'string' ? false : true
+      },
+      default: '',
+    },
     kind: { type: String, enum: Object.values(EntryKind) },
     description: { type: String, required: true },
     card: {

backend/src/routes/v2/model/patchModel.ts

@@ -7,12 +7,19 @@ import audit from '../../../connectors/audit/index.js'
 import { EntryKind, EntryVisibility, ModelInterface } from '../../../models/Model.js'
 import { updateModel } from '../../../services/model.js'
 import { modelInterfaceSchema, registerPath } from '../../../services/specification.js'
+import config from '../../../utils/config.js'
 import { parse } from '../../../utils/validate.js'
 
+const organisationsList = [...config.ui.modelDetails.organisations, '']
+const statesList = [...config.ui.modelDetails.states, '']
+
 export const patchModelSchema = z.object({
   body: z.object({
     name: z.string().optional().openapi({ example: 'Yolo v4' }),
+
     kind: z.nativeEnum(EntryKind).optional().openapi({ example: EntryKind.Model }),
+    organisation: z.enum(organisationsList as [string, ...string[]]).optional(),
+    state: z.enum(statesList as [string, ...string[]]).optional(),
     description: z.string().optional().openapi({ example: 'You only look once' }),
     visibility: z.nativeEnum(EntryVisibility).optional().openapi({ example: 'private' }),
     settings: z

backend/src/routes/v2/model/postModel.ts

@@ -7,11 +7,16 @@ import audit from '../../../connectors/audit/index.js'
 import { EntryKind, EntryVisibility, ModelInterface } from '../../../models/Model.js'
 import { createModel } from '../../../services/model.js'
 import { modelInterfaceSchema, registerPath } from '../../../services/specification.js'
+import config from '../../../utils/config.js'
 import { parse } from '../../../utils/validate.js'
 
+const organisationsList = [...config.ui.modelDetails.organisations, '']
+
 export const postModelSchema = z.object({
   body: z.object({
     name: z.string().min(1, 'You must provide a model name').openapi({ example: 'Yolo v4' }),
+    organisation: z.enum(organisationsList as [string, ...string[]]).optional(),
+    state: z.enum(config.ui.modelDetails.states as [string, ...string[], '']).optional(),
     kind: z.nativeEnum(EntryKind).openapi({ example: 'model' }),
     description: z.string().min(1, 'You must provide a model description').openapi({ example: 'You only look once' }),
     visibility: z.nativeEnum(EntryVisibility).optional().default(EntryVisibility.Public),

backend/src/seeds/data/models.ts

@@ -10,6 +10,8 @@ export const model: ModelInterface = {
   name: 'Basic Model',
   description:
     'This model has standard permissions and settings.  Use this model for testing generic new features and services.',
+  organisation: 'Example',
+  state: 'Development',
   collaborators: [
     {
       entity: 'user:user',

backend/src/services/model.ts

@@ -304,7 +304,10 @@ export async function updateModelCard(
   return revision
 }
 
-export type UpdateModelParams = Pick<ModelInterface, 'name' | 'description' | 'visibility' | 'collaborators'> & {
+export type UpdateModelParams = Pick<
+  ModelInterface,
+  'name' | 'description' | 'visibility' | 'collaborators' | 'state' | 'organisation'
+> & {
   settings: Partial<ModelInterface['settings']>
 }
 export async function updateModel(user: UserInterface, modelId: string, modelDiff: Partial<UpdateModelParams>) {

backend/src/types/types.ts

@@ -100,4 +100,9 @@ export interface UiConfig {
   helpPopoverText: {
     manualEntryAccess: string
   }
+
+  modelDetails: {
+    organisations: string[]
+    states: string[]
+  }
 }

backend/src/utils/__mocks__/config.ts

@@ -113,6 +113,10 @@ const config: PartialDeep<Config> = {
     inference: {
       enabled: true,
     },
+    modelDetails: {
+      organisations: ['My Organisation'],
+      states: ['Development', 'Review', 'Production'],
+    },
   },
 }
 

frontend/actions/model.ts

@@ -151,7 +151,12 @@ export async function postModel(form: EntryForm) {
 
 export async function patchModel(
   id: string,
-  delta: Partial<Pick<EntryInterface, 'name' | 'description' | 'collaborators' | 'visibility' | 'settings'>>,
+  delta: Partial<
+    Pick<
+      EntryInterface,
+      'name' | 'description' | 'collaborators' | 'visibility' | 'settings' | 'organisation' | 'state'
+    >
+  >,
 ) {
   return fetch(`/api/v2/model/${id}`, {
     method: 'PATCH',

frontend/src/entry/CreateEntry.tsx

@@ -24,6 +24,7 @@ import { FormEvent, useMemo, useState } from 'react'
 import Loading from 'src/common/Loading'
 import EntryDescriptionInput from 'src/entry/EntryDescriptionInput'
 import EntryNameInput from 'src/entry/EntryNameInput'
+import EntryOrganisationInput from 'src/entry/EntryOrganisationInput'
 import EntryAccessInput from 'src/entry/settings/EntryAccessInput'
 import SourceModelInput from 'src/entry/SourceModelnput'
 import MessageAlert from 'src/MessageAlert'
@@ -53,6 +54,7 @@ export default function CreateEntry({ createEntryKind, onBackClick }: CreateEntr
 
   const [name, setName] = useState('')
   const [sourceModelId, setSourceModelId] = useState('')
+  const [organisation, setOrganisation] = useState<string>('')
   const [description, setDescription] = useState('')
   const [visibility, setVisibility] = useState<EntryForm['visibility']>(EntryVisibility.Public)
   const [collaborators, setCollaborators] = useState<CollaboratorEntry[]>(
@@ -73,13 +75,14 @@ export default function CreateEntry({ createEntryKind, onBackClick }: CreateEntr
     [name, description, createEntryKind, sourceModelId],
   )
 
-  async function handleSubmit(event: FormEvent<HTMLFormElement>) {
+  async function handleSubmit(event: FormEvent) {
     event.preventDefault()
     setLoading(true)
     setErrorMessage('')
 
     const formData: EntryForm = {
       name,
+      organisation,
       kind: entryKind,
       description,
       visibility,
@@ -191,6 +194,7 @@ export default function CreateEntry({ createEntryKind, onBackClick }: CreateEntr
               </Typography>
               <Stack spacing={2} direction={{ xs: 'column', sm: 'row' }}>
                 <EntryNameInput autoFocus value={name} kind={entryKind} onChange={(value) => setName(value)} />
+                <EntryOrganisationInput value={organisation} onChange={(value) => setOrganisation(value)} />
                 {createEntryKind === CreateEntryKind.MIRRORED_MODEL && (
                   <SourceModelInput onChange={(value) => setSourceModelId(value)} value={sourceModelId} />
                 )}

frontend/src/entry/EntryOrganisationInput.tsx

@@ -0,0 +1,58 @@
+import { MenuItem, Select, SelectChangeEvent } from '@mui/material'
+import { useGetUiConfig } from 'actions/uiConfig'
+import { useMemo } from 'react'
+import LabelledInput from 'src/common/LabelledInput'
+import Loading from 'src/common/Loading'
+import MessageAlert from 'src/MessageAlert'
+
+const htmlId = 'entry-organisation-input'
+
+type EntryOrganisationInputProps = {
+  value: string
+  onChange: (value: string) => void
+}
+
+export default function EntryOrganisationInput({ value, onChange }: EntryOrganisationInputProps) {
+  const { uiConfig, isUiConfigLoading, isUiConfigError } = useGetUiConfig()
+
+  const handleChange = (event: SelectChangeEvent) => {
+    onChange(event.target.value)
+  }
+
+  const organisationOptions = useMemo(
+    () =>
+      uiConfig
+        ? [
+            <MenuItem value={''} key='unset'>
+              <em>Unset</em>
+            </MenuItem>,
+            ...uiConfig.modelDetails.organisations.map((organisationItem) => (
+              <MenuItem value={organisationItem} key={organisationItem}>
+                {organisationItem}
+              </MenuItem>
+            )),
+          ]
+        : [],
+    [uiConfig],
+  )
+
+  if (isUiConfigError) {
+    return <MessageAlert message={isUiConfigError.info.message} severity='error' />
+  }
+
+  if (!uiConfig || isUiConfigLoading) {
+    return <Loading />
+  }
+
+  if (uiConfig.modelDetails.organisations.length === 0) {
+    return <></>
+  }
+
+  return (
+    <LabelledInput fullWidth label='Organisation' htmlFor={htmlId}>
+      <Select size='small' value={value} onChange={handleChange} id={htmlId}>
+        {organisationOptions}
+      </Select>
+    </LabelledInput>
+  )
+}

frontend/src/entry/EntryStateInput.tsx

@@ -0,0 +1,58 @@
+import { MenuItem, Select, SelectChangeEvent } from '@mui/material'
+import { useGetUiConfig } from 'actions/uiConfig'
+import { useMemo } from 'react'
+import LabelledInput from 'src/common/LabelledInput'
+import Loading from 'src/common/Loading'
+import MessageAlert from 'src/MessageAlert'
+
+const htmlId = 'entry-state-input'
+
+type EntryStateInputProps = {
+  value: string
+  onChange: (value: string) => void
+}
+
+export default function EntryStateInput({ value, onChange }: EntryStateInputProps) {
+  const { uiConfig, isUiConfigLoading, isUiConfigError } = useGetUiConfig()
+
+  const handleChange = (event: SelectChangeEvent) => {
+    onChange(event.target.value)
+  }
+
+  const stateOptions = useMemo(
+    () =>
+      uiConfig
+        ? [
+            <MenuItem value={''} key='unset'>
+              <em>Unset</em>
+            </MenuItem>,
+            ...uiConfig.modelDetails.states.map((stateItem) => (
+              <MenuItem value={stateItem} key={stateItem}>
+                {stateItem}
+              </MenuItem>
+            )),
+          ]
+        : [],
+    [uiConfig],
+  )
+
+  if (isUiConfigError) {
+    return <MessageAlert message={isUiConfigError.info.message} severity='error' />
+  }
+
+  if (!uiConfig || isUiConfigLoading) {
+    return <Loading />
+  }
+
+  if (uiConfig.modelDetails.states.length === 0) {
+    return <></>
+  }
+
+  return (
+    <LabelledInput fullWidth label='Model State' htmlFor={htmlId}>
+      <Select size='small' value={value} onChange={handleChange} id={htmlId}>
+        {stateOptions}
+      </Select>
+    </LabelledInput>
+  )
+}

frontend/src/entry/settings/EntryDetails.tsx

@@ -5,6 +5,8 @@ import { patchModel } from 'actions/model'
 import { FormEvent, useMemo, useState } from 'react'
 import EntryDescriptionInput from 'src/entry/EntryDescriptionInput'
 import EntryNameInput from 'src/entry/EntryNameInput'
+import EntryOrganisationInput from 'src/entry/EntryOrganisationInput'
+import EntryStateInput from 'src/entry/EntryStateInput'
 import useNotification from 'src/hooks/useNotification'
 import MessageAlert from 'src/MessageAlert'
 import { EntryInterface, EntryKindLabel, UpdateEntryForm } from 'types/types'
@@ -17,6 +19,8 @@ type EntryDetailsProps = {
 
 export default function EntryDetails({ entry }: EntryDetailsProps) {
   const [name, setName] = useState(entry.name)
+  const [organisation, setOrganisation] = useState(entry.organisation || '')
+  const [state, setState] = useState(entry.state || '')
   const [description, setDescription] = useState(entry.description)
   const [visibility, setVisibility] = useState<UpdateEntryForm['visibility']>(entry.visibility)
   const [isLoading, setIsLoading] = useState(false)
@@ -42,6 +46,8 @@ export default function EntryDetails({ entry }: EntryDetailsProps) {
       name,
       description,
       visibility,
+      organisation: organisation || '',
+      state: state || '',
     }
     const response = await patchModel(entry.id, formData)
 
@@ -93,7 +99,9 @@ export default function EntryDetails({ entry }: EntryDetailsProps) {
             {`${toTitleCase(EntryKindLabel[entry.kind])} Details`}
           </Typography>
           <EntryNameInput autoFocus value={name} kind={entry.kind} onChange={(value) => setName(value)} />
+          <EntryOrganisationInput value={organisation} onChange={(value) => setOrganisation(value)} />
           <EntryDescriptionInput value={description} onChange={(value) => setDescription(value)} />
+          <EntryStateInput value={state} onChange={(value) => setState(value)} />
         </>
         <Divider />
         <>

frontend/types/types.ts

@@ -64,6 +64,11 @@ export interface UiConfig {
   helpPopoverText: {
     manualEntryAccess: string
   }
+
+  modelDetails: {
+    organisations: string[]
+    states: string[]
+  }
 }
 
 export interface FileInterface {
@@ -402,6 +407,8 @@ export type CreateEntryKindKeys = (typeof CreateEntryKind)[keyof typeof CreateEn
 export interface EntryInterface {
   id: string
   name: string
+  organisation?: string
+  state?: string
   kind: EntryKindKeys
   description: string
   settings: {
@@ -433,6 +440,8 @@ export interface EntryForm {
       destinationModelId?: string
     }
   }
+  organisation?: string
+  state?: string
 }
 
 export type UpdateEntryForm = Omit<EntryForm, 'kind' | 'collaborators'>

infrastructure/helm/bailo/templates/bailo/bailo.configmap.yaml

@@ -190,6 +190,11 @@ data:
         helpPopoverText: {
           manualEntryAccess: '{{ .Values.config.ui.helpPopoverText.manualEntryAccess }}'
         },
+
+        modelDetails: {
+          organisations: {{ toJson .Values.config.ui.modelDetails.organisations }},
+          states: {{ toJson .Values.config.ui.modelDetails.states }},
+        },
       },
 
       connectors: {

infrastructure/helm/bailo/values.yaml

@@ -234,6 +234,10 @@ config:
     helpPopoverText:
       manualEntryAccess: ''
 
+    modelDetails:
+      organisations: []
+      states: []
+
   smtp:
     #host: 'mail' #service name
     port: 1025