Skip to content

Releases: dotnet/orleans

v7.0.0-rc2

19 Oct 18:26
78d9f67
Compare
Choose a tag to compare
v7.0.0-rc2 Pre-release
Pre-release

Note that we have aligned versions with .NET, down to the release candidate number. This means that Orleans 7.0.0 replaces the would-be Orleans 4.0.0 release

What's Changed since 4.0.0-preview2

New Contributors

Full Changelog: v4.0.0-preview2...v7.0.0-rc1

v3.6.5

15 Aug 15:45
54382a1
Compare
Choose a tag to compare

What's Changed

  • Add azure pipeline yaml file for 3.x to build and test PR by @benjaminpetit in #7914
  • [3.x] Fix NullReferenceException when too many instances of a [StatelessWorker] are created and Debug logging is enabled by @ReubenBond in #7918
  • Fix Source Link and packaging by @ReubenBond in #7919

Full Changelog: v3.6.4...v3.6.5

v3.6.4

10 Aug 17:48
2e4ac1d
Compare
Choose a tag to compare

What's Changed

Full Changelog: v3.6.3...v3.6.4

v4.0.0-preview2

04 Aug 21:44
0748f6a
Compare
Choose a tag to compare
v4.0.0-preview2 Pre-release
Pre-release

What's Changed

Read more

v3.6.3

04 Aug 22:20
985d0ed
Compare
Choose a tag to compare

What's Changed

  • Fix generic method by @phynalle in #7697
  • Updating ConsulVersion for 3.x to match main by @Tapanila in #7709
  • Fix support for grains with no namespace (in global namespace) by @ReubenBond in #7758
  • [3.x] Make IKeyedSerializer public for more advanced serialization cases by @ReubenBond in #7766
  • Improve : throw `TypeLoadException on failing to load a type by @wangjia184 in #7851
  • Validate constraints that are themselves generic correctly in GenericMethodInvoker. by @niblak in #7876

New Contributors

Full Changelog: v3.6.2...v3.6.3

v3.6.2

15 Apr 21:51
041fd50
Compare
Choose a tag to compare

What's Changed

  • DynamoDB optional table create / update and update corner cases by @smiron in #7681
  • 3.x - Ensure timestamp is updated on codegen output for incremental builds by @archonandrewhunt in #7687

New Contributors

  • @archonandrewhunt made their first contribution in #7687

Full Changelog: v3.6.1...v3.6.2

v3.6.1

05 Apr 15:48
3b9db14
Compare
Choose a tag to compare

What's Changed

  • Ignore value loaded in EventHubCheckpointer if it's obviously corrupted by @benjaminpetit in #7529
  • Fix custom grain directory registration by @benjaminpetit in #7613
  • In CachedGrainLocator.Unregister, remove from cache using the address by @benjaminpetit in #7604
  • Add IGrainLocator.InvalidateCache to remove cache entry when using a custom directory by @benjaminpetit in #7636
  • Check [KnownBaseType] by Type.FullName rather than reference by @wangjia184 in #7656
  • Ignore KnownAssembly attribute which points to the containing assembly by @ReubenBond in #7664
  • Orleans.Reminders.DynamoDB use the Query operation for ReadRows by @smiron in #7658
  • Fix Source Link build for CI by @ReubenBond in #7673

New Contributors

Full Changelog: v3.6.0...v3.6.1

v4.0.0-preview1

16 Feb 00:02
dc036e3
Compare
Choose a tag to compare
v4.0.0-preview1 Pre-release
Pre-release

Major changes from the 3.x release series

The full change log lists around 500 changes, and many involve small quality of life improvements, internal refactorings for performance, reliability, versatility, and maintainability. What follows are the larger changes which we would like to highlight in these release notes since they are more likely to impact application developers.

Grain and Stream identity enhancements

Grain identities now take the form type/key where both type and key are strings. This greatly simplifies how grain identity works and improves support for generic grain types.
Previous versions of Orleans used a compound type for GrainIds in order to support grain keys of either: Guid, long, string, Guid + string, or long + string. This involves some complexity when it comes to dealing with grain keys. Grain identities consist of two components: a type and a key. The type component previously consisted of a numeric type code, a category, and 3 bytes of generic type information.

Streams are also now identified using a string instead of a Guid, which grants more flexibility, especially when working with declarative subscriptions (most commonly accessed via the [ImplicitStreamSubscription(...)] attribute)

This move to stringly-typed ids is expected to be easier for developers to work with, particularly since the GrainId and StreamId types are now public (they were internal) and GrainId is able to identify any grain.

Version-tolerant, high-performance serialization & RPC

4.x changes how serialization works. The default serializer in previous releases of Orleans is not tolerant to changes in a type's schema. Adding, removing, or renaming a field or type could cause serialization to break without obvious recourse. In 4.x, we introduce a new version-tolerant serializer which allows adding/removing/renaming fields and some type change operations (widening or narrowing a numeric type, for example). We still recommended that developers use JSON serialization for persistence. The new serializer is also designed for high performance and as a result, it is substantially faster than the serializer which it replaces.

Aside from serialization, the remote procedure call internals have been overhauled for performance and flexibility. Previous versions of Orleans use a type called InvokeMethodRequest which identifies the interface and method being invoked using generated integer values and contain an array of objects representing the arguments. The InvokeMethodRequest object is passed to a generated IGrainMethodInvoker implementation which essentially contains some nested switch statements to find the correct method to invoke, then casts the arguments in the object array to the correct types in the invocation. This design has several drawbacks:

  • Handling of overloads and complex generic types is complicated and sometimes intractable
  • It requires boxing primitive argument types, such as int, DateTimeOffset, and user-defined structs
  • Type information must be serialized for all method arguments

Instead, the replacement (which lives in Microsoft.Orleans.Serialization) involves generating an implementation of IInvokable for every method. This interface gives infrastructure components like grain filters enough information to see interface and method information as well as to inspect and manipulate arguments and return values. It is also more efficient to serialize and invoke and relies on the C# compiler to perform method overloading. Generic parameters from generic grain interfaces and generic methods become generic parameters of the implementation, avoiding or offloading most of the complexities involved with generics.

Notice about Breaking Changes

  • Clusters cannot be smoothly upgraded from a previous version of Orleans to Orleans 4.0 via a rolling upgrade.
  • Serializable types must be marked with the [GenerateSerializer] attribute, with any serializable property or field marked with the corresponding [Id(x)] attribute. This is intentionally less magical than in previous versions of Orleans, which did its best to infer what types needed to have serializers generated for them. What this extra ceremony buys you is valuable, though: version tolerance.
  • Since GrainId and StreamId are so different, persistence, streams, and reminders are not forward-compatible yet.
  • We will have more to say regarding our plans to facilitate migration of Orleans 3.x applications to Orleans 4.x.

Here is an example of a type which Orleans would generate a serializer for previously, versus how that same type should be written for Orleans 4.0:

Orleans 3.x and below:

[Serializable]
public class UserProfile
{
    public string DisplayName { get; set; }

    public string PreferredLanguage { get; set; }

    public DateTimeOffset AccountCreated { get; set; }
}

Orleans 4.x and above:

[GenerateSerializer]
public class UserProfile
{
    [Id(0)]
    public string DisplayName { get; set; }

    [Id(1)]
    public string PreferredLanguage { get; set; }

    [Id(2)]
    public DateTimeOffset AccountCreated { get; set; }
}

We have included some analyzers to make this process easier for developers. The first code fix prompts you to add the [GenerateSerializer] attribute for any type which has the [Serializable] attribute:
image
The second analyzer will add [Id(x)] attributes for you:
orleans_analyzer

Full Changelog from 3.0.0 to 4.0.0-preview1: v3.0.0...v4.0.0-preview1

Read more

v3.6.0

20 Jan 16:59
f66bff5
Compare
Choose a tag to compare

Breaking changes for Azure providers

Authentication to Azure services has evolved and connection strings are typically deemphasized in favor of managed identities. In this release, we've migrated Azure providers to newer libraries which support managed identities and other authentication methods and we've updated options to expose this functionality. Since there are a large number of potential authentication methods requiring various combinations of options, we moved away from exposing each property and instead added configuration methods to the provider options.

For example, AzureStorageOperationOptions has a ConfigureTableServiceClient method with the following overloads:

  • void ConfigureTableServiceClient(string connectionString)
  • void ConfigureTableServiceClient(Uri serviceUri)
  • void ConfigureTableServiceClient(Func<Task<TableServiceClient>> createClientCallback)
  • void ConfigureTableServiceClient(Uri serviceUri, TokenCredential tokenCredential)
  • void ConfigureTableServiceClient(Uri serviceUri, AzureSasCredential azureSasCredential)
  • void ConfigureTableServiceClient(Uri serviceUri, TableSharedKeyCredential sharedKeyCredential)

Configuration methods help to ensure that the right combination of parameters are provided.

Breaking issue with ASP.NET Core 2.1

Note, if you are using ASP.NET Core 2.1, please note that we have had reports of users running into an incompatibility issue in Microsoft.Extensions, preventing the upgrade. Please see dotnet/extensions#3800, dotnet/aspnetcore#40255, and #7608

Build system changes

  • Builds are now reproducible
  • SourceLink has been enabled and sources are no longer shipped in the NuGet packages
  • Debug symbols are now embedded in the shipped dlls instead of alongside them

Improvements and bug fixes since 3.5.1

  • Breaking and potentially breaking changes

    • Migrate to Azure.Data.Tables SDK for Azure Table Storage (#7300) (#7363)
    • Upgrade to .NET 6.0, update dependencies, and fix packaging (#7431)
  • Non-breaking improvements

    • Rewrite batch build script in powershell (#7379) (#7382)
    • Support Npgsql 6.0 for clustering and reminders (#7402)
    • Initial commit for distributed tests using crank (#7323) (#7440)
    • Support configuring ILBasedSerializer and BinaryFormatterISerializableSerializer as pre-fallback serializers (#7384)
    • Support opting in to IKeyedSerializer implementations on a per-type basis using an attribute (#7438)
    • Create PostgreSQL migrations for version 3.6.0 (#7490) (#7492)
  • Non-breaking bug fixes

    • Fix bug in validating generic constraints for method invocation (#7400)
    • Do not register IGrainStorage in DI unless there is a provider named "Default" (#7409) (#7444)
    • AdoNet - be more explicit when extracting DateTime from IDataRecord (#6968) (#7463)
    • DynamoDB Reminders load using GSI (#7437)

Thank you to the following community members for your PR contributions and to everyone else who contributed: @mjameson-se @dave-b-code @michaeltdaniels @EdeMeijer @shmurchi

Full Changelog: v3.5.1...v3.6.0

v3.5.1

08 Nov 17:18
928c259
Compare
Choose a tag to compare

Improvements and bug fixes since 3.5.0

  • Potentially-breaking changes

    • Support ILBasedSerializer as a fallback only after trying the configured fallback (#7355)
      • This change may expose cases where types in an application are no longer able to be serialized because they were being serialized by ILBasedSerializer. In 3.6.0, we are introducing an option to revert to the previous behavior (attempting to use ILBasedSerializer before the configured fallback serializer), so if this affects you, please wait for that release. If you encounter any issues, please open an issue.
  • Non-breaking improvements

    • Support Minimal API host builder (#7316)
    • CodeGenerator: support implicit using directives (#7310)
    • Improve graceful connection shutdown (#7345)
    • Upgrade Kubernetes version used by Microsoft.Orleans.Kubernetes.Hosting package (Fix: Orleans.Hosting.KubernetesHosting: System.MissingMethodException (#7364))
    • Implement GetGrainId() for SystemTargets & GrainService (#7259)
    • Make Silo.WaitForMessageToBeQueuedForOutbound configurable. (#7354) (#7355)
    • Clarify comment on disabling workload analysis and log unknown status updates at the debug level (#7358)
  • Non-breaking bug fixes

    • Fix: wrong parameter used when throwing QueueCacheMissException (#7295) (#7306)
    • Add support for generic constraint during resolution of generic grain methods (#7325)
    • Adjust ETag options on Clear/Write (#6908) (#7187) (#7326)
    • Record result of deserialization for keyed serializers (#7336)
    • Record deserialized array before deserializing array contents arrays of non-primitive types (#7335)
    • Fix in Redis GrainDirectory: when deleting, check only the ActivationId (#7362)
    • [Streaming] Fix token comparison in SetCursor (#7308)