Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Maintenance and docs re: integrating upstream changes #67

Closed
wchargin opened this issue Oct 29, 2023 · 0 comments · Fixed by #68
Closed

Maintenance and docs re: integrating upstream changes #67

wchargin opened this issue Oct 29, 2023 · 0 comments · Fixed by #68

Comments

@wchargin
Copy link

wchargin commented Oct 29, 2023

Hi 👋! I am trying to make some simple changes and running into trouble.

I've spent a few hours trying to do a simple patch version upgrade here,
upgrading darkweak/souin from v1.6.40 to v1.6.43 to fix the bug where it
info-logs the entire upstream response bodies on every cache fill(!!).
But between initial setup issues (from breaking changes in transitive
deps), breaking API changes in darkweak/souin patch versions, and sparse
documentation, I've come away tired and empty-handed.

I can see that substantive parts of this repo appear to be copy-pasted
from darkweak/souin upstream. But the files are not always identical,
and sometimes they don't even correspond to the same commit. For
example, at current master 7e61efad6316, file configuration.json
corresponds to upstream commits souin/v1.6.43~15 (103602ce8fe4) and
earlier, whereas file configuration.go corresponds to upstream commits
at souin/v1.6.43~7 (6b17da1cf027) and later. No upstream commit
contains both files at the versions currently vendored in this repo.

Since this repo pins darkweak/[email protected], I even tried to extract the
patches from that repo to apply here:

# generate 4 patch files for changes in just the Caddy plugin directory
git -C ../souin format-patch v1.6.40... ./plugins/caddy

But these patches fail to apply because of divergence from upstream:

# the first patch applies cleanly (after manually updating to go1.21)...
git am -p3 --exclude=go.mod ../souin/0001-feat-chore-allow-chained-storages-359.patch
# ...but the second fails because of skew in configuration.json, go.mod, go.sum
git am -p3 ../souin/0002-feat-rfc-Cache-invalidation-and-Cache-groups-363.patch
# (no use trying the rest)

Is there a plan for the maintenance and documentation of this project?
All I need is simple in-memory caching, and the Caddyfile API of this
project is attractive, but in its current state I'd need to make a
number of cleanup changes to make it viable. I'm willing to put in that
effort, but without a plan I fear that the effort will be wasted as
darkweak/souin continues to diverge.

(much love to caddy-team; i appreciate what y'all have built and am a
happy user overall 💜 )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant