apolloconfig / apollo

Apollo is a reliable configuration management system suitable for microservice configuration management scenarios.
https://www.apolloconfig.com
Apache License 2.0
28.93k stars 10.19k forks source link

Fix npe of audit log get operator #5153

Closed BlackBear2003 closed 3 weeks ago

BlackBear2003 commented 3 weeks ago

What's the purpose of this PR

To fix existing NPE bug in audit logging

when there is no active span exists on request thread context, trying to get operator will cause NPE by continuously get().

image

In some case this bug will appear:

Set audit.log.enabled=false in Portal and audit.log.enabled=true in AdminService.

In this case, no activeSpan would be passed to AdminService, meanwhile AdminService would get operator through active span. And then cause NPE.

Brief changelog

  1. Fix this continuously get()
  2. Reduce inelegant ways of exposing interfaces to the outside
  3. Add unit test for ApolloAuditOperatorDefaultSupplier

Follow this checklist to help us incorporate your contribution quickly and easily:

Summary by CodeRabbit

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes primarily involve modifying access levels and enhancing functionality related to auditing in the Apollo framework. The scopeManager method in ApolloAuditTracer is now protected instead of public. Enhancements in ApolloAuditOperatorDefaultSupplier enable it to fetch the operator from the active audit span. Corresponding tests have been added to validate these behaviors.

Changes

File Path Summary of Changes
.../ApolloAuditTracer.java Changed scopeManager method's access modifier from public to protected.
.../ApolloAuditOperatorDefaultSupplier.java Added import for ApolloAuditSpan and modified getOperator method to fetch operator from the active span or return "anonymous".
.../ApolloAuditOperatorSupplierTest.java Added test methods for scenarios with and without an active span. Included necessary imports for testing.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ApolloAuditOperatorDefaultSupplier
    participant ApolloAuditSpan
    participant ApolloAuditTracer

    Client->>ApolloAuditOperatorDefaultSupplier: getOperator()
    ApolloAuditOperatorDefaultSupplier->>ApolloAuditTracer: scopeManager()
    ApolloAuditTracer-->>ApolloAuditOperatorDefaultSupplier: ApolloAuditScopeManager
    ApolloAuditOperatorDefaultSupplier->>ApolloAuditSpan: getActiveSpan()
    alt Active Span Exists
        ApolloAuditSpan-->>ApolloAuditOperatorDefaultSupplier: operator
    else No Active Span
        ApolloAuditOperatorDefaultSupplier-->>Client: "anonymous"
    end

Poem

In the code where audits bloom,
Changes sweep away the gloom.
Protected methods, spans in flight,
Operators now in clear sight.
Tests ensure the path is true,
Apollo's audit shines anew. 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.