[erp5_hal_json_style] Do not generate link for empty value, as it will not be clickable in UI

Tests: do not depend on previous test executions.

bt5/erp5_hal_json_style/SkinTemplateItem/portal_skins/erp5_hal_json_style/ERP5Document_getHateoas.py

@@ -1814,72 +1814,74 @@ def calculateHateoas(is_portal=None, is_site_root=None, traversed_document=None,
             key='field_%s_%s' % (editable_field.id, brain_uid))
 
 
-        # By default, we won't be generating views in the URL
-        url_parameter_dict = None
-        if select in url_column_dict:
-          # Check if we get URL parameters using listbox field `url_columns`
-          try:
-            url_column_method = getattr(brain, url_column_dict[select])
-            # Result of `url_column_method` must be a dictionary in the format
-            # {'command': <command_name, ex: 'raw', 'push_history'>,
-            #  'options': {'url': <Absolute URL>, 'jio_key': <Relative URL of object>, 'view': <id of the view>}}
-            url_parameter_dict = url_column_method(url_dict=True,
-                                                   brain=brain,
-                                                   selection=catalog_kw['selection'],
-                                                   selection_name=catalog_kw['selection_name'],
-                                                   column_id=select)
-          except AttributeError as e:
-            # In case the URL method is invalid or empty, we expect to have no link
-            # for the column to maintain compatibility with old UI, hence we create
-            # an empty url_parameter_dict for these cases.
-            url_parameter_dict = {}
-            if url_column_dict[select]:
-              log("Invalid URL method {!s} on column {}".format(url_column_dict[select], select), level=800)
-
-        elif getattr(brain, 'getListItemUrlDict', None) is not None:
-          # Check if we can get URL result from the brain
-          try:
-            url_parameter_dict = brain.getListItemUrlDict(
-              select, result_index, catalog_kw['selection_name']
-            )
-          except (ConflictError, RuntimeError):
-            raise
-          except:
-            log('could not evaluate the url method getListItemUrlDict with %r' % brain,
-                level=800)
-
-        if isinstance(url_parameter_dict, dict):
-          # We need to put URL into rendered field so just ensure it is a dict
-          if not isinstance(contents_item[select], dict):
-            contents_item[select] = {
-              'default': contents_item[select],
-            }
-          # We should be generating view if there is extra params for view in
-          # view_kw. These parameters are required to create url at hateoas side
-          # using the URL template as necessary
-          if 'view_kw' not in url_parameter_dict:
-            contents_item[select]['url_value'] = url_parameter_dict
-          else:
-            # Get extra parameters either from url_result_dict or from brain
-            extra_url_param_dict = url_parameter_dict['view_kw'].get('extra_param_json', {})
-            url_template_id = 'traverse_generator'
-            if extra_url_param_dict:
-              url_template_id = 'traverse_generator_action'
-
-            # Explicity populate url_value dict. This way we can ensure that whatever been
-            # sent via url_parameter_dict goes directly in url_value dict
-            contents_item[select]['url_value'] = {}
-            contents_item[select]['url_value']['command'] = url_parameter_dict['command']
-            contents_item[select]['url_value']['options'] = url_parameter_dict['options']
-            # Generate `view` to be used to construct URL
-            contents_item[select]['url_value']['options']['view'] = url_template_dict[url_template_id] % {
-              "root_url": site_root.absolute_url(),
-              "script_id": script.id,
-              "relative_url": url_parameter_dict['view_kw']['jio_key'].replace("/", "%2F"),
-              "view": url_parameter_dict['view_kw']['view'],
-              "extra_param_json": urlsafe_b64encode(
-                json.dumps(ensureSerializable(extra_url_param_dict)))
+        # Do not generate link for empty value, as it will not be clickable in UI
+        if default_field_value not in ('', None):
+          # By default, we won't be generating views in the URL
+          url_parameter_dict = None
+          if select in url_column_dict:
+            # Check if we get URL parameters using listbox field `url_columns`
+            try:
+              url_column_method = getattr(brain, url_column_dict[select])
+              # Result of `url_column_method` must be a dictionary in the format
+              # {'command': <command_name, ex: 'raw', 'push_history'>,
+              #  'options': {'url': <Absolute URL>, 'jio_key': <Relative URL of object>, 'view': <id of the view>}}
+              url_parameter_dict = url_column_method(url_dict=True,
+                                                     brain=brain,
+                                                     selection=catalog_kw['selection'],
+                                                     selection_name=catalog_kw['selection_name'],
+                                                     column_id=select)
+            except AttributeError as e:
+              # In case the URL method is invalid or empty, we expect to have no link
+              # for the column to maintain compatibility with old UI, hence we create
+              # an empty url_parameter_dict for these cases.
+              url_parameter_dict = {}
+              if url_column_dict[select]:
+                log("Invalid URL method {!s} on column {}".format(url_column_dict[select], select), level=800)
+
+          elif getattr(brain, 'getListItemUrlDict', None) is not None:
+            # Check if we can get URL result from the brain
+            try:
+              url_parameter_dict = brain.getListItemUrlDict(
+                select, result_index, catalog_kw['selection_name']
+              )
+            except (ConflictError, RuntimeError):
+              raise
+            except:
+              log('could not evaluate the url method getListItemUrlDict with %r' % brain,
+                  level=800)
+
+          if isinstance(url_parameter_dict, dict):
+            # We need to put URL into rendered field so just ensure it is a dict
+            if not isinstance(contents_item[select], dict):
+              contents_item[select] = {
+                'default': contents_item[select],
               }
+            # We should be generating view if there is extra params for view in
+            # view_kw. These parameters are required to create url at hateoas side
+            # using the URL template as necessary
+            if 'view_kw' not in url_parameter_dict:
+              contents_item[select]['url_value'] = url_parameter_dict
+            else:
+              # Get extra parameters either from url_result_dict or from brain
+              extra_url_param_dict = url_parameter_dict['view_kw'].get('extra_param_json', {})
+              url_template_id = 'traverse_generator'
+              if extra_url_param_dict:
+                url_template_id = 'traverse_generator_action'
+
+              # Explicity populate url_value dict. This way we can ensure that whatever been
+              # sent via url_parameter_dict goes directly in url_value dict
+              contents_item[select]['url_value'] = {}
+              contents_item[select]['url_value']['command'] = url_parameter_dict['command']
+              contents_item[select]['url_value']['options'] = url_parameter_dict['options']
+              # Generate `view` to be used to construct URL
+              contents_item[select]['url_value']['options']['view'] = url_template_dict[url_template_id] % {
+                "root_url": site_root.absolute_url(),
+                "script_id": script.id,
+                "relative_url": url_parameter_dict['view_kw']['jio_key'].replace("/", "%2F"),
+                "view": url_parameter_dict['view_kw']['view'],
+                "extra_param_json": urlsafe_b64encode(
+                  json.dumps(ensureSerializable(extra_url_param_dict)))
+                }
 
       # endfor select
       contents_list.append(contents_item)

bt5/erp5_hal_json_style/TestTemplateItem/portal_components/test.erp5.testHalJsonStyle.py

@@ -66,9 +66,10 @@ def simulate(script_id, params_string, code_string):
     return decorated
   return upperWrap
 
-def wipeFolder(folder):
+def wipeFolder(folder, commit=True):
   folder.deleteContent(list(folder.objectIds()))
-  transaction.commit()
+  if commit:
+    transaction.commit()
 
 def createIndexedDocument(quantity=1):
   """Create `quantity` Foo document(s) in Foo module and pass it as `document(_list)` argument into the wrapped function."""
@@ -136,6 +137,8 @@ from Products.ERP5Type.tests.ERP5TypeTestCase import ERP5TypeTestCase
 class ERP5HALJSONStyleSkinsMixin(ERP5TypeTestCase):
   def afterSetUp(self):
     self.login()
+    wipeFolder(self.portal.foo_module, commit=False)
+
 
   def beforeTearDown(self):
     transaction.abort()
@@ -1384,6 +1387,7 @@ return '%s/Base_viewMetadata?reset:int=1' % context.getRelativeUrl()
 """)
   @changeSkin('Hal')
   def test_getHateoasDocument_listbox_check_url_column_different_view(self):
+    self._makeDocument()
     # pass custom list method which expect input arguments
     self.portal.foo_module.FooModule_viewFooList.listbox.ListBox_setPropertyList(
       field_url_columns = ['modification_date | Base_getUrl',])
@@ -1466,9 +1470,6 @@ return url
       'return "http://example.org/bar"')
   @simulate('Base_getRequestHeader', '*args, **kwargs',
             'return "application/hal+json"')
-  @simulate('Test_listProducts', '*args, **kwargs', """
-return context.getPortalObject().foo_module.contentValues()
-""")
   @simulate('Base_getUrl', 'url_dict=False, *args, **kwargs', """
 url =  "https://officejs.com"
 if url_dict:
@@ -1481,6 +1482,7 @@ return url
 """)
   @changeSkin('Hal')
   def test_getHateoasDocument_listbox_check_url_column_absolute_url_without_field_rendering(self):
+    self._makeDocument()
     # pass custom list method which expect input arguments
     self.portal.foo_module.FooModule_viewFooList.listbox.ListBox_setPropertyList(
       field_url_columns = ['title | Base_getUrl',])
@@ -1489,7 +1491,8 @@ return url
     result = self.portal.web_site_module.hateoas.ERP5Document_getHateoas(
                   REQUEST=fake_request,
                   mode="search",
-                  list_method='Test_listProducts',
+                  list_method='contentValues',
+                  relative_url='foo_module',
                   select_list=['id', 'title', 'creation_date', 'modification_date'],
                   form_relative_url='portal_skins/erp5_ui_test/FooModule_viewFooList/listbox')
     result_dict = json.loads(result)
@@ -1519,11 +1522,9 @@ return url
       'return "http://example.org/bar"')
   @simulate('Base_getRequestHeader', '*args, **kwargs',
             'return "application/hal+json"')
-  @simulate('Test_listProducts', '*args, **kwargs', """
-return context.getPortalObject().foo_module.contentValues()
-""")
   @changeSkin('Hal')
   def test_getHateoasDocument_listbox_check_url_column_no_url(self):
+    self._makeDocument()
     # pass custom list method which expect input arguments
     self.portal.foo_module.FooModule_viewFooList.listbox.ListBox_setPropertyList(
       field_url_columns = ['title|',])
@@ -1532,7 +1533,8 @@ return context.getPortalObject().foo_module.contentValues()
     result = self.portal.web_site_module.hateoas.ERP5Document_getHateoas(
                   REQUEST=fake_request,
                   mode="search",
-                  list_method='Test_listProducts',
+                  list_method='contentValues',
+                  relative_url='foo_module',
                   select_list=['id', 'title', 'creation_date', 'modification_date'],
                   form_relative_url='portal_skins/erp5_ui_test/FooModule_viewFooList/listbox')
     result_dict = json.loads(result)
@@ -1554,9 +1556,6 @@ return context.getPortalObject().foo_module.contentValues()
       'return "http://example.org/bar"')
   @simulate('Base_getRequestHeader', '*args, **kwargs',
             'return "application/hal+json"')
-  @simulate('Test_listProducts', '*args, **kwargs', """
-return context.getPortalObject().foo_module.contentValues()
-""")
   @simulate('Base_getUrl', 'url_dict=False, *args, **kwargs', """
 url =  "https://officejs.com"
 if url_dict:
@@ -1570,6 +1569,7 @@ return url
 """)
   @changeSkin('Hal')
   def test_getHateoasDocument_listbox_check_url_column_option_parameters(self):
+    self._makeDocument()
     # pass custom list method which expect input arguments
     self.portal.foo_module.FooModule_viewFooList.listbox.ListBox_setPropertyList(
       field_url_columns = ['title | Base_getUrl',])
@@ -1578,7 +1578,8 @@ return url
     result = self.portal.web_site_module.hateoas.ERP5Document_getHateoas(
                   REQUEST=fake_request,
                   mode="search",
-                  list_method='Test_listProducts',
+                  list_method='contentValues',
+                  relative_url='foo_module',
                   select_list=['id', 'title', 'creation_date', 'modification_date'],
                   form_relative_url='portal_skins/erp5_ui_test/FooModule_viewFooList/listbox')
     result_dict = json.loads(result)