1.8.0 - issues with dependency on Microsoft.OpenApi version 2.0.0-preview.xx

[phelm1-landolakes]

Describe the bug

We use .Net8 because it is active LTS.

Upgrading to 1.8.0 breaks all tests that use WireMock.

 System.Reflection.ReflectionTypeLoadException : Unable to load one or more of the requested types.
Could not load type 'Microsoft.OpenApi.Models.OperationType' from assembly 'Microsoft.OpenApi, Version=2.0.0.0, Culture=neutral, PublicKeyToken=3f5743946376f042'.
Could not load type 'Microsoft.OpenApi.Models.OperationType' from assembly 'Microsoft.OpenApi, Version=2.0.0.0, Culture=neutral, PublicKeyToken=3f5743946376f042'.
  ----> System.TypeLoadException : Could not load type 'Microsoft.OpenApi.Models.OperationType' from assembly 'Microsoft.OpenApi, Version=2.0.0.0, Culture=neutral, PublicKeyToken=3f5743946376f042'.
  ----> System.TypeLoadException : Could not load type 'Microsoft.OpenApi.Models.OperationType' from assembly 'Microsoft.OpenApi, Version=2.0.0.0, Culture=neutral, PublicKeyToken=3f5743946376f042'.

[StefH]

@phelm1-landolakes
Can you please provide an example project to show this error?

[phelm1-landolakes]

After further digging, this isn't your issue. It has to do with Microsoft dropping support for Swashbuckle in .Net after version 8.

dotnet/aspnetcore#58103

[tbright92]

So I just noticed the same error today when trying to update our dependencies. Even though we're on .NET 9 and I've removed all references to Swashbuckle (and Swagger) in favor of Microsoft's OpenApi and Scalar, I'm still getting the error above (with the additional error Could not load type 'Microsoft.OpenApi.Any.IOpenApiAny' from assembly 'Microsoft.OpenApi, Version=2.0.0.0, Culture=neutral, PublicKeyToken=3f5743946376f042'..

The only other thing I noticed is that with WireMock 1.8.0, the OpenApi transitive dependency updated from 1.6.24 to 2.0.0-preview.16

[StefH]

@tbright92

That dependency was introduced by #1275, however I didn't know this could break?

Do you still have issues when including 2.0.0-preview.16 in your own project?

[tbright92]

@StefH If I remain on WireMock 1.7.4 but update to 2.0.0-preview.16, I still have issues. Dropping down to 2.0.0-preview.15 seems to get rid of the errors phelm1-landolakes mentioned above, but I'm still seeing the IOpenApiAny error (which may be specific to .NET 9, let me test further), so it does appear to be a Microsoft issue.

[StefH]

I noticed also that the '2.0.0-preview.xx' contains a lot of breaking changes.

A possible way to solve this issue is to remove the dependency on WireMock.Net.OpenApiParser (which introduced .0.0-preview.16) and change this to a more plugin-loading logic.

[StefH]

@phelm1-landolakes
@tbright92

Can you please provide an example project to show this error?
I see that there's now version preview.17, probably this one has the same issue

[tbright92]

I can confirm it does still exist in preview.17

[tbright92]

To amend my previous statement, these seem to be the scenarios I've found:

Remain on WireMock 1.7.4 - all good

Remain on WireMock 1.7.4 and update to any OpenApi preview version - if using Swashbuckle, Could not load type 'Microsoft.OpenApi.Models.OperationType'. If not, Could not load type 'Microsoft.OpenApi.Any.IOpenApiAny

Update to WireMock 1.8.0 or update to WireMock.Net.OpenApiParser 1.8.0 - Could not load type 'Microsoft.OpenApi.Models.OperationType' and Could not load type 'Microsoft.OpenApi.Any.IOpenApiAny'

I also found this issue on the OpenApi.NET repo that speaks to the IOpenApiAny issue on .NET 9 specifically - microsoft/OpenAPI.NET#2069