refactor: Ensure Flask framework leverages the Flask-SQLAlchemy session (Phase I) #26200

john-bodley · 2023-12-06T21:01:58Z

SUMMARY

Somewhat related to #26186 (though for non-Celery related workflows) this PR ensures that the remainder of the codebase (excluding tests and Alembic migrations) leverage the Flask-SQLAlchemy session (db.session).

This refactor helps to reduce the code complexity and ensures we're not generating any rouge sessions which are often not explicitly closed and can lead to connection pooling issues.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

CI.

ADDITIONAL INFORMATION

Has associated issue: [SIP-99A] Primer on managing SQLAlchemy sessions #25107
Required feature flags:
Changes UI
Includes DB Migration (follow approval process in SIP-59)
- Migration is atomic, supports rollback & is backwards-compatible
- Confirm DB migration upgrade and downgrade tested
- Runtime estimates and downtime expectations provided
Introduces new feature or API
Removes existing feature or API

john-bodley · 2023-12-06T21:08:59Z

superset/security/manager.py

-    def get_user_by_username(
-        self, username: str, session: Session = None
-    ) -> Optional[User]:
+    def get_user_by_username(self, username: str) -> Optional[User]:


This method was never called with the session parameter.

john-bodley · 2023-12-06T21:10:13Z

superset/utils/log.py

@@ -152,8 +153,7 @@ def log_with_context(  # pylint: disable=too-many-locals
        # need to add them back before logging to capture user_id
        if user_id is None:
            try:
-                session = current_app.appbuilder.get_session
-                session.add(g.user)
+                db.session.add(g.user)


Same session as current_app.appbuilder.get_session. Consistency is key here.

john-bodley · 2023-12-06T21:12:32Z

tests/unit_tests/datasource/dao_tests.py

@@ -106,7 +106,6 @@ def test_get_datasource_sqlatable(session_with_data: Session) -> None:
    result = DatasourceDAO.get_datasource(
        datasource_type=DatasourceType.TABLE,
        datasource_id=1,
-        session=session_with_data,


The db.session is mocked here and is included as a fixture to the test.

john-bodley · 2023-12-06T21:14:15Z

superset/daos/datasource.py

@@ -45,15 +44,14 @@ class DatasourceDAO(BaseDAO[Datasource]):
    @classmethod
    def get_datasource(
        cls,
-        session: Session,


It is not apparent to me why the session was included here. There are unit tests which use a session other than db.session but, per here, the global db.session is mocked to use said session.

codecov · 2023-12-06T21:54:38Z

Codecov Report

Attention: 12 lines in your changes are missing coverage. Please review.

Comparison is base (aaa4a7b) 69.08% compared to head (6b0eb40) 66.87%.

Files	Patch %	Lines
superset/models/dashboard.py	27.27%	8 Missing ⚠️
superset/utils/database.py	0.00%	2 Missing ⚠️
superset/utils/mock_data.py	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #26200      +/-   ##
==========================================
- Coverage   69.08%   66.87%   -2.22%     
==========================================
  Files        1931     1931              
  Lines       75351    75333      -18     
  Branches     8429     8429              
==========================================
- Hits        52056    50376    -1680     
- Misses      21148    22810    +1662     
  Partials     2147     2147

Flag	Coverage Δ
hive	`?`
mysql	`77.92% <73.91%> (+<0.01%)`	⬆️
postgres	`78.02% <73.91%> (+<0.01%)`	⬆️
presto	`?`
python	`78.16% <73.91%> (-4.62%)`	⬇️
sqlite	`77.61% <73.91%> (+<0.01%)`	⬆️
unit	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

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

john-bodley · 2023-12-06T23:35:43Z

superset/models/dashboard.py

-        )
-        session.add(dashboard)
+    session = sqla.inspect(target).session
+    new_user = session.query(User).filter_by(id=target.id).first()


Same logic without the try block.

john-bodley · 2024-01-02T20:11:59Z

ping @michael-s-molina @villebro

michael-s-molina · 2024-01-03T12:53:58Z

@john-bodley I think it would be great to label this PR with v4.0 and merge it during the breaking window to reuse the test/stabilization efforts that will occur during that period.

john-bodley · 2024-01-03T21:37:01Z

scripts/benchmark_migration.py

        print(f"- {model.__name__} ({rows} rows in table {model.__tablename__})")
        model_rows[model] = rows
-    session.close()


There is no need to explicitly close the session as this is handled by Flask-SQLAlchemy when the session is torn down—be that at the end of request or when a script/shell terminates.

john-bodley · 2024-01-03T21:53:46Z

Regarding,

@john-bodley I think it would be great to label this PR with v4.0 and merge it during the breaking window to reuse the test/stabilization efforts that will occur during that period.

as discussed with @michael-s-molina, though this is technically a non-breaking change, it seems prudent (from a safety perspective) to hold off merging this until the v4.0 breaking window.

john-bodley · 2024-01-17T00:43:11Z

@michael-s-molina would you mind reviewing this PR?

michael-s-molina

LGTM

…on (apache#26200)

pull-request-size bot added the size/XL label Dec 6, 2023

john-bodley commented Dec 6, 2023

View reviewed changes

john-bodley force-pushed the john-bodley--sip-99-non-celery-sessions branch from 0205b85 to b37c7cf Compare December 6, 2023 21:49

john-bodley force-pushed the john-bodley--sip-99-non-celery-sessions branch 4 times, most recently from 5486cd6 to 490aeff Compare December 6, 2023 22:46

john-bodley marked this pull request as ready for review December 6, 2023 23:08

john-bodley commented Dec 6, 2023

View reviewed changes

john-bodley requested review from michael-s-molina, eschutho, villebro and betodealmeida December 7, 2023 17:48

michael-s-molina changed the title ~~chore: Ensure Flask framework leverages Flask-SQLAlchemy session~~ refactpr: Ensure Flask framework leverages Flask-SQLAlchemy session Dec 7, 2023

michael-s-molina changed the title ~~refactpr: Ensure Flask framework leverages Flask-SQLAlchemy session~~ refactor: Ensure Flask framework leverages Flask-SQLAlchemy session Dec 7, 2023

john-bodley changed the title ~~refactor: Ensure Flask framework leverages Flask-SQLAlchemy session~~ refactor: Ensure Flask framework leverages the Flask-SQLAlchemy session Dec 11, 2023

michael-s-molina added hold! On hold v4.0 Label added by the release manager to track PRs to be included in the 4.0 branch labels Jan 3, 2024

john-bodley force-pushed the john-bodley--sip-99-non-celery-sessions branch from 490aeff to 1a61b1e Compare January 3, 2024 21:21

john-bodley commented Jan 3, 2024

View reviewed changes

michael-s-molina removed the hold! On hold label Jan 16, 2024

chore: Leverage Flask-SQLAlchemy session

6b0eb40

john-bodley force-pushed the john-bodley--sip-99-non-celery-sessions branch from 1a61b1e to 6b0eb40 Compare January 17, 2024 00:42

michael-s-molina approved these changes Jan 17, 2024

View reviewed changes

john-bodley merged commit df79522 into apache:master Jan 17, 2024
33 checks passed

john-bodley deleted the john-bodley--sip-99-non-celery-sessions branch January 17, 2024 19:28

Muhammed-baban pushed a commit to intellica-tech/reporting-tool that referenced this pull request Jan 19, 2024

refactor: Ensure Flask framework leverages the Flask-SQLAlchemy sessi…

31103d1

…on (apache#26200)

john-bodley changed the title ~~refactor: Ensure Flask framework leverages the Flask-SQLAlchemy session~~ refactor: Ensure Flask framework leverages the Flask-SQLAlchemy session (Phase I) Jan 31, 2024

john-bodley mentioned this pull request Jan 31, 2024

refactor: Ensure Flask framework leverages the Flask-SQLAlchemy session (Phase II) #26909

Merged

9 tasks

sfirke pushed a commit to sfirke/superset that referenced this pull request Mar 22, 2024

refactor: Ensure Flask framework leverages the Flask-SQLAlchemy sessi…

9328b9a

…on (apache#26200)

mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 4.0.0 labels Apr 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: Ensure Flask framework leverages the Flask-SQLAlchemy session (Phase I) #26200

refactor: Ensure Flask framework leverages the Flask-SQLAlchemy session (Phase I) #26200

john-bodley commented Dec 6, 2023 •

edited

Loading

john-bodley Dec 6, 2023

john-bodley Dec 6, 2023

john-bodley Dec 6, 2023

john-bodley Dec 6, 2023

codecov bot commented Dec 6, 2023 •

edited

Loading

john-bodley Dec 6, 2023

john-bodley commented Jan 2, 2024

michael-s-molina commented Jan 3, 2024

john-bodley Jan 3, 2024

john-bodley commented Jan 3, 2024

john-bodley commented Jan 17, 2024

michael-s-molina left a comment

refactor: Ensure Flask framework leverages the Flask-SQLAlchemy session (Phase I) #26200

refactor: Ensure Flask framework leverages the Flask-SQLAlchemy session (Phase I) #26200

Conversation

john-bodley commented Dec 6, 2023 • edited Loading

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

john-bodley Dec 6, 2023

Choose a reason for hiding this comment

john-bodley Dec 6, 2023

Choose a reason for hiding this comment

john-bodley Dec 6, 2023

Choose a reason for hiding this comment

john-bodley Dec 6, 2023

Choose a reason for hiding this comment

codecov bot commented Dec 6, 2023 • edited Loading

Codecov Report

john-bodley Dec 6, 2023

Choose a reason for hiding this comment

john-bodley commented Jan 2, 2024

michael-s-molina commented Jan 3, 2024

john-bodley Jan 3, 2024

Choose a reason for hiding this comment

john-bodley commented Jan 3, 2024

john-bodley commented Jan 17, 2024

michael-s-molina left a comment

Choose a reason for hiding this comment

john-bodley commented Dec 6, 2023 •

edited

Loading

codecov bot commented Dec 6, 2023 •

edited

Loading