Skip to content

Conversation

lucanovera
Copy link
Contributor

@lucanovera lucanovera commented Aug 20, 2025

Description Of Changes

Implements a new beta flag called "New integration management". When the flag is on, all existing SaaS integrations will show in the Settings > Integrations screen and you'll be able to add new ones from that screen as well. This is the first step towards unifying all integration management things in this page.

The Integrations page UI requires some extra details about integrations, like tags, category, enabled features, etc. To keep a single source of truth, these extra information was added as an optional display_info field on the saas config files.

Code Changes

  • Added new type for the new display_info property, and enums for integrations categories and enabled features. Updated the FE types to use the new models from openapi.
  • Added display_info property to SaaS integrations in this repo (fidesplus saas changes here)
  • Add "newIntegrationManagement" beta flag
  • Update fetched integrations to include Saas when flag is on
  • Update add integration modal category select to only show a category if it has results

Steps to Confirm

Prerequisite: Having a Saas integration setup locally. Skip if you have one already

  1. Login to admin-ui
  2. Go to any system, in the Integrations tab and add a saas integration (like Adobe Sign), no need to use real connection details.

Checking saas integrations don't show up without the flag on:

  1. Go to Settings > About and make sure the "New integration management" flag is off
  2. Go to Settings > Integrations and check the Saas integration doesn't show up in the list
  3. Click on Add integration and check no saas integrations show up there

Checking saas integration do show up with the flag on:

  1. Go to Settings > About and make sure the "New integration management" flag is on
  2. Go to Settings > Integrations and check the Saas integration does show up in the list and in alphabetical order
  3. Click on Add integration and check that all saas integrations appear, their logos and tags show up and that you can filter them by their corresponding category

Checking you can add a new saas integration:

  1. Click on Add integration and add any saas integration (the ones that have the "API" tag)
  2. Check the new integration appears after creating it
  3. Check the table column "Type" shows the correct integration name and tags.
  4. Click on the integration to go to the integration detail page
  5. Check that the logo, category, tags and integration name are correct. Check the only tab that appears is Connection. No description will appear at this time.
  6. Only exception to the above is the Salesforce integration, which has an extra Data discovery tab and some extra tags

Checking you can still upload a custom integration without display_info and it works:

  1. Download this config and this dataset
  2. Rename the files to config.yml and dataset.yml
  3. Compress both files in a zip
  4. Go to a System > Integration tab, and click on Upload integration
  5. Check you can now search and add a Custom Privacy Request Fields integration
  6. Go to the Settings > Integrations page, and check the new integration appears with a Custom category
  7. Click on Add integration and check that you can find the custom integration under the "Custom" category

Pre-Merge Checklist

  • All CI Pipelines Succeeded
  • New features have been verified on Demo Environment using nox -s demo -- dev
  • Documentation:
    • documentation complete, PR opened in fidesdocs
    • documentation issue created in fidesdocs
    • if there are any new client scopes created as part of the pull request, remember to update public-facing documentation that references our scope registry
  • Issue Requirements are Met
  • Optional: Follow-Up Issues Created
  • Update CHANGELOG.md

@lucanovera lucanovera requested a review from a team as a code owner August 20, 2025 15:45
Copy link

vercel bot commented Aug 20, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
fides-plus-nightly Ready Ready Preview Comment Aug 26, 2025 8:04pm
1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
fides-privacy-center Ignored Ignored Aug 26, 2025 8:04pm

@lucanovera lucanovera changed the title Draft:Eng 801 display saas integrations in the integrations page Draft:Display saas integrations in the integrations page Aug 20, 2025
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Comment @cursor review or bugbot run to trigger another review on this PR

Copy link

codecov bot commented Aug 25, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.66%. Comparing base (fc1dbd6) to head (c010476).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6480      +/-   ##
==========================================
+ Coverage   87.64%   87.66%   +0.01%     
==========================================
  Files         477      480       +3     
  Lines       30609    30657      +48     
  Branches     3445     3446       +1     
==========================================
+ Hits        26828    26876      +48     
  Misses       3040     3040              
  Partials      741      741              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@lucanovera lucanovera changed the title Draft:Display saas integrations in the integrations page Display saas integrations in the integrations page Aug 26, 2025
Copy link
Contributor

@JadeCara JadeCara left a comment

Choose a reason for hiding this comment

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

This looks good to me!
The only comment I had would be to make sure there were clear enum tests to verify how things would pipe through to the front end. It looks like they are in a lot of the integration tests though and - since you have been using them though - my guess is they are ok!

@lucanovera lucanovera merged commit 92ccbb5 into main Aug 26, 2025
24 checks passed
@lucanovera lucanovera deleted the ENG-801-Display-saas-integrations-in-the-integrations-page branch August 26, 2025 20:05
Copy link

cypress bot commented Aug 26, 2025

fides    Run #13265

Run Properties:  status check failed Failed #13265  •  git commit 92ccbb5793: Display saas integrations in the integrations page (#6480)
Project fides
Branch Review main
Run status status check failed Failed #13265
Run duration 00m 59s
Commit git commit 92ccbb5793: Display saas integrations in the integrations page (#6480)
Committer Lucano Vera
View all properties for this run ↗︎

Test results
Tests that failed  Failures 1
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 4
View all changes introduced in this branch ↗︎

Tests for review

Failed  cypress/e2e/smoke_test.cy.ts • 1 failed test

View Output Video

Test Artifacts
Smoke test > can submit an access request from the Privacy Center Screenshots Video

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