Skip to content

fix(tenancy): pose le search_path via after_begin sans autobegin à l'entrée de session - #301

Merged
NICE-DEV226 merged 1 commit into
mainfrom
fix/tenancy-session-begin
Oct 13, 2026
Merged

NICE-DEV226 merged 1 commit into
mainfrom
fix/tenancy-session-begin

Conversation

@NICE-DEV226

@NICE-DEV226 NICE-DEV226 commented Oct 13, 2026 •

Copy link
Copy Markdown
Collaborator

Ce que ça remédie

Régression introduite par #299 : sur PostgreSQL avec isolate_db: true, tout plugin qui fait async with session.begin(): échouait (InvalidRequestError: A transaction is already begun, HTTP 500). TenantAwareDB._set_tenant_schema exécutait set_config puis current_setting à l'entrée de session(), ce qui déclenchait l'autobegin de SQLAlchemy avant que le plugin n'ouvre sa propre transaction. Avec isolate_db: false tout passait. Idiome courant dans les plugins ERP (xstock, xsales, xpurchase…). Mes tests de #299 ne couvraient pas ce cas.

Correctif

_set_tenant_schema n'exécute plus aucun SQL à l'entrée de la session : il attache un écouteur after_begin qui pose set_config('search_path', :sp, true) et relit current_setting au début de chaque transaction (autobegin, begin() du plugin, après commit ou rollback). Toutes les garanties de #299 sont conservées : isolation dans la même transaction que les requêtes du plugin, échec fermé (RuntimeError) si le search_path n'a pas tenu (AUTOCOMMIT, pooler en mode statement), aucune fuite entre requêtes du pool. Si l'adaptateur a déjà ouvert la transaction (option execution_options), le search_path est posé immédiatement via run_sync.

Tests

  • Sur PostgreSQL réel, rouges avant correctif : session.begin() du plugin, 50 sessions concurrentes de tenants différents sur un pool de 5 (mêlant begin(), commit/rollback et requête simple : 0 fuite), AUTOCOMMIT toujours refusé avec begin().
  • Suite unitaire + intégration : 1469 passés / 15 ignorés (tests PostgreSQL sans XCORE_TEST_PG_URL, exécutés par le job CI qui a un service postgres), 2 échecs test_xworker::test_build_app_* (module dateutil absent de l'environnement de test), identiques sans ce changement. isort / black OK.
  • 3 tests de fix(tenancy): isole réellement la base par search_path PostgreSQL #299 supposaient du SQL exécuté à l'entrée de la session : adaptés pour passer par l'écouteur ; un test vérifie qu'aucun execute n'a lieu à l'entrée.

À savoir

  • Le search_path est posé à la première requête de la transaction, plus à l'entrée de session : plus de SQL implicite avant le premier execute du plugin.
  • Non couvert : un plugin qui appelle begin() sur une session que l'adaptateur a déjà fait autobégin (cas execution_options) échoue toujours ; comportement de l'adaptateur déjà présent avec isolate_db: false.

Summary by Sourcery

Defer tenant search-path setup to transaction start so explicit plugin transactions work without compromising database isolation.

Bug Fixes:

  • Prevent tenant session initialization from implicitly opening a transaction, allowing plugins to start explicit transactions with session.begin() without errors.
  • Reapply and validate the tenant-specific PostgreSQL search_path at the start of every transaction while preserving fail-closed isolation behavior.

Enhancements:

  • Handle sessions whose transaction was already opened by the adapter while retaining tenant schema isolation.

Tests:

  • Update tenancy unit and integration tests for deferred after_begin schema setup, explicit plugin transactions, transaction boundaries, concurrent pooled sessions, and AUTOCOMMIT rejection.

…entrée de session

Exécuter set_config à l'entrée de TenantAwareDB.session() ouvrait la
transaction et faisait échouer 'async with session.begin():' des plugins
(InvalidRequestError). Le search_path est désormais posé et vérifié
(fail-closed) par un listener after_begin au début de chaque transaction.
Copilot AI balanced review requested due to automatic review settings October 13, 2026 21:34
@sourcery-ai

sourcery-ai Bot commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Le correctif élimine l’autobegin implicite provoqué par l’initialisation du tenancy en différant la configuration et la validation du search_path au hook after_begin, avec une gestion spécifique des transactions déjà ouvertes. Les tests simulent ce cycle SQLAlchemy et valident les usages plugin, les transitions de transaction, la concurrence, l’échec fermé et l’absence de fuite entre tenants.

Sequence diagram for deferred tenant search_path configuration

sequenceDiagram
    participant Plugin
    participant Session
    participant SQLAlchemy
    participant PostgreSQL

    Plugin->>Session: session()
    Note over Session: No SQL, no implicit autobegin
    Plugin->>Session: begin()
    Session->>SQLAlchemy: after_begin
    SQLAlchemy->>PostgreSQL: set_config(search_path, :sp, true)
    SQLAlchemy->>PostgreSQL: current_setting(search_path)
    PostgreSQL-->>SQLAlchemy: tenant, public
    Plugin->>PostgreSQL: Plugin queries
Loading

Sequence diagram for tenant search_path across session transactions

sequenceDiagram
    participant Plugin
    participant Session
    participant PostgreSQL

    Plugin->>Session: begin()
    Session->>PostgreSQL: after_begin: set_config(search_path)
    Session->>PostgreSQL: after_begin: current_setting(search_path)
    Plugin->>Session: commit()
    Plugin->>Session: begin()
    Session->>PostgreSQL: after_begin: set_config(search_path)
    Session->>PostgreSQL: after_begin: current_setting(search_path)
    Plugin->>Session: rollback()
    Plugin->>Session: execute()
    Session->>PostgreSQL: after_begin: set_config(search_path)
    Session->>PostgreSQL: after_begin: current_setting(search_path)
Loading

Flow diagram for already-open tenant transactions

flowchart TD
    A["_set_tenant_schema"] --> B["Attach after_begin listener"]
    B --> C{"sync_sess.in_transaction()"}
    C -->|No| D["Wait for transaction start"]
    C -->|Yes| E["sess.connection()"]
    E --> F["conn.run_sync(_apply_conn)"]
    F --> G["set_config and current_setting"]
    G --> H{"search_path persisted?"}
    H -->|Yes| I["Continue"]
    H -->|No| J["Raise RuntimeError"]
Loading

File-Level Changes

Change Details Files
Déplacer l’application et la validation du search_path au début de chaque transaction SQLAlchemy, sans exécuter de SQL lors de l’entrée dans la session.
  • Enregistrer un listener after_begin sur la session synchrone.
  • Appliquer set_config puis vérifier current_setting sur la même connexion et propager les erreurs d’isolation.
  • Réappliquer le schéma après chaque nouvelle transaction, tout en gérant immédiatement les transactions déjà ouvertes par l’adaptateur via run_sync.
  • Préserver le filtrage PostgreSQL et le comportement d’échec fermé pour AUTOCOMMIT ou les poolers incompatibles.
xcore/kernel/tenancy/services.py
Adapter les tests unitaires et d’intégration au déclenchement différé du SQL et couvrir les scénarios transactionnels régressifs.
  • Mettre à jour les faux objets SQLAlchemy pour simuler after_begin au premier accès SQL.
  • Vérifier qu’aucune requête n’est exécutée à l’entrée de session et que les erreurs du listener sont propagées.
  • Tester session.begin() piloté par un plugin, les transactions successives après commit/rollback, la concurrence entre 50 sessions sur un pool de cinq connexions et le refus en AUTOCOMMIT.
  • Conserver les vérifications d’isolation entre tenants et d’absence de fuite vers les connexions réutilisées.
tests/integration/test_tenancy_integration.py
tests/unit/kernel/test_tenancy.py
tests/unit/kernel/test_tenancy_isolation_real.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@github-actions

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!

Sourcery assessment

Needs a human reviewer. If the after_begin listener fails to set the tenant search path on a transaction, queries could read another schema’s data or write records to the wrong one. Reverting restores the previous behavior, but data already exposed or written incorrectly would not be undone.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@NICE-DEV226
NICE-DEV226 merged commit 2a0af45 into main Oct 13, 2026
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants