Investigate resource_already_exists error when passing --cli-path

[leggetter]

Summary of Reported Issue

A user encountered a 409 RESOURCE_ALREADY_EXISTS error when attempting to restart a Hookdeck CLI listener with the following command:

hookdeck listen 8071 Source --cli-path /monitor

Error:

{
  "code": "RESOURCE_ALREADY_EXISTS",
  "status": 409,
  "message": "Resource already exists",
  "data": {
    "id": "[REDACTED_SOURCE_ID]",
    "resource_type": "source"
  }
}

Context

• The connection was previously established using the CLI.
• When trying to re-establish the same connection after interruption, the CLI returns the 409 error.
• The CLI --cli-path flag was used, which may be affecting the behavior.
• User was advised that --cli-path is optional and that the path can be set on the destination permanently.
• The user resolved the issue by deleting and reconfiguring the setup locally.

Next Steps

Investigate whether the CLI is correctly handling reconnection attempts when the same source is reused and --cli-path is specified.

[alexluong]

After looking into this issue, I think I had a good idea of what happened. The main issue is around Hookdeck source name being unique and case-sensitive. Here's the recreation step.

First, the user creates a source named source, either via the CLI or the dashboard. Using hookdeck listen, you can set up the full source + CLI destination + connection like so

hookdeck listen 8071 source --cli-path /monitor

The CLI can detect that the user wants to listen to source source, and if there's no source, the CLI will send a POST request to create one.

Then, if the user runs this command:

hookdeck listen 8071 Source --cli-path /monitor

Notice the capitalization here, Source instead of source. Because Hookdeck source is case-sensitive, the CLI detects that there's no Source source yet and will try to create one. When creating a new source with the CLI, we run the source name through a sluggify step. This turns Source into source, which already exists, hence the error RESOURCE_ALREADY_EXISTS.

The PR #123 configures this sluggify step to preserve the casing of the original name input to resolve this issue.