Make UIDReferenceField to not keep back-references by default

CHANGES.rst

@@ -4,6 +4,7 @@ Changelog
 2.4.0 (unreleased)
 ------------------
 
+- #2219 Make `UIDReferenceField` to not keep back-references by default
 - #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/browser/fields/uidreferencefield.py

@@ -39,9 +39,8 @@ class ReferenceException(Exception):
 
 class UIDReferenceField(StringField):
     """A field that stores References as UID values.  This acts as a drop-in
-    replacement for Archetypes' ReferenceField.  A relationship is required
-    but if one is not provided, it will be composed from a concatenation
-    of `portal_type` + `fieldname`.
+    replacement for Archetypes' ReferenceField. If no relationship is provided,
+    the field won't keep backreferences in referenced objects
     """
     _properties = Field._properties.copy()
     _properties.update({
@@ -55,6 +54,17 @@ class UIDReferenceField(StringField):
 
     security = ClassSecurityInfo()
 
+    @property
+    def keep_backreferences(self):
+        """Returns whether this field must keep back references. Returns True
+        if the value for property relationship is None
+        """
+        if not isinstance(self.relationship, six.string_types):
+            return False
+        if not self.relationship:
+            return False
+        return True
+
     def get_relationship_key(self, context):
         """Return the configured relationship key or generate a new one
         """
@@ -231,7 +241,8 @@ def set(self, context, value, **kwargs):
         uids = filter(api.is_uid, uids)
 
         # Back-reference current object to referenced objects
-        self._set_backreferences(context, uids, **kwargs)
+        if self.keep_backreferences:
+            self._set_backreferences(context, uids, **kwargs)
 
         # Store the referenced objects as uids
         if not self.multiValued:

src/bika/lims/content/abstractanalysis.py

@@ -66,7 +66,8 @@
 Attachment = UIDReferenceField(
     'Attachment',
     multiValued=1,
-    allowed_types=('Attachment',)
+    allowed_types=('Attachment',),
+    relationship='AnalysisAttachment'
 )
 
 # The final result of the analysis is stored here.  The field contains a
@@ -88,7 +89,8 @@
 
 # Returns the retracted analysis this analysis is a retest of
 RetestOf = UIDReferenceField(
-    'RetestOf'
+    'RetestOf',
+    relationship="AnalysisRetestOf",
 )
 
 # If the result is outside of the detection limits of the method or instrument,
@@ -1127,7 +1129,7 @@ def getRetestOfUID(self):
     def getRawRetest(self):
         """Returns the UID of the retest that comes from this analysis, if any
         """
-        relationship = "{}RetestOf".format(self.portal_type)
+        relationship = self.getField("RetestOf").relationship
         uids = get_backreferences(self, relationship)
         if not uids:
             return None

src/bika/lims/content/analysisrequest.py

@@ -230,7 +230,12 @@
         'Client',
         required=1,
         allowed_types=('Client',),
-        relationship='AnalysisRequestClient',
+        # Do not back-reference. This field is only used for the rendering of
+        # the reference widget in Add Form. An AnalysisRequest is always
+        # created inside a Client object. Therefore, there is no need to keep
+        # back references. Since the Client object is not updated, this should
+        # also reduce the chance of transaction conflicts as well
+        relationship=None,
         mode="rw",
         read_permission=View,
         write_permission=FieldEditClient,

src/bika/lims/content/analysisservice.py

@@ -98,6 +98,7 @@
     "Calculation",
     schemata="Method",
     required=0,
+    relationship="AnalysisServiceCalculation",
     vocabulary="_default_calculation_vocabulary",
     allowed_types=("Calculation", ),
     accessor="getRawCalculation",

src/bika/lims/content/calculation.py

@@ -71,6 +71,7 @@
         'DependentServices',
         required=1,
         multiValued=1,
+        relationship="CalculationDependentServices",
         allowed_types=('AnalysisService',),
         widget=ReferenceWidget(
             checkbox_bound=0,

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,38 @@ def migrate_reference_fields(obj, field_names):
 
         # Remove this relationship from reference catalog
         ref_tool.deleteReferences(obj, relationship=ref_id)
+
+
+def rename_retestof_relationship(tool):
+    """Renames the relationship for field RetestOf from the format
+    '<portal-type>RetestOf' to 'AnalysisRetestOf'. This field is inherited by
+    different analysis-like types and since we now assume that if no
+    relationship is explicitly set, UIDReferenceField does not keep
+    back-references, we need to update the relationship for those objects that
+    are not from 'Analysis' portal_type
+    """
+    logger.info("Rename RetestOf relationship ...")
+    uc = api.get_tool("uid_catalog")
+    portal_types = ['DuplicateAnalysis', 'ReferenceAnalysis', 'RejectAnalysis']
+    brains = uc(portal_type=portal_types)
+    total = len(brains)
+    for num, brain in enumerate(brains):
+        if num and num % 100 == 0:
+            logger.info("Rename RetestOf relationship {}/{}"
+                        .format(num, total))
+
+        if num and num % 1000 == 0:
+            transaction.savepoint()
+
+        # find out if the current analysis is a retest
+        obj = api.get_object(brain)
+        field = obj.getField("RetestOf")
+        retest_of = field.get(obj)
+        if retest_of:
+            # re-link referenced object
+            field.link_reference(retest_of, obj)
+
+        # Flush the object from memory
+        obj._p_deactivate()
+
+    logger.info("Rename RetestOf relationship [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"/>
 
+  <!-- Rename RetestOf relationship
+       https://github.com/senaite/senaite.core/pull/2219 -->
+  <genericsetup:upgradeStep
+      title="SENAITE CORE 2.4.0: Rename RetestOf relationship"
+      description="Rename RetestOf relationship"
+      source="2408"
+      destination="2409"
+      handler="senaite.core.upgrade.v02_04_000.rename_retestof_relationship"
+      profile="senaite.core:default"/>
+
 </configure>