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

Fix to provision/deprovision to repos #51

Merged
merged 1 commit into from
Jan 13, 2025
Merged

Fix to provision/deprovision to repos #51

merged 1 commit into from
Jan 13, 2025

Conversation

harikac1
Copy link
Contributor

@harikac1 harikac1 commented Jan 13, 2025

Pull Request

To help us get this pull request reviewed and merged quickly, please be sure to include the following items:

  • Tests (if applicable)
  • Documentation (if applicable)
  • Changelog entry
  • A full explanation here in the PR description of the work done

PR Type

What kind of change does this PR introduce?

  • [-] Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Tests
  • Other

Bugfix - Updated Grant and Revoke functions for repo.go to use username instead of display name

Backward Compatibility

Is this change backward compatible with the most recently released version? Does it introduce changes which might change the user experience in any way? Does it alter the Connector in any way?

  • Yes (backward compatible)
  • No (breaking changes)

Useful links:

  • [https://github.com/ConductorOne/baton-sdk/wiki/Coding-Guidelines](Baton SDK coding guidelines)
  • [https://github.com/ConductorOne/baton/blob/main/CONTRIBUTING.md](New contributor guide)

Issue Linking

What's new?

Summary by CodeRabbit

  • Bug Fixes
    • Updated permission management to use more precise user and group identifiers
    • Improved consistency in handling repository permissions

Copy link

coderabbitai bot commented Jan 13, 2025

Walkthrough

The changes in pkg/connector/repo.go focus on modifying how user and group identifiers are retrieved for permission management. The Grant and Revoke methods of the repoBuilder struct now use principal.Id.Resource instead of principal.DisplayName when handling repository permissions. This adjustment ensures a more consistent approach to identifying users and groups during permission operations.

Changes

File Change Summary
pkg/connector/repo.go - Updated Grant method to use principal.Id.Resource for user and group identifiers
- Modified Revoke method to use principal.Id.Resource when revoking permissions

Poem

🐰 Permissions dance, a code ballet fine,
Where Id.Resource now takes the line!
No more DisplayName to confuse the way,
Identifiers clear as a bright spring day
Rabbit's refactor, precise and neat! 🔑

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

CodeRabbit Configuration 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 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 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.

Copy link

@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

🧹 Nitpick comments (1)
pkg/connector/repo.go (1)

Line range hint 332-335: Update logging statements for consistency.

The logging statements still use DisplayName while the code has been updated to use Id.Resource. For consistency and easier troubleshooting, the logs should use the same identifier.

 		l.Info("User Membership has been revoked.",
-			zap.String("UserName", principal.DisplayName),
+			zap.String("UserName", principal.Id.Resource),
 			zap.String("ProjectKey", projectKey),
 			zap.String("RepositorySlug", repoSlug),
 		)

 		l.Info("Group Membership has been revoked.",
-			zap.String("GroupName", principal.DisplayName),
+			zap.String("GroupName", principal.Id.Resource),
 			zap.String("ProjectKey", projectKey),
 			zap.String("RepositorySlug", repoSlug),
 		)

Also applies to: 360-363

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1ce0511 and 140ddde.

📒 Files selected for processing (1)
  • pkg/connector/repo.go (5 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: test
🔇 Additional comments (3)
pkg/connector/repo.go (3)

207-207: LGTM! Critical bugfix for user/group identification.

The change from DisplayName to Id.Resource is correct and addresses the core issue. This ensures that the actual Bitbucket username/groupname is used for permission management instead of the display name, which could differ and cause permission issues.

Also applies to: 242-242


327-327: LGTM! Core changes for permission revocation.

The use of Id.Resource for permission checks and revocation is correct and consistent with the Grant method changes.

Also applies to: 344-344, 355-355


Line range hint 207-363: Verify consistent usage of Id.Resource across the codebase.

Let's ensure there are no other instances where DisplayName is used for permission management.

✅ Verification successful

DisplayName usage is correctly limited to display purposes only

The verification confirms that Id.Resource is consistently used for all permission management operations across the codebase, while DisplayName is only used for entitlement metadata and logging. The changes are safe and maintain consistency.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for potential instances where DisplayName might be used for permissions

# Look for DisplayName usage in permission-related code
echo "Searching for DisplayName usage in permission-related code..."
rg -l 'DisplayName.*\b(permission|Permission|PERMISSION)\b' --type go

# Look for specific permission update/revoke method calls
echo "Searching for permission management method calls..."
ast-grep --pattern 'UpdateUserRepositoryPermission($$$)' --lang go
ast-grep --pattern 'UpdateGroupRepositoryPermission($$$)' --lang go
ast-grep --pattern 'RevokeUserRepositoryPermission($$$)' --lang go
ast-grep --pattern 'RevokeGroupRepositoryPermission($$$)' --lang go

Length of output: 524


Script:

#!/bin/bash
# Show the actual lines containing DisplayName in permission context
echo "=== DisplayName usage in permission context ==="
rg 'DisplayName.*\b(permission|Permission|PERMISSION)\b' --type go -C 2

# Search for other permission-related methods
echo -e "\n=== Other permission-related methods ==="
rg '(Update|Revoke|Remove).*Permission' --type go -C 2

# Look for permission-related interfaces and structs
echo -e "\n=== Permission-related types ==="
ast-grep --pattern 'type $_ interface {
  $$$
  Permission
  $$$
}' --lang go

ast-grep --pattern 'type $_ struct {
  $$$
  Permission
  $$$
}' --lang go

Length of output: 11689

@ggreer ggreer merged commit d27560f into main Jan 13, 2025
3 checks passed
@ggreer ggreer deleted the Harika/Bitbucket_DC branch January 13, 2025 23:38
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.

2 participants