Add Api diff between 8.2.1 -> 9.0 RC1 #6295

joperezr · 2024-10-14T18:23:48Z

This is adding a markdown file that has the API Diff between 8.2.1 and 9.0-rc1 release.

@davidfowl @DamianEdwards @eerhardt @mitchdenny @JamesNK PTAL and make sure everything here is expected. Also, please tag anyone that is relevant for areas as you see appropriate.

Microsoft Reviewers: Open in CodeFlow

eerhardt · 2024-10-14T18:32:55Z

docs/api-diffs/9.0/rc.1/diff.md

+## Aspire.Hosting.Analyzers
+
+``` diff
+ {
+    namespace Aspire.Hosting.Analyzers {
+        [DiagnosticAnalyzerAttribute("C#", new string[]{ })]
+        public class AppHostAnalyzer : DiagnosticAnalyzer {
+            public AppHostAnalyzer();
+            public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; }
+            public override void Initialize(AnalysisContext context);
+        }
+    }
+}


Can we filter this out? This is not real API - it is a tooling (analyzer) assembly.

eerhardt · 2024-10-14T18:34:03Z

docs/api-diffs/9.0/rc.1/diff.md

+            public OpenAISettings();
+            public bool DisableMetrics { get; set; }
+            public bool DisableTracing { get; set; }
+            public Uri Endpoint { get; set; }


This is

public Uri? Endpoint { get; set; }

in the code. Is there a reason this doesn't have ? on it?

Same for Key.

likely a bug in asmdiff.

eerhardt · 2024-10-14T18:37:44Z

docs/api-diffs/9.0/rc.1/diff.md

+            public IServiceProvider Services { get; }
+        }
+         public class ConnectionStringReference : IManifestExpressionProvider, IValueProvider, IValueWithReferences {
+            public string? ConnectionName { get; set; }


@captainsafia - I'm not seeing this property used anywhere. Can it be removed?

It was added in Add AzureFunctionsEndToEnd with prototype implementation (dotnet/aspire#5418)

I added it, I think we should keep it. It properly captures all of the information from the call. It was missing before.

Might be good to have a unit test for it...

Yes, I believe we can remove it. This property predates our proposal to use IAzureFunctionsResourceConfig to inject environment variables into the Functions process. I can open a PR to remove it.

I added it, I think we should keep it. It properly captures all of the information from the call. It was missing before.

Looks like I hit send on my message before seeing yours. What do you mean by “properly capture all of the information from the call”?

eerhardt · 2024-10-14T18:42:52Z

docs/api-diffs/9.0/rc.1/diff.md

+            public static IResourceBuilder<T> WithLifetime<T>(this IResourceBuilder<T> builder, ContainerLifetime lifetime) where T : ContainerResource;
+         }
+         public class DistributedApplicationBuilder : IDistributedApplicationBuilder {
+            public string AppHostPath { get; }


@davidfowl @danegsta - Was this new public property necessary? I see we didn't add it on the interface, was that intentional?

Honestly, looking at the original PR again, this property is probably superfluous, since we ended up generating the project hash in the DistributedApplicationBuilder constructor and exposing it as an in memory configuration property.

Let's remove it.

docs/api-diffs/9.0/rc.1/diff.md

joperezr · 2024-10-14T20:06:28Z

docs/api-diffs/9.0/rc.1/diff.md

+        }
+         public class ResourceNotificationService {
+-            [ObsoleteAttribute("ResourceNotificationService now requires an IHostApplicationLifetime.\r\nUse the constructor that accepts an ILogger<ResourceNotificationService> and IHostApplicationLifetime.\r\nThis constructor will be removed in the next major version of Aspire.")]
+-            public ResourceNotificationService(ILogger<ResourceNotificationService> logger);


I know this was obsoleted already, but we should make sure this is called out in the breaking changes notes anyway. cc: @mitchdenny

joperezr · 2024-10-14T20:08:30Z

docs/api-diffs/9.0/rc.1/diff.md

+-        public interface IDistributedApplicationEvent
+        public interface IDistributedApplicationEvent
+         public interface IDistributedApplicationEventing {
+            Task PublishAsync<T>(T @event, EventDispatchBehavior dispatchBehavior, CancellationToken cancellationToken = default(CancellationToken)) where T : IDistributedApplicationEvent;


This is a breaking change. While this was experimental, we may need to call this out in our release notes.

joperezr · 2024-10-14T20:18:04Z

docs/api-diffs/9.0/rc.1/diff.md

+-            public static void AssignProperty<T>(this Resource<T> resource, Expression<Func<T, object?>> propertySelector, IResourceBuilder<ParameterResource> parameterResourceBuilder, string? parameterName = null);
+-            public static void AssignProperty<T>(this Resource<T> resource, Expression<Func<T, object?>> propertySelector, BicepOutputReference outputReference, string? parameterName = null);


Breaking change

With what API to replace those? I assume with this ones AsProvisioningParameter? Are there examples?

joperezr · 2024-10-14T20:19:09Z

docs/api-diffs/9.0/rc.1/diff.md

+-            public Parameter PrincipalIdParameter { get; }
+            public ProvisioningParameter PrincipalIdParameter { get; }
+-            public Parameter PrincipalNameParameter { get; }
+            public ProvisioningParameter PrincipalNameParameter { get; }
+-            public Parameter PrincipalTypeParameter { get; }
+            public ProvisioningParameter PrincipalTypeParameter { get; }


Breaking changes.

joperezr · 2024-10-14T20:20:46Z

docs/api-diffs/9.0/rc.1/diff.md

+-            public static IResourceBuilder<ICloudFormationStackResource> AddAWSCloudFormationStack(this IDistributedApplicationBuilder builder, string stackName);
+            public static IResourceBuilder<ICloudFormationStackResource> AddAWSCloudFormationStack(this IDistributedApplicationBuilder builder, [ResourceNameAttribute] string name, string? stackName = null);
+-            public static IResourceBuilder<ICloudFormationTemplateResource> AddAWSCloudFormationTemplate(this IDistributedApplicationBuilder builder, string stackName, string templatePath);
+            public static IResourceBuilder<ICloudFormationTemplateResource> AddAWSCloudFormationTemplate(this IDistributedApplicationBuilder builder, [ResourceNameAttribute] string name, string templatePath, string? stackName = null);
+-            public static IResourceBuilder<ICloudFormationStackResource> WithReference(this IResourceBuilder<ICloudFormationStackResource> builder, IAmazonCloudFormation cloudFormationClient);
+-            public static IResourceBuilder<ICloudFormationStackResource> WithReference(this IResourceBuilder<ICloudFormationStackResource> builder, IAWSSDKConfig awsSdkConfig);
+-            public static IResourceBuilder<ICloudFormationTemplateResource> WithReference(this IResourceBuilder<ICloudFormationTemplateResource> builder, IAmazonCloudFormation cloudFormationClient);
+-            public static IResourceBuilder<ICloudFormationTemplateResource> WithReference(this IResourceBuilder<ICloudFormationTemplateResource> builder, IAWSSDKConfig awsSdkConfig);
+            public static IResourceBuilder<TDestination> WithReference<TDestination>(this IResourceBuilder<TDestination> builder, IAmazonCloudFormation cloudFormationClient) where TDestination : ICloudFormationResource;
+-            public static IResourceBuilder<TDestination> WithReference<TDestination>(this IResourceBuilder<TDestination> builder, IResourceBuilder<ICloudFormationResource> cloudFormationResourceBuilder, string configSection = "AWS::Resources") where TDestination : IResourceWithEnvironment;


Breaking changes

AWS was not "stable" before this release.

Yup, I think all the breaking changes I found (or most) were not stable APIs. Just flagging the ones that are breaking in case we decide to include in the release notes for existing customers (not saying we have to given they were experimental)

joperezr · 2024-10-14T20:21:11Z

docs/api-diffs/9.0/rc.1/diff.md

+        }
+     }
+     namespace Aspire.Hosting.AWS {
+-        public class AWSProvisioningException : Exception {


breaking change

With what exception to replace this one?

I see it was moved to a new namespace:

namespace Aspire.Hosting.AWS.Provisioning { + public class AWSProvisioningException : Exception { + public AWSProvisioningException(string message, Exception? innerException = null); + } + }

joperezr · 2024-10-14T20:21:34Z

docs/api-diffs/9.0/rc.1/diff.md

+        public interface ICloudFormationResource : IAWSResource, IResource {
+-            IAWSSDKConfig AWSSDKConfig { get; set; }
+-            TaskCompletionSource ProvisioningTaskCompletionSource { get; set; }
+            string StackName { get; }


Breaking change

what is the replacement for removed API or suggestion?

docs/api-diffs/9.0/rc.1/diff.md

Add Api diff between 8.2.1 -> 9.0 RC1

f929cac

eerhardt reviewed Oct 14, 2024

View reviewed changes

docs/api-diffs/9.0/rc.1/diff.md Show resolved Hide resolved

joperezr commented Oct 14, 2024

View reviewed changes

captainsafia mentioned this pull request Oct 14, 2024

Remove unused ConnectionName property #6302

Merged

JamesNK reviewed Oct 14, 2024

View reviewed changes

JamesNK mentioned this pull request Oct 15, 2024

API cleanup from diff review #6305

Merged

16 tasks

davidfowl reviewed Oct 16, 2024

View reviewed changes

docs/api-diffs/9.0/rc.1/diff.md Show resolved Hide resolved

JamesNK mentioned this pull request Oct 17, 2024

Rename CommandType to Name on resource command types #6350

Merged

16 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Api diff between 8.2.1 -> 9.0 RC1 #6295

Add Api diff between 8.2.1 -> 9.0 RC1 #6295

joperezr commented Oct 14, 2024 •

edited by dotnet-policy-service bot

Loading

eerhardt Oct 14, 2024

eerhardt Oct 14, 2024 •

edited

Loading

joperezr Oct 14, 2024

eerhardt Oct 14, 2024 •

edited

Loading

davidfowl Oct 14, 2024

eerhardt Oct 14, 2024

captainsafia Oct 14, 2024

captainsafia Oct 15, 2024

eerhardt Oct 14, 2024

danegsta Oct 14, 2024

davidfowl Oct 15, 2024

joperezr Oct 14, 2024

joperezr Oct 14, 2024

joperezr Oct 14, 2024

abpiskunov Oct 23, 2024 •

edited

Loading

joperezr Oct 14, 2024

joperezr Oct 14, 2024

eerhardt Oct 14, 2024

joperezr Oct 14, 2024

joperezr Oct 14, 2024

abpiskunov Oct 23, 2024

abpiskunov Oct 23, 2024 •

edited

Loading

joperezr Oct 14, 2024

abpiskunov Oct 23, 2024

		- public static void AssignProperty<T>(this Resource<T> resource, Expression<Func<T, object?>> propertySelector, IResourceBuilder<ParameterResource> parameterResourceBuilder, string? parameterName = null);
		- public static void AssignProperty<T>(this Resource<T> resource, Expression<Func<T, object?>> propertySelector, BicepOutputReference outputReference, string? parameterName = null);

Add Api diff between 8.2.1 -> 9.0 RC1 #6295

Are you sure you want to change the base?

Add Api diff between 8.2.1 -> 9.0 RC1 #6295

Conversation

joperezr commented Oct 14, 2024 • edited by dotnet-policy-service bot Loading

Microsoft Reviewers: Open in CodeFlow

Choose a reason for hiding this comment

eerhardt Oct 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eerhardt Oct 14, 2024 • edited Loading

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

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

abpiskunov Oct 23, 2024 • edited Loading

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

Choose a reason for hiding this comment

abpiskunov Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joperezr commented Oct 14, 2024 •

edited by dotnet-policy-service bot

Loading

eerhardt Oct 14, 2024 •

edited

Loading

eerhardt Oct 14, 2024 •

edited

Loading

abpiskunov Oct 23, 2024 •

edited

Loading

abpiskunov Oct 23, 2024 •

edited

Loading