Skip to content
This repository has been archived by the owner on Mar 15, 2022. It is now read-only.

Liquid Application Framework - Services caller base classes and supported cartridges

License

Notifications You must be signed in to change notification settings

ava-innersource/Liquid.Services-Deprecated

Repository files navigation

DEPRECATED No Maintenance Intended

This repo is no longer supported and will not receive any updates nor bug fixes, This code has been moved to the main Liquid repository and will be maintained there.

Liquid Application Framework - Services

This repository is part of the Liquid Application Framework, a modern Dotnet Core Application Framework for building cloud native microservices.

The main repository contains the examples and documentation on how to use Liquid.

Liquid.Services

Quality Gate Status

This package contains the service client subsystem of Liquid, for writing client to synchronous services. It implements common patterns for resiliency such as Retry and Circuit Breaker along with several backing implementations.

Available implementations Badges
Liquid.Services.Grpc Quality Gate Status Service implementation with Grpc protocol.
Liquid.Services.Http Quality Gate Status Service implementation with Http (Rest) protocol and GraphQL.

Usage

This is a the simplest form on how to use the service client:

  • Declare your request and response classes.
  • Declare your service interface, inherting from one of the implemetations provided.
  • Implement your service class, inherting from one of the implemetations provided.
  • Configure it.
  • Inject it were you want to use it.
  • Invoke the methods!
// using statemens ommited for brevity

namespace Liquid.Example.ServiceClient
{
    public class HelloRequest 
    {

        [JsonProperty("name")]
        public string Name {get; set;}
       
    }

    public class HelloResponse
    {

        [JsonProperty("message")]
        public string Message {get; set;}
       
    }

    public interface IHelloService : ILightHttpService
    {
        Task<HelloResponse> HelloAsync(HelloRequest request);
    }

    // Ideally the Interface and Implementation should be in different projects, to avoid coupling
    public class HelloService : LightHttpService, IHelloService
    {
        public HelloService(IHttpClientFactory httpClientFactory, 
                           ILoggerFactory loggerFactory, 
                           ILightContextFactory contextFactory, 
                           ILightTelemetryFactory telemetryFactory, 
                           ILightConfiguration<List<LightServiceSetting>> servicesSettings, 
                           IMapper mapperService) : base(httpClientFactory, loggerFactory, contextFactory, telemetryFactory, servicesSettings, mapperService)
        {
        }

        Task<HelloResponse> HelloAsync(HelloRequest request)
        {
            var httpResponse = await PostAsync<HelloRequest, HelloResponse>("/hello", request);

            if (httpResponse.HttpResponse.IsSuccessStatusCode)
            {
                return await httpResponse.GetContentObjectAsync();
            }

            // process the status code and throw exceptions if needed.
            return null;
        }
    }

}

The configuration can be made in the appsettings.json, such as:

{
    "services": [
    {
      "id": "HelloService",
      "address": "https://your-base-url-here/",
      "timeout": 5,
      "resilience": {
        "circuitBreaker": {
          "enabled": false,
          "failureThreshold": 0.9,
          "samplingDuration": 10,
          "minimumThroughput": 3,
          "durationOfBreak": 10
        },
        "retry": {
          "enabled": false,
          "attempts": 3,
          "waitDuration": 200
        }
      }
    }
  ],

}

To use it, in your Startup add:

services.AddDefaultTelemetry();
services.AddDefaultContext();
services.AddConfigurations(GetType().Assembly);
builder.Services.AddHttpServices(typeof(HelloService).Assembly);

About

Liquid Application Framework - Services caller base classes and supported cartridges

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages