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

Define RefreshMethodType enum values #15938

Merged
merged 1 commit into from
Apr 2, 2024
Merged

Conversation

nzdev
Copy link
Contributor

@nzdev nzdev commented Mar 25, 2024

Prerequisites

  • I have added steps to test this contribution in the description below

If there's an existing issue for this PR then this fixes

Description

Define RefreshMethodType enum values to be the existing values. Prevent errors in future if these are reordered as the number is being serialized.

Copy link

github-actions bot commented Mar 25, 2024

Hi there @nzdev, thank you for this contribution! 👍

While we wait for one of the Core Collaborators team to have a look at your work, we wanted to let you know about that we have a checklist for some of the things we will consider during review:

  • It's clear what problem this is solving, there's a connected issue or a description of what the changes do and how to test them
  • The automated tests all pass (see "Checks" tab on this PR)
  • The level of security for this contribution is the same or improved
  • The level of performance for this contribution is the same or improved
  • Avoids creating breaking changes; note that behavioral changes might also be perceived as breaking
  • If this is a new feature, Umbraco HQ provided guidance on the implementation beforehand
  • 💡 The contribution looks original and the contributor is presumably allowed to share it

Don't worry if you got something wrong. We like to think of a pull request as the start of a conversation, we're happy to provide guidance on improving your contribution.

If you realize that you might want to make some changes then you can do that by adding new commits to the branch you created for this work and pushing new commits. They should then automatically show up as updates to this pull request.

Thanks, from your friendly Umbraco GitHub bot 🤖 🙂

@mikecp
Copy link
Contributor

mikecp commented Mar 25, 2024

Hello @nzdev ,

Thanks a lot for your PR and for making the RefreshMethodType enum more robust 👍
A member of the core collabs team will have a check at it soon.

A quick note for the future core-collab checking this one; I was actually about to merge it but then had the following question that I wanted to test: if we do a ToString() on one of the enum values (e.g. RefreshByGuid) in the old and new version, will be get the same output, or do we get the name (e.g. "RefreshByGuid") in the old version and the stringified value (e.g. "1") in the new version?
I'm not sure anymore and we need to make sure it won't break such scenario's 😅

Or maybe you already checked this @nzdev? 😁

Cheers!

@nzdev
Copy link
Contributor Author

nzdev commented Mar 25, 2024

Hi @mikecp . The behaviour will be the same as it's not changing ToString().

@JasonElkin
Copy link
Contributor

Thanks @nzdev.

I'd hope that a breaking change like an enum re-order would get flagged at PR, but better safe than sorry!

@JasonElkin JasonElkin merged commit 682b765 into umbraco:contrib Apr 2, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants