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

Adding null check to IsCulturePublished on IContent #12094

Merged
merged 1 commit into from Mar 5, 2022

Conversation

callumbwhyte
Copy link
Contributor

Currently if you pass null into IsCulturePublished it throws an ArgumentNullException - this is because (rightfully) the publishedInfos dictionary cannot contain null keys. Passing an empty string for the culture instead returns false. It seems to have been this way since V8.

Many of the other methods on IContent that take a culture defend against this, e.g. GetCultureName, so I found it weird that this method didn't. For now I have just added a null check in my package when calling the method.

This PR adds a NullOrWhitespace check on the culture before checking the dictionary to prevent any issues.

@umbrabot
Copy link

umbrabot commented Mar 3, 2022

Hi there @callumbwhyte, 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 5, 2022

Thanks for this PR @callumbwhyte, the check is indeed more robust like this 👍

Just out of curiosity, did you already encounter actual situations where this was null?

Cheers and thanks again!

@mikecp mikecp merged commit 10d2528 into umbraco:v9/contrib Mar 5, 2022
@mikecp
Copy link
Contributor

mikecp commented Mar 5, 2022

FYI: failing tests do not seem to be linked to the changes in this PR.

@callumbwhyte
Copy link
Contributor Author

Thanks @mikecp!

My specific use case was needing to lookup this information inside a ValueEditor, where the culture param is optional and defaults to null.

@mikecp mikecp self-requested a review March 6, 2022 17:15
@mikecp
Copy link
Contributor

mikecp commented Mar 6, 2022

Thanks @callumbwhyte for the details 😉

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.

None yet

3 participants