search

tidalcycles / Tidal

Pattern language
http://tidalcycles.org/
GNU General Public License v3.0
2.27k stars 255 forks source link

BootTidal.hs breaking change + use of `defaultConfig` #1074

Closed matthewkaney closed 7 months ago

matthewkaney commented 7 months ago

I just ran into a bug we didn't catch with #1059: because it removes the cFrameTimespan from the config object, the default BootTidal.hs throws an error. This is pretty minor, but has a couple implications that are worth discussing:

Is this breaking change okay?

Given that this has been in the default boot file for a long time, this is likely going to break everyone's custom BootTidal file. Personally, I think this is fine (breaking changes happen, and we can increment the version number and document migration steps accordingly), but I understand if anyone's hesitant. The backwards-compatible approach would be to include all (or most) of the new Clock configuration options in the main Config datatype, and let startStream copy values individually.

That said, perhaps this is a good release to rework the boot file generally (see #954), incorporating the changes from #1007. We should also make sure that editors are falling back to the BootFile.hs installed with Tidal (e.g. tidalcycles/vscode-tidalcycles#40).

Why don't we just use defaultConfig in the first place?

I'm also not totally sure why the default boot file updates the default config option anyway, given that the new values ({cVerbose = True, cFrameTimespan = 1/20}) are the same as the defaults. Is this desirable (perhaps so that people have example code to work from), or is it accidental or unnecessary?

@polymorphicengine and @yaxu probably have thoughts, but also interested in what others have to say!

yaxu commented 7 months ago

Yep they were just there to make it easy to tweak.

Actually this sort of problem was solved with #1007 with a magical Sound.Tidal.Boot, but in the now retired 2.0 branch. @ejconlon are you up for redoing this magic to the current dev branch? I'd be happy to do it, but don't want to take credit for the work!

matthewkaney commented 7 months ago

Cool—sounds good. I was toying with it yesterday and was able to port the changes using a cherry-pick, which seems to keep the authorship intact?

I'll do a test with a different repo to double-check that that extends to release notes, etc, but also happy if Eric wants to just submit a new PR!

ejconlon commented 7 months ago

If you can cherry-pick it successfully, please do! Depending on how the API has evolved you may need to adjust it. If you need help let me know.