Remove System.ServiceModel.Primitives dependency. #1017
Conversation
Add an ArrayPool<byte> from the System.Buffers namespace. With it, one can exclude the System.ServiceModel.Primitives package.
In an effort to use NetMQ with Unity3D, one problem was trying to
satisfy the dependencies for `System.ServiceModel.Primitives`. It
required also providing `System.ServiceModel.{Http,Duplex,NetTcp}` and
perhaps more before I gave up. These dependencies were only noticed
while Unity3D built the project. When using NetMQ in a regular dotnet
project, I've had no problems with the `System.ServiceModel.Primitives`
dependencies.
I added an alternative implementation of `IBufferPool` using the
`ArrayPool` from `System.Buffers` but it is unused. I instrumented the
build system to have a "Flavor" that by default is set to "Standard",
which changes nothing from before.
For my usecase, however, I set the flavor to "Minimal".
$ dotnet build -p:Flavor=Minimal
This excludes "System.ServiceModel.Primitives" and defines a
preprocessor flag of `FLAVOR_MINIMAL` that excludes the
BufferManagerBufferPool class and uses the ArrayBufferPool instead.
|
Is there a reason not to outright replace the prior implementation? Losing the dependency on a WCF library seems sensible. |
|
There's no reason that I know. I did it this way merely to make the least invasive change. Technically using |
|
I'd vote for just replacing the WCF implementation outright, and removing the dependency on that package. The implementation is here for reference: https://github.com/CoreWCF/CoreWCF/blob/f7113a7f2537ecd4d5ca397fbebbbb97aad241a1/src/CoreWCF.Primitives/src/CoreWCF/Runtime/InternalBufferManager.cs @somdoron, any thoughts on this? |
Codecov Report
@@ Coverage Diff @@
## master #1017 +/- ##
==========================================
+ Coverage 65.76% 65.81% +0.04%
==========================================
Files 146 146
Lines 9065 9076 +11
Branches 1450 1450
==========================================
+ Hits 5962 5973 +11
Misses 2503 2503
Partials 600 600
|
Subsitute with reference to System.Buffers.
I expect the BufferMangerBufferPool implementation will go away but before that happens I wanted the tests for each implementation to remain accessible. If you define USE_SERVICE_MODEL, it will build the old pool implementation and use it. And it'll also run tests against the old and new pool.
|
In response to the feedback and code coverage report given above, I added tests for both pool implementations, and based on those tests I added a fix to make I removed the I removed the reference to I did add a USE_SERVICE_MODEL define so that we can exercise tests against both implementations for the interim. On macOS, I couldn't run the full test suite. (Something hangs but I didn't investigate it.) I did exercise ArrayBufferPoolTests and BufferManagerBufferPoolTests that I wrote and they pass. From the testing I did notice one peculiarity. No matter how small the pool size parameters are, one can rent an array much larger than the max array size. This is true with the original implementation and the new implementation preserves this behavior but it seems odd. I would expect an exception to be thrown if I requested an array size that was bigger than my pool's max array size. But that doesn't happen here currently. See |
|
Is this failure genuinely a result of my changes? I'm having trouble running the test suite on macOS. I'll try on Windows another time. |
shanecelis
changed the title
|
Please be aware that the ArrayBufferPool behaves very differently than the existing BufferManagerBufferPool, very different values needs to be passed for the construction. |
In an effort to use NetMQ with Unity3D, one problem was trying to
satisfy the dependencies for
System.ServiceModel.Primitives. Itrequired also providing
System.ServiceModel.{Http,Duplex,NetTcp}andperhaps more before I gave up. These dependencies were only noticed
while Unity3D built the project. When using NetMQ in a regular dotnet
project, I've had no problems with the
System.ServiceModel.Primitivesdependencies.
I added an alternative implementation of
IBufferPoolusing theArrayPoolfromSystem.Buffersbut it is unused. I instrumented thebuild system to have a "Flavor" that by default is set to "Standard",
which changes nothing from before.
For my usecase, however, I set the flavor to "Minimal".
This excludes "System.ServiceModel.Primitives" and defines a
preprocessor flag of
FLAVOR_MINIMALthat excludes theBufferManagerBufferPool class and uses the ArrayBufferPool instead.