Skip to content

Implementing Feature Switch for CFNetworkHandler and NSUrlSessionHandler #19003

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
wants to merge 11 commits into from
Closed

Implementing Feature Switch for CFNetworkHandler and NSUrlSessionHandler #19003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
410cd4b
Add UseCFNetworkHandler and UseNSUrlSessionHandler internal static bo…
Agnik7 Sep 12, 2023
c334747
Compute the value for properties UseCFNetworkHandler and UseNSUrlSess…
Agnik7 Sep 12, 2023
04e103a
Computing the values for UseCFNetworkHandler and UseNSUrlSessionHandler
Agnik7 Sep 12, 2023
d00e2b8
Added 2 new Runtimes
Agnik7 Sep 12, 2023
ee19d84
Reworked code to use 2 new Runtime properties
Agnik7 Sep 12, 2023
4e9835e
Fixed compilation errors, moved logic to Read() method.
dustin-wojciechowski Sep 15, 2023
89f467f
Fixed formatting
dustin-wojciechowski Sep 15, 2023
d32496e
Auto-format source code
Sep 15, 2023
d9902b8
Merge branch 'net8.0' into net8.0
dalexsoto Sep 18, 2023
5ec35c6
Created backing fields for UseCFNetworkHandler and UseNSURLSessionHan…
dustin-wojciechowski Sep 19, 2023
88b9703
Whitespace
dustin-wojciechowski Sep 19, 2023
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
8 changes: 8 additions & 0 deletions dotnet/targets/Xamarin.Shared.Sdk.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -483,12 +483,20 @@
<!-- Set NativeAOT value -->
<_IsNativeAOTFeature Condition="'$(_XamarinRuntime)' == 'NativeAOT'">true</_IsNativeAOTFeature>
<_IsNativeAOTFeature Condition="'$(_XamarinRuntime)' != 'NativeAOT'">false</_IsNativeAOTFeature>

<!-- Computing the values for UseCFNetworkHandler and UseNSUrlSessionHandler -->
<_IsCFNetworkHandlerFeature Condition="'$(UseNativeHttpHandler)' == 'true' And '$(MtouchHttpClientHandler)' == 'CFNetworkHandler'">true</_IsCFNetworkHandlerFeature>
<_IsCFNetworkHandlerFeature Condition="'$(_IsCFNetworkHandlerFeature)' == ''">false</_IsCFNetworkHandlerFeature>
<_IsNSUrlSessionHandlerFeature Condition="'$(UseNativeHttpHandler)' == 'true' And '$(MtouchHttpClientHandler)' == 'NSUrlSessionHandler'">true</_IsNSUrlSessionHandlerFeature>
<_IsNSUrlSessionHandlerFeature Condition="'$(_IsNSUrlSessionHandlerFeature)' == ''">false</_IsNSUrlSessionHandlerFeature>
</PropertyGroup>

<ItemGroup>
<RuntimeHostConfigurationOption Include="ObjCRuntime.Runtime.Arch.IsSimulator" Value="$(_IsSimulatorFeature)" Trim="true" />
<RuntimeHostConfigurationOption Include="ObjCRuntime.Runtime.IsManagedStaticRegistrar" Value="$(_IsManagedStaticRegistrarFeature)" Trim="true" />
<RuntimeHostConfigurationOption Include="ObjCRuntime.Runtime.IsNativeAOT" Value="$(_IsNativeAOTFeature)" Trim="true" />
<RuntimeHostConfigurationOption Include="ObjCRuntime.Runtime.UseCFNetworkHandler" Value="$(_IsCFNetworkHandlerFeature)" Trim="true" />
<RuntimeHostConfigurationOption Include="ObjCRuntime.Runtime.UseNSUrlSessionHandler" Value="$(_IsNSUrlSessionHandlerFeature)" Trim="true" />
</ItemGroup>
</Target>

Expand Down
6 changes: 6 additions & 0 deletions src/ObjCRuntime/Runtime.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ public partial class Runtime {
static object lock_obj;
static IntPtr NSObjectClass;
static bool initialized;
static bool useCFNetworkHandler = false;
static bool useNSUrlSessionHandler = false;
Comment on lines +52 to +53
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The assignment to the default value is unnecessary, except that the default is to use NSUrlSessionHandler:

Suggested change
static bool useCFNetworkHandler = false;
static bool useNSUrlSessionHandler = false;
static bool useCFNetworkHandler;
static bool useNSUrlSessionHandler = true;


internal static IntPtrEqualityComparer IntPtrEqualityComparer;
internal static TypeEqualityComparer TypeEqualityComparer;
Expand Down Expand Up @@ -249,6 +251,10 @@ public static bool DynamicRegistrationSupported {
}
}

internal static bool UseCFNetworkHandler => useCFNetworkHandler;

internal static bool UseNSUrlSessionHandler => useNSUrlSessionHandler;

internal static bool Initialized {
get { return initialized; }
}
Expand Down
10 changes: 10 additions & 0 deletions src/ObjCRuntime/RuntimeOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,15 @@ internal static TypeDefinition GetHttpMessageHandler (Application app, RuntimeOp

internal static RuntimeOptions? Read ()
{
#if NET
var options = new RuntimeOptions ();
if (Runtime.UseCFNetworkHandler)
options.http_message_handler = CFNetworkHandlerValue;
else if (Runtime.UseNSUrlSessionHandler)
options.http_message_handler = NSUrlSessionHandlerValue;

return options;
#else
Comment on lines 157 to +167
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this can be simplified a lot more, by inlining this logic in the GetHttpMessageHandler method below:

internal static HttpMessageHandler GetHttpMessageHandler ()
{
#if NET
    if (Runtime.UseCFNetworkHandler)
        return new CFNetworkHandler ();
    if (Runtime.UseNSUrlSessionHandler)
        return new NSUrlSessionHandler ();
    return new HttpClientHandler ();
#else
   // existing logic
#endif
}

// for iOS NSBundle.ResourcePath returns the path to the root of the app bundle
// for macOS apps NSBundle.ResourcePath returns foo.app/Contents/Resources
// for macOS frameworks NSBundle.ResourcePath returns foo.app/Versions/Current/Resources
Expand All @@ -171,6 +180,7 @@ internal static TypeDefinition GetHttpMessageHandler (Application app, RuntimeOp
options.http_message_handler = (NSString) plist ["HttpMessageHandler"];
return options;
}
#endif
}

// This is invoked by
Expand Down