Cleanup Batch content type and remove getBatchUID index and column

CHANGES.rst

@@ -4,6 +4,7 @@ Changelog
 2.4.0 (unreleased)
 ------------------
 
+- #2210 Cleanup Batch content type and remove `getBatchUID` index and column
 - #2209 Migrate AnalysisRequest's ReferenceField fields to UIDReferenceField
 - #2218 Improve performance of legacy AT `UIDReferenceField`'s setter
 - #2214 Remove `DefaultContainerType` field (stale) from AnalysisRequest

src/bika/lims/adapters/widgetvisibility.py

@@ -293,7 +293,7 @@ def isVisible(self, field, mode="view", default="visible"):
         if mode == "edit":
             # This batch does not have a client assigned, but allow the client
             # field to be editable only if does not contain any sample
-            if self.context.getAnalysisRequestsBrains():
+            if self.context.getRawAnalysisRequests():
                 return "invisible"
 
         return default

src/bika/lims/browser/batch/analysisrequests.py

@@ -18,15 +18,15 @@
 # Copyright 2018-2021 by it's authors.
 # Some rights reserved, see README and LICENSE.
 
-from bika.lims import api
 from bika.lims.browser.analysisrequest import AnalysisRequestsView as BaseView
 
 
 class AnalysisRequestsView(BaseView):
 
     def __init__(self, context, request):
         super(AnalysisRequestsView, self).__init__(context, request)
+        sample_uids = self.context.getRawAnalysisRequests()
         self.contentFilter = {"portal_type": "AnalysisRequest",
-                              "getBatchUID": api.get_uid(self.context),
+                              "UID": sample_uids,
                               "sort_on": "created",
                               "sort_order": "reverse"}

src/bika/lims/content/analysisrequest.py

@@ -1515,11 +1515,14 @@ def getBatch(self):
         else:
             return self.Schema()['Batch'].get(self)
 
-    @security.public
+    @deprecated("Use getRawBatch instead. Will be removed in SENAITE 3.0")
     def getBatchUID(self):
-        batch = self.getBatch()
-        if batch:
-            return batch.UID()
+        """Returns the UID of the Batch assigned to this sample
+
+        Backwards compatibility for removed getBatchUID indexes/columns:
+        https://github.com/senaite/senaite.core/pull/2210
+        """
+        return self.getRawBatch()
 
     @security.public
     def setBatch(self, value=None):

src/bika/lims/content/batch.py

@@ -23,6 +23,7 @@
 from bika.lims import bikaMessageFactory as _
 from bika.lims import deprecated
 from bika.lims.browser.fields.remarksfield import RemarksField
+from bika.lims.browser.fields.uidreferencefield import get_backreferences
 from bika.lims.browser.widgets import DateTimeWidget
 from bika.lims.browser.widgets import ReferenceWidget
 from bika.lims.browser.widgets import RemarksWidget
@@ -168,12 +169,15 @@ def getClient(self):
             return client
         return None
 
+    @deprecated("Will be removed in SENAITE 3.0")
     def getContactTitle(self):
         return ""
 
+    @deprecated("Will be removed in SENAITE 3.0")
     def getProfilesTitle(self):
         return ""
 
+    @deprecated("Will be removed in SENAITE 3.0")
     def getAnalysisService(self):
         analyses = set()
         for ar in self.getAnalysisRequests():
@@ -186,6 +190,7 @@ def getAnalysisService(self):
                 value.append(val)
         return list(value)
 
+    @deprecated("Will be removed in SENAITE 3.0")
     def getAnalysts(self):
         analyses = []
         for ar in self.getAnalysisRequests():
@@ -220,21 +225,32 @@ def BatchLabelVocabulary(self):
             ret.append((p.UID, p.Title))
         return DisplayList(ret)
 
+    @deprecated("Use getAnalysisRequests(full_objects=False, **kwargs) instead. Will be removed in SENAITE 3.0")
     def getAnalysisRequestsBrains(self, **kwargs):
         """Return all the Analysis Requests brains linked to the Batch
         kargs are passed directly to the catalog.
+
+        Backwards compatibility for removed getBatchUID indexes/columns:
+        https://github.com/senaite/senaite.core/pull/2210
+        """
+        kwargs.update({"full_objects": False})
+        return self.getAnalysisRequests(**kwargs)
+
+    def getRawAnalysisRequests(self):
+        """Returns the UIDs of all AnalysisRequests assigned to this Batch
         """
-        kwargs['getBatchUID'] = self.UID()
-        catalog = getToolByName(self, SAMPLE_CATALOG)
-        brains = catalog(kwargs)
-        return brains
+        return get_backreferences(self, "AnalysisRequestBatch")
 
     def getAnalysisRequests(self, **kwargs):
         """Return all the Analysis Requests objects linked to the Batch kargs
         are passed directly to the catalog.
         """
-        brains = self.getAnalysisRequestsBrains(**kwargs)
-        return [b.getObject() for b in brains]
+        full_objects = kwargs.pop("full_objects", True)
+        kwargs.update({"UID": self.getRawAnalysisRequests()})
+        brains = api.search(kwargs, SAMPLE_CATALOG)
+        if not full_objects:
+            return brains
+        return [api.get_object(brain) for brain in brains]
 
     def isOpen(self):
         """Returns true if the Batch is in 'open' state
@@ -251,10 +267,10 @@ def getProgress(self):
         """Returns the progress in percent of all samples
         """
         total_progress = 0
-        samples = self.getAnalysisRequests()
+        samples = self.getAnalysisRequests(full_objects=False)
         total = len(samples)
         if total > 0:
-            sample_progresses = map(lambda s: s.getProgress(), samples)
+            sample_progresses = map(lambda s: s.getProgress, samples)
             total_progress = sum(sample_progresses) / total
         return total_progress
 

src/senaite/core/catalog/sample_catalog.py

@@ -13,7 +13,6 @@
 INDEXES = BASE_INDEXES + [
     # id, indexed attribute, type
     ("assigned_state", "", "FieldIndex"),
-    ("getBatchUID", "", "FieldIndex"),
     ("getClientID", "", "FieldIndex"),
     ("getClientSampleID", "", "FieldIndex"),
     ("getClientTitle", "", "FieldIndex"),
@@ -43,7 +42,6 @@
     "assigned_state",
     "getAnalysesNum",
     "getBatchID",
-    "getBatchUID",
     "getBatchURL",
     "getClientID",
     "getClientOrderNumber",

src/senaite/core/profiles/default/metadata.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <metadata>
-  <version>2408</version>
+  <version>2409</version>
   <dependencies>
     <dependency>profile-Products.ATContentTypes:base</dependency>
     <dependency>profile-Products.CMFEditions:CMFEditions</dependency>

src/senaite/core/upgrade/v02_04_000.py

@@ -323,3 +323,21 @@ def migrate_reference_fields(obj, field_names):
 
         # Remove this relationship from reference catalog
         ref_tool.deleteReferences(obj, relationship=ref_id)
+
+
+def cleanup_batch_type(tool):
+    """Cleanup of functions of Batch type, that entails the removal of some
+    catalog indexes and metadata
+    """
+    logger.info("Cleanup batch content type ...")
+    indexes_to_remove = [
+        ("getBatchUID", SAMPLE_CATALOG),
+    ]
+    columns_to_remove = [
+        ("getBatchUID", SAMPLE_CATALOG),
+    ]
+
+    # Purge the catalogs
+    purge_catalogs(indexes_to_remove, columns_to_remove)
+
+    logger.info("Cleanup batch content type [DONE]")

src/senaite/core/upgrade/v02_04_000.zcml

@@ -83,4 +83,14 @@
       handler="senaite.core.upgrade.v02_04_000.migrate_analysisrequest_referencefields"
       profile="senaite.core:default"/>
 
+  <!-- Cleanup Batch content type
+       https://github.com/senaite/senaite.core/pull/2210 -->
+  <genericsetup:upgradeStep
+      title="SENAITE CORE 2.4.0: Cleanup Batch content type"
+      description="Optimizes functions from Batch type and removes indexes and columns that are no longer required"
+      source="2408"
+      destination="2409"
+      handler="senaite.core.upgrade.v02_04_000.cleanup_batch_type"
+      profile="senaite.core:default"/>
+
 </configure>