CHANGELOG.md

RandomSkunk.Results

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

No notable changes have been made.

1.4.0 - 2023-06-28

Changed

• RandomSkunk.Results:

  • When creating error from exception, use exception full name as title of inner error.

• RandomSkunk.Results.Http:

  • Add "responseStatusCode" and "problemDetailsStatus" extensions to errors.

Fixed

• RandomSkunk.Results.Http:
  • If ErrorCode is not specified in the Problem Details object, use the Http Status Code instead.

1.3.1 - 2023-05-15

Fixed

• Fix issues with Source Link.

1.3.0 - 2023-05-02

Added

• RandomSkunk.Results:
  • Add Maybe<T>.ToFailIfNone method.
  • Add Rescue methods.

Fixed

• RandomSkunk.Results:
  • Add nullable annotation to the Error parameter in implicit operators.
  • Fix bug where the "callback" and "replace error" functions from FailResult were invoked multiple times for the same error.

1.2.0 - 2023-04-10

Added

• RandomSkunk.Results:
  • Add Errors.Canceled and automatic task cancellation handling.

Fixed

• RandomSkunk.Results:
  • Catch and handle exceptions thrown from callbacks where possible.

1.1.0 - 2023-03-28

Added

• RandomSkunk.Results:

  • Add Errors.NoValue() method.
  • Add implicit conversion from Result<Unit> and Maybe<Unit> to Result.
  • Add overloads for Maybe<T>.ToResult and Maybe<T>.Truncate with onNoneSelector parameter.
  • Add implicit conversion operator methods from Error to Result, Result<T>, and Maybe<T>.
  • Add Unit.Invoke method.
  • Add AwaitSettings.ContinueOnCapturedContext setting.

• RandomSkunk.Results.AspNetCore:

  • Add ToFileActionResult extension methods.
  • Add ToActionResult overloads that have an onSuccess function parameter.
  • Add ToJsonActionResult extension methods.

Fixed

• RandomSkunk.Results:

  • Change targets of LINQ-to-Results methods from IResult<Unit> to Result. This fixes queries where the first clause is of type Task<Result>, which would fail to compile.
  • Add missing calls to ConfigureAwait(false).

• RandomSkunk.Results.Http:

  • When JSON deserializing, accept Status field with token type of either Number or String.

1.0.0 - 2023-01-12

Initial release.

Changed

• RandomSkunk.Results:
  • Change Maybe.None() method to property.
  • Rename ErrorCodes.NoneResult to ErrorCodes.NoValue.
  • Replace DBNull with new Unit type.
  • Rename SetStackTrace to OmitStackTrace and flip logic.

Added

• RandomSkunk.Results:
  • Add optional onNoneSelector parameter to Maybe<T>.Select and Maybe<T>.SelectMany methods.
  • Add implicit conversion operator methods from T to Result<T> and Maybe<T>.
  • Add AsNonNullable extension methods.

1.0.0-alpha23 - 2023-01-03

Fixed

• RandomSkunk.Results.Analyzers:
  • Fix generated method when return type is ValueTask or ValueTask<T>.

Changed

• RandomSkunk.Results:
  • Allow Error properties to be initialized with null values. Without this change, there was no way to use a with statement to create a new Error with a null Identifier or StackTrace value.
  • Adds isSensitive and extensions parameters to result Fail methods.

1.0.0-alpha22 - 2022-12-09

Changed

• RandomSkunk.Results
  • Extract more information from an Exception when creating an Error from it.

Added

• Add support for .NET 7.
• RandomSkunk.Results
  • Add [TryCatch] and [assembly: TryCatchThirdParty] attributes.
  • Add ToFailIf and ToNoneIf methods.
  • Add IReadOnlyList<T>.ForEach extension methods.
• RandomSkunk.Results.Analyzers (new package)
  • Add try/catch source generator.

Removed

• Remove support for .NET 5 and .NET Standard 2.1.

1.0.0-alpha21 - 2022-11-10

RandomSkunk.Results API (diff)
RandomSkunk.Results.AspNetCore API (diff)
RandomSkunk.Results.Dapper API (diff)
RandomSkunk.Results.Http API (diff)

Added

• RandomSkunk.Results:
  • Add Truncate methods for Result<T> and Maybe<T>.
  • Add overloads for ForEach methods that take a function with an index parameter.

Changed

• RandomSkunk.Results:
  • Added additional optional parameters to methods in the Errors class.

1.0.0-alpha20 - 2022-10-26

RandomSkunk.Results API (diff)
RandomSkunk.Results.AspNetCore API (diff)
RandomSkunk.Results.Dapper API (diff)
RandomSkunk.Results.Http API (diff)

Added

• RandomSkunk.Results:
  • Add [StackTraceBoundary] attribute, which lets an app define a "cutting off" point for a stack trace.
  • Add Error.IsSensitive property. This property determines whether the Error.ToString() method results in a full representation of the error or an abbreviated representation.
  • Add FailResult.SetCallbackFunction and FailResult.SetReplaceErrorFunction methods. Functions passed to these methods are invoked whenver a Fail result is created.

Removed

• RandomSkunk.Results:
  • Remove IsDefault property from each result type.
  • Remove Error.ToString(bool includeStackTrace) overload.
  • Remove FailResult.OnCreated property.

Changed

• RandomSkunk.Results:
  • Make stack trace generation consistent.

1.0.0-alpha19 - 2022-10-18

RandomSkunk.Results API (diff)
RandomSkunk.Results.AspNetCore API (diff)
RandomSkunk.Results.Dapper API (diff)
RandomSkunk.Results.Http API (diff)

Added

• RandomSkunk.Results:
  • Add IEnumerable<T>.ForEach result extension methods.

Fixed

• RandomSkunk.Results:
  • Fix doc comment issues by removing all uses of <inheritdoc cref='...'/> tags.

1.0.0-alpha18 - 2022-10-13

RandomSkunk.Results API (diff)
RandomSkunk.Results.AspNetCore API (diff)
RandomSkunk.Results.Dapper API (diff)
RandomSkunk.Results.Http API (diff)

Added

• RandomSkunk.Results:
  • Add GetValueOrDefault() method to Result<T> and Maybe<T>.

Changed

• RandomSkunk.Results:
  • Remove "Async" suffix from methods.
  • Change value of ErrorCodes.NoneResult from -410 to -404.

Removed

• RandomSkunk.Results:
  • Remove AndAlso methods (SelectMany provides the exact same functionality).

Fixed

• RandomSkunk.Results.Http:
  • Fix bug in ReadMaybeFromJsonAsync<T> extension method that occurred when the response contained problem problem details with error code ErrorCodes.NoneResult. Instead of reading it as a None result as expected, it would read it as a Fail result.
• RandomSkunk.Results.AspNetCore:
  • Fix bug in Maybe<T>.ToActionResult() extension method that occurred with None results. Instead of returning of returning a NotFoundResult, return an ObjectResult with a ProblemDetails value, where the problem details has an errorCode of ErrorCodes.NoneResult. This makes the HTTP response able to be read correctly with the RandomSkunk.Results.Http package.

1.0.0-alpha17 - 2022-10-02

RandomSkunk.Results API (diff)
RandomSkunk.Results.AspNetCore API (diff)
RandomSkunk.Results.Dapper API (diff)
RandomSkunk.Results.Http API (diff)

Added

• RandomSkunk.Results:
  • Add first-class support for Result in LINQ-to-Results query syntax.
  • Add optional setStackTrace parameter (default: true) to factory methods in Errors static class.
• RandomSkunk.Results.Http:
  • Add HttpClient.TryGetByteArrayAsync extension method.

Removed

• RandomSkunk.Results:
  • Remove Result.AsDBNullResult() method.

1.0.0-alpha16 - 2022-09-22

RandomSkunk.Results API (diff)
RandomSkunk.Results.AspNetCore API (diff)
RandomSkunk.Results.Dapper API (diff)
RandomSkunk.Results.Http API (diff)

Added

• RandomSkunk.Results:
  • Add extension methods for async linq-to-results.
  • Add Unauthorized and Forbidden properties to Errors and ErrorCodes classes.
  • Add FailResult.OnCreated callback, which is called whenever a fail result is created.
  • Add TryGetError method for each result type.
  • Add TryCatch overloads with 3, 4, and 5 exceptions.

Changed

• RandomSkunk.Results:
  • Rename Map and FlatMap methods to Select and SelectMany.
  • Rename MapAll and FlatMapAll extension methods to Select and SelectMany.
  • Rename CompositeError.Create method to CreateOrGetSingle.
  • Replace GetValue() and GetError() extension methods with Value and Error properties.
  • Change namespace of enumerable extensions (e.g. FirstOrNone or SingleOrFail) to System.Linq to improve discoverability.

Removed

• RandomSkunk.Results:
  • Remove RandomSkunk.Results.Linq namespace.
  • Remove RandomSkunk.Results.Unsafe namespace.
  • Remove Type property from Result, Result<T>, and Maybe<T>.
  • Remove unnecessary generic parameter from some Flatten extension methods.

1.0.0-alpha15 - 2022-07-28

RandomSkunk.Results API (diff)
RandomSkunk.Results.AspNetCore API (diff)
RandomSkunk.Results.Dapper API (diff)
RandomSkunk.Results.Http API (diff)

Added

• RandomSkunk.Results:
  • Add ErrorCodes class.
  • Add Error.ToString(bool includeStackTrace) overload.
  • Add MapAll and FlatMapAll extension methods for value tuples of results.
  • Add Filter method and LINQ Where extension method for Result<T>.
  • Add Result<DBNull> Result.AsDBNullResult() method.
  • Add error code description to output of Error.ToString().
  • Add ErrorCodes.GetDescription and RegisterErrorCodes static methods to get and set the description for an error code respectively.
• RandomSkunk.Results.Dapper:
  • Add ResultSqlMapper.GridReader class.

Changed

• RandomSkunk.Results:
  • Return a Fail result instead of throwing exception when a supplied delegate parameter returns a null value.
  • Rename CrossMap to FlatMap.
  • Rename Error.Type to Error.Title.
  • Exclude stack trace from Error.ToString() output.
  • Stack trace generation happens only in the Error constructor.
  • When generating stack trace, exclude frames with methods decorated with the [StackTraceHidden] attribute.
  • In Error.FromException, the exception information is completely contained in the InnerError property. The outer error contains information about the callsite.
  • Replace delegate extensions with TryCatch, TryCatch<TException> and TryCatch<TException1, TException2> classes containing methods with the same functionality.
  • Move extension properties functionality to the base Error class.
  • Improve output of Error.ToString.
• RandomSkunk.Results.Dapper:
  • Catch general Exception instead of both DbException and Exception in all ResultSqlMapper extension methods.
  • TryQueryMultiple and TryQueryMultipleAsync return a ResultSqlMapper.GridReader instead of a SqlMapper.GridReader.
• RandomSkunk.Results.Http:
  • Improve the mapping of error code to HTTP status code. The positive or negative hundreds part of the decimal error code becomes the HTTP status code. Examples:
    • Error code 9500 maps to HTTP status code 500.
    • Error code -4040404 maps to HTTP status code 404.
  • The mapping of error code to HTTP status code can be specified on a per-call basis.

Removed

• RandomSkunk.Results:
  • Remove FailFactory<TResult> class and result FailWith fields.
  • Remove ResultExtensions.DefaultOnNoneCallback static property.
  • Remove most Func<Error, Error>? onFail parameters.
  • Remove Func<Error>? onNoneGetError parameters.
  • Remove Error.DefaultMessage static property.
  • Remove ExtendedError class.
• RandomSkunk.Results.Http:
  • Remove HttpClientExtensions.DefaultGetHttpError and HttpClientExtensions.DefaultGetTimeoutError static properties.
• RandomSkunk.Results.Dapper:
  • Remove DbError class.

1.0.0-alpha14 - 2022-06-30

RandomSkunk.Results API (diff)
RandomSkunk.Results.AspNetCore API (diff)
RandomSkunk.Results.Dapper API (diff)
RandomSkunk.Results.Http API (diff)

Added

• RandomSkunk.Results:
  • Add generated stack traces to additional fail factory methods.
  • Add Result.AndAlso and Result.AndAlsoAsync extension methods, allowing valueless results to be chained together.
  • Add IResult and IResult<T> interfaces, allowing different kinds of results to be used the same manner.
  • Add OnAllSuccess, OnAnyNonSuccess, and MatchAll extension methods for value tuples of results.
  • Add OnNonSuccess extension methods.
• RandomSkunk.Results.Dapper:
  • Add EnsureOneRowAffected and EnsureNRowsAffected extension methods.

Changed

• RandomSkunk.Results:
  • Simplify error/fail factory methods that have an exception parameter by removing the type and innerError parameters and using the name of the exception's type as the error type and its inner exception to create the inner error instead.
  • Simplify Result<T>.FromValue method and FactoryExtensions.ToResult<T> extension methods by replacing nullValueErrorMessage, nullValueErrorCode, nullValueErrorIdentifier, and nullValueErrorType parameters with single getNullValueError function parameter.
  • Rename Some to Success.

Removed

• RandomSkunk.Results:
  • Remove the side-effect versions of Match methods. Use the OnSuccess, OnFail, or OnNone methods to apply side-effects based on a result instead.

1.0.0-alpha13 - 2022-06-03

RandomSkunk.Results API (diff)
RandomSkunk.Results.AspNetCore API (diff)
RandomSkunk.Results.Dapper API (diff)
RandomSkunk.Results.Http API (diff)

Added

• RandomSkunk.Results:
  • Add AsDisposable() and AsAsyncDisposable() extension methods for Result<T> and Maybe<T>.
  • Add additional overloads of Flatten where the source is a mixed nested results. For example, Result<Maybe<T>> flattens to Maybe<T>.
  • Add Result<T>.FromValue method, which gracefully handles null values by returning a Fail result.
  • Add extension methods for IEnumerable<T> in the RandomSkunk.Results.Linq namespace that behave the same way that the System.Linq extension methods do. Except instead of returning T and perhaps throwing an exception or returning null, they return Result<T> (the "OnFail" methods) or Maybe<T> (the "OnNone" methods).
    • FirstOrFail | FirstOrNone
    • LastOrFail | LastOrNone
    • SingleOrFail | SingleOrNone
    • ElementAtOrFail | ElementAtOrNone

Changed

• RandomSkunk.Results:
  • Remove Create factory field. Pull result factory methods up to the result types themselves. Add back FailWith factory field that only creates Fail results.
  • The FactoryExtensions.ToResult extension method now gracefully handles null values by calling Result<T>.FromValue.

1.0.0-alpha12 - 2022-05-31

RandomSkunk.Results API (diff)
RandomSkunk.Results.AspNetCore API (diff)
RandomSkunk.Results.Dapper API
RandomSkunk.Results.Http API (diff)

Added

• Add RandomSkunk.Results.Dapper project.
  • Extension methods mirroring Dapper's extension methods that start with Try and return result objects.
• RandomSkunk.Results:
  • Add ToResult<T>() and ToMaybe<T>() extension methods under the RandomSkunk.Results.FactoryExtensions namespace.
  • Add Result<T>.AsMaybe() and Maybe<T>.AsResult() methods.
• RandomSkunk.Results.AspNetCore:
  • In ToActionResult() extension methods, add ability to provide custom status code for success results.

Changed

• RandomSkunk.Results:
  • Rename delegate extension methods to differentiate between new factory extension methods.
    • ToResult() -> TryInvokeAsResult()
    • ToResult<T>() -> TryInvokeAsResult<T>()
    • ToMaybe<T>() -> TryInvokeAsMaybe<T>()

1.0.0-alpha11 - 2022-05-26

RandomSkunk.Results API (diff)
RandomSkunk.Results.AspNetCore API (diff)
RandomSkunk.Results.Http API (diff)

Fixed

• RandomSkunk.Results:
  • Fix Error.ToString() formatting for derived types.

Changed

• RandomSkunk.Results:
  • Change result extension methods to instance methods wherever possible.
  • Move InvalidStateException to RandomSkunk.Results.Unsafe namespace.

Added

• RandomSkunk.Results.Http:
  • Add extension methods for Task<HttpResponseMessage> and Task<Result<HttpResponseMessage>>.
• RandomSkunk.Result.AspNetCore:
  • Add ToActionResult extension methods for results.

1.0.0-alpha10 - 2022-05-24

RandomSkunk.Results API (diff)
RandomSkunk.Results.AspNetCore API (diff)
RandomSkunk.Results.Http API (diff)

Fixed

• RandomSkunk.Results.Http:
  • Fix ambiguous overloads in HttpResponseMessage extension methods.

Added

• RandomSkunk.Results:
  • Add JSON serialization support for Error class.
  • Add ExtendedError class, designed to losslessly capture additional properties when deserialized.
  • Add OnFail extension methods for all result types and OnNone extension methods for Maybe<T>.
  • Add overloads of almost all result extension methods that extend a Task<Result>, Task<Result<T>> or Task<Maybe<T>>. This allows easier method chaining for users.

Changed

• RandomSkunk.Results
  • Error is now a record class instead of a regular class.

1.0.0-alpha09 - 2022-05-19

RandomSkunk.Results API (diff)
RandomSkunk.Results.AspNetCore API (diff)
RandomSkunk.Results.Http API (diff)

Added

• RandomSkunk.Results:
  • Add [DebuggerDisplay] to each of the result structs and the error class.
  • Add CrossMap extension methods to convert from one type of result to another.
  • Add ToResult, ToResult<T>, ToMaybe<T>, ToResultAsync, ToResultAsync<T>, and ToMaybeAsync<T> extension methods to convert delegates into results.
  • Add OnSuccess and OnSome extension methods to conditionally invoke a callback and return the same result.
• RandomSkunk.Results.Http:
  • Add extension methods for HttpClient to convert HTTP operations into results.
  • Add JsonSerializerOptions parameter to HttpResponseMessage extension methods.

Fixed

• RandomSkunk.Results:
  • Fix bugs in Equals(object) and GetHashCode().

Changed

• RandomSkunk.Results:
  • Add optional getError parameter to all Map and FlapMap extension methods.
• RandomSkunk.Results.Http:
  • Rename ReadResultFromJsonAsync extension method to GetResultAsync.

1.0.0-alpha08 - 2022-05-11

RandomSkunk.Results API (diff)
RandomSkunk.Results.AspNetCore API (diff)
RandomSkunk.Results.Http API (diff)

Added

• RandomSkunk.Results:
  • Add WithError extension methods.

Changed

• RandomSkunk.Results.AspNetCore:
  • Include Error.InnerError in the problem details.
  • Map Error.Type to ProblemDetails.Title instead of ProblemDetails.Extensions["errorType"].
• RandomSkunk.Results.Http:
  • Set Error.InnerError from the problem details.
  • Map ProblemDetails.Title to Error.Type instead of being part of Error.Message.

Fixed

• RandomSkunk.Results.Http:
  • Fix bug when getting values of errorStackTrace and errorIdentifier. Their values would be null even when specified in the JSON.

1.0.0-alpha07 - 2022-05-09

RandomSkunk.Results API (diff)
RandomSkunk.Results.AspNetCore API (diff)
RandomSkunk.Results.Http API (diff)

Added

• RandomSkunk.Results:
  • Add InnerError property to Error class.
  • Add 'type' parameter to FromException and Fail factory methods.
  • Add Error property to InvalidStateException class.
  • Add IsDefault property to result types.

Changed

• RandomSkunk.Results:
  • Move Match and MatchAsync methods to result types (from extension methods).

Removed

• RandomSkunk.Results:
  • Remove implicit conversion operator from Maybe<T>.
  • Remove unused constructors from InvalidStateException class.

1.0.0-alpha06 - 2022-05-07

RandomSkunk.Results API (diff)
RandomSkunk.Results.AspNetCore API (diff)
RandomSkunk.Results.Http API (diff)

Changed

• RandomSkunk.Results:
  • Replace factory methods on result types with Create property of type IResultFactory, IResultFactory<T>, or IMaybeResultFactory<T>. These interfaces define the same base factory methods that they replace, and extension methods define Fail overloads.
  • Rename MaybeResult to just Maybe. Other types are similarly renamed.
  • Move direct access to the value and error of a result to the GetValue() and GetError() extension methods under the RandomSkunk.Results.Unsafe namespace.
• RandomSkunk.Results.AspNetCore:
  • Add cancellation token to all async methods.
  • Never return a Fail result about an issue getting the problem details.

Added

• RandomSkunk.Results:
  • Add InvalidStateException, which is thrown from the unsafe extension methods when the result an invalid state for directly reading its value or error.

1.0.0-alpha05 - 2022-05-05

RandomSkunk.Results API (diff)
RandomSkunk.Results.AspNetCore API (diff)
RandomSkunk.Results.Http API (diff)

Added

• RandomSkunk.Results:
  • Add Type property to the Error class.
    • Initialized with the name of the error type (e.g. "Error" for the base Error class) by default.

Changed

• RandomSkunk.Results:
  • Each of the result types is a struct instead of a class.
  • The Error class is no longer sealed.
  • Changed default value of Error.DefaultMessage.
• RandomSkunk.Results.AspNetCore:
  • Each extension method maps the Type property to "errorType" extension property of ProblemDetails object.
• RandomSkunk.Result.Http:
  • Extension method maps the "errorType" extension property of the problem details object to the Type of the Error object.

1.0.0-alpha04 - 2022-05-02

RandomSkunk.Results API (diff)
RandomSkunk.Results.AspNetCore API
RandomSkunk.Results.Http API

Changed

• RandomSkunk.Results:
  • The Error class and the various Fail factory methods take a message parameter instead of a messagePrefix parameter.

Added

• Add RandomSkunk.Result.Http project.
  • Extension methods for getting a result object directly from an HttpResponseMessage:
    • HttpResponseMessage.ReadResultFromJsonAsync
    • HttpResponseMessage.ReadResultFromJsonAsync<T>
    • HttpResponseMessage.ReadMaybeResultFromJsonAsync<T>
• Add RandomSkunk.Result.AspNetCore project.
  • Extension method for getting a ProblemDetails object from a result error:
    • Error.GetProblemDetails

Removed

• Remove CallSite struct.
• Remove abstract base classes, ResultBase and ResultBase<T>.

Note that version 1.0.0-alpha03 was burned due to publishing error.

1.0.0-alpha02 - 2022-04-28

RandomSkunk.Results API (diff)

Added

• Add result extension methods: Or, Else, Map, MapAsync, FlapMap, FlapMapAsync, Flatten, Filter, and FilterAsync.
• Add Identifier property to Error class,
• Add overloads of Fail result factory methods that take an Error parameter.
• Add FromException factory method to Error class.
• Add overloads of Fail result factory methods that take an Exception parameter.
• Add LINQ extension methods: Select, SelectMany, and Where.

1.0.0-alpha01 - 2022-04-28

RandomSkunk.Results API

Added

• Add initial project, solution, and package structures.
• Add Result, Result<T>, and MaybeResult<T> classes.