Rin by Mayuki Sawatari

<PackageReference Include="Rin" Version="2.5.0-preview.20201021-061646" />

---

API Diff between 2.5.0-preview.20201021-061646 and 1.0.0-preview.20180807.1

192 Additions 60 Removals

Microsoft.Extensions.DependencyInjection

• public static class RinSerivceExtensions
• public static class RinBuilderExtensions
  • public static IRinBuilder AddBodyDataTransformer<T>(this IRinBuilder builder) where T : IBodyDataTransformer
  • public static IRinBuilder AddRequestBodyDataTransformer<T>(this IRinBuilder builder) where T : IRequestBodyDataTransformer
  • public static IRinBuilder AddResponseBodyDataTransformer<T>(this IRinBuilder builder) where T : IResponseBodyDataTransformer
• public static class RinServiceExtensions
  • public static IRinBuilder AddRin(this IServiceCollection services, Action<RinOptions> configure = null)

Microsoft.Extensions.Logging

• public static class RinLoggerExtensions
  • public static void AddRinLogger(this ILoggerFactory loggerFactory, IServiceProvider serviceProvider)
  • public static void AddRinLogger(this ILoggingBuilder loggingBuilder)

Rin

• public static class Resources
  • public static string GetContentType(string path)
  • public static bool TryOpen(string name, out Stream stream, out string contentType)

Rin.Channel

• public class RinChannel : IDisposable
  • public RinChannel()
  • public RinChannel(ILoggerFactory loggerFactory)
  • public Task ManageAsync<THub>(WebSocket socket, THub hub) where THub : IHub
  • public Task ManageAsync(WebSocket socket, IHub hub)

Rin.Channel.HubInvoker

• public struct HubInvocationResult
  • public bool HasResult { get; }
  • public object Value { get; }
  • public HubInvocationResult(object value)
• public class HubInvokeMessage
  • public object[] Arguments { get; }
  • public string Method { get; }
  • public HubMethodDefinition MethodDefinition { get; }
  • public string OperationId { get; }
  • public HubInvokeMessage(string operationId, string method, HubMethodDefinition methodDefinition, object[] arguments)
• public class HubInvoker<T> : IHubInvoker
  • public IReadOnlyDictionary<string, HubMethodDefinition> MethodMap { get; }
  • public HubInvoker()
  • public ValueTask<HubInvocationResult> InvokeAsync(T instance, HubInvokeMessage invokeMessage)
  • public bool TryCreateMessage(string json, out HubInvokeMessage invokeMessage)
• public class HubMethodDefinition
  • public MethodInfo Method { get; }
  • public IReadOnlyList<Type> ParameterTypes { get; }
  • public Type ReturnType { get; }
  • public HubMethodDefinition(MethodInfo method)
• public interface IHubInvoker
  • IReadOnlyDictionary<string, HubMethodDefinition> MethodMap { get; }
  • ValueTask<HubInvocationResult> InvokeAsync(object instance, HubInvokeMessage invokeMessage)
  • bool TryCreateMessage(string json, out HubInvokeMessage invokeMessage)

Rin.Core

• public abstract class BodyDataTransformer : IBodyDataTransformer
• public class BodyDataTransformerPipeline : IBodyDataTransformer
  • public BodyDataTransformResult Transform(HttpRequestRecord record, byte[] body, StringValues contentTypeHeaderValues)
  • public bool TryTransform(HttpRequestRecord record, ReadOnlySpan<byte> body, StringValues contentTypeHeaderValues, out BodyDataTransformResult result)
• public interface IBodyDataTransformer
  • BodyDataTransformResult Transform(HttpRequestRecord record, byte[] body, StringValues contentTypeHeaderValues)
  • bool TryTransform(HttpRequestRecord record, ReadOnlySpan<byte> body, StringValues contentTypeHeaderValues, out BodyDataTransformResult result)
• public class InspectorOptions
  • public List<IBodyDataTransformer> RequestBodyDataTransformers { get; }
  • public List<IBodyDataTransformer> ResponseBodyDataTransformers { get; }
• public interface IRequestBodyDataTransformer : IBodyDataTransformer
• public interface IResponseBodyDataTransformer : IBodyDataTransformer
• public class RequestRecorderOptions
  • public bool AllowRunningOnProduction { get; set; }
  • public Func<HttpRequest, bool> Excludes { get; set; }
  • public List<Func<HttpRequest, bool>> Excludes { get; set; }

Rin.Core.Event

• public interface IMessageEventBus<T> : IDisposable
  • void Subscribe(IEnumerable<IMessageSubscriber<T>> subscribers)
• public interface IMessageSubscriber<T>
  • void Publish(T message)
  • Task Publish(T message)
• public class MessageEventBus<T> : IMessageEventBus<T>, IDisposable
  • public MessageEventBus(IMessageSubscriber<T>[] subscribers)
  • public MessageEventBus(ILogger<MessageEventBus<T>> logger)
  • public void Subscribe(IEnumerable<IMessageSubscriber<T>> subscribers)
• public struct RequestEventMessage
  • public string EventSource { get; set; }
  • public RequestEventMessage(HttpRequestRecord value, RequestEvent requestEvent)
  • public RequestEventMessage(string eventSource, HttpRequestRecord value, RequestEvent requestEvent)
• public enum StoreBodyEvent
  • Request = 0
  • Response = 1
• public struct StoreBodyEventMessage
  • public byte[] Body { get; set; }
  • public StoreBodyEvent Event { get; set; }
  • public string Id { get; set; }
  • public StoreBodyEventMessage(StoreBodyEvent storeBodyEvent, string id, byte[] body)

Rin.Core.Record

• public class ExceptionData
  • public string ClassName { get; set; }
  • public string FullMessage { get; set; }
  • public string FullName { get; set; }
  • public string Message { get; set; }
  • public string StackTrace { get; set; }
  • public ExceptionData()
  • public ExceptionData(Exception ex)
• public class HttpRequestRecord : HttpRequestRecordInfo
  • public Exception Exception { get; }
  • public HostString Host { get; }
  • public string Id { get; }
  • public bool IsCompleted { get; }
  • public bool IsHttps { get; }
  • public string Method { get; }
  • public PathString Path { get; }
  • public QueryString QueryString { get; }
  • public IPAddress RemoteIpAddress { get; }
  • public byte[] RequestBody { get; }
  • public ExceptionData Exception { get; set; }
  • public ITimelineScope Processing { get; set; }
  • public DateTime RequestReceivedAt { get; }
  • public byte[] ResponseBody { get; }
  • public IDictionary<string, StringValues> RequestTrailers { get; set; }
  • public int ResponseStatusCode { get; }
  • public IDictionary<string, StringValues> ResponseTrailers { get; set; }
  • public ConcurrentQueue<TraceLogRecord> Traces { get; }
  • public DateTime TransferringCompletedAt { get; }
  • public ITimelineScope Transferring { get; set; }
• public class InMemoryRecordStorage : IRecordStorage, IMessageSubscriber<RequestEventMessage>
• public class HttpRequestRecordInfo
  • public string Host { get; set; }
  • public string Id { get; set; }
  • public bool IsCompleted { get; }
  • public bool IsHttps { get; set; }
  • public string Method { get; set; }
  • public string ParentId { get; set; }
  • public string Path { get; set; }
  • public string QueryString { get; set; }
  • public IPAddress RemoteIpAddress { get; set; }
  • public DateTimeOffset RequestReceivedAt { get; set; }
  • public int ResponseStatusCode { get; set; }
  • public DateTimeOffset TransferringCompletedAt { get; set; }
  • public HttpRequestRecordInfo()
  • public static HttpRequestRecordInfo CreateFromRecord(HttpRequestRecord record)
• public interface IRecordStorage : IMessageSubscriber<RequestEventMessage>, IMessageSubscriber<StoreBodyEventMessage>, IDisposable
  • void Add(HttpRequestRecord entry)
  • HttpRequestRecord[] GetAll()
  • bool TryGetById(string id, out HttpRequestRecord value)
  • Task AddAsync(HttpRequestRecord entry)
  • Task<HttpRequestRecordInfo[]> GetAllAsync()
  • Task<RecordStorageTryGetResult<HttpRequestRecord>> TryGetDetailByIdAsync(string id)
  • Task<RecordStorageTryGetResult<byte[]>> TryGetRequestBodyByIdAsync(string id)
  • Task<RecordStorageTryGetResult<byte[]>> TryGetResponseBodyByIdAsync(string id)
  • Task UpdateAsync(HttpRequestRecord entry)
• public interface ITimelineEvent
  • string Category { get; set; }
  • string Data { get; set; }
  • string EventType { get; }
  • string Name { get; set; }
  • DateTimeOffset Timestamp { get; set; }
• public interface ITimelineScope : ITimelineEvent, IDisposable
  • DateTime BeginTime { get; }
  • string Category { get; }
  • IReadOnlyCollection<TimelineScope> Children { get; }
  • string Data { get; }
  • IReadOnlyCollection<ITimelineEvent> Children { get; }
  • string Name { get; }
  • ITimelineScope Create(string name, string category, string data)
• public interface ITimelineScopeCreatable : ITimelineScope, ITimelineEvent, IDisposable
  • ITimelineScope Create(string name, string category, string data)
• public interface ITimelineStamp : ITimelineEvent
• public sealed class NullTimelineScope : ITimelineScopeCreatable, ITimelineScope, ITimelineEvent, IDisposable
  • public DateTime BeginTime { get; }
  • public IReadOnlyCollection<TimelineScope> Children { get; }
  • public IReadOnlyCollection<ITimelineEvent> Children { get; }
  • public string EventType { get; }
  • public DateTimeOffset Timestamp { get; set; }
• public static class RecordStorageTryGetResult
  • public static RecordStorageTryGetResult<T> Create<T>(bool succeed, T value)
• public struct RecordStorageTryGetResult<T>
  • public bool Succeed { get; }
  • public T Value { get; }
  • public RecordStorageTryGetResult(bool succeed, T value)
• public static class TimelineEventCategory
  • public const string AspNetCoreCommon = "Rin.Timeline.AspNetCore.Common"
  • public const string AspNetCoreMvcAction = "Rin.Timeline.AspNetCore.Mvc.Action"
  • public const string AspNetCoreMvcResult = "Rin.Timeline.AspNetCore.Mvc.Result"
  • public const string AspNetCoreMvcView = "Rin.Timeline.AspNetCore.Mvc.View"
  • public const string Data = "Rin.Timeline.Data"
  • public const string Method = "Rin.Timeline.Method"
  • public const string Trace = "Rin.Timeline.Trace"
• public class TimelineScope : ITimelineScopeCreatable, ITimelineScope, ITimelineEvent, IDisposable
  • public DateTime BeginTime { get; }
  • public IReadOnlyCollection<TimelineScope> Children { get; }
  • public IReadOnlyCollection<ITimelineEvent> Children { get; }
  • public string EventType { get; }
  • public DateTimeOffset Timestamp { get; set; }
  • public static TimelineScope Prepare()
• public static class TimelineScopeCategory
• public class TraceLogRecord
• public class TimelineStamp : ITimelineStamp, ITimelineEvent
  • public string Category { get; set; }
  • public string Data { get; set; }
  • public string EventType { get; }
  • public string Name { get; set; }
  • public DateTimeOffset Timestamp { get; set; }
  • public static void Stamp(string name, string category, string data = null, DateTimeOffset? timestamp = default)

Rin.Core.Resource

• public class EmbeddedZipResourceProvider : IResourceProvider
  • public EmbeddedZipResourceProvider()
  • public Task<bool> TryProcessAsync(HttpContext context)
• public interface IResourceProvider
  • Task<bool> TryProcessAsync(HttpContext context)

Rin.Core.Storage

• public class InMemoryRecordStorage : IRecordStorage, IMessageSubscriber<RequestEventMessage>, IMessageSubscriber<StoreBodyEventMessage>, IDisposable
  • public InMemoryRecordStorage(IOptions<RinOptions> options)
  • public Task AddAsync(HttpRequestRecord record)
  • public void Dispose()
  • public Task<HttpRequestRecordInfo[]> GetAllAsync()
  • public Task<RecordStorageTryGetResult<HttpRequestRecord>> TryGetDetailByIdAsync(string id)
  • public Task<RecordStorageTryGetResult<byte[]>> TryGetRequestBodyByIdAsync(string id)
  • public Task<RecordStorageTryGetResult<byte[]>> TryGetResponseBodyByIdAsync(string id)
  • public Task UpdateAsync(HttpRequestRecord record)

Rin.Extensions

• public interface IRinBuilder
  • IServiceCollection Services { get; }

Rin.Features

• public class CaptureHttpResponseBodyFeature : IHttpResponseBodyFeature
  • public DataCaptureStream CaptureStream { get; }
  • public Stream Stream { get; }
  • public PipeWriter Writer { get; }
  • public CaptureHttpResponseBodyFeature(IHttpResponseBodyFeature responseBodyFeature)
  • public Task CompleteAsync()
  • public void DisableBuffering()
  • public Task SendFileAsync(string path, long offset, long? count, CancellationToken cancellationToken = default)
  • public Task StartAsync(CancellationToken cancellationToken = default)
• public interface IRinRequestRecordingFeatureAccessor
  • IRinRequestRecordingFeature Feature { get; }
  • void SetValue(IRinRequestRecordingFeature feature)
• public class RinRequestRecordingFeatureAccessor : IRinRequestRecordingFeatureAccessor
  • public IRinRequestRecordingFeature Feature { get; }
  • public RinRequestRecordingFeatureAccessor()
  • public void SetValue(IRinRequestRecordingFeature feature)

Rin.FrontendResources

• public static class Resources

Rin.Hubs

• public class RinCoreHub : IHub
  • public RinCoreHub(IRecordStorage storage, RinChannel rinChannel, BodyDataTransformerSet bodyDataTransformerSet)
  • public RequestRecordDetailPayload GetDetailById(string id)
  • public RequestEventPayload[] GetRecordingList()
  • public BodyDataPayload GetRequestBody(string id)
  • public BodyDataPayload GetResponseBody(string id)
  • public RinCoreHub(IRecordStorage storage, BodyDataTransformerSet bodyDataTransformerSet)
  • public Task<RequestRecordDetailPayload> GetDetailById(string id)
  • public Task<RequestEventPayload[]> GetRecordingList()
  • public Task<BodyDataPayload> GetRequestBody(string id)
  • public Task<BodyDataPayload> GetResponseBody(string id)
  • public RinServerInfoPayload GetServerInfo()

Rin.Hubs.Payloads

• public class BodyDataPayload
  • public static BodyDataPayload CreateFromRecord(HttpRequestRecord record, IDictionary<string, StringValues> headers, ReadOnlySpan<byte> body, IBodyDataTransformer transformer)
• public class RequestEventPayload
  • public string ParentId { get; }
  • public DateTimeOffset RequestReceivedAt { get; }
  • public RequestEventPayload(HttpRequestRecord record)
  • public RequestEventPayload(HttpRequestRecordInfo record)
• public class RequestRecordDetailPayload
  • public Exception Exception { get; }
  • public ExceptionData Exception { get; }
  • public string ParentId { get; }
  • public DateTime ProcessingCompletedAt { get; }
  • public DateTime ProcessingStartedAt { get; }
  • public DateTime RequestReceivedAt { get; }
  • public DateTimeOffset RequestReceivedAt { get; }
  • public IDictionary<string, StringValues> RequestTrailers { get; }
  • public IDictionary<string, StringValues> ResponseTrailers { get; }
  • public TraceLogRecord[] Traces { get; }
  • public DateTime TransferringCompletedAt { get; }
  • public DateTime TransferringStartedAt { get; }
  • public DateTimeOffset TransferringCompletedAt { get; }
• public class RinServerInfoPayload
  • public DateTimeOffset BuildDate { get; }
  • public IReadOnlyList<string> FeatureFlags { get; }
  • public string Version { get; }
  • public RinServerInfoPayload(string version, DateTimeOffset buildDate, IReadOnlyList<string> featureFlags)

Rin.IO

• public class CapturePipeWriter : PipeWriter
  • public CapturePipeWriter(PipeWriter pipeWriter, MemoryStream capturedDataStream)
• public class DataCaptureStream : Stream
  • public DataCaptureStream(Stream stream)
  • public Stream CaptureStream { get; }
  • public DataCaptureStream(Stream stream, MemoryStream capturedDataStream = null)

Rin.Middlewares

• public class RequestRecorderMiddleware
  • public RequestRecorderMiddleware(RequestDelegate next, IMessageEventBus<RequestEventMessage> eventBus, RinChannel rinChannel)
  • public const string EventSourceName = "Rin.Middlewares.RequestRecorderMiddleware"
  • public RequestRecorderMiddleware(RequestDelegate next, IMessageEventBus<RequestEventMessage> eventBus, IMessageEventBus<StoreBodyEventMessage> eventBusStoreBody, RinChannel rinChannel, ILoggerFactory loggerFactory, IRinRequestRecordingFeatureAccessor recordingFeatureAccessor)
• public class ResourcesMiddleware
  • public ResourcesMiddleware(RequestDelegate next)
  • public ResourcesMiddleware(RequestDelegate next, IEnumerable<IResourceProvider> resourceProviders)

Rin.Middlewares.Api

• public class GetDetailByIdMiddleware
  • public GetDetailByIdMiddleware(RequestDelegate next, IRecordStorage storage)
  • public Task InvokeAsync(HttpContext context)