Merge pull request #4100 from 3scale/fixed-order-backend-mapping-rules

THREESCALE-11879: Order backend API mapping rules

Author: mayorova

app/models/backend_api.rb

@@ -19,7 +19,7 @@ class BackendApi < ApplicationRecord
   after_create :create_default_metrics
   before_destroy :avoid_destruction
 
-  has_many :proxy_rules, as: :owner, dependent: :destroy, inverse_of: :owner
+  has_many :proxy_rules, -> { order(position: :asc) }, as: :owner, dependent: :destroy, inverse_of: :owner
   has_many :metrics, as: :owner, dependent: :destroy, inverse_of: :owner
   alias_method :all_metrics, :metrics
 

test/integration/admin/api/backend_apis/mapping_rules_controller_test.rb

@@ -114,6 +114,24 @@ def setup
       delete admin_api_backend_api_mapping_rule_path(backend_api, mapping_rule), params: { access_token: access_token_value }
       assert_response :not_found
     end
+
+    test 'mapping rules are ordered by position' do
+      backend_api.proxy_rules.destroy_all
+
+      FactoryBot.create(:proxy_rule, owner: backend_api, pattern: '/two')
+      rule_3 = FactoryBot.create(:proxy_rule, owner: backend_api, pattern: '/three')
+      rule_1 = FactoryBot.create(:proxy_rule, owner: backend_api, pattern: '/one')
+      rule_1.move_to_top
+      rule_3.move_to_bottom
+
+      get admin_api_backend_api_mapping_rules_path(backend_api), params: { access_token: access_token_value }
+
+      assert_response :success
+      assert(response_mapping_rules = JSON.parse(response.body)['mapping_rules'])
+
+      patterns = response_mapping_rules.map { |mapping_rule| mapping_rule.dig('mapping_rule', 'pattern') }
+      assert_equal %w[/one /two /three], patterns
+    end
   end
 
   class MemberPermission < self

test/unit/apicast/proxy_rules_source_test.rb

@@ -2,14 +2,19 @@
 
 class Apicast::ProxyRulesSourceTest < ActiveSupport::TestCase
 
+  def setup
+    @proxy = FactoryBot.create(:proxy)
+    backend_api_config = FactoryBot.create(:backend_api_config, service: @proxy.service, path: '/test/path/')
+    @backend_api = backend_api_config.backend_api
+    @metric = FactoryBot.create(:metric, owner: backend_api, description: 'My awesome metric', system_name: 'my-metric')
+  end
+
+  attr_reader :backend_api, :metric, :proxy
+
   def test_to_hash
-    proxy = FactoryBot.create(:proxy)
     rule_1 = FactoryBot.create(:proxy_rule, proxy: proxy, last: true)
     rule_2 = FactoryBot.create(:proxy_rule, proxy: proxy)
 
-    backend_api_config = FactoryBot.create(:backend_api_config, service: proxy.service, path: '/test/path/')
-    backend_api = backend_api_config.backend_api
-    metric = FactoryBot.create(:metric, owner: backend_api, description: 'My awesome metric', system_name: 'my-metric')
     rule_3 = FactoryBot.create(:proxy_rule, owner: backend_api, pattern: '/create')
     rule_4 = FactoryBot.create(:proxy_rule, owner: backend_api, pattern: '/delete', metric: metric)
     rule_5 = FactoryBot.create(:proxy_rule, owner: backend_api, pattern: '/list?filter=a', metric: metric)
@@ -33,6 +38,21 @@ def test_to_hash
     assert_equal ['username'], rule_hash_6['parameters']
   end
 
+  test 'backend api mapping rules are ordered by position' do
+    proxy.proxy_rules.destroy_all
+
+    assert backend_api.proxy_rules.empty?
+
+    FactoryBot.create(:proxy_rule, owner: backend_api, pattern: '/two')
+    rule_3 = FactoryBot.create(:proxy_rule, owner: backend_api, pattern: '/three')
+    rule_1 = FactoryBot.create(:proxy_rule, owner: backend_api, pattern: '/one')
+    rule_1.move_to_top
+    rule_3.move_to_bottom
+
+    source = Apicast::ProxyRulesSource.new(proxy).to_hash
+    assert_equal %w[/test/path/one /test/path/two /test/path/three], source.map { |rule| rule['pattern'] }
+  end
+
   private
 
   def find_by_id_in_hash(id, hash)