hal_json_style: sort keys when base64 encoding json

This produces stable output that we can assert more easily in the test

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

@@ -677,7 +677,8 @@ def renderField(traversed_document, field, form, value=MARKER, meta_type=None,
           json.dumps(ensureSerializable({
             'original_form_id': form.id,
             'field_id': field.id
-        })))))
+          }),
+          sort_keys=True))))
       }
     })
 
@@ -799,9 +800,9 @@ def renderField(traversed_document, field, form, value=MARKER, meta_type=None,
         "form_relative_url": "%s/%s" % (form_relative_url, field.id),
         "list_method": list_method_name,
         "default_param_json": bytes2str(urlsafe_b64encode(str2bytes(
-          json.dumps(ensureSerializable(list_method_query_dict))))),
+          json.dumps(ensureSerializable(list_method_query_dict), sort_keys=True)))),
         "extra_param_json": bytes2str(urlsafe_b64encode(str2bytes(
-          json.dumps(ensureSerializable(extra_param_dict)))))
+          json.dumps(ensureSerializable(extra_param_dict), sort_keys=True))))
       }
       # once we imprint `default_params` into query string of 'list method' we
       # don't want them to propagate to the query as well
@@ -820,7 +821,7 @@ def renderField(traversed_document, field, form, value=MARKER, meta_type=None,
         "script_id": script.id,
         "relative_url": traversed_document.getRelativeUrl().replace("/", "%2F"),
         "list_method": list_method_name,
-        "default_param_json": bytes2str(urlsafe_b64encode(str2bytes(json.dumps(ensureSerializable(list_method_query_dict)))))
+        "default_param_json": bytes2str(urlsafe_b64encode(str2bytes(json.dumps(ensureSerializable(list_method_query_dict), sort_keys=True))))
       }
       list_method_query_dict = {}
     """
@@ -1069,7 +1070,9 @@ def renderForm(traversed_document, form, response_dict, key_prefix=None, selecti
             'proxy_listbox_id': x,
             'original_form_id': extra_param_json['original_form_id'],
             'field_id': extra_param_json['field_id']
-          })))))
+            }),
+            sort_keys=True,
+          ))))
       }) for x, y in proxy_form_id_list],
       "first_item": 1,
       "required": 0,
@@ -1092,7 +1095,8 @@ def renderForm(traversed_document, form, response_dict, key_prefix=None, selecti
             'proxy_listbox_id': REQUEST.get('proxy_listbox_id', None),
             'original_form_id': extra_param_json['original_form_id'],
             'field_id': extra_param_json['field_id']
-          })))))
+          }),
+          sort_keys=True))))
       }
 
   # Go through all groups ("left", "bottom", "hidden" etc.) and add fields from
@@ -1591,7 +1595,7 @@ def calculateHateoas(is_portal=None, is_site_root=None, traversed_document=None,
                 "script_id": script.id,                                   # this script (ERP5Document_getHateoas)
                 "relative_url": getRealRelativeUrl(traversed_document).replace("/", "%2F"),
                 "view": erp5_action_list[-1]['name'],
-                "extra_param_json": bytes2str(urlsafe_b64encode(str2bytes(json.dumps(ensureSerializable(extra_param_json)))))
+                "extra_param_json": bytes2str(urlsafe_b64encode(str2bytes(json.dumps(ensureSerializable(extra_param_json), sort_keys=True))))
               }
 
       if erp5_action_list:
@@ -1758,7 +1762,9 @@ def calculateHateoas(is_portal=None, is_site_root=None, traversed_document=None,
       'relative_url': relative_url,
       'group_by': group_by,
       'sort_on': sort_on
-    })))))
+    }),
+    sort_keys=True,
+    ))))
 
     # set 'here' for field rendering which contain TALES expressions
     REQUEST.set('here', traversed_document)
@@ -2205,7 +2211,7 @@ def calculateHateoas(is_portal=None, is_site_root=None, traversed_document=None,
                 "relative_url": url_parameter_dict['view_kw']['jio_key'].replace("/", "%2F"),
                 "view": url_parameter_dict['view_kw']['view'],
                 "extra_param_json": bytes2str(urlsafe_b64encode(str2bytes(
-                  json.dumps(ensureSerializable(extra_url_param_dict)))))
+                  json.dumps(ensureSerializable(extra_url_param_dict), sort_keys=True))))
                 }
 
       # endfor select
@@ -2423,7 +2429,7 @@ if mode == 'url_generator':
   else:
     generator_key = 'traverse_generator_action'
     keep_items_json = bytes2str(urlsafe_b64encode(str2bytes(
-      json.dumps(ensureSerializable(keep_items)))))
+      json.dumps(ensureSerializable(keep_items), sort_keys=True))))
   return url_template_dict[generator_key] % {
     "root_url": site_root.absolute_url(),
     "script_id": 'ERP5Document_getHateoas',

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

@@ -677,7 +677,7 @@ class TestERP5Document_getHateoas_mode_traverse(ERP5HALJSONStyleSkinsMixin):
     self.assertEqual(result_dict['_embedded']['_view']['listbox']['editable_column_list'], [['id', 'ID'], ['title', 'Title'], ['quantity', 'quantity'], ['start_date', 'Date']])
     self.assertEqual(result_dict['_embedded']['_view']['listbox']['sort_column_list'], [['id', 'ID'], ['title', 'Title'], ['quantity', 'Quantity'], ['start_date', 'Date']])
     self.assertEqual(result_dict['_embedded']['_view']['listbox']['list_method_template'],
-                     '%s/web_site_module/hateoas/ERP5Document_getHateoas?mode=search&relative_url=foo_module%%2F%s&form_relative_url=portal_skins/erp5_ui_test/Foo_view/listbox&list_method=objectValues&extra_param_json=eyJmb3JtX2lkIjogIkZvb192aWV3In0=&default_param_json=eyJwb3J0YWxfdHlwZSI6IFsiRm9vIExpbmUiXSwgImlnbm9yZV91bmtub3duX2NvbHVtbnMiOiB0cnVlfQ=={&query,select_list*,limit*,group_by*,sort_on*,local_roles*,selection_domain*}' % (self.portal.absolute_url(), document.getId()))
+                     '%s/web_site_module/hateoas/ERP5Document_getHateoas?mode=search&relative_url=foo_module%%2F%s&form_relative_url=portal_skins/erp5_ui_test/Foo_view/listbox&list_method=objectValues&extra_param_json=eyJmb3JtX2lkIjogIkZvb192aWV3In0=&default_param_json=eyJpZ25vcmVfdW5rbm93bl9jb2x1bW5zIjogdHJ1ZSwgInBvcnRhbF90eXBlIjogWyJGb28gTGluZSJdfQ=={&query,select_list*,limit*,group_by*,sort_on*,local_roles*,selection_domain*}' % (self.portal.absolute_url(), document.getId()))
     self.assertEqual(result_dict['_embedded']['_view']['listbox']['domain_root_list'], [['foo_category', 'FooCat'], ['foo_domain', 'FooDomain'], ['not_existing_domain', 'NotExisting']])
     NBSP_prefix = u'\xA0' * 4
     self.assertEqual(result_dict['_embedded']['_view']['listbox']['domain_dict'], {'foo_domain': [['a', 'a'], ['%sa1' % NBSP_prefix, 'a/a1'], ['%sa2' % NBSP_prefix, 'a/a2'], ['b', 'b']], 'foo_category': [['a', 'a'], ['a/a1', 'a/a1'], ['a/a2', 'a/a2'], ['b', 'b']]})
@@ -1235,7 +1235,7 @@ class TestERP5Document_getHateoas_mode_traverse(ERP5HALJSONStyleSkinsMixin):
     self.assertEqual(result_dict['_embedded']['_view']['report_section_list'][2]['listbox']['editable_column_list'], [['time', 'Time'], ['comment', 'Comment'], ['error_message', 'Error Message']])
     self.assertEqual(result_dict['_embedded']['_view']['report_section_list'][2]['listbox']['sort_column_list'], [])
     self.assertEqual(result_dict['_embedded']['_view']['report_section_list'][2]['listbox']['list_method_template'],
-                     '%s/web_site_module/hateoas/ERP5Document_getHateoas?mode=search&relative_url=foo_module%%2F%s&form_relative_url=portal_skins/erp5_core/Base_viewWorkflowHistory/listbox&list_method=Base_getWorkflowHistoryItemList&extra_param_json=eyJmb3JtX2lkIjogIkJhc2Vfdmlld1dvcmtmbG93SGlzdG9yeSJ9&default_param_json=eyJ3b3JrZmxvd19pZCI6ICJmb29fd29ya2Zsb3ciLCAiY2hlY2tlZF9wZXJtaXNzaW9uIjogIlZpZXciLCAid29ya2Zsb3dfdGl0bGUiOiAiRm9vIFdvcmtmbG93IiwgImlnbm9yZV91bmtub3duX2NvbHVtbnMiOiB0cnVlfQ=={&query,select_list*,limit*,group_by*,sort_on*,local_roles*,selection_domain*}' % (self.portal.absolute_url(), document.getId()))
+                     '%s/web_site_module/hateoas/ERP5Document_getHateoas?mode=search&relative_url=foo_module%%2F%s&form_relative_url=portal_skins/erp5_core/Base_viewWorkflowHistory/listbox&list_method=Base_getWorkflowHistoryItemList&extra_param_json=eyJmb3JtX2lkIjogIkJhc2Vfdmlld1dvcmtmbG93SGlzdG9yeSJ9&default_param_json=eyJjaGVja2VkX3Blcm1pc3Npb24iOiAiVmlldyIsICJpZ25vcmVfdW5rbm93bl9jb2x1bW5zIjogdHJ1ZSwgIndvcmtmbG93X2lkIjogImZvb193b3JrZmxvdyIsICJ3b3JrZmxvd190aXRsZSI6ICJGb28gV29ya2Zsb3cifQ=={&query,select_list*,limit*,group_by*,sort_on*,local_roles*,selection_domain*}' % (self.portal.absolute_url(), document.getId()))
 
 
   @simulate('Base_getRequestUrl', '*args, **kwargs',
@@ -2797,7 +2797,7 @@ class TestERP5Document_getHateoas_mode_url_generator(ERP5HALJSONStyleSkinsMixin)
       result,
       '%s/web_site_module/hateoas/ERP5Document_getHateoas?'
       'mode=traverse&relative_url=foo%%2Fbar&view=Foo_viewBar'
-      '&extra_param_json=eyJmb28iOiAiYSIsICJiYXIiOiAiYiJ9' % self.portal.absolute_url()
+      '&extra_param_json=eyJiYXIiOiAiYiIsICJmb28iOiAiYSJ9' % self.portal.absolute_url()
     )
 
   @simulate('Base_checkOnContextDocument', '*args, **kwargs',