feat: allow for instruments to be add to call without being selectable (#1055)

Co-authored-by: Rasmia Kulan <69144386+RasmiaKulan@users.noreply.github.com>
Co-authored-by: Rasmia Kulan <rasmia.kulan@stfc.ac.uk>

Author: TCMeldrum

apps/backend/db_patches/0180_MarkInstrumentsAsUnselectable.sql

@@ -0,0 +1,14 @@
+DO
+$$
+BEGIN
+	IF register_patch('0180_MarkInstrumentsAsUnselectable.sql', 'TCMeldrum', 'Mark instruments as unselecable for instrument picker', '2025-05-25') THEN
+	BEGIN
+
+    ALTER TABLE instruments
+    ADD COLUMN selectable boolean DEFAULT true; 
+
+    END;
+	END IF;
+END;
+$$
+LANGUAGE plpgsql;

apps/backend/src/datasources/InstrumentDataSource.ts

@@ -19,7 +19,8 @@ export interface InstrumentDataSource {
   ): Promise<{ totalCount: number; instruments: Instrument[] }>;
   getUserInstruments(userId: number): Promise<Instrument[]>;
   getInstrumentsByCallId(
-    callIds: number[]
+    callIds: number[],
+    selectableOnly?: boolean
   ): Promise<InstrumentWithAvailabilityTime[]>;
   getCallsByInstrumentId(
     instrumentId: number,

apps/backend/src/datasources/mockups/InstrumentDataSource.ts

@@ -16,15 +16,17 @@ export const dummyInstrument = new Instrument(
   'Dummy instrument 1',
   'instrument_1',
   'This is test instrument.',
-  1
+  1,
+  true
 );
 
 export const dummyInstrument2 = new Instrument(
   2,
   'Dummy instrument 2',
   'instrument_2',
   'This is test instrument.',
-  1
+  1,
+  true
 );
 
 export const dummyInstrumentWithAvailabilityTime =

apps/backend/src/datasources/postgres/InstrumentDataSource.ts

@@ -41,7 +41,8 @@ export default class PostgresInstrumentDataSource
       instrument.name,
       instrument.short_code,
       instrument.description,
-      instrument.manager_user_id
+      instrument.manager_user_id,
+      instrument.selectable
     );
   }
 
@@ -80,6 +81,7 @@ export default class PostgresInstrumentDataSource
         short_code: args.shortCode,
         description: args.description,
         manager_user_id: args.managerUserId,
+        selectable: !!args.selectable,
       })
       .into('instruments')
       .returning('*');
@@ -153,7 +155,8 @@ export default class PostgresInstrumentDataSource
   }
 
   async getInstrumentsByCallId(
-    callIds: number[]
+    callIds: number[],
+    selectableOnly?: boolean
   ): Promise<InstrumentWithAvailabilityTime[]> {
     return database
       .select([
@@ -170,6 +173,11 @@ export default class PostgresInstrumentDataSource
         'i.instrument_id': 'chi.instrument_id',
       })
       .whereIn('chi.call_id', callIds)
+      .modify((query) => {
+        if (selectableOnly) {
+          query.andWhere('i.selectable', true);
+        }
+      })
       .distinct('i.instrument_id')
       .then((instruments: InstrumentWithAvailabilityTimeRecord[]) => {
         const result = instruments.map((instrument) =>
@@ -286,6 +294,7 @@ export default class PostgresInstrumentDataSource
           short_code: instrument.shortCode,
           description: instrument.description,
           manager_user_id: instrument.managerUserId,
+          selectable: instrument.selectable,
         },
         ['*']
       )

apps/backend/src/datasources/postgres/records.ts

@@ -484,6 +484,7 @@ export interface InstrumentRecord {
   readonly description: string;
   readonly manager_user_id: number;
   readonly full_count: number;
+  readonly selectable: boolean;
 }
 
 export interface InstrumentHasProposalRecord {
@@ -823,7 +824,8 @@ export const createInstrumentObject = (instrument: InstrumentRecord) => {
     instrument.name,
     instrument.short_code,
     instrument.description,
-    instrument.manager_user_id
+    instrument.manager_user_id,
+    instrument.selectable
   );
 };
 

apps/backend/src/models/Instrument.ts

@@ -4,7 +4,8 @@ export class Instrument {
     public name: string,
     public shortCode: string,
     public description: string,
-    public managerUserId: number
+    public managerUserId: number,
+    public selectable?: boolean
   ) {}
 }
 

apps/backend/src/models/questionTypes/InstrumentPicker.ts

@@ -64,9 +64,10 @@ export const instrumentPickerDefinition: Question<DataType.INSTRUMENT_PICKER> =
           Tokens.InstrumentDataSource
         );
 
-        const instruments = await instrumentDataSource.getInstrumentsByCallId([
-          callId,
-        ]);
+        const instruments = await instrumentDataSource.getInstrumentsByCallId(
+          [callId],
+          true
+        );
 
         return {
           ...config,

apps/backend/src/mutations/InstrumentMutations.spec.ts

@@ -59,6 +59,7 @@ describe('Test Instrument Mutations', () => {
       shortCode: '2020-06-15',
       description: 'Test instrument description',
       managerUserId: 1,
+      selectable: true,
     };
 
     return expect(
@@ -74,6 +75,7 @@ describe('Test Instrument Mutations', () => {
       description: 'Test instrument description 1',
       managerUserId: 1,
       updateTechReview: true,
+      selectable: true,
     };
 
     return expect(

apps/backend/src/resolvers/mutations/CreateInstrumentMutation.ts

@@ -24,6 +24,9 @@ export class CreateInstrumentArgs {
 
   @Field(() => Int)
   public managerUserId: number;
+
+  @Field(() => Boolean, { nullable: true, defaultValue: true })
+  public selectable?: boolean;
 }
 
 @Resolver()

apps/backend/src/resolvers/mutations/UpdateInstrumentMutation.ts

@@ -31,6 +31,9 @@ export class UpdateInstrumentArgs {
 
   @Field(() => Boolean)
   public updateTechReview: boolean;
+
+  @Field(() => Boolean, { nullable: true })
+  public selectable?: boolean;
 }
 
 @ArgsType()