diffplug / diffplug/selfie

`cacheSelfie().xxx_TODO()` should cascade through later `cacheSelfie` calls

Open
#237 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Kotlin
Stars
101
Forks
18
PR merge metrics
No merged PRs in 30d

Description

A classic problem in Jupyter / IPython workflows is:

- you run the whole notebook
- you make some changes and run just the first cell
- you look at the last cell which has cached results from the initial run, but has not updated since the changes in the first cell, and you are confused

If you use `//selfieonce` or `//SELFIEWRITE`, these sorts of problems don't happen. But with `_TODO` they can. We should probably have something like this in our settings:

```kotlin
enum CacheTodoCascade {
NONE, // This is our current behavior
WITHIN_TEST, // Once a _TODO is encountered in a test,
// it will rewrite everything after that in the test.
// This should probably be the default.
WITHIN_TEST_CLASS, // Rewrite everything in all the rest of the tests in that class
// This introduces coupling between tests, which is ill-defined if they are
// being executed in parallel. Might be not be a good idea...
}
```

This is quite hazardous with `cacheSelfie`. With `expectSelfie` it's not hazardous but can be annoying. I'm inclined for this functionality to be limited only to `CacheTodoCascade`, but it's worth considering just `TodoCascade` and use it for both `expectSelfie` and `cacheSelfie` calls.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.