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

Revert "R - move findFileName from FuncForPC to CallerFrames" #53

Closed
wants to merge 1 commit into from

Conversation

aleclerc-cio
Copy link
Contributor

@aleclerc-cio aleclerc-cio commented Nov 21, 2024

Reverts #41

Summary by Sourcery

Chores:

  • Revert changes from a previous commit that moved the findFileName function from FuncForPC to CallerFrames.

Copy link

sourcery-ai bot commented Nov 21, 2024

Reviewer's Guide by Sourcery

This PR reverts changes made to the file name finding mechanism in the approval testing framework. The implementation switches back from using CallersFrames to using FuncForPC for stack trace analysis, reverting to a more direct approach for finding the test method's file name.

Class diagram for reverted findFileName function

classDiagram
    class ApprovalName {
        +NewApprovalName(name string, fileName string) ApprovalName
    }
    class findFileName {
        +findFileName() *string, error
    }
    class runtime {
        +Callers(skip int, pc []uintptr) int
        +FuncForPC(pc uintptr) *Func
    }
    class Func {
        +Name() string
        +FileLine(pc uintptr) (string, int)
    }
    ApprovalName --> findFileName
    findFileName --> runtime
    runtime --> Func

    note for findFileName "Reverted to using FuncForPC instead of CallersFrames"
Loading

File-Level Changes

Change Details Files
Reverted the stack trace analysis implementation from using CallersFrames back to FuncForPC
  • Removed CallersFrames usage and frame iteration logic
  • Reintroduced direct stack frame indexing with FuncForPC
  • Changed the test runner detection to work with Func instead of Frame objects
  • Modified the file name retrieval to use FileLine method directly from the test method
  • Updated error checking condition for test runner detection
approval_name.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.

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

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