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

fix: Move from private OC\HintException to public OCP\HintException #514

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

susnux
Copy link
Contributor

@susnux susnux commented Nov 12, 2023

We should not use private API in apps, especially if there is a public alternative.

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
Copy link
Member

@nickvergessen nickvergessen left a comment

Choose a reason for hiding this comment

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

This breaks all the consumers of the API, because OCP does not extend the former exception, so any catch does not work anymore?🤔

@susnux susnux changed the title fix: Move from private OC\HintException to public OCP\HintException fix(docs): Move from private OC\HintException to public OCP\HintException Nov 12, 2023
@susnux
Copy link
Contributor Author

susnux commented Nov 12, 2023

This breaks all the consumers of the API, because OCP does not extend the former exception, so any catch does not work anymore?🤔

No basically we can use OCP because users of the API that still throw the OC exception will still work -> OC extends OCP meaning as we catch OCP we also catch OC.
Thus we still catch all exceptions.

Quick search did not show any API users, but you are right if that API is expected to be used by external apps, then this breaks. Still I think, especially if this is used externally, we should not enforce API users to use private Nextcloud API.
So lets only change the documentation so that users catch OCP\HintException as OC extends from OCP, meaning catching OCP works even when throwing OC. (The OC exception is deprecated since NC23).

@susnux susnux changed the title fix(docs): Move from private OC\HintException to public OCP\HintException fix: Move from private OC\HintException to public OCP\HintException Nov 12, 2023
@nickvergessen
Copy link
Member

Still I think, especially if this is used externally, we should not enforce API users to use private Nextcloud API.
So lets only change the documentation so that users catch OCP\HintException as OC extends from OCP, meaning catching OCP works even when throwing OC. (The OC exception is deprecated since NC23).

This part is exactly the right one.

You don't find any consumers of the API because you look for the wrong one.
Apps emit OCP\Security\Events\ValidatePasswordPolicyEvent which is listened to by this app in https://github.com/nextcloud/password_policy/blob/master/lib/Listener/ValidatePasswordPolicyEventListener.php

https://github.com/search?q=org%3Anextcloud%20ValidatePasswordPolicyEvent&type=code

Used in our org in 4 repos at least:

  • Talk
  • Guests
  • Server:
    • Sharing
    • User backend
  • user_sql

So the correct way would be to document it in the dev docs that OCP should be catched now and then we can switch to it in some releases

@blizzz blizzz added this to the Nextcloud 29 milestone Nov 23, 2023
Copy link

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!

@susnux
Copy link
Contributor Author

susnux commented Mar 14, 2024

As @nickvergessen mentioned we can not replace this directly but need to deprecate first.

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

5 participants