Commit b0b9394
authored
Fix trampoline notebook filename collision (#5508)
## Why
Found during a full-repo review of the CLI. The python wheel wrapper
(trampoline) names its generated notebook
`notebook_<job_key>_<task_key>`. Both keys can contain underscores, so
distinct pairs can produce the same name: job `a_b` with task `c` and
job `a` with task `b_c` both map to `notebook_a_b_c`. The second wrapper
overwrites the first, and both tasks point at the same notebook, so one
task silently runs the other task's wrapper.
## Changes
Before, two different (job key, task key) pairs could collide on one
wrapper filename; now every pair gets a unique name. The name is now
`notebook_<job_key_length>_<job_key>_<task_key>` (in
`bundle/trampoline/trampoline.go`). The length prefix makes the encoding
unambiguous for any keys, with no new dependencies. The example above
becomes `notebook_3_a_b_c` vs `notebook_1_a_b_c`.
Existing wrapper notebooks get a new path on the next deploy. This only
affects bundles with `experimental.python_wheel_wrapper: true`, and the
wrapper is regenerated and the job spec updated on every deploy, so no
action is needed.
## Test plan
- [x] New unit test `TestGenerateTrampolineWithCollidingKeys` covering
the colliding pair, asserting two distinct wrapper files and notebook
paths (fails without the fix)
- [x] Updated existing expectations in `bundle/trampoline` tests for the
new naming
- [x] `go test ./bundle/trampoline/ -count=1` passes
- [x] `./task fmt-q`, `./task lint-q`, and `./task checks` pass
This pull request and its description were written by Isaac.1 parent bf1d217 commit b0b9394
3 files changed
Lines changed: 73 additions & 9 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
108 | 108 | | |
109 | 109 | | |
110 | 110 | | |
111 | | - | |
| 111 | + | |
112 | 112 | | |
113 | 113 | | |
114 | 114 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
59 | 59 | | |
60 | 60 | | |
61 | 61 | | |
62 | | - | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
63 | 65 | | |
64 | 66 | | |
65 | 67 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
17 | 17 | | |
18 | 18 | | |
19 | 19 | | |
20 | | - | |
21 | | - | |
22 | | - | |
23 | | - | |
24 | | - | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
25 | 27 | | |
26 | 28 | | |
27 | 29 | | |
| |||
85 | 87 | | |
86 | 88 | | |
87 | 89 | | |
88 | | - | |
| 90 | + | |
89 | 91 | | |
90 | 92 | | |
91 | 93 | | |
92 | 94 | | |
93 | 95 | | |
94 | 96 | | |
95 | 97 | | |
96 | | - | |
| 98 | + | |
97 | 99 | | |
98 | 100 | | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
0 commit comments