Update credential usage across all languages #15

ArjunNarendra · 2025-11-14T20:02:42Z

Remove dependency on DefaultAzureCredential internally and require the user to pass in a credential from which to generate a token across all languages and database drivers

Copilot

Pull Request Overview

This PR updates credential usage across Python, JavaScript, and .NET implementations to require users to explicitly pass authentication credentials instead of relying on internal DefaultAzureCredential instantiation. This change improves flexibility and gives users explicit control over authentication.

Removed internal fallback to DefaultAzureCredential() in all language implementations
Updated all connection methods to require credential parameters (no longer optional/nullable)
Updated documentation and samples to show explicit credential passing
Moved identity dependencies from core to peer/dev dependencies

Reviewed Changes

Copilot reviewed 21 out of 21 changed files in this pull request and generated 17 comments.

Show a summary per file

File	Description
python/src/azure_postgresql_auth/core.py	Removed `DefaultAzureCredential` imports and made credential parameters required (non-nullable)
python/src/azure_postgresql_auth/sqlalchemy/entra_connection.py	Updated to require credential via connect_args with validation and added usage examples
python/src/azure_postgresql_auth/sqlalchemy/async_entra_connection.py	Updated async SQLAlchemy to require credential via connect_args with validation
python/src/azure_postgresql_auth/psycopg3/entra_connection.py	Updated psycopg3 sync connection to require credential parameter
python/src/azure_postgresql_auth/psycopg3/async_entra_connection.py	Updated psycopg3 async connection to require AsyncTokenCredential parameter
python/src/azure_postgresql_auth/psycopg2/entra_connection.py	Updated psycopg2 connection to require credential parameter
python/pyproject.toml	Removed azure-identity from core dependencies
python/README.md	Updated all code examples to show explicit credential instantiation
python/samples/sqlalchemy/getting_started/create_db_connection.py	Updated sample to pass credential via connect_args
python/samples/psycopg3/getting_started/create_db_connection.py	Updated sample to pass credential via kwargs parameter
python/samples/psycopg2/getting_started/create_db_connection.py	Updated sample to use partial function to bind credential
javascript/src/entra_id_extension.js	Removed DefaultAzureCredential import and made credential parameter required
javascript/samples/sequelize/getting-started/create-db-connection.js	Updated sample to instantiate and pass credential explicitly
javascript/samples/pg/getting-started/create-db-connection.js	Updated sample to pass credential to getEntraTokenPassword function
javascript/package.json	Moved @azure/identity to peer dependency from core dependency
javascript/README.md	Updated all documentation examples to show explicit credential usage
dotnet/src/Microsoft/Azure/PostgreSQL/Auth/EntraIdExtension.cs	Removed nullable credential parameters and DefaultAzureCredential fallback
dotnet/src/Microsoft/Azure/PostgreSQL/Auth/Microsoft.Azure.PostgreSQL.Auth.csproj	Removed Azure.Identity package dependency
dotnet/samples/GettingStarted/GettingStarted.csproj	Added Azure.Identity package dependency for sample usage
dotnet/samples/GettingStarted/CreateDbConnectionNpgsql.cs	Updated sample to instantiate credential and pass to extension methods
dotnet/README.md	Updated documentation examples to show credential instantiation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-14T20:07:32Z

python/src/azure_postgresql_auth/sqlalchemy/entra_connection.py

+        if not isinstance(credential, (TokenCredential)):
            raise CredentialValueError(
-                "credential must be a TokenCredential for sync connections"
+                "credential is required and must be a TokenCredential. "
+                "Pass it via connect_args={'credential': DefaultAzureCredential()}"
            )


The validation logic will raise a TypeError when credential is None because isinstance(None, TokenCredential) check happens before raising the CredentialValueError.

The check should validate that credential is not None first:

if credential is None or not isinstance(credential, TokenCredential): raise CredentialValueError( "credential is required and must be a TokenCredential. " "Pass it via connect_args={'credential': DefaultAzureCredential()}" )

Copilot · 2025-11-14T20:07:32Z

python/src/azure_postgresql_auth/sqlalchemy/entra_connection.py


    Args:
        engine: The SQLAlchemy Engine to enable Entra authentication for
+        


Trailing whitespace on this line. Remove the trailing spaces after engine:.

Suggested change

Copilot · 2025-11-14T20:07:33Z

python/src/azure_postgresql_auth/sqlalchemy/async_entra_connection.py


    Args:
        engine: The async SQLAlchemy Engine to enable Entra authentication for
+        


Trailing whitespace on this line. Remove the trailing spaces after engine:.

Suggested change

Copilot · 2025-11-14T20:07:33Z

python/samples/psycopg2/getting_started/create_db_connection.py

    # authentication tokens are properly managed and refreshed so that each connection uses a valid token.
    #
    # For more details, see: https://www.psycopg.org/docs/advanced.html#subclassing-connection
+


Trailing whitespace on this line. Remove the trailing spaces.

Suggested change

I think this white space serves a purpose here.

Copilot · 2025-11-14T20:07:33Z

python/samples/psycopg2/getting_started/create_db_connection.py

+
+    # Create a connection factory with the credential bound using functools.partial
+    credential = DefaultAzureCredential()
+    connection_factory = partial(EntraConnection, credential=credential)


Trailing whitespace on this line. Remove the trailing spaces.

Same thoughts as the previous comment

Copilot · 2025-11-14T20:07:36Z

javascript/package.json

+    "@azure/identity": {
+      "optional": false
+    },


[nitpick] Moving @azure/identity from dependencies to devDependencies while making it a required peer dependency is correct for a library pattern. However, the peerDependenciesMeta marks it as optional: false, which means it's required. This conflicts with the peer dependency pattern where packages are typically optional in metadata.

Either:

Keep it as a regular dependency (if you want to bundle it)

Make it truly optional in peerDependenciesMeta with optional: true and handle the missing credential case gracefully

Remove the peerDependenciesMeta entry entirely (required is the default for peerDependencies)

Given the PR's intent to require users to provide credentials, option 3 (removing the meta entry) would be most appropriate.

Suggested change

"@azure/identity": {

"optional": false

},

Sounds good

Copilot · 2025-11-14T20:07:36Z

python/src/azure_postgresql_auth/sqlalchemy/entra_connection.py

+                "credential is required and must be a TokenCredential. "
+                "Pass it via connect_args={'credential': DefaultAzureCredential()}"
            )
+


Trailing whitespace on this line. Remove the trailing spaces.

Suggested change

Copilot · 2025-11-14T20:07:37Z

python/src/azure_postgresql_auth/psycopg3/async_entra_connection.py

        """
        credential = kwargs.pop("credential", None)
-        if credential and not isinstance(credential, (AsyncTokenCredential)):
+        if not isinstance(credential, (AsyncTokenCredential)):


The validation logic will raise a TypeError when credential is None because isinstance(None, AsyncTokenCredential) check happens before raising the CredentialValueError.

The check should validate that credential is not None first:

if credential is None or not isinstance(credential, AsyncTokenCredential): raise CredentialValueError( "credential is required and must be an AsyncTokenCredential for async connections" )

Suggested change

if not isinstance(credential, (AsyncTokenCredential)):

if credential is None or not isinstance(credential, AsyncTokenCredential):

Copilot · 2025-11-14T20:07:37Z

python/src/azure_postgresql_auth/sqlalchemy/async_entra_connection.py

-    Event handlers do not support async behavior so the token fetching will still
-    be synchronous.
+    Entra ID credentials for each database connection. A credential must be
+    provided via connect_args when creating the engine. Event handlers do not 


Trailing whitespace on this line. Remove the trailing spaces after the period.

Suggested change

provided via connect_args when creating the engine. Event handlers do not

provided via connect_args when creating the engine. Event handlers do not

Copilot · 2025-11-14T20:07:37Z

python/src/azure_postgresql_auth/sqlalchemy/async_entra_connection.py

+                "credential is required and must be a TokenCredential. "
+                "Pass it via connect_args={'credential': DefaultAzureCredential()}"
            )
+


Trailing whitespace on this line. Remove the trailing spaces.

Suggested change

…tial-usage

…NET GitHub Actions workflow

…ilot suggested

ArjunNarendra added 3 commits November 14, 2025 11:57

Update credential usage in .NET

d62592d

Update credential usage in JavaScript

1b7d853

Update credential usage in Python

8a78719

ArjunNarendra requested review from Copilot and lossyrob November 14, 2025 20:02

Copilot started reviewing on behalf of ArjunNarendra November 14, 2025 20:03 View session

Copilot finished reviewing on behalf of ArjunNarendra November 14, 2025 20:05

Copilot AI reviewed Nov 14, 2025

View reviewed changes

ArjunNarendra added 6 commits November 17, 2025 12:07

Fix file references in GitHub workflow for .NET

0f19550

Merge remote-tracking branch 'origin/main' into user/an/update-creden…

83da7ca

…tial-usage

Add back check to ensure format check is not performed for Linux in .…

22deb30

…NET GitHub Actions workflow

Remove dependency on azure.identity in core.py

e873ccc

Remove azure.identity from peerDependenciesMeta

8bb07bd

Make small fixes regarding error handling and linting that GitHub CoP…

24950e4

…ilot suggested

lossyrob approved these changes Nov 25, 2025

View reviewed changes

ArjunNarendra added 2 commits December 4, 2025 10:49

Merge branch 'main' into user/an/update-credential-usage

3b4ac77

Remove unused import of DefaultAzureCredential

5831e9d

ArjunNarendra merged commit 2eb235d into main Dec 4, 2025
5 checks passed

ArjunNarendra deleted the user/an/update-credential-usage branch December 4, 2025 18:55


		Args:
		engine: The SQLAlchemy Engine to enable Entra authentication for


		Args:
		engine: The async SQLAlchemy Engine to enable Entra authentication for

	if not isinstance(credential, (AsyncTokenCredential)):
	if credential is None or not isinstance(credential, AsyncTokenCredential):

	provided via connect_args when creating the engine. Event handlers do not
	provided via connect_args when creating the engine. Event handlers do not

Update credential usage across all languages #15

Update credential usage across all languages #15

Uh oh!

Conversation

ArjunNarendra commented Nov 14, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants