Skip to content

Latest commit

 

History

History
251 lines (176 loc) · 12.1 KB

CHANGELOG.md

File metadata and controls

251 lines (176 loc) · 12.1 KB

Unreleased

v1.0.0 - 2024-07-13

🎉 Version 1.0! No new features, but after much procrastination I'm confident that Phetch is stable and ready to release properly.

Changed

  • BREAKING CHANGE: SetArgAsync, RefetchAsync, and TriggerAsync no longer throw an exception if the query function fails, and instead return a QueryResult<T> type which is either a success or failure.
    • This makes them safer to use as callbacks in your Blazor components, but in most cases you should still use the non-async versions (SetArg, Refetch, Trigger).
    • To migrate code using these methods without changing the functionality, simply replace await query.SetArgAsync(..) with (await query.SetArgAsync(..)).GetOrThrow().

Removed

  • BREAKING CHANGE: Removed the old Mutation<TArg> class which was previously marked obsolete. Use Query<TArg, Unit> instead, which is equivalent.
  • BREAKING CHANGE: Removed the old Skip option on <UseEndpoint/>, which was previously marked obsolete. Use AutoFetch instead.

v0.7.1 - 2024-06-08

Added

  • New RefetchInterval option on queries to automatically re-fetch a query on a fixed interval.

Changed

  • Some minor improvements to type definitions for Query methods (non-breaking).
  • Improved docs for async Query methods.

Development

  • More tests.

Changes

v0.7.0 - 2024-05-04

Added

  • The non-generic QueryOptions class can now be implicitly cast to QueryOptions<TArg, TResult>.
  • New DataChanged event for queries, which is triggered whenever the Data property changes.

Changed

  • BREAKING CHANGE: If a query succeeds and then fails on a refetch, query.Data now returns null/default, instead of the old data. Also, query.LastData now returns the data from the last successful request (even if the arg was different) instead of null/default.
  • QueryOptions.OnSuccess is now called when a cached result is returned (unless it's stale). Note: EndpointOptions.OnSuccess is unchanged, and still won't be called when a cached result is returned.

Development

  • More tests.
  • Sample project improvements.

Changes

v0.6.0 - 2023-12-01

Added

  • New DocFX site for documentation
  • Updated docs for CacheTime and StaleTime
  • If you're targeting .NET 8, you'll now have proper hot reload support in components containing <UseEndpoint/> or <ObserveQuery/>. This isn't specific to this version of Phetch, but worth mentioning anyway.
  • UseEndpointInfinite.LoadNextPageAsync now returns the result of the next page query, or throws if the next page can't be loaded yet (e.g., the last page failed).

Changed

  • BREAKING CHANGE: <ObserveQuery/> no longer detaches queries automatically when disposed. To keep the same behaviour as before, set DetachWhenDisposed="true", or explicitly call query.Dispose() in the Dispose method of your component.
  • BREAKING CHANGE: Changed the function signature for the GetNextPageArg option of <UseEndpointInfinite/>.
  • Removed the <UseMutationEndpoint/> component that was previously marked as [Obsolete].

Fixed

  • Fixed events not being properly unsubscribed when <ObserveQuery/> was disposed.
  • Fixed failed queries in cache not automatically re-fetching if they have previously succeeded.

Development

  • Lots more tests.
  • Upgraded sample projects to .NET 8

Changes

v0.5.1 - 2023-07-14

Changed

  • Queries now trigger a StateChanged event when they begin fetching. This makes the behavior a bit more predictable when using endpoints across multiple components.
  • Improved docs for <ObserveQuery/>.

Added

  • New onSuccess and onFailure callback parameters for query.Trigger() methods, which get called when the query succeeds or fails, respectively. Thanks to @Paxol for suggesting this.

Changes

v0.5.0 - 2023-06-19

Changed

  • BREAKING CHANGE: Removed public constructors for Query that were previously deprecated.
  • BREAKING CHANGE: Renamed MutationEndpoint<T> to ResultlessEndpoint<T> for better consistency. The old MutationEndpoint<T> has been marked as obsolete, and left in temporarily to make migration easier. Also removed Mutation<T> and <UseMutationEndpoint/>, which can safely be replaced with Query<T, Unit> and <UseEndpoint/>.
  • Moved some of the methods on Query<T> to extension methods, so that they would also work on the equivalent Query<Unit, T> class.
  • Lots of improvements to documentation and samples.
  • More tests.

Fixed

  • Fixed some issues that arise when Skip and Arg parameters of UseEndpoint are changed simultaneously.

Changes

v0.4.0 - 2023-03-06

Added

  • Endpoint.TryGetCachedResult method, to retrieve a cached result synchronously for the given query argument.
  • New IQuery and IQuery<TArg, TResult> interfaces, to help with testing or writing methods that operate on queries.
  • Lots more tests (currently 96% line coverage in Phetch.Core).
  • Lots of improvements to the sample projects (in samples).

Changed

  • Public constructors for Query are now deprecated, because they serve very little value since adding Endpoints. Instead, just create an endpoint and call .Use(). These constructors will be removed in a future release.

Fixed

  • Exceptions in OnSuccess/OnFailure callbacks are now caught, instead of being incorrectly treated as a query failure.

Changes

v0.3.1 - 2022-11-21

Added

  • Lots more tests
  • Query and Endpoint classes now have a public Options property to read the options that were passed to them.
  • Query now has a CurrentQuery property to get the FixedQuery that it is currently observing.
  • New KeySelector option to customize the value used for caching query arguments.
  • Support for infinite StaleTime by passing a negative value

Changed

  • RefetchAsync and similar methods now return the result data from the query.

Fixed

  • BREAKING CHANGE: Query.Refetch now throws an exception if it is un-initialized, instead of failing silently.
  • null can now be used as a query argument.
  • Fixed bug where large StaleTime values (e.g., `TimeSpan.MaxValue) would cause an overflow.

Changes

v0.3.0 - 2022-11-13

Added

  • New parameter for UpdateQueryData to optionally insert a new cache entry if one doesn't already exist for the given argument.
  • Read-only Arg property on Query class, to access the last argument passed to SetArg.
  • Option to pass child content directly to <ObserveQuery/>, so that only the child content is re-rendered when the query updates. When using this method, there is no need to pass the OnChanged="StateHasChanged" parameter.
  • New RetryHandler option for endpoints and queries, to control whether and how the query retries upon failure.
  • New non-generic EndpointOptions and QueryOptions classes, which can be used to share "default" settings between endpoints and queries.
  • New experimental <UseEndpointInfinite/> component for creating "infinite scroll" features. To use this, add @using Phetch.Blazor.Experimental to your _Imports.razor.

Changed

  • BREAKING CHANGE: Removed the return value from UpdateQueryData
  • BREAKING CHANGE: Removed the arg parameter from InvalidateWhere. Instead, use the Arg property of the query.
  • Various improvements to documentation and sample projects.

Changes

v0.2.0 - 2022-08-18

Added

  • New GetCachedQuery method on Endpoint to look up a cache entry.
    • The returned cache entry can also be invalidated with Invalidate(), or have its data updated with UpdateQueryData(...).
  • New overload for UpdateQueryData which takes a function of the old query data.
  • New DefaultStaleTime option for Endpoint, which sets the stale time when no value is passed to Use.
  • New synchronous Prefetch() method on Endpoint, which doesn't return a Task.

Changed

  • BREAKING CHANGE: Rename QuerySuccessContext and QueryFailureContext to QuerySuccessEventArgs and QueryFailureEventArgs.
  • Various improvements to documentation and sample projects.

Fixed

  • Query functions that throw OperationCancelledException instead of TaskCancelledException will now be caught correctly after cancelling a query.

Changes

v0.1.2 - 2022-08-06

Changes

  • Enabled source link, debug symbols, and deterministic builds.
  • Added null checks to public methods, so they now throw ArgumentNullException if null is passed where it shouldn't be.

Other

  • Set up CI deployments with GitHub actions

Changes

v0.1.1 - 2022-08-01

Changes

  • Query.Cancel() now causes the query state to change immediately, rather than waiting for the query function to throw a TaskCanceledException.

New Features

  • Added a PrefetchAsync method to Endpoint, which can be used to fetch data ahead of time.
  • Added new overloads for Endpoint constructors which don't require a CancellationToken to be passed.
  • Added a Trigger() method to Query<T> that doesn't require an argument to be passed.

Bugfixes

  • Fixed a bug which caused Cancel() to result in a query error if the cancellation didn't happen synchronously.

Changes

v0.1.0 - 2022-07-26

This release removes the concept of mutations as the previously existed, and instead combines the previous functionality of mutations into the Query class. This is a very significant change, but future releases should contain far fewer breaking changes.

BREAKING CHANGES:

  • Removes the existing Mutation and MutationEndpoint classes.
    • You can now just use the standard Query classes, and call Trigger instead of SetArg to get the same functionality.
  • Replaces QueryEndpoint with Endpoint, ParameterlessEndpoint, and 'MutationEndpoint` (depending on the shape of the query function).
  • Replaces UseQueryEndpoint with UseEndpoint, UseParameterlessEndpoint, and 'UseMutationEndpoint`.
  • Renames SetParam to SetArg.

New Features

  • Mutations now have all the same features as queries, including caching, cache updates/invalidation, and cancellation.
  • Adds OnSuccess/OnFailure options to both queries and endpoints.
  • Adds support for CancellationToken across the entire library.
  • Adds a Skip parameter to UseEndpoint, for conditional fetching.
  • Lots of extra documentation.

Other Changes

  • Fixes bugs involving the handling of out-of-order query returns.
  • Fixes bugs causing double-fetching
  • Fixes bugs causing unnecessary double-rendering of Blazor components.
  • Adds lots of automated tests.
  • Significantly improves the README.

Changes