-
Notifications
You must be signed in to change notification settings - Fork 11
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
implement conditional requests #352
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| package cachecontrol | ||
|
|
||
| import ( | ||
| "time" | ||
|
|
||
| "github.com/Southclaws/opt" | ||
|
|
||
| "github.com/Southclaws/storyden/app/transports/http/openapi" | ||
| ) | ||
|
|
||
| // Query represents a HTTP conditional request query. | ||
| type Query struct { | ||
| ETag opt.Optional[string] | ||
| ModifiedSince opt.Optional[time.Time] | ||
| } | ||
|
|
||
| // NewQuery must be constructed from a HTTP request's conditional headers. | ||
| func NewQuery( | ||
| IfNoneMatch *string, | ||
| IfModifiedSince *string, | ||
| ) opt.Optional[Query] { | ||
| if IfNoneMatch == nil && IfModifiedSince == nil { | ||
| return opt.NewEmpty[Query]() | ||
| } | ||
|
|
||
| modifiedSince, err := opt.MapErr(opt.NewPtr(IfModifiedSince), parseConditionalRequestTime) | ||
| if err != nil { | ||
| return opt.NewEmpty[Query]() | ||
| } | ||
|
|
||
| return opt.New(Query{ | ||
| ETag: opt.NewPtr((*string)(IfNoneMatch)), | ||
| ModifiedSince: modifiedSince, | ||
| }) | ||
| } | ||
|
|
||
| // NotModified takes the current updated date of a resource and returns true if | ||
| // the cache control query includes a Is-Modified-Since header and the resource | ||
| // updated date is not after the header value. True means a 304 response header. | ||
| func (q Query) NotModified(resourceUpdated time.Time) bool { | ||
| // truncate the resourceUpdated to the nearest second because the actual | ||
| // HTTP header is already truncated but the database time is in nanoseconds. | ||
| // If we didn't do this, the resource updated will always be slightly ahead. | ||
| truncated := resourceUpdated.Truncate(time.Second) | ||
|
|
||
| if ms, ok := q.ModifiedSince.Get(); ok { | ||
|
|
||
| // If the resource update time is ahead of the HTTP Last-Modified check, | ||
| // modified = 1, meaning the resource has been modified since the last | ||
| // request and should be returned from the DB, instead of a 304 status. | ||
| modified := truncated.Compare(ms) | ||
|
|
||
| return modified <= 0 | ||
| } | ||
|
|
||
| return false | ||
| } | ||
|
|
||
| func parseConditionalRequestTime(in openapi.IfModifiedSince) (time.Time, error) { | ||
| return time.Parse(time.RFC1123, in) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| package thread_cache | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/Southclaws/fault" | ||
| "github.com/Southclaws/fault/fctx" | ||
| "github.com/Southclaws/opt" | ||
| "github.com/rs/xid" | ||
|
|
||
| "github.com/Southclaws/storyden/app/resources/cachecontrol" | ||
| "github.com/Southclaws/storyden/internal/ent" | ||
| "github.com/Southclaws/storyden/internal/ent/post" | ||
| ) | ||
|
|
||
| type Cache struct { | ||
| db *ent.Client | ||
| } | ||
|
|
||
| func New(db *ent.Client) *Cache { | ||
| return &Cache{ | ||
| db: db, | ||
| } | ||
| } | ||
|
|
||
| func (c *Cache) IsNotModified(ctx context.Context, cq opt.Optional[cachecontrol.Query], id xid.ID) (bool, error) { | ||
| query, ok := cq.Get() | ||
| if !ok { | ||
| return false, nil | ||
| } | ||
|
|
||
| r, err := c.db.Post.Query().Select(post.FieldUpdatedAt).Where(post.ID(id)).Only(ctx) | ||
| if err != nil { | ||
| return false, fault.Wrap(err, fctx.With(ctx)) | ||
| } | ||
|
|
||
| notModified := query.NotModified(r.UpdatedAt) | ||
|
|
||
| return notModified, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Consider implementing ETag comparison
The
NotModifiedmethod currently only checksIf-Modified-Since. Consider implementing ETag comparison for better caching support.func (q Query) NotModified(resourceUpdated time.Time) bool { // truncate the resourceUpdated to the nearest second because the actual // HTTP header is already truncated but the database time is in nanoseconds. // If we didn't do this, the resource updated will always be slightly ahead. truncated := resourceUpdated.Truncate(time.Second) + // Check ETag first if available + if etag, ok := q.ETag.Get(); ok { + // TODO: Implement ETag comparison logic + // This would require the resource to provide its current ETag + // return resourceEtag == etag + } + if ms, ok := q.ModifiedSince.Get(); ok { // If the resource update time is ahead of the HTTP Last-Modified check, // modified = 1, meaning the resource has been modified since the last // request and should be returned from the DB, instead of a 304 status. modified := truncated.Compare(ms) return modified <= 0 } return false }