Fix sample transition in listings (senaite#1925)

* Don't set sample date if already set

* Convert field getter names back to field name

* Imports only

* Fixed datetime conversion in sample listing when sample wf is active

* Fixed workflow adapter for sample transition in listings

* Changelog updated

* Allow to set min/max values for datetime field

Author: ramonski

CHANGES.rst

@@ -4,6 +4,7 @@ Changelog
 2.2.0 (unreleased)
 ------------------
 
+- #1925 Fix sample transition in listings
 - #1924 Fix Login screen shows message error while rendering plone.htmlhead.socialtags
 - #1923 Use native date input fields in reports
 - #1920 Fix indexed attributes not set when adding a new index with catalog API

src/bika/lims/browser/workflow/analysisrequest.py

@@ -295,14 +295,17 @@ class WorkflowActionSampleAdapter(WorkflowActionGenericAdapter):
 
     def __call__(self, action, objects):
         # Assign the Sampler and DateSampled
-        transitioned = filter(lambda obj: self.set_sampler_info(obj), objects)
-        if not transitioned:
-            return self.redirect(message=_("No changes made"), level="warning")
+        for obj in objects:
+            try:
+                self.set_sampler_info(obj)
+            except ValueError as e:
+                return self.redirect(message=str(e), level="warning")
 
         # Trigger "sample" transition
-        transitioned = self.do_action(action, transitioned)
+        transitioned = self.do_action(action, objects)
         if not transitioned:
-            return self.redirect(message=_("No changes made"), level="warning")
+            message = _("Could not transition samples to the sampled state")
+            return self.redirect(message=message, level="warning")
 
         # Redirect the user to success page
         return self.success(transitioned)
@@ -315,13 +318,29 @@ def set_sampler_info(self, sample):
         if sample.getSampler() and sample.getDateSampled():
             # Sampler and Date Sampled already set. This is correct
             return True
-        sampler = self.get_form_value("Sampler", sample, sample.getSampler())
+
+        # Try to get the sampler and date sampled from the request.
+        # This might happen when the "Sample" transition is triggered from the
+        # samples listing view (form keys == column names of the listing)
+
+        # try to get the sampler from the request
+        sampler = self.get_form_value("getSampler", sample,
+                                      sample.getSampler())
+        if not sampler:
+            sid = api.get_id(sample)
+            raise ValueError(_("Sampler required for sample %s" % sid))
+
+        # try to get the date sampled from the request
         sampled = self.get_form_value("getDateSampled", sample,
                                       sample.getDateSampled())
-        if not all([sampler, sampled]):
-            return False
+        if not sampled:
+            sid = api.get_id(sample)
+            raise ValueError(_("Sample date required for sample %s" % sid))
+
+        # set the field values
         sample.setSampler(sampler)
-        sample.setDateSampled(DateTime(sampled))
+        sample.setDateSampled(sampled)
+
         return True
 
 

src/bika/lims/workflow/analysisrequest/events.py

@@ -173,7 +173,11 @@ def after_sample(analysis_request):
     """Method triggered after "sample" transition for the Analysis Request
     passed in is performed
     """
-    analysis_request.setDateSampled(DateTime())
+    # The date might be already set by the `Sample` listing workflow action
+    date_sampled = analysis_request.getDateSampled()
+    if not date_sampled:
+        # set to current date when empty
+        analysis_request.setDateSampled(DateTime())
 
 
 def after_rollback_to_receive(analysis_request):

src/senaite/core/browser/samples/view.py

@@ -23,7 +23,7 @@
 
 from bika.lims import _
 from bika.lims import api
-from senaite.core.catalog import SAMPLE_CATALOG
+from bika.lims.api.security import check_permission
 from bika.lims.config import PRIORITIES
 from bika.lims.permissions import AddAnalysisRequest
 from bika.lims.permissions import TransitionSampleSample
@@ -33,6 +33,7 @@
 from bika.lims.utils import t
 from DateTime import DateTime
 from senaite.app.listing import ListingView
+from senaite.core.catalog import SAMPLE_CATALOG
 from senaite.core.interfaces import ISamplesView
 from zope.interface import implementer
 
@@ -66,6 +67,8 @@ def __init__(self, context, request):
         # Toggle some columns if the sampling workflow is enabled
         sampling_enabled = api.get_setup().getSamplingWorkflowEnabled()
 
+        now = DateTime().strftime("%Y-%m-%d %H:%M")
+
         self.columns = collections.OrderedDict((
             ("Priority", {
                 "title": "",
@@ -102,12 +105,13 @@ def __init__(self, context, request):
                 "title": _("Date Sampled"),
                 "toggle": True,
                 "type": "datetime",
-                "input_width": "10"}),
+                "max": now,
+                "sortable": True}),
             ("getDatePreserved", {
                 "title": _("Date Preserved"),
                 "toggle": False,
                 "type": "datetime",
-                "input_width": "10",
+                "max": now,
                 "sortable": False}),  # no datesort without index
             ("getDateReceived", {
                 "title": _("Date Received"),
@@ -506,6 +510,7 @@ def folderitem(self, obj, item, index):
         # item['SubGroup'] = val.Title() if val else ''
 
         item["SamplingDate"] = self.str_date(obj.getSamplingDate)
+        item["getDateSampled"] = self.str_date(obj.getDateSampled)
         item["getDateReceived"] = self.str_date(obj.getDateReceived)
         item["getDueDate"] = self.str_date(obj.getDueDate)
         item["getDatePublished"] = self.str_date(obj.getDatePublished)
@@ -571,58 +576,34 @@ def folderitem(self, obj, item, index):
         # full object to check the user permissions, so far this is
         # a performance hit.
         if obj.getSamplingWorkflowEnabled:
-            # We don't do anything with Sampling Date.
-            # User can modify Sampling date
-            # inside AR view. In this listing view,
-            # we only let the user to edit Date Sampled
-            # and Sampler if he wants to make 'sample' transaction.
-            if not obj.getDateSampled:
-                datesampled = self.ulocalized_time(
-                    DateTime(), long_format=True)
-                item["class"]["getDateSampled"] = "provisional"
-            else:
-                datesampled = self.ulocalized_time(obj.getDateSampled,
-                                                   long_format=True)
 
             sampler = obj.getSampler
             if sampler:
+                item["getSampler"] = obj.getSampler
                 item["replace"]["getSampler"] = obj.getSamplerFullName
-            if "Sampler" in self.roles and not sampler:
-                sampler = self.member.id
-                item["class"]["getSampler"] = "provisional"
+
             # sampling workflow - inline edits for Sampler and Date Sampled
-            if item["review_state"] == 'to_be_sampled':
+            if item["review_state"] == "to_be_sampled":
                 # We need to get the full object in order to check
                 # the permissions
-                full_object = obj.getObject()
-                checkPermission = \
-                    self.context.portal_membership.checkPermission
-
-                # TODO Do we really need this check?
-                if checkPermission(TransitionSampleSample, full_object):
+                full_object = api.get_object(obj)
+                if check_permission(TransitionSampleSample, full_object):
+                    # make fields required and editable
                     item["required"] = ["getSampler", "getDateSampled"]
                     item["allow_edit"] = ["getSampler", "getDateSampled"]
-                    # TODO-performance: hit performance while getting the
-                    # sample object...
-                    # TODO Can LabManagers be a Sampler?!
-                    samplers = getUsers(full_object, ["Sampler", ])
-                    username = self.member.getUserName()
+                    date = obj.getDateSampled or DateTime()
+                    # provide date and time in a valid input format
+                    item["getDateSampled"] = self.to_datetime_input_value(date)
+                    sampler_roles = ["Sampler", "LabManager", ""]
+                    samplers = getUsers(full_object, sampler_roles)
                     users = [({
                         "ResultValue": u,
                         "ResultText": samplers.getValue(u)}) for u in samplers]
-                    item['choices'] = {'getSampler': users}
-                    Sampler = sampler and sampler or (username in samplers.keys() and username) or ''
-                    sampler = Sampler
-                else:
-                    datesampled = self.ulocalized_time(obj.getDateSampled,
-                                                       long_format=True)
-                    sampler = obj.getSamplerFullName if obj.getSampler else ''
-        else:
-            datesampled = self.ulocalized_time(obj.getDateSampled,
-                                               long_format=True)
-            sampler = ""
-        item["getDateSampled"] = datesampled
-        item["getSampler"] = sampler
+                    item["choices"] = {"getSampler": users}
+                    # preselect the current user as sampler
+                    if not sampler and "Sampler" in self.roles:
+                        sampler = self.member.getUserName()
+                        item["getSampler"] = sampler
 
         # These don't exist on ARs
         # XXX This should be a list of preservers...
@@ -715,6 +696,13 @@ def str_date(self, date, long_format=1, default=""):
             return default
         return self.ulocalized_time(date, long_format=long_format)
 
+    def to_datetime_input_value(self, date):
+        """Converts to a compatible datetime format
+        """
+        if not isinstance(date, DateTime):
+            return ""
+        return date.strftime("%Y-%m-%d %H:%M")
+
     def getDefaultAddCount(self):
         return self.context.bika_setup.getDefaultNumberOfARsToAdd()
 

src/senaite/core/datamanagers/sample.py

@@ -28,11 +28,25 @@ def is_field_writeable(self, field):
         """
         return field.checkPermission("set", self.context)
 
+    def get_field_by_name(self, name):
+        """Get the field by name
+        """
+        field = self.fields.get(name)
+
+        # try to fetch the field w/o the `get` prefix
+        # this might be the case is some listings
+        if field is None:
+            # ensure we do not have the field setter as column
+            name = name.split("get", 1)[-1]
+            field = self.fields.get(name)
+
+        return field
+
     def get(self, name):
         """Get sample field
         """
-        # schema field
-        field = self.fields.get(name)
+        # get the schema field
+        field = self.get_field_by_name(name)
 
         # check if the field exists
         if field is None:
@@ -56,8 +70,8 @@ def set(self, name, value):
         # set of updated objects
         updated_objects = set()
 
-        # schema field
-        field = self.fields.get(name)
+        # get the schema field
+        field = self.get_field_by_name(name)
 
         if field is None:
             raise AttributeError("Field '{}' not found".format(name))