-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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.
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
Move the working BinaryFormatter implementation to a NuGet package #103255
Changes from 2 commits
c508a3c
f3b7ba8
3dd94ff
ad7974f
d69488f
eaaa177
72c9197
9c68be5
a5c760d
be4a980
abdae6f
5bb3345
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
<Project> | ||
<Import Project="..\Directory.Build.targets" /> | ||
<PropertyGroup> | ||
|
||
<!-- | ||
The real implementation of this library is built for NetCoreAppMinimum, | ||
the NetCoreAppCurrent build has a non-functional copy of BinaryFormatter. | ||
The NetCoreAppCurrent build is only included in the shared runtime, | ||
and should always lose to the package for unification; so it is pinned | ||
at an assembly version that will always lose. | ||
--> | ||
<AssemblyVersion Condition="'$(TargetFramework)' == '$(NetCoreAppCurrent)'">8.1.0.0</AssemblyVersion> | ||
</PropertyGroup> | ||
</Project> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
## About | ||
|
||
Provides the legacy BinaryFormatter class for workloads which still require it. | ||
|
||
## Main Types | ||
|
||
The main types provided by this library are: | ||
|
||
* `System.Runtime.Serialization.Formatters.Binary.BinaryFormatter` | ||
|
||
## Additional Documentation | ||
|
||
* [Obsoletion Notice](https://aka.ms/binaryformatter) | ||
|
||
## Feedback & Contributing | ||
|
||
System.Runtime.Serialization.Formatters is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports are welcome at [the GitHub repository](https://github.com/dotnet/runtime). This package is considered legacy, and we only consider low-risk, high-impact fixes that are necessary to maintain functionality. |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -75,6 +75,21 @@ internal ObjectReader(Stream stream, ISurrogateSelector? selector, StreamingCont | |
_formatterEnums = formatterEnums; | ||
} | ||
|
||
private static IDisposable? StartDeserialization() | ||
{ | ||
MethodInfo? targetMethod = typeof(SerializationInfo).GetMethod( | ||
"StartDeserialization", | ||
BindingFlags.Public | BindingFlags.Static, | ||
Type.EmptyTypes); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Worth caching (or caching a delegate created to it)? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It would be even better to use UnsafeAccessor - no reflection, no delegates, no caching. UnsafeAccessor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Slow invoke works, or we can add another method in corelib that does the boxing to IDisposable there so it can be bound with UnsafeAccessor. I'm guessing we don't like that option, so I'm guessing we're sticking with slow-invoke. But either way I've moved this to a different type, and am at least saving the MethodInfo. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we rather get rid of this (it would be my preference), or turn it into a public API? The non-public dependencies of OOB nuget packages like this one are always factory for problems. |
||
|
||
if (targetMethod is null) | ||
{ | ||
throw new InvalidOperationException(); | ||
} | ||
|
||
return (IDisposable?)targetMethod.Invoke(null, null); | ||
} | ||
|
||
[RequiresDynamicCode(ObjectReaderUnreferencedCodeMessage)] | ||
[RequiresUnreferencedCode("Types might be removed")] | ||
internal object Deserialize(BinaryParser serParser) | ||
|
@@ -87,7 +102,7 @@ internal object Deserialize(BinaryParser serParser) | |
|
||
_isSimpleAssembly = (_formatterEnums._assemblyFormat == FormatterAssemblyStyle.Simple); | ||
|
||
using (DeserializationToken token = SerializationInfo.StartDeserialization()) | ||
using (StartDeserialization()) | ||
{ | ||
if (_fullDeserialization) | ||
{ | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we need to build this for .NET 8?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's the best/only way I could find for having two builds for the DLL, one where BF works (net8/NuGet) and one where it doesn't (net9/shared runtime).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where are the problems with building the non-working inbox version via independent project?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm. The original plan was to typeforward BinaryFormatter out into a new library and do the package trick there (which would still have required making two copies), but it turns out that System.Runtime.Serialization.Formatters.dll is itself basically the minimum closure of BinaryFormatter.
It sounds like your suggestion is to sort of do that again, making something like
I don't know how well our build system would like that. And since the preview snap date is Tuesday, I don't know that I have the time to find out before then. We could explore it after.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, something like that. The current scheme where the build for NetCoreAppMinimum is meant for NetCoreAppCurrent is not easy to understand. It is fine to explore something better later. It is possible that what you have put together is the best out of all bad solutions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
NuGet limits us here. It doesn't support specifying multiple TFMs that map to the same TargetFrameworkMoniker+TargetPlatformMoniker tuple in a project. There's a proposal up to fix that eventually but until then, separate projects need to be used in such scenarios.
We have multiple source generator project files per rdifferent roslyn targeting pack version because of the exact same reason.
I would agree with Jan that the current solution might be good enough for what's proposed.