Skip to content

Prevent race conditions in BindableProperty tests and benchmarks #3188

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

Closed
matt-goldman wants to merge 11 commits into from
Closed

Prevent race conditions in BindableProperty tests and benchmarks #3188

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
a9421df
Fix: [THREADSAFE] Use ThreadStatic for initializing property flag to …
matt-goldman Apr 6, 2026
3e78738
Use ThreadStatic for initialization flags in BindableProperty tests t…
matt-goldman Apr 6, 2026
93f1f36
Separate build and run steps in benchmarks to prevent parallel race c…
matt-goldman Apr 6, 2026
b75ccb6
Update OnValidationPropertyChanged to resolve race conditions
matt-goldman Apr 6, 2026
fd83e1d
Updsate LazyView LoadAsync test to allow indefinite wait for toekn ex…
matt-goldman Apr 6, 2026
127f834
Update src/CommunityToolkit.Maui/Behaviors/Validators/ValidationBehav…
matt-goldman Apr 6, 2026
50b3c4a
Merge branch 'main' into fix-threadsafe-bindable-property-generator
TheCodeTraveler Apr 8, 2026
8a54006
Make init flags instance fields, remove helper class prefix as now ne…
matt-goldman Apr 11, 2026
d34e922
Fix hard coded string value in test
matt-goldman Apr 11, 2026
7db8cd7
Merge branch 'main' into fix-threadsafe-bindable-property-generator
matt-goldman Apr 11, 2026
1dc38a8
Merge branch 'main' into fix-threadsafe-bindable-property-generator
matt-goldman Apr 16, 2026
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
9 changes: 7 additions & 2 deletions .github/workflows/benchmarks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,16 @@ jobs:
- name: Display dotnet info
run: dotnet --info

- name: Build Benchmarks
run: |
dotnet build ${{ env.PathToCommunityToolkitAnalyzersBenchmarksCsproj }} -c Release
dotnet build ${{ env.PathToCommunityToolkitSourceGeneratorsBenchmarksCsproj }} -c Release

- name: Run Analyzer Benchmarks
run: dotnet run --project ${{ env.PathToCommunityToolkitAnalyzersBenchmarksCsproj }} -c Release -- -a "${{ runner.temp }}"
run: dotnet run --project ${{ env.PathToCommunityToolkitAnalyzersBenchmarksCsproj }} -c Release --no-build -- -a "${{ runner.temp }}"

- name: Run Source Generator Benchmarks
run: dotnet run --project ${{ env.PathToCommunityToolkitSourceGeneratorsBenchmarksCsproj }} -c Release -- -a "${{ runner.temp }}"
run: dotnet run --project ${{ env.PathToCommunityToolkitSourceGeneratorsBenchmarksCsproj }} -c Release --no-build -- -a "${{ runner.temp }}"

- name: Publish Benchmarks
uses: actions/upload-artifact@v7
Expand Down
30 changes: 22 additions & 8 deletions ...ttributeSourceGeneratorTests/BindablePropertyAttributeSourceGenerator_CommonUsageTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -610,22 +610,36 @@ public partial class {{defaultTestClassName}}

file static class __{{defaultTestClassName}}BindablePropertyInitHelpers
{
public static volatile bool IsInitializingText = false;
[global::System.ThreadStatic]
public static bool IsInitializingText;
public static object CreateDefaultText(global::Microsoft.Maui.Controls.BindableObject bindable)
{
IsInitializingText = true;
var defaultValue = ((TestView)bindable).Text;
IsInitializingText = false;
return defaultValue;
try
{
var defaultValue = ((TestView)bindable).Text;
return defaultValue;
}
finally
{
IsInitializingText = false;
}
}

public static volatile bool IsInitializingCustomDuration = false;
[global::System.ThreadStatic]
public static bool IsInitializingCustomDuration;
public static object CreateDefaultCustomDuration(global::Microsoft.Maui.Controls.BindableObject bindable)
{
IsInitializingCustomDuration = true;
var defaultValue = ((TestView)bindable).CustomDuration;
IsInitializingCustomDuration = false;
return defaultValue;
try
{
var defaultValue = ((TestView)bindable).CustomDuration;
return defaultValue;
}
finally
{
IsInitializingCustomDuration = false;
}
}
}
""";
Expand Down
180 changes: 132 additions & 48 deletions ...tyAttributeSourceGeneratorTests/BindablePropertyAttributeSourceGenerator_EdgeCaseTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,13 +100,20 @@ public partial class {{defaultTestClassName}}

file static class __{{defaultTestClassName}}BindablePropertyInitHelpers
{
public static volatile bool IsInitializingInvoiceStatus = false;
[global::System.ThreadStatic]
public static bool IsInitializingInvoiceStatus;
public static object CreateDefaultInvoiceStatus(global::Microsoft.Maui.Controls.BindableObject bindable)
{
IsInitializingInvoiceStatus = true;
var defaultValue = ((TestView)bindable).InvoiceStatus;
IsInitializingInvoiceStatus = false;
return defaultValue;
try
{
var defaultValue = ((TestView)bindable).InvoiceStatus;
return defaultValue;
}
finally
{
IsInitializingInvoiceStatus = false;
}
}
}
""";
Expand Down Expand Up @@ -160,13 +167,20 @@ public partial class {{defaultTestClassName}}

file static class __{{defaultTestClassName}}BindablePropertyInitHelpers
{
public static volatile bool IsInitializingInvoiceStatus = false;
[global::System.ThreadStatic]
public static bool IsInitializingInvoiceStatus;
public static object CreateDefaultInvoiceStatus(global::Microsoft.Maui.Controls.BindableObject bindable)
{
IsInitializingInvoiceStatus = true;
var defaultValue = ((TestView)bindable).InvoiceStatus;
IsInitializingInvoiceStatus = false;
return defaultValue;
try
{
var defaultValue = ((TestView)bindable).InvoiceStatus;
return defaultValue;
}
finally
{
IsInitializingInvoiceStatus = false;
}
}
}
""";
Expand Down Expand Up @@ -516,67 +530,116 @@ public partial class {{defaultTestClassName}}

file static class __{{defaultTestClassName}}BindablePropertyInitHelpers
{
public static volatile bool IsInitializingIsEnabled = false;
[global::System.ThreadStatic]
public static bool IsInitializingIsEnabled;
public static object CreateDefaultIsEnabled(global::Microsoft.Maui.Controls.BindableObject bindable)
{
IsInitializingIsEnabled = true;
var defaultValue = ((TestView)bindable).IsEnabled;
IsInitializingIsEnabled = false;
return defaultValue;
try
{
var defaultValue = ((TestView)bindable).IsEnabled;
return defaultValue;
}
finally
{
IsInitializingIsEnabled = false;
}
}

public static volatile bool IsInitializingPi = false;
[global::System.ThreadStatic]
public static bool IsInitializingPi;
public static object CreateDefaultPi(global::Microsoft.Maui.Controls.BindableObject bindable)
{
IsInitializingPi = true;
var defaultValue = ((TestView)bindable).Pi;
IsInitializingPi = false;
return defaultValue;
try
{
var defaultValue = ((TestView)bindable).Pi;
return defaultValue;
}
finally
{
IsInitializingPi = false;
}
}

public static volatile bool IsInitializingLetter = false;
[global::System.ThreadStatic]
public static bool IsInitializingLetter;
public static object CreateDefaultLetter(global::Microsoft.Maui.Controls.BindableObject bindable)
{
IsInitializingLetter = true;
var defaultValue = ((TestView)bindable).Letter;
IsInitializingLetter = false;
return defaultValue;
try
{
var defaultValue = ((TestView)bindable).Letter;
return defaultValue;
}
finally
{
IsInitializingLetter = false;
}
}

public static volatile bool IsInitializingTimeSpent = false;
[global::System.ThreadStatic]
public static bool IsInitializingTimeSpent;
public static object CreateDefaultTimeSpent(global::Microsoft.Maui.Controls.BindableObject bindable)
{
IsInitializingTimeSpent = true;
var defaultValue = ((TestView)bindable).TimeSpent;
IsInitializingTimeSpent = false;
return defaultValue;
try
{
var defaultValue = ((TestView)bindable).TimeSpent;
return defaultValue;
}
finally
{
IsInitializingTimeSpent = false;
}
}

public static volatile bool IsInitializingDoubleEpsilon = false;
[global::System.ThreadStatic]
public static bool IsInitializingDoubleEpsilon;
public static object CreateDefaultDoubleEpsilon(global::Microsoft.Maui.Controls.BindableObject bindable)
{
IsInitializingDoubleEpsilon = true;
var defaultValue = ((TestView)bindable).DoubleEpsilon;
IsInitializingDoubleEpsilon = false;
return defaultValue;
try
{
var defaultValue = ((TestView)bindable).DoubleEpsilon;
return defaultValue;
}
finally
{
IsInitializingDoubleEpsilon = false;
}
}

public static volatile bool IsInitializingSingleEpsilon = false;
[global::System.ThreadStatic]
public static bool IsInitializingSingleEpsilon;
public static object CreateDefaultSingleEpsilon(global::Microsoft.Maui.Controls.BindableObject bindable)
{
IsInitializingSingleEpsilon = true;
var defaultValue = ((TestView)bindable).SingleEpsilon;
IsInitializingSingleEpsilon = false;
return defaultValue;
try
{
var defaultValue = ((TestView)bindable).SingleEpsilon;
return defaultValue;
}
finally
{
IsInitializingSingleEpsilon = false;
}
}

public static volatile bool IsInitializingCurrentTime = false;
[global::System.ThreadStatic]
public static bool IsInitializingCurrentTime;
public static object CreateDefaultCurrentTime(global::Microsoft.Maui.Controls.BindableObject bindable)
{
IsInitializingCurrentTime = true;
var defaultValue = ((TestView)bindable).CurrentTime;
IsInitializingCurrentTime = false;
return defaultValue;
try
{
var defaultValue = ((TestView)bindable).CurrentTime;
return defaultValue;
}
finally
{
IsInitializingCurrentTime = false;
}
}
}
""";
Expand Down Expand Up @@ -690,31 +753,52 @@ public partial class {{defaultTestClassName}}

file static class __{{defaultTestClassName}}BindablePropertyInitHelpers
{
public static volatile bool IsInitializingText = false;
[global::System.ThreadStatic]
public static bool IsInitializingText;
public static object CreateDefaultText(global::Microsoft.Maui.Controls.BindableObject bindable)
{
IsInitializingText = true;
var defaultValue = ((TestView)bindable).Text;
IsInitializingText = false;
return defaultValue;
try
{
var defaultValue = ((TestView)bindable).Text;
return defaultValue;
}
finally
{
IsInitializingText = false;
}
}

public static volatile bool IsInitializingTime = false;
[global::System.ThreadStatic]
public static bool IsInitializingTime;
public static object CreateDefaultTime(global::Microsoft.Maui.Controls.BindableObject bindable)
{
IsInitializingTime = true;
var defaultValue = ((TestView)bindable).Time;
IsInitializingTime = false;
return defaultValue;
try
{
var defaultValue = ((TestView)bindable).Time;
return defaultValue;
}
finally
{
IsInitializingTime = false;
}
}

public static volatile bool IsInitializingCustomDuration = false;
[global::System.ThreadStatic]
public static bool IsInitializingCustomDuration;
public static object CreateDefaultCustomDuration(global::Microsoft.Maui.Controls.BindableObject bindable)
{
IsInitializingCustomDuration = true;
var defaultValue = ((TestView)bindable).CustomDuration;
IsInitializingCustomDuration = false;
return defaultValue;
try
{
var defaultValue = ((TestView)bindable).CustomDuration;
return defaultValue;
}
finally
{
IsInitializingCustomDuration = false;
}
}
}
""";
Expand Down
15 changes: 11 additions & 4 deletions ...ttributeSourceGeneratorTests/BindablePropertyAttributeSourceGenerator_IntegrationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,13 +168,20 @@ public partial class {{defaultTestClassName}}<T, U>
[global::System.ComponentModel.EditorBrowsable(global::System.ComponentModel.EditorBrowsableState.Never)]
private static class __{{defaultTestClassName}}BindablePropertyInitHelpers
{
public static volatile bool IsInitializingValue = false;
[global::System.ThreadStatic]
public static bool IsInitializingValue;
public static object CreateDefaultValue(global::Microsoft.Maui.Controls.BindableObject bindable)
{
IsInitializingValue = true;
var defaultValue = (({{defaultTestClassName}}<T, U>)bindable).Value;
IsInitializingValue = false;
return defaultValue;
try
{
var defaultValue = (({{defaultTestClassName}}<T, U>)bindable).Value;
return defaultValue;
}
finally
{
IsInitializingValue = false;
}
}
}
}
Expand Down
14 changes: 9 additions & 5 deletions ...unityToolkit.Maui.SourceGenerators/Generators/BindablePropertyAttributeSourceGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -597,15 +597,16 @@ static string GetFormattedReturnType(ITypeSymbol typeSymbol)
/// <param name="info">Property model.</param>
static void AppendHelperInitializingField(StringBuilder fileStaticClassStringBuilder, in BindablePropertyModel info)
{
// Make the flag public static so it can be referenced from the generated partial class in the same file.
fileStaticClassStringBuilder.Append("public static volatile bool ")
// Use [ThreadStatic] so each thread has its own flag, preventing cross-thread
// interference when multiple instances resolve default values concurrently.
fileStaticClassStringBuilder.Append("[global::System.ThreadStatic]\npublic static bool ")
.Append(info.InitializingPropertyName)
.Append(" = false;\n");
.Append(";\n");
}

/// <summary>
/// Appends a default value creator method into the file-static helper class.
/// The method sets the static initializing flag, reads the property's initializer value by casting the bindable
/// The method sets the thread-static initializing flag, reads the property's initializer value by casting the bindable
/// to the declaring type, then clears the flag and returns the value.
/// </summary>
/// <param name="fileStaticClassStringBuilder">Helper StringBuilder used to collect helper members.</param>
Expand All @@ -621,14 +622,17 @@ static void AppendHelperDefaultValueMethod(StringBuilder fileStaticClassStringBu
.Append("{\n")
.Append(info.InitializingPropertyName)
.Append(" = true;\n")
Comment thread
TheCodeTraveler marked this conversation as resolved.
.Append("try\n{\n")
.Append("var defaultValue = ((")
.Append(fullDeclaringType)
.Append(")bindable).")
.Append(sanitizedPropertyName)
.Append(";\n")
.Append("return defaultValue;\n")
.Append("}\nfinally\n{\n")
.Append(info.InitializingPropertyName)
.Append(" = false;\n")
.Append("return defaultValue;\n")
.Append("}\n")
.Append("}\n\n");
}
}
Loading
Loading