fix(aws-lambda): Fix bug for initial handler path (#1139)

* fix(aws-lambda): Fix bug for initial handler path Adds support for long initial handler paths in the format of `x.y.z` and dir paths in the format of `x/y.z`

Author: ahmedetefy

scripts/init_serverless_sdk.py

@@ -6,6 +6,8 @@
 'sentry_sdk.integrations.init_serverless_sdk.sentry_lambda_handler'
 """
 import os
+import sys
+import re
 
 import sentry_sdk
 from sentry_sdk._types import MYPY
@@ -23,16 +25,53 @@
 )
 
 
+class AWSLambdaModuleLoader:
+ DIR_PATH_REGEX = r"^(.+)\/([^\/]+)$"
+
+ def __init__(self, sentry_initial_handler):
+ try:
+ module_path, self.handler_name = sentry_initial_handler.rsplit(".", 1)
+ except ValueError:
+ raise ValueError("Incorrect AWS Handler path (Not a path)")
+
+ self.extract_and_load_lambda_function_module(module_path)
+
+ def extract_and_load_lambda_function_module(self, module_path):
+ """
+ Method that extracts and loads lambda function module from module_path
+ """
+ py_version = sys.version_info
+
+ if re.match(self.DIR_PATH_REGEX, module_path):
+ # With a path like -> `scheduler/scheduler/event`
+ # `module_name` is `event`, and `module_file_path` is `scheduler/scheduler/event.py`
+ module_name = module_path.split(os.path.sep)[-1]
+ module_file_path = module_path + ".py"
+
+ # Supported python versions are 2.7, 3.6, 3.7, 3.8
+ if py_version >= (3, 5):
+ import importlib.util
+ spec = importlib.util.spec_from_file_location(module_name, module_file_path)
+ self.lambda_function_module = importlib.util.module_from_spec(spec)
+ spec.loader.exec_module(self.lambda_function_module)
+ elif py_version[0] < 3:
+ import imp
+ self.lambda_function_module = imp.load_source(module_name, module_file_path)
+ else:
+ raise ValueError("Python version %s is not supported." % py_version)
+ else:
+ import importlib
+ self.lambda_function_module = importlib.import_module(module_path)
+
+ def get_lambda_handler(self):
+ return getattr(self.lambda_function_module, self.handler_name)
+
+
 def sentry_lambda_handler(event, context):
  # type: (Any, Any) -> None
  """
  Handler function that invokes a lambda handler which path is defined in
- environment vairables as "SENTRY_INITIAL_HANDLER"
+ environment variables as "SENTRY_INITIAL_HANDLER"
  """
- try:
- module_name, handler_name = os.environ["SENTRY_INITIAL_HANDLER"].rsplit(".", 1)
- except ValueError:
- raise ValueError("Incorrect AWS Handler path (Not a path)")
- lambda_function = __import__(module_name)
- lambda_handler = getattr(lambda_function, handler_name)
- return lambda_handler(event, context)
+ module_loader = AWSLambdaModuleLoader(os.environ["SENTRY_INITIAL_HANDLER"])
+ return module_loader.get_lambda_handler()(event, context)

tests/integrations/aws_lambda/client.py

@@ -18,7 +18,7 @@ def get_boto_client():
 
 
 def build_no_code_serverless_function_and_layer(
- client, tmpdir, fn_name, runtime, timeout
+ client, tmpdir, fn_name, runtime, timeout, initial_handler
 ):
  """
  Util function that auto instruments the no code implementation of the python
@@ -45,7 +45,7 @@ def build_no_code_serverless_function_and_layer(
  Timeout=timeout,
  Environment={
  "Variables": {
- "SENTRY_INITIAL_HANDLER": "test_lambda.test_handler",
+ "SENTRY_INITIAL_HANDLER": initial_handler,
  "SENTRY_DSN": "https://123abc@example.com/123",
  "SENTRY_TRACES_SAMPLE_RATE": "1.0",
  }
@@ -67,12 +67,27 @@ def run_lambda_function(
  syntax_check=True,
  timeout=30,
  layer=None,
+ initial_handler=None,
  subprocess_kwargs=(),
 ):
  subprocess_kwargs = dict(subprocess_kwargs)
 
  with tempfile.TemporaryDirectory() as tmpdir:
- test_lambda_py = os.path.join(tmpdir, "test_lambda.py")
+ if initial_handler:
+ # If Initial handler value is provided i.e. it is not the default
+ # `test_lambda.test_handler`, then create another dir level so that our path is
+ # test_dir.test_lambda.test_handler
+ test_dir_path = os.path.join(tmpdir, "test_dir")
+ python_init_file = os.path.join(test_dir_path, "__init__.py")
+ os.makedirs(test_dir_path)
+ with open(python_init_file, "w"):
+ # Create __init__ file to make it a python package
+ pass
+
+ test_lambda_py = os.path.join(tmpdir, "test_dir", "test_lambda.py")
+ else:
+ test_lambda_py = os.path.join(tmpdir, "test_lambda.py")
+
  with open(test_lambda_py, "w") as f:
  f.write(code)
 
@@ -127,8 +142,13 @@ def run_lambda_function(
  cwd=tmpdir,
  check=True,
  )
+
+ # Default initial handler
+ if not initial_handler:
+ initial_handler = "test_lambda.test_handler"
+
  build_no_code_serverless_function_and_layer(
- client, tmpdir, fn_name, runtime, timeout
+ client, tmpdir, fn_name, runtime, timeout, initial_handler
  )
 
  @add_finalizer

tests/integrations/aws_lambda/test_aws.py

@@ -112,7 +112,9 @@ def lambda_runtime(request):
 
 @pytest.fixture
 def run_lambda_function(request, lambda_client, lambda_runtime):
- def inner(code, payload, timeout=30, syntax_check=True, layer=None):
+ def inner(
+ code, payload, timeout=30, syntax_check=True, layer=None, initial_handler=None
+ ):
  from tests.integrations.aws_lambda.client import run_lambda_function
 
  response = run_lambda_function(
@@ -124,6 +126,7 @@ def inner(code, payload, timeout=30, syntax_check=True, layer=None):
  timeout=timeout,
  syntax_check=syntax_check,
  layer=layer,
+ initial_handler=initial_handler,
  )
 
  # for better debugging
@@ -621,32 +624,39 @@ def test_serverless_no_code_instrumentation(run_lambda_function):
  python sdk, with no code changes sentry is able to capture errors
  """
 
- _, _, response = run_lambda_function(
- dedent(
- """
- import sentry_sdk
+ for initial_handler in [
+ None,
+ "test_dir/test_lambda.test_handler",
+ "test_dir.test_lambda.test_handler",
+ ]:
+ print("Testing Initial Handler ", initial_handler)
+ _, _, response = run_lambda_function(
+ dedent(
+ """
+ import sentry_sdk
 
- def test_handler(event, context):
- current_client = sentry_sdk.Hub.current.client
+  def test_handler(event, context):
+  current_client = sentry_sdk.Hub.current.client
 
- assert current_client is not None
+  assert current_client is not None
 
- assert len(current_client.options['integrations']) == 1
- assert isinstance(current_client.options['integrations'][0],
- sentry_sdk.integrations.aws_lambda.AwsLambdaIntegration)
+  assert len(current_client.options['integrations']) == 1
+  assert isinstance(current_client.options['integrations'][0],
+  sentry_sdk.integrations.aws_lambda.AwsLambdaIntegration)
 
- raise Exception("something went wrong")
- """
- ),
- b'{"foo": "bar"}',
- layer=True,
- )
- assert response["FunctionError"] == "Unhandled"
- assert response["StatusCode"] == 200
+ raise Exception("something went wrong")
+ """
+ ),
+ b'{"foo": "bar"}',
+ layer=True,
+ initial_handler=initial_handler,
+ )
+ assert response["FunctionError"] == "Unhandled"
+ assert response["StatusCode"] == 200
 
- assert response["Payload"]["errorType"] != "AssertionError"
+  assert response["Payload"]["errorType"] != "AssertionError"
 
- assert response["Payload"]["errorType"] == "Exception"
- assert response["Payload"]["errorMessage"] == "something went wrong"
+  assert response["Payload"]["errorType"] == "Exception"
+  assert response["Payload"]["errorMessage"] == "something went wrong"
 
- assert "sentry_handler" in response["LogResult"][3].decode("utf-8")
+  assert "sentry_handler" in response["LogResult"][3].decode("utf-8")

tests/integrations/django/myapp/settings.py

@@ -157,7 +157,7 @@ def middleware(request):
 
 USE_L10N = True
 
-USE_TZ = True
+USE_TZ = False
 
 TEMPLATE_DEBUG = True