unexpected api endpoint availability

[teodorescuserban]

I am using souin as caddy module.

I only cache some of the requests. I was very surprised to notice (after a couple of hours of unsuccessful tries) that in certain configurations the souin api endpoint is not available. More precise, if a request to /souin-api/souin is not configured to be cached, the api won't respond.

Like in this Caddyfile example:

{
    cache
}

:80 {

    @somecache path /i-cache-this
    @nocache not path /i-cache-this

    route @somecache {
        cache
        respond "caching."
    }

    route @nocache {
        respond "not caching. and no souin api."    
    }
}

Now, I don't have a sane suggestion. My first instinct would tell me that it would be nice to have the souin-api endpoint liked to the caddy admin port instead. But there are a number of problems with that.

Perhaps the best solution would br to just document that (with a nice example of how to also secure the souin api endpoint from external).

Keep up the good work, @darkweak !

[darkweak]

Hey @teodorescuserban I plan to bring this feature in the PR #589.

[darkweak]

@teodorescuserban you can already try it using:

xcaddy build --with github.com/darkweak/souin@e5c1440eb3a0c1c6832488a6605e842c09ecc04a --with github.com/darkweak/souin/plugins/caddy@e5c1440eb3a0c1c6832488a6605e842c09ecc04a

and send the following request (assuming you're running it on localhost and enabled souin api in the config):

curl http://localhost:2019/souin-api/souin

[teodorescuserban]

@darkweak maybe wrong sha?

65.45 go: upgraded google.golang.org/protobuf v1.34.1 => v1.34.2
65.45 2025/01/22 14:34:36 [INFO] exec (timeout=0s): /usr/local/go/bin/go get -v github.com/darkweak/souin@e5c1440eb3a0c1c6832488a6605e842c09ecc04a github.com/caddyserver/caddy/v2@v2.8.4
79.74 go: github.com/darkweak/souin@e5c1440eb3a0c1c6832488a6605e842c09ecc04a: invalid version: unknown revision e5c1440eb3a0c1c6832488a6605e842c09ecc04a
79.74 2025/01/22 14:34:51 [FATAL] exit status 1
------
Dockerfile:13
--------------------
  12 |
  13 | >>> RUN CGO_ENABLED=0 GOARCH=${TARGETARCH} GOOS=${TARGETOS} \
  14 | >>>     xcaddy build \
...
  21 | >>>     --with github.com/darkweak/storages/go-redis/caddy \
  22 | >>>     --with github.com/darkweak/souin@e5c1440eb3a0c1c6832488a6605e842c09ecc04a \
  23 | >>>     --with github.com/darkweak/souin/plugins/caddy@e5c1440eb3a0c1c6832488a6605e842c09ecc04a
  24 |

[darkweak]

@teodorescuserban this one fad3f2f3162e1f9f588fa7a4bb70cdaa41403374 should work. The previous one had a panic error.

[teodorescuserban]

I tested it and it works! However, setting basepath or souin basepath seems to break it; I mean it doesn't work with the baseline settings or any permutation (/souin-api/souin, /souin-api/keys,/cache/souin,/cache/keys)

My cache config looks like this:

cache {
        ...
        api {
                basepath /cache
                debug
                prometheus
                souin {
                       basepath /keys
                }
        }
}

It will only work with this config:

cache {
        ...
        api {
                # basepath /cache
                debug
                prometheus
                souin # {
                #       basepath /keys
                # }
        }
}

It does look promising though, @darkweak !

[teodorescuserban]

Any news on this, @darkweak ? Were you able to fix the basepath not working? Should we expect this change in the next release?

Thank you for your great work! 🙏

[darkweak]

Hey @teodorescuserban I'll release the new version tomorrow. Sorry for the long delay, I had other (personal/professional) stuff that took all my time.

[teodorescuserban]

Hey @teodorescuserban I'll release the new version tomorrow. Sorry for the long delay, I had other (personal/professional) stuff that took all my time.

Hey @darkweak, all good, thank you for your work!