Future breaking update of Rspotify

[marioortizmanero]

Hello!

I'm a maintainer of Rspotify. I picked up this library in July and have made lots of improvements since, with the help of the original maintainer. The library is now much cleaner, more flexible, and more performant. For now, these are the noticeable improvements for the end user:

• async code has dropped from 206 (!!) compilation units (~1 min 29s on my machine) to 154 (~1min 10s)
• blocking code has dropped from 207 compilation units (~1min 34s) to 103 (~1 min 1s) and now uses ureq
• from 16310 LoC to 7268 (obtained with Tokei)
• more clear documentation, getting started should be more straightforward
• i intend to make an actual benchmark with more details

And we are just at 50% of the changes we intend to make, so it'll be even better. But these kind of improvements require breaking changes. A lot of them, in fact. I wanted to ask the maintainers of this crate (which is one of the most active ones using Rspotify, although you seem to be using an outdated version, check this out) for help in some discussions relating the future of Rspotify:

• Optional parameters ramsayleung/rspotify#134 Optional parameters
• Consider making the cache file a feature  ramsayleung/rspotify#135 Consider making the cache file a feature or not default
• Clean up and re-structure the errors ramsayleung/rspotify#137 Clean up and re-structure the errors
• CHANGELOG.md What we've already changed so far
• Meta-Issue ramsayleung/rspotify#127 What we are working on

Before the new release, we'd like to at least finish these changes, and afterwards we can keep adding new features and prepare for v1.0 in the far future. These include lots of proposals and changes, so don't feel the need to check out each of them. At least a bit of feedback will be useful to us.

Edit: this issue might be mislabeled.

[robinvd]

@marioortizmanero i just tried the current master branch of rspotify, and it seems to work without a lot of change. What is the timeline for releasing the version on crates.io? so that we can update to the newest version.

as for the breaking changes, this project only uses a few basic api requests like the current song. So i think most breaking changes wont effect us or woudnt need too much work on our side.

edit: link to diff robinvd@a863582

[marioortizmanero]

We don't have a set release date but I can tell you there's still a lot of work left, hopefully we can release before 2021 but I can't assure that. We think it's better to release all breaking changes in a single version instead of multiple ones (do you agree?).

It's great that you already tried to update the code. In your diff I can see some functions that won't be needed after we're done, like datetime_to_timestamp (we'll use datetimes instead of timestamps) and is_token_expired (this is now Token::is_expired).

[robinvd]

We think it's better to release all breaking changes in a single version instead of multiple ones (do you agree?)

yes i agree, maybe if breaking changes are unrelated they could be in a different breaking release, but in general fewer is better. Then ill personally wait for the release before making a pr so i dont have to upgrade twice (but if anyone else wants to update to the currently latest crates.io version, feel free).

It's great that you already tried to update the code. In your diff I can see some functions that won't be needed after we're done

that sounds like a great improvement, and i look forward to seeing those changes as well. Could you ping me or this issue if you have a new release?

[marioortizmanero]

that sounds like a great improvement, and i look forward to seeing those changes as well. Could you ping me or this issue if you have a new release?

Sure, I'll leave a comment here when we release the new version. By the way, you might be interested in https://dependabot.com/, it's useful to get notifications for new updates.

[robinvd]

we already use dependabot for PR's like this #699

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[marioortizmanero]

@robinvd Heads up: the new release is finally out! If you need help please let us know at ramsayleung/rspotify#218