orleans

Bug fix: Prevent null reference exception after clearing PubSubRendezvousGrain state #2040

NB: There is a subtle breaking change in this release, which is unfortunately easy to miss.
If you are using AzureSilo.Start(ClusterConfiguration config, string deploymentId) in your code, that overload has been removed, but the new one that replaced it has the same argument signature with a different second argument: (ClusterConfiguration config, string connectionString). Deployment ID now has to be passed as part of the config argument: config.Globals.DeploymentId. This removed the ambiguous possibility of passing two different Deployment IDs, but unfortunately at the cost of the breaking API change.

• Notable new features
  • Support for geo-distributed multi-cluster deployments #1108 #1109 #1800
  • Added new Amazon AWS basic Orleans providers #2006
  • Support distributed cancellation tokens in grain methods #1599
• Providers
  • Remove confusing parameter from AzureSilo.Start #2109
  • Minimal Service Fabric integration #2120
  • Update blob storage provider to throw on storage exceptions #1902
  • Decode protobuf using MessageParser, not dynamic #2136
  • Service Provider is no longer required by EventHubAdapter #2044
  • Preliminary relational persistence queries #1682
  • Add a function that checks the connection string for use during initialization #1987
  • A new ADO.NET storage provider that is significantly easier to setup, which replaces the the previous one. This change is not backwards compatible and does not support sharding
    (likely be replaced later with Orleans sharding provider). The most straightforward migration plan is likely to persist the state classes from Orleans application code.
    More information in #1682 and in #1682 (comment).
  • Support for PostgreSql #2113
  • Memory Storage eTag enforcement less strict. #1885
  • Added option to perform provider commands quietly #1762
  • CreateOrleansTables_SqlServer.sql: Removed support for SQL Server 2000 and 2005 #1779
• Streaming
  • EventHub stream provider made more extensible #1861 1714
  • EventHub stream provider with improved monitoring logging #1857 #2146
  • EventHub stream provider time based message purge #2093
  • Add Memory Stream Provider #2063
  • Persistent stream pulling agent now uses exponential backoff #2078
  • Add dynamic adding / removing stream providers functionality. #1966
  • Consistent implicit subscription Id generation. #1828
  • Event hub stream provider EventData to cached data mapping #1727
• Bug fixes
  • CodeGen: fix generated DeepCopy method to call RecordObject earlier #2135
  • Fix support for serializing SByte[] #2140
  • Fix synchronization bug in Orleans/Async/BatchWorker #2133
  • Fix #2119 by allowing full uninitialization in SiloHost #2127
  • Persistent Stream Provider initialization timeout fix. #2065
  • Fix null reference in StreamPubSub grain. #2040
  • Some EventHub stream provider bug fixes #1760 #1935 #1921 #1922
  • Allow comments in configuration XML #1994
  • Fixed null MethodInfo in Interceptors #1938
  • EventHub stream provider Object Pools not pooling fix. #1937
  • Harden explicit subscription pubsub system #1884
  • Fix #1869. Grain Extensions + method interception should function correctly #1874
  • Fix bug with generic state parameter caused by inconsistent use of grainClassName / genericArgument / genericInterface #1897
  • Throw meaningful exception if grain timer is created outside grain context #1858
  • Do not deactivate Stateless Workers upon grain directory partition shutdown. #1838
  • Fixed a NullReferenceException bug in ClientObserverRegistrar. #1823
• Test
  • Allow liveness config in TestCluster #1818
  • Fix for strange bug in BondSerializer #1790
  • Some improvements for unit testing #1792 #1802
• Other
  • Move JSON serialization methods into OrleansJsonSerializer #2206
  • Updated package dependencies for Azure Storage, ServiceBus, ZooKeeperNetEx, Protobuf and codegen related
  • Remove UseStandardSerializer and UseJsonFallbackSerializer options #2193 #2204
  • Make IGrainFactory injectable #2192
  • Recover types from ReflectionTypeLoadException #2164
  • Moved Orleans Performance Counters into its own Telemetry Consumer. Now you need to explicitly register the OrleansPerfCounterTelemetryConsumer either by code or XML. More information in #2122 and docs will come later. Microsoft.Orleans.CounterControl can still be used to install the performance counters or you can use InstallUtil.exe OrleansTelemetryConsumers.Counters.dll to install it without depending on OrleansCounterControl.exe
  • New PowerShell client Module #1990
  • Expose property IsLongKey for IAddressable #1939
  • Removed OrleansDependencyInjection package and instead Orleans references Microsoft.Extensions.DepedencyInjection #1911 #1901 #1878
  • Now using Microsoft.Extensions.DepedencyInjection.ServiceProvider as the default service provider if the user does not override it. Grains are still not being injected automatically unless the user opts in by specifying his own Startup configuration that returns a service provider.
  • Do not require explicitly registering grains in ServiceCollection #1901
  • ClusterConfiguration extension for setting Startup class #1842
  • Log more runtime statistics on the client. #1778
  • Added ManagementGrain.GetDetailedHosts() #1794
  • Can get a list of active grains in Orleans for monitoring #1772
  • Rename InstanceName to SiloName. #1740
  • Reworked documentation to use DocFX #1970

Beta1 release of Microsoft Orleans v1.3.0
It does not yet include all the features that will go into the final 1.3.0 release. Most notably, the Global Single Instance protocol for Multi-Clusters (#1800).

See https://github.com/dotnet/orleans/issues/1972 for pending work that should go into the final release of 1.3.0

• Ability to force creation of Orleans serializers for types not marked with [Serializable] by using GenerateSerializer, KnownType or KnownAssembly.TreatTypesAsSerializable #1888 #1864 #1855
• Troubleshooting improvements:
  • Fixed stacktrace preservation in exceptions from grain calls (bug introduced in 1.2.0) #1879 #1808
  • Better messaging when silo fails to join due to initial connectivity problems #1866 #1933
  • Throw meaningful exception if grain timer is created outside grain context #1858
• Bug fixes:
  • Do not deactivate Stateless Workers upon grain directory partition shutdown #1838
  • interception works with Streams and grain extensions #1874
  • Memory Storage provider properly enforces etags for any state that has been added or removed, but does not enforce etags for newly added state. #1885
  • Other minor bug fixes #1884 #1823

• Bugfix: Remote stacktrace is once again being included in the exception that bubbles up to the caller (bug introduced in 1.2.0). https://github.com/dotnet/orleans/pull/1808
• Bugfix: Memory Storage provider no longer throws NullReferenceException after the grain state is cleared. https://github.com/dotnet/orleans/pull/1804
• Microsoft.Orleans.OrleansCodeGenerator.Build package updated to not add the empty orleans.codegen.cs content file at install time, and instead create it at build time (should be more compatible with NuGet Transitive Restore). https://github.com/dotnet/orleans/pull/1720
• Added GrainCreator abstraction to enable some unit testing scenarios.https://github.com/dotnet/orleans/pull/1802/ https://github.com/dotnet/orleans/pull/1792/
• ServiceBus package dependency upgraded to 3.2.2 https://github.com/dotnet/orleans/pull/1758/

Bug fixes:

• SupressDuplicateDeads: Use SiloAddress.Endpoint instead of InstanceName. https://github.com/dotnet/orleans/pull/1728
• Added support for complex generic grain parameters https://github.com/dotnet/orleans/pull/1732
• Fix race condition bugs in LocalReminderService https://github.com/dotnet/orleans/pull/1757

In addition to all the changes in 1.2.0-beta.

• Azure storage 7.0 compatibility https://github.com/dotnet/orleans/pull/1704.
• Updated to latest version of Consul and ZooKeeper NuGets.
• Added ability to throw exceptions that occur when starting silo https://github.com/dotnet/orleans/pull/1711.

• Major improvements
  • Added an EventHub stream provider based on the same code that is used in Halo 5.
  • Increased throughput by between 5% and 26% depending on the scenario. https://github.com/dotnet/orleans/pull/1586
  • Migrated all but 30 functional tests to GitHub.
  • Grain state doesn't have to extend GrainState anymore (marked as [Obsolete]) and can be a simple POCO class.
  • Added support for per-grain-class and global server-side interceptors. https://github.com/dotnet/orleans/pull/965 https://github.com/dotnet/orleans/pull/963
  • Added support for using Consul 0.6.0 as a Membership Provider. https://github.com/dotnet/orleans/pull/1267
  • Support C# 6. https://github.com/dotnet/orleans/pull/1479
  • Switched to xUnit for testing as a step towards CoreCLR compatibility. https://github.com/dotnet/orleans/pull/1455
• Codegen & serialization
  • Added support for generic type constraints in codegen. https://github.com/dotnet/orleans/pull/1137
  • Added support for Newtonsoft.Json as a fallback serializer. https://github.com/dotnet/orleans/pull/1047
  • Added generation of serializers for type arguments of IAsyncObserver<T>. https://github.com/dotnet/orleans/pull/1319
  • Improved support for F# interfaces. https://github.com/dotnet/orleans/pull/1369
  • Consolidated two compile time codegen NuGet packages into one Microsoft.Orleans.OrleansCodeGenerator.Build. Microsoft.Orleans.Templates.Interfaces and Microsoft.Orleans.Templates.Grains are now meta-packages for backward compatibility only. https://github.com/dotnet/orleans/pull/1501
  • Moved to Newtonsoft.Json 7.0.1. https://github.com/dotnet/orleans/pull/1302
• Programmatic config
  • Added helper methods for programmatic test configuration. https://github.com/dotnet/orleans/pull/1411
  • Added helper methods to AzureClient and AzureSilo for easier programmatic config. https://github.com/dotnet/orleans/pull/1622
  • Added extension methods for using programmatic config. https://github.com/dotnet/orleans/pull/1623
  • Remove config filed from Server and Client NuGet packages. https://github.com/dotnet/orleans/pull/1629
• Other
  • Improved support for SQL membership, reminders, and grain storage.
    https://github.com/dotnet/orleans/pull/1060
  • Improved propagation of exception, so that the caller gets the originally thrown exception instead of an AggregateException wrapping it. https://github.com/dotnet/orleans/pull/1356
  • Added a storage provider for Azure Blob (graduated from OrleansContrib). https://github.com/dotnet/orleans/pull/1376
  • Start Reminder Service initial load in the background. https://github.com/dotnet/orleans/pull/1520
  • Added automatic cleanup of dead client stream producers and consumers. https://github.com/dotnet/orleans/pull/1429 https://github.com/dotnet/orleans/pull/1669
  • Added GetPrimaryKeyString extension method for IAddressable. https://github.com/dotnet/orleans/pull/1675
  • Added support for additional application directories. https://github.com/dotnet/orleans/pull/1674
• Many other fixes and improvements.

A patch release with a set of bug fixes.

• https://github.com/dotnet/orleans/pull/1345 Initialize SerializationManager before CodeGeneratorManager
• https://github.com/dotnet/orleans/pull/1348 Avoid unnecessary table scan when finding reminder entries to delete
• https://github.com/dotnet/orleans/pull/1351 Stop a stuck BlockingCollection.Take operation that caused thread leak on the client.
• https://github.com/dotnet/orleans/pull/1381 Fixed Azure table property being not sanitized.
• https://github.com/dotnet/orleans/pull/1384 Fixed String.Format arguments in DetailedGrainReport.ToString()
• https://github.com/dotnet/orleans/pull/1405 Increment and DecrementMetric methods in Orleans.TraceLogger had same body
• https://github.com/dotnet/orleans/pull/1414 Update the custom serializer warning message to adequately reflect the OSS status of Orleans
• https://github.com/dotnet/orleans/pull/1503 Fix retry timeout when running under debugger
• https://github.com/dotnet/orleans/pull/1478 Networking bug fix: Reset receive buffer on error.
• https://github.com/dotnet/orleans/pull/1518 Fixed performance regression in networking
• https://github.com/dotnet/orleans/pull/1520 Start ReminderService initial load in the background
• https://github.com/dotnet/orleans/pull/1534 Safe load of types from failing assemblies in TypeUtils.GetTypes

A patch release with bug fixes, primarily for codegen and serializer corner cases.

• https://github.com/dotnet/orleans/pull/1137 Add support for generic type constraints in codegen
• https://github.com/dotnet/orleans/pull/1178 Correctly specify struct type constraint in generated code
• https://github.com/dotnet/orleans/pull/1182 fix issue:GetReminder throws exception when reminder don't exists #1167
• https://github.com/dotnet/orleans/pull/1240 Cleanup/fix usage of IsNested vs. IsNestedXXX & serialize nested types.
• https://github.com/dotnet/orleans/pull/1241 Correctly serialize [Obsolete] fields and properties.
• https://github.com/dotnet/orleans/pull/1249 Nested serialization of Guid with Json serializer.
• https://github.com/dotnet/orleans/pull/1261 Fix a race in StreamConsumer.SubscribeAsync.
• https://github.com/dotnet/orleans/pull/1280 fix deepcopy issue #1278
• https://github.com/dotnet/orleans/pull/1284 Check declaring types when performing accessibility checks for code gen.
• https://github.com/dotnet/orleans/pull/1285 Allow to configure PubSub for SMS.
• https://github.com/dotnet/orleans/pull/1270 Make Namespace access modifier public in ImplicitStreamSubscriptionAttribute. Add Provider property.

A patch release for two bug fixes.

• https://github.com/dotnet/orleans/pull/1134 Missing argument to trace format in TraceLogger.Initialize
• https://github.com/dotnet/orleans/pull/1195 Make ConsoleText resilient to ObjectDisposedExceptions

• New Roslyn-based codegen, compile time and run time
• Public APIs:
  • Core API for Event Sourcing
  • Most methods of Grain class are now virtual
  • ASP.NET vNext style Dependency Injection for grains
  • New telemetry API
• Portability:
  • Support for C# 6.0
  • Improved support for F# and VB
  • Code adjustments towards CoreCLR compliance
  • Orleans assemblies are not strong-named anymore
• SQL:
  • OrleansSQLUtils.dll for SQL-related functionality
  • MySQL is now supported as a cluster membership store
  • Storage provider for SQL Server
• Serialization:
  • Support for pluggable external serializers
  • Bond serializer plugin
  • Support for Json.Net as a fallback serializer
  • Added [KnownType] attribute for generating serializers for arbitrary types
• Upgraded to Azure Storage 5.0
• Upgraded to .NET 4.5.1
• Other fixes and improvements

• New Roslyn-based codegen, compile time and run time
• Support for C# 6.0
• ASP.NET vNext style Dependency Injection for grains
• Core API for Event Sourcing
• Code adjustments towards CoreCLR compliance
• OrleansSQLUtils.dll for SQL-related functionality
• MySQL is now supported as a cluster membership store
• Most methods of Grain class are now virtual
• Orleans assemblies are not strong-named anymore
• Storage provider for SQL Server
• Support for pluggable external serializers
• Bond serializer plugin
• Support for Json.Net as a fallback serializer
• Improved support for F# and VB
• Added [KnownType] attribute for generating serializers for arbitrary types
• New telemetry API
• Upgraded to Azure Storage 5.0
• Other fixes and improvements

• New Roslyn-based codegen, compile time and run time
• Support for C# 6.0
• ASP.NET vNext style Dependency Injection for grains
• Core API for Event Sourcing
• Code adjustments towards CoreCLR compliance
• OrleansSQLUtils.dll for SQL-related functionality
• Most methods of Grain class are now virtual
• Orleans assemblies are not strong-named anymore
• Other fixes and improvements (including progress on CoreCLR compatability)

General:

• No SDK msi anymore, only NuGets from now on
• Removed support for grain state interfaces and code generation of state classes
• Removed code generated MyGrainFactory.GetGrain() factory methods
• StorageProvider attribute is now optional
• Membership and reminder table implementations were made pluggable
• Improvements to ObserverSubscriptionManager
• Strong guarantee for specified max number of StatelessWorker activations per silo
• General purpose interface for sending run time control commands to providers
• Named event to trigger silo shutdown

Streaming:

• Support for multiple ImplicitSubscription attributes for streams
• Support for rewinding of implicit stream subscriptions
• Propagate request context via persistent streams
• More options for stream Queue Balancers
• Delayed repartitioning of stream queues
• Improved cleanup of client stream producers/consumers when client shuts down
• Config option and management grain API for controlling start/stop state of stream pulling agents
• Azure Queue stream provider fixed to guarantees at least once delivery
• Numerous bug fixes and improvements, mostly to streaming

• Graceful shutdown of a silo with deactivation of all grains hosted in it.
• Support for Dependency Injection and better testability of grains:
  • Direct instantiation of grains with passing IGrainIdentity and IGrainRuntime to constructor.
  • IGrainRuntime is a mockable interface that includes a set of system service interfaces, also mockable.
  • GrainFactory is a non-static class that is accessed via base.GrainFactory from within a grain and via GrainClient.GrainFactory on the client.
• Deprecated generated per-interface GetGrain static factory methods.
• Added support for concrete grain state classes, deprecated grain state interfaces and code generation of grain classes.
• Removed Read/Write/ClearStateAsync methods from IGrainState and moved them to Grain<T>.
• Performance optimizations of messaging with up to 40% improvements in throughput.
• Added ZooKeeper based cluster membership storage option.
• Removed compile time dependency on Microsoft.WindowsAzure.ServiceRuntime.dll.
• Consolidated dependencies on Azure in OrleansAzureUtils.dll, which is now optional.
• Refactored SQL system store to be more robust and vendor agnostic.
• Added streaming event deliver policy and failure reporting.
• Changed VS project templates to use only NuGet packages and not the SDK.
• Removed binaries and local silo environment from the SDK.
• Numerous bug fixes and other improvements.

Fixed versions of references Orleans NuGet packages to match the current one.
Switched message header keys from strings to enums for performance.
Fixed a deadlock issue in deactivation process.
Added a NuGet package to simplify testing of grain projects - Microsoft.Orleans.TestingHost.
Fixed regression of reporting codegen error to Visual Studio Errors window.
Added version to SDK msi product and folder name.
Other fixes and improvements.

Major refactoring of the stream adapter API.
Improvements to the steaming API to support subscription multiplicity.
Made IAddressable.AsReference strongly-typed.
Added a Chocolatey package.
Added support for private storage keys for testing.
Replaced ExtendedPrimaryKeyAttribute with IGrainWithGuidCompoundKey and IGrainWithIntegerCompoundKey.
Added support for grain classes that are implementations of generic grain interfaces with concrete type arguments.
Numerous other fixes and improvements.

Major reorganization of NuGet packages and project templates.
Fixes to reflection-only assembly inspection and loading for side-by-side versioning.
Improved scalability of observers.
Programmatic configuration of providers.
Numerous other fixes and improvements.

Stable production-quality release identical to v1.0.0 but with Newtonsoft.Json.dll added to LocalSilo and OrleansServer folders. Azure Table persistence provider has a dependency on Newtonsoft.Json.dll for JSON serialization.