Skip to content
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

Rename CommandType to Name on resource command types #6350

Merged
merged 2 commits into from
Oct 18, 2024

Conversation

JamesNK
Copy link
Member

@JamesNK JamesNK commented Oct 17, 2024

Description

Feedback from #6295 (comment).

Note that this is a source breaking change for people who have implemented the proto when they update the proto the identifer will change name. It's not a wire breaking change because the field id (1 in this case) is the same.

@joperezr Where should the commandType -> name breaking change be communicated? The model API is new in 9.0 so I believe can change at this point without breaking change notification.

Checklist

  • Is this feature complete?
    • Yes. Ready to ship.
    • No. Follow-up changes expected.
  • Are you including unit tests for the changes and scenario tests if relevant?
    • Yes
    • No
  • Did you add public API?
    • Yes
      • If yes, did you have an API Review for it?
        • Yes
        • No
      • Did you add <remarks /> and <code /> elements on your triple slash comments?
        • Yes
        • No
    • No
  • Does the change make any security assumptions or guarantees?
    • Yes
      • If yes, have you done a threat model and had a security review?
        • Yes
        • No
    • No
  • Does the change require an update in our Aspire docs?
    • Yes
      • Link to aspire-docs issue:
    • No

Copy link
Member

@drewnoakes drewnoakes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine, other than compile error in tests. I think "Id" would be a better term as it indicates the uniqueness requirement more so than "Name".

@DamianEdwards
Copy link
Member

I think we need to do regular breaking change notifications as we changed this after the rc.

@davidfowl davidfowl added the breaking-change Issue or PR that represents a breaking API or functional change over a prerelease. label Oct 17, 2024
@JamesNK
Copy link
Member Author

JamesNK commented Oct 17, 2024

I prefer name because resources have a name, and endpoints have a name. Command names would be consistent.

And I think name makes more sense because the value is being provided by the user. Id feels more appropriate if the value is auto-generated.

@JamesNK JamesNK force-pushed the jamesnk/resource-command-name branch 2 times, most recently from bc1b356 to eaab07e Compare October 17, 2024 08:52
@JamesNK JamesNK force-pushed the jamesnk/resource-command-name branch from eaab07e to e2d266c Compare October 17, 2024 23:08
@JamesNK
Copy link
Member Author

JamesNK commented Oct 18, 2024

/azp run

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@JamesNK JamesNK merged commit cbbc1f3 into main Oct 18, 2024
9 checks passed
@JamesNK JamesNK deleted the jamesnk/resource-command-name branch October 18, 2024 03:27
@davidfowl
Copy link
Member

It turns out we shipped commands in the resource server protocol so this change breaks ACA and we need to either revert all of it, or deprecate the old fields and add the new fields

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-dashboard breaking-change Issue or PR that represents a breaking API or functional change over a prerelease.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants