Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(derived_code_mappings): Add metric for creating a repository and dry_run mode #86387

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -589,7 +589,7 @@ def get_path_from_module(module: str, abs_path: str) -> tuple[str, str]:
raise DoesNotFollowJavaPackageNamingConvention

# If module has a dot, take everything before the last dot
# com.example.foo.Bar$InnerClass -> com/example/foo/
# com.example.foo.Bar$InnerClass -> com/example/foo
Copy link
Member Author

Choose a reason for hiding this comment

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

To match the code.

stack_root = module.rsplit(".", 1)[0].replace(".", "/")
file_path = f"{stack_root}/{abs_path}"

Expand Down
1 change: 1 addition & 0 deletions src/sentry/issues/auto_source_code_config/constants.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
METRIC_PREFIX = "auto_source_code_config"
SUPPORTED_INTEGRATIONS = ["github"]
# XXX: We may want to change these constants into a configuration object
# Any new languages should also require updating the stacktraceLink.tsx and repo_trees.py SUPPORTED_EXTENSIONS
Expand Down
68 changes: 47 additions & 21 deletions src/sentry/issues/auto_source_code_config/task.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
from sentry.utils import metrics
from sentry.utils.locking import UnableToAcquireLock

from .constants import METRIC_PREFIX
from .integration_utils import (
InstallationCannotGetTreesError,
InstallationNotFoundError,
Expand Down Expand Up @@ -79,8 +80,7 @@ def process_event(project_id: int, group_id: int, event_id: str) -> list[CodeMap
trees = get_trees_for_org(installation, org, extra)
trees_helper = CodeMappingTreesHelper(trees)
code_mappings = trees_helper.generate_code_mappings(frames_to_process, platform)
if not is_dry_run_platform(platform):
set_project_codemappings(code_mappings, installation, project, platform)
create_repos_and_code_mappings(code_mappings, installation, project, platform)
except (InstallationNotFoundError, InstallationCannotGetTreesError):
pass

Expand Down Expand Up @@ -157,7 +157,7 @@ def get_trees_for_org(
return trees


def set_project_codemappings(
def create_repos_and_code_mappings(
code_mappings: list[CodeMapping],
installation: IntegrationInstallation,
project: Project,
Expand All @@ -167,6 +167,7 @@ def set_project_codemappings(
Given a list of code mappings, create a new repository project path
config for each mapping.
"""
dry_run = is_dry_run_platform(platform)
organization_integration = installation.org_integration
if not organization_integration:
raise InstallationNotFoundError
Expand All @@ -180,25 +181,50 @@ def set_project_codemappings(
)

if not repository:
repository = Repository.objects.create(
name=code_mapping.repo.name,
organization_id=organization_id,
if not dry_run:
repository = Repository.objects.create(
name=code_mapping.repo.name,
organization_id=organization_id,
integration_id=organization_integration.integration_id,
)
metrics.incr(
key=f"{METRIC_PREFIX}.repository.created",
tags={"platform": platform, "dry_run": dry_run},
sample_rate=1.0,
)

extra = {
"project_id": project.id,
"stack_root": code_mapping.stacktrace_root,
"repository_name": code_mapping.repo.name,
}
# The project and stack_root are unique together
existing_code_mappings = RepositoryProjectPathConfig.objects.filter(
project=project, stack_root=code_mapping.stacktrace_root
)
if existing_code_mappings.exists():
logger.warning("Investigate.", extra=extra)
Copy link
Member Author

Choose a reason for hiding this comment

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

This should never happen, thus, logging to Sentry.

continue

if not dry_run:
if repository is None: # This is mostly to appease the type checker
logger.warning("Investigate.", extra=extra)
continue

RepositoryProjectPathConfig.objects.create(
project=project,
stack_root=code_mapping.stacktrace_root,
repository=repository,
organization_integration_id=organization_integration.id,
integration_id=organization_integration.integration_id,
organization_id=organization_integration.organization_id,
source_root=code_mapping.source_path,
default_branch=code_mapping.repo.branch,
automatically_generated=True,
)

_, created = RepositoryProjectPathConfig.objects.get_or_create(
project=project,
stack_root=code_mapping.stacktrace_root,
defaults={
"repository": repository,
"organization_integration_id": organization_integration.id,
"integration_id": organization_integration.integration_id,
"organization_id": organization_integration.organization_id,
"source_root": code_mapping.source_path,
"default_branch": code_mapping.repo.branch,
"automatically_generated": True,
},
metrics.incr(
key=f"{METRIC_PREFIX}.code_mapping.created",
tags={"platform": platform, "dry_run": dry_run},
Copy link
Member Author

Choose a reason for hiding this comment

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

We're assuming that in dry run mode, it would have created the record.

sample_rate=1.0,
)
if created:
# Since it is a low volume event, we can sample at 100%
metrics.incr(key="code_mappings.created", tags={"platform": platform}, sample_rate=1.0)
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@
from sentry.integrations.models.repository_project_path_config import RepositoryProjectPathConfig
from sentry.integrations.source_code_management.repo_trees import RepoAndBranch, RepoTree
from sentry.issues.auto_source_code_config.code_mapping import CodeMapping
from sentry.issues.auto_source_code_config.constants import METRIC_PREFIX
from sentry.issues.auto_source_code_config.integration_utils import InstallationNotFoundError
from sentry.issues.auto_source_code_config.task import DeriveCodeMappingsErrorReason, process_event
from sentry.issues.auto_source_code_config.utils import is_dry_run_platform
from sentry.models.repository import Repository
from sentry.shared_integrations.exceptions import ApiError
from sentry.testutils.asserts import assert_failure_metric, assert_halt_metric
Expand Down Expand Up @@ -78,8 +80,17 @@ def _process_and_assert_code_mapping(
code_mapping = code_mappings[0]
assert code_mapping.stack_root == expected_stack_root
assert code_mapping.source_root == expected_source_root
mock_incr.assert_called_with(
key="code_mappings.created", tags={"platform": event.platform}, sample_rate=1.0
dry_run = is_dry_run_platform(platform)
# Check that both metrics were called with any order
mock_incr.assert_any_call(
key=f"{METRIC_PREFIX}.code_mapping.created",
tags={"dry_run": dry_run, "platform": event.platform},
sample_rate=1.0,
)
mock_incr.assert_any_call(
key=f"{METRIC_PREFIX}.repository.created",
tags={"dry_run": dry_run, "platform": event.platform},
sample_rate=1.0,
)

def _process_and_assert_no_code_mapping(
Expand All @@ -93,10 +104,24 @@ def _process_and_assert_no_code_mapping(
patch(f"{CLIENT}.get_tree", return_value=self._repo_tree_files(repo_files)),
patch(f"{CLIENT}.get_remaining_api_requests", return_value=500),
patch(REPO_TREES_GET_REPOS, return_value=[self._repo_info()]),
patch("sentry.utils.metrics.incr") as mock_incr,
):
event = self.create_event(frames, platform)
code_mappings = process_event(self.project.id, event.group_id, event.event_id)
assert not RepositoryProjectPathConfig.objects.exists()
dry_run = is_dry_run_platform(platform)
if code_mappings:
# Check that both metrics were called with any order
mock_incr.assert_any_call(
key=f"{METRIC_PREFIX}.repository.created",
tags={"platform": event.platform, "dry_run": dry_run},
sample_rate=1.0,
)
mock_incr.assert_any_call(
key=f"{METRIC_PREFIX}.code_mapping.created",
tags={"platform": event.platform, "dry_run": dry_run},
sample_rate=1.0,
)
return code_mappings

def frame(self, filename: str, in_app: bool | None = True) -> dict[str, str | bool]:
Expand Down Expand Up @@ -179,15 +204,17 @@ def test_handle_existing_code_mapping(self) -> None:
def test_dry_run_platform(self) -> None:
frame_filename = "foo/bar.py"
file_in_repo = "src/foo/bar.py"
platform = "other"
with (
patch(f"{CODE_ROOT}.task.supported_platform", return_value=True),
patch(f"{CODE_ROOT}.task.is_dry_run_platform", return_value=True),
override_options({"issues.auto_source_code_config.dry-run-platforms": [platform]}),
):
# No code mapping will be stored, however, we get what would have been created
code_mappings = self._process_and_assert_no_code_mapping(
repo_files=[file_in_repo],
frames=[self.frame(frame_filename, True)],
platform="other",
platform=platform,
)
assert len(code_mappings) == 1
assert code_mappings[0].stacktrace_root == "foo/"
Expand Down
Loading