Reduce conflict errors on number generation

CHANGES.rst

@@ -4,6 +4,7 @@ Changelog
 2.4.0 (unreleased)
 ------------------
 
+- #2258 Reduce conflict errors on number generation
 - #2256 Do not keep DX UID reference field back-references per default
 - #2257 Fix UnicodeEncode error when viewing report objects
 - #2254 Fix attachments to be ignored are included in email results view

src/bika/lims/configure.zcml

@@ -72,9 +72,4 @@
       layer="bika.lims.interfaces.IBikaLIMS"
       />
 
-  <utility
-      provides="bika.lims.interfaces.INumberGenerator"
-      factory=".numbergenerator.NumberGenerator"
-      />
-
 </configure>

src/bika/lims/content/bikasetup.py

@@ -37,7 +37,6 @@
 from bika.lims.config import WEEKDAYS
 from bika.lims.content.bikaschema import BikaFolderSchema
 from bika.lims.interfaces import IBikaSetup
-from bika.lims.numbergenerator import INumberGenerator
 from bika.lims.vocabularies import getStickerTemplates as _getStickerTemplates
 from plone.app.folder import folder
 from Products.Archetypes.atapi import BooleanField
@@ -61,6 +60,7 @@
 from senaite.core.api import geo
 from senaite.core.browser.fields.records import RecordsField
 from senaite.core.interfaces import IHideActionsMenu
+from senaite.core.interfaces import INumberGenerator
 from senaite.core.p3compat import cmp
 from zope.component import getUtility
 from zope.interface import implements

src/bika/lims/idserver.py

@@ -20,7 +20,10 @@
 
 import itertools
 import re
+from datetime import datetime
+
 import six
+
 import transaction
 from bika.lims import api
 from bika.lims import logger
@@ -36,15 +39,13 @@
 from bika.lims.interfaces import IIdServer
 from bika.lims.interfaces import IIdServerTypeID
 from bika.lims.interfaces import IIdServerVariables
-from bika.lims.numbergenerator import INumberGenerator
 from DateTime import DateTime
-from datetime import datetime
 from Products.ATContentTypes.utils import DT2dt
+from senaite.core.interfaces import INumberGenerator
 from zope.component import getAdapters
 from zope.component import getUtility
 from zope.component import queryAdapter
 
-
 AR_TYPES = [
     "AnalysisRequest",
     "AnalysisRequestRetest",

src/bika/lims/interfaces/__init__.py

@@ -873,11 +873,6 @@ def get_front_page_url(self):
         """
 
 
-class INumberGenerator(Interface):
-    """A utility to generates unique numbers by key
-    """
-
-
 class ITopRightHTMLComponentsHook(Interface):
     """Marker interface to hook html components in bikalisting
     """

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

@@ -21,9 +21,9 @@
 from bika.lims import api
 from bika.lims import bikaMessageFactory as _
 from bika.lims.idserver import get_config
-from bika.lims.numbergenerator import INumberGenerator
 from Products.Five import BrowserView
 from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
+from senaite.core.interfaces import INumberGenerator
 from zope.component import getUtility
 from zope.interface import Interface
 from zope.interface import implements

src/senaite/core/configure.zcml

@@ -23,6 +23,7 @@
   <include package=".registry" />
   <include package=".schema" />
   <include package=".upgrade" />
+  <include package=".utilities" />
   <include package=".z3cform" />
 
   <!-- portal skins -->

src/senaite/core/interfaces/__init__.py

@@ -75,6 +75,11 @@ def modified(data):
         """
 
 
+class INumberGenerator(Interface):
+    """A utility to generates unique numbers by key
+    """
+
+
 class IContainer(Interface):
     """SENAITE Base Container
     """

src/senaite/core/tests/doctests/IDServer.rst

@@ -43,7 +43,7 @@ Needed Imports:
     >>> from bika.lims import alphanumber as alpha
     >>> from bika.lims import api
     >>> from bika.lims import idserver
-    >>> from bika.lims.interfaces import INumberGenerator
+    >>> from senaite.core.interfaces import INumberGenerator
     >>> from bika.lims.utils.analysisrequest import create_analysisrequest
     >>> from bika.lims.workflow import doActionFor as do_action_for
 
@@ -225,7 +225,7 @@ Change ID formats and create new `AnalysisRequest`:
 Re-seed and create a new `Batch`:
 
     >>> from zope.component import getUtility
-    >>> from bika.lims.numbergenerator import INumberGenerator
+    >>> from senaite.core.interfaces import INumberGenerator
     >>> ng = getUtility(INumberGenerator)
     >>> seed = ng.set_number("batch-BA", 10)
 

src/senaite/core/utilities/configure.zcml

@@ -0,0 +1,10 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:browser="http://namespaces.zope.org/browser">
+
+  <utility
+      provides="senaite.core.interfaces.INumberGenerator"
+      factory=".numbergenerator.NumberGenerator"
+      />
+
+</configure>

src/bika/lims/numbergenerator.py → src/senaite/core/utilities/numbergenerator.py

@@ -19,33 +19,33 @@
 # Some rights reserved, see README and LICENSE.
 
 import thread
-import logging
-from bika.lims.interfaces import INumberGenerator
+
+from bika.lims import logger
 from BTrees.OIBTree import OIBTree
 from plone import api
+from senaite.core.interfaces import INumberGenerator
 from zope.annotation.interfaces import IAnnotations
 from zope.interface import implements
 
-
-
 lock = thread.allocate_lock()
 
-logger = logging.getLogger("bika.lims.idserver")
+STORAGE_KEY = "bika.lims.numbercounter"
+NUMBER_STORAGE = "bika.lims.consecutive_numbers_storage"
 
-STORAGE_KEY  = "bika.lims.numbercounter"
-STORAGE_HASH = "bika.lims.numbercounter.hash"
 
-NUMBER_STORAGE = "bika.lims.consecutive_numbers_storage"
+def get_portal():
+    return api.portal.getSite()
 
 
 def get_storage_location():
     """ get the portal with the plone.api
     """
-    location = api.portal.getSite()
+    location = get_portal()
     if location.get('bika_setup', False):
         location = location['bika_setup']
     return location
 
+
 def get_portal_annotation():
     """ annotation storage bound to the portal
     """
@@ -63,7 +63,7 @@ def storage(self):
         """
         annotation = get_portal_annotation()
         if annotation.get(NUMBER_STORAGE) is None:
-            annotation[NUMBER_STORAGE]  = OIBTree()
+            annotation[NUMBER_STORAGE] = OIBTree()
         return annotation[NUMBER_STORAGE]
 
     def flush(self):
@@ -97,43 +97,35 @@ def get(self, key, default=None):
     def get_number(self, key):
         """ get the next consecutive number
         """
-        storage = self.storage
-
-        logger.debug("NUMBER before => %s" % storage.get(key, '-'))
+        logger.debug("NUMBER before => %s" % self.storage.get(key, '-'))
         try:
             logger.debug("*** consecutive number lock acquire ***")
             lock.acquire()
             try:
-                counter = storage[key]
-                storage[key] = counter + 1
+                counter = self.storage[key]
+                self.storage[key] = counter + 1
             except KeyError:
-                storage[key] = 1
+                self.storage[key] = 1
         finally:
             logger.debug("*** consecutive number lock release ***")
-            self.storage._p_changed = True
             lock.release()
 
-        logger.debug("NUMBER after => %s" % storage.get(key, '-'))
-        return storage[key]
+        logger.debug("NUMBER after => %s" % self.storage.get(key, '-'))
+        return self.storage[key]
 
     def set_number(self, key, value):
         """ set a key's value
         """
-        storage = self.storage
-
         if not isinstance(value, int):
             logger.error("set_number: Value must be an integer")
             return
-
         try:
             lock.acquire()
-            storage[key] = value
+            self.storage[key] = value
         finally:
-            self.storage._p_changed = True
             lock.release()
 
-        return storage[key]
-
+        return self.storage[key]
 
     def generate_number(self, key="default"):
         """ get a number