Skip to content

Commit a1ec850

Browse files
leggetterclaude
andcommitted
docs(known-issues): record --rule-transform-name attaching empty transformations
Symptom, cause, affected versions (v3.1.0 and earlier), the fix version, a --rules workaround, and how to find and delete the empty transformations it left behind. Also stops the lookup's comment claiming the API's name filter returns near matches, which hasn't been verified. The exact compare and pagination hold either way. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 041903c commit a1ec850

2 files changed

Lines changed: 31 additions & 3 deletions

File tree

‎KNOWN_ISSUES.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,32 @@
11
# Known Issues
22

3+
## `--rule-transform-name` with an ID or a mistyped name attaches an empty transformation
4+
5+
**Symptom:** `hookdeck gateway connection create`, `update` or `upsert` with `--rule-transform-name`
6+
set to a transformation ID, or to a name that doesn't exist, succeeds, but every event on the
7+
connection then fails its transformation with a `TypeError`.
8+
9+
**Why:** The CLI always sent the value as a transformation name. When no transformation has that
10+
name, the API creates one, even with no code, so the connection got a new, empty transformation
11+
instead of the one you meant.
12+
13+
**Affected:** v3.1.0 and earlier.
14+
15+
**Recommended fix:** Update to **v3.2.0 or later**. The value is then resolved as an ID or an exact
16+
name, and an unknown value without `--rule-transform-code` is an error.
17+
18+
- npm: `npm install -g hookdeck-cli@latest`
19+
- Homebrew: `brew upgrade hookdeck`
20+
21+
**Workaround (until you update):** Pass the rule as JSON with `--rules` or `--rules-file`,
22+
referencing the transformation by `transformation_id`.
23+
24+
**Cleanup:** If you hit this, you have empty transformations named after an ID (`trs_...`) or a
25+
typo. Find them with `hookdeck gateway transformation list`. Point any connection that uses one at
26+
the right transformation, then delete it with `hookdeck gateway transformation delete <id>`.
27+
28+
**Tracking:** #468
29+
330
## Connection rules built from `--rule-*` flags run in a fixed order, not the order you wrote them
431

532
**Symptom:** A connection created, updated or upserted with `--rule-*` flags runs its rules in a

‎pkg/cmd/connection_transform_rule.go‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@ import (
99
"github.com/hookdeck/hookdeck-cli/pkg/hookdeck"
1010
)
1111

12-
// The name filter on GET /transformations can return near matches, so the
13-
// exact name is not necessarily on the first page. The lookup asks for the
14-
// largest page the API allows and follows pagination.next, up to a bound.
12+
// The lookup doesn't rely on the name filter on GET /transformations being an
13+
// exact match. It compares names exactly and, in case the filter matches more
14+
// than one page, asks for the largest page the API allows and follows
15+
// pagination.next, up to a bound.
1516
const (
1617
transformationLookupPageLimit = 255
1718
transformationLookupMaxPages = 20

0 commit comments

Comments
 (0)