feat: managed connection inclusion #1242
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1242 +/- ##
==========================================
+ Coverage 80.42% 80.46% +0.03%
==========================================
Files 146 146
Lines 5772 5794 +22
Branches 1174 1183 +9
==========================================
+ Hits 4642 4662 +20
- Misses 645 646 +1
- Partials 485 486 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
docs/configuring-the-deploy-cli.md
Outdated
|
|
||
| ```json | ||
| { | ||
| "AUTH0_INCLUDED_CONNECTIONS": ["github", "google-oauth2", "Username-Password-Authentication"] |
There was a problem hiding this comment.
"Username-Password-Authentication" comes under database resource type on deploy cli
There was a problem hiding this comment.
Revised the documentation.
| }; | ||
|
|
||
| const managedConnectionNames = this.config('AUTH0_INCLUDED_CONNECTIONS'); | ||
| const filteredConnections = managedConnectionNames |
There was a problem hiding this comment.
Please check the logic on src/context/index.ts , similar logic AUTH0_EXCLUDED_CONNECTIONS, AUTH0_INCLUDED_CONNECTIONS can be applied
| conflicts: [], | ||
| }; | ||
|
|
||
| const managedConnectionNames = this.config('AUTH0_INCLUDED_CONNECTIONS'); |
There was a problem hiding this comment.
Instead of using from config object, please use better to use similar approach AUTH0_EXCLUDED_CONNECTIONS
There was a problem hiding this comment.
Used the same logic as AUTH0_EXCLUDED_CONNECTIONS.
|
Please mark it ready to review once the unit tests pass |
kushalshit27
left a comment
kushalshit27
left a comment
There was a problem hiding this comment.
Can you please point to where we are adding the validation restriction when AUTH0_INCLUDED_CONNECTIONS and AUTH0_EXCLUDED_CONNECTIONS together?
| if (includedConnections.length > 0 && filteredConnections.length !== connections.length) { | ||
| const excludedCount = connections.length - filteredConnections.length; | ||
| log.info( | ||
| `AUTH0_INCLUDED_CONNECTIONS is configured. Managing ${filteredConnections.length} connection(s), ignoring ${excludedCount} connection(s) not in the managed list.` |
There was a problem hiding this comment.
No ignoring, please add validation to ensure not to use both in the config file.
There was a problem hiding this comment.
Implemented a validation check ensuring that AUTH0_INCLUDED_CONNECTIONS and AUTH0_EXCLUDED_CONNECTIONS are mutually exclusive.
| if (includedConnections.length > 0 && filteredConnections.length !== connections.length) { | ||
| const excludedCount = connections.length - filteredConnections.length; | ||
| log.info( | ||
| `AUTH0_INCLUDED_CONNECTIONS is configured. Managing ${filteredConnections.length} connection(s), ignoring ${excludedCount} connection(s) not in the managed list.` | ||
| ); | ||
| } |
There was a problem hiding this comment.
should not be part of src/tools/auth0/handlers/connections.ts
There was a problem hiding this comment.
Implemented the validation check within the global context.
…and AUTH0_EXCLUDED_CONNECTIONS
kushalshit27
changed the title
kushalshit27
left a comment
kushalshit27
left a comment
There was a problem hiding this comment.
Current code changes are not working. Please add instructions on how to test, ensuring that the changes are thoroughly tested before moving to 'PR ready to review'.
- Adjusted logic to ensure 'enterprise-saml' is not marked for deletion when not in the include list. - Modified tests to reflect that 'google-oauth2' should not be deleted if it's not in the include list. - Updated behavior to only delete managed connections when assets are empty, preserving unmanaged ones. - Ensured that unmanaged connections are ignored during updates, preventing unintended deletions.
🔧 Changes
This PR introduces the
AUTH0_INCLUDED_CONNECTIONSconfiguration option to the Auth0 Deploy CLI. This allows for a "managed-only" approach to connection management, which is essential for environments where self-service or dynamic connections exist alongside managed infrastructure.Key Improvements:
exportandimport.JSON Format
Environment Variable
export AUTH0_INCLUDED_CONNECTIONS='["github","google-oauth2"]'📚 References
Closes #1163
Enterprise Connections
🔬 Testing
Unit test added
E2E added
📝 Checklist