erp5_wendelin: Add Base_deleteZBigArray to manually GC ZBigArray

With the new extension method 'Base_deleteZBigArray' we can garbage
collect individual ZBigArray.

bt5/erp5_wendelin/ExtensionTemplateItem/portal_components/extension.erp5.Wendelin.py

@@ -4,6 +4,17 @@
 """
 from wendelin.bigarray.array_zodb import ZBigArray
 import numpy as np
+import ZODB
+import transaction
+from ZODB.FileStorage import FileStorage
+try:  # duplication wrt neo/client/patch
+  from ZODB.Connection import TransactionMetaData
+except ImportError: # BBB: ZODB < 5
+  from ZODB.BaseStorage import TransactionRecord
+  TransactionMetaData = lambda user='', description='', extension=None: \
+      TransactionRecord(None, None, user, description, extension)
+import sys
+
 
 def DataStream_copyCSVToDataArray(data_stream, chunk_list, start, end, \
                                   data_array_reference=None):
@@ -58,3 +69,40 @@ def DataStream_copyCSVToDataArray(data_stream, chunk_list, start, end, \
   zarray[-ndarray_shape[0]:] = ndarray
   
   return start, end
+
+
+def Base_deleteZBigArray(zbigarray):
+  conn = zbigarray._p_jar
+  storage = conn.db().storage
+
+  txn = TransactionMetaData()
+
+  def rm(obj):
+    _deleteObject(obj, txn, storage)
+
+  storage.tpc_begin(txn)
+
+  zfile = zbigarray.zfile
+  blktab = zfile.blktab
+
+  for _, b in blktab.items():
+    rm(b)
+
+  for obj in (blktab, zfile, zbigarray):
+    rm(obj)
+
+  storage.tpc_vote(txn)
+  storage.tpc_finish(txn)
+  transaction.commit()
+
+
+def _deleteObject(obj, txn, storage):
+  oid, tid = obj._p_oid, obj._p_serial
+  try:
+    storage.deleteObject(oid, tid, txn)
+  except (
+    KeyError,
+    ZODB.POSException.POSKeyError,
+    ZODB.POSException.ConflictError
+  ):
+    pass

bt5/erp5_wendelin/ExtensionTemplateItem/portal_components/extension.erp5.Wendelin.xml

@@ -6,12 +6,6 @@
     </pickle>
     <pickle>
       <dictionary>
-        <item>
-            <key> <string>_recorded_property_dict</string> </key>
-            <value>
-              <persistent> <string encoding="base64">AAAAAAAAAAI=</string> </persistent>
-            </value>
-        </item>
         <item>
             <key> <string>default_reference</string> </key>
             <value> <string>Wendelin</string> </value>
@@ -55,28 +49,13 @@
         <item>
             <key> <string>workflow_history</string> </key>
             <value>
-              <persistent> <string encoding="base64">AAAAAAAAAAM=</string> </persistent>
+              <persistent> <string encoding="base64">AAAAAAAAAAI=</string> </persistent>
             </value>
         </item>
       </dictionary>
     </pickle>
   </record>
   <record id="2" aka="AAAAAAAAAAI=">
-    <pickle>
-      <global name="PersistentMapping" module="Persistence.mapping"/>
-    </pickle>
-    <pickle>
-      <dictionary>
-        <item>
-            <key> <string>data</string> </key>
-            <value>
-              <dictionary/>
-            </value>
-        </item>
-      </dictionary>
-    </pickle>
-  </record>
-  <record id="3" aka="AAAAAAAAAAM=">
     <pickle>
       <global name="PersistentMapping" module="Persistence.mapping"/>
     </pickle>
@@ -89,7 +68,7 @@
                 <item>
                     <key> <string>component_validation_workflow</string> </key>
                     <value>
-                      <persistent> <string encoding="base64">AAAAAAAAAAQ=</string> </persistent>
+                      <persistent> <string encoding="base64">AAAAAAAAAAM=</string> </persistent>
                     </value>
                 </item>
               </dictionary>
@@ -98,7 +77,7 @@
       </dictionary>
     </pickle>
   </record>
-  <record id="4" aka="AAAAAAAAAAQ=">
+  <record id="3" aka="AAAAAAAAAAM=">
     <pickle>
       <global name="WorkflowHistoryList" module="Products.ERP5Type.Workflow"/>
     </pickle>

bt5/erp5_wendelin/SkinTemplateItem/portal_skins/erp5_wendelin/Base_deleteZBigArray.xml

+<?xml version="1.0"?>
+<ZopeData>
+  <record id="1" aka="AAAAAAAAAAE=">
+    <pickle>
+      <global name="ExternalMethod" module="Products.ExternalMethod.ExternalMethod"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>_function</string> </key>
+            <value> <string>Base_deleteZBigArray</string> </value>
+        </item>
+        <item>
+            <key> <string>_module</string> </key>
+            <value> <string>Wendelin</string> </value>
+        </item>
+        <item>
+            <key> <string>id</string> </key>
+            <value> <string>Base_deleteZBigArray</string> </value>
+        </item>
+        <item>
+            <key> <string>title</string> </key>
+            <value> <string>Base_deleteZBigArray</string> </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+</ZopeData>

bt5/erp5_wendelin/TestTemplateItem/portal_components/test.erp5.testWendelin.py

 ##############################################################################
 #
-# Copyright (c) 2002-2015 Nexedi SA and Contributors. All Rights Reserved.
+# Copyright (c) 2002-2024 Nexedi SA and Contributors. All Rights Reserved.
 #
 # This program is free software: you can Use, Study, Modify and Redistribute
 # it under the terms of the GNU General Public License version 3, or (at your
@@ -882,3 +882,22 @@ result = [x for x in data_bucket_stream.getBucketIndexKeySequenceByIndex()]
     self.assertRaises(ValueError,
                       portal.Base_wendelinTextToNumpy,
                       wendelin_text)
+
+  def test_19_Base_deleteZBigArray(self):
+    """
+      Simple test to ensure 'Base_deleteZBigArray' runs without errors.
+    """
+    portal = self.portal
+    data_array = portal.newContent(portal_type = "Data Array")
+    data_array.initArray((1, 2), int)
+    self.tic()
+
+    A = data_array.getArray()
+    A.append([[1, 2] for _ in range(5000)])
+    self.tic()
+
+    data_array.setArray(None)
+    portal.Base_deleteZBigArray(A)
+    self.tic()
+
+    self.assertTrue(True)

bt5/erp5_wendelin/TestTemplateItem/portal_components/test.erp5.testWendelin.xml

@@ -39,7 +39,9 @@
         <item>
             <key> <string>text_content_warning_message</string> </key>
             <value>
-              <tuple/>
+              <tuple>
+                <string>W:907,  4: Redundant use of assertTrue with constant value True (redundant-unittest-assert)</string>
+              </tuple>
             </value>
         </item>
         <item>