chore(hybridcloud) Remove role switching and update guard method #52673
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add guards for deletes on hybridcloudforeignkey models. - Remove role creation/permisission setting. - Add unguarded_write() context manager that emits fencing queries. - Make in_test_psql_role_override an alias to unguarded_write
github-actions
bot
added
the
Scope: Backend
markstory
commented
Jul 11, 2023
| _fencing_counters: MutableMapping[str, int] = defaultdict(int) | ||
|
|
||
|
|
||
| @contextlib.contextmanager | ||
| def in_test_psql_role_override(role_name: str, using: str | None = None): |
There was a problem hiding this comment.
This will be around for a bit longer until I can update getsentry.
| @@ -94,6 +93,8 @@ def increment_project_counter(project, delta=1, using="default"): | |||
| # this must be idempotent because it seems to execute twice | |||
| # (at least during test runs) | |||
| def create_counter_function(app_config, using, **kwargs): | |||
| from sentry.testutils.silo import unguarded_write | |||
There was a problem hiding this comment.
Circular import sadness.
src/sentry/testutils/asserts.py
Outdated
| @@ -1,7 +1,5 @@ | |||
| from typing import Optional | |||
|
|
|||
| from sentry.models import AuditLogEntry, CommitFileChange | |||
There was a problem hiding this comment.
More circular import sadness.
src/sentry/testutils/silo.py
Outdated
|
|
||
| @contextlib.contextmanager | ||
| def unguarded_write(using: str | None = None, *args: Any, **kwargs: Any): |
There was a problem hiding this comment.
I'm not 💯 sold on this name, and welcome any suggestions to improve it.
Comment on lines
+283
to
+293
| seen_models: MutableSet[type] = set() | ||
| for app_config in apps.get_app_configs(): | ||
| for model in iter_models(app_config.name): | ||
| for field in model._meta.fields: | ||
| if not isinstance(field, HybridCloudForeignKey): | ||
| continue | ||
| fk_model = field.foreign_model | ||
| if fk_model is None or fk_model in seen_models: | ||
| continue | ||
| seen_models.add(fk_model) | ||
| _protected_operations.append(protected_table(fk_model._meta.db_table, "delete")) |
There was a problem hiding this comment.
I missed adding these guards in the initial pass, but noticed these were missing when removing the role based methods.
There was a problem hiding this comment.
There should also be a test, somewhere, I wrote that fails if a raw deletion succeeds without throwing an exception.
| @@ -10,14 +7,6 @@ | |||
|
|
|||
| @control_silo_test(stable=True) | |||
| class IntegrationTest(TestCase): | |||
| def test_cannot_delete_with_queryset(self): | |||
There was a problem hiding this comment.
These tests had to be removed as they now throw during teardown which we can't catch.
There was a problem hiding this comment.
Is there some alternative that ensures atleast that this logic does exist?
corps
reviewed
Jul 11, 2023
src/sentry/db/postgres/roles.py
Outdated
| # TODO(mark) Move this closer to other silo code. | ||
| _fencing_counters[using] += 1 | ||
| # Deprecated shim for getsentry compatibility | ||
| from sentry.testutils.silo import unguarded_write |
There was a problem hiding this comment.
does this need the using = determine_using_by_silo_mode logic for split db still?
There was a problem hiding this comment.
Nevermind, it is captured inside the call.
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #52673 +/- ##
==========================================
+ Coverage 77.54% 79.39% +1.84%
==========================================
Files 4921 4922 +1
Lines 206673 206698 +25
Branches 35331 35340 +9
==========================================
+ Hits 160264 164100 +3836
+ Misses 41347 37573 -3774
+ Partials 5062 5025 -37
|
corps
approved these changes
Jul 11, 2023
markstory
added a commit
that referenced
this pull request
Jul 12, 2023
I'm having a hard time getting #52673 to pass CI because of getsentry dependencies. These changes add the new helpers to adopt query auditing instead of role swapping without touching role. My plan now is to get these changes merged, then update getsentry to use query auditing and then update sentry and remove role swapping.
dashed
approved these changes
Jul 12, 2023
markstory
added a commit
that referenced
this pull request
Jul 12, 2023
I'm having a hard time getting #52673 to pass CI because of getsentry dependencies. These changes add the new helpers to adopt query auditing instead of role swapping without touching role. My plan now is to get these changes merged, then update getsentry to use query auditing and then update sentry and remove role swapping.
GabeVillalobos
approved these changes
Jul 13, 2023
|
PR reverted: ace3ab5 |
markstory
added a commit
that referenced
this pull request
Jul 13, 2023
Mulligan on #52673 as using testutils code in application code blows up docker image generation. Because of that I've moved unguarded_write to sentry.silo instead.
michellewzhang
pushed a commit
that referenced
this pull request
Jul 13, 2023
) The role switching logic to catch write operations that are missing outboxes has been causing test flakiness and disrupting development workflows. These changes finish replacing role switching with query auditing that is done during test teardown. Switching to a teardown based audit means we can't give the precise location of where the bad operation was as the stack frames have been lost. However, we are able to show the offending query and its location in the SQL logs for a test.
mifu67
pushed a commit
that referenced
this pull request
Jul 13, 2023
) The role switching logic to catch write operations that are missing outboxes has been causing test flakiness and disrupting development workflows. These changes finish replacing role switching with query auditing that is done during test teardown. Switching to a teardown based audit means we can't give the precise location of where the bad operation was as the stack frames have been lost. However, we are able to show the offending query and its location in the SQL logs for a test.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The role switching logic to catch write operations that are missing outboxes has been causing test flakiness and disrupting development workflows.
These changes finish replacing role switching with query auditing that is done during test teardown. Switching to a teardown based audit means we can't give the precise location of where the bad operation was as the stack frames have been lost. However, we are able to show the offending query and its location in the SQL logs for a test.