Rust demo presentation v1

.env.development

@@ -1,6 +1,7 @@
 VITE_TRACTION_BASE_URL=http://traction
 VITE_PRINTMYBARCODE_BASE_URL=http://printmybarcode
 VITE_LABWHERE_BASE_URL=http://localhost:3003
+VITE_LABWHERE_V2_BASE_URL=http://localhost:3000
 VITE_SEQUENCESCAPE_API_KEY=development
 VITE_LOG=true
 VITE_ENVIRONMENT=development

.env.production

@@ -2,6 +2,7 @@ VITE_TRACTION_BASE_URL=REPLACE_VITE_TRACTION_BASE_URL
 VITE_PRINTMYBARCODE_BASE_URL=REPLACE_VITE_PRINTMYBARCODE_BASE_URL
 VITE_SEQUENCESCAPE_BASE_URL=REPLACE_VITE_SEQUENCESCAPE_BASE_URL
 VITE_LABWHERE_BASE_URL=REPLACE_VITE_LABWHERE_BASE_URL
+VITE_LABWHERE_V2_BASE_URL=REPLACE_VITE_LABWHERE_V2_BASE_URL
 VITE_SEQUENCESCAPE_API_KEY=REPLACE_VITE_SEQUENCESCAPE_API_KEY
 VITE_ENVIRONMENT=REPLACE_VITE_ENVIRONMENT
 VITE_DESTROYED_LOCATION_BARCODE=REPLACE_VITE_LABWHERE_DESTROY_LOCATION_BARCODE

.env.uat

@@ -2,6 +2,7 @@ VITE_TRACTION_BASE_URL=REPLACE_VITE_TRACTION_BASE_URL
 VITE_PRINTMYBARCODE_BASE_URL=REPLACE_VITE_PRINTMYBARCODE_BASE_URL
 VITE_SEQUENCESCAPE_BASE_URL=REPLACE_VITE_SEQUENCESCAPE_BASE_URL
 VITE_LABWHERE_BASE_URL=REPLACE_VITE_LABWHERE_BASE_URL
+VITE_LABWHERE_V2_BASE_URL=REPLACE_VITE_LABWHERE_V2_BASE_URL
 VITE_SEQUENCESCAPE_API_KEY=REPLACE_VITE_SEQUENCESCAPE_API_KEY
 VITE_ENVIRONMENT=REPLACE_VITE_ENVIRONMENT
 VITE_DESTROYED_LOCATION_BARCODE=REPLACE_VITE_LABWHERE_DESTROY_LOCATION_BARCODE

src/api/FeatureFlag.js

@@ -0,0 +1,15 @@
+/**
+ * Checks if a feature flag is enabled.
+ * @param {string} featureFlag - The name of the feature flag to check.
+ * @returns {boolean} - A true or false status on whether the feature flag is enabled.
+ */
+
+const checkFeatureFlag = async (featureFlag) => {
+  const response = await fetch(`${import.meta.env.VITE_TRACTION_BASE_URL}/flipper/api/actors/User`)
+  const flags = await response.json()
+  return flags?.features?.[featureFlag]?.enabled == true
+}
+
+export { checkFeatureFlag }
+
+export default checkFeatureFlag

src/composables/useLocationFetcher.js

@@ -1,5 +1,6 @@
-import { getLabwhereLocations } from '@/services/labwhere/client.js'
+import { getLabwhereLocations, getLabwhereLocationsV2 } from '@/services/labwhere/client.js'
 import { formatLocations } from '@/services/labwhere/helpers.js'
+import { checkFeatureFlag } from '@/api/FeatureFlag.js'
 
 /**
  * A composable function to fetch and format location data for given barcodes.
@@ -23,12 +24,16 @@ export default function useLocationFetcher() {
       name: '-', // Default name for missing barcodes
     }))
 
+    const fn = (await checkFeatureFlag('rust_labwhere_service'))
+      ? getLabwhereLocationsV2
+      : getLabwhereLocations
+
     try {
       const trimmedBarcodes = barcodes.map((barcode) =>
         barcode.includes(':') ? barcode.split(':')[0] : barcode,
       )
 
-      const extractedLocations = await getLabwhereLocations(trimmedBarcodes)
+      const extractedLocations = await fn(trimmedBarcodes)
       locationData = formatLocations(extractedLocations)
     } catch (error) {
       console.error('Error fetching locations:', error)

src/services/labwhere/client.js

@@ -7,6 +7,7 @@ import {
 import { getPacbioLibraryResources } from '@/services/traction/PacbioLibrary.js'
 
 const labwhereFetch = FetchWrapper(import.meta.env['VITE_LABWHERE_BASE_URL'], 'LabWhere')
+const labwhereFetchV2 = FetchWrapper(import.meta.env['VITE_LABWHERE_V2_BASE_URL'], 'LabWhere')
 const destroyLocation = import.meta.env['VITE_DESTROYED_LOCATION_BARCODE']
 /**
  * Fetches the locations of labwares from LabWhere based on provided barcodes.
@@ -146,4 +147,98 @@ const exhaustLibraryVolumeIfDestroyed = async (locationBarcode, labwareBarcodes)
   )
   return { success: exhaustedLibraries.length > 0, exhaustedLibraries }
 }
-export { getLabwhereLocations, scanBarcodesInLabwhereLocation, exhaustLibraryVolumeIfDestroyed }
+
+/**
+ * Scans labware barcodes into a specified location in LabWhere (V2 API with Rust).
+ *
+ * @param {string} locationBarcode - The barcode of the location where labware will be stored.
+ * @param {string} labwareBarcodes - The barcodes of the labware to be stored, separated by newlines.
+ * @param {Object} [fetchWrapper=labwhereFetchV2] - The fetch wrapper to use for the request (optional).
+ * @returns {Promise<{success: boolean, errors: string[], message: string}>} - A promise that resolves to an object containing:
+ * - `success` (boolean): Whether the operation was successful.
+ * - `errors` (string[]): An array of error messages, if any.
+ * - `message` (string): A message describing the result of the operation.
+ *
+ * @example
+ * const locationBarcode = 'location123';
+ * const labwareBarcodes = 'barcode1\nbarcode2';
+ * scanBarcodesInLabwhereLocationV2(locationBarcode, labwareBarcodes).then(response => {
+ *   if (response.success) {
+ *     console.log('Barcodes scanned successfully:', response.message);
+ *   } else {
+ *     console.error('Errors:', response.errors);
+ *   }
+ * });
+ */
+const scanBarcodesInLabwhereLocationV2 = async (
+  userCode,
+  locationBarcode,
+  labwareBarcodes,
+  startPosition,
+  fetchWrapper = labwhereFetchV2,
+) => {
+  if (!labwareBarcodes) {
+    return { success: false, errors: ['Required parameters are missing for the Scan In operation'] }
+  }
+  const response = await fetchWrapper.post(
+    '/scan',
+    JSON.stringify({
+      labware_barcodes: labwareBarcodes,
+      location_barcode: locationBarcode,
+    }),
+  )
+
+  return { success: response.success, errors: response.errors, message: response.data.message }
+}
+
+/**
+ * Fetches labware locations from Labwhere using the provided barcodes.
+ *
+ * @async
+ * @function getLabwhereLocationsV2
+ * @param {string[]} labwhereBarcodes - An array of labware barcodes to search for.
+ * @param {Object} [fetchWrapper=labwhereFetchv2] - An optional fetch wrapper for making HTTP requests.
+ * @param {Function} fetchWrapper.post - A function to perform POST requests.
+ * @returns {Promise<Object>} A promise that resolves to an object containing:
+ *   - `success` {boolean}: Indicates whether the request was successful.
+ *   - `errors` {string[]}: An array of error messages, if any.
+ *   - `data` {Object}: The response data, including extracted locations for the provided barcodes.
+ *
+ * @throws {Error} Throws an error if the fetch request fails.
+ *
+ * @example
+ * const barcodes = ['ABC123', 'DEF456'];
+ * const result = await getLabwhereLocationsV2(barcodes);
+ * if (result.success) {
+ *   console.log('Locations:', result.data);
+ * } else {
+ *   console.error('Errors:', result.errors);
+ * }
+ */
+const getLabwhereLocationsV2 = async (labwhereBarcodes, fetchWrapper = labwhereFetchV2) => {
+  // If no barcodes are provided, return a failed response.
+  if (!labwhereBarcodes || labwhereBarcodes.length === 0) {
+    return { success: false, errors: ['No barcodes provided'], data: {} }
+  }
+
+  const response = await fetchWrapper.post(
+    '/searches',
+    JSON.stringify({
+      labware_barcodes: labwhereBarcodes.join('\n'),
+    }),
+    'application/json',
+  )
+
+  if (response.success) {
+    response.data = extractLocationsForLabwares(response.data, labwhereBarcodes)
+  }
+  return response
+}
+
+export {
+  getLabwhereLocations,
+  getLabwhereLocationsV2,
+  scanBarcodesInLabwhereLocation,
+  exhaustLibraryVolumeIfDestroyed,
+  scanBarcodesInLabwhereLocationV2,
+}

src/views/LabwhereReception.vue

@@ -101,8 +101,10 @@ import { ref, reactive, computed } from 'vue'
 import {
   scanBarcodesInLabwhereLocation,
   exhaustLibraryVolumeIfDestroyed,
+  scanBarcodesInLabwhereLocationV2,
 } from '@/services/labwhere/client.js'
 import useAlert from '@/composables/useAlert.js'
+import { checkFeatureFlag } from '@/api/FeatureFlag.js'
 
 const user_code = ref('') // User code or swipecard
 const location_barcode = ref('') // Location barcode
@@ -166,8 +168,12 @@ const uniqueBarcodesArray = computed(() => {
  *
  */
 const scanBarcodesToLabwhere = async () => {
+  const fn = (await checkFeatureFlag('rust_labwhere_service'))
+    ? scanBarcodesInLabwhereLocationV2
+    : scanBarcodesInLabwhereLocation
+
   if (validateForm()) {
-    const response = await scanBarcodesInLabwhereLocation(
+    const response = await fn(
       user_code.value,
       location_barcode.value,
       uniqueBarcodesArray.value.join('\n'),

tests/e2e/specs/ont/ont_pools_view.cy.js

@@ -2,6 +2,11 @@ import OntPoolFactory from '../../../factories/OntPoolFactory.js'
 import PrinterFactory from '../../../factories/PrinterFactory.js'
 
 describe('Ont pools view', () => {
+  beforeEach(() => {
+    cy.withFlags({
+      rust_labwhere_service: { enabled: false },
+    })
+  })
   it('Visits the ont pools url', () => {
     cy.wrap(OntPoolFactory.all()).as('ontPoolFactory')
     cy.get('@ontPoolFactory').then((ontPoolFactory) => {

tests/e2e/specs/ont/ont_samples_view.cy.js

@@ -9,6 +9,9 @@ describe('Ont samples view', () => {
         body: ontRequestFactory.content,
       })
     })
+    cy.withFlags({
+      rust_labwhere_service: { enabled: false },
+    })
     // Stub labwhere request
     cy.get('@ontRequestFactory').then((ontRequestFactory) => {
       const labwhereUrl = Cypress.env('VITE_LABWHERE_BASE_URL')

tests/e2e/specs/pacbio/pacbio_libraries_view.cy.js

@@ -4,6 +4,9 @@ import PacbioLibraryFactory from '../../../factories/PacbioLibraryFactory.js'
 
 describe('Pacbio Libraries view', () => {
   beforeEach(() => {
+    cy.withFlags({
+      rust_labwhere_service: { enabled: false },
+    })
     cy.wrap(PacbioTagSetFactory()).as('pacbioTagSetFactory')
     cy.wrap(PrinterFactory()).as('printerFactory')
     cy.wrap(PacbioLibraryFactory()).as('pacbioLibraryFactory')

tests/e2e/specs/pacbio/pacbio_pool_edit.cy.js

@@ -5,6 +5,9 @@ import PacbioPlateFactory from '../../../factories/PacbioPlateFactory.js'
 
 describe('Pacbio Pool Edit', () => {
   beforeEach(() => {
+    cy.withFlags({
+      rust_labwhere_service: { enabled: false },
+    })
     cy.wrap(PacbioTagSetFactory()).as('pacbioTagSetFactory')
     cy.wrap(PrinterFactory()).as('printerFactory')
 

tests/e2e/specs/pacbio/pacbio_pools_view.cy.js

@@ -2,6 +2,11 @@ import PrinterFactory from '../../../factories/PrinterFactory.js'
 import PacbioPoolFactory from '../../../factories/PacbioPoolFactory.js'
 
 describe('Pacbio Pools view', () => {
+  beforeEach(() => {
+    cy.withFlags({
+      rust_labwhere_service: { enabled: false },
+    })
+  })
   it('Visits the pacbio pools url', () => {
     cy.wrap(PacbioPoolFactory()).as('pacbioPoolFactory')
     cy.get('@pacbioPoolFactory').then((pacbioPoolFactory) => {

tests/e2e/specs/pacbio/pacbio_samples_view.cy.js

@@ -6,6 +6,9 @@ import LibraryTypeFactory from '../../../factories/LibraryTypeFactory.js'
 
 describe('Pacbio samples view', () => {
   beforeEach(() => {
+    cy.withFlags({
+      rust_labwhere_service: { enabled: false },
+    })
     cy.wrap(PacbioTagSetFactory()).as('pacbioTagSetFactory')
     cy.wrap(PrinterFactory()).as('printerFactory')
     cy.wrap(LibraryTypeFactory()).as('libraryTypeFactory')

tests/e2e/specs/visit_labwhere_reception_page.cy.js

@@ -4,6 +4,9 @@ describe('Labware Reception page', () => {
   const labwhereUrl = Cypress.env('VITE_LABWHERE_BASE_URL')
 
   beforeEach(() => {
+    cy.withFlags({
+      rust_labwhere_service: { enabled: false },
+    })
     cy.visit('#/labwhere-reception')
   })
 

tests/unit/composables/useLocationFetcher.spec.js

@@ -11,6 +11,10 @@ vi.mock('@/services/labwhere/helpers.js', () => ({
   formatLocations: vi.fn(),
 }))
 
+vi.mock('@/api/FeatureFlag.js', () => ({
+  checkFeatureFlag: vi.fn().mockReturnValue(false),
+}))
+
 describe('useLocationFetcher', () => {
   const { fetchLocations } = useLocationFetcher()
 

tests/unit/services/labwhere/client.spec.js

@@ -1,6 +1,8 @@
 import {
   getLabwhereLocations,
+  getLabwhereLocationsV2,
   scanBarcodesInLabwhereLocation,
+  scanBarcodesInLabwhereLocationV2,
   exhaustLibraryVolumeIfDestroyed,
 } from '@/services/labwhere/client.js'
 import * as pacbioLibraryUtilities from '@/stores/utilities/pacbioLibraries.js'
@@ -51,6 +53,44 @@ describe('getLabwhereLocations', () => {
   })
 })
 
+describe('getLabwhereLocationsV2', () => {
+  it('should return an error if no barcodes are provided', async () => {
+    const result = await getLabwhereLocationsV2([], mockFetchWrapper)
+    expect(result).toEqual({ success: false, errors: ['No barcodes provided'], data: {} })
+  })
+
+  it('should not call extractLocationsForLabwares if post fails', async () => {
+    const response = {
+      success: false,
+      errors: ['Failed to access LabWhere: Network error'],
+      data: {},
+    }
+    mockFetchWrapper.post.mockResolvedValue(response)
+    const result = await getLabwhereLocationsV2(['barcode1'], mockFetchWrapper)
+    expect(result).toEqual(response)
+  })
+
+  it('should call extractLocationsForLabwares if post succeeds', async () => {
+    const data = [
+      {
+        barcode: 'barcode1',
+        location: 'location1',
+      },
+      {
+        barcode: 'barcode2',
+        location: 'location2',
+      },
+    ]
+    const mockResponse = { success: true, errors: [], data }
+    mockFetchWrapper.post.mockResolvedValue(mockResponse)
+    const result = await getLabwhereLocationsV2(['barcode1', 'barcode2'], mockFetchWrapper)
+    expect(result).toEqual({
+      ...mockResponse,
+      data: { barcode1: 'location1', barcode2: 'location2' },
+    })
+  })
+})
+
 describe('scanBarcodesInLabwhereLocation', () => {
   it('should return an error if required parameters are missing', async () => {
     const result = await scanBarcodesInLabwhereLocation('', '', '', null, mockFetchWrapper)
@@ -100,7 +140,43 @@ describe('scanBarcodesInLabwhereLocation', () => {
   })
 })
 
-// TODO: remove mocks
+describe('scanBarcodesInLabwhereLocationV2', () => {
+  it('should return an error if required parameters are missing', async () => {
+    const result = await scanBarcodesInLabwhereLocationV2('', '', '', null, mockFetchWrapper)
+    expect(result).toEqual({
+      success: false,
+      errors: ['Required parameters are missing for the Scan In operation'],
+    })
+  })
+
+  it('should return formatted result for post response', async () => {
+    mockFetchWrapper.post.mockResolvedValue({
+      success: true,
+      errors: [],
+      data: { message: 'Labware stored to location 1' },
+    })
+    const result = await scanBarcodesInLabwhereLocationV2(
+      '',
+      'location1',
+      'labware1',
+      null,
+      mockFetchWrapper,
+    )
+    expect(mockFetchWrapper.post).toHaveBeenCalledWith(
+      '/scan',
+      JSON.stringify({
+        labware_barcodes: 'labware1',
+        location_barcode: 'location1',
+      }),
+    )
+    expect(result).toEqual({
+      success: true,
+      errors: [],
+      message: 'Labware stored to location 1',
+    })
+  })
+})
+
 describe('exhaustLibraryVolumeIfDestroyed', () => {
   const destroyLocation = import.meta.env['VITE_DESTROYED_LOCATION_BARCODE']
   const labwareBarcodes = ['barcode1', 'barcode2', 'barcode3']