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

Open
#237 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
kotlin
Domain
testing

Research direction

Start by locating the implementations and tests for cacheSelfie, expectSelfie, and the existing _TODO behavior. Read how //selfieonce and //SELFIEWRITE differ, then resolve whether cascading belongs to CacheTodoCascade or a shared TodoCascade and which scope should be supported. Done means the chosen semantics are documented and covered by tests.

Written by the indexing model from the issue text.

Description

enhancement

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:

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.

Dominant language
Kotlin
Stars
101
Forks
18
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from diffplug/selfie

All issues in diffplug/selfie

Similar issues

More Kotlin issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.