Skip to content

CSLA 10 upgrade doc #4745

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
+10 −6
Draft

CSLA 10 upgrade doc #4745

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0dcdf57
Clean up CSLA 10 upgrade doc
rockfordlhotka Oct 17, 2025
71c7b38
Merge branch 'main' into dev/v10-notes
rockfordlhotka Nov 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions docs/Upgrading to CSLA 10.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ TBD

The constructor has changed and now expects an `IOptions<RevalidatingInterceptorOptions>` instance. With this new options object it is now possible to skip the revalidation of business rules during a `Delete` operation.
To configure the new options we are using the .Net [Options pattern](https://learn.microsoft.com/en-us/dotnet/core/extensions/options).

```csharp
services.Configure<RevalidatingInterceptorOptions>(opts =>
{
Expand All @@ -22,22 +23,24 @@ services.Configure<RevalidatingInterceptorOptions>(opts =>
```

## Exception from asynchronous rules

A new API is added to make it possible to handle exceptions thrown by asynchronous rules.
The new interface to implement is `Csla.Rules.IUnhandledAsyncRuleExceptionHandler` which has two methods
* `bool CanHandle(Exception, IBusinessRuleBase)`
* to decide whether this exception should be handled or not

* `bool CanHandle(Exception, IBusinessRuleBase)`
* to decide whether this exception should be handled or not
* `ValueTask Handle(Exception, IBusinessRuleBase, IRuleContext)`
* to handle the exception when `CanHandle(...) == true`
* to handle the exception when `CanHandle(...) == true`

With these methods you can now decide whether to handle the exception and how or let the exception be unobserved bubble up and potentially cause a crash.

You can register your implementation in two ways

* Just add the implementation to your service collection `services.AddScoped<IUnhandledAsyncRuleExceptionHandler, YourImplementation>()`
* Use `services.AddCsla(o => o.UseUnhandledAsyncRuleExceptionHandler<YourImplementation>());`. The handler is registered as scoped.

The _default_ is still no handling of any exception thrown in an asynchronous rule.


## Nullable Reference Types

CSLA 10 supports the use of nullable reference types in your code. This means that you can use the `#nullable enable` directive in your code and the compiler will now tell you where CSLA does not expect any `null` values or returns `null`.
Expand Down Expand Up @@ -76,9 +79,10 @@ Supporting nullable types means that some APIs have changed to support nullable
* `DataPortalResponse` now uses `[AutoSerializable]` to auto implement `IMobileObject` instead of inheriting from `ReadOnlyBase`.
* `UpdateRequest` now uses `[AutoSerializable]` to auto implement `IMobileObject` instead of inheriting from `ReadOnlyBase`.


## Breaking changes

* `Csla.Server.DataPortal` constructor changed.
* Removed unused parameters: `IDataPortalActivator activator`, `IDataPortalExceptionInspector exceptionInspector`.
* `Csla.Rules.BusinessRules` constructor changed.
* New parameter `IUnhandledAsyncRuleExceptionHandler` added to support the new asynchronous rule exception handling.
* New parameter `IUnhandledAsyncRuleExceptionHandler` added to support the new asynchronous rule exception handling.