TD-820: Refactors routing to support critical score rejections (#105)

* TD-820: Refactors routing to support critical score rejections

* Moves routing context helpers to appropriate module

* Splits large functions, fixes misconfiguration error bug

* Fixes second fail rates query

* Fixes routes equality check

* Extracts route struct functions

* Extracts routing context into separate module

* Fixes rejected routes ordering consistency

* Fixes funx naming and adds routes equality tests

* Makes rejected routes reasons more explicit in code

* Adds routing ctx pipeline test

* Adds specified routing sub failures

* Updates tests; replaces static errors translation

* Fixes ubiquity of availability status naming

* Updates route reject error codes

* Bumps damsel

Author: nanodirijabl

apps/hellgate/include/hg_invoice_payment.hrl

@@ -5,8 +5,8 @@
     activity :: hg_invoice_payment:activity(),
     payment :: undefined | hg_invoice_payment:payment(),
     risk_score :: undefined | hg_inspector:risk_score(),
-    routes = [] :: [hg_routing:payment_route()],
-    candidate_routes :: undefined | [hg_routing:payment_route()],
+    routes = [] :: [hg_route:payment_route()],
+    candidate_routes :: undefined | [hg_route:payment_route()],
     interim_payment_status :: undefined | hg_invoice_payment:payment_status(),
     new_cash :: undefined | hg_cash:cash(),
     new_cash_provided :: undefined | boolean(),

apps/hellgate/src/hg_accounting.erl

@@ -39,7 +39,7 @@
 -type payment() :: dmsl_domain_thrift:'InvoicePayment'().
 -type party() :: dmsl_domain_thrift:'Party'().
 -type shop() :: dmsl_domain_thrift:'Shop'().
--type route() :: hg_routing:payment_route().
+-type route() :: hg_route:payment_route().
 -type payment_institution() :: dmsl_domain_thrift:'PaymentInstitution'().
 -type provider() :: dmsl_domain_thrift:'Provider'().
 -type varset() :: hg_varset:varset().

apps/hellgate/src/hg_cascade.erl

@@ -12,7 +12,7 @@
 -spec is_triggered(
     cascade_behaviour() | undefined,
     operation_failure(),
-    hg_routing:payment_route(),
+    hg_route:payment_route(),
     [hg_session:t()]
 ) ->
     boolean().

apps/hellgate/src/hg_cashflow.erl

@@ -29,7 +29,7 @@
 
 -type shop_id() :: dmsl_domain_thrift:'ShopID'().
 -type party_id() :: dmsl_domain_thrift:'PartyID'().
--type route() :: hg_routing:payment_route().
+-type route() :: hg_route:payment_route().
 
 %%
 

apps/hellgate/src/hg_invoice_payment.erl

@@ -11,7 +11,7 @@
 -type turnover_limit() :: dmsl_domain_thrift:'TurnoverLimit'().
 -type invoice() :: dmsl_domain_thrift:'Invoice'().
 -type payment() :: dmsl_domain_thrift:'InvoicePayment'().
--type route() :: hg_routing:payment_route().
+-type route() :: hg_route:payment_route().
 -type refund() :: hg_invoice_payment:domain_refund().
 -type cash() :: dmsl_domain_thrift:'Cash'().
 -type handling_flag() :: ignore_business_error.

apps/hellgate/src/hg_limiter.erl

@@ -20,7 +20,7 @@
 %%
 
 -type trx_info() :: hg_invoice_payment:trx_info().
--type route() :: hg_routing:payment_route().
+-type route() :: hg_route:payment_route().
 
 -type change() :: dmsl_payproc_thrift:'SessionChangePayload'().
 -type proxy_state() :: dmsl_base_thrift:'Opaque'().

apps/hellgate/src/hg_proxy_provider.erl

@@ -51,7 +51,7 @@
 -type rec_payment_tool_change() :: dmsl_payproc_thrift:'RecurrentPaymentToolChange'().
 -type rec_payment_tool_params() :: dmsl_payproc_thrift:'RecurrentPaymentToolParams'().
 
--type route() :: hg_routing:payment_route().
+-type route() :: hg_route:payment_route().
 -type risk_score() :: hg_inspector:risk_score().
 -type shop() :: dmsl_domain_thrift:'Shop'().
 -type party() :: dmsl_domain_thrift:'Party'().
@@ -251,7 +251,7 @@ init(EncodedParams, #{id := RecPaymentToolID}) ->
             client_ip => get_client_info_ip(Params#payproc_RecurrentPaymentToolParams.payment_resource)
         }),
         {ChosenRoute, ChoiceContext} = hg_routing:choose_route(NonFailRatedRoutes),
-        ChosenPaymentRoute = hg_routing:to_payment_route(ChosenRoute),
+        ChosenPaymentRoute = hg_route:to_payment_route(ChosenRoute),
         LoggerMetadata = hg_routing:get_logger_metadata(ChoiceContext, Revision),
         _ = logger:log(info, "Routing decision made", #{routing => LoggerMetadata}),
         RecPaymentTool2 = set_minimal_payment_cost(RecPaymentTool, ChosenPaymentRoute, VS, Revision),
@@ -274,20 +274,13 @@ init(EncodedParams, #{id := RecPaymentToolID}) ->
 
 gather_routes(PaymentInstitution, VS, Revision, Ctx) ->
     Predestination = recurrent_paytool,
-    case
-        hg_routing:gather_routes(
-            Predestination,
-            PaymentInstitution,
-            VS,
-            Revision,
-            Ctx
-        )
-    of
-        {ok, {[], RejectedRoutes}} ->
-            throw({no_route_found, {unknown, RejectedRoutes}});
-        {ok, {Routes, _RejectContext}} ->
+    RoutingCtx = hg_routing:gather_routes(Predestination, PaymentInstitution, VS, Revision, Ctx),
+    case {hg_routing_ctx:candidates(RoutingCtx), hg_routing_ctx:error(RoutingCtx)} of
+        {[], undefined} ->
+            throw({no_route_found, {unknown, hg_routing_ctx:rejected_routes(RoutingCtx)}});
+        {Routes, undefined} ->
             Routes;
-        {error, {misconfiguration, _Reason}} ->
+        {_Routes, {misconfiguration, _Reason}} ->
             throw({no_route_found, misconfiguration})
     end.
 

apps/hellgate/src/hg_recurrent_paytool.erl

@@ -0,0 +1,191 @@
+-module(hg_route).
+
+-export([new/2]).
+-export([new/4]).
+-export([new/5]).
+-export([new/6]).
+-export([provider_ref/1]).
+-export([terminal_ref/1]).
+-export([priority/1]).
+-export([weight/1]).
+-export([set_weight/2]).
+-export([pin/1]).
+-export([fd_overrides/1]).
+
+-export([equal/2]).
+
+-export([from_payment_route/1]).
+-export([to_payment_route/1]).
+-export([to_rejected_route/2]).
+
+%%
+
+-include("domain.hrl").
+
+-record(route, {
+    provider_ref :: dmsl_domain_thrift:'ProviderRef'(),
+    terminal_ref :: dmsl_domain_thrift:'TerminalRef'(),
+    weight :: integer(),
+    priority :: integer(),
+    pin :: pin(),
+    fd_overrides :: fd_overrides()
+}).
+
+-type t() :: #route{}.
+-type payment_route() :: dmsl_domain_thrift:'PaymentRoute'().
+-type route_rejection_reason() :: {atom(), _DescOrAttrs} | {atom(), _DescOrAttrs1, _DescOrAttrs2}.
+-type rejected_route() :: {provider_ref(), terminal_ref(), route_rejection_reason()}.
+-type provider_ref() :: dmsl_domain_thrift:'ProviderRef'().
+-type terminal_ref() :: dmsl_domain_thrift:'TerminalRef'().
+-type fd_overrides() :: dmsl_domain_thrift:'RouteFaultDetectorOverrides'().
+
+-type currency() :: dmsl_domain_thrift:'CurrencyRef'().
+-type payment_tool() :: dmsl_domain_thrift:'PaymentTool'().
+-type party_id() :: dmsl_domain_thrift:'PartyID'().
+-type client_ip() :: dmsl_domain_thrift:'IPAddress'().
+
+-type pin() :: #{
+    currency => currency(),
+    payment_tool => payment_tool(),
+    party_id => party_id(),
+    client_ip => client_ip() | undefined
+}.
+
+-export_type([t/0]).
+-export_type([provider_ref/0]).
+-export_type([terminal_ref/0]).
+-export_type([payment_route/0]).
+-export_type([rejected_route/0]).
+
+%%
+
+-spec new(provider_ref(), terminal_ref()) -> t().
+new(ProviderRef, TerminalRef) ->
+    new(
+        ProviderRef,
+        TerminalRef,
+        ?DOMAIN_CANDIDATE_WEIGHT,
+        ?DOMAIN_CANDIDATE_PRIORITY
+    ).
+
+-spec new(provider_ref(), terminal_ref(), integer() | undefined, integer()) -> t().
+new(ProviderRef, TerminalRef, Weight, Priority) ->
+    new(ProviderRef, TerminalRef, Weight, Priority, #{}).
+
+-spec new(provider_ref(), terminal_ref(), integer() | undefined, integer(), pin()) -> t().
+new(ProviderRef, TerminalRef, undefined, Priority, Pin) ->
+    new(ProviderRef, TerminalRef, ?DOMAIN_CANDIDATE_WEIGHT, Priority, Pin);
+new(ProviderRef, TerminalRef, Weight, Priority, Pin) ->
+    new(ProviderRef, TerminalRef, Weight, Priority, Pin, #domain_RouteFaultDetectorOverrides{}).
+
+-spec new(provider_ref(), terminal_ref(), integer(), integer(), pin(), fd_overrides() | undefined) -> t().
+new(ProviderRef, TerminalRef, Weight, Priority, Pin, undefined) ->
+    new(ProviderRef, TerminalRef, Weight, Priority, Pin, #domain_RouteFaultDetectorOverrides{});
+new(ProviderRef, TerminalRef, Weight, Priority, Pin, FdOverrides) ->
+    #route{
+        provider_ref = ProviderRef,
+        terminal_ref = TerminalRef,
+        weight = Weight,
+        priority = Priority,
+        pin = Pin,
+        fd_overrides = FdOverrides
+    }.
+
+-spec provider_ref(t()) -> provider_ref().
+provider_ref(#route{provider_ref = Ref}) ->
+    Ref.
+
+-spec terminal_ref(t()) -> terminal_ref().
+terminal_ref(#route{terminal_ref = Ref}) ->
+    Ref.
+
+-spec priority(t()) -> integer().
+priority(#route{priority = Priority}) ->
+    Priority.
+
+-spec weight(t()) -> integer().
+weight(#route{weight = Weight}) ->
+    Weight.
+
+-spec pin(t()) -> pin() | undefined.
+pin(#route{pin = Pin}) ->
+    Pin.
+
+-spec fd_overrides(t()) -> fd_overrides().
+fd_overrides(#route{fd_overrides = FdOverrides}) ->
+    FdOverrides.
+
+-spec set_weight(integer(), t()) -> t().
+set_weight(Weight, Route) ->
+    Route#route{weight = Weight}.
+
+-spec equal(R, R) -> boolean() when
+    R :: t() | rejected_route() | payment_route() | {provider_ref(), terminal_ref()}.
+equal(A, B) ->
+    routes_equal_(route_ref(A), route_ref(B)).
+
+%%
+
+-spec from_payment_route(payment_route()) -> t().
+from_payment_route(Route) ->
+    ?route(ProviderRef, TerminalRef) = Route,
+    new(ProviderRef, TerminalRef).
+
+-spec to_payment_route(t()) -> payment_route().
+to_payment_route(#route{} = Route) ->
+    ?route(provider_ref(Route), terminal_ref(Route)).
+
+-spec to_rejected_route(t(), route_rejection_reason()) -> rejected_route().
+to_rejected_route(Route, Reason) ->
+    {provider_ref(Route), terminal_ref(Route), Reason}.
+
+%%
+
+routes_equal_(A, A) when A =/= undefined ->
+    true;
+routes_equal_(_A, _B) ->
+    false.
+
+route_ref(#route{provider_ref = Prv, terminal_ref = Trm}) ->
+    {Prv, Trm};
+route_ref(#domain_PaymentRoute{provider = Prv, terminal = Trm}) ->
+    {Prv, Trm};
+route_ref({Prv, Trm}) ->
+    {Prv, Trm};
+route_ref({Prv, Trm, _RejectionReason}) ->
+    {Prv, Trm};
+route_ref(_) ->
+    undefined.
+
+%%
+
+-ifdef(TEST).
+
+-include_lib("eunit/include/eunit.hrl").
+
+-define(prv(ID), #domain_ProviderRef{id = ID}).
+-define(trm(ID), #domain_TerminalRef{id = ID}).
+
+-spec test() -> _.
+
+-spec routes_equality_test_() -> [_].
+routes_equality_test_() ->
+    lists:flatten([
+        [?_assert(equal(A, B)) || {A, B} <- route_pairs({?prv(1), ?trm(1)}, {?prv(1), ?trm(1)})],
+        [?_assertNot(equal(A, B)) || {A, B} <- route_pairs({?prv(1), ?trm(1)}, {?prv(1), ?trm(2)})],
+        [?_assertNot(equal(A, B)) || {A, B} <- route_pairs({?prv(1), ?trm(1)}, {?prv(2), ?trm(1)})],
+        [?_assertNot(equal(A, B)) || {A, B} <- route_pairs({?prv(1), ?trm(1)}, {?prv(2), ?trm(2)})]
+    ]).
+
+route_pairs({Prv1, Trm1}, {Prv2, Trm2}) ->
+    Fs = [
+        fun(X) -> X end,
+        fun to_payment_route/1,
+        fun(X) -> to_rejected_route(X, {test, <<"whatever">>}) end,
+        fun(X) -> {provider_ref(X), terminal_ref(X)} end
+    ],
+    A = new(Prv1, Trm1),
+    B = new(Prv2, Trm2),
+    lists:flatten([[{F1(A), F2(B)} || F1 <- Fs] || F2 <- Fs]).
+
+-endif.