#1408 In-memory session storage for `CookieStickySessions` load balancer to facilitate DI replacements #1405

EliSyrota · 2020-12-29T10:28:49Z

Closes #1408

Sessions Storage for CookieStickySessions #1408

Problem to solve

The current implementation of CookieStickySessions contains ConcurrentDictionary<string, StickySession> where all the sessions are stored.
We faced a situation when we need to have a few Ocelot instances on-premise of the customer
and we have some services that enforces us to use CookieStickySessions for our Load Balancer.
Having several instances of Ocelot push us to add the ability to use CookieStickySessions for load balancing across these several Ocelot instances.
To do so we need to have an ability to inject our own session storage implementation for CookieStickySessions.

New Feature

Sessions storage implementations for CookieStickySessions
Add the ability to use CookieStickySessions for load balancing across these several Ocelot instances

Proposed Changes

To do so, we need to:

extract sessions collection from CookieStickySessions
make a public interface for session storage so users can implement their own mechanism of storing user sessions such as distributed sessions storage etc.
substitute CookieStickySessionsCreator to inject into CookieStickySessions own storage mechanism

raman-m · 2023-08-22T16:07:26Z

Hi @EliSyrota !
Thanks for the great PR and your interest in Ocelot!
I know you're requesting a new feature, but could this PR be related to an issue in the backlog?

The feature branch (develop) has been rebased onto ThreeMammals:develop!
Welcome to code review!
Good luck!

raman-m

Major issues are

No unit tests for newly added InMemoryStickySessionStorage class
No new unit tests in CookieStickySessionsTests, but behavior of CookieStickySessions class has changed. New parameter for the constructor should be tested.
No tests for CookieStickySessionsCreator

I believe, current design can be enhanced a bit, to allow to developer not implementing ILoadBalancerCreator interface, but simply replace InMemoryStickySessionStorage class by custom one in DI-container for IStickySessionStorage interface.

raman-m · 2023-08-22T16:28:29Z

src/Ocelot/LoadBalancer/LoadBalancers/InMemoryStickySessionStorage.cs

This new class should be covered by unit tests!

raman-m · 2023-08-22T16:40:16Z

test/Ocelot.UnitTests/LoadBalancer/CookieStickySessionsTests.cs

@@ -41,7 +41,8 @@ public CookieStickySessionsTests()
            _bus = new FakeBus<StickySession>();
            _loadBalancer = new Mock<ILoadBalancer>();
            _defaultExpiryInMs = 0;
-            _stickySessions = new CookieStickySessions(_loadBalancer.Object, "sessionid", _defaultExpiryInMs, _bus);
+            var sessionStorage = new InMemoryStickySessionStorage();


You are in unit tests! You haven't & shouldn't create concrete instance of the class!
You need to create mocked IStickySessionStorage object for the constructor on the next line.

Suggested change

var sessionStorage = new InMemoryStickySessionStorage();

var sessionStorage = new Mock<IStickySessionStorage>();

// setup the mock

raman-m · 2023-08-22T17:00:32Z

src/Ocelot/LoadBalancer/LoadBalancers/CookieStickySessionsCreator.cs

@@ -14,8 +15,9 @@ public Response<ILoadBalancer> Create(DownstreamRoute route, IServiceDiscoveryPr
        {
            var loadBalancer = new RoundRobin(async () => await serviceProvider.Get());
            var bus = new InMemoryBus<StickySession>();
+            var sessionStorage = new InMemoryStickySessionStorage();


Is it possible to inject this default concrete class from DI-container, and/or via extra argument?
Because this method is responsible for default implementations injection, we need to forward a IStickySessionStorage object to CookieStickySessions constructor.

substitute CookieStickySessionsCreator to inject into CookieStickySessions own storage mechanism

Because this class (creator) is managed by DI-container, we have to add InMemoryStickySessionStorage class to DI-container too, and inject it via constructor. This is the simplest solution!
Finally, developer should not implement new creator inheriting the ILoadBalancerCreator interface.

P.S. See previous line 17. Consider moving of InMemoryBus<StickySession> object to DI-container too while refactoring this class.

raman-m · 2023-08-22T17:06:45Z

src/Ocelot/LoadBalancer/LoadBalancers/IStickySessionStorage.cs

@@ -0,0 +1,10 @@
+namespace Ocelot.LoadBalancer.LoadBalancers;
+
+public interface IStickySessionStorage


Well... In PR you said:

make a public interface for session storage so users can implement their own mechanism of storing user sessions such as distributed sessions storage etc.

Based on the current code I can say, the interface object is not added to DI-container.

Still the issue: not in DI !!!

raman-m · 2023-08-22T17:14:09Z

src/Ocelot/LoadBalancer/LoadBalancers/CookieStickySessions.cs

        private readonly IBus<StickySession> _bus;
        private readonly object _lock = new();

-        public CookieStickySessions(ILoadBalancer loadBalancer, string key, int keyExpiryInMs, IBus<StickySession> bus)
+        public CookieStickySessions(ILoadBalancer loadBalancer, string key, int keyExpiryInMs, IBus<StickySession> bus, IStickySessionStorage storage)


substitute CookieStickySessionsCreator to inject into CookieStickySessions own storage mechanism

Because new added interface object can be injected by this creator, we need to explain to developer how to implement custom creator using ILoadBalancerCreator interface.
So, new paragraph in docs is required.

…tion

Use File-scoped namespace declaration

Remove and Sort Usings

raman-m

Additional Development Needed❗

Unit tests are missing
Acceptance tests are absent
The suggested service class has not been included in Dependency Injection❗

raman-m · 2024-11-05T12:08:11Z

src/Ocelot/LoadBalancer/LoadBalancers/CookieStickySessionsCreator.cs

            var options = route.LoadBalancerOptions;
            var loadBalancer = new RoundRobin(serviceProvider.GetAsync, route.LoadBalancerKey);
-            var bus = new InMemoryBus<StickySession>();
+            var bus = new InMemoryBus<StickySession>();
+            var sessionStorage = new InMemoryStickySessionStorage();


Adding to DI is required❗

raman-m · 2024-11-05T12:09:10Z

src/Ocelot/LoadBalancer/LoadBalancers/IStickySessionStorage.cs

@@ -0,0 +1,10 @@
+namespace Ocelot.LoadBalancer.LoadBalancers;
+
+public interface IStickySessionStorage


Still the issue: not in DI !!!

src/Ocelot/LoadBalancer/LoadBalancers/InMemoryStickySessionStorage.cs

raman-m · 2024-11-05T12:45:17Z

Hi @EliSyrota! Are you online?

EliSyrota changed the title ~~InMemoryStickySessionStorage for CookieStickySessions~~ Sessions Storage for CookieStickySessions Dec 29, 2020

EliSyrota mentioned this pull request Jan 4, 2021

Sessions Storage for CookieStickySessions #1408

Open

raman-m assigned EliSyrota Jul 11, 2023

raman-m added feature A new feature proposal Proposal for a new functionality in Ocelot needs feedback Issue is waiting on feedback before acceptance labels Jul 11, 2023

raman-m self-requested a review July 11, 2023 17:36

raman-m force-pushed the develop branch from bad58c8 to 74000e2 Compare August 22, 2023 15:51

raman-m requested review from binarymash, jps, geffzhang, RaynaldM, philproctor, anktsrkr, sharpn, abooraja, wast, yangzhongke and thiagoloureiro August 22, 2023 16:09

raman-m requested changes Aug 22, 2023

View reviewed changes

RaynaldM approved these changes Aug 23, 2023

View reviewed changes

raman-m changed the title ~~Sessions Storage for CookieStickySessions~~ #1408 Sessions Storage for CookieStickySessions Jun 15, 2024

Eli Syrota and others added 7 commits November 5, 2024 14:28

InMemoryStickySessionStorage provider for CookieStickySessions separa…

91adda1

…tion

Dependency Injection for IStickySessionStorage prodiver

6e34321

UT coverage

ab6637f

Refactoring

6c456eb

CookieStickySessionsCreator with spare storage for each route

4964723

Update IStickySessionStorage.cs

7719e78

Use File-scoped namespace declaration

Update InMemoryStickySessionStorage.cs

37cc861

Use File-scoped namespace declaration

raman-m added 2 commits November 5, 2024 14:39

Update CookieStickySessions.cs

1c1cebc

Remove and Sort Usings

Fix build errors: review CookieStickySessions

32b42ab

raman-m force-pushed the develop branch from b673311 to 32b42ab Compare November 5, 2024 11:58

raman-m requested changes Nov 5, 2024

View reviewed changes

Minor refactoring

a2d1e3b

raman-m requested review from RaynaldM, raman-m and ggnaegi and removed request for binarymash, jps, geffzhang, philproctor, anktsrkr, sharpn, abooraja, wast, yangzhongke and thiagoloureiro November 5, 2024 12:36

raman-m added Load Balancer Ocelot feature: Load Balancer and removed needs feedback Issue is waiting on feedback before acceptance labels Nov 5, 2024

raman-m changed the title ~~#1408 Sessions Storage for CookieStickySessions~~ #1408 In-memory session storage for CookieStickySessions load balancer to facilitate DI replacements Nov 5, 2024

raman-m added the Dependency Injection Ocelot feature: Dependency Injection label Nov 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#1408 In-memory session storage for `CookieStickySessions` load balancer to facilitate DI replacements #1405

#1408 In-memory session storage for `CookieStickySessions` load balancer to facilitate DI replacements #1405

EliSyrota commented Dec 29, 2020 •

edited by raman-m

Loading

raman-m commented Aug 22, 2023

raman-m left a comment

raman-m Aug 22, 2023

raman-m Aug 22, 2023

raman-m Aug 22, 2023 •

edited

Loading

raman-m Aug 22, 2023 •

edited

Loading

raman-m Nov 5, 2024 •

edited

Loading

raman-m Aug 22, 2023

raman-m left a comment

raman-m Nov 5, 2024

raman-m Nov 5, 2024 •

edited

Loading

raman-m commented Nov 5, 2024

	var sessionStorage = new InMemoryStickySessionStorage();
	var sessionStorage = new Mock<IStickySessionStorage>();
	// setup the mock

		@@ -0,0 +1,10 @@
		namespace Ocelot.LoadBalancer.LoadBalancers;

		public interface IStickySessionStorage

#1408 In-memory session storage for CookieStickySessions load balancer to facilitate DI replacements #1405

Are you sure you want to change the base?

#1408 In-memory session storage for CookieStickySessions load balancer to facilitate DI replacements #1405

Conversation

EliSyrota commented Dec 29, 2020 • edited by raman-m Loading

Closes #1408

Problem to solve

New Feature

Proposed Changes

raman-m commented Aug 22, 2023

raman-m left a comment

Choose a reason for hiding this comment

raman-m Aug 22, 2023

Choose a reason for hiding this comment

raman-m Aug 22, 2023

Choose a reason for hiding this comment

raman-m Aug 22, 2023 • edited Loading

Choose a reason for hiding this comment

raman-m Aug 22, 2023 • edited Loading

Choose a reason for hiding this comment

raman-m Nov 5, 2024 • edited Loading

Choose a reason for hiding this comment

raman-m Aug 22, 2023

Choose a reason for hiding this comment

raman-m left a comment

Choose a reason for hiding this comment

Additional Development Needed❗

raman-m Nov 5, 2024

Choose a reason for hiding this comment

raman-m Nov 5, 2024 • edited Loading

Choose a reason for hiding this comment

raman-m commented Nov 5, 2024

#1408 In-memory session storage for `CookieStickySessions` load balancer to facilitate DI replacements #1405

#1408 In-memory session storage for `CookieStickySessions` load balancer to facilitate DI replacements #1405

EliSyrota commented Dec 29, 2020 •

edited by raman-m

Loading

raman-m Aug 22, 2023 •

edited

Loading

raman-m Aug 22, 2023 •

edited

Loading

raman-m Nov 5, 2024 •

edited

Loading

raman-m Nov 5, 2024 •

edited

Loading