Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

cnlangzi
Copy link
Member

@cnlangzi cnlangzi commented Feb 20, 2025

Changed

Fixed

Added

  • fix(htmx): added htmx.js libraries to help htmx development.

Tests

Tasks to complete before merging PR:

  • Ensure unit tests are passing. If not run make unit-test to check for any regressions πŸ“‹
  • Ensure lint tests are passing. if not run make lint to check for any issues
  • Ensure codecov/patch is passing for changes.

Summary by Sourcery

This pull request adds the htmx.js library and enhances caching for HTMX and CSRF JavaScript files by implementing ETag support. It also includes a new $x.ready() function that executes callbacks when the DOM is loaded or when an htmx:load event occurs.

New Features:

  • Adds the htmx.js library to provide client-side support for HTMX development, including a $x.ready() function that executes callbacks when the DOM is loaded or when an htmx:load event occurs.

Enhancements:

  • Improves HTTP caching by adding ETag support to the HTMX and CSRF handlers, preventing unnecessary data transfer when the client already has the latest version of the JavaScript files.
  • Refactors the CSRF handler to use a common function for loading JavaScript and computing ETags.

Tests:

  • Adds tests for the HTMX handler to verify that it serves the htmx.js library correctly and returns a 304 status code when the ETag matches.

@sourcery-ai
Copy link

sourcery-ai bot commented Feb 20, 2025

Reviewer's Guide by Sourcery

This pull request introduces the htmx extension, which serves the htmx.js library and provides a global $x object for managing custom events and callbacks. It also enhances ETag generation and handling for static files and the CSRF extension to improve caching.

Sequence diagram for serving htmx.js with ETag caching

sequenceDiagram
    participant Browser
    participant Server

    Browser->>Server: GET htmx.js
    Server->>Server: Compute ETag for htmx.js
    Server->>Server: Check If-None-Match header
    alt If-None-Match matches ETag
        Server-->>Browser: 304 Not Modified
    else If-None-Match does not match ETag
        Server-->>Browser: 200 OK with htmx.js and ETag
    end
Loading

Class diagram for FileViewer changes

classDiagram
    class FileViewer {
        -fsys fs.FS
        -path string
        -isEmbed bool
        -etag string
        +NewFileViewer(fsys fs.FS, path string, isEmbed bool) *FileViewer
        +Render(ctx *Context, data any) error
        -serveContent(w http.ResponseWriter, r *http.Request) error
    }

    note for FileViewer "ETag is now computed using ComputeETag function"
Loading

File-Level Changes

Change Details Files
Introduces the htmx extension, serving the htmx.js library and providing a global $x object for managing custom events and callbacks.
  • Added htmx.go to implement the extension.
  • Added htmx.js as an embedded file containing the javascript library.
  • Implemented a handler function to serve the htmx.js library with ETag caching.
  • Added a global $x object to manage custom events and callbacks for htmx.
  • Added tests for the handler function, including ETag validation.
ext/htmx/htmx_test.go
ext/htmx/htmx.go
ext/htmx/htmx.js
Improves ETag generation and handling for static files and the CSRF extension to prevent unnecessary re-downloads by the client.
  • Added etag.go to implement generic ETag computation and handling.
  • Refactored FileViewer to use the new ETag functionality.
  • Refactored the CSRF extension to use the new ETag functionality.
  • Added tests for ETag handling.
ext/csrf/csrf.go
viewer_file.go
ext/csrf/csrf_test.go
etag.go
etag_test.go

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@deepsource-io
Copy link

deepsource-io bot commented Feb 20, 2025

Here's the code health analysis summary for commits d37d00c..6338be1. View details on DeepSourceΒ β†—.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Go LogoGoβœ…Β SuccessView CheckΒ β†—

πŸ’‘ If you’re a repository administrator, you can configure the quality gates from the settings.

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @cnlangzi - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a comment to the HandleFunc in htmx.go explaining what the javascript code does.
  • It looks like you've extracted the etag logic into etag.go - consider renaming this to etag_utils.go or similar to indicate that it's a utility file.
Here's what I looked at during the review
  • 🟑 General issues: 1 issue found
  • 🟒 Security: all looks good
  • 🟒 Testing: all looks good
  • 🟑 Complexity: 2 issues found
  • 🟒 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click πŸ‘ or πŸ‘Ž on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Feb 20, 2025

Codecov Report

All modified and coverable lines are covered by tests βœ…

Project coverage is 94.35%. Comparing base (d37d00c) to head (6338be1).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #52      +/-   ##
==========================================
+ Coverage   94.13%   94.35%   +0.21%     
==========================================
  Files          54       55       +1     
  Lines        2200     2284      +84     
==========================================
+ Hits         2071     2155      +84     
  Misses         96       96              
  Partials       33       33              
Flag Coverage Ξ”
Unit-Tests 94.35% <100.00%> (+0.21%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

β˜” View full report in Codecov by Sentry.
πŸ“’ Have feedback on the report? Share it here.

@cnlangzi
Copy link
Member Author

@sourcery-ai review

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @cnlangzi - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider extracting the common ETag logic into a shared utility function to reduce code duplication.
  • The loadJavaScript function is duplicated in both the htmx and csrf extensions; can this be moved to a common utility?
Here's what I looked at during the review
  • 🟒 General issues: all looks good
  • 🟒 Security: all looks good
  • 🟒 Testing: all looks good
  • 🟒 Complexity: all looks good
  • 🟒 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click πŸ‘ or πŸ‘Ž on each comment and I'll use the feedback to improve your reviews.

@cnlangzi cnlangzi merged commit e1bbb9a into main Feb 20, 2025
8 checks passed
@cnlangzi cnlangzi deleted the fix/htmx_js branch February 20, 2025 11:28
@cnlangzi cnlangzi changed the title fix(htmx): added htmx.js fix(htmx): added ext/htmx.js library Feb 20, 2025
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 this pull request may close these issues.

1 participant