Enable RID-specific Apps on Shared Framework #1053

eerhardt · 2017-03-29T22:15:14Z

Allow .NET Core applications to be RID-specific, but still run on the Shared Framework. This enables an application to carry only the native assets it needs for the specific runtime it intends to run on.

For example, if an application uses a graphics library and wants to run on the shared framework, it would carry that graphics library for all the runtimes the graphics library supported (win, osx, linux, x86, x64, arm, etc). But if the application is only intended to run on one runtime, these extra assemblies bloat the app.

@ericstj @nguerrera @dsplaisted @livarcocc

/cc @Petermarcu

Notes:

There are 2 other changes that need to go into other repos:

dotnet/cli will add a new option to publish --self-contained[:false|true], which flows into the MSBuild $(SelfContained) property added here.
We need to change a single line in the DependencyModel library, which assumes "IsPortable" means "FrameworkDependent". https://github.com/dotnet/core-setup/blob/master/src/Microsoft.Extensions.DependencyModel/DependencyContextLoader.cs#L74-L76

A future, potential scenario is to publish self-contained, but don't specify any RID. This won't work today because dotnet restore hasn't restored for that RID, thus the necessary assets are not available. This can be revisited when restore occurs during publish. For now, that scenario raises an error with a message saying it is unsupported.

This option enables a RID-specific application to still use the shared framework.

Allow .NET Core applications to be RID-specific, but still run on the Shared Framework. This enables an application to carry only the native assets it needs for the specific runtime it intends to run on. For example, if an application uses a graphics library and wants to run on the shared framework, it would carry that graphics library for all the runtimes the graphics library supported (win, osx, linux, x86, x64, arm, etc). But if the application is only intended to run on one runtime, these extra assemblies bloat the app.

ericstj · 2017-03-30T03:56:55Z

src/Tasks/Microsoft.NET.Build.Tasks/DependencyContextBuilder.cs

@@ -125,7 +124,7 @@ public DependencyContext Build()
                _projectContext.LockFileTarget.TargetFramework.DotNetFrameworkName,
                _projectContext.LockFileTarget.RuntimeIdentifier,
                runtimeSignature,
-                _projectContext.IsPortable);
+                isPortable: string.IsNullOrEmpty(_projectContext.LockFileTarget.RuntimeIdentifier));


Why do we use the RID check here but plumb IsSelfContained elsewhere?

I need to add a comment here.

Basically, IsPortable != IsFrameworkDependent and IsPortable != !IsSelfContained.

But IsFrameworkDependent == !IsSelfContained. (for now until we add some other app model where it doesn't run on a shared framework and still isn't self-contained.)

IsPortable means your app can run on any machine. It is portable across architectures, OSes, etc.
IsFrameworkDependent means your app runs on the shared framework, but it can still be runtime-specific. note: IsPortable implies IsFrameworkDependent
IsSelfContained means everything required to run your app is located in your publish output.

In this case, DependencyModel is strictly asking for IsPortable, not IsFrameworkDependent or !IsSelfContained. And looking under the hood, DependencyModel treats IsPortable and an empty RuntimeIdentifier the same. In a perfect world, this boolean wouldn't be needed to be passed here.

Thanks for the thorough explanation.

Add a comment for DependencyContext IsPortable usage.

After dotnet/sdk#1053 is merged, it is possible for an app to run on the shared framework, but not be "portable". DependencyContextLoader should always load the "runtime" context, if it is present. Also, with #1597, there may be other deps files for the app. It should load those as well. Fix #1886

eerhardt · 2017-04-03T17:09:41Z

@nguerrera @dsplaisted - can you take a look?

I'd like to get this merged today.

nguerrera · 2017-04-03T17:11:06Z

src/Tasks/Microsoft.NET.Build.Tasks.UnitTests/GivenAPublishAssembliesResolver.cs

@@ -24,7 +24,8 @@ public void ItResolvesAssembliesFromProjectLockFiles(string projectName, string
            ProjectContext projectContext = lockFile.CreateProjectContext(
                FrameworkConstants.CommonFrameworks.NetCoreApp10,
                runtime,
-                Constants.DefaultPlatformLibrary);
+                Constants.DefaultPlatformLibrary,
+                false);


Please use named arguments for bools.

Done on both of these.

nguerrera · 2017-04-03T17:11:14Z

src/Tasks/Microsoft.NET.Build.Tasks.UnitTests/GivenAPublishAssembliesResolver.cs

@@ -42,7 +43,8 @@ public void ItResolvesAssembliesFromProjectLockFilesWithCacheLayout(string proje
            ProjectContext projectContext = lockFile.CreateProjectContext(
                FrameworkConstants.CommonFrameworks.NetCoreApp10,
                runtime,
-                Constants.DefaultPlatformLibrary);
+                Constants.DefaultPlatformLibrary,
+                false);


Ditto, named argument.

nguerrera · 2017-04-03T17:16:43Z

src/Tasks/Microsoft.NET.Build.Tasks/ProjectContext.cs

+            if (isFrameworkDependent)
+            {
+                Debug.Assert(platformLibrary != null);
+            }


Debug.Assert(!isFrameworkDependent || platformLibrary != null) ?

I kind of like the readability of the way it is. It is very straight-forward to understand (at least to me). The compiler will remove the if statement in release mode, since it is empty, so it isn't like it will affect the outputted assembly code.

Do you have a strong opinion on this?

I don't have a strong opinion.

This is necessary because of dotnet/sdk#1053

This is necessary for dotnet/sdk#1053

This flows to the $(SelfContained) property added in dotnet/sdk#1053

…0191030.11 (dotnet#1053) - Microsoft.AspNetCore.Analyzers - 3.1.0-preview3.19530.11 - Microsoft.AspNetCore.Mvc.Api.Analyzers - 3.1.0-preview3.19530.11 - Microsoft.AspNetCore.Mvc.Analyzers - 3.1.0-preview3.19530.11 - Microsoft.AspNetCore.Components.Analyzers - 3.1.0-preview3.19530.11

ericstj and others added 2 commits March 28, 2017 12:52

Add support for IsSharedFrameworkApplication

bcee200

This option enables a RID-specific application to still use the shared framework.

dnfclas added the cla-already-signed label Mar 29, 2017

Fix tests for CI

6073bc4

ericstj reviewed Mar 30, 2017

View reviewed changes

ericstj approved these changes Mar 30, 2017

View reviewed changes

Respond to PR feedback.

7579fb1

Add a comment for DependencyContext IsPortable usage.

nguerrera approved these changes Apr 3, 2017

View reviewed changes

eerhardt added a commit to dotnet/standard that referenced this pull request Apr 3, 2017

Add IsSelfContained parameter to ResolvePublishAssemblies.

0f48be1

This is necessary because of dotnet/sdk#1053

eerhardt mentioned this pull request Apr 3, 2017

Add IsSelfContained parameter to ResolvePublishAssemblies. dotnet/standard#283

Merged

eerhardt added a commit to eerhardt/core-setup that referenced this pull request Apr 3, 2017

Add SelfContained check to PackageConflictPlatformManifests.

23c8771

This is necessary for dotnet/sdk#1053

eerhardt mentioned this pull request Apr 3, 2017

Add SelfContained check to PackageConflictPlatformManifests. dotnet/core-setup#1936

Merged

Use named arguments on booleans.

d01532a

eerhardt merged commit 09c2a6b into dotnet:master Apr 3, 2017

eerhardt deleted the LowFatApps branch April 3, 2017 20:12

eerhardt added a commit to eerhardt/cli that referenced this pull request Apr 3, 2017

Add --self-contained to publish.

a3e0ea4

This flows to the $(SelfContained) property added in dotnet/sdk#1053

eerhardt added a commit to eerhardt/cli that referenced this pull request Apr 3, 2017

Add --self-contained to publish.

ab15200

This flows to the $(SelfContained) property added in dotnet/sdk#1053

This was referenced Apr 3, 2017

Add --self-contained to publish. dotnet/cli#6234

Merged

Add conflict resolution #1052

Merged

eerhardt mentioned this pull request Jun 23, 2017

ASP.NET TargetManifestFiles should use $(SelfContained) property aspnet/MetaPackages#175

Closed

dsplaisted mentioned this pull request Jun 1, 2018

Implement framework-dependent application with apphost. #2282

Merged

eerhardt mentioned this pull request Jan 30, 2020

DependencyContextLoader should load all dependency files it is given to it dotnet/runtime#2669

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable RID-specific Apps on Shared Framework #1053

Enable RID-specific Apps on Shared Framework #1053

eerhardt commented Mar 29, 2017

ericstj Mar 30, 2017

eerhardt Mar 30, 2017

ericstj Mar 30, 2017

eerhardt commented Apr 3, 2017

nguerrera Apr 3, 2017

eerhardt Apr 3, 2017

nguerrera Apr 3, 2017

nguerrera Apr 3, 2017

eerhardt Apr 3, 2017

nguerrera Apr 3, 2017

Enable RID-specific Apps on Shared Framework #1053

Enable RID-specific Apps on Shared Framework #1053

Conversation

eerhardt commented Mar 29, 2017

Notes:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eerhardt commented Apr 3, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment