SessionTracker 1.0.17

SessionTracker

Library that allows working with "sessions".

Features

• Session tracking via starting, updating, finishing, fetching and fetching finished Session objects.
• Configurable caching settings per Session type.
• In-memory and Redis implementations provided out of the box.

Description

A session is encapsulated data that has to be passed around via an in-memory cache, a distributed cache or any other backing-store custom implementation. It is helpful when dealing with for example Discord API interactions that may need some data passed between them without relying on Discords custom ID.

Installation

To register the session tracker service use the following extension methods:

For base in-memory implementation:

services.AddSessionTracker(options);

For Redis implementation:

builder.AddRedisSessionTracker(options, redisOptions);

If you wish to configure the JsonSerializerOptions used for serializing/deserializing session instances within Redis provider use:

services.Configure<JsonSerializerOptions>(SessionSettings.JsonSerializerName, yourOptions);

You can implement your own backing store provider by implementing ISessionsBackingStoreProvider interface and registering your new service with the container like so:

services.AddSingleton<ISessionsBackingStoreProvider, YourImplementationType>;

Example usage

Create your own Session type:

public CustomSession : Session
{
    public bool IsThisASuperSession { get; set; }
    
    public CustomSession(bool isSuper = true)
        => IsThisASuperSession = isSuper;
}

Inject ISessionTracker to your handlers/services/controllers/whatnot:

Start session inside one handler:

public FirstSimpleInteractionHandler
{
    private readonly ISessionTracker _tracker;

    public FirstSimpleInteractionHandler(ISessionTracker tracker)
        => _tracker = tracker;

    void Handle()
    {
        string key = "superKeyForThisSession";
        var session = new CustomSession(false);

        await _tracker.StartSessionAsync<CustomSession>(key, session);
    }
}

Update from another:

public SecondSimpleInteractionHandler
{
    private readonly ISessionTracker _tracker;

    public SecondSimpleInteractionHandler(ISessionTracker tracker)
        => _tracker = tracker;

    void Handle()
    {
        string key = "superKeyForThisSession"

        var result = await _tracker.GetSessionAsync<CustomSession>(key);
        if (!result.IsDefined(out var session))
            return;

        result.IsThisASuperSession = false;

        await _tracker.UpdateSessionAsync<CustomSession>(key, result);
    }
}

Use in third:

public ThirdSimpleInteractionHandler
{
    private readonly ISessionTracker _tracker;

    public ThirdSimpleInteractionHandler(ISessionTracker tracker)
        => _tracker = tracker;

    void Handle()
    {
        string key = "superKeyForThisSession"

        var result = await _tracker.GetSessionAsync<CustomSession>(key);
        if (!result.IsDefined(out var session))
            return;

        var check = result.IsThisASuperSession // returns false
    }
}

Finalize in fourth:

public FourthSimpleInteractionHandler
{
    private readonly ISessionTracker _tracker;

    public FourthSimpleInteractionHandler(ISessionTracker tracker)
        => _tracker = tracker;

    void Handle()
    {
        string key = "superKeyForThisSession"

        await _tracker.FinishSessionAsync<CustomSession>(key);
    }
}

Get from finalized cache in fifth:

public FifthSimpleInteractionHandler
{
    private readonly ISessionTracker _tracker;

    public FifthSimpleInteractionHandler(ISessionTracker tracker)
        => _tracker = tracker;

    void Handle()
    {
        string key = "superKeyForThisSession"
        
        // note that using GetSessionAsync here would result in a NotFoundError
        var result = await _tracker.GetFinishedSessionAsync<CustomSession>(key);
        if (!result.IsDefined(out var session))
            return;
    }
}