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

docs(x/authz): update changelog to include API breaking events change #21522

Merged
merged 1 commit into from
Sep 4, 2024

Conversation

kocubinski
Copy link
Member

@kocubinski kocubinski commented Sep 3, 2024

Description

Noting a "soft" API break around events which was surfaced in audits.

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features

    • Enhanced authorization module for improved message routing and event handling.
    • Introduced appmodule.Environment for better integration with application services.
    • Added limit argument to DequeueAndDeleteExpiredGrants for optimized resource management.
  • Bug Fixes

    • Prevented emission of duplicate events in the Exec function for clearer event handling.
  • Documentation

    • Updated changelog to reflect significant changes and their impact on the Cosmos SDK's authorization process.

Copy link
Contributor

coderabbitai bot commented Sep 3, 2024

Walkthrough

Walkthrough

The Cosmos SDK's authorization module has undergone significant updates, including modifications to the NewKeeper function, enhancements to event handling in the Exec function, and the introduction of the appmodule.Environment. The DequeueAndDeleteExpiredGrants method now accepts a limit argument for better resource management, and the AcceptResponse has been relocated with a change in its field type. These changes aim to streamline authorization processes and improve integration within the SDK.

Changes

File(s) Change Summary
x/authz/keeper.go NewKeeper(router) changed to NewKeeper(). DequeueAndDeleteExpiredGrants(...) updated to accept a limit argument.
x/authz/exec.go Exec(...) modified to prevent duplicate event emissions.
x/authz/types.go AcceptResponse relocated to sdk/types/authz; field type changed from authz.Authorization to sdk.Msg.

Sequence Diagram(s)

sequenceDiagram
    participant App as Application
    participant Keeper as Authorization Keeper
    participant Router as Message Router
    participant Event as Event System

    App->>Keeper: NewKeeper()
    Keeper->>App: Initialize with Environment
    App->>Router: Set message routing
    App->>Keeper: Exec(message)
    Keeper->>Event: Emit event (no duplicates)
    Event->>App: Notify event listeners
Loading

Tip

We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.


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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@kocubinski kocubinski mentioned this pull request Sep 3, 2024
28 tasks
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
x/authz/CHANGELOG.md (1)

47-47: Fix the grammar in the changelog entry.

The static analysis tool suggests using "an" instead of "a" before "authz_msg_index".

Apply this diff to fix the grammar:

-    * `Exec` no longer emits duplicate events containing a "authz_msg_index" attribute.
+    * `Exec` no longer emits duplicate events containing an "authz_msg_index" attribute.
Tools
LanguageTool

[misspelling] ~47-~47: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...onger emits duplicate events containing a "authz_msg_index" attribute. * [#19490]...

(EN_A_VS_AN)

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 54b49d4 and 00e94cc.

Files selected for processing (1)
  • x/authz/CHANGELOG.md (1 hunks)
Additional context used
Path-based instructions (1)
x/authz/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

LanguageTool
x/authz/CHANGELOG.md

[misspelling] ~47-~47: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...onger emits duplicate events containing a "authz_msg_index" attribute. * [#19490]...

(EN_A_VS_AN)

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Sep 3, 2024
@julienrbrt julienrbrt added this pull request to the merge queue Sep 4, 2024
Merged via the queue into main with commit daef054 Sep 4, 2024
70 checks passed
@julienrbrt julienrbrt deleted the kocu/authz-events-changelog branch September 4, 2024 08:47
mergify bot pushed a commit that referenced this pull request Sep 4, 2024
julienrbrt pushed a commit that referenced this pull request Sep 4, 2024
… (backport #21522) (#21538)

Co-authored-by: Matt Kocubinski <mkocubinski@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release C:x/authz
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants