Skip to content

feat(GitSync): Remap playbook view roles by name#686

Open
avitav-svg wants to merge 5 commits intochronicle:mainfrom
avitav-svg:soc-roles-fix
Open

feat(GitSync): Remap playbook view roles by name#686
avitav-svg wants to merge 5 commits intochronicle:mainfrom
avitav-svg:soc-roles-fix

Conversation

@avitav-svg
Copy link
Copy Markdown

@avitav-svg avitav-svg commented Apr 16, 2026

Fixes playbook pull failures due to non-portable role IDs by mapping roles by name to destination IDs. Missing roles are removed.

Title (Please follow the convention below)

Please use a clear and concise title that summarizes your changes.
If this PR is related to an internal Buganizer ticket, please include its ID at the beginning.

Convention: [Optional Buganizer ID: 123456789] Short, descriptive title of changes

Examples:

  • Fix: Resolve issue with API endpoint returning 500 error
  • [Buganizer ID: 987654321] Feature: Add support for custom data types
  • Docs: Update README with installation instructions

Description

Please provide a detailed description of your changes. This helps reviewers understand your work and its context.

What problem does this PR solve?
(e.g., "Fixes a bug where X was happening," "Implements feature Y to allow Z," "Improves performance of function A.")

How does this PR solve the problem?
(e.g., "Modified algorithm in src/foo.js," "Added new component Bar.vue," "Updated dependency baz to version 1.2.3.")

Any other relevant information (e.g., design choices, tradeoffs, known issues):
(e.g., "Chose approach A over B due to performance considerations," "This change might affect X in certain edge cases," "Requires manual migration steps for existing users.")


Checklist:

Please ensure you have completed the following items before submitting your PR.
This helps us review your contribution faster and more efficiently.

General Checks:

  • I have read and followed the project's contributing.md guide.
  • My code follows the project's coding style guidelines.
  • I have performed a self-review of my own code.
  • My changes do not introduce any new warnings.
  • My changes pass all existing tests.
  • I have added new tests where appropriate to cover my changes. (If applicable)
  • I have updated the documentation where necessary (e.g., README, API docs). (If applicable)

Open-Source Specific Checks:

  • My changes do not introduce any Personally Identifiable Information (PII) or sensitive customer data.
  • My changes do not expose any internal-only code examples, configurations, or URLs.
  • All code examples, comments, and messages are generic and suitable for a public repository.
  • I understand that any internal context or sensitive details related to this work are handled separately in internal systems (Buganizer for Google team members).

For Google Team Members and Reviewers Only:

  • I have included the Buganizer ID in the PR title or description (e.g., "Internal Buganizer ID: 123456789" or "Related Buganizer: go/buganizer/123456789").
  • I have ensured that all internal discussions and PII related to this work remain in Buganizer.
  • I have tagged the PR with one or more labels that reflect the pull request purpose.

Screenshots (If Applicable)

If your changes involve UI or visual elements, please include screenshots or GIFs here.
Ensure any sensitive data is redacted or generalized.


Further Comments / Questions

Any additional comments, questions, or areas where you'd like specific feedback.


Note

Medium Risk
Touches workflow save/install logic and permission-related role mappings; incorrect role resolution could change which users can see playbook views or strip roles when names don’t match.

Overview
Ensures playbook overviewTemplates role assignments are portable across SOAR instances by remapping roles from roleNames to destination role IDs before saving workflows.

During both new installs and updates, GitSync now fetches and caches SOC roles via a new get_soc_roles API call, replaces template roles with the matched IDs, drops unknown roles (with a warning), and removes the roleNames field from the payload.

Reviewed by Cursor Bugbot for commit 2d88fac. Bugbot is set up for automated code reviews on this repo. Configure here.

@avitav-svg avitav-svg requested a review from a team as a code owner April 16, 2026 11:59
@google-cla
Copy link
Copy Markdown

google-cla Bot commented Apr 16, 2026

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses issues with playbook pull failures caused by non-portable role IDs. By implementing a name-based mapping system, the synchronization process now correctly resolves roles to their corresponding IDs in the destination system and gracefully handles missing roles by removing them, thereby improving the reliability of playbook deployments.

Highlights

  • Role Mapping Implementation: Introduced a new mechanism to remap playbook view roles by name to destination-specific IDs, ensuring portability across different environments.
  • API Integration: Added a new method to the Siemplify API client to fetch SOC roles, which are now cached in the GitSyncManager.
  • Workflow Processing: Updated both local workflow updates and new workflow installations to include the role remapping process, automatically removing missing roles.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request implements role remapping for workflows during synchronization. It introduces a _remap_workflow_roles method in GitSyncManager to translate role names to system-specific IDs and adds a get_soc_roles method to SiemplifyApiClient. Feedback was provided regarding missing type annotations and docstrings in the API client, as well as suggestions for improved defensive programming, docstring compliance, and the use of non-deprecated logging methods in the manager class.

Comment thread content/response_integrations/power_ups/git_sync/core/SiemplifyApiClient.py Outdated
Comment thread content/response_integrations/power_ups/git_sync/core/GitSyncManager.py Outdated
Copy link
Copy Markdown
Member

@TalShafir1 TalShafir1 left a comment

Choose a reason for hiding this comment

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

Please add release notes and increase the integration's version

@TalShafir1 TalShafir1 added Bug Something isn't working Git Sync labels Apr 21, 2026
TalShafir1 pushed a commit that referenced this pull request Apr 21, 2026
…ntegrations (#702)

* Fix: CI path filter typo skipping all checks for power_ups integrations

The path filters in 5 workflow files referenced `power_up/` instead of
`power_ups/`, causing validate, build, lint, code check, and Windows
CI jobs to silently skip when power_ups integrations were modified.
This allowed PR #686 to pass CI without version bump or release notes
validation.

* Add .claude/ to .gitignore
@github-actions
Copy link
Copy Markdown

Marketplace Validation Failed

Click to view the full report

Validation Report

🧩 Integrations
Pre-Build Stage

git_sync

Validation Name Details
⚠️ Integration Version Bump project.toml and release_notes.yml files must be updated before PR
⚠️ Test Config Validation 'git_sync' is missing tests/config.json

2 similar comments
@github-actions
Copy link
Copy Markdown

Marketplace Validation Failed

Click to view the full report

Validation Report

🧩 Integrations
Pre-Build Stage

git_sync

Validation Name Details
⚠️ Integration Version Bump project.toml and release_notes.yml files must be updated before PR
⚠️ Test Config Validation 'git_sync' is missing tests/config.json

@github-actions
Copy link
Copy Markdown

Marketplace Validation Failed

Click to view the full report

Validation Report

🧩 Integrations
Pre-Build Stage

git_sync

Validation Name Details
⚠️ Integration Version Bump project.toml and release_notes.yml files must be updated before PR
⚠️ Test Config Validation 'git_sync' is missing tests/config.json

@github-actions
Copy link
Copy Markdown

Marketplace Validation Failed

Click to view the full report

Validation Report

🧩 Integrations
Pre-Build Stage

git_sync

Validation Name Details
⚠️ Integration Version Bump project.toml file must be updated before PR
⚠️ Test Config Validation 'git_sync' is missing tests/config.json

Fixes playbook pull failures due to non-portable role IDs by mapping roles by name to destination IDs. Missing roles are removed.
Signed-off-by: avitav-svg <avitav@google.com>
@avitav-svg avitav-svg requested a review from TalShafir1 April 23, 2026 09:35
@github-actions
Copy link
Copy Markdown

Marketplace Validation Failed

Click to view the full report

Validation Report

🧩 Integrations
Pre-Build Stage

git_sync

Validation Name Details
⚠️ Integration Version Bump project.toml file must be updated before PR
⚠️ Test Config Validation 'git_sync' is missing tests/config.json

@github-actions
Copy link
Copy Markdown

Marketplace Validation Failed

Click to view the full report

Validation Report

🧩 Integrations
Pre-Build Stage

git_sync

Validation Name Details
⚠️ Integration Version Bump project.toml file must be updated before PR
⚠️ Test Config Validation 'git_sync' is missing tests/config.json

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Bug Something isn't working Git Sync

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants