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

Breaking Changes v7 #525

Open
1 of 3 tasks
0xpr03 opened this issue Aug 14, 2023 · 7 comments
Open
1 of 3 tasks

Breaking Changes v7 #525

0xpr03 opened this issue Aug 14, 2023 · 7 comments

Comments

@0xpr03
Copy link
Member

0xpr03 commented Aug 14, 2023

List of things to change in v7

  • PollWatcher: change timeout between intervals to include time spend performing work
  • Config: Replace deprecated poll_interval signature with poll_interval_v2
  • unify all places of panic/error for locking & thread starts
@0xpr03 0xpr03 added this to the notify-7.0 milestone Aug 14, 2023
@zeroishero
Copy link
Contributor

Is there more detailed information about 2 and 3?

@0xpr03
Copy link
Member Author

0xpr03 commented Nov 5, 2023

Not much. We introduced poll_intervall_v2 to stay semver compliant, we should change poll_intervall for v7 and thus remove v2.

And for thread start, join etc we don't handle errors the same way everywhere. Basic idea is to just decide whether to unwrap or error and do that everywhere.

Mainly a list of things to do when hitting v7, so we don't miss our chance for breaking changes.

@zeroishero
Copy link
Contributor

So, i checked the 2nd one. It seems poll_interval is returning Duration while poll_interval_v2 is returning Option. So, the intended change is to just change poll_interval to return Option and change calls of poll_interval_v2 back to poll_interval? That seems easy. Or Am I missing something?

@0xpr03
Copy link
Member Author

0xpr03 commented Nov 5, 2023

Yep that's the plan for when we actually go for v7. Until then I'd leave it as is (in main), or we'll have a harder time making patch/fix releases.

@zeroishero
Copy link
Contributor

So, is there branch for v7? Will work related to this issue be accepted? I would like to do the 2nd one as it's quite easy and I will attempt 1.

@0xpr03
Copy link
Member Author

0xpr03 commented Nov 6, 2023

No we normally don't have that, but you can do a PR for these things anyway.

@zeroishero
Copy link
Contributor

Can you explain what the first checklist is about? I want to try that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants