ref(auto_source_config): Move logic around

[armenzg]

Changes included:

• Move some of the endpoint logic to the centralized location
• Create repository and platform modules

[armenzg]

I'm moving the test under tests.sentry.issues.auto_source_config, where all other related tests are located.

[armenzg]

The CodeMapping type contains all four variables I'm replacing it with.

[armenzg]

All the logic comes from the endpoint:
https://github.com/getsentry/sentry/blob/master/src/sentry/issues/endpoints/organization_derive_code_mappings.py

There are some minor changes I indicate below.

[armenzg]

Roughly equivalent to the original method:

sentry/src/sentry/issues/endpoints/organization_derive_code_mappings.py

Lines 55 to 78 in 88e21e7

	try:
	possible_code_mappings = []
	resp_status: Literal[200, 204, 400] = status.HTTP_400_BAD_REQUEST
	if stacktrace_filename:
	possible_code_mappings = derive_code_mappings(
	organization, {"filename": stacktrace_filename}, platform
	)
	if possible_code_mappings:
	resp_status = status.HTTP_200_OK
	else:
	resp_status = status.HTTP_204_NO_CONTENT
	return Response(serialize(possible_code_mappings), status=resp_status)
	except InstallationCannotGetTreesError:
	return self.respond(
	{"text": "The integration does not support getting trees"},
	status=status.HTTP_404_NOT_FOUND,
	)
	except InstallationNotFoundError:
	return self.respond(
	{"text": "Could not find this integration installed on your organization"},
	status=status.HTTP_404_NOT_FOUND,
	)

[armenzg]

The frontend currently only sends filename, however, we're going to need the other two values as well.

[armenzg]

This is new. It can be raised when get_frame_info_from_request gets called.

[armenzg]

Roughly equivalent to the original method:

sentry/src/sentry/issues/endpoints/organization_derive_code_mappings.py

Lines 93 to 129 in 88e21e7

	try:
	project = Project.objects.get(id=request.data.get("projectId"))
	except Project.DoesNotExist:
	return self.respond(
	{"text": "Could not find project"}, status=status.HTTP_404_NOT_FOUND
	)
	if not request.access.has_project_access(project):
	return self.respond(status=status.HTTP_403_FORBIDDEN)
	repo_name = request.data.get("repoName")
	stack_root = request.data.get("stackRoot")
	source_root = request.data.get("sourceRoot")
	branch = request.data.get("defaultBranch")
	if not repo_name or not stack_root or not source_root or not branch:
	return self.respond(
	{"text": "Missing required parameters"}, status=status.HTTP_400_BAD_REQUEST
	)
	try:
	new_code_mapping = create_code_mapping(
	organization, project, stack_root, source_root, repo_name, branch
	)
	except InstallationNotFoundError:
	return self.respond(
	{"text": "Could not find this integration installed on your organization"},
	status=status.HTTP_404_NOT_FOUND,
	)
	except InstallationCannotGetTreesError:
	return self.respond(
	{"text": "The integration does not support getting trees"},
	status=status.HTTP_404_NOT_FOUND,
	)
	return self.respond(
	serialize(new_code_mapping, request.user), status=status.HTTP_201_CREATED
	)

[armenzg]

Passing now code_mapping instead of the four parameters.

[armenzg]

We will need these values for Java calls.

[JoshFerge]

keeping all of the logic outside of the actual endpoint file is a pattern that i'd prefer not to do -- it's not something that we really do elsewhere in the codebase.

it makes sense to have:

• serialization
• pagination
• authorization
• query building, etc.

inside the endpoint. domain specific business logic can live in a helper folder, but passing the entire request to a helper function is unnecessary indirection and can introduce confusion

[codecov]

Codecov Report

Attention: Patch coverage is 89.04110% with 8 lines in your changes missing coverage. Please review.

✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
...ues/endpoints/organization_derive_code_mappings.py	71.42%	6 Missing ⚠️
...try/issues/auto_source_code_config/code_mapping.py	66.66%	1 Missing ⚠️
...urce_code_config/derived_code_mappings_endpoint.py	95.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           master   #88251       +/-   ##
===========================================
+ Coverage   46.48%   87.71%   +41.22%     
===========================================
  Files        9973     9992       +19     
  Lines      564383   565254      +871     
  Branches    22289    22289               
===========================================
+ Hits       262349   495806   +233457     
+ Misses     301599    69013   -232586     
  Partials      435      435               

[armenzg]

keeping all of the logic outside of the actual endpoint file is a pattern that i'd prefer not to do -- it's not something that we really do elsewhere in the codebase.

it makes sense to have:

• serialization
• pagination
• authorization
• query building, etc.

inside the endpoint. domain specific business logic can live in a helper folder, but passing the entire request to a helper function is unnecessary indirection and can introduce confusion

I have partially gone back. Let me know if you want more changes than that.

[armenzg]

This is a change rather than just a refactor because we have a bunch of user generated code mappings marked as automatically generated (which is not true).

[armenzg]

This is the behaviour change I mentioned earlier.

[armenzg]

All four values are now returned as an object in the call below: code_mapping = get_code_mapping_from_request(request)

[sentry-io]

Suspect Issues

This pull request was deployed and Sentry observed the following issues:

• ‼️ UnsupportedFrameInfo: This path is not supported. /api/0/organizations/{organization_id_or_slug}/... View Issue
• ‼️ MissingModuleOrAbsPath: Investigate why the data is missing. /api/0/organizations/{organization_id_or_slug}/... View Issue

_{Did you find this useful? React with a 👍 or 👎}