Skip to content

Conversation

cnlangzi
Copy link
Member

@cnlangzi cnlangzi commented Jan 19, 2025

Changed

Fixed

  • specified viewer should take precedence over first one

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

Bug Fixes:

  • Fixed an issue where the specified viewer was not taking precedence over the first available viewer.

Copy link

sourcery-ai bot commented Jan 19, 2025

Reviewer's Guide by Sourcery

This pull request modifies the view selection logic to prioritize a specified viewer over the first available viewer when handling requests. It also includes new test cases to verify the correct behavior of the view selection logic.

Sequence diagram for viewer selection logic

sequenceDiagram
    participant C as Context
    participant V as Viewers

    Note over C: View method called with name
    C->>C: getViewer(name)
    alt Viewer found by name and mime matches
        C-->>V: Return named viewer
    else No named viewer or mime mismatch
        loop For each Accept header
            C->>V: Check viewers for mime match
            alt Mime match found
                V-->>C: Return matching viewer
            end
        end
        alt No matches found
            alt Named viewer exists
                C-->>V: Use named viewer as fallback
            else No named viewer
                C-->>V: Use first viewer as fallback
            end
        end
    end
Loading

File-Level Changes

Change Details Files
Modified view selection logic to prioritize specified viewer.
  • Modified the View function to prioritize a specified viewer by name.
  • Modified the getViewer function to return a boolean indicating if the viewer was found.
  • Modified the logic to fallback to the first viewer only when no viewer is matched or specified by name.
context.go
Added new test cases to verify the view selection logic.
  • Added a new test case TestMixedViewers to verify the view selection logic.
  • Added test cases to verify that the specified viewer is used when the accept header matches.
  • Added test cases to verify that the first viewer is used when the accept header does not match.
  • Added test cases to verify that wildcard accept headers are matched on the first viewer.
  • Added test cases to verify that the specified viewer is used when no viewer is matched by the accept header.
context_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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

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 documentation comments to explain the viewer precedence rules in the Context.View() and getViewer() methods
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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.

v = c.Routing.Viewers[0] // pickup first viewer as default
if !ok {
if v == nil {
v = c.Routing.Viewers[0] // use the first viewer as a fallback when no viewer is matched or specified by name
Copy link

Choose a reason for hiding this comment

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

issue: This could panic if Routing.Viewers is empty

Add a check for len(c.Routing.Viewers) > 0 before accessing the first element to prevent a potential panic.

Copy link

codecov bot commented Jan 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.17%. Comparing base (cc6c72b) to head (138c255).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #27      +/-   ##
==========================================
+ Coverage   90.15%   90.17%   +0.01%     
==========================================
  Files          34       34              
  Lines        1219     1221       +2     
==========================================
+ Hits         1099     1101       +2     
  Misses         83       83              
  Partials       37       37              
Flag Coverage Δ
Unit-Tests 90.17% <100.00%> (+0.01%) ⬆️

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.

Copy link

deepsource-io bot commented Jan 19, 2025

Here's the code health analysis summary for commits cc6c72b..138c255. 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.

@cnlangzi cnlangzi merged commit b84c4f4 into main Jan 19, 2025
7 checks passed
@cnlangzi cnlangzi deleted the fix/view_with branch January 19, 2025 23:47
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