preserve pystein function app metadata key order (#177)

Co-authored-by: Bill Wang <[email protected]>
Co-authored-by: gavin-aguiar <[email protected]>

Author: 3 people

azure/functions/decorators/core.py

@@ -115,7 +115,8 @@ def get_dict_repr(self) -> Dict:
 
         :return: Dictionary representation of the binding.
         """
-        for p in getattr(self, 'init_params', []):
+        params = list(dict.fromkeys(getattr(self, 'init_params', [])))
+        for p in params:
             if p not in Binding.EXCLUDED_INIT_PARAMS:
                 self._dict[to_camel_case(p)] = getattr(self, p, None)
 

azure/functions/decorators/function_app.py

@@ -214,11 +214,11 @@ def _validate_function(self,
         # http trigger
         if Trigger.is_supported_trigger_type(trigger, HttpTrigger):
             if getattr(trigger, 'route', None) is None:
-                getattr(trigger, 'init_params').add('route')
+                getattr(trigger, 'init_params').append('route')
                 setattr(trigger, 'route', function_name)
             if getattr(trigger, 'auth_level',
                        None) is None and auth_level is not None:
-                getattr(trigger, 'init_params').add('auth_level')
+                getattr(trigger, 'init_params').append('auth_level')
                 setattr(trigger, 'auth_level',
                         parse_singular_param_to_enum(auth_level, AuthLevel))
             self._function._is_http_function = True

azure/functions/decorators/utils.py

@@ -56,8 +56,8 @@ def wrapper(*args, **kwargs):
 
             self = args[0]
 
-            init_params = set(inspect.signature(func).parameters.keys())
-            init_params.update(kwargs.keys())
+            init_params = list(inspect.signature(func).parameters.keys())
+            init_params.extend(list(kwargs.keys()))
             for key in kwargs.keys():
                 if not hasattr(self, key):
                     setattr(self, key, kwargs[key])

tests/decorators/test_decorators.py

@@ -2053,3 +2053,43 @@ def dummy():
             "tableName": "dummy_table_name",
             "connection": "dummy_out_conn"
         })
+
+    def test_function_app_full_bindings_metadata_key_order(self):
+        app = self.func_app
+
+        @app.route(trigger_arg_name='trigger_name', binding_arg_name='out',
+                   methods=(HttpMethod.GET, HttpMethod.PATCH),
+                   auth_level=AuthLevel.FUNCTION, route='dummy_route',
+                   trigger_extra_fields={"dummy_field": "dummy"},
+                   binding_extra_fields={"dummy_field": "dummy"})
+        @app.table_input(arg_name="in", table_name="dummy_table_name",
+                         connection="dummy_in_conn",
+                         row_key="dummy_key",
+                         partition_key="dummy_partition_key",
+                         take=1,
+                         filter="dummy_filter")
+        @app.table_output(arg_name="out", table_name="dummy_table_name",
+                          connection="dummy_out_conn",
+                          row_key="dummy_key",
+                          partition_key="dummy_partition_key")
+        def dummy():
+            pass
+
+        self._test_function_metadata_order(app)
+
+    def test_function_app_generic_http_trigger_metadata_key_order(self):
+        app = self.func_app
+
+        @app.generic_trigger(arg_name="req", type=HTTP_TRIGGER)
+        def dummy():
+            pass
+
+        self._test_function_metadata_order(app)
+
+    def _test_function_metadata_order(self, app):
+        func = self._get_user_function(app)
+        last_metadata_payload = str(func)
+        for _ in range(3):
+            new_metadata_payload = str(func)
+            self.assertEqual(new_metadata_payload, last_metadata_payload)
+            last_metadata_payload = new_metadata_payload