fix(static): fixed embed fs checking #34

cnlangzi · 2025-01-25T08:53:16Z

Changed

used sha256 to generate etag

Fixed

fixed embed fs checking

Added

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

Fix embed filesystem checking and use MD5 for ETag generation.

Bug Fixes:

Fixed a bug in embed filesystem checking.

Enhancements:

Use MD5 instead of SHA512 for ETag generation.

sourcery-ai · 2025-01-25T08:53:22Z

Reviewer's Guide by Sourcery

This pull request fixes an issue with embed file system checking and updates the etag generation to use md5 instead of sha512.

Sequence diagram for updated file viewer etag generation

sequenceDiagram
    participant FV as FileViewer
    participant FS as FileSystem
    participant Hash as Hash Function

    FV->>FS: Open file
    activate FS
    FS-->>FV: Return file handle
    deactivate FS

    Note over FV,Hash: Changed from sha512 to md5
    FV->>Hash: Create MD5 hash
    activate Hash
    Hash-->>FV: Return hash
    deactivate Hash

    FV->>FV: Format etag with hex encoding

Class diagram showing StaticViewEngine and FileViewer changes

classDiagram
    class StaticViewEngine {
        -bool isEmbedFsys
        +Load(fsys fs.FS, app *App) error
    }

    class FileViewer {
        -string etag
        -bool isEmbed
        +NewFileViewer(fsys fs.FS, path string, isEmbed bool) *FileViewer
    }

    note for StaticViewEngine "Changed embed FS detection"
    note for FileViewer "Changed hash from sha512 to md5"

File-Level Changes

Change	Details	Files
Fix embed file system checking.	The code now uses reflection to check if the file system is an embed file system. The code now checks if the error is nil before checking the type of the file system.	`viewengine_static.go`
Update etag generation to use md5 instead of sha512.	The code now uses md5 to generate the etag. The code now uses hex.EncodeToString to format the etag.	`viewer_file.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

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

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

Overall Comments:

Consider adding a comment explaining why MD5 is used for etag generation (e.g., performance vs cryptographic security tradeoff)

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.}

codecov · 2025-01-25T08:54:08Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.99%. Comparing base (bc1170e) to head (6b9f0c5).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #34      +/-   ##
==========================================
+ Coverage   90.97%   90.99%   +0.02%     
==========================================
  Files          37       37              
  Lines        1330     1333       +3     
==========================================
+ Hits         1210     1213       +3     
  Misses         83       83              
  Partials       37       37

Flag	Coverage Δ
Unit-Tests	`90.99% <100.00%> (+0.02%)`	⬆️

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.

deepsource-io · 2025-01-25T08:54:09Z

Here's the code health analysis summary for commits bc1170e..6b9f0c5. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Go	✅ Success		View Check ↗

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

fix(static): fixed embed fs checking

4df376d

sourcery-ai bot reviewed Jan 25, 2025

View reviewed changes

fix(file): used sha256 to generate etag

6b9f0c5

cnlangzi merged commit 2eed869 into main Jan 25, 2025
7 checks passed

cnlangzi deleted the fix/check_embed_fs branch January 25, 2025 09:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(static): fixed embed fs checking #34

fix(static): fixed embed fs checking #34

Uh oh!

cnlangzi commented Jan 25, 2025 •

edited

Loading

Uh oh!

sourcery-ai bot commented Jan 25, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

codecov bot commented Jan 25, 2025 •

edited

Loading

Uh oh!

deepsource-io bot commented Jan 25, 2025 •

edited

Loading

Analysis Summary

Uh oh!

Uh oh!

Uh oh!

fix(static): fixed embed fs checking #34

fix(static): fixed embed fs checking #34

Uh oh!

Conversation

cnlangzi commented Jan 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changed

Fixed

Added

Tests

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Jan 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

Sequence diagram for updated file viewer etag generation

Class diagram showing StaticViewEngine and FileViewer changes

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Jan 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

deepsource-io bot commented Jan 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Analysis Summary

Uh oh!

Uh oh!

Uh oh!

cnlangzi commented Jan 25, 2025 •

edited

Loading

sourcery-ai bot commented Jan 25, 2025 •

edited

Loading

codecov bot commented Jan 25, 2025 •

edited

Loading

deepsource-io bot commented Jan 25, 2025 •

edited

Loading