From 166e8a3a1bea138f77c0dd75ef975ef0ad97504e Mon Sep 17 00:00:00 2001 From: Blind-Striker Date: Fri, 11 Oct 2024 18:01:16 +0300 Subject: [PATCH] generate CompatibilitySuppressions file for intentional breaking changes --- src/LocalStack.Client.Extensions/README.md | 2 ++ .../CompatibilitySuppressions.xml | 32 +++++++++++++++++++ .../Exceptions/LocalStackClientException.cs | 6 +++- .../LocalStack.Client.csproj | 1 + src/LocalStack.Client/README.md | 2 ++ 5 files changed, 42 insertions(+), 1 deletion(-) create mode 100644 src/LocalStack.Client/CompatibilitySuppressions.xml diff --git a/src/LocalStack.Client.Extensions/README.md b/src/LocalStack.Client.Extensions/README.md index 53a759e..0db2a60 100644 --- a/src/LocalStack.Client.Extensions/README.md +++ b/src/LocalStack.Client.Extensions/README.md @@ -129,6 +129,8 @@ The `RegionName` is important as LocalStack creates resources based on the speci ## Known Issues +- **SNS with LocalStack v3.7.2 and v3.8.0:** During development on the new version, it was discovered that SNS functional tests are not working in LocalStack versions v3.7.2 and v3.8.0. This issue was reported in LocalStack [issue #11652](https://github.com/localstack/localstack/issues/11652). The LocalStack team identified a bug related to handling SNS URIs and resolved it in [PR #11653](https://github.com/localstack/localstack/pull/11653). The fix will be included in an upcoming release of LocalStack. In the meantime, if you're using SNS, it is recommended to stick to version v3.7.1 of LocalStack until the fix is available. + - **LocalStack Versions v2.0.1 - v2.2:** In versions v2.0.1 through v2.2 of LocalStack, the URL routing logic was changed, causing issues with SQS and S3 operations. Two issues were opened in LocalStack regarding this: [issue #8928](https://github.com/localstack/localstack/issues/8928) and [issue #8924](https://github.com/localstack/localstack/issues/8924). LocalStack addressed this problem with [PR #8962](https://github.com/localstack/localstack/pull/8962). Therefore, when using LocalStack.NET, either use version v2.0 of LocalStack (there are no issues with the v1 series as well) or the upcoming v2.3 version, or use the latest v3 series container from Docker Hub. - **AWS_SERVICE_URL Environment Variable:** Unexpected behaviors might occur in LocalStack.NET when the `AWS_SERVICE_URL` environment variable is set. This environment variable is typically set by LocalStack in the container when using AWS Lambda, and AWS also uses this environment variable in the live environment. Soon, just like in LocalStack's official Python library, this environment variable will be prioritized by LocalStack.NET when configuring the LocalStack host, and there will be a general simplification in the configuration. You can follow this in the issues [issue #27](https://github.com/localstack-dotnet/localstack-dotnet-client/issues/27) and [issue #32](https://github.com/localstack-dotnet/localstack-dotnet-client/issues/32). You set the `AWS_SERVICE_URL` to empty string until this issue is resolved. diff --git a/src/LocalStack.Client/CompatibilitySuppressions.xml b/src/LocalStack.Client/CompatibilitySuppressions.xml new file mode 100644 index 0000000..b901ebb --- /dev/null +++ b/src/LocalStack.Client/CompatibilitySuppressions.xml @@ -0,0 +1,32 @@ + + + + + CP0008 + T:LocalStack.Client.Exceptions.LocalStackClientException + lib/net461/LocalStack.Client.dll + lib/netstandard2.0/LocalStack.Client.dll + true + + + CP0008 + T:LocalStack.Client.Exceptions.MisconfiguredClientException + lib/net461/LocalStack.Client.dll + lib/netstandard2.0/LocalStack.Client.dll + true + + + CP0008 + T:LocalStack.Client.Exceptions.NotSupportedClientException + lib/net461/LocalStack.Client.dll + lib/netstandard2.0/LocalStack.Client.dll + true + + + CP0008 + T:LocalStack.Client.Enums.AwsService + lib/net7.0/LocalStack.Client.dll + lib/net6.0/LocalStack.Client.dll + true + + \ No newline at end of file diff --git a/src/LocalStack.Client/Exceptions/LocalStackClientException.cs b/src/LocalStack.Client/Exceptions/LocalStackClientException.cs index c01aaa0..03aced5 100644 --- a/src/LocalStack.Client/Exceptions/LocalStackClientException.cs +++ b/src/LocalStack.Client/Exceptions/LocalStackClientException.cs @@ -1,7 +1,11 @@ namespace LocalStack.Client.Exceptions; [Serializable] -public abstract class LocalStackClientException : Exception +#if NETFRAMEWORK +public class LocalStackClientException : Exception, System.Runtime.InteropServices._Exception +#else +public class LocalStackClientException : Exception +#endif { /// /// Construct instance of ConfigurationException diff --git a/src/LocalStack.Client/LocalStack.Client.csproj b/src/LocalStack.Client/LocalStack.Client.csproj index aa56aa7..b0224dd 100644 --- a/src/LocalStack.Client/LocalStack.Client.csproj +++ b/src/LocalStack.Client/LocalStack.Client.csproj @@ -15,6 +15,7 @@ README.md true 1.4.1 + true true $(NoWarn);MA0006;CA1510 diff --git a/src/LocalStack.Client/README.md b/src/LocalStack.Client/README.md index 53a759e..0db2a60 100644 --- a/src/LocalStack.Client/README.md +++ b/src/LocalStack.Client/README.md @@ -129,6 +129,8 @@ The `RegionName` is important as LocalStack creates resources based on the speci ## Known Issues +- **SNS with LocalStack v3.7.2 and v3.8.0:** During development on the new version, it was discovered that SNS functional tests are not working in LocalStack versions v3.7.2 and v3.8.0. This issue was reported in LocalStack [issue #11652](https://github.com/localstack/localstack/issues/11652). The LocalStack team identified a bug related to handling SNS URIs and resolved it in [PR #11653](https://github.com/localstack/localstack/pull/11653). The fix will be included in an upcoming release of LocalStack. In the meantime, if you're using SNS, it is recommended to stick to version v3.7.1 of LocalStack until the fix is available. + - **LocalStack Versions v2.0.1 - v2.2:** In versions v2.0.1 through v2.2 of LocalStack, the URL routing logic was changed, causing issues with SQS and S3 operations. Two issues were opened in LocalStack regarding this: [issue #8928](https://github.com/localstack/localstack/issues/8928) and [issue #8924](https://github.com/localstack/localstack/issues/8924). LocalStack addressed this problem with [PR #8962](https://github.com/localstack/localstack/pull/8962). Therefore, when using LocalStack.NET, either use version v2.0 of LocalStack (there are no issues with the v1 series as well) or the upcoming v2.3 version, or use the latest v3 series container from Docker Hub. - **AWS_SERVICE_URL Environment Variable:** Unexpected behaviors might occur in LocalStack.NET when the `AWS_SERVICE_URL` environment variable is set. This environment variable is typically set by LocalStack in the container when using AWS Lambda, and AWS also uses this environment variable in the live environment. Soon, just like in LocalStack's official Python library, this environment variable will be prioritized by LocalStack.NET when configuring the LocalStack host, and there will be a general simplification in the configuration. You can follow this in the issues [issue #27](https://github.com/localstack-dotnet/localstack-dotnet-client/issues/27) and [issue #32](https://github.com/localstack-dotnet/localstack-dotnet-client/issues/32). You set the `AWS_SERVICE_URL` to empty string until this issue is resolved.