From 19a72911223c44543fe5b5bf5c9cb44118a45848 Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Tue, 7 Oct 2025 10:57:04 -0700 Subject: [PATCH 001/124] Add response token count logic to Gemini instrumentation. (#1486) * Add response token count logic to Gemini instrumentation. * Update token counting util functions. * Linting * Add response token count logic to Gemini instrumentation. * Update token counting util functions. * [MegaLinter] Apply linters fixes * Bump tests. --------- Co-authored-by: Tim Pansino --- newrelic/hooks/mlmodel_gemini.py | 152 ++++++++++++------ tests/mlmodel_gemini/test_embeddings.py | 6 +- tests/mlmodel_gemini/test_embeddings_error.py | 62 +------ tests/mlmodel_gemini/test_text_generation.py | 12 +- .../test_text_generation_error.py | 81 +--------- tests/testing_support/ml_testing_utils.py | 19 +++ 6 files changed, 139 insertions(+), 193 deletions(-) diff --git a/newrelic/hooks/mlmodel_gemini.py b/newrelic/hooks/mlmodel_gemini.py index 8aeb1355d0..6f61c11125 100644 --- a/newrelic/hooks/mlmodel_gemini.py +++ b/newrelic/hooks/mlmodel_gemini.py @@ -175,20 +175,24 @@ def _record_embedding_success(transaction, embedding_id, linking_metadata, kwarg embedding_content = str(embedding_content) request_model = kwargs.get("model") + embedding_token_count = ( + settings.ai_monitoring.llm_token_count_callback(request_model, embedding_content) + if settings.ai_monitoring.llm_token_count_callback + else None + ) + full_embedding_response_dict = { "id": embedding_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(request_model, embedding_content) - if settings.ai_monitoring.llm_token_count_callback - else None - ), "request.model": request_model, "duration": ft.duration * 1000, "vendor": "gemini", "ingest_source": "Python", } + if embedding_token_count: + full_embedding_response_dict["response.usage.total_tokens"] = embedding_token_count + if settings.ai_monitoring.record_content.enabled: full_embedding_response_dict["input"] = embedding_content @@ -300,15 +304,13 @@ def _record_generation_error(transaction, linking_metadata, completion_id, kwarg "Unable to parse input message to Gemini LLM. Message content and role will be omitted from " "corresponding LlmChatCompletionMessage event. " ) + # Extract the input message content and role from the input message if it exists + input_message_content, input_role = _parse_input_message(input_message) if input_message else (None, None) - generation_config = kwargs.get("config") - if generation_config: - request_temperature = getattr(generation_config, "temperature", None) - request_max_tokens = getattr(generation_config, "max_output_tokens", None) - else: - request_temperature = None - request_max_tokens = None + # Extract data from generation config object + request_temperature, request_max_tokens = _extract_generation_config(kwargs) + # Prepare error attributes notice_error_attributes = { "http.statusCode": getattr(exc, "code", None), "error.message": getattr(exc, "message", None), @@ -348,15 +350,17 @@ def _record_generation_error(transaction, linking_metadata, completion_id, kwarg create_chat_completion_message_event( transaction, - input_message, + input_message_content, + input_role, completion_id, span_id, trace_id, # Passing the request model as the response model here since we do not have access to a response model request_model, - request_model, llm_metadata, output_message_list, + # We do not record token counts in error cases, so set all_token_counts to True so the pipeline tokenizer does not run + all_token_counts=True, ) except Exception: _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) @@ -377,6 +381,7 @@ def _handle_generation_success(transaction, linking_metadata, completion_id, kwa def _record_generation_success(transaction, linking_metadata, completion_id, kwargs, ft, response): + settings = transaction.settings or global_settings() span_id = linking_metadata.get("span.id") trace_id = linking_metadata.get("trace.id") try: @@ -385,12 +390,14 @@ def _record_generation_success(transaction, linking_metadata, completion_id, kwa # finish_reason is an enum, so grab just the stringified value from it to report finish_reason = response.get("candidates")[0].get("finish_reason").value output_message_list = [response.get("candidates")[0].get("content")] + token_usage = response.get("usage_metadata") or {} else: # Set all values to NoneTypes since we cannot access them through kwargs or another method that doesn't # require the response object response_model = None output_message_list = [] finish_reason = None + token_usage = {} request_model = kwargs.get("model") @@ -412,13 +419,44 @@ def _record_generation_success(transaction, linking_metadata, completion_id, kwa "corresponding LlmChatCompletionMessage event. " ) - generation_config = kwargs.get("config") - if generation_config: - request_temperature = getattr(generation_config, "temperature", None) - request_max_tokens = getattr(generation_config, "max_output_tokens", None) + input_message_content, input_role = _parse_input_message(input_message) if input_message else (None, None) + + # Parse output message content + # This list should have a length of 1 to represent the output message + # Parse the message text out to pass to any registered token counting callback + output_message_content = output_message_list[0].get("parts")[0].get("text") if output_message_list else None + + # Extract token counts from response object + if token_usage: + response_prompt_tokens = token_usage.get("prompt_token_count") + response_completion_tokens = token_usage.get("candidates_token_count") + response_total_tokens = token_usage.get("total_token_count") + else: - request_temperature = None - request_max_tokens = None + response_prompt_tokens = None + response_completion_tokens = None + response_total_tokens = None + + # Calculate token counts by checking if a callback is registered and if we have the necessary content to pass + # to it. If not, then we use the token counts provided in the response object + prompt_tokens = ( + settings.ai_monitoring.llm_token_count_callback(request_model, input_message_content) + if settings.ai_monitoring.llm_token_count_callback and input_message_content + else response_prompt_tokens + ) + completion_tokens = ( + settings.ai_monitoring.llm_token_count_callback(response_model, output_message_content) + if settings.ai_monitoring.llm_token_count_callback and output_message_content + else response_completion_tokens + ) + total_tokens = ( + prompt_tokens + completion_tokens if all([prompt_tokens, completion_tokens]) else response_total_tokens + ) + + all_token_counts = bool(prompt_tokens and completion_tokens and total_tokens) + + # Extract generation config + request_temperature, request_max_tokens = _extract_generation_config(kwargs) full_chat_completion_summary_dict = { "id": completion_id, @@ -438,66 +476,78 @@ def _record_generation_success(transaction, linking_metadata, completion_id, kwa "response.number_of_messages": 1 + len(output_message_list), } + if all_token_counts: + full_chat_completion_summary_dict["response.usage.prompt_tokens"] = prompt_tokens + full_chat_completion_summary_dict["response.usage.completion_tokens"] = completion_tokens + full_chat_completion_summary_dict["response.usage.total_tokens"] = total_tokens + llm_metadata = _get_llm_attributes(transaction) full_chat_completion_summary_dict.update(llm_metadata) transaction.record_custom_event("LlmChatCompletionSummary", full_chat_completion_summary_dict) create_chat_completion_message_event( transaction, - input_message, + input_message_content, + input_role, completion_id, span_id, trace_id, response_model, - request_model, llm_metadata, output_message_list, + all_token_counts, ) except Exception: _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) +def _parse_input_message(input_message): + # The input_message will be a string if generate_content was called directly. In this case, we don't have + # access to the role, so we default to user since this was an input message + if isinstance(input_message, str): + return input_message, "user" + # The input_message will be a Google Content type if send_message was called, so we parse out the message + # text and role (which should be "user") + elif isinstance(input_message, google.genai.types.Content): + return input_message.parts[0].text, input_message.role + else: + return None, None + + +def _extract_generation_config(kwargs): + generation_config = kwargs.get("config") + if generation_config: + request_temperature = getattr(generation_config, "temperature", None) + request_max_tokens = getattr(generation_config, "max_output_tokens", None) + else: + request_temperature = None + request_max_tokens = None + + return request_temperature, request_max_tokens + + def create_chat_completion_message_event( transaction, - input_message, + input_message_content, + input_role, chat_completion_id, span_id, trace_id, response_model, - request_model, llm_metadata, output_message_list, + all_token_counts, ): try: settings = transaction.settings or global_settings() - if input_message: - # The input_message will be a string if generate_content was called directly. In this case, we don't have - # access to the role, so we default to user since this was an input message - if isinstance(input_message, str): - input_message_content = input_message - input_role = "user" - # The input_message will be a Google Content type if send_message was called, so we parse out the message - # text and role (which should be "user") - elif isinstance(input_message, google.genai.types.Content): - input_message_content = input_message.parts[0].text - input_role = input_message.role - # Set input data to NoneTypes to ensure token_count callback is not called - else: - input_message_content = None - input_role = None - + if input_message_content: message_id = str(uuid.uuid4()) chat_completion_input_message_dict = { "id": message_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(request_model, input_message_content) - if settings.ai_monitoring.llm_token_count_callback and input_message_content - else None - ), "role": input_role, "completion_id": chat_completion_id, # The input message will always be the first message in our request/ response sequence so this will @@ -507,6 +557,8 @@ def create_chat_completion_message_event( "vendor": "gemini", "ingest_source": "Python", } + if all_token_counts: + chat_completion_input_message_dict["token_count"] = 0 if settings.ai_monitoring.record_content.enabled: chat_completion_input_message_dict["content"] = input_message_content @@ -523,7 +575,7 @@ def create_chat_completion_message_event( # Add one to the index to account for the single input message so our sequence value is accurate for # the output message - if input_message: + if input_message_content: index += 1 message_id = str(uuid.uuid4()) @@ -532,11 +584,6 @@ def create_chat_completion_message_event( "id": message_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(response_model, message_content) - if settings.ai_monitoring.llm_token_count_callback - else None - ), "role": message.get("role"), "completion_id": chat_completion_id, "sequence": index, @@ -546,6 +593,9 @@ def create_chat_completion_message_event( "is_response": True, } + if all_token_counts: + chat_completion_output_message_dict["token_count"] = 0 + if settings.ai_monitoring.record_content.enabled: chat_completion_output_message_dict["content"] = message_content diff --git a/tests/mlmodel_gemini/test_embeddings.py b/tests/mlmodel_gemini/test_embeddings.py index 0fc92897b6..5b4e30f860 100644 --- a/tests/mlmodel_gemini/test_embeddings.py +++ b/tests/mlmodel_gemini/test_embeddings.py @@ -15,7 +15,7 @@ import google.genai from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_to_embedding_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -93,7 +93,7 @@ def test_gemini_embedding_sync_no_content(gemini_dev_client, set_trace_info): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(embedding_recorded_events)) +@validate_custom_events(add_token_count_to_embedding_events(embedding_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_embeddings:test_gemini_embedding_sync_with_token_count", @@ -177,7 +177,7 @@ def test_gemini_embedding_async_no_content(gemini_dev_client, loop, set_trace_in @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(embedding_recorded_events)) +@validate_custom_events(add_token_count_to_embedding_events(embedding_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_embeddings:test_gemini_embedding_async_with_token_count", diff --git a/tests/mlmodel_gemini/test_embeddings_error.py b/tests/mlmodel_gemini/test_embeddings_error.py index a65a6c2c6f..f0e7aac58a 100644 --- a/tests/mlmodel_gemini/test_embeddings_error.py +++ b/tests/mlmodel_gemini/test_embeddings_error.py @@ -16,12 +16,10 @@ import google.genai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -159,34 +157,6 @@ def test_embeddings_invalid_request_error_invalid_model(gemini_dev_client, set_t gemini_dev_client.models.embed_content(contents="Embedded: Model does not exist.", model="does-not-exist") -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(google.genai.errors.ClientError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "NOT_FOUND", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={ - "error.message": "models/does-not-exist is not found for API version v1beta, or is not supported for embedContent. Call ListModels to see the list of available models and their supported methods." - } -) -@validate_transaction_metrics( - name="test_embeddings_error:test_embeddings_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/embedding/Gemini/embed_content", 1)], - rollup_metrics=[("Llm/embedding/Gemini/embed_content", 1)], - custom_metrics=[(f"Supportability/Python/ML/Gemini/{google.genai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_with_token_count(gemini_dev_client, set_trace_info): - with pytest.raises(google.genai.errors.ClientError): - set_trace_info() - gemini_dev_client.models.embed_content(contents="Embedded: Model does not exist.", model="does-not-exist") - - embedding_invalid_key_error_events = [ ( {"type": "LlmEmbedding"}, @@ -326,36 +296,6 @@ def test_embeddings_async_invalid_request_error_invalid_model(gemini_dev_client, ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(google.genai.errors.ClientError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "NOT_FOUND", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={ - "error.message": "models/does-not-exist is not found for API version v1beta, or is not supported for embedContent. Call ListModels to see the list of available models and their supported methods." - } -) -@validate_transaction_metrics( - name="test_embeddings_error:test_embeddings_async_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/embedding/Gemini/embed_content", 1)], - rollup_metrics=[("Llm/embedding/Gemini/embed_content", 1)], - custom_metrics=[(f"Supportability/Python/ML/Gemini/{google.genai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_async_invalid_request_error_invalid_model_with_token_count(gemini_dev_client, loop, set_trace_info): - with pytest.raises(google.genai.errors.ClientError): - set_trace_info() - loop.run_until_complete( - gemini_dev_client.models.embed_content(contents="Embedded: Model does not exist.", model="does-not-exist") - ) - - # Wrong api_key provided @dt_enabled @reset_core_stats_engine() diff --git a/tests/mlmodel_gemini/test_text_generation.py b/tests/mlmodel_gemini/test_text_generation.py index faec66aa75..3da978e777 100644 --- a/tests/mlmodel_gemini/test_text_generation.py +++ b/tests/mlmodel_gemini/test_text_generation.py @@ -15,7 +15,7 @@ import google.genai from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -50,6 +50,9 @@ "vendor": "gemini", "ingest_source": "Python", "response.number_of_messages": 2, + "response.usage.prompt_tokens": 9, + "response.usage.completion_tokens": 13, + "response.usage.total_tokens": 22, }, ), ( @@ -60,6 +63,7 @@ "llm.foo": "bar", "span_id": None, "trace_id": "trace-id", + "token_count": 0, "content": "How many letters are in the word Python?", "role": "user", "completion_id": None, @@ -77,6 +81,7 @@ "llm.foo": "bar", "span_id": None, "trace_id": "trace-id", + "token_count": 0, "content": 'There are **6** letters in the word "Python".\n', "role": "model", "completion_id": None, @@ -183,7 +188,8 @@ def test_gemini_text_generation_sync_no_content(gemini_dev_client, set_trace_inf @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(text_generation_recorded_events)) +# Ensure LLM callback is invoked and response token counts are overridden +@validate_custom_events(add_token_counts_to_chat_events(text_generation_recorded_events)) @validate_custom_event_count(count=3) @validate_transaction_metrics( name="test_text_generation:test_gemini_text_generation_sync_with_token_count", @@ -324,7 +330,7 @@ def test_gemini_text_generation_async_no_content(gemini_dev_client, loop, set_tr @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(text_generation_recorded_events)) +@validate_custom_events(add_token_counts_to_chat_events(text_generation_recorded_events)) @validate_custom_event_count(count=3) @validate_transaction_metrics( name="test_text_generation:test_gemini_text_generation_async_with_token_count", diff --git a/tests/mlmodel_gemini/test_text_generation_error.py b/tests/mlmodel_gemini/test_text_generation_error.py index 5e6f1c04de..c92e1a2d45 100644 --- a/tests/mlmodel_gemini/test_text_generation_error.py +++ b/tests/mlmodel_gemini/test_text_generation_error.py @@ -17,13 +17,11 @@ import google.genai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, events_with_context_attrs, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -63,6 +61,7 @@ "trace_id": "trace-id", "content": "How many letters are in the word Python?", "role": "user", + "token_count": 0, "completion_id": None, "sequence": 0, "vendor": "gemini", @@ -167,6 +166,7 @@ def _test(): "trace_id": "trace-id", "content": "Model does not exist.", "role": "user", + "token_count": 0, "completion_id": None, "response.model": "does-not-exist", "sequence": 0, @@ -179,39 +179,6 @@ def _test(): @dt_enabled @reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(google.genai.errors.ClientError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "NOT_FOUND", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={ - "error.message": "models/does-not-exist is not found for API version v1beta, or is not supported for generateContent. Call ListModels to see the list of available models and their supported methods." - } -) -@validate_transaction_metrics( - "test_text_generation_error:test_text_generation_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/completion/Gemini/generate_content", 1)], - rollup_metrics=[("Llm/completion/Gemini/generate_content", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_text_generation_invalid_request_error_invalid_model_with_token_count(gemini_dev_client, set_trace_info): - with pytest.raises(google.genai.errors.ClientError): - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - gemini_dev_client.models.generate_content( - model="does-not-exist", - contents=["Model does not exist."], - config=google.genai.types.GenerateContentConfig(max_output_tokens=100, temperature=0.7), - ) - - -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) @validate_error_trace_attributes( callable_name(google.genai.errors.ClientError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "NOT_FOUND", "http.statusCode": 404}}, @@ -227,7 +194,7 @@ def test_text_generation_invalid_request_error_invalid_model_with_token_count(ge rollup_metrics=[("Llm/completion/Gemini/generate_content", 1)], background_task=True, ) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) +@validate_custom_events(expected_events_on_invalid_model_error) @validate_custom_event_count(count=2) @background_task() def test_text_generation_invalid_request_error_invalid_model_chat(gemini_dev_client, set_trace_info): @@ -266,6 +233,7 @@ def test_text_generation_invalid_request_error_invalid_model_chat(gemini_dev_cli "trace_id": "trace-id", "content": "Invalid API key.", "role": "user", + "token_count": 0, "response.model": "gemini-flash-2.0", "completion_id": None, "sequence": 0, @@ -377,43 +345,6 @@ def _test(): @dt_enabled @reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(google.genai.errors.ClientError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "NOT_FOUND", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={ - "error.message": "models/does-not-exist is not found for API version v1beta, or is not supported for generateContent. Call ListModels to see the list of available models and their supported methods." - } -) -@validate_transaction_metrics( - "test_text_generation_error:test_text_generation_async_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/completion/Gemini/generate_content", 1)], - rollup_metrics=[("Llm/completion/Gemini/generate_content", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_text_generation_async_invalid_request_error_invalid_model_with_token_count( - gemini_dev_client, loop, set_trace_info -): - with pytest.raises(google.genai.errors.ClientError): - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - loop.run_until_complete( - gemini_dev_client.models.generate_content( - model="does-not-exist", - contents=["Model does not exist."], - config=google.genai.types.GenerateContentConfig(max_output_tokens=100, temperature=0.7), - ) - ) - - -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) @validate_error_trace_attributes( callable_name(google.genai.errors.ClientError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "NOT_FOUND", "http.statusCode": 404}}, @@ -429,7 +360,7 @@ def test_text_generation_async_invalid_request_error_invalid_model_with_token_co rollup_metrics=[("Llm/completion/Gemini/generate_content", 1)], background_task=True, ) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) +@validate_custom_events(expected_events_on_invalid_model_error) @validate_custom_event_count(count=2) @background_task() def test_text_generation_async_invalid_request_error_invalid_model_chat(gemini_dev_client, loop, set_trace_info): diff --git a/tests/testing_support/ml_testing_utils.py b/tests/testing_support/ml_testing_utils.py index 4ff70c7ed4..55dbd08105 100644 --- a/tests/testing_support/ml_testing_utils.py +++ b/tests/testing_support/ml_testing_utils.py @@ -29,6 +29,7 @@ def llm_token_count_callback(model, content): return 105 +# This will be removed once all LLM instrumentations have been converted to use new token count design def add_token_count_to_events(expected_events): events = copy.deepcopy(expected_events) for event in events: @@ -37,6 +38,24 @@ def add_token_count_to_events(expected_events): return events +def add_token_count_to_embedding_events(expected_events): + events = copy.deepcopy(expected_events) + for event in events: + if event[0]["type"] == "LlmEmbedding": + event[1]["response.usage.total_tokens"] = 105 + return events + + +def add_token_counts_to_chat_events(expected_events): + events = copy.deepcopy(expected_events) + for event in events: + if event[0]["type"] == "LlmChatCompletionSummary": + event[1]["response.usage.prompt_tokens"] = 105 + event[1]["response.usage.completion_tokens"] = 105 + event[1]["response.usage.total_tokens"] = 210 + return events + + def events_sans_content(event): new_event = copy.deepcopy(event) for _event in new_event: From 7d5adac309d46d8d97a29b94c3c3bb51fbf8fe81 Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Tue, 7 Oct 2025 13:14:56 -0700 Subject: [PATCH 002/124] Add response token count logic to OpenAI instrumentation. (#1498) * Add OpenAI token counts. * Add token counts to langchain + openai tests. * Remove unused expected events. * Linting * Add OpenAI token counts. * Add token counts to langchain + openai tests. * Remove unused expected events. * [MegaLinter] Apply linters fixes --------- Co-authored-by: Tim Pansino --- newrelic/hooks/mlmodel_openai.py | 87 ++++++++--- tests/mlmodel_langchain/test_chain.py | 8 + tests/mlmodel_openai/test_chat_completion.py | 12 +- .../test_chat_completion_error.py | 71 +-------- .../test_chat_completion_error_v1.py | 142 +----------------- .../test_chat_completion_stream.py | 101 ++++++++++++- .../test_chat_completion_stream_error.py | 75 +-------- .../test_chat_completion_stream_error_v1.py | 80 +--------- .../test_chat_completion_stream_v1.py | 11 +- .../mlmodel_openai/test_chat_completion_v1.py | 12 +- tests/mlmodel_openai/test_embeddings.py | 7 +- .../test_embeddings_error_v1.py | 120 +-------------- tests/mlmodel_openai/test_embeddings_v1.py | 7 +- tests/testing_support/ml_testing_utils.py | 8 + 14 files changed, 241 insertions(+), 500 deletions(-) diff --git a/newrelic/hooks/mlmodel_openai.py b/newrelic/hooks/mlmodel_openai.py index c3f7960b6e..3484762951 100644 --- a/newrelic/hooks/mlmodel_openai.py +++ b/newrelic/hooks/mlmodel_openai.py @@ -129,11 +129,11 @@ def create_chat_completion_message_event( span_id, trace_id, response_model, - request_model, response_id, request_id, llm_metadata, output_message_list, + all_token_counts, ): settings = transaction.settings if transaction.settings is not None else global_settings() @@ -153,11 +153,6 @@ def create_chat_completion_message_event( "request_id": request_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(request_model, message_content) - if settings.ai_monitoring.llm_token_count_callback - else None - ), "role": message.get("role"), "completion_id": chat_completion_id, "sequence": index, @@ -166,6 +161,9 @@ def create_chat_completion_message_event( "ingest_source": "Python", } + if all_token_counts: + chat_completion_input_message_dict["token_count"] = 0 + if settings.ai_monitoring.record_content.enabled: chat_completion_input_message_dict["content"] = message_content @@ -193,11 +191,6 @@ def create_chat_completion_message_event( "request_id": request_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(response_model, message_content) - if settings.ai_monitoring.llm_token_count_callback - else None - ), "role": message.get("role"), "completion_id": chat_completion_id, "sequence": index, @@ -207,6 +200,9 @@ def create_chat_completion_message_event( "is_response": True, } + if all_token_counts: + chat_completion_output_message_dict["token_count"] = 0 + if settings.ai_monitoring.record_content.enabled: chat_completion_output_message_dict["content"] = message_content @@ -280,15 +276,18 @@ def _record_embedding_success(transaction, embedding_id, linking_metadata, kwarg else getattr(attribute_response, "organization", None) ) + response_total_tokens = attribute_response.get("usage", {}).get("total_tokens") if response else None + + total_tokens = ( + settings.ai_monitoring.llm_token_count_callback(response_model, input_) + if settings.ai_monitoring.llm_token_count_callback and input_ + else response_total_tokens + ) + full_embedding_response_dict = { "id": embedding_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(response_model, input_) - if settings.ai_monitoring.llm_token_count_callback - else None - ), "request.model": kwargs.get("model") or kwargs.get("engine"), "request_id": request_id, "duration": ft.duration * 1000, @@ -313,6 +312,7 @@ def _record_embedding_success(transaction, embedding_id, linking_metadata, kwarg "response.headers.ratelimitRemainingRequests": check_rate_limit_header( response_headers, "x-ratelimit-remaining-requests", True ), + "response.usage.total_tokens": total_tokens, "vendor": "openai", "ingest_source": "Python", } @@ -475,12 +475,15 @@ def _handle_completion_success(transaction, linking_metadata, completion_id, kwa def _record_completion_success(transaction, linking_metadata, completion_id, kwargs, ft, response_headers, response): + settings = transaction.settings if transaction.settings is not None else global_settings() span_id = linking_metadata.get("span.id") trace_id = linking_metadata.get("trace.id") + try: if response: response_model = response.get("model") response_id = response.get("id") + token_usage = response.get("usage") or {} output_message_list = [] finish_reason = None choices = response.get("choices") or [] @@ -494,6 +497,7 @@ def _record_completion_success(transaction, linking_metadata, completion_id, kwa else: response_model = kwargs.get("response.model") response_id = kwargs.get("id") + token_usage = {} output_message_list = [] finish_reason = kwargs.get("finish_reason") if "content" in kwargs: @@ -505,10 +509,44 @@ def _record_completion_success(transaction, linking_metadata, completion_id, kwa output_message_list = [] request_model = kwargs.get("model") or kwargs.get("engine") - request_id = response_headers.get("x-request-id") - organization = response_headers.get("openai-organization") or getattr(response, "organization", None) messages = kwargs.get("messages") or [{"content": kwargs.get("prompt"), "role": "user"}] input_message_list = list(messages) + + # Extract token counts from response object + if token_usage: + response_prompt_tokens = token_usage.get("prompt_tokens") + response_completion_tokens = token_usage.get("completion_tokens") + response_total_tokens = token_usage.get("total_tokens") + + else: + response_prompt_tokens = None + response_completion_tokens = None + response_total_tokens = None + + # Calculate token counts by checking if a callback is registered and if we have the necessary content to pass + # to it. If not, then we use the token counts provided in the response object + input_message_content = " ".join([msg.get("content", "") for msg in input_message_list if msg.get("content")]) + prompt_tokens = ( + settings.ai_monitoring.llm_token_count_callback(request_model, input_message_content) + if settings.ai_monitoring.llm_token_count_callback and input_message_content + else response_prompt_tokens + ) + output_message_content = " ".join([msg.get("content", "") for msg in output_message_list if msg.get("content")]) + completion_tokens = ( + settings.ai_monitoring.llm_token_count_callback(response_model, output_message_content) + if settings.ai_monitoring.llm_token_count_callback and output_message_content + else response_completion_tokens + ) + + total_tokens = ( + prompt_tokens + completion_tokens if all([prompt_tokens, completion_tokens]) else response_total_tokens + ) + + all_token_counts = bool(prompt_tokens and completion_tokens and total_tokens) + + request_id = response_headers.get("x-request-id") + organization = response_headers.get("openai-organization") or getattr(response, "organization", None) + full_chat_completion_summary_dict = { "id": completion_id, "span_id": span_id, @@ -553,6 +591,12 @@ def _record_completion_success(transaction, linking_metadata, completion_id, kwa ), "response.number_of_messages": len(input_message_list) + len(output_message_list), } + + if all_token_counts: + full_chat_completion_summary_dict["response.usage.prompt_tokens"] = prompt_tokens + full_chat_completion_summary_dict["response.usage.completion_tokens"] = completion_tokens + full_chat_completion_summary_dict["response.usage.total_tokens"] = total_tokens + llm_metadata = _get_llm_attributes(transaction) full_chat_completion_summary_dict.update(llm_metadata) transaction.record_custom_event("LlmChatCompletionSummary", full_chat_completion_summary_dict) @@ -564,11 +608,11 @@ def _record_completion_success(transaction, linking_metadata, completion_id, kwa span_id, trace_id, response_model, - request_model, response_id, request_id, llm_metadata, output_message_list, + all_token_counts, ) except Exception: _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, traceback.format_exception(*sys.exc_info())) @@ -579,6 +623,7 @@ def _record_completion_error(transaction, linking_metadata, completion_id, kwarg trace_id = linking_metadata.get("trace.id") request_message_list = kwargs.get("messages", None) or [] notice_error_attributes = {} + try: if OPENAI_V1: response = getattr(exc, "response", None) @@ -643,6 +688,7 @@ def _record_completion_error(transaction, linking_metadata, completion_id, kwarg output_message_list = [] if "content" in kwargs: output_message_list = [{"content": kwargs.get("content"), "role": kwargs.get("role")}] + create_chat_completion_message_event( transaction, request_message_list, @@ -650,11 +696,12 @@ def _record_completion_error(transaction, linking_metadata, completion_id, kwarg span_id, trace_id, kwargs.get("response.model"), - request_model, response_id, request_id, llm_metadata, output_message_list, + # We do not record token counts in error cases, so set all_token_counts to True so the pipeline tokenizer does not run + all_token_counts=True, ) except Exception: _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, traceback.format_exception(*sys.exc_info())) diff --git a/tests/mlmodel_langchain/test_chain.py b/tests/mlmodel_langchain/test_chain.py index 1a3cbbfd76..abf52efe09 100644 --- a/tests/mlmodel_langchain/test_chain.py +++ b/tests/mlmodel_langchain/test_chain.py @@ -359,6 +359,7 @@ "response.headers.ratelimitResetRequests": "20ms", "response.headers.ratelimitRemainingTokens": 999992, "response.headers.ratelimitRemainingRequests": 2999, + "response.usage.total_tokens": 8, "vendor": "openai", "ingest_source": "Python", "input": "[[3923, 374, 220, 17, 489, 220, 19, 30]]", @@ -382,6 +383,7 @@ "response.headers.ratelimitResetRequests": "20ms", "response.headers.ratelimitRemainingTokens": 999998, "response.headers.ratelimitRemainingRequests": 2999, + "response.usage.total_tokens": 1, "vendor": "openai", "ingest_source": "Python", "input": "[[10590]]", @@ -452,6 +454,9 @@ "response.headers.ratelimitResetRequests": "8.64s", "response.headers.ratelimitRemainingTokens": 199912, "response.headers.ratelimitRemainingRequests": 9999, + "response.usage.prompt_tokens": 73, + "response.usage.completion_tokens": 375, + "response.usage.total_tokens": 448, "response.number_of_messages": 3, }, ], @@ -467,6 +472,7 @@ "sequence": 0, "response.model": "gpt-3.5-turbo-0125", "vendor": "openai", + "token_count": 0, "ingest_source": "Python", "content": "You are a generator of quiz questions for a seminar. Use the following pieces of retrieved context to generate 5 multiple choice questions (A,B,C,D) on the subject matter. Use a three sentence maximum and keep the answer concise. Render the output as HTML\n\nWhat is 2 + 4?", }, @@ -483,6 +489,7 @@ "sequence": 1, "response.model": "gpt-3.5-turbo-0125", "vendor": "openai", + "token_count": 0, "ingest_source": "Python", "content": "math", }, @@ -499,6 +506,7 @@ "sequence": 2, "response.model": "gpt-3.5-turbo-0125", "vendor": "openai", + "token_count": 0, "ingest_source": "Python", "is_response": True, "content": "```html\n\n\n\n Math Quiz\n\n\n

Math Quiz Questions

\n
    \n
  1. What is the result of 5 + 3?
    2. \n
      \n
    • A) 7
      • \n
    • B) 8
      • \n
    • C) 9
      • \n
    • D) 10
      • \n
    \n
  2. What is the product of 6 x 7?
    3. \n
      \n
    • A) 36
      • \n
    • B) 42
      • \n
    • C) 48
      • \n
    • D) 56
      • \n
    \n
  3. What is the square root of 64?
    4. \n
      \n
    • A) 6
      • \n
    • B) 7
      • \n
    • C) 8
      • \n
    • D) 9
      • \n
    \n
  4. What is the result of 12 / 4?
    5. \n
      \n
    • A) 2
      • \n
    • B) 3
      • \n
    • C) 4
      • \n
    • D) 5
      • \n
    \n
  5. What is the sum of 15 + 9?
    6. \n
      \n
    • A) 22
      • \n
    • B) 23
      • \n
    • C) 24
      • \n
    • D) 25
      • \n
    \n
\n\n\n```", diff --git a/tests/mlmodel_openai/test_chat_completion.py b/tests/mlmodel_openai/test_chat_completion.py index 1f8cf1cb74..5e4d209ed7 100644 --- a/tests/mlmodel_openai/test_chat_completion.py +++ b/tests/mlmodel_openai/test_chat_completion.py @@ -15,7 +15,7 @@ import openai from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, disabled_ai_monitoring_streaming_settings, @@ -55,6 +55,9 @@ "response.organization": "new-relic-nkmd8b", "request.temperature": 0.7, "request.max_tokens": 100, + "response.usage.completion_tokens": 11, + "response.usage.total_tokens": 64, + "response.usage.prompt_tokens": 53, "response.choices.finish_reason": "stop", "response.headers.llmVersion": "2020-10-01", "response.headers.ratelimitLimitRequests": 200, @@ -81,6 +84,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "gpt-3.5-turbo-0613", "vendor": "openai", "ingest_source": "Python", @@ -99,6 +103,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "gpt-3.5-turbo-0613", "vendor": "openai", "ingest_source": "Python", @@ -117,6 +122,7 @@ "role": "assistant", "completion_id": None, "sequence": 2, + "token_count": 0, "response.model": "gpt-3.5-turbo-0613", "vendor": "openai", "is_response": True, @@ -172,7 +178,7 @@ def test_openai_chat_completion_sync_no_content(set_trace_info): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events(add_token_counts_to_chat_events(chat_completion_recorded_events)) # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( @@ -343,7 +349,7 @@ def test_openai_chat_completion_async_no_content(loop, set_trace_info): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events(add_token_counts_to_chat_events(chat_completion_recorded_events)) # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( diff --git a/tests/mlmodel_openai/test_chat_completion_error.py b/tests/mlmodel_openai/test_chat_completion_error.py index bfb2267a33..97a4dd8793 100644 --- a/tests/mlmodel_openai/test_chat_completion_error.py +++ b/tests/mlmodel_openai/test_chat_completion_error.py @@ -15,13 +15,11 @@ import openai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, events_with_context_attrs, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -68,6 +66,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -83,6 +82,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -186,6 +186,7 @@ def test_chat_completion_invalid_request_error_no_model_no_content(set_trace_inf "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -193,36 +194,6 @@ def test_chat_completion_invalid_request_error_no_model_no_content(set_trace_inf ] -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.InvalidRequestError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - "test_chat_completion_error:test_chat_completion_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count(set_trace_info): - set_trace_info() - with pytest.raises(openai.InvalidRequestError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - - openai.ChatCompletion.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - ) - - # Invalid model provided @dt_enabled @reset_core_stats_engine() @@ -281,6 +252,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info): "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -296,6 +268,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info): "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -360,6 +333,7 @@ def test_chat_completion_authentication_error(monkeypatch, set_trace_info): "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -471,37 +445,6 @@ def test_chat_completion_invalid_request_error_no_model_async_no_content(loop, s ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.InvalidRequestError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - "test_chat_completion_error:test_chat_completion_invalid_request_error_invalid_model_with_token_count_async", - scoped_metrics=[("Llm/completion/OpenAI/acreate", 1)], - rollup_metrics=[("Llm/completion/OpenAI/acreate", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count_async(loop, set_trace_info): - set_trace_info() - with pytest.raises(openai.InvalidRequestError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - loop.run_until_complete( - openai.ChatCompletion.acreate( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - ) - ) - - # Invalid model provided @dt_enabled @reset_core_stats_engine() diff --git a/tests/mlmodel_openai/test_chat_completion_error_v1.py b/tests/mlmodel_openai/test_chat_completion_error_v1.py index 9be9fcab9c..5af1598847 100644 --- a/tests/mlmodel_openai/test_chat_completion_error_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_error_v1.py @@ -14,13 +14,11 @@ import openai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, events_with_context_attrs, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -67,6 +65,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -82,6 +81,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -229,6 +229,7 @@ def test_chat_completion_invalid_request_error_no_model_async_no_content(loop, s "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -266,37 +267,6 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info, syn ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - "test_chat_completion_error_v1:test_chat_completion_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count(set_trace_info, sync_openai_client): - set_trace_info() - with pytest.raises(openai.NotFoundError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - sync_openai_client.chat.completions.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - ) - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -329,41 +299,6 @@ def test_chat_completion_invalid_request_error_invalid_model_async(loop, set_tra ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - "test_chat_completion_error_v1:test_chat_completion_invalid_request_error_invalid_model_with_token_count_async", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count_async( - loop, set_trace_info, async_openai_client -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - loop.run_until_complete( - async_openai_client.chat.completions.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - ) - ) - - expected_events_on_wrong_api_key_error = [ ( {"type": "LlmChatCompletionSummary"}, @@ -391,6 +326,7 @@ def test_chat_completion_invalid_request_error_invalid_model_with_token_count_as "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -610,39 +546,6 @@ def test_chat_completion_invalid_request_error_invalid_model_with_raw_response(s ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - "test_chat_completion_error_v1:test_chat_completion_invalid_request_error_invalid_model_with_token_count_with_raw_response", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count_with_raw_response( - set_trace_info, sync_openai_client -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - sync_openai_client.chat.completions.with_raw_response.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - ) - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -677,41 +580,6 @@ def test_chat_completion_invalid_request_error_invalid_model_async_with_raw_resp ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - "test_chat_completion_error_v1:test_chat_completion_invalid_request_error_invalid_model_with_token_count_async_with_raw_response", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count_async_with_raw_response( - loop, set_trace_info, async_openai_client -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - loop.run_until_complete( - async_openai_client.chat.completions.with_raw_response.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - ) - ) - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( diff --git a/tests/mlmodel_openai/test_chat_completion_stream.py b/tests/mlmodel_openai/test_chat_completion_stream.py index ad89d6f260..8019c0b6a9 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream.py +++ b/tests/mlmodel_openai/test_chat_completion_stream.py @@ -15,7 +15,8 @@ import openai from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_streaming_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, disabled_ai_monitoring_streaming_settings, @@ -184,9 +185,101 @@ def test_openai_chat_completion_sync_no_content(set_trace_info): assert resp +chat_completion_recorded_token_events = [ + ( + {"type": "LlmChatCompletionSummary"}, + { + "id": None, # UUID that varies with each run + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "span_id": None, + "trace_id": "trace-id", + "request_id": "49dbbffbd3c3f4612aa48def69059ccd", + "duration": None, # Response time varies each test run + "request.model": "gpt-3.5-turbo", + "response.model": "gpt-3.5-turbo-0613", + "response.organization": "new-relic-nkmd8b", + "request.temperature": 0.7, + "request.max_tokens": 100, + "response.choices.finish_reason": "stop", + "response.headers.llmVersion": "2020-10-01", + "response.headers.ratelimitLimitRequests": 200, + "response.headers.ratelimitLimitTokens": 40000, + "response.headers.ratelimitResetTokens": "90ms", + "response.headers.ratelimitResetRequests": "7m12s", + "response.headers.ratelimitRemainingTokens": 39940, + "response.headers.ratelimitRemainingRequests": 199, + "vendor": "openai", + "ingest_source": "Python", + "response.number_of_messages": 3, + }, + ), + ( + {"type": "LlmChatCompletionMessage"}, + { + "id": "chatcmpl-87sb95K4EF2nuJRcTs43Tm9ntTemv-0", + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "request_id": "49dbbffbd3c3f4612aa48def69059ccd", + "span_id": None, + "trace_id": "trace-id", + "content": "You are a scientist.", + "role": "system", + "completion_id": None, + "sequence": 0, + "token_count": 0, + "response.model": "gpt-3.5-turbo-0613", + "vendor": "openai", + "ingest_source": "Python", + }, + ), + ( + {"type": "LlmChatCompletionMessage"}, + { + "id": "chatcmpl-87sb95K4EF2nuJRcTs43Tm9ntTemv-1", + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "request_id": "49dbbffbd3c3f4612aa48def69059ccd", + "span_id": None, + "trace_id": "trace-id", + "content": "What is 212 degrees Fahrenheit converted to Celsius?", + "role": "user", + "completion_id": None, + "sequence": 1, + "token_count": 0, + "response.model": "gpt-3.5-turbo-0613", + "vendor": "openai", + "ingest_source": "Python", + }, + ), + ( + {"type": "LlmChatCompletionMessage"}, + { + "id": "chatcmpl-87sb95K4EF2nuJRcTs43Tm9ntTemv-2", + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "request_id": "49dbbffbd3c3f4612aa48def69059ccd", + "span_id": None, + "trace_id": "trace-id", + "content": "212 degrees Fahrenheit is equal to 100 degrees Celsius.", + "role": "assistant", + "completion_id": None, + "sequence": 2, + "token_count": 0, + "response.model": "gpt-3.5-turbo-0613", + "vendor": "openai", + "is_response": True, + "ingest_source": "Python", + }, + ), +] + + @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events( + add_token_counts_to_chat_events(add_token_count_streaming_events(chat_completion_recorded_events)) +) # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( @@ -378,7 +471,9 @@ async def consumer(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events( + add_token_counts_to_chat_events(add_token_count_streaming_events(chat_completion_recorded_events)) +) @validate_custom_event_count(count=4) @validate_transaction_metrics( name="test_chat_completion_stream:test_openai_chat_completion_async_with_token_count", diff --git a/tests/mlmodel_openai/test_chat_completion_stream_error.py b/tests/mlmodel_openai/test_chat_completion_stream_error.py index eebb5ee8fb..e8e55426e9 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream_error.py +++ b/tests/mlmodel_openai/test_chat_completion_stream_error.py @@ -15,13 +15,11 @@ import openai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, events_with_context_attrs, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -68,6 +66,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -83,6 +82,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -191,6 +191,7 @@ def test_chat_completion_invalid_request_error_no_model_no_content(set_trace_inf "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -198,38 +199,6 @@ def test_chat_completion_invalid_request_error_no_model_no_content(set_trace_inf ] -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.InvalidRequestError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - "test_chat_completion_stream_error:test_chat_completion_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count(set_trace_info): - set_trace_info() - with pytest.raises(openai.InvalidRequestError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - generator = openai.ChatCompletion.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - stream=True, - ) - for resp in generator: - assert resp - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -290,6 +259,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info): "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -305,6 +275,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info): "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -374,6 +345,7 @@ def test_chat_completion_authentication_error(monkeypatch, set_trace_info): "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -488,38 +460,6 @@ def test_chat_completion_invalid_request_error_no_model_async_no_content(loop, s ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.InvalidRequestError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - "test_chat_completion_stream_error:test_chat_completion_invalid_request_error_invalid_model_with_token_count_async", - scoped_metrics=[("Llm/completion/OpenAI/acreate", 1)], - rollup_metrics=[("Llm/completion/OpenAI/acreate", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count_async(loop, set_trace_info): - set_trace_info() - with pytest.raises(openai.InvalidRequestError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - loop.run_until_complete( - openai.ChatCompletion.acreate( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - stream=True, - ) - ) - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -649,6 +589,7 @@ def test_chat_completion_wrong_api_key_error_async(loop, monkeypatch, set_trace_ "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, diff --git a/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py b/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py index 5f769ea0e6..64798300fc 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py @@ -12,16 +12,13 @@ # See the License for the specific language governing permissions and # limitations under the License. - import openai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, events_with_context_attrs, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -68,6 +65,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -83,6 +81,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -243,6 +242,7 @@ async def consumer(): "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -281,77 +281,6 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info, syn assert resp -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - "test_chat_completion_stream_error_v1:test_chat_completion_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count(set_trace_info, sync_openai_client): - set_trace_info() - with pytest.raises(openai.NotFoundError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - - generator = sync_openai_client.chat.completions.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - stream=True, - ) - for resp in generator: - assert resp - - -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - "test_chat_completion_stream_error_v1:test_chat_completion_invalid_request_error_invalid_model_async_with_token_count", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_async_with_token_count( - loop, set_trace_info, async_openai_client -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - - async def consumer(): - generator = await async_openai_client.chat.completions.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - stream=True, - ) - async for resp in generator: - assert resp - - loop.run_until_complete(consumer()) - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -414,6 +343,7 @@ async def consumer(): "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, diff --git a/tests/mlmodel_openai/test_chat_completion_stream_v1.py b/tests/mlmodel_openai/test_chat_completion_stream_v1.py index 796404012b..c88e8b1df6 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_stream_v1.py @@ -17,7 +17,8 @@ from conftest import get_openai_version from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_streaming_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, disabled_ai_monitoring_streaming_settings, @@ -300,7 +301,9 @@ def test_openai_chat_completion_sync_no_content(set_trace_info, sync_openai_clie @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events( + add_token_counts_to_chat_events(add_token_count_streaming_events(chat_completion_recorded_events)) +) # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( @@ -622,7 +625,9 @@ async def consumer(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events( + add_token_counts_to_chat_events(add_token_count_streaming_events(chat_completion_recorded_events)) +) # One summary event, one system message, one user message, and one response message from the assistant # @validate_custom_event_count(count=4) @validate_transaction_metrics( diff --git a/tests/mlmodel_openai/test_chat_completion_v1.py b/tests/mlmodel_openai/test_chat_completion_v1.py index 817db35d8e..007effcb17 100644 --- a/tests/mlmodel_openai/test_chat_completion_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_v1.py @@ -15,7 +15,7 @@ import openai from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, disabled_ai_monitoring_streaming_settings, @@ -54,6 +54,9 @@ "response.organization": "new-relic-nkmd8b", "request.temperature": 0.7, "request.max_tokens": 100, + "response.usage.completion_tokens": 75, + "response.usage.total_tokens": 101, + "response.usage.prompt_tokens": 26, "response.choices.finish_reason": "stop", "response.headers.llmVersion": "2020-10-01", "response.headers.ratelimitLimitRequests": 10000, @@ -80,6 +83,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "gpt-3.5-turbo-0125", "vendor": "openai", "ingest_source": "Python", @@ -98,6 +102,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "gpt-3.5-turbo-0125", "vendor": "openai", "ingest_source": "Python", @@ -116,6 +121,7 @@ "role": "assistant", "completion_id": None, "sequence": 2, + "token_count": 0, "response.model": "gpt-3.5-turbo-0125", "vendor": "openai", "is_response": True, @@ -193,7 +199,7 @@ def test_openai_chat_completion_sync_no_content(set_trace_info, sync_openai_clie @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events(add_token_counts_to_chat_events(chat_completion_recorded_events)) # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( @@ -389,7 +395,7 @@ def test_openai_chat_completion_async_with_llm_metadata_no_content(loop, set_tra @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events(add_token_counts_to_chat_events(chat_completion_recorded_events)) # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( diff --git a/tests/mlmodel_openai/test_embeddings.py b/tests/mlmodel_openai/test_embeddings.py index c3c3e7c429..935db04fe0 100644 --- a/tests/mlmodel_openai/test_embeddings.py +++ b/tests/mlmodel_openai/test_embeddings.py @@ -19,7 +19,7 @@ validate_attributes, ) from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_to_embedding_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -55,6 +55,7 @@ "response.headers.ratelimitResetRequests": "19m45.394s", "response.headers.ratelimitRemainingTokens": 149994, "response.headers.ratelimitRemainingRequests": 197, + "response.usage.total_tokens": 6, "vendor": "openai", "ingest_source": "Python", }, @@ -107,7 +108,7 @@ def test_openai_embedding_sync_no_content(set_trace_info): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(embedding_recorded_events)) +@validate_custom_events(add_token_count_to_embedding_events(embedding_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_embeddings:test_openai_embedding_sync_with_token_count", @@ -191,7 +192,7 @@ def test_openai_embedding_async_no_content(loop, set_trace_info): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(embedding_recorded_events)) +@validate_custom_events(add_token_count_to_embedding_events(embedding_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_embeddings:test_openai_embedding_async_with_token_count", diff --git a/tests/mlmodel_openai/test_embeddings_error_v1.py b/tests/mlmodel_openai/test_embeddings_error_v1.py index fd29236122..499f96893b 100644 --- a/tests/mlmodel_openai/test_embeddings_error_v1.py +++ b/tests/mlmodel_openai/test_embeddings_error_v1.py @@ -16,12 +16,10 @@ import openai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -149,32 +147,6 @@ def test_embeddings_invalid_request_error_no_model_async(set_trace_info, async_o ] -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"http.statusCode": 404, "error.code": "model_not_found"}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - name="test_embeddings_error_v1:test_embeddings_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/embedding/OpenAI/create", 1)], - rollup_metrics=[("Llm/embedding/OpenAI/create", 1)], - custom_metrics=[(f"Supportability/Python/ML/OpenAI/{openai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_with_token_count(set_trace_info, sync_openai_client): - set_trace_info() - with pytest.raises(openai.NotFoundError): - sync_openai_client.embeddings.create(input="Model does not exist.", model="does-not-exist") - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -255,36 +227,6 @@ def test_embeddings_invalid_request_error_invalid_model_async_no_content(set_tra ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"http.statusCode": 404, "error.code": "model_not_found"}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - name="test_embeddings_error_v1:test_embeddings_invalid_request_error_invalid_model_async_with_token_count", - scoped_metrics=[("Llm/embedding/OpenAI/create", 1)], - rollup_metrics=[("Llm/embedding/OpenAI/create", 1)], - custom_metrics=[(f"Supportability/Python/ML/OpenAI/{openai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_async_with_token_count( - set_trace_info, async_openai_client, loop -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - loop.run_until_complete( - async_openai_client.embeddings.create(input="Model does not exist.", model="does-not-exist") - ) - - embedding_invalid_key_error_events = [ ( {"type": "LlmEmbedding"}, @@ -449,34 +391,6 @@ def test_embeddings_invalid_request_error_no_model_async_with_raw_response(set_t ) # no model provided -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"http.statusCode": 404, "error.code": "model_not_found"}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - name="test_embeddings_error_v1:test_embeddings_invalid_request_error_invalid_model_with_token_count_with_raw_response", - scoped_metrics=[("Llm/embedding/OpenAI/create", 1)], - rollup_metrics=[("Llm/embedding/OpenAI/create", 1)], - custom_metrics=[(f"Supportability/Python/ML/OpenAI/{openai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_with_token_count_with_raw_response( - set_trace_info, sync_openai_client -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - sync_openai_client.embeddings.with_raw_response.create(input="Model does not exist.", model="does-not-exist") - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -566,38 +480,6 @@ def test_embeddings_invalid_request_error_invalid_model_async_no_content_with_ra ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"http.statusCode": 404, "error.code": "model_not_found"}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - name="test_embeddings_error_v1:test_embeddings_invalid_request_error_invalid_model_async_with_token_count_with_raw_response", - scoped_metrics=[("Llm/embedding/OpenAI/create", 1)], - rollup_metrics=[("Llm/embedding/OpenAI/create", 1)], - custom_metrics=[(f"Supportability/Python/ML/OpenAI/{openai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_async_with_token_count_with_raw_response( - set_trace_info, async_openai_client, loop -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - loop.run_until_complete( - async_openai_client.embeddings.with_raw_response.create( - input="Model does not exist.", model="does-not-exist" - ) - ) - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( diff --git a/tests/mlmodel_openai/test_embeddings_v1.py b/tests/mlmodel_openai/test_embeddings_v1.py index 405a2a9e5f..3801d3639c 100644 --- a/tests/mlmodel_openai/test_embeddings_v1.py +++ b/tests/mlmodel_openai/test_embeddings_v1.py @@ -15,7 +15,7 @@ import openai from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_to_embedding_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -48,6 +48,7 @@ "response.headers.ratelimitResetRequests": "20ms", "response.headers.ratelimitRemainingTokens": 999994, "response.headers.ratelimitRemainingRequests": 2999, + "response.usage.total_tokens": 6, "vendor": "openai", "ingest_source": "Python", }, @@ -111,7 +112,7 @@ def test_openai_embedding_sync_no_content(set_trace_info, sync_openai_client): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(embedding_recorded_events)) +@validate_custom_events(add_token_count_to_embedding_events(embedding_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_embeddings_v1:test_openai_embedding_sync_with_token_count", @@ -206,7 +207,7 @@ def test_openai_embedding_async_no_content(loop, set_trace_info, async_openai_cl @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(embedding_recorded_events)) +@validate_custom_events(add_token_count_to_embedding_events(embedding_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_embeddings_v1:test_openai_embedding_async_with_token_count", diff --git a/tests/testing_support/ml_testing_utils.py b/tests/testing_support/ml_testing_utils.py index 55dbd08105..8c2c0444f0 100644 --- a/tests/testing_support/ml_testing_utils.py +++ b/tests/testing_support/ml_testing_utils.py @@ -46,6 +46,14 @@ def add_token_count_to_embedding_events(expected_events): return events +def add_token_count_streaming_events(expected_events): + events = copy.deepcopy(expected_events) + for event in events: + if event[0]["type"] == "LlmChatCompletionMessage": + event[1]["token_count"] = 0 + return events + + def add_token_counts_to_chat_events(expected_events): events = copy.deepcopy(expected_events) for event in events: From b18104dc7cf70a3c9292d90514c0d09ec45c737c Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Thu, 23 Oct 2025 14:32:16 -0700 Subject: [PATCH 003/124] Strands Mock Model (#1551) * Add strands to tox.ini * Add mock models for strands testing * Add simple test file to validate strands mocking --- tests/mlmodel_strands/_mock_model_provider.py | 99 ++++++++++++ tests/mlmodel_strands/conftest.py | 144 ++++++++++++++++++ tests/mlmodel_strands/test_simple.py | 36 +++++ tox.ini | 12 +- 4 files changed, 287 insertions(+), 4 deletions(-) create mode 100644 tests/mlmodel_strands/_mock_model_provider.py create mode 100644 tests/mlmodel_strands/conftest.py create mode 100644 tests/mlmodel_strands/test_simple.py diff --git a/tests/mlmodel_strands/_mock_model_provider.py b/tests/mlmodel_strands/_mock_model_provider.py new file mode 100644 index 0000000000..e4c9e79930 --- /dev/null +++ b/tests/mlmodel_strands/_mock_model_provider.py @@ -0,0 +1,99 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Test setup derived from: https://github.com/strands-agents/sdk-python/blob/main/tests/fixtures/mocked_model_provider.py +# strands Apache 2.0 license: https://github.com/strands-agents/sdk-python/blob/main/LICENSE + +import json +from typing import TypedDict + +from strands.models import Model + + +class RedactionMessage(TypedDict): + redactedUserContent: str + redactedAssistantContent: str + + +class MockedModelProvider(Model): + """A mock implementation of the Model interface for testing purposes. + + This class simulates a model provider by returning pre-defined agent responses + in sequence. It implements the Model interface methods and provides functionality + to stream mock responses as events. + """ + + def __init__(self, agent_responses): + self.agent_responses = agent_responses + self.index = 0 + + def format_chunk(self, event): + return event + + def format_request(self, messages, tool_specs=None, system_prompt=None): + return None + + def get_config(self): + pass + + def update_config(self, **model_config): + pass + + async def structured_output(self, output_model, prompt, system_prompt=None, **kwargs): + pass + + async def stream(self, messages, tool_specs=None, system_prompt=None): + events = self.map_agent_message_to_events(self.agent_responses[self.index]) + for event in events: + yield event + + self.index += 1 + + def map_agent_message_to_events(self, agent_message): + stop_reason = "end_turn" + yield {"messageStart": {"role": "assistant"}} + if agent_message.get("redactedAssistantContent"): + yield {"redactContent": {"redactUserContentMessage": agent_message["redactedUserContent"]}} + yield {"contentBlockStart": {"start": {}}} + yield {"contentBlockDelta": {"delta": {"text": agent_message["redactedAssistantContent"]}}} + yield {"contentBlockStop": {}} + stop_reason = "guardrail_intervened" + else: + for content in agent_message["content"]: + if "reasoningContent" in content: + yield {"contentBlockStart": {"start": {}}} + yield {"contentBlockDelta": {"delta": {"reasoningContent": content["reasoningContent"]}}} + yield {"contentBlockStop": {}} + if "text" in content: + yield {"contentBlockStart": {"start": {}}} + yield {"contentBlockDelta": {"delta": {"text": content["text"]}}} + yield {"contentBlockStop": {}} + if "toolUse" in content: + stop_reason = "tool_use" + yield { + "contentBlockStart": { + "start": { + "toolUse": { + "name": content["toolUse"]["name"], + "toolUseId": content["toolUse"]["toolUseId"], + } + } + } + } + yield { + "contentBlockDelta": {"delta": {"toolUse": {"input": json.dumps(content["toolUse"]["input"])}}} + } + yield {"contentBlockStop": {}} + + yield {"messageStop": {"stopReason": stop_reason}} diff --git a/tests/mlmodel_strands/conftest.py b/tests/mlmodel_strands/conftest.py new file mode 100644 index 0000000000..b810161f6a --- /dev/null +++ b/tests/mlmodel_strands/conftest.py @@ -0,0 +1,144 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from _mock_model_provider import MockedModelProvider +from testing_support.fixtures import collector_agent_registration_fixture, collector_available_fixture +from testing_support.ml_testing_utils import set_trace_info + +_default_settings = { + "package_reporting.enabled": False, # Turn off package reporting for testing as it causes slowdowns. + "transaction_tracer.explain_threshold": 0.0, + "transaction_tracer.transaction_threshold": 0.0, + "transaction_tracer.stack_trace_threshold": 0.0, + "debug.log_data_collector_payloads": True, + "debug.record_transaction_failure": True, + "ai_monitoring.enabled": True, +} + +collector_agent_registration = collector_agent_registration_fixture( + app_name="Python Agent Test (mlmodel_strands)", default_settings=_default_settings +) + + +@pytest.fixture +def single_tool_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def single_tool_model_error(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + # Set arguments to an invalid type to trigger error in tool + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": 12}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def multi_tool_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 5, "b": 3}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Goodbye"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 123, "b": 2}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def multi_tool_model_error(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 5, "b": 3}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Goodbye"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + # Set insufficient arguments to trigger error in tool + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 123}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model diff --git a/tests/mlmodel_strands/test_simple.py b/tests/mlmodel_strands/test_simple.py new file mode 100644 index 0000000000..ae24003fab --- /dev/null +++ b/tests/mlmodel_strands/test_simple.py @@ -0,0 +1,36 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from strands import Agent, tool + +from newrelic.api.background_task import background_task + + +# Example tool for testing purposes +@tool +def add_exclamation(message: str) -> str: + return f"{message}!" + + +# TODO: Remove this file once all real tests are in place + + +@background_task() +def test_simple_run_agent(set_trace_info, single_tool_model): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + response = my_agent("Run the tools.") + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 diff --git a/tox.ini b/tox.ini index 39148b657f..ace7839db3 100644 --- a/tox.ini +++ b/tox.ini @@ -182,6 +182,7 @@ envlist = python-logger_structlog-{py38,py39,py310,py311,py312,py313,py314,pypy311}-structloglatest, python-mlmodel_autogen-{py310,py311,py312,py313,py314,pypy311}-autogen061, python-mlmodel_autogen-{py310,py311,py312,py313,py314,pypy311}-autogenlatest, + python-mlmodel_strands-{py310,py311,py312,py313}-strandslatest, python-mlmodel_gemini-{py39,py310,py311,py312,py313,py314}, python-mlmodel_langchain-{py39,py310,py311,py312,py313}, ;; Package not ready for Python 3.14 (type annotations not updated) @@ -440,6 +441,8 @@ deps = mlmodel_langchain: faiss-cpu mlmodel_langchain: mock mlmodel_langchain: asyncio + mlmodel_strands: strands-agents[openai] + mlmodel_strands: strands-agents-tools logger_loguru-logurulatest: loguru logger_structlog-structloglatest: structlog messagebroker_pika-pikalatest: pika @@ -510,6 +513,7 @@ changedir = application_celery: tests/application_celery component_djangorestframework: tests/component_djangorestframework component_flask_rest: tests/component_flask_rest + component_graphenedjango: tests/component_graphenedjango component_graphqlserver: tests/component_graphqlserver component_tastypie: tests/component_tastypie coroutines_asyncio: tests/coroutines_asyncio @@ -521,17 +525,17 @@ changedir = datastore_cassandradriver: tests/datastore_cassandradriver datastore_elasticsearch: tests/datastore_elasticsearch datastore_firestore: tests/datastore_firestore - datastore_oracledb: tests/datastore_oracledb datastore_memcache: tests/datastore_memcache + datastore_motor: tests/datastore_motor datastore_mysql: tests/datastore_mysql datastore_mysqldb: tests/datastore_mysqldb + datastore_oracledb: tests/datastore_oracledb datastore_postgresql: tests/datastore_postgresql datastore_psycopg: tests/datastore_psycopg datastore_psycopg2: tests/datastore_psycopg2 datastore_psycopg2cffi: tests/datastore_psycopg2cffi datastore_pylibmc: tests/datastore_pylibmc datastore_pymemcache: tests/datastore_pymemcache - datastore_motor: tests/datastore_motor datastore_pymongo: tests/datastore_pymongo datastore_pymssql: tests/datastore_pymssql datastore_pymysql: tests/datastore_pymysql @@ -539,8 +543,8 @@ changedir = datastore_pysolr: tests/datastore_pysolr datastore_redis: tests/datastore_redis datastore_rediscluster: tests/datastore_rediscluster - datastore_valkey: tests/datastore_valkey datastore_sqlite: tests/datastore_sqlite + datastore_valkey: tests/datastore_valkey external_aiobotocore: tests/external_aiobotocore external_botocore: tests/external_botocore external_feedparser: tests/external_feedparser @@ -561,7 +565,6 @@ changedir = framework_fastapi: tests/framework_fastapi framework_flask: tests/framework_flask framework_graphene: tests/framework_graphene - component_graphenedjango: tests/component_graphenedjango framework_graphql: tests/framework_graphql framework_grpc: tests/framework_grpc framework_pyramid: tests/framework_pyramid @@ -581,6 +584,7 @@ changedir = mlmodel_langchain: tests/mlmodel_langchain mlmodel_openai: tests/mlmodel_openai mlmodel_sklearn: tests/mlmodel_sklearn + mlmodel_strands: tests/mlmodel_strands template_genshi: tests/template_genshi template_jinja2: tests/template_jinja2 template_mako: tests/template_mako From c19207b273607e5346ac6639b9be6307ff862d6e Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Thu, 23 Oct 2025 14:32:16 -0700 Subject: [PATCH 004/124] Strands Mock Model (#1551) * Add strands to tox.ini * Add mock models for strands testing * Add simple test file to validate strands mocking --- tests/mlmodel_strands/_mock_model_provider.py | 99 ++++++++++++ tests/mlmodel_strands/conftest.py | 144 ++++++++++++++++++ tests/mlmodel_strands/test_simple.py | 36 +++++ tox.ini | 12 +- 4 files changed, 287 insertions(+), 4 deletions(-) create mode 100644 tests/mlmodel_strands/_mock_model_provider.py create mode 100644 tests/mlmodel_strands/conftest.py create mode 100644 tests/mlmodel_strands/test_simple.py diff --git a/tests/mlmodel_strands/_mock_model_provider.py b/tests/mlmodel_strands/_mock_model_provider.py new file mode 100644 index 0000000000..e4c9e79930 --- /dev/null +++ b/tests/mlmodel_strands/_mock_model_provider.py @@ -0,0 +1,99 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Test setup derived from: https://github.com/strands-agents/sdk-python/blob/main/tests/fixtures/mocked_model_provider.py +# strands Apache 2.0 license: https://github.com/strands-agents/sdk-python/blob/main/LICENSE + +import json +from typing import TypedDict + +from strands.models import Model + + +class RedactionMessage(TypedDict): + redactedUserContent: str + redactedAssistantContent: str + + +class MockedModelProvider(Model): + """A mock implementation of the Model interface for testing purposes. + + This class simulates a model provider by returning pre-defined agent responses + in sequence. It implements the Model interface methods and provides functionality + to stream mock responses as events. + """ + + def __init__(self, agent_responses): + self.agent_responses = agent_responses + self.index = 0 + + def format_chunk(self, event): + return event + + def format_request(self, messages, tool_specs=None, system_prompt=None): + return None + + def get_config(self): + pass + + def update_config(self, **model_config): + pass + + async def structured_output(self, output_model, prompt, system_prompt=None, **kwargs): + pass + + async def stream(self, messages, tool_specs=None, system_prompt=None): + events = self.map_agent_message_to_events(self.agent_responses[self.index]) + for event in events: + yield event + + self.index += 1 + + def map_agent_message_to_events(self, agent_message): + stop_reason = "end_turn" + yield {"messageStart": {"role": "assistant"}} + if agent_message.get("redactedAssistantContent"): + yield {"redactContent": {"redactUserContentMessage": agent_message["redactedUserContent"]}} + yield {"contentBlockStart": {"start": {}}} + yield {"contentBlockDelta": {"delta": {"text": agent_message["redactedAssistantContent"]}}} + yield {"contentBlockStop": {}} + stop_reason = "guardrail_intervened" + else: + for content in agent_message["content"]: + if "reasoningContent" in content: + yield {"contentBlockStart": {"start": {}}} + yield {"contentBlockDelta": {"delta": {"reasoningContent": content["reasoningContent"]}}} + yield {"contentBlockStop": {}} + if "text" in content: + yield {"contentBlockStart": {"start": {}}} + yield {"contentBlockDelta": {"delta": {"text": content["text"]}}} + yield {"contentBlockStop": {}} + if "toolUse" in content: + stop_reason = "tool_use" + yield { + "contentBlockStart": { + "start": { + "toolUse": { + "name": content["toolUse"]["name"], + "toolUseId": content["toolUse"]["toolUseId"], + } + } + } + } + yield { + "contentBlockDelta": {"delta": {"toolUse": {"input": json.dumps(content["toolUse"]["input"])}}} + } + yield {"contentBlockStop": {}} + + yield {"messageStop": {"stopReason": stop_reason}} diff --git a/tests/mlmodel_strands/conftest.py b/tests/mlmodel_strands/conftest.py new file mode 100644 index 0000000000..b810161f6a --- /dev/null +++ b/tests/mlmodel_strands/conftest.py @@ -0,0 +1,144 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from _mock_model_provider import MockedModelProvider +from testing_support.fixtures import collector_agent_registration_fixture, collector_available_fixture +from testing_support.ml_testing_utils import set_trace_info + +_default_settings = { + "package_reporting.enabled": False, # Turn off package reporting for testing as it causes slowdowns. + "transaction_tracer.explain_threshold": 0.0, + "transaction_tracer.transaction_threshold": 0.0, + "transaction_tracer.stack_trace_threshold": 0.0, + "debug.log_data_collector_payloads": True, + "debug.record_transaction_failure": True, + "ai_monitoring.enabled": True, +} + +collector_agent_registration = collector_agent_registration_fixture( + app_name="Python Agent Test (mlmodel_strands)", default_settings=_default_settings +) + + +@pytest.fixture +def single_tool_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def single_tool_model_error(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + # Set arguments to an invalid type to trigger error in tool + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": 12}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def multi_tool_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 5, "b": 3}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Goodbye"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 123, "b": 2}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def multi_tool_model_error(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 5, "b": 3}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Goodbye"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + # Set insufficient arguments to trigger error in tool + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 123}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model diff --git a/tests/mlmodel_strands/test_simple.py b/tests/mlmodel_strands/test_simple.py new file mode 100644 index 0000000000..ae24003fab --- /dev/null +++ b/tests/mlmodel_strands/test_simple.py @@ -0,0 +1,36 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from strands import Agent, tool + +from newrelic.api.background_task import background_task + + +# Example tool for testing purposes +@tool +def add_exclamation(message: str) -> str: + return f"{message}!" + + +# TODO: Remove this file once all real tests are in place + + +@background_task() +def test_simple_run_agent(set_trace_info, single_tool_model): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + response = my_agent("Run the tools.") + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 diff --git a/tox.ini b/tox.ini index 39148b657f..ace7839db3 100644 --- a/tox.ini +++ b/tox.ini @@ -182,6 +182,7 @@ envlist = python-logger_structlog-{py38,py39,py310,py311,py312,py313,py314,pypy311}-structloglatest, python-mlmodel_autogen-{py310,py311,py312,py313,py314,pypy311}-autogen061, python-mlmodel_autogen-{py310,py311,py312,py313,py314,pypy311}-autogenlatest, + python-mlmodel_strands-{py310,py311,py312,py313}-strandslatest, python-mlmodel_gemini-{py39,py310,py311,py312,py313,py314}, python-mlmodel_langchain-{py39,py310,py311,py312,py313}, ;; Package not ready for Python 3.14 (type annotations not updated) @@ -440,6 +441,8 @@ deps = mlmodel_langchain: faiss-cpu mlmodel_langchain: mock mlmodel_langchain: asyncio + mlmodel_strands: strands-agents[openai] + mlmodel_strands: strands-agents-tools logger_loguru-logurulatest: loguru logger_structlog-structloglatest: structlog messagebroker_pika-pikalatest: pika @@ -510,6 +513,7 @@ changedir = application_celery: tests/application_celery component_djangorestframework: tests/component_djangorestframework component_flask_rest: tests/component_flask_rest + component_graphenedjango: tests/component_graphenedjango component_graphqlserver: tests/component_graphqlserver component_tastypie: tests/component_tastypie coroutines_asyncio: tests/coroutines_asyncio @@ -521,17 +525,17 @@ changedir = datastore_cassandradriver: tests/datastore_cassandradriver datastore_elasticsearch: tests/datastore_elasticsearch datastore_firestore: tests/datastore_firestore - datastore_oracledb: tests/datastore_oracledb datastore_memcache: tests/datastore_memcache + datastore_motor: tests/datastore_motor datastore_mysql: tests/datastore_mysql datastore_mysqldb: tests/datastore_mysqldb + datastore_oracledb: tests/datastore_oracledb datastore_postgresql: tests/datastore_postgresql datastore_psycopg: tests/datastore_psycopg datastore_psycopg2: tests/datastore_psycopg2 datastore_psycopg2cffi: tests/datastore_psycopg2cffi datastore_pylibmc: tests/datastore_pylibmc datastore_pymemcache: tests/datastore_pymemcache - datastore_motor: tests/datastore_motor datastore_pymongo: tests/datastore_pymongo datastore_pymssql: tests/datastore_pymssql datastore_pymysql: tests/datastore_pymysql @@ -539,8 +543,8 @@ changedir = datastore_pysolr: tests/datastore_pysolr datastore_redis: tests/datastore_redis datastore_rediscluster: tests/datastore_rediscluster - datastore_valkey: tests/datastore_valkey datastore_sqlite: tests/datastore_sqlite + datastore_valkey: tests/datastore_valkey external_aiobotocore: tests/external_aiobotocore external_botocore: tests/external_botocore external_feedparser: tests/external_feedparser @@ -561,7 +565,6 @@ changedir = framework_fastapi: tests/framework_fastapi framework_flask: tests/framework_flask framework_graphene: tests/framework_graphene - component_graphenedjango: tests/component_graphenedjango framework_graphql: tests/framework_graphql framework_grpc: tests/framework_grpc framework_pyramid: tests/framework_pyramid @@ -581,6 +584,7 @@ changedir = mlmodel_langchain: tests/mlmodel_langchain mlmodel_openai: tests/mlmodel_openai mlmodel_sklearn: tests/mlmodel_sklearn + mlmodel_strands: tests/mlmodel_strands template_genshi: tests/template_genshi template_jinja2: tests/template_jinja2 template_mako: tests/template_mako From 630f4093150c89f84e8661875c676ce4f750b38e Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Thu, 13 Nov 2025 14:53:41 -0800 Subject: [PATCH 005/124] Add response token count logic to Bedrock instrumentation. (#1504) * Add bedrock token counting. * [MegaLinter] Apply linters fixes * Add bedrock token counting. * Add safeguards when grabbing token counts. * Remove extra None defaults. * Cleanup default None checks. --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- newrelic/hooks/external_botocore.py | 260 ++++++++++++++---- .../test_bedrock_chat_completion_converse.py | 53 +--- ...st_bedrock_chat_completion_invoke_model.py | 102 +------ .../test_bedrock_embeddings.py | 43 +-- .../_test_bedrock_chat_completion.py | 30 ++ .../_test_bedrock_embeddings.py | 2 + ...st_bedrock_chat_completion_invoke_model.py | 150 ++++------ .../test_bedrock_embeddings.py | 43 +-- .../test_chat_completion_converse.py | 64 +---- tests/mlmodel_openai/test_embeddings_error.py | 57 +--- 10 files changed, 319 insertions(+), 485 deletions(-) diff --git a/newrelic/hooks/external_botocore.py b/newrelic/hooks/external_botocore.py index d8c18b49db..a3da091284 100644 --- a/newrelic/hooks/external_botocore.py +++ b/newrelic/hooks/external_botocore.py @@ -192,6 +192,7 @@ def create_chat_completion_message_event( request_model, request_id, llm_metadata_dict, + all_token_counts, response_id=None, ): if not transaction: @@ -224,6 +225,8 @@ def create_chat_completion_message_event( "vendor": "bedrock", "ingest_source": "Python", } + if all_token_counts: + chat_completion_message_dict["token_count"] = 0 if settings.ai_monitoring.record_content.enabled: chat_completion_message_dict["content"] = content @@ -263,6 +266,8 @@ def create_chat_completion_message_event( "ingest_source": "Python", "is_response": True, } + if all_token_counts: + chat_completion_message_dict["token_count"] = 0 if settings.ai_monitoring.record_content.enabled: chat_completion_message_dict["content"] = content @@ -272,24 +277,21 @@ def create_chat_completion_message_event( transaction.record_custom_event("LlmChatCompletionMessage", chat_completion_message_dict) -def extract_bedrock_titan_text_model_request(request_body, bedrock_attrs): +def extract_bedrock_titan_embedding_model_request(request_body, bedrock_attrs): request_body = json.loads(request_body) - request_config = request_body.get("textGenerationConfig", {}) - input_message_list = [{"role": "user", "content": request_body.get("inputText")}] - - bedrock_attrs["input_message_list"] = input_message_list - bedrock_attrs["request.max_tokens"] = request_config.get("maxTokenCount") - bedrock_attrs["request.temperature"] = request_config.get("temperature") + bedrock_attrs["input"] = request_body.get("inputText") return bedrock_attrs -def extract_bedrock_mistral_text_model_request(request_body, bedrock_attrs): - request_body = json.loads(request_body) - bedrock_attrs["input_message_list"] = [{"role": "user", "content": request_body.get("prompt")}] - bedrock_attrs["request.max_tokens"] = request_body.get("max_tokens") - bedrock_attrs["request.temperature"] = request_body.get("temperature") +def extract_bedrock_titan_embedding_model_response(response_body, bedrock_attrs): + if response_body: + response_body = json.loads(response_body) + + input_tokens = response_body.get("inputTextTokenCount", 0) + bedrock_attrs["response.usage.total_tokens"] = input_tokens + return bedrock_attrs @@ -297,16 +299,31 @@ def extract_bedrock_titan_text_model_response(response_body, bedrock_attrs): if response_body: response_body = json.loads(response_body) + input_tokens = response_body.get("inputTextTokenCount", 0) + completion_tokens = sum(result.get("tokenCount", 0) for result in response_body.get("results", [])) + total_tokens = input_tokens + completion_tokens + output_message_list = [ - {"role": "assistant", "content": result["outputText"]} for result in response_body.get("results", []) + {"role": "assistant", "content": result.get("outputText")} for result in response_body.get("results", []) ] bedrock_attrs["response.choices.finish_reason"] = response_body["results"][0]["completionReason"] + bedrock_attrs["response.usage.completion_tokens"] = completion_tokens + bedrock_attrs["response.usage.prompt_tokens"] = input_tokens + bedrock_attrs["response.usage.total_tokens"] = total_tokens bedrock_attrs["output_message_list"] = output_message_list return bedrock_attrs +def extract_bedrock_mistral_text_model_request(request_body, bedrock_attrs): + request_body = json.loads(request_body) + bedrock_attrs["input_message_list"] = [{"role": "user", "content": request_body.get("prompt")}] + bedrock_attrs["request.max_tokens"] = request_body.get("max_tokens") + bedrock_attrs["request.temperature"] = request_body.get("temperature") + return bedrock_attrs + + def extract_bedrock_mistral_text_model_response(response_body, bedrock_attrs): if response_body: response_body = json.loads(response_body) @@ -319,17 +336,6 @@ def extract_bedrock_mistral_text_model_response(response_body, bedrock_attrs): return bedrock_attrs -def extract_bedrock_titan_text_model_streaming_response(response_body, bedrock_attrs): - if response_body: - if "outputText" in response_body: - bedrock_attrs["output_message_list"] = messages = bedrock_attrs.get("output_message_list", []) - messages.append({"role": "assistant", "content": response_body["outputText"]}) - - bedrock_attrs["response.choices.finish_reason"] = response_body.get("completionReason", None) - - return bedrock_attrs - - def extract_bedrock_mistral_text_model_streaming_response(response_body, bedrock_attrs): if response_body: outputs = response_body.get("outputs") @@ -338,14 +344,46 @@ def extract_bedrock_mistral_text_model_streaming_response(response_body, bedrock "output_message_list", [{"role": "assistant", "content": ""}] ) bedrock_attrs["output_message_list"][0]["content"] += outputs[0].get("text", "") - bedrock_attrs["response.choices.finish_reason"] = outputs[0].get("stop_reason", None) + bedrock_attrs["response.choices.finish_reason"] = outputs[0].get("stop_reason") return bedrock_attrs -def extract_bedrock_titan_embedding_model_request(request_body, bedrock_attrs): +def extract_bedrock_titan_text_model_request(request_body, bedrock_attrs): request_body = json.loads(request_body) + request_config = request_body.get("textGenerationConfig", {}) - bedrock_attrs["input"] = request_body.get("inputText") + input_message_list = [{"role": "user", "content": request_body.get("inputText")}] + + bedrock_attrs["input_message_list"] = input_message_list + bedrock_attrs["request.max_tokens"] = request_config.get("maxTokenCount") + bedrock_attrs["request.temperature"] = request_config.get("temperature") + + return bedrock_attrs + + +def extract_bedrock_titan_text_model_streaming_response(response_body, bedrock_attrs): + if response_body: + if "outputText" in response_body: + bedrock_attrs["output_message_list"] = messages = bedrock_attrs.get("output_message_list", []) + messages.append({"role": "assistant", "content": response_body["outputText"]}) + + bedrock_attrs["response.choices.finish_reason"] = response_body.get("completionReason") + + # Extract token information + invocation_metrics = response_body.get("amazon-bedrock-invocationMetrics", {}) + prompt_tokens = invocation_metrics.get("inputTokenCount", 0) + completion_tokens = invocation_metrics.get("outputTokenCount", 0) + total_tokens = prompt_tokens + completion_tokens + + bedrock_attrs["response.usage.completion_tokens"] = ( + bedrock_attrs.get("response.usage.completion_tokens", 0) + completion_tokens + ) + bedrock_attrs["response.usage.prompt_tokens"] = ( + bedrock_attrs.get("response.usage.prompt_tokens", 0) + prompt_tokens + ) + bedrock_attrs["response.usage.total_tokens"] = ( + bedrock_attrs.get("response.usage.total_tokens", 0) + total_tokens + ) return bedrock_attrs @@ -409,6 +447,17 @@ def extract_bedrock_claude_model_response(response_body, bedrock_attrs): output_message_list = [{"role": role, "content": content}] bedrock_attrs["response.choices.finish_reason"] = response_body.get("stop_reason") bedrock_attrs["output_message_list"] = output_message_list + bedrock_attrs[""] = str(response_body.get("id")) + + # Extract token information + token_usage = response_body.get("usage", {}) + if token_usage: + prompt_tokens = token_usage.get("input_tokens", 0) + completion_tokens = token_usage.get("output_tokens", 0) + total_tokens = prompt_tokens + completion_tokens + bedrock_attrs["response.usage.prompt_tokens"] = prompt_tokens + bedrock_attrs["response.usage.completion_tokens"] = completion_tokens + bedrock_attrs["response.usage.total_tokens"] = total_tokens return bedrock_attrs @@ -420,6 +469,23 @@ def extract_bedrock_claude_model_streaming_response(response_body, bedrock_attrs bedrock_attrs["output_message_list"] = [{"role": "assistant", "content": ""}] bedrock_attrs["output_message_list"][0]["content"] += content bedrock_attrs["response.choices.finish_reason"] = response_body.get("stop_reason") + + # Extract token information + invocation_metrics = response_body.get("amazon-bedrock-invocationMetrics", {}) + prompt_tokens = invocation_metrics.get("inputTokenCount", 0) + completion_tokens = invocation_metrics.get("outputTokenCount", 0) + total_tokens = prompt_tokens + completion_tokens + + bedrock_attrs["response.usage.completion_tokens"] = ( + bedrock_attrs.get("response.usage.completion_tokens", 0) + completion_tokens + ) + bedrock_attrs["response.usage.prompt_tokens"] = ( + bedrock_attrs.get("response.usage.prompt_tokens", 0) + prompt_tokens + ) + bedrock_attrs["response.usage.total_tokens"] = ( + bedrock_attrs.get("response.usage.total_tokens", 0) + total_tokens + ) + return bedrock_attrs @@ -440,6 +506,13 @@ def extract_bedrock_llama_model_response(response_body, bedrock_attrs): response_body = json.loads(response_body) output_message_list = [{"role": "assistant", "content": response_body.get("generation")}] + prompt_tokens = response_body.get("prompt_token_count", 0) + completion_tokens = response_body.get("generation_token_count", 0) + total_tokens = prompt_tokens + completion_tokens + + bedrock_attrs["response.usage.completion_tokens"] = completion_tokens + bedrock_attrs["response.usage.prompt_tokens"] = prompt_tokens + bedrock_attrs["response.usage.total_tokens"] = total_tokens bedrock_attrs["response.choices.finish_reason"] = response_body.get("stop_reason") bedrock_attrs["output_message_list"] = output_message_list @@ -453,6 +526,22 @@ def extract_bedrock_llama_model_streaming_response(response_body, bedrock_attrs) bedrock_attrs["output_message_list"] = [{"role": "assistant", "content": ""}] bedrock_attrs["output_message_list"][0]["content"] += content bedrock_attrs["response.choices.finish_reason"] = response_body.get("stop_reason") + + # Extract token information + invocation_metrics = response_body.get("amazon-bedrock-invocationMetrics", {}) + prompt_tokens = invocation_metrics.get("inputTokenCount", 0) + completion_tokens = invocation_metrics.get("outputTokenCount", 0) + total_tokens = prompt_tokens + completion_tokens + + bedrock_attrs["response.usage.completion_tokens"] = ( + bedrock_attrs.get("response.usage.completion_tokens", 0) + completion_tokens + ) + bedrock_attrs["response.usage.prompt_tokens"] = ( + bedrock_attrs.get("response.usage.prompt_tokens", 0) + prompt_tokens + ) + bedrock_attrs["response.usage.total_tokens"] = ( + bedrock_attrs.get("response.usage.total_tokens", 0) + total_tokens + ) return bedrock_attrs @@ -493,12 +582,33 @@ def extract_bedrock_cohere_model_streaming_response(response_body, bedrock_attrs bedrock_attrs["response.choices.finish_reason"] = response_body["generations"][0]["finish_reason"] bedrock_attrs["response_id"] = str(response_body.get("id")) + # Extract token information + invocation_metrics = response_body.get("amazon-bedrock-invocationMetrics", {}) + prompt_tokens = invocation_metrics.get("inputTokenCount", 0) + completion_tokens = invocation_metrics.get("outputTokenCount", 0) + total_tokens = prompt_tokens + completion_tokens + + bedrock_attrs["response.usage.completion_tokens"] = ( + bedrock_attrs.get("response.usage.completion_tokens", 0) + completion_tokens + ) + bedrock_attrs["response.usage.prompt_tokens"] = ( + bedrock_attrs.get("response.usage.prompt_tokens", 0) + prompt_tokens + ) + bedrock_attrs["response.usage.total_tokens"] = ( + bedrock_attrs.get("response.usage.total_tokens", 0) + total_tokens + ) + return bedrock_attrs NULL_EXTRACTOR = lambda *args: {} # noqa: E731 # Empty extractor that returns nothing MODEL_EXTRACTORS = [ # Order is important here, avoiding dictionaries - ("amazon.titan-embed", extract_bedrock_titan_embedding_model_request, NULL_EXTRACTOR, NULL_EXTRACTOR), + ( + "amazon.titan-embed", + extract_bedrock_titan_embedding_model_request, + extract_bedrock_titan_embedding_model_response, + NULL_EXTRACTOR, + ), ("cohere.embed", extract_bedrock_cohere_embedding_model_request, NULL_EXTRACTOR, NULL_EXTRACTOR), ( "amazon.titan", @@ -550,8 +660,8 @@ def handle_bedrock_exception( input_message_list = [] bedrock_attrs["input_message_list"] = input_message_list - bedrock_attrs["request.max_tokens"] = kwargs.get("inferenceConfig", {}).get("maxTokens", None) - bedrock_attrs["request.temperature"] = kwargs.get("inferenceConfig", {}).get("temperature", None) + bedrock_attrs["request.max_tokens"] = kwargs.get("inferenceConfig", {}).get("maxTokens") + bedrock_attrs["request.temperature"] = kwargs.get("inferenceConfig", {}).get("temperature") try: request_extractor(request_body, bedrock_attrs) @@ -801,6 +911,7 @@ def _wrap_bedrock_runtime_converse(wrapped, instance, args, kwargs): try: # For aioboto3 clients, this will call make_api_call instrumentation in external_aiobotocore response = wrapped(*args, **kwargs) + except Exception as exc: handle_bedrock_exception( exc, False, model, span_id, trace_id, request_extractor, {}, ft, transaction, kwargs, is_converse=True @@ -848,6 +959,10 @@ def extract_bedrock_converse_attrs(kwargs, response, response_headers, model, sp for result in response.get("output").get("message").get("content", []) ] + response_prompt_tokens = response.get("usage", {}).get("inputTokens") if response else None + response_completion_tokens = response.get("usage", {}).get("outputTokens") if response else None + response_total_tokens = response.get("usage", {}).get("totalTokens") if response else None + bedrock_attrs = { "request_id": response_headers.get("x-amzn-requestid"), "model": model, @@ -855,9 +970,12 @@ def extract_bedrock_converse_attrs(kwargs, response, response_headers, model, sp "trace_id": trace_id, "response.choices.finish_reason": response.get("stopReason"), "output_message_list": output_message_list, - "request.max_tokens": kwargs.get("inferenceConfig", {}).get("maxTokens", None), - "request.temperature": kwargs.get("inferenceConfig", {}).get("temperature", None), + "request.max_tokens": kwargs.get("inferenceConfig", {}).get("maxTokens"), + "request.temperature": kwargs.get("inferenceConfig", {}).get("temperature"), "input_message_list": input_message_list, + "response.usage.prompt_tokens": response_prompt_tokens, + "response.usage.completion_tokens": response_completion_tokens, + "response.usage.total_tokens": response_total_tokens, } return bedrock_attrs @@ -1008,29 +1126,34 @@ def handle_embedding_event(transaction, bedrock_attrs): custom_attrs_dict = transaction._custom_params llm_metadata_dict = {key: value for key, value in custom_attrs_dict.items() if key.startswith("llm.")} - span_id = bedrock_attrs.get("span_id", None) - trace_id = bedrock_attrs.get("trace_id", None) - request_id = bedrock_attrs.get("request_id", None) - model = bedrock_attrs.get("model", None) + span_id = bedrock_attrs.get("span_id") + trace_id = bedrock_attrs.get("trace_id") + request_id = bedrock_attrs.get("request_id") + model = bedrock_attrs.get("model") input_ = bedrock_attrs.get("input") + response_total_tokens = bedrock_attrs.get("response.usage.total_tokens") + + total_tokens = ( + settings.ai_monitoring.llm_token_count_callback(model, input_) + if settings.ai_monitoring.llm_token_count_callback and input_ + else response_total_tokens + ) + embedding_dict = { "vendor": "bedrock", "ingest_source": "Python", "id": embedding_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(model, input_) - if settings.ai_monitoring.llm_token_count_callback - else None - ), "request_id": request_id, - "duration": bedrock_attrs.get("duration", None), + "duration": bedrock_attrs.get("duration"), "request.model": model, "response.model": model, - "error": bedrock_attrs.get("error", None), + "response.usage.total_tokens": total_tokens, + "error": bedrock_attrs.get("error"), } + embedding_dict.update(llm_metadata_dict) if settings.ai_monitoring.record_content.enabled: @@ -1041,6 +1164,7 @@ def handle_embedding_event(transaction, bedrock_attrs): def handle_chat_completion_event(transaction, bedrock_attrs): + settings = transaction.settings or global_settings() chat_completion_id = str(uuid.uuid4()) # Grab LLM-related custom attributes off of the transaction to store as metadata on LLM events custom_attrs_dict = transaction._custom_params @@ -1049,11 +1173,15 @@ def handle_chat_completion_event(transaction, bedrock_attrs): llm_context_attrs = getattr(transaction, "_llm_context_attrs", None) if llm_context_attrs: llm_metadata_dict.update(llm_context_attrs) - span_id = bedrock_attrs.get("span_id", None) - trace_id = bedrock_attrs.get("trace_id", None) - request_id = bedrock_attrs.get("request_id", None) - response_id = bedrock_attrs.get("response_id", None) - model = bedrock_attrs.get("model", None) + span_id = bedrock_attrs.get("span_id") + trace_id = bedrock_attrs.get("trace_id") + request_id = bedrock_attrs.get("request_id") + response_id = bedrock_attrs.get("response_id") + model = bedrock_attrs.get("model") + + response_prompt_tokens = bedrock_attrs.get("response.usage.prompt_tokens") + response_completion_tokens = bedrock_attrs.get("response.usage.completion_tokens") + response_total_tokens = bedrock_attrs.get("response.usage.total_tokens") input_message_list = bedrock_attrs.get("input_message_list", []) output_message_list = bedrock_attrs.get("output_message_list", []) @@ -1061,6 +1189,25 @@ def handle_chat_completion_event(transaction, bedrock_attrs): len(input_message_list) + len(output_message_list) ) or None # If 0, attribute will be set to None and removed + input_message_content = " ".join([msg.get("content") for msg in input_message_list if msg.get("content")]) + prompt_tokens = ( + settings.ai_monitoring.llm_token_count_callback(model, input_message_content) + if settings.ai_monitoring.llm_token_count_callback and input_message_content + else response_prompt_tokens + ) + + output_message_content = " ".join([msg.get("content") for msg in output_message_list if msg.get("content")]) + completion_tokens = ( + settings.ai_monitoring.llm_token_count_callback(model, output_message_content) + if settings.ai_monitoring.llm_token_count_callback and output_message_content + else response_completion_tokens + ) + total_tokens = ( + prompt_tokens + completion_tokens if all([prompt_tokens, completion_tokens]) else response_total_tokens + ) + + all_token_counts = bool(prompt_tokens and completion_tokens and total_tokens) + chat_completion_summary_dict = { "vendor": "bedrock", "ingest_source": "Python", @@ -1069,15 +1216,21 @@ def handle_chat_completion_event(transaction, bedrock_attrs): "trace_id": trace_id, "request_id": request_id, "response_id": response_id, - "duration": bedrock_attrs.get("duration", None), - "request.max_tokens": bedrock_attrs.get("request.max_tokens", None), - "request.temperature": bedrock_attrs.get("request.temperature", None), + "duration": bedrock_attrs.get("duration"), + "request.max_tokens": bedrock_attrs.get("request.max_tokens"), + "request.temperature": bedrock_attrs.get("request.temperature"), "request.model": model, "response.model": model, # Duplicate data required by the UI "response.number_of_messages": number_of_messages, - "response.choices.finish_reason": bedrock_attrs.get("response.choices.finish_reason", None), - "error": bedrock_attrs.get("error", None), + "response.choices.finish_reason": bedrock_attrs.get("response.choices.finish_reason"), + "error": bedrock_attrs.get("error"), } + + if all_token_counts: + chat_completion_summary_dict["response.usage.prompt_tokens"] = prompt_tokens + chat_completion_summary_dict["response.usage.completion_tokens"] = completion_tokens + chat_completion_summary_dict["response.usage.total_tokens"] = total_tokens + chat_completion_summary_dict.update(llm_metadata_dict) chat_completion_summary_dict = {k: v for k, v in chat_completion_summary_dict.items() if v is not None} transaction.record_custom_event("LlmChatCompletionSummary", chat_completion_summary_dict) @@ -1092,6 +1245,7 @@ def handle_chat_completion_event(transaction, bedrock_attrs): request_model=model, request_id=request_id, llm_metadata_dict=llm_metadata_dict, + all_token_counts=all_token_counts, response_id=response_id, ) diff --git a/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py b/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py index da9c5818e7..87dfa1f1b6 100644 --- a/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py +++ b/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py @@ -17,7 +17,7 @@ from conftest import BOTOCORE_VERSION from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -49,6 +49,9 @@ "duration": None, # Response time varies each test run "request.model": "anthropic.claude-3-sonnet-20240229-v1:0", "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", + "response.usage.prompt_tokens": 26, + "response.usage.completion_tokens": 100, + "response.usage.total_tokens": 126, "request.temperature": 0.7, "request.max_tokens": 100, "response.choices.finish_reason": "max_tokens", @@ -70,6 +73,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", "vendor": "bedrock", "ingest_source": "Python", @@ -88,6 +92,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", "vendor": "bedrock", "ingest_source": "Python", @@ -106,6 +111,7 @@ "role": "assistant", "completion_id": None, "sequence": 2, + "token_count": 0, "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", "vendor": "bedrock", "ingest_source": "Python", @@ -189,7 +195,7 @@ def _test(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) def test_bedrock_chat_completion_with_token_count(set_trace_info, exercise_model): - @validate_custom_events(add_token_count_to_events(chat_completion_expected_events)) + @validate_custom_events(add_token_counts_to_chat_events(chat_completion_expected_events)) # One summary event, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( @@ -476,46 +482,3 @@ def _test(): converse_invalid_model(loop, bedrock_converse_server) _test() - - -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_chat_completion_error_incorrect_access_key_with_token_count( - monkeypatch, bedrock_converse_server, loop, set_trace_info -): - """ - A request is made to the server with invalid credentials. botocore will reach out to the server and receive an - UnrecognizedClientException as a response. Information from the request will be parsed and reported in customer - events. The error response can also be parsed, and will be included as attributes on the recorded exception. - """ - - @validate_custom_events(add_token_count_to_events(chat_completion_invalid_access_key_error_events)) - @validate_error_trace_attributes( - _client_error_name, - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "http.statusCode": 403, - "error.message": "The security token included in the request is invalid.", - "error.code": "UnrecognizedClientException", - }, - }, - ) - @validate_transaction_metrics( - name="test_bedrock_chat_completion_incorrect_access_key_with_token_count", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, - ) - @background_task(name="test_bedrock_chat_completion_incorrect_access_key_with_token_count") - def _test(): - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - converse_incorrect_access_key(loop, bedrock_converse_server, monkeypatch) - - _test() diff --git a/tests/external_aiobotocore/test_bedrock_chat_completion_invoke_model.py b/tests/external_aiobotocore/test_bedrock_chat_completion_invoke_model.py index 65cb276c77..e3a897d0c8 100644 --- a/tests/external_aiobotocore/test_bedrock_chat_completion_invoke_model.py +++ b/tests/external_aiobotocore/test_bedrock_chat_completion_invoke_model.py @@ -34,7 +34,8 @@ ) from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_streaming_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, disabled_ai_monitoring_streaming_settings, @@ -206,7 +207,7 @@ def _test(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) def test_bedrock_chat_completion_with_token_count(set_trace_info, exercise_model, expected_events, expected_metrics): - @validate_custom_events(add_token_count_to_events(expected_events)) + @validate_custom_events(add_token_counts_to_chat_events(add_token_count_streaming_events(expected_events))) # One summary event, one user message, and one response message from the assistant @validate_custom_event_count(count=3) @validate_transaction_metrics( @@ -455,51 +456,6 @@ def _test(): _test() -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_chat_completion_error_incorrect_access_key_with_token( - monkeypatch, - bedrock_server, - exercise_model, - set_trace_info, - expected_invalid_access_key_error_events, - expected_metrics, -): - @validate_custom_events(add_token_count_to_events(expected_invalid_access_key_error_events)) - @validate_error_trace_attributes( - _client_error_name, - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "http.statusCode": 403, - "error.message": "The security token included in the request is invalid.", - "error.code": "UnrecognizedClientException", - }, - }, - ) - @validate_transaction_metrics( - name="test_bedrock_chat_completion", - scoped_metrics=expected_metrics, - rollup_metrics=expected_metrics, - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, - ) - @background_task(name="test_bedrock_chat_completion") - def _test(): - monkeypatch.setattr(bedrock_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY") - - with pytest.raises(_client_error): # not sure where this exception actually comes from - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - exercise_model(prompt="Invalid Token", temperature=0.7, max_tokens=100) - - _test() - - def invoke_model_malformed_request_body(loop, bedrock_server, response_streaming): async def _coro(): with pytest.raises(_client_error): @@ -798,58 +754,6 @@ async def _test(): loop.run_until_complete(_test()) -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_expected_streaming_error_events)) -@validate_custom_event_count(count=2) -@validate_error_trace_attributes( - _event_stream_error_name, - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "error.message": "Malformed input request, please reformat your input and try again.", - "error.code": "ValidationException", - }, - }, - forgone_params={"agent": (), "intrinsic": (), "user": ("http.statusCode")}, -) -@validate_transaction_metrics( - name="test_bedrock_chat_completion", - scoped_metrics=[("Llm/completion/Bedrock/invoke_model_with_response_stream", 1)], - rollup_metrics=[("Llm/completion/Bedrock/invoke_model_with_response_stream", 1)], - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, -) -@background_task(name="test_bedrock_chat_completion") -def test_bedrock_chat_completion_error_streaming_exception_with_token_count(loop, bedrock_server, set_trace_info): - """ - Duplicate of test_bedrock_chat_completion_error_streaming_exception, but with token callback being set. - - See the original test for a description of the error case. - """ - - async def _test(): - with pytest.raises(_event_stream_error): - model = "amazon.titan-text-express-v1" - body = (chat_completion_payload_templates[model] % ("Streaming Exception", 0.7, 100)).encode("utf-8") - - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - response = await bedrock_server.invoke_model_with_response_stream( - body=body, modelId=model, accept="application/json", contentType="application/json" - ) - - body = response.get("body") - async for resp in body: - assert resp - - loop.run_until_complete(_test()) - - def test_bedrock_chat_completion_functions_marked_as_wrapped_for_sdk_compatibility(bedrock_server): assert bedrock_server._nr_wrapped diff --git a/tests/external_aiobotocore/test_bedrock_embeddings.py b/tests/external_aiobotocore/test_bedrock_embeddings.py index 96b930feb5..dacfbb4eed 100644 --- a/tests/external_aiobotocore/test_bedrock_embeddings.py +++ b/tests/external_aiobotocore/test_bedrock_embeddings.py @@ -27,7 +27,7 @@ ) from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_to_embedding_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -164,7 +164,7 @@ def _test(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) def test_bedrock_embedding_with_token_count(set_trace_info, exercise_model, expected_events): - @validate_custom_events(add_token_count_to_events(expected_events)) + @validate_custom_events(add_token_count_to_embedding_events(expected_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_bedrock_embedding", @@ -289,45 +289,6 @@ def _test(): _test() -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_embedding_error_incorrect_access_key_with_token_count( - monkeypatch, bedrock_server, exercise_model, set_trace_info, expected_invalid_access_key_error_events -): - @validate_custom_events(add_token_count_to_events(expected_invalid_access_key_error_events)) - @validate_error_trace_attributes( - _client_error_name, - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "http.statusCode": 403, - "error.message": "The security token included in the request is invalid.", - "error.code": "UnrecognizedClientException", - }, - }, - ) - @validate_transaction_metrics( - name="test_bedrock_embedding", - scoped_metrics=[("Llm/embedding/Bedrock/invoke_model", 1)], - rollup_metrics=[("Llm/embedding/Bedrock/invoke_model", 1)], - background_task=True, - ) - @background_task(name="test_bedrock_embedding") - def _test(): - monkeypatch.setattr(bedrock_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY") - - with pytest.raises(_client_error): # not sure where this exception actually comes from - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - exercise_model(prompt="Invalid Token") - - _test() - - @reset_core_stats_engine() @validate_custom_events(embedding_expected_malformed_request_body_events) @validate_custom_event_count(count=1) diff --git a/tests/external_botocore/_test_bedrock_chat_completion.py b/tests/external_botocore/_test_bedrock_chat_completion.py index 155b6c993c..6b65af8cb2 100644 --- a/tests/external_botocore/_test_bedrock_chat_completion.py +++ b/tests/external_botocore/_test_bedrock_chat_completion.py @@ -97,6 +97,9 @@ "duration": None, # Response time varies each test run "request.model": "amazon.titan-text-express-v1", "response.model": "amazon.titan-text-express-v1", + "response.usage.completion_tokens": 32, + "response.usage.total_tokens": 44, + "response.usage.prompt_tokens": 12, "request.temperature": 0.7, "request.max_tokens": 100, "response.choices.finish_reason": "FINISH", @@ -118,6 +121,7 @@ "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "amazon.titan-text-express-v1", "vendor": "bedrock", "ingest_source": "Python", @@ -136,6 +140,7 @@ "role": "assistant", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "amazon.titan-text-express-v1", "vendor": "bedrock", "ingest_source": "Python", @@ -335,6 +340,9 @@ "duration": None, # Response time varies each test run "request.model": "meta.llama2-13b-chat-v1", "response.model": "meta.llama2-13b-chat-v1", + "response.usage.prompt_tokens": 17, + "response.usage.completion_tokens": 69, + "response.usage.total_tokens": 86, "request.temperature": 0.7, "request.max_tokens": 100, "response.choices.finish_reason": "stop", @@ -356,6 +364,7 @@ "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "meta.llama2-13b-chat-v1", "vendor": "bedrock", "ingest_source": "Python", @@ -374,6 +383,7 @@ "role": "assistant", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "meta.llama2-13b-chat-v1", "vendor": "bedrock", "ingest_source": "Python", @@ -919,6 +929,9 @@ "duration": None, # Response time varies each test run "request.model": "amazon.titan-text-express-v1", "response.model": "amazon.titan-text-express-v1", + "response.usage.completion_tokens": 35, + "response.usage.total_tokens": 47, + "response.usage.prompt_tokens": 12, "request.temperature": 0.7, "request.max_tokens": 100, "response.choices.finish_reason": "FINISH", @@ -940,6 +953,7 @@ "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "amazon.titan-text-express-v1", "vendor": "bedrock", "ingest_source": "Python", @@ -958,6 +972,7 @@ "role": "assistant", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "amazon.titan-text-express-v1", "vendor": "bedrock", "ingest_source": "Python", @@ -978,6 +993,9 @@ "duration": None, # Response time varies each test run "request.model": "anthropic.claude-instant-v1", "response.model": "anthropic.claude-instant-v1", + "response.usage.completion_tokens": 99, + "response.usage.prompt_tokens": 19, + "response.usage.total_tokens": 118, "request.temperature": 0.7, "request.max_tokens": 100, "response.choices.finish_reason": "stop_sequence", @@ -999,6 +1017,7 @@ "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "anthropic.claude-instant-v1", "vendor": "bedrock", "ingest_source": "Python", @@ -1017,6 +1036,7 @@ "role": "assistant", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "anthropic.claude-instant-v1", "vendor": "bedrock", "ingest_source": "Python", @@ -1038,6 +1058,9 @@ "duration": None, # Response time varies each test run "request.model": "cohere.command-text-v14", "response.model": "cohere.command-text-v14", + "response.usage.completion_tokens": 91, + "response.usage.total_tokens": 100, + "response.usage.prompt_tokens": 9, "request.temperature": 0.7, "request.max_tokens": 100, "response.choices.finish_reason": "COMPLETE", @@ -1059,6 +1082,7 @@ "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "cohere.command-text-v14", "vendor": "bedrock", "ingest_source": "Python", @@ -1077,6 +1101,7 @@ "role": "assistant", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "cohere.command-text-v14", "vendor": "bedrock", "ingest_source": "Python", @@ -1097,6 +1122,9 @@ "duration": None, # Response time varies each test run "request.model": "meta.llama2-13b-chat-v1", "response.model": "meta.llama2-13b-chat-v1", + "response.usage.prompt_tokens": 17, + "response.usage.completion_tokens": 100, + "response.usage.total_tokens": 117, "request.temperature": 0.7, "request.max_tokens": 100, "response.choices.finish_reason": "length", @@ -1118,6 +1146,7 @@ "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "meta.llama2-13b-chat-v1", "vendor": "bedrock", "ingest_source": "Python", @@ -1136,6 +1165,7 @@ "role": "assistant", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "meta.llama2-13b-chat-v1", "vendor": "bedrock", "ingest_source": "Python", diff --git a/tests/external_botocore/_test_bedrock_embeddings.py b/tests/external_botocore/_test_bedrock_embeddings.py index f5c227b9c3..af544af001 100644 --- a/tests/external_botocore/_test_bedrock_embeddings.py +++ b/tests/external_botocore/_test_bedrock_embeddings.py @@ -33,6 +33,7 @@ "response.model": "amazon.titan-embed-text-v1", "request.model": "amazon.titan-embed-text-v1", "request_id": "11233989-07e8-4ecb-9ba6-79601ba6d8cc", + "response.usage.total_tokens": 6, "vendor": "bedrock", "ingest_source": "Python", }, @@ -52,6 +53,7 @@ "response.model": "amazon.titan-embed-g1-text-02", "request.model": "amazon.titan-embed-g1-text-02", "request_id": "b10ac895-eae3-4f07-b926-10b2866c55ed", + "response.usage.total_tokens": 6, "vendor": "bedrock", "ingest_source": "Python", }, diff --git a/tests/external_botocore/test_bedrock_chat_completion_invoke_model.py b/tests/external_botocore/test_bedrock_chat_completion_invoke_model.py index 94a88e7a56..7a471b950e 100644 --- a/tests/external_botocore/test_bedrock_chat_completion_invoke_model.py +++ b/tests/external_botocore/test_bedrock_chat_completion_invoke_model.py @@ -11,6 +11,7 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. + import json import os from io import BytesIO @@ -35,7 +36,8 @@ from conftest import BOTOCORE_VERSION from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_streaming_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, disabled_ai_monitoring_streaming_settings, @@ -129,6 +131,14 @@ def expected_events(model_id, response_streaming): return chat_completion_expected_events[model_id] +@pytest.fixture(scope="module") +def expected_events(model_id, response_streaming): + if response_streaming: + return chat_completion_streaming_expected_events[model_id] + else: + return chat_completion_expected_events[model_id] + + @pytest.fixture(scope="module") def expected_metrics(response_streaming): if response_streaming: @@ -200,7 +210,7 @@ def _test(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) def test_bedrock_chat_completion_with_token_count(set_trace_info, exercise_model, expected_events, expected_metrics): - @validate_custom_events(add_token_count_to_events(expected_events)) + @validate_custom_events(add_token_counts_to_chat_events(add_token_count_streaming_events(expected_events))) # One summary event, one user message, and one response message from the assistant @validate_custom_event_count(count=3) @validate_transaction_metrics( @@ -438,49 +448,50 @@ def _test(): _test() -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_chat_completion_error_incorrect_access_key_with_token( - monkeypatch, - bedrock_server, - exercise_model, - set_trace_info, - expected_invalid_access_key_error_events, - expected_metrics, -): - @validate_custom_events(add_token_count_to_events(expected_invalid_access_key_error_events)) - @validate_error_trace_attributes( - _client_error_name, - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "http.statusCode": 403, - "error.message": "The security token included in the request is invalid.", - "error.code": "UnrecognizedClientException", - }, - }, - ) - @validate_transaction_metrics( - name="test_bedrock_chat_completion", - scoped_metrics=expected_metrics, - rollup_metrics=expected_metrics, - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, - ) - @background_task(name="test_bedrock_chat_completion") - def _test(): - monkeypatch.setattr(bedrock_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY") - - with pytest.raises(_client_error): # not sure where this exception actually comes from - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - exercise_model(prompt="Invalid Token", temperature=0.7, max_tokens=100) - - _test() +# +# @reset_core_stats_engine() +# @override_llm_token_callback_settings(llm_token_count_callback) +# def test_bedrock_chat_completion_error_incorrect_access_key_with_token( +# monkeypatch, +# bedrock_server, +# exercise_model, +# set_trace_info, +# expected_invalid_access_key_error_events, +# expected_metrics, +# ): +# @validate_custom_events(add_token_count_to_events(expected_invalid_access_key_error_events)) +# @validate_error_trace_attributes( +# _client_error_name, +# exact_attrs={ +# "agent": {}, +# "intrinsic": {}, +# "user": { +# "http.statusCode": 403, +# "error.message": "The security token included in the request is invalid.", +# "error.code": "UnrecognizedClientException", +# }, +# }, +# ) +# @validate_transaction_metrics( +# name="test_bedrock_chat_completion", +# scoped_metrics=expected_metrics, +# rollup_metrics=expected_metrics, +# custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], +# background_task=True, +# ) +# @background_task(name="test_bedrock_chat_completion") +# def _test(): +# monkeypatch.setattr(bedrock_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY") +# +# with pytest.raises(_client_error): # not sure where this exception actually comes from +# set_trace_info() +# add_custom_attribute("llm.conversation_id", "my-awesome-id") +# add_custom_attribute("llm.foo", "bar") +# add_custom_attribute("non_llm_attr", "python-agent") +# +# exercise_model(prompt="Invalid Token", temperature=0.7, max_tokens=100) +# +# _test() @reset_core_stats_engine() @@ -762,55 +773,6 @@ def _test(): _test() -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_chat_completion_error_streaming_exception_with_token_count(bedrock_server, set_trace_info): - """ - Duplicate of test_bedrock_chat_completion_error_streaming_exception, but with token callback being set. - - See the original test for a description of the error case. - """ - - @validate_custom_events(add_token_count_to_events(chat_completion_expected_streaming_error_events)) - @validate_custom_event_count(count=2) - @validate_error_trace_attributes( - _event_stream_error_name, - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "error.message": "Malformed input request, please reformat your input and try again.", - "error.code": "ValidationException", - }, - }, - forgone_params={"agent": (), "intrinsic": (), "user": ("http.statusCode")}, - ) - @validate_transaction_metrics( - name="test_bedrock_chat_completion", - scoped_metrics=[("Llm/completion/Bedrock/invoke_model_with_response_stream", 1)], - rollup_metrics=[("Llm/completion/Bedrock/invoke_model_with_response_stream", 1)], - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, - ) - @background_task(name="test_bedrock_chat_completion") - def _test(): - with pytest.raises(_event_stream_error): - model = "amazon.titan-text-express-v1" - body = (chat_completion_payload_templates[model] % ("Streaming Exception", 0.7, 100)).encode("utf-8") - - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - response = bedrock_server.invoke_model_with_response_stream( - body=body, modelId=model, accept="application/json", contentType="application/json" - ) - list(response["body"]) # Iterate - - _test() - - def test_bedrock_chat_completion_functions_marked_as_wrapped_for_sdk_compatibility(bedrock_server): assert bedrock_server._nr_wrapped diff --git a/tests/external_botocore/test_bedrock_embeddings.py b/tests/external_botocore/test_bedrock_embeddings.py index 417e24b2d9..de2cb201e7 100644 --- a/tests/external_botocore/test_bedrock_embeddings.py +++ b/tests/external_botocore/test_bedrock_embeddings.py @@ -28,7 +28,7 @@ from conftest import BOTOCORE_VERSION from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_to_embedding_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -161,7 +161,7 @@ def _test(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) def test_bedrock_embedding_with_token_count(set_trace_info, exercise_model, expected_events): - @validate_custom_events(add_token_count_to_events(expected_events)) + @validate_custom_events(add_token_count_to_embedding_events(expected_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_bedrock_embedding", @@ -286,45 +286,6 @@ def _test(): _test() -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_embedding_error_incorrect_access_key_with_token_count( - monkeypatch, bedrock_server, exercise_model, set_trace_info, expected_invalid_access_key_error_events -): - @validate_custom_events(add_token_count_to_events(expected_invalid_access_key_error_events)) - @validate_error_trace_attributes( - _client_error_name, - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "http.statusCode": 403, - "error.message": "The security token included in the request is invalid.", - "error.code": "UnrecognizedClientException", - }, - }, - ) - @validate_transaction_metrics( - name="test_bedrock_embedding", - scoped_metrics=[("Llm/embedding/Bedrock/invoke_model", 1)], - rollup_metrics=[("Llm/embedding/Bedrock/invoke_model", 1)], - background_task=True, - ) - @background_task(name="test_bedrock_embedding") - def _test(): - monkeypatch.setattr(bedrock_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY") - - with pytest.raises(_client_error): # not sure where this exception actually comes from - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - exercise_model(prompt="Invalid Token") - - _test() - - @reset_core_stats_engine() def test_bedrock_embedding_error_malformed_request_body(bedrock_server, set_trace_info): """ diff --git a/tests/external_botocore/test_chat_completion_converse.py b/tests/external_botocore/test_chat_completion_converse.py index 96ead41dd7..2d38d6b4a4 100644 --- a/tests/external_botocore/test_chat_completion_converse.py +++ b/tests/external_botocore/test_chat_completion_converse.py @@ -17,7 +17,7 @@ from conftest import BOTOCORE_VERSION from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -49,6 +49,9 @@ "duration": None, # Response time varies each test run "request.model": "anthropic.claude-3-sonnet-20240229-v1:0", "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", + "response.usage.prompt_tokens": 26, + "response.usage.completion_tokens": 100, + "response.usage.total_tokens": 126, "request.temperature": 0.7, "request.max_tokens": 100, "response.choices.finish_reason": "max_tokens", @@ -70,6 +73,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", "vendor": "bedrock", "ingest_source": "Python", @@ -88,6 +92,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", "vendor": "bedrock", "ingest_source": "Python", @@ -106,6 +111,7 @@ "role": "assistant", "completion_id": None, "sequence": 2, + "token_count": 0, "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", "vendor": "bedrock", "ingest_source": "Python", @@ -185,7 +191,7 @@ def _test(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) def test_bedrock_chat_completion_with_token_count(set_trace_info, exercise_model): - @validate_custom_events(add_token_count_to_events(chat_completion_expected_events)) + @validate_custom_events(add_token_counts_to_chat_events(chat_completion_expected_events)) # One summary event, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( @@ -468,57 +474,3 @@ def _test(): assert response _test() - - -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_chat_completion_error_incorrect_access_key_with_token_count( - monkeypatch, bedrock_converse_server, exercise_model, set_trace_info -): - """ - A request is made to the server with invalid credentials. botocore will reach out to the server and receive an - UnrecognizedClientException as a response. Information from the request will be parsed and reported in customer - events. The error response can also be parsed, and will be included as attributes on the recorded exception. - """ - - @validate_custom_events(add_token_count_to_events(chat_completion_invalid_access_key_error_events)) - @validate_error_trace_attributes( - _client_error_name, - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "http.statusCode": 403, - "error.message": "The security token included in the request is invalid.", - "error.code": "UnrecognizedClientException", - }, - }, - ) - @validate_transaction_metrics( - name="test_bedrock_chat_completion_incorrect_access_key_with_token_count", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, - ) - @background_task(name="test_bedrock_chat_completion_incorrect_access_key_with_token_count") - def _test(): - monkeypatch.setattr(bedrock_converse_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY") - - with pytest.raises(_client_error): - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - message = [{"role": "user", "content": [{"text": "Invalid Token"}]}] - - response = bedrock_converse_server.converse( - modelId="anthropic.claude-3-sonnet-20240229-v1:0", - messages=message, - inferenceConfig={"temperature": 0.7, "maxTokens": 100}, - ) - - assert response - - _test() diff --git a/tests/mlmodel_openai/test_embeddings_error.py b/tests/mlmodel_openai/test_embeddings_error.py index a8e46bf23a..f80e6ff41d 100644 --- a/tests/mlmodel_openai/test_embeddings_error.py +++ b/tests/mlmodel_openai/test_embeddings_error.py @@ -14,12 +14,10 @@ import openai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -128,35 +126,6 @@ def test_embeddings_invalid_request_error_no_model_no_content(set_trace_info): ] -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.InvalidRequestError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={ - "error.message": "The model `does-not-exist` does not exist" - # "http.statusCode": 404, - } -) -@validate_transaction_metrics( - name="test_embeddings_error:test_embeddings_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/embedding/OpenAI/create", 1)], - rollup_metrics=[("Llm/embedding/OpenAI/create", 1)], - custom_metrics=[(f"Supportability/Python/ML/OpenAI/{openai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_with_token_count(set_trace_info): - set_trace_info() - with pytest.raises(openai.InvalidRequestError): - openai.Embedding.create(input="Model does not exist.", model="does-not-exist") - - # Invalid model provided @dt_enabled @reset_core_stats_engine() @@ -348,30 +317,6 @@ def test_embeddings_invalid_request_error_no_model_async_no_content(loop, set_tr ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.InvalidRequestError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - name="test_embeddings_error:test_embeddings_invalid_request_error_invalid_model_with_token_count_async", - scoped_metrics=[("Llm/embedding/OpenAI/acreate", 1)], - rollup_metrics=[("Llm/embedding/OpenAI/acreate", 1)], - custom_metrics=[(f"Supportability/Python/ML/OpenAI/{openai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_with_token_count_async(set_trace_info, loop): - set_trace_info() - with pytest.raises(openai.InvalidRequestError): - loop.run_until_complete(openai.Embedding.acreate(input="Model does not exist.", model="does-not-exist")) - - # Invalid model provided @dt_enabled @reset_core_stats_engine() From e3b91062ecc3d380e157de229b524b7706c9709d Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Thu, 13 Nov 2025 14:54:05 -0800 Subject: [PATCH 006/124] Add Strands tools and agents instrumentation. (#1563) * Add baseline instrumentation. * Add tool and agent instrumentation. * Add tests file. * Cleanup instrumentation. * Cleanup. Co-authored-by: Tim Pansino * [MegaLinter] Apply linters fixes * Strands Mock Model (#1551) * Add strands to tox.ini * Add mock models for strands testing * Add simple test file to validate strands mocking * Add baseline instrumentation. * Add tool and agent instrumentation. * Add tests file. * Cleanup instrumentation. * Cleanup. Co-authored-by: Tim Pansino * Handle additional args in mock model. * Add test to force exception and exercise _handle_tool_streaming_completion_error. * Strands Mock Model (#1551) * Add strands to tox.ini * Add mock models for strands testing * Add simple test file to validate strands mocking * Add baseline instrumentation. * Add tool and agent instrumentation. * Add tests file. * Cleanup instrumentation. * Cleanup. Co-authored-by: Tim Pansino * Handle additional args in mock model. * Strands Mock Model (#1551) * Add strands to tox.ini * Add mock models for strands testing * Add simple test file to validate strands mocking * Add baseline instrumentation. * Add tool and agent instrumentation. * Cleanup. Co-authored-by: Tim Pansino * [MegaLinter] Apply linters fixes * Add test to force exception and exercise _handle_tool_streaming_completion_error. * Implement strands context passing instrumentation. * Address review feedback. * [MegaLinter] Apply linters fixes * Remove test_simple.py file. --------- Co-authored-by: Tim Pansino Co-authored-by: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Co-authored-by: Tim Pansino --- newrelic/api/error_trace.py | 29 +- newrelic/common/llm_utils.py | 24 + newrelic/config.py | 7 + newrelic/hooks/mlmodel_strands.py | 492 ++++++++++++++++++ tests/mlmodel_strands/_mock_model_provider.py | 4 +- tests/mlmodel_strands/conftest.py | 25 +- tests/mlmodel_strands/test_agent.py | 427 +++++++++++++++ tests/mlmodel_strands/test_simple.py | 36 -- tests/testing_support/fixtures.py | 2 +- .../validators/validate_custom_event.py | 4 +- .../validate_error_event_collector_json.py | 2 +- .../validate_transaction_error_event_count.py | 4 +- 12 files changed, 1004 insertions(+), 52 deletions(-) create mode 100644 newrelic/common/llm_utils.py create mode 100644 newrelic/hooks/mlmodel_strands.py create mode 100644 tests/mlmodel_strands/test_agent.py delete mode 100644 tests/mlmodel_strands/test_simple.py diff --git a/newrelic/api/error_trace.py b/newrelic/api/error_trace.py index db63c54316..aaa12b50e3 100644 --- a/newrelic/api/error_trace.py +++ b/newrelic/api/error_trace.py @@ -15,6 +15,7 @@ import functools from newrelic.api.time_trace import current_trace, notice_error +from newrelic.common.async_wrapper import async_wrapper as get_async_wrapper from newrelic.common.object_wrapper import FunctionWrapper, wrap_object @@ -43,17 +44,31 @@ def __exit__(self, exc, value, tb): ) -def ErrorTraceWrapper(wrapped, ignore=None, expected=None, status_code=None): - def wrapper(wrapped, instance, args, kwargs): - parent = current_trace() +def ErrorTraceWrapper(wrapped, ignore=None, expected=None, status_code=None, async_wrapper=None): + def literal_wrapper(wrapped, instance, args, kwargs): + # Determine if the wrapped function is async or sync + wrapper = async_wrapper if async_wrapper is not None else get_async_wrapper(wrapped) + # Sync function path + if not wrapper: + parent = current_trace() + if not parent: + # No active tracing context so just call the wrapped function directly + return wrapped(*args, **kwargs) + # Async function path + else: + # For async functions, the async wrapper will handle trace context propagation + parent = None - if parent is None: - return wrapped(*args, **kwargs) + trace = ErrorTrace(ignore, expected, status_code, parent=parent) + + if wrapper: + # The async wrapper handles the context management for us + return wrapper(wrapped, trace)(*args, **kwargs) - with ErrorTrace(ignore, expected, status_code, parent=parent): + with trace: return wrapped(*args, **kwargs) - return FunctionWrapper(wrapped, wrapper) + return FunctionWrapper(wrapped, literal_wrapper) def error_trace(ignore=None, expected=None, status_code=None): diff --git a/newrelic/common/llm_utils.py b/newrelic/common/llm_utils.py new file mode 100644 index 0000000000..eebdacfc7f --- /dev/null +++ b/newrelic/common/llm_utils.py @@ -0,0 +1,24 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +def _get_llm_metadata(transaction): + # Grab LLM-related custom attributes off of the transaction to store as metadata on LLM events + custom_attrs_dict = transaction._custom_params + llm_metadata_dict = {key: value for key, value in custom_attrs_dict.items() if key.startswith("llm.")} + llm_context_attrs = getattr(transaction, "_llm_context_attrs", None) + if llm_context_attrs: + llm_metadata_dict.update(llm_context_attrs) + + return llm_metadata_dict diff --git a/newrelic/config.py b/newrelic/config.py index 21ce996f6c..ff2d85e359 100644 --- a/newrelic/config.py +++ b/newrelic/config.py @@ -2946,6 +2946,13 @@ def _process_module_builtin_defaults(): "newrelic.hooks.mlmodel_autogen", "instrument_autogen_agentchat_agents__assistant_agent", ) + _process_module_definition("strands.agent.agent", "newrelic.hooks.mlmodel_strands", "instrument_agent_agent") + _process_module_definition( + "strands.tools.executors._executor", "newrelic.hooks.mlmodel_strands", "instrument_tools_executors__executor" + ) + _process_module_definition("strands.tools.registry", "newrelic.hooks.mlmodel_strands", "instrument_tools_registry") + _process_module_definition("strands.models.bedrock", "newrelic.hooks.mlmodel_strands", "instrument_models_bedrock") + _process_module_definition("mcp.client.session", "newrelic.hooks.adapter_mcp", "instrument_mcp_client_session") _process_module_definition( "mcp.server.fastmcp.tools.tool_manager", diff --git a/newrelic/hooks/mlmodel_strands.py b/newrelic/hooks/mlmodel_strands.py new file mode 100644 index 0000000000..bf849fd717 --- /dev/null +++ b/newrelic/hooks/mlmodel_strands.py @@ -0,0 +1,492 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import logging +import sys +import uuid + +from newrelic.api.error_trace import ErrorTraceWrapper +from newrelic.api.function_trace import FunctionTrace +from newrelic.api.time_trace import current_trace, get_trace_linking_metadata +from newrelic.api.transaction import current_transaction +from newrelic.common.llm_utils import _get_llm_metadata +from newrelic.common.object_names import callable_name +from newrelic.common.object_wrapper import ObjectProxy, wrap_function_wrapper +from newrelic.common.package_version_utils import get_package_version +from newrelic.common.signature import bind_args +from newrelic.core.config import global_settings +from newrelic.core.context import ContextOf + +_logger = logging.getLogger(__name__) +STRANDS_VERSION = get_package_version("strands-agents") + +RECORD_EVENTS_FAILURE_LOG_MESSAGE = "Exception occurred in Strands instrumentation: Failed to record LLM events. Please report this issue to New Relic Support." +TOOL_OUTPUT_FAILURE_LOG_MESSAGE = "Exception occurred in Strands instrumentation: Failed to record output of tool call. Please report this issue to New Relic Support." +AGENT_EVENT_FAILURE_LOG_MESSAGE = "Exception occurred in Strands instrumentation: Failed to record agent data. Please report this issue to New Relic Support." +TOOL_EXTRACTOR_FAILURE_LOG_MESSAGE = "Exception occurred in Strands instrumentation: Failed to extract tool information. If the issue persists, report this issue to New Relic support.\n" + + +def wrap_agent__call__(wrapped, instance, args, kwargs): + trace = current_trace() + if not trace: + return wrapped(*args, **kwargs) + + try: + bound_args = bind_args(wrapped, args, kwargs) + # Make a copy of the invocation state before we mutate it + if "invocation_state" in bound_args: + invocation_state = bound_args["invocation_state"] = dict(bound_args["invocation_state"] or {}) + + # Attempt to save the current transaction context into the invocation state dictionary + invocation_state["_nr_transaction"] = trace + except Exception: + return wrapped(*args, **kwargs) + else: + return wrapped(**bound_args) + + +async def wrap_agent_invoke_async(wrapped, instance, args, kwargs): + # If there's already a transaction, don't propagate anything here + if current_transaction(): + return await wrapped(*args, **kwargs) + + try: + # Grab the trace context we should be running under and pass it to ContextOf + bound_args = bind_args(wrapped, args, kwargs) + invocation_state = bound_args["invocation_state"] or {} + trace = invocation_state.pop("_nr_transaction", None) + except Exception: + return await wrapped(*args, **kwargs) + + # If we find a transaction to propagate, use it. Otherwise, just call wrapped. + if trace: + with ContextOf(trace=trace): + return await wrapped(*args, **kwargs) + else: + return await wrapped(*args, **kwargs) + + +def wrap_stream_async(wrapped, instance, args, kwargs): + transaction = current_transaction() + if not transaction: + return wrapped(*args, **kwargs) + + settings = transaction.settings or global_settings() + if not settings.ai_monitoring.enabled: + return wrapped(*args, **kwargs) + + # Framework metric also used for entity tagging in the UI + transaction.add_ml_model_info("Strands", STRANDS_VERSION) + transaction._add_agent_attribute("llm", True) + + func_name = callable_name(wrapped) + agent_name = getattr(instance, "name", "agent") + function_trace_name = f"{func_name}/{agent_name}" + + ft = FunctionTrace(name=function_trace_name, group="Llm/agent/Strands") + ft.__enter__() + linking_metadata = get_trace_linking_metadata() + agent_id = str(uuid.uuid4()) + + try: + return_val = wrapped(*args, **kwargs) + except Exception: + raise + + # For streaming responses, wrap with proxy and attach metadata + try: + # For streaming responses, wrap with proxy and attach metadata + proxied_return_val = AsyncGeneratorProxy( + return_val, _record_agent_event_on_stop_iteration, _handle_agent_streaming_completion_error + ) + proxied_return_val._nr_ft = ft + proxied_return_val._nr_metadata = linking_metadata + proxied_return_val._nr_strands_attrs = {"agent_name": agent_name, "agent_id": agent_id} + return proxied_return_val + except Exception: + # If proxy creation fails, clean up the function trace and return original value + ft.__exit__(*sys.exc_info()) + return return_val + + +def _record_agent_event_on_stop_iteration(self, transaction): + if hasattr(self, "_nr_ft"): + # Use saved linking metadata to maintain correct span association + linking_metadata = self._nr_metadata or get_trace_linking_metadata() + self._nr_ft.__exit__(None, None, None) + + try: + strands_attrs = getattr(self, "_nr_strands_attrs", {}) + + # If there are no strands attrs exit early as there's no data to record. + if not strands_attrs: + return + + agent_name = strands_attrs.get("agent_name", "agent") + agent_id = strands_attrs.get("agent_id") + agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction, linking_metadata) + agent_event_dict["duration"] = self._nr_ft.duration * 1000 + transaction.record_custom_event("LlmAgent", agent_event_dict) + + except Exception: + _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) + finally: + # Clear cached data to prevent memory leaks and duplicate reporting + if hasattr(self, "_nr_strands_attrs"): + self._nr_strands_attrs.clear() + + +def _record_tool_event_on_stop_iteration(self, transaction): + if hasattr(self, "_nr_ft"): + # Use saved linking metadata to maintain correct span association + linking_metadata = self._nr_metadata or get_trace_linking_metadata() + self._nr_ft.__exit__(None, None, None) + + try: + strands_attrs = getattr(self, "_nr_strands_attrs", {}) + + # If there are no strands attrs exit early as there's no data to record. + if not strands_attrs: + return + + try: + tool_results = strands_attrs.get("tool_results", []) + except Exception: + tool_results = None + _logger.warning(TOOL_OUTPUT_FAILURE_LOG_MESSAGE, exc_info=True) + + tool_event_dict = _construct_base_tool_event_dict( + strands_attrs, tool_results, transaction, linking_metadata + ) + tool_event_dict["duration"] = self._nr_ft.duration * 1000 + transaction.record_custom_event("LlmTool", tool_event_dict) + + except Exception: + _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) + finally: + # Clear cached data to prevent memory leaks and duplicate reporting + if hasattr(self, "_nr_strands_attrs"): + self._nr_strands_attrs.clear() + + +def _construct_base_tool_event_dict(strands_attrs, tool_results, transaction, linking_metadata): + try: + try: + tool_output = tool_results[-1]["content"][0] if tool_results else None + error = tool_results[-1]["status"] == "error" + except Exception: + tool_output = None + error = False + _logger.warning(TOOL_OUTPUT_FAILURE_LOG_MESSAGE, exc_info=True) + + tool_name = strands_attrs.get("tool_name", "tool") + tool_id = strands_attrs.get("tool_id") + run_id = strands_attrs.get("run_id") + tool_input = strands_attrs.get("tool_input") + agent_name = strands_attrs.get("agent_name", "agent") + settings = transaction.settings or global_settings() + + tool_event_dict = { + "id": tool_id, + "run_id": run_id, + "name": tool_name, + "span_id": linking_metadata.get("span.id"), + "trace_id": linking_metadata.get("trace.id"), + "agent_name": agent_name, + "vendor": "strands", + "ingest_source": "Python", + } + # Set error flag if the status shows an error was caught, + # it will be reported further down in the instrumentation. + if error: + tool_event_dict["error"] = True + + if settings.ai_monitoring.record_content.enabled: + tool_event_dict["input"] = tool_input + # In error cases, the output will hold the error message + tool_event_dict["output"] = tool_output + tool_event_dict.update(_get_llm_metadata(transaction)) + except Exception: + tool_event_dict = {} + _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) + + return tool_event_dict + + +def _construct_base_agent_event_dict(agent_name, agent_id, transaction, linking_metadata): + try: + agent_event_dict = { + "id": agent_id, + "name": agent_name, + "span_id": linking_metadata.get("span.id"), + "trace_id": linking_metadata.get("trace.id"), + "vendor": "strands", + "ingest_source": "Python", + } + agent_event_dict.update(_get_llm_metadata(transaction)) + except Exception: + _logger.warning(AGENT_EVENT_FAILURE_LOG_MESSAGE, exc_info=True) + agent_event_dict = {} + + return agent_event_dict + + +def _handle_agent_streaming_completion_error(self, transaction): + if hasattr(self, "_nr_ft"): + strands_attrs = getattr(self, "_nr_strands_attrs", {}) + + # If there are no strands attrs exit early as there's no data to record. + if not strands_attrs: + self._nr_ft.__exit__(*sys.exc_info()) + return + + # Use saved linking metadata to maintain correct span association + linking_metadata = self._nr_metadata or get_trace_linking_metadata() + + try: + agent_name = strands_attrs.get("agent_name", "agent") + agent_id = strands_attrs.get("agent_id") + + # Notice the error on the function trace + self._nr_ft.notice_error(attributes={"agent_id": agent_id}) + self._nr_ft.__exit__(*sys.exc_info()) + + # Create error event + agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction, linking_metadata) + agent_event_dict.update({"duration": self._nr_ft.duration * 1000, "error": True}) + transaction.record_custom_event("LlmAgent", agent_event_dict) + + except Exception: + _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) + finally: + # Clear cached data to prevent memory leaks + if hasattr(self, "_nr_strands_attrs"): + self._nr_strands_attrs.clear() + + +def _handle_tool_streaming_completion_error(self, transaction): + if hasattr(self, "_nr_ft"): + strands_attrs = getattr(self, "_nr_strands_attrs", {}) + + # If there are no strands attrs exit early as there's no data to record. + if not strands_attrs: + self._nr_ft.__exit__(*sys.exc_info()) + return + + # Use saved linking metadata to maintain correct span association + linking_metadata = self._nr_metadata or get_trace_linking_metadata() + + try: + tool_id = strands_attrs.get("tool_id") + + # We expect this to never have any output since this is an error case, + # but if it does we will report it. + try: + tool_results = strands_attrs.get("tool_results", []) + except Exception: + tool_results = None + _logger.warning(TOOL_OUTPUT_FAILURE_LOG_MESSAGE, exc_info=True) + + # Notice the error on the function trace + self._nr_ft.notice_error(attributes={"tool_id": tool_id}) + self._nr_ft.__exit__(*sys.exc_info()) + + # Create error event + tool_event_dict = _construct_base_tool_event_dict( + strands_attrs, tool_results, transaction, linking_metadata + ) + tool_event_dict["duration"] = self._nr_ft.duration * 1000 + # Ensure error flag is set to True in case the tool_results did not indicate an error + if "error" not in tool_event_dict: + tool_event_dict["error"] = True + + transaction.record_custom_event("LlmTool", tool_event_dict) + + except Exception: + _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) + finally: + # Clear cached data to prevent memory leaks + if hasattr(self, "_nr_strands_attrs"): + self._nr_strands_attrs.clear() + + +def wrap_tool_executor__stream(wrapped, instance, args, kwargs): + transaction = current_transaction() + if not transaction: + return wrapped(*args, **kwargs) + + settings = transaction.settings or global_settings() + if not settings.ai_monitoring.enabled: + return wrapped(*args, **kwargs) + + # Framework metric also used for entity tagging in the UI + transaction.add_ml_model_info("Strands", STRANDS_VERSION) + transaction._add_agent_attribute("llm", True) + + # Grab tool data + try: + bound_args = bind_args(wrapped, args, kwargs) + agent_name = getattr(bound_args.get("agent"), "name", "agent") + tool_use = bound_args.get("tool_use", {}) + + run_id = tool_use.get("toolUseId", "") + tool_name = tool_use.get("name", "tool") + _input = tool_use.get("input") + tool_input = str(_input) if _input else None + tool_results = bound_args.get("tool_results", []) + except Exception: + tool_name = "tool" + _logger.warning(TOOL_EXTRACTOR_FAILURE_LOG_MESSAGE, exc_info=True) + + func_name = callable_name(wrapped) + function_trace_name = f"{func_name}/{tool_name}" + + ft = FunctionTrace(name=function_trace_name, group="Llm/tool/Strands") + ft.__enter__() + linking_metadata = get_trace_linking_metadata() + tool_id = str(uuid.uuid4()) + + try: + return_val = wrapped(*args, **kwargs) + except Exception: + raise + + try: + # Wrap return value with proxy and attach metadata for later access + proxied_return_val = AsyncGeneratorProxy( + return_val, _record_tool_event_on_stop_iteration, _handle_tool_streaming_completion_error + ) + proxied_return_val._nr_ft = ft + proxied_return_val._nr_metadata = linking_metadata + proxied_return_val._nr_strands_attrs = { + "tool_results": tool_results, + "tool_name": tool_name, + "tool_id": tool_id, + "run_id": run_id, + "tool_input": tool_input, + "agent_name": agent_name, + } + return proxied_return_val + except Exception: + # If proxy creation fails, clean up the function trace and return original value + ft.__exit__(*sys.exc_info()) + return return_val + + +class AsyncGeneratorProxy(ObjectProxy): + def __init__(self, wrapped, on_stop_iteration, on_error): + super().__init__(wrapped) + self._nr_on_stop_iteration = on_stop_iteration + self._nr_on_error = on_error + + def __aiter__(self): + self._nr_wrapped_iter = self.__wrapped__.__aiter__() + return self + + async def __anext__(self): + transaction = current_transaction() + if not transaction: + return await self._nr_wrapped_iter.__anext__() + + return_val = None + try: + return_val = await self._nr_wrapped_iter.__anext__() + except StopAsyncIteration: + self._nr_on_stop_iteration(self, transaction) + raise + except Exception: + self._nr_on_error(self, transaction) + raise + return return_val + + async def aclose(self): + return await super().aclose() + + +def wrap_ToolRegister_register_tool(wrapped, instance, args, kwargs): + bound_args = bind_args(wrapped, args, kwargs) + bound_args["tool"]._tool_func = ErrorTraceWrapper(bound_args["tool"]._tool_func) + return wrapped(*args, **kwargs) + + +def wrap_bedrock_model_stream(wrapped, instance, args, kwargs): + """Stores trace context on the messages argument to be retrieved by the _stream() instrumentation.""" + trace = current_trace() + if not trace: + return wrapped(*args, **kwargs) + + settings = trace.settings or global_settings() + if not settings.ai_monitoring.enabled: + return wrapped(*args, **kwargs) + + try: + bound_args = bind_args(wrapped, args, kwargs) + except Exception: + return wrapped(*args, **kwargs) + + if "messages" in bound_args and isinstance(bound_args["messages"], list): + bound_args["messages"].append({"newrelic_trace": trace}) + + return wrapped(*args, **kwargs) + + +def wrap_bedrock_model__stream(wrapped, instance, args, kwargs): + """Retrieves trace context stored on the messages argument and propagates it to the new thread.""" + try: + bound_args = bind_args(wrapped, args, kwargs) + except Exception: + return wrapped(*args, **kwargs) + + if ( + "messages" in bound_args + and isinstance(bound_args["messages"], list) + and bound_args["messages"] # non-empty list + and "newrelic_trace" in bound_args["messages"][-1] + ): + trace_message = bound_args["messages"].pop() + with ContextOf(trace=trace_message["newrelic_trace"]): + return wrapped(*args, **kwargs) + + return wrapped(*args, **kwargs) + + +def instrument_agent_agent(module): + if hasattr(module, "Agent"): + if hasattr(module.Agent, "__call__"): # noqa: B004 + wrap_function_wrapper(module, "Agent.__call__", wrap_agent__call__) + if hasattr(module.Agent, "invoke_async"): + wrap_function_wrapper(module, "Agent.invoke_async", wrap_agent_invoke_async) + if hasattr(module.Agent, "stream_async"): + wrap_function_wrapper(module, "Agent.stream_async", wrap_stream_async) + + +def instrument_tools_executors__executor(module): + if hasattr(module, "ToolExecutor"): + if hasattr(module.ToolExecutor, "_stream"): + wrap_function_wrapper(module, "ToolExecutor._stream", wrap_tool_executor__stream) + + +def instrument_tools_registry(module): + if hasattr(module, "ToolRegistry"): + if hasattr(module.ToolRegistry, "register_tool"): + wrap_function_wrapper(module, "ToolRegistry.register_tool", wrap_ToolRegister_register_tool) + + +def instrument_models_bedrock(module): + # This instrumentation only exists to pass trace context due to bedrock models using a separate thread. + if hasattr(module, "BedrockModel"): + if hasattr(module.BedrockModel, "stream"): + wrap_function_wrapper(module, "BedrockModel.stream", wrap_bedrock_model_stream) + if hasattr(module.BedrockModel, "_stream"): + wrap_function_wrapper(module, "BedrockModel._stream", wrap_bedrock_model__stream) diff --git a/tests/mlmodel_strands/_mock_model_provider.py b/tests/mlmodel_strands/_mock_model_provider.py index e4c9e79930..ef60e13bad 100644 --- a/tests/mlmodel_strands/_mock_model_provider.py +++ b/tests/mlmodel_strands/_mock_model_provider.py @@ -41,7 +41,7 @@ def __init__(self, agent_responses): def format_chunk(self, event): return event - def format_request(self, messages, tool_specs=None, system_prompt=None): + def format_request(self, messages, tool_specs=None, system_prompt=None, **kwargs): return None def get_config(self): @@ -53,7 +53,7 @@ def update_config(self, **model_config): async def structured_output(self, output_model, prompt, system_prompt=None, **kwargs): pass - async def stream(self, messages, tool_specs=None, system_prompt=None): + async def stream(self, messages, tool_specs=None, system_prompt=None, **kwargs): events = self.map_agent_message_to_events(self.agent_responses[self.index]) for event in events: yield event diff --git a/tests/mlmodel_strands/conftest.py b/tests/mlmodel_strands/conftest.py index b810161f6a..a2ad9b8dd0 100644 --- a/tests/mlmodel_strands/conftest.py +++ b/tests/mlmodel_strands/conftest.py @@ -14,6 +14,7 @@ import pytest from _mock_model_provider import MockedModelProvider +from testing_support.fixture.event_loop import event_loop as loop from testing_support.fixtures import collector_agent_registration_fixture, collector_available_fixture from testing_support.ml_testing_utils import set_trace_info @@ -50,15 +51,33 @@ def single_tool_model(): @pytest.fixture -def single_tool_model_error(): +def single_tool_model_runtime_error_coro(): model = MockedModelProvider( [ { "role": "assistant", "content": [ - {"text": "Calling add_exclamation tool"}, + {"text": "Calling throw_exception_coro tool"}, + # Set arguments to an invalid type to trigger error in tool + {"toolUse": {"name": "throw_exception_coro", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def single_tool_model_runtime_error_agen(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling throw_exception_agen tool"}, # Set arguments to an invalid type to trigger error in tool - {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": 12}}}, + {"toolUse": {"name": "throw_exception_agen", "toolUseId": "123", "input": {"message": "Hello"}}}, ], }, {"role": "assistant", "content": [{"text": "Success!"}]}, diff --git a/tests/mlmodel_strands/test_agent.py b/tests/mlmodel_strands/test_agent.py new file mode 100644 index 0000000000..af685668ad --- /dev/null +++ b/tests/mlmodel_strands/test_agent.py @@ -0,0 +1,427 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from strands import Agent, tool +from testing_support.fixtures import reset_core_stats_engine, validate_attributes +from testing_support.ml_testing_utils import ( + disabled_ai_monitoring_record_content_settings, + disabled_ai_monitoring_settings, + events_with_context_attrs, + tool_events_sans_content, +) +from testing_support.validators.validate_custom_event import validate_custom_event_count +from testing_support.validators.validate_custom_events import validate_custom_events +from testing_support.validators.validate_error_trace_attributes import validate_error_trace_attributes +from testing_support.validators.validate_transaction_error_event_count import validate_transaction_error_event_count +from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics + +from newrelic.api.background_task import background_task +from newrelic.api.llm_custom_attributes import WithLlmCustomAttributes +from newrelic.common.object_names import callable_name +from newrelic.common.object_wrapper import transient_function_wrapper + +tool_recorded_event = [ + ( + {"type": "LlmTool"}, + { + "id": None, + "run_id": "123", + "output": "{'text': 'Hello!'}", + "name": "add_exclamation", + "agent_name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "input": "{'message': 'Hello'}", + "vendor": "strands", + "ingest_source": "Python", + "duration": None, + }, + ) +] + +tool_recorded_event_forced_internal_error = [ + ( + {"type": "LlmTool"}, + { + "id": None, + "run_id": "123", + "name": "add_exclamation", + "agent_name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "input": "{'message': 'Hello'}", + "vendor": "strands", + "ingest_source": "Python", + "duration": None, + "error": True, + }, + ) +] + +tool_recorded_event_error_coro = [ + ( + {"type": "LlmTool"}, + { + "id": None, + "run_id": "123", + "name": "throw_exception_coro", + "agent_name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "input": "{'message': 'Hello'}", + "vendor": "strands", + "ingest_source": "Python", + "error": True, + "output": "{'text': 'Error: RuntimeError - Oops'}", + "duration": None, + }, + ) +] + + +tool_recorded_event_error_agen = [ + ( + {"type": "LlmTool"}, + { + "id": None, + "run_id": "123", + "name": "throw_exception_agen", + "agent_name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "input": "{'message': 'Hello'}", + "vendor": "strands", + "ingest_source": "Python", + "error": True, + "output": "{'text': 'Error: RuntimeError - Oops'}", + "duration": None, + }, + ) +] + + +agent_recorded_event = [ + ( + {"type": "LlmAgent"}, + { + "id": None, + "name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + "ingest_source": "Python", + "duration": None, + }, + ) +] + +agent_recorded_event_error = [ + ( + {"type": "LlmAgent"}, + { + "id": None, + "name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + "ingest_source": "Python", + "error": True, + "duration": None, + }, + ) +] + + +# Example tool for testing purposes +@tool +async def add_exclamation(message: str) -> str: + return f"{message}!" + + +@tool +async def throw_exception_coro(message: str) -> str: + raise RuntimeError("Oops") + + +@tool +async def throw_exception_agen(message: str) -> str: + raise RuntimeError("Oops") + yield + + +@reset_core_stats_engine() +@validate_custom_events(events_with_context_attrs(tool_recorded_event)) +@validate_custom_events(events_with_context_attrs(agent_recorded_event)) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "test_agent:test_agent_invoke", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent_invoke(set_trace_info, single_tool_model): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + with WithLlmCustomAttributes({"context": "attr"}): + response = my_agent('Add an exclamation to the word "Hello"') + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 + + +@reset_core_stats_engine() +@validate_custom_events(tool_recorded_event) +@validate_custom_events(agent_recorded_event) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "test_agent:test_agent_invoke_async", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent_invoke_async(loop, set_trace_info, single_tool_model): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + async def _test(): + response = await my_agent.invoke_async('Add an exclamation to the word "Hello"') + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 + + loop.run_until_complete(_test()) + + +@reset_core_stats_engine() +@validate_custom_events(tool_recorded_event) +@validate_custom_events(agent_recorded_event) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "test_agent:test_agent_stream_async", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent_stream_async(loop, set_trace_info, single_tool_model): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + async def _test(): + response = my_agent.stream_async('Add an exclamation to the word "Hello"') + messages = [event["message"]["content"] async for event in response if "message" in event] + + assert len(messages) == 3 + assert messages[0][0]["text"] == "Calling add_exclamation tool" + assert messages[0][1]["toolUse"]["name"] == "add_exclamation" + assert messages[1][0]["toolResult"]["content"][0]["text"] == "Hello!" + assert messages[2][0]["text"] == "Success!" + + loop.run_until_complete(_test()) + + +@reset_core_stats_engine() +@disabled_ai_monitoring_record_content_settings +@validate_custom_events(agent_recorded_event) +@validate_custom_events(tool_events_sans_content(tool_recorded_event)) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "test_agent:test_agent_invoke_no_content", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent_invoke_no_content(set_trace_info, single_tool_model): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + response = my_agent('Add an exclamation to the word "Hello"') + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 + + +@disabled_ai_monitoring_settings +@reset_core_stats_engine() +@validate_custom_event_count(count=0) +@background_task() +def test_agent_invoke_disabled_ai_monitoring_events(set_trace_info, single_tool_model): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + response = my_agent('Add an exclamation to the word "Hello"') + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 + + +@reset_core_stats_engine() +@validate_transaction_error_event_count(1) +@validate_error_trace_attributes(callable_name(ValueError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) +@validate_custom_events(agent_recorded_event_error) +@validate_custom_event_count(count=1) +@validate_transaction_metrics( + "test_agent:test_agent_invoke_error", + scoped_metrics=[("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1)], + rollup_metrics=[("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1)], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent_invoke_error(set_trace_info, single_tool_model): + # Add a wrapper to intentionally force an error in the Agent code + @transient_function_wrapper("strands.agent.agent", "Agent._convert_prompt_to_messages") + def _wrap_convert_prompt_to_messages(wrapped, instance, args, kwargs): + raise ValueError("Oops") + + @_wrap_convert_prompt_to_messages + def _test(): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + my_agent('Add an exclamation to the word "Hello"') # raises ValueError + + with pytest.raises(ValueError): + _test() + + +@reset_core_stats_engine() +@validate_transaction_error_event_count(1) +@validate_error_trace_attributes(callable_name(RuntimeError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) +@validate_custom_events(tool_recorded_event_error_coro) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "test_agent:test_agent_invoke_tool_coro_runtime_error", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/throw_exception_coro", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/throw_exception_coro", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent_invoke_tool_coro_runtime_error(set_trace_info, single_tool_model_runtime_error_coro): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model_runtime_error_coro, tools=[throw_exception_coro]) + + response = my_agent('Add an exclamation to the word "Hello"') + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["throw_exception_coro"].error_count == 1 + + +@reset_core_stats_engine() +@validate_transaction_error_event_count(1) +@validate_error_trace_attributes(callable_name(RuntimeError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) +@validate_custom_events(tool_recorded_event_error_agen) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "test_agent:test_agent_invoke_tool_agen_runtime_error", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/throw_exception_agen", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/throw_exception_agen", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent_invoke_tool_agen_runtime_error(set_trace_info, single_tool_model_runtime_error_agen): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model_runtime_error_agen, tools=[throw_exception_agen]) + + response = my_agent('Add an exclamation to the word "Hello"') + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["throw_exception_agen"].error_count == 1 + + +@reset_core_stats_engine() +@validate_transaction_error_event_count(1) +@validate_error_trace_attributes(callable_name(ValueError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) +@validate_custom_events(agent_recorded_event) +@validate_custom_events(tool_recorded_event_forced_internal_error) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "test_agent:test_agent_tool_forced_exception", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent_tool_forced_exception(set_trace_info, single_tool_model): + # Add a wrapper to intentionally force an error in the ToolExecutor._stream code to hit the exception path in + # the AsyncGeneratorProxy + @transient_function_wrapper("strands.hooks.events", "BeforeToolCallEvent.__init__") + def _wrap_BeforeToolCallEvent_init(wrapped, instance, args, kwargs): + raise ValueError("Oops") + + @_wrap_BeforeToolCallEvent_init + def _test(): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + my_agent('Add an exclamation to the word "Hello"') + + # This will not explicitly raise a ValueError when running the test but we are still able to capture it in the error trace + _test() + + +@reset_core_stats_engine() +@validate_custom_event_count(count=0) +def test_agent_invoke_outside_txn(single_tool_model): + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + response = my_agent('Add an exclamation to the word "Hello"') + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 diff --git a/tests/mlmodel_strands/test_simple.py b/tests/mlmodel_strands/test_simple.py deleted file mode 100644 index ae24003fab..0000000000 --- a/tests/mlmodel_strands/test_simple.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2010 New Relic, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -from strands import Agent, tool - -from newrelic.api.background_task import background_task - - -# Example tool for testing purposes -@tool -def add_exclamation(message: str) -> str: - return f"{message}!" - - -# TODO: Remove this file once all real tests are in place - - -@background_task() -def test_simple_run_agent(set_trace_info, single_tool_model): - set_trace_info() - my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) - - response = my_agent("Run the tools.") - assert response.message["content"][0]["text"] == "Success!" - assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 diff --git a/tests/testing_support/fixtures.py b/tests/testing_support/fixtures.py index 3d93e06e30..540e44f70c 100644 --- a/tests/testing_support/fixtures.py +++ b/tests/testing_support/fixtures.py @@ -797,7 +797,7 @@ def _bind_params(transaction, *args, **kwargs): transaction = _bind_params(*args, **kwargs) error_events = transaction.error_events(instance.stats_table) - assert len(error_events) == num_errors + assert len(error_events) == num_errors, f"Expected: {num_errors}, Got: {len(error_events)}" for sample in error_events: assert isinstance(sample, list) assert len(sample) == 3 diff --git a/tests/testing_support/validators/validate_custom_event.py b/tests/testing_support/validators/validate_custom_event.py index deeef7fb25..c3cf78032a 100644 --- a/tests/testing_support/validators/validate_custom_event.py +++ b/tests/testing_support/validators/validate_custom_event.py @@ -61,7 +61,9 @@ def _validate_custom_event_count(wrapped, instance, args, kwargs): raise else: stats = core_application_stats_engine(None) - assert stats.custom_events.num_samples == count + assert stats.custom_events.num_samples == count, ( + f"Expected: {count}, Got: {stats.custom_events.num_samples}. Events: {list(stats.custom_events)}" + ) return result diff --git a/tests/testing_support/validators/validate_error_event_collector_json.py b/tests/testing_support/validators/validate_error_event_collector_json.py index d1cec3a558..27ea76f3a3 100644 --- a/tests/testing_support/validators/validate_error_event_collector_json.py +++ b/tests/testing_support/validators/validate_error_event_collector_json.py @@ -52,7 +52,7 @@ def _validate_error_event_collector_json(wrapped, instance, args, kwargs): error_events = decoded_json[2] - assert len(error_events) == num_errors + assert len(error_events) == num_errors, f"Expected: {num_errors}, Got: {len(error_events)}" for event in error_events: # event is an array containing intrinsics, user-attributes, # and agent-attributes diff --git a/tests/testing_support/validators/validate_transaction_error_event_count.py b/tests/testing_support/validators/validate_transaction_error_event_count.py index b41a52330f..f5e8c0b206 100644 --- a/tests/testing_support/validators/validate_transaction_error_event_count.py +++ b/tests/testing_support/validators/validate_transaction_error_event_count.py @@ -28,7 +28,9 @@ def _validate_error_event_on_stats_engine(wrapped, instance, args, kwargs): raise else: error_events = list(instance.error_events) - assert len(error_events) == num_errors + assert len(error_events) == num_errors, ( + f"Expected: {num_errors}, Got: {len(error_events)}. Errors: {error_events}" + ) return result From bea210070f93e576a4c10d00ea6ac0b65514b507 Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Tue, 7 Oct 2025 10:34:31 -0700 Subject: [PATCH 007/124] Bump tests. From 491dd98553d9d65c933b43d9310ea3bd919fe2f8 Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Tue, 7 Oct 2025 10:57:04 -0700 Subject: [PATCH 008/124] Add response token count logic to Gemini instrumentation. (#1486) * Add response token count logic to Gemini instrumentation. * Update token counting util functions. * Linting * Add response token count logic to Gemini instrumentation. * Update token counting util functions. * [MegaLinter] Apply linters fixes * Bump tests. --------- Co-authored-by: Tim Pansino --- newrelic/hooks/mlmodel_gemini.py | 152 ++++++++++++------ tests/mlmodel_gemini/test_embeddings.py | 6 +- tests/mlmodel_gemini/test_embeddings_error.py | 62 +------ tests/mlmodel_gemini/test_text_generation.py | 12 +- .../test_text_generation_error.py | 81 +--------- tests/testing_support/ml_testing_utils.py | 19 +++ 6 files changed, 139 insertions(+), 193 deletions(-) diff --git a/newrelic/hooks/mlmodel_gemini.py b/newrelic/hooks/mlmodel_gemini.py index 8aeb1355d0..6f61c11125 100644 --- a/newrelic/hooks/mlmodel_gemini.py +++ b/newrelic/hooks/mlmodel_gemini.py @@ -175,20 +175,24 @@ def _record_embedding_success(transaction, embedding_id, linking_metadata, kwarg embedding_content = str(embedding_content) request_model = kwargs.get("model") + embedding_token_count = ( + settings.ai_monitoring.llm_token_count_callback(request_model, embedding_content) + if settings.ai_monitoring.llm_token_count_callback + else None + ) + full_embedding_response_dict = { "id": embedding_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(request_model, embedding_content) - if settings.ai_monitoring.llm_token_count_callback - else None - ), "request.model": request_model, "duration": ft.duration * 1000, "vendor": "gemini", "ingest_source": "Python", } + if embedding_token_count: + full_embedding_response_dict["response.usage.total_tokens"] = embedding_token_count + if settings.ai_monitoring.record_content.enabled: full_embedding_response_dict["input"] = embedding_content @@ -300,15 +304,13 @@ def _record_generation_error(transaction, linking_metadata, completion_id, kwarg "Unable to parse input message to Gemini LLM. Message content and role will be omitted from " "corresponding LlmChatCompletionMessage event. " ) + # Extract the input message content and role from the input message if it exists + input_message_content, input_role = _parse_input_message(input_message) if input_message else (None, None) - generation_config = kwargs.get("config") - if generation_config: - request_temperature = getattr(generation_config, "temperature", None) - request_max_tokens = getattr(generation_config, "max_output_tokens", None) - else: - request_temperature = None - request_max_tokens = None + # Extract data from generation config object + request_temperature, request_max_tokens = _extract_generation_config(kwargs) + # Prepare error attributes notice_error_attributes = { "http.statusCode": getattr(exc, "code", None), "error.message": getattr(exc, "message", None), @@ -348,15 +350,17 @@ def _record_generation_error(transaction, linking_metadata, completion_id, kwarg create_chat_completion_message_event( transaction, - input_message, + input_message_content, + input_role, completion_id, span_id, trace_id, # Passing the request model as the response model here since we do not have access to a response model request_model, - request_model, llm_metadata, output_message_list, + # We do not record token counts in error cases, so set all_token_counts to True so the pipeline tokenizer does not run + all_token_counts=True, ) except Exception: _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) @@ -377,6 +381,7 @@ def _handle_generation_success(transaction, linking_metadata, completion_id, kwa def _record_generation_success(transaction, linking_metadata, completion_id, kwargs, ft, response): + settings = transaction.settings or global_settings() span_id = linking_metadata.get("span.id") trace_id = linking_metadata.get("trace.id") try: @@ -385,12 +390,14 @@ def _record_generation_success(transaction, linking_metadata, completion_id, kwa # finish_reason is an enum, so grab just the stringified value from it to report finish_reason = response.get("candidates")[0].get("finish_reason").value output_message_list = [response.get("candidates")[0].get("content")] + token_usage = response.get("usage_metadata") or {} else: # Set all values to NoneTypes since we cannot access them through kwargs or another method that doesn't # require the response object response_model = None output_message_list = [] finish_reason = None + token_usage = {} request_model = kwargs.get("model") @@ -412,13 +419,44 @@ def _record_generation_success(transaction, linking_metadata, completion_id, kwa "corresponding LlmChatCompletionMessage event. " ) - generation_config = kwargs.get("config") - if generation_config: - request_temperature = getattr(generation_config, "temperature", None) - request_max_tokens = getattr(generation_config, "max_output_tokens", None) + input_message_content, input_role = _parse_input_message(input_message) if input_message else (None, None) + + # Parse output message content + # This list should have a length of 1 to represent the output message + # Parse the message text out to pass to any registered token counting callback + output_message_content = output_message_list[0].get("parts")[0].get("text") if output_message_list else None + + # Extract token counts from response object + if token_usage: + response_prompt_tokens = token_usage.get("prompt_token_count") + response_completion_tokens = token_usage.get("candidates_token_count") + response_total_tokens = token_usage.get("total_token_count") + else: - request_temperature = None - request_max_tokens = None + response_prompt_tokens = None + response_completion_tokens = None + response_total_tokens = None + + # Calculate token counts by checking if a callback is registered and if we have the necessary content to pass + # to it. If not, then we use the token counts provided in the response object + prompt_tokens = ( + settings.ai_monitoring.llm_token_count_callback(request_model, input_message_content) + if settings.ai_monitoring.llm_token_count_callback and input_message_content + else response_prompt_tokens + ) + completion_tokens = ( + settings.ai_monitoring.llm_token_count_callback(response_model, output_message_content) + if settings.ai_monitoring.llm_token_count_callback and output_message_content + else response_completion_tokens + ) + total_tokens = ( + prompt_tokens + completion_tokens if all([prompt_tokens, completion_tokens]) else response_total_tokens + ) + + all_token_counts = bool(prompt_tokens and completion_tokens and total_tokens) + + # Extract generation config + request_temperature, request_max_tokens = _extract_generation_config(kwargs) full_chat_completion_summary_dict = { "id": completion_id, @@ -438,66 +476,78 @@ def _record_generation_success(transaction, linking_metadata, completion_id, kwa "response.number_of_messages": 1 + len(output_message_list), } + if all_token_counts: + full_chat_completion_summary_dict["response.usage.prompt_tokens"] = prompt_tokens + full_chat_completion_summary_dict["response.usage.completion_tokens"] = completion_tokens + full_chat_completion_summary_dict["response.usage.total_tokens"] = total_tokens + llm_metadata = _get_llm_attributes(transaction) full_chat_completion_summary_dict.update(llm_metadata) transaction.record_custom_event("LlmChatCompletionSummary", full_chat_completion_summary_dict) create_chat_completion_message_event( transaction, - input_message, + input_message_content, + input_role, completion_id, span_id, trace_id, response_model, - request_model, llm_metadata, output_message_list, + all_token_counts, ) except Exception: _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) +def _parse_input_message(input_message): + # The input_message will be a string if generate_content was called directly. In this case, we don't have + # access to the role, so we default to user since this was an input message + if isinstance(input_message, str): + return input_message, "user" + # The input_message will be a Google Content type if send_message was called, so we parse out the message + # text and role (which should be "user") + elif isinstance(input_message, google.genai.types.Content): + return input_message.parts[0].text, input_message.role + else: + return None, None + + +def _extract_generation_config(kwargs): + generation_config = kwargs.get("config") + if generation_config: + request_temperature = getattr(generation_config, "temperature", None) + request_max_tokens = getattr(generation_config, "max_output_tokens", None) + else: + request_temperature = None + request_max_tokens = None + + return request_temperature, request_max_tokens + + def create_chat_completion_message_event( transaction, - input_message, + input_message_content, + input_role, chat_completion_id, span_id, trace_id, response_model, - request_model, llm_metadata, output_message_list, + all_token_counts, ): try: settings = transaction.settings or global_settings() - if input_message: - # The input_message will be a string if generate_content was called directly. In this case, we don't have - # access to the role, so we default to user since this was an input message - if isinstance(input_message, str): - input_message_content = input_message - input_role = "user" - # The input_message will be a Google Content type if send_message was called, so we parse out the message - # text and role (which should be "user") - elif isinstance(input_message, google.genai.types.Content): - input_message_content = input_message.parts[0].text - input_role = input_message.role - # Set input data to NoneTypes to ensure token_count callback is not called - else: - input_message_content = None - input_role = None - + if input_message_content: message_id = str(uuid.uuid4()) chat_completion_input_message_dict = { "id": message_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(request_model, input_message_content) - if settings.ai_monitoring.llm_token_count_callback and input_message_content - else None - ), "role": input_role, "completion_id": chat_completion_id, # The input message will always be the first message in our request/ response sequence so this will @@ -507,6 +557,8 @@ def create_chat_completion_message_event( "vendor": "gemini", "ingest_source": "Python", } + if all_token_counts: + chat_completion_input_message_dict["token_count"] = 0 if settings.ai_monitoring.record_content.enabled: chat_completion_input_message_dict["content"] = input_message_content @@ -523,7 +575,7 @@ def create_chat_completion_message_event( # Add one to the index to account for the single input message so our sequence value is accurate for # the output message - if input_message: + if input_message_content: index += 1 message_id = str(uuid.uuid4()) @@ -532,11 +584,6 @@ def create_chat_completion_message_event( "id": message_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(response_model, message_content) - if settings.ai_monitoring.llm_token_count_callback - else None - ), "role": message.get("role"), "completion_id": chat_completion_id, "sequence": index, @@ -546,6 +593,9 @@ def create_chat_completion_message_event( "is_response": True, } + if all_token_counts: + chat_completion_output_message_dict["token_count"] = 0 + if settings.ai_monitoring.record_content.enabled: chat_completion_output_message_dict["content"] = message_content diff --git a/tests/mlmodel_gemini/test_embeddings.py b/tests/mlmodel_gemini/test_embeddings.py index 0fc92897b6..5b4e30f860 100644 --- a/tests/mlmodel_gemini/test_embeddings.py +++ b/tests/mlmodel_gemini/test_embeddings.py @@ -15,7 +15,7 @@ import google.genai from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_to_embedding_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -93,7 +93,7 @@ def test_gemini_embedding_sync_no_content(gemini_dev_client, set_trace_info): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(embedding_recorded_events)) +@validate_custom_events(add_token_count_to_embedding_events(embedding_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_embeddings:test_gemini_embedding_sync_with_token_count", @@ -177,7 +177,7 @@ def test_gemini_embedding_async_no_content(gemini_dev_client, loop, set_trace_in @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(embedding_recorded_events)) +@validate_custom_events(add_token_count_to_embedding_events(embedding_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_embeddings:test_gemini_embedding_async_with_token_count", diff --git a/tests/mlmodel_gemini/test_embeddings_error.py b/tests/mlmodel_gemini/test_embeddings_error.py index a65a6c2c6f..f0e7aac58a 100644 --- a/tests/mlmodel_gemini/test_embeddings_error.py +++ b/tests/mlmodel_gemini/test_embeddings_error.py @@ -16,12 +16,10 @@ import google.genai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -159,34 +157,6 @@ def test_embeddings_invalid_request_error_invalid_model(gemini_dev_client, set_t gemini_dev_client.models.embed_content(contents="Embedded: Model does not exist.", model="does-not-exist") -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(google.genai.errors.ClientError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "NOT_FOUND", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={ - "error.message": "models/does-not-exist is not found for API version v1beta, or is not supported for embedContent. Call ListModels to see the list of available models and their supported methods." - } -) -@validate_transaction_metrics( - name="test_embeddings_error:test_embeddings_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/embedding/Gemini/embed_content", 1)], - rollup_metrics=[("Llm/embedding/Gemini/embed_content", 1)], - custom_metrics=[(f"Supportability/Python/ML/Gemini/{google.genai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_with_token_count(gemini_dev_client, set_trace_info): - with pytest.raises(google.genai.errors.ClientError): - set_trace_info() - gemini_dev_client.models.embed_content(contents="Embedded: Model does not exist.", model="does-not-exist") - - embedding_invalid_key_error_events = [ ( {"type": "LlmEmbedding"}, @@ -326,36 +296,6 @@ def test_embeddings_async_invalid_request_error_invalid_model(gemini_dev_client, ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(google.genai.errors.ClientError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "NOT_FOUND", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={ - "error.message": "models/does-not-exist is not found for API version v1beta, or is not supported for embedContent. Call ListModels to see the list of available models and their supported methods." - } -) -@validate_transaction_metrics( - name="test_embeddings_error:test_embeddings_async_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/embedding/Gemini/embed_content", 1)], - rollup_metrics=[("Llm/embedding/Gemini/embed_content", 1)], - custom_metrics=[(f"Supportability/Python/ML/Gemini/{google.genai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_async_invalid_request_error_invalid_model_with_token_count(gemini_dev_client, loop, set_trace_info): - with pytest.raises(google.genai.errors.ClientError): - set_trace_info() - loop.run_until_complete( - gemini_dev_client.models.embed_content(contents="Embedded: Model does not exist.", model="does-not-exist") - ) - - # Wrong api_key provided @dt_enabled @reset_core_stats_engine() diff --git a/tests/mlmodel_gemini/test_text_generation.py b/tests/mlmodel_gemini/test_text_generation.py index faec66aa75..3da978e777 100644 --- a/tests/mlmodel_gemini/test_text_generation.py +++ b/tests/mlmodel_gemini/test_text_generation.py @@ -15,7 +15,7 @@ import google.genai from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -50,6 +50,9 @@ "vendor": "gemini", "ingest_source": "Python", "response.number_of_messages": 2, + "response.usage.prompt_tokens": 9, + "response.usage.completion_tokens": 13, + "response.usage.total_tokens": 22, }, ), ( @@ -60,6 +63,7 @@ "llm.foo": "bar", "span_id": None, "trace_id": "trace-id", + "token_count": 0, "content": "How many letters are in the word Python?", "role": "user", "completion_id": None, @@ -77,6 +81,7 @@ "llm.foo": "bar", "span_id": None, "trace_id": "trace-id", + "token_count": 0, "content": 'There are **6** letters in the word "Python".\n', "role": "model", "completion_id": None, @@ -183,7 +188,8 @@ def test_gemini_text_generation_sync_no_content(gemini_dev_client, set_trace_inf @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(text_generation_recorded_events)) +# Ensure LLM callback is invoked and response token counts are overridden +@validate_custom_events(add_token_counts_to_chat_events(text_generation_recorded_events)) @validate_custom_event_count(count=3) @validate_transaction_metrics( name="test_text_generation:test_gemini_text_generation_sync_with_token_count", @@ -324,7 +330,7 @@ def test_gemini_text_generation_async_no_content(gemini_dev_client, loop, set_tr @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(text_generation_recorded_events)) +@validate_custom_events(add_token_counts_to_chat_events(text_generation_recorded_events)) @validate_custom_event_count(count=3) @validate_transaction_metrics( name="test_text_generation:test_gemini_text_generation_async_with_token_count", diff --git a/tests/mlmodel_gemini/test_text_generation_error.py b/tests/mlmodel_gemini/test_text_generation_error.py index 5e6f1c04de..c92e1a2d45 100644 --- a/tests/mlmodel_gemini/test_text_generation_error.py +++ b/tests/mlmodel_gemini/test_text_generation_error.py @@ -17,13 +17,11 @@ import google.genai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, events_with_context_attrs, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -63,6 +61,7 @@ "trace_id": "trace-id", "content": "How many letters are in the word Python?", "role": "user", + "token_count": 0, "completion_id": None, "sequence": 0, "vendor": "gemini", @@ -167,6 +166,7 @@ def _test(): "trace_id": "trace-id", "content": "Model does not exist.", "role": "user", + "token_count": 0, "completion_id": None, "response.model": "does-not-exist", "sequence": 0, @@ -179,39 +179,6 @@ def _test(): @dt_enabled @reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(google.genai.errors.ClientError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "NOT_FOUND", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={ - "error.message": "models/does-not-exist is not found for API version v1beta, or is not supported for generateContent. Call ListModels to see the list of available models and their supported methods." - } -) -@validate_transaction_metrics( - "test_text_generation_error:test_text_generation_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/completion/Gemini/generate_content", 1)], - rollup_metrics=[("Llm/completion/Gemini/generate_content", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_text_generation_invalid_request_error_invalid_model_with_token_count(gemini_dev_client, set_trace_info): - with pytest.raises(google.genai.errors.ClientError): - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - gemini_dev_client.models.generate_content( - model="does-not-exist", - contents=["Model does not exist."], - config=google.genai.types.GenerateContentConfig(max_output_tokens=100, temperature=0.7), - ) - - -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) @validate_error_trace_attributes( callable_name(google.genai.errors.ClientError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "NOT_FOUND", "http.statusCode": 404}}, @@ -227,7 +194,7 @@ def test_text_generation_invalid_request_error_invalid_model_with_token_count(ge rollup_metrics=[("Llm/completion/Gemini/generate_content", 1)], background_task=True, ) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) +@validate_custom_events(expected_events_on_invalid_model_error) @validate_custom_event_count(count=2) @background_task() def test_text_generation_invalid_request_error_invalid_model_chat(gemini_dev_client, set_trace_info): @@ -266,6 +233,7 @@ def test_text_generation_invalid_request_error_invalid_model_chat(gemini_dev_cli "trace_id": "trace-id", "content": "Invalid API key.", "role": "user", + "token_count": 0, "response.model": "gemini-flash-2.0", "completion_id": None, "sequence": 0, @@ -377,43 +345,6 @@ def _test(): @dt_enabled @reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(google.genai.errors.ClientError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "NOT_FOUND", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={ - "error.message": "models/does-not-exist is not found for API version v1beta, or is not supported for generateContent. Call ListModels to see the list of available models and their supported methods." - } -) -@validate_transaction_metrics( - "test_text_generation_error:test_text_generation_async_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/completion/Gemini/generate_content", 1)], - rollup_metrics=[("Llm/completion/Gemini/generate_content", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_text_generation_async_invalid_request_error_invalid_model_with_token_count( - gemini_dev_client, loop, set_trace_info -): - with pytest.raises(google.genai.errors.ClientError): - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - loop.run_until_complete( - gemini_dev_client.models.generate_content( - model="does-not-exist", - contents=["Model does not exist."], - config=google.genai.types.GenerateContentConfig(max_output_tokens=100, temperature=0.7), - ) - ) - - -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) @validate_error_trace_attributes( callable_name(google.genai.errors.ClientError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "NOT_FOUND", "http.statusCode": 404}}, @@ -429,7 +360,7 @@ def test_text_generation_async_invalid_request_error_invalid_model_with_token_co rollup_metrics=[("Llm/completion/Gemini/generate_content", 1)], background_task=True, ) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) +@validate_custom_events(expected_events_on_invalid_model_error) @validate_custom_event_count(count=2) @background_task() def test_text_generation_async_invalid_request_error_invalid_model_chat(gemini_dev_client, loop, set_trace_info): diff --git a/tests/testing_support/ml_testing_utils.py b/tests/testing_support/ml_testing_utils.py index 4ff70c7ed4..55dbd08105 100644 --- a/tests/testing_support/ml_testing_utils.py +++ b/tests/testing_support/ml_testing_utils.py @@ -29,6 +29,7 @@ def llm_token_count_callback(model, content): return 105 +# This will be removed once all LLM instrumentations have been converted to use new token count design def add_token_count_to_events(expected_events): events = copy.deepcopy(expected_events) for event in events: @@ -37,6 +38,24 @@ def add_token_count_to_events(expected_events): return events +def add_token_count_to_embedding_events(expected_events): + events = copy.deepcopy(expected_events) + for event in events: + if event[0]["type"] == "LlmEmbedding": + event[1]["response.usage.total_tokens"] = 105 + return events + + +def add_token_counts_to_chat_events(expected_events): + events = copy.deepcopy(expected_events) + for event in events: + if event[0]["type"] == "LlmChatCompletionSummary": + event[1]["response.usage.prompt_tokens"] = 105 + event[1]["response.usage.completion_tokens"] = 105 + event[1]["response.usage.total_tokens"] = 210 + return events + + def events_sans_content(event): new_event = copy.deepcopy(event) for _event in new_event: From b266594910afccc7daf785cf26137694b8951307 Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Tue, 7 Oct 2025 13:14:56 -0700 Subject: [PATCH 009/124] Add response token count logic to OpenAI instrumentation. (#1498) * Add OpenAI token counts. * Add token counts to langchain + openai tests. * Remove unused expected events. * Linting * Add OpenAI token counts. * Add token counts to langchain + openai tests. * Remove unused expected events. * [MegaLinter] Apply linters fixes --------- Co-authored-by: Tim Pansino --- newrelic/hooks/mlmodel_openai.py | 87 ++++++++--- tests/mlmodel_langchain/test_chain.py | 8 + tests/mlmodel_openai/test_chat_completion.py | 12 +- .../test_chat_completion_error.py | 71 +-------- .../test_chat_completion_error_v1.py | 142 +----------------- .../test_chat_completion_stream.py | 101 ++++++++++++- .../test_chat_completion_stream_error.py | 75 +-------- .../test_chat_completion_stream_error_v1.py | 80 +--------- .../test_chat_completion_stream_v1.py | 11 +- .../mlmodel_openai/test_chat_completion_v1.py | 12 +- tests/mlmodel_openai/test_embeddings.py | 7 +- .../test_embeddings_error_v1.py | 120 +-------------- tests/mlmodel_openai/test_embeddings_v1.py | 7 +- tests/testing_support/ml_testing_utils.py | 8 + 14 files changed, 241 insertions(+), 500 deletions(-) diff --git a/newrelic/hooks/mlmodel_openai.py b/newrelic/hooks/mlmodel_openai.py index c3f7960b6e..3484762951 100644 --- a/newrelic/hooks/mlmodel_openai.py +++ b/newrelic/hooks/mlmodel_openai.py @@ -129,11 +129,11 @@ def create_chat_completion_message_event( span_id, trace_id, response_model, - request_model, response_id, request_id, llm_metadata, output_message_list, + all_token_counts, ): settings = transaction.settings if transaction.settings is not None else global_settings() @@ -153,11 +153,6 @@ def create_chat_completion_message_event( "request_id": request_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(request_model, message_content) - if settings.ai_monitoring.llm_token_count_callback - else None - ), "role": message.get("role"), "completion_id": chat_completion_id, "sequence": index, @@ -166,6 +161,9 @@ def create_chat_completion_message_event( "ingest_source": "Python", } + if all_token_counts: + chat_completion_input_message_dict["token_count"] = 0 + if settings.ai_monitoring.record_content.enabled: chat_completion_input_message_dict["content"] = message_content @@ -193,11 +191,6 @@ def create_chat_completion_message_event( "request_id": request_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(response_model, message_content) - if settings.ai_monitoring.llm_token_count_callback - else None - ), "role": message.get("role"), "completion_id": chat_completion_id, "sequence": index, @@ -207,6 +200,9 @@ def create_chat_completion_message_event( "is_response": True, } + if all_token_counts: + chat_completion_output_message_dict["token_count"] = 0 + if settings.ai_monitoring.record_content.enabled: chat_completion_output_message_dict["content"] = message_content @@ -280,15 +276,18 @@ def _record_embedding_success(transaction, embedding_id, linking_metadata, kwarg else getattr(attribute_response, "organization", None) ) + response_total_tokens = attribute_response.get("usage", {}).get("total_tokens") if response else None + + total_tokens = ( + settings.ai_monitoring.llm_token_count_callback(response_model, input_) + if settings.ai_monitoring.llm_token_count_callback and input_ + else response_total_tokens + ) + full_embedding_response_dict = { "id": embedding_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(response_model, input_) - if settings.ai_monitoring.llm_token_count_callback - else None - ), "request.model": kwargs.get("model") or kwargs.get("engine"), "request_id": request_id, "duration": ft.duration * 1000, @@ -313,6 +312,7 @@ def _record_embedding_success(transaction, embedding_id, linking_metadata, kwarg "response.headers.ratelimitRemainingRequests": check_rate_limit_header( response_headers, "x-ratelimit-remaining-requests", True ), + "response.usage.total_tokens": total_tokens, "vendor": "openai", "ingest_source": "Python", } @@ -475,12 +475,15 @@ def _handle_completion_success(transaction, linking_metadata, completion_id, kwa def _record_completion_success(transaction, linking_metadata, completion_id, kwargs, ft, response_headers, response): + settings = transaction.settings if transaction.settings is not None else global_settings() span_id = linking_metadata.get("span.id") trace_id = linking_metadata.get("trace.id") + try: if response: response_model = response.get("model") response_id = response.get("id") + token_usage = response.get("usage") or {} output_message_list = [] finish_reason = None choices = response.get("choices") or [] @@ -494,6 +497,7 @@ def _record_completion_success(transaction, linking_metadata, completion_id, kwa else: response_model = kwargs.get("response.model") response_id = kwargs.get("id") + token_usage = {} output_message_list = [] finish_reason = kwargs.get("finish_reason") if "content" in kwargs: @@ -505,10 +509,44 @@ def _record_completion_success(transaction, linking_metadata, completion_id, kwa output_message_list = [] request_model = kwargs.get("model") or kwargs.get("engine") - request_id = response_headers.get("x-request-id") - organization = response_headers.get("openai-organization") or getattr(response, "organization", None) messages = kwargs.get("messages") or [{"content": kwargs.get("prompt"), "role": "user"}] input_message_list = list(messages) + + # Extract token counts from response object + if token_usage: + response_prompt_tokens = token_usage.get("prompt_tokens") + response_completion_tokens = token_usage.get("completion_tokens") + response_total_tokens = token_usage.get("total_tokens") + + else: + response_prompt_tokens = None + response_completion_tokens = None + response_total_tokens = None + + # Calculate token counts by checking if a callback is registered and if we have the necessary content to pass + # to it. If not, then we use the token counts provided in the response object + input_message_content = " ".join([msg.get("content", "") for msg in input_message_list if msg.get("content")]) + prompt_tokens = ( + settings.ai_monitoring.llm_token_count_callback(request_model, input_message_content) + if settings.ai_monitoring.llm_token_count_callback and input_message_content + else response_prompt_tokens + ) + output_message_content = " ".join([msg.get("content", "") for msg in output_message_list if msg.get("content")]) + completion_tokens = ( + settings.ai_monitoring.llm_token_count_callback(response_model, output_message_content) + if settings.ai_monitoring.llm_token_count_callback and output_message_content + else response_completion_tokens + ) + + total_tokens = ( + prompt_tokens + completion_tokens if all([prompt_tokens, completion_tokens]) else response_total_tokens + ) + + all_token_counts = bool(prompt_tokens and completion_tokens and total_tokens) + + request_id = response_headers.get("x-request-id") + organization = response_headers.get("openai-organization") or getattr(response, "organization", None) + full_chat_completion_summary_dict = { "id": completion_id, "span_id": span_id, @@ -553,6 +591,12 @@ def _record_completion_success(transaction, linking_metadata, completion_id, kwa ), "response.number_of_messages": len(input_message_list) + len(output_message_list), } + + if all_token_counts: + full_chat_completion_summary_dict["response.usage.prompt_tokens"] = prompt_tokens + full_chat_completion_summary_dict["response.usage.completion_tokens"] = completion_tokens + full_chat_completion_summary_dict["response.usage.total_tokens"] = total_tokens + llm_metadata = _get_llm_attributes(transaction) full_chat_completion_summary_dict.update(llm_metadata) transaction.record_custom_event("LlmChatCompletionSummary", full_chat_completion_summary_dict) @@ -564,11 +608,11 @@ def _record_completion_success(transaction, linking_metadata, completion_id, kwa span_id, trace_id, response_model, - request_model, response_id, request_id, llm_metadata, output_message_list, + all_token_counts, ) except Exception: _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, traceback.format_exception(*sys.exc_info())) @@ -579,6 +623,7 @@ def _record_completion_error(transaction, linking_metadata, completion_id, kwarg trace_id = linking_metadata.get("trace.id") request_message_list = kwargs.get("messages", None) or [] notice_error_attributes = {} + try: if OPENAI_V1: response = getattr(exc, "response", None) @@ -643,6 +688,7 @@ def _record_completion_error(transaction, linking_metadata, completion_id, kwarg output_message_list = [] if "content" in kwargs: output_message_list = [{"content": kwargs.get("content"), "role": kwargs.get("role")}] + create_chat_completion_message_event( transaction, request_message_list, @@ -650,11 +696,12 @@ def _record_completion_error(transaction, linking_metadata, completion_id, kwarg span_id, trace_id, kwargs.get("response.model"), - request_model, response_id, request_id, llm_metadata, output_message_list, + # We do not record token counts in error cases, so set all_token_counts to True so the pipeline tokenizer does not run + all_token_counts=True, ) except Exception: _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, traceback.format_exception(*sys.exc_info())) diff --git a/tests/mlmodel_langchain/test_chain.py b/tests/mlmodel_langchain/test_chain.py index a6b7470a9a..5d7586ffb9 100644 --- a/tests/mlmodel_langchain/test_chain.py +++ b/tests/mlmodel_langchain/test_chain.py @@ -371,6 +371,7 @@ "response.headers.ratelimitResetRequests": "20ms", "response.headers.ratelimitRemainingTokens": 999992, "response.headers.ratelimitRemainingRequests": 2999, + "response.usage.total_tokens": 8, "vendor": "openai", "ingest_source": "Python", "input": "[[3923, 374, 220, 17, 489, 220, 19, 30]]", @@ -394,6 +395,7 @@ "response.headers.ratelimitResetRequests": "20ms", "response.headers.ratelimitRemainingTokens": 999998, "response.headers.ratelimitRemainingRequests": 2999, + "response.usage.total_tokens": 1, "vendor": "openai", "ingest_source": "Python", "input": "[[10590]]", @@ -464,6 +466,9 @@ "response.headers.ratelimitResetRequests": "8.64s", "response.headers.ratelimitRemainingTokens": 199912, "response.headers.ratelimitRemainingRequests": 9999, + "response.usage.prompt_tokens": 73, + "response.usage.completion_tokens": 375, + "response.usage.total_tokens": 448, "response.number_of_messages": 3, }, ], @@ -479,6 +484,7 @@ "sequence": 0, "response.model": "gpt-3.5-turbo-0125", "vendor": "openai", + "token_count": 0, "ingest_source": "Python", "content": "You are a generator of quiz questions for a seminar. Use the following pieces of retrieved context to generate 5 multiple choice questions (A,B,C,D) on the subject matter. Use a three sentence maximum and keep the answer concise. Render the output as HTML\n\nWhat is 2 + 4?", }, @@ -495,6 +501,7 @@ "sequence": 1, "response.model": "gpt-3.5-turbo-0125", "vendor": "openai", + "token_count": 0, "ingest_source": "Python", "content": "math", }, @@ -511,6 +518,7 @@ "sequence": 2, "response.model": "gpt-3.5-turbo-0125", "vendor": "openai", + "token_count": 0, "ingest_source": "Python", "is_response": True, "content": "```html\n\n\n\n Math Quiz\n\n\n

Math Quiz Questions

\n
    \n
  1. What is the result of 5 + 3?
    2. \n
      \n
    • A) 7
      • \n
    • B) 8
      • \n
    • C) 9
      • \n
    • D) 10
      • \n
    \n
  2. What is the product of 6 x 7?
    3. \n
      \n
    • A) 36
      • \n
    • B) 42
      • \n
    • C) 48
      • \n
    • D) 56
      • \n
    \n
  3. What is the square root of 64?
    4. \n
      \n
    • A) 6
      • \n
    • B) 7
      • \n
    • C) 8
      • \n
    • D) 9
      • \n
    \n
  4. What is the result of 12 / 4?
    5. \n
      \n
    • A) 2
      • \n
    • B) 3
      • \n
    • C) 4
      • \n
    • D) 5
      • \n
    \n
  5. What is the sum of 15 + 9?
    6. \n
      \n
    • A) 22
      • \n
    • B) 23
      • \n
    • C) 24
      • \n
    • D) 25
      • \n
    \n
\n\n\n```", diff --git a/tests/mlmodel_openai/test_chat_completion.py b/tests/mlmodel_openai/test_chat_completion.py index 1f8cf1cb74..5e4d209ed7 100644 --- a/tests/mlmodel_openai/test_chat_completion.py +++ b/tests/mlmodel_openai/test_chat_completion.py @@ -15,7 +15,7 @@ import openai from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, disabled_ai_monitoring_streaming_settings, @@ -55,6 +55,9 @@ "response.organization": "new-relic-nkmd8b", "request.temperature": 0.7, "request.max_tokens": 100, + "response.usage.completion_tokens": 11, + "response.usage.total_tokens": 64, + "response.usage.prompt_tokens": 53, "response.choices.finish_reason": "stop", "response.headers.llmVersion": "2020-10-01", "response.headers.ratelimitLimitRequests": 200, @@ -81,6 +84,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "gpt-3.5-turbo-0613", "vendor": "openai", "ingest_source": "Python", @@ -99,6 +103,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "gpt-3.5-turbo-0613", "vendor": "openai", "ingest_source": "Python", @@ -117,6 +122,7 @@ "role": "assistant", "completion_id": None, "sequence": 2, + "token_count": 0, "response.model": "gpt-3.5-turbo-0613", "vendor": "openai", "is_response": True, @@ -172,7 +178,7 @@ def test_openai_chat_completion_sync_no_content(set_trace_info): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events(add_token_counts_to_chat_events(chat_completion_recorded_events)) # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( @@ -343,7 +349,7 @@ def test_openai_chat_completion_async_no_content(loop, set_trace_info): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events(add_token_counts_to_chat_events(chat_completion_recorded_events)) # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( diff --git a/tests/mlmodel_openai/test_chat_completion_error.py b/tests/mlmodel_openai/test_chat_completion_error.py index bfb2267a33..97a4dd8793 100644 --- a/tests/mlmodel_openai/test_chat_completion_error.py +++ b/tests/mlmodel_openai/test_chat_completion_error.py @@ -15,13 +15,11 @@ import openai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, events_with_context_attrs, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -68,6 +66,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -83,6 +82,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -186,6 +186,7 @@ def test_chat_completion_invalid_request_error_no_model_no_content(set_trace_inf "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -193,36 +194,6 @@ def test_chat_completion_invalid_request_error_no_model_no_content(set_trace_inf ] -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.InvalidRequestError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - "test_chat_completion_error:test_chat_completion_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count(set_trace_info): - set_trace_info() - with pytest.raises(openai.InvalidRequestError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - - openai.ChatCompletion.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - ) - - # Invalid model provided @dt_enabled @reset_core_stats_engine() @@ -281,6 +252,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info): "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -296,6 +268,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info): "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -360,6 +333,7 @@ def test_chat_completion_authentication_error(monkeypatch, set_trace_info): "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -471,37 +445,6 @@ def test_chat_completion_invalid_request_error_no_model_async_no_content(loop, s ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.InvalidRequestError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - "test_chat_completion_error:test_chat_completion_invalid_request_error_invalid_model_with_token_count_async", - scoped_metrics=[("Llm/completion/OpenAI/acreate", 1)], - rollup_metrics=[("Llm/completion/OpenAI/acreate", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count_async(loop, set_trace_info): - set_trace_info() - with pytest.raises(openai.InvalidRequestError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - loop.run_until_complete( - openai.ChatCompletion.acreate( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - ) - ) - - # Invalid model provided @dt_enabled @reset_core_stats_engine() diff --git a/tests/mlmodel_openai/test_chat_completion_error_v1.py b/tests/mlmodel_openai/test_chat_completion_error_v1.py index 9be9fcab9c..5af1598847 100644 --- a/tests/mlmodel_openai/test_chat_completion_error_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_error_v1.py @@ -14,13 +14,11 @@ import openai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, events_with_context_attrs, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -67,6 +65,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -82,6 +81,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -229,6 +229,7 @@ def test_chat_completion_invalid_request_error_no_model_async_no_content(loop, s "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -266,37 +267,6 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info, syn ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - "test_chat_completion_error_v1:test_chat_completion_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count(set_trace_info, sync_openai_client): - set_trace_info() - with pytest.raises(openai.NotFoundError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - sync_openai_client.chat.completions.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - ) - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -329,41 +299,6 @@ def test_chat_completion_invalid_request_error_invalid_model_async(loop, set_tra ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - "test_chat_completion_error_v1:test_chat_completion_invalid_request_error_invalid_model_with_token_count_async", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count_async( - loop, set_trace_info, async_openai_client -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - loop.run_until_complete( - async_openai_client.chat.completions.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - ) - ) - - expected_events_on_wrong_api_key_error = [ ( {"type": "LlmChatCompletionSummary"}, @@ -391,6 +326,7 @@ def test_chat_completion_invalid_request_error_invalid_model_with_token_count_as "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -610,39 +546,6 @@ def test_chat_completion_invalid_request_error_invalid_model_with_raw_response(s ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - "test_chat_completion_error_v1:test_chat_completion_invalid_request_error_invalid_model_with_token_count_with_raw_response", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count_with_raw_response( - set_trace_info, sync_openai_client -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - sync_openai_client.chat.completions.with_raw_response.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - ) - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -677,41 +580,6 @@ def test_chat_completion_invalid_request_error_invalid_model_async_with_raw_resp ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - "test_chat_completion_error_v1:test_chat_completion_invalid_request_error_invalid_model_with_token_count_async_with_raw_response", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count_async_with_raw_response( - loop, set_trace_info, async_openai_client -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - loop.run_until_complete( - async_openai_client.chat.completions.with_raw_response.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - ) - ) - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( diff --git a/tests/mlmodel_openai/test_chat_completion_stream.py b/tests/mlmodel_openai/test_chat_completion_stream.py index ad89d6f260..8019c0b6a9 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream.py +++ b/tests/mlmodel_openai/test_chat_completion_stream.py @@ -15,7 +15,8 @@ import openai from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_streaming_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, disabled_ai_monitoring_streaming_settings, @@ -184,9 +185,101 @@ def test_openai_chat_completion_sync_no_content(set_trace_info): assert resp +chat_completion_recorded_token_events = [ + ( + {"type": "LlmChatCompletionSummary"}, + { + "id": None, # UUID that varies with each run + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "span_id": None, + "trace_id": "trace-id", + "request_id": "49dbbffbd3c3f4612aa48def69059ccd", + "duration": None, # Response time varies each test run + "request.model": "gpt-3.5-turbo", + "response.model": "gpt-3.5-turbo-0613", + "response.organization": "new-relic-nkmd8b", + "request.temperature": 0.7, + "request.max_tokens": 100, + "response.choices.finish_reason": "stop", + "response.headers.llmVersion": "2020-10-01", + "response.headers.ratelimitLimitRequests": 200, + "response.headers.ratelimitLimitTokens": 40000, + "response.headers.ratelimitResetTokens": "90ms", + "response.headers.ratelimitResetRequests": "7m12s", + "response.headers.ratelimitRemainingTokens": 39940, + "response.headers.ratelimitRemainingRequests": 199, + "vendor": "openai", + "ingest_source": "Python", + "response.number_of_messages": 3, + }, + ), + ( + {"type": "LlmChatCompletionMessage"}, + { + "id": "chatcmpl-87sb95K4EF2nuJRcTs43Tm9ntTemv-0", + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "request_id": "49dbbffbd3c3f4612aa48def69059ccd", + "span_id": None, + "trace_id": "trace-id", + "content": "You are a scientist.", + "role": "system", + "completion_id": None, + "sequence": 0, + "token_count": 0, + "response.model": "gpt-3.5-turbo-0613", + "vendor": "openai", + "ingest_source": "Python", + }, + ), + ( + {"type": "LlmChatCompletionMessage"}, + { + "id": "chatcmpl-87sb95K4EF2nuJRcTs43Tm9ntTemv-1", + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "request_id": "49dbbffbd3c3f4612aa48def69059ccd", + "span_id": None, + "trace_id": "trace-id", + "content": "What is 212 degrees Fahrenheit converted to Celsius?", + "role": "user", + "completion_id": None, + "sequence": 1, + "token_count": 0, + "response.model": "gpt-3.5-turbo-0613", + "vendor": "openai", + "ingest_source": "Python", + }, + ), + ( + {"type": "LlmChatCompletionMessage"}, + { + "id": "chatcmpl-87sb95K4EF2nuJRcTs43Tm9ntTemv-2", + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "request_id": "49dbbffbd3c3f4612aa48def69059ccd", + "span_id": None, + "trace_id": "trace-id", + "content": "212 degrees Fahrenheit is equal to 100 degrees Celsius.", + "role": "assistant", + "completion_id": None, + "sequence": 2, + "token_count": 0, + "response.model": "gpt-3.5-turbo-0613", + "vendor": "openai", + "is_response": True, + "ingest_source": "Python", + }, + ), +] + + @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events( + add_token_counts_to_chat_events(add_token_count_streaming_events(chat_completion_recorded_events)) +) # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( @@ -378,7 +471,9 @@ async def consumer(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events( + add_token_counts_to_chat_events(add_token_count_streaming_events(chat_completion_recorded_events)) +) @validate_custom_event_count(count=4) @validate_transaction_metrics( name="test_chat_completion_stream:test_openai_chat_completion_async_with_token_count", diff --git a/tests/mlmodel_openai/test_chat_completion_stream_error.py b/tests/mlmodel_openai/test_chat_completion_stream_error.py index eebb5ee8fb..e8e55426e9 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream_error.py +++ b/tests/mlmodel_openai/test_chat_completion_stream_error.py @@ -15,13 +15,11 @@ import openai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, events_with_context_attrs, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -68,6 +66,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -83,6 +82,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -191,6 +191,7 @@ def test_chat_completion_invalid_request_error_no_model_no_content(set_trace_inf "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -198,38 +199,6 @@ def test_chat_completion_invalid_request_error_no_model_no_content(set_trace_inf ] -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.InvalidRequestError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - "test_chat_completion_stream_error:test_chat_completion_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count(set_trace_info): - set_trace_info() - with pytest.raises(openai.InvalidRequestError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - generator = openai.ChatCompletion.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - stream=True, - ) - for resp in generator: - assert resp - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -290,6 +259,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info): "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -305,6 +275,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info): "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -374,6 +345,7 @@ def test_chat_completion_authentication_error(monkeypatch, set_trace_info): "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -488,38 +460,6 @@ def test_chat_completion_invalid_request_error_no_model_async_no_content(loop, s ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.InvalidRequestError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - "test_chat_completion_stream_error:test_chat_completion_invalid_request_error_invalid_model_with_token_count_async", - scoped_metrics=[("Llm/completion/OpenAI/acreate", 1)], - rollup_metrics=[("Llm/completion/OpenAI/acreate", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count_async(loop, set_trace_info): - set_trace_info() - with pytest.raises(openai.InvalidRequestError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - loop.run_until_complete( - openai.ChatCompletion.acreate( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - stream=True, - ) - ) - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -649,6 +589,7 @@ def test_chat_completion_wrong_api_key_error_async(loop, monkeypatch, set_trace_ "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, diff --git a/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py b/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py index 5f769ea0e6..64798300fc 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py @@ -12,16 +12,13 @@ # See the License for the specific language governing permissions and # limitations under the License. - import openai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, events_with_context_attrs, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -68,6 +65,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -83,6 +81,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -243,6 +242,7 @@ async def consumer(): "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -281,77 +281,6 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info, syn assert resp -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - "test_chat_completion_stream_error_v1:test_chat_completion_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count(set_trace_info, sync_openai_client): - set_trace_info() - with pytest.raises(openai.NotFoundError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - - generator = sync_openai_client.chat.completions.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - stream=True, - ) - for resp in generator: - assert resp - - -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - "test_chat_completion_stream_error_v1:test_chat_completion_invalid_request_error_invalid_model_async_with_token_count", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_async_with_token_count( - loop, set_trace_info, async_openai_client -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - - async def consumer(): - generator = await async_openai_client.chat.completions.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - stream=True, - ) - async for resp in generator: - assert resp - - loop.run_until_complete(consumer()) - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -414,6 +343,7 @@ async def consumer(): "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, diff --git a/tests/mlmodel_openai/test_chat_completion_stream_v1.py b/tests/mlmodel_openai/test_chat_completion_stream_v1.py index 796404012b..c88e8b1df6 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_stream_v1.py @@ -17,7 +17,8 @@ from conftest import get_openai_version from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_streaming_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, disabled_ai_monitoring_streaming_settings, @@ -300,7 +301,9 @@ def test_openai_chat_completion_sync_no_content(set_trace_info, sync_openai_clie @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events( + add_token_counts_to_chat_events(add_token_count_streaming_events(chat_completion_recorded_events)) +) # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( @@ -622,7 +625,9 @@ async def consumer(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events( + add_token_counts_to_chat_events(add_token_count_streaming_events(chat_completion_recorded_events)) +) # One summary event, one system message, one user message, and one response message from the assistant # @validate_custom_event_count(count=4) @validate_transaction_metrics( diff --git a/tests/mlmodel_openai/test_chat_completion_v1.py b/tests/mlmodel_openai/test_chat_completion_v1.py index 817db35d8e..007effcb17 100644 --- a/tests/mlmodel_openai/test_chat_completion_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_v1.py @@ -15,7 +15,7 @@ import openai from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, disabled_ai_monitoring_streaming_settings, @@ -54,6 +54,9 @@ "response.organization": "new-relic-nkmd8b", "request.temperature": 0.7, "request.max_tokens": 100, + "response.usage.completion_tokens": 75, + "response.usage.total_tokens": 101, + "response.usage.prompt_tokens": 26, "response.choices.finish_reason": "stop", "response.headers.llmVersion": "2020-10-01", "response.headers.ratelimitLimitRequests": 10000, @@ -80,6 +83,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "gpt-3.5-turbo-0125", "vendor": "openai", "ingest_source": "Python", @@ -98,6 +102,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "gpt-3.5-turbo-0125", "vendor": "openai", "ingest_source": "Python", @@ -116,6 +121,7 @@ "role": "assistant", "completion_id": None, "sequence": 2, + "token_count": 0, "response.model": "gpt-3.5-turbo-0125", "vendor": "openai", "is_response": True, @@ -193,7 +199,7 @@ def test_openai_chat_completion_sync_no_content(set_trace_info, sync_openai_clie @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events(add_token_counts_to_chat_events(chat_completion_recorded_events)) # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( @@ -389,7 +395,7 @@ def test_openai_chat_completion_async_with_llm_metadata_no_content(loop, set_tra @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events(add_token_counts_to_chat_events(chat_completion_recorded_events)) # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( diff --git a/tests/mlmodel_openai/test_embeddings.py b/tests/mlmodel_openai/test_embeddings.py index c3c3e7c429..935db04fe0 100644 --- a/tests/mlmodel_openai/test_embeddings.py +++ b/tests/mlmodel_openai/test_embeddings.py @@ -19,7 +19,7 @@ validate_attributes, ) from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_to_embedding_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -55,6 +55,7 @@ "response.headers.ratelimitResetRequests": "19m45.394s", "response.headers.ratelimitRemainingTokens": 149994, "response.headers.ratelimitRemainingRequests": 197, + "response.usage.total_tokens": 6, "vendor": "openai", "ingest_source": "Python", }, @@ -107,7 +108,7 @@ def test_openai_embedding_sync_no_content(set_trace_info): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(embedding_recorded_events)) +@validate_custom_events(add_token_count_to_embedding_events(embedding_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_embeddings:test_openai_embedding_sync_with_token_count", @@ -191,7 +192,7 @@ def test_openai_embedding_async_no_content(loop, set_trace_info): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(embedding_recorded_events)) +@validate_custom_events(add_token_count_to_embedding_events(embedding_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_embeddings:test_openai_embedding_async_with_token_count", diff --git a/tests/mlmodel_openai/test_embeddings_error_v1.py b/tests/mlmodel_openai/test_embeddings_error_v1.py index fd29236122..499f96893b 100644 --- a/tests/mlmodel_openai/test_embeddings_error_v1.py +++ b/tests/mlmodel_openai/test_embeddings_error_v1.py @@ -16,12 +16,10 @@ import openai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -149,32 +147,6 @@ def test_embeddings_invalid_request_error_no_model_async(set_trace_info, async_o ] -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"http.statusCode": 404, "error.code": "model_not_found"}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - name="test_embeddings_error_v1:test_embeddings_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/embedding/OpenAI/create", 1)], - rollup_metrics=[("Llm/embedding/OpenAI/create", 1)], - custom_metrics=[(f"Supportability/Python/ML/OpenAI/{openai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_with_token_count(set_trace_info, sync_openai_client): - set_trace_info() - with pytest.raises(openai.NotFoundError): - sync_openai_client.embeddings.create(input="Model does not exist.", model="does-not-exist") - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -255,36 +227,6 @@ def test_embeddings_invalid_request_error_invalid_model_async_no_content(set_tra ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"http.statusCode": 404, "error.code": "model_not_found"}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - name="test_embeddings_error_v1:test_embeddings_invalid_request_error_invalid_model_async_with_token_count", - scoped_metrics=[("Llm/embedding/OpenAI/create", 1)], - rollup_metrics=[("Llm/embedding/OpenAI/create", 1)], - custom_metrics=[(f"Supportability/Python/ML/OpenAI/{openai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_async_with_token_count( - set_trace_info, async_openai_client, loop -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - loop.run_until_complete( - async_openai_client.embeddings.create(input="Model does not exist.", model="does-not-exist") - ) - - embedding_invalid_key_error_events = [ ( {"type": "LlmEmbedding"}, @@ -449,34 +391,6 @@ def test_embeddings_invalid_request_error_no_model_async_with_raw_response(set_t ) # no model provided -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"http.statusCode": 404, "error.code": "model_not_found"}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - name="test_embeddings_error_v1:test_embeddings_invalid_request_error_invalid_model_with_token_count_with_raw_response", - scoped_metrics=[("Llm/embedding/OpenAI/create", 1)], - rollup_metrics=[("Llm/embedding/OpenAI/create", 1)], - custom_metrics=[(f"Supportability/Python/ML/OpenAI/{openai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_with_token_count_with_raw_response( - set_trace_info, sync_openai_client -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - sync_openai_client.embeddings.with_raw_response.create(input="Model does not exist.", model="does-not-exist") - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -566,38 +480,6 @@ def test_embeddings_invalid_request_error_invalid_model_async_no_content_with_ra ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"http.statusCode": 404, "error.code": "model_not_found"}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - name="test_embeddings_error_v1:test_embeddings_invalid_request_error_invalid_model_async_with_token_count_with_raw_response", - scoped_metrics=[("Llm/embedding/OpenAI/create", 1)], - rollup_metrics=[("Llm/embedding/OpenAI/create", 1)], - custom_metrics=[(f"Supportability/Python/ML/OpenAI/{openai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_async_with_token_count_with_raw_response( - set_trace_info, async_openai_client, loop -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - loop.run_until_complete( - async_openai_client.embeddings.with_raw_response.create( - input="Model does not exist.", model="does-not-exist" - ) - ) - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( diff --git a/tests/mlmodel_openai/test_embeddings_v1.py b/tests/mlmodel_openai/test_embeddings_v1.py index 405a2a9e5f..3801d3639c 100644 --- a/tests/mlmodel_openai/test_embeddings_v1.py +++ b/tests/mlmodel_openai/test_embeddings_v1.py @@ -15,7 +15,7 @@ import openai from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_to_embedding_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -48,6 +48,7 @@ "response.headers.ratelimitResetRequests": "20ms", "response.headers.ratelimitRemainingTokens": 999994, "response.headers.ratelimitRemainingRequests": 2999, + "response.usage.total_tokens": 6, "vendor": "openai", "ingest_source": "Python", }, @@ -111,7 +112,7 @@ def test_openai_embedding_sync_no_content(set_trace_info, sync_openai_client): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(embedding_recorded_events)) +@validate_custom_events(add_token_count_to_embedding_events(embedding_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_embeddings_v1:test_openai_embedding_sync_with_token_count", @@ -206,7 +207,7 @@ def test_openai_embedding_async_no_content(loop, set_trace_info, async_openai_cl @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(embedding_recorded_events)) +@validate_custom_events(add_token_count_to_embedding_events(embedding_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_embeddings_v1:test_openai_embedding_async_with_token_count", diff --git a/tests/testing_support/ml_testing_utils.py b/tests/testing_support/ml_testing_utils.py index 55dbd08105..8c2c0444f0 100644 --- a/tests/testing_support/ml_testing_utils.py +++ b/tests/testing_support/ml_testing_utils.py @@ -46,6 +46,14 @@ def add_token_count_to_embedding_events(expected_events): return events +def add_token_count_streaming_events(expected_events): + events = copy.deepcopy(expected_events) + for event in events: + if event[0]["type"] == "LlmChatCompletionMessage": + event[1]["token_count"] = 0 + return events + + def add_token_counts_to_chat_events(expected_events): events = copy.deepcopy(expected_events) for event in events: From 41939912cdde3bd4f6506542e1333678ec4885eb Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Mon, 17 Nov 2025 14:54:25 -0800 Subject: [PATCH 010/124] Fix instability in CI caused by health check tests (#1584) --- .../test_agent_control_health_check.py | 22 +++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/tests/agent_features/test_agent_control_health_check.py b/tests/agent_features/test_agent_control_health_check.py index e12f3a07f0..84058a1b28 100644 --- a/tests/agent_features/test_agent_control_health_check.py +++ b/tests/agent_features/test_agent_control_health_check.py @@ -38,7 +38,7 @@ def get_health_file_contents(tmp_path): return contents -@pytest.fixture(scope="module", autouse=True) +@pytest.fixture(autouse=True) def restore_settings_fixture(): # Backup settings from before this test file runs original_settings = global_settings() @@ -51,6 +51,10 @@ def restore_settings_fixture(): original_settings.__dict__.clear() original_settings.__dict__.update(backup) + # Re-initialize the agent to restore the settings + _reset_configuration_done() + initialize() + @pytest.mark.parametrize("file_uri", ["", "file://", "/test/dir", "foo:/test/dir"]) def test_invalid_file_directory_supplied(monkeypatch, file_uri): @@ -155,10 +159,18 @@ def test_no_override_on_unhealthy_shutdown(monkeypatch, tmp_path): def test_health_check_running_threads(monkeypatch, tmp_path): - running_threads = threading.enumerate() - # Only the main thread should be running since not agent control env vars are set - assert len(running_threads) == 1 + # If the Activate-Session thread is still active, give it time to close before we proceed + timeout = 30.0 + while len(threading.enumerate()) != 1 and timeout > 0: + time.sleep(0.1) + timeout -= 0.1 + # Only the main thread should be running since no agent control env vars are set + assert len(threading.enumerate()) == 1, ( + f"Expected only the main thread to be running before the test starts. Got: {threading.enumerate()}" + ) + + # Setup expected env vars to run agent control health check monkeypatch.setenv("NEW_RELIC_AGENT_CONTROL_ENABLED", "True") file_path = tmp_path.as_uri() monkeypatch.setenv("NEW_RELIC_AGENT_CONTROL_HEALTH_DELIVERY_LOCATION", file_path) @@ -180,6 +192,7 @@ def test_proxy_error_status(monkeypatch, tmp_path): file_path = tmp_path.as_uri() monkeypatch.setenv("NEW_RELIC_AGENT_CONTROL_HEALTH_DELIVERY_LOCATION", file_path) + # Re-initialize the agent to allow the health check thread to start _reset_configuration_done() initialize() @@ -209,6 +222,7 @@ def test_multiple_activations_running_threads(monkeypatch, tmp_path): file_path = tmp_path.as_uri() monkeypatch.setenv("NEW_RELIC_AGENT_CONTROL_HEALTH_DELIVERY_LOCATION", file_path) + # Re-initialize the agent to allow the health check thread to start and assert that it did _reset_configuration_done() initialize() From 32215b90c906ee43ae5e03379cd87a3e9a80ff8b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 17 Nov 2025 16:20:03 -0800 Subject: [PATCH 011/124] Bump the github_actions group across 1 directory with 5 updates (#1582) Bumps the github_actions group with 5 updates in the / directory: | Package | From | To | | --- | --- | --- | | [actions/checkout](https://github.com/actions/checkout) | `5.0.0` | `5.0.1` | | [docker/metadata-action](https://github.com/docker/metadata-action) | `5.8.0` | `5.9.0` | | [docker/setup-qemu-action](https://github.com/docker/setup-qemu-action) | `3.6.0` | `3.7.0` | | [astral-sh/setup-uv](https://github.com/astral-sh/setup-uv) | `7.1.2` | `7.1.3` | | [github/codeql-action](https://github.com/github/codeql-action) | `4.31.2` | `4.31.3` | Updates `actions/checkout` from 5.0.0 to 5.0.1 - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/08c6903cd8c0fde910a37f88322edcfb5dd907a8...93cb6efe18208431cddfb8368fd83d5badbf9bfd) Updates `docker/metadata-action` from 5.8.0 to 5.9.0 - [Release notes](https://github.com/docker/metadata-action/releases) - [Commits](https://github.com/docker/metadata-action/compare/c1e51972afc2121e065aed6d45c65596fe445f3f...318604b99e75e41977312d83839a89be02ca4893) Updates `docker/setup-qemu-action` from 3.6.0 to 3.7.0 - [Release notes](https://github.com/docker/setup-qemu-action/releases) - [Commits](https://github.com/docker/setup-qemu-action/compare/29109295f81e9208d7d86ff1c6c12d2833863392...c7c53464625b32c7a7e944ae62b3e17d2b600130) Updates `astral-sh/setup-uv` from 7.1.2 to 7.1.3 - [Release notes](https://github.com/astral-sh/setup-uv/releases) - [Commits](https://github.com/astral-sh/setup-uv/compare/85856786d1ce8acfbcc2f13a5f3fbd6b938f9f41...5a7eac68fb9809dea845d802897dc5c723910fa3) Updates `github/codeql-action` from 4.31.2 to 4.31.3 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/github/codeql-action/compare/0499de31b99561a6d14a36a5f662c2a54f91beee...014f16e7ab1402f30e7c3329d33797e7948572db) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: 5.0.1 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions - dependency-name: docker/metadata-action dependency-version: 5.9.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: docker/setup-qemu-action dependency-version: 3.7.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: astral-sh/setup-uv dependency-version: 7.1.3 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions - dependency-name: github/codeql-action dependency-version: 4.31.3 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- .github/workflows/addlicense.yml | 2 +- .github/workflows/benchmarks.yml | 2 +- .github/workflows/build-ci-image.yml | 6 +-- .github/workflows/deploy.yml | 6 +-- .github/workflows/mega-linter.yml | 2 +- .github/workflows/tests.yml | 58 ++++++++++++++-------------- .github/workflows/trivy.yml | 4 +- 7 files changed, 40 insertions(+), 40 deletions(-) diff --git a/.github/workflows/addlicense.yml b/.github/workflows/addlicense.yml index 8d66691ff7..83e5b29ef4 100644 --- a/.github/workflows/addlicense.yml +++ b/.github/workflows/addlicense.yml @@ -39,7 +39,7 @@ jobs: permissions: contents: read steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | diff --git a/.github/workflows/benchmarks.yml b/.github/workflows/benchmarks.yml index 513e467f29..a65695e7c4 100644 --- a/.github/workflows/benchmarks.yml +++ b/.github/workflows/benchmarks.yml @@ -38,7 +38,7 @@ jobs: BASE_SHA: ${{ github.event.pull_request.base.sha }} steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 with: fetch-depth: 0 diff --git a/.github/workflows/build-ci-image.yml b/.github/workflows/build-ci-image.yml index ab183f48a2..061233b6dd 100644 --- a/.github/workflows/build-ci-image.yml +++ b/.github/workflows/build-ci-image.yml @@ -43,7 +43,7 @@ jobs: name: Docker Build ${{ matrix.platform }} steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 with: persist-credentials: false fetch-depth: 0 @@ -60,7 +60,7 @@ jobs: - name: Generate Docker Metadata (Tags and Labels) id: meta - uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # 5.8.0 + uses: docker/metadata-action@318604b99e75e41977312d83839a89be02ca4893 # 5.9.0 with: images: ghcr.io/${{ steps.image-name.outputs.IMAGE_NAME }} flavor: | @@ -139,7 +139,7 @@ jobs: - name: Generate Docker Metadata (Tags and Labels) id: meta - uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # 5.8.0 + uses: docker/metadata-action@318604b99e75e41977312d83839a89be02ca4893 # 5.9.0 with: images: ghcr.io/${{ steps.image-name.outputs.IMAGE_NAME }} flavor: | diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 8b469eaacb..af4739f2a3 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -69,14 +69,14 @@ jobs: runs-on: ${{ matrix.os }} steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 with: persist-credentials: false fetch-depth: 0 - name: Setup QEMU if: runner.os == 'Linux' - uses: docker/setup-qemu-action@29109295f81e9208d7d86ff1c6c12d2833863392 # 3.6.0 + uses: docker/setup-qemu-action@c7c53464625b32c7a7e944ae62b3e17d2b600130 # 3.7.0 with: platforms: arm64 @@ -109,7 +109,7 @@ jobs: runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 with: persist-credentials: false fetch-depth: 0 diff --git a/.github/workflows/mega-linter.yml b/.github/workflows/mega-linter.yml index 8f74866d43..0f869f3b58 100644 --- a/.github/workflows/mega-linter.yml +++ b/.github/workflows/mega-linter.yml @@ -45,7 +45,7 @@ jobs: steps: # Git Checkout - name: Checkout Code - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 with: token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }} fetch-depth: 0 # Required for pushing commits to PRs diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index e9ef7b2d4e..9e47302bd4 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -93,7 +93,7 @@ jobs: - tests steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # 6.0.0 with: python-version: "3.13" @@ -127,7 +127,7 @@ jobs: - tests steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # 6.0.0 with: python-version: "3.13" @@ -166,7 +166,7 @@ jobs: --add-host=host.docker.internal:host-gateway timeout-minutes: 30 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -231,7 +231,7 @@ jobs: --add-host=host.docker.internal:host-gateway timeout-minutes: 30 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -294,14 +294,14 @@ jobs: runs-on: windows-2025 timeout-minutes: 30 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | git fetch --tags origin - name: Install uv - uses: astral-sh/setup-uv@85856786d1ce8acfbcc2f13a5f3fbd6b938f9f41 # 7.1.2 + uses: astral-sh/setup-uv@5a7eac68fb9809dea845d802897dc5c723910fa3 # 7.1.3 - name: Install Python run: | @@ -363,14 +363,14 @@ jobs: runs-on: windows-11-arm timeout-minutes: 30 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | git fetch --tags origin - name: Install uv - uses: astral-sh/setup-uv@85856786d1ce8acfbcc2f13a5f3fbd6b938f9f41 # 7.1.2 + uses: astral-sh/setup-uv@5a7eac68fb9809dea845d802897dc5c723910fa3 # 7.1.3 - name: Install Python run: | @@ -443,7 +443,7 @@ jobs: --add-host=host.docker.internal:host-gateway timeout-minutes: 30 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -526,7 +526,7 @@ jobs: --health-retries 10 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -606,7 +606,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -687,7 +687,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -772,7 +772,7 @@ jobs: # from every being executed as bash commands. steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -837,7 +837,7 @@ jobs: --add-host=host.docker.internal:host-gateway timeout-minutes: 30 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -927,7 +927,7 @@ jobs: KAFKA_CFG_INTER_BROKER_LISTENER_NAME: L3 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -1005,7 +1005,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -1083,7 +1083,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -1161,7 +1161,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -1244,7 +1244,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -1327,7 +1327,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -1406,7 +1406,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -1487,7 +1487,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -1567,7 +1567,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -1647,7 +1647,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -1726,7 +1726,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -1804,7 +1804,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -1923,7 +1923,7 @@ jobs: --add-host=host.docker.internal:host-gateway steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -2003,7 +2003,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | @@ -2081,7 +2081,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 - name: Fetch git tags run: | diff --git a/.github/workflows/trivy.yml b/.github/workflows/trivy.yml index c373a38bb1..e4b0e38c9c 100644 --- a/.github/workflows/trivy.yml +++ b/.github/workflows/trivy.yml @@ -32,7 +32,7 @@ jobs: steps: # Git Checkout - name: Checkout Code - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # 5.0.0 + uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 with: token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }} fetch-depth: 0 @@ -61,6 +61,6 @@ jobs: - name: Upload Trivy scan results to GitHub Security tab if: ${{ github.event_name == 'schedule' }} - uses: github/codeql-action/upload-sarif@0499de31b99561a6d14a36a5f662c2a54f91beee # 4.31.2 + uses: github/codeql-action/upload-sarif@014f16e7ab1402f30e7c3329d33797e7948572db # 4.31.3 with: sarif_file: "trivy-results.sarif" From f59f52cd5c4856c57670ff8c4db40d723553ed96 Mon Sep 17 00:00:00 2001 From: Lalleh Rafeei <84813886+lrafeei@users.noreply.github.com> Date: Mon, 17 Nov 2025 16:54:54 -0800 Subject: [PATCH 012/124] Asyncio loop_factory fix (#1576) * Runner instrumentation in asyncio * Clean up asyncio instrumentation * Add asyncio tests for loop_factory * Modify uvicorn test for loop_factory * Fix linter errors * [MegaLinter] Apply linters fixes * Apply suggestions from code review --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Tim Pansino --- newrelic/config.py | 6 +- newrelic/hooks/coroutines_asyncio.py | 61 +++++++-- tests/adapter_uvicorn/test_uvicorn.py | 6 +- .../test_context_propagation.py | 119 +++++++++++++++++- tox.ini | 8 +- 5 files changed, 176 insertions(+), 24 deletions(-) diff --git a/newrelic/config.py b/newrelic/config.py index 21ce996f6c..c2b7b5c2d6 100644 --- a/newrelic/config.py +++ b/newrelic/config.py @@ -2084,6 +2084,10 @@ def _process_module_builtin_defaults(): "asyncio.base_events", "newrelic.hooks.coroutines_asyncio", "instrument_asyncio_base_events" ) + _process_module_definition("asyncio.events", "newrelic.hooks.coroutines_asyncio", "instrument_asyncio_events") + + _process_module_definition("asyncio.runners", "newrelic.hooks.coroutines_asyncio", "instrument_asyncio_runners") + _process_module_definition( "langchain_core.runnables.base", "newrelic.hooks.mlmodel_langchain", @@ -2671,8 +2675,6 @@ def _process_module_builtin_defaults(): "langchain_core.callbacks.manager", "newrelic.hooks.mlmodel_langchain", "instrument_langchain_callbacks_manager" ) - _process_module_definition("asyncio.events", "newrelic.hooks.coroutines_asyncio", "instrument_asyncio_events") - _process_module_definition("asgiref.sync", "newrelic.hooks.adapter_asgiref", "instrument_asgiref_sync") _process_module_definition( diff --git a/newrelic/hooks/coroutines_asyncio.py b/newrelic/hooks/coroutines_asyncio.py index 41fc776595..6f862d52dd 100644 --- a/newrelic/hooks/coroutines_asyncio.py +++ b/newrelic/hooks/coroutines_asyncio.py @@ -16,36 +16,73 @@ from newrelic.core.trace_cache import trace_cache -def remove_from_cache(task): +def remove_from_cache_callback(task): cache = trace_cache() cache.task_stop(task) -def propagate_task_context(task): +def wrap_create_task(task): trace_cache().task_start(task) - task.add_done_callback(remove_from_cache) + task.add_done_callback(remove_from_cache_callback) return task -def _bind_loop(loop, *args, **kwargs): +def _instrument_event_loop(loop): + if loop and hasattr(loop, "create_task") and not hasattr(loop.create_task, "__wrapped__"): + wrap_out_function(loop, "create_task", wrap_create_task) + + +def _bind_set_event_loop(loop, *args, **kwargs): return loop -def wrap_create_task(wrapped, instance, args, kwargs): - loop = _bind_loop(*args, **kwargs) +def wrap_set_event_loop(wrapped, instance, args, kwargs): + loop = _bind_set_event_loop(*args, **kwargs) - if loop and not hasattr(loop.create_task, "__wrapped__"): - wrap_out_function(loop, "create_task", propagate_task_context) + _instrument_event_loop(loop) return wrapped(*args, **kwargs) +def wrap__lazy_init(wrapped, instance, args, kwargs): + result = wrapped(*args, **kwargs) + # This logic can be used for uvloop, but should + # work for any valid custom loop factory. + + # A custom loop_factory will be used to create + # a new event loop instance. It will then run + # the main() coroutine on this event loop. Once + # this coroutine is complete, the event loop will + # be stopped and closed. + + # The new loop that is created and set as the + # running loop of the duration of the run() call. + # When the coroutine starts, it runs in the context + # that was active when run() was called. Any tasks + # created within this coroutine on this new event + # loop will inherit that context. + + # Note: The loop created by loop_factory is never + # set as the global current loop for the thread, + # even while it is running. + loop = instance._loop + _instrument_event_loop(loop) + + return result + + def instrument_asyncio_base_events(module): - wrap_out_function(module, "BaseEventLoop.create_task", propagate_task_context) + wrap_out_function(module, "BaseEventLoop.create_task", wrap_create_task) def instrument_asyncio_events(module): if hasattr(module, "_BaseDefaultEventLoopPolicy"): # Python >= 3.14 - wrap_function_wrapper(module, "_BaseDefaultEventLoopPolicy.set_event_loop", wrap_create_task) - else: # Python <= 3.13 - wrap_function_wrapper(module, "BaseDefaultEventLoopPolicy.set_event_loop", wrap_create_task) + wrap_function_wrapper(module, "_BaseDefaultEventLoopPolicy.set_event_loop", wrap_set_event_loop) + elif hasattr(module, "BaseDefaultEventLoopPolicy"): # Python <= 3.13 + wrap_function_wrapper(module, "BaseDefaultEventLoopPolicy.set_event_loop", wrap_set_event_loop) + + +# For Python >= 3.11 +def instrument_asyncio_runners(module): + if hasattr(module, "Runner") and hasattr(module.Runner, "_lazy_init"): + wrap_function_wrapper(module, "Runner._lazy_init", wrap__lazy_init) diff --git a/tests/adapter_uvicorn/test_uvicorn.py b/tests/adapter_uvicorn/test_uvicorn.py index 0084be3e46..d5db2d6ca6 100644 --- a/tests/adapter_uvicorn/test_uvicorn.py +++ b/tests/adapter_uvicorn/test_uvicorn.py @@ -56,8 +56,8 @@ def app(request): return request.param -@pytest.fixture -def port(app): +@pytest.fixture(params=["asyncio", "uvloop", "none"], ids=["asyncio", "uvloop", "none"]) +def port(app, request): port = get_open_port() loops = [] @@ -72,7 +72,7 @@ def on_tick_sync(): async def on_tick(): on_tick_sync() - config = Config(app, host="127.0.0.1", port=port, loop="asyncio") + config = Config(app, host="127.0.0.1", port=port, loop=request.param) config.callback_notify = on_tick config.log_config = {"version": 1} config.disable_lifespan = True diff --git a/tests/coroutines_asyncio/test_context_propagation.py b/tests/coroutines_asyncio/test_context_propagation.py index b338b6ec3e..eb5c358745 100644 --- a/tests/coroutines_asyncio/test_context_propagation.py +++ b/tests/coroutines_asyncio/test_context_propagation.py @@ -36,16 +36,31 @@ import uvloop loop_policies = (pytest.param(None, id="asyncio"), pytest.param(uvloop.EventLoopPolicy(), id="uvloop")) + uvloop_factory = (pytest.param(uvloop.new_event_loop, id="uvloop"), pytest.param(None, id="None")) except ImportError: loop_policies = (pytest.param(None, id="asyncio"),) + uvloop_factory = (pytest.param(None, id="None"),) + + +def loop_factories(): + import asyncio + + if sys.platform == "win32": + return (pytest.param(asyncio.ProactorEventLoop, id="asyncio.ProactorEventLoop"), *uvloop_factory) + else: + return (pytest.param(asyncio.SelectorEventLoop, id="asyncio.SelectorEventLoop"), *uvloop_factory) @pytest.fixture(autouse=True) def reset_event_loop(): - from asyncio import set_event_loop, set_event_loop_policy + try: + from asyncio import set_event_loop, set_event_loop_policy + + # Remove the loop policy to avoid side effects + set_event_loop_policy(None) + except ImportError: + from asyncio import set_event_loop - # Remove the loop policy to avoid side effects - set_event_loop_policy(None) set_event_loop(None) @@ -102,6 +117,7 @@ async def _test(asyncio, schedule, nr_enabled=True): return trace +@pytest.mark.skipif(sys.version_info >= (3, 16), reason="loop_policy is not available") @pytest.mark.parametrize("loop_policy", loop_policies) @pytest.mark.parametrize("schedule", ("create_task", "ensure_future")) @validate_transaction_metrics( @@ -166,10 +182,12 @@ def handle_exception(loop, context): memcache_trace("cmd"), ], ) -def test_two_transactions(event_loop, trace): +def test_two_transactions_with_global_event_loop(event_loop, trace): """ Instantiate a coroutine in one transaction and await it in another. This should not cause any errors. + This uses the global event loop policy, which has been deprecated + since Python 3.11 and is scheduled for removal in Python 3.16. """ import asyncio @@ -211,6 +229,99 @@ async def await_task(): event_loop.run_until_complete(asyncio.gather(afut, bfut)) +@pytest.mark.skipif(sys.version_info < (3, 11), reason="asyncio.Runner is not available") +@validate_transaction_metrics("await_task", background_task=True) +@validate_transaction_metrics("create_coro", background_task=True, index=-2) +@pytest.mark.parametrize("loop_factory", loop_factories()) +@pytest.mark.parametrize( + "trace", + [ + function_trace(name="simple_gen"), + external_trace(library="lib", url="http://foo.com"), + database_trace("select * from foo"), + datastore_trace("lib", "foo", "bar"), + message_trace("lib", "op", "typ", "name"), + memcache_trace("cmd"), + ], +) +def test_two_transactions_with_loop_factory(trace, loop_factory): + """ + Instantiate a coroutine in one transaction and await it in + another. This should not cause any errors. + Starting in Python 3.11, the asyncio.Runner class was added + as well as the loop_factory parameter. The loop_factory + parameter provides a replacement for loop policies (which + are scheduled for removal in Python 3.16). + """ + import asyncio + + @trace + async def task(): + pass + + @background_task(name="create_coro") + async def create_coro(): + return asyncio.create_task(task()) + + @background_task(name="await_task") + async def await_task(task_to_await): + return await task_to_await + + async def _main(): + _task = await create_coro() + return await await_task(_task) + + with asyncio.Runner(loop_factory=loop_factory) as runner: + runner.run(_main()) + + +@pytest.mark.skipif(sys.version_info < (3, 11), reason="loop_factory/asyncio.Runner is not available") +@pytest.mark.parametrize("loop_factory", loop_factories()) +@validate_transaction_metrics( + "test_context_propagation:test_context_propagation_with_loop_factory", + background_task=True, + scoped_metrics=(("Function/waiter2", 2), ("Function/waiter3", 2)), +) +@background_task() +def test_context_propagation_with_loop_factory(loop_factory): + import asyncio + + exceptions = [] + + def handle_exception(loop, context): + exceptions.append(context) + + # Call default handler for standard logging + loop.default_exception_handler(context) + + async def subtask(): + with FunctionTrace(name="waiter2", terminal=True): + pass + + await child() + + async def _task(trace): + assert current_trace() == trace + + await subtask() + + trace = current_trace() + + with asyncio.Runner(loop_factory=loop_factory) as runner: + assert trace == current_trace() + runner._loop.set_exception_handler(handle_exception) + runner.run(_task(trace)) + runner.run(_task(trace)) + + # The agent should have removed all traces from the cache since + # run_until_complete has terminated (all callbacks scheduled inside the + # task have run) + assert len(trace_cache()) == 1 # Sentinel is all that remains + + # # Assert that no exceptions have occurred + assert not exceptions, exceptions + + # Sentinel left in cache transaction exited async def sentinel_in_cache_txn_exited(asyncio, bg): event = asyncio.Event() diff --git a/tox.ini b/tox.ini index e27ce2ef83..98cea6ee29 100644 --- a/tox.ini +++ b/tox.ini @@ -116,8 +116,8 @@ envlist = python-adapter_hypercorn-{py310,py311,py312,py313,py314}-hypercornlatest, python-adapter_hypercorn-{py38,py39}-hypercorn{0010,0011,0012,0013}, python-adapter_mcp-{py310,py311,py312,py313,py314}, - python-adapter_uvicorn-{py38,py39,py310,py311,py312,py313,py314}-uvicornlatest, - python-adapter_uvicorn-py38-uvicorn014, + python-adapter_uvicorn-{py39,py310,py311,py312,py313,py314}-uvicornlatest, + python-adapter_uvicorn-py38-uvicorn020, python-adapter_waitress-{py38,py39,py310,py311,py312,py313,py314}-waitresslatest, python-application_celery-{py38,py39,py310,py311,py312,py313,py314,pypy311}-celerylatest, python-application_celery-py311-celery{0504,0503,0502}, @@ -239,9 +239,11 @@ deps = adapter_hypercorn-hypercorn0010: hypercorn[h3]<0.11 adapter_hypercorn: niquests adapter_mcp: fastmcp - adapter_uvicorn-uvicorn014: uvicorn<0.15 + adapter_uvicorn-uvicorn020: uvicorn<0.21 + adapter_uvicorn-uvicorn020: uvloop<0.20 adapter_uvicorn-uvicornlatest: uvicorn adapter_uvicorn: typing-extensions + adapter_uvicorn: uvloop adapter_waitress: WSGIProxy2 adapter_waitress-waitresslatest: waitress agent_features: beautifulsoup4 From f1815857622a7f4e47c5e3051b24ae755349d7fd Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Tue, 18 Nov 2025 10:45:06 -0800 Subject: [PATCH 013/124] Fix issue in ASGI header consumption (#1578) * Correct code for Sanic instrumentation * Correct handling of headers in ASGIWebTransaction * Correct handling of headers in ASGIBrowserMiddleware * Add regression test for ASGI headers issues --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- newrelic/api/asgi_application.py | 20 ++++++++++++++-- newrelic/hooks/framework_sanic.py | 2 +- tests/agent_features/test_asgi_transaction.py | 24 +++++++++++++++++++ tests/testing_support/asgi_testing.py | 2 +- .../sample_asgi_applications.py | 17 +++++++++++++ 5 files changed, 61 insertions(+), 4 deletions(-) diff --git a/newrelic/api/asgi_application.py b/newrelic/api/asgi_application.py index 669d3e6db5..6b9a31130e 100644 --- a/newrelic/api/asgi_application.py +++ b/newrelic/api/asgi_application.py @@ -132,10 +132,20 @@ async def send_inject_browser_agent(self, message): message_type = message["type"] if message_type == "http.response.start" and not self.initial_message: - headers = list(message.get("headers", ())) + # message["headers"] may be a generator, and consuming it via process_response will leave the original + # application with no headers. Fix this by preserving them in a list before consuming them. + if "headers" in message: + message["headers"] = headers = list(message["headers"]) + else: + headers = [] + + # Check if we should insert the HTML snippet based on the headers. + # Currently if there are no headers this will always be False, but call the function + # anyway in case this logic changes in the future. if not self.should_insert_html(headers): await self.abort() return + message["headers"] = headers self.initial_message = message elif message_type == "http.response.body" and self.initial_message: @@ -232,7 +242,13 @@ async def send(self, event): finally: self.__exit__(*sys.exc_info()) elif event["type"] == "http.response.start": - self.process_response(event["status"], event.get("headers", ())) + # event["headers"] may be a generator, and consuming it via process_response will leave the original + # ASGI application with no headers. Fix this by preserving them in a list before consuming them. + if "headers" in event: + event["headers"] = headers = list(event["headers"]) + else: + headers = [] + self.process_response(event["status"], headers) return await self._send(event) diff --git a/newrelic/hooks/framework_sanic.py b/newrelic/hooks/framework_sanic.py index 14077eb6d9..74d8ab678e 100644 --- a/newrelic/hooks/framework_sanic.py +++ b/newrelic/hooks/framework_sanic.py @@ -183,7 +183,7 @@ async def _nr_sanic_response_send(wrapped, instance, args, kwargs): transaction = current_transaction() result = wrapped(*args, **kwargs) if isawaitable(result): - await result + result = await result if transaction is None: return result diff --git a/tests/agent_features/test_asgi_transaction.py b/tests/agent_features/test_asgi_transaction.py index e70ec95901..ac774689bd 100644 --- a/tests/agent_features/test_asgi_transaction.py +++ b/tests/agent_features/test_asgi_transaction.py @@ -19,6 +19,7 @@ from testing_support.fixtures import override_application_settings from testing_support.sample_asgi_applications import ( AppWithDescriptor, + asgi_application_generator_headers, simple_app_v2, simple_app_v2_init_exc, simple_app_v2_raw, @@ -37,6 +38,7 @@ simple_app_v3_wrapped = AsgiTest(simple_app_v3) simple_app_v2_wrapped = AsgiTest(simple_app_v2) simple_app_v2_init_exc = AsgiTest(simple_app_v2_init_exc) +asgi_application_generator_headers = AsgiTest(asgi_application_generator_headers) # Test naming scheme logic and ASGIApplicationWrapper for a single callable @@ -85,6 +87,28 @@ def test_double_callable_raw(): assert response.body == b"" +# Ensure headers object is preserved +@pytest.mark.parametrize("browser_monitoring", [True, False]) +@validate_transaction_metrics(name="", group="Uri") +def test_generator_headers(browser_monitoring): + """ + Both ASGIApplicationWrapper and ASGIBrowserMiddleware can cause headers to be lost if generators are + not handled properly. + + Ensure neither destroys headers by testing with and without the ASGIBrowserMiddleware, to make sure whichever + receives headers first properly preserves them in a list. + """ + + @override_application_settings({"browser_monitoring.enabled": browser_monitoring}) + def _test(): + response = asgi_application_generator_headers.make_request("GET", "/") + assert response.status == 200 + assert response.headers == {"x-my-header": "myvalue"} + assert response.body == b"" + + _test() + + # Test asgi_application decorator with parameters passed in on a single callable @pytest.mark.parametrize("name, group", ((None, "group"), ("name", "group"), ("", "group"))) def test_asgi_application_decorator_single_callable(name, group): diff --git a/tests/testing_support/asgi_testing.py b/tests/testing_support/asgi_testing.py index 821a20fe96..5c97be8860 100644 --- a/tests/testing_support/asgi_testing.py +++ b/tests/testing_support/asgi_testing.py @@ -106,7 +106,7 @@ def process_output(self): if self.response_state is ResponseState.NOT_STARTED: assert message["type"] == "http.response.start" response_status = message["status"] - response_headers = message.get("headers", response_headers) + response_headers = list(message.get("headers", response_headers)) self.response_state = ResponseState.BODY elif self.response_state is ResponseState.BODY: assert message["type"] == "http.response.body" diff --git a/tests/testing_support/sample_asgi_applications.py b/tests/testing_support/sample_asgi_applications.py index c1ef860763..e281a7cbf2 100644 --- a/tests/testing_support/sample_asgi_applications.py +++ b/tests/testing_support/sample_asgi_applications.py @@ -114,6 +114,23 @@ async def normal_asgi_application(scope, receive, send): await send({"type": "http.response.body", "body": output}) +@ASGIApplicationWrapper +async def asgi_application_generator_headers(scope, receive, send): + if scope["type"] == "lifespan": + return await handle_lifespan(scope, receive, send) + + if scope["type"] != "http": + raise ValueError("unsupported") + + def headers(): + yield (b"x-my-header", b"myvalue") + + await send({"type": "http.response.start", "status": 200, "headers": headers()}) + await send({"type": "http.response.body"}) + + assert current_transaction() is None + + async def handle_lifespan(scope, receive, send): """Handle lifespan protocol with no-ops to allow more compatibility.""" while True: From 060ddbdc1b5cdb12bce69510bd1d3ef4a898224a Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Tue, 18 Nov 2025 14:25:23 -0800 Subject: [PATCH 014/124] Bedrock Converse Streaming Support (#1565) * Add more formatting to custom event validatators * Add streamed responses to converse mock server * Add streaming fixtures for testing for converse * Rename other bedrock test files * Add tests for converse streaming * Instrument converse streaming * Move GeneratorProxy adjacent functions to mixin * Fix checking of supported models * Reorganize converse error tests * Port new converse botocore tests to aiobotocore * Instrument response streaming in aiobotocore converse * Fix suggestions from code review * Port in converse changes from strands PR * Delete commented code --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- newrelic/hooks/external_aiobotocore.py | 11 + newrelic/hooks/external_botocore.py | 206 +++++---- .../test_bedrock_chat_completion_converse.py | 388 ++++++----------- ...st_bedrock_chat_completion_invoke_model.py | 19 +- .../test_bedrock_embeddings.py | 16 +- .../_mock_external_bedrock_server_converse.py | 137 +++++- .../_test_bedrock_chat_completion_converse.py | 253 +++++++++++ ...t_bedrock_chat_completion_invoke_model.py} | 0 ... test_bedrock_chat_completion_converse.py} | 401 ++++++------------ ...st_bedrock_chat_completion_invoke_model.py | 19 +- ...t_bedrock_chat_completion_via_langchain.py | 2 +- .../test_bedrock_embeddings.py | 16 +- .../validators/validate_custom_event.py | 5 +- .../validators/validate_custom_events.py | 5 +- 14 files changed, 837 insertions(+), 641 deletions(-) create mode 100644 tests/external_botocore/_test_bedrock_chat_completion_converse.py rename tests/external_botocore/{_test_bedrock_chat_completion.py => _test_bedrock_chat_completion_invoke_model.py} (100%) rename tests/external_botocore/{test_chat_completion_converse.py => test_bedrock_chat_completion_converse.py} (54%) diff --git a/newrelic/hooks/external_aiobotocore.py b/newrelic/hooks/external_aiobotocore.py index ddb9d4d056..15daa7bd6d 100644 --- a/newrelic/hooks/external_aiobotocore.py +++ b/newrelic/hooks/external_aiobotocore.py @@ -149,6 +149,17 @@ async def wrap_client__make_api_call(wrapped, instance, args, kwargs): bedrock_attrs = extract_bedrock_converse_attrs( args[1], response, response_headers, model, span_id, trace_id ) + + if response_streaming: + # Wrap EventStream object here to intercept __iter__ method instead of instrumenting class. + # This class is used in numerous other services in botocore, and would cause conflicts. + response["stream"] = stream = AsyncEventStreamWrapper(response["stream"]) + stream._nr_ft = ft or None + stream._nr_bedrock_attrs = bedrock_attrs or {} + stream._nr_model_extractor = stream_extractor or None + stream._nr_is_converse = True + return response + else: bedrock_attrs = { "request_id": response_headers.get("x-amzn-requestid"), diff --git a/newrelic/hooks/external_botocore.py b/newrelic/hooks/external_botocore.py index 39317ea752..e00e50b770 100644 --- a/newrelic/hooks/external_botocore.py +++ b/newrelic/hooks/external_botocore.py @@ -576,9 +576,9 @@ def handle_bedrock_exception( } if is_embedding: - notice_error_attributes.update({"embedding_id": str(uuid.uuid4())}) + notice_error_attributes["embedding_id"] = str(uuid.uuid4()) else: - notice_error_attributes.update({"completion_id": str(uuid.uuid4())}) + notice_error_attributes["completion_id"] = str(uuid.uuid4()) if ft: ft.notice_error(attributes=notice_error_attributes) @@ -766,7 +766,7 @@ def _wrap_bedrock_runtime_converse(wrapped, instance, args, kwargs): if not transaction: return wrapped(*args, **kwargs) - settings = transaction.settings or global_settings + settings = transaction.settings or global_settings() if not settings.ai_monitoring.enabled: return wrapped(*args, **kwargs) @@ -826,6 +826,16 @@ def _wrap_bedrock_runtime_converse(wrapped, instance, args, kwargs): bedrock_attrs = extract_bedrock_converse_attrs(kwargs, response, response_headers, model, span_id, trace_id) try: + if response_streaming: + # Wrap EventStream object here to intercept __iter__ method instead of instrumenting class. + # This class is used in numerous other services in botocore, and would cause conflicts. + response["stream"] = stream = EventStreamWrapper(response["stream"]) + stream._nr_ft = ft + stream._nr_bedrock_attrs = bedrock_attrs + stream._nr_model_extractor = stream_extractor + stream._nr_is_converse = True + return response + ft.__exit__(None, None, None) bedrock_attrs["duration"] = ft.duration * 1000 run_bedrock_response_extractor(response_extractor, {}, bedrock_attrs, False, transaction) @@ -846,14 +856,19 @@ def extract_bedrock_converse_attrs(kwargs, response, response_headers, model, sp # kwargs["messages"] can hold multiple requests and responses to maintain conversation history # We grab the last message (the newest request) in the list each time, so we don't duplicate recorded data + _input_messages = kwargs.get("messages", []) + _input_messages = _input_messages and (_input_messages[-1] or {}) + _input_messages = _input_messages.get("content", []) input_message_list.extend( - [{"role": "user", "content": result["text"]} for result in kwargs["messages"][-1].get("content", [])] + [{"role": "user", "content": result["text"]} for result in _input_messages if "text" in result] ) - output_message_list = [ - {"role": "assistant", "content": result["text"]} - for result in response.get("output").get("message").get("content", []) - ] + output_message_list = None + if "output" in response: + output_message_list = [ + {"role": "assistant", "content": result["text"]} + for result in response.get("output").get("message").get("content", []) + ] bedrock_attrs = { "request_id": response_headers.get("x-amzn-requestid"), @@ -861,24 +876,112 @@ def extract_bedrock_converse_attrs(kwargs, response, response_headers, model, sp "span_id": span_id, "trace_id": trace_id, "response.choices.finish_reason": response.get("stopReason"), - "output_message_list": output_message_list, "request.max_tokens": kwargs.get("inferenceConfig", {}).get("maxTokens", None), "request.temperature": kwargs.get("inferenceConfig", {}).get("temperature", None), "input_message_list": input_message_list, } + + if output_message_list is not None: + bedrock_attrs["output_message_list"] = output_message_list + return bedrock_attrs +class BedrockRecordEventMixin: + def record_events_on_stop_iteration(self, transaction): + if hasattr(self, "_nr_ft"): + bedrock_attrs = getattr(self, "_nr_bedrock_attrs", {}) + self._nr_ft.__exit__(None, None, None) + + # If there are no bedrock attrs exit early as there's no data to record. + if not bedrock_attrs: + return + + try: + bedrock_attrs["duration"] = self._nr_ft.duration * 1000 + handle_chat_completion_event(transaction, bedrock_attrs) + except Exception: + _logger.warning(RESPONSE_PROCESSING_FAILURE_LOG_MESSAGE, exc_info=True) + + # Clear cached data as this can be very large. + self._nr_bedrock_attrs.clear() + + def record_error(self, transaction, exc): + if hasattr(self, "_nr_ft"): + try: + ft = self._nr_ft + error_attributes = getattr(self, "_nr_bedrock_attrs", {}) + + # If there are no bedrock attrs exit early as there's no data to record. + if not error_attributes: + return + + error_attributes = bedrock_error_attributes(exc, error_attributes) + notice_error_attributes = { + "http.statusCode": error_attributes.get("http.statusCode"), + "error.message": error_attributes.get("error.message"), + "error.code": error_attributes.get("error.code"), + } + notice_error_attributes["completion_id"] = str(uuid.uuid4()) + + ft.notice_error(attributes=notice_error_attributes) + + ft.__exit__(*sys.exc_info()) + error_attributes["duration"] = ft.duration * 1000 + + handle_chat_completion_event(transaction, error_attributes) + + # Clear cached data as this can be very large. + error_attributes.clear() + except Exception: + _logger.warning(EXCEPTION_HANDLING_FAILURE_LOG_MESSAGE, exc_info=True) + + def record_stream_chunk(self, event, transaction): + if event: + try: + if getattr(self, "_nr_is_converse", False): + return self.converse_record_stream_chunk(event, transaction) + else: + return self.invoke_record_stream_chunk(event, transaction) + except Exception: + _logger.warning(RESPONSE_EXTRACTOR_FAILURE_LOG_MESSAGE, exc_info=True) + + def invoke_record_stream_chunk(self, event, transaction): + bedrock_attrs = getattr(self, "_nr_bedrock_attrs", {}) + chunk = json.loads(event["chunk"]["bytes"].decode("utf-8")) + self._nr_model_extractor(chunk, bedrock_attrs) + # In Langchain, the bedrock iterator exits early if type is "content_block_stop". + # So we need to call the record events here since stop iteration will not be raised. + _type = chunk.get("type") + if _type == "content_block_stop": + self.record_events_on_stop_iteration(transaction) + + def converse_record_stream_chunk(self, event, transaction): + bedrock_attrs = getattr(self, "_nr_bedrock_attrs", {}) + if "contentBlockDelta" in event: + if not bedrock_attrs: + return + + content = ((event.get("contentBlockDelta") or {}).get("delta") or {}).get("text", "") + if "output_message_list" not in bedrock_attrs: + bedrock_attrs["output_message_list"] = [{"role": "assistant", "content": ""}] + bedrock_attrs["output_message_list"][0]["content"] += content + + if "messageStop" in event: + bedrock_attrs["response.choices.finish_reason"] = (event.get("messageStop") or {}).get("stopReason", "") + + class EventStreamWrapper(ObjectProxy): def __iter__(self): g = GeneratorProxy(self.__wrapped__.__iter__()) g._nr_ft = getattr(self, "_nr_ft", None) g._nr_bedrock_attrs = getattr(self, "_nr_bedrock_attrs", {}) g._nr_model_extractor = getattr(self, "_nr_model_extractor", NULL_EXTRACTOR) + g._nr_is_converse = getattr(self, "_nr_is_converse", False) return g -class GeneratorProxy(ObjectProxy): +class GeneratorProxy(BedrockRecordEventMixin, ObjectProxy): def __init__(self, wrapped): super().__init__(wrapped) @@ -893,12 +996,12 @@ def __next__(self): return_val = None try: return_val = self.__wrapped__.__next__() - record_stream_chunk(self, return_val, transaction) + self.record_stream_chunk(return_val, transaction) except StopIteration: - record_events_on_stop_iteration(self, transaction) + self.record_events_on_stop_iteration(transaction) raise except Exception as exc: - record_error(self, transaction, exc) + self.record_error(transaction, exc) raise return return_val @@ -912,13 +1015,11 @@ def __aiter__(self): g._nr_ft = getattr(self, "_nr_ft", None) g._nr_bedrock_attrs = getattr(self, "_nr_bedrock_attrs", {}) g._nr_model_extractor = getattr(self, "_nr_model_extractor", NULL_EXTRACTOR) + g._nr_is_converse = getattr(self, "_nr_is_converse", False) return g -class AsyncGeneratorProxy(ObjectProxy): - def __init__(self, wrapped): - super().__init__(wrapped) - +class AsyncGeneratorProxy(BedrockRecordEventMixin, ObjectProxy): def __aiter__(self): return self @@ -929,12 +1030,12 @@ async def __anext__(self): return_val = None try: return_val = await self.__wrapped__.__anext__() - record_stream_chunk(self, return_val, transaction) + self.record_stream_chunk(return_val, transaction) except StopAsyncIteration: - record_events_on_stop_iteration(self, transaction) + self.record_events_on_stop_iteration(transaction) raise except Exception as exc: - record_error(self, transaction, exc) + self.record_error(transaction, exc) raise return return_val @@ -942,70 +1043,6 @@ async def aclose(self): return await super().aclose() -def record_stream_chunk(self, return_val, transaction): - if return_val: - try: - chunk = json.loads(return_val["chunk"]["bytes"].decode("utf-8")) - self._nr_model_extractor(chunk, self._nr_bedrock_attrs) - # In Langchain, the bedrock iterator exits early if type is "content_block_stop". - # So we need to call the record events here since stop iteration will not be raised. - _type = chunk.get("type") - if _type == "content_block_stop": - record_events_on_stop_iteration(self, transaction) - except Exception: - _logger.warning(RESPONSE_EXTRACTOR_FAILURE_LOG_MESSAGE, exc_info=True) - - -def record_events_on_stop_iteration(self, transaction): - if hasattr(self, "_nr_ft"): - bedrock_attrs = getattr(self, "_nr_bedrock_attrs", {}) - self._nr_ft.__exit__(None, None, None) - - # If there are no bedrock attrs exit early as there's no data to record. - if not bedrock_attrs: - return - - try: - bedrock_attrs["duration"] = self._nr_ft.duration * 1000 - handle_chat_completion_event(transaction, bedrock_attrs) - except Exception: - _logger.warning(RESPONSE_PROCESSING_FAILURE_LOG_MESSAGE, exc_info=True) - - # Clear cached data as this can be very large. - self._nr_bedrock_attrs.clear() - - -def record_error(self, transaction, exc): - if hasattr(self, "_nr_ft"): - try: - ft = self._nr_ft - error_attributes = getattr(self, "_nr_bedrock_attrs", {}) - - # If there are no bedrock attrs exit early as there's no data to record. - if not error_attributes: - return - - error_attributes = bedrock_error_attributes(exc, error_attributes) - notice_error_attributes = { - "http.statusCode": error_attributes.get("http.statusCode"), - "error.message": error_attributes.get("error.message"), - "error.code": error_attributes.get("error.code"), - } - notice_error_attributes.update({"completion_id": str(uuid.uuid4())}) - - ft.notice_error(attributes=notice_error_attributes) - - ft.__exit__(*sys.exc_info()) - error_attributes["duration"] = ft.duration * 1000 - - handle_chat_completion_event(transaction, error_attributes) - - # Clear cached data as this can be very large. - error_attributes.clear() - except Exception: - _logger.warning(EXCEPTION_HANDLING_FAILURE_LOG_MESSAGE, exc_info=True) - - def handle_embedding_event(transaction, bedrock_attrs): embedding_id = str(uuid.uuid4()) @@ -1551,6 +1588,7 @@ def wrap_serialize_to_request(wrapped, instance, args, kwargs): response_streaming=True ), ("bedrock-runtime", "converse"): wrap_bedrock_runtime_converse(response_streaming=False), + ("bedrock-runtime", "converse_stream"): wrap_bedrock_runtime_converse(response_streaming=True), } diff --git a/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py b/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py index da9c5818e7..55843b832c 100644 --- a/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py +++ b/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py @@ -15,6 +15,12 @@ import botocore.exceptions import pytest from conftest import BOTOCORE_VERSION +from external_botocore._test_bedrock_chat_completion_converse import ( + chat_completion_expected_events, + chat_completion_expected_streaming_events, + chat_completion_invalid_access_key_error_events, + chat_completion_invalid_model_error_events, +) from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( add_token_count_to_events, @@ -36,113 +42,65 @@ from newrelic.api.transaction import add_custom_attribute from newrelic.common.object_names import callable_name -chat_completion_expected_events = [ - ( - {"type": "LlmChatCompletionSummary"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "span_id": None, - "trace_id": "trace-id", - "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", - "duration": None, # Response time varies each test run - "request.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "request.temperature": 0.7, - "request.max_tokens": 100, - "response.choices.finish_reason": "max_tokens", - "vendor": "bedrock", - "ingest_source": "Python", - "response.number_of_messages": 3, - }, - ), - ( - {"type": "LlmChatCompletionMessage"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", - "span_id": None, - "trace_id": "trace-id", - "content": "You are a scientist.", - "role": "system", - "completion_id": None, - "sequence": 0, - "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "vendor": "bedrock", - "ingest_source": "Python", - }, - ), - ( - {"type": "LlmChatCompletionMessage"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", - "span_id": None, - "trace_id": "trace-id", - "content": "What is 212 degrees Fahrenheit converted to Celsius?", - "role": "user", - "completion_id": None, - "sequence": 1, - "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "vendor": "bedrock", - "ingest_source": "Python", - }, - ), - ( - {"type": "LlmChatCompletionMessage"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", - "span_id": None, - "trace_id": "trace-id", - "content": "To convert 212°F to Celsius, we can use the formula:\n\nC = (F - 32) × 5/9\n\nWhere:\nC is the temperature in Celsius\nF is the temperature in Fahrenheit\n\nPlugging in 212°F, we get:\n\nC = (212 - 32) × 5/9\nC = 180 × 5/9\nC = 100\n\nTherefore, 212°", # noqa: RUF001 - "role": "assistant", - "completion_id": None, - "sequence": 2, - "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "vendor": "bedrock", - "ingest_source": "Python", - "is_response": True, - }, - ), -] + +@pytest.fixture(scope="session", params=[False, True], ids=["ResponseStandard", "ResponseStreaming"]) +def response_streaming(request): + return request.param + + +@pytest.fixture(scope="session") +def expected_metric(response_streaming): + return ("Llm/completion/Bedrock/converse" + ("_stream" if response_streaming else ""), 1) + + +@pytest.fixture(scope="session") +def expected_events(response_streaming): + return chat_completion_expected_streaming_events if response_streaming else chat_completion_expected_events @pytest.fixture(scope="module") -def exercise_model(loop, bedrock_converse_server): +def exercise_model(loop, bedrock_converse_server, response_streaming): def _exercise_model(message): async def coro(): inference_config = {"temperature": 0.7, "maxTokens": 100} - response = await bedrock_converse_server.converse( + _response = await bedrock_converse_server.converse( modelId="anthropic.claude-3-sonnet-20240229-v1:0", messages=message, system=[{"text": "You are a scientist."}], inferenceConfig=inference_config, ) - assert response return loop.run_until_complete(coro()) - return _exercise_model + def _exercise_model_streaming(message): + async def coro(): + inference_config = {"temperature": 0.7, "maxTokens": 100} + + response = await bedrock_converse_server.converse_stream( + modelId="anthropic.claude-3-sonnet-20240229-v1:0", + messages=message, + system=[{"text": "You are a scientist."}], + inferenceConfig=inference_config, + ) + _responses = [r async for r in response["stream"]] # Consume the response stream + + return loop.run_until_complete(coro()) + + return _exercise_model_streaming if response_streaming else _exercise_model @reset_core_stats_engine() -def test_bedrock_chat_completion_in_txn_with_llm_metadata(set_trace_info, exercise_model): - @validate_custom_events(events_with_context_attrs(chat_completion_expected_events)) - # One summary event, one user message, and one response message from the assistant +def test_bedrock_chat_completion_in_txn_with_llm_metadata( + set_trace_info, exercise_model, expected_metric, expected_events +): + @validate_custom_events(events_with_context_attrs(expected_events)) + # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( name="test_bedrock_chat_completion_in_txn_with_llm_metadata", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], + scoped_metrics=[expected_metric], + rollup_metrics=[expected_metric], custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], background_task=True, ) @@ -162,14 +120,14 @@ def _test(): @disabled_ai_monitoring_record_content_settings @reset_core_stats_engine() -def test_bedrock_chat_completion_no_content(set_trace_info, exercise_model): - @validate_custom_events(events_sans_content(chat_completion_expected_events)) +def test_bedrock_chat_completion_no_content(set_trace_info, exercise_model, expected_metric, expected_events): + @validate_custom_events(events_sans_content(expected_events)) # One summary event, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( name="test_bedrock_chat_completion_no_content", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], + scoped_metrics=[expected_metric], + rollup_metrics=[expected_metric], custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], background_task=True, ) @@ -188,14 +146,14 @@ def _test(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_chat_completion_with_token_count(set_trace_info, exercise_model): - @validate_custom_events(add_token_count_to_events(chat_completion_expected_events)) +def test_bedrock_chat_completion_with_token_count(set_trace_info, exercise_model, expected_metric, expected_events): + @validate_custom_events(add_token_count_to_events(expected_events)) # One summary event, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( name="test_bedrock_chat_completion_with_token_count", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], + scoped_metrics=[expected_metric], + rollup_metrics=[expected_metric], custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], background_task=True, ) @@ -213,13 +171,13 @@ def _test(): @reset_core_stats_engine() -def test_bedrock_chat_completion_no_llm_metadata(set_trace_info, exercise_model): - @validate_custom_events(events_sans_llm_metadata(chat_completion_expected_events)) +def test_bedrock_chat_completion_no_llm_metadata(set_trace_info, exercise_model, expected_metric, expected_events): + @validate_custom_events(events_sans_llm_metadata(expected_events)) @validate_custom_event_count(count=4) @validate_transaction_metrics( name="test_bedrock_chat_completion_in_txn_no_llm_metadata", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], + scoped_metrics=[expected_metric], + rollup_metrics=[expected_metric], custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], background_task=True, ) @@ -250,54 +208,37 @@ def test_bedrock_chat_completion_disabled_ai_monitoring_settings(set_trace_info, exercise_model(message) -chat_completion_invalid_access_key_error_events = [ - ( - {"type": "LlmChatCompletionSummary"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "span_id": None, - "trace_id": "trace-id", - "request_id": "e1206e19-2318-4a9d-be98-017c73f06118", - "duration": None, # Response time varies each test run - "request.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "request.temperature": 0.7, - "request.max_tokens": 100, - "vendor": "bedrock", - "ingest_source": "Python", - "response.number_of_messages": 1, - "error": True, - }, - ), - ( - {"type": "LlmChatCompletionMessage"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "request_id": "e1206e19-2318-4a9d-be98-017c73f06118", - "span_id": None, - "trace_id": "trace-id", - "content": "Invalid Token", - "role": "user", - "completion_id": None, - "sequence": 0, - "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "vendor": "bedrock", - "ingest_source": "Python", - }, - ), -] - _client_error = botocore.exceptions.ClientError _client_error_name = callable_name(_client_error) +@pytest.fixture +def exercise_converse_incorrect_access_key(loop, bedrock_converse_server, response_streaming, monkeypatch): + def _exercise_converse_incorrect_access_key(): + async def _coro(): + monkeypatch.setattr( + bedrock_converse_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY" + ) + + message = [{"role": "user", "content": [{"text": "Invalid Token"}]}] + request = ( + bedrock_converse_server.converse_stream if response_streaming else bedrock_converse_server.converse + ) + with pytest.raises(_client_error): + await request( + modelId="anthropic.claude-3-sonnet-20240229-v1:0", + messages=message, + inferenceConfig={"temperature": 0.7, "maxTokens": 100}, + ) + + loop.run_until_complete(_coro()) + + return _exercise_converse_incorrect_access_key + + @reset_core_stats_engine() def test_bedrock_chat_completion_error_incorrect_access_key( - loop, monkeypatch, bedrock_converse_server, exercise_model, set_trace_info + exercise_converse_incorrect_access_key, set_trace_info, expected_metric ): """ A request is made to the server with invalid credentials. botocore will reach out to the server and receive an @@ -320,8 +261,8 @@ def test_bedrock_chat_completion_error_incorrect_access_key( ) @validate_transaction_metrics( name="test_bedrock_chat_completion", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], + scoped_metrics=[expected_metric], + rollup_metrics=[expected_metric], custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], background_task=True, ) @@ -332,121 +273,79 @@ def _test(): add_custom_attribute("llm.foo", "bar") add_custom_attribute("non_llm_attr", "python-agent") - converse_incorrect_access_key(loop, bedrock_converse_server, monkeypatch) + exercise_converse_incorrect_access_key() _test() -def converse_incorrect_access_key(loop, bedrock_converse_server, monkeypatch): - async def _coro(): - monkeypatch.setattr(bedrock_converse_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY") - - with pytest.raises(_client_error): - message = [{"role": "user", "content": [{"text": "Invalid Token"}]}] - response = await bedrock_converse_server.converse( - modelId="anthropic.claude-3-sonnet-20240229-v1:0", - messages=message, - inferenceConfig={"temperature": 0.7, "maxTokens": 100}, - ) - assert response - - loop.run_until_complete(_coro()) - - -chat_completion_invalid_model_error_events = [ - ( - {"type": "LlmChatCompletionSummary"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "request_id": "f4908827-3db9-4742-9103-2bbc34578b03", - "span_id": None, - "trace_id": "trace-id", - "duration": None, # Response time varies each test run - "request.model": "does-not-exist", - "response.model": "does-not-exist", - "request.temperature": 0.7, - "request.max_tokens": 100, - "response.number_of_messages": 1, - "vendor": "bedrock", - "ingest_source": "Python", - "error": True, - }, - ), - ( - {"type": "LlmChatCompletionMessage"}, - { - "id": None, - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "span_id": None, - "trace_id": "trace-id", - "request_id": "f4908827-3db9-4742-9103-2bbc34578b03", - "content": "Model does not exist.", - "role": "user", - "completion_id": None, - "response.model": "does-not-exist", - "sequence": 0, - "vendor": "bedrock", - "ingest_source": "Python", - }, - ), -] - - @reset_core_stats_engine() -def test_bedrock_chat_completion_error_invalid_model(loop, bedrock_converse_server, set_trace_info): - @validate_custom_events(chat_completion_invalid_model_error_events) +@override_llm_token_callback_settings(llm_token_count_callback) +def test_bedrock_chat_completion_error_incorrect_access_key_with_token_count( + exercise_converse_incorrect_access_key, set_trace_info, expected_metric +): + """ + A request is made to the server with invalid credentials. botocore will reach out to the server and receive an + UnrecognizedClientException as a response. Information from the request will be parsed and reported in customer + events. The error response can also be parsed, and will be included as attributes on the recorded exception. + """ + + @validate_custom_events(add_token_count_to_events(chat_completion_invalid_access_key_error_events)) @validate_error_trace_attributes( - "botocore.errorfactory:ValidationException", + _client_error_name, exact_attrs={ "agent": {}, "intrinsic": {}, "user": { - "http.statusCode": 400, - "error.message": "The provided model identifier is invalid.", - "error.code": "ValidationException", + "http.statusCode": 403, + "error.message": "The security token included in the request is invalid.", + "error.code": "UnrecognizedClientException", }, }, ) @validate_transaction_metrics( - name="test_bedrock_chat_completion_error_invalid_model", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], + name="test_bedrock_chat_completion_incorrect_access_key_with_token_count", + scoped_metrics=[expected_metric], + rollup_metrics=[expected_metric], custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], background_task=True, ) - @background_task(name="test_bedrock_chat_completion_error_invalid_model") + @background_task(name="test_bedrock_chat_completion_incorrect_access_key_with_token_count") def _test(): set_trace_info() add_custom_attribute("llm.conversation_id", "my-awesome-id") add_custom_attribute("llm.foo", "bar") add_custom_attribute("non_llm_attr", "python-agent") - converse_invalid_model(loop, bedrock_converse_server) + exercise_converse_incorrect_access_key() _test() -def converse_invalid_model(loop, bedrock_converse_server): - async def _coro(): - with pytest.raises(_client_error): - message = [{"role": "user", "content": [{"text": "Model does not exist."}]}] +@pytest.fixture +def exercise_converse_invalid_model(loop, bedrock_converse_server, response_streaming, monkeypatch): + def _exercise_converse_invalid_model(): + async def _coro(): + monkeypatch.setattr( + bedrock_converse_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY" + ) - response = await bedrock_converse_server.converse( - modelId="does-not-exist", messages=message, inferenceConfig={"temperature": 0.7, "maxTokens": 100} + message = [{"role": "user", "content": [{"text": "Model does not exist."}]}] + request = ( + bedrock_converse_server.converse_stream if response_streaming else bedrock_converse_server.converse ) + with pytest.raises(_client_error): + await request( + modelId="does-not-exist", messages=message, inferenceConfig={"temperature": 0.7, "maxTokens": 100} + ) - assert response + loop.run_until_complete(_coro()) - loop.run_until_complete(_coro()) + return _exercise_converse_invalid_model @reset_core_stats_engine() -@disabled_ai_monitoring_record_content_settings -def test_bedrock_chat_completion_error_invalid_model_no_content(loop, bedrock_converse_server, set_trace_info): - @validate_custom_events(events_sans_content(chat_completion_invalid_model_error_events)) +def test_bedrock_chat_completion_error_invalid_model(exercise_converse_invalid_model, set_trace_info, expected_metric): + @validate_custom_events(events_with_context_attrs(chat_completion_invalid_model_error_events)) @validate_error_trace_attributes( "botocore.errorfactory:ValidationException", exact_attrs={ @@ -460,62 +359,57 @@ def test_bedrock_chat_completion_error_invalid_model_no_content(loop, bedrock_co }, ) @validate_transaction_metrics( - name="test_bedrock_chat_completion_error_invalid_model_no_content", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], + name="test_bedrock_chat_completion_error_invalid_model", + scoped_metrics=[expected_metric], + rollup_metrics=[expected_metric], custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], background_task=True, ) - @background_task(name="test_bedrock_chat_completion_error_invalid_model_no_content") + @background_task(name="test_bedrock_chat_completion_error_invalid_model") def _test(): set_trace_info() add_custom_attribute("llm.conversation_id", "my-awesome-id") add_custom_attribute("llm.foo", "bar") add_custom_attribute("non_llm_attr", "python-agent") - converse_invalid_model(loop, bedrock_converse_server) + with WithLlmCustomAttributes({"context": "attr"}): + exercise_converse_invalid_model() _test() @reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_chat_completion_error_incorrect_access_key_with_token_count( - monkeypatch, bedrock_converse_server, loop, set_trace_info +@disabled_ai_monitoring_record_content_settings +def test_bedrock_chat_completion_error_invalid_model_no_content( + exercise_converse_invalid_model, set_trace_info, expected_metric ): - """ - A request is made to the server with invalid credentials. botocore will reach out to the server and receive an - UnrecognizedClientException as a response. Information from the request will be parsed and reported in customer - events. The error response can also be parsed, and will be included as attributes on the recorded exception. - """ - - @validate_custom_events(add_token_count_to_events(chat_completion_invalid_access_key_error_events)) + @validate_custom_events(events_sans_content(chat_completion_invalid_model_error_events)) @validate_error_trace_attributes( - _client_error_name, + "botocore.errorfactory:ValidationException", exact_attrs={ "agent": {}, "intrinsic": {}, "user": { - "http.statusCode": 403, - "error.message": "The security token included in the request is invalid.", - "error.code": "UnrecognizedClientException", + "http.statusCode": 400, + "error.message": "The provided model identifier is invalid.", + "error.code": "ValidationException", }, }, ) @validate_transaction_metrics( - name="test_bedrock_chat_completion_incorrect_access_key_with_token_count", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], + name="test_bedrock_chat_completion_error_invalid_model_no_content", + scoped_metrics=[expected_metric], + rollup_metrics=[expected_metric], custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], background_task=True, ) - @background_task(name="test_bedrock_chat_completion_incorrect_access_key_with_token_count") + @background_task(name="test_bedrock_chat_completion_error_invalid_model_no_content") def _test(): set_trace_info() add_custom_attribute("llm.conversation_id", "my-awesome-id") add_custom_attribute("llm.foo", "bar") add_custom_attribute("non_llm_attr", "python-agent") - converse_incorrect_access_key(loop, bedrock_converse_server, monkeypatch) + exercise_converse_invalid_model() _test() diff --git a/tests/external_aiobotocore/test_bedrock_chat_completion_invoke_model.py b/tests/external_aiobotocore/test_bedrock_chat_completion_invoke_model.py index e02cc5b543..207db7e31e 100644 --- a/tests/external_aiobotocore/test_bedrock_chat_completion_invoke_model.py +++ b/tests/external_aiobotocore/test_bedrock_chat_completion_invoke_model.py @@ -14,13 +14,13 @@ import json import os from io import BytesIO +from pprint import pformat -import botocore.errorfactory import botocore.eventstream import botocore.exceptions import pytest from conftest import BOTOCORE_VERSION -from external_botocore._test_bedrock_chat_completion import ( +from external_botocore._test_bedrock_chat_completion_invoke_model import ( chat_completion_expected_events, chat_completion_expected_malformed_request_body_events, chat_completion_expected_malformed_response_body_events, @@ -858,7 +858,12 @@ def test_bedrock_chat_completion_functions_marked_as_wrapped_for_sdk_compatibili def test_chat_models_instrumented(loop): import aiobotocore - SUPPORTED_MODELS = [model for model, _, _, _ in MODEL_EXTRACTORS if "embed" not in model] + def _is_supported_model(model): + supported_models = [model for model, _, _, _ in MODEL_EXTRACTORS if "embed" not in model] + for supported_model in supported_models: + if supported_model in model: + return True + return False _id = os.environ.get("AWS_ACCESS_KEY_ID") key = os.environ.get("AWS_SECRET_ACCESS_KEY") @@ -871,12 +876,8 @@ def test_chat_models_instrumented(loop): try: response = loop.run_until_complete(client.list_foundation_models(byOutputModality="TEXT")) models = [model["modelId"] for model in response["modelSummaries"]] - not_supported = [] - for model in models: - is_supported = any(model.startswith(supported_model) for supported_model in SUPPORTED_MODELS) - if not is_supported: - not_supported.append(model) + not_supported = [model for model in models if not _is_supported_model(model)] - assert not not_supported, f"The following unsupported models were found: {not_supported}" + assert not not_supported, f"The following unsupported models were found: {pformat(not_supported)}" finally: loop.run_until_complete(client.__aexit__(None, None, None)) diff --git a/tests/external_aiobotocore/test_bedrock_embeddings.py b/tests/external_aiobotocore/test_bedrock_embeddings.py index 96b930feb5..b964122294 100644 --- a/tests/external_aiobotocore/test_bedrock_embeddings.py +++ b/tests/external_aiobotocore/test_bedrock_embeddings.py @@ -14,6 +14,7 @@ import json import os from io import BytesIO +from pprint import pformat import botocore.exceptions import pytest @@ -414,7 +415,12 @@ async def _test(): def test_embedding_models_instrumented(loop): import aiobotocore - SUPPORTED_MODELS = [model for model, _, _, _ in MODEL_EXTRACTORS if "embed" in model] + def _is_supported_model(model): + supported_models = [model for model, _, _, _ in MODEL_EXTRACTORS if "embed" in model] + for supported_model in supported_models: + if supported_model in model: + return True + return False _id = os.environ.get("AWS_ACCESS_KEY_ID") key = os.environ.get("AWS_SECRET_ACCESS_KEY") @@ -427,12 +433,8 @@ def test_embedding_models_instrumented(loop): try: response = client.list_foundation_models(byOutputModality="EMBEDDING") models = [model["modelId"] for model in response["modelSummaries"]] - not_supported = [] - for model in models: - is_supported = any(model.startswith(supported_model) for supported_model in SUPPORTED_MODELS) - if not is_supported: - not_supported.append(model) + not_supported = [model for model in models if not _is_supported_model(model)] - assert not not_supported, f"The following unsupported models were found: {not_supported}" + assert not not_supported, f"The following unsupported models were found: {pformat(not_supported)}" finally: loop.run_until_complete(client.__aexit__(None, None, None)) diff --git a/tests/external_botocore/_mock_external_bedrock_server_converse.py b/tests/external_botocore/_mock_external_bedrock_server_converse.py index aef6d52856..bc93c8b773 100644 --- a/tests/external_botocore/_mock_external_bedrock_server_converse.py +++ b/tests/external_botocore/_mock_external_bedrock_server_converse.py @@ -16,6 +16,105 @@ from testing_support.mock_external_http_server import MockExternalHTTPServer +STREAMED_RESPONSES = { + "What is 212 degrees Fahrenheit converted to Celsius?": [ + { + "Content-Type": "application/vnd.amazon.eventstream", + "x-amzn-RequestId": "f070b880-e0fb-4537-8093-796671c39239", + }, + 200, + [ + "000000b2000000528a40b4c50b3a6576656e742d7479706507000c6d65737361676553746172740d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152535455565758595a30222c22726f6c65223a22617373697374616e74227d40ff8268000000ae000000575f3a3ac90b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a22546f227d2c2270223a226162636465666768696a6b6c6d6e6f70717273227d57b47eb0", + "000000b800000057b09a58eb0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220636f6e76657274227d2c2270223a226162636465666768696a6b6c6d6e6f7071727374757677227d7f921878", + "000000c600000057f67806450b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a222046616872656e227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c227d725b3c0b", + "000000a800000057d07acf690b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2268656974227d2c2270223a226162636465666768696a6b227d926527fe", + "000000b400000057756ab5ea0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220746f227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778227d47f66bd8", + "000000a400000057158a22680b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a222043656c73697573227d2c2270223a22616263227dc03a975f", + "000000c8000000574948b8240b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a222c227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f5051525354227db2e3dafb", + "000000ad00000057189a40190b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220796f75227d2c2270223a226162636465666768696a6b6c6d6e6f70227d76c0e56b", + "000000c500000057b1d87c950b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220757365227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e227de3731476", + "000000cb000000570ee8c2f40b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220746865227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f5051525354227dd4810232", + "000000d3000000575e781eb70b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220666f726d756c61227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152535455565758227df6672f41", + "000000d00000005719d864670b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a223a227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152535455565758595a3031227dbd8afb45", + "000000b6000000570faae68a0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a225c6e5c6e43227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778227d088d049f", + "000000a700000057522a58b80b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a22203d227d2c2270223a226162636465666768696a6b6c227d88e54236", + "000000b70000005732cacf3a0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a222028227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142227de6ec1ebe", + "000000b400000057756ab5ea0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2246227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a227d02007761", + "000000c900000057742891940b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a22202d227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f5051525354227d3b3f080c", + "000000ab0000005797dab5b90b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220227d2c2270223a226162636465666768696a6b6c6d6e6f7071227d5638cc83", + "0000009d00000057b9bbf89f0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a223332227d2c2270223a226162227dc02cb212", + "000000bc00000057451afe2b0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2229227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748227da0e9aee9", + "000000c700000057cb182ff50b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a22202a227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152227d0e3821bb", + "000000b70000005732cacf3a0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a414243227d1daf3cc5", + "000000b400000057756ab5ea0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2235227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a227dada5d973", + "000000d10000005724b84dd70b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a222f227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152535455565758595a303132227db97b8201", + "000000bc00000057451afe2b0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2239227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748227d99250da7", + "000000ad00000057189a40190b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a225c6e5c6e5768657265227d2c2270223a226162636465666768696a6b227d5f2ed4ef", + "0000009f00000057c37babff0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a223a227d2c2270223a226162636465227d85a07294", + "000000a900000057ed1ae6d90b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a225c6e43227d2c2270223a226162636465666768696a6b6c6d227d50fa22de", + "000000ce00000057c6084d840b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a22206973227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152535455565758227dfe3dc5ac", + "000000c8000000574948b8240b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220746865227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f5051227d3f77fbbc", + "000000c1000000574458da550b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a222074656d7065726174757265227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142227d402a7229", + "000000d200000057631837070b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220696e227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152535455565758595a3031227df5f66d94", + "000000d90000005714c806160b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a222043656c73697573227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152535455565758595a30313233227d3daccf94", + "000000b500000057480a9c5a0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a225c6e46227d2c2270223a226162636465666768696a6b6c6d6e6f70717273747576777879227d5042c3ff", + "000000cf00000057fb6864340b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a22206973227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f50515253545556575859227da79da7ad", + "000000bd00000057787ad79b0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220746865227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a414243444546227dbd3a0aec", + "000000b70000005732cacf3a0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a222074656d7065726174757265227d2c2270223a226162636465666768696a6b6c6d6e6f707172227d1560b810", + "000000bf0000005702ba84fb0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220696e227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a414243444546474849227d40f78c16", + "000000ce00000057c6084d840b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a222046616872656e227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f5051525354227d47b98626", + "000000a2000000579acad7c80b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2268656974227d2c2270223a226162636465227d54cc33be", + "000000da0000005753687cc60b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a225c6e5c6e506c7567227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152535455565758595a3031323334227d9eb4ac9a", + "000000bc00000057451afe2b0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2267696e67227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445227d3a11d9ac000000c500000057b1d87c950b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220696e227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f227d391bdff3", + "0000009e00000057fe1b824f0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220227d2c2270223a2261626364227da292de09", + "000000b70000005732cacf3a0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a22323132227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a41227dbfd117db", + "000000c20000005703f8a0850b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a22c2b0227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d227d1166f202", + "000000a100000057dd6aad180b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2246227d2c2270223a2261626364656667227dcba24fa6", + "000000b300000057c74a69fa0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220666f72227d2c2270223a226162636465666768696a6b6c6d6e6f70717273747576227dd306dee6", + "000000c700000057cb182ff50b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a222046227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152227d3bdbedf1", + "000000c600000057f67806450b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a223a227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152227d71d79c49", + "000000ae000000575f3a3ac90b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a225c6e5c6e43227d2c2270223a226162636465666768696a6b6c6d6e6f70227d2d8a1cce", + "000000bf0000005702ba84fb0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a22203d227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a227de81a06eb", + "000000b6000000570faae68a0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a222028227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a41227dea662b27", + "000000d500000057d138eb170b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a22323132227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152535455565758595a3031323334227da7888b21", + "000000d700000057abf8b8770b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152535455565758595a303132333435363738227d63107603", + "000000c0000000577938f3e50b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a222d227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c227d9e32b6f5", + "000000c600000057f67806450b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152227db3145f6b", + "0000009f00000057c37babff0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a223332227d2c2270223a2261626364227d277c3f97", + "000000a300000057a7aafe780b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2229227d2c2270223a22616263646566676869227dd05f85ca", + "000000bc00000057451afe2b0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a22202a227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a41424344454647227db0dfade1", + "000000aa00000057aaba9c090b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220227d2c2270223a226162636465666768696a6b6c6d6e6f70227da476449e", + "000000ac0000005725fa69a90b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2235227d2c2270223a226162636465666768696a6b6c6d6e6f707172227deedc54f0", + "000000ca000000573388eb440b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a222f227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f50515253545556227d7abef087", + "000000d00000005719d864670b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2239227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152535455565758595a3031227de7c50a2e", + "0000009f00000057c37babff0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a225c6e43227d2c2270223a22616263227df88e9dc2", + "000000ac0000005725fa69a90b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a22203d227d2c2270223a226162636465666768696a6b6c6d6e6f7071227d6f5c7d17", + "000000bd00000057787ad79b0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a414243444546474849227d1c650877", + "000000a400000057158a22680b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a22313830227d2c2270223a226162636465666768227dba33e936", + "000000bb00000057f73a223b0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a41424344454647227df14100ef", + "000000a400000057158a22680b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a222a227d2c2270223a226162636465666768696a227da79b0693", + "000000c700000057cb182ff50b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f50515253227de52ff51e", + "000000aa00000057aaba9c090b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2235227d2c2270223a226162636465666768696a6b6c6d6e6f70227df5cf9fcf", + "000000b9000000578dfa715b0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a222f227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445227dc22fcb78", + "0000009d00000057b9bbf89f0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2239227d2c2270223a22616263227db33d112d", + "000000b9000000578dfa715b0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a225c6e43227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a414243227d6e135792", + "000000c20000005703f8a0850b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a22203d227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d227d242e22f6", + "000000a000000057e00a84a80b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220227d2c2270223a22616263646566227d64c7e90b", + "000000a800000057d07acf690b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a22313030227d2c2270223a226162636465666768696a6b6c227dee65d4c5", + "000000e200000057c2398f810b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a225c6e5c6e5468657265666f7265227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152535455565758595a3031323334353637227d43ae3a9e", + "000000c600000057f67806450b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a222c227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152227df0760dea", + "000000a50000005728ea0bd80b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220227d2c2270223a226162636465666768696a6b227db714fc15", + "000000ab0000005797dab5b90b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a22323132227d2c2270223a226162636465666768696a6b6c6d6e6f227de9fc19df", + "000000be000000573fdaad4b0b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2220227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a227dd7107790", + "000000c600000057f67806450b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a2264656772656573227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c227d15374080", + "000000dd00000057e148a0d60b3a6576656e742d74797065070011636f6e74656e74426c6f636b44656c74610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2264656c7461223a7b2274657874223a222046616872656e227d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152535455565758595a303132333435363738227d8993e5c9", + "000000a800000056a77dffff0b3a6576656e742d74797065070010636f6e74656e74426c6f636b53746f700d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b22636f6e74656e74426c6f636b496e646578223a302c2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a227d1c361897", + "000000bd00000051911972ae0b3a6576656e742d7479706507000b6d65737361676553746f700d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b2270223a226162636465666768696a6b6c6d6e6f707172737475767778797a4142434445464748494a4b4c4d4e4f505152535455565758595a303132333435222c2273746f70526561736f6e223a226d61785f746f6b656e73227d2963d7e1", + "000000f00000004ebc72e3a30b3a6576656e742d747970650700086d657461646174610d3a636f6e74656e742d747970650700106170706c69636174696f6e2f6a736f6e0d3a6d6573736167652d747970650700056576656e747b226d657472696373223a7b226c6174656e63794d73223a323134397d2c2270223a226162636465666768696a6b6c6d6e6f707172737475767778222c227573616765223a7b22696e707574546f6b656e73223a32362c226f7574707574546f6b656e73223a3130302c22736572766572546f6f6c5573616765223a7b7d2c22746f74616c546f6b656e73223a3132367d7dd415e186", + ], + ] +} + RESPONSES = { "What is 212 degrees Fahrenheit converted to Celsius?": [ {"Content-Type": "application/json", "x-amzn-RequestId": "c20d345e-6878-4778-b674-6b187bae8ecf"}, @@ -65,6 +164,7 @@ def simple_get(self): except Exception: content = body + stream = self.path.endswith("converse-stream") prompt = extract_shortened_prompt_converse(content) if not prompt: self.send_response(500) @@ -73,11 +173,23 @@ def simple_get(self): return headers, status_code, response = ({}, 0, "") - - for k, v in RESPONSES.items(): - if prompt.startswith(k): - headers, status_code, response = v - break + if stream: + for k, v in STREAMED_RESPONSES.items(): + if prompt.startswith(k): + headers, status_code, response = v + break + if not response: + for k, v in RESPONSES.items(): + # Only look for error responses returned immediately instead of in a stream + if prompt.startswith(k) and v[1] >= 400: + headers, status_code, response = v + stream = False # Response will not be streamed + break + else: + for k, v in RESPONSES.items(): + if prompt.startswith(k): + headers, status_code, response = v + break if not response: # If no matches found @@ -94,10 +206,19 @@ def simple_get(self): self.send_header(k, v) self.end_headers() - # Send response body - response_body = json.dumps(response).encode("utf-8") + if stream: + # Send response body + for resp in response: + self.wfile.write(bytes.fromhex(resp)) + else: + # Send response body + response_body = json.dumps(response).encode("utf-8") + + if "Malformed Body" in prompt: + # Remove end of response to make invalid JSON + response_body = response_body[:-4] - self.wfile.write(response_body) + self.wfile.write(response_body) return diff --git a/tests/external_botocore/_test_bedrock_chat_completion_converse.py b/tests/external_botocore/_test_bedrock_chat_completion_converse.py new file mode 100644 index 0000000000..cdec652292 --- /dev/null +++ b/tests/external_botocore/_test_bedrock_chat_completion_converse.py @@ -0,0 +1,253 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Ignore unicode characters in this file from LLM responses +# ruff: noqa: RUF001 + +chat_completion_expected_events = [ + ( + {"type": "LlmChatCompletionSummary"}, + { + "id": None, # UUID that varies with each run + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "span_id": None, + "trace_id": "trace-id", + "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", + "duration": None, # Response time varies each test run + "request.model": "anthropic.claude-3-sonnet-20240229-v1:0", + "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", + "request.temperature": 0.7, + "request.max_tokens": 100, + "response.choices.finish_reason": "max_tokens", + "vendor": "bedrock", + "ingest_source": "Python", + "response.number_of_messages": 3, + }, + ), + ( + {"type": "LlmChatCompletionMessage"}, + { + "id": None, # UUID that varies with each run + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", + "span_id": None, + "trace_id": "trace-id", + "content": "You are a scientist.", + "role": "system", + "completion_id": None, + "sequence": 0, + "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", + "vendor": "bedrock", + "ingest_source": "Python", + }, + ), + ( + {"type": "LlmChatCompletionMessage"}, + { + "id": None, # UUID that varies with each run + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", + "span_id": None, + "trace_id": "trace-id", + "content": "What is 212 degrees Fahrenheit converted to Celsius?", + "role": "user", + "completion_id": None, + "sequence": 1, + "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", + "vendor": "bedrock", + "ingest_source": "Python", + }, + ), + ( + {"type": "LlmChatCompletionMessage"}, + { + "id": None, # UUID that varies with each run + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", + "span_id": None, + "trace_id": "trace-id", + "content": "To convert 212°F to Celsius, we can use the formula:\n\nC = (F - 32) × 5/9\n\nWhere:\nC is the temperature in Celsius\nF is the temperature in Fahrenheit\n\nPlugging in 212°F, we get:\n\nC = (212 - 32) × 5/9\nC = 180 × 5/9\nC = 100\n\nTherefore, 212°", + "role": "assistant", + "completion_id": None, + "sequence": 2, + "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", + "vendor": "bedrock", + "ingest_source": "Python", + "is_response": True, + }, + ), +] + +chat_completion_expected_streaming_events = [ + ( + {"type": "LlmChatCompletionSummary"}, + { + "id": None, # UUID that varies with each run + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "span_id": None, + "trace_id": "trace-id", + "request_id": "f070b880-e0fb-4537-8093-796671c39239", + "duration": None, # Response time varies each test run + "request.model": "anthropic.claude-3-sonnet-20240229-v1:0", + "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", + "request.temperature": 0.7, + "request.max_tokens": 100, + "response.choices.finish_reason": "max_tokens", + "vendor": "bedrock", + "ingest_source": "Python", + "response.number_of_messages": 3, + }, + ), + ( + {"type": "LlmChatCompletionMessage"}, + { + "id": None, # UUID that varies with each run + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "request_id": "f070b880-e0fb-4537-8093-796671c39239", + "span_id": None, + "trace_id": "trace-id", + "content": "You are a scientist.", + "role": "system", + "completion_id": None, + "sequence": 0, + "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", + "vendor": "bedrock", + "ingest_source": "Python", + }, + ), + ( + {"type": "LlmChatCompletionMessage"}, + { + "id": None, # UUID that varies with each run + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "request_id": "f070b880-e0fb-4537-8093-796671c39239", + "span_id": None, + "trace_id": "trace-id", + "content": "What is 212 degrees Fahrenheit converted to Celsius?", + "role": "user", + "completion_id": None, + "sequence": 1, + "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", + "vendor": "bedrock", + "ingest_source": "Python", + }, + ), + ( + {"type": "LlmChatCompletionMessage"}, + { + "id": None, # UUID that varies with each run + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "request_id": "f070b880-e0fb-4537-8093-796671c39239", + "span_id": None, + "trace_id": "trace-id", + "content": "To convert Fahrenheit to Celsius, you use the formula:\n\nC = (F - 32) * 5/9\n\nWhere:\nC is the temperature in Celsius\nF is the temperature in Fahrenheit\n\nPlugging in 212°F for F:\n\nC = (212 - 32) * 5/9\nC = 180 * 5/9\nC = 100\n\nTherefore, 212 degrees Fahren", + "role": "assistant", + "completion_id": None, + "sequence": 2, + "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", + "vendor": "bedrock", + "ingest_source": "Python", + "is_response": True, + }, + ), +] + +chat_completion_invalid_access_key_error_events = [ + ( + {"type": "LlmChatCompletionSummary"}, + { + "id": None, # UUID that varies with each run + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "span_id": None, + "trace_id": "trace-id", + "request_id": "e1206e19-2318-4a9d-be98-017c73f06118", + "duration": None, # Response time varies each test run + "request.model": "anthropic.claude-3-sonnet-20240229-v1:0", + "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", + "request.temperature": 0.7, + "request.max_tokens": 100, + "vendor": "bedrock", + "ingest_source": "Python", + "response.number_of_messages": 1, + "error": True, + }, + ), + ( + {"type": "LlmChatCompletionMessage"}, + { + "id": None, # UUID that varies with each run + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "request_id": "e1206e19-2318-4a9d-be98-017c73f06118", + "span_id": None, + "trace_id": "trace-id", + "content": "Invalid Token", + "role": "user", + "completion_id": None, + "sequence": 0, + "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", + "vendor": "bedrock", + "ingest_source": "Python", + }, + ), +] +chat_completion_invalid_model_error_events = [ + ( + {"type": "LlmChatCompletionSummary"}, + { + "id": None, # UUID that varies with each run + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "request_id": "f4908827-3db9-4742-9103-2bbc34578b03", + "span_id": None, + "trace_id": "trace-id", + "duration": None, # Response time varies each test run + "request.model": "does-not-exist", + "response.model": "does-not-exist", + "request.temperature": 0.7, + "request.max_tokens": 100, + "response.number_of_messages": 1, + "vendor": "bedrock", + "ingest_source": "Python", + "error": True, + }, + ), + ( + {"type": "LlmChatCompletionMessage"}, + { + "id": None, + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "span_id": None, + "trace_id": "trace-id", + "request_id": "f4908827-3db9-4742-9103-2bbc34578b03", + "content": "Model does not exist.", + "role": "user", + "completion_id": None, + "response.model": "does-not-exist", + "sequence": 0, + "vendor": "bedrock", + "ingest_source": "Python", + }, + ), +] diff --git a/tests/external_botocore/_test_bedrock_chat_completion.py b/tests/external_botocore/_test_bedrock_chat_completion_invoke_model.py similarity index 100% rename from tests/external_botocore/_test_bedrock_chat_completion.py rename to tests/external_botocore/_test_bedrock_chat_completion_invoke_model.py diff --git a/tests/external_botocore/test_chat_completion_converse.py b/tests/external_botocore/test_bedrock_chat_completion_converse.py similarity index 54% rename from tests/external_botocore/test_chat_completion_converse.py rename to tests/external_botocore/test_bedrock_chat_completion_converse.py index 96ead41dd7..e365b5163b 100644 --- a/tests/external_botocore/test_chat_completion_converse.py +++ b/tests/external_botocore/test_bedrock_chat_completion_converse.py @@ -14,6 +14,12 @@ import botocore.exceptions import pytest +from _test_bedrock_chat_completion_converse import ( + chat_completion_expected_events, + chat_completion_expected_streaming_events, + chat_completion_invalid_access_key_error_events, + chat_completion_invalid_model_error_events, +) from conftest import BOTOCORE_VERSION from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( @@ -36,109 +42,59 @@ from newrelic.api.transaction import add_custom_attribute from newrelic.common.object_names import callable_name -chat_completion_expected_events = [ - ( - {"type": "LlmChatCompletionSummary"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "span_id": None, - "trace_id": "trace-id", - "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", - "duration": None, # Response time varies each test run - "request.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "request.temperature": 0.7, - "request.max_tokens": 100, - "response.choices.finish_reason": "max_tokens", - "vendor": "bedrock", - "ingest_source": "Python", - "response.number_of_messages": 3, - }, - ), - ( - {"type": "LlmChatCompletionMessage"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", - "span_id": None, - "trace_id": "trace-id", - "content": "You are a scientist.", - "role": "system", - "completion_id": None, - "sequence": 0, - "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "vendor": "bedrock", - "ingest_source": "Python", - }, - ), - ( - {"type": "LlmChatCompletionMessage"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", - "span_id": None, - "trace_id": "trace-id", - "content": "What is 212 degrees Fahrenheit converted to Celsius?", - "role": "user", - "completion_id": None, - "sequence": 1, - "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "vendor": "bedrock", - "ingest_source": "Python", - }, - ), - ( - {"type": "LlmChatCompletionMessage"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", - "span_id": None, - "trace_id": "trace-id", - "content": "To convert 212°F to Celsius, we can use the formula:\n\nC = (F - 32) × 5/9\n\nWhere:\nC is the temperature in Celsius\nF is the temperature in Fahrenheit\n\nPlugging in 212°F, we get:\n\nC = (212 - 32) × 5/9\nC = 180 × 5/9\nC = 100\n\nTherefore, 212°", # noqa: RUF001 - "role": "assistant", - "completion_id": None, - "sequence": 2, - "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "vendor": "bedrock", - "ingest_source": "Python", - "is_response": True, - }, - ), -] + +@pytest.fixture(scope="session", params=[False, True], ids=["ResponseStandard", "ResponseStreaming"]) +def response_streaming(request): + return request.param + + +@pytest.fixture(scope="session") +def expected_metric(response_streaming): + return ("Llm/completion/Bedrock/converse" + ("_stream" if response_streaming else ""), 1) + + +@pytest.fixture(scope="session") +def expected_events(response_streaming): + return chat_completion_expected_streaming_events if response_streaming else chat_completion_expected_events @pytest.fixture(scope="module") -def exercise_model(bedrock_converse_server): +def exercise_model(bedrock_converse_server, response_streaming): def _exercise_model(message): inference_config = {"temperature": 0.7, "maxTokens": 100} - response = bedrock_converse_server.converse( + _response = bedrock_converse_server.converse( + modelId="anthropic.claude-3-sonnet-20240229-v1:0", + messages=message, + system=[{"text": "You are a scientist."}], + inferenceConfig=inference_config, + ) + + def _exercise_model_streaming(message): + inference_config = {"temperature": 0.7, "maxTokens": 100} + + response = bedrock_converse_server.converse_stream( modelId="anthropic.claude-3-sonnet-20240229-v1:0", messages=message, system=[{"text": "You are a scientist."}], inferenceConfig=inference_config, ) + _responses = list(response["stream"]) # Consume the response stream - return _exercise_model + return _exercise_model_streaming if response_streaming else _exercise_model @reset_core_stats_engine() -def test_bedrock_chat_completion_in_txn_with_llm_metadata(set_trace_info, exercise_model): - @validate_custom_events(events_with_context_attrs(chat_completion_expected_events)) - # One summary event, one user message, and one response message from the assistant +def test_bedrock_chat_completion_in_txn_with_llm_metadata( + set_trace_info, exercise_model, expected_metric, expected_events +): + @validate_custom_events(events_with_context_attrs(expected_events)) + # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( name="test_bedrock_chat_completion_in_txn_with_llm_metadata", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], + scoped_metrics=[expected_metric], + rollup_metrics=[expected_metric], custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], background_task=True, ) @@ -158,14 +114,14 @@ def _test(): @disabled_ai_monitoring_record_content_settings @reset_core_stats_engine() -def test_bedrock_chat_completion_no_content(set_trace_info, exercise_model): - @validate_custom_events(events_sans_content(chat_completion_expected_events)) +def test_bedrock_chat_completion_no_content(set_trace_info, exercise_model, expected_metric, expected_events): + @validate_custom_events(events_sans_content(expected_events)) # One summary event, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( name="test_bedrock_chat_completion_no_content", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], + scoped_metrics=[expected_metric], + rollup_metrics=[expected_metric], custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], background_task=True, ) @@ -184,14 +140,14 @@ def _test(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_chat_completion_with_token_count(set_trace_info, exercise_model): - @validate_custom_events(add_token_count_to_events(chat_completion_expected_events)) +def test_bedrock_chat_completion_with_token_count(set_trace_info, exercise_model, expected_metric, expected_events): + @validate_custom_events(add_token_count_to_events(expected_events)) # One summary event, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( name="test_bedrock_chat_completion_with_token_count", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], + scoped_metrics=[expected_metric], + rollup_metrics=[expected_metric], custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], background_task=True, ) @@ -209,13 +165,13 @@ def _test(): @reset_core_stats_engine() -def test_bedrock_chat_completion_no_llm_metadata(set_trace_info, exercise_model): - @validate_custom_events(events_sans_llm_metadata(chat_completion_expected_events)) +def test_bedrock_chat_completion_no_llm_metadata(set_trace_info, exercise_model, expected_metric, expected_events): + @validate_custom_events(events_sans_llm_metadata(expected_events)) @validate_custom_event_count(count=4) @validate_transaction_metrics( name="test_bedrock_chat_completion_in_txn_no_llm_metadata", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], + scoped_metrics=[expected_metric], + rollup_metrics=[expected_metric], custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], background_task=True, ) @@ -246,54 +202,30 @@ def test_bedrock_chat_completion_disabled_ai_monitoring_settings(set_trace_info, exercise_model(message) -chat_completion_invalid_access_key_error_events = [ - ( - {"type": "LlmChatCompletionSummary"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "span_id": None, - "trace_id": "trace-id", - "request_id": "e1206e19-2318-4a9d-be98-017c73f06118", - "duration": None, # Response time varies each test run - "request.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "request.temperature": 0.7, - "request.max_tokens": 100, - "vendor": "bedrock", - "ingest_source": "Python", - "response.number_of_messages": 1, - "error": True, - }, - ), - ( - {"type": "LlmChatCompletionMessage"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "request_id": "e1206e19-2318-4a9d-be98-017c73f06118", - "span_id": None, - "trace_id": "trace-id", - "content": "Invalid Token", - "role": "user", - "completion_id": None, - "sequence": 0, - "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "vendor": "bedrock", - "ingest_source": "Python", - }, - ), -] - _client_error = botocore.exceptions.ClientError _client_error_name = callable_name(_client_error) +@pytest.fixture +def exercise_converse_incorrect_access_key(bedrock_converse_server, response_streaming, monkeypatch): + def _exercise_converse_incorrect_access_key(): + monkeypatch.setattr(bedrock_converse_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY") + + message = [{"role": "user", "content": [{"text": "Invalid Token"}]}] + request = bedrock_converse_server.converse_stream if response_streaming else bedrock_converse_server.converse + with pytest.raises(_client_error): + request( + modelId="anthropic.claude-3-sonnet-20240229-v1:0", + messages=message, + inferenceConfig={"temperature": 0.7, "maxTokens": 100}, + ) + + return _exercise_converse_incorrect_access_key + + @reset_core_stats_engine() def test_bedrock_chat_completion_error_incorrect_access_key( - monkeypatch, bedrock_converse_server, exercise_model, set_trace_info + exercise_converse_incorrect_access_key, set_trace_info, expected_metric ): """ A request is made to the server with invalid credentials. botocore will reach out to the server and receive an @@ -316,122 +248,82 @@ def test_bedrock_chat_completion_error_incorrect_access_key( ) @validate_transaction_metrics( name="test_bedrock_chat_completion", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], + scoped_metrics=[expected_metric], + rollup_metrics=[expected_metric], custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], background_task=True, ) @background_task(name="test_bedrock_chat_completion") def _test(): - monkeypatch.setattr(bedrock_converse_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY") - - with pytest.raises(_client_error): - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - message = [{"role": "user", "content": [{"text": "Invalid Token"}]}] - - response = bedrock_converse_server.converse( - modelId="anthropic.claude-3-sonnet-20240229-v1:0", - messages=message, - inferenceConfig={"temperature": 0.7, "maxTokens": 100}, - ) + set_trace_info() + add_custom_attribute("llm.conversation_id", "my-awesome-id") + add_custom_attribute("llm.foo", "bar") + add_custom_attribute("non_llm_attr", "python-agent") - assert response + exercise_converse_incorrect_access_key() _test() -chat_completion_invalid_model_error_events = [ - ( - {"type": "LlmChatCompletionSummary"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "request_id": "f4908827-3db9-4742-9103-2bbc34578b03", - "span_id": None, - "trace_id": "trace-id", - "duration": None, # Response time varies each test run - "request.model": "does-not-exist", - "response.model": "does-not-exist", - "request.temperature": 0.7, - "request.max_tokens": 100, - "response.number_of_messages": 1, - "vendor": "bedrock", - "ingest_source": "Python", - "error": True, - }, - ), - ( - {"type": "LlmChatCompletionMessage"}, - { - "id": None, - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "span_id": None, - "trace_id": "trace-id", - "request_id": "f4908827-3db9-4742-9103-2bbc34578b03", - "content": "Model does not exist.", - "role": "user", - "completion_id": None, - "response.model": "does-not-exist", - "sequence": 0, - "vendor": "bedrock", - "ingest_source": "Python", - }, - ), -] - - @reset_core_stats_engine() -def test_bedrock_chat_completion_error_invalid_model(bedrock_converse_server, set_trace_info): - @validate_custom_events(events_with_context_attrs(chat_completion_invalid_model_error_events)) +@override_llm_token_callback_settings(llm_token_count_callback) +def test_bedrock_chat_completion_error_incorrect_access_key_with_token_count( + exercise_converse_incorrect_access_key, set_trace_info, expected_metric +): + """ + A request is made to the server with invalid credentials. botocore will reach out to the server and receive an + UnrecognizedClientException as a response. Information from the request will be parsed and reported in customer + events. The error response can also be parsed, and will be included as attributes on the recorded exception. + """ + + @validate_custom_events(add_token_count_to_events(chat_completion_invalid_access_key_error_events)) @validate_error_trace_attributes( - "botocore.errorfactory:ValidationException", + _client_error_name, exact_attrs={ "agent": {}, "intrinsic": {}, "user": { - "http.statusCode": 400, - "error.message": "The provided model identifier is invalid.", - "error.code": "ValidationException", + "http.statusCode": 403, + "error.message": "The security token included in the request is invalid.", + "error.code": "UnrecognizedClientException", }, }, ) @validate_transaction_metrics( - name="test_bedrock_chat_completion_error_invalid_model", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], + name="test_bedrock_chat_completion_incorrect_access_key_with_token_count", + scoped_metrics=[expected_metric], + rollup_metrics=[expected_metric], custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], background_task=True, ) - @background_task(name="test_bedrock_chat_completion_error_invalid_model") + @background_task(name="test_bedrock_chat_completion_incorrect_access_key_with_token_count") def _test(): set_trace_info() add_custom_attribute("llm.conversation_id", "my-awesome-id") add_custom_attribute("llm.foo", "bar") add_custom_attribute("non_llm_attr", "python-agent") - with pytest.raises(_client_error): - with WithLlmCustomAttributes({"context": "attr"}): - message = [{"role": "user", "content": [{"text": "Model does not exist."}]}] + exercise_converse_incorrect_access_key() - response = bedrock_converse_server.converse( - modelId="does-not-exist", messages=message, inferenceConfig={"temperature": 0.7, "maxTokens": 100} - ) + _test() - assert response - _test() +@pytest.fixture +def exercise_converse_invalid_model(bedrock_converse_server, response_streaming, monkeypatch): + def _exercise_converse_invalid_model(): + monkeypatch.setattr(bedrock_converse_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY") + + message = [{"role": "user", "content": [{"text": "Model does not exist."}]}] + request = bedrock_converse_server.converse_stream if response_streaming else bedrock_converse_server.converse + with pytest.raises(_client_error): + request(modelId="does-not-exist", messages=message, inferenceConfig={"temperature": 0.7, "maxTokens": 100}) + + return _exercise_converse_invalid_model @reset_core_stats_engine() -@disabled_ai_monitoring_record_content_settings -def test_bedrock_chat_completion_error_invalid_model_no_content(bedrock_converse_server, set_trace_info): - @validate_custom_events(events_sans_content(chat_completion_invalid_model_error_events)) +def test_bedrock_chat_completion_error_invalid_model(exercise_converse_invalid_model, set_trace_info, expected_metric): + @validate_custom_events(events_with_context_attrs(chat_completion_invalid_model_error_events)) @validate_error_trace_attributes( "botocore.errorfactory:ValidationException", exact_attrs={ @@ -445,80 +337,57 @@ def test_bedrock_chat_completion_error_invalid_model_no_content(bedrock_converse }, ) @validate_transaction_metrics( - name="test_bedrock_chat_completion_error_invalid_model_no_content", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], + name="test_bedrock_chat_completion_error_invalid_model", + scoped_metrics=[expected_metric], + rollup_metrics=[expected_metric], custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], background_task=True, ) - @background_task(name="test_bedrock_chat_completion_error_invalid_model_no_content") + @background_task(name="test_bedrock_chat_completion_error_invalid_model") def _test(): set_trace_info() add_custom_attribute("llm.conversation_id", "my-awesome-id") add_custom_attribute("llm.foo", "bar") add_custom_attribute("non_llm_attr", "python-agent") - with pytest.raises(_client_error): - message = [{"role": "user", "content": [{"text": "Model does not exist."}]}] - - response = bedrock_converse_server.converse( - modelId="does-not-exist", messages=message, inferenceConfig={"temperature": 0.7, "maxTokens": 100} - ) - - assert response + with WithLlmCustomAttributes({"context": "attr"}): + exercise_converse_invalid_model() _test() @reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_chat_completion_error_incorrect_access_key_with_token_count( - monkeypatch, bedrock_converse_server, exercise_model, set_trace_info +@disabled_ai_monitoring_record_content_settings +def test_bedrock_chat_completion_error_invalid_model_no_content( + exercise_converse_invalid_model, set_trace_info, expected_metric ): - """ - A request is made to the server with invalid credentials. botocore will reach out to the server and receive an - UnrecognizedClientException as a response. Information from the request will be parsed and reported in customer - events. The error response can also be parsed, and will be included as attributes on the recorded exception. - """ - - @validate_custom_events(add_token_count_to_events(chat_completion_invalid_access_key_error_events)) + @validate_custom_events(events_sans_content(chat_completion_invalid_model_error_events)) @validate_error_trace_attributes( - _client_error_name, + "botocore.errorfactory:ValidationException", exact_attrs={ "agent": {}, "intrinsic": {}, "user": { - "http.statusCode": 403, - "error.message": "The security token included in the request is invalid.", - "error.code": "UnrecognizedClientException", + "http.statusCode": 400, + "error.message": "The provided model identifier is invalid.", + "error.code": "ValidationException", }, }, ) @validate_transaction_metrics( - name="test_bedrock_chat_completion_incorrect_access_key_with_token_count", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], + name="test_bedrock_chat_completion_error_invalid_model_no_content", + scoped_metrics=[expected_metric], + rollup_metrics=[expected_metric], custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], background_task=True, ) - @background_task(name="test_bedrock_chat_completion_incorrect_access_key_with_token_count") + @background_task(name="test_bedrock_chat_completion_error_invalid_model_no_content") def _test(): - monkeypatch.setattr(bedrock_converse_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY") - - with pytest.raises(_client_error): - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - message = [{"role": "user", "content": [{"text": "Invalid Token"}]}] - - response = bedrock_converse_server.converse( - modelId="anthropic.claude-3-sonnet-20240229-v1:0", - messages=message, - inferenceConfig={"temperature": 0.7, "maxTokens": 100}, - ) + set_trace_info() + add_custom_attribute("llm.conversation_id", "my-awesome-id") + add_custom_attribute("llm.foo", "bar") + add_custom_attribute("non_llm_attr", "python-agent") - assert response + exercise_converse_invalid_model() _test() diff --git a/tests/external_botocore/test_bedrock_chat_completion_invoke_model.py b/tests/external_botocore/test_bedrock_chat_completion_invoke_model.py index 4422685b9f..9acb0e8ed2 100644 --- a/tests/external_botocore/test_bedrock_chat_completion_invoke_model.py +++ b/tests/external_botocore/test_bedrock_chat_completion_invoke_model.py @@ -14,13 +14,13 @@ import json import os from io import BytesIO +from pprint import pformat import boto3 -import botocore.errorfactory import botocore.eventstream import botocore.exceptions import pytest -from _test_bedrock_chat_completion import ( +from _test_bedrock_chat_completion_invoke_model import ( chat_completion_expected_events, chat_completion_expected_malformed_request_body_events, chat_completion_expected_malformed_response_body_events, @@ -816,7 +816,12 @@ def test_bedrock_chat_completion_functions_marked_as_wrapped_for_sdk_compatibili def test_chat_models_instrumented(): - SUPPORTED_MODELS = [model for model, _, _, _ in MODEL_EXTRACTORS if "embed" not in model] + def _is_supported_model(model): + supported_models = [model for model, _, _, _ in MODEL_EXTRACTORS if "embed" not in model] + for supported_model in supported_models: + if supported_model in model: + return True + return False _id = os.environ.get("AWS_ACCESS_KEY_ID") key = os.environ.get("AWS_SECRET_ACCESS_KEY") @@ -826,10 +831,6 @@ def test_chat_models_instrumented(): client = boto3.client("bedrock", "us-east-1") response = client.list_foundation_models(byOutputModality="TEXT") models = [model["modelId"] for model in response["modelSummaries"]] - not_supported = [] - for model in models: - is_supported = any(model.startswith(supported_model) for supported_model in SUPPORTED_MODELS) - if not is_supported: - not_supported.append(model) + not_supported = [model for model in models if not _is_supported_model(model)] - assert not not_supported, f"The following unsupported models were found: {not_supported}" + assert not not_supported, f"The following unsupported models were found: {pformat(not_supported)}" diff --git a/tests/external_botocore/test_bedrock_chat_completion_via_langchain.py b/tests/external_botocore/test_bedrock_chat_completion_via_langchain.py index 82537cd10a..b25516cd5b 100644 --- a/tests/external_botocore/test_bedrock_chat_completion_via_langchain.py +++ b/tests/external_botocore/test_bedrock_chat_completion_via_langchain.py @@ -13,7 +13,7 @@ # limitations under the License. import pytest -from _test_bedrock_chat_completion import ( +from _test_bedrock_chat_completion_invoke_model import ( chat_completion_langchain_expected_events, chat_completion_langchain_expected_streaming_events, ) diff --git a/tests/external_botocore/test_bedrock_embeddings.py b/tests/external_botocore/test_bedrock_embeddings.py index 417e24b2d9..36a5db6619 100644 --- a/tests/external_botocore/test_bedrock_embeddings.py +++ b/tests/external_botocore/test_bedrock_embeddings.py @@ -14,6 +14,7 @@ import json import os from io import BytesIO +from pprint import pformat import boto3 import botocore.exceptions @@ -409,7 +410,12 @@ def _test(): def test_embedding_models_instrumented(): - SUPPORTED_MODELS = [model for model, _, _, _ in MODEL_EXTRACTORS if "embed" in model] + def _is_supported_model(model): + supported_models = [model for model, _, _, _ in MODEL_EXTRACTORS if "embed" in model] + for supported_model in supported_models: + if supported_model in model: + return True + return False _id = os.environ.get("AWS_ACCESS_KEY_ID") key = os.environ.get("AWS_SECRET_ACCESS_KEY") @@ -419,10 +425,6 @@ def test_embedding_models_instrumented(): client = boto3.client("bedrock", "us-east-1") response = client.list_foundation_models(byOutputModality="EMBEDDING") models = [model["modelId"] for model in response["modelSummaries"]] - not_supported = [] - for model in models: - is_supported = any(model.startswith(supported_model) for supported_model in SUPPORTED_MODELS) - if not is_supported: - not_supported.append(model) + not_supported = [model for model in models if not _is_supported_model(model)] - assert not not_supported, f"The following unsupported models were found: {not_supported}" + assert not not_supported, f"The following unsupported models were found: {pformat(not_supported)}" diff --git a/tests/testing_support/validators/validate_custom_event.py b/tests/testing_support/validators/validate_custom_event.py index deeef7fb25..5e3eb65b74 100644 --- a/tests/testing_support/validators/validate_custom_event.py +++ b/tests/testing_support/validators/validate_custom_event.py @@ -13,6 +13,7 @@ # limitations under the License. import time +from pprint import pformat from newrelic.common.object_wrapper import function_wrapper from testing_support.fixtures import core_application_stats_engine @@ -61,7 +62,9 @@ def _validate_custom_event_count(wrapped, instance, args, kwargs): raise else: stats = core_application_stats_engine(None) - assert stats.custom_events.num_samples == count + assert stats.custom_events.num_samples == count, ( + f"Expected: {count}, Got: {stats.custom_events.num_samples}\nEvents: {pformat(list(stats.custom_events))}" + ) return result diff --git a/tests/testing_support/validators/validate_custom_events.py b/tests/testing_support/validators/validate_custom_events.py index 8a1bad4342..e3f1c1a15a 100644 --- a/tests/testing_support/validators/validate_custom_events.py +++ b/tests/testing_support/validators/validate_custom_events.py @@ -14,6 +14,7 @@ import copy import time +from pprint import pformat from newrelic.common.object_wrapper import function_wrapper, transient_function_wrapper from testing_support.fixtures import catch_background_exceptions @@ -100,8 +101,8 @@ def _check_event_attributes(expected, captured, mismatches): def _event_details(matching_custom_events, captured, mismatches): details = [ f"matching_custom_events={matching_custom_events}", - f"mismatches={mismatches}", - f"captured_events={captured}", + f"mismatches={pformat(mismatches)}", + f"captured_events={pformat(captured)}", ] return "\n".join(details) From fa7f3ca213aa71dfc7ed660ae3b8780f1c096caf Mon Sep 17 00:00:00 2001 From: Lalleh Rafeei <84813886+lrafeei@users.noreply.github.com> Date: Wed, 19 Nov 2025 15:07:14 -0800 Subject: [PATCH 015/124] Add new Redis methods (#1588) * Add new Redis methods * Add RedisCluster methods to ignore list --- newrelic/hooks/datastore_redis.py | 2 ++ .../test_uninstrumented_rediscluster_methods.py | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/newrelic/hooks/datastore_redis.py b/newrelic/hooks/datastore_redis.py index 0888f4a4b3..af14746692 100644 --- a/newrelic/hooks/datastore_redis.py +++ b/newrelic/hooks/datastore_redis.py @@ -278,6 +278,7 @@ "hsetnx", "hstrlen", "hvals", + "hybrid_search", "incr", "incrby", "incrbyfloat", @@ -325,6 +326,7 @@ "mrange", "mrevrange", "mset", + "msetex", "msetnx", "numincrby", "object_encoding", diff --git a/tests/datastore_rediscluster/test_uninstrumented_rediscluster_methods.py b/tests/datastore_rediscluster/test_uninstrumented_rediscluster_methods.py index 3f2a258355..c926a2ae21 100644 --- a/tests/datastore_rediscluster/test_uninstrumented_rediscluster_methods.py +++ b/tests/datastore_rediscluster/test_uninstrumented_rediscluster_methods.py @@ -118,10 +118,14 @@ "get_node", "get_node_from_key", "get_nodes", + "get_nodes_from_slot", "get_primaries", "get_random_node", + "get_random_primary_node", + "get_random_primary_or_all_nodes", "get_redis_connection", "get_replicas", + "get_special_nodes", "keyslot", "mget_nonatomic", "monitor", From 4f5ef0d5c030e53d907ac90b0fb7cb8f9b034dba Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 24 Nov 2025 17:06:14 +0000 Subject: [PATCH 016/124] Bump the github_actions group with 3 updates (#1591) Bumps the github_actions group with 3 updates: [actions/checkout](https://github.com/actions/checkout), [astral-sh/setup-uv](https://github.com/astral-sh/setup-uv) and [github/codeql-action](https://github.com/github/codeql-action). Updates `actions/checkout` from 5.0.1 to 6.0.0 - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/93cb6efe18208431cddfb8368fd83d5badbf9bfd...1af3b93b6815bc44a9784bd300feb67ff0d1eeb3) Updates `astral-sh/setup-uv` from 7.1.3 to 7.1.4 - [Release notes](https://github.com/astral-sh/setup-uv/releases) - [Commits](https://github.com/astral-sh/setup-uv/compare/5a7eac68fb9809dea845d802897dc5c723910fa3...1e862dfacbd1d6d858c55d9b792c756523627244) Updates `github/codeql-action` from 4.31.3 to 4.31.5 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/github/codeql-action/compare/014f16e7ab1402f30e7c3329d33797e7948572db...fdbfb4d2750291e159f0156def62b853c2798ca2) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: 6.0.0 dependency-type: direct:production update-type: version-update:semver-major dependency-group: github_actions - dependency-name: astral-sh/setup-uv dependency-version: 7.1.4 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions - dependency-name: github/codeql-action dependency-version: 4.31.5 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/addlicense.yml | 2 +- .github/workflows/benchmarks.yml | 2 +- .github/workflows/build-ci-image.yml | 2 +- .github/workflows/deploy.yml | 4 +- .github/workflows/mega-linter.yml | 2 +- .github/workflows/tests.yml | 58 ++++++++++++++-------------- .github/workflows/trivy.yml | 4 +- 7 files changed, 37 insertions(+), 37 deletions(-) diff --git a/.github/workflows/addlicense.yml b/.github/workflows/addlicense.yml index 83e5b29ef4..171cbf7f59 100644 --- a/.github/workflows/addlicense.yml +++ b/.github/workflows/addlicense.yml @@ -39,7 +39,7 @@ jobs: permissions: contents: read steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | diff --git a/.github/workflows/benchmarks.yml b/.github/workflows/benchmarks.yml index a65695e7c4..77e0537925 100644 --- a/.github/workflows/benchmarks.yml +++ b/.github/workflows/benchmarks.yml @@ -38,7 +38,7 @@ jobs: BASE_SHA: ${{ github.event.pull_request.base.sha }} steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 with: fetch-depth: 0 diff --git a/.github/workflows/build-ci-image.yml b/.github/workflows/build-ci-image.yml index 061233b6dd..dd3833d79c 100644 --- a/.github/workflows/build-ci-image.yml +++ b/.github/workflows/build-ci-image.yml @@ -43,7 +43,7 @@ jobs: name: Docker Build ${{ matrix.platform }} steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 with: persist-credentials: false fetch-depth: 0 diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index af4739f2a3..a91dae3061 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -69,7 +69,7 @@ jobs: runs-on: ${{ matrix.os }} steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 with: persist-credentials: false fetch-depth: 0 @@ -109,7 +109,7 @@ jobs: runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 with: persist-credentials: false fetch-depth: 0 diff --git a/.github/workflows/mega-linter.yml b/.github/workflows/mega-linter.yml index 0f869f3b58..99b010c0d6 100644 --- a/.github/workflows/mega-linter.yml +++ b/.github/workflows/mega-linter.yml @@ -45,7 +45,7 @@ jobs: steps: # Git Checkout - name: Checkout Code - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 with: token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }} fetch-depth: 0 # Required for pushing commits to PRs diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 9e47302bd4..70bdc8c6c5 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -93,7 +93,7 @@ jobs: - tests steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # 6.0.0 with: python-version: "3.13" @@ -127,7 +127,7 @@ jobs: - tests steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # 6.0.0 with: python-version: "3.13" @@ -166,7 +166,7 @@ jobs: --add-host=host.docker.internal:host-gateway timeout-minutes: 30 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -231,7 +231,7 @@ jobs: --add-host=host.docker.internal:host-gateway timeout-minutes: 30 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -294,14 +294,14 @@ jobs: runs-on: windows-2025 timeout-minutes: 30 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | git fetch --tags origin - name: Install uv - uses: astral-sh/setup-uv@5a7eac68fb9809dea845d802897dc5c723910fa3 # 7.1.3 + uses: astral-sh/setup-uv@1e862dfacbd1d6d858c55d9b792c756523627244 # 7.1.4 - name: Install Python run: | @@ -363,14 +363,14 @@ jobs: runs-on: windows-11-arm timeout-minutes: 30 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | git fetch --tags origin - name: Install uv - uses: astral-sh/setup-uv@5a7eac68fb9809dea845d802897dc5c723910fa3 # 7.1.3 + uses: astral-sh/setup-uv@1e862dfacbd1d6d858c55d9b792c756523627244 # 7.1.4 - name: Install Python run: | @@ -443,7 +443,7 @@ jobs: --add-host=host.docker.internal:host-gateway timeout-minutes: 30 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -526,7 +526,7 @@ jobs: --health-retries 10 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -606,7 +606,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -687,7 +687,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -772,7 +772,7 @@ jobs: # from every being executed as bash commands. steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -837,7 +837,7 @@ jobs: --add-host=host.docker.internal:host-gateway timeout-minutes: 30 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -927,7 +927,7 @@ jobs: KAFKA_CFG_INTER_BROKER_LISTENER_NAME: L3 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -1005,7 +1005,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -1083,7 +1083,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -1161,7 +1161,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -1244,7 +1244,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -1327,7 +1327,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -1406,7 +1406,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -1487,7 +1487,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -1567,7 +1567,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -1647,7 +1647,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -1726,7 +1726,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -1804,7 +1804,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -1923,7 +1923,7 @@ jobs: --add-host=host.docker.internal:host-gateway steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -2003,7 +2003,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | @@ -2081,7 +2081,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - name: Fetch git tags run: | diff --git a/.github/workflows/trivy.yml b/.github/workflows/trivy.yml index e4b0e38c9c..614ec8903e 100644 --- a/.github/workflows/trivy.yml +++ b/.github/workflows/trivy.yml @@ -32,7 +32,7 @@ jobs: steps: # Git Checkout - name: Checkout Code - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # 5.0.1 + uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 with: token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }} fetch-depth: 0 @@ -61,6 +61,6 @@ jobs: - name: Upload Trivy scan results to GitHub Security tab if: ${{ github.event_name == 'schedule' }} - uses: github/codeql-action/upload-sarif@014f16e7ab1402f30e7c3329d33797e7948572db # 4.31.3 + uses: github/codeql-action/upload-sarif@fdbfb4d2750291e159f0156def62b853c2798ca2 # 4.31.5 with: sarif_file: "trivy-results.sarif" From cb33db94e3e385e0fd36b7270b6d67d4e3e36247 Mon Sep 17 00:00:00 2001 From: sgoel-nr Date: Tue, 2 Dec 2025 02:55:50 +0530 Subject: [PATCH 017/124] LangChain: Fix message timestamps, add default role assignment, and Bedrock support (#1580) * Record the request message as the time the request started for LangChain. * Tracking the original timestamp of the request for input messages that are recorded as LlmChatCompletionMessage event types. * First pass at preserving LlmChatCompletionMessage timestamp for the request with Bedrock methods. * the `kwargs` was being mapped directly to the OpenAI client and having timestamp in there caused a problem. As a quick test, only add the request timestamp after the wrapped function has been invoked. * Moved the request timestamp to its own variable instead of part of kwargs. * OpenAI async request messages were not being assigned the correct timestamp. * Trying to improve the passing of the request timestamp through for Bedrock. * Passing too many parameters. * Set a default role on input/output messages within LangChain. * [MegaLinter] Apply linters fixes * Fix request_timestamp for LlmChatCompletionSummary table * Fix request_timestamp for LlmChatCompletionSummary table * [MegaLinter] Apply linters fixes * Bedrock Converse Streaming Support (#1565) * Add more formatting to custom event validatators * Add streamed responses to converse mock server * Add streaming fixtures for testing for converse * Rename other bedrock test files * Add tests for converse streaming * Instrument converse streaming * Move GeneratorProxy adjacent functions to mixin * Fix checking of supported models * Reorganize converse error tests * Port new converse botocore tests to aiobotocore * Instrument response streaming in aiobotocore converse * Fix suggestions from code review * Port in converse changes from strands PR * Delete commented code --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Bedrock Converse Streaming Support (#1565) * Add more formatting to custom event validatators * Add streamed responses to converse mock server * Add streaming fixtures for testing for converse * Rename other bedrock test files * Add tests for converse streaming * Instrument converse streaming * Move GeneratorProxy adjacent functions to mixin * Fix checking of supported models * Reorganize converse error tests * Port new converse botocore tests to aiobotocore * Instrument response streaming in aiobotocore converse * Fix suggestions from code review * Port in converse changes from strands PR * Delete commented code --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * [MegaLinter] Apply linters fixes * request_timestamp is now passed across different method * Fixed gemini model kwargs issue * [MegaLinter] Apply linters fixes * Update tests to validate presence of timestamp/ role and fix bugs in instrumentation. * Update aiobotocore instrumentation to receive request timestamp. --------- Co-authored-by: Josh Bonczkowski Co-authored-by: sgoel-nr <236423107+sgoel-nr@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Co-authored-by: Uma Annamalai --- newrelic/core/custom_event.py | 2 +- newrelic/hooks/external_aiobotocore.py | 6 +- newrelic/hooks/external_botocore.py | 101 ++++++++++++++---- newrelic/hooks/mlmodel_gemini.py | 34 ++++-- newrelic/hooks/mlmodel_langchain.py | 27 ++++- newrelic/hooks/mlmodel_openai.py | 64 ++++++++--- .../_test_bedrock_chat_completion_converse.py | 12 +++ ...st_bedrock_chat_completion_invoke_model.py | 93 ++++++++++++++++ tests/mlmodel_gemini/test_text_generation.py | 3 + .../test_text_generation_error.py | 6 ++ tests/mlmodel_langchain/test_chain.py | 54 ++++++++++ tests/mlmodel_openai/test_chat_completion.py | 4 + .../test_chat_completion_error.py | 10 ++ .../test_chat_completion_error_v1.py | 7 ++ .../test_chat_completion_stream.py | 4 + .../test_chat_completion_stream_error.py | 12 +++ .../test_chat_completion_stream_error_v1.py | 7 ++ .../test_chat_completion_stream_v1.py | 4 + .../mlmodel_openai/test_chat_completion_v1.py | 4 + 19 files changed, 405 insertions(+), 49 deletions(-) diff --git a/newrelic/core/custom_event.py b/newrelic/core/custom_event.py index 9bf5f75eda..c960a0afa2 100644 --- a/newrelic/core/custom_event.py +++ b/newrelic/core/custom_event.py @@ -141,7 +141,7 @@ def create_custom_event(event_type, params, settings=None, is_ml_event=False): ) return None - intrinsics = {"type": name, "timestamp": int(1000.0 * time.time())} + intrinsics = {"type": name, "timestamp": params.get("timestamp") or int(1000.0 * time.time())} event = [intrinsics, attributes] return event diff --git a/newrelic/hooks/external_aiobotocore.py b/newrelic/hooks/external_aiobotocore.py index 15daa7bd6d..1dbb2f2816 100644 --- a/newrelic/hooks/external_aiobotocore.py +++ b/newrelic/hooks/external_aiobotocore.py @@ -98,6 +98,7 @@ async def wrap_client__make_api_call(wrapped, instance, args, kwargs): response_extractor = getattr(instance, "_nr_response_extractor", None) stream_extractor = getattr(instance, "_nr_stream_extractor", None) response_streaming = getattr(instance, "_nr_response_streaming", False) + request_timestamp = getattr(instance, "_nr_request_timestamp", None) is_converse = getattr(instance, "_nr_is_converse", False) ft = getattr(instance, "_nr_ft", None) @@ -125,6 +126,7 @@ async def wrap_client__make_api_call(wrapped, instance, args, kwargs): transaction, bedrock_args, is_converse, + request_timestamp, ) raise @@ -187,7 +189,9 @@ async def wrap_client__make_api_call(wrapped, instance, args, kwargs): if ft: ft.__exit__(None, None, None) bedrock_attrs["duration"] = ft.duration * 1000 - run_bedrock_response_extractor(response_extractor, response_body, bedrock_attrs, is_embedding, transaction) + run_bedrock_response_extractor( + response_extractor, response_body, bedrock_attrs, is_embedding, transaction, request_timestamp + ) except Exception: _logger.warning(RESPONSE_PROCESSING_FAILURE_LOG_MESSAGE, exc_info=True) diff --git a/newrelic/hooks/external_botocore.py b/newrelic/hooks/external_botocore.py index e00e50b770..d481ce8450 100644 --- a/newrelic/hooks/external_botocore.py +++ b/newrelic/hooks/external_botocore.py @@ -17,6 +17,7 @@ import logging import re import sys +import time import uuid from io import BytesIO @@ -193,6 +194,7 @@ def create_chat_completion_message_event( request_id, llm_metadata_dict, response_id=None, + request_timestamp=None, ): if not transaction: return @@ -227,6 +229,8 @@ def create_chat_completion_message_event( if settings.ai_monitoring.record_content.enabled: chat_completion_message_dict["content"] = content + if request_timestamp: + chat_completion_message_dict["timestamp"] = request_timestamp chat_completion_message_dict.update(llm_metadata_dict) @@ -266,6 +270,8 @@ def create_chat_completion_message_event( if settings.ai_monitoring.record_content.enabled: chat_completion_message_dict["content"] = content + if request_timestamp: + chat_completion_message_dict["timestamp"] = request_timestamp chat_completion_message_dict.update(llm_metadata_dict) @@ -542,10 +548,22 @@ def extract_bedrock_cohere_model_streaming_response(response_body, bedrock_attrs def handle_bedrock_exception( - exc, is_embedding, model, span_id, trace_id, request_extractor, request_body, ft, transaction, kwargs, is_converse + exc, + is_embedding, + model, + span_id, + trace_id, + request_extractor, + request_body, + ft, + transaction, + kwargs, + is_converse, + request_timestamp=None, ): try: bedrock_attrs = {"model": model, "span_id": span_id, "trace_id": trace_id} + if is_converse: try: input_message_list = [ @@ -589,12 +607,14 @@ def handle_bedrock_exception( if is_embedding: handle_embedding_event(transaction, error_attributes) else: - handle_chat_completion_event(transaction, error_attributes) + handle_chat_completion_event(transaction, error_attributes, request_timestamp) except Exception: _logger.warning(EXCEPTION_HANDLING_FAILURE_LOG_MESSAGE, exc_info=True) -def run_bedrock_response_extractor(response_extractor, response_body, bedrock_attrs, is_embedding, transaction): +def run_bedrock_response_extractor( + response_extractor, response_body, bedrock_attrs, is_embedding, transaction, request_timestamp=None +): # Run response extractor for non-streaming responses try: response_extractor(response_body, bedrock_attrs) @@ -604,7 +624,7 @@ def run_bedrock_response_extractor(response_extractor, response_body, bedrock_at if is_embedding: handle_embedding_event(transaction, bedrock_attrs) else: - handle_chat_completion_event(transaction, bedrock_attrs) + handle_chat_completion_event(transaction, bedrock_attrs, request_timestamp) def run_bedrock_request_extractor(request_extractor, request_body, bedrock_attrs): @@ -628,6 +648,8 @@ def _wrap_bedrock_runtime_invoke_model(wrapped, instance, args, kwargs): if not settings.ai_monitoring.enabled: return wrapped(*args, **kwargs) + request_timestamp = int(1000.0 * time.time()) + transaction.add_ml_model_info("Bedrock", BOTOCORE_VERSION) transaction._add_agent_attribute("llm", True) @@ -683,6 +705,7 @@ def _wrap_bedrock_runtime_invoke_model(wrapped, instance, args, kwargs): instance._nr_ft = ft instance._nr_response_streaming = response_streaming instance._nr_settings = settings + instance._nr_request_timestamp = request_timestamp # Add a bedrock flag to instance so we can determine when make_api_call instrumentation is hit from non-Bedrock paths and bypass it if so instance._nr_is_bedrock = True @@ -703,6 +726,7 @@ def _wrap_bedrock_runtime_invoke_model(wrapped, instance, args, kwargs): transaction, kwargs, is_converse=False, + request_timestamp=request_timestamp, ) raise @@ -733,6 +757,8 @@ def _wrap_bedrock_runtime_invoke_model(wrapped, instance, args, kwargs): run_bedrock_request_extractor(request_extractor, request_body, bedrock_attrs) try: + bedrock_attrs.pop("timestamp", None) # The request timestamp is only needed for request extraction + if response_streaming: # Wrap EventStream object here to intercept __iter__ method instead of instrumenting class. # This class is used in numerous other services in botocore, and would cause conflicts. @@ -748,7 +774,14 @@ def _wrap_bedrock_runtime_invoke_model(wrapped, instance, args, kwargs): bedrock_attrs["duration"] = ft.duration * 1000 response["body"] = StreamingBody(BytesIO(response_body), len(response_body)) - run_bedrock_response_extractor(response_extractor, response_body, bedrock_attrs, is_embedding, transaction) + run_bedrock_response_extractor( + response_extractor, + response_body, + bedrock_attrs, + is_embedding, + transaction, + request_timestamp=request_timestamp, + ) except Exception: _logger.warning(RESPONSE_PROCESSING_FAILURE_LOG_MESSAGE, exc_info=True) @@ -770,6 +803,8 @@ def _wrap_bedrock_runtime_converse(wrapped, instance, args, kwargs): if not settings.ai_monitoring.enabled: return wrapped(*args, **kwargs) + request_timestamp = int(1000.0 * time.time()) + transaction.add_ml_model_info("Bedrock", BOTOCORE_VERSION) transaction._add_agent_attribute("llm", True) @@ -800,6 +835,7 @@ def _wrap_bedrock_runtime_converse(wrapped, instance, args, kwargs): instance._nr_ft = ft instance._nr_response_streaming = response_streaming instance._nr_settings = settings + instance._nr_request_timestamp = request_timestamp instance._nr_is_converse = True # Add a bedrock flag to instance so we can determine when make_api_call instrumentation is hit from non-Bedrock paths and bypass it if so @@ -810,7 +846,18 @@ def _wrap_bedrock_runtime_converse(wrapped, instance, args, kwargs): response = wrapped(*args, **kwargs) except Exception as exc: handle_bedrock_exception( - exc, False, model, span_id, trace_id, request_extractor, {}, ft, transaction, kwargs, is_converse=True + exc, + False, + model, + span_id, + trace_id, + request_extractor, + {}, + ft, + transaction, + kwargs, + is_converse=True, + request_timestamp=request_timestamp, ) raise @@ -824,6 +871,7 @@ def _wrap_bedrock_runtime_converse(wrapped, instance, args, kwargs): response_headers = response.get("ResponseMetadata", {}).get("HTTPHeaders") or {} bedrock_attrs = extract_bedrock_converse_attrs(kwargs, response, response_headers, model, span_id, trace_id) + bedrock_attrs["timestamp"] = request_timestamp try: if response_streaming: @@ -838,7 +886,9 @@ def _wrap_bedrock_runtime_converse(wrapped, instance, args, kwargs): ft.__exit__(None, None, None) bedrock_attrs["duration"] = ft.duration * 1000 - run_bedrock_response_extractor(response_extractor, {}, bedrock_attrs, False, transaction) + run_bedrock_response_extractor( + response_extractor, {}, bedrock_attrs, False, transaction, request_timestamp=request_timestamp + ) except Exception: _logger.warning(RESPONSE_PROCESSING_FAILURE_LOG_MESSAGE, exc_info=True) @@ -888,7 +938,7 @@ def extract_bedrock_converse_attrs(kwargs, response, response_headers, model, sp class BedrockRecordEventMixin: - def record_events_on_stop_iteration(self, transaction): + def record_events_on_stop_iteration(self, transaction, request_timestamp=None): if hasattr(self, "_nr_ft"): bedrock_attrs = getattr(self, "_nr_bedrock_attrs", {}) self._nr_ft.__exit__(None, None, None) @@ -899,14 +949,14 @@ def record_events_on_stop_iteration(self, transaction): try: bedrock_attrs["duration"] = self._nr_ft.duration * 1000 - handle_chat_completion_event(transaction, bedrock_attrs) + handle_chat_completion_event(transaction, bedrock_attrs, request_timestamp) except Exception: _logger.warning(RESPONSE_PROCESSING_FAILURE_LOG_MESSAGE, exc_info=True) # Clear cached data as this can be very large. self._nr_bedrock_attrs.clear() - def record_error(self, transaction, exc): + def record_error(self, transaction, exc, request_timestamp=None): if hasattr(self, "_nr_ft"): try: ft = self._nr_ft @@ -929,24 +979,24 @@ def record_error(self, transaction, exc): ft.__exit__(*sys.exc_info()) error_attributes["duration"] = ft.duration * 1000 - handle_chat_completion_event(transaction, error_attributes) + handle_chat_completion_event(transaction, error_attributes, request_timestamp) # Clear cached data as this can be very large. error_attributes.clear() except Exception: _logger.warning(EXCEPTION_HANDLING_FAILURE_LOG_MESSAGE, exc_info=True) - def record_stream_chunk(self, event, transaction): + def record_stream_chunk(self, event, transaction, request_timestamp=None): if event: try: if getattr(self, "_nr_is_converse", False): return self.converse_record_stream_chunk(event, transaction) else: - return self.invoke_record_stream_chunk(event, transaction) + return self.invoke_record_stream_chunk(event, transaction, request_timestamp) except Exception: _logger.warning(RESPONSE_EXTRACTOR_FAILURE_LOG_MESSAGE, exc_info=True) - def invoke_record_stream_chunk(self, event, transaction): + def invoke_record_stream_chunk(self, event, transaction, request_timestamp=None): bedrock_attrs = getattr(self, "_nr_bedrock_attrs", {}) chunk = json.loads(event["chunk"]["bytes"].decode("utf-8")) self._nr_model_extractor(chunk, bedrock_attrs) @@ -954,7 +1004,7 @@ def invoke_record_stream_chunk(self, event, transaction): # So we need to call the record events here since stop iteration will not be raised. _type = chunk.get("type") if _type == "content_block_stop": - self.record_events_on_stop_iteration(transaction) + self.record_events_on_stop_iteration(transaction, request_timestamp) def converse_record_stream_chunk(self, event, transaction): bedrock_attrs = getattr(self, "_nr_bedrock_attrs", {}) @@ -984,6 +1034,7 @@ def __iter__(self): class GeneratorProxy(BedrockRecordEventMixin, ObjectProxy): def __init__(self, wrapped): super().__init__(wrapped) + self._nr_request_timestamp = int(1000.0 * time.time()) def __iter__(self): return self @@ -996,12 +1047,12 @@ def __next__(self): return_val = None try: return_val = self.__wrapped__.__next__() - self.record_stream_chunk(return_val, transaction) + self.record_stream_chunk(return_val, transaction, self._nr_request_timestamp) except StopIteration: - self.record_events_on_stop_iteration(transaction) + self.record_events_on_stop_iteration(transaction, self._nr_request_timestamp) raise except Exception as exc: - self.record_error(transaction, exc) + self.record_error(transaction, exc, self._nr_request_timestamp) raise return return_val @@ -1020,6 +1071,10 @@ def __aiter__(self): class AsyncGeneratorProxy(BedrockRecordEventMixin, ObjectProxy): + def __init__(self, wrapped): + super().__init__(wrapped) + self._nr_request_timestamp = int(1000.0 * time.time()) + def __aiter__(self): return self @@ -1030,12 +1085,12 @@ async def __anext__(self): return_val = None try: return_val = await self.__wrapped__.__anext__() - self.record_stream_chunk(return_val, transaction) + self.record_stream_chunk(return_val, transaction, self._nr_request_timestamp) except StopAsyncIteration: - self.record_events_on_stop_iteration(transaction) + self.record_events_on_stop_iteration(transaction, self._nr_request_timestamp) raise except Exception as exc: - self.record_error(transaction, exc) + self.record_error(transaction, exc, self._nr_request_timestamp) raise return return_val @@ -1084,7 +1139,7 @@ def handle_embedding_event(transaction, bedrock_attrs): transaction.record_custom_event("LlmEmbedding", embedding_dict) -def handle_chat_completion_event(transaction, bedrock_attrs): +def handle_chat_completion_event(transaction, bedrock_attrs, request_timestamp=None): chat_completion_id = str(uuid.uuid4()) # Grab LLM-related custom attributes off of the transaction to store as metadata on LLM events custom_attrs_dict = transaction._custom_params @@ -1128,6 +1183,7 @@ def handle_chat_completion_event(transaction, bedrock_attrs): "response.number_of_messages": number_of_messages, "response.choices.finish_reason": bedrock_attrs.get("response.choices.finish_reason", None), "error": bedrock_attrs.get("error", None), + "timestamp": request_timestamp or None, } chat_completion_summary_dict.update(llm_metadata_dict) chat_completion_summary_dict = {k: v for k, v in chat_completion_summary_dict.items() if v is not None} @@ -1144,6 +1200,7 @@ def handle_chat_completion_event(transaction, bedrock_attrs): request_id=request_id, llm_metadata_dict=llm_metadata_dict, response_id=response_id, + request_timestamp=request_timestamp, ) diff --git a/newrelic/hooks/mlmodel_gemini.py b/newrelic/hooks/mlmodel_gemini.py index 8aeb1355d0..6fffbebb47 100644 --- a/newrelic/hooks/mlmodel_gemini.py +++ b/newrelic/hooks/mlmodel_gemini.py @@ -14,6 +14,7 @@ import logging import sys +import time import uuid import google @@ -226,6 +227,7 @@ def wrap_generate_content_sync(wrapped, instance, args, kwargs): transaction._add_agent_attribute("llm", True) completion_id = str(uuid.uuid4()) + request_timestamp = int(1000.0 * time.time()) ft = FunctionTrace(name=wrapped.__name__, group="Llm/completion/Gemini") ft.__enter__() @@ -236,12 +238,12 @@ def wrap_generate_content_sync(wrapped, instance, args, kwargs): except Exception as exc: # In error cases, exit the function trace in _record_generation_error before recording the LLM error event so # that the duration is calculated correctly. - _record_generation_error(transaction, linking_metadata, completion_id, kwargs, ft, exc) + _record_generation_error(transaction, linking_metadata, completion_id, kwargs, ft, exc, request_timestamp) raise ft.__exit__(None, None, None) - _handle_generation_success(transaction, linking_metadata, completion_id, kwargs, ft, return_val) + _handle_generation_success(transaction, linking_metadata, completion_id, kwargs, ft, return_val, request_timestamp) return return_val @@ -260,6 +262,7 @@ async def wrap_generate_content_async(wrapped, instance, args, kwargs): transaction._add_agent_attribute("llm", True) completion_id = str(uuid.uuid4()) + request_timestamp = int(1000.0 * time.time()) ft = FunctionTrace(name=wrapped.__name__, group="Llm/completion/Gemini") ft.__enter__() @@ -269,17 +272,17 @@ async def wrap_generate_content_async(wrapped, instance, args, kwargs): except Exception as exc: # In error cases, exit the function trace in _record_generation_error before recording the LLM error event so # that the duration is calculated correctly. - _record_generation_error(transaction, linking_metadata, completion_id, kwargs, ft, exc) + _record_generation_error(transaction, linking_metadata, completion_id, kwargs, ft, exc, request_timestamp) raise ft.__exit__(None, None, None) - _handle_generation_success(transaction, linking_metadata, completion_id, kwargs, ft, return_val) + _handle_generation_success(transaction, linking_metadata, completion_id, kwargs, ft, return_val, request_timestamp) return return_val -def _record_generation_error(transaction, linking_metadata, completion_id, kwargs, ft, exc): +def _record_generation_error(transaction, linking_metadata, completion_id, kwargs, ft, exc, request_timestamp=None): span_id = linking_metadata.get("span.id") trace_id = linking_metadata.get("trace.id") @@ -339,6 +342,7 @@ def _record_generation_error(transaction, linking_metadata, completion_id, kwarg "ingest_source": "Python", "duration": ft.duration * 1000, "error": True, + "timestamp": request_timestamp, } llm_metadata = _get_llm_attributes(transaction) error_chat_completion_dict.update(llm_metadata) @@ -357,12 +361,15 @@ def _record_generation_error(transaction, linking_metadata, completion_id, kwarg request_model, llm_metadata, output_message_list, + request_timestamp, ) except Exception: _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) -def _handle_generation_success(transaction, linking_metadata, completion_id, kwargs, ft, return_val): +def _handle_generation_success( + transaction, linking_metadata, completion_id, kwargs, ft, return_val, request_timestamp=None +): if not return_val: return @@ -370,13 +377,17 @@ def _handle_generation_success(transaction, linking_metadata, completion_id, kwa # Response objects are pydantic models so this function call converts the response into a dict response = return_val.model_dump() if hasattr(return_val, "model_dump") else return_val - _record_generation_success(transaction, linking_metadata, completion_id, kwargs, ft, response) + _record_generation_success( + transaction, linking_metadata, completion_id, kwargs, ft, response, request_timestamp + ) except Exception: _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) -def _record_generation_success(transaction, linking_metadata, completion_id, kwargs, ft, response): +def _record_generation_success( + transaction, linking_metadata, completion_id, kwargs, ft, response, request_timestamp=None +): span_id = linking_metadata.get("span.id") trace_id = linking_metadata.get("trace.id") try: @@ -436,6 +447,7 @@ def _record_generation_success(transaction, linking_metadata, completion_id, kwa # message This value should be 2 in almost all cases since we will report a summary event for each # separate request (every input and output from the LLM) "response.number_of_messages": 1 + len(output_message_list), + "timestamp": request_timestamp, } llm_metadata = _get_llm_attributes(transaction) @@ -452,6 +464,7 @@ def _record_generation_success(transaction, linking_metadata, completion_id, kwa request_model, llm_metadata, output_message_list, + request_timestamp, ) except Exception: _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) @@ -467,6 +480,7 @@ def create_chat_completion_message_event( request_model, llm_metadata, output_message_list, + request_timestamp=None, ): try: settings = transaction.settings or global_settings() @@ -510,6 +524,8 @@ def create_chat_completion_message_event( if settings.ai_monitoring.record_content.enabled: chat_completion_input_message_dict["content"] = input_message_content + if request_timestamp: + chat_completion_input_message_dict["timestamp"] = request_timestamp chat_completion_input_message_dict.update(llm_metadata) @@ -548,6 +564,8 @@ def create_chat_completion_message_event( if settings.ai_monitoring.record_content.enabled: chat_completion_output_message_dict["content"] = message_content + if request_timestamp: + chat_completion_output_message_dict["timestamp"] = request_timestamp chat_completion_output_message_dict.update(llm_metadata) diff --git a/newrelic/hooks/mlmodel_langchain.py b/newrelic/hooks/mlmodel_langchain.py index cfcc031e9d..318e1313a7 100644 --- a/newrelic/hooks/mlmodel_langchain.py +++ b/newrelic/hooks/mlmodel_langchain.py @@ -14,6 +14,7 @@ import logging import sys +import time import traceback import uuid @@ -549,6 +550,7 @@ async def wrap_chain_async_run(wrapped, instance, args, kwargs): transaction._add_agent_attribute("llm", True) run_args = bind_args(wrapped, args, kwargs) + run_args["timestamp"] = int(1000.0 * time.time()) completion_id = str(uuid.uuid4()) add_nr_completion_id(run_args, completion_id) # Check to see if launched from agent or directly from chain. @@ -593,6 +595,7 @@ def wrap_chain_sync_run(wrapped, instance, args, kwargs): transaction._add_agent_attribute("llm", True) run_args = bind_args(wrapped, args, kwargs) + run_args["timestamp"] = int(1000.0 * time.time()) completion_id = str(uuid.uuid4()) add_nr_completion_id(run_args, completion_id) # Check to see if launched from agent or directly from chain. @@ -658,12 +661,21 @@ def _create_error_chain_run_events(transaction, instance, run_args, completion_i "response.number_of_messages": len(input_message_list), "tags": tags, "error": True, + "timestamp": run_args.get("timestamp") or None, } ) full_chat_completion_summary_dict.update(llm_metadata_dict) transaction.record_custom_event("LlmChatCompletionSummary", full_chat_completion_summary_dict) create_chat_completion_message_event( - transaction, input_message_list, completion_id, span_id, trace_id, run_id, llm_metadata_dict, [] + transaction, + input_message_list, + completion_id, + span_id, + trace_id, + run_id, + llm_metadata_dict, + [], + run_args["timestamp"] or None, ) @@ -728,8 +740,13 @@ def _create_successful_chain_run_events( "duration": duration, "response.number_of_messages": len(input_message_list) + len(output_message_list), "tags": tags, + "timestamp": run_args.get("timestamp") or None, } ) + + if run_args.get("timestamp"): + full_chat_completion_summary_dict["timestamp"] = run_args.get("timestamp") + full_chat_completion_summary_dict.update(llm_metadata_dict) transaction.record_custom_event("LlmChatCompletionSummary", full_chat_completion_summary_dict) create_chat_completion_message_event( @@ -741,6 +758,7 @@ def _create_successful_chain_run_events( run_id, llm_metadata_dict, output_message_list, + run_args["timestamp"] or None, ) @@ -753,6 +771,7 @@ def create_chat_completion_message_event( run_id, llm_metadata_dict, output_message_list, + request_timestamp=None, ): settings = transaction.settings if transaction.settings is not None else global_settings() @@ -768,9 +787,12 @@ def create_chat_completion_message_event( "vendor": "langchain", "ingest_source": "Python", "virtual_llm": True, + "role": "user", # default role for input messages, overridden by values in llm_metadata_dict } if settings.ai_monitoring.record_content.enabled: chat_completion_input_message_dict["content"] = message + if request_timestamp: + chat_completion_input_message_dict["timestamp"] = request_timestamp chat_completion_input_message_dict.update(llm_metadata_dict) transaction.record_custom_event("LlmChatCompletionMessage", chat_completion_input_message_dict) @@ -791,9 +813,12 @@ def create_chat_completion_message_event( "ingest_source": "Python", "is_response": True, "virtual_llm": True, + "role": "assistant", # default role for output messages, overridden by values in llm_metadata_dict } if settings.ai_monitoring.record_content.enabled: chat_completion_output_message_dict["content"] = message + if request_timestamp: + chat_completion_output_message_dict["timestamp"] = request_timestamp chat_completion_output_message_dict.update(llm_metadata_dict) transaction.record_custom_event("LlmChatCompletionMessage", chat_completion_output_message_dict) diff --git a/newrelic/hooks/mlmodel_openai.py b/newrelic/hooks/mlmodel_openai.py index c3f7960b6e..59f7060394 100644 --- a/newrelic/hooks/mlmodel_openai.py +++ b/newrelic/hooks/mlmodel_openai.py @@ -15,6 +15,7 @@ import json import logging import sys +import time import traceback import uuid @@ -84,6 +85,8 @@ def wrap_chat_completion_sync(wrapped, instance, args, kwargs): if (kwargs.get("extra_headers") or {}).get("X-Stainless-Raw-Response") == "stream": return wrapped(*args, **kwargs) + request_timestamp = int(1000.0 * time.time()) + settings = transaction.settings if transaction.settings is not None else global_settings() if not settings.ai_monitoring.enabled: return wrapped(*args, **kwargs) @@ -100,9 +103,10 @@ def wrap_chat_completion_sync(wrapped, instance, args, kwargs): try: return_val = wrapped(*args, **kwargs) except Exception as exc: - _record_completion_error(transaction, linking_metadata, completion_id, kwargs, ft, exc) + _record_completion_error(transaction, linking_metadata, completion_id, kwargs, ft, exc, request_timestamp) raise - _handle_completion_success(transaction, linking_metadata, completion_id, kwargs, ft, return_val) + + _handle_completion_success(transaction, linking_metadata, completion_id, kwargs, ft, return_val, request_timestamp) return return_val @@ -134,6 +138,7 @@ def create_chat_completion_message_event( request_id, llm_metadata, output_message_list, + request_timestamp=None, ): settings = transaction.settings if transaction.settings is not None else global_settings() @@ -168,6 +173,8 @@ def create_chat_completion_message_event( if settings.ai_monitoring.record_content.enabled: chat_completion_input_message_dict["content"] = message_content + if request_timestamp: + chat_completion_input_message_dict["timestamp"] = request_timestamp chat_completion_input_message_dict.update(llm_metadata) @@ -209,6 +216,8 @@ def create_chat_completion_message_event( if settings.ai_monitoring.record_content.enabled: chat_completion_output_message_dict["content"] = message_content + if request_timestamp: + chat_completion_output_message_dict["timestamp"] = request_timestamp chat_completion_output_message_dict.update(llm_metadata) @@ -403,6 +412,8 @@ async def wrap_chat_completion_async(wrapped, instance, args, kwargs): if (kwargs.get("extra_headers") or {}).get("X-Stainless-Raw-Response") == "stream": return await wrapped(*args, **kwargs) + request_timestamp = int(1000.0 * time.time()) + settings = transaction.settings if transaction.settings is not None else global_settings() if not settings.ai_monitoring.enabled: return await wrapped(*args, **kwargs) @@ -419,14 +430,16 @@ async def wrap_chat_completion_async(wrapped, instance, args, kwargs): try: return_val = await wrapped(*args, **kwargs) except Exception as exc: - _record_completion_error(transaction, linking_metadata, completion_id, kwargs, ft, exc) + _record_completion_error(transaction, linking_metadata, completion_id, kwargs, ft, exc, request_timestamp) raise - _handle_completion_success(transaction, linking_metadata, completion_id, kwargs, ft, return_val) + _handle_completion_success(transaction, linking_metadata, completion_id, kwargs, ft, return_val, request_timestamp) return return_val -def _handle_completion_success(transaction, linking_metadata, completion_id, kwargs, ft, return_val): +def _handle_completion_success( + transaction, linking_metadata, completion_id, kwargs, ft, return_val, request_timestamp=None +): settings = transaction.settings if transaction.settings is not None else global_settings() stream = kwargs.get("stream", False) # Only if streaming and streaming monitoring is enabled and the response is not empty @@ -469,12 +482,16 @@ def _handle_completion_success(transaction, linking_metadata, completion_id, kwa # openai._legacy_response.LegacyAPIResponse response = json.loads(response.http_response.text.strip()) - _record_completion_success(transaction, linking_metadata, completion_id, kwargs, ft, response_headers, response) + _record_completion_success( + transaction, linking_metadata, completion_id, kwargs, ft, response_headers, response, request_timestamp + ) except Exception: _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, traceback.format_exception(*sys.exc_info())) -def _record_completion_success(transaction, linking_metadata, completion_id, kwargs, ft, response_headers, response): +def _record_completion_success( + transaction, linking_metadata, completion_id, kwargs, ft, response_headers, response, request_timestamp=None +): span_id = linking_metadata.get("span.id") trace_id = linking_metadata.get("trace.id") try: @@ -552,6 +569,7 @@ def _record_completion_success(transaction, linking_metadata, completion_id, kwa response_headers, "x-ratelimit-remaining-tokens_usage_based", True ), "response.number_of_messages": len(input_message_list) + len(output_message_list), + "timestamp": request_timestamp, } llm_metadata = _get_llm_attributes(transaction) full_chat_completion_summary_dict.update(llm_metadata) @@ -569,12 +587,13 @@ def _record_completion_success(transaction, linking_metadata, completion_id, kwa request_id, llm_metadata, output_message_list, + request_timestamp, ) except Exception: _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, traceback.format_exception(*sys.exc_info())) -def _record_completion_error(transaction, linking_metadata, completion_id, kwargs, ft, exc): +def _record_completion_error(transaction, linking_metadata, completion_id, kwargs, ft, exc, request_timestamp=None): span_id = linking_metadata.get("span.id") trace_id = linking_metadata.get("trace.id") request_message_list = kwargs.get("messages", None) or [] @@ -635,6 +654,7 @@ def _record_completion_error(transaction, linking_metadata, completion_id, kwarg "response.organization": exc_organization, "duration": ft.duration * 1000, "error": True, + "timestamp": request_timestamp, } llm_metadata = _get_llm_attributes(transaction) error_chat_completion_dict.update(llm_metadata) @@ -655,6 +675,7 @@ def _record_completion_error(transaction, linking_metadata, completion_id, kwarg request_id, llm_metadata, output_message_list, + request_timestamp, ) except Exception: _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, traceback.format_exception(*sys.exc_info())) @@ -719,6 +740,7 @@ async def wrap_base_client_process_response_async(wrapped, instance, args, kwarg class GeneratorProxy(ObjectProxy): def __init__(self, wrapped): super().__init__(wrapped) + self._nr_request_timestamp = int(1000.0 * time.time()) def __iter__(self): return self @@ -733,10 +755,10 @@ def __next__(self): return_val = self.__wrapped__.__next__() _record_stream_chunk(self, return_val) except StopIteration: - _record_events_on_stop_iteration(self, transaction) + _record_events_on_stop_iteration(self, transaction, self._nr_request_timestamp) raise except Exception as exc: - _handle_streaming_completion_error(self, transaction, exc) + _handle_streaming_completion_error(self, transaction, exc, self._nr_request_timestamp) raise return return_val @@ -770,7 +792,7 @@ def _record_stream_chunk(self, return_val): _logger.warning(STREAM_PARSING_FAILURE_LOG_MESSAGE, traceback.format_exception(*sys.exc_info())) -def _record_events_on_stop_iteration(self, transaction): +def _record_events_on_stop_iteration(self, transaction, request_timestamp=None): if hasattr(self, "_nr_ft"): # We first check for our saved linking metadata before making a new call to get_trace_linking_metadata # Directly calling get_trace_linking_metadata() causes the incorrect span ID to be captured and associated with the LLM call @@ -787,7 +809,14 @@ def _record_events_on_stop_iteration(self, transaction): completion_id = str(uuid.uuid4()) response_headers = openai_attrs.get("response_headers") or {} _record_completion_success( - transaction, linking_metadata, completion_id, openai_attrs, self._nr_ft, response_headers, None + transaction, + linking_metadata, + completion_id, + openai_attrs, + self._nr_ft, + response_headers, + None, + request_timestamp, ) except Exception: _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, traceback.format_exception(*sys.exc_info())) @@ -802,7 +831,7 @@ def _record_events_on_stop_iteration(self, transaction): self._nr_openai_attrs.clear() -def _handle_streaming_completion_error(self, transaction, exc): +def _handle_streaming_completion_error(self, transaction, exc, request_timestamp=None): if hasattr(self, "_nr_ft"): openai_attrs = getattr(self, "_nr_openai_attrs", {}) @@ -812,12 +841,15 @@ def _handle_streaming_completion_error(self, transaction, exc): return linking_metadata = get_trace_linking_metadata() completion_id = str(uuid.uuid4()) - _record_completion_error(transaction, linking_metadata, completion_id, openai_attrs, self._nr_ft, exc) + _record_completion_error( + transaction, linking_metadata, completion_id, openai_attrs, self._nr_ft, exc, request_timestamp + ) class AsyncGeneratorProxy(ObjectProxy): def __init__(self, wrapped): super().__init__(wrapped) + self._nr_request_timestamp = int(1000.0 * time.time()) def __aiter__(self): self._nr_wrapped_iter = self.__wrapped__.__aiter__() @@ -833,10 +865,10 @@ async def __anext__(self): return_val = await self._nr_wrapped_iter.__anext__() _record_stream_chunk(self, return_val) except StopAsyncIteration: - _record_events_on_stop_iteration(self, transaction) + _record_events_on_stop_iteration(self, transaction, self._nr_request_timestamp) raise except Exception as exc: - _handle_streaming_completion_error(self, transaction, exc) + _handle_streaming_completion_error(self, transaction, exc, self._nr_request_timestamp) raise return return_val diff --git a/tests/external_botocore/_test_bedrock_chat_completion_converse.py b/tests/external_botocore/_test_bedrock_chat_completion_converse.py index cdec652292..7cde46faf8 100644 --- a/tests/external_botocore/_test_bedrock_chat_completion_converse.py +++ b/tests/external_botocore/_test_bedrock_chat_completion_converse.py @@ -20,6 +20,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -40,6 +41,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", @@ -58,6 +60,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", @@ -76,6 +79,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", @@ -98,6 +102,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -118,6 +123,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "f070b880-e0fb-4537-8093-796671c39239", @@ -136,6 +142,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "f070b880-e0fb-4537-8093-796671c39239", @@ -154,6 +161,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "f070b880-e0fb-4537-8093-796671c39239", @@ -176,6 +184,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -196,6 +205,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "e1206e19-2318-4a9d-be98-017c73f06118", @@ -216,6 +226,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "f4908827-3db9-4742-9103-2bbc34578b03", @@ -236,6 +247,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, diff --git a/tests/external_botocore/_test_bedrock_chat_completion_invoke_model.py b/tests/external_botocore/_test_bedrock_chat_completion_invoke_model.py index fd970b0603..f72b9fa583 100644 --- a/tests/external_botocore/_test_bedrock_chat_completion_invoke_model.py +++ b/tests/external_botocore/_test_bedrock_chat_completion_invoke_model.py @@ -31,6 +31,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -51,6 +52,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "48c7ee13-7790-461f-959f-04b0a4cf91c8", @@ -69,6 +71,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "48c7ee13-7790-461f-959f-04b0a4cf91c8", @@ -90,6 +93,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -110,6 +114,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "81508a1c-33a8-4294-8743-f0c629af2f49", @@ -128,6 +133,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "81508a1c-33a8-4294-8743-f0c629af2f49", @@ -149,6 +155,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -170,6 +177,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": "1234-0", + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "228ee63f-4eca-4b7d-b679-bc920de63525", @@ -188,6 +196,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": "1234-1", + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "228ee63f-4eca-4b7d-b679-bc920de63525", @@ -209,6 +218,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -229,6 +239,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "6a886158-b39f-46ce-b214-97458ab76f2f", @@ -247,6 +258,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "6a886158-b39f-46ce-b214-97458ab76f2f", @@ -268,6 +280,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -288,6 +301,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "ab38295d-df9c-4141-8173-38221651bf46", @@ -306,6 +320,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "ab38295d-df9c-4141-8173-38221651bf46", @@ -327,6 +342,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -348,6 +364,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "12912a17-aa13-45f3-914c-cc82166f3601", @@ -366,6 +383,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "12912a17-aa13-45f3-914c-cc82166f3601", @@ -387,6 +405,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -407,6 +426,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "a168214d-742d-4244-bd7f-62214ffa07df", @@ -425,6 +445,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "a168214d-742d-4244-bd7f-62214ffa07df", @@ -448,6 +469,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -468,6 +490,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "48c7ee13-7790-461f-959f-04b0a4cf91c8", @@ -486,6 +509,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "48c7ee13-7790-461f-959f-04b0a4cf91c8", @@ -507,6 +531,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -525,6 +550,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "884db5c9-18ab-4f27-8892-33656176a2e6", @@ -543,6 +569,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "884db5c9-18ab-4f27-8892-33656176a2e6", @@ -564,6 +591,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -581,6 +609,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "1a72a1f6-310f-469c-af1d-2c59eb600089", @@ -599,6 +628,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "1a72a1f6-310f-469c-af1d-2c59eb600089", @@ -620,6 +650,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -637,6 +668,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "e8fc1dd7-3d1e-42c6-9c58-535cae563bff", @@ -655,6 +687,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "e8fc1dd7-3d1e-42c6-9c58-535cae563bff", @@ -676,6 +709,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -694,6 +728,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "cce6b34c-812c-4f97-8885-515829aa9639", @@ -712,6 +747,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "cce6b34c-812c-4f97-8885-515829aa9639", @@ -735,6 +771,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -755,6 +792,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "48c7ee13-7790-461f-959f-04b0a4cf91c8", @@ -773,6 +811,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "48c7ee13-7790-461f-959f-04b0a4cf91c8", @@ -794,6 +833,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -812,6 +852,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "884db5c9-18ab-4f27-8892-33656176a2e6", @@ -830,6 +871,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "884db5c9-18ab-4f27-8892-33656176a2e6", @@ -851,6 +893,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -869,6 +912,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "1a72a1f6-310f-469c-af1d-2c59eb600089", @@ -887,6 +931,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "1a72a1f6-310f-469c-af1d-2c59eb600089", @@ -908,6 +953,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -926,6 +972,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "96c7306d-2d60-4629-83e9-dbd6befb0e4e", @@ -944,6 +991,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "96c7306d-2d60-4629-83e9-dbd6befb0e4e", @@ -965,6 +1013,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -983,6 +1032,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "cce6b34c-812c-4f97-8885-515829aa9639", @@ -1001,6 +1051,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "cce6b34c-812c-4f97-8885-515829aa9639", @@ -1025,6 +1076,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -1045,6 +1097,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "48c7ee13-7790-461f-959f-04b0a4cf91c8", @@ -1063,6 +1116,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "48c7ee13-7790-461f-959f-04b0a4cf91c8", @@ -1084,6 +1138,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -1104,6 +1159,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "request_id": "b427270f-371a-458d-81b6-a05aafb2704c", "span_id": None, "trace_id": "trace-id", @@ -1122,6 +1178,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "request_id": "b427270f-371a-458d-81b6-a05aafb2704c", "span_id": None, "trace_id": "trace-id", @@ -1143,6 +1200,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -1163,6 +1221,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "request_id": "a645548f-0b3a-47ce-a675-f51e6e9037de", "span_id": None, "trace_id": "trace-id", @@ -1181,6 +1240,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "request_id": "a645548f-0b3a-47ce-a675-f51e6e9037de", "span_id": None, "trace_id": "trace-id", @@ -1202,6 +1262,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -1221,6 +1282,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "1efe6197-80f9-43a6-89a5-bb536c1b822f", @@ -1239,6 +1301,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "1efe6197-80f9-43a6-89a5-bb536c1b822f", @@ -1260,6 +1323,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -1281,6 +1345,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "request_id": "4f8ab6c5-42d1-4e35-9573-30f9f41f821e", "span_id": None, "trace_id": "trace-id", @@ -1299,6 +1364,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "request_id": "4f8ab6c5-42d1-4e35-9573-30f9f41f821e", "span_id": None, "trace_id": "trace-id", @@ -1320,6 +1386,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -1340,6 +1407,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "request_id": "6dd99878-0919-4f92-850c-48f50f923b76", "span_id": None, "trace_id": "trace-id", @@ -1358,6 +1426,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "request_id": "6dd99878-0919-4f92-850c-48f50f923b76", "span_id": None, "trace_id": "trace-id", @@ -1381,6 +1450,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "f4908827-3db9-4742-9103-2bbc34578b03", @@ -1402,6 +1472,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -1422,6 +1493,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "48c7ee13-7790-461f-959f-04b0a4cf91c8", @@ -1442,6 +1514,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -1462,6 +1535,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "15b39c8b-8e85-42c9-9623-06720301bda3", @@ -1482,6 +1556,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -1502,6 +1577,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "9021791d-3797-493d-9277-e33aa6f6d544", @@ -1522,6 +1598,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -1542,6 +1619,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "37396f55-b721-4bae-9461-4c369f5a080d", @@ -1562,6 +1640,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -1582,6 +1661,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "282ba076-576f-46aa-a2e6-680392132e87", @@ -1602,6 +1682,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -1622,6 +1703,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "22476490-a0d6-42db-b5ea-32d0b8a7f751", @@ -1642,6 +1724,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -1662,6 +1745,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "22476490-a0d6-42db-b5ea-32d0b8a7f751", @@ -1685,6 +1769,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -1705,6 +1790,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -1724,6 +1810,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "81508a1c-33a8-4294-8743-f0c629af2f49", @@ -1745,6 +1832,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -1764,6 +1852,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "a5a8cebb-fd33-4437-8168-5667fbdfc1fb", @@ -1785,6 +1874,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -1804,6 +1894,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "a5a8cebb-fd33-4437-8168-5667fbdfc1fb", @@ -1826,6 +1917,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -1845,6 +1937,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, diff --git a/tests/mlmodel_gemini/test_text_generation.py b/tests/mlmodel_gemini/test_text_generation.py index faec66aa75..1c789f8197 100644 --- a/tests/mlmodel_gemini/test_text_generation.py +++ b/tests/mlmodel_gemini/test_text_generation.py @@ -37,6 +37,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -56,6 +57,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -73,6 +75,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, diff --git a/tests/mlmodel_gemini/test_text_generation_error.py b/tests/mlmodel_gemini/test_text_generation_error.py index 5e6f1c04de..eb8aec950f 100644 --- a/tests/mlmodel_gemini/test_text_generation_error.py +++ b/tests/mlmodel_gemini/test_text_generation_error.py @@ -42,6 +42,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -58,6 +59,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -145,6 +147,7 @@ def _test(): {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -162,6 +165,7 @@ def _test(): {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -246,6 +250,7 @@ def test_text_generation_invalid_request_error_invalid_model_chat(gemini_dev_cli {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "span_id": None, "trace_id": "trace-id", "duration": None, # Response time varies each test run @@ -262,6 +267,7 @@ def test_text_generation_invalid_request_error_invalid_model_chat(gemini_dev_cli {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "span_id": None, "trace_id": "trace-id", "content": "Invalid API key.", diff --git a/tests/mlmodel_langchain/test_chain.py b/tests/mlmodel_langchain/test_chain.py index a6b7470a9a..2f52f85504 100644 --- a/tests/mlmodel_langchain/test_chain.py +++ b/tests/mlmodel_langchain/test_chain.py @@ -65,6 +65,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -83,6 +84,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -93,6 +95,7 @@ "sequence": 0, "vendor": "langchain", "ingest_source": "Python", + "role": "user", "virtual_llm": True, }, ), @@ -103,6 +106,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -121,6 +125,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -131,6 +136,7 @@ "sequence": 0, "vendor": "langchain", "ingest_source": "Python", + "role": "user", "virtual_llm": True, }, ), @@ -140,6 +146,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -158,6 +165,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -168,6 +176,7 @@ "sequence": 0, "vendor": "langchain", "ingest_source": "Python", + "role": "user", "virtual_llm": True, }, ), @@ -175,6 +184,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -185,6 +195,7 @@ "sequence": 1, "vendor": "langchain", "ingest_source": "Python", + "role": "assistant", "is_response": True, "virtual_llm": True, }, @@ -195,6 +206,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -213,6 +225,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -223,6 +236,7 @@ "sequence": 0, "vendor": "langchain", "ingest_source": "Python", + "role": "user", "virtual_llm": True, }, ), @@ -230,6 +244,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -240,6 +255,7 @@ "sequence": 1, "vendor": "langchain", "ingest_source": "Python", + "role": "assistant", "is_response": True, "virtual_llm": True, }, @@ -250,6 +266,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -266,6 +283,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -276,6 +294,7 @@ "sequence": 0, "vendor": "langchain", "ingest_source": "Python", + "role": "user", "virtual_llm": True, }, ), @@ -283,6 +302,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -293,6 +313,7 @@ "sequence": 1, "vendor": "langchain", "ingest_source": "Python", + "role": "assistant", "is_response": True, "virtual_llm": True, }, @@ -303,6 +324,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -319,6 +341,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -329,6 +352,7 @@ "sequence": 0, "vendor": "langchain", "ingest_source": "Python", + "role": "user", "virtual_llm": True, }, ), @@ -336,6 +360,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -346,6 +371,7 @@ "sequence": 1, "vendor": "langchain", "ingest_source": "Python", + "role": "assistant", "is_response": True, "virtual_llm": True, }, @@ -430,6 +456,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "request_id": None, "span_id": None, "trace_id": "trace-id", @@ -438,6 +465,7 @@ "vendor": "langchain", "ingest_source": "Python", "is_response": True, + "role": "assistant", "virtual_llm": True, "content": "page_content='What is 2 + 4?'", }, @@ -446,6 +474,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, + "timestamp": None, "span_id": None, "trace_id": "trace-id", "request.model": "gpt-3.5-turbo", @@ -471,6 +500,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "request_id": None, "span_id": None, "trace_id": "trace-id", @@ -487,6 +517,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "request_id": None, "span_id": None, "trace_id": "trace-id", @@ -503,6 +534,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "request_id": None, "span_id": None, "trace_id": "trace-id", @@ -520,6 +552,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "request_id": None, "span_id": None, "trace_id": "trace-id", @@ -527,6 +560,7 @@ "sequence": 0, "vendor": "langchain", "ingest_source": "Python", + "role": "user", "virtual_llm": True, "content": "{'input': 'math', 'context': [Document(id='1234', metadata={}, page_content='What is 2 + 4?')]}", }, @@ -535,6 +569,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "request_id": None, "span_id": None, "trace_id": "trace-id", @@ -542,6 +577,7 @@ "sequence": 1, "vendor": "langchain", "ingest_source": "Python", + "role": "assistant", "is_response": True, "virtual_llm": True, "content": "```html\n\n\n\n Math Quiz\n\n\n

Math Quiz Questions

\n
    \n
  1. What is the result of 5 + 3?
    2. \n
      \n
    • A) 7
      • \n
    • B) 8
      • \n
    • C) 9
      • \n
    • D) 10
      • \n
    \n
  2. What is the product of 6 x 7?
    3. \n
      \n
    • A) 36
      • \n
    • B) 42
      • \n
    • C) 48
      • \n
    • D) 56
      • \n
    \n
  3. What is the square root of 64?
    4. \n
      \n
    • A) 6
      • \n
    • B) 7
      • \n
    • C) 8
      • \n
    • D) 9
      • \n
    \n
  4. What is the result of 12 / 4?
    5. \n
      \n
    • A) 2
      • \n
    • B) 3
      • \n
    • C) 4
      • \n
    • D) 5
      • \n
    \n
  5. What is the sum of 15 + 9?
    6. \n
      \n
    • A) 22
      • \n
    • B) 23
      • \n
    • C) 24
      • \n
    • D) 25
      • \n
    \n
\n\n\n```", @@ -551,6 +587,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "request_id": None, "span_id": None, "trace_id": "trace-id", @@ -558,6 +595,7 @@ "sequence": 1, "vendor": "langchain", "ingest_source": "Python", + "role": "assistant", "is_response": True, "virtual_llm": True, "content": "{'input': 'math', 'context': [Document(id='1234', metadata={}, page_content='What is 2 + 4?')], 'answer': '```html\\n\\n\\n\\n Math Quiz\\n\\n\\n

Math Quiz Questions

\\n
    \\n
  1. What is the result of 5 + 3?
    2. \\n
      \\n
    • A) 7
      • \\n
    • B) 8
      • \\n
    • C) 9
      • \\n
    • D) 10
      • \\n
    \\n
  2. What is the product of 6 x 7?
    3. \\n
      \\n
    • A) 36
      • \\n
    • B) 42
      • \\n
    • C) 48
      • \\n
    • D) 56
      • \\n
    \\n
  3. What is the square root of 64?
    4. \\n
      \\n
    • A) 6
      • \\n
    • B) 7
      • \\n
    • C) 8
      • \\n
    • D) 9
      • \\n
    \\n
  4. What is the result of 12 / 4?
    5. \\n
      \\n
    • A) 2
      • \\n
    • B) 3
      • \\n
    • C) 4
      • \\n
    • D) 5
      • \\n
    \\n
  5. What is the sum of 15 + 9?
    6. \\n
      \\n
    • A) 22
      • \\n
    • B) 23
      • \\n
    • C) 24
      • \\n
    • D) 25
      • \\n
    \\n
\\n\\n\\n```'}", @@ -570,6 +608,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -587,6 +626,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -597,6 +637,7 @@ "sequence": 0, "vendor": "langchain", "ingest_source": "Python", + "role": "user", "virtual_llm": True, }, ), @@ -604,6 +645,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -614,6 +656,7 @@ "sequence": 1, "vendor": "langchain", "ingest_source": "Python", + "role": "assistant", "is_response": True, "virtual_llm": True, }, @@ -624,6 +667,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -641,6 +685,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -651,6 +696,7 @@ "sequence": 0, "vendor": "langchain", "ingest_source": "Python", + "role": "user", "virtual_llm": True, }, ), @@ -658,6 +704,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -668,6 +715,7 @@ "sequence": 1, "vendor": "langchain", "ingest_source": "Python", + "role": "assistant", "is_response": True, "virtual_llm": True, }, @@ -679,6 +727,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -696,6 +745,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -706,6 +756,7 @@ "sequence": 0, "vendor": "langchain", "ingest_source": "Python", + "role": "user", "virtual_llm": True, }, ), @@ -716,6 +767,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -732,6 +784,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -742,6 +795,7 @@ "sequence": 0, "vendor": "langchain", "ingest_source": "Python", + "role": "user", "virtual_llm": True, }, ), diff --git a/tests/mlmodel_openai/test_chat_completion.py b/tests/mlmodel_openai/test_chat_completion.py index 1f8cf1cb74..89208ab268 100644 --- a/tests/mlmodel_openai/test_chat_completion.py +++ b/tests/mlmodel_openai/test_chat_completion.py @@ -44,6 +44,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -72,6 +73,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": "chatcmpl-87sb95K4EF2nuJRcTs43Tm9ntTemv-0", + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "49dbbffbd3c3f4612aa48def69059ccd", @@ -90,6 +92,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": "chatcmpl-87sb95K4EF2nuJRcTs43Tm9ntTemv-1", + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "49dbbffbd3c3f4612aa48def69059ccd", @@ -108,6 +111,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": "chatcmpl-87sb95K4EF2nuJRcTs43Tm9ntTemv-2", + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "49dbbffbd3c3f4612aa48def69059ccd", diff --git a/tests/mlmodel_openai/test_chat_completion_error.py b/tests/mlmodel_openai/test_chat_completion_error.py index bfb2267a33..79cc79d6db 100644 --- a/tests/mlmodel_openai/test_chat_completion_error.py +++ b/tests/mlmodel_openai/test_chat_completion_error.py @@ -45,6 +45,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -61,6 +62,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -76,6 +78,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -162,6 +165,7 @@ def test_chat_completion_invalid_request_error_no_model_no_content(set_trace_inf {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -179,6 +183,7 @@ def test_chat_completion_invalid_request_error_no_model_no_content(set_trace_inf {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -257,6 +262,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info): {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -274,6 +280,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info): {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -289,6 +296,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info): {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -338,6 +346,7 @@ def test_chat_completion_authentication_error(monkeypatch, set_trace_info): {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "span_id": None, "trace_id": "trace-id", "duration": None, # Response time varies each test run @@ -354,6 +363,7 @@ def test_chat_completion_authentication_error(monkeypatch, set_trace_info): {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "span_id": None, "trace_id": "trace-id", "content": "Invalid API key.", diff --git a/tests/mlmodel_openai/test_chat_completion_error_v1.py b/tests/mlmodel_openai/test_chat_completion_error_v1.py index 9be9fcab9c..848ad57add 100644 --- a/tests/mlmodel_openai/test_chat_completion_error_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_error_v1.py @@ -44,6 +44,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -60,6 +61,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -75,6 +77,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -205,6 +208,7 @@ def test_chat_completion_invalid_request_error_no_model_async_no_content(loop, s {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -222,6 +226,7 @@ def test_chat_completion_invalid_request_error_no_model_async_no_content(loop, s {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -369,6 +374,7 @@ def test_chat_completion_invalid_request_error_invalid_model_with_token_count_as {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "span_id": None, "trace_id": "trace-id", "duration": None, # Response time varies each test run @@ -385,6 +391,7 @@ def test_chat_completion_invalid_request_error_invalid_model_with_token_count_as {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "span_id": None, "trace_id": "trace-id", "content": "Invalid API key.", diff --git a/tests/mlmodel_openai/test_chat_completion_stream.py b/tests/mlmodel_openai/test_chat_completion_stream.py index ad89d6f260..55e8e8fbdb 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream.py +++ b/tests/mlmodel_openai/test_chat_completion_stream.py @@ -45,6 +45,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -73,6 +74,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": "chatcmpl-87sb95K4EF2nuJRcTs43Tm9ntTemv-0", + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "49dbbffbd3c3f4612aa48def69059ccd", @@ -91,6 +93,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": "chatcmpl-87sb95K4EF2nuJRcTs43Tm9ntTemv-1", + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "49dbbffbd3c3f4612aa48def69059ccd", @@ -109,6 +112,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": "chatcmpl-87sb95K4EF2nuJRcTs43Tm9ntTemv-2", + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "49dbbffbd3c3f4612aa48def69059ccd", diff --git a/tests/mlmodel_openai/test_chat_completion_stream_error.py b/tests/mlmodel_openai/test_chat_completion_stream_error.py index eebb5ee8fb..0fb0d06867 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream_error.py +++ b/tests/mlmodel_openai/test_chat_completion_stream_error.py @@ -45,6 +45,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -61,6 +62,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -76,6 +78,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -167,6 +170,7 @@ def test_chat_completion_invalid_request_error_no_model_no_content(set_trace_inf {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -184,6 +188,7 @@ def test_chat_completion_invalid_request_error_no_model_no_content(set_trace_inf {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -266,6 +271,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info): {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -283,6 +289,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info): {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -298,6 +305,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info): {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -352,6 +360,7 @@ def test_chat_completion_authentication_error(monkeypatch, set_trace_info): {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "span_id": None, "trace_id": "trace-id", "duration": None, # Response time varies each test run @@ -368,6 +377,7 @@ def test_chat_completion_authentication_error(monkeypatch, set_trace_info): {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "span_id": None, "trace_id": "trace-id", "content": "Invalid API key.", @@ -626,6 +636,7 @@ def test_chat_completion_wrong_api_key_error_async(loop, monkeypatch, set_trace_ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "span_id": None, "trace_id": "trace-id", "duration": None, # Response time varies each test run @@ -643,6 +654,7 @@ def test_chat_completion_wrong_api_key_error_async(loop, monkeypatch, set_trace_ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "span_id": None, "trace_id": "trace-id", "content": "Stream parsing error.", diff --git a/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py b/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py index 5f769ea0e6..5d06dc2a28 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py @@ -45,6 +45,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -61,6 +62,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -76,6 +78,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -219,6 +222,7 @@ async def consumer(): {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -236,6 +240,7 @@ async def consumer(): {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "llm.conversation_id": "my-awesome-id", "span_id": None, "trace_id": "trace-id", @@ -392,6 +397,7 @@ async def consumer(): {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "span_id": None, "trace_id": "trace-id", "duration": None, # Response time varies each test run @@ -408,6 +414,7 @@ async def consumer(): {"type": "LlmChatCompletionMessage"}, { "id": None, + "timestamp": None, "span_id": None, "trace_id": "trace-id", "content": "Invalid API key.", diff --git a/tests/mlmodel_openai/test_chat_completion_stream_v1.py b/tests/mlmodel_openai/test_chat_completion_stream_v1.py index 796404012b..6fc5d58f28 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_stream_v1.py @@ -54,6 +54,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -83,6 +84,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug-0", + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "f8d0f53b6881c5c0a3698e55f8f410ac", @@ -101,6 +103,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug-1", + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "f8d0f53b6881c5c0a3698e55f8f410ac", @@ -119,6 +122,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug-2", + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "f8d0f53b6881c5c0a3698e55f8f410ac", diff --git a/tests/mlmodel_openai/test_chat_completion_v1.py b/tests/mlmodel_openai/test_chat_completion_v1.py index 817db35d8e..5a6793d955 100644 --- a/tests/mlmodel_openai/test_chat_completion_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_v1.py @@ -43,6 +43,7 @@ {"type": "LlmChatCompletionSummary"}, { "id": None, # UUID that varies with each run + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, @@ -71,6 +72,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": "chatcmpl-9NPYxI4Zk5ztxNwW5osYdpevgoiBQ-0", + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "req_25be7e064e0c590cd65709c85385c796", @@ -89,6 +91,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": "chatcmpl-9NPYxI4Zk5ztxNwW5osYdpevgoiBQ-1", + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "req_25be7e064e0c590cd65709c85385c796", @@ -107,6 +110,7 @@ {"type": "LlmChatCompletionMessage"}, { "id": "chatcmpl-9NPYxI4Zk5ztxNwW5osYdpevgoiBQ-2", + "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "req_25be7e064e0c590cd65709c85385c796", From 1606479bd4b354e68aa2ef1d88b72497e523c95c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 2 Dec 2025 22:01:27 +0000 Subject: [PATCH 018/124] Bump the github_actions group with 4 updates (#1595) Bumps the github_actions group with 4 updates: [actions/setup-python](https://github.com/actions/setup-python), [docker/metadata-action](https://github.com/docker/metadata-action), [oxsecurity/megalinter](https://github.com/oxsecurity/megalinter) and [github/codeql-action](https://github.com/github/codeql-action). Updates `actions/setup-python` from 6.0.0 to 6.1.0 - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](https://github.com/actions/setup-python/compare/e797f83bcb11b83ae66e0230d6156d7c80228e7c...83679a892e2d95755f2dac6acb0bfd1e9ac5d548) Updates `docker/metadata-action` from 5.9.0 to 5.10.0 - [Release notes](https://github.com/docker/metadata-action/releases) - [Commits](https://github.com/docker/metadata-action/compare/318604b99e75e41977312d83839a89be02ca4893...c299e40c65443455700f0fdfc63efafe5b349051) Updates `oxsecurity/megalinter` from 9.1.0 to 9.2.0 - [Release notes](https://github.com/oxsecurity/megalinter/releases) - [Changelog](https://github.com/oxsecurity/megalinter/blob/main/CHANGELOG.md) - [Commits](https://github.com/oxsecurity/megalinter/compare/62c799d895af9bcbca5eacfebca29d527f125a57...55a59b24a441e0e1943080d4a512d827710d4a9d) Updates `github/codeql-action` from 4.31.5 to 4.31.6 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/github/codeql-action/compare/fdbfb4d2750291e159f0156def62b853c2798ca2...fe4161a26a8629af62121b670040955b330f9af2) --- updated-dependencies: - dependency-name: actions/setup-python dependency-version: 6.1.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: docker/metadata-action dependency-version: 5.10.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: oxsecurity/megalinter dependency-version: 9.2.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: github/codeql-action dependency-version: 4.31.6 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- .github/workflows/benchmarks.yml | 2 +- .github/workflows/build-ci-image.yml | 4 ++-- .github/workflows/deploy.yml | 2 +- .github/workflows/mega-linter.yml | 2 +- .github/workflows/tests.yml | 4 ++-- .github/workflows/trivy.yml | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/benchmarks.yml b/.github/workflows/benchmarks.yml index 77e0537925..d66254bd9e 100644 --- a/.github/workflows/benchmarks.yml +++ b/.github/workflows/benchmarks.yml @@ -42,7 +42,7 @@ jobs: with: fetch-depth: 0 - - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # 6.0.0 + - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # 6.1.0 with: python-version: "${{ matrix.python }}" diff --git a/.github/workflows/build-ci-image.yml b/.github/workflows/build-ci-image.yml index dd3833d79c..ee867679ae 100644 --- a/.github/workflows/build-ci-image.yml +++ b/.github/workflows/build-ci-image.yml @@ -60,7 +60,7 @@ jobs: - name: Generate Docker Metadata (Tags and Labels) id: meta - uses: docker/metadata-action@318604b99e75e41977312d83839a89be02ca4893 # 5.9.0 + uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # 5.10.0 with: images: ghcr.io/${{ steps.image-name.outputs.IMAGE_NAME }} flavor: | @@ -139,7 +139,7 @@ jobs: - name: Generate Docker Metadata (Tags and Labels) id: meta - uses: docker/metadata-action@318604b99e75e41977312d83839a89be02ca4893 # 5.9.0 + uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051 # 5.10.0 with: images: ghcr.io/${{ steps.image-name.outputs.IMAGE_NAME }} flavor: | diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index a91dae3061..c82c1d0654 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -114,7 +114,7 @@ jobs: persist-credentials: false fetch-depth: 0 - - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # 6.0.0 + - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # 6.1.0 with: python-version: "3.13" diff --git a/.github/workflows/mega-linter.yml b/.github/workflows/mega-linter.yml index 99b010c0d6..76f6ea74b4 100644 --- a/.github/workflows/mega-linter.yml +++ b/.github/workflows/mega-linter.yml @@ -53,7 +53,7 @@ jobs: # MegaLinter - name: MegaLinter id: ml - uses: oxsecurity/megalinter/flavors/python@62c799d895af9bcbca5eacfebca29d527f125a57 # 9.1.0 + uses: oxsecurity/megalinter/flavors/python@55a59b24a441e0e1943080d4a512d827710d4a9d # 9.2.0 env: # All available variables are described in documentation # https://megalinter.io/latest/configuration/ diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 70bdc8c6c5..fcb9289971 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -94,7 +94,7 @@ jobs: steps: - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # 6.0.0 + - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # 6.1.0 with: python-version: "3.13" architecture: x64 @@ -128,7 +128,7 @@ jobs: steps: - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 - - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # 6.0.0 + - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # 6.1.0 with: python-version: "3.13" architecture: x64 diff --git a/.github/workflows/trivy.yml b/.github/workflows/trivy.yml index 614ec8903e..a485674e55 100644 --- a/.github/workflows/trivy.yml +++ b/.github/workflows/trivy.yml @@ -61,6 +61,6 @@ jobs: - name: Upload Trivy scan results to GitHub Security tab if: ${{ github.event_name == 'schedule' }} - uses: github/codeql-action/upload-sarif@fdbfb4d2750291e159f0156def62b853c2798ca2 # 4.31.5 + uses: github/codeql-action/upload-sarif@fe4161a26a8629af62121b670040955b330f9af2 # 4.31.6 with: sarif_file: "trivy-results.sarif" From 748bd5b60fd46412e313b2a721eeb737ee0b2405 Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Fri, 5 Dec 2025 09:14:46 -0800 Subject: [PATCH 019/124] Strands MultiAgent Instrumentation (#1590) * Rename strands instrument functions * Add instrumentation for strands multiagent * Reorganize strands tests * Strands multiagent tests * Remove timestamp from test expected events. --------- Co-authored-by: Uma Annamalai --- newrelic/config.py | 22 +- newrelic/hooks/mlmodel_strands.py | 24 +- tests/mlmodel_strands/__init__.py | 13 + tests/mlmodel_strands/_test_agent.py | 165 +++++++++++ .../mlmodel_strands/_test_multiagent_graph.py | 91 ++++++ .../mlmodel_strands/_test_multiagent_swarm.py | 108 ++++++++ tests/mlmodel_strands/conftest.py | 132 --------- tests/mlmodel_strands/test_agent.py | 46 ++-- .../mlmodel_strands/test_multiagent_graph.py | 233 ++++++++++++++++ .../mlmodel_strands/test_multiagent_swarm.py | 260 ++++++++++++++++++ 10 files changed, 928 insertions(+), 166 deletions(-) create mode 100644 tests/mlmodel_strands/__init__.py create mode 100644 tests/mlmodel_strands/_test_agent.py create mode 100644 tests/mlmodel_strands/_test_multiagent_graph.py create mode 100644 tests/mlmodel_strands/_test_multiagent_swarm.py create mode 100644 tests/mlmodel_strands/test_multiagent_graph.py create mode 100644 tests/mlmodel_strands/test_multiagent_swarm.py diff --git a/newrelic/config.py b/newrelic/config.py index 94955293d5..4b8627772d 100644 --- a/newrelic/config.py +++ b/newrelic/config.py @@ -2948,12 +2948,26 @@ def _process_module_builtin_defaults(): "newrelic.hooks.mlmodel_autogen", "instrument_autogen_agentchat_agents__assistant_agent", ) - _process_module_definition("strands.agent.agent", "newrelic.hooks.mlmodel_strands", "instrument_agent_agent") _process_module_definition( - "strands.tools.executors._executor", "newrelic.hooks.mlmodel_strands", "instrument_tools_executors__executor" + "strands.agent.agent", "newrelic.hooks.mlmodel_strands", "instrument_strands_agent_agent" + ) + _process_module_definition( + "strands.multiagent.graph", "newrelic.hooks.mlmodel_strands", "instrument_strands_multiagent_graph" + ) + _process_module_definition( + "strands.multiagent.swarm", "newrelic.hooks.mlmodel_strands", "instrument_strands_multiagent_swarm" + ) + _process_module_definition( + "strands.tools.executors._executor", + "newrelic.hooks.mlmodel_strands", + "instrument_strands_tools_executors__executor", + ) + _process_module_definition( + "strands.tools.registry", "newrelic.hooks.mlmodel_strands", "instrument_strands_tools_registry" + ) + _process_module_definition( + "strands.models.bedrock", "newrelic.hooks.mlmodel_strands", "instrument_strands_models_bedrock" ) - _process_module_definition("strands.tools.registry", "newrelic.hooks.mlmodel_strands", "instrument_tools_registry") - _process_module_definition("strands.models.bedrock", "newrelic.hooks.mlmodel_strands", "instrument_models_bedrock") _process_module_definition("mcp.client.session", "newrelic.hooks.adapter_mcp", "instrument_mcp_client_session") _process_module_definition( diff --git a/newrelic/hooks/mlmodel_strands.py b/newrelic/hooks/mlmodel_strands.py index bf849fd717..20317626da 100644 --- a/newrelic/hooks/mlmodel_strands.py +++ b/newrelic/hooks/mlmodel_strands.py @@ -461,7 +461,7 @@ def wrap_bedrock_model__stream(wrapped, instance, args, kwargs): return wrapped(*args, **kwargs) -def instrument_agent_agent(module): +def instrument_strands_agent_agent(module): if hasattr(module, "Agent"): if hasattr(module.Agent, "__call__"): # noqa: B004 wrap_function_wrapper(module, "Agent.__call__", wrap_agent__call__) @@ -471,19 +471,35 @@ def instrument_agent_agent(module): wrap_function_wrapper(module, "Agent.stream_async", wrap_stream_async) -def instrument_tools_executors__executor(module): +def instrument_strands_multiagent_graph(module): + if hasattr(module, "Graph"): + if hasattr(module.Graph, "__call__"): # noqa: B004 + wrap_function_wrapper(module, "Graph.__call__", wrap_agent__call__) + if hasattr(module.Graph, "invoke_async"): + wrap_function_wrapper(module, "Graph.invoke_async", wrap_agent_invoke_async) + + +def instrument_strands_multiagent_swarm(module): + if hasattr(module, "Swarm"): + if hasattr(module.Swarm, "__call__"): # noqa: B004 + wrap_function_wrapper(module, "Swarm.__call__", wrap_agent__call__) + if hasattr(module.Swarm, "invoke_async"): + wrap_function_wrapper(module, "Swarm.invoke_async", wrap_agent_invoke_async) + + +def instrument_strands_tools_executors__executor(module): if hasattr(module, "ToolExecutor"): if hasattr(module.ToolExecutor, "_stream"): wrap_function_wrapper(module, "ToolExecutor._stream", wrap_tool_executor__stream) -def instrument_tools_registry(module): +def instrument_strands_tools_registry(module): if hasattr(module, "ToolRegistry"): if hasattr(module.ToolRegistry, "register_tool"): wrap_function_wrapper(module, "ToolRegistry.register_tool", wrap_ToolRegister_register_tool) -def instrument_models_bedrock(module): +def instrument_strands_models_bedrock(module): # This instrumentation only exists to pass trace context due to bedrock models using a separate thread. if hasattr(module, "BedrockModel"): if hasattr(module.BedrockModel, "stream"): diff --git a/tests/mlmodel_strands/__init__.py b/tests/mlmodel_strands/__init__.py new file mode 100644 index 0000000000..8030baccf7 --- /dev/null +++ b/tests/mlmodel_strands/__init__.py @@ -0,0 +1,13 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. diff --git a/tests/mlmodel_strands/_test_agent.py b/tests/mlmodel_strands/_test_agent.py new file mode 100644 index 0000000000..15aa79a5ac --- /dev/null +++ b/tests/mlmodel_strands/_test_agent.py @@ -0,0 +1,165 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from strands import tool + +from ._mock_model_provider import MockedModelProvider + + +# Example tool for testing purposes +@tool +async def add_exclamation(message: str) -> str: + return f"{message}!" + + +@tool +async def throw_exception_coro(message: str) -> str: + raise RuntimeError("Oops") + + +@tool +async def throw_exception_agen(message: str) -> str: + raise RuntimeError("Oops") + yield + + +@pytest.fixture +def single_tool_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def single_tool_model_runtime_error_coro(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling throw_exception_coro tool"}, + # Set arguments to an invalid type to trigger error in tool + {"toolUse": {"name": "throw_exception_coro", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def single_tool_model_runtime_error_agen(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling throw_exception_agen tool"}, + # Set arguments to an invalid type to trigger error in tool + {"toolUse": {"name": "throw_exception_agen", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def multi_tool_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 5, "b": 3}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Goodbye"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 123, "b": 2}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def multi_tool_model_error(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 5, "b": 3}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Goodbye"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + # Set insufficient arguments to trigger error in tool + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 123}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model diff --git a/tests/mlmodel_strands/_test_multiagent_graph.py b/tests/mlmodel_strands/_test_multiagent_graph.py new file mode 100644 index 0000000000..73c1679701 --- /dev/null +++ b/tests/mlmodel_strands/_test_multiagent_graph.py @@ -0,0 +1,91 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from strands import Agent, tool +from strands.multiagent.graph import GraphBuilder + +from ._mock_model_provider import MockedModelProvider + + +@pytest.fixture +def math_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "I'll calculate the sum of 15 and 27 for you."}, + {"toolUse": {"name": "calculate_sum", "toolUseId": "123", "input": {"a": 15, "b": 27}}}, + ], + }, + {"role": "assistant", "content": [{"text": "The sum of 15 and 27 is 42."}]}, + ] + ) + return model + + +@pytest.fixture +def analysis_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "I'll validate the calculation result of 42 from the calculator."}, + {"toolUse": {"name": "analyze_result", "toolUseId": "456", "input": {"value": 42}}}, + ], + }, + { + "role": "assistant", + "content": [{"text": "The calculation is correct, and 42 is a positive integer result."}], + }, + ] + ) + return model + + +# Example tool for testing purposes +@tool +async def calculate_sum(a: int, b: int) -> int: + """Calculate the sum of two numbers.""" + return a + b + + +@tool +async def analyze_result(value: int) -> str: + """Analyze a numeric result.""" + return f"The result {value} is {'positive' if value > 0 else 'zero or negative'}" + + +@pytest.fixture +def math_agent(math_model): + return Agent(name="math_agent", model=math_model, tools=[calculate_sum]) + + +@pytest.fixture +def analysis_agent(analysis_model): + return Agent(name="analysis_agent", model=analysis_model, tools=[analyze_result]) + + +@pytest.fixture +def agent_graph(math_agent, analysis_agent): + # Build graph + builder = GraphBuilder() + builder.add_node(math_agent, "math") + builder.add_node(analysis_agent, "analysis") + builder.add_edge("math", "analysis") + builder.set_entry_point("math") + + return builder.build() diff --git a/tests/mlmodel_strands/_test_multiagent_swarm.py b/tests/mlmodel_strands/_test_multiagent_swarm.py new file mode 100644 index 0000000000..4b7916c27b --- /dev/null +++ b/tests/mlmodel_strands/_test_multiagent_swarm.py @@ -0,0 +1,108 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from strands import Agent, tool +from strands.multiagent.swarm import Swarm + +from ._mock_model_provider import MockedModelProvider + + +@pytest.fixture +def math_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "I'll calculate the sum of 15 and 27 for you."}, + {"toolUse": {"name": "calculate_sum", "toolUseId": "123", "input": {"a": 15, "b": 27}}}, + ], + }, + { + "role": "assistant", + "content": [ + { + "toolUse": { + "name": "handoff_to_agent", + "toolUseId": "789", + "input": { + "agent_name": "analysis_agent", + "message": "Analyze the result of the calculation done by the math_agent.", + "context": {"result": 42}, + }, + } + } + ], + }, + {"role": "assistant", "content": [{"text": "The sum of 15 and 27 is 42."}]}, + ] + ) + return model + + +@pytest.fixture +def analysis_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "I'll validate the calculation result of 42 from the calculator."}, + {"toolUse": {"name": "analyze_result", "toolUseId": "456", "input": {"value": 42}}}, + ], + }, + { + "role": "assistant", + "content": [{"text": "The calculation is correct, and 42 is a positive integer result."}], + }, + ] + ) + return model + + +# Example tool for testing purposes +@tool +async def calculate_sum(a: int, b: int) -> int: + """Calculate the sum of two numbers.""" + return a + b + + +@tool +async def analyze_result(value: int) -> str: + """Analyze a numeric result.""" + return f"The result {value} is {'positive' if value > 0 else 'zero or negative'}" + + +@pytest.fixture +def math_agent(math_model): + return Agent(name="math_agent", model=math_model, tools=[calculate_sum]) + + +@pytest.fixture +def analysis_agent(analysis_model): + return Agent(name="analysis_agent", model=analysis_model, tools=[analyze_result]) + + +@pytest.fixture +def agent_swarm(math_agent, analysis_agent): + # Build graph with conditional edge + return Swarm( + [math_agent, analysis_agent], + entry_point=math_agent, + execution_timeout=60, + node_timeout=30, + max_handoffs=5, + max_iterations=5, + ) diff --git a/tests/mlmodel_strands/conftest.py b/tests/mlmodel_strands/conftest.py index a2ad9b8dd0..abbc29b969 100644 --- a/tests/mlmodel_strands/conftest.py +++ b/tests/mlmodel_strands/conftest.py @@ -12,8 +12,6 @@ # See the License for the specific language governing permissions and # limitations under the License. -import pytest -from _mock_model_provider import MockedModelProvider from testing_support.fixture.event_loop import event_loop as loop from testing_support.fixtures import collector_agent_registration_fixture, collector_available_fixture from testing_support.ml_testing_utils import set_trace_info @@ -31,133 +29,3 @@ collector_agent_registration = collector_agent_registration_fixture( app_name="Python Agent Test (mlmodel_strands)", default_settings=_default_settings ) - - -@pytest.fixture -def single_tool_model(): - model = MockedModelProvider( - [ - { - "role": "assistant", - "content": [ - {"text": "Calling add_exclamation tool"}, - {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, - ], - }, - {"role": "assistant", "content": [{"text": "Success!"}]}, - ] - ) - return model - - -@pytest.fixture -def single_tool_model_runtime_error_coro(): - model = MockedModelProvider( - [ - { - "role": "assistant", - "content": [ - {"text": "Calling throw_exception_coro tool"}, - # Set arguments to an invalid type to trigger error in tool - {"toolUse": {"name": "throw_exception_coro", "toolUseId": "123", "input": {"message": "Hello"}}}, - ], - }, - {"role": "assistant", "content": [{"text": "Success!"}]}, - ] - ) - return model - - -@pytest.fixture -def single_tool_model_runtime_error_agen(): - model = MockedModelProvider( - [ - { - "role": "assistant", - "content": [ - {"text": "Calling throw_exception_agen tool"}, - # Set arguments to an invalid type to trigger error in tool - {"toolUse": {"name": "throw_exception_agen", "toolUseId": "123", "input": {"message": "Hello"}}}, - ], - }, - {"role": "assistant", "content": [{"text": "Success!"}]}, - ] - ) - return model - - -@pytest.fixture -def multi_tool_model(): - model = MockedModelProvider( - [ - { - "role": "assistant", - "content": [ - {"text": "Calling add_exclamation tool"}, - {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, - ], - }, - { - "role": "assistant", - "content": [ - {"text": "Calling compute_sum tool"}, - {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 5, "b": 3}}}, - ], - }, - { - "role": "assistant", - "content": [ - {"text": "Calling add_exclamation tool"}, - {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Goodbye"}}}, - ], - }, - { - "role": "assistant", - "content": [ - {"text": "Calling compute_sum tool"}, - {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 123, "b": 2}}}, - ], - }, - {"role": "assistant", "content": [{"text": "Success!"}]}, - ] - ) - return model - - -@pytest.fixture -def multi_tool_model_error(): - model = MockedModelProvider( - [ - { - "role": "assistant", - "content": [ - {"text": "Calling add_exclamation tool"}, - {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, - ], - }, - { - "role": "assistant", - "content": [ - {"text": "Calling compute_sum tool"}, - {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 5, "b": 3}}}, - ], - }, - { - "role": "assistant", - "content": [ - {"text": "Calling add_exclamation tool"}, - {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Goodbye"}}}, - ], - }, - { - "role": "assistant", - "content": [ - {"text": "Calling compute_sum tool"}, - # Set insufficient arguments to trigger error in tool - {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 123}}}, - ], - }, - {"role": "assistant", "content": [{"text": "Success!"}]}, - ] - ) - return model diff --git a/tests/mlmodel_strands/test_agent.py b/tests/mlmodel_strands/test_agent.py index af685668ad..6fa5e56a68 100644 --- a/tests/mlmodel_strands/test_agent.py +++ b/tests/mlmodel_strands/test_agent.py @@ -13,7 +13,7 @@ # limitations under the License. import pytest -from strands import Agent, tool +from strands import Agent from testing_support.fixtures import reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( disabled_ai_monitoring_record_content_settings, @@ -32,6 +32,17 @@ from newrelic.common.object_names import callable_name from newrelic.common.object_wrapper import transient_function_wrapper +from ._test_agent import ( + add_exclamation, + multi_tool_model, + multi_tool_model_error, + single_tool_model, + single_tool_model_runtime_error_agen, + single_tool_model_runtime_error_coro, + throw_exception_agen, + throw_exception_coro, +) + tool_recorded_event = [ ( {"type": "LlmTool"}, @@ -144,29 +155,12 @@ ] -# Example tool for testing purposes -@tool -async def add_exclamation(message: str) -> str: - return f"{message}!" - - -@tool -async def throw_exception_coro(message: str) -> str: - raise RuntimeError("Oops") - - -@tool -async def throw_exception_agen(message: str) -> str: - raise RuntimeError("Oops") - yield - - @reset_core_stats_engine() @validate_custom_events(events_with_context_attrs(tool_recorded_event)) @validate_custom_events(events_with_context_attrs(agent_recorded_event)) @validate_custom_event_count(count=2) @validate_transaction_metrics( - "test_agent:test_agent_invoke", + "mlmodel_strands.test_agent:test_agent_invoke", scoped_metrics=[ ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), @@ -194,7 +188,7 @@ def test_agent_invoke(set_trace_info, single_tool_model): @validate_custom_events(agent_recorded_event) @validate_custom_event_count(count=2) @validate_transaction_metrics( - "test_agent:test_agent_invoke_async", + "mlmodel_strands.test_agent:test_agent_invoke_async", scoped_metrics=[ ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), @@ -224,7 +218,7 @@ async def _test(): @validate_custom_events(agent_recorded_event) @validate_custom_event_count(count=2) @validate_transaction_metrics( - "test_agent:test_agent_stream_async", + "mlmodel_strands.test_agent:test_agent_stream_async", scoped_metrics=[ ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), @@ -260,7 +254,7 @@ async def _test(): @validate_custom_events(tool_events_sans_content(tool_recorded_event)) @validate_custom_event_count(count=2) @validate_transaction_metrics( - "test_agent:test_agent_invoke_no_content", + "mlmodel_strands.test_agent:test_agent_invoke_no_content", scoped_metrics=[ ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), @@ -301,7 +295,7 @@ def test_agent_invoke_disabled_ai_monitoring_events(set_trace_info, single_tool_ @validate_custom_events(agent_recorded_event_error) @validate_custom_event_count(count=1) @validate_transaction_metrics( - "test_agent:test_agent_invoke_error", + "mlmodel_strands.test_agent:test_agent_invoke_error", scoped_metrics=[("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1)], rollup_metrics=[("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1)], background_task=True, @@ -330,7 +324,7 @@ def _test(): @validate_custom_events(tool_recorded_event_error_coro) @validate_custom_event_count(count=2) @validate_transaction_metrics( - "test_agent:test_agent_invoke_tool_coro_runtime_error", + "mlmodel_strands.test_agent:test_agent_invoke_tool_coro_runtime_error", scoped_metrics=[ ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/throw_exception_coro", 1), @@ -358,7 +352,7 @@ def test_agent_invoke_tool_coro_runtime_error(set_trace_info, single_tool_model_ @validate_custom_events(tool_recorded_event_error_agen) @validate_custom_event_count(count=2) @validate_transaction_metrics( - "test_agent:test_agent_invoke_tool_agen_runtime_error", + "mlmodel_strands.test_agent:test_agent_invoke_tool_agen_runtime_error", scoped_metrics=[ ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/throw_exception_agen", 1), @@ -387,7 +381,7 @@ def test_agent_invoke_tool_agen_runtime_error(set_trace_info, single_tool_model_ @validate_custom_events(tool_recorded_event_forced_internal_error) @validate_custom_event_count(count=2) @validate_transaction_metrics( - "test_agent:test_agent_tool_forced_exception", + "mlmodel_strands.test_agent:test_agent_tool_forced_exception", scoped_metrics=[ ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), diff --git a/tests/mlmodel_strands/test_multiagent_graph.py b/tests/mlmodel_strands/test_multiagent_graph.py new file mode 100644 index 0000000000..7bd84fc901 --- /dev/null +++ b/tests/mlmodel_strands/test_multiagent_graph.py @@ -0,0 +1,233 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from testing_support.fixtures import reset_core_stats_engine, validate_attributes +from testing_support.ml_testing_utils import disabled_ai_monitoring_settings, events_with_context_attrs +from testing_support.validators.validate_custom_event import validate_custom_event_count +from testing_support.validators.validate_custom_events import validate_custom_events +from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics + +from newrelic.api.background_task import background_task +from newrelic.api.llm_custom_attributes import WithLlmCustomAttributes + +from ._test_multiagent_graph import agent_graph, analysis_agent, analysis_model, math_agent, math_model + +agent_recorded_events = [ + [ + {"type": "LlmAgent"}, + { + "duration": None, + "id": None, + "ingest_source": "Python", + "name": "math_agent", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + }, + ], + [ + {"type": "LlmAgent"}, + { + "duration": None, + "id": None, + "ingest_source": "Python", + "name": "analysis_agent", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + }, + ], +] + +tool_recorded_events = [ + [ + {"type": "LlmTool"}, + { + "agent_name": "math_agent", + "duration": None, + "id": None, + "ingest_source": "Python", + "input": "{'a': 15, 'b': 27}", + "name": "calculate_sum", + "output": "{'text': '42'}", + "run_id": "123", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + }, + ], + [ + {"type": "LlmTool"}, + { + "agent_name": "analysis_agent", + "duration": None, + "id": None, + "ingest_source": "Python", + "input": "{'value': 42}", + "name": "analyze_result", + "output": "{'text': 'The result 42 is positive'}", + "run_id": "456", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + }, + ], +] + + +@reset_core_stats_engine() +@validate_custom_events(events_with_context_attrs(tool_recorded_events)) +@validate_custom_events(events_with_context_attrs(agent_recorded_events)) +@validate_custom_event_count(count=4) # 2 LlmTool events, 2 LlmAgent events +@validate_transaction_metrics( + "mlmodel_strands.test_multiagent_graph:test_multiagent_graph_invoke", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_multiagent_graph_invoke(set_trace_info, agent_graph): + set_trace_info() + + with WithLlmCustomAttributes({"context": "attr"}): + response = agent_graph("Calculate the sum of 15 and 27.") + + assert response.execution_count == 2 + assert not response.failed_nodes + assert response.results["math"].result.message["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert ( + response.results["analysis"].result.message["content"][0]["text"] + == "The calculation is correct, and 42 is a positive integer result." + ) + + +@reset_core_stats_engine() +@validate_custom_events(tool_recorded_events) +@validate_custom_events(agent_recorded_events) +@validate_custom_event_count(count=4) # 2 LlmTool events, 2 LlmAgent events +@validate_transaction_metrics( + "mlmodel_strands.test_multiagent_graph:test_multiagent_graph_invoke_async", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_multiagent_graph_invoke_async(loop, set_trace_info, agent_graph): + set_trace_info() + + async def _test(): + response = await agent_graph.invoke_async("Calculate the sum of 15 and 27.") + + assert response.execution_count == 2 + assert not response.failed_nodes + assert response.results["math"].result.message["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert ( + response.results["analysis"].result.message["content"][0]["text"] + == "The calculation is correct, and 42 is a positive integer result." + ) + + loop.run_until_complete(_test()) + + +@reset_core_stats_engine() +@validate_custom_events(tool_recorded_events) +@validate_custom_events(agent_recorded_events) +@validate_custom_event_count(count=4) # 2 LlmTool events, 2 LlmAgent events +@validate_transaction_metrics( + "mlmodel_strands.test_multiagent_graph:test_multiagent_graph_stream_async", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_multiagent_graph_stream_async(loop, set_trace_info, agent_graph): + set_trace_info() + + async def _test(): + response = agent_graph.stream_async("Calculate the sum of 15 and 27.") + messages = [ + event["node_result"].result.message async for event in response if event["type"] == "multiagent_node_stop" + ] + + assert len(messages) == 2 + + assert messages[0]["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert messages[1]["content"][0]["text"] == "The calculation is correct, and 42 is a positive integer result." + + loop.run_until_complete(_test()) + + +@disabled_ai_monitoring_settings +@reset_core_stats_engine() +@validate_custom_event_count(count=0) +@background_task() +def test_multiagent_graph_invoke_disabled_ai_monitoring_events(set_trace_info, agent_graph): + set_trace_info() + + response = agent_graph("Calculate the sum of 15 and 27.") + + assert response.execution_count == 2 + assert not response.failed_nodes + assert response.results["math"].result.message["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert ( + response.results["analysis"].result.message["content"][0]["text"] + == "The calculation is correct, and 42 is a positive integer result." + ) + + +@reset_core_stats_engine() +@validate_custom_event_count(count=0) +def test_multiagent_graph_invoke_outside_txn(agent_graph): + response = agent_graph("Calculate the sum of 15 and 27.") + + assert response.execution_count == 2 + assert not response.failed_nodes + assert response.results["math"].result.message["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert ( + response.results["analysis"].result.message["content"][0]["text"] + == "The calculation is correct, and 42 is a positive integer result." + ) diff --git a/tests/mlmodel_strands/test_multiagent_swarm.py b/tests/mlmodel_strands/test_multiagent_swarm.py new file mode 100644 index 0000000000..bbcbb3e27c --- /dev/null +++ b/tests/mlmodel_strands/test_multiagent_swarm.py @@ -0,0 +1,260 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from testing_support.fixtures import reset_core_stats_engine, validate_attributes +from testing_support.ml_testing_utils import disabled_ai_monitoring_settings, events_with_context_attrs +from testing_support.validators.validate_custom_event import validate_custom_event_count +from testing_support.validators.validate_custom_events import validate_custom_events +from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics + +from newrelic.api.background_task import background_task +from newrelic.api.llm_custom_attributes import WithLlmCustomAttributes + +from ._test_multiagent_swarm import agent_swarm, analysis_agent, analysis_model, math_agent, math_model + +agent_recorded_events = [ + [ + {"type": "LlmAgent"}, + { + "duration": None, + "id": None, + "ingest_source": "Python", + "name": "math_agent", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + }, + ], + [ + {"type": "LlmAgent"}, + { + "duration": None, + "id": None, + "ingest_source": "Python", + "name": "analysis_agent", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + }, + ], +] + +tool_recorded_events = [ + [ + {"type": "LlmTool"}, + { + "agent_name": "math_agent", + "duration": None, + "id": None, + "ingest_source": "Python", + "input": "{'a': 15, 'b': 27}", + "name": "calculate_sum", + "output": "{'text': '42'}", + "run_id": "123", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + }, + ], + [ + {"type": "LlmTool"}, + { + "agent_name": "analysis_agent", + "duration": None, + "id": None, + "ingest_source": "Python", + "input": "{'value': 42}", + "name": "analyze_result", + "output": "{'text': 'The result 42 is positive'}", + "run_id": "456", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + }, + ], +] + +handoff_recorded_event = [ + [ + {"type": "LlmTool"}, + { + "agent_name": "math_agent", + "duration": None, + "id": None, + "ingest_source": "Python", + # This is the output from math_agent being sent to the handoff_to_agent tool, which will then be input to the analysis_agent + "input": "{'agent_name': 'analysis_agent', 'message': 'Analyze the result of the calculation done by the math_agent.', 'context': {'result': 42}}", + "name": "handoff_to_agent", + "output": "{'text': 'Handing off to analysis_agent: Analyze the result of the calculation done by the math_agent.'}", + "run_id": "789", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + }, + ] +] + + +@reset_core_stats_engine() +@validate_custom_events(events_with_context_attrs(tool_recorded_events)) +@validate_custom_events(events_with_context_attrs(agent_recorded_events)) +@validate_custom_events(events_with_context_attrs(handoff_recorded_event)) +@validate_custom_event_count(count=5) # 2 LlmTool events, 2 LlmAgent events, 1 LlmTool Handoff event +@validate_transaction_metrics( + "mlmodel_strands.test_multiagent_swarm:test_multiagent_swarm_invoke", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_multiagent_swarm_invoke(set_trace_info, agent_swarm): + set_trace_info() + + with WithLlmCustomAttributes({"context": "attr"}): + response = agent_swarm("Calculate the sum of 15 and 27.") + + assert response.execution_count == 2 + node_history = [node.node_id for node in response.node_history] + assert node_history == ["math_agent", "analysis_agent"] + assert response.results["math_agent"].result.message["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert ( + response.results["analysis_agent"].result.message["content"][0]["text"] + == "The calculation is correct, and 42 is a positive integer result." + ) + + +@reset_core_stats_engine() +@validate_custom_events(tool_recorded_events) +@validate_custom_events(agent_recorded_events) +@validate_custom_events(handoff_recorded_event) +@validate_custom_event_count(count=5) # 2 LlmTool events, 2 LlmAgent events, 1 LlmTool Handoff event +@validate_transaction_metrics( + "mlmodel_strands.test_multiagent_swarm:test_multiagent_swarm_invoke_async", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_multiagent_swarm_invoke_async(loop, set_trace_info, agent_swarm): + set_trace_info() + + async def _test(): + response = await agent_swarm.invoke_async("Calculate the sum of 15 and 27.") + + assert response.execution_count == 2 + node_history = [node.node_id for node in response.node_history] + assert node_history == ["math_agent", "analysis_agent"] + assert response.results["math_agent"].result.message["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert ( + response.results["analysis_agent"].result.message["content"][0]["text"] + == "The calculation is correct, and 42 is a positive integer result." + ) + + loop.run_until_complete(_test()) + + +@reset_core_stats_engine() +@validate_custom_events(tool_recorded_events) +@validate_custom_events(agent_recorded_events) +@validate_custom_events(handoff_recorded_event) +@validate_custom_event_count(count=5) # 2 LlmTool events, 2 LlmAgent events, 1 LlmTool Handoff event +@validate_transaction_metrics( + "mlmodel_strands.test_multiagent_swarm:test_multiagent_swarm_stream_async", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_multiagent_swarm_stream_async(loop, set_trace_info, agent_swarm): + set_trace_info() + + async def _test(): + response = agent_swarm.stream_async("Calculate the sum of 15 and 27.") + messages = [ + event["node_result"].result.message async for event in response if event["type"] == "multiagent_node_stop" + ] + + assert len(messages) == 2 + + assert messages[0]["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert messages[1]["content"][0]["text"] == "The calculation is correct, and 42 is a positive integer result." + + loop.run_until_complete(_test()) + + +@disabled_ai_monitoring_settings +@reset_core_stats_engine() +@validate_custom_event_count(count=0) +@background_task() +def test_multiagent_swarm_invoke_disabled_ai_monitoring_events(set_trace_info, agent_swarm): + set_trace_info() + + response = agent_swarm("Calculate the sum of 15 and 27.") + + assert response.execution_count == 2 + node_history = [node.node_id for node in response.node_history] + assert node_history == ["math_agent", "analysis_agent"] + assert response.results["math_agent"].result.message["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert ( + response.results["analysis_agent"].result.message["content"][0]["text"] + == "The calculation is correct, and 42 is a positive integer result." + ) + + +@reset_core_stats_engine() +@validate_custom_event_count(count=0) +def test_multiagent_swarm_invoke_outside_txn(agent_swarm): + response = agent_swarm("Calculate the sum of 15 and 27.") + + assert response.execution_count == 2 + node_history = [node.node_id for node in response.node_history] + assert node_history == ["math_agent", "analysis_agent"] + assert response.results["math_agent"].result.message["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert ( + response.results["analysis_agent"].result.message["content"][0]["text"] + == "The calculation is correct, and 42 is a positive integer result." + ) From dcadeb103f2db611ab58df24e5caba121c5296b8 Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Thu, 23 Oct 2025 14:32:16 -0700 Subject: [PATCH 020/124] Strands Mock Model (#1551) * Add strands to tox.ini * Add mock models for strands testing * Add simple test file to validate strands mocking --- tests/mlmodel_strands/_mock_model_provider.py | 99 ++++++++++++ tests/mlmodel_strands/conftest.py | 144 ++++++++++++++++++ tests/mlmodel_strands/test_simple.py | 36 +++++ tox.ini | 12 +- 4 files changed, 287 insertions(+), 4 deletions(-) create mode 100644 tests/mlmodel_strands/_mock_model_provider.py create mode 100644 tests/mlmodel_strands/conftest.py create mode 100644 tests/mlmodel_strands/test_simple.py diff --git a/tests/mlmodel_strands/_mock_model_provider.py b/tests/mlmodel_strands/_mock_model_provider.py new file mode 100644 index 0000000000..e4c9e79930 --- /dev/null +++ b/tests/mlmodel_strands/_mock_model_provider.py @@ -0,0 +1,99 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Test setup derived from: https://github.com/strands-agents/sdk-python/blob/main/tests/fixtures/mocked_model_provider.py +# strands Apache 2.0 license: https://github.com/strands-agents/sdk-python/blob/main/LICENSE + +import json +from typing import TypedDict + +from strands.models import Model + + +class RedactionMessage(TypedDict): + redactedUserContent: str + redactedAssistantContent: str + + +class MockedModelProvider(Model): + """A mock implementation of the Model interface for testing purposes. + + This class simulates a model provider by returning pre-defined agent responses + in sequence. It implements the Model interface methods and provides functionality + to stream mock responses as events. + """ + + def __init__(self, agent_responses): + self.agent_responses = agent_responses + self.index = 0 + + def format_chunk(self, event): + return event + + def format_request(self, messages, tool_specs=None, system_prompt=None): + return None + + def get_config(self): + pass + + def update_config(self, **model_config): + pass + + async def structured_output(self, output_model, prompt, system_prompt=None, **kwargs): + pass + + async def stream(self, messages, tool_specs=None, system_prompt=None): + events = self.map_agent_message_to_events(self.agent_responses[self.index]) + for event in events: + yield event + + self.index += 1 + + def map_agent_message_to_events(self, agent_message): + stop_reason = "end_turn" + yield {"messageStart": {"role": "assistant"}} + if agent_message.get("redactedAssistantContent"): + yield {"redactContent": {"redactUserContentMessage": agent_message["redactedUserContent"]}} + yield {"contentBlockStart": {"start": {}}} + yield {"contentBlockDelta": {"delta": {"text": agent_message["redactedAssistantContent"]}}} + yield {"contentBlockStop": {}} + stop_reason = "guardrail_intervened" + else: + for content in agent_message["content"]: + if "reasoningContent" in content: + yield {"contentBlockStart": {"start": {}}} + yield {"contentBlockDelta": {"delta": {"reasoningContent": content["reasoningContent"]}}} + yield {"contentBlockStop": {}} + if "text" in content: + yield {"contentBlockStart": {"start": {}}} + yield {"contentBlockDelta": {"delta": {"text": content["text"]}}} + yield {"contentBlockStop": {}} + if "toolUse" in content: + stop_reason = "tool_use" + yield { + "contentBlockStart": { + "start": { + "toolUse": { + "name": content["toolUse"]["name"], + "toolUseId": content["toolUse"]["toolUseId"], + } + } + } + } + yield { + "contentBlockDelta": {"delta": {"toolUse": {"input": json.dumps(content["toolUse"]["input"])}}} + } + yield {"contentBlockStop": {}} + + yield {"messageStop": {"stopReason": stop_reason}} diff --git a/tests/mlmodel_strands/conftest.py b/tests/mlmodel_strands/conftest.py new file mode 100644 index 0000000000..b810161f6a --- /dev/null +++ b/tests/mlmodel_strands/conftest.py @@ -0,0 +1,144 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from _mock_model_provider import MockedModelProvider +from testing_support.fixtures import collector_agent_registration_fixture, collector_available_fixture +from testing_support.ml_testing_utils import set_trace_info + +_default_settings = { + "package_reporting.enabled": False, # Turn off package reporting for testing as it causes slowdowns. + "transaction_tracer.explain_threshold": 0.0, + "transaction_tracer.transaction_threshold": 0.0, + "transaction_tracer.stack_trace_threshold": 0.0, + "debug.log_data_collector_payloads": True, + "debug.record_transaction_failure": True, + "ai_monitoring.enabled": True, +} + +collector_agent_registration = collector_agent_registration_fixture( + app_name="Python Agent Test (mlmodel_strands)", default_settings=_default_settings +) + + +@pytest.fixture +def single_tool_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def single_tool_model_error(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + # Set arguments to an invalid type to trigger error in tool + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": 12}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def multi_tool_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 5, "b": 3}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Goodbye"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 123, "b": 2}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def multi_tool_model_error(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 5, "b": 3}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Goodbye"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + # Set insufficient arguments to trigger error in tool + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 123}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model diff --git a/tests/mlmodel_strands/test_simple.py b/tests/mlmodel_strands/test_simple.py new file mode 100644 index 0000000000..ae24003fab --- /dev/null +++ b/tests/mlmodel_strands/test_simple.py @@ -0,0 +1,36 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from strands import Agent, tool + +from newrelic.api.background_task import background_task + + +# Example tool for testing purposes +@tool +def add_exclamation(message: str) -> str: + return f"{message}!" + + +# TODO: Remove this file once all real tests are in place + + +@background_task() +def test_simple_run_agent(set_trace_info, single_tool_model): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + response = my_agent("Run the tools.") + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 diff --git a/tox.ini b/tox.ini index 98cea6ee29..24bdb095e6 100644 --- a/tox.ini +++ b/tox.ini @@ -183,6 +183,7 @@ envlist = python-logger_structlog-{py38,py39,py310,py311,py312,py313,py314,pypy311}-structloglatest, python-mlmodel_autogen-{py310,py311,py312,py313,py314,pypy311}-autogen061, python-mlmodel_autogen-{py310,py311,py312,py313,py314,pypy311}-autogenlatest, + python-mlmodel_strands-{py310,py311,py312,py313}-strandslatest, python-mlmodel_gemini-{py39,py310,py311,py312,py313,py314}, python-mlmodel_langchain-{py39,py310,py311,py312,py313}, ;; Package not ready for Python 3.14 (type annotations not updated) @@ -443,6 +444,8 @@ deps = mlmodel_langchain: faiss-cpu mlmodel_langchain: mock mlmodel_langchain: asyncio + mlmodel_strands: strands-agents[openai] + mlmodel_strands: strands-agents-tools logger_loguru-logurulatest: loguru logger_structlog-structloglatest: structlog messagebroker_pika-pikalatest: pika @@ -513,6 +516,7 @@ changedir = application_celery: tests/application_celery component_djangorestframework: tests/component_djangorestframework component_flask_rest: tests/component_flask_rest + component_graphenedjango: tests/component_graphenedjango component_graphqlserver: tests/component_graphqlserver component_tastypie: tests/component_tastypie coroutines_asyncio: tests/coroutines_asyncio @@ -524,17 +528,17 @@ changedir = datastore_cassandradriver: tests/datastore_cassandradriver datastore_elasticsearch: tests/datastore_elasticsearch datastore_firestore: tests/datastore_firestore - datastore_oracledb: tests/datastore_oracledb datastore_memcache: tests/datastore_memcache + datastore_motor: tests/datastore_motor datastore_mysql: tests/datastore_mysql datastore_mysqldb: tests/datastore_mysqldb + datastore_oracledb: tests/datastore_oracledb datastore_postgresql: tests/datastore_postgresql datastore_psycopg: tests/datastore_psycopg datastore_psycopg2: tests/datastore_psycopg2 datastore_psycopg2cffi: tests/datastore_psycopg2cffi datastore_pylibmc: tests/datastore_pylibmc datastore_pymemcache: tests/datastore_pymemcache - datastore_motor: tests/datastore_motor datastore_pymongo: tests/datastore_pymongo datastore_pymssql: tests/datastore_pymssql datastore_pymysql: tests/datastore_pymysql @@ -542,8 +546,8 @@ changedir = datastore_pysolr: tests/datastore_pysolr datastore_redis: tests/datastore_redis datastore_rediscluster: tests/datastore_rediscluster - datastore_valkey: tests/datastore_valkey datastore_sqlite: tests/datastore_sqlite + datastore_valkey: tests/datastore_valkey external_aiobotocore: tests/external_aiobotocore external_botocore: tests/external_botocore external_feedparser: tests/external_feedparser @@ -564,7 +568,6 @@ changedir = framework_fastapi: tests/framework_fastapi framework_flask: tests/framework_flask framework_graphene: tests/framework_graphene - component_graphenedjango: tests/component_graphenedjango framework_graphql: tests/framework_graphql framework_grpc: tests/framework_grpc framework_pyramid: tests/framework_pyramid @@ -584,6 +587,7 @@ changedir = mlmodel_langchain: tests/mlmodel_langchain mlmodel_openai: tests/mlmodel_openai mlmodel_sklearn: tests/mlmodel_sklearn + mlmodel_strands: tests/mlmodel_strands template_genshi: tests/template_genshi template_jinja2: tests/template_jinja2 template_mako: tests/template_mako From e1a82c6193188e42c0e6a5fafcd6013d55c0de66 Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Thu, 13 Nov 2025 14:54:05 -0800 Subject: [PATCH 021/124] Add Strands tools and agents instrumentation. (#1563) * Add baseline instrumentation. * Add tool and agent instrumentation. * Add tests file. * Cleanup instrumentation. * Cleanup. Co-authored-by: Tim Pansino * [MegaLinter] Apply linters fixes * Strands Mock Model (#1551) * Add strands to tox.ini * Add mock models for strands testing * Add simple test file to validate strands mocking * Add baseline instrumentation. * Add tool and agent instrumentation. * Add tests file. * Cleanup instrumentation. * Cleanup. Co-authored-by: Tim Pansino * Handle additional args in mock model. * Add test to force exception and exercise _handle_tool_streaming_completion_error. * Strands Mock Model (#1551) * Add strands to tox.ini * Add mock models for strands testing * Add simple test file to validate strands mocking * Add baseline instrumentation. * Add tool and agent instrumentation. * Add tests file. * Cleanup instrumentation. * Cleanup. Co-authored-by: Tim Pansino * Handle additional args in mock model. * Strands Mock Model (#1551) * Add strands to tox.ini * Add mock models for strands testing * Add simple test file to validate strands mocking * Add baseline instrumentation. * Add tool and agent instrumentation. * Cleanup. Co-authored-by: Tim Pansino * [MegaLinter] Apply linters fixes * Add test to force exception and exercise _handle_tool_streaming_completion_error. * Implement strands context passing instrumentation. * Address review feedback. * [MegaLinter] Apply linters fixes * Remove test_simple.py file. --------- Co-authored-by: Tim Pansino Co-authored-by: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Co-authored-by: Tim Pansino --- newrelic/api/error_trace.py | 29 +- newrelic/common/llm_utils.py | 24 + newrelic/config.py | 7 + newrelic/hooks/mlmodel_strands.py | 492 ++++++++++++++++++ tests/mlmodel_strands/_mock_model_provider.py | 4 +- tests/mlmodel_strands/conftest.py | 25 +- tests/mlmodel_strands/test_agent.py | 427 +++++++++++++++ tests/mlmodel_strands/test_simple.py | 36 -- tests/testing_support/fixtures.py | 2 +- .../validate_error_event_collector_json.py | 2 +- .../validate_transaction_error_event_count.py | 4 +- 11 files changed, 1001 insertions(+), 51 deletions(-) create mode 100644 newrelic/common/llm_utils.py create mode 100644 newrelic/hooks/mlmodel_strands.py create mode 100644 tests/mlmodel_strands/test_agent.py delete mode 100644 tests/mlmodel_strands/test_simple.py diff --git a/newrelic/api/error_trace.py b/newrelic/api/error_trace.py index db63c54316..aaa12b50e3 100644 --- a/newrelic/api/error_trace.py +++ b/newrelic/api/error_trace.py @@ -15,6 +15,7 @@ import functools from newrelic.api.time_trace import current_trace, notice_error +from newrelic.common.async_wrapper import async_wrapper as get_async_wrapper from newrelic.common.object_wrapper import FunctionWrapper, wrap_object @@ -43,17 +44,31 @@ def __exit__(self, exc, value, tb): ) -def ErrorTraceWrapper(wrapped, ignore=None, expected=None, status_code=None): - def wrapper(wrapped, instance, args, kwargs): - parent = current_trace() +def ErrorTraceWrapper(wrapped, ignore=None, expected=None, status_code=None, async_wrapper=None): + def literal_wrapper(wrapped, instance, args, kwargs): + # Determine if the wrapped function is async or sync + wrapper = async_wrapper if async_wrapper is not None else get_async_wrapper(wrapped) + # Sync function path + if not wrapper: + parent = current_trace() + if not parent: + # No active tracing context so just call the wrapped function directly + return wrapped(*args, **kwargs) + # Async function path + else: + # For async functions, the async wrapper will handle trace context propagation + parent = None - if parent is None: - return wrapped(*args, **kwargs) + trace = ErrorTrace(ignore, expected, status_code, parent=parent) + + if wrapper: + # The async wrapper handles the context management for us + return wrapper(wrapped, trace)(*args, **kwargs) - with ErrorTrace(ignore, expected, status_code, parent=parent): + with trace: return wrapped(*args, **kwargs) - return FunctionWrapper(wrapped, wrapper) + return FunctionWrapper(wrapped, literal_wrapper) def error_trace(ignore=None, expected=None, status_code=None): diff --git a/newrelic/common/llm_utils.py b/newrelic/common/llm_utils.py new file mode 100644 index 0000000000..eebdacfc7f --- /dev/null +++ b/newrelic/common/llm_utils.py @@ -0,0 +1,24 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +def _get_llm_metadata(transaction): + # Grab LLM-related custom attributes off of the transaction to store as metadata on LLM events + custom_attrs_dict = transaction._custom_params + llm_metadata_dict = {key: value for key, value in custom_attrs_dict.items() if key.startswith("llm.")} + llm_context_attrs = getattr(transaction, "_llm_context_attrs", None) + if llm_context_attrs: + llm_metadata_dict.update(llm_context_attrs) + + return llm_metadata_dict diff --git a/newrelic/config.py b/newrelic/config.py index c2b7b5c2d6..94955293d5 100644 --- a/newrelic/config.py +++ b/newrelic/config.py @@ -2948,6 +2948,13 @@ def _process_module_builtin_defaults(): "newrelic.hooks.mlmodel_autogen", "instrument_autogen_agentchat_agents__assistant_agent", ) + _process_module_definition("strands.agent.agent", "newrelic.hooks.mlmodel_strands", "instrument_agent_agent") + _process_module_definition( + "strands.tools.executors._executor", "newrelic.hooks.mlmodel_strands", "instrument_tools_executors__executor" + ) + _process_module_definition("strands.tools.registry", "newrelic.hooks.mlmodel_strands", "instrument_tools_registry") + _process_module_definition("strands.models.bedrock", "newrelic.hooks.mlmodel_strands", "instrument_models_bedrock") + _process_module_definition("mcp.client.session", "newrelic.hooks.adapter_mcp", "instrument_mcp_client_session") _process_module_definition( "mcp.server.fastmcp.tools.tool_manager", diff --git a/newrelic/hooks/mlmodel_strands.py b/newrelic/hooks/mlmodel_strands.py new file mode 100644 index 0000000000..bf849fd717 --- /dev/null +++ b/newrelic/hooks/mlmodel_strands.py @@ -0,0 +1,492 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import logging +import sys +import uuid + +from newrelic.api.error_trace import ErrorTraceWrapper +from newrelic.api.function_trace import FunctionTrace +from newrelic.api.time_trace import current_trace, get_trace_linking_metadata +from newrelic.api.transaction import current_transaction +from newrelic.common.llm_utils import _get_llm_metadata +from newrelic.common.object_names import callable_name +from newrelic.common.object_wrapper import ObjectProxy, wrap_function_wrapper +from newrelic.common.package_version_utils import get_package_version +from newrelic.common.signature import bind_args +from newrelic.core.config import global_settings +from newrelic.core.context import ContextOf + +_logger = logging.getLogger(__name__) +STRANDS_VERSION = get_package_version("strands-agents") + +RECORD_EVENTS_FAILURE_LOG_MESSAGE = "Exception occurred in Strands instrumentation: Failed to record LLM events. Please report this issue to New Relic Support." +TOOL_OUTPUT_FAILURE_LOG_MESSAGE = "Exception occurred in Strands instrumentation: Failed to record output of tool call. Please report this issue to New Relic Support." +AGENT_EVENT_FAILURE_LOG_MESSAGE = "Exception occurred in Strands instrumentation: Failed to record agent data. Please report this issue to New Relic Support." +TOOL_EXTRACTOR_FAILURE_LOG_MESSAGE = "Exception occurred in Strands instrumentation: Failed to extract tool information. If the issue persists, report this issue to New Relic support.\n" + + +def wrap_agent__call__(wrapped, instance, args, kwargs): + trace = current_trace() + if not trace: + return wrapped(*args, **kwargs) + + try: + bound_args = bind_args(wrapped, args, kwargs) + # Make a copy of the invocation state before we mutate it + if "invocation_state" in bound_args: + invocation_state = bound_args["invocation_state"] = dict(bound_args["invocation_state"] or {}) + + # Attempt to save the current transaction context into the invocation state dictionary + invocation_state["_nr_transaction"] = trace + except Exception: + return wrapped(*args, **kwargs) + else: + return wrapped(**bound_args) + + +async def wrap_agent_invoke_async(wrapped, instance, args, kwargs): + # If there's already a transaction, don't propagate anything here + if current_transaction(): + return await wrapped(*args, **kwargs) + + try: + # Grab the trace context we should be running under and pass it to ContextOf + bound_args = bind_args(wrapped, args, kwargs) + invocation_state = bound_args["invocation_state"] or {} + trace = invocation_state.pop("_nr_transaction", None) + except Exception: + return await wrapped(*args, **kwargs) + + # If we find a transaction to propagate, use it. Otherwise, just call wrapped. + if trace: + with ContextOf(trace=trace): + return await wrapped(*args, **kwargs) + else: + return await wrapped(*args, **kwargs) + + +def wrap_stream_async(wrapped, instance, args, kwargs): + transaction = current_transaction() + if not transaction: + return wrapped(*args, **kwargs) + + settings = transaction.settings or global_settings() + if not settings.ai_monitoring.enabled: + return wrapped(*args, **kwargs) + + # Framework metric also used for entity tagging in the UI + transaction.add_ml_model_info("Strands", STRANDS_VERSION) + transaction._add_agent_attribute("llm", True) + + func_name = callable_name(wrapped) + agent_name = getattr(instance, "name", "agent") + function_trace_name = f"{func_name}/{agent_name}" + + ft = FunctionTrace(name=function_trace_name, group="Llm/agent/Strands") + ft.__enter__() + linking_metadata = get_trace_linking_metadata() + agent_id = str(uuid.uuid4()) + + try: + return_val = wrapped(*args, **kwargs) + except Exception: + raise + + # For streaming responses, wrap with proxy and attach metadata + try: + # For streaming responses, wrap with proxy and attach metadata + proxied_return_val = AsyncGeneratorProxy( + return_val, _record_agent_event_on_stop_iteration, _handle_agent_streaming_completion_error + ) + proxied_return_val._nr_ft = ft + proxied_return_val._nr_metadata = linking_metadata + proxied_return_val._nr_strands_attrs = {"agent_name": agent_name, "agent_id": agent_id} + return proxied_return_val + except Exception: + # If proxy creation fails, clean up the function trace and return original value + ft.__exit__(*sys.exc_info()) + return return_val + + +def _record_agent_event_on_stop_iteration(self, transaction): + if hasattr(self, "_nr_ft"): + # Use saved linking metadata to maintain correct span association + linking_metadata = self._nr_metadata or get_trace_linking_metadata() + self._nr_ft.__exit__(None, None, None) + + try: + strands_attrs = getattr(self, "_nr_strands_attrs", {}) + + # If there are no strands attrs exit early as there's no data to record. + if not strands_attrs: + return + + agent_name = strands_attrs.get("agent_name", "agent") + agent_id = strands_attrs.get("agent_id") + agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction, linking_metadata) + agent_event_dict["duration"] = self._nr_ft.duration * 1000 + transaction.record_custom_event("LlmAgent", agent_event_dict) + + except Exception: + _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) + finally: + # Clear cached data to prevent memory leaks and duplicate reporting + if hasattr(self, "_nr_strands_attrs"): + self._nr_strands_attrs.clear() + + +def _record_tool_event_on_stop_iteration(self, transaction): + if hasattr(self, "_nr_ft"): + # Use saved linking metadata to maintain correct span association + linking_metadata = self._nr_metadata or get_trace_linking_metadata() + self._nr_ft.__exit__(None, None, None) + + try: + strands_attrs = getattr(self, "_nr_strands_attrs", {}) + + # If there are no strands attrs exit early as there's no data to record. + if not strands_attrs: + return + + try: + tool_results = strands_attrs.get("tool_results", []) + except Exception: + tool_results = None + _logger.warning(TOOL_OUTPUT_FAILURE_LOG_MESSAGE, exc_info=True) + + tool_event_dict = _construct_base_tool_event_dict( + strands_attrs, tool_results, transaction, linking_metadata + ) + tool_event_dict["duration"] = self._nr_ft.duration * 1000 + transaction.record_custom_event("LlmTool", tool_event_dict) + + except Exception: + _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) + finally: + # Clear cached data to prevent memory leaks and duplicate reporting + if hasattr(self, "_nr_strands_attrs"): + self._nr_strands_attrs.clear() + + +def _construct_base_tool_event_dict(strands_attrs, tool_results, transaction, linking_metadata): + try: + try: + tool_output = tool_results[-1]["content"][0] if tool_results else None + error = tool_results[-1]["status"] == "error" + except Exception: + tool_output = None + error = False + _logger.warning(TOOL_OUTPUT_FAILURE_LOG_MESSAGE, exc_info=True) + + tool_name = strands_attrs.get("tool_name", "tool") + tool_id = strands_attrs.get("tool_id") + run_id = strands_attrs.get("run_id") + tool_input = strands_attrs.get("tool_input") + agent_name = strands_attrs.get("agent_name", "agent") + settings = transaction.settings or global_settings() + + tool_event_dict = { + "id": tool_id, + "run_id": run_id, + "name": tool_name, + "span_id": linking_metadata.get("span.id"), + "trace_id": linking_metadata.get("trace.id"), + "agent_name": agent_name, + "vendor": "strands", + "ingest_source": "Python", + } + # Set error flag if the status shows an error was caught, + # it will be reported further down in the instrumentation. + if error: + tool_event_dict["error"] = True + + if settings.ai_monitoring.record_content.enabled: + tool_event_dict["input"] = tool_input + # In error cases, the output will hold the error message + tool_event_dict["output"] = tool_output + tool_event_dict.update(_get_llm_metadata(transaction)) + except Exception: + tool_event_dict = {} + _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) + + return tool_event_dict + + +def _construct_base_agent_event_dict(agent_name, agent_id, transaction, linking_metadata): + try: + agent_event_dict = { + "id": agent_id, + "name": agent_name, + "span_id": linking_metadata.get("span.id"), + "trace_id": linking_metadata.get("trace.id"), + "vendor": "strands", + "ingest_source": "Python", + } + agent_event_dict.update(_get_llm_metadata(transaction)) + except Exception: + _logger.warning(AGENT_EVENT_FAILURE_LOG_MESSAGE, exc_info=True) + agent_event_dict = {} + + return agent_event_dict + + +def _handle_agent_streaming_completion_error(self, transaction): + if hasattr(self, "_nr_ft"): + strands_attrs = getattr(self, "_nr_strands_attrs", {}) + + # If there are no strands attrs exit early as there's no data to record. + if not strands_attrs: + self._nr_ft.__exit__(*sys.exc_info()) + return + + # Use saved linking metadata to maintain correct span association + linking_metadata = self._nr_metadata or get_trace_linking_metadata() + + try: + agent_name = strands_attrs.get("agent_name", "agent") + agent_id = strands_attrs.get("agent_id") + + # Notice the error on the function trace + self._nr_ft.notice_error(attributes={"agent_id": agent_id}) + self._nr_ft.__exit__(*sys.exc_info()) + + # Create error event + agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction, linking_metadata) + agent_event_dict.update({"duration": self._nr_ft.duration * 1000, "error": True}) + transaction.record_custom_event("LlmAgent", agent_event_dict) + + except Exception: + _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) + finally: + # Clear cached data to prevent memory leaks + if hasattr(self, "_nr_strands_attrs"): + self._nr_strands_attrs.clear() + + +def _handle_tool_streaming_completion_error(self, transaction): + if hasattr(self, "_nr_ft"): + strands_attrs = getattr(self, "_nr_strands_attrs", {}) + + # If there are no strands attrs exit early as there's no data to record. + if not strands_attrs: + self._nr_ft.__exit__(*sys.exc_info()) + return + + # Use saved linking metadata to maintain correct span association + linking_metadata = self._nr_metadata or get_trace_linking_metadata() + + try: + tool_id = strands_attrs.get("tool_id") + + # We expect this to never have any output since this is an error case, + # but if it does we will report it. + try: + tool_results = strands_attrs.get("tool_results", []) + except Exception: + tool_results = None + _logger.warning(TOOL_OUTPUT_FAILURE_LOG_MESSAGE, exc_info=True) + + # Notice the error on the function trace + self._nr_ft.notice_error(attributes={"tool_id": tool_id}) + self._nr_ft.__exit__(*sys.exc_info()) + + # Create error event + tool_event_dict = _construct_base_tool_event_dict( + strands_attrs, tool_results, transaction, linking_metadata + ) + tool_event_dict["duration"] = self._nr_ft.duration * 1000 + # Ensure error flag is set to True in case the tool_results did not indicate an error + if "error" not in tool_event_dict: + tool_event_dict["error"] = True + + transaction.record_custom_event("LlmTool", tool_event_dict) + + except Exception: + _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) + finally: + # Clear cached data to prevent memory leaks + if hasattr(self, "_nr_strands_attrs"): + self._nr_strands_attrs.clear() + + +def wrap_tool_executor__stream(wrapped, instance, args, kwargs): + transaction = current_transaction() + if not transaction: + return wrapped(*args, **kwargs) + + settings = transaction.settings or global_settings() + if not settings.ai_monitoring.enabled: + return wrapped(*args, **kwargs) + + # Framework metric also used for entity tagging in the UI + transaction.add_ml_model_info("Strands", STRANDS_VERSION) + transaction._add_agent_attribute("llm", True) + + # Grab tool data + try: + bound_args = bind_args(wrapped, args, kwargs) + agent_name = getattr(bound_args.get("agent"), "name", "agent") + tool_use = bound_args.get("tool_use", {}) + + run_id = tool_use.get("toolUseId", "") + tool_name = tool_use.get("name", "tool") + _input = tool_use.get("input") + tool_input = str(_input) if _input else None + tool_results = bound_args.get("tool_results", []) + except Exception: + tool_name = "tool" + _logger.warning(TOOL_EXTRACTOR_FAILURE_LOG_MESSAGE, exc_info=True) + + func_name = callable_name(wrapped) + function_trace_name = f"{func_name}/{tool_name}" + + ft = FunctionTrace(name=function_trace_name, group="Llm/tool/Strands") + ft.__enter__() + linking_metadata = get_trace_linking_metadata() + tool_id = str(uuid.uuid4()) + + try: + return_val = wrapped(*args, **kwargs) + except Exception: + raise + + try: + # Wrap return value with proxy and attach metadata for later access + proxied_return_val = AsyncGeneratorProxy( + return_val, _record_tool_event_on_stop_iteration, _handle_tool_streaming_completion_error + ) + proxied_return_val._nr_ft = ft + proxied_return_val._nr_metadata = linking_metadata + proxied_return_val._nr_strands_attrs = { + "tool_results": tool_results, + "tool_name": tool_name, + "tool_id": tool_id, + "run_id": run_id, + "tool_input": tool_input, + "agent_name": agent_name, + } + return proxied_return_val + except Exception: + # If proxy creation fails, clean up the function trace and return original value + ft.__exit__(*sys.exc_info()) + return return_val + + +class AsyncGeneratorProxy(ObjectProxy): + def __init__(self, wrapped, on_stop_iteration, on_error): + super().__init__(wrapped) + self._nr_on_stop_iteration = on_stop_iteration + self._nr_on_error = on_error + + def __aiter__(self): + self._nr_wrapped_iter = self.__wrapped__.__aiter__() + return self + + async def __anext__(self): + transaction = current_transaction() + if not transaction: + return await self._nr_wrapped_iter.__anext__() + + return_val = None + try: + return_val = await self._nr_wrapped_iter.__anext__() + except StopAsyncIteration: + self._nr_on_stop_iteration(self, transaction) + raise + except Exception: + self._nr_on_error(self, transaction) + raise + return return_val + + async def aclose(self): + return await super().aclose() + + +def wrap_ToolRegister_register_tool(wrapped, instance, args, kwargs): + bound_args = bind_args(wrapped, args, kwargs) + bound_args["tool"]._tool_func = ErrorTraceWrapper(bound_args["tool"]._tool_func) + return wrapped(*args, **kwargs) + + +def wrap_bedrock_model_stream(wrapped, instance, args, kwargs): + """Stores trace context on the messages argument to be retrieved by the _stream() instrumentation.""" + trace = current_trace() + if not trace: + return wrapped(*args, **kwargs) + + settings = trace.settings or global_settings() + if not settings.ai_monitoring.enabled: + return wrapped(*args, **kwargs) + + try: + bound_args = bind_args(wrapped, args, kwargs) + except Exception: + return wrapped(*args, **kwargs) + + if "messages" in bound_args and isinstance(bound_args["messages"], list): + bound_args["messages"].append({"newrelic_trace": trace}) + + return wrapped(*args, **kwargs) + + +def wrap_bedrock_model__stream(wrapped, instance, args, kwargs): + """Retrieves trace context stored on the messages argument and propagates it to the new thread.""" + try: + bound_args = bind_args(wrapped, args, kwargs) + except Exception: + return wrapped(*args, **kwargs) + + if ( + "messages" in bound_args + and isinstance(bound_args["messages"], list) + and bound_args["messages"] # non-empty list + and "newrelic_trace" in bound_args["messages"][-1] + ): + trace_message = bound_args["messages"].pop() + with ContextOf(trace=trace_message["newrelic_trace"]): + return wrapped(*args, **kwargs) + + return wrapped(*args, **kwargs) + + +def instrument_agent_agent(module): + if hasattr(module, "Agent"): + if hasattr(module.Agent, "__call__"): # noqa: B004 + wrap_function_wrapper(module, "Agent.__call__", wrap_agent__call__) + if hasattr(module.Agent, "invoke_async"): + wrap_function_wrapper(module, "Agent.invoke_async", wrap_agent_invoke_async) + if hasattr(module.Agent, "stream_async"): + wrap_function_wrapper(module, "Agent.stream_async", wrap_stream_async) + + +def instrument_tools_executors__executor(module): + if hasattr(module, "ToolExecutor"): + if hasattr(module.ToolExecutor, "_stream"): + wrap_function_wrapper(module, "ToolExecutor._stream", wrap_tool_executor__stream) + + +def instrument_tools_registry(module): + if hasattr(module, "ToolRegistry"): + if hasattr(module.ToolRegistry, "register_tool"): + wrap_function_wrapper(module, "ToolRegistry.register_tool", wrap_ToolRegister_register_tool) + + +def instrument_models_bedrock(module): + # This instrumentation only exists to pass trace context due to bedrock models using a separate thread. + if hasattr(module, "BedrockModel"): + if hasattr(module.BedrockModel, "stream"): + wrap_function_wrapper(module, "BedrockModel.stream", wrap_bedrock_model_stream) + if hasattr(module.BedrockModel, "_stream"): + wrap_function_wrapper(module, "BedrockModel._stream", wrap_bedrock_model__stream) diff --git a/tests/mlmodel_strands/_mock_model_provider.py b/tests/mlmodel_strands/_mock_model_provider.py index e4c9e79930..ef60e13bad 100644 --- a/tests/mlmodel_strands/_mock_model_provider.py +++ b/tests/mlmodel_strands/_mock_model_provider.py @@ -41,7 +41,7 @@ def __init__(self, agent_responses): def format_chunk(self, event): return event - def format_request(self, messages, tool_specs=None, system_prompt=None): + def format_request(self, messages, tool_specs=None, system_prompt=None, **kwargs): return None def get_config(self): @@ -53,7 +53,7 @@ def update_config(self, **model_config): async def structured_output(self, output_model, prompt, system_prompt=None, **kwargs): pass - async def stream(self, messages, tool_specs=None, system_prompt=None): + async def stream(self, messages, tool_specs=None, system_prompt=None, **kwargs): events = self.map_agent_message_to_events(self.agent_responses[self.index]) for event in events: yield event diff --git a/tests/mlmodel_strands/conftest.py b/tests/mlmodel_strands/conftest.py index b810161f6a..a2ad9b8dd0 100644 --- a/tests/mlmodel_strands/conftest.py +++ b/tests/mlmodel_strands/conftest.py @@ -14,6 +14,7 @@ import pytest from _mock_model_provider import MockedModelProvider +from testing_support.fixture.event_loop import event_loop as loop from testing_support.fixtures import collector_agent_registration_fixture, collector_available_fixture from testing_support.ml_testing_utils import set_trace_info @@ -50,15 +51,33 @@ def single_tool_model(): @pytest.fixture -def single_tool_model_error(): +def single_tool_model_runtime_error_coro(): model = MockedModelProvider( [ { "role": "assistant", "content": [ - {"text": "Calling add_exclamation tool"}, + {"text": "Calling throw_exception_coro tool"}, + # Set arguments to an invalid type to trigger error in tool + {"toolUse": {"name": "throw_exception_coro", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def single_tool_model_runtime_error_agen(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling throw_exception_agen tool"}, # Set arguments to an invalid type to trigger error in tool - {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": 12}}}, + {"toolUse": {"name": "throw_exception_agen", "toolUseId": "123", "input": {"message": "Hello"}}}, ], }, {"role": "assistant", "content": [{"text": "Success!"}]}, diff --git a/tests/mlmodel_strands/test_agent.py b/tests/mlmodel_strands/test_agent.py new file mode 100644 index 0000000000..af685668ad --- /dev/null +++ b/tests/mlmodel_strands/test_agent.py @@ -0,0 +1,427 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from strands import Agent, tool +from testing_support.fixtures import reset_core_stats_engine, validate_attributes +from testing_support.ml_testing_utils import ( + disabled_ai_monitoring_record_content_settings, + disabled_ai_monitoring_settings, + events_with_context_attrs, + tool_events_sans_content, +) +from testing_support.validators.validate_custom_event import validate_custom_event_count +from testing_support.validators.validate_custom_events import validate_custom_events +from testing_support.validators.validate_error_trace_attributes import validate_error_trace_attributes +from testing_support.validators.validate_transaction_error_event_count import validate_transaction_error_event_count +from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics + +from newrelic.api.background_task import background_task +from newrelic.api.llm_custom_attributes import WithLlmCustomAttributes +from newrelic.common.object_names import callable_name +from newrelic.common.object_wrapper import transient_function_wrapper + +tool_recorded_event = [ + ( + {"type": "LlmTool"}, + { + "id": None, + "run_id": "123", + "output": "{'text': 'Hello!'}", + "name": "add_exclamation", + "agent_name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "input": "{'message': 'Hello'}", + "vendor": "strands", + "ingest_source": "Python", + "duration": None, + }, + ) +] + +tool_recorded_event_forced_internal_error = [ + ( + {"type": "LlmTool"}, + { + "id": None, + "run_id": "123", + "name": "add_exclamation", + "agent_name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "input": "{'message': 'Hello'}", + "vendor": "strands", + "ingest_source": "Python", + "duration": None, + "error": True, + }, + ) +] + +tool_recorded_event_error_coro = [ + ( + {"type": "LlmTool"}, + { + "id": None, + "run_id": "123", + "name": "throw_exception_coro", + "agent_name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "input": "{'message': 'Hello'}", + "vendor": "strands", + "ingest_source": "Python", + "error": True, + "output": "{'text': 'Error: RuntimeError - Oops'}", + "duration": None, + }, + ) +] + + +tool_recorded_event_error_agen = [ + ( + {"type": "LlmTool"}, + { + "id": None, + "run_id": "123", + "name": "throw_exception_agen", + "agent_name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "input": "{'message': 'Hello'}", + "vendor": "strands", + "ingest_source": "Python", + "error": True, + "output": "{'text': 'Error: RuntimeError - Oops'}", + "duration": None, + }, + ) +] + + +agent_recorded_event = [ + ( + {"type": "LlmAgent"}, + { + "id": None, + "name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + "ingest_source": "Python", + "duration": None, + }, + ) +] + +agent_recorded_event_error = [ + ( + {"type": "LlmAgent"}, + { + "id": None, + "name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + "ingest_source": "Python", + "error": True, + "duration": None, + }, + ) +] + + +# Example tool for testing purposes +@tool +async def add_exclamation(message: str) -> str: + return f"{message}!" + + +@tool +async def throw_exception_coro(message: str) -> str: + raise RuntimeError("Oops") + + +@tool +async def throw_exception_agen(message: str) -> str: + raise RuntimeError("Oops") + yield + + +@reset_core_stats_engine() +@validate_custom_events(events_with_context_attrs(tool_recorded_event)) +@validate_custom_events(events_with_context_attrs(agent_recorded_event)) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "test_agent:test_agent_invoke", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent_invoke(set_trace_info, single_tool_model): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + with WithLlmCustomAttributes({"context": "attr"}): + response = my_agent('Add an exclamation to the word "Hello"') + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 + + +@reset_core_stats_engine() +@validate_custom_events(tool_recorded_event) +@validate_custom_events(agent_recorded_event) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "test_agent:test_agent_invoke_async", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent_invoke_async(loop, set_trace_info, single_tool_model): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + async def _test(): + response = await my_agent.invoke_async('Add an exclamation to the word "Hello"') + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 + + loop.run_until_complete(_test()) + + +@reset_core_stats_engine() +@validate_custom_events(tool_recorded_event) +@validate_custom_events(agent_recorded_event) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "test_agent:test_agent_stream_async", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent_stream_async(loop, set_trace_info, single_tool_model): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + async def _test(): + response = my_agent.stream_async('Add an exclamation to the word "Hello"') + messages = [event["message"]["content"] async for event in response if "message" in event] + + assert len(messages) == 3 + assert messages[0][0]["text"] == "Calling add_exclamation tool" + assert messages[0][1]["toolUse"]["name"] == "add_exclamation" + assert messages[1][0]["toolResult"]["content"][0]["text"] == "Hello!" + assert messages[2][0]["text"] == "Success!" + + loop.run_until_complete(_test()) + + +@reset_core_stats_engine() +@disabled_ai_monitoring_record_content_settings +@validate_custom_events(agent_recorded_event) +@validate_custom_events(tool_events_sans_content(tool_recorded_event)) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "test_agent:test_agent_invoke_no_content", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent_invoke_no_content(set_trace_info, single_tool_model): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + response = my_agent('Add an exclamation to the word "Hello"') + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 + + +@disabled_ai_monitoring_settings +@reset_core_stats_engine() +@validate_custom_event_count(count=0) +@background_task() +def test_agent_invoke_disabled_ai_monitoring_events(set_trace_info, single_tool_model): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + response = my_agent('Add an exclamation to the word "Hello"') + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 + + +@reset_core_stats_engine() +@validate_transaction_error_event_count(1) +@validate_error_trace_attributes(callable_name(ValueError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) +@validate_custom_events(agent_recorded_event_error) +@validate_custom_event_count(count=1) +@validate_transaction_metrics( + "test_agent:test_agent_invoke_error", + scoped_metrics=[("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1)], + rollup_metrics=[("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1)], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent_invoke_error(set_trace_info, single_tool_model): + # Add a wrapper to intentionally force an error in the Agent code + @transient_function_wrapper("strands.agent.agent", "Agent._convert_prompt_to_messages") + def _wrap_convert_prompt_to_messages(wrapped, instance, args, kwargs): + raise ValueError("Oops") + + @_wrap_convert_prompt_to_messages + def _test(): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + my_agent('Add an exclamation to the word "Hello"') # raises ValueError + + with pytest.raises(ValueError): + _test() + + +@reset_core_stats_engine() +@validate_transaction_error_event_count(1) +@validate_error_trace_attributes(callable_name(RuntimeError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) +@validate_custom_events(tool_recorded_event_error_coro) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "test_agent:test_agent_invoke_tool_coro_runtime_error", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/throw_exception_coro", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/throw_exception_coro", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent_invoke_tool_coro_runtime_error(set_trace_info, single_tool_model_runtime_error_coro): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model_runtime_error_coro, tools=[throw_exception_coro]) + + response = my_agent('Add an exclamation to the word "Hello"') + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["throw_exception_coro"].error_count == 1 + + +@reset_core_stats_engine() +@validate_transaction_error_event_count(1) +@validate_error_trace_attributes(callable_name(RuntimeError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) +@validate_custom_events(tool_recorded_event_error_agen) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "test_agent:test_agent_invoke_tool_agen_runtime_error", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/throw_exception_agen", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/throw_exception_agen", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent_invoke_tool_agen_runtime_error(set_trace_info, single_tool_model_runtime_error_agen): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model_runtime_error_agen, tools=[throw_exception_agen]) + + response = my_agent('Add an exclamation to the word "Hello"') + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["throw_exception_agen"].error_count == 1 + + +@reset_core_stats_engine() +@validate_transaction_error_event_count(1) +@validate_error_trace_attributes(callable_name(ValueError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) +@validate_custom_events(agent_recorded_event) +@validate_custom_events(tool_recorded_event_forced_internal_error) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "test_agent:test_agent_tool_forced_exception", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent_tool_forced_exception(set_trace_info, single_tool_model): + # Add a wrapper to intentionally force an error in the ToolExecutor._stream code to hit the exception path in + # the AsyncGeneratorProxy + @transient_function_wrapper("strands.hooks.events", "BeforeToolCallEvent.__init__") + def _wrap_BeforeToolCallEvent_init(wrapped, instance, args, kwargs): + raise ValueError("Oops") + + @_wrap_BeforeToolCallEvent_init + def _test(): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + my_agent('Add an exclamation to the word "Hello"') + + # This will not explicitly raise a ValueError when running the test but we are still able to capture it in the error trace + _test() + + +@reset_core_stats_engine() +@validate_custom_event_count(count=0) +def test_agent_invoke_outside_txn(single_tool_model): + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + response = my_agent('Add an exclamation to the word "Hello"') + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 diff --git a/tests/mlmodel_strands/test_simple.py b/tests/mlmodel_strands/test_simple.py deleted file mode 100644 index ae24003fab..0000000000 --- a/tests/mlmodel_strands/test_simple.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2010 New Relic, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -from strands import Agent, tool - -from newrelic.api.background_task import background_task - - -# Example tool for testing purposes -@tool -def add_exclamation(message: str) -> str: - return f"{message}!" - - -# TODO: Remove this file once all real tests are in place - - -@background_task() -def test_simple_run_agent(set_trace_info, single_tool_model): - set_trace_info() - my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) - - response = my_agent("Run the tools.") - assert response.message["content"][0]["text"] == "Success!" - assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 diff --git a/tests/testing_support/fixtures.py b/tests/testing_support/fixtures.py index 3d93e06e30..540e44f70c 100644 --- a/tests/testing_support/fixtures.py +++ b/tests/testing_support/fixtures.py @@ -797,7 +797,7 @@ def _bind_params(transaction, *args, **kwargs): transaction = _bind_params(*args, **kwargs) error_events = transaction.error_events(instance.stats_table) - assert len(error_events) == num_errors + assert len(error_events) == num_errors, f"Expected: {num_errors}, Got: {len(error_events)}" for sample in error_events: assert isinstance(sample, list) assert len(sample) == 3 diff --git a/tests/testing_support/validators/validate_error_event_collector_json.py b/tests/testing_support/validators/validate_error_event_collector_json.py index d1cec3a558..27ea76f3a3 100644 --- a/tests/testing_support/validators/validate_error_event_collector_json.py +++ b/tests/testing_support/validators/validate_error_event_collector_json.py @@ -52,7 +52,7 @@ def _validate_error_event_collector_json(wrapped, instance, args, kwargs): error_events = decoded_json[2] - assert len(error_events) == num_errors + assert len(error_events) == num_errors, f"Expected: {num_errors}, Got: {len(error_events)}" for event in error_events: # event is an array containing intrinsics, user-attributes, # and agent-attributes diff --git a/tests/testing_support/validators/validate_transaction_error_event_count.py b/tests/testing_support/validators/validate_transaction_error_event_count.py index b41a52330f..f5e8c0b206 100644 --- a/tests/testing_support/validators/validate_transaction_error_event_count.py +++ b/tests/testing_support/validators/validate_transaction_error_event_count.py @@ -28,7 +28,9 @@ def _validate_error_event_on_stats_engine(wrapped, instance, args, kwargs): raise else: error_events = list(instance.error_events) - assert len(error_events) == num_errors + assert len(error_events) == num_errors, ( + f"Expected: {num_errors}, Got: {len(error_events)}. Errors: {error_events}" + ) return result From 4d234e4213a04ce53c7cedb5773aa94f1ef34df4 Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Fri, 5 Dec 2025 09:14:46 -0800 Subject: [PATCH 022/124] Strands MultiAgent Instrumentation (#1590) * Rename strands instrument functions * Add instrumentation for strands multiagent * Reorganize strands tests * Strands multiagent tests * Remove timestamp from test expected events. --------- Co-authored-by: Uma Annamalai --- newrelic/config.py | 22 +- newrelic/hooks/mlmodel_strands.py | 24 +- tests/mlmodel_strands/__init__.py | 13 + tests/mlmodel_strands/_test_agent.py | 165 +++++++++++ .../mlmodel_strands/_test_multiagent_graph.py | 91 ++++++ .../mlmodel_strands/_test_multiagent_swarm.py | 108 ++++++++ tests/mlmodel_strands/conftest.py | 132 --------- tests/mlmodel_strands/test_agent.py | 46 ++-- .../mlmodel_strands/test_multiagent_graph.py | 233 ++++++++++++++++ .../mlmodel_strands/test_multiagent_swarm.py | 260 ++++++++++++++++++ 10 files changed, 928 insertions(+), 166 deletions(-) create mode 100644 tests/mlmodel_strands/__init__.py create mode 100644 tests/mlmodel_strands/_test_agent.py create mode 100644 tests/mlmodel_strands/_test_multiagent_graph.py create mode 100644 tests/mlmodel_strands/_test_multiagent_swarm.py create mode 100644 tests/mlmodel_strands/test_multiagent_graph.py create mode 100644 tests/mlmodel_strands/test_multiagent_swarm.py diff --git a/newrelic/config.py b/newrelic/config.py index 94955293d5..4b8627772d 100644 --- a/newrelic/config.py +++ b/newrelic/config.py @@ -2948,12 +2948,26 @@ def _process_module_builtin_defaults(): "newrelic.hooks.mlmodel_autogen", "instrument_autogen_agentchat_agents__assistant_agent", ) - _process_module_definition("strands.agent.agent", "newrelic.hooks.mlmodel_strands", "instrument_agent_agent") _process_module_definition( - "strands.tools.executors._executor", "newrelic.hooks.mlmodel_strands", "instrument_tools_executors__executor" + "strands.agent.agent", "newrelic.hooks.mlmodel_strands", "instrument_strands_agent_agent" + ) + _process_module_definition( + "strands.multiagent.graph", "newrelic.hooks.mlmodel_strands", "instrument_strands_multiagent_graph" + ) + _process_module_definition( + "strands.multiagent.swarm", "newrelic.hooks.mlmodel_strands", "instrument_strands_multiagent_swarm" + ) + _process_module_definition( + "strands.tools.executors._executor", + "newrelic.hooks.mlmodel_strands", + "instrument_strands_tools_executors__executor", + ) + _process_module_definition( + "strands.tools.registry", "newrelic.hooks.mlmodel_strands", "instrument_strands_tools_registry" + ) + _process_module_definition( + "strands.models.bedrock", "newrelic.hooks.mlmodel_strands", "instrument_strands_models_bedrock" ) - _process_module_definition("strands.tools.registry", "newrelic.hooks.mlmodel_strands", "instrument_tools_registry") - _process_module_definition("strands.models.bedrock", "newrelic.hooks.mlmodel_strands", "instrument_models_bedrock") _process_module_definition("mcp.client.session", "newrelic.hooks.adapter_mcp", "instrument_mcp_client_session") _process_module_definition( diff --git a/newrelic/hooks/mlmodel_strands.py b/newrelic/hooks/mlmodel_strands.py index bf849fd717..20317626da 100644 --- a/newrelic/hooks/mlmodel_strands.py +++ b/newrelic/hooks/mlmodel_strands.py @@ -461,7 +461,7 @@ def wrap_bedrock_model__stream(wrapped, instance, args, kwargs): return wrapped(*args, **kwargs) -def instrument_agent_agent(module): +def instrument_strands_agent_agent(module): if hasattr(module, "Agent"): if hasattr(module.Agent, "__call__"): # noqa: B004 wrap_function_wrapper(module, "Agent.__call__", wrap_agent__call__) @@ -471,19 +471,35 @@ def instrument_agent_agent(module): wrap_function_wrapper(module, "Agent.stream_async", wrap_stream_async) -def instrument_tools_executors__executor(module): +def instrument_strands_multiagent_graph(module): + if hasattr(module, "Graph"): + if hasattr(module.Graph, "__call__"): # noqa: B004 + wrap_function_wrapper(module, "Graph.__call__", wrap_agent__call__) + if hasattr(module.Graph, "invoke_async"): + wrap_function_wrapper(module, "Graph.invoke_async", wrap_agent_invoke_async) + + +def instrument_strands_multiagent_swarm(module): + if hasattr(module, "Swarm"): + if hasattr(module.Swarm, "__call__"): # noqa: B004 + wrap_function_wrapper(module, "Swarm.__call__", wrap_agent__call__) + if hasattr(module.Swarm, "invoke_async"): + wrap_function_wrapper(module, "Swarm.invoke_async", wrap_agent_invoke_async) + + +def instrument_strands_tools_executors__executor(module): if hasattr(module, "ToolExecutor"): if hasattr(module.ToolExecutor, "_stream"): wrap_function_wrapper(module, "ToolExecutor._stream", wrap_tool_executor__stream) -def instrument_tools_registry(module): +def instrument_strands_tools_registry(module): if hasattr(module, "ToolRegistry"): if hasattr(module.ToolRegistry, "register_tool"): wrap_function_wrapper(module, "ToolRegistry.register_tool", wrap_ToolRegister_register_tool) -def instrument_models_bedrock(module): +def instrument_strands_models_bedrock(module): # This instrumentation only exists to pass trace context due to bedrock models using a separate thread. if hasattr(module, "BedrockModel"): if hasattr(module.BedrockModel, "stream"): diff --git a/tests/mlmodel_strands/__init__.py b/tests/mlmodel_strands/__init__.py new file mode 100644 index 0000000000..8030baccf7 --- /dev/null +++ b/tests/mlmodel_strands/__init__.py @@ -0,0 +1,13 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. diff --git a/tests/mlmodel_strands/_test_agent.py b/tests/mlmodel_strands/_test_agent.py new file mode 100644 index 0000000000..15aa79a5ac --- /dev/null +++ b/tests/mlmodel_strands/_test_agent.py @@ -0,0 +1,165 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from strands import tool + +from ._mock_model_provider import MockedModelProvider + + +# Example tool for testing purposes +@tool +async def add_exclamation(message: str) -> str: + return f"{message}!" + + +@tool +async def throw_exception_coro(message: str) -> str: + raise RuntimeError("Oops") + + +@tool +async def throw_exception_agen(message: str) -> str: + raise RuntimeError("Oops") + yield + + +@pytest.fixture +def single_tool_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def single_tool_model_runtime_error_coro(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling throw_exception_coro tool"}, + # Set arguments to an invalid type to trigger error in tool + {"toolUse": {"name": "throw_exception_coro", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def single_tool_model_runtime_error_agen(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling throw_exception_agen tool"}, + # Set arguments to an invalid type to trigger error in tool + {"toolUse": {"name": "throw_exception_agen", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def multi_tool_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 5, "b": 3}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Goodbye"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 123, "b": 2}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def multi_tool_model_error(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 5, "b": 3}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Goodbye"}}}, + ], + }, + { + "role": "assistant", + "content": [ + {"text": "Calling compute_sum tool"}, + # Set insufficient arguments to trigger error in tool + {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 123}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model diff --git a/tests/mlmodel_strands/_test_multiagent_graph.py b/tests/mlmodel_strands/_test_multiagent_graph.py new file mode 100644 index 0000000000..73c1679701 --- /dev/null +++ b/tests/mlmodel_strands/_test_multiagent_graph.py @@ -0,0 +1,91 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from strands import Agent, tool +from strands.multiagent.graph import GraphBuilder + +from ._mock_model_provider import MockedModelProvider + + +@pytest.fixture +def math_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "I'll calculate the sum of 15 and 27 for you."}, + {"toolUse": {"name": "calculate_sum", "toolUseId": "123", "input": {"a": 15, "b": 27}}}, + ], + }, + {"role": "assistant", "content": [{"text": "The sum of 15 and 27 is 42."}]}, + ] + ) + return model + + +@pytest.fixture +def analysis_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "I'll validate the calculation result of 42 from the calculator."}, + {"toolUse": {"name": "analyze_result", "toolUseId": "456", "input": {"value": 42}}}, + ], + }, + { + "role": "assistant", + "content": [{"text": "The calculation is correct, and 42 is a positive integer result."}], + }, + ] + ) + return model + + +# Example tool for testing purposes +@tool +async def calculate_sum(a: int, b: int) -> int: + """Calculate the sum of two numbers.""" + return a + b + + +@tool +async def analyze_result(value: int) -> str: + """Analyze a numeric result.""" + return f"The result {value} is {'positive' if value > 0 else 'zero or negative'}" + + +@pytest.fixture +def math_agent(math_model): + return Agent(name="math_agent", model=math_model, tools=[calculate_sum]) + + +@pytest.fixture +def analysis_agent(analysis_model): + return Agent(name="analysis_agent", model=analysis_model, tools=[analyze_result]) + + +@pytest.fixture +def agent_graph(math_agent, analysis_agent): + # Build graph + builder = GraphBuilder() + builder.add_node(math_agent, "math") + builder.add_node(analysis_agent, "analysis") + builder.add_edge("math", "analysis") + builder.set_entry_point("math") + + return builder.build() diff --git a/tests/mlmodel_strands/_test_multiagent_swarm.py b/tests/mlmodel_strands/_test_multiagent_swarm.py new file mode 100644 index 0000000000..4b7916c27b --- /dev/null +++ b/tests/mlmodel_strands/_test_multiagent_swarm.py @@ -0,0 +1,108 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from strands import Agent, tool +from strands.multiagent.swarm import Swarm + +from ._mock_model_provider import MockedModelProvider + + +@pytest.fixture +def math_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "I'll calculate the sum of 15 and 27 for you."}, + {"toolUse": {"name": "calculate_sum", "toolUseId": "123", "input": {"a": 15, "b": 27}}}, + ], + }, + { + "role": "assistant", + "content": [ + { + "toolUse": { + "name": "handoff_to_agent", + "toolUseId": "789", + "input": { + "agent_name": "analysis_agent", + "message": "Analyze the result of the calculation done by the math_agent.", + "context": {"result": 42}, + }, + } + } + ], + }, + {"role": "assistant", "content": [{"text": "The sum of 15 and 27 is 42."}]}, + ] + ) + return model + + +@pytest.fixture +def analysis_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "I'll validate the calculation result of 42 from the calculator."}, + {"toolUse": {"name": "analyze_result", "toolUseId": "456", "input": {"value": 42}}}, + ], + }, + { + "role": "assistant", + "content": [{"text": "The calculation is correct, and 42 is a positive integer result."}], + }, + ] + ) + return model + + +# Example tool for testing purposes +@tool +async def calculate_sum(a: int, b: int) -> int: + """Calculate the sum of two numbers.""" + return a + b + + +@tool +async def analyze_result(value: int) -> str: + """Analyze a numeric result.""" + return f"The result {value} is {'positive' if value > 0 else 'zero or negative'}" + + +@pytest.fixture +def math_agent(math_model): + return Agent(name="math_agent", model=math_model, tools=[calculate_sum]) + + +@pytest.fixture +def analysis_agent(analysis_model): + return Agent(name="analysis_agent", model=analysis_model, tools=[analyze_result]) + + +@pytest.fixture +def agent_swarm(math_agent, analysis_agent): + # Build graph with conditional edge + return Swarm( + [math_agent, analysis_agent], + entry_point=math_agent, + execution_timeout=60, + node_timeout=30, + max_handoffs=5, + max_iterations=5, + ) diff --git a/tests/mlmodel_strands/conftest.py b/tests/mlmodel_strands/conftest.py index a2ad9b8dd0..abbc29b969 100644 --- a/tests/mlmodel_strands/conftest.py +++ b/tests/mlmodel_strands/conftest.py @@ -12,8 +12,6 @@ # See the License for the specific language governing permissions and # limitations under the License. -import pytest -from _mock_model_provider import MockedModelProvider from testing_support.fixture.event_loop import event_loop as loop from testing_support.fixtures import collector_agent_registration_fixture, collector_available_fixture from testing_support.ml_testing_utils import set_trace_info @@ -31,133 +29,3 @@ collector_agent_registration = collector_agent_registration_fixture( app_name="Python Agent Test (mlmodel_strands)", default_settings=_default_settings ) - - -@pytest.fixture -def single_tool_model(): - model = MockedModelProvider( - [ - { - "role": "assistant", - "content": [ - {"text": "Calling add_exclamation tool"}, - {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, - ], - }, - {"role": "assistant", "content": [{"text": "Success!"}]}, - ] - ) - return model - - -@pytest.fixture -def single_tool_model_runtime_error_coro(): - model = MockedModelProvider( - [ - { - "role": "assistant", - "content": [ - {"text": "Calling throw_exception_coro tool"}, - # Set arguments to an invalid type to trigger error in tool - {"toolUse": {"name": "throw_exception_coro", "toolUseId": "123", "input": {"message": "Hello"}}}, - ], - }, - {"role": "assistant", "content": [{"text": "Success!"}]}, - ] - ) - return model - - -@pytest.fixture -def single_tool_model_runtime_error_agen(): - model = MockedModelProvider( - [ - { - "role": "assistant", - "content": [ - {"text": "Calling throw_exception_agen tool"}, - # Set arguments to an invalid type to trigger error in tool - {"toolUse": {"name": "throw_exception_agen", "toolUseId": "123", "input": {"message": "Hello"}}}, - ], - }, - {"role": "assistant", "content": [{"text": "Success!"}]}, - ] - ) - return model - - -@pytest.fixture -def multi_tool_model(): - model = MockedModelProvider( - [ - { - "role": "assistant", - "content": [ - {"text": "Calling add_exclamation tool"}, - {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, - ], - }, - { - "role": "assistant", - "content": [ - {"text": "Calling compute_sum tool"}, - {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 5, "b": 3}}}, - ], - }, - { - "role": "assistant", - "content": [ - {"text": "Calling add_exclamation tool"}, - {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Goodbye"}}}, - ], - }, - { - "role": "assistant", - "content": [ - {"text": "Calling compute_sum tool"}, - {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 123, "b": 2}}}, - ], - }, - {"role": "assistant", "content": [{"text": "Success!"}]}, - ] - ) - return model - - -@pytest.fixture -def multi_tool_model_error(): - model = MockedModelProvider( - [ - { - "role": "assistant", - "content": [ - {"text": "Calling add_exclamation tool"}, - {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, - ], - }, - { - "role": "assistant", - "content": [ - {"text": "Calling compute_sum tool"}, - {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 5, "b": 3}}}, - ], - }, - { - "role": "assistant", - "content": [ - {"text": "Calling add_exclamation tool"}, - {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Goodbye"}}}, - ], - }, - { - "role": "assistant", - "content": [ - {"text": "Calling compute_sum tool"}, - # Set insufficient arguments to trigger error in tool - {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 123}}}, - ], - }, - {"role": "assistant", "content": [{"text": "Success!"}]}, - ] - ) - return model diff --git a/tests/mlmodel_strands/test_agent.py b/tests/mlmodel_strands/test_agent.py index af685668ad..6fa5e56a68 100644 --- a/tests/mlmodel_strands/test_agent.py +++ b/tests/mlmodel_strands/test_agent.py @@ -13,7 +13,7 @@ # limitations under the License. import pytest -from strands import Agent, tool +from strands import Agent from testing_support.fixtures import reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( disabled_ai_monitoring_record_content_settings, @@ -32,6 +32,17 @@ from newrelic.common.object_names import callable_name from newrelic.common.object_wrapper import transient_function_wrapper +from ._test_agent import ( + add_exclamation, + multi_tool_model, + multi_tool_model_error, + single_tool_model, + single_tool_model_runtime_error_agen, + single_tool_model_runtime_error_coro, + throw_exception_agen, + throw_exception_coro, +) + tool_recorded_event = [ ( {"type": "LlmTool"}, @@ -144,29 +155,12 @@ ] -# Example tool for testing purposes -@tool -async def add_exclamation(message: str) -> str: - return f"{message}!" - - -@tool -async def throw_exception_coro(message: str) -> str: - raise RuntimeError("Oops") - - -@tool -async def throw_exception_agen(message: str) -> str: - raise RuntimeError("Oops") - yield - - @reset_core_stats_engine() @validate_custom_events(events_with_context_attrs(tool_recorded_event)) @validate_custom_events(events_with_context_attrs(agent_recorded_event)) @validate_custom_event_count(count=2) @validate_transaction_metrics( - "test_agent:test_agent_invoke", + "mlmodel_strands.test_agent:test_agent_invoke", scoped_metrics=[ ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), @@ -194,7 +188,7 @@ def test_agent_invoke(set_trace_info, single_tool_model): @validate_custom_events(agent_recorded_event) @validate_custom_event_count(count=2) @validate_transaction_metrics( - "test_agent:test_agent_invoke_async", + "mlmodel_strands.test_agent:test_agent_invoke_async", scoped_metrics=[ ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), @@ -224,7 +218,7 @@ async def _test(): @validate_custom_events(agent_recorded_event) @validate_custom_event_count(count=2) @validate_transaction_metrics( - "test_agent:test_agent_stream_async", + "mlmodel_strands.test_agent:test_agent_stream_async", scoped_metrics=[ ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), @@ -260,7 +254,7 @@ async def _test(): @validate_custom_events(tool_events_sans_content(tool_recorded_event)) @validate_custom_event_count(count=2) @validate_transaction_metrics( - "test_agent:test_agent_invoke_no_content", + "mlmodel_strands.test_agent:test_agent_invoke_no_content", scoped_metrics=[ ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), @@ -301,7 +295,7 @@ def test_agent_invoke_disabled_ai_monitoring_events(set_trace_info, single_tool_ @validate_custom_events(agent_recorded_event_error) @validate_custom_event_count(count=1) @validate_transaction_metrics( - "test_agent:test_agent_invoke_error", + "mlmodel_strands.test_agent:test_agent_invoke_error", scoped_metrics=[("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1)], rollup_metrics=[("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1)], background_task=True, @@ -330,7 +324,7 @@ def _test(): @validate_custom_events(tool_recorded_event_error_coro) @validate_custom_event_count(count=2) @validate_transaction_metrics( - "test_agent:test_agent_invoke_tool_coro_runtime_error", + "mlmodel_strands.test_agent:test_agent_invoke_tool_coro_runtime_error", scoped_metrics=[ ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/throw_exception_coro", 1), @@ -358,7 +352,7 @@ def test_agent_invoke_tool_coro_runtime_error(set_trace_info, single_tool_model_ @validate_custom_events(tool_recorded_event_error_agen) @validate_custom_event_count(count=2) @validate_transaction_metrics( - "test_agent:test_agent_invoke_tool_agen_runtime_error", + "mlmodel_strands.test_agent:test_agent_invoke_tool_agen_runtime_error", scoped_metrics=[ ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/throw_exception_agen", 1), @@ -387,7 +381,7 @@ def test_agent_invoke_tool_agen_runtime_error(set_trace_info, single_tool_model_ @validate_custom_events(tool_recorded_event_forced_internal_error) @validate_custom_event_count(count=2) @validate_transaction_metrics( - "test_agent:test_agent_tool_forced_exception", + "mlmodel_strands.test_agent:test_agent_tool_forced_exception", scoped_metrics=[ ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), diff --git a/tests/mlmodel_strands/test_multiagent_graph.py b/tests/mlmodel_strands/test_multiagent_graph.py new file mode 100644 index 0000000000..7bd84fc901 --- /dev/null +++ b/tests/mlmodel_strands/test_multiagent_graph.py @@ -0,0 +1,233 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from testing_support.fixtures import reset_core_stats_engine, validate_attributes +from testing_support.ml_testing_utils import disabled_ai_monitoring_settings, events_with_context_attrs +from testing_support.validators.validate_custom_event import validate_custom_event_count +from testing_support.validators.validate_custom_events import validate_custom_events +from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics + +from newrelic.api.background_task import background_task +from newrelic.api.llm_custom_attributes import WithLlmCustomAttributes + +from ._test_multiagent_graph import agent_graph, analysis_agent, analysis_model, math_agent, math_model + +agent_recorded_events = [ + [ + {"type": "LlmAgent"}, + { + "duration": None, + "id": None, + "ingest_source": "Python", + "name": "math_agent", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + }, + ], + [ + {"type": "LlmAgent"}, + { + "duration": None, + "id": None, + "ingest_source": "Python", + "name": "analysis_agent", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + }, + ], +] + +tool_recorded_events = [ + [ + {"type": "LlmTool"}, + { + "agent_name": "math_agent", + "duration": None, + "id": None, + "ingest_source": "Python", + "input": "{'a': 15, 'b': 27}", + "name": "calculate_sum", + "output": "{'text': '42'}", + "run_id": "123", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + }, + ], + [ + {"type": "LlmTool"}, + { + "agent_name": "analysis_agent", + "duration": None, + "id": None, + "ingest_source": "Python", + "input": "{'value': 42}", + "name": "analyze_result", + "output": "{'text': 'The result 42 is positive'}", + "run_id": "456", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + }, + ], +] + + +@reset_core_stats_engine() +@validate_custom_events(events_with_context_attrs(tool_recorded_events)) +@validate_custom_events(events_with_context_attrs(agent_recorded_events)) +@validate_custom_event_count(count=4) # 2 LlmTool events, 2 LlmAgent events +@validate_transaction_metrics( + "mlmodel_strands.test_multiagent_graph:test_multiagent_graph_invoke", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_multiagent_graph_invoke(set_trace_info, agent_graph): + set_trace_info() + + with WithLlmCustomAttributes({"context": "attr"}): + response = agent_graph("Calculate the sum of 15 and 27.") + + assert response.execution_count == 2 + assert not response.failed_nodes + assert response.results["math"].result.message["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert ( + response.results["analysis"].result.message["content"][0]["text"] + == "The calculation is correct, and 42 is a positive integer result." + ) + + +@reset_core_stats_engine() +@validate_custom_events(tool_recorded_events) +@validate_custom_events(agent_recorded_events) +@validate_custom_event_count(count=4) # 2 LlmTool events, 2 LlmAgent events +@validate_transaction_metrics( + "mlmodel_strands.test_multiagent_graph:test_multiagent_graph_invoke_async", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_multiagent_graph_invoke_async(loop, set_trace_info, agent_graph): + set_trace_info() + + async def _test(): + response = await agent_graph.invoke_async("Calculate the sum of 15 and 27.") + + assert response.execution_count == 2 + assert not response.failed_nodes + assert response.results["math"].result.message["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert ( + response.results["analysis"].result.message["content"][0]["text"] + == "The calculation is correct, and 42 is a positive integer result." + ) + + loop.run_until_complete(_test()) + + +@reset_core_stats_engine() +@validate_custom_events(tool_recorded_events) +@validate_custom_events(agent_recorded_events) +@validate_custom_event_count(count=4) # 2 LlmTool events, 2 LlmAgent events +@validate_transaction_metrics( + "mlmodel_strands.test_multiagent_graph:test_multiagent_graph_stream_async", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_multiagent_graph_stream_async(loop, set_trace_info, agent_graph): + set_trace_info() + + async def _test(): + response = agent_graph.stream_async("Calculate the sum of 15 and 27.") + messages = [ + event["node_result"].result.message async for event in response if event["type"] == "multiagent_node_stop" + ] + + assert len(messages) == 2 + + assert messages[0]["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert messages[1]["content"][0]["text"] == "The calculation is correct, and 42 is a positive integer result." + + loop.run_until_complete(_test()) + + +@disabled_ai_monitoring_settings +@reset_core_stats_engine() +@validate_custom_event_count(count=0) +@background_task() +def test_multiagent_graph_invoke_disabled_ai_monitoring_events(set_trace_info, agent_graph): + set_trace_info() + + response = agent_graph("Calculate the sum of 15 and 27.") + + assert response.execution_count == 2 + assert not response.failed_nodes + assert response.results["math"].result.message["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert ( + response.results["analysis"].result.message["content"][0]["text"] + == "The calculation is correct, and 42 is a positive integer result." + ) + + +@reset_core_stats_engine() +@validate_custom_event_count(count=0) +def test_multiagent_graph_invoke_outside_txn(agent_graph): + response = agent_graph("Calculate the sum of 15 and 27.") + + assert response.execution_count == 2 + assert not response.failed_nodes + assert response.results["math"].result.message["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert ( + response.results["analysis"].result.message["content"][0]["text"] + == "The calculation is correct, and 42 is a positive integer result." + ) diff --git a/tests/mlmodel_strands/test_multiagent_swarm.py b/tests/mlmodel_strands/test_multiagent_swarm.py new file mode 100644 index 0000000000..bbcbb3e27c --- /dev/null +++ b/tests/mlmodel_strands/test_multiagent_swarm.py @@ -0,0 +1,260 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from testing_support.fixtures import reset_core_stats_engine, validate_attributes +from testing_support.ml_testing_utils import disabled_ai_monitoring_settings, events_with_context_attrs +from testing_support.validators.validate_custom_event import validate_custom_event_count +from testing_support.validators.validate_custom_events import validate_custom_events +from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics + +from newrelic.api.background_task import background_task +from newrelic.api.llm_custom_attributes import WithLlmCustomAttributes + +from ._test_multiagent_swarm import agent_swarm, analysis_agent, analysis_model, math_agent, math_model + +agent_recorded_events = [ + [ + {"type": "LlmAgent"}, + { + "duration": None, + "id": None, + "ingest_source": "Python", + "name": "math_agent", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + }, + ], + [ + {"type": "LlmAgent"}, + { + "duration": None, + "id": None, + "ingest_source": "Python", + "name": "analysis_agent", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + }, + ], +] + +tool_recorded_events = [ + [ + {"type": "LlmTool"}, + { + "agent_name": "math_agent", + "duration": None, + "id": None, + "ingest_source": "Python", + "input": "{'a': 15, 'b': 27}", + "name": "calculate_sum", + "output": "{'text': '42'}", + "run_id": "123", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + }, + ], + [ + {"type": "LlmTool"}, + { + "agent_name": "analysis_agent", + "duration": None, + "id": None, + "ingest_source": "Python", + "input": "{'value': 42}", + "name": "analyze_result", + "output": "{'text': 'The result 42 is positive'}", + "run_id": "456", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + }, + ], +] + +handoff_recorded_event = [ + [ + {"type": "LlmTool"}, + { + "agent_name": "math_agent", + "duration": None, + "id": None, + "ingest_source": "Python", + # This is the output from math_agent being sent to the handoff_to_agent tool, which will then be input to the analysis_agent + "input": "{'agent_name': 'analysis_agent', 'message': 'Analyze the result of the calculation done by the math_agent.', 'context': {'result': 42}}", + "name": "handoff_to_agent", + "output": "{'text': 'Handing off to analysis_agent: Analyze the result of the calculation done by the math_agent.'}", + "run_id": "789", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + }, + ] +] + + +@reset_core_stats_engine() +@validate_custom_events(events_with_context_attrs(tool_recorded_events)) +@validate_custom_events(events_with_context_attrs(agent_recorded_events)) +@validate_custom_events(events_with_context_attrs(handoff_recorded_event)) +@validate_custom_event_count(count=5) # 2 LlmTool events, 2 LlmAgent events, 1 LlmTool Handoff event +@validate_transaction_metrics( + "mlmodel_strands.test_multiagent_swarm:test_multiagent_swarm_invoke", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_multiagent_swarm_invoke(set_trace_info, agent_swarm): + set_trace_info() + + with WithLlmCustomAttributes({"context": "attr"}): + response = agent_swarm("Calculate the sum of 15 and 27.") + + assert response.execution_count == 2 + node_history = [node.node_id for node in response.node_history] + assert node_history == ["math_agent", "analysis_agent"] + assert response.results["math_agent"].result.message["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert ( + response.results["analysis_agent"].result.message["content"][0]["text"] + == "The calculation is correct, and 42 is a positive integer result." + ) + + +@reset_core_stats_engine() +@validate_custom_events(tool_recorded_events) +@validate_custom_events(agent_recorded_events) +@validate_custom_events(handoff_recorded_event) +@validate_custom_event_count(count=5) # 2 LlmTool events, 2 LlmAgent events, 1 LlmTool Handoff event +@validate_transaction_metrics( + "mlmodel_strands.test_multiagent_swarm:test_multiagent_swarm_invoke_async", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_multiagent_swarm_invoke_async(loop, set_trace_info, agent_swarm): + set_trace_info() + + async def _test(): + response = await agent_swarm.invoke_async("Calculate the sum of 15 and 27.") + + assert response.execution_count == 2 + node_history = [node.node_id for node in response.node_history] + assert node_history == ["math_agent", "analysis_agent"] + assert response.results["math_agent"].result.message["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert ( + response.results["analysis_agent"].result.message["content"][0]["text"] + == "The calculation is correct, and 42 is a positive integer result." + ) + + loop.run_until_complete(_test()) + + +@reset_core_stats_engine() +@validate_custom_events(tool_recorded_events) +@validate_custom_events(agent_recorded_events) +@validate_custom_events(handoff_recorded_event) +@validate_custom_event_count(count=5) # 2 LlmTool events, 2 LlmAgent events, 1 LlmTool Handoff event +@validate_transaction_metrics( + "mlmodel_strands.test_multiagent_swarm:test_multiagent_swarm_stream_async", + scoped_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + rollup_metrics=[ + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/math_agent", 1), + ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/analysis_agent", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/calculate_sum", 1), + ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/analyze_result", 1), + ], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_multiagent_swarm_stream_async(loop, set_trace_info, agent_swarm): + set_trace_info() + + async def _test(): + response = agent_swarm.stream_async("Calculate the sum of 15 and 27.") + messages = [ + event["node_result"].result.message async for event in response if event["type"] == "multiagent_node_stop" + ] + + assert len(messages) == 2 + + assert messages[0]["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert messages[1]["content"][0]["text"] == "The calculation is correct, and 42 is a positive integer result." + + loop.run_until_complete(_test()) + + +@disabled_ai_monitoring_settings +@reset_core_stats_engine() +@validate_custom_event_count(count=0) +@background_task() +def test_multiagent_swarm_invoke_disabled_ai_monitoring_events(set_trace_info, agent_swarm): + set_trace_info() + + response = agent_swarm("Calculate the sum of 15 and 27.") + + assert response.execution_count == 2 + node_history = [node.node_id for node in response.node_history] + assert node_history == ["math_agent", "analysis_agent"] + assert response.results["math_agent"].result.message["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert ( + response.results["analysis_agent"].result.message["content"][0]["text"] + == "The calculation is correct, and 42 is a positive integer result." + ) + + +@reset_core_stats_engine() +@validate_custom_event_count(count=0) +def test_multiagent_swarm_invoke_outside_txn(agent_swarm): + response = agent_swarm("Calculate the sum of 15 and 27.") + + assert response.execution_count == 2 + node_history = [node.node_id for node in response.node_history] + assert node_history == ["math_agent", "analysis_agent"] + assert response.results["math_agent"].result.message["content"][0]["text"] == "The sum of 15 and 27 is 42." + assert ( + response.results["analysis_agent"].result.message["content"][0]["text"] + == "The calculation is correct, and 42 is a positive integer result." + ) From 2ac14945eb4188e4af64de2542395242f6d82ff0 Mon Sep 17 00:00:00 2001 From: Shubham Goel Date: Mon, 8 Dec 2025 12:37:14 +0530 Subject: [PATCH 023/124] Fixed tool type bug for strands --- newrelic/hooks/mlmodel_strands.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/newrelic/hooks/mlmodel_strands.py b/newrelic/hooks/mlmodel_strands.py index bf849fd717..cf1a76cf28 100644 --- a/newrelic/hooks/mlmodel_strands.py +++ b/newrelic/hooks/mlmodel_strands.py @@ -416,7 +416,10 @@ async def aclose(self): def wrap_ToolRegister_register_tool(wrapped, instance, args, kwargs): bound_args = bind_args(wrapped, args, kwargs) - bound_args["tool"]._tool_func = ErrorTraceWrapper(bound_args["tool"]._tool_func) + tool = bound_args.get("tool") + + if hasattr(tool, "_tool_func"): + tool._tool_func = ErrorTraceWrapper(tool._tool_func) return wrapped(*args, **kwargs) From 7bea863271df6e6ede9260eaa12e32e0c28381e3 Mon Sep 17 00:00:00 2001 From: Lalleh Rafeei <84813886+lrafeei@users.noreply.github.com> Date: Mon, 8 Dec 2025 13:57:10 -0800 Subject: [PATCH 024/124] Pin langchain & langchain_core (#1604) --- tox.ini | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tox.ini b/tox.ini index 98cea6ee29..d3549c71a6 100644 --- a/tox.ini +++ b/tox.ini @@ -432,10 +432,10 @@ deps = mlmodel_openai-openailatest: openai[datalib] ; Required for openai testing mlmodel_openai: protobuf - ; Pinning to 0.1.16 while adding support for with_structured_output in chain tests - mlmodel_langchain: langchain + ; Pin to 1.1.0 temporarily + mlmodel_langchain: langchain<1.1.1 + mlmodel_langchain: langchain-core<1.1.1 mlmodel_langchain: langchain-community - mlmodel_langchain: langchain-core mlmodel_langchain: langchain-openai ; Required for langchain testing mlmodel_langchain: pypdf From 6860fc1c506054139eb1079ae73d2009bc00d648 Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Mon, 8 Dec 2025 14:15:40 -0800 Subject: [PATCH 025/124] Add safeguarding to converse attr extraction. (#1603) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- newrelic/hooks/external_botocore.py | 49 +++++++++++++++++++---------- 1 file changed, 32 insertions(+), 17 deletions(-) diff --git a/newrelic/hooks/external_botocore.py b/newrelic/hooks/external_botocore.py index d481ce8450..12dd4153f9 100644 --- a/newrelic/hooks/external_botocore.py +++ b/newrelic/hooks/external_botocore.py @@ -900,25 +900,40 @@ def _wrap_bedrock_runtime_converse(wrapped, instance, args, kwargs): def extract_bedrock_converse_attrs(kwargs, response, response_headers, model, span_id, trace_id): input_message_list = [] - # If a system message is supplied, it is under its own key in kwargs rather than with the other input messages - if "system" in kwargs.keys(): - input_message_list.extend({"role": "system", "content": result["text"]} for result in kwargs.get("system", [])) - - # kwargs["messages"] can hold multiple requests and responses to maintain conversation history - # We grab the last message (the newest request) in the list each time, so we don't duplicate recorded data - _input_messages = kwargs.get("messages", []) - _input_messages = _input_messages and (_input_messages[-1] or {}) - _input_messages = _input_messages.get("content", []) - input_message_list.extend( - [{"role": "user", "content": result["text"]} for result in _input_messages if "text" in result] - ) + try: + # If a system message is supplied, it is under its own key in kwargs rather than with the other input messages + if "system" in kwargs.keys(): + input_message_list.extend( + {"role": "system", "content": result["text"]} for result in kwargs.get("system", []) if "text" in result + ) + + # kwargs["messages"] can hold multiple requests and responses to maintain conversation history + # We grab the last message (the newest request) in the list each time, so we don't duplicate recorded data + _input_messages = kwargs.get("messages", []) + _input_messages = _input_messages and (_input_messages[-1] or {}) + _input_messages = _input_messages.get("content", []) + input_message_list.extend( + [{"role": "user", "content": result["text"]} for result in _input_messages if "text" in result] + ) + except Exception: + _logger.warning( + "Exception occurred in botocore instrumentation for AWS Bedrock: Failed to extract input messages from Converse request. Report this issue to New Relic Support.", + exc_info=True, + ) output_message_list = None - if "output" in response: - output_message_list = [ - {"role": "assistant", "content": result["text"]} - for result in response.get("output").get("message").get("content", []) - ] + try: + if "output" in response: + output_message_list = [ + {"role": "assistant", "content": result["text"]} + for result in response.get("output").get("message").get("content", []) + if "text" in result + ] + except Exception: + _logger.warning( + "Exception occurred in botocore instrumentation for AWS Bedrock: Failed to extract output messages from onverse response. Report this issue to New Relic Support.", + exc_info=True, + ) bedrock_attrs = { "request_id": response_headers.get("x-amzn-requestid"), From 38d7547314882c15c58d16a93f13c5fcd552d253 Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Tue, 7 Oct 2025 10:34:31 -0700 Subject: [PATCH 026/124] Bump tests. From e6cb2bb1d3be80b080fd5526e95808f55ea59986 Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Tue, 7 Oct 2025 10:57:04 -0700 Subject: [PATCH 027/124] Add response token count logic to Gemini instrumentation. (#1486) * Add response token count logic to Gemini instrumentation. * Update token counting util functions. * Linting * Add response token count logic to Gemini instrumentation. * Update token counting util functions. * [MegaLinter] Apply linters fixes * Bump tests. --------- Co-authored-by: Tim Pansino --- newrelic/hooks/mlmodel_gemini.py | 152 ++++++++++++------ tests/mlmodel_gemini/test_embeddings.py | 6 +- tests/mlmodel_gemini/test_embeddings_error.py | 62 +------ tests/mlmodel_gemini/test_text_generation.py | 12 +- .../test_text_generation_error.py | 81 +--------- tests/testing_support/ml_testing_utils.py | 19 +++ 6 files changed, 139 insertions(+), 193 deletions(-) diff --git a/newrelic/hooks/mlmodel_gemini.py b/newrelic/hooks/mlmodel_gemini.py index 6fffbebb47..d7585e0b60 100644 --- a/newrelic/hooks/mlmodel_gemini.py +++ b/newrelic/hooks/mlmodel_gemini.py @@ -176,20 +176,24 @@ def _record_embedding_success(transaction, embedding_id, linking_metadata, kwarg embedding_content = str(embedding_content) request_model = kwargs.get("model") + embedding_token_count = ( + settings.ai_monitoring.llm_token_count_callback(request_model, embedding_content) + if settings.ai_monitoring.llm_token_count_callback + else None + ) + full_embedding_response_dict = { "id": embedding_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(request_model, embedding_content) - if settings.ai_monitoring.llm_token_count_callback - else None - ), "request.model": request_model, "duration": ft.duration * 1000, "vendor": "gemini", "ingest_source": "Python", } + if embedding_token_count: + full_embedding_response_dict["response.usage.total_tokens"] = embedding_token_count + if settings.ai_monitoring.record_content.enabled: full_embedding_response_dict["input"] = embedding_content @@ -303,15 +307,13 @@ def _record_generation_error(transaction, linking_metadata, completion_id, kwarg "Unable to parse input message to Gemini LLM. Message content and role will be omitted from " "corresponding LlmChatCompletionMessage event. " ) + # Extract the input message content and role from the input message if it exists + input_message_content, input_role = _parse_input_message(input_message) if input_message else (None, None) - generation_config = kwargs.get("config") - if generation_config: - request_temperature = getattr(generation_config, "temperature", None) - request_max_tokens = getattr(generation_config, "max_output_tokens", None) - else: - request_temperature = None - request_max_tokens = None + # Extract data from generation config object + request_temperature, request_max_tokens = _extract_generation_config(kwargs) + # Prepare error attributes notice_error_attributes = { "http.statusCode": getattr(exc, "code", None), "error.message": getattr(exc, "message", None), @@ -352,15 +354,17 @@ def _record_generation_error(transaction, linking_metadata, completion_id, kwarg create_chat_completion_message_event( transaction, - input_message, + input_message_content, + input_role, completion_id, span_id, trace_id, # Passing the request model as the response model here since we do not have access to a response model request_model, - request_model, llm_metadata, output_message_list, + # We do not record token counts in error cases, so set all_token_counts to True so the pipeline tokenizer does not run + True, request_timestamp, ) except Exception: @@ -388,6 +392,7 @@ def _handle_generation_success( def _record_generation_success( transaction, linking_metadata, completion_id, kwargs, ft, response, request_timestamp=None ): + settings = transaction.settings or global_settings() span_id = linking_metadata.get("span.id") trace_id = linking_metadata.get("trace.id") try: @@ -396,12 +401,14 @@ def _record_generation_success( # finish_reason is an enum, so grab just the stringified value from it to report finish_reason = response.get("candidates")[0].get("finish_reason").value output_message_list = [response.get("candidates")[0].get("content")] + token_usage = response.get("usage_metadata") or {} else: # Set all values to NoneTypes since we cannot access them through kwargs or another method that doesn't # require the response object response_model = None output_message_list = [] finish_reason = None + token_usage = {} request_model = kwargs.get("model") @@ -423,13 +430,44 @@ def _record_generation_success( "corresponding LlmChatCompletionMessage event. " ) - generation_config = kwargs.get("config") - if generation_config: - request_temperature = getattr(generation_config, "temperature", None) - request_max_tokens = getattr(generation_config, "max_output_tokens", None) + input_message_content, input_role = _parse_input_message(input_message) if input_message else (None, None) + + # Parse output message content + # This list should have a length of 1 to represent the output message + # Parse the message text out to pass to any registered token counting callback + output_message_content = output_message_list[0].get("parts")[0].get("text") if output_message_list else None + + # Extract token counts from response object + if token_usage: + response_prompt_tokens = token_usage.get("prompt_token_count") + response_completion_tokens = token_usage.get("candidates_token_count") + response_total_tokens = token_usage.get("total_token_count") + else: - request_temperature = None - request_max_tokens = None + response_prompt_tokens = None + response_completion_tokens = None + response_total_tokens = None + + # Calculate token counts by checking if a callback is registered and if we have the necessary content to pass + # to it. If not, then we use the token counts provided in the response object + prompt_tokens = ( + settings.ai_monitoring.llm_token_count_callback(request_model, input_message_content) + if settings.ai_monitoring.llm_token_count_callback and input_message_content + else response_prompt_tokens + ) + completion_tokens = ( + settings.ai_monitoring.llm_token_count_callback(response_model, output_message_content) + if settings.ai_monitoring.llm_token_count_callback and output_message_content + else response_completion_tokens + ) + total_tokens = ( + prompt_tokens + completion_tokens if all([prompt_tokens, completion_tokens]) else response_total_tokens + ) + + all_token_counts = bool(prompt_tokens and completion_tokens and total_tokens) + + # Extract generation config + request_temperature, request_max_tokens = _extract_generation_config(kwargs) full_chat_completion_summary_dict = { "id": completion_id, @@ -450,68 +488,80 @@ def _record_generation_success( "timestamp": request_timestamp, } + if all_token_counts: + full_chat_completion_summary_dict["response.usage.prompt_tokens"] = prompt_tokens + full_chat_completion_summary_dict["response.usage.completion_tokens"] = completion_tokens + full_chat_completion_summary_dict["response.usage.total_tokens"] = total_tokens + llm_metadata = _get_llm_attributes(transaction) full_chat_completion_summary_dict.update(llm_metadata) transaction.record_custom_event("LlmChatCompletionSummary", full_chat_completion_summary_dict) create_chat_completion_message_event( transaction, - input_message, + input_message_content, + input_role, completion_id, span_id, trace_id, response_model, - request_model, llm_metadata, output_message_list, + all_token_counts, request_timestamp, ) except Exception: _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) +def _parse_input_message(input_message): + # The input_message will be a string if generate_content was called directly. In this case, we don't have + # access to the role, so we default to user since this was an input message + if isinstance(input_message, str): + return input_message, "user" + # The input_message will be a Google Content type if send_message was called, so we parse out the message + # text and role (which should be "user") + elif isinstance(input_message, google.genai.types.Content): + return input_message.parts[0].text, input_message.role + else: + return None, None + + +def _extract_generation_config(kwargs): + generation_config = kwargs.get("config") + if generation_config: + request_temperature = getattr(generation_config, "temperature", None) + request_max_tokens = getattr(generation_config, "max_output_tokens", None) + else: + request_temperature = None + request_max_tokens = None + + return request_temperature, request_max_tokens + + def create_chat_completion_message_event( transaction, - input_message, + input_message_content, + input_role, chat_completion_id, span_id, trace_id, response_model, - request_model, llm_metadata, output_message_list, + all_token_counts, request_timestamp=None, ): try: settings = transaction.settings or global_settings() - if input_message: - # The input_message will be a string if generate_content was called directly. In this case, we don't have - # access to the role, so we default to user since this was an input message - if isinstance(input_message, str): - input_message_content = input_message - input_role = "user" - # The input_message will be a Google Content type if send_message was called, so we parse out the message - # text and role (which should be "user") - elif isinstance(input_message, google.genai.types.Content): - input_message_content = input_message.parts[0].text - input_role = input_message.role - # Set input data to NoneTypes to ensure token_count callback is not called - else: - input_message_content = None - input_role = None - + if input_message_content: message_id = str(uuid.uuid4()) chat_completion_input_message_dict = { "id": message_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(request_model, input_message_content) - if settings.ai_monitoring.llm_token_count_callback and input_message_content - else None - ), "role": input_role, "completion_id": chat_completion_id, # The input message will always be the first message in our request/ response sequence so this will @@ -521,6 +571,8 @@ def create_chat_completion_message_event( "vendor": "gemini", "ingest_source": "Python", } + if all_token_counts: + chat_completion_input_message_dict["token_count"] = 0 if settings.ai_monitoring.record_content.enabled: chat_completion_input_message_dict["content"] = input_message_content @@ -539,7 +591,7 @@ def create_chat_completion_message_event( # Add one to the index to account for the single input message so our sequence value is accurate for # the output message - if input_message: + if input_message_content: index += 1 message_id = str(uuid.uuid4()) @@ -548,11 +600,6 @@ def create_chat_completion_message_event( "id": message_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(response_model, message_content) - if settings.ai_monitoring.llm_token_count_callback - else None - ), "role": message.get("role"), "completion_id": chat_completion_id, "sequence": index, @@ -562,6 +609,9 @@ def create_chat_completion_message_event( "is_response": True, } + if all_token_counts: + chat_completion_output_message_dict["token_count"] = 0 + if settings.ai_monitoring.record_content.enabled: chat_completion_output_message_dict["content"] = message_content if request_timestamp: diff --git a/tests/mlmodel_gemini/test_embeddings.py b/tests/mlmodel_gemini/test_embeddings.py index 0fc92897b6..5b4e30f860 100644 --- a/tests/mlmodel_gemini/test_embeddings.py +++ b/tests/mlmodel_gemini/test_embeddings.py @@ -15,7 +15,7 @@ import google.genai from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_to_embedding_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -93,7 +93,7 @@ def test_gemini_embedding_sync_no_content(gemini_dev_client, set_trace_info): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(embedding_recorded_events)) +@validate_custom_events(add_token_count_to_embedding_events(embedding_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_embeddings:test_gemini_embedding_sync_with_token_count", @@ -177,7 +177,7 @@ def test_gemini_embedding_async_no_content(gemini_dev_client, loop, set_trace_in @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(embedding_recorded_events)) +@validate_custom_events(add_token_count_to_embedding_events(embedding_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_embeddings:test_gemini_embedding_async_with_token_count", diff --git a/tests/mlmodel_gemini/test_embeddings_error.py b/tests/mlmodel_gemini/test_embeddings_error.py index a65a6c2c6f..f0e7aac58a 100644 --- a/tests/mlmodel_gemini/test_embeddings_error.py +++ b/tests/mlmodel_gemini/test_embeddings_error.py @@ -16,12 +16,10 @@ import google.genai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -159,34 +157,6 @@ def test_embeddings_invalid_request_error_invalid_model(gemini_dev_client, set_t gemini_dev_client.models.embed_content(contents="Embedded: Model does not exist.", model="does-not-exist") -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(google.genai.errors.ClientError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "NOT_FOUND", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={ - "error.message": "models/does-not-exist is not found for API version v1beta, or is not supported for embedContent. Call ListModels to see the list of available models and their supported methods." - } -) -@validate_transaction_metrics( - name="test_embeddings_error:test_embeddings_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/embedding/Gemini/embed_content", 1)], - rollup_metrics=[("Llm/embedding/Gemini/embed_content", 1)], - custom_metrics=[(f"Supportability/Python/ML/Gemini/{google.genai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_with_token_count(gemini_dev_client, set_trace_info): - with pytest.raises(google.genai.errors.ClientError): - set_trace_info() - gemini_dev_client.models.embed_content(contents="Embedded: Model does not exist.", model="does-not-exist") - - embedding_invalid_key_error_events = [ ( {"type": "LlmEmbedding"}, @@ -326,36 +296,6 @@ def test_embeddings_async_invalid_request_error_invalid_model(gemini_dev_client, ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(google.genai.errors.ClientError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "NOT_FOUND", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={ - "error.message": "models/does-not-exist is not found for API version v1beta, or is not supported for embedContent. Call ListModels to see the list of available models and their supported methods." - } -) -@validate_transaction_metrics( - name="test_embeddings_error:test_embeddings_async_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/embedding/Gemini/embed_content", 1)], - rollup_metrics=[("Llm/embedding/Gemini/embed_content", 1)], - custom_metrics=[(f"Supportability/Python/ML/Gemini/{google.genai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_async_invalid_request_error_invalid_model_with_token_count(gemini_dev_client, loop, set_trace_info): - with pytest.raises(google.genai.errors.ClientError): - set_trace_info() - loop.run_until_complete( - gemini_dev_client.models.embed_content(contents="Embedded: Model does not exist.", model="does-not-exist") - ) - - # Wrong api_key provided @dt_enabled @reset_core_stats_engine() diff --git a/tests/mlmodel_gemini/test_text_generation.py b/tests/mlmodel_gemini/test_text_generation.py index 1c789f8197..ad35024afe 100644 --- a/tests/mlmodel_gemini/test_text_generation.py +++ b/tests/mlmodel_gemini/test_text_generation.py @@ -15,7 +15,7 @@ import google.genai from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -51,6 +51,9 @@ "vendor": "gemini", "ingest_source": "Python", "response.number_of_messages": 2, + "response.usage.prompt_tokens": 9, + "response.usage.completion_tokens": 13, + "response.usage.total_tokens": 22, }, ), ( @@ -62,6 +65,7 @@ "llm.foo": "bar", "span_id": None, "trace_id": "trace-id", + "token_count": 0, "content": "How many letters are in the word Python?", "role": "user", "completion_id": None, @@ -80,6 +84,7 @@ "llm.foo": "bar", "span_id": None, "trace_id": "trace-id", + "token_count": 0, "content": 'There are **6** letters in the word "Python".\n', "role": "model", "completion_id": None, @@ -186,7 +191,8 @@ def test_gemini_text_generation_sync_no_content(gemini_dev_client, set_trace_inf @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(text_generation_recorded_events)) +# Ensure LLM callback is invoked and response token counts are overridden +@validate_custom_events(add_token_counts_to_chat_events(text_generation_recorded_events)) @validate_custom_event_count(count=3) @validate_transaction_metrics( name="test_text_generation:test_gemini_text_generation_sync_with_token_count", @@ -327,7 +333,7 @@ def test_gemini_text_generation_async_no_content(gemini_dev_client, loop, set_tr @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(text_generation_recorded_events)) +@validate_custom_events(add_token_counts_to_chat_events(text_generation_recorded_events)) @validate_custom_event_count(count=3) @validate_transaction_metrics( name="test_text_generation:test_gemini_text_generation_async_with_token_count", diff --git a/tests/mlmodel_gemini/test_text_generation_error.py b/tests/mlmodel_gemini/test_text_generation_error.py index eb8aec950f..37f5b06467 100644 --- a/tests/mlmodel_gemini/test_text_generation_error.py +++ b/tests/mlmodel_gemini/test_text_generation_error.py @@ -17,13 +17,11 @@ import google.genai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, events_with_context_attrs, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -65,6 +63,7 @@ "trace_id": "trace-id", "content": "How many letters are in the word Python?", "role": "user", + "token_count": 0, "completion_id": None, "sequence": 0, "vendor": "gemini", @@ -171,6 +170,7 @@ def _test(): "trace_id": "trace-id", "content": "Model does not exist.", "role": "user", + "token_count": 0, "completion_id": None, "response.model": "does-not-exist", "sequence": 0, @@ -183,39 +183,6 @@ def _test(): @dt_enabled @reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(google.genai.errors.ClientError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "NOT_FOUND", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={ - "error.message": "models/does-not-exist is not found for API version v1beta, or is not supported for generateContent. Call ListModels to see the list of available models and their supported methods." - } -) -@validate_transaction_metrics( - "test_text_generation_error:test_text_generation_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/completion/Gemini/generate_content", 1)], - rollup_metrics=[("Llm/completion/Gemini/generate_content", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_text_generation_invalid_request_error_invalid_model_with_token_count(gemini_dev_client, set_trace_info): - with pytest.raises(google.genai.errors.ClientError): - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - gemini_dev_client.models.generate_content( - model="does-not-exist", - contents=["Model does not exist."], - config=google.genai.types.GenerateContentConfig(max_output_tokens=100, temperature=0.7), - ) - - -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) @validate_error_trace_attributes( callable_name(google.genai.errors.ClientError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "NOT_FOUND", "http.statusCode": 404}}, @@ -231,7 +198,7 @@ def test_text_generation_invalid_request_error_invalid_model_with_token_count(ge rollup_metrics=[("Llm/completion/Gemini/generate_content", 1)], background_task=True, ) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) +@validate_custom_events(expected_events_on_invalid_model_error) @validate_custom_event_count(count=2) @background_task() def test_text_generation_invalid_request_error_invalid_model_chat(gemini_dev_client, set_trace_info): @@ -272,6 +239,7 @@ def test_text_generation_invalid_request_error_invalid_model_chat(gemini_dev_cli "trace_id": "trace-id", "content": "Invalid API key.", "role": "user", + "token_count": 0, "response.model": "gemini-flash-2.0", "completion_id": None, "sequence": 0, @@ -383,43 +351,6 @@ def _test(): @dt_enabled @reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(google.genai.errors.ClientError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "NOT_FOUND", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={ - "error.message": "models/does-not-exist is not found for API version v1beta, or is not supported for generateContent. Call ListModels to see the list of available models and their supported methods." - } -) -@validate_transaction_metrics( - "test_text_generation_error:test_text_generation_async_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/completion/Gemini/generate_content", 1)], - rollup_metrics=[("Llm/completion/Gemini/generate_content", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_text_generation_async_invalid_request_error_invalid_model_with_token_count( - gemini_dev_client, loop, set_trace_info -): - with pytest.raises(google.genai.errors.ClientError): - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - loop.run_until_complete( - gemini_dev_client.models.generate_content( - model="does-not-exist", - contents=["Model does not exist."], - config=google.genai.types.GenerateContentConfig(max_output_tokens=100, temperature=0.7), - ) - ) - - -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) @validate_error_trace_attributes( callable_name(google.genai.errors.ClientError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "NOT_FOUND", "http.statusCode": 404}}, @@ -435,7 +366,7 @@ def test_text_generation_async_invalid_request_error_invalid_model_with_token_co rollup_metrics=[("Llm/completion/Gemini/generate_content", 1)], background_task=True, ) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) +@validate_custom_events(expected_events_on_invalid_model_error) @validate_custom_event_count(count=2) @background_task() def test_text_generation_async_invalid_request_error_invalid_model_chat(gemini_dev_client, loop, set_trace_info): diff --git a/tests/testing_support/ml_testing_utils.py b/tests/testing_support/ml_testing_utils.py index 4ff70c7ed4..55dbd08105 100644 --- a/tests/testing_support/ml_testing_utils.py +++ b/tests/testing_support/ml_testing_utils.py @@ -29,6 +29,7 @@ def llm_token_count_callback(model, content): return 105 +# This will be removed once all LLM instrumentations have been converted to use new token count design def add_token_count_to_events(expected_events): events = copy.deepcopy(expected_events) for event in events: @@ -37,6 +38,24 @@ def add_token_count_to_events(expected_events): return events +def add_token_count_to_embedding_events(expected_events): + events = copy.deepcopy(expected_events) + for event in events: + if event[0]["type"] == "LlmEmbedding": + event[1]["response.usage.total_tokens"] = 105 + return events + + +def add_token_counts_to_chat_events(expected_events): + events = copy.deepcopy(expected_events) + for event in events: + if event[0]["type"] == "LlmChatCompletionSummary": + event[1]["response.usage.prompt_tokens"] = 105 + event[1]["response.usage.completion_tokens"] = 105 + event[1]["response.usage.total_tokens"] = 210 + return events + + def events_sans_content(event): new_event = copy.deepcopy(event) for _event in new_event: From f4b9faaa688c981b4495959454c960cef17012ae Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Tue, 7 Oct 2025 13:14:56 -0700 Subject: [PATCH 028/124] Add response token count logic to OpenAI instrumentation. (#1498) * Add OpenAI token counts. * Add token counts to langchain + openai tests. * Remove unused expected events. * Linting * Add OpenAI token counts. * Add token counts to langchain + openai tests. * Remove unused expected events. * [MegaLinter] Apply linters fixes --------- Co-authored-by: Tim Pansino --- newrelic/hooks/mlmodel_openai.py | 87 ++++++++--- tests/mlmodel_langchain/test_chain.py | 8 + tests/mlmodel_openai/test_chat_completion.py | 12 +- .../test_chat_completion_error.py | 71 +-------- .../test_chat_completion_error_v1.py | 142 +----------------- .../test_chat_completion_stream.py | 101 ++++++++++++- .../test_chat_completion_stream_error.py | 75 +-------- .../test_chat_completion_stream_error_v1.py | 80 +--------- .../test_chat_completion_stream_v1.py | 11 +- .../mlmodel_openai/test_chat_completion_v1.py | 12 +- tests/mlmodel_openai/test_embeddings.py | 7 +- .../test_embeddings_error_v1.py | 120 +-------------- tests/mlmodel_openai/test_embeddings_v1.py | 7 +- tests/testing_support/ml_testing_utils.py | 8 + 14 files changed, 241 insertions(+), 500 deletions(-) diff --git a/newrelic/hooks/mlmodel_openai.py b/newrelic/hooks/mlmodel_openai.py index 59f7060394..26b51e52f9 100644 --- a/newrelic/hooks/mlmodel_openai.py +++ b/newrelic/hooks/mlmodel_openai.py @@ -133,11 +133,11 @@ def create_chat_completion_message_event( span_id, trace_id, response_model, - request_model, response_id, request_id, llm_metadata, output_message_list, + all_token_counts, request_timestamp=None, ): settings = transaction.settings if transaction.settings is not None else global_settings() @@ -158,11 +158,6 @@ def create_chat_completion_message_event( "request_id": request_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(request_model, message_content) - if settings.ai_monitoring.llm_token_count_callback - else None - ), "role": message.get("role"), "completion_id": chat_completion_id, "sequence": index, @@ -171,6 +166,9 @@ def create_chat_completion_message_event( "ingest_source": "Python", } + if all_token_counts: + chat_completion_input_message_dict["token_count"] = 0 + if settings.ai_monitoring.record_content.enabled: chat_completion_input_message_dict["content"] = message_content if request_timestamp: @@ -200,11 +198,6 @@ def create_chat_completion_message_event( "request_id": request_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(response_model, message_content) - if settings.ai_monitoring.llm_token_count_callback - else None - ), "role": message.get("role"), "completion_id": chat_completion_id, "sequence": index, @@ -214,6 +207,9 @@ def create_chat_completion_message_event( "is_response": True, } + if all_token_counts: + chat_completion_output_message_dict["token_count"] = 0 + if settings.ai_monitoring.record_content.enabled: chat_completion_output_message_dict["content"] = message_content if request_timestamp: @@ -289,15 +285,18 @@ def _record_embedding_success(transaction, embedding_id, linking_metadata, kwarg else getattr(attribute_response, "organization", None) ) + response_total_tokens = attribute_response.get("usage", {}).get("total_tokens") if response else None + + total_tokens = ( + settings.ai_monitoring.llm_token_count_callback(response_model, input_) + if settings.ai_monitoring.llm_token_count_callback and input_ + else response_total_tokens + ) + full_embedding_response_dict = { "id": embedding_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(response_model, input_) - if settings.ai_monitoring.llm_token_count_callback - else None - ), "request.model": kwargs.get("model") or kwargs.get("engine"), "request_id": request_id, "duration": ft.duration * 1000, @@ -322,6 +321,7 @@ def _record_embedding_success(transaction, embedding_id, linking_metadata, kwarg "response.headers.ratelimitRemainingRequests": check_rate_limit_header( response_headers, "x-ratelimit-remaining-requests", True ), + "response.usage.total_tokens": total_tokens, "vendor": "openai", "ingest_source": "Python", } @@ -492,12 +492,15 @@ def _handle_completion_success( def _record_completion_success( transaction, linking_metadata, completion_id, kwargs, ft, response_headers, response, request_timestamp=None ): + settings = transaction.settings if transaction.settings is not None else global_settings() span_id = linking_metadata.get("span.id") trace_id = linking_metadata.get("trace.id") + try: if response: response_model = response.get("model") response_id = response.get("id") + token_usage = response.get("usage") or {} output_message_list = [] finish_reason = None choices = response.get("choices") or [] @@ -511,6 +514,7 @@ def _record_completion_success( else: response_model = kwargs.get("response.model") response_id = kwargs.get("id") + token_usage = {} output_message_list = [] finish_reason = kwargs.get("finish_reason") if "content" in kwargs: @@ -522,10 +526,44 @@ def _record_completion_success( output_message_list = [] request_model = kwargs.get("model") or kwargs.get("engine") - request_id = response_headers.get("x-request-id") - organization = response_headers.get("openai-organization") or getattr(response, "organization", None) messages = kwargs.get("messages") or [{"content": kwargs.get("prompt"), "role": "user"}] input_message_list = list(messages) + + # Extract token counts from response object + if token_usage: + response_prompt_tokens = token_usage.get("prompt_tokens") + response_completion_tokens = token_usage.get("completion_tokens") + response_total_tokens = token_usage.get("total_tokens") + + else: + response_prompt_tokens = None + response_completion_tokens = None + response_total_tokens = None + + # Calculate token counts by checking if a callback is registered and if we have the necessary content to pass + # to it. If not, then we use the token counts provided in the response object + input_message_content = " ".join([msg.get("content", "") for msg in input_message_list if msg.get("content")]) + prompt_tokens = ( + settings.ai_monitoring.llm_token_count_callback(request_model, input_message_content) + if settings.ai_monitoring.llm_token_count_callback and input_message_content + else response_prompt_tokens + ) + output_message_content = " ".join([msg.get("content", "") for msg in output_message_list if msg.get("content")]) + completion_tokens = ( + settings.ai_monitoring.llm_token_count_callback(response_model, output_message_content) + if settings.ai_monitoring.llm_token_count_callback and output_message_content + else response_completion_tokens + ) + + total_tokens = ( + prompt_tokens + completion_tokens if all([prompt_tokens, completion_tokens]) else response_total_tokens + ) + + all_token_counts = bool(prompt_tokens and completion_tokens and total_tokens) + + request_id = response_headers.get("x-request-id") + organization = response_headers.get("openai-organization") or getattr(response, "organization", None) + full_chat_completion_summary_dict = { "id": completion_id, "span_id": span_id, @@ -571,6 +609,12 @@ def _record_completion_success( "response.number_of_messages": len(input_message_list) + len(output_message_list), "timestamp": request_timestamp, } + + if all_token_counts: + full_chat_completion_summary_dict["response.usage.prompt_tokens"] = prompt_tokens + full_chat_completion_summary_dict["response.usage.completion_tokens"] = completion_tokens + full_chat_completion_summary_dict["response.usage.total_tokens"] = total_tokens + llm_metadata = _get_llm_attributes(transaction) full_chat_completion_summary_dict.update(llm_metadata) transaction.record_custom_event("LlmChatCompletionSummary", full_chat_completion_summary_dict) @@ -582,11 +626,11 @@ def _record_completion_success( span_id, trace_id, response_model, - request_model, response_id, request_id, llm_metadata, output_message_list, + all_token_counts, request_timestamp, ) except Exception: @@ -598,6 +642,7 @@ def _record_completion_error(transaction, linking_metadata, completion_id, kwarg trace_id = linking_metadata.get("trace.id") request_message_list = kwargs.get("messages", None) or [] notice_error_attributes = {} + try: if OPENAI_V1: response = getattr(exc, "response", None) @@ -663,6 +708,7 @@ def _record_completion_error(transaction, linking_metadata, completion_id, kwarg output_message_list = [] if "content" in kwargs: output_message_list = [{"content": kwargs.get("content"), "role": kwargs.get("role")}] + create_chat_completion_message_event( transaction, request_message_list, @@ -670,11 +716,12 @@ def _record_completion_error(transaction, linking_metadata, completion_id, kwarg span_id, trace_id, kwargs.get("response.model"), - request_model, response_id, request_id, llm_metadata, output_message_list, + # We do not record token counts in error cases, so set all_token_counts to True so the pipeline tokenizer does not run + True, request_timestamp, ) except Exception: diff --git a/tests/mlmodel_langchain/test_chain.py b/tests/mlmodel_langchain/test_chain.py index 2f52f85504..d859b41c84 100644 --- a/tests/mlmodel_langchain/test_chain.py +++ b/tests/mlmodel_langchain/test_chain.py @@ -397,6 +397,7 @@ "response.headers.ratelimitResetRequests": "20ms", "response.headers.ratelimitRemainingTokens": 999992, "response.headers.ratelimitRemainingRequests": 2999, + "response.usage.total_tokens": 8, "vendor": "openai", "ingest_source": "Python", "input": "[[3923, 374, 220, 17, 489, 220, 19, 30]]", @@ -420,6 +421,7 @@ "response.headers.ratelimitResetRequests": "20ms", "response.headers.ratelimitRemainingTokens": 999998, "response.headers.ratelimitRemainingRequests": 2999, + "response.usage.total_tokens": 1, "vendor": "openai", "ingest_source": "Python", "input": "[[10590]]", @@ -493,6 +495,9 @@ "response.headers.ratelimitResetRequests": "8.64s", "response.headers.ratelimitRemainingTokens": 199912, "response.headers.ratelimitRemainingRequests": 9999, + "response.usage.prompt_tokens": 73, + "response.usage.completion_tokens": 375, + "response.usage.total_tokens": 448, "response.number_of_messages": 3, }, ], @@ -509,6 +514,7 @@ "sequence": 0, "response.model": "gpt-3.5-turbo-0125", "vendor": "openai", + "token_count": 0, "ingest_source": "Python", "content": "You are a generator of quiz questions for a seminar. Use the following pieces of retrieved context to generate 5 multiple choice questions (A,B,C,D) on the subject matter. Use a three sentence maximum and keep the answer concise. Render the output as HTML\n\nWhat is 2 + 4?", }, @@ -526,6 +532,7 @@ "sequence": 1, "response.model": "gpt-3.5-turbo-0125", "vendor": "openai", + "token_count": 0, "ingest_source": "Python", "content": "math", }, @@ -543,6 +550,7 @@ "sequence": 2, "response.model": "gpt-3.5-turbo-0125", "vendor": "openai", + "token_count": 0, "ingest_source": "Python", "is_response": True, "content": "```html\n\n\n\n Math Quiz\n\n\n

Math Quiz Questions

\n
    \n
  1. What is the result of 5 + 3?
    2. \n
      \n
    • A) 7
      • \n
    • B) 8
      • \n
    • C) 9
      • \n
    • D) 10
      • \n
    \n
  2. What is the product of 6 x 7?
    3. \n
      \n
    • A) 36
      • \n
    • B) 42
      • \n
    • C) 48
      • \n
    • D) 56
      • \n
    \n
  3. What is the square root of 64?
    4. \n
      \n
    • A) 6
      • \n
    • B) 7
      • \n
    • C) 8
      • \n
    • D) 9
      • \n
    \n
  4. What is the result of 12 / 4?
    5. \n
      \n
    • A) 2
      • \n
    • B) 3
      • \n
    • C) 4
      • \n
    • D) 5
      • \n
    \n
  5. What is the sum of 15 + 9?
    6. \n
      \n
    • A) 22
      • \n
    • B) 23
      • \n
    • C) 24
      • \n
    • D) 25
      • \n
    \n
\n\n\n```", diff --git a/tests/mlmodel_openai/test_chat_completion.py b/tests/mlmodel_openai/test_chat_completion.py index 89208ab268..9bb57e48b5 100644 --- a/tests/mlmodel_openai/test_chat_completion.py +++ b/tests/mlmodel_openai/test_chat_completion.py @@ -15,7 +15,7 @@ import openai from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, disabled_ai_monitoring_streaming_settings, @@ -56,6 +56,9 @@ "response.organization": "new-relic-nkmd8b", "request.temperature": 0.7, "request.max_tokens": 100, + "response.usage.completion_tokens": 11, + "response.usage.total_tokens": 64, + "response.usage.prompt_tokens": 53, "response.choices.finish_reason": "stop", "response.headers.llmVersion": "2020-10-01", "response.headers.ratelimitLimitRequests": 200, @@ -83,6 +86,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "gpt-3.5-turbo-0613", "vendor": "openai", "ingest_source": "Python", @@ -102,6 +106,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "gpt-3.5-turbo-0613", "vendor": "openai", "ingest_source": "Python", @@ -121,6 +126,7 @@ "role": "assistant", "completion_id": None, "sequence": 2, + "token_count": 0, "response.model": "gpt-3.5-turbo-0613", "vendor": "openai", "is_response": True, @@ -176,7 +182,7 @@ def test_openai_chat_completion_sync_no_content(set_trace_info): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events(add_token_counts_to_chat_events(chat_completion_recorded_events)) # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( @@ -347,7 +353,7 @@ def test_openai_chat_completion_async_no_content(loop, set_trace_info): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events(add_token_counts_to_chat_events(chat_completion_recorded_events)) # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( diff --git a/tests/mlmodel_openai/test_chat_completion_error.py b/tests/mlmodel_openai/test_chat_completion_error.py index 79cc79d6db..042cdef31a 100644 --- a/tests/mlmodel_openai/test_chat_completion_error.py +++ b/tests/mlmodel_openai/test_chat_completion_error.py @@ -15,13 +15,11 @@ import openai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, events_with_context_attrs, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -70,6 +68,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -86,6 +85,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -191,6 +191,7 @@ def test_chat_completion_invalid_request_error_no_model_no_content(set_trace_inf "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -198,36 +199,6 @@ def test_chat_completion_invalid_request_error_no_model_no_content(set_trace_inf ] -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.InvalidRequestError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - "test_chat_completion_error:test_chat_completion_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count(set_trace_info): - set_trace_info() - with pytest.raises(openai.InvalidRequestError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - - openai.ChatCompletion.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - ) - - # Invalid model provided @dt_enabled @reset_core_stats_engine() @@ -288,6 +259,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info): "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -304,6 +276,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info): "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -370,6 +343,7 @@ def test_chat_completion_authentication_error(monkeypatch, set_trace_info): "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -481,37 +455,6 @@ def test_chat_completion_invalid_request_error_no_model_async_no_content(loop, s ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.InvalidRequestError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - "test_chat_completion_error:test_chat_completion_invalid_request_error_invalid_model_with_token_count_async", - scoped_metrics=[("Llm/completion/OpenAI/acreate", 1)], - rollup_metrics=[("Llm/completion/OpenAI/acreate", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count_async(loop, set_trace_info): - set_trace_info() - with pytest.raises(openai.InvalidRequestError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - loop.run_until_complete( - openai.ChatCompletion.acreate( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - ) - ) - - # Invalid model provided @dt_enabled @reset_core_stats_engine() diff --git a/tests/mlmodel_openai/test_chat_completion_error_v1.py b/tests/mlmodel_openai/test_chat_completion_error_v1.py index 848ad57add..0f9b05c562 100644 --- a/tests/mlmodel_openai/test_chat_completion_error_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_error_v1.py @@ -14,13 +14,11 @@ import openai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, events_with_context_attrs, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -69,6 +67,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -85,6 +84,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -234,6 +234,7 @@ def test_chat_completion_invalid_request_error_no_model_async_no_content(loop, s "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -271,37 +272,6 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info, syn ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - "test_chat_completion_error_v1:test_chat_completion_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count(set_trace_info, sync_openai_client): - set_trace_info() - with pytest.raises(openai.NotFoundError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - sync_openai_client.chat.completions.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - ) - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -334,41 +304,6 @@ def test_chat_completion_invalid_request_error_invalid_model_async(loop, set_tra ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - "test_chat_completion_error_v1:test_chat_completion_invalid_request_error_invalid_model_with_token_count_async", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count_async( - loop, set_trace_info, async_openai_client -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - loop.run_until_complete( - async_openai_client.chat.completions.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - ) - ) - - expected_events_on_wrong_api_key_error = [ ( {"type": "LlmChatCompletionSummary"}, @@ -398,6 +333,7 @@ def test_chat_completion_invalid_request_error_invalid_model_with_token_count_as "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -617,39 +553,6 @@ def test_chat_completion_invalid_request_error_invalid_model_with_raw_response(s ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - "test_chat_completion_error_v1:test_chat_completion_invalid_request_error_invalid_model_with_token_count_with_raw_response", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count_with_raw_response( - set_trace_info, sync_openai_client -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - sync_openai_client.chat.completions.with_raw_response.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - ) - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -684,41 +587,6 @@ def test_chat_completion_invalid_request_error_invalid_model_async_with_raw_resp ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - "test_chat_completion_error_v1:test_chat_completion_invalid_request_error_invalid_model_with_token_count_async_with_raw_response", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count_async_with_raw_response( - loop, set_trace_info, async_openai_client -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - loop.run_until_complete( - async_openai_client.chat.completions.with_raw_response.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - ) - ) - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( diff --git a/tests/mlmodel_openai/test_chat_completion_stream.py b/tests/mlmodel_openai/test_chat_completion_stream.py index 55e8e8fbdb..ae62b88c4b 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream.py +++ b/tests/mlmodel_openai/test_chat_completion_stream.py @@ -15,7 +15,8 @@ import openai from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_streaming_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, disabled_ai_monitoring_streaming_settings, @@ -188,9 +189,101 @@ def test_openai_chat_completion_sync_no_content(set_trace_info): assert resp +chat_completion_recorded_token_events = [ + ( + {"type": "LlmChatCompletionSummary"}, + { + "id": None, # UUID that varies with each run + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "span_id": None, + "trace_id": "trace-id", + "request_id": "49dbbffbd3c3f4612aa48def69059ccd", + "duration": None, # Response time varies each test run + "request.model": "gpt-3.5-turbo", + "response.model": "gpt-3.5-turbo-0613", + "response.organization": "new-relic-nkmd8b", + "request.temperature": 0.7, + "request.max_tokens": 100, + "response.choices.finish_reason": "stop", + "response.headers.llmVersion": "2020-10-01", + "response.headers.ratelimitLimitRequests": 200, + "response.headers.ratelimitLimitTokens": 40000, + "response.headers.ratelimitResetTokens": "90ms", + "response.headers.ratelimitResetRequests": "7m12s", + "response.headers.ratelimitRemainingTokens": 39940, + "response.headers.ratelimitRemainingRequests": 199, + "vendor": "openai", + "ingest_source": "Python", + "response.number_of_messages": 3, + }, + ), + ( + {"type": "LlmChatCompletionMessage"}, + { + "id": "chatcmpl-87sb95K4EF2nuJRcTs43Tm9ntTemv-0", + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "request_id": "49dbbffbd3c3f4612aa48def69059ccd", + "span_id": None, + "trace_id": "trace-id", + "content": "You are a scientist.", + "role": "system", + "completion_id": None, + "sequence": 0, + "token_count": 0, + "response.model": "gpt-3.5-turbo-0613", + "vendor": "openai", + "ingest_source": "Python", + }, + ), + ( + {"type": "LlmChatCompletionMessage"}, + { + "id": "chatcmpl-87sb95K4EF2nuJRcTs43Tm9ntTemv-1", + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "request_id": "49dbbffbd3c3f4612aa48def69059ccd", + "span_id": None, + "trace_id": "trace-id", + "content": "What is 212 degrees Fahrenheit converted to Celsius?", + "role": "user", + "completion_id": None, + "sequence": 1, + "token_count": 0, + "response.model": "gpt-3.5-turbo-0613", + "vendor": "openai", + "ingest_source": "Python", + }, + ), + ( + {"type": "LlmChatCompletionMessage"}, + { + "id": "chatcmpl-87sb95K4EF2nuJRcTs43Tm9ntTemv-2", + "llm.conversation_id": "my-awesome-id", + "llm.foo": "bar", + "request_id": "49dbbffbd3c3f4612aa48def69059ccd", + "span_id": None, + "trace_id": "trace-id", + "content": "212 degrees Fahrenheit is equal to 100 degrees Celsius.", + "role": "assistant", + "completion_id": None, + "sequence": 2, + "token_count": 0, + "response.model": "gpt-3.5-turbo-0613", + "vendor": "openai", + "is_response": True, + "ingest_source": "Python", + }, + ), +] + + @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events( + add_token_counts_to_chat_events(add_token_count_streaming_events(chat_completion_recorded_events)) +) # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( @@ -382,7 +475,9 @@ async def consumer(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events( + add_token_counts_to_chat_events(add_token_count_streaming_events(chat_completion_recorded_events)) +) @validate_custom_event_count(count=4) @validate_transaction_metrics( name="test_chat_completion_stream:test_openai_chat_completion_async_with_token_count", diff --git a/tests/mlmodel_openai/test_chat_completion_stream_error.py b/tests/mlmodel_openai/test_chat_completion_stream_error.py index 0fb0d06867..2b01813d9f 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream_error.py +++ b/tests/mlmodel_openai/test_chat_completion_stream_error.py @@ -15,13 +15,11 @@ import openai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, events_with_context_attrs, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -70,6 +68,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -86,6 +85,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -196,6 +196,7 @@ def test_chat_completion_invalid_request_error_no_model_no_content(set_trace_inf "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -203,38 +204,6 @@ def test_chat_completion_invalid_request_error_no_model_no_content(set_trace_inf ] -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.InvalidRequestError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - "test_chat_completion_stream_error:test_chat_completion_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count(set_trace_info): - set_trace_info() - with pytest.raises(openai.InvalidRequestError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - generator = openai.ChatCompletion.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - stream=True, - ) - for resp in generator: - assert resp - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -297,6 +266,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info): "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -313,6 +283,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info): "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -384,6 +355,7 @@ def test_chat_completion_authentication_error(monkeypatch, set_trace_info): "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -498,38 +470,6 @@ def test_chat_completion_invalid_request_error_no_model_async_no_content(loop, s ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.InvalidRequestError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - "test_chat_completion_stream_error:test_chat_completion_invalid_request_error_invalid_model_with_token_count_async", - scoped_metrics=[("Llm/completion/OpenAI/acreate", 1)], - rollup_metrics=[("Llm/completion/OpenAI/acreate", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count_async(loop, set_trace_info): - set_trace_info() - with pytest.raises(openai.InvalidRequestError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - loop.run_until_complete( - openai.ChatCompletion.acreate( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - stream=True, - ) - ) - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -661,6 +601,7 @@ def test_chat_completion_wrong_api_key_error_async(loop, monkeypatch, set_trace_ "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, diff --git a/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py b/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py index 5d06dc2a28..987991d9f8 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py @@ -12,16 +12,13 @@ # See the License for the specific language governing permissions and # limitations under the License. - import openai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, events_with_context_attrs, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -70,6 +67,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -86,6 +84,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -248,6 +247,7 @@ async def consumer(): "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, @@ -286,77 +286,6 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info, syn assert resp -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - "test_chat_completion_stream_error_v1:test_chat_completion_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_with_token_count(set_trace_info, sync_openai_client): - set_trace_info() - with pytest.raises(openai.NotFoundError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - - generator = sync_openai_client.chat.completions.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - stream=True, - ) - for resp in generator: - assert resp - - -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - "test_chat_completion_stream_error_v1:test_chat_completion_invalid_request_error_invalid_model_async_with_token_count", - scoped_metrics=[("Llm/completion/OpenAI/create", 1)], - rollup_metrics=[("Llm/completion/OpenAI/create", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(expected_events_on_invalid_model_error)) -@validate_custom_event_count(count=2) -@background_task() -def test_chat_completion_invalid_request_error_invalid_model_async_with_token_count( - loop, set_trace_info, async_openai_client -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - - async def consumer(): - generator = await async_openai_client.chat.completions.create( - model="does-not-exist", - messages=({"role": "user", "content": "Model does not exist."},), - temperature=0.7, - max_tokens=100, - stream=True, - ) - async for resp in generator: - assert resp - - loop.run_until_complete(consumer()) - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -421,6 +350,7 @@ async def consumer(): "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "vendor": "openai", "ingest_source": "Python", }, diff --git a/tests/mlmodel_openai/test_chat_completion_stream_v1.py b/tests/mlmodel_openai/test_chat_completion_stream_v1.py index 6fc5d58f28..2fb0c4950a 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_stream_v1.py @@ -17,7 +17,8 @@ from conftest import get_openai_version from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_streaming_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, disabled_ai_monitoring_streaming_settings, @@ -304,7 +305,9 @@ def test_openai_chat_completion_sync_no_content(set_trace_info, sync_openai_clie @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events( + add_token_counts_to_chat_events(add_token_count_streaming_events(chat_completion_recorded_events)) +) # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( @@ -626,7 +629,9 @@ async def consumer(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events( + add_token_counts_to_chat_events(add_token_count_streaming_events(chat_completion_recorded_events)) +) # One summary event, one system message, one user message, and one response message from the assistant # @validate_custom_event_count(count=4) @validate_transaction_metrics( diff --git a/tests/mlmodel_openai/test_chat_completion_v1.py b/tests/mlmodel_openai/test_chat_completion_v1.py index 5a6793d955..495bf5de93 100644 --- a/tests/mlmodel_openai/test_chat_completion_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_v1.py @@ -15,7 +15,7 @@ import openai from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, disabled_ai_monitoring_streaming_settings, @@ -55,6 +55,9 @@ "response.organization": "new-relic-nkmd8b", "request.temperature": 0.7, "request.max_tokens": 100, + "response.usage.completion_tokens": 75, + "response.usage.total_tokens": 101, + "response.usage.prompt_tokens": 26, "response.choices.finish_reason": "stop", "response.headers.llmVersion": "2020-10-01", "response.headers.ratelimitLimitRequests": 10000, @@ -82,6 +85,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "gpt-3.5-turbo-0125", "vendor": "openai", "ingest_source": "Python", @@ -101,6 +105,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "gpt-3.5-turbo-0125", "vendor": "openai", "ingest_source": "Python", @@ -120,6 +125,7 @@ "role": "assistant", "completion_id": None, "sequence": 2, + "token_count": 0, "response.model": "gpt-3.5-turbo-0125", "vendor": "openai", "is_response": True, @@ -197,7 +203,7 @@ def test_openai_chat_completion_sync_no_content(set_trace_info, sync_openai_clie @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events(add_token_counts_to_chat_events(chat_completion_recorded_events)) # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( @@ -393,7 +399,7 @@ def test_openai_chat_completion_async_with_llm_metadata_no_content(loop, set_tra @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_recorded_events)) +@validate_custom_events(add_token_counts_to_chat_events(chat_completion_recorded_events)) # One summary event, one system message, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( diff --git a/tests/mlmodel_openai/test_embeddings.py b/tests/mlmodel_openai/test_embeddings.py index c3c3e7c429..935db04fe0 100644 --- a/tests/mlmodel_openai/test_embeddings.py +++ b/tests/mlmodel_openai/test_embeddings.py @@ -19,7 +19,7 @@ validate_attributes, ) from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_to_embedding_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -55,6 +55,7 @@ "response.headers.ratelimitResetRequests": "19m45.394s", "response.headers.ratelimitRemainingTokens": 149994, "response.headers.ratelimitRemainingRequests": 197, + "response.usage.total_tokens": 6, "vendor": "openai", "ingest_source": "Python", }, @@ -107,7 +108,7 @@ def test_openai_embedding_sync_no_content(set_trace_info): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(embedding_recorded_events)) +@validate_custom_events(add_token_count_to_embedding_events(embedding_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_embeddings:test_openai_embedding_sync_with_token_count", @@ -191,7 +192,7 @@ def test_openai_embedding_async_no_content(loop, set_trace_info): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(embedding_recorded_events)) +@validate_custom_events(add_token_count_to_embedding_events(embedding_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_embeddings:test_openai_embedding_async_with_token_count", diff --git a/tests/mlmodel_openai/test_embeddings_error_v1.py b/tests/mlmodel_openai/test_embeddings_error_v1.py index fd29236122..499f96893b 100644 --- a/tests/mlmodel_openai/test_embeddings_error_v1.py +++ b/tests/mlmodel_openai/test_embeddings_error_v1.py @@ -16,12 +16,10 @@ import openai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -149,32 +147,6 @@ def test_embeddings_invalid_request_error_no_model_async(set_trace_info, async_o ] -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"http.statusCode": 404, "error.code": "model_not_found"}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - name="test_embeddings_error_v1:test_embeddings_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/embedding/OpenAI/create", 1)], - rollup_metrics=[("Llm/embedding/OpenAI/create", 1)], - custom_metrics=[(f"Supportability/Python/ML/OpenAI/{openai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_with_token_count(set_trace_info, sync_openai_client): - set_trace_info() - with pytest.raises(openai.NotFoundError): - sync_openai_client.embeddings.create(input="Model does not exist.", model="does-not-exist") - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -255,36 +227,6 @@ def test_embeddings_invalid_request_error_invalid_model_async_no_content(set_tra ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"http.statusCode": 404, "error.code": "model_not_found"}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - name="test_embeddings_error_v1:test_embeddings_invalid_request_error_invalid_model_async_with_token_count", - scoped_metrics=[("Llm/embedding/OpenAI/create", 1)], - rollup_metrics=[("Llm/embedding/OpenAI/create", 1)], - custom_metrics=[(f"Supportability/Python/ML/OpenAI/{openai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_async_with_token_count( - set_trace_info, async_openai_client, loop -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - loop.run_until_complete( - async_openai_client.embeddings.create(input="Model does not exist.", model="does-not-exist") - ) - - embedding_invalid_key_error_events = [ ( {"type": "LlmEmbedding"}, @@ -449,34 +391,6 @@ def test_embeddings_invalid_request_error_no_model_async_with_raw_response(set_t ) # no model provided -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"http.statusCode": 404, "error.code": "model_not_found"}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - name="test_embeddings_error_v1:test_embeddings_invalid_request_error_invalid_model_with_token_count_with_raw_response", - scoped_metrics=[("Llm/embedding/OpenAI/create", 1)], - rollup_metrics=[("Llm/embedding/OpenAI/create", 1)], - custom_metrics=[(f"Supportability/Python/ML/OpenAI/{openai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_with_token_count_with_raw_response( - set_trace_info, sync_openai_client -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - sync_openai_client.embeddings.with_raw_response.create(input="Model does not exist.", model="does-not-exist") - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( @@ -566,38 +480,6 @@ def test_embeddings_invalid_request_error_invalid_model_async_no_content_with_ra ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.NotFoundError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"http.statusCode": 404, "error.code": "model_not_found"}}, -) -@validate_span_events( - exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} -) -@validate_transaction_metrics( - name="test_embeddings_error_v1:test_embeddings_invalid_request_error_invalid_model_async_with_token_count_with_raw_response", - scoped_metrics=[("Llm/embedding/OpenAI/create", 1)], - rollup_metrics=[("Llm/embedding/OpenAI/create", 1)], - custom_metrics=[(f"Supportability/Python/ML/OpenAI/{openai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_async_with_token_count_with_raw_response( - set_trace_info, async_openai_client, loop -): - set_trace_info() - with pytest.raises(openai.NotFoundError): - loop.run_until_complete( - async_openai_client.embeddings.with_raw_response.create( - input="Model does not exist.", model="does-not-exist" - ) - ) - - @dt_enabled @reset_core_stats_engine() @validate_error_trace_attributes( diff --git a/tests/mlmodel_openai/test_embeddings_v1.py b/tests/mlmodel_openai/test_embeddings_v1.py index 405a2a9e5f..3801d3639c 100644 --- a/tests/mlmodel_openai/test_embeddings_v1.py +++ b/tests/mlmodel_openai/test_embeddings_v1.py @@ -15,7 +15,7 @@ import openai from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_to_embedding_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -48,6 +48,7 @@ "response.headers.ratelimitResetRequests": "20ms", "response.headers.ratelimitRemainingTokens": 999994, "response.headers.ratelimitRemainingRequests": 2999, + "response.usage.total_tokens": 6, "vendor": "openai", "ingest_source": "Python", }, @@ -111,7 +112,7 @@ def test_openai_embedding_sync_no_content(set_trace_info, sync_openai_client): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(embedding_recorded_events)) +@validate_custom_events(add_token_count_to_embedding_events(embedding_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_embeddings_v1:test_openai_embedding_sync_with_token_count", @@ -206,7 +207,7 @@ def test_openai_embedding_async_no_content(loop, set_trace_info, async_openai_cl @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(embedding_recorded_events)) +@validate_custom_events(add_token_count_to_embedding_events(embedding_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_embeddings_v1:test_openai_embedding_async_with_token_count", diff --git a/tests/testing_support/ml_testing_utils.py b/tests/testing_support/ml_testing_utils.py index 55dbd08105..8c2c0444f0 100644 --- a/tests/testing_support/ml_testing_utils.py +++ b/tests/testing_support/ml_testing_utils.py @@ -46,6 +46,14 @@ def add_token_count_to_embedding_events(expected_events): return events +def add_token_count_streaming_events(expected_events): + events = copy.deepcopy(expected_events) + for event in events: + if event[0]["type"] == "LlmChatCompletionMessage": + event[1]["token_count"] = 0 + return events + + def add_token_counts_to_chat_events(expected_events): events = copy.deepcopy(expected_events) for event in events: From 1b08062f92722818b6bd6d8288ccbd477e67911f Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Tue, 7 Oct 2025 10:57:04 -0700 Subject: [PATCH 029/124] Add response token count logic to Gemini instrumentation. (#1486) * Add response token count logic to Gemini instrumentation. * Update token counting util functions. * Linting * Add response token count logic to Gemini instrumentation. * Update token counting util functions. * [MegaLinter] Apply linters fixes * Bump tests. --------- Co-authored-by: Tim Pansino --- newrelic/hooks/mlmodel_gemini.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/newrelic/hooks/mlmodel_gemini.py b/newrelic/hooks/mlmodel_gemini.py index d7585e0b60..bc6f8b2340 100644 --- a/newrelic/hooks/mlmodel_gemini.py +++ b/newrelic/hooks/mlmodel_gemini.py @@ -364,7 +364,7 @@ def _record_generation_error(transaction, linking_metadata, completion_id, kwarg llm_metadata, output_message_list, # We do not record token counts in error cases, so set all_token_counts to True so the pipeline tokenizer does not run - True, + True, request_timestamp, ) except Exception: From 055f4f3be74ba7bc989e5ccde79639ba41929450 Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Tue, 7 Oct 2025 13:14:56 -0700 Subject: [PATCH 030/124] Add response token count logic to OpenAI instrumentation. (#1498) * Add OpenAI token counts. * Add token counts to langchain + openai tests. * Remove unused expected events. * Linting * Add OpenAI token counts. * Add token counts to langchain + openai tests. * Remove unused expected events. * [MegaLinter] Apply linters fixes --------- Co-authored-by: Tim Pansino --- newrelic/hooks/mlmodel_openai.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/newrelic/hooks/mlmodel_openai.py b/newrelic/hooks/mlmodel_openai.py index 26b51e52f9..4dcdda8c11 100644 --- a/newrelic/hooks/mlmodel_openai.py +++ b/newrelic/hooks/mlmodel_openai.py @@ -649,7 +649,7 @@ def _record_completion_error(transaction, linking_metadata, completion_id, kwarg response_headers = getattr(response, "headers", None) or {} exc_organization = response_headers.get("openai-organization") # There appears to be a bug here in openai v1 where despite having code, - # param, etc in the error response, they are not populated on the exception + # param, etc. in the error response, they are not populated on the exception # object so grab them from the response body object instead. body = getattr(exc, "body", None) or {} notice_error_attributes = { From 509a4d70cad9b0b94c4c6b020e2f3cd997fa2127 Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Thu, 13 Nov 2025 14:53:41 -0800 Subject: [PATCH 031/124] Add response token count logic to Bedrock instrumentation. (#1504) * Add bedrock token counting. * [MegaLinter] Apply linters fixes * Add bedrock token counting. * Add safeguards when grabbing token counts. * Remove extra None defaults. * Cleanup default None checks. --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- newrelic/hooks/external_botocore.py | 255 ++++++++++++++---- .../test_bedrock_chat_completion_converse.py | 47 +--- ...st_bedrock_chat_completion_invoke_model.py | 102 +------ .../test_bedrock_embeddings.py | 43 +-- .../_test_bedrock_chat_completion_converse.py | 6 + ...st_bedrock_chat_completion_invoke_model.py | 30 +++ .../_test_bedrock_embeddings.py | 2 + .../test_bedrock_chat_completion_converse.py | 47 +--- ...st_bedrock_chat_completion_invoke_model.py | 150 ++++------- .../test_bedrock_embeddings.py | 43 +-- tests/mlmodel_openai/test_embeddings_error.py | 57 +--- 11 files changed, 310 insertions(+), 472 deletions(-) diff --git a/newrelic/hooks/external_botocore.py b/newrelic/hooks/external_botocore.py index 12dd4153f9..86fa65e20f 100644 --- a/newrelic/hooks/external_botocore.py +++ b/newrelic/hooks/external_botocore.py @@ -193,6 +193,7 @@ def create_chat_completion_message_event( request_model, request_id, llm_metadata_dict, + all_token_counts, response_id=None, request_timestamp=None, ): @@ -226,6 +227,8 @@ def create_chat_completion_message_event( "vendor": "bedrock", "ingest_source": "Python", } + if all_token_counts: + chat_completion_message_dict["token_count"] = 0 if settings.ai_monitoring.record_content.enabled: chat_completion_message_dict["content"] = content @@ -267,6 +270,8 @@ def create_chat_completion_message_event( "ingest_source": "Python", "is_response": True, } + if all_token_counts: + chat_completion_message_dict["token_count"] = 0 if settings.ai_monitoring.record_content.enabled: chat_completion_message_dict["content"] = content @@ -278,24 +283,21 @@ def create_chat_completion_message_event( transaction.record_custom_event("LlmChatCompletionMessage", chat_completion_message_dict) -def extract_bedrock_titan_text_model_request(request_body, bedrock_attrs): +def extract_bedrock_titan_embedding_model_request(request_body, bedrock_attrs): request_body = json.loads(request_body) - request_config = request_body.get("textGenerationConfig", {}) - input_message_list = [{"role": "user", "content": request_body.get("inputText")}] - - bedrock_attrs["input_message_list"] = input_message_list - bedrock_attrs["request.max_tokens"] = request_config.get("maxTokenCount") - bedrock_attrs["request.temperature"] = request_config.get("temperature") + bedrock_attrs["input"] = request_body.get("inputText") return bedrock_attrs -def extract_bedrock_mistral_text_model_request(request_body, bedrock_attrs): - request_body = json.loads(request_body) - bedrock_attrs["input_message_list"] = [{"role": "user", "content": request_body.get("prompt")}] - bedrock_attrs["request.max_tokens"] = request_body.get("max_tokens") - bedrock_attrs["request.temperature"] = request_body.get("temperature") +def extract_bedrock_titan_embedding_model_response(response_body, bedrock_attrs): + if response_body: + response_body = json.loads(response_body) + + input_tokens = response_body.get("inputTextTokenCount", 0) + bedrock_attrs["response.usage.total_tokens"] = input_tokens + return bedrock_attrs @@ -303,16 +305,31 @@ def extract_bedrock_titan_text_model_response(response_body, bedrock_attrs): if response_body: response_body = json.loads(response_body) + input_tokens = response_body.get("inputTextTokenCount", 0) + completion_tokens = sum(result.get("tokenCount", 0) for result in response_body.get("results", [])) + total_tokens = input_tokens + completion_tokens + output_message_list = [ - {"role": "assistant", "content": result["outputText"]} for result in response_body.get("results", []) + {"role": "assistant", "content": result.get("outputText")} for result in response_body.get("results", []) ] bedrock_attrs["response.choices.finish_reason"] = response_body["results"][0]["completionReason"] + bedrock_attrs["response.usage.completion_tokens"] = completion_tokens + bedrock_attrs["response.usage.prompt_tokens"] = input_tokens + bedrock_attrs["response.usage.total_tokens"] = total_tokens bedrock_attrs["output_message_list"] = output_message_list return bedrock_attrs +def extract_bedrock_mistral_text_model_request(request_body, bedrock_attrs): + request_body = json.loads(request_body) + bedrock_attrs["input_message_list"] = [{"role": "user", "content": request_body.get("prompt")}] + bedrock_attrs["request.max_tokens"] = request_body.get("max_tokens") + bedrock_attrs["request.temperature"] = request_body.get("temperature") + return bedrock_attrs + + def extract_bedrock_mistral_text_model_response(response_body, bedrock_attrs): if response_body: response_body = json.loads(response_body) @@ -325,17 +342,6 @@ def extract_bedrock_mistral_text_model_response(response_body, bedrock_attrs): return bedrock_attrs -def extract_bedrock_titan_text_model_streaming_response(response_body, bedrock_attrs): - if response_body: - if "outputText" in response_body: - bedrock_attrs["output_message_list"] = messages = bedrock_attrs.get("output_message_list", []) - messages.append({"role": "assistant", "content": response_body["outputText"]}) - - bedrock_attrs["response.choices.finish_reason"] = response_body.get("completionReason", None) - - return bedrock_attrs - - def extract_bedrock_mistral_text_model_streaming_response(response_body, bedrock_attrs): if response_body: outputs = response_body.get("outputs") @@ -344,14 +350,46 @@ def extract_bedrock_mistral_text_model_streaming_response(response_body, bedrock "output_message_list", [{"role": "assistant", "content": ""}] ) bedrock_attrs["output_message_list"][0]["content"] += outputs[0].get("text", "") - bedrock_attrs["response.choices.finish_reason"] = outputs[0].get("stop_reason", None) + bedrock_attrs["response.choices.finish_reason"] = outputs[0].get("stop_reason") return bedrock_attrs -def extract_bedrock_titan_embedding_model_request(request_body, bedrock_attrs): +def extract_bedrock_titan_text_model_request(request_body, bedrock_attrs): request_body = json.loads(request_body) + request_config = request_body.get("textGenerationConfig", {}) - bedrock_attrs["input"] = request_body.get("inputText") + input_message_list = [{"role": "user", "content": request_body.get("inputText")}] + + bedrock_attrs["input_message_list"] = input_message_list + bedrock_attrs["request.max_tokens"] = request_config.get("maxTokenCount") + bedrock_attrs["request.temperature"] = request_config.get("temperature") + + return bedrock_attrs + + +def extract_bedrock_titan_text_model_streaming_response(response_body, bedrock_attrs): + if response_body: + if "outputText" in response_body: + bedrock_attrs["output_message_list"] = messages = bedrock_attrs.get("output_message_list", []) + messages.append({"role": "assistant", "content": response_body["outputText"]}) + + bedrock_attrs["response.choices.finish_reason"] = response_body.get("completionReason") + + # Extract token information + invocation_metrics = response_body.get("amazon-bedrock-invocationMetrics", {}) + prompt_tokens = invocation_metrics.get("inputTokenCount", 0) + completion_tokens = invocation_metrics.get("outputTokenCount", 0) + total_tokens = prompt_tokens + completion_tokens + + bedrock_attrs["response.usage.completion_tokens"] = ( + bedrock_attrs.get("response.usage.completion_tokens", 0) + completion_tokens + ) + bedrock_attrs["response.usage.prompt_tokens"] = ( + bedrock_attrs.get("response.usage.prompt_tokens", 0) + prompt_tokens + ) + bedrock_attrs["response.usage.total_tokens"] = ( + bedrock_attrs.get("response.usage.total_tokens", 0) + total_tokens + ) return bedrock_attrs @@ -421,6 +459,17 @@ def extract_bedrock_claude_model_response(response_body, bedrock_attrs): bedrock_attrs["response.choices.finish_reason"] = response_body.get("stop_reason") bedrock_attrs["output_message_list"] = output_message_list + bedrock_attrs[""] = str(response_body.get("id")) + + # Extract token information + token_usage = response_body.get("usage", {}) + if token_usage: + prompt_tokens = token_usage.get("input_tokens", 0) + completion_tokens = token_usage.get("output_tokens", 0) + total_tokens = prompt_tokens + completion_tokens + bedrock_attrs["response.usage.prompt_tokens"] = prompt_tokens + bedrock_attrs["response.usage.completion_tokens"] = completion_tokens + bedrock_attrs["response.usage.total_tokens"] = total_tokens return bedrock_attrs @@ -433,6 +482,22 @@ def extract_bedrock_claude_model_streaming_response(response_body, bedrock_attrs bedrock_attrs["output_message_list"][0]["content"] += content bedrock_attrs["response.choices.finish_reason"] = response_body.get("stop_reason") + # Extract token information + invocation_metrics = response_body.get("amazon-bedrock-invocationMetrics", {}) + prompt_tokens = invocation_metrics.get("inputTokenCount", 0) + completion_tokens = invocation_metrics.get("outputTokenCount", 0) + total_tokens = prompt_tokens + completion_tokens + + bedrock_attrs["response.usage.completion_tokens"] = ( + bedrock_attrs.get("response.usage.completion_tokens", 0) + completion_tokens + ) + bedrock_attrs["response.usage.prompt_tokens"] = ( + bedrock_attrs.get("response.usage.prompt_tokens", 0) + prompt_tokens + ) + bedrock_attrs["response.usage.total_tokens"] = ( + bedrock_attrs.get("response.usage.total_tokens", 0) + total_tokens + ) + return bedrock_attrs @@ -453,6 +518,13 @@ def extract_bedrock_llama_model_response(response_body, bedrock_attrs): response_body = json.loads(response_body) output_message_list = [{"role": "assistant", "content": response_body.get("generation")}] + prompt_tokens = response_body.get("prompt_token_count", 0) + completion_tokens = response_body.get("generation_token_count", 0) + total_tokens = prompt_tokens + completion_tokens + + bedrock_attrs["response.usage.completion_tokens"] = completion_tokens + bedrock_attrs["response.usage.prompt_tokens"] = prompt_tokens + bedrock_attrs["response.usage.total_tokens"] = total_tokens bedrock_attrs["response.choices.finish_reason"] = response_body.get("stop_reason") bedrock_attrs["output_message_list"] = output_message_list @@ -466,6 +538,22 @@ def extract_bedrock_llama_model_streaming_response(response_body, bedrock_attrs) bedrock_attrs["output_message_list"] = [{"role": "assistant", "content": ""}] bedrock_attrs["output_message_list"][0]["content"] += content bedrock_attrs["response.choices.finish_reason"] = response_body.get("stop_reason") + + # Extract token information + invocation_metrics = response_body.get("amazon-bedrock-invocationMetrics", {}) + prompt_tokens = invocation_metrics.get("inputTokenCount", 0) + completion_tokens = invocation_metrics.get("outputTokenCount", 0) + total_tokens = prompt_tokens + completion_tokens + + bedrock_attrs["response.usage.completion_tokens"] = ( + bedrock_attrs.get("response.usage.completion_tokens", 0) + completion_tokens + ) + bedrock_attrs["response.usage.prompt_tokens"] = ( + bedrock_attrs.get("response.usage.prompt_tokens", 0) + prompt_tokens + ) + bedrock_attrs["response.usage.total_tokens"] = ( + bedrock_attrs.get("response.usage.total_tokens", 0) + total_tokens + ) return bedrock_attrs @@ -506,12 +594,33 @@ def extract_bedrock_cohere_model_streaming_response(response_body, bedrock_attrs bedrock_attrs["response.choices.finish_reason"] = response_body["generations"][0]["finish_reason"] bedrock_attrs["response_id"] = str(response_body.get("id")) + # Extract token information + invocation_metrics = response_body.get("amazon-bedrock-invocationMetrics", {}) + prompt_tokens = invocation_metrics.get("inputTokenCount", 0) + completion_tokens = invocation_metrics.get("outputTokenCount", 0) + total_tokens = prompt_tokens + completion_tokens + + bedrock_attrs["response.usage.completion_tokens"] = ( + bedrock_attrs.get("response.usage.completion_tokens", 0) + completion_tokens + ) + bedrock_attrs["response.usage.prompt_tokens"] = ( + bedrock_attrs.get("response.usage.prompt_tokens", 0) + prompt_tokens + ) + bedrock_attrs["response.usage.total_tokens"] = ( + bedrock_attrs.get("response.usage.total_tokens", 0) + total_tokens + ) + return bedrock_attrs NULL_EXTRACTOR = lambda *args: {} # noqa: E731 # Empty extractor that returns nothing MODEL_EXTRACTORS = [ # Order is important here, avoiding dictionaries - ("amazon.titan-embed", extract_bedrock_titan_embedding_model_request, NULL_EXTRACTOR, NULL_EXTRACTOR), + ( + "amazon.titan-embed", + extract_bedrock_titan_embedding_model_request, + extract_bedrock_titan_embedding_model_response, + NULL_EXTRACTOR, + ), ("cohere.embed", extract_bedrock_cohere_embedding_model_request, NULL_EXTRACTOR, NULL_EXTRACTOR), ( "amazon.titan", @@ -575,8 +684,8 @@ def handle_bedrock_exception( input_message_list = [] bedrock_attrs["input_message_list"] = input_message_list - bedrock_attrs["request.max_tokens"] = kwargs.get("inferenceConfig", {}).get("maxTokens", None) - bedrock_attrs["request.temperature"] = kwargs.get("inferenceConfig", {}).get("temperature", None) + bedrock_attrs["request.max_tokens"] = kwargs.get("inferenceConfig", {}).get("maxTokens") + bedrock_attrs["request.temperature"] = kwargs.get("inferenceConfig", {}).get("temperature") try: request_extractor(request_body, bedrock_attrs) @@ -844,6 +953,7 @@ def _wrap_bedrock_runtime_converse(wrapped, instance, args, kwargs): try: # For aioboto3 clients, this will call make_api_call instrumentation in external_aiobotocore response = wrapped(*args, **kwargs) + except Exception as exc: handle_bedrock_exception( exc, @@ -935,15 +1045,22 @@ def extract_bedrock_converse_attrs(kwargs, response, response_headers, model, sp exc_info=True, ) + response_prompt_tokens = response.get("usage", {}).get("inputTokens") if response else None + response_completion_tokens = response.get("usage", {}).get("outputTokens") if response else None + response_total_tokens = response.get("usage", {}).get("totalTokens") if response else None + bedrock_attrs = { "request_id": response_headers.get("x-amzn-requestid"), "model": model, "span_id": span_id, "trace_id": trace_id, "response.choices.finish_reason": response.get("stopReason"), - "request.max_tokens": kwargs.get("inferenceConfig", {}).get("maxTokens", None), - "request.temperature": kwargs.get("inferenceConfig", {}).get("temperature", None), + "request.max_tokens": kwargs.get("inferenceConfig", {}).get("maxTokens"), + "request.temperature": kwargs.get("inferenceConfig", {}).get("temperature"), "input_message_list": input_message_list, + "response.usage.prompt_tokens": response_prompt_tokens, + "response.usage.completion_tokens": response_completion_tokens, + "response.usage.total_tokens": response_total_tokens, } if output_message_list is not None: @@ -1122,29 +1239,34 @@ def handle_embedding_event(transaction, bedrock_attrs): custom_attrs_dict = transaction._custom_params llm_metadata_dict = {key: value for key, value in custom_attrs_dict.items() if key.startswith("llm.")} - span_id = bedrock_attrs.get("span_id", None) - trace_id = bedrock_attrs.get("trace_id", None) - request_id = bedrock_attrs.get("request_id", None) - model = bedrock_attrs.get("model", None) + span_id = bedrock_attrs.get("span_id") + trace_id = bedrock_attrs.get("trace_id") + request_id = bedrock_attrs.get("request_id") + model = bedrock_attrs.get("model") input_ = bedrock_attrs.get("input") + response_total_tokens = bedrock_attrs.get("response.usage.total_tokens") + + total_tokens = ( + settings.ai_monitoring.llm_token_count_callback(model, input_) + if settings.ai_monitoring.llm_token_count_callback and input_ + else response_total_tokens + ) + embedding_dict = { "vendor": "bedrock", "ingest_source": "Python", "id": embedding_id, "span_id": span_id, "trace_id": trace_id, - "token_count": ( - settings.ai_monitoring.llm_token_count_callback(model, input_) - if settings.ai_monitoring.llm_token_count_callback - else None - ), "request_id": request_id, - "duration": bedrock_attrs.get("duration", None), + "duration": bedrock_attrs.get("duration"), "request.model": model, "response.model": model, - "error": bedrock_attrs.get("error", None), + "response.usage.total_tokens": total_tokens, + "error": bedrock_attrs.get("error"), } + embedding_dict.update(llm_metadata_dict) if settings.ai_monitoring.record_content.enabled: @@ -1155,6 +1277,7 @@ def handle_embedding_event(transaction, bedrock_attrs): def handle_chat_completion_event(transaction, bedrock_attrs, request_timestamp=None): + settings = transaction.settings or global_settings() chat_completion_id = str(uuid.uuid4()) # Grab LLM-related custom attributes off of the transaction to store as metadata on LLM events custom_attrs_dict = transaction._custom_params @@ -1163,11 +1286,15 @@ def handle_chat_completion_event(transaction, bedrock_attrs, request_timestamp=N llm_context_attrs = getattr(transaction, "_llm_context_attrs", None) if llm_context_attrs: llm_metadata_dict.update(llm_context_attrs) - span_id = bedrock_attrs.get("span_id", None) - trace_id = bedrock_attrs.get("trace_id", None) - request_id = bedrock_attrs.get("request_id", None) - response_id = bedrock_attrs.get("response_id", None) - model = bedrock_attrs.get("model", None) + span_id = bedrock_attrs.get("span_id") + trace_id = bedrock_attrs.get("trace_id") + request_id = bedrock_attrs.get("request_id") + response_id = bedrock_attrs.get("response_id") + model = bedrock_attrs.get("model") + + response_prompt_tokens = bedrock_attrs.get("response.usage.prompt_tokens") + response_completion_tokens = bedrock_attrs.get("response.usage.completion_tokens") + response_total_tokens = bedrock_attrs.get("response.usage.total_tokens") input_message_list = bedrock_attrs.get("input_message_list", []) output_message_list = bedrock_attrs.get("output_message_list", []) @@ -1182,6 +1309,25 @@ def handle_chat_completion_event(transaction, bedrock_attrs, request_timestamp=N len(input_message_list) + len(output_message_list) ) or None # If 0, attribute will be set to None and removed + input_message_content = " ".join([msg.get("content") for msg in input_message_list if msg.get("content")]) + prompt_tokens = ( + settings.ai_monitoring.llm_token_count_callback(model, input_message_content) + if settings.ai_monitoring.llm_token_count_callback and input_message_content + else response_prompt_tokens + ) + + output_message_content = " ".join([msg.get("content") for msg in output_message_list if msg.get("content")]) + completion_tokens = ( + settings.ai_monitoring.llm_token_count_callback(model, output_message_content) + if settings.ai_monitoring.llm_token_count_callback and output_message_content + else response_completion_tokens + ) + total_tokens = ( + prompt_tokens + completion_tokens if all([prompt_tokens, completion_tokens]) else response_total_tokens + ) + + all_token_counts = bool(prompt_tokens and completion_tokens and total_tokens) + chat_completion_summary_dict = { "vendor": "bedrock", "ingest_source": "Python", @@ -1190,9 +1336,9 @@ def handle_chat_completion_event(transaction, bedrock_attrs, request_timestamp=N "trace_id": trace_id, "request_id": request_id, "response_id": response_id, - "duration": bedrock_attrs.get("duration", None), - "request.max_tokens": bedrock_attrs.get("request.max_tokens", None), - "request.temperature": bedrock_attrs.get("request.temperature", None), + "duration": bedrock_attrs.get("duration"), + "request.max_tokens": bedrock_attrs.get("request.max_tokens"), + "request.temperature": bedrock_attrs.get("request.temperature"), "request.model": model, "response.model": model, # Duplicate data required by the UI "response.number_of_messages": number_of_messages, @@ -1200,6 +1346,12 @@ def handle_chat_completion_event(transaction, bedrock_attrs, request_timestamp=N "error": bedrock_attrs.get("error", None), "timestamp": request_timestamp or None, } + + if all_token_counts: + chat_completion_summary_dict["response.usage.prompt_tokens"] = prompt_tokens + chat_completion_summary_dict["response.usage.completion_tokens"] = completion_tokens + chat_completion_summary_dict["response.usage.total_tokens"] = total_tokens + chat_completion_summary_dict.update(llm_metadata_dict) chat_completion_summary_dict = {k: v for k, v in chat_completion_summary_dict.items() if v is not None} transaction.record_custom_event("LlmChatCompletionSummary", chat_completion_summary_dict) @@ -1214,6 +1366,7 @@ def handle_chat_completion_event(transaction, bedrock_attrs, request_timestamp=N request_model=model, request_id=request_id, llm_metadata_dict=llm_metadata_dict, + all_token_counts=all_token_counts, response_id=response_id, request_timestamp=request_timestamp, ) diff --git a/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py b/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py index 55843b832c..f115fc3d90 100644 --- a/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py +++ b/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py @@ -23,7 +23,7 @@ ) from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -147,7 +147,7 @@ def _test(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) def test_bedrock_chat_completion_with_token_count(set_trace_info, exercise_model, expected_metric, expected_events): - @validate_custom_events(add_token_count_to_events(expected_events)) + @validate_custom_events(add_token_counts_to_chat_events(chat_completion_expected_events)) # One summary event, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( @@ -278,49 +278,6 @@ def _test(): _test() -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_chat_completion_error_incorrect_access_key_with_token_count( - exercise_converse_incorrect_access_key, set_trace_info, expected_metric -): - """ - A request is made to the server with invalid credentials. botocore will reach out to the server and receive an - UnrecognizedClientException as a response. Information from the request will be parsed and reported in customer - events. The error response can also be parsed, and will be included as attributes on the recorded exception. - """ - - @validate_custom_events(add_token_count_to_events(chat_completion_invalid_access_key_error_events)) - @validate_error_trace_attributes( - _client_error_name, - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "http.statusCode": 403, - "error.message": "The security token included in the request is invalid.", - "error.code": "UnrecognizedClientException", - }, - }, - ) - @validate_transaction_metrics( - name="test_bedrock_chat_completion_incorrect_access_key_with_token_count", - scoped_metrics=[expected_metric], - rollup_metrics=[expected_metric], - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, - ) - @background_task(name="test_bedrock_chat_completion_incorrect_access_key_with_token_count") - def _test(): - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - exercise_converse_incorrect_access_key() - - _test() - - @pytest.fixture def exercise_converse_invalid_model(loop, bedrock_converse_server, response_streaming, monkeypatch): def _exercise_converse_invalid_model(): diff --git a/tests/external_aiobotocore/test_bedrock_chat_completion_invoke_model.py b/tests/external_aiobotocore/test_bedrock_chat_completion_invoke_model.py index 207db7e31e..40c21c35ee 100644 --- a/tests/external_aiobotocore/test_bedrock_chat_completion_invoke_model.py +++ b/tests/external_aiobotocore/test_bedrock_chat_completion_invoke_model.py @@ -34,7 +34,8 @@ ) from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_streaming_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, disabled_ai_monitoring_streaming_settings, @@ -207,7 +208,7 @@ def _test(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) def test_bedrock_chat_completion_with_token_count(set_trace_info, exercise_model, expected_events, expected_metrics): - @validate_custom_events(add_token_count_to_events(expected_events)) + @validate_custom_events(add_token_counts_to_chat_events(add_token_count_streaming_events(expected_events))) # One summary event, one user message, and one response message from the assistant @validate_custom_event_count(count=3) @validate_transaction_metrics( @@ -456,51 +457,6 @@ def _test(): _test() -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_chat_completion_error_incorrect_access_key_with_token( - monkeypatch, - bedrock_server, - exercise_model, - set_trace_info, - expected_invalid_access_key_error_events, - expected_metrics, -): - @validate_custom_events(add_token_count_to_events(expected_invalid_access_key_error_events)) - @validate_error_trace_attributes( - _client_error_name, - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "http.statusCode": 403, - "error.message": "The security token included in the request is invalid.", - "error.code": "UnrecognizedClientException", - }, - }, - ) - @validate_transaction_metrics( - name="test_bedrock_chat_completion", - scoped_metrics=expected_metrics, - rollup_metrics=expected_metrics, - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, - ) - @background_task(name="test_bedrock_chat_completion") - def _test(): - monkeypatch.setattr(bedrock_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY") - - with pytest.raises(_client_error): # not sure where this exception actually comes from - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - exercise_model(prompt="Invalid Token", temperature=0.7, max_tokens=100) - - _test() - - def invoke_model_malformed_request_body(loop, bedrock_server, response_streaming): async def _coro(): with pytest.raises(_client_error): @@ -799,58 +755,6 @@ async def _test(): loop.run_until_complete(_test()) -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_custom_events(add_token_count_to_events(chat_completion_expected_streaming_error_events)) -@validate_custom_event_count(count=2) -@validate_error_trace_attributes( - _event_stream_error_name, - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "error.message": "Malformed input request, please reformat your input and try again.", - "error.code": "ValidationException", - }, - }, - forgone_params={"agent": (), "intrinsic": (), "user": ("http.statusCode")}, -) -@validate_transaction_metrics( - name="test_bedrock_chat_completion", - scoped_metrics=[("Llm/completion/Bedrock/invoke_model_with_response_stream", 1)], - rollup_metrics=[("Llm/completion/Bedrock/invoke_model_with_response_stream", 1)], - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, -) -@background_task(name="test_bedrock_chat_completion") -def test_bedrock_chat_completion_error_streaming_exception_with_token_count(loop, bedrock_server, set_trace_info): - """ - Duplicate of test_bedrock_chat_completion_error_streaming_exception, but with token callback being set. - - See the original test for a description of the error case. - """ - - async def _test(): - with pytest.raises(_event_stream_error): - model = "amazon.titan-text-express-v1" - body = (chat_completion_payload_templates[model] % ("Streaming Exception", 0.7, 100)).encode("utf-8") - - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - response = await bedrock_server.invoke_model_with_response_stream( - body=body, modelId=model, accept="application/json", contentType="application/json" - ) - - body = response.get("body") - async for resp in body: - assert resp - - loop.run_until_complete(_test()) - - def test_bedrock_chat_completion_functions_marked_as_wrapped_for_sdk_compatibility(bedrock_server): assert bedrock_server._nr_wrapped diff --git a/tests/external_aiobotocore/test_bedrock_embeddings.py b/tests/external_aiobotocore/test_bedrock_embeddings.py index b964122294..1f9359934b 100644 --- a/tests/external_aiobotocore/test_bedrock_embeddings.py +++ b/tests/external_aiobotocore/test_bedrock_embeddings.py @@ -28,7 +28,7 @@ ) from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_to_embedding_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -165,7 +165,7 @@ def _test(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) def test_bedrock_embedding_with_token_count(set_trace_info, exercise_model, expected_events): - @validate_custom_events(add_token_count_to_events(expected_events)) + @validate_custom_events(add_token_count_to_embedding_events(expected_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_bedrock_embedding", @@ -290,45 +290,6 @@ def _test(): _test() -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_embedding_error_incorrect_access_key_with_token_count( - monkeypatch, bedrock_server, exercise_model, set_trace_info, expected_invalid_access_key_error_events -): - @validate_custom_events(add_token_count_to_events(expected_invalid_access_key_error_events)) - @validate_error_trace_attributes( - _client_error_name, - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "http.statusCode": 403, - "error.message": "The security token included in the request is invalid.", - "error.code": "UnrecognizedClientException", - }, - }, - ) - @validate_transaction_metrics( - name="test_bedrock_embedding", - scoped_metrics=[("Llm/embedding/Bedrock/invoke_model", 1)], - rollup_metrics=[("Llm/embedding/Bedrock/invoke_model", 1)], - background_task=True, - ) - @background_task(name="test_bedrock_embedding") - def _test(): - monkeypatch.setattr(bedrock_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY") - - with pytest.raises(_client_error): # not sure where this exception actually comes from - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - exercise_model(prompt="Invalid Token") - - _test() - - @reset_core_stats_engine() @validate_custom_events(embedding_expected_malformed_request_body_events) @validate_custom_event_count(count=1) diff --git a/tests/external_botocore/_test_bedrock_chat_completion_converse.py b/tests/external_botocore/_test_bedrock_chat_completion_converse.py index 7cde46faf8..a3501ef27d 100644 --- a/tests/external_botocore/_test_bedrock_chat_completion_converse.py +++ b/tests/external_botocore/_test_bedrock_chat_completion_converse.py @@ -29,6 +29,9 @@ "duration": None, # Response time varies each test run "request.model": "anthropic.claude-3-sonnet-20240229-v1:0", "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", + "response.usage.prompt_tokens": 26, + "response.usage.completion_tokens": 100, + "response.usage.total_tokens": 126, "request.temperature": 0.7, "request.max_tokens": 100, "response.choices.finish_reason": "max_tokens", @@ -51,6 +54,7 @@ "role": "system", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", "vendor": "bedrock", "ingest_source": "Python", @@ -70,6 +74,7 @@ "role": "user", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", "vendor": "bedrock", "ingest_source": "Python", @@ -89,6 +94,7 @@ "role": "assistant", "completion_id": None, "sequence": 2, + "token_count": 0, "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", "vendor": "bedrock", "ingest_source": "Python", diff --git a/tests/external_botocore/_test_bedrock_chat_completion_invoke_model.py b/tests/external_botocore/_test_bedrock_chat_completion_invoke_model.py index f72b9fa583..63db603f78 100644 --- a/tests/external_botocore/_test_bedrock_chat_completion_invoke_model.py +++ b/tests/external_botocore/_test_bedrock_chat_completion_invoke_model.py @@ -102,6 +102,9 @@ "duration": None, # Response time varies each test run "request.model": "amazon.titan-text-express-v1", "response.model": "amazon.titan-text-express-v1", + "response.usage.completion_tokens": 32, + "response.usage.total_tokens": 44, + "response.usage.prompt_tokens": 12, "request.temperature": 0.7, "request.max_tokens": 100, "response.choices.finish_reason": "FINISH", @@ -124,6 +127,7 @@ "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "amazon.titan-text-express-v1", "vendor": "bedrock", "ingest_source": "Python", @@ -143,6 +147,7 @@ "role": "assistant", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "amazon.titan-text-express-v1", "vendor": "bedrock", "ingest_source": "Python", @@ -414,6 +419,9 @@ "duration": None, # Response time varies each test run "request.model": "meta.llama2-13b-chat-v1", "response.model": "meta.llama2-13b-chat-v1", + "response.usage.prompt_tokens": 17, + "response.usage.completion_tokens": 69, + "response.usage.total_tokens": 86, "request.temperature": 0.7, "request.max_tokens": 100, "response.choices.finish_reason": "stop", @@ -436,6 +444,7 @@ "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "meta.llama2-13b-chat-v1", "vendor": "bedrock", "ingest_source": "Python", @@ -455,6 +464,7 @@ "role": "assistant", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "meta.llama2-13b-chat-v1", "vendor": "bedrock", "ingest_source": "Python", @@ -1147,6 +1157,9 @@ "duration": None, # Response time varies each test run "request.model": "amazon.titan-text-express-v1", "response.model": "amazon.titan-text-express-v1", + "response.usage.completion_tokens": 35, + "response.usage.total_tokens": 47, + "response.usage.prompt_tokens": 12, "request.temperature": 0.7, "request.max_tokens": 100, "response.choices.finish_reason": "FINISH", @@ -1169,6 +1182,7 @@ "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "amazon.titan-text-express-v1", "vendor": "bedrock", "ingest_source": "Python", @@ -1188,6 +1202,7 @@ "role": "assistant", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "amazon.titan-text-express-v1", "vendor": "bedrock", "ingest_source": "Python", @@ -1209,6 +1224,9 @@ "duration": None, # Response time varies each test run "request.model": "anthropic.claude-instant-v1", "response.model": "anthropic.claude-instant-v1", + "response.usage.completion_tokens": 99, + "response.usage.prompt_tokens": 19, + "response.usage.total_tokens": 118, "request.temperature": 0.7, "request.max_tokens": 100, "response.choices.finish_reason": "stop_sequence", @@ -1231,6 +1249,7 @@ "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "anthropic.claude-instant-v1", "vendor": "bedrock", "ingest_source": "Python", @@ -1250,6 +1269,7 @@ "role": "assistant", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "anthropic.claude-instant-v1", "vendor": "bedrock", "ingest_source": "Python", @@ -1333,6 +1353,9 @@ "duration": None, # Response time varies each test run "request.model": "cohere.command-text-v14", "response.model": "cohere.command-text-v14", + "response.usage.completion_tokens": 91, + "response.usage.total_tokens": 100, + "response.usage.prompt_tokens": 9, "request.temperature": 0.7, "request.max_tokens": 100, "response.choices.finish_reason": "COMPLETE", @@ -1355,6 +1378,7 @@ "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "cohere.command-text-v14", "vendor": "bedrock", "ingest_source": "Python", @@ -1374,6 +1398,7 @@ "role": "assistant", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "cohere.command-text-v14", "vendor": "bedrock", "ingest_source": "Python", @@ -1395,6 +1420,9 @@ "duration": None, # Response time varies each test run "request.model": "meta.llama2-13b-chat-v1", "response.model": "meta.llama2-13b-chat-v1", + "response.usage.prompt_tokens": 17, + "response.usage.completion_tokens": 100, + "response.usage.total_tokens": 117, "request.temperature": 0.7, "request.max_tokens": 100, "response.choices.finish_reason": "length", @@ -1417,6 +1445,7 @@ "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "meta.llama2-13b-chat-v1", "vendor": "bedrock", "ingest_source": "Python", @@ -1436,6 +1465,7 @@ "role": "assistant", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "meta.llama2-13b-chat-v1", "vendor": "bedrock", "ingest_source": "Python", diff --git a/tests/external_botocore/_test_bedrock_embeddings.py b/tests/external_botocore/_test_bedrock_embeddings.py index f5c227b9c3..af544af001 100644 --- a/tests/external_botocore/_test_bedrock_embeddings.py +++ b/tests/external_botocore/_test_bedrock_embeddings.py @@ -33,6 +33,7 @@ "response.model": "amazon.titan-embed-text-v1", "request.model": "amazon.titan-embed-text-v1", "request_id": "11233989-07e8-4ecb-9ba6-79601ba6d8cc", + "response.usage.total_tokens": 6, "vendor": "bedrock", "ingest_source": "Python", }, @@ -52,6 +53,7 @@ "response.model": "amazon.titan-embed-g1-text-02", "request.model": "amazon.titan-embed-g1-text-02", "request_id": "b10ac895-eae3-4f07-b926-10b2866c55ed", + "response.usage.total_tokens": 6, "vendor": "bedrock", "ingest_source": "Python", }, diff --git a/tests/external_botocore/test_bedrock_chat_completion_converse.py b/tests/external_botocore/test_bedrock_chat_completion_converse.py index e365b5163b..ca6cfd9d7b 100644 --- a/tests/external_botocore/test_bedrock_chat_completion_converse.py +++ b/tests/external_botocore/test_bedrock_chat_completion_converse.py @@ -23,7 +23,7 @@ from conftest import BOTOCORE_VERSION from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -141,7 +141,7 @@ def _test(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) def test_bedrock_chat_completion_with_token_count(set_trace_info, exercise_model, expected_metric, expected_events): - @validate_custom_events(add_token_count_to_events(expected_events)) + @validate_custom_events(add_token_counts_to_chat_events(chat_completion_expected_events)) # One summary event, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( @@ -265,49 +265,6 @@ def _test(): _test() -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_chat_completion_error_incorrect_access_key_with_token_count( - exercise_converse_incorrect_access_key, set_trace_info, expected_metric -): - """ - A request is made to the server with invalid credentials. botocore will reach out to the server and receive an - UnrecognizedClientException as a response. Information from the request will be parsed and reported in customer - events. The error response can also be parsed, and will be included as attributes on the recorded exception. - """ - - @validate_custom_events(add_token_count_to_events(chat_completion_invalid_access_key_error_events)) - @validate_error_trace_attributes( - _client_error_name, - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "http.statusCode": 403, - "error.message": "The security token included in the request is invalid.", - "error.code": "UnrecognizedClientException", - }, - }, - ) - @validate_transaction_metrics( - name="test_bedrock_chat_completion_incorrect_access_key_with_token_count", - scoped_metrics=[expected_metric], - rollup_metrics=[expected_metric], - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, - ) - @background_task(name="test_bedrock_chat_completion_incorrect_access_key_with_token_count") - def _test(): - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - exercise_converse_incorrect_access_key() - - _test() - - @pytest.fixture def exercise_converse_invalid_model(bedrock_converse_server, response_streaming, monkeypatch): def _exercise_converse_invalid_model(): diff --git a/tests/external_botocore/test_bedrock_chat_completion_invoke_model.py b/tests/external_botocore/test_bedrock_chat_completion_invoke_model.py index 9acb0e8ed2..ac72e458fb 100644 --- a/tests/external_botocore/test_bedrock_chat_completion_invoke_model.py +++ b/tests/external_botocore/test_bedrock_chat_completion_invoke_model.py @@ -11,6 +11,7 @@ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. + import json import os from io import BytesIO @@ -35,7 +36,8 @@ from conftest import BOTOCORE_VERSION from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_streaming_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, disabled_ai_monitoring_streaming_settings, @@ -129,6 +131,14 @@ def expected_events(model_id, response_streaming): return chat_completion_expected_events[model_id] +@pytest.fixture(scope="module") +def expected_events(model_id, response_streaming): + if response_streaming: + return chat_completion_streaming_expected_events[model_id] + else: + return chat_completion_expected_events[model_id] + + @pytest.fixture(scope="module") def expected_metrics(response_streaming): if response_streaming: @@ -200,7 +210,7 @@ def _test(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) def test_bedrock_chat_completion_with_token_count(set_trace_info, exercise_model, expected_events, expected_metrics): - @validate_custom_events(add_token_count_to_events(expected_events)) + @validate_custom_events(add_token_counts_to_chat_events(add_token_count_streaming_events(expected_events))) # One summary event, one user message, and one response message from the assistant @validate_custom_event_count(count=3) @validate_transaction_metrics( @@ -438,49 +448,50 @@ def _test(): _test() -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_chat_completion_error_incorrect_access_key_with_token( - monkeypatch, - bedrock_server, - exercise_model, - set_trace_info, - expected_invalid_access_key_error_events, - expected_metrics, -): - @validate_custom_events(add_token_count_to_events(expected_invalid_access_key_error_events)) - @validate_error_trace_attributes( - _client_error_name, - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "http.statusCode": 403, - "error.message": "The security token included in the request is invalid.", - "error.code": "UnrecognizedClientException", - }, - }, - ) - @validate_transaction_metrics( - name="test_bedrock_chat_completion", - scoped_metrics=expected_metrics, - rollup_metrics=expected_metrics, - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, - ) - @background_task(name="test_bedrock_chat_completion") - def _test(): - monkeypatch.setattr(bedrock_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY") - - with pytest.raises(_client_error): # not sure where this exception actually comes from - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - exercise_model(prompt="Invalid Token", temperature=0.7, max_tokens=100) - - _test() +# +# @reset_core_stats_engine() +# @override_llm_token_callback_settings(llm_token_count_callback) +# def test_bedrock_chat_completion_error_incorrect_access_key_with_token( +# monkeypatch, +# bedrock_server, +# exercise_model, +# set_trace_info, +# expected_invalid_access_key_error_events, +# expected_metrics, +# ): +# @validate_custom_events(add_token_count_to_events(expected_invalid_access_key_error_events)) +# @validate_error_trace_attributes( +# _client_error_name, +# exact_attrs={ +# "agent": {}, +# "intrinsic": {}, +# "user": { +# "http.statusCode": 403, +# "error.message": "The security token included in the request is invalid.", +# "error.code": "UnrecognizedClientException", +# }, +# }, +# ) +# @validate_transaction_metrics( +# name="test_bedrock_chat_completion", +# scoped_metrics=expected_metrics, +# rollup_metrics=expected_metrics, +# custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], +# background_task=True, +# ) +# @background_task(name="test_bedrock_chat_completion") +# def _test(): +# monkeypatch.setattr(bedrock_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY") +# +# with pytest.raises(_client_error): # not sure where this exception actually comes from +# set_trace_info() +# add_custom_attribute("llm.conversation_id", "my-awesome-id") +# add_custom_attribute("llm.foo", "bar") +# add_custom_attribute("non_llm_attr", "python-agent") +# +# exercise_model(prompt="Invalid Token", temperature=0.7, max_tokens=100) +# +# _test() @reset_core_stats_engine() @@ -762,55 +773,6 @@ def _test(): _test() -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_chat_completion_error_streaming_exception_with_token_count(bedrock_server, set_trace_info): - """ - Duplicate of test_bedrock_chat_completion_error_streaming_exception, but with token callback being set. - - See the original test for a description of the error case. - """ - - @validate_custom_events(add_token_count_to_events(chat_completion_expected_streaming_error_events)) - @validate_custom_event_count(count=2) - @validate_error_trace_attributes( - _event_stream_error_name, - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "error.message": "Malformed input request, please reformat your input and try again.", - "error.code": "ValidationException", - }, - }, - forgone_params={"agent": (), "intrinsic": (), "user": ("http.statusCode")}, - ) - @validate_transaction_metrics( - name="test_bedrock_chat_completion", - scoped_metrics=[("Llm/completion/Bedrock/invoke_model_with_response_stream", 1)], - rollup_metrics=[("Llm/completion/Bedrock/invoke_model_with_response_stream", 1)], - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, - ) - @background_task(name="test_bedrock_chat_completion") - def _test(): - with pytest.raises(_event_stream_error): - model = "amazon.titan-text-express-v1" - body = (chat_completion_payload_templates[model] % ("Streaming Exception", 0.7, 100)).encode("utf-8") - - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - response = bedrock_server.invoke_model_with_response_stream( - body=body, modelId=model, accept="application/json", contentType="application/json" - ) - list(response["body"]) # Iterate - - _test() - - def test_bedrock_chat_completion_functions_marked_as_wrapped_for_sdk_compatibility(bedrock_server): assert bedrock_server._nr_wrapped diff --git a/tests/external_botocore/test_bedrock_embeddings.py b/tests/external_botocore/test_bedrock_embeddings.py index 36a5db6619..f28308354a 100644 --- a/tests/external_botocore/test_bedrock_embeddings.py +++ b/tests/external_botocore/test_bedrock_embeddings.py @@ -29,7 +29,7 @@ from conftest import BOTOCORE_VERSION from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_count_to_events, + add_token_count_to_embedding_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -162,7 +162,7 @@ def _test(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) def test_bedrock_embedding_with_token_count(set_trace_info, exercise_model, expected_events): - @validate_custom_events(add_token_count_to_events(expected_events)) + @validate_custom_events(add_token_count_to_embedding_events(expected_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( name="test_bedrock_embedding", @@ -287,45 +287,6 @@ def _test(): _test() -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_embedding_error_incorrect_access_key_with_token_count( - monkeypatch, bedrock_server, exercise_model, set_trace_info, expected_invalid_access_key_error_events -): - @validate_custom_events(add_token_count_to_events(expected_invalid_access_key_error_events)) - @validate_error_trace_attributes( - _client_error_name, - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "http.statusCode": 403, - "error.message": "The security token included in the request is invalid.", - "error.code": "UnrecognizedClientException", - }, - }, - ) - @validate_transaction_metrics( - name="test_bedrock_embedding", - scoped_metrics=[("Llm/embedding/Bedrock/invoke_model", 1)], - rollup_metrics=[("Llm/embedding/Bedrock/invoke_model", 1)], - background_task=True, - ) - @background_task(name="test_bedrock_embedding") - def _test(): - monkeypatch.setattr(bedrock_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY") - - with pytest.raises(_client_error): # not sure where this exception actually comes from - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - exercise_model(prompt="Invalid Token") - - _test() - - @reset_core_stats_engine() def test_bedrock_embedding_error_malformed_request_body(bedrock_server, set_trace_info): """ diff --git a/tests/mlmodel_openai/test_embeddings_error.py b/tests/mlmodel_openai/test_embeddings_error.py index a8e46bf23a..f80e6ff41d 100644 --- a/tests/mlmodel_openai/test_embeddings_error.py +++ b/tests/mlmodel_openai/test_embeddings_error.py @@ -14,12 +14,10 @@ import openai import pytest -from testing_support.fixtures import dt_enabled, override_llm_token_callback_settings, reset_core_stats_engine +from testing_support.fixtures import dt_enabled, reset_core_stats_engine from testing_support.ml_testing_utils import ( - add_token_count_to_events, disabled_ai_monitoring_record_content_settings, events_sans_content, - llm_token_count_callback, set_trace_info, ) from testing_support.validators.validate_custom_event import validate_custom_event_count @@ -128,35 +126,6 @@ def test_embeddings_invalid_request_error_no_model_no_content(set_trace_info): ] -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.InvalidRequestError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"http.statusCode": 404}}, -) -@validate_span_events( - exact_agents={ - "error.message": "The model `does-not-exist` does not exist" - # "http.statusCode": 404, - } -) -@validate_transaction_metrics( - name="test_embeddings_error:test_embeddings_invalid_request_error_invalid_model_with_token_count", - scoped_metrics=[("Llm/embedding/OpenAI/create", 1)], - rollup_metrics=[("Llm/embedding/OpenAI/create", 1)], - custom_metrics=[(f"Supportability/Python/ML/OpenAI/{openai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_with_token_count(set_trace_info): - set_trace_info() - with pytest.raises(openai.InvalidRequestError): - openai.Embedding.create(input="Model does not exist.", model="does-not-exist") - - # Invalid model provided @dt_enabled @reset_core_stats_engine() @@ -348,30 +317,6 @@ def test_embeddings_invalid_request_error_no_model_async_no_content(loop, set_tr ) -@dt_enabled -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -@validate_error_trace_attributes( - callable_name(openai.InvalidRequestError), - exact_attrs={"agent": {}, "intrinsic": {}, "user": {"http.statusCode": 404}}, -) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) -@validate_transaction_metrics( - name="test_embeddings_error:test_embeddings_invalid_request_error_invalid_model_with_token_count_async", - scoped_metrics=[("Llm/embedding/OpenAI/acreate", 1)], - rollup_metrics=[("Llm/embedding/OpenAI/acreate", 1)], - custom_metrics=[(f"Supportability/Python/ML/OpenAI/{openai.__version__}", 1)], - background_task=True, -) -@validate_custom_events(add_token_count_to_events(invalid_model_events)) -@validate_custom_event_count(count=1) -@background_task() -def test_embeddings_invalid_request_error_invalid_model_with_token_count_async(set_trace_info, loop): - set_trace_info() - with pytest.raises(openai.InvalidRequestError): - loop.run_until_complete(openai.Embedding.acreate(input="Model does not exist.", model="does-not-exist")) - - # Invalid model provided @dt_enabled @reset_core_stats_engine() From bf80674de84467aa4ad2e9b2710efe8759d8e933 Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Wed, 10 Dec 2025 19:02:25 -0800 Subject: [PATCH 032/124] Reconcile changes from main and token counting branch. --- .../test_bedrock_chat_completion_converse.py | 6 +++++- .../_test_bedrock_chat_completion_invoke_model.py | 5 +++++ .../test_bedrock_chat_completion_converse.py | 9 +++++++-- 3 files changed, 17 insertions(+), 3 deletions(-) diff --git a/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py b/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py index f115fc3d90..765d21f790 100644 --- a/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py +++ b/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py @@ -24,6 +24,7 @@ from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( add_token_counts_to_chat_events, + add_token_count_streaming_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -147,7 +148,10 @@ def _test(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) def test_bedrock_chat_completion_with_token_count(set_trace_info, exercise_model, expected_metric, expected_events): - @validate_custom_events(add_token_counts_to_chat_events(chat_completion_expected_events)) + expected_events = add_token_counts_to_chat_events(expected_events) + if response_streaming: + expected_events = add_token_count_streaming_events(expected_events) + @validate_custom_events(expected_events) # One summary event, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( diff --git a/tests/external_botocore/_test_bedrock_chat_completion_invoke_model.py b/tests/external_botocore/_test_bedrock_chat_completion_invoke_model.py index 63db603f78..e7b1844922 100644 --- a/tests/external_botocore/_test_bedrock_chat_completion_invoke_model.py +++ b/tests/external_botocore/_test_bedrock_chat_completion_invoke_model.py @@ -294,6 +294,9 @@ "duration": None, # Response time varies each test run "request.model": "anthropic.claude-3-sonnet-20240229-v1:0", "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", + "response.usage.completion_tokens": 31, + "response.usage.prompt_tokens": 21, + "response.usage.total_tokens": 52, "request.temperature": 0.7, "request.max_tokens": 100, "response.choices.finish_reason": "end_turn", @@ -316,6 +319,7 @@ "role": "user", "completion_id": None, "sequence": 0, + "token_count": 0, "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", "vendor": "bedrock", "ingest_source": "Python", @@ -335,6 +339,7 @@ "role": "assistant", "completion_id": None, "sequence": 1, + "token_count": 0, "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", "vendor": "bedrock", "ingest_source": "Python", diff --git a/tests/external_botocore/test_bedrock_chat_completion_converse.py b/tests/external_botocore/test_bedrock_chat_completion_converse.py index ca6cfd9d7b..273a2626f5 100644 --- a/tests/external_botocore/test_bedrock_chat_completion_converse.py +++ b/tests/external_botocore/test_bedrock_chat_completion_converse.py @@ -24,6 +24,7 @@ from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( add_token_counts_to_chat_events, + add_token_count_streaming_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -140,8 +141,12 @@ def _test(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_chat_completion_with_token_count(set_trace_info, exercise_model, expected_metric, expected_events): - @validate_custom_events(add_token_counts_to_chat_events(chat_completion_expected_events)) +def test_bedrock_chat_completion_with_token_count(set_trace_info, exercise_model, expected_metric, expected_events, response_streaming): + expected_events = add_token_counts_to_chat_events(expected_events) + if response_streaming: + expected_events = add_token_count_streaming_events(expected_events) + + @validate_custom_events(expected_events) # One summary event, one user message, and one response message from the assistant @validate_custom_event_count(count=4) @validate_transaction_metrics( From 4ea432ae26581cb0e165849156d89ae21caf5e64 Mon Sep 17 00:00:00 2001 From: umaannamalai <19895951+umaannamalai@users.noreply.github.com> Date: Thu, 11 Dec 2025 03:10:37 +0000 Subject: [PATCH 033/124] [MegaLinter] Apply linters fixes --- .../test_bedrock_chat_completion_converse.py | 2 +- .../test_bedrock_chat_completion_converse.py | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py b/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py index 5fedb34550..516787c2e5 100644 --- a/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py +++ b/tests/external_aiobotocore/test_bedrock_chat_completion_converse.py @@ -23,8 +23,8 @@ ) from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_counts_to_chat_events, add_token_count_streaming_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, diff --git a/tests/external_botocore/test_bedrock_chat_completion_converse.py b/tests/external_botocore/test_bedrock_chat_completion_converse.py index 273a2626f5..b613b6c3a8 100644 --- a/tests/external_botocore/test_bedrock_chat_completion_converse.py +++ b/tests/external_botocore/test_bedrock_chat_completion_converse.py @@ -23,8 +23,8 @@ from conftest import BOTOCORE_VERSION from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( - add_token_counts_to_chat_events, add_token_count_streaming_events, + add_token_counts_to_chat_events, disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, events_sans_content, @@ -141,7 +141,9 @@ def _test(): @reset_core_stats_engine() @override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_chat_completion_with_token_count(set_trace_info, exercise_model, expected_metric, expected_events, response_streaming): +def test_bedrock_chat_completion_with_token_count( + set_trace_info, exercise_model, expected_metric, expected_events, response_streaming +): expected_events = add_token_counts_to_chat_events(expected_events) if response_streaming: expected_events = add_token_count_streaming_events(expected_events) From 4897665750cb5e307c24c6542a91ccb4803d3346 Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Wed, 10 Dec 2025 20:04:18 -0800 Subject: [PATCH 034/124] Remove outdated converse testing file. --- .../test_chat_completion_converse.py | 476 ------------------ 1 file changed, 476 deletions(-) delete mode 100644 tests/external_botocore/test_chat_completion_converse.py diff --git a/tests/external_botocore/test_chat_completion_converse.py b/tests/external_botocore/test_chat_completion_converse.py deleted file mode 100644 index 2d38d6b4a4..0000000000 --- a/tests/external_botocore/test_chat_completion_converse.py +++ /dev/null @@ -1,476 +0,0 @@ -# Copyright 2010 New Relic, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import botocore.exceptions -import pytest -from conftest import BOTOCORE_VERSION -from testing_support.fixtures import override_llm_token_callback_settings, reset_core_stats_engine, validate_attributes -from testing_support.ml_testing_utils import ( - add_token_counts_to_chat_events, - disabled_ai_monitoring_record_content_settings, - disabled_ai_monitoring_settings, - events_sans_content, - events_sans_llm_metadata, - events_with_context_attrs, - llm_token_count_callback, - set_trace_info, -) -from testing_support.validators.validate_custom_event import validate_custom_event_count -from testing_support.validators.validate_custom_events import validate_custom_events -from testing_support.validators.validate_error_trace_attributes import validate_error_trace_attributes -from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics - -from newrelic.api.background_task import background_task -from newrelic.api.llm_custom_attributes import WithLlmCustomAttributes -from newrelic.api.transaction import add_custom_attribute -from newrelic.common.object_names import callable_name - -chat_completion_expected_events = [ - ( - {"type": "LlmChatCompletionSummary"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "span_id": None, - "trace_id": "trace-id", - "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", - "duration": None, # Response time varies each test run - "request.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "response.usage.prompt_tokens": 26, - "response.usage.completion_tokens": 100, - "response.usage.total_tokens": 126, - "request.temperature": 0.7, - "request.max_tokens": 100, - "response.choices.finish_reason": "max_tokens", - "vendor": "bedrock", - "ingest_source": "Python", - "response.number_of_messages": 3, - }, - ), - ( - {"type": "LlmChatCompletionMessage"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", - "span_id": None, - "trace_id": "trace-id", - "content": "You are a scientist.", - "role": "system", - "completion_id": None, - "sequence": 0, - "token_count": 0, - "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "vendor": "bedrock", - "ingest_source": "Python", - }, - ), - ( - {"type": "LlmChatCompletionMessage"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", - "span_id": None, - "trace_id": "trace-id", - "content": "What is 212 degrees Fahrenheit converted to Celsius?", - "role": "user", - "completion_id": None, - "sequence": 1, - "token_count": 0, - "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "vendor": "bedrock", - "ingest_source": "Python", - }, - ), - ( - {"type": "LlmChatCompletionMessage"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", - "span_id": None, - "trace_id": "trace-id", - "content": "To convert 212°F to Celsius, we can use the formula:\n\nC = (F - 32) × 5/9\n\nWhere:\nC is the temperature in Celsius\nF is the temperature in Fahrenheit\n\nPlugging in 212°F, we get:\n\nC = (212 - 32) × 5/9\nC = 180 × 5/9\nC = 100\n\nTherefore, 212°", # noqa: RUF001 - "role": "assistant", - "completion_id": None, - "sequence": 2, - "token_count": 0, - "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "vendor": "bedrock", - "ingest_source": "Python", - "is_response": True, - }, - ), -] - - -@pytest.fixture(scope="module") -def exercise_model(bedrock_converse_server): - def _exercise_model(message): - inference_config = {"temperature": 0.7, "maxTokens": 100} - - response = bedrock_converse_server.converse( - modelId="anthropic.claude-3-sonnet-20240229-v1:0", - messages=message, - system=[{"text": "You are a scientist."}], - inferenceConfig=inference_config, - ) - - return _exercise_model - - -@reset_core_stats_engine() -def test_bedrock_chat_completion_in_txn_with_llm_metadata(set_trace_info, exercise_model): - @validate_custom_events(events_with_context_attrs(chat_completion_expected_events)) - # One summary event, one user message, and one response message from the assistant - @validate_custom_event_count(count=4) - @validate_transaction_metrics( - name="test_bedrock_chat_completion_in_txn_with_llm_metadata", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, - ) - @validate_attributes("agent", ["llm"]) - @background_task(name="test_bedrock_chat_completion_in_txn_with_llm_metadata") - def _test(): - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - with WithLlmCustomAttributes({"context": "attr"}): - message = [{"role": "user", "content": [{"text": "What is 212 degrees Fahrenheit converted to Celsius?"}]}] - exercise_model(message) - - _test() - - -@disabled_ai_monitoring_record_content_settings -@reset_core_stats_engine() -def test_bedrock_chat_completion_no_content(set_trace_info, exercise_model): - @validate_custom_events(events_sans_content(chat_completion_expected_events)) - # One summary event, one user message, and one response message from the assistant - @validate_custom_event_count(count=4) - @validate_transaction_metrics( - name="test_bedrock_chat_completion_no_content", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, - ) - @validate_attributes("agent", ["llm"]) - @background_task(name="test_bedrock_chat_completion_no_content") - def _test(): - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - message = [{"role": "user", "content": [{"text": "What is 212 degrees Fahrenheit converted to Celsius?"}]}] - exercise_model(message) - - _test() - - -@reset_core_stats_engine() -@override_llm_token_callback_settings(llm_token_count_callback) -def test_bedrock_chat_completion_with_token_count(set_trace_info, exercise_model): - @validate_custom_events(add_token_counts_to_chat_events(chat_completion_expected_events)) - # One summary event, one user message, and one response message from the assistant - @validate_custom_event_count(count=4) - @validate_transaction_metrics( - name="test_bedrock_chat_completion_with_token_count", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, - ) - @validate_attributes("agent", ["llm"]) - @background_task(name="test_bedrock_chat_completion_with_token_count") - def _test(): - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - message = [{"role": "user", "content": [{"text": "What is 212 degrees Fahrenheit converted to Celsius?"}]}] - exercise_model(message) - - _test() - - -@reset_core_stats_engine() -def test_bedrock_chat_completion_no_llm_metadata(set_trace_info, exercise_model): - @validate_custom_events(events_sans_llm_metadata(chat_completion_expected_events)) - @validate_custom_event_count(count=4) - @validate_transaction_metrics( - name="test_bedrock_chat_completion_in_txn_no_llm_metadata", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, - ) - @background_task(name="test_bedrock_chat_completion_in_txn_no_llm_metadata") - def _test(): - set_trace_info() - message = [{"role": "user", "content": [{"text": "What is 212 degrees Fahrenheit converted to Celsius?"}]}] - exercise_model(message) - - _test() - - -@reset_core_stats_engine() -@validate_custom_event_count(count=0) -def test_bedrock_chat_completion_outside_txn(exercise_model): - add_custom_attribute("llm.conversation_id", "my-awesome-id") - message = [{"role": "user", "content": [{"text": "What is 212 degrees Fahrenheit converted to Celsius?"}]}] - exercise_model(message) - - -@disabled_ai_monitoring_settings -@reset_core_stats_engine() -@validate_custom_event_count(count=0) -@background_task(name="test_bedrock_chat_completion_disabled_ai_monitoring_settings") -def test_bedrock_chat_completion_disabled_ai_monitoring_settings(set_trace_info, exercise_model): - set_trace_info() - message = [{"role": "user", "content": [{"text": "What is 212 degrees Fahrenheit converted to Celsius?"}]}] - exercise_model(message) - - -chat_completion_invalid_access_key_error_events = [ - ( - {"type": "LlmChatCompletionSummary"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "span_id": None, - "trace_id": "trace-id", - "request_id": "e1206e19-2318-4a9d-be98-017c73f06118", - "duration": None, # Response time varies each test run - "request.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "request.temperature": 0.7, - "request.max_tokens": 100, - "vendor": "bedrock", - "ingest_source": "Python", - "response.number_of_messages": 1, - "error": True, - }, - ), - ( - {"type": "LlmChatCompletionMessage"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "request_id": "e1206e19-2318-4a9d-be98-017c73f06118", - "span_id": None, - "trace_id": "trace-id", - "content": "Invalid Token", - "role": "user", - "completion_id": None, - "sequence": 0, - "response.model": "anthropic.claude-3-sonnet-20240229-v1:0", - "vendor": "bedrock", - "ingest_source": "Python", - }, - ), -] - -_client_error = botocore.exceptions.ClientError -_client_error_name = callable_name(_client_error) - - -@reset_core_stats_engine() -def test_bedrock_chat_completion_error_incorrect_access_key( - monkeypatch, bedrock_converse_server, exercise_model, set_trace_info -): - """ - A request is made to the server with invalid credentials. botocore will reach out to the server and receive an - UnrecognizedClientException as a response. Information from the request will be parsed and reported in customer - events. The error response can also be parsed, and will be included as attributes on the recorded exception. - """ - - @validate_custom_events(chat_completion_invalid_access_key_error_events) - @validate_error_trace_attributes( - _client_error_name, - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "http.statusCode": 403, - "error.message": "The security token included in the request is invalid.", - "error.code": "UnrecognizedClientException", - }, - }, - ) - @validate_transaction_metrics( - name="test_bedrock_chat_completion", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, - ) - @background_task(name="test_bedrock_chat_completion") - def _test(): - monkeypatch.setattr(bedrock_converse_server._request_signer._credentials, "access_key", "INVALID-ACCESS-KEY") - - with pytest.raises(_client_error): - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - message = [{"role": "user", "content": [{"text": "Invalid Token"}]}] - - response = bedrock_converse_server.converse( - modelId="anthropic.claude-3-sonnet-20240229-v1:0", - messages=message, - inferenceConfig={"temperature": 0.7, "maxTokens": 100}, - ) - - assert response - - _test() - - -chat_completion_invalid_model_error_events = [ - ( - {"type": "LlmChatCompletionSummary"}, - { - "id": None, # UUID that varies with each run - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "request_id": "f4908827-3db9-4742-9103-2bbc34578b03", - "span_id": None, - "trace_id": "trace-id", - "duration": None, # Response time varies each test run - "request.model": "does-not-exist", - "response.model": "does-not-exist", - "request.temperature": 0.7, - "request.max_tokens": 100, - "response.number_of_messages": 1, - "vendor": "bedrock", - "ingest_source": "Python", - "error": True, - }, - ), - ( - {"type": "LlmChatCompletionMessage"}, - { - "id": None, - "llm.conversation_id": "my-awesome-id", - "llm.foo": "bar", - "span_id": None, - "trace_id": "trace-id", - "request_id": "f4908827-3db9-4742-9103-2bbc34578b03", - "content": "Model does not exist.", - "role": "user", - "completion_id": None, - "response.model": "does-not-exist", - "sequence": 0, - "vendor": "bedrock", - "ingest_source": "Python", - }, - ), -] - - -@reset_core_stats_engine() -def test_bedrock_chat_completion_error_invalid_model(bedrock_converse_server, set_trace_info): - @validate_custom_events(events_with_context_attrs(chat_completion_invalid_model_error_events)) - @validate_error_trace_attributes( - "botocore.errorfactory:ValidationException", - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "http.statusCode": 400, - "error.message": "The provided model identifier is invalid.", - "error.code": "ValidationException", - }, - }, - ) - @validate_transaction_metrics( - name="test_bedrock_chat_completion_error_invalid_model", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, - ) - @background_task(name="test_bedrock_chat_completion_error_invalid_model") - def _test(): - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - with pytest.raises(_client_error): - with WithLlmCustomAttributes({"context": "attr"}): - message = [{"role": "user", "content": [{"text": "Model does not exist."}]}] - - response = bedrock_converse_server.converse( - modelId="does-not-exist", messages=message, inferenceConfig={"temperature": 0.7, "maxTokens": 100} - ) - - assert response - - _test() - - -@reset_core_stats_engine() -@disabled_ai_monitoring_record_content_settings -def test_bedrock_chat_completion_error_invalid_model_no_content(bedrock_converse_server, set_trace_info): - @validate_custom_events(events_sans_content(chat_completion_invalid_model_error_events)) - @validate_error_trace_attributes( - "botocore.errorfactory:ValidationException", - exact_attrs={ - "agent": {}, - "intrinsic": {}, - "user": { - "http.statusCode": 400, - "error.message": "The provided model identifier is invalid.", - "error.code": "ValidationException", - }, - }, - ) - @validate_transaction_metrics( - name="test_bedrock_chat_completion_error_invalid_model_no_content", - scoped_metrics=[("Llm/completion/Bedrock/converse", 1)], - rollup_metrics=[("Llm/completion/Bedrock/converse", 1)], - custom_metrics=[(f"Supportability/Python/ML/Bedrock/{BOTOCORE_VERSION}", 1)], - background_task=True, - ) - @background_task(name="test_bedrock_chat_completion_error_invalid_model_no_content") - def _test(): - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - with pytest.raises(_client_error): - message = [{"role": "user", "content": [{"text": "Model does not exist."}]}] - - response = bedrock_converse_server.converse( - modelId="does-not-exist", messages=message, inferenceConfig={"temperature": 0.7, "maxTokens": 100} - ) - - assert response - - _test() From d04c1c6bea530ef6eb3cff53f8bbb327ae6d1249 Mon Sep 17 00:00:00 2001 From: Lalleh Rafeei Date: Thu, 11 Dec 2025 17:19:50 -0800 Subject: [PATCH 035/124] Pin scikit-learn --- tox.ini | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tox.ini b/tox.ini index 98308c74cb..11ba696c83 100644 --- a/tox.ini +++ b/tox.ini @@ -262,7 +262,8 @@ deps = mlmodel_sklearn: pandas mlmodel_sklearn: protobuf mlmodel_sklearn: numpy - mlmodel_sklearn-scikitlearnlatest: scikit-learn + ; Temporarily pin scikit-learn to below v1.8.0 + mlmodel_sklearn-scikitlearnlatest: scikit-learn<1.8 mlmodel_sklearn-scikitlearnlatest: scipy component_djangorestframework-djangorestframeworklatest: Django component_djangorestframework-djangorestframeworklatest: djangorestframework From 563c431c8e5bab9a8cad8ef782aa4330fc358e02 Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Tue, 16 Dec 2025 11:15:49 -0500 Subject: [PATCH 036/124] Free Threaded Python Support (#1554) * Update wrapt * Add no GIL flag to thread_utilization extension * Enable testing for Python 3.14 free threading in tox * Add python free threading wheels * Misc updates after wrapt upgrade --- .github/workflows/deploy.yml | 9 + newrelic/common/object_wrapper.py | 11 +- newrelic/core/_thread_utilization.c | 13 +- newrelic/hooks/database_dbapi2.py | 3 + newrelic/packages/requirements.txt | 2 +- newrelic/packages/wrapt/__init__.py | 89 +- newrelic/packages/wrapt/__init__.pyi | 315 ++ newrelic/packages/wrapt/__wrapt__.py | 50 +- newrelic/packages/wrapt/_wrappers.c | 4825 +++++++++++++--------- newrelic/packages/wrapt/arguments.py | 47 +- newrelic/packages/wrapt/decorators.py | 177 +- newrelic/packages/wrapt/importer.py | 151 +- newrelic/packages/wrapt/patches.py | 144 +- newrelic/packages/wrapt/proxies.py | 282 ++ newrelic/packages/wrapt/py.typed | 1 + newrelic/packages/wrapt/weakrefs.py | 40 +- newrelic/packages/wrapt/wrappers.py | 560 ++- tests/datastore_psycopg/test_cursor.py | 4 +- tests/datastore_psycopg/test_register.py | 4 +- tests/datastore_psycopg/test_rollback.py | 2 +- tox.ini | 196 +- 21 files changed, 4405 insertions(+), 2520 deletions(-) create mode 100644 newrelic/packages/wrapt/__init__.pyi create mode 100644 newrelic/packages/wrapt/proxies.py create mode 100644 newrelic/packages/wrapt/py.typed diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index af4739f2a3..4c0c627db3 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -41,8 +41,12 @@ jobs: os: ubuntu-24.04 - wheel: cp313-manylinux os: ubuntu-24.04 + - wheel: cp313t-manylinux + os: ubuntu-24.04 - wheel: cp314-manylinux os: ubuntu-24.04 + - wheel: cp314t-manylinux + os: ubuntu-24.04 # Linux musllibc - wheel: cp38-musllinux os: ubuntu-24.04 @@ -56,8 +60,12 @@ jobs: os: ubuntu-24.04 - wheel: cp313-musllinux os: ubuntu-24.04 + - wheel: cp313t-musllinux + os: ubuntu-24.04 - wheel: cp314-musllinux os: ubuntu-24.04 + - wheel: cp314t-musllinux + os: ubuntu-24.04 # Windows # Windows wheels won't but published until the full release announcement. # - wheel: cp313-win @@ -89,6 +97,7 @@ jobs: CIBW_ARCHS_MACOS: native CIBW_ARCHS_WINDOWS: AMD64 ARM64 CIBW_ENVIRONMENT_LINUX: "LD_LIBRARY_PATH=/opt/rh/devtoolset-8/root/usr/lib64:/opt/rh/devtoolset-8/root/usr/lib:/opt/rh/devtoolset-8/root/usr/lib64/dyninst:/opt/rh/devtoolset-8/root/usr/lib/dyninst:/usr/local/lib64:/usr/local/lib" + CIBW_ENABLE: cpython-freethreading CIBW_TEST_REQUIRES: pytest CIBW_TEST_COMMAND_LINUX: "export PYTHONPATH={project}/tests; pytest {project}/tests/agent_unittests -vx" CIBW_TEST_COMMAND_MACOS: "export PYTHONPATH={project}/tests; pytest {project}/tests/agent_unittests -vx" diff --git a/newrelic/common/object_wrapper.py b/newrelic/common/object_wrapper.py index be8c351f4e..e535559109 100644 --- a/newrelic/common/object_wrapper.py +++ b/newrelic/common/object_wrapper.py @@ -21,11 +21,16 @@ import inspect +from newrelic.packages.wrapt import ( # noqa: F401 + BaseObjectProxy, + apply_patch, + resolve_path, + wrap_object, + wrap_object_attribute, +) from newrelic.packages.wrapt import BoundFunctionWrapper as _BoundFunctionWrapper from newrelic.packages.wrapt import CallableObjectProxy as _CallableObjectProxy from newrelic.packages.wrapt import FunctionWrapper as _FunctionWrapper -from newrelic.packages.wrapt import ObjectProxy as _ObjectProxy -from newrelic.packages.wrapt import apply_patch, resolve_path, wrap_object, wrap_object_attribute # noqa: F401 # We previously had our own pure Python implementation of the generic # object wrapper but we now defer to using the wrapt module as its C @@ -44,7 +49,7 @@ # ObjectProxy or FunctionWrapper should be used going forward. -class ObjectProxy(_ObjectProxy): +class ObjectProxy(BaseObjectProxy): """ This class provides method overrides for all object wrappers used by the agent. These methods allow attributes to be defined with the special prefix diff --git a/newrelic/core/_thread_utilization.c b/newrelic/core/_thread_utilization.c index d1d7bfacc6..18f081a5be 100644 --- a/newrelic/core/_thread_utilization.c +++ b/newrelic/core/_thread_utilization.c @@ -202,13 +202,10 @@ static PyObject *NRUtilization_new(PyTypeObject *type, return NULL; /* - * XXX Using a mutex for now just in case the calls to get - * the current thread are causing release of GIL in a - * multithreaded context. May explain why having issues with - * object referred to by weakrefs being corrupted. The GIL - * should technically be enough to protect us here. + * Using a mutex to ensure this is compatible with free threaded Python interpreters. + * In the past, this relied on the GIL for thread safety with weakrefs but that was + * not reliable enough anyway. */ - self->thread_mutex = PyThread_allocate_lock(); self->set_of_all_threads = PyDict_New(); @@ -455,6 +452,10 @@ moduleinit(void) PyModule_AddObject(module, "ThreadUtilization", (PyObject *)&NRUtilization_Type); +#ifdef Py_GIL_DISABLED + PyUnstable_Module_SetGIL(module, Py_MOD_GIL_NOT_USED); +#endif + return module; } diff --git a/newrelic/hooks/database_dbapi2.py b/newrelic/hooks/database_dbapi2.py index b100fa58de..1e38880113 100644 --- a/newrelic/hooks/database_dbapi2.py +++ b/newrelic/hooks/database_dbapi2.py @@ -89,6 +89,9 @@ def callproc(self, procname, parameters=DEFAULT): else: return self.__wrapped__.callproc(procname) + def __iter__(self): + return iter(self.__wrapped__) + class ConnectionWrapper(ObjectProxy): __cursor_wrapper__ = CursorWrapper diff --git a/newrelic/packages/requirements.txt b/newrelic/packages/requirements.txt index 5d8c59db2e..b3820134f3 100644 --- a/newrelic/packages/requirements.txt +++ b/newrelic/packages/requirements.txt @@ -4,5 +4,5 @@ # to the New Relic Python Agent's dependencies in newrelic/packages/. opentelemetry_proto==1.32.1 urllib3==1.26.19 -wrapt==1.16.0 +wrapt==2.0.0 asgiref==3.6.0 # We only vendor asgiref.compatibility.py diff --git a/newrelic/packages/wrapt/__init__.py b/newrelic/packages/wrapt/__init__.py index ed31a94313..3735818c61 100644 --- a/newrelic/packages/wrapt/__init__.py +++ b/newrelic/packages/wrapt/__init__.py @@ -1,30 +1,63 @@ -__version_info__ = ('1', '16', '0') -__version__ = '.'.join(__version_info__) - -from .__wrapt__ import (ObjectProxy, CallableObjectProxy, FunctionWrapper, - BoundFunctionWrapper, PartialCallableObjectProxy) - -from .patches import (resolve_path, apply_patch, wrap_object, wrap_object_attribute, - function_wrapper, wrap_function_wrapper, patch_function_wrapper, - transient_function_wrapper) - +""" +Wrapt is a library for decorators, wrappers and monkey patching. +""" + +__version_info__ = ("2", "0", "0") +__version__ = ".".join(__version_info__) + +from .__wrapt__ import ( + BaseObjectProxy, + BoundFunctionWrapper, + CallableObjectProxy, + FunctionWrapper, + PartialCallableObjectProxy, + partial, +) +from .decorators import AdapterFactory, adapter_factory, decorator, synchronized +from .importer import ( + discover_post_import_hooks, + notify_module_loaded, + register_post_import_hook, + when_imported, +) +from .patches import ( + apply_patch, + function_wrapper, + patch_function_wrapper, + resolve_path, + transient_function_wrapper, + wrap_function_wrapper, + wrap_object, + wrap_object_attribute, +) +from .proxies import AutoObjectProxy, LazyObjectProxy, ObjectProxy, lazy_import from .weakrefs import WeakFunctionProxy -from .decorators import (adapter_factory, AdapterFactory, decorator, - synchronized) - -from .importer import (register_post_import_hook, when_imported, - notify_module_loaded, discover_post_import_hooks) - -# Import of inspect.getcallargs() included for backward compatibility. An -# implementation of this was previously bundled and made available here for -# Python <2.7. Avoid using this in future. - -from inspect import getcallargs - -# Variant of inspect.formatargspec() included here for forward compatibility. -# This is being done because Python 3.11 dropped inspect.formatargspec() but -# code for handling signature changing decorators relied on it. Exposing the -# bundled implementation here in case any user of wrapt was also needing it. - -from .arguments import formatargspec +__all__ = ( + "AutoObjectProxy", + "BaseObjectProxy", + "BoundFunctionWrapper", + "CallableObjectProxy", + "FunctionWrapper", + "LazyObjectProxy", + "ObjectProxy", + "PartialCallableObjectProxy", + "partial", + "AdapterFactory", + "adapter_factory", + "decorator", + "synchronized", + "discover_post_import_hooks", + "notify_module_loaded", + "register_post_import_hook", + "when_imported", + "apply_patch", + "function_wrapper", + "patch_function_wrapper", + "resolve_path", + "transient_function_wrapper", + "wrap_function_wrapper", + "wrap_object", + "wrap_object_attribute", + "WeakFunctionProxy", +) diff --git a/newrelic/packages/wrapt/__init__.pyi b/newrelic/packages/wrapt/__init__.pyi new file mode 100644 index 0000000000..31ba64ca10 --- /dev/null +++ b/newrelic/packages/wrapt/__init__.pyi @@ -0,0 +1,315 @@ +import sys + +if sys.version_info >= (3, 10): + from inspect import FullArgSpec + from types import ModuleType, TracebackType + from typing import ( + Any, + Callable, + Concatenate, + Generic, + ParamSpec, + Protocol, + TypeVar, + overload, + ) + + P = ParamSpec("P") + R = TypeVar("R", covariant=True) + + T = TypeVar("T", bound=Any) + + class Boolean(Protocol): + def __bool__(self) -> bool: ... + + # ObjectProxy + + class BaseObjectProxy(Generic[T]): + __wrapped__: T + def __init__(self, wrapped: T) -> None: ... + + class ObjectProxy(BaseObjectProxy[T]): + def __init__(self, wrapped: T) -> None: ... + + class AutoObjectProxy(BaseObjectProxy[T]): + def __init__(self, wrapped: T) -> None: ... + + # LazyObjectProxy + + class LazyObjectProxy(AutoObjectProxy[T]): + def __init__(self, callback: Callable[[], T] | None) -> None: ... + + @overload + def lazy_import(name: str) -> LazyObjectProxy[ModuleType]: ... + @overload + def lazy_import(name: str, attribute: str) -> LazyObjectProxy[Any]: ... + + # CallableObjectProxy + + class CallableObjectProxy(BaseObjectProxy[T]): + def __call__(self, *args: Any, **kwargs: Any) -> Any: ... + + # PartialCallableObjectProxy + + class PartialCallableObjectProxy: + def __init__( + self, func: Callable[..., Any], *args: Any, **kwargs: Any + ) -> None: ... + def __call__(self, *args: Any, **kwargs: Any) -> Any: ... + + def partial( + func: Callable[..., Any], /, *args: Any, **kwargs: Any + ) -> Callable[..., Any]: ... + + # WeakFunctionProxy + + class WeakFunctionProxy: + def __init__( + self, + wrapped: Callable[..., Any], + callback: Callable[..., Any] | None = None, + ) -> None: ... + def __call__(self, *args: Any, **kwargs: Any) -> Any: ... + + # FunctionWrapper + + WrappedFunction = Callable[P, R] + + GenericCallableWrapperFunction = Callable[ + [WrappedFunction[P, R], Any, tuple[Any, ...], dict[str, Any]], R + ] + + ClassMethodWrapperFunction = Callable[ + [type[Any], WrappedFunction[P, R], Any, tuple[Any, ...], dict[str, Any]], R + ] + + InstanceMethodWrapperFunction = Callable[ + [Any, WrappedFunction[P, R], Any, tuple[Any, ...], dict[str, Any]], R + ] + + WrapperFunction = ( + GenericCallableWrapperFunction[P, R] + | ClassMethodWrapperFunction[P, R] + | InstanceMethodWrapperFunction[P, R] + ) + + class _FunctionWrapperBase(ObjectProxy[WrappedFunction[P, R]]): + _self_instance: Any + _self_wrapper: WrapperFunction[P, R] + _self_enabled: bool | Boolean | Callable[[], bool] | None + _self_binding: str + _self_parent: Any + _self_owner: Any + + class BoundFunctionWrapper(_FunctionWrapperBase[P, R]): + def __call__(self, *args: P.args, **kwargs: P.kwargs) -> R: ... + def __get__( + self, instance: Any, owner: type[Any] | None = None + ) -> "BoundFunctionWrapper[P, R]": ... + + class FunctionWrapper(_FunctionWrapperBase[P, R]): + def __init__( + self, + wrapped: WrappedFunction[P, R], + wrapper: WrapperFunction[P, R], + enabled: bool | Boolean | Callable[[], bool] | None = None, + ) -> None: ... + def __call__(self, *args: P.args, **kwargs: P.kwargs) -> R: ... + def __get__( + self, instance: Any, owner: type[Any] | None = None + ) -> BoundFunctionWrapper[P, R]: ... + + # AdapterFactory/adapter_factory() + + class AdapterFactory(Protocol): + def __call__( + self, wrapped: Callable[..., Any] + ) -> str | FullArgSpec | Callable[..., Any]: ... + + def adapter_factory(wrapped: Callable[..., Any]) -> AdapterFactory: ... + + # decorator() + + class Descriptor(Protocol): + def __get__(self, instance: Any, owner: type[Any] | None = None) -> Any: ... + + class FunctionDecorator(Generic[P, R]): + def __call__( + self, + callable: ( + Callable[P, R] + | Callable[Concatenate[type[T], P], R] + | Callable[Concatenate[Any, P], R] + | Callable[[type[T]], R] + | Descriptor + ), + ) -> FunctionWrapper[P, R]: ... + + class PartialFunctionDecorator: + @overload + def __call__( + self, wrapper: GenericCallableWrapperFunction[P, R], / + ) -> FunctionDecorator[P, R]: ... + @overload + def __call__( + self, wrapper: ClassMethodWrapperFunction[P, R], / + ) -> FunctionDecorator[P, R]: ... + @overload + def __call__( + self, wrapper: InstanceMethodWrapperFunction[P, R], / + ) -> FunctionDecorator[P, R]: ... + + # ... Decorator applied to class type. + + @overload + def decorator(wrapper: type[T], /) -> FunctionDecorator[Any, Any]: ... + + # ... Decorator applied to function or method. + + @overload + def decorator( + wrapper: GenericCallableWrapperFunction[P, R], / + ) -> FunctionDecorator[P, R]: ... + @overload + def decorator( + wrapper: ClassMethodWrapperFunction[P, R], / + ) -> FunctionDecorator[P, R]: ... + @overload + def decorator( + wrapper: InstanceMethodWrapperFunction[P, R], / + ) -> FunctionDecorator[P, R]: ... + + # ... Positional arguments. + + @overload + def decorator( + *, + enabled: bool | Boolean | Callable[[], bool] | None = None, + adapter: str | FullArgSpec | AdapterFactory | Callable[..., Any] | None = None, + proxy: type[FunctionWrapper[Any, Any]] | None = None, + ) -> PartialFunctionDecorator: ... + + # function_wrapper() + + @overload + def function_wrapper(wrapper: type[Any]) -> FunctionDecorator[Any, Any]: ... + @overload + def function_wrapper( + wrapper: GenericCallableWrapperFunction[P, R], + ) -> FunctionDecorator[P, R]: ... + @overload + def function_wrapper( + wrapper: ClassMethodWrapperFunction[P, R], + ) -> FunctionDecorator[P, R]: ... + @overload + def function_wrapper( + wrapper: InstanceMethodWrapperFunction[P, R], + ) -> FunctionDecorator[P, R]: ... + # @overload + # def function_wrapper(wrapper: Any) -> FunctionDecorator[Any, Any]: ... # Don't use, breaks stuff. + + # wrap_function_wrapper() + + def wrap_function_wrapper( + target: ModuleType | type[Any] | Any | str, + name: str, + wrapper: WrapperFunction[P, R], + ) -> FunctionWrapper[P, R]: ... + + # patch_function_wrapper() + + class WrapperDecorator: + def __call__(self, wrapper: WrapperFunction[P, R]) -> FunctionWrapper[P, R]: ... + + def patch_function_wrapper( + target: ModuleType | type[Any] | Any | str, + name: str, + enabled: bool | Boolean | Callable[[], bool] | None = None, + ) -> WrapperDecorator: ... + + # transient_function_wrapper() + + class TransientDecorator: + def __call__( + self, wrapper: WrapperFunction[P, R] + ) -> FunctionDecorator[P, R]: ... + + def transient_function_wrapper( + target: ModuleType | type[Any] | Any | str, name: str + ) -> TransientDecorator: ... + + # resolve_path() + + def resolve_path( + target: ModuleType | type[Any] | Any | str, name: str + ) -> tuple[ModuleType | type[Any] | Any, str, Callable[..., Any]]: ... + + # apply_patch() + + def apply_patch( + parent: ModuleType | type[Any] | Any, + attribute: str, + replacement: Any, + ) -> None: ... + + # wrap_object() + + WrapperFactory = Callable[ + [Callable[..., Any], tuple[Any, ...], dict[str, Any]], type[ObjectProxy[Any]] + ] + + def wrap_object( + target: ModuleType | type[Any] | Any | str, + name: str, + factory: WrapperFactory | type[ObjectProxy[Any]], + args: tuple[Any, ...], + kwargs: dict[str, Any], + ) -> Any: ... + + # wrap_object_attribute() + + def wrap_object_attribute( + target: ModuleType | type[Any] | Any | str, + name: str, + factory: WrapperFactory | type[ObjectProxy[Any]], + args: tuple[Any, ...] = (), + kwargs: dict[str, Any] = {}, + ) -> Any: ... + + # register_post_import_hook() + + def register_post_import_hook( + hook: Callable[[ModuleType], Any] | str, name: str + ) -> None: ... + + # discover_post_import_hooks() + + def discover_post_import_hooks(group: str) -> None: ... + + # notify_module_loaded() + + def notify_module_loaded(module: ModuleType) -> None: ... + + # when_imported() + + class ImportHookDecorator: + def __call__(self, hook: Callable[[ModuleType], Any]) -> Callable[..., Any]: ... + + def when_imported(name: str) -> ImportHookDecorator: ... + + # synchronized() + + class SynchronizedObject: + def __call__(self, wrapped: Callable[P, R]) -> Callable[P, R]: ... + def __enter__(self) -> Any: ... + def __exit__( + self, + exc_type: type[BaseException] | None, + exc_value: BaseException | None, + traceback: TracebackType | None, + ) -> bool | None: ... + + @overload + def synchronized(wrapped: Callable[P, R]) -> Callable[P, R]: ... + @overload + def synchronized(wrapped: Any) -> SynchronizedObject: ... diff --git a/newrelic/packages/wrapt/__wrapt__.py b/newrelic/packages/wrapt/__wrapt__.py index 9933b2c972..ac8f32bb92 100644 --- a/newrelic/packages/wrapt/__wrapt__.py +++ b/newrelic/packages/wrapt/__wrapt__.py @@ -1,14 +1,44 @@ +"""This module is used to switch between C and Python implementations of the +wrappers. +""" + import os -from .wrappers import (ObjectProxy, CallableObjectProxy, - PartialCallableObjectProxy, FunctionWrapper, - BoundFunctionWrapper, _FunctionWrapperBase) +from .wrappers import BoundFunctionWrapper, CallableObjectProxy, FunctionWrapper +from .wrappers import ObjectProxy as BaseObjectProxy +from .wrappers import PartialCallableObjectProxy, _FunctionWrapperBase + +# Try to use C extensions if not disabled. + +_using_c_extension = False + +_use_extensions = not os.environ.get("WRAPT_DISABLE_EXTENSIONS") + +if _use_extensions: + try: + from ._wrappers import ( # type: ignore[no-redef,import-not-found] + BoundFunctionWrapper, + CallableObjectProxy, + FunctionWrapper, + ) + from ._wrappers import ( + ObjectProxy as BaseObjectProxy, # type: ignore[no-redef,import-not-found] + ) + from ._wrappers import ( # type: ignore[no-redef,import-not-found] + PartialCallableObjectProxy, + _FunctionWrapperBase, + ) + + _using_c_extension = True + except ImportError: + # C extensions not available, using Python implementations + pass -try: - if not os.environ.get('WRAPT_DISABLE_EXTENSIONS'): - from ._wrappers import (ObjectProxy, CallableObjectProxy, - PartialCallableObjectProxy, FunctionWrapper, - BoundFunctionWrapper, _FunctionWrapperBase) -except ImportError: - pass +def partial(*args, **kwargs): + """Create a callable object proxy with partial application of the given + arguments and keywords. This behaves the same as `functools.partial`, but + implemented using the `ObjectProxy` class to provide better support for + introspection. + """ + return PartialCallableObjectProxy(*args, **kwargs) diff --git a/newrelic/packages/wrapt/_wrappers.c b/newrelic/packages/wrapt/_wrappers.c index e0e1b5bc65..8cd2f6c28f 100644 --- a/newrelic/packages/wrapt/_wrappers.c +++ b/newrelic/packages/wrapt/_wrappers.c @@ -10,34 +10,38 @@ /* ------------------------------------------------------------------------- */ -typedef struct { - PyObject_HEAD +typedef struct +{ + PyObject_HEAD - PyObject *dict; - PyObject *wrapped; - PyObject *weakreflist; + PyObject *dict; + PyObject *wrapped; + PyObject *weakreflist; } WraptObjectProxyObject; PyTypeObject WraptObjectProxy_Type; PyTypeObject WraptCallableObjectProxy_Type; -typedef struct { - WraptObjectProxyObject object_proxy; +typedef struct +{ + WraptObjectProxyObject object_proxy; - PyObject *args; - PyObject *kwargs; + PyObject *args; + PyObject *kwargs; } WraptPartialCallableObjectProxyObject; PyTypeObject WraptPartialCallableObjectProxy_Type; -typedef struct { - WraptObjectProxyObject object_proxy; - - PyObject *instance; - PyObject *wrapper; - PyObject *enabled; - PyObject *binding; - PyObject *parent; +typedef struct +{ + WraptObjectProxyObject object_proxy; + + PyObject *instance; + PyObject *wrapper; + PyObject *enabled; + PyObject *binding; + PyObject *parent; + PyObject *owner; } WraptFunctionWrapperObject; PyTypeObject WraptFunctionWrapperBase_Type; @@ -46,3195 +50,4048 @@ PyTypeObject WraptFunctionWrapper_Type; /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_new(PyTypeObject *type, - PyObject *args, PyObject *kwds) +static int raise_uninitialized_wrapper_error(WraptObjectProxyObject *object) { - WraptObjectProxyObject *self; + // Before raising an exception we need to first check whether this is a lazy + // proxy object and attempt to intialize the wrapped object using the supplied + // callback if so. If the callback is not present then we can proceed to raise + // the exception, but if the callback is present and returns a value, we set + // that as the wrapped object and continue and return without raising an error. + + static PyObject *wrapped_str = NULL; + static PyObject *wrapped_factory_str = NULL; + static PyObject *wrapped_get_str = NULL; + + PyObject *callback = NULL; + PyObject *value = NULL; + + if (!wrapped_str) + { + wrapped_str = PyUnicode_InternFromString("__wrapped__"); + wrapped_factory_str = PyUnicode_InternFromString("__wrapped_factory__"); + wrapped_get_str = PyUnicode_InternFromString("__wrapped_get__"); + } + + // Note that we use existance of __wrapped_factory__ to gate whether we can + // attempt to initialize the wrapped object lazily, but it is __wrapped_get__ + // that we actually call to do the initialization. This is so that we can + // handle multithreading correctly by having __wrapped_get__ use a lock to + // protect against multiple threads trying to initialize the wrapped object + // at the same time. + + callback = PyObject_GenericGetAttr((PyObject *)object, wrapped_factory_str); + + if (callback) + { + if (callback != Py_None) + { + Py_DECREF(callback); + + callback = PyObject_GenericGetAttr((PyObject *)object, wrapped_get_str); + + if (!callback) + return -1; - self = (WraptObjectProxyObject *)type->tp_alloc(type, 0); + value = PyObject_CallObject(callback, NULL); - if (!self) - return NULL; + Py_DECREF(callback); - self->dict = PyDict_New(); - self->wrapped = NULL; - self->weakreflist = NULL; + if (value) + { + // We use setattr so that special dunder methods will be properly set. - return (PyObject *)self; + if (PyObject_SetAttr((PyObject *)object, wrapped_str, value) == -1) + { + Py_DECREF(value); + return -1; + } + + Py_DECREF(value); + + return 0; + } + else + { + return -1; + } + } + else + { + Py_DECREF(callback); + } + } + else + PyErr_Clear(); + + // We need to reach into the wrapt.wrappers module to get the exception + // class because the exception we need to raise needs to inherit from both + // ValueError and AttributeError and we can't do that in C code using the + // built in exception classes, or at least not easily or safely. + + PyObject *wrapt_wrappers_module = NULL; + PyObject *wrapper_not_initialized_error = NULL; + + // Import the wrapt.wrappers module and get the exception class. + // We do this fresh each time to be safe with multiple sub-interpreters. + + wrapt_wrappers_module = PyImport_ImportModule("wrapt.wrappers"); + + if (!wrapt_wrappers_module) + { + // Fallback to ValueError if import fails. + + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + + return -1; + } + + wrapper_not_initialized_error = PyObject_GetAttrString( + wrapt_wrappers_module, "WrapperNotInitializedError"); + + if (!wrapper_not_initialized_error) + { + // Fallback to ValueError if attribute lookup fails. + + Py_DECREF(wrapt_wrappers_module); + + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + + return -1; + } + + // Raise the custom exception. + + PyErr_SetString(wrapper_not_initialized_error, + "wrapper has not been initialized"); + + // Clean up references. + + Py_DECREF(wrapper_not_initialized_error); + Py_DECREF(wrapt_wrappers_module); + + return -1; } /* ------------------------------------------------------------------------- */ -static int WraptObjectProxy_raw_init(WraptObjectProxyObject *self, - PyObject *wrapped) +static PyObject *WraptObjectProxy_new(PyTypeObject *type, PyObject *args, + PyObject *kwds) { - static PyObject *module_str = NULL; - static PyObject *doc_str = NULL; + WraptObjectProxyObject *self; - PyObject *object = NULL; + self = (WraptObjectProxyObject *)type->tp_alloc(type, 0); - Py_INCREF(wrapped); - Py_XDECREF(self->wrapped); - self->wrapped = wrapped; + if (!self) + return NULL; - if (!module_str) { -#if PY_MAJOR_VERSION >= 3 - module_str = PyUnicode_InternFromString("__module__"); -#else - module_str = PyString_InternFromString("__module__"); -#endif - } + self->dict = PyDict_New(); + self->wrapped = NULL; + self->weakreflist = NULL; - if (!doc_str) { -#if PY_MAJOR_VERSION >= 3 - doc_str = PyUnicode_InternFromString("__doc__"); -#else - doc_str = PyString_InternFromString("__doc__"); -#endif - } + return (PyObject *)self; +} - object = PyObject_GetAttr(wrapped, module_str); +/* ------------------------------------------------------------------------- */ - if (object) { - if (PyDict_SetItem(self->dict, module_str, object) == -1) { - Py_DECREF(object); - return -1; - } - Py_DECREF(object); +static int WraptObjectProxy_raw_init(WraptObjectProxyObject *self, + PyObject *wrapped) +{ + static PyObject *module_str = NULL; + static PyObject *doc_str = NULL; + static PyObject *wrapped_factory_str = NULL; + + PyObject *object = NULL; + + // If wrapped is Py_None and we have a __wrapped_factory__ attribute + // then we defer initialization of the wrapped object until it is first needed. + + if (!wrapped_factory_str) + { + wrapped_factory_str = PyUnicode_InternFromString("__wrapped_factory__"); + } + + if (wrapped == Py_None) + { + PyObject *callback = NULL; + + callback = PyObject_GenericGetAttr((PyObject *)self, wrapped_factory_str); + + if (callback) + { + if (callback != Py_None) + { + Py_DECREF(callback); + return 0; + } + else + { + Py_DECREF(callback); + } } else - PyErr_Clear(); + PyErr_Clear(); + } + + Py_INCREF(wrapped); + Py_XDECREF(self->wrapped); + self->wrapped = wrapped; + + if (!module_str) + { + module_str = PyUnicode_InternFromString("__module__"); + } + + if (!doc_str) + { + doc_str = PyUnicode_InternFromString("__doc__"); + } + + object = PyObject_GetAttr(wrapped, module_str); + + if (object) + { + if (PyDict_SetItem(self->dict, module_str, object) == -1) + { + Py_DECREF(object); + return -1; + } + Py_DECREF(object); + } + else + PyErr_Clear(); - object = PyObject_GetAttr(wrapped, doc_str); + object = PyObject_GetAttr(wrapped, doc_str); - if (object) { - if (PyDict_SetItem(self->dict, doc_str, object) == -1) { - Py_DECREF(object); - return -1; - } - Py_DECREF(object); + if (object) + { + if (PyDict_SetItem(self->dict, doc_str, object) == -1) + { + Py_DECREF(object); + return -1; } - else - PyErr_Clear(); + Py_DECREF(object); + } + else + PyErr_Clear(); - return 0; + return 0; } /* ------------------------------------------------------------------------- */ -static int WraptObjectProxy_init(WraptObjectProxyObject *self, - PyObject *args, PyObject *kwds) +static int WraptObjectProxy_init(WraptObjectProxyObject *self, PyObject *args, + PyObject *kwds) { - PyObject *wrapped = NULL; + PyObject *wrapped = NULL; - static char *kwlist[] = { "wrapped", NULL }; + char *const kwlist[] = {"wrapped", NULL}; - if (!PyArg_ParseTupleAndKeywords(args, kwds, "O:ObjectProxy", - kwlist, &wrapped)) { - return -1; - } + if (!PyArg_ParseTupleAndKeywords(args, kwds, "O:ObjectProxy", kwlist, + &wrapped)) + { + return -1; + } - return WraptObjectProxy_raw_init(self, wrapped); + return WraptObjectProxy_raw_init(self, wrapped); } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_traverse(WraptObjectProxyObject *self, - visitproc visit, void *arg) + visitproc visit, void *arg) { - Py_VISIT(self->dict); - Py_VISIT(self->wrapped); + Py_VISIT(self->dict); + Py_VISIT(self->wrapped); - return 0; + return 0; } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_clear(WraptObjectProxyObject *self) { - Py_CLEAR(self->dict); - Py_CLEAR(self->wrapped); + Py_CLEAR(self->dict); + Py_CLEAR(self->wrapped); - return 0; + return 0; } /* ------------------------------------------------------------------------- */ static void WraptObjectProxy_dealloc(WraptObjectProxyObject *self) { - PyObject_GC_UnTrack(self); + PyObject_GC_UnTrack(self); - if (self->weakreflist != NULL) - PyObject_ClearWeakRefs((PyObject *)self); + if (self->weakreflist != NULL) + PyObject_ClearWeakRefs((PyObject *)self); - WraptObjectProxy_clear(self); + WraptObjectProxy_clear(self); - Py_TYPE(self)->tp_free(self); + Py_TYPE(self)->tp_free(self); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_repr(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } -#if PY_MAJOR_VERSION >= 3 - return PyUnicode_FromFormat("<%s at %p for %s at %p>", - Py_TYPE(self)->tp_name, self, - Py_TYPE(self->wrapped)->tp_name, self->wrapped); -#else - return PyString_FromFormat("<%s at %p for %s at %p>", - Py_TYPE(self)->tp_name, self, - Py_TYPE(self->wrapped)->tp_name, self->wrapped); -#endif + return PyUnicode_FromFormat("<%s at %p for %s at %p>", Py_TYPE(self)->tp_name, + self, Py_TYPE(self->wrapped)->tp_name, + self->wrapped); } /* ------------------------------------------------------------------------- */ -#if PY_MAJOR_VERSION < 3 || (PY_MAJOR_VERSION == 3 && PY_MINOR_VERSION < 3) -typedef long Py_hash_t; -#endif - static Py_hash_t WraptObjectProxy_hash(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return -1; - } + } - return PyObject_Hash(self->wrapped); + return PyObject_Hash(self->wrapped); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_str(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyObject_Str(self->wrapped); + return PyObject_Str(self->wrapped); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_add(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o1)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } - - o1 = ((WraptObjectProxyObject *)o1)->wrapped; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o1)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) + return NULL; } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o2)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } + o1 = ((WraptObjectProxyObject *)o1)->wrapped; + } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o2)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) + return NULL; } - return PyNumber_Add(o1, o2); + o2 = ((WraptObjectProxyObject *)o2)->wrapped; + } + + return PyNumber_Add(o1, o2); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_subtract(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o1)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } - - o1 = ((WraptObjectProxyObject *)o1)->wrapped; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o1)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) + return NULL; } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o2)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } + o1 = ((WraptObjectProxyObject *)o1)->wrapped; + } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o2)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) + return NULL; } + o2 = ((WraptObjectProxyObject *)o2)->wrapped; + } - return PyNumber_Subtract(o1, o2); + return PyNumber_Subtract(o1, o2); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_multiply(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o1)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } - - o1 = ((WraptObjectProxyObject *)o1)->wrapped; - } - - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o2)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } - - o2 = ((WraptObjectProxyObject *)o2)->wrapped; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o1)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) + return NULL; } - return PyNumber_Multiply(o1, o2); -} - -/* ------------------------------------------------------------------------- */ - -#if PY_MAJOR_VERSION < 3 -static PyObject *WraptObjectProxy_divide(PyObject *o1, PyObject *o2) -{ - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o1)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } + o1 = ((WraptObjectProxyObject *)o1)->wrapped; + } - o1 = ((WraptObjectProxyObject *)o1)->wrapped; + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o2)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) + return NULL; } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o2)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } - - o2 = ((WraptObjectProxyObject *)o2)->wrapped; - } + o2 = ((WraptObjectProxyObject *)o2)->wrapped; + } - return PyNumber_Divide(o1, o2); + return PyNumber_Multiply(o1, o2); } -#endif /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_remainder(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o1)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } - - o1 = ((WraptObjectProxyObject *)o1)->wrapped; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o1)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) + return NULL; } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o2)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } + o1 = ((WraptObjectProxyObject *)o1)->wrapped; + } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o2)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) + return NULL; } - return PyNumber_Remainder(o1, o2); + o2 = ((WraptObjectProxyObject *)o2)->wrapped; + } + + return PyNumber_Remainder(o1, o2); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_divmod(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o1)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } - - o1 = ((WraptObjectProxyObject *)o1)->wrapped; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o1)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) + return NULL; } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o2)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } + o1 = ((WraptObjectProxyObject *)o1)->wrapped; + } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o2)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) + return NULL; } - return PyNumber_Divmod(o1, o2); + o2 = ((WraptObjectProxyObject *)o2)->wrapped; + } + + return PyNumber_Divmod(o1, o2); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_power(PyObject *o1, PyObject *o2, - PyObject *modulo) + PyObject *modulo) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o1)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } - - o1 = ((WraptObjectProxyObject *)o1)->wrapped; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o1)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) + return NULL; } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o2)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } + o1 = ((WraptObjectProxyObject *)o1)->wrapped; + } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o2)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) + return NULL; } - return PyNumber_Power(o1, o2, modulo); + o2 = ((WraptObjectProxyObject *)o2)->wrapped; + } + + return PyNumber_Power(o1, o2, modulo); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_negative(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyNumber_Negative(self->wrapped); + return PyNumber_Negative(self->wrapped); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_positive(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyNumber_Positive(self->wrapped); + return PyNumber_Positive(self->wrapped); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_absolute(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyNumber_Absolute(self->wrapped); + return PyNumber_Absolute(self->wrapped); } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_bool(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return -1; - } + } - return PyObject_IsTrue(self->wrapped); + return PyObject_IsTrue(self->wrapped); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_invert(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyNumber_Invert(self->wrapped); + return PyNumber_Invert(self->wrapped); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_lshift(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o1)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } - - o1 = ((WraptObjectProxyObject *)o1)->wrapped; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o1)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) + return NULL; } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o2)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } + o1 = ((WraptObjectProxyObject *)o1)->wrapped; + } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o2)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) + return NULL; } - return PyNumber_Lshift(o1, o2); + o2 = ((WraptObjectProxyObject *)o2)->wrapped; + } + + return PyNumber_Lshift(o1, o2); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_rshift(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o1)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } - - o1 = ((WraptObjectProxyObject *)o1)->wrapped; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o1)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) + return NULL; } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o2)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } + o1 = ((WraptObjectProxyObject *)o1)->wrapped; + } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o2)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) + return NULL; } - return PyNumber_Rshift(o1, o2); + o2 = ((WraptObjectProxyObject *)o2)->wrapped; + } + + return PyNumber_Rshift(o1, o2); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_and(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o1)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } - - o1 = ((WraptObjectProxyObject *)o1)->wrapped; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o1)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) + return NULL; } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o2)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } + o1 = ((WraptObjectProxyObject *)o1)->wrapped; + } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o2)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) + return NULL; } - return PyNumber_And(o1, o2); + o2 = ((WraptObjectProxyObject *)o2)->wrapped; + } + + return PyNumber_And(o1, o2); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_xor(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o1)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } - - o1 = ((WraptObjectProxyObject *)o1)->wrapped; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o1)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) + return NULL; } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o2)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } + o1 = ((WraptObjectProxyObject *)o1)->wrapped; + } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o2)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) + return NULL; } - return PyNumber_Xor(o1, o2); + o2 = ((WraptObjectProxyObject *)o2)->wrapped; + } + + return PyNumber_Xor(o1, o2); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_or(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o1)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } - - o1 = ((WraptObjectProxyObject *)o1)->wrapped; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o1)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) + return NULL; } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o2)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } + o1 = ((WraptObjectProxyObject *)o1)->wrapped; + } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o2)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) + return NULL; } - return PyNumber_Or(o1, o2); -} - -/* ------------------------------------------------------------------------- */ - -#if PY_MAJOR_VERSION < 3 -static PyObject *WraptObjectProxy_int(WraptObjectProxyObject *self) -{ - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } + o2 = ((WraptObjectProxyObject *)o2)->wrapped; + } - return PyNumber_Int(self->wrapped); + return PyNumber_Or(o1, o2); } -#endif /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_long(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyNumber_Long(self->wrapped); + return PyNumber_Long(self->wrapped); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_float(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyNumber_Float(self->wrapped); + return PyNumber_Float(self->wrapped); } /* ------------------------------------------------------------------------- */ -#if PY_MAJOR_VERSION < 3 -static PyObject *WraptObjectProxy_oct(WraptObjectProxyObject *self) +static PyObject *WraptObjectProxy_inplace_add(WraptObjectProxyObject *self, + PyObject *other) { - PyNumberMethods *nb; + PyObject *object = NULL; - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - if ((nb = self->wrapped->ob_type->tp_as_number) == NULL || - nb->nb_oct == NULL) { - PyErr_SetString(PyExc_TypeError, - "oct() argument can't be converted to oct"); - return NULL; - } + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; - return (*nb->nb_oct)(self->wrapped); -} -#endif + if (PyObject_HasAttrString(self->wrapped, "__iadd__")) + { + object = PyNumber_InPlaceAdd(self->wrapped, other); -/* ------------------------------------------------------------------------- */ + if (!object) + return NULL; -#if PY_MAJOR_VERSION < 3 -static PyObject *WraptObjectProxy_hex(WraptObjectProxyObject *self) -{ - PyNumberMethods *nb; + Py_DECREF(self->wrapped); + self->wrapped = object; + + Py_INCREF(self); + return (PyObject *)self; + } + else + { + PyObject *result = PyNumber_Add(self->wrapped, other); - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!result) + return NULL; + + PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); + + if (!proxy_type) + { + Py_DECREF(proxy_type); return NULL; } - if ((nb = self->wrapped->ob_type->tp_as_number) == NULL || - nb->nb_hex == NULL) { - PyErr_SetString(PyExc_TypeError, - "hex() argument can't be converted to hex"); - return NULL; + PyObject *proxy_args = PyTuple_Pack(1, result); + + Py_DECREF(result); + + if (!proxy_args) + { + Py_DECREF(proxy_type); + return NULL; } - return (*nb->nb_hex)(self->wrapped); + PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); + + Py_DECREF(proxy_type); + Py_DECREF(proxy_args); + + return proxy_instance; + } } -#endif /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_inplace_add(WraptObjectProxyObject *self, - PyObject *other) +static PyObject *WraptObjectProxy_inplace_subtract(WraptObjectProxyObject *self, + PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; - object = PyNumber_InPlaceAdd(self->wrapped, other); + if (PyObject_HasAttrString(self->wrapped, "__isub__")) + { + object = PyNumber_InPlaceSubtract(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; -} + } + else + { + PyObject *result = PyNumber_Subtract(self->wrapped, other); -/* ------------------------------------------------------------------------- */ + if (!result) + return NULL; -static PyObject *WraptObjectProxy_inplace_subtract( - WraptObjectProxyObject *self, PyObject *other) -{ - PyObject *object = NULL; + PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!proxy_type) + { + Py_DECREF(proxy_type); return NULL; } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + PyObject *proxy_args = PyTuple_Pack(1, result); - object = PyNumber_InPlaceSubtract(self->wrapped, other); + Py_DECREF(result); - if (!object) - return NULL; + if (!proxy_args) + { + Py_DECREF(proxy_type); + return NULL; + } - Py_DECREF(self->wrapped); - self->wrapped = object; + PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); - Py_INCREF(self); - return (PyObject *)self; + Py_DECREF(proxy_type); + Py_DECREF(proxy_args); + + return proxy_instance; + } } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_inplace_multiply( - WraptObjectProxyObject *self, PyObject *other) +static PyObject *WraptObjectProxy_inplace_multiply(WraptObjectProxyObject *self, + PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_HasAttrString(self->wrapped, "__imul__")) + { object = PyNumber_InPlaceMultiply(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; -} + } + else + { + PyObject *result = PyNumber_Multiply(self->wrapped, other); -/* ------------------------------------------------------------------------- */ + if (!result) + return NULL; -#if PY_MAJOR_VERSION < 3 -static PyObject *WraptObjectProxy_inplace_divide( - WraptObjectProxyObject *self, PyObject *other) -{ - PyObject *object = NULL; + PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!proxy_type) + { + Py_DECREF(proxy_type); return NULL; } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + PyObject *proxy_args = PyTuple_Pack(1, result); - object = PyNumber_InPlaceDivide(self->wrapped, other); + Py_DECREF(result); - if (!object) - return NULL; + if (!proxy_args) + { + Py_DECREF(proxy_type); + return NULL; + } - Py_DECREF(self->wrapped); - self->wrapped = object; + PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); - Py_INCREF(self); - return (PyObject *)self; + Py_DECREF(proxy_type); + Py_DECREF(proxy_args); + + return proxy_instance; + } } -#endif /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_inplace_remainder( - WraptObjectProxyObject *self, PyObject *other) +static PyObject * +WraptObjectProxy_inplace_remainder(WraptObjectProxyObject *self, + PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_HasAttrString(self->wrapped, "__imod__")) + { object = PyNumber_InPlaceRemainder(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; -} + } + else + { + PyObject *result = PyNumber_Remainder(self->wrapped, other); -/* ------------------------------------------------------------------------- */ + if (!result) + return NULL; -static PyObject *WraptObjectProxy_inplace_power(WraptObjectProxyObject *self, - PyObject *other, PyObject *modulo) -{ - PyObject *object = NULL; + PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!proxy_type) + { + Py_DECREF(proxy_type); return NULL; } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + PyObject *proxy_args = PyTuple_Pack(1, result); - object = PyNumber_InPlacePower(self->wrapped, other, modulo); - - if (!object) - return NULL; + Py_DECREF(result); + + if (!proxy_args) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); + + Py_DECREF(proxy_type); + Py_DECREF(proxy_args); + + return proxy_instance; + } +} + +/* ------------------------------------------------------------------------- */ + +static PyObject *WraptObjectProxy_inplace_power(WraptObjectProxyObject *self, + PyObject *other, + PyObject *modulo) +{ + PyObject *object = NULL; + + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) + return NULL; + } + + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; + + if (PyObject_HasAttrString(self->wrapped, "__ipow__")) + { + object = PyNumber_InPlacePower(self->wrapped, other, modulo); + + if (!object) + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; + } + else + { + PyObject *result = PyNumber_Power(self->wrapped, other, modulo); + + if (!result) + return NULL; + + PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); + + if (!proxy_type) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_args = PyTuple_Pack(1, result); + + Py_DECREF(result); + + if (!proxy_args) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); + + Py_DECREF(proxy_type); + Py_DECREF(proxy_args); + + return proxy_instance; + } } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_inplace_lshift(WraptObjectProxyObject *self, - PyObject *other) + PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_HasAttrString(self->wrapped, "__ilshift__")) + { object = PyNumber_InPlaceLshift(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; + } + else + { + PyObject *result = PyNumber_Lshift(self->wrapped, other); + + if (!result) + return NULL; + + PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); + + if (!proxy_type) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_args = PyTuple_Pack(1, result); + + Py_DECREF(result); + + if (!proxy_args) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); + + Py_DECREF(proxy_type); + Py_DECREF(proxy_args); + + return proxy_instance; + } } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_inplace_rshift(WraptObjectProxyObject *self, - PyObject *other) + PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_HasAttrString(self->wrapped, "__irshift__")) + { object = PyNumber_InPlaceRshift(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; + } + else + { + PyObject *result = PyNumber_Rshift(self->wrapped, other); + + if (!result) + return NULL; + + PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); + + if (!proxy_type) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_args = PyTuple_Pack(1, result); + + Py_DECREF(result); + + if (!proxy_args) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); + + Py_DECREF(proxy_type); + Py_DECREF(proxy_args); + + return proxy_instance; + } } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_inplace_and(WraptObjectProxyObject *self, - PyObject *other) + PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_HasAttrString(self->wrapped, "__iand__")) + { object = PyNumber_InPlaceAnd(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; + } + else + { + PyObject *result = PyNumber_And(self->wrapped, other); + + if (!result) + return NULL; + + PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); + + if (!proxy_type) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_args = PyTuple_Pack(1, result); + + Py_DECREF(result); + + if (!proxy_args) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); + + Py_DECREF(proxy_type); + Py_DECREF(proxy_args); + + return proxy_instance; + } } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_inplace_xor(WraptObjectProxyObject *self, - PyObject *other) + PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_HasAttrString(self->wrapped, "__ixor__")) + { object = PyNumber_InPlaceXor(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; + } + else + { + PyObject *result = PyNumber_Xor(self->wrapped, other); + + if (!result) + return NULL; + + PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); + + if (!proxy_type) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_args = PyTuple_Pack(1, result); + + Py_DECREF(result); + + if (!proxy_args) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); + + Py_DECREF(proxy_type); + Py_DECREF(proxy_args); + + return proxy_instance; + } } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_inplace_or(WraptObjectProxyObject *self, - PyObject *other) + PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_HasAttrString(self->wrapped, "__ior__")) + { object = PyNumber_InPlaceOr(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; + } + else + { + PyObject *result = PyNumber_Or(self->wrapped, other); + + if (!result) + return NULL; + + PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); + + if (!proxy_type) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_args = PyTuple_Pack(1, result); + + Py_DECREF(result); + + if (!proxy_args) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); + + Py_DECREF(proxy_type); + Py_DECREF(proxy_args); + + return proxy_instance; + } } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_floor_divide(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o1)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } - - o1 = ((WraptObjectProxyObject *)o1)->wrapped; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o1)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) + return NULL; } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o2)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } + o1 = ((WraptObjectProxyObject *)o1)->wrapped; + } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o2)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) + return NULL; } - return PyNumber_FloorDivide(o1, o2); + o2 = ((WraptObjectProxyObject *)o2)->wrapped; + } + + return PyNumber_FloorDivide(o1, o2); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_true_divide(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o1)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } - - o1 = ((WraptObjectProxyObject *)o1)->wrapped; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o1)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) + return NULL; } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { - if (!((WraptObjectProxyObject *)o2)->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } + o1 = ((WraptObjectProxyObject *)o1)->wrapped; + } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o2)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) + return NULL; } - return PyNumber_TrueDivide(o1, o2); + o2 = ((WraptObjectProxyObject *)o2)->wrapped; + } + + return PyNumber_TrueDivide(o1, o2); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_inplace_floor_divide( - WraptObjectProxyObject *self, PyObject *other) +static PyObject * +WraptObjectProxy_inplace_floor_divide(WraptObjectProxyObject *self, + PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_HasAttrString(self->wrapped, "__ifloordiv__")) + { object = PyNumber_InPlaceFloorDivide(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; + } + else + { + PyObject *result = PyNumber_FloorDivide(self->wrapped, other); + + if (!result) + return NULL; + + PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); + + if (!proxy_type) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_args = PyTuple_Pack(1, result); + + Py_DECREF(result); + + if (!proxy_args) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); + + Py_DECREF(proxy_type); + Py_DECREF(proxy_args); + + return proxy_instance; + } } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_inplace_true_divide( - WraptObjectProxyObject *self, PyObject *other) +static PyObject * +WraptObjectProxy_inplace_true_divide(WraptObjectProxyObject *self, + PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_HasAttrString(self->wrapped, "__itruediv__")) + { object = PyNumber_InPlaceTrueDivide(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; + } + else + { + PyObject *result = PyNumber_TrueDivide(self->wrapped, other); + + if (!result) + return NULL; + + PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); + + if (!proxy_type) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_args = PyTuple_Pack(1, result); + + Py_DECREF(result); + + if (!proxy_args) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); + + Py_DECREF(proxy_type); + Py_DECREF(proxy_args); + + return proxy_instance; + } } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_index(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; + } + + return PyNumber_Index(self->wrapped); +} + +/* ------------------------------------------------------------------------- */ + +static PyObject *WraptObjectProxy_matrix_multiply(PyObject *o1, PyObject *o2) +{ + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o1)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) + return NULL; } - return PyNumber_Index(self->wrapped); + o1 = ((WraptObjectProxyObject *)o1)->wrapped; + } + + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) + { + if (!((WraptObjectProxyObject *)o2)->wrapped) + { + if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) + return NULL; + } + + o2 = ((WraptObjectProxyObject *)o2)->wrapped; + } + + return PyNumber_MatrixMultiply(o1, o2); +} + +/* ------------------------------------------------------------------------- */ + +static PyObject *WraptObjectProxy_inplace_matrix_multiply( + WraptObjectProxyObject *self, PyObject *other) +{ + PyObject *object = NULL; + + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) + return NULL; + } + + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; + + if (PyObject_HasAttrString(self->wrapped, "__imatmul__")) + { + object = PyNumber_InPlaceMatrixMultiply(self->wrapped, other); + + if (!object) + return NULL; + + Py_DECREF(self->wrapped); + self->wrapped = object; + + Py_INCREF(self); + return (PyObject *)self; + } + else + { + PyObject *result = PyNumber_MatrixMultiply(self->wrapped, other); + + if (!result) + return NULL; + + PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); + + if (!proxy_type) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_args = PyTuple_Pack(1, result); + + Py_DECREF(result); + + if (!proxy_args) + { + Py_DECREF(proxy_type); + return NULL; + } + + PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); + + Py_DECREF(proxy_type); + Py_DECREF(proxy_args); + + return proxy_instance; + } } /* ------------------------------------------------------------------------- */ static Py_ssize_t WraptObjectProxy_length(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return -1; - } + } - return PyObject_Length(self->wrapped); + return PyObject_Length(self->wrapped); } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_contains(WraptObjectProxyObject *self, - PyObject *value) + PyObject *value) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return -1; - } + } - return PySequence_Contains(self->wrapped, value); + return PySequence_Contains(self->wrapped, value); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_getitem(WraptObjectProxyObject *self, - PyObject *key) + PyObject *key) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyObject_GetItem(self->wrapped, key); + return PyObject_GetItem(self->wrapped, key); } /* ------------------------------------------------------------------------- */ -static int WraptObjectProxy_setitem(WraptObjectProxyObject *self, - PyObject *key, PyObject* value) +static int WraptObjectProxy_setitem(WraptObjectProxyObject *self, PyObject *key, + PyObject *value) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return -1; - } + } - if (value == NULL) - return PyObject_DelItem(self->wrapped, key); - else - return PyObject_SetItem(self->wrapped, key, value); + if (value == NULL) + return PyObject_DelItem(self->wrapped, key); + else + return PyObject_SetItem(self->wrapped, key, value); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_self_setattr( - WraptObjectProxyObject *self, PyObject *args) +static PyObject *WraptObjectProxy_self_setattr(WraptObjectProxyObject *self, + PyObject *args) { - PyObject *name = NULL; - PyObject *value = NULL; + PyObject *name = NULL; + PyObject *value = NULL; -#if PY_MAJOR_VERSION >= 3 - if (!PyArg_ParseTuple(args, "UO:__self_setattr__", &name, &value)) - return NULL; -#else - if (!PyArg_ParseTuple(args, "SO:__self_setattr__", &name, &value)) - return NULL; -#endif + if (!PyArg_ParseTuple(args, "UO:__self_setattr__", &name, &value)) + return NULL; - if (PyObject_GenericSetAttr((PyObject *)self, name, value) != 0) { - return NULL; - } + if (PyObject_GenericSetAttr((PyObject *)self, name, value) != 0) + { + return NULL; + } - Py_INCREF(Py_None); - return Py_None; + Py_INCREF(Py_None); + return Py_None; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_dir( - WraptObjectProxyObject *self, PyObject *args) +static PyObject *WraptObjectProxy_dir(WraptObjectProxyObject *self, + PyObject *args) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyObject_Dir(self->wrapped); + return PyObject_Dir(self->wrapped); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_enter( - WraptObjectProxyObject *self, PyObject *args, PyObject *kwds) +static PyObject *WraptObjectProxy_enter(WraptObjectProxyObject *self, + PyObject *args, PyObject *kwds) { - PyObject *method = NULL; - PyObject *result = NULL; + PyObject *method = NULL; + PyObject *result = NULL; - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - method = PyObject_GetAttrString(self->wrapped, "__enter__"); + method = PyObject_GetAttrString(self->wrapped, "__enter__"); - if (!method) - return NULL; + if (!method) + return NULL; - result = PyObject_Call(method, args, kwds); + result = PyObject_Call(method, args, kwds); - Py_DECREF(method); + Py_DECREF(method); - return result; + return result; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_exit( - WraptObjectProxyObject *self, PyObject *args, PyObject *kwds) +static PyObject *WraptObjectProxy_exit(WraptObjectProxyObject *self, + PyObject *args, PyObject *kwds) { - PyObject *method = NULL; - PyObject *result = NULL; + PyObject *method = NULL; + PyObject *result = NULL; - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - method = PyObject_GetAttrString(self->wrapped, "__exit__"); + method = PyObject_GetAttrString(self->wrapped, "__exit__"); - if (!method) - return NULL; + if (!method) + return NULL; - result = PyObject_Call(method, args, kwds); + result = PyObject_Call(method, args, kwds); - Py_DECREF(method); + Py_DECREF(method); - return result; + return result; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_copy( - WraptObjectProxyObject *self, PyObject *args, PyObject *kwds) +static PyObject *WraptObjectProxy_aenter(WraptObjectProxyObject *self, + PyObject *args, PyObject *kwds) { - PyErr_SetString(PyExc_NotImplementedError, - "object proxy must define __copy__()"); + PyObject *method = NULL; + PyObject *result = NULL; + + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) + return NULL; + } + + method = PyObject_GetAttrString(self->wrapped, "__aenter__"); + if (!method) return NULL; + + result = PyObject_Call(method, args, kwds); + + Py_DECREF(method); + + return result; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_deepcopy( - WraptObjectProxyObject *self, PyObject *args, PyObject *kwds) +static PyObject *WraptObjectProxy_aexit(WraptObjectProxyObject *self, + PyObject *args, PyObject *kwds) { - PyErr_SetString(PyExc_NotImplementedError, - "object proxy must define __deepcopy__()"); + PyObject *method = NULL; + PyObject *result = NULL; + + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) + return NULL; + } + + method = PyObject_GetAttrString(self->wrapped, "__aexit__"); + if (!method) return NULL; + + result = PyObject_Call(method, args, kwds); + + Py_DECREF(method); + + return result; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_reduce( - WraptObjectProxyObject *self, PyObject *args, PyObject *kwds) +static PyObject *WraptObjectProxy_copy(WraptObjectProxyObject *self, + PyObject *args, PyObject *kwds) { - PyErr_SetString(PyExc_NotImplementedError, - "object proxy must define __reduce_ex__()"); + PyErr_SetString(PyExc_NotImplementedError, + "object proxy must define __copy__()"); - return NULL; + return NULL; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_reduce_ex( - WraptObjectProxyObject *self, PyObject *args, PyObject *kwds) +static PyObject *WraptObjectProxy_deepcopy(WraptObjectProxyObject *self, + PyObject *args, PyObject *kwds) { - PyErr_SetString(PyExc_NotImplementedError, - "object proxy must define __reduce_ex__()"); + PyErr_SetString(PyExc_NotImplementedError, + "object proxy must define __deepcopy__()"); - return NULL; + return NULL; +} + +/* ------------------------------------------------------------------------- */ + +static PyObject *WraptObjectProxy_reduce(WraptObjectProxyObject *self, + PyObject *args, PyObject *kwds) +{ + PyErr_SetString(PyExc_NotImplementedError, + "object proxy must define __reduce__()"); + + return NULL; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_bytes( - WraptObjectProxyObject *self, PyObject *args) +static PyObject *WraptObjectProxy_reduce_ex(WraptObjectProxyObject *self, + PyObject *args, PyObject *kwds) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + PyErr_SetString(PyExc_NotImplementedError, + "object proxy must define __reduce_ex__()"); + + return NULL; +} + +/* ------------------------------------------------------------------------- */ + +static PyObject *WraptObjectProxy_bytes(WraptObjectProxyObject *self, + PyObject *args) +{ + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyObject_Bytes(self->wrapped); + return PyObject_Bytes(self->wrapped); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_reversed( - WraptObjectProxyObject *self, PyObject *args) +static PyObject *WraptObjectProxy_format(WraptObjectProxyObject *self, + PyObject *args) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + PyObject *format_spec = NULL; + + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } + + if (!PyArg_ParseTuple(args, "|O:format", &format_spec)) + return NULL; - return PyObject_CallFunctionObjArgs((PyObject *)&PyReversed_Type, - self->wrapped, NULL); + return PyObject_Format(self->wrapped, format_spec); } /* ------------------------------------------------------------------------- */ -#if PY_MAJOR_VERSION >= 3 -static PyObject *WraptObjectProxy_round( - WraptObjectProxyObject *self, PyObject *args) +static PyObject *WraptObjectProxy_reversed(WraptObjectProxyObject *self, + PyObject *args) { - PyObject *module = NULL; - PyObject *dict = NULL; - PyObject *round = NULL; + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) + return NULL; + } - PyObject *result = NULL; + return PyObject_CallFunctionObjArgs((PyObject *)&PyReversed_Type, + self->wrapped, NULL); +} - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); +/* ------------------------------------------------------------------------- */ + +static PyObject *WraptObjectProxy_round(WraptObjectProxyObject *self, + PyObject *args, PyObject *kwds) +{ + PyObject *ndigits = NULL; + + PyObject *module = NULL; + PyObject *round = NULL; + + PyObject *result = NULL; + + char *const kwlist[] = {"ndigits", NULL}; + + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - module = PyImport_ImportModule("builtins"); + if (!PyArg_ParseTupleAndKeywords(args, kwds, "|O:ObjectProxy", kwlist, + &ndigits)) + { + return NULL; + } - if (!module) - return NULL; + module = PyImport_ImportModule("builtins"); - dict = PyModule_GetDict(module); - round = PyDict_GetItemString(dict, "round"); + if (!module) + return NULL; - if (!round) { - Py_DECREF(module); - return NULL; - } + round = PyObject_GetAttrString(module, "round"); - Py_INCREF(round); + if (!round) + { Py_DECREF(module); + return NULL; + } - result = PyObject_CallFunctionObjArgs(round, self->wrapped, NULL); + Py_INCREF(round); + Py_DECREF(module); - Py_DECREF(round); + result = PyObject_CallFunctionObjArgs(round, self->wrapped, ndigits, NULL); - return result; + Py_DECREF(round); + + return result; } -#endif /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_complex( - WraptObjectProxyObject *self, PyObject *args) +static PyObject *WraptObjectProxy_complex(WraptObjectProxyObject *self, + PyObject *args) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyObject_CallFunctionObjArgs((PyObject *)&PyComplex_Type, - self->wrapped, NULL); + return PyObject_CallFunctionObjArgs((PyObject *)&PyComplex_Type, + self->wrapped, NULL); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_mro_entries( - WraptObjectProxyObject *self, PyObject *args, PyObject *kwds) +static PyObject *WraptObjectProxy_mro_entries(WraptObjectProxyObject *self, + PyObject *args, PyObject *kwds) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + PyObject *wrapped = NULL; + PyObject *mro_entries_method = NULL; + PyObject *result = NULL; + int is_type = 0; + + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; + } + + wrapped = self->wrapped; + + // Check if wrapped is a type (class). + + is_type = PyType_Check(wrapped); + + // If wrapped is not a type and has __mro_entries__, forward to it. + + if (!is_type) + { + mro_entries_method = PyObject_GetAttrString(wrapped, "__mro_entries__"); + + if (mro_entries_method) + { + // Call wrapped.__mro_entries__(bases). + + result = PyObject_Call(mro_entries_method, args, kwds); + + Py_DECREF(mro_entries_method); + + return result; + } + else + { + PyErr_Clear(); } + } - return Py_BuildValue("(O)", self->wrapped); + return Py_BuildValue("(O)", wrapped); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_get_name( - WraptObjectProxyObject *self) +static PyObject *WraptObjectProxy_get_name(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyObject_GetAttrString(self->wrapped, "__name__"); + return PyObject_GetAttrString(self->wrapped, "__name__"); } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_set_name(WraptObjectProxyObject *self, - PyObject *value) + PyObject *value) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return -1; - } + } - return PyObject_SetAttrString(self->wrapped, "__name__", value); + return PyObject_SetAttrString(self->wrapped, "__name__", value); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_get_qualname( - WraptObjectProxyObject *self) +static PyObject *WraptObjectProxy_get_qualname(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyObject_GetAttrString(self->wrapped, "__qualname__"); + return PyObject_GetAttrString(self->wrapped, "__qualname__"); } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_set_qualname(WraptObjectProxyObject *self, - PyObject *value) + PyObject *value) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return -1; - } + } - return PyObject_SetAttrString(self->wrapped, "__qualname__", value); + return PyObject_SetAttrString(self->wrapped, "__qualname__", value); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_get_module( - WraptObjectProxyObject *self) +static PyObject *WraptObjectProxy_get_module(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyObject_GetAttrString(self->wrapped, "__module__"); + return PyObject_GetAttrString(self->wrapped, "__module__"); } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_set_module(WraptObjectProxyObject *self, - PyObject *value) + PyObject *value) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return -1; - } + } - if (PyObject_SetAttrString(self->wrapped, "__module__", value) == -1) - return -1; + if (PyObject_SetAttrString(self->wrapped, "__module__", value) == -1) + return -1; - return PyDict_SetItemString(self->dict, "__module__", value); + return PyDict_SetItemString(self->dict, "__module__", value); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_get_doc( - WraptObjectProxyObject *self) +static PyObject *WraptObjectProxy_get_doc(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyObject_GetAttrString(self->wrapped, "__doc__"); + return PyObject_GetAttrString(self->wrapped, "__doc__"); } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_set_doc(WraptObjectProxyObject *self, - PyObject *value) + PyObject *value) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return -1; - } + } - if (PyObject_SetAttrString(self->wrapped, "__doc__", value) == -1) - return -1; + if (PyObject_SetAttrString(self->wrapped, "__doc__", value) == -1) + return -1; - return PyDict_SetItemString(self->dict, "__doc__", value); + return PyDict_SetItemString(self->dict, "__doc__", value); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_get_class( - WraptObjectProxyObject *self) +static PyObject *WraptObjectProxy_get_class(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyObject_GetAttrString(self->wrapped, "__class__"); + return PyObject_GetAttrString(self->wrapped, "__class__"); } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_set_class(WraptObjectProxyObject *self, - PyObject *value) + PyObject *value) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return -1; - } + } - return PyObject_SetAttrString(self->wrapped, "__class__", value); + return PyObject_SetAttrString(self->wrapped, "__class__", value); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_get_annotations( - WraptObjectProxyObject *self) +static PyObject * +WraptObjectProxy_get_annotations(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyObject_GetAttrString(self->wrapped, "__annotations__"); + return PyObject_GetAttrString(self->wrapped, "__annotations__"); } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_set_annotations(WraptObjectProxyObject *self, - PyObject *value) + PyObject *value) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return -1; - } + } - return PyObject_SetAttrString(self->wrapped, "__annotations__", value); + return PyObject_SetAttrString(self->wrapped, "__annotations__", value); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_get_wrapped( - WraptObjectProxyObject *self) +static PyObject *WraptObjectProxy_get_wrapped(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - Py_INCREF(self->wrapped); - return self->wrapped; + Py_INCREF(self->wrapped); + return self->wrapped; +} + +/* ------------------------------------------------------------------------- */ + +static PyObject *WraptObjectProxy_get_object_proxy(WraptObjectProxyObject *self) +{ + Py_INCREF(&WraptObjectProxy_Type); + return (PyObject *)&WraptObjectProxy_Type; } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_set_wrapped(WraptObjectProxyObject *self, - PyObject *value) + PyObject *value) { - if (!value) { - PyErr_SetString(PyExc_TypeError, "__wrapped__ must be an object"); - return -1; - } + static PyObject *fixups_str = NULL; + + PyObject *fixups = NULL; + + if (!value) + { + PyErr_SetString(PyExc_TypeError, "__wrapped__ must be an object"); + return -1; + } + + Py_INCREF(value); + Py_XDECREF(self->wrapped); + + self->wrapped = value; + + if (!fixups_str) + { + fixups_str = PyUnicode_InternFromString("__wrapped_setattr_fixups__"); + } + + fixups = PyObject_GetAttr((PyObject *)self, fixups_str); - Py_INCREF(value); - Py_XDECREF(self->wrapped); + if (fixups) + { + PyObject *result = NULL; + + result = PyObject_CallObject(fixups, NULL); + Py_DECREF(fixups); + + if (!result) + return -1; - self->wrapped = value; + Py_DECREF(result); + } + else + PyErr_Clear(); - return 0; + return 0; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_getattro( - WraptObjectProxyObject *self, PyObject *name) +static PyObject *WraptObjectProxy_getattro(WraptObjectProxyObject *self, + PyObject *name) { - PyObject *object = NULL; - PyObject *result = NULL; + PyObject *object = NULL; + PyObject *result = NULL; - static PyObject *getattr_str = NULL; + static PyObject *getattr_str = NULL; - object = PyObject_GenericGetAttr((PyObject *)self, name); + object = PyObject_GenericGetAttr((PyObject *)self, name); - if (object) - return object; + if (object) + return object; - if (!PyErr_ExceptionMatches(PyExc_AttributeError)) - return NULL; + if (!PyErr_ExceptionMatches(PyExc_AttributeError)) + return NULL; - PyErr_Clear(); + PyErr_Clear(); - if (!getattr_str) { -#if PY_MAJOR_VERSION >= 3 - getattr_str = PyUnicode_InternFromString("__getattr__"); -#else - getattr_str = PyString_InternFromString("__getattr__"); -#endif - } + if (!getattr_str) + { + getattr_str = PyUnicode_InternFromString("__getattr__"); + } - object = PyObject_GenericGetAttr((PyObject *)self, getattr_str); + object = PyObject_GenericGetAttr((PyObject *)self, getattr_str); - if (!object) - return NULL; + if (!object) + return NULL; - result = PyObject_CallFunctionObjArgs(object, name, NULL); + result = PyObject_CallFunctionObjArgs(object, name, NULL); - Py_DECREF(object); + Py_DECREF(object); - return result; + return result; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_getattr( - WraptObjectProxyObject *self, PyObject *args) +static PyObject *WraptObjectProxy_getattr(WraptObjectProxyObject *self, + PyObject *args) { - PyObject *name = NULL; + PyObject *name = NULL; -#if PY_MAJOR_VERSION >= 3 - if (!PyArg_ParseTuple(args, "U:__getattr__", &name)) - return NULL; -#else - if (!PyArg_ParseTuple(args, "S:__getattr__", &name)) - return NULL; -#endif + if (!PyArg_ParseTuple(args, "U:__getattr__", &name)) + return NULL; - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyObject_GetAttr(self->wrapped, name); + return PyObject_GetAttr(self->wrapped, name); } /* ------------------------------------------------------------------------- */ -static int WraptObjectProxy_setattro( - WraptObjectProxyObject *self, PyObject *name, PyObject *value) +static int WraptObjectProxy_setattro(WraptObjectProxyObject *self, + PyObject *name, PyObject *value) { - static PyObject *self_str = NULL; - static PyObject *wrapped_str = NULL; - static PyObject *startswith_str = NULL; + static PyObject *self_str = NULL; + static PyObject *startswith_str = NULL; - PyObject *match = NULL; + PyObject *match = NULL; - if (!startswith_str) { -#if PY_MAJOR_VERSION >= 3 - startswith_str = PyUnicode_InternFromString("startswith"); -#else - startswith_str = PyString_InternFromString("startswith"); -#endif - } + if (!startswith_str) + { + startswith_str = PyUnicode_InternFromString("startswith"); + } - if (!self_str) { -#if PY_MAJOR_VERSION >= 3 - self_str = PyUnicode_InternFromString("_self_"); -#else - self_str = PyString_InternFromString("_self_"); -#endif - } - - match = PyObject_CallMethodObjArgs(name, startswith_str, self_str, NULL); + if (!self_str) + { + self_str = PyUnicode_InternFromString("_self_"); + } - if (match == Py_True) { - Py_DECREF(match); + match = PyObject_CallMethodObjArgs(name, startswith_str, self_str, NULL); - return PyObject_GenericSetAttr((PyObject *)self, name, value); - } - else if (!match) - PyErr_Clear(); + if (match == Py_True) + { + Py_DECREF(match); - Py_XDECREF(match); + return PyObject_GenericSetAttr((PyObject *)self, name, value); + } + else if (!match) + PyErr_Clear(); - if (!wrapped_str) { -#if PY_MAJOR_VERSION >= 3 - wrapped_str = PyUnicode_InternFromString("__wrapped__"); -#else - wrapped_str = PyString_InternFromString("__wrapped__"); -#endif - } + Py_XDECREF(match); - if (PyObject_HasAttr((PyObject *)Py_TYPE(self), name)) - return PyObject_GenericSetAttr((PyObject *)self, name, value); + if (PyObject_HasAttr((PyObject *)Py_TYPE(self), name)) + return PyObject_GenericSetAttr((PyObject *)self, name, value); - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return -1; - } + } - return PyObject_SetAttr(self->wrapped, name, value); + return PyObject_SetAttr(self->wrapped, name, value); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_richcompare(WraptObjectProxyObject *self, - PyObject *other, int opcode) + PyObject *other, int opcode) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyObject_RichCompare(self->wrapped, other, opcode); + return PyObject_RichCompare(self->wrapped, other, opcode); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_iter(WraptObjectProxyObject *self) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyObject_GetIter(self->wrapped); + return PyObject_GetIter(self->wrapped); } /* ------------------------------------------------------------------------- */ static PyNumberMethods WraptObjectProxy_as_number = { - (binaryfunc)WraptObjectProxy_add, /*nb_add*/ - (binaryfunc)WraptObjectProxy_subtract, /*nb_subtract*/ - (binaryfunc)WraptObjectProxy_multiply, /*nb_multiply*/ -#if PY_MAJOR_VERSION < 3 - (binaryfunc)WraptObjectProxy_divide, /*nb_divide*/ -#endif - (binaryfunc)WraptObjectProxy_remainder, /*nb_remainder*/ - (binaryfunc)WraptObjectProxy_divmod, /*nb_divmod*/ - (ternaryfunc)WraptObjectProxy_power, /*nb_power*/ - (unaryfunc)WraptObjectProxy_negative, /*nb_negative*/ - (unaryfunc)WraptObjectProxy_positive, /*nb_positive*/ - (unaryfunc)WraptObjectProxy_absolute, /*nb_absolute*/ - (inquiry)WraptObjectProxy_bool, /*nb_nonzero/nb_bool*/ - (unaryfunc)WraptObjectProxy_invert, /*nb_invert*/ - (binaryfunc)WraptObjectProxy_lshift, /*nb_lshift*/ - (binaryfunc)WraptObjectProxy_rshift, /*nb_rshift*/ - (binaryfunc)WraptObjectProxy_and, /*nb_and*/ - (binaryfunc)WraptObjectProxy_xor, /*nb_xor*/ - (binaryfunc)WraptObjectProxy_or, /*nb_or*/ -#if PY_MAJOR_VERSION < 3 - 0, /*nb_coerce*/ -#endif -#if PY_MAJOR_VERSION < 3 - (unaryfunc)WraptObjectProxy_int, /*nb_int*/ - (unaryfunc)WraptObjectProxy_long, /*nb_long*/ -#else - (unaryfunc)WraptObjectProxy_long, /*nb_int*/ - 0, /*nb_long/nb_reserved*/ -#endif - (unaryfunc)WraptObjectProxy_float, /*nb_float*/ -#if PY_MAJOR_VERSION < 3 - (unaryfunc)WraptObjectProxy_oct, /*nb_oct*/ - (unaryfunc)WraptObjectProxy_hex, /*nb_hex*/ -#endif - (binaryfunc)WraptObjectProxy_inplace_add, /*nb_inplace_add*/ - (binaryfunc)WraptObjectProxy_inplace_subtract, /*nb_inplace_subtract*/ - (binaryfunc)WraptObjectProxy_inplace_multiply, /*nb_inplace_multiply*/ -#if PY_MAJOR_VERSION < 3 - (binaryfunc)WraptObjectProxy_inplace_divide, /*nb_inplace_divide*/ -#endif + (binaryfunc)WraptObjectProxy_add, /*nb_add*/ + (binaryfunc)WraptObjectProxy_subtract, /*nb_subtract*/ + (binaryfunc)WraptObjectProxy_multiply, /*nb_multiply*/ + (binaryfunc)WraptObjectProxy_remainder, /*nb_remainder*/ + (binaryfunc)WraptObjectProxy_divmod, /*nb_divmod*/ + (ternaryfunc)WraptObjectProxy_power, /*nb_power*/ + (unaryfunc)WraptObjectProxy_negative, /*nb_negative*/ + (unaryfunc)WraptObjectProxy_positive, /*nb_positive*/ + (unaryfunc)WraptObjectProxy_absolute, /*nb_absolute*/ + (inquiry)WraptObjectProxy_bool, /*nb_nonzero/nb_bool*/ + (unaryfunc)WraptObjectProxy_invert, /*nb_invert*/ + (binaryfunc)WraptObjectProxy_lshift, /*nb_lshift*/ + (binaryfunc)WraptObjectProxy_rshift, /*nb_rshift*/ + (binaryfunc)WraptObjectProxy_and, /*nb_and*/ + (binaryfunc)WraptObjectProxy_xor, /*nb_xor*/ + (binaryfunc)WraptObjectProxy_or, /*nb_or*/ + (unaryfunc)WraptObjectProxy_long, /*nb_int*/ + 0, /*nb_long/nb_reserved*/ + (unaryfunc)WraptObjectProxy_float, /*nb_float*/ + (binaryfunc)WraptObjectProxy_inplace_add, /*nb_inplace_add*/ + (binaryfunc)WraptObjectProxy_inplace_subtract, /*nb_inplace_subtract*/ + (binaryfunc)WraptObjectProxy_inplace_multiply, /*nb_inplace_multiply*/ (binaryfunc)WraptObjectProxy_inplace_remainder, /*nb_inplace_remainder*/ - (ternaryfunc)WraptObjectProxy_inplace_power, /*nb_inplace_power*/ - (binaryfunc)WraptObjectProxy_inplace_lshift, /*nb_inplace_lshift*/ - (binaryfunc)WraptObjectProxy_inplace_rshift, /*nb_inplace_rshift*/ - (binaryfunc)WraptObjectProxy_inplace_and, /*nb_inplace_and*/ - (binaryfunc)WraptObjectProxy_inplace_xor, /*nb_inplace_xor*/ - (binaryfunc)WraptObjectProxy_inplace_or, /*nb_inplace_or*/ - (binaryfunc)WraptObjectProxy_floor_divide, /*nb_floor_divide*/ - (binaryfunc)WraptObjectProxy_true_divide, /*nb_true_divide*/ - (binaryfunc)WraptObjectProxy_inplace_floor_divide, /*nb_inplace_floor_divide*/ - (binaryfunc)WraptObjectProxy_inplace_true_divide, /*nb_inplace_true_divide*/ - (unaryfunc)WraptObjectProxy_index, /*nb_index*/ + (ternaryfunc)WraptObjectProxy_inplace_power, /*nb_inplace_power*/ + (binaryfunc)WraptObjectProxy_inplace_lshift, /*nb_inplace_lshift*/ + (binaryfunc)WraptObjectProxy_inplace_rshift, /*nb_inplace_rshift*/ + (binaryfunc)WraptObjectProxy_inplace_and, /*nb_inplace_and*/ + (binaryfunc)WraptObjectProxy_inplace_xor, /*nb_inplace_xor*/ + (binaryfunc)WraptObjectProxy_inplace_or, /*nb_inplace_or*/ + (binaryfunc)WraptObjectProxy_floor_divide, /*nb_floor_divide*/ + (binaryfunc)WraptObjectProxy_true_divide, /*nb_true_divide*/ + (binaryfunc) + WraptObjectProxy_inplace_floor_divide, /*nb_inplace_floor_divide*/ + (binaryfunc)WraptObjectProxy_inplace_true_divide, /*nb_inplace_true_divide*/ + (unaryfunc)WraptObjectProxy_index, /*nb_index*/ + (binaryfunc)WraptObjectProxy_matrix_multiply, /*nb_matrix_multiply*/ + (binaryfunc)WraptObjectProxy_inplace_matrix_multiply, /*nb_inplace_matrix_multiply*/ }; static PySequenceMethods WraptObjectProxy_as_sequence = { - (lenfunc)WraptObjectProxy_length, /*sq_length*/ - 0, /*sq_concat*/ - 0, /*sq_repeat*/ - 0, /*sq_item*/ - 0, /*sq_slice*/ - 0, /*sq_ass_item*/ - 0, /*sq_ass_slice*/ + (lenfunc)WraptObjectProxy_length, /*sq_length*/ + 0, /*sq_concat*/ + 0, /*sq_repeat*/ + 0, /*sq_item*/ + 0, /*sq_slice*/ + 0, /*sq_ass_item*/ + 0, /*sq_ass_slice*/ (objobjproc)WraptObjectProxy_contains, /* sq_contains */ }; static PyMappingMethods WraptObjectProxy_as_mapping = { - (lenfunc)WraptObjectProxy_length, /*mp_length*/ - (binaryfunc)WraptObjectProxy_getitem, /*mp_subscript*/ + (lenfunc)WraptObjectProxy_length, /*mp_length*/ + (binaryfunc)WraptObjectProxy_getitem, /*mp_subscript*/ (objobjargproc)WraptObjectProxy_setitem, /*mp_ass_subscript*/ }; static PyMethodDef WraptObjectProxy_methods[] = { - { "__self_setattr__", (PyCFunction)WraptObjectProxy_self_setattr, - METH_VARARGS , 0 }, - { "__dir__", (PyCFunction)WraptObjectProxy_dir, METH_NOARGS, 0 }, - { "__enter__", (PyCFunction)WraptObjectProxy_enter, - METH_VARARGS | METH_KEYWORDS, 0 }, - { "__exit__", (PyCFunction)WraptObjectProxy_exit, - METH_VARARGS | METH_KEYWORDS, 0 }, - { "__copy__", (PyCFunction)WraptObjectProxy_copy, - METH_NOARGS, 0 }, - { "__deepcopy__", (PyCFunction)WraptObjectProxy_deepcopy, - METH_VARARGS | METH_KEYWORDS, 0 }, - { "__reduce__", (PyCFunction)WraptObjectProxy_reduce, - METH_NOARGS, 0 }, - { "__reduce_ex__", (PyCFunction)WraptObjectProxy_reduce_ex, - METH_VARARGS | METH_KEYWORDS, 0 }, - { "__getattr__", (PyCFunction)WraptObjectProxy_getattr, - METH_VARARGS , 0 }, - { "__bytes__", (PyCFunction)WraptObjectProxy_bytes, METH_NOARGS, 0 }, - { "__reversed__", (PyCFunction)WraptObjectProxy_reversed, METH_NOARGS, 0 }, -#if PY_MAJOR_VERSION >= 3 - { "__round__", (PyCFunction)WraptObjectProxy_round, METH_NOARGS, 0 }, -#endif - { "__complex__", (PyCFunction)WraptObjectProxy_complex, METH_NOARGS, 0 }, -#if PY_MAJOR_VERSION > 3 || (PY_MAJOR_VERSION == 3 && PY_MINOR_VERSION >= 7) - { "__mro_entries__", (PyCFunction)WraptObjectProxy_mro_entries, - METH_VARARGS | METH_KEYWORDS, 0 }, -#endif - { NULL, NULL }, + {"__self_setattr__", (PyCFunction)WraptObjectProxy_self_setattr, + METH_VARARGS, 0}, + {"__dir__", (PyCFunction)WraptObjectProxy_dir, METH_NOARGS, 0}, + {"__enter__", (PyCFunction)WraptObjectProxy_enter, + METH_VARARGS | METH_KEYWORDS, 0}, + {"__exit__", (PyCFunction)WraptObjectProxy_exit, + METH_VARARGS | METH_KEYWORDS, 0}, + {"__aenter__", (PyCFunction)WraptObjectProxy_aenter, + METH_VARARGS | METH_KEYWORDS, 0}, + {"__aexit__", (PyCFunction)WraptObjectProxy_aexit, + METH_VARARGS | METH_KEYWORDS, 0}, + {"__copy__", (PyCFunction)WraptObjectProxy_copy, METH_NOARGS, 0}, + {"__deepcopy__", (PyCFunction)WraptObjectProxy_deepcopy, + METH_VARARGS | METH_KEYWORDS, 0}, + {"__reduce__", (PyCFunction)WraptObjectProxy_reduce, METH_NOARGS, 0}, + {"__reduce_ex__", (PyCFunction)WraptObjectProxy_reduce_ex, + METH_VARARGS | METH_KEYWORDS, 0}, + {"__getattr__", (PyCFunction)WraptObjectProxy_getattr, METH_VARARGS, 0}, + {"__bytes__", (PyCFunction)WraptObjectProxy_bytes, METH_NOARGS, 0}, + {"__format__", (PyCFunction)WraptObjectProxy_format, METH_VARARGS, 0}, + {"__reversed__", (PyCFunction)WraptObjectProxy_reversed, METH_NOARGS, 0}, + {"__round__", (PyCFunction)WraptObjectProxy_round, + METH_VARARGS | METH_KEYWORDS, 0}, + {"__complex__", (PyCFunction)WraptObjectProxy_complex, METH_NOARGS, 0}, + {"__mro_entries__", (PyCFunction)WraptObjectProxy_mro_entries, + METH_VARARGS | METH_KEYWORDS, 0}, + {NULL, NULL}, }; static PyGetSetDef WraptObjectProxy_getset[] = { - { "__name__", (getter)WraptObjectProxy_get_name, - (setter)WraptObjectProxy_set_name, 0 }, - { "__qualname__", (getter)WraptObjectProxy_get_qualname, - (setter)WraptObjectProxy_set_qualname, 0 }, - { "__module__", (getter)WraptObjectProxy_get_module, - (setter)WraptObjectProxy_set_module, 0 }, - { "__doc__", (getter)WraptObjectProxy_get_doc, - (setter)WraptObjectProxy_set_doc, 0 }, - { "__class__", (getter)WraptObjectProxy_get_class, - (setter)WraptObjectProxy_set_class, 0 }, - { "__annotations__", (getter)WraptObjectProxy_get_annotations, - (setter)WraptObjectProxy_set_annotations, 0 }, - { "__wrapped__", (getter)WraptObjectProxy_get_wrapped, - (setter)WraptObjectProxy_set_wrapped, 0 }, - { NULL }, + {"__name__", (getter)WraptObjectProxy_get_name, + (setter)WraptObjectProxy_set_name, 0}, + {"__qualname__", (getter)WraptObjectProxy_get_qualname, + (setter)WraptObjectProxy_set_qualname, 0}, + {"__module__", (getter)WraptObjectProxy_get_module, + (setter)WraptObjectProxy_set_module, 0}, + {"__doc__", (getter)WraptObjectProxy_get_doc, + (setter)WraptObjectProxy_set_doc, 0}, + {"__class__", (getter)WraptObjectProxy_get_class, + (setter)WraptObjectProxy_set_class, 0}, + {"__annotations__", (getter)WraptObjectProxy_get_annotations, + (setter)WraptObjectProxy_set_annotations, 0}, + {"__wrapped__", (getter)WraptObjectProxy_get_wrapped, + (setter)WraptObjectProxy_set_wrapped, 0}, + {"__object_proxy__", (getter)WraptObjectProxy_get_object_proxy, 0, 0}, + {NULL}, }; PyTypeObject WraptObjectProxy_Type = { - PyVarObject_HEAD_INIT(NULL, 0) - "ObjectProxy", /*tp_name*/ - sizeof(WraptObjectProxyObject), /*tp_basicsize*/ - 0, /*tp_itemsize*/ + PyVarObject_HEAD_INIT(NULL, 0) "ObjectProxy", /*tp_name*/ + sizeof(WraptObjectProxyObject), /*tp_basicsize*/ + 0, /*tp_itemsize*/ /* methods */ - (destructor)WraptObjectProxy_dealloc, /*tp_dealloc*/ - 0, /*tp_print*/ - 0, /*tp_getattr*/ - 0, /*tp_setattr*/ - 0, /*tp_compare*/ - (unaryfunc)WraptObjectProxy_repr, /*tp_repr*/ - &WraptObjectProxy_as_number, /*tp_as_number*/ - &WraptObjectProxy_as_sequence, /*tp_as_sequence*/ - &WraptObjectProxy_as_mapping, /*tp_as_mapping*/ - (hashfunc)WraptObjectProxy_hash, /*tp_hash*/ - 0, /*tp_call*/ - (unaryfunc)WraptObjectProxy_str, /*tp_str*/ - (getattrofunc)WraptObjectProxy_getattro, /*tp_getattro*/ - (setattrofunc)WraptObjectProxy_setattro, /*tp_setattro*/ - 0, /*tp_as_buffer*/ -#if PY_MAJOR_VERSION < 3 - Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | - Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_CHECKTYPES, /*tp_flags*/ -#else - Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | - Py_TPFLAGS_HAVE_GC, /*tp_flags*/ -#endif - 0, /*tp_doc*/ - (traverseproc)WraptObjectProxy_traverse, /*tp_traverse*/ - (inquiry)WraptObjectProxy_clear, /*tp_clear*/ - (richcmpfunc)WraptObjectProxy_richcompare, /*tp_richcompare*/ - offsetof(WraptObjectProxyObject, weakreflist), /*tp_weaklistoffset*/ - (getiterfunc)WraptObjectProxy_iter, /*tp_iter*/ - 0, /*tp_iternext*/ - WraptObjectProxy_methods, /*tp_methods*/ - 0, /*tp_members*/ - WraptObjectProxy_getset, /*tp_getset*/ - 0, /*tp_base*/ - 0, /*tp_dict*/ - 0, /*tp_descr_get*/ - 0, /*tp_descr_set*/ - offsetof(WraptObjectProxyObject, dict), /*tp_dictoffset*/ - (initproc)WraptObjectProxy_init, /*tp_init*/ - PyType_GenericAlloc, /*tp_alloc*/ - WraptObjectProxy_new, /*tp_new*/ - PyObject_GC_Del, /*tp_free*/ - 0, /*tp_is_gc*/ + (destructor)WraptObjectProxy_dealloc, /*tp_dealloc*/ + 0, /*tp_print*/ + 0, /*tp_getattr*/ + 0, /*tp_setattr*/ + 0, /*tp_as_async*/ + (unaryfunc)WraptObjectProxy_repr, /*tp_repr*/ + &WraptObjectProxy_as_number, /*tp_as_number*/ + &WraptObjectProxy_as_sequence, /*tp_as_sequence*/ + &WraptObjectProxy_as_mapping, /*tp_as_mapping*/ + (hashfunc)WraptObjectProxy_hash, /*tp_hash*/ + 0, /*tp_call*/ + (unaryfunc)WraptObjectProxy_str, /*tp_str*/ + (getattrofunc)WraptObjectProxy_getattro, /*tp_getattro*/ + (setattrofunc)WraptObjectProxy_setattro, /*tp_setattro*/ + 0, /*tp_as_buffer*/ + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, /*tp_flags*/ + 0, /*tp_doc*/ + (traverseproc)WraptObjectProxy_traverse, /*tp_traverse*/ + (inquiry)WraptObjectProxy_clear, /*tp_clear*/ + (richcmpfunc)WraptObjectProxy_richcompare, /*tp_richcompare*/ + offsetof(WraptObjectProxyObject, weakreflist), /*tp_weaklistoffset*/ + 0, /* (getiterfunc)WraptObjectProxy_iter, */ /*tp_iter*/ + 0, /*tp_iternext*/ + WraptObjectProxy_methods, /*tp_methods*/ + 0, /*tp_members*/ + WraptObjectProxy_getset, /*tp_getset*/ + 0, /*tp_base*/ + 0, /*tp_dict*/ + 0, /*tp_descr_get*/ + 0, /*tp_descr_set*/ + offsetof(WraptObjectProxyObject, dict), /*tp_dictoffset*/ + (initproc)WraptObjectProxy_init, /*tp_init*/ + PyType_GenericAlloc, /*tp_alloc*/ + WraptObjectProxy_new, /*tp_new*/ + PyObject_GC_Del, /*tp_free*/ + 0, /*tp_is_gc*/ }; /* ------------------------------------------------------------------------- */ -static PyObject *WraptCallableObjectProxy_call( - WraptObjectProxyObject *self, PyObject *args, PyObject *kwds) +static PyObject *WraptCallableObjectProxy_call(WraptObjectProxyObject *self, + PyObject *args, PyObject *kwds) { - if (!self->wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->wrapped) + { + if (raise_uninitialized_wrapper_error(self) == -1) return NULL; - } + } - return PyObject_Call(self->wrapped, args, kwds); + return PyObject_Call(self->wrapped, args, kwds); } /* ------------------------------------------------------------------------- */; static PyGetSetDef WraptCallableObjectProxy_getset[] = { - { "__module__", (getter)WraptObjectProxy_get_module, - (setter)WraptObjectProxy_set_module, 0 }, - { "__doc__", (getter)WraptObjectProxy_get_doc, - (setter)WraptObjectProxy_set_doc, 0 }, - { NULL }, + {"__module__", (getter)WraptObjectProxy_get_module, + (setter)WraptObjectProxy_set_module, 0}, + {"__doc__", (getter)WraptObjectProxy_get_doc, + (setter)WraptObjectProxy_set_doc, 0}, + {NULL}, }; PyTypeObject WraptCallableObjectProxy_Type = { - PyVarObject_HEAD_INIT(NULL, 0) - "CallableObjectProxy", /*tp_name*/ - sizeof(WraptObjectProxyObject), /*tp_basicsize*/ - 0, /*tp_itemsize*/ + PyVarObject_HEAD_INIT(NULL, 0) "CallableObjectProxy", /*tp_name*/ + sizeof(WraptObjectProxyObject), /*tp_basicsize*/ + 0, /*tp_itemsize*/ /* methods */ - 0, /*tp_dealloc*/ - 0, /*tp_print*/ - 0, /*tp_getattr*/ - 0, /*tp_setattr*/ - 0, /*tp_compare*/ - 0, /*tp_repr*/ - 0, /*tp_as_number*/ - 0, /*tp_as_sequence*/ - 0, /*tp_as_mapping*/ - 0, /*tp_hash*/ - (ternaryfunc)WraptCallableObjectProxy_call, /*tp_call*/ - 0, /*tp_str*/ - 0, /*tp_getattro*/ - 0, /*tp_setattro*/ - 0, /*tp_as_buffer*/ -#if PY_MAJOR_VERSION < 3 - Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_CHECKTYPES, /*tp_flags*/ -#else - Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ -#endif - 0, /*tp_doc*/ - 0, /*tp_traverse*/ - 0, /*tp_clear*/ - 0, /*tp_richcompare*/ + 0, /*tp_dealloc*/ + 0, /*tp_print*/ + 0, /*tp_getattr*/ + 0, /*tp_setattr*/ + 0, /*tp_compare*/ + 0, /*tp_repr*/ + 0, /*tp_as_number*/ + 0, /*tp_as_sequence*/ + 0, /*tp_as_mapping*/ + 0, /*tp_hash*/ + (ternaryfunc)WraptCallableObjectProxy_call, /*tp_call*/ + 0, /*tp_str*/ + 0, /*tp_getattro*/ + 0, /*tp_setattro*/ + 0, /*tp_as_buffer*/ + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ + 0, /*tp_doc*/ + 0, /*tp_traverse*/ + 0, /*tp_clear*/ + 0, /*tp_richcompare*/ offsetof(WraptObjectProxyObject, weakreflist), /*tp_weaklistoffset*/ - 0, /*tp_iter*/ - 0, /*tp_iternext*/ - 0, /*tp_methods*/ - 0, /*tp_members*/ - WraptCallableObjectProxy_getset, /*tp_getset*/ - 0, /*tp_base*/ - 0, /*tp_dict*/ - 0, /*tp_descr_get*/ - 0, /*tp_descr_set*/ - 0, /*tp_dictoffset*/ - (initproc)WraptObjectProxy_init, /*tp_init*/ - 0, /*tp_alloc*/ - 0, /*tp_new*/ - 0, /*tp_free*/ - 0, /*tp_is_gc*/ + 0, /*tp_iter*/ + 0, /*tp_iternext*/ + 0, /*tp_methods*/ + 0, /*tp_members*/ + WraptCallableObjectProxy_getset, /*tp_getset*/ + 0, /*tp_base*/ + 0, /*tp_dict*/ + 0, /*tp_descr_get*/ + 0, /*tp_descr_set*/ + 0, /*tp_dictoffset*/ + (initproc)WraptObjectProxy_init, /*tp_init*/ + 0, /*tp_alloc*/ + 0, /*tp_new*/ + 0, /*tp_free*/ + 0, /*tp_is_gc*/ }; /* ------------------------------------------------------------------------- */ static PyObject *WraptPartialCallableObjectProxy_new(PyTypeObject *type, - PyObject *args, PyObject *kwds) + PyObject *args, + PyObject *kwds) { - WraptPartialCallableObjectProxyObject *self; + WraptPartialCallableObjectProxyObject *self; - self = (WraptPartialCallableObjectProxyObject *)WraptObjectProxy_new(type, - args, kwds); + self = (WraptPartialCallableObjectProxyObject *)WraptObjectProxy_new( + type, args, kwds); - if (!self) - return NULL; + if (!self) + return NULL; - self->args = NULL; - self->kwargs = NULL; + self->args = NULL; + self->kwargs = NULL; - return (PyObject *)self; + return (PyObject *)self; } /* ------------------------------------------------------------------------- */ static int WraptPartialCallableObjectProxy_raw_init( - WraptPartialCallableObjectProxyObject *self, - PyObject *wrapped, PyObject *args, PyObject *kwargs) + WraptPartialCallableObjectProxyObject *self, PyObject *wrapped, + PyObject *args, PyObject *kwargs) { - int result = 0; + int result = 0; - result = WraptObjectProxy_raw_init((WraptObjectProxyObject *)self, - wrapped); + result = WraptObjectProxy_raw_init((WraptObjectProxyObject *)self, wrapped); - if (result == 0) { - Py_INCREF(args); - Py_XDECREF(self->args); - self->args = args; + if (result == 0) + { + Py_INCREF(args); + Py_XDECREF(self->args); + self->args = args; - Py_XINCREF(kwargs); - Py_XDECREF(self->kwargs); - self->kwargs = kwargs; - } + Py_XINCREF(kwargs); + Py_XDECREF(self->kwargs); + self->kwargs = kwargs; + } - return result; + return result; } /* ------------------------------------------------------------------------- */ static int WraptPartialCallableObjectProxy_init( - WraptPartialCallableObjectProxyObject *self, PyObject *args, - PyObject *kwds) + WraptPartialCallableObjectProxyObject *self, PyObject *args, + PyObject *kwds) { - PyObject *wrapped = NULL; - PyObject *fnargs = NULL; + PyObject *wrapped = NULL; + PyObject *fnargs = NULL; - int result = 0; + int result = 0; - if (!PyObject_Length(args)) { - PyErr_SetString(PyExc_TypeError, - "__init__ of partial needs an argument"); - return -1; - } + if (!PyObject_Length(args)) + { + PyErr_SetString(PyExc_TypeError, "__init__ of partial needs an argument"); + return -1; + } - if (PyObject_Length(args) < 1) { - PyErr_SetString(PyExc_TypeError, - "partial type takes at least one argument"); - return -1; - } + if (PyObject_Length(args) < 1) + { + PyErr_SetString(PyExc_TypeError, + "partial type takes at least one argument"); + return -1; + } - wrapped = PyTuple_GetItem(args, 0); + wrapped = PyTuple_GetItem(args, 0); - if (!PyCallable_Check(wrapped)) { - PyErr_SetString(PyExc_TypeError, - "the first argument must be callable"); - return -1; - } + if (!PyCallable_Check(wrapped)) + { + PyErr_SetString(PyExc_TypeError, "the first argument must be callable"); + return -1; + } - fnargs = PyTuple_GetSlice(args, 1, PyTuple_Size(args)); + fnargs = PyTuple_GetSlice(args, 1, PyTuple_Size(args)); - if (!fnargs) - return -1; + if (!fnargs) + return -1; - result = WraptPartialCallableObjectProxy_raw_init(self, wrapped, - fnargs, kwds); + result = + WraptPartialCallableObjectProxy_raw_init(self, wrapped, fnargs, kwds); - Py_DECREF(fnargs); + Py_DECREF(fnargs); - return result; + return result; } /* ------------------------------------------------------------------------- */ static int WraptPartialCallableObjectProxy_traverse( - WraptPartialCallableObjectProxyObject *self, - visitproc visit, void *arg) + WraptPartialCallableObjectProxyObject *self, visitproc visit, void *arg) { - WraptObjectProxy_traverse((WraptObjectProxyObject *)self, visit, arg); + WraptObjectProxy_traverse((WraptObjectProxyObject *)self, visit, arg); - Py_VISIT(self->args); - Py_VISIT(self->kwargs); + Py_VISIT(self->args); + Py_VISIT(self->kwargs); - return 0; + return 0; } /* ------------------------------------------------------------------------- */ static int WraptPartialCallableObjectProxy_clear( - WraptPartialCallableObjectProxyObject *self) + WraptPartialCallableObjectProxyObject *self) { - WraptObjectProxy_clear((WraptObjectProxyObject *)self); + WraptObjectProxy_clear((WraptObjectProxyObject *)self); - Py_CLEAR(self->args); - Py_CLEAR(self->kwargs); + Py_CLEAR(self->args); + Py_CLEAR(self->kwargs); - return 0; + return 0; } /* ------------------------------------------------------------------------- */ static void WraptPartialCallableObjectProxy_dealloc( - WraptPartialCallableObjectProxyObject *self) + WraptPartialCallableObjectProxyObject *self) { - PyObject_GC_UnTrack(self); + PyObject_GC_UnTrack(self); - WraptPartialCallableObjectProxy_clear(self); + WraptPartialCallableObjectProxy_clear(self); - WraptObjectProxy_dealloc((WraptObjectProxyObject *)self); + WraptObjectProxy_dealloc((WraptObjectProxyObject *)self); } /* ------------------------------------------------------------------------- */ static PyObject *WraptPartialCallableObjectProxy_call( - WraptPartialCallableObjectProxyObject *self, PyObject *args, - PyObject *kwds) + WraptPartialCallableObjectProxyObject *self, PyObject *args, + PyObject *kwds) { - PyObject *fnargs = NULL; - PyObject *fnkwargs = NULL; + PyObject *fnargs = NULL; + PyObject *fnkwargs = NULL; - PyObject *result = NULL; + PyObject *result = NULL; - long i; - long offset; + long i; + long offset; - if (!self->object_proxy.wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->object_proxy.wrapped) + { + if (raise_uninitialized_wrapper_error(&self->object_proxy) == -1) return NULL; - } + } - fnargs = PyTuple_New(PyTuple_Size(self->args)+PyTuple_Size(args)); + fnargs = PyTuple_New(PyTuple_Size(self->args) + PyTuple_Size(args)); - for (i=0; iargs); i++) { - PyObject *item; - item = PyTuple_GetItem(self->args, i); - Py_INCREF(item); - PyTuple_SetItem(fnargs, i, item); - } - - offset = PyTuple_Size(self->args); - - for (i=0; iargs); i++) + { + PyObject *item; + item = PyTuple_GetItem(self->args, i); + Py_INCREF(item); + PyTuple_SetItem(fnargs, i, item); + } - fnkwargs = PyDict_New(); + offset = PyTuple_Size(self->args); - if (self->kwargs && PyDict_Update(fnkwargs, self->kwargs) == -1) { - Py_DECREF(fnargs); - Py_DECREF(fnkwargs); - return NULL; - } + for (i = 0; i < PyTuple_Size(args); i++) + { + PyObject *item; + item = PyTuple_GetItem(args, i); + Py_INCREF(item); + PyTuple_SetItem(fnargs, offset + i, item); + } - if (kwds && PyDict_Update(fnkwargs, kwds) == -1) { - Py_DECREF(fnargs); - Py_DECREF(fnkwargs); - return NULL; - } + fnkwargs = PyDict_New(); - result = PyObject_Call(self->object_proxy.wrapped, - fnargs, fnkwargs); + if (self->kwargs && PyDict_Update(fnkwargs, self->kwargs) == -1) + { + Py_DECREF(fnargs); + Py_DECREF(fnkwargs); + return NULL; + } + if (kwds && PyDict_Update(fnkwargs, kwds) == -1) + { Py_DECREF(fnargs); Py_DECREF(fnkwargs); + return NULL; + } - return result; + result = PyObject_Call(self->object_proxy.wrapped, fnargs, fnkwargs); + + Py_DECREF(fnargs); + Py_DECREF(fnkwargs); + + return result; } /* ------------------------------------------------------------------------- */; static PyGetSetDef WraptPartialCallableObjectProxy_getset[] = { - { "__module__", (getter)WraptObjectProxy_get_module, - (setter)WraptObjectProxy_set_module, 0 }, - { "__doc__", (getter)WraptObjectProxy_get_doc, - (setter)WraptObjectProxy_set_doc, 0 }, - { NULL }, + {"__module__", (getter)WraptObjectProxy_get_module, + (setter)WraptObjectProxy_set_module, 0}, + {"__doc__", (getter)WraptObjectProxy_get_doc, + (setter)WraptObjectProxy_set_doc, 0}, + {NULL}, }; PyTypeObject WraptPartialCallableObjectProxy_Type = { - PyVarObject_HEAD_INIT(NULL, 0) - "PartialCallableObjectProxy", /*tp_name*/ - sizeof(WraptPartialCallableObjectProxyObject), /*tp_basicsize*/ - 0, /*tp_itemsize*/ + PyVarObject_HEAD_INIT(NULL, 0) "PartialCallableObjectProxy", /*tp_name*/ + sizeof(WraptPartialCallableObjectProxyObject), /*tp_basicsize*/ + 0, /*tp_itemsize*/ /* methods */ - (destructor)WraptPartialCallableObjectProxy_dealloc, /*tp_dealloc*/ - 0, /*tp_print*/ - 0, /*tp_getattr*/ - 0, /*tp_setattr*/ - 0, /*tp_compare*/ - 0, /*tp_repr*/ - 0, /*tp_as_number*/ - 0, /*tp_as_sequence*/ - 0, /*tp_as_mapping*/ - 0, /*tp_hash*/ - (ternaryfunc)WraptPartialCallableObjectProxy_call, /*tp_call*/ - 0, /*tp_str*/ - 0, /*tp_getattro*/ - 0, /*tp_setattro*/ - 0, /*tp_as_buffer*/ -#if PY_MAJOR_VERSION < 3 - Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | - Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_CHECKTYPES, /*tp_flags*/ -#else - Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | - Py_TPFLAGS_HAVE_GC, /*tp_flags*/ -#endif - 0, /*tp_doc*/ - (traverseproc)WraptPartialCallableObjectProxy_traverse, /*tp_traverse*/ - (inquiry)WraptPartialCallableObjectProxy_clear, /*tp_clear*/ - 0, /*tp_richcompare*/ - offsetof(WraptObjectProxyObject, weakreflist), /*tp_weaklistoffset*/ - 0, /*tp_iter*/ - 0, /*tp_iternext*/ - 0, /*tp_methods*/ - 0, /*tp_members*/ - WraptPartialCallableObjectProxy_getset, /*tp_getset*/ - 0, /*tp_base*/ - 0, /*tp_dict*/ - 0, /*tp_descr_get*/ - 0, /*tp_descr_set*/ - 0, /*tp_dictoffset*/ - (initproc)WraptPartialCallableObjectProxy_init, /*tp_init*/ - 0, /*tp_alloc*/ - WraptPartialCallableObjectProxy_new, /*tp_new*/ - 0, /*tp_free*/ - 0, /*tp_is_gc*/ + (destructor)WraptPartialCallableObjectProxy_dealloc, /*tp_dealloc*/ + 0, /*tp_print*/ + 0, /*tp_getattr*/ + 0, /*tp_setattr*/ + 0, /*tp_compare*/ + 0, /*tp_repr*/ + 0, /*tp_as_number*/ + 0, /*tp_as_sequence*/ + 0, /*tp_as_mapping*/ + 0, /*tp_hash*/ + (ternaryfunc)WraptPartialCallableObjectProxy_call, /*tp_call*/ + 0, /*tp_str*/ + 0, /*tp_getattro*/ + 0, /*tp_setattro*/ + 0, /*tp_as_buffer*/ + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, /*tp_flags*/ + 0, /*tp_doc*/ + (traverseproc)WraptPartialCallableObjectProxy_traverse, /*tp_traverse*/ + (inquiry)WraptPartialCallableObjectProxy_clear, /*tp_clear*/ + 0, /*tp_richcompare*/ + offsetof(WraptObjectProxyObject, weakreflist), /*tp_weaklistoffset*/ + 0, /*tp_iter*/ + 0, /*tp_iternext*/ + 0, /*tp_methods*/ + 0, /*tp_members*/ + WraptPartialCallableObjectProxy_getset, /*tp_getset*/ + 0, /*tp_base*/ + 0, /*tp_dict*/ + 0, /*tp_descr_get*/ + 0, /*tp_descr_set*/ + 0, /*tp_dictoffset*/ + (initproc)WraptPartialCallableObjectProxy_init, /*tp_init*/ + 0, /*tp_alloc*/ + WraptPartialCallableObjectProxy_new, /*tp_new*/ + 0, /*tp_free*/ + 0, /*tp_is_gc*/ }; /* ------------------------------------------------------------------------- */ static PyObject *WraptFunctionWrapperBase_new(PyTypeObject *type, - PyObject *args, PyObject *kwds) + PyObject *args, PyObject *kwds) { - WraptFunctionWrapperObject *self; + WraptFunctionWrapperObject *self; - self = (WraptFunctionWrapperObject *)WraptObjectProxy_new(type, - args, kwds); + self = (WraptFunctionWrapperObject *)WraptObjectProxy_new(type, args, kwds); - if (!self) - return NULL; + if (!self) + return NULL; - self->instance = NULL; - self->wrapper = NULL; - self->enabled = NULL; - self->binding = NULL; - self->parent = NULL; + self->instance = NULL; + self->wrapper = NULL; + self->enabled = NULL; + self->binding = NULL; + self->parent = NULL; + self->owner = NULL; - return (PyObject *)self; + return (PyObject *)self; } /* ------------------------------------------------------------------------- */ -static int WraptFunctionWrapperBase_raw_init(WraptFunctionWrapperObject *self, - PyObject *wrapped, PyObject *instance, PyObject *wrapper, - PyObject *enabled, PyObject *binding, PyObject *parent) +static int WraptFunctionWrapperBase_raw_init( + WraptFunctionWrapperObject *self, PyObject *wrapped, PyObject *instance, + PyObject *wrapper, PyObject *enabled, PyObject *binding, PyObject *parent, + PyObject *owner) { - int result = 0; + int result = 0; - result = WraptObjectProxy_raw_init((WraptObjectProxyObject *)self, - wrapped); + result = WraptObjectProxy_raw_init((WraptObjectProxyObject *)self, wrapped); - if (result == 0) { - Py_INCREF(instance); - Py_XDECREF(self->instance); - self->instance = instance; + if (result == 0) + { + Py_INCREF(instance); + Py_XDECREF(self->instance); + self->instance = instance; - Py_INCREF(wrapper); - Py_XDECREF(self->wrapper); - self->wrapper = wrapper; + Py_INCREF(wrapper); + Py_XDECREF(self->wrapper); + self->wrapper = wrapper; - Py_INCREF(enabled); - Py_XDECREF(self->enabled); - self->enabled = enabled; + Py_INCREF(enabled); + Py_XDECREF(self->enabled); + self->enabled = enabled; - Py_INCREF(binding); - Py_XDECREF(self->binding); - self->binding = binding; + Py_INCREF(binding); + Py_XDECREF(self->binding); + self->binding = binding; - Py_INCREF(parent); - Py_XDECREF(self->parent); - self->parent = parent; - } + Py_INCREF(parent); + Py_XDECREF(self->parent); + self->parent = parent; - return result; + Py_INCREF(owner); + Py_XDECREF(self->owner); + self->owner = owner; + } + + return result; } /* ------------------------------------------------------------------------- */ static int WraptFunctionWrapperBase_init(WraptFunctionWrapperObject *self, - PyObject *args, PyObject *kwds) + PyObject *args, PyObject *kwds) { - PyObject *wrapped = NULL; - PyObject *instance = NULL; - PyObject *wrapper = NULL; - PyObject *enabled = Py_None; - PyObject *binding = NULL; - PyObject *parent = Py_None; - - static PyObject *function_str = NULL; - - static char *kwlist[] = { "wrapped", "instance", "wrapper", - "enabled", "binding", "parent", NULL }; - - if (!function_str) { -#if PY_MAJOR_VERSION >= 3 - function_str = PyUnicode_InternFromString("function"); -#else - function_str = PyString_InternFromString("function"); -#endif - } - - if (!PyArg_ParseTupleAndKeywords(args, kwds, - "OOO|OOO:FunctionWrapperBase", kwlist, &wrapped, &instance, - &wrapper, &enabled, &binding, &parent)) { - return -1; - } - - if (!binding) - binding = function_str; - - return WraptFunctionWrapperBase_raw_init(self, wrapped, instance, wrapper, - enabled, binding, parent); + PyObject *wrapped = NULL; + PyObject *instance = NULL; + PyObject *wrapper = NULL; + PyObject *enabled = Py_None; + PyObject *binding = NULL; + PyObject *parent = Py_None; + PyObject *owner = Py_None; + + static PyObject *callable_str = NULL; + + char *const kwlist[] = {"wrapped", "instance", "wrapper", "enabled", + "binding", "parent", "owner", NULL}; + + if (!callable_str) + { + callable_str = PyUnicode_InternFromString("callable"); + } + + if (!PyArg_ParseTupleAndKeywords(args, kwds, "OOO|OOOO:FunctionWrapperBase", + kwlist, &wrapped, &instance, &wrapper, + &enabled, &binding, &parent, &owner)) + { + return -1; + } + + if (!binding) + binding = callable_str; + + return WraptFunctionWrapperBase_raw_init(self, wrapped, instance, wrapper, + enabled, binding, parent, owner); } /* ------------------------------------------------------------------------- */ static int WraptFunctionWrapperBase_traverse(WraptFunctionWrapperObject *self, - visitproc visit, void *arg) + visitproc visit, void *arg) { - WraptObjectProxy_traverse((WraptObjectProxyObject *)self, visit, arg); + WraptObjectProxy_traverse((WraptObjectProxyObject *)self, visit, arg); - Py_VISIT(self->instance); - Py_VISIT(self->wrapper); - Py_VISIT(self->enabled); - Py_VISIT(self->binding); - Py_VISIT(self->parent); + Py_VISIT(self->instance); + Py_VISIT(self->wrapper); + Py_VISIT(self->enabled); + Py_VISIT(self->binding); + Py_VISIT(self->parent); + Py_VISIT(self->owner); - return 0; + return 0; } /* ------------------------------------------------------------------------- */ static int WraptFunctionWrapperBase_clear(WraptFunctionWrapperObject *self) { - WraptObjectProxy_clear((WraptObjectProxyObject *)self); + WraptObjectProxy_clear((WraptObjectProxyObject *)self); - Py_CLEAR(self->instance); - Py_CLEAR(self->wrapper); - Py_CLEAR(self->enabled); - Py_CLEAR(self->binding); - Py_CLEAR(self->parent); + Py_CLEAR(self->instance); + Py_CLEAR(self->wrapper); + Py_CLEAR(self->enabled); + Py_CLEAR(self->binding); + Py_CLEAR(self->parent); + Py_CLEAR(self->owner); - return 0; + return 0; } /* ------------------------------------------------------------------------- */ static void WraptFunctionWrapperBase_dealloc(WraptFunctionWrapperObject *self) { - PyObject_GC_UnTrack(self); + PyObject_GC_UnTrack(self); - WraptFunctionWrapperBase_clear(self); + WraptFunctionWrapperBase_clear(self); - WraptObjectProxy_dealloc((WraptObjectProxyObject *)self); + WraptObjectProxy_dealloc((WraptObjectProxyObject *)self); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptFunctionWrapperBase_call( - WraptFunctionWrapperObject *self, PyObject *args, PyObject *kwds) +static PyObject *WraptFunctionWrapperBase_call(WraptFunctionWrapperObject *self, + PyObject *args, PyObject *kwds) { - PyObject *param_kwds = NULL; - - PyObject *result = NULL; - - static PyObject *function_str = NULL; - static PyObject *classmethod_str = NULL; - - if (!function_str) { -#if PY_MAJOR_VERSION >= 3 - function_str = PyUnicode_InternFromString("function"); - classmethod_str = PyUnicode_InternFromString("classmethod"); -#else - function_str = PyString_InternFromString("function"); - classmethod_str = PyString_InternFromString("classmethod"); -#endif - } + PyObject *param_kwds = NULL; - if (self->enabled != Py_None) { - if (PyCallable_Check(self->enabled)) { - PyObject *object = NULL; + PyObject *result = NULL; - object = PyObject_CallFunctionObjArgs(self->enabled, NULL); + static PyObject *function_str = NULL; + static PyObject *callable_str = NULL; + static PyObject *classmethod_str = NULL; + static PyObject *instancemethod_str = NULL; - if (!object) - return NULL; + if (!function_str) + { + function_str = PyUnicode_InternFromString("function"); + callable_str = PyUnicode_InternFromString("callable"); + classmethod_str = PyUnicode_InternFromString("classmethod"); + instancemethod_str = PyUnicode_InternFromString("instancemethod"); + } - if (PyObject_Not(object)) { - Py_DECREF(object); - return PyObject_Call(self->object_proxy.wrapped, args, kwds); - } + if (self->enabled != Py_None) + { + if (PyCallable_Check(self->enabled)) + { + PyObject *object = NULL; - Py_DECREF(object); - } - else if (PyObject_Not(self->enabled)) { - return PyObject_Call(self->object_proxy.wrapped, args, kwds); - } - } + object = PyObject_CallFunctionObjArgs(self->enabled, NULL); - if (!kwds) { - param_kwds = PyDict_New(); - kwds = param_kwds; - } + if (!object) + return NULL; - if ((self->instance == Py_None) && (self->binding == function_str || - PyObject_RichCompareBool(self->binding, function_str, - Py_EQ) == 1 || self->binding == classmethod_str || - PyObject_RichCompareBool(self->binding, classmethod_str, - Py_EQ) == 1)) { + if (PyObject_Not(object)) + { + Py_DECREF(object); + return PyObject_Call(self->object_proxy.wrapped, args, kwds); + } + + Py_DECREF(object); + } + else if (PyObject_Not(self->enabled)) + { + return PyObject_Call(self->object_proxy.wrapped, args, kwds); + } + } + + if (!kwds) + { + param_kwds = PyDict_New(); + kwds = param_kwds; + } + + if ((self->instance == Py_None) && + (self->binding == function_str || + PyObject_RichCompareBool(self->binding, function_str, Py_EQ) == 1 || + self->binding == instancemethod_str || + PyObject_RichCompareBool(self->binding, instancemethod_str, Py_EQ) == + 1 || + self->binding == callable_str || + PyObject_RichCompareBool(self->binding, callable_str, Py_EQ) == 1 || + self->binding == classmethod_str || + PyObject_RichCompareBool(self->binding, classmethod_str, Py_EQ) == 1)) + { - PyObject *instance = NULL; + PyObject *instance = NULL; - instance = PyObject_GetAttrString(self->object_proxy.wrapped, - "__self__"); + instance = PyObject_GetAttrString(self->object_proxy.wrapped, "__self__"); - if (instance) { - result = PyObject_CallFunctionObjArgs(self->wrapper, - self->object_proxy.wrapped, instance, args, kwds, NULL); + if (instance) + { + result = PyObject_CallFunctionObjArgs(self->wrapper, + self->object_proxy.wrapped, + instance, args, kwds, NULL); - Py_XDECREF(param_kwds); + Py_XDECREF(param_kwds); - Py_DECREF(instance); + Py_DECREF(instance); - return result; - } - else - PyErr_Clear(); + return result; } + else + PyErr_Clear(); + } - result = PyObject_CallFunctionObjArgs(self->wrapper, - self->object_proxy.wrapped, self->instance, args, kwds, NULL); + result = + PyObject_CallFunctionObjArgs(self->wrapper, self->object_proxy.wrapped, + self->instance, args, kwds, NULL); - Py_XDECREF(param_kwds); + Py_XDECREF(param_kwds); - return result; + return result; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptFunctionWrapperBase_descr_get( - WraptFunctionWrapperObject *self, PyObject *obj, PyObject *type) +static PyObject * +WraptFunctionWrapperBase_descr_get(WraptFunctionWrapperObject *self, + PyObject *obj, PyObject *type) { - PyObject *bound_type = NULL; - PyObject *descriptor = NULL; - PyObject *result = NULL; - - static PyObject *bound_type_str = NULL; - static PyObject *function_str = NULL; + PyObject *bound_type = NULL; + PyObject *descriptor = NULL; + PyObject *result = NULL; + + static PyObject *bound_type_str = NULL; + static PyObject *function_str = NULL; + static PyObject *callable_str = NULL; + static PyObject *builtin_str = NULL; + static PyObject *class_str = NULL; + static PyObject *instancemethod_str = NULL; + + if (!bound_type_str) + { + bound_type_str = PyUnicode_InternFromString("__bound_function_wrapper__"); + } + + if (!function_str) + { + function_str = PyUnicode_InternFromString("function"); + callable_str = PyUnicode_InternFromString("callable"); + builtin_str = PyUnicode_InternFromString("builtin"); + class_str = PyUnicode_InternFromString("class"); + instancemethod_str = PyUnicode_InternFromString("instancemethod"); + } + + if (self->parent == Py_None) + { + if (self->binding == builtin_str || + PyObject_RichCompareBool(self->binding, builtin_str, Py_EQ) == 1) + { + Py_INCREF(self); + return (PyObject *)self; + } + + if (self->binding == class_str || + PyObject_RichCompareBool(self->binding, class_str, Py_EQ) == 1) + { + Py_INCREF(self); + return (PyObject *)self; + } + + if (Py_TYPE(self->object_proxy.wrapped)->tp_descr_get == NULL) + { + Py_INCREF(self); + return (PyObject *)self; + } + + descriptor = (Py_TYPE(self->object_proxy.wrapped)->tp_descr_get)( + self->object_proxy.wrapped, obj, type); + + if (!descriptor) + return NULL; - if (!bound_type_str) { -#if PY_MAJOR_VERSION >= 3 - bound_type_str = PyUnicode_InternFromString( - "__bound_function_wrapper__"); -#else - bound_type_str = PyString_InternFromString( - "__bound_function_wrapper__"); -#endif - } + if (Py_TYPE(self) != &WraptFunctionWrapper_Type) + { + bound_type = PyObject_GenericGetAttr((PyObject *)self, bound_type_str); - if (!function_str) { -#if PY_MAJOR_VERSION >= 3 - function_str = PyUnicode_InternFromString("function"); -#else - function_str = PyString_InternFromString("function"); -#endif + if (!bound_type) + PyErr_Clear(); } - if (self->parent == Py_None) { -#if PY_MAJOR_VERSION < 3 - if (PyObject_IsInstance(self->object_proxy.wrapped, - (PyObject *)&PyClass_Type) || PyObject_IsInstance( - self->object_proxy.wrapped, (PyObject *)&PyType_Type)) { - Py_INCREF(self); - return (PyObject *)self; - } -#else - if (PyObject_IsInstance(self->object_proxy.wrapped, - (PyObject *)&PyType_Type)) { - Py_INCREF(self); - return (PyObject *)self; - } -#endif - - if (Py_TYPE(self->object_proxy.wrapped)->tp_descr_get == NULL) { - PyErr_Format(PyExc_AttributeError, - "'%s' object has no attribute '__get__'", - Py_TYPE(self->object_proxy.wrapped)->tp_name); - return NULL; - } - - descriptor = (Py_TYPE(self->object_proxy.wrapped)->tp_descr_get)( - self->object_proxy.wrapped, obj, type); + if (obj == NULL) + obj = Py_None; - if (!descriptor) - return NULL; + result = PyObject_CallFunctionObjArgs( + bound_type ? bound_type : (PyObject *)&WraptBoundFunctionWrapper_Type, + descriptor, obj, self->wrapper, self->enabled, self->binding, self, + type, NULL); - if (Py_TYPE(self) != &WraptFunctionWrapper_Type) { - bound_type = PyObject_GenericGetAttr((PyObject *)self, - bound_type_str); - - if (!bound_type) - PyErr_Clear(); - } + Py_XDECREF(bound_type); + Py_DECREF(descriptor); - if (obj == NULL) - obj = Py_None; + return result; + } + + if (self->instance == Py_None && + (self->binding == function_str || + PyObject_RichCompareBool(self->binding, function_str, Py_EQ) == 1 || + self->binding == instancemethod_str || + PyObject_RichCompareBool(self->binding, instancemethod_str, Py_EQ) == + 1 || + self->binding == callable_str || + PyObject_RichCompareBool(self->binding, callable_str, Py_EQ) == 1)) + { - result = PyObject_CallFunctionObjArgs(bound_type ? bound_type : - (PyObject *)&WraptBoundFunctionWrapper_Type, descriptor, - obj, self->wrapper, self->enabled, self->binding, - self, NULL); + PyObject *wrapped = NULL; - Py_XDECREF(bound_type); - Py_DECREF(descriptor); + static PyObject *wrapped_str = NULL; - return result; + if (!wrapped_str) + { + wrapped_str = PyUnicode_InternFromString("__wrapped__"); } - if (self->instance == Py_None && (self->binding == function_str || - PyObject_RichCompareBool(self->binding, function_str, - Py_EQ) == 1)) { - - PyObject *wrapped = NULL; + wrapped = PyObject_GetAttr(self->parent, wrapped_str); - static PyObject *wrapped_str = NULL; - - if (!wrapped_str) { -#if PY_MAJOR_VERSION >= 3 - wrapped_str = PyUnicode_InternFromString("__wrapped__"); -#else - wrapped_str = PyString_InternFromString("__wrapped__"); -#endif - } - - wrapped = PyObject_GetAttr(self->parent, wrapped_str); + if (!wrapped) + return NULL; - if (!wrapped) - return NULL; - - if (Py_TYPE(wrapped)->tp_descr_get == NULL) { - PyErr_Format(PyExc_AttributeError, - "'%s' object has no attribute '__get__'", - Py_TYPE(wrapped)->tp_name); - Py_DECREF(wrapped); - return NULL; - } + if (Py_TYPE(wrapped)->tp_descr_get == NULL) + { + PyErr_Format(PyExc_AttributeError, + "'%s' object has no attribute '__get__'", + Py_TYPE(wrapped)->tp_name); + Py_DECREF(wrapped); + return NULL; + } - descriptor = (Py_TYPE(wrapped)->tp_descr_get)(wrapped, obj, type); + descriptor = (Py_TYPE(wrapped)->tp_descr_get)(wrapped, obj, type); - Py_DECREF(wrapped); + Py_DECREF(wrapped); - if (!descriptor) - return NULL; + if (!descriptor) + return NULL; - if (Py_TYPE(self->parent) != &WraptFunctionWrapper_Type) { - bound_type = PyObject_GenericGetAttr((PyObject *)self->parent, - bound_type_str); + if (Py_TYPE(self->parent) != &WraptFunctionWrapper_Type) + { + bound_type = + PyObject_GenericGetAttr((PyObject *)self->parent, bound_type_str); - if (!bound_type) - PyErr_Clear(); - } + if (!bound_type) + PyErr_Clear(); + } - if (obj == NULL) - obj = Py_None; + if (obj == NULL) + obj = Py_None; - result = PyObject_CallFunctionObjArgs(bound_type ? bound_type : - (PyObject *)&WraptBoundFunctionWrapper_Type, descriptor, - obj, self->wrapper, self->enabled, self->binding, - self->parent, NULL); + result = PyObject_CallFunctionObjArgs( + bound_type ? bound_type : (PyObject *)&WraptBoundFunctionWrapper_Type, + descriptor, obj, self->wrapper, self->enabled, self->binding, + self->parent, type, NULL); - Py_XDECREF(bound_type); - Py_DECREF(descriptor); + Py_XDECREF(bound_type); + Py_DECREF(descriptor); - return result; - } + return result; + } - Py_INCREF(self); - return (PyObject *)self; + Py_INCREF(self); + return (PyObject *)self; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptFunctionWrapperBase_set_name( - WraptFunctionWrapperObject *self, PyObject *args, PyObject *kwds) +static PyObject * +WraptFunctionWrapperBase_set_name(WraptFunctionWrapperObject *self, + PyObject *args, PyObject *kwds) { - PyObject *method = NULL; - PyObject *result = NULL; + PyObject *method = NULL; + PyObject *result = NULL; - if (!self->object_proxy.wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->object_proxy.wrapped) + { + if (raise_uninitialized_wrapper_error(&self->object_proxy) == -1) return NULL; - } + } - method = PyObject_GetAttrString(self->object_proxy.wrapped, - "__set_name__"); + method = PyObject_GetAttrString(self->object_proxy.wrapped, "__set_name__"); - if (!method) { - PyErr_Clear(); - Py_INCREF(Py_None); - return Py_None; - } + if (!method) + { + PyErr_Clear(); + Py_INCREF(Py_None); + return Py_None; + } - result = PyObject_Call(method, args, kwds); + result = PyObject_Call(method, args, kwds); - Py_DECREF(method); + Py_DECREF(method); - return result; + return result; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptFunctionWrapperBase_instancecheck( - WraptFunctionWrapperObject *self, PyObject *instance) +static PyObject * +WraptFunctionWrapperBase_instancecheck(WraptFunctionWrapperObject *self, + PyObject *instance) { - PyObject *result = NULL; + PyObject *result = NULL; - int check = 0; + int check = 0; - if (!self->object_proxy.wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - return NULL; - } + if (!self->object_proxy.wrapped) + { + if (raise_uninitialized_wrapper_error(&self->object_proxy) == -1) + return NULL; + } - check = PyObject_IsInstance(instance, self->object_proxy.wrapped); + check = PyObject_IsInstance(instance, self->object_proxy.wrapped); - if (check < 0) { - return NULL; - } + if (check < 0) + { + return NULL; + } - result = check ? Py_True : Py_False; + result = check ? Py_True : Py_False; - Py_INCREF(result); - return result; + Py_INCREF(result); + return result; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptFunctionWrapperBase_subclasscheck( - WraptFunctionWrapperObject *self, PyObject *args) +static PyObject * +WraptFunctionWrapperBase_subclasscheck(WraptFunctionWrapperObject *self, + PyObject *args) { - PyObject *subclass = NULL; - PyObject *object = NULL; - PyObject *result = NULL; + PyObject *subclass = NULL; + PyObject *object = NULL; + PyObject *result = NULL; - int check = 0; + int check = 0; - if (!self->object_proxy.wrapped) { - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + if (!self->object_proxy.wrapped) + { + if (raise_uninitialized_wrapper_error(&self->object_proxy) == -1) return NULL; - } + } - if (!PyArg_ParseTuple(args, "O", &subclass)) - return NULL; + if (!PyArg_ParseTuple(args, "O", &subclass)) + return NULL; - object = PyObject_GetAttrString(subclass, "__wrapped__"); + object = PyObject_GetAttrString(subclass, "__wrapped__"); - if (!object) - PyErr_Clear(); + if (!object) + PyErr_Clear(); - check = PyObject_IsSubclass(object ? object: subclass, - self->object_proxy.wrapped); + check = PyObject_IsSubclass(object ? object : subclass, + self->object_proxy.wrapped); - Py_XDECREF(object); + Py_XDECREF(object); - if (check == -1) - return NULL; + if (check == -1) + return NULL; - result = check ? Py_True : Py_False; + result = check ? Py_True : Py_False; - Py_INCREF(result); + Py_INCREF(result); - return result; + return result; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptFunctionWrapperBase_get_self_instance( - WraptFunctionWrapperObject *self, void *closure) +static PyObject * +WraptFunctionWrapperBase_get_self_instance(WraptFunctionWrapperObject *self, + void *closure) { - if (!self->instance) { - Py_INCREF(Py_None); - return Py_None; - } + if (!self->instance) + { + Py_INCREF(Py_None); + return Py_None; + } - Py_INCREF(self->instance); - return self->instance; + Py_INCREF(self->instance); + return self->instance; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptFunctionWrapperBase_get_self_wrapper( - WraptFunctionWrapperObject *self, void *closure) +static PyObject * +WraptFunctionWrapperBase_get_self_wrapper(WraptFunctionWrapperObject *self, + void *closure) { - if (!self->wrapper) { - Py_INCREF(Py_None); - return Py_None; - } + if (!self->wrapper) + { + Py_INCREF(Py_None); + return Py_None; + } - Py_INCREF(self->wrapper); - return self->wrapper; + Py_INCREF(self->wrapper); + return self->wrapper; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptFunctionWrapperBase_get_self_enabled( - WraptFunctionWrapperObject *self, void *closure) +static PyObject * +WraptFunctionWrapperBase_get_self_enabled(WraptFunctionWrapperObject *self, + void *closure) { - if (!self->enabled) { - Py_INCREF(Py_None); - return Py_None; - } + if (!self->enabled) + { + Py_INCREF(Py_None); + return Py_None; + } - Py_INCREF(self->enabled); - return self->enabled; + Py_INCREF(self->enabled); + return self->enabled; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptFunctionWrapperBase_get_self_binding( - WraptFunctionWrapperObject *self, void *closure) +static PyObject * +WraptFunctionWrapperBase_get_self_binding(WraptFunctionWrapperObject *self, + void *closure) { - if (!self->binding) { - Py_INCREF(Py_None); - return Py_None; - } + if (!self->binding) + { + Py_INCREF(Py_None); + return Py_None; + } - Py_INCREF(self->binding); - return self->binding; + Py_INCREF(self->binding); + return self->binding; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptFunctionWrapperBase_get_self_parent( - WraptFunctionWrapperObject *self, void *closure) +static PyObject * +WraptFunctionWrapperBase_get_self_parent(WraptFunctionWrapperObject *self, + void *closure) { - if (!self->parent) { - Py_INCREF(Py_None); - return Py_None; - } + if (!self->parent) + { + Py_INCREF(Py_None); + return Py_None; + } + + Py_INCREF(self->parent); + return self->parent; +} + +/* ------------------------------------------------------------------------- */ + +static PyObject * +WraptFunctionWrapperBase_get_self_owner(WraptFunctionWrapperObject *self, + void *closure) +{ + if (!self->owner) + { + Py_INCREF(Py_None); + return Py_None; + } - Py_INCREF(self->parent); - return self->parent; + Py_INCREF(self->owner); + return self->owner; } /* ------------------------------------------------------------------------- */; static PyMethodDef WraptFunctionWrapperBase_methods[] = { - { "__set_name__", (PyCFunction)WraptFunctionWrapperBase_set_name, - METH_VARARGS | METH_KEYWORDS, 0 }, - { "__instancecheck__", (PyCFunction)WraptFunctionWrapperBase_instancecheck, - METH_O, 0}, - { "__subclasscheck__", (PyCFunction)WraptFunctionWrapperBase_subclasscheck, - METH_VARARGS, 0 }, - { NULL, NULL }, + {"__set_name__", (PyCFunction)WraptFunctionWrapperBase_set_name, + METH_VARARGS | METH_KEYWORDS, 0}, + {"__instancecheck__", (PyCFunction)WraptFunctionWrapperBase_instancecheck, + METH_O, 0}, + {"__subclasscheck__", (PyCFunction)WraptFunctionWrapperBase_subclasscheck, + METH_VARARGS, 0}, + {NULL, NULL}, }; /* ------------------------------------------------------------------------- */; static PyGetSetDef WraptFunctionWrapperBase_getset[] = { - { "__module__", (getter)WraptObjectProxy_get_module, - (setter)WraptObjectProxy_set_module, 0 }, - { "__doc__", (getter)WraptObjectProxy_get_doc, - (setter)WraptObjectProxy_set_doc, 0 }, - { "_self_instance", (getter)WraptFunctionWrapperBase_get_self_instance, - NULL, 0 }, - { "_self_wrapper", (getter)WraptFunctionWrapperBase_get_self_wrapper, - NULL, 0 }, - { "_self_enabled", (getter)WraptFunctionWrapperBase_get_self_enabled, - NULL, 0 }, - { "_self_binding", (getter)WraptFunctionWrapperBase_get_self_binding, - NULL, 0 }, - { "_self_parent", (getter)WraptFunctionWrapperBase_get_self_parent, - NULL, 0 }, - { NULL }, + {"__module__", (getter)WraptObjectProxy_get_module, + (setter)WraptObjectProxy_set_module, 0}, + {"__doc__", (getter)WraptObjectProxy_get_doc, + (setter)WraptObjectProxy_set_doc, 0}, + {"_self_instance", (getter)WraptFunctionWrapperBase_get_self_instance, NULL, + 0}, + {"_self_wrapper", (getter)WraptFunctionWrapperBase_get_self_wrapper, NULL, + 0}, + {"_self_enabled", (getter)WraptFunctionWrapperBase_get_self_enabled, NULL, + 0}, + {"_self_binding", (getter)WraptFunctionWrapperBase_get_self_binding, NULL, + 0}, + {"_self_parent", (getter)WraptFunctionWrapperBase_get_self_parent, NULL, 0}, + {"_self_owner", (getter)WraptFunctionWrapperBase_get_self_owner, NULL, 0}, + {NULL}, }; PyTypeObject WraptFunctionWrapperBase_Type = { - PyVarObject_HEAD_INIT(NULL, 0) - "_FunctionWrapperBase", /*tp_name*/ - sizeof(WraptFunctionWrapperObject), /*tp_basicsize*/ - 0, /*tp_itemsize*/ + PyVarObject_HEAD_INIT(NULL, 0) "_FunctionWrapperBase", /*tp_name*/ + sizeof(WraptFunctionWrapperObject), /*tp_basicsize*/ + 0, /*tp_itemsize*/ /* methods */ - (destructor)WraptFunctionWrapperBase_dealloc, /*tp_dealloc*/ - 0, /*tp_print*/ - 0, /*tp_getattr*/ - 0, /*tp_setattr*/ - 0, /*tp_compare*/ - 0, /*tp_repr*/ - 0, /*tp_as_number*/ - 0, /*tp_as_sequence*/ - 0, /*tp_as_mapping*/ - 0, /*tp_hash*/ - (ternaryfunc)WraptFunctionWrapperBase_call, /*tp_call*/ - 0, /*tp_str*/ - 0, /*tp_getattro*/ - 0, /*tp_setattro*/ - 0, /*tp_as_buffer*/ -#if PY_MAJOR_VERSION < 3 - Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | - Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_CHECKTYPES, /*tp_flags*/ -#else - Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | - Py_TPFLAGS_HAVE_GC, /*tp_flags*/ -#endif - 0, /*tp_doc*/ - (traverseproc)WraptFunctionWrapperBase_traverse, /*tp_traverse*/ - (inquiry)WraptFunctionWrapperBase_clear, /*tp_clear*/ - 0, /*tp_richcompare*/ - offsetof(WraptObjectProxyObject, weakreflist), /*tp_weaklistoffset*/ - 0, /*tp_iter*/ - 0, /*tp_iternext*/ - WraptFunctionWrapperBase_methods, /*tp_methods*/ - 0, /*tp_members*/ - WraptFunctionWrapperBase_getset, /*tp_getset*/ - 0, /*tp_base*/ - 0, /*tp_dict*/ - (descrgetfunc)WraptFunctionWrapperBase_descr_get, /*tp_descr_get*/ - 0, /*tp_descr_set*/ - 0, /*tp_dictoffset*/ - (initproc)WraptFunctionWrapperBase_init, /*tp_init*/ - 0, /*tp_alloc*/ - WraptFunctionWrapperBase_new, /*tp_new*/ - 0, /*tp_free*/ - 0, /*tp_is_gc*/ + (destructor)WraptFunctionWrapperBase_dealloc, /*tp_dealloc*/ + 0, /*tp_print*/ + 0, /*tp_getattr*/ + 0, /*tp_setattr*/ + 0, /*tp_compare*/ + 0, /*tp_repr*/ + 0, /*tp_as_number*/ + 0, /*tp_as_sequence*/ + 0, /*tp_as_mapping*/ + 0, /*tp_hash*/ + (ternaryfunc)WraptFunctionWrapperBase_call, /*tp_call*/ + 0, /*tp_str*/ + 0, /*tp_getattro*/ + 0, /*tp_setattro*/ + 0, /*tp_as_buffer*/ + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, /*tp_flags*/ + 0, /*tp_doc*/ + (traverseproc)WraptFunctionWrapperBase_traverse, /*tp_traverse*/ + (inquiry)WraptFunctionWrapperBase_clear, /*tp_clear*/ + 0, /*tp_richcompare*/ + offsetof(WraptObjectProxyObject, weakreflist), /*tp_weaklistoffset*/ + 0, /*tp_iter*/ + 0, /*tp_iternext*/ + WraptFunctionWrapperBase_methods, /*tp_methods*/ + 0, /*tp_members*/ + WraptFunctionWrapperBase_getset, /*tp_getset*/ + 0, /*tp_base*/ + 0, /*tp_dict*/ + (descrgetfunc)WraptFunctionWrapperBase_descr_get, /*tp_descr_get*/ + 0, /*tp_descr_set*/ + 0, /*tp_dictoffset*/ + (initproc)WraptFunctionWrapperBase_init, /*tp_init*/ + 0, /*tp_alloc*/ + WraptFunctionWrapperBase_new, /*tp_new*/ + 0, /*tp_free*/ + 0, /*tp_is_gc*/ }; /* ------------------------------------------------------------------------- */ -static PyObject *WraptBoundFunctionWrapper_call( - WraptFunctionWrapperObject *self, PyObject *args, PyObject *kwds) +static PyObject * +WraptBoundFunctionWrapper_call(WraptFunctionWrapperObject *self, PyObject *args, + PyObject *kwds) { - PyObject *param_args = NULL; - PyObject *param_kwds = NULL; - - PyObject *wrapped = NULL; - PyObject *instance = NULL; - - PyObject *result = NULL; - - static PyObject *function_str = NULL; - - if (self->enabled != Py_None) { - if (PyCallable_Check(self->enabled)) { - PyObject *object = NULL; - - object = PyObject_CallFunctionObjArgs(self->enabled, NULL); - - if (!object) - return NULL; - - if (PyObject_Not(object)) { - Py_DECREF(object); - return PyObject_Call(self->object_proxy.wrapped, args, kwds); - } + PyObject *param_args = NULL; + PyObject *param_kwds = NULL; - Py_DECREF(object); - } - else if (PyObject_Not(self->enabled)) { - return PyObject_Call(self->object_proxy.wrapped, args, kwds); - } - } - - if (!function_str) { -#if PY_MAJOR_VERSION >= 3 - function_str = PyUnicode_InternFromString("function"); -#else - function_str = PyString_InternFromString("function"); -#endif - } + PyObject *wrapped = NULL; + PyObject *instance = NULL; - /* - * We need to do things different depending on whether we are likely - * wrapping an instance method vs a static method or class method. - */ + PyObject *result = NULL; - if (self->binding == function_str || PyObject_RichCompareBool( - self->binding, function_str, Py_EQ) == 1) { + static PyObject *function_str = NULL; + static PyObject *callable_str = NULL; - if (self->instance == Py_None) { - /* - * This situation can occur where someone is calling the - * instancemethod via the class type and passing the - * instance as the first argument. We need to shift the args - * before making the call to the wrapper and effectively - * bind the instance to the wrapped function using a partial - * so the wrapper doesn't see anything as being different. - */ + if (self->enabled != Py_None) + { + if (PyCallable_Check(self->enabled)) + { + PyObject *object = NULL; - if (PyTuple_Size(args) == 0) { - PyErr_SetString(PyExc_TypeError, - "missing 1 required positional argument"); - return NULL; - } + object = PyObject_CallFunctionObjArgs(self->enabled, NULL); - instance = PyTuple_GetItem(args, 0); - - if (!instance) - return NULL; + if (!object) + return NULL; - wrapped = PyObject_CallFunctionObjArgs( - (PyObject *)&WraptPartialCallableObjectProxy_Type, - self->object_proxy.wrapped, instance, NULL); + if (PyObject_Not(object)) + { + Py_DECREF(object); + return PyObject_Call(self->object_proxy.wrapped, args, kwds); + } + + Py_DECREF(object); + } + else if (PyObject_Not(self->enabled)) + { + return PyObject_Call(self->object_proxy.wrapped, args, kwds); + } + } + + if (!function_str) + { + function_str = PyUnicode_InternFromString("function"); + callable_str = PyUnicode_InternFromString("callable"); + } + + /* + * We need to do things different depending on whether we are likely + * wrapping an instance method vs a static method or class method. + */ + + if (self->binding == function_str || + PyObject_RichCompareBool(self->binding, function_str, Py_EQ) == 1 || + self->binding == callable_str || + PyObject_RichCompareBool(self->binding, callable_str, Py_EQ) == 1) + { + + // if (self->instance == Py_None) { + // /* + // * This situation can occur where someone is calling the + // * instancemethod via the class type and passing the + // * instance as the first argument. We need to shift the args + // * before making the call to the wrapper and effectively + // * bind the instance to the wrapped function using a partial + // * so the wrapper doesn't see anything as being different. + // */ + + // if (PyTuple_Size(args) == 0) { + // PyErr_SetString(PyExc_TypeError, + // "missing 1 required positional argument"); + // return NULL; + // } + + // instance = PyTuple_GetItem(args, 0); + + // if (!instance) + // return NULL; + + // wrapped = PyObject_CallFunctionObjArgs( + // (PyObject *)&WraptPartialCallableObjectProxy_Type, + // self->object_proxy.wrapped, instance, NULL); + + // if (!wrapped) + // return NULL; + + // param_args = PyTuple_GetSlice(args, 1, PyTuple_Size(args)); + + // if (!param_args) { + // Py_DECREF(wrapped); + // return NULL; + // } + + // args = param_args; + // } + + if (self->instance == Py_None && PyTuple_Size(args) != 0) + { + /* + * This situation can occur where someone is calling the + * instancemethod via the class type and passing the + * instance as the first argument. We need to shift the args + * before making the call to the wrapper and effectively + * bind the instance to the wrapped function using a partial + * so the wrapper doesn't see anything as being different. + */ + + instance = PyTuple_GetItem(args, 0); + + if (!instance) + return NULL; - if (!wrapped) - return NULL; + if (PyObject_IsInstance(instance, self->owner) == 1) + { + wrapped = PyObject_CallFunctionObjArgs( + (PyObject *)&WraptPartialCallableObjectProxy_Type, + self->object_proxy.wrapped, instance, NULL); - param_args = PyTuple_GetSlice(args, 1, PyTuple_Size(args)); + if (!wrapped) + return NULL; - if (!param_args) { - Py_DECREF(wrapped); - return NULL; - } + param_args = PyTuple_GetSlice(args, 1, PyTuple_Size(args)); - args = param_args; + if (!param_args) + { + Py_DECREF(wrapped); + return NULL; } - else - instance = self->instance; - if (!wrapped) { - Py_INCREF(self->object_proxy.wrapped); - wrapped = self->object_proxy.wrapped; - } + args = param_args; + } + else + { + instance = self->instance; + } + } + else + { + instance = self->instance; + } - if (!kwds) { - param_kwds = PyDict_New(); - kwds = param_kwds; - } + if (!wrapped) + { + Py_INCREF(self->object_proxy.wrapped); + wrapped = self->object_proxy.wrapped; + } - result = PyObject_CallFunctionObjArgs(self->wrapper, wrapped, - instance, args, kwds, NULL); - - Py_XDECREF(param_args); - Py_XDECREF(param_kwds); - Py_DECREF(wrapped); - - return result; - } - else { - /* - * As in this case we would be dealing with a classmethod or - * staticmethod, then _self_instance will only tell us whether - * when calling the classmethod or staticmethod they did it via - * an instance of the class it is bound to and not the case - * where done by the class type itself. We thus ignore - * _self_instance and use the __self__ attribute of the bound - * function instead. For a classmethod, this means instance will - * be the class type and for a staticmethod it will be None. - * This is probably the more useful thing we can pass through - * even though we loose knowledge of whether they were called on - * the instance vs the class type, as it reflects what they have - * available in the decoratored function. - */ - - instance = PyObject_GetAttrString(self->object_proxy.wrapped, - "__self__"); - - if (!instance) { - PyErr_Clear(); - Py_INCREF(Py_None); - instance = Py_None; - } + if (!kwds) + { + param_kwds = PyDict_New(); + kwds = param_kwds; + } - if (!kwds) { - param_kwds = PyDict_New(); - kwds = param_kwds; - } + result = PyObject_CallFunctionObjArgs(self->wrapper, wrapped, instance, + args, kwds, NULL); + + Py_XDECREF(param_args); + Py_XDECREF(param_kwds); + Py_DECREF(wrapped); - result = PyObject_CallFunctionObjArgs(self->wrapper, - self->object_proxy.wrapped, instance, args, kwds, NULL); + return result; + } + else + { + /* + * As in this case we would be dealing with a classmethod or + * staticmethod, then _self_instance will only tell us whether + * when calling the classmethod or staticmethod they did it via + * an instance of the class it is bound to and not the case + * where done by the class type itself. We thus ignore + * _self_instance and use the __self__ attribute of the bound + * function instead. For a classmethod, this means instance will + * be the class type and for a staticmethod it will be None. + * This is probably the more useful thing we can pass through + * even though we loose knowledge of whether they were called on + * the instance vs the class type, as it reflects what they have + * available in the decoratored function. + */ + + instance = PyObject_GetAttrString(self->object_proxy.wrapped, "__self__"); + + if (!instance) + { + PyErr_Clear(); + Py_INCREF(Py_None); + instance = Py_None; + } + + if (!kwds) + { + param_kwds = PyDict_New(); + kwds = param_kwds; + } + + result = PyObject_CallFunctionObjArgs( + self->wrapper, self->object_proxy.wrapped, instance, args, kwds, NULL); - Py_XDECREF(param_kwds); + Py_XDECREF(param_kwds); - Py_DECREF(instance); + Py_DECREF(instance); - return result; - } + return result; + } } /* ------------------------------------------------------------------------- */ static PyGetSetDef WraptBoundFunctionWrapper_getset[] = { - { "__module__", (getter)WraptObjectProxy_get_module, - (setter)WraptObjectProxy_set_module, 0 }, - { "__doc__", (getter)WraptObjectProxy_get_doc, - (setter)WraptObjectProxy_set_doc, 0 }, - { NULL }, + {"__module__", (getter)WraptObjectProxy_get_module, + (setter)WraptObjectProxy_set_module, 0}, + {"__doc__", (getter)WraptObjectProxy_get_doc, + (setter)WraptObjectProxy_set_doc, 0}, + {NULL}, }; PyTypeObject WraptBoundFunctionWrapper_Type = { - PyVarObject_HEAD_INIT(NULL, 0) - "BoundFunctionWrapper", /*tp_name*/ - sizeof(WraptFunctionWrapperObject), /*tp_basicsize*/ - 0, /*tp_itemsize*/ + PyVarObject_HEAD_INIT(NULL, 0) "BoundFunctionWrapper", /*tp_name*/ + sizeof(WraptFunctionWrapperObject), /*tp_basicsize*/ + 0, /*tp_itemsize*/ /* methods */ - 0, /*tp_dealloc*/ - 0, /*tp_print*/ - 0, /*tp_getattr*/ - 0, /*tp_setattr*/ - 0, /*tp_compare*/ - 0, /*tp_repr*/ - 0, /*tp_as_number*/ - 0, /*tp_as_sequence*/ - 0, /*tp_as_mapping*/ - 0, /*tp_hash*/ - (ternaryfunc)WraptBoundFunctionWrapper_call, /*tp_call*/ - 0, /*tp_str*/ - 0, /*tp_getattro*/ - 0, /*tp_setattro*/ - 0, /*tp_as_buffer*/ -#if PY_MAJOR_VERSION < 3 - Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_CHECKTYPES, /*tp_flags*/ -#else - Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ -#endif - 0, /*tp_doc*/ - 0, /*tp_traverse*/ - 0, /*tp_clear*/ - 0, /*tp_richcompare*/ + 0, /*tp_dealloc*/ + 0, /*tp_print*/ + 0, /*tp_getattr*/ + 0, /*tp_setattr*/ + 0, /*tp_compare*/ + 0, /*tp_repr*/ + 0, /*tp_as_number*/ + 0, /*tp_as_sequence*/ + 0, /*tp_as_mapping*/ + 0, /*tp_hash*/ + (ternaryfunc)WraptBoundFunctionWrapper_call, /*tp_call*/ + 0, /*tp_str*/ + 0, /*tp_getattro*/ + 0, /*tp_setattro*/ + 0, /*tp_as_buffer*/ + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ + 0, /*tp_doc*/ + 0, /*tp_traverse*/ + 0, /*tp_clear*/ + 0, /*tp_richcompare*/ offsetof(WraptObjectProxyObject, weakreflist), /*tp_weaklistoffset*/ - 0, /*tp_iter*/ - 0, /*tp_iternext*/ - 0, /*tp_methods*/ - 0, /*tp_members*/ - WraptBoundFunctionWrapper_getset, /*tp_getset*/ - 0, /*tp_base*/ - 0, /*tp_dict*/ - 0, /*tp_descr_get*/ - 0, /*tp_descr_set*/ - 0, /*tp_dictoffset*/ - 0, /*tp_init*/ - 0, /*tp_alloc*/ - 0, /*tp_new*/ - 0, /*tp_free*/ - 0, /*tp_is_gc*/ + 0, /*tp_iter*/ + 0, /*tp_iternext*/ + 0, /*tp_methods*/ + 0, /*tp_members*/ + WraptBoundFunctionWrapper_getset, /*tp_getset*/ + 0, /*tp_base*/ + 0, /*tp_dict*/ + 0, /*tp_descr_get*/ + 0, /*tp_descr_set*/ + 0, /*tp_dictoffset*/ + 0, /*tp_init*/ + 0, /*tp_alloc*/ + 0, /*tp_new*/ + 0, /*tp_free*/ + 0, /*tp_is_gc*/ }; /* ------------------------------------------------------------------------- */ static int WraptFunctionWrapper_init(WraptFunctionWrapperObject *self, - PyObject *args, PyObject *kwds) + PyObject *args, PyObject *kwds) { - PyObject *wrapped = NULL; - PyObject *wrapper = NULL; - PyObject *enabled = Py_None; - PyObject *binding = NULL; - PyObject *instance = NULL; - - static PyObject *classmethod_str = NULL; - static PyObject *staticmethod_str = NULL; - static PyObject *function_str = NULL; - - int result = 0; - - static char *kwlist[] = { "wrapped", "wrapper", "enabled", NULL }; - - if (!PyArg_ParseTupleAndKeywords(args, kwds, "OO|O:FunctionWrapper", - kwlist, &wrapped, &wrapper, &enabled)) { - return -1; - } - - if (!classmethod_str) { -#if PY_MAJOR_VERSION >= 3 - classmethod_str = PyUnicode_InternFromString("classmethod"); -#else - classmethod_str = PyString_InternFromString("classmethod"); -#endif - } - - if (!staticmethod_str) { -#if PY_MAJOR_VERSION >= 3 - staticmethod_str = PyUnicode_InternFromString("staticmethod"); -#else - staticmethod_str = PyString_InternFromString("staticmethod"); -#endif - } - - if (!function_str) { -#if PY_MAJOR_VERSION >= 3 - function_str = PyUnicode_InternFromString("function"); -#else - function_str = PyString_InternFromString("function"); -#endif - } - - if (PyObject_IsInstance(wrapped, (PyObject *)&PyClassMethod_Type)) { + PyObject *wrapped = NULL; + PyObject *wrapper = NULL; + PyObject *enabled = Py_None; + PyObject *binding = NULL; + PyObject *instance = NULL; + + static PyObject *function_str = NULL; + static PyObject *classmethod_str = NULL; + static PyObject *staticmethod_str = NULL; + static PyObject *callable_str = NULL; + static PyObject *builtin_str = NULL; + static PyObject *class_str = NULL; + static PyObject *instancemethod_str = NULL; + + int result = 0; + + char *const kwlist[] = {"wrapped", "wrapper", "enabled", NULL}; + + if (!PyArg_ParseTupleAndKeywords(args, kwds, "OO|O:FunctionWrapper", kwlist, + &wrapped, &wrapper, &enabled)) + { + return -1; + } + + if (!function_str) + { + function_str = PyUnicode_InternFromString("function"); + } + + if (!classmethod_str) + { + classmethod_str = PyUnicode_InternFromString("classmethod"); + } + + if (!staticmethod_str) + { + staticmethod_str = PyUnicode_InternFromString("staticmethod"); + } + + if (!callable_str) + { + callable_str = PyUnicode_InternFromString("callable"); + } + + if (!builtin_str) + { + builtin_str = PyUnicode_InternFromString("builtin"); + } + + if (!class_str) + { + class_str = PyUnicode_InternFromString("class"); + } + + if (!instancemethod_str) + { + instancemethod_str = PyUnicode_InternFromString("instancemethod"); + } + + if (PyObject_IsInstance(wrapped, + (PyObject *)&WraptFunctionWrapperBase_Type)) + { + binding = PyObject_GetAttrString(wrapped, "_self_binding"); + } + + if (!binding) + { + if (PyCFunction_Check(wrapped)) + { + binding = builtin_str; + } + else if (PyObject_IsInstance(wrapped, (PyObject *)&PyFunction_Type)) + { + binding = function_str; + } + else if (PyObject_IsInstance(wrapped, (PyObject *)&PyClassMethod_Type)) + { + binding = classmethod_str; + } + else if (PyObject_IsInstance(wrapped, (PyObject *)&PyType_Type)) + { + binding = class_str; + } + else if (PyObject_IsInstance(wrapped, (PyObject *)&PyStaticMethod_Type)) + { + binding = staticmethod_str; + } + else if ((instance = PyObject_GetAttrString(wrapped, "__self__")) != 0) + { + if (PyObject_IsInstance(instance, (PyObject *)&PyType_Type)) + { binding = classmethod_str; - } - else if (PyObject_IsInstance(wrapped, (PyObject *)&PyStaticMethod_Type)) { - binding = staticmethod_str; - } - else if ((instance = PyObject_GetAttrString(wrapped, "__self__")) != 0) { -#if PY_MAJOR_VERSION < 3 - if (PyObject_IsInstance(instance, (PyObject *)&PyClass_Type) || - PyObject_IsInstance(instance, (PyObject *)&PyType_Type)) { - binding = classmethod_str; - } -#else - if (PyObject_IsInstance(instance, (PyObject *)&PyType_Type)) { - binding = classmethod_str; - } -#endif - else - binding = function_str; + } + else if (PyObject_IsInstance(wrapped, (PyObject *)&PyMethod_Type)) + { + binding = instancemethod_str; + } + else + binding = callable_str; - Py_DECREF(instance); + Py_DECREF(instance); } - else { - PyErr_Clear(); + else + { + PyErr_Clear(); - binding = function_str; + binding = callable_str; } + } - result = WraptFunctionWrapperBase_raw_init(self, wrapped, Py_None, - wrapper, enabled, binding, Py_None); + result = WraptFunctionWrapperBase_raw_init( + self, wrapped, Py_None, wrapper, enabled, binding, Py_None, Py_None); - return result; + return result; } /* ------------------------------------------------------------------------- */ static PyGetSetDef WraptFunctionWrapper_getset[] = { - { "__module__", (getter)WraptObjectProxy_get_module, - (setter)WraptObjectProxy_set_module, 0 }, - { "__doc__", (getter)WraptObjectProxy_get_doc, - (setter)WraptObjectProxy_set_doc, 0 }, - { NULL }, + {"__module__", (getter)WraptObjectProxy_get_module, + (setter)WraptObjectProxy_set_module, 0}, + {"__doc__", (getter)WraptObjectProxy_get_doc, + (setter)WraptObjectProxy_set_doc, 0}, + {NULL}, }; PyTypeObject WraptFunctionWrapper_Type = { - PyVarObject_HEAD_INIT(NULL, 0) - "FunctionWrapper", /*tp_name*/ - sizeof(WraptFunctionWrapperObject), /*tp_basicsize*/ - 0, /*tp_itemsize*/ + PyVarObject_HEAD_INIT(NULL, 0) "FunctionWrapper", /*tp_name*/ + sizeof(WraptFunctionWrapperObject), /*tp_basicsize*/ + 0, /*tp_itemsize*/ /* methods */ - 0, /*tp_dealloc*/ - 0, /*tp_print*/ - 0, /*tp_getattr*/ - 0, /*tp_setattr*/ - 0, /*tp_compare*/ - 0, /*tp_repr*/ - 0, /*tp_as_number*/ - 0, /*tp_as_sequence*/ - 0, /*tp_as_mapping*/ - 0, /*tp_hash*/ - 0, /*tp_call*/ - 0, /*tp_str*/ - 0, /*tp_getattro*/ - 0, /*tp_setattro*/ - 0, /*tp_as_buffer*/ -#if PY_MAJOR_VERSION < 3 - Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_CHECKTYPES, /*tp_flags*/ -#else - Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ -#endif - 0, /*tp_doc*/ - 0, /*tp_traverse*/ - 0, /*tp_clear*/ - 0, /*tp_richcompare*/ + 0, /*tp_dealloc*/ + 0, /*tp_print*/ + 0, /*tp_getattr*/ + 0, /*tp_setattr*/ + 0, /*tp_compare*/ + 0, /*tp_repr*/ + 0, /*tp_as_number*/ + 0, /*tp_as_sequence*/ + 0, /*tp_as_mapping*/ + 0, /*tp_hash*/ + 0, /*tp_call*/ + 0, /*tp_str*/ + 0, /*tp_getattro*/ + 0, /*tp_setattro*/ + 0, /*tp_as_buffer*/ + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ + 0, /*tp_doc*/ + 0, /*tp_traverse*/ + 0, /*tp_clear*/ + 0, /*tp_richcompare*/ offsetof(WraptObjectProxyObject, weakreflist), /*tp_weaklistoffset*/ - 0, /*tp_iter*/ - 0, /*tp_iternext*/ - 0, /*tp_methods*/ - 0, /*tp_members*/ - WraptFunctionWrapper_getset, /*tp_getset*/ - 0, /*tp_base*/ - 0, /*tp_dict*/ - 0, /*tp_descr_get*/ - 0, /*tp_descr_set*/ - 0, /*tp_dictoffset*/ - (initproc)WraptFunctionWrapper_init, /*tp_init*/ - 0, /*tp_alloc*/ - 0, /*tp_new*/ - 0, /*tp_free*/ - 0, /*tp_is_gc*/ + 0, /*tp_iter*/ + 0, /*tp_iternext*/ + 0, /*tp_methods*/ + 0, /*tp_members*/ + WraptFunctionWrapper_getset, /*tp_getset*/ + 0, /*tp_base*/ + 0, /*tp_dict*/ + 0, /*tp_descr_get*/ + 0, /*tp_descr_set*/ + 0, /*tp_dictoffset*/ + (initproc)WraptFunctionWrapper_init, /*tp_init*/ + 0, /*tp_alloc*/ + 0, /*tp_new*/ + 0, /*tp_free*/ + 0, /*tp_is_gc*/ }; /* ------------------------------------------------------------------------- */ -#if PY_MAJOR_VERSION >= 3 static struct PyModuleDef moduledef = { PyModuleDef_HEAD_INIT, - "_wrappers", /* m_name */ - NULL, /* m_doc */ - -1, /* m_size */ - NULL, /* m_methods */ - NULL, /* m_reload */ - NULL, /* m_traverse */ - NULL, /* m_clear */ - NULL, /* m_free */ + "_wrappers", /* m_name */ + NULL, /* m_doc */ + -1, /* m_size */ + NULL, /* m_methods */ + NULL, /* m_reload */ + NULL, /* m_traverse */ + NULL, /* m_clear */ + NULL, /* m_free */ }; -#endif -static PyObject * -moduleinit(void) +static PyObject *moduleinit(void) { - PyObject *module; - -#if PY_MAJOR_VERSION >= 3 - module = PyModule_Create(&moduledef); -#else - module = Py_InitModule3("_wrappers", NULL, NULL); -#endif + PyObject *module; - if (module == NULL) - return NULL; + module = PyModule_Create(&moduledef); - if (PyType_Ready(&WraptObjectProxy_Type) < 0) - return NULL; + if (module == NULL) + return NULL; - /* Ensure that inheritance relationships specified. */ + if (PyType_Ready(&WraptObjectProxy_Type) < 0) + return NULL; - WraptCallableObjectProxy_Type.tp_base = &WraptObjectProxy_Type; - WraptPartialCallableObjectProxy_Type.tp_base = &WraptObjectProxy_Type; - WraptFunctionWrapperBase_Type.tp_base = &WraptObjectProxy_Type; - WraptBoundFunctionWrapper_Type.tp_base = &WraptFunctionWrapperBase_Type; - WraptFunctionWrapper_Type.tp_base = &WraptFunctionWrapperBase_Type; + /* Ensure that inheritance relationships specified. */ - if (PyType_Ready(&WraptCallableObjectProxy_Type) < 0) - return NULL; - if (PyType_Ready(&WraptPartialCallableObjectProxy_Type) < 0) - return NULL; - if (PyType_Ready(&WraptFunctionWrapperBase_Type) < 0) - return NULL; - if (PyType_Ready(&WraptBoundFunctionWrapper_Type) < 0) - return NULL; - if (PyType_Ready(&WraptFunctionWrapper_Type) < 0) - return NULL; + WraptCallableObjectProxy_Type.tp_base = &WraptObjectProxy_Type; + WraptPartialCallableObjectProxy_Type.tp_base = &WraptObjectProxy_Type; + WraptFunctionWrapperBase_Type.tp_base = &WraptObjectProxy_Type; + WraptBoundFunctionWrapper_Type.tp_base = &WraptFunctionWrapperBase_Type; + WraptFunctionWrapper_Type.tp_base = &WraptFunctionWrapperBase_Type; - Py_INCREF(&WraptObjectProxy_Type); - PyModule_AddObject(module, "ObjectProxy", - (PyObject *)&WraptObjectProxy_Type); - Py_INCREF(&WraptCallableObjectProxy_Type); - PyModule_AddObject(module, "CallableObjectProxy", - (PyObject *)&WraptCallableObjectProxy_Type); - PyModule_AddObject(module, "PartialCallableObjectProxy", - (PyObject *)&WraptPartialCallableObjectProxy_Type); - Py_INCREF(&WraptFunctionWrapper_Type); - PyModule_AddObject(module, "FunctionWrapper", - (PyObject *)&WraptFunctionWrapper_Type); + if (PyType_Ready(&WraptCallableObjectProxy_Type) < 0) + return NULL; + if (PyType_Ready(&WraptPartialCallableObjectProxy_Type) < 0) + return NULL; + if (PyType_Ready(&WraptFunctionWrapperBase_Type) < 0) + return NULL; + if (PyType_Ready(&WraptBoundFunctionWrapper_Type) < 0) + return NULL; + if (PyType_Ready(&WraptFunctionWrapper_Type) < 0) + return NULL; - Py_INCREF(&WraptFunctionWrapperBase_Type); - PyModule_AddObject(module, "_FunctionWrapperBase", - (PyObject *)&WraptFunctionWrapperBase_Type); - Py_INCREF(&WraptBoundFunctionWrapper_Type); - PyModule_AddObject(module, "BoundFunctionWrapper", - (PyObject *)&WraptBoundFunctionWrapper_Type); + Py_INCREF(&WraptObjectProxy_Type); + PyModule_AddObject(module, "ObjectProxy", (PyObject *)&WraptObjectProxy_Type); + Py_INCREF(&WraptCallableObjectProxy_Type); + PyModule_AddObject(module, "CallableObjectProxy", + (PyObject *)&WraptCallableObjectProxy_Type); + Py_INCREF(&WraptPartialCallableObjectProxy_Type); + PyModule_AddObject(module, "PartialCallableObjectProxy", + (PyObject *)&WraptPartialCallableObjectProxy_Type); + Py_INCREF(&WraptFunctionWrapper_Type); + PyModule_AddObject(module, "FunctionWrapper", + (PyObject *)&WraptFunctionWrapper_Type); + + Py_INCREF(&WraptFunctionWrapperBase_Type); + PyModule_AddObject(module, "_FunctionWrapperBase", + (PyObject *)&WraptFunctionWrapperBase_Type); + Py_INCREF(&WraptBoundFunctionWrapper_Type); + PyModule_AddObject(module, "BoundFunctionWrapper", + (PyObject *)&WraptBoundFunctionWrapper_Type); + +#ifdef Py_GIL_DISABLED + PyUnstable_Module_SetGIL(module, Py_MOD_GIL_NOT_USED); +#endif - return module; + return module; } -#if PY_MAJOR_VERSION < 3 -PyMODINIT_FUNC init_wrappers(void) -{ - moduleinit(); -} -#else -PyMODINIT_FUNC PyInit__wrappers(void) -{ - return moduleinit(); -} -#endif +PyMODINIT_FUNC PyInit__wrappers(void) { return moduleinit(); } /* ------------------------------------------------------------------------- */ diff --git a/newrelic/packages/wrapt/arguments.py b/newrelic/packages/wrapt/arguments.py index 032bc059e0..554f62cd28 100644 --- a/newrelic/packages/wrapt/arguments.py +++ b/newrelic/packages/wrapt/arguments.py @@ -1,16 +1,35 @@ -# The inspect.formatargspec() function was dropped in Python 3.11 but we need -# need it for when constructing signature changing decorators based on result of -# inspect.getargspec() or inspect.getfullargspec(). The code here implements -# inspect.formatargspec() base on Parameter and Signature from inspect module, -# which were added in Python 3.6. Thanks to Cyril Jouve for the implementation. +"""The inspect.formatargspec() function was dropped in Python 3.11 but we need +it for when constructing signature changing decorators based on result of +inspect.getfullargspec(). The code here implements inspect.formatargspec() based +on Parameter and Signature from inspect module, which were added in Python 3.6. +Thanks to Cyril Jouve for the implementation. +""" + +from typing import Any, Callable, List, Mapping, Optional, Sequence, Tuple try: from inspect import Parameter, Signature except ImportError: - from inspect import formatargspec + from inspect import formatargspec # type: ignore[attr-defined] else: - def formatargspec(args, varargs=None, varkw=None, defaults=None, - kwonlyargs=(), kwonlydefaults={}, annotations={}): + + def formatargspec( + args: List[str], + varargs: Optional[str] = None, + varkw: Optional[str] = None, + defaults: Optional[Tuple[Any, ...]] = None, + kwonlyargs: Optional[Sequence[str]] = None, + kwonlydefaults: Optional[Mapping[str, Any]] = None, + annotations: Mapping[str, Any] = {}, + formatarg: Callable[[str], str] = str, + formatvarargs: Callable[[str], str] = lambda name: "*" + name, + formatvarkw: Callable[[str], str] = lambda name: "**" + name, + formatvalue: Callable[[Any], str] = lambda value: "=" + repr(value), + formatreturns: Callable[[Any], str] = lambda text: " -> " + text, + formatannotation: Callable[[Any], str] = lambda annot: " -> " + repr(annot), + ) -> str: + if kwonlyargs is None: + kwonlyargs = () if kwonlydefaults is None: kwonlydefaults = {} ndefaults = len(defaults) if defaults else 0 @@ -18,9 +37,10 @@ def formatargspec(args, varargs=None, varkw=None, defaults=None, Parameter( arg, Parameter.POSITIONAL_OR_KEYWORD, - default=defaults[i] if i >= 0 else Parameter.empty, + default=defaults[i] if defaults and i >= 0 else Parameter.empty, annotation=annotations.get(arg, Parameter.empty), - ) for i, arg in enumerate(args, ndefaults - len(args)) + ) + for i, arg in enumerate(args, ndefaults - len(args)) ] if varargs: parameters.append(Parameter(varargs, Parameter.VAR_POSITIONAL)) @@ -30,9 +50,10 @@ def formatargspec(args, varargs=None, varkw=None, defaults=None, Parameter.KEYWORD_ONLY, default=kwonlydefaults.get(kwonlyarg, Parameter.empty), annotation=annotations.get(kwonlyarg, Parameter.empty), - ) for kwonlyarg in kwonlyargs + ) + for kwonlyarg in kwonlyargs ) if varkw: parameters.append(Parameter(varkw, Parameter.VAR_KEYWORD)) - return_annotation = annotations.get('return', Signature.empty) - return str(Signature(parameters, return_annotation=return_annotation)) \ No newline at end of file + return_annotation = annotations.get("return", Signature.empty) + return str(Signature(parameters, return_annotation=return_annotation)) diff --git a/newrelic/packages/wrapt/decorators.py b/newrelic/packages/wrapt/decorators.py index c80a4bb72e..6f5cedd2a4 100644 --- a/newrelic/packages/wrapt/decorators.py +++ b/newrelic/packages/wrapt/decorators.py @@ -4,51 +4,18 @@ """ import sys - -PY2 = sys.version_info[0] == 2 - -if PY2: - string_types = basestring, - - def exec_(_code_, _globs_=None, _locs_=None): - """Execute code in a namespace.""" - if _globs_ is None: - frame = sys._getframe(1) - _globs_ = frame.f_globals - if _locs_ is None: - _locs_ = frame.f_locals - del frame - elif _locs_ is None: - _locs_ = _globs_ - exec("""exec _code_ in _globs_, _locs_""") - -else: - string_types = str, - - import builtins - - exec_ = getattr(builtins, "exec") - del builtins - from functools import partial -from inspect import isclass +from inspect import isclass, signature from threading import Lock, RLock +from .__wrapt__ import BoundFunctionWrapper, CallableObjectProxy, FunctionWrapper from .arguments import formatargspec -try: - from inspect import signature -except ImportError: - pass - -from .__wrapt__ import (FunctionWrapper, BoundFunctionWrapper, ObjectProxy, - CallableObjectProxy) - # Adapter wrapper for the wrapped function which will overlay certain # properties from the adapter function onto the wrapped function so that -# functions such as inspect.getargspec(), inspect.getfullargspec(), -# inspect.signature() and inspect.getsource() return the correct results -# one would expect. +# functions such as inspect.getfullargspec(), inspect.signature() and +# inspect.getsource() return the correct results one would expect. + class _AdapterFunctionCode(CallableObjectProxy): @@ -76,6 +43,7 @@ def co_kwonlyargcount(self): def co_varnames(self): return self._self_adapter_code.co_varnames + class _AdapterFunctionSurrogate(CallableObjectProxy): def __init__(self, wrapped, adapter): @@ -84,8 +52,9 @@ def __init__(self, wrapped, adapter): @property def __code__(self): - return _AdapterFunctionCode(self.__wrapped__.__code__, - self._self_adapter.__code__) + return _AdapterFunctionCode( + self.__wrapped__.__code__, self._self_adapter.__code__ + ) @property def __defaults__(self): @@ -97,41 +66,36 @@ def __kwdefaults__(self): @property def __signature__(self): - if 'signature' not in globals(): + if "signature" not in globals(): return self._self_adapter.__signature__ else: return signature(self._self_adapter) - if PY2: - func_code = __code__ - func_defaults = __defaults__ class _BoundAdapterWrapper(BoundFunctionWrapper): @property def __func__(self): - return _AdapterFunctionSurrogate(self.__wrapped__.__func__, - self._self_parent._self_adapter) + return _AdapterFunctionSurrogate( + self.__wrapped__.__func__, self._self_parent._self_adapter + ) @property def __signature__(self): - if 'signature' not in globals(): + if "signature" not in globals(): return self.__wrapped__.__signature__ else: return signature(self._self_parent._self_adapter) - if PY2: - im_func = __func__ class AdapterWrapper(FunctionWrapper): __bound_function_wrapper__ = _BoundAdapterWrapper def __init__(self, *args, **kwargs): - adapter = kwargs.pop('adapter') + adapter = kwargs.pop("adapter") super(AdapterWrapper, self).__init__(*args, **kwargs) - self._self_surrogate = _AdapterFunctionSurrogate( - self.__wrapped__, adapter) + self._self_surrogate = _AdapterFunctionSurrogate(self.__wrapped__, adapter) self._self_adapter = adapter @property @@ -146,25 +110,25 @@ def __defaults__(self): def __kwdefaults__(self): return self._self_surrogate.__kwdefaults__ - if PY2: - func_code = __code__ - func_defaults = __defaults__ - @property def __signature__(self): return self._self_surrogate.__signature__ -class AdapterFactory(object): + +class AdapterFactory: def __call__(self, wrapped): raise NotImplementedError() + class DelegatedAdapterFactory(AdapterFactory): def __init__(self, factory): super(DelegatedAdapterFactory, self).__init__() self.factory = factory + def __call__(self, wrapped): return self.factory(wrapped) + adapter_factory = DelegatedAdapterFactory # Decorator for creating other decorators. This decorator and the @@ -174,29 +138,32 @@ def __call__(self, wrapped): # function so the wrapper is effectively indistinguishable from the # original wrapped function. -def decorator(wrapper=None, enabled=None, adapter=None, proxy=FunctionWrapper): - # The decorator should be supplied with a single positional argument - # which is the wrapper function to be used to implement the - # decorator. This may be preceded by a step whereby the keyword - # arguments are supplied to customise the behaviour of the - # decorator. The 'adapter' argument is used to optionally denote a - # separate function which is notionally used by an adapter - # decorator. In that case parts of the function '__code__' and - # '__defaults__' attributes are used from the adapter function - # rather than those of the wrapped function. This allows for the - # argument specification from inspect.getfullargspec() and similar - # functions to be overridden with a prototype for a different - # function than what was wrapped. The 'enabled' argument provides a - # way to enable/disable the use of the decorator. If the type of - # 'enabled' is a boolean, then it is evaluated immediately and the - # wrapper not even applied if it is False. If not a boolean, it will - # be evaluated when the wrapper is called for an unbound wrapper, - # and when binding occurs for a bound wrapper. When being evaluated, - # if 'enabled' is callable it will be called to obtain the value to - # be checked. If False, the wrapper will not be called and instead - # the original wrapped function will be called directly instead. - # The 'proxy' argument provides a way of passing a custom version of - # the FunctionWrapper class used in decorating the function. + +def decorator(wrapper=None, /, *, enabled=None, adapter=None, proxy=FunctionWrapper): + """ + The decorator should be supplied with a single positional argument + which is the `wrapper` function to be used to implement the + decorator. This may be preceded by a step whereby the keyword + arguments are supplied to customise the behaviour of the + decorator. The `adapter` argument is used to optionally denote a + separate function which is notionally used by an adapter + decorator. In that case parts of the function `__code__` and + `__defaults__` attributes are used from the adapter function + rather than those of the wrapped function. This allows for the + argument specification from `inspect.getfullargspec()` and similar + functions to be overridden with a prototype for a different + function than what was wrapped. The `enabled` argument provides a + way to enable/disable the use of the decorator. If the type of + `enabled` is a boolean, then it is evaluated immediately and the + wrapper not even applied if it is `False`. If not a boolean, it will + be evaluated when the wrapper is called for an unbound wrapper, + and when binding occurs for a bound wrapper. When being evaluated, + if `enabled` is callable it will be called to obtain the value to + be checked. If `False`, the wrapper will not be called and instead + the original wrapped function will be called directly instead. + The `proxy` argument provides a way of passing a custom version of + the `FunctionWrapper` class used in decorating the function. + """ if wrapper is not None: # Helper function for creating wrapper of the appropriate @@ -220,14 +187,14 @@ def _build(wrapped, wrapper, enabled=None, adapter=None): annotations = {} - if not isinstance(adapter, string_types): + if not isinstance(adapter, str): if len(adapter) == 7: annotations = adapter[-1] adapter = adapter[:-1] adapter = formatargspec(*adapter) - exec_('def adapter{}: pass'.format(adapter), ns, ns) - adapter = ns['adapter'] + exec(f"def adapter{adapter}: pass", ns, ns) + adapter = ns["adapter"] # Override the annotations for the manufactured # adapter function so they match the original @@ -236,8 +203,9 @@ def _build(wrapped, wrapper, enabled=None, adapter=None): if annotations: adapter.__annotations__ = annotations - return AdapterWrapper(wrapped=wrapped, wrapper=wrapper, - enabled=enabled, adapter=adapter) + return AdapterWrapper( + wrapped=wrapped, wrapper=wrapper, enabled=enabled, adapter=adapter + ) return proxy(wrapped=wrapped, wrapper=wrapper, enabled=enabled) @@ -253,7 +221,7 @@ def _wrapper(wrapped, instance, args, kwargs): # to a class type. # # @decorator - # class mydecoratorclass(object): + # class mydecoratorclass: # def __init__(self, arg=None): # self.arg = arg # def __call__(self, wrapped, instance, args, kwargs): @@ -297,8 +265,7 @@ def _capture(target_wrapped): # Finally build the wrapper itself and return it. - return _build(target_wrapped, target_wrapper, - _enabled, adapter) + return _build(target_wrapped, target_wrapper, _enabled, adapter) return _capture @@ -328,7 +295,7 @@ def _capture(target_wrapped): # as the decorator wrapper function. # # @decorator - # class mydecoratorclass(object): + # class mydecoratorclass: # def __init__(self, arg=None): # self.arg = arg # def __call__(self, wrapped, instance, @@ -368,7 +335,7 @@ def _capture(target_wrapped): # In this case the decorator was applied to a class # method. # - # class myclass(object): + # class myclass: # @decorator # @classmethod # def decoratorclassmethod(cls, wrapped, @@ -393,7 +360,7 @@ def _capture(target_wrapped): # In this case the decorator was applied to an instance # method. # - # class myclass(object): + # class myclass: # @decorator # def decoratorclassmethod(self, wrapped, # instance, args, kwargs): @@ -432,8 +399,8 @@ def _capture(target_wrapped): # decorator again wrapped in a partial using the collected # arguments. - return partial(decorator, enabled=enabled, adapter=adapter, - proxy=proxy) + return partial(decorator, enabled=enabled, adapter=adapter, proxy=proxy) + # Decorator for implementing thread synchronization. It can be used as a # decorator, in which case the synchronization context is determined by @@ -445,14 +412,27 @@ def _capture(target_wrapped): # synchronization primitive without creating a separate lock against the # derived or supplied context. + def synchronized(wrapped): + """Depending on the nature of the `wrapped` object, will either return a + decorator which can be used to wrap a function or method, or a context + manager, both of which will act accordingly depending on how used, to + synchronize access to calling of the wrapped function, or the block of + code within the context manager. If it is an object which is a + synchronization primitive, such as a threading Lock, RLock, Semaphore, + Condition, or Event, then it is assumed that the object is to be used + directly as the synchronization primitive, otherwise a lock is created + automatically and attached to the wrapped object and used as the + synchronization primitive. + """ + # Determine if being passed an object which is a synchronization # primitive. We can't check by type for Lock, RLock, Semaphore etc, # as the means of creating them isn't the type. Therefore use the # existence of acquire() and release() methods. This is more # extensible anyway as it allows custom synchronization mechanisms. - if hasattr(wrapped, 'acquire') and hasattr(wrapped, 'release'): + if hasattr(wrapped, "acquire") and hasattr(wrapped, "release"): # We remember what the original lock is and then return a new # decorator which accesses and locks it. When returning the new # decorator we wrap it with an object proxy so we can override @@ -489,7 +469,7 @@ def __exit__(self, *args): def _synchronized_lock(context): # Attempt to retrieve the lock for the specific context. - lock = vars(context).get('_synchronized_lock', None) + lock = vars(context).get("_synchronized_lock", None) if lock is None: # There is no existing lock defined for the context we @@ -510,11 +490,11 @@ def _synchronized_lock(context): # at the same time and were competing to create the # meta lock. - lock = vars(context).get('_synchronized_lock', None) + lock = vars(context).get("_synchronized_lock", None) if lock is None: lock = RLock() - setattr(context, '_synchronized_lock', lock) + setattr(context, "_synchronized_lock", lock) return lock @@ -538,4 +518,5 @@ def __exit__(self, *args): return _FinalDecorator(wrapped=wrapped, wrapper=_synchronized_wrapper) -synchronized._synchronized_meta_lock = Lock() + +synchronized._synchronized_meta_lock = Lock() # type: ignore[attr-defined] diff --git a/newrelic/packages/wrapt/importer.py b/newrelic/packages/wrapt/importer.py index 23fcbd2f63..a1e0cb7c59 100644 --- a/newrelic/packages/wrapt/importer.py +++ b/newrelic/packages/wrapt/importer.py @@ -3,19 +3,13 @@ """ +import importlib.metadata import sys import threading +from importlib.util import find_spec +from typing import Callable, Dict, List -PY2 = sys.version_info[0] == 2 - -if PY2: - string_types = basestring, - find_spec = None -else: - string_types = str, - from importlib.util import find_spec - -from .__wrapt__ import ObjectProxy +from .__wrapt__ import BaseObjectProxy # The dictionary registering any post import hooks to be triggered once # the target module has been imported. Once a module has been imported @@ -23,7 +17,7 @@ # module will be truncated but the list left in the dictionary. This # acts as a flag to indicate that the module had already been imported. -_post_import_hooks = {} +_post_import_hooks: Dict[str, List[Callable]] = {} _post_import_hooks_init = False _post_import_hooks_lock = threading.RLock() @@ -34,22 +28,36 @@ # proxy callback being registered which will defer loading of the # specified module containing the callback function until required. + def _create_import_hook_from_string(name): def import_hook(module): - module_name, function = name.split(':') - attrs = function.split('.') + module_name, function = name.split(":") + attrs = function.split(".") __import__(module_name) callback = sys.modules[module_name] for attr in attrs: callback = getattr(callback, attr) return callback(module) + return import_hook + def register_post_import_hook(hook, name): + """ + Register a post import hook for the target module `name`. The `hook` + function will be called once the module is imported and will be passed the + module as argument. If the module is already imported, the `hook` will be + called immediately. If you also want to defer loading of the module containing + the `hook` function until required, you can specify the `hook` as a string in + the form 'module:function'. This will result in a proxy hook function being + registered which will defer loading of the specified module containing the + callback function until required. + """ + # Create a deferred import hook if hook is a string name rather than # a callable function. - if isinstance(hook, string_types): + if isinstance(hook, str): hook = _create_import_hook_from_string(hook) with _post_import_hooks_lock: @@ -78,34 +86,59 @@ def register_post_import_hook(hook, name): if module is not None: hook(module) + # Register post import hooks defined as package entry points. + def _create_import_hook_from_entrypoint(entrypoint): def import_hook(module): - __import__(entrypoint.module_name) - callback = sys.modules[entrypoint.module_name] - for attr in entrypoint.attrs: - callback = getattr(callback, attr) + entrypoint_value = entrypoint.value.split(":") + module_name = entrypoint_value[0] + __import__(module_name) + callback = sys.modules[module_name] + + if len(entrypoint_value) > 1: + attrs = entrypoint_value[1].split(".") + for attr in attrs: + callback = getattr(callback, attr) return callback(module) + return import_hook + def discover_post_import_hooks(group): - try: - import pkg_resources - except ImportError: - return + """ + Discover and register post import hooks defined as package entry points + in the specified `group`. The group should be a string that matches the + entry point group name used in the package metadata. + """ - for entrypoint in pkg_resources.iter_entry_points(group=group): - callback = _create_import_hook_from_entrypoint(entrypoint) + try: + # Python 3.10+ style with select parameter + entrypoints = importlib.metadata.entry_points(group=group) + except TypeError: + # Python 3.8-3.9 style that returns a dict + entrypoints = importlib.metadata.entry_points().get(group, ()) + + for entrypoint in entrypoints: + callback = entrypoint.load() # Use the loaded callback directly register_post_import_hook(callback, entrypoint.name) + # Indicate that a module has been loaded. Any post import hooks which # were registered against the target module will be invoked. If an # exception is raised in any of the post import hooks, that will cause # the import of the target module to fail. + def notify_module_loaded(module): - name = getattr(module, '__name__', None) + """ + Notify that a `module` has been loaded and invoke any post import hooks + registered against the module. If the module is not registered, this + function does nothing. + """ + + name = getattr(module, "__name__", None) with _post_import_hooks_lock: hooks = _post_import_hooks.pop(name, ()) @@ -117,11 +150,13 @@ def notify_module_loaded(module): for hook in hooks: hook(module) + # A custom module import finder. This intercepts attempts to import # modules and watches out for attempts to import target modules of # interest. When a module of interest is imported, then any post import # hooks which are registered will be invoked. + class _ImportHookLoader: def load_module(self, fullname): @@ -130,17 +165,18 @@ def load_module(self, fullname): return module -class _ImportHookChainedLoader(ObjectProxy): + +class _ImportHookChainedLoader(BaseObjectProxy): def __init__(self, loader): super(_ImportHookChainedLoader, self).__init__(loader) if hasattr(loader, "load_module"): - self.__self_setattr__('load_module', self._self_load_module) + self.__self_setattr__("load_module", self._self_load_module) if hasattr(loader, "create_module"): - self.__self_setattr__('create_module', self._self_create_module) + self.__self_setattr__("create_module", self._self_create_module) if hasattr(loader, "exec_module"): - self.__self_setattr__('exec_module', self._self_exec_module) + self.__self_setattr__("exec_module", self._self_exec_module) def _self_set_loader(self, module): # Set module's loader to self.__wrapped__ unless it's already set to @@ -148,13 +184,14 @@ def _self_set_loader(self, module): # None, so handle None as well. The module may not support attribute # assignment, in which case we simply skip it. Note that we also deal # with __loader__ not existing at all. This is to future proof things - # due to proposal to remove the attribue as described in the GitHub + # due to proposal to remove the attribute as described in the GitHub # issue at https://github.com/python/cpython/issues/77458. Also prior # to Python 3.3, the __loader__ attribute was only set if a custom # module loader was used. It isn't clear whether the attribute still # existed in that case or was set to None. - class UNDEFINED: pass + class UNDEFINED: + pass if getattr(module, "__loader__", UNDEFINED) in (None, self): try: @@ -162,8 +199,10 @@ class UNDEFINED: pass except AttributeError: pass - if (getattr(module, "__spec__", None) is not None - and getattr(module.__spec__, "loader", None) is self): + if ( + getattr(module, "__spec__", None) is not None + and getattr(module.__spec__, "loader", None) is self + ): module.__spec__.loader = self.__wrapped__ def _self_load_module(self, fullname): @@ -184,6 +223,7 @@ def _self_exec_module(self, module): self.__wrapped__.exec_module(module) notify_module_loaded(module) + class ImportHookFinder: def __init__(self): @@ -213,32 +253,18 @@ def find_module(self, fullname, path=None): # Now call back into the import system again. try: - if not find_spec: - # For Python 2 we don't have much choice but to - # call back in to __import__(). This will - # actually cause the module to be imported. If no - # module could be found then ImportError will be - # raised. Otherwise we return a loader which - # returns the already loaded module and invokes - # the post import hooks. - - __import__(fullname) + # For Python 3 we need to use find_spec().loader + # from the importlib.util module. It doesn't actually + # import the target module and only finds the + # loader. If a loader is found, we need to return + # our own loader which will then in turn call the + # real loader to import the module and invoke the + # post import hooks. - return _ImportHookLoader() + loader = getattr(find_spec(fullname), "loader", None) - else: - # For Python 3 we need to use find_spec().loader - # from the importlib.util module. It doesn't actually - # import the target module and only finds the - # loader. If a loader is found, we need to return - # our own loader which will then in turn call the - # real loader to import the module and invoke the - # post import hooks. - - loader = getattr(find_spec(fullname), "loader", None) - - if loader and not isinstance(loader, _ImportHookChainedLoader): - return _ImportHookChainedLoader(loader) + if loader and not isinstance(loader, _ImportHookChainedLoader): + return _ImportHookChainedLoader(loader) finally: del self.in_progress[fullname] @@ -285,11 +311,22 @@ def find_spec(self, fullname, path=None, target=None): finally: del self.in_progress[fullname] + # Decorator for marking that a function should be called as a post # import hook when the target module is imported. + def when_imported(name): + """ + Returns a decorator that registers the decorated function as a post import + hook for the module specified by `name`. The function will be called once + the module with the specified name is imported, and will be passed the + module as argument. If the module is already imported, the function will + be called immediately. + """ + def register(hook): register_post_import_hook(hook, name) return hook + return register diff --git a/newrelic/packages/wrapt/patches.py b/newrelic/packages/wrapt/patches.py index e22adf7ca8..f5f1fc3ca9 100644 --- a/newrelic/packages/wrapt/patches.py +++ b/newrelic/packages/wrapt/patches.py @@ -1,25 +1,29 @@ import inspect import sys -PY2 = sys.version_info[0] == 2 - -if PY2: - string_types = basestring, -else: - string_types = str, - from .__wrapt__ import FunctionWrapper # Helper functions for applying wrappers to existing functions. -def resolve_path(module, name): - if isinstance(module, string_types): - __import__(module) - module = sys.modules[module] - parent = module +def resolve_path(target, name): + """ + Resolves the dotted path supplied as `name` to an attribute on a target + object. The `target` can be a module, class, or instance of a class. If the + `target` argument is a string, it is assumed to be the name of a module, + which will be imported if necessary and then used as the target object. + Returns a tuple containing the parent object holding the attribute lookup + resolved to, the attribute name (path prefix removed if present), and the + original attribute value. + """ + + if isinstance(target, str): + __import__(target) + target = sys.modules[target] - path = name.split('.') + parent = target + + path = name.split(".") attribute = path[0] # We can't just always use getattr() because in doing @@ -53,22 +57,46 @@ def lookup_attribute(parent, attribute): return (parent, attribute, original) + def apply_patch(parent, attribute, replacement): + """ + Convenience function for applying a patch to an attribute. Currently this + maps to the standard setattr() function, but in the future may be extended + to support more complex patching strategies. + """ + setattr(parent, attribute, replacement) -def wrap_object(module, name, factory, args=(), kwargs={}): - (parent, attribute, original) = resolve_path(module, name) + +def wrap_object(target, name, factory, args=(), kwargs={}): + """ + Wraps an object which is the attribute of a target object with a wrapper + object created by the `factory` function. The `target` can be a module, + class, or instance of a class. In the special case of `target` being a + string, it is assumed to be the name of a module, with the module being + imported if necessary and then used as the target object. The `name` is a + string representing the dotted path to the attribute. The `factory` function + should accept the original object and may accept additional positional and + keyword arguments which will be set by unpacking input arguments using + `*args` and `**kwargs` calling conventions. The factory function should + return a new object that will replace the original object. + """ + + (parent, attribute, original) = resolve_path(target, name) wrapper = factory(original, *args, **kwargs) apply_patch(parent, attribute, wrapper) + return wrapper + # Function for applying a proxy object to an attribute of a class # instance. The wrapper works by defining an attribute of the same name # on the class which is a descriptor and which intercepts access to the # instance attribute. Note that this cannot be used on attributes which # are themselves defined by a property object. -class AttributeWrapper(object): + +class AttributeWrapper: def __init__(self, attribute, factory, args, kwargs): self.attribute = attribute @@ -86,19 +114,47 @@ def __set__(self, instance, value): def __delete__(self, instance): del instance.__dict__[self.attribute] + def wrap_object_attribute(module, name, factory, args=(), kwargs={}): - path, attribute = name.rsplit('.', 1) + """ + Wraps an object which is the attribute of a class instance with a wrapper + object created by the `factory` function. It does this by patching the + class, not the instance, with a descriptor that intercepts access to the + instance attribute. The `module` can be a module, class, or instance of a + class. In the special case of `module` being a string, it is assumed to be + the name of a module, with the module being imported if necessary and then + used as the target object. The `name` is a string representing the dotted + path to the attribute. The `factory` function should accept the original + object and may accept additional positional and keyword arguments which will + be set by unpacking input arguments using `*args` and `**kwargs` calling + conventions. The factory function should return a new object that will + replace the original object. + """ + + path, attribute = name.rsplit(".", 1) parent = resolve_path(module, path)[2] wrapper = AttributeWrapper(attribute, factory, args, kwargs) apply_patch(parent, attribute, wrapper) return wrapper + # Functions for creating a simple decorator using a FunctionWrapper, # plus short cut functions for applying wrappers to functions. These are # for use when doing monkey patching. For a more featured way of # creating decorators see the decorator decorator instead. + def function_wrapper(wrapper): + """ + Creates a decorator for wrapping a function with a `wrapper` function. + The decorator which is returned may also be applied to any other callable + objects such as lambda functions, methods, classmethods, and staticmethods, + or objects which implement the `__call__()` method. The `wrapper` function + should accept the `wrapped` function, `instance`, `args`, and `kwargs`, + arguments and return the result of calling the wrapped function or some + other appropriate value. + """ + def _wrapper(wrapped, instance, args, kwargs): target_wrapped = args[0] if instance is None: @@ -108,17 +164,55 @@ def _wrapper(wrapped, instance, args, kwargs): else: target_wrapper = wrapper.__get__(instance, type(instance)) return FunctionWrapper(target_wrapped, target_wrapper) + return FunctionWrapper(wrapper, _wrapper) -def wrap_function_wrapper(module, name, wrapper): - return wrap_object(module, name, FunctionWrapper, (wrapper,)) -def patch_function_wrapper(module, name, enabled=None): +def wrap_function_wrapper(target, name, wrapper): + """ + Wraps a function which is the attribute of a target object with a `wrapper` + function. The `target` can be a module, class, or instance of a class. In + the special case of `target` being a string, it is assumed to be the name + of a module, with the module being imported if necessary. The `name` is a + string representing the dotted path to the attribute. The `wrapper` function + should accept the `wrapped` function, `instance`, `args`, and `kwargs` + arguments, and would return the result of calling the wrapped attribute or + some other appropriate value. + """ + + return wrap_object(target, name, FunctionWrapper, (wrapper,)) + + +def patch_function_wrapper(target, name, enabled=None): + """ + Creates a decorator which can be applied to a wrapper function, where the + wrapper function will be used to wrap a function which is the attribute of + a target object. The `target` can be a module, class, or instance of a class. + In the special case of `target` being a string, it is assumed to be the name + of a module, with the module being imported if necessary. The `name` is a + string representing the dotted path to the attribute. The `enabled` + argument can be a boolean or a callable that returns a boolean. When a + callable is provided, it will be called each time the wrapper is invoked to + determine if the wrapper function should be executed or whether the wrapped + function should be called directly. If `enabled` is not provided, the + wrapper is enabled by default. + """ + def _wrapper(wrapper): - return wrap_object(module, name, FunctionWrapper, (wrapper, enabled)) + return wrap_object(target, name, FunctionWrapper, (wrapper, enabled)) + return _wrapper -def transient_function_wrapper(module, name): + +def transient_function_wrapper(target, name): + """Creates a decorator that patches a target function with a wrapper + function, but only for the duration of the call that the decorator was + applied to. The `target` can be a module, class, or instance of a class. + In the special case of `target` being a string, it is assumed to be the name + of a module, with the module being imported if necessary. The `name` is a + string representing the dotted path to the attribute. + """ + def _decorator(wrapper): def _wrapper(wrapped, instance, args, kwargs): target_wrapped = args[0] @@ -128,14 +222,18 @@ def _wrapper(wrapped, instance, args, kwargs): target_wrapper = wrapper.__get__(None, instance) else: target_wrapper = wrapper.__get__(instance, type(instance)) + def _execute(wrapped, instance, args, kwargs): - (parent, attribute, original) = resolve_path(module, name) + (parent, attribute, original) = resolve_path(target, name) replacement = FunctionWrapper(original, target_wrapper) setattr(parent, attribute, replacement) try: return wrapped(*args, **kwargs) finally: setattr(parent, attribute, original) + return FunctionWrapper(target_wrapped, _execute) + return FunctionWrapper(wrapper, _wrapper) + return _decorator diff --git a/newrelic/packages/wrapt/proxies.py b/newrelic/packages/wrapt/proxies.py new file mode 100644 index 0000000000..60261da21a --- /dev/null +++ b/newrelic/packages/wrapt/proxies.py @@ -0,0 +1,282 @@ +"""Variants of ObjectProxy for different use cases.""" + +from .__wrapt__ import BaseObjectProxy +from .decorators import synchronized + +# Define ObjectProxy which for compatibility adds `__iter__()` support which +# has been removed from `BaseObjectProxy`. + + +class ObjectProxy(BaseObjectProxy): + """A generic object proxy which forwards special methods as needed. + For backwards compatibility this class adds support for `__iter__()`. If + you don't need backward compatibility for `__iter__()` support then it is + preferable to use `BaseObjectProxy` directly. If you want automatic + support for special dunder methods for callables, iterators, and async, + then use `AutoObjectProxy`.""" + + @property + def __object_proxy__(self): + return ObjectProxy + + def __new__(cls, *args, **kwargs): + return super().__new__(cls) + + def __iter__(self): + return iter(self.__wrapped__) + + +# Define variant of ObjectProxy which can automatically adjust to the wrapped +# object and add special dunder methods. + + +def __wrapper_call__(self, *args, **kwargs): + return self.__wrapped__(*args, **kwargs) + + +def __wrapper_iter__(self): + return iter(self.__wrapped__) + + +def __wrapper_next__(self): + return self.__wrapped__.__next__() + + +def __wrapper_aiter__(self): + return self.__wrapped__.__aiter__() + + +async def __wrapper_anext__(self): + return await self.__wrapped__.__anext__() + + +def __wrapper_length_hint__(self): + return self.__wrapped__.__length_hint__() + + +def __wrapper_await__(self): + return (yield from self.__wrapped__.__await__()) + + +def __wrapper_get__(self, instance, owner): + return self.__wrapped__.__get__(instance, owner) + + +def __wrapper_set__(self, instance, value): + return self.__wrapped__.__set__(instance, value) + + +def __wrapper_delete__(self, instance): + return self.__wrapped__.__delete__(instance) + + +def __wrapper_set_name__(self, owner, name): + return self.__wrapped__.__set_name__(owner, name) + + +class AutoObjectProxy(BaseObjectProxy): + """An object proxy which can automatically adjust to the wrapped object + and add special dunder methods as needed. Note that this creates a new + class for each instance, so it has much higher memory overhead than using + `BaseObjectProxy` directly. If you know what special dunder methods you need + then it is preferable to use `BaseObjectProxy` directly and add them to a + subclass as needed. If you only need `__iter__()` support for backwards + compatibility then use `ObjectProxy` instead. + """ + + def __new__(cls, wrapped): + """Injects special dunder methods into a dynamically created subclass + as needed based on the wrapped object. + """ + + namespace = {} + + wrapped_attrs = dir(wrapped) + class_attrs = set(dir(cls)) + + if callable(wrapped) and "__call__" not in class_attrs: + namespace["__call__"] = __wrapper_call__ + + if "__iter__" in wrapped_attrs and "__iter__" not in class_attrs: + namespace["__iter__"] = __wrapper_iter__ + + if "__next__" in wrapped_attrs and "__next__" not in class_attrs: + namespace["__next__"] = __wrapper_next__ + + if "__aiter__" in wrapped_attrs and "__aiter__" not in class_attrs: + namespace["__aiter__"] = __wrapper_aiter__ + + if "__anext__" in wrapped_attrs and "__anext__" not in class_attrs: + namespace["__anext__"] = __wrapper_anext__ + + if "__length_hint__" in wrapped_attrs and "__length_hint__" not in class_attrs: + namespace["__length_hint__"] = __wrapper_length_hint__ + + # Note that not providing compatibility with generator-based coroutines + # (PEP 342) here as they are removed in Python 3.11+ and were deprecated + # in 3.8. + + if "__await__" in wrapped_attrs and "__await__" not in class_attrs: + namespace["__await__"] = __wrapper_await__ + + if "__get__" in wrapped_attrs and "__get__" not in class_attrs: + namespace["__get__"] = __wrapper_get__ + + if "__set__" in wrapped_attrs and "__set__" not in class_attrs: + namespace["__set__"] = __wrapper_set__ + + if "__delete__" in wrapped_attrs and "__delete__" not in class_attrs: + namespace["__delete__"] = __wrapper_delete__ + + if "__set_name__" in wrapped_attrs and "__set_name__" not in class_attrs: + namespace["__set_name__"] = __wrapper_set_name__ + + name = cls.__name__ + + if cls is AutoObjectProxy: + name = BaseObjectProxy.__name__ + + return super().__new__(type(name, (cls,), namespace)) + + def __wrapped_setattr_fixups__(self): + """Adjusts special dunder methods on the class as needed based on the + wrapped object, when `__wrapped__` is changed. + """ + + cls = type(self) + class_attrs = set(dir(cls)) + + if callable(self.__wrapped__): + if "__call__" not in class_attrs: + cls.__call__ = __wrapper_call__ + elif getattr(cls, "__call__", None) is __wrapper_call__: + delattr(cls, "__call__") + + if hasattr(self.__wrapped__, "__iter__"): + if "__iter__" not in class_attrs: + cls.__iter__ = __wrapper_iter__ + elif getattr(cls, "__iter__", None) is __wrapper_iter__: + delattr(cls, "__iter__") + + if hasattr(self.__wrapped__, "__next__"): + if "__next__" not in class_attrs: + cls.__next__ = __wrapper_next__ + elif getattr(cls, "__next__", None) is __wrapper_next__: + delattr(cls, "__next__") + + if hasattr(self.__wrapped__, "__aiter__"): + if "__aiter__" not in class_attrs: + cls.__aiter__ = __wrapper_aiter__ + elif getattr(cls, "__aiter__", None) is __wrapper_aiter__: + delattr(cls, "__aiter__") + + if hasattr(self.__wrapped__, "__anext__"): + if "__anext__" not in class_attrs: + cls.__anext__ = __wrapper_anext__ + elif getattr(cls, "__anext__", None) is __wrapper_anext__: + delattr(cls, "__anext__") + + if hasattr(self.__wrapped__, "__length_hint__"): + if "__length_hint__" not in class_attrs: + cls.__length_hint__ = __wrapper_length_hint__ + elif getattr(cls, "__length_hint__", None) is __wrapper_length_hint__: + delattr(cls, "__length_hint__") + + if hasattr(self.__wrapped__, "__await__"): + if "__await__" not in class_attrs: + cls.__await__ = __wrapper_await__ + elif getattr(cls, "__await__", None) is __wrapper_await__: + delattr(cls, "__await__") + + if hasattr(self.__wrapped__, "__get__"): + if "__get__" not in class_attrs: + cls.__get__ = __wrapper_get__ + elif getattr(cls, "__get__", None) is __wrapper_get__: + delattr(cls, "__get__") + + if hasattr(self.__wrapped__, "__set__"): + if "__set__" not in class_attrs: + cls.__set__ = __wrapper_set__ + elif getattr(cls, "__set__", None) is __wrapper_set__: + delattr(cls, "__set__") + + if hasattr(self.__wrapped__, "__delete__"): + if "__delete__" not in class_attrs: + cls.__delete__ = __wrapper_delete__ + elif getattr(cls, "__delete__", None) is __wrapper_delete__: + delattr(cls, "__delete__") + + if hasattr(self.__wrapped__, "__set_name__"): + if "__set_name__" not in class_attrs: + cls.__set_name__ = __wrapper_set_name__ + elif getattr(cls, "__set_name__", None) is __wrapper_set_name__: + delattr(cls, "__set_name__") + + +class LazyObjectProxy(AutoObjectProxy): + """An object proxy which can generate/create the wrapped object on demand + when it is first needed. + """ + + def __new__(cls, callback=None): + return super().__new__(cls, None) + + def __init__(self, callback=None): + """Initialize the object proxy with wrapped object as `None` but due + to presence of special `__wrapped_factory__` attribute addded first, + this will actually trigger the deferred creation of the wrapped object + when first needed. + """ + + if callback is not None: + self.__wrapped_factory__ = callback + + super().__init__(None) + + __wrapped_initialized__ = False + + def __wrapped_factory__(self): + return None + + def __wrapped_get__(self): + """Gets the wrapped object, creating it if necessary.""" + + # We synchronize on the class type, which will be unique to this instance + # since we inherit from `AutoObjectProxy` which creates a new class + # for each instance. If we synchronize on `self` or the method then + # we can end up in infinite recursion via `__getattr__()`. + + with synchronized(type(self)): + # We were called because `__wrapped__` was not set, but because of + # multiple threads we may find that it has been set by the time + # we get the lock. So check again now whether `__wrapped__` is set. + # If it is then just return it, otherwise call the factory to + # create it. + + if self.__wrapped_initialized__: + return self.__wrapped__ + + self.__wrapped__ = self.__wrapped_factory__() + + self.__wrapped_initialized__ = True + + return self.__wrapped__ + + +def lazy_import(name, attribute=None): + """Lazily imports the module `name`, returning a `LazyObjectProxy` which + will import the module when it is first needed. When `name is a dotted name, + then the full dotted name is imported and the last module is taken as the + target. If `attribute` is provided then it is used to retrieve an attribute + from the module. + """ + + def _import(): + module = __import__(name, fromlist=[""]) + + if attribute is not None: + return getattr(module, attribute) + + return module + + return LazyObjectProxy(_import) diff --git a/newrelic/packages/wrapt/py.typed b/newrelic/packages/wrapt/py.typed new file mode 100644 index 0000000000..b648ac9233 --- /dev/null +++ b/newrelic/packages/wrapt/py.typed @@ -0,0 +1 @@ +partial diff --git a/newrelic/packages/wrapt/weakrefs.py b/newrelic/packages/wrapt/weakrefs.py index f931b60d5f..dc8e7eb2d3 100644 --- a/newrelic/packages/wrapt/weakrefs.py +++ b/newrelic/packages/wrapt/weakrefs.py @@ -1,7 +1,7 @@ import functools import weakref -from .__wrapt__ import ObjectProxy, _FunctionWrapperBase +from .__wrapt__ import BaseObjectProxy, _FunctionWrapperBase # A weak function proxy. This will work on instance methods, class # methods, static methods and regular functions. Special treatment is @@ -12,6 +12,7 @@ # and the original function. The function is then rebound at the point # of a call via the weak function proxy. + def _weak_function_proxy_callback(ref, proxy, callback): if proxy._self_expired: return @@ -25,11 +26,25 @@ def _weak_function_proxy_callback(ref, proxy, callback): if callback is not None: callback(proxy) -class WeakFunctionProxy(ObjectProxy): - __slots__ = ('_self_expired', '_self_instance') +class WeakFunctionProxy(BaseObjectProxy): + """A weak function proxy.""" + + __slots__ = ("_self_expired", "_self_instance") def __init__(self, wrapped, callback=None): + """Create a proxy to object which uses a weak reference. This is + similar to the `weakref.proxy` but is designed to work with functions + and methods. It will automatically rebind the function to the instance + when called if the function was originally a bound method. This is + necessary because bound methods are transient objects and applying a + weak reference to one will immediately result in it being destroyed + and the weakref callback called. The weak reference is therefore + applied to the instance the method is bound to and the original + function. The function is then rebound at the point of a call via the + weak function proxy. + """ + # We need to determine if the wrapped function is actually a # bound method. In the case of a bound method, we need to keep a # reference to the original unbound function and the instance. @@ -43,22 +58,23 @@ def __init__(self, wrapped, callback=None): # the callback here so as not to cause any odd reference cycles. _callback = callback and functools.partial( - _weak_function_proxy_callback, proxy=self, - callback=callback) + _weak_function_proxy_callback, proxy=self, callback=callback + ) self._self_expired = False if isinstance(wrapped, _FunctionWrapperBase): - self._self_instance = weakref.ref(wrapped._self_instance, - _callback) + self._self_instance = weakref.ref(wrapped._self_instance, _callback) if wrapped._self_parent is not None: super(WeakFunctionProxy, self).__init__( - weakref.proxy(wrapped._self_parent, _callback)) + weakref.proxy(wrapped._self_parent, _callback) + ) else: super(WeakFunctionProxy, self).__init__( - weakref.proxy(wrapped, _callback)) + weakref.proxy(wrapped, _callback) + ) return @@ -66,13 +82,13 @@ def __init__(self, wrapped, callback=None): self._self_instance = weakref.ref(wrapped.__self__, _callback) super(WeakFunctionProxy, self).__init__( - weakref.proxy(wrapped.__func__, _callback)) + weakref.proxy(wrapped.__func__, _callback) + ) except AttributeError: self._self_instance = None - super(WeakFunctionProxy, self).__init__( - weakref.proxy(wrapped, _callback)) + super(WeakFunctionProxy, self).__init__(weakref.proxy(wrapped, _callback)) def __call__(*args, **kwargs): def _unpack_self(self, *args): diff --git a/newrelic/packages/wrapt/wrappers.py b/newrelic/packages/wrapt/wrappers.py index dfc3440db4..445d0b2c6e 100644 --- a/newrelic/packages/wrapt/wrappers.py +++ b/newrelic/packages/wrapt/wrappers.py @@ -1,19 +1,24 @@ -import sys -import operator import inspect +import operator +import sys -PY2 = sys.version_info[0] == 2 - -if PY2: - string_types = basestring, -else: - string_types = str, def with_metaclass(meta, *bases): """Create a base class with a metaclass.""" return meta("NewBase", bases, {}) -class _ObjectProxyMethods(object): + +class WrapperNotInitializedError(ValueError, AttributeError): + """ + Exception raised when a wrapper is accessed before it has been initialized. + To satisfy different situations where this could arise, we inherit from both + ValueError and AttributeError. + """ + + pass + + +class _ObjectProxyMethods: # We use properties to override the values of __module__ and # __doc__. If we add these in ObjectProxy, the derived class @@ -56,6 +61,7 @@ def __dict__(self): def __weakref__(self): return self.__wrapped__.__weakref__ + class _ObjectProxyMetaType(type): def __new__(cls, name, bases, dictionary): # Copy our special properties into the class so that they @@ -67,19 +73,47 @@ def __new__(cls, name, bases, dictionary): return type.__new__(cls, name, bases, dictionary) -class ObjectProxy(with_metaclass(_ObjectProxyMetaType)): - __slots__ = '__wrapped__' +# NOTE: Although Python 3+ supports the newer metaclass=MetaClass syntax, +# we must continue using with_metaclass() for ObjectProxy. The newer syntax +# changes how __slots__ is handled during class creation, which would break +# the ability to set _self_* attributes on ObjectProxy instances. The +# with_metaclass() approach creates an intermediate base class that allows +# the necessary attribute flexibility while still applying the metaclass. + + +class ObjectProxy(with_metaclass(_ObjectProxyMetaType)): # type: ignore[misc] + + __slots__ = "__wrapped__" def __init__(self, wrapped): - object.__setattr__(self, '__wrapped__', wrapped) + """Create an object proxy around the given object.""" + + if wrapped is None: + try: + callback = object.__getattribute__(self, "__wrapped_factory__") + except AttributeError: + callback = None + + if callback is not None: + # If wrapped is none and class has a __wrapped_factory__ + # method, then we don't set __wrapped__ yet and instead will + # defer creation of the wrapped object until it is first + # needed. + + pass + + else: + object.__setattr__(self, "__wrapped__", wrapped) + else: + object.__setattr__(self, "__wrapped__", wrapped) # Python 3.2+ has the __qualname__ attribute, but it does not # allow it to be overridden using a property and it must instead # be an actual string object instead. try: - object.__setattr__(self, '__qualname__', wrapped.__qualname__) + object.__setattr__(self, "__qualname__", wrapped.__qualname__) except AttributeError: pass @@ -87,10 +121,14 @@ def __init__(self, wrapped): # using a property and it must instead be set explicitly. try: - object.__setattr__(self, '__annotations__', wrapped.__annotations__) + object.__setattr__(self, "__annotations__", wrapped.__annotations__) except AttributeError: pass + @property + def __object_proxy__(self): + return ObjectProxy + def __self_setattr__(self, name, value): object.__setattr__(self, name, value) @@ -116,26 +154,27 @@ def __dir__(self): def __str__(self): return str(self.__wrapped__) - if not PY2: - def __bytes__(self): - return bytes(self.__wrapped__) + def __bytes__(self): + return bytes(self.__wrapped__) def __repr__(self): - return '<{} at 0x{:x} for {} at 0x{:x}>'.format( - type(self).__name__, id(self), - type(self.__wrapped__).__name__, - id(self.__wrapped__)) + return f"<{type(self).__name__} at 0x{id(self):x} for {type(self.__wrapped__).__name__} at 0x{id(self.__wrapped__):x}>" + + def __format__(self, format_spec): + return format(self.__wrapped__, format_spec) def __reversed__(self): return reversed(self.__wrapped__) - if not PY2: - def __round__(self): - return round(self.__wrapped__) + def __round__(self, ndigits=None): + return round(self.__wrapped__, ndigits) - if sys.hexversion >= 0x03070000: - def __mro_entries__(self, bases): - return (self.__wrapped__,) + def __mro_entries__(self, bases): + if not isinstance(self.__wrapped__, type) and hasattr( + self.__wrapped__, "__mro_entries__" + ): + return self.__wrapped__.__mro_entries__(bases) + return (self.__wrapped__,) def __lt__(self, other): return self.__wrapped__ < other @@ -165,33 +204,41 @@ def __bool__(self): return bool(self.__wrapped__) def __setattr__(self, name, value): - if name.startswith('_self_'): + if name.startswith("_self_"): object.__setattr__(self, name, value) - elif name == '__wrapped__': + elif name == "__wrapped__": object.__setattr__(self, name, value) + try: - object.__delattr__(self, '__qualname__') + object.__delattr__(self, "__qualname__") except AttributeError: pass try: - object.__setattr__(self, '__qualname__', value.__qualname__) + object.__setattr__(self, "__qualname__", value.__qualname__) except AttributeError: pass try: - object.__delattr__(self, '__annotations__') + object.__delattr__(self, "__annotations__") except AttributeError: pass try: - object.__setattr__(self, '__annotations__', value.__annotations__) + object.__setattr__(self, "__annotations__", value.__annotations__) except AttributeError: pass - elif name == '__qualname__': + __wrapped_setattr_fixups__ = getattr( + self, "__wrapped_setattr_fixups__", None + ) + + if __wrapped_setattr_fixups__ is not None: + __wrapped_setattr_fixups__() + + elif name == "__qualname__": setattr(self.__wrapped__, name, value) object.__setattr__(self, name, value) - elif name == '__annotations__': + elif name == "__annotations__": setattr(self.__wrapped__, name, value) object.__setattr__(self, name, value) @@ -202,22 +249,37 @@ def __setattr__(self, name, value): setattr(self.__wrapped__, name, value) def __getattr__(self, name): - # If we are being to lookup '__wrapped__' then the - # '__init__()' method cannot have been called. + # If we need to lookup `__wrapped__` then the `__init__()` method + # cannot have been called, or this is a lazy object proxy which is + # deferring creation of the wrapped object until it is first needed. + + if name == "__wrapped__": + # Note that we use existance of `__wrapped_factory__` to gate whether + # we can attempt to initialize the wrapped object lazily, but it is + # `__wrapped_get__` that we actually call to do the initialization. + # This is so that we can handle multithreading correctly by having + # `__wrapped_get__` use a lock to protect against multiple threads + # trying to initialize the wrapped object at the same time. - if name == '__wrapped__': - raise ValueError('wrapper has not been initialised') + try: + object.__getattribute__(self, "__wrapped_factory__") + except AttributeError: + pass + else: + return object.__getattribute__(self, "__wrapped_get__")() + + raise WrapperNotInitializedError("wrapper has not been initialized") return getattr(self.__wrapped__, name) def __delattr__(self, name): - if name.startswith('_self_'): + if name.startswith("_self_"): object.__delattr__(self, name) - elif name == '__wrapped__': - raise TypeError('__wrapped__ must be an object') + elif name == "__wrapped__": + raise TypeError("__wrapped__ attribute cannot be deleted") - elif name == '__qualname__': + elif name == "__qualname__": object.__delattr__(self, name) delattr(self.__wrapped__, name) @@ -236,9 +298,6 @@ def __sub__(self, other): def __mul__(self, other): return self.__wrapped__ * other - def __div__(self, other): - return operator.div(self.__wrapped__, other) - def __truediv__(self, other): return operator.truediv(self.__wrapped__, other) @@ -278,9 +337,6 @@ def __rsub__(self, other): def __rmul__(self, other): return other * self.__wrapped__ - def __rdiv__(self, other): - return operator.div(other, self.__wrapped__) - def __rtruediv__(self, other): return operator.truediv(other, self.__wrapped__) @@ -312,56 +368,90 @@ def __ror__(self, other): return other | self.__wrapped__ def __iadd__(self, other): - self.__wrapped__ += other - return self + if hasattr(self.__wrapped__, "__iadd__"): + self.__wrapped__ += other + return self + else: + return self.__object_proxy__(self.__wrapped__ + other) def __isub__(self, other): - self.__wrapped__ -= other - return self + if hasattr(self.__wrapped__, "__isub__"): + self.__wrapped__ -= other + return self + else: + return self.__object_proxy__(self.__wrapped__ - other) def __imul__(self, other): - self.__wrapped__ *= other - return self - - def __idiv__(self, other): - self.__wrapped__ = operator.idiv(self.__wrapped__, other) - return self + if hasattr(self.__wrapped__, "__imul__"): + self.__wrapped__ *= other + return self + else: + return self.__object_proxy__(self.__wrapped__ * other) def __itruediv__(self, other): - self.__wrapped__ = operator.itruediv(self.__wrapped__, other) - return self + if hasattr(self.__wrapped__, "__itruediv__"): + self.__wrapped__ /= other + return self + else: + return self.__object_proxy__(self.__wrapped__ / other) def __ifloordiv__(self, other): - self.__wrapped__ //= other - return self + if hasattr(self.__wrapped__, "__ifloordiv__"): + self.__wrapped__ //= other + return self + else: + return self.__object_proxy__(self.__wrapped__ // other) def __imod__(self, other): - self.__wrapped__ %= other - return self + if hasattr(self.__wrapped__, "__imod__"): + self.__wrapped__ %= other + return self + else: + return self.__object_proxy__(self.__wrapped__ % other) - def __ipow__(self, other): - self.__wrapped__ **= other return self + def __ipow__(self, other): # type: ignore[misc] + if hasattr(self.__wrapped__, "__ipow__"): + self.__wrapped__ **= other + return self + else: + return self.__object_proxy__(self.__wrapped__**other) + def __ilshift__(self, other): - self.__wrapped__ <<= other - return self + if hasattr(self.__wrapped__, "__ilshift__"): + self.__wrapped__ <<= other + return self + else: + return self.__object_proxy__(self.__wrapped__ << other) def __irshift__(self, other): - self.__wrapped__ >>= other - return self + if hasattr(self.__wrapped__, "__irshift__"): + self.__wrapped__ >>= other + return self + else: + return self.__object_proxy__(self.__wrapped__ >> other) def __iand__(self, other): - self.__wrapped__ &= other - return self + if hasattr(self.__wrapped__, "__iand__"): + self.__wrapped__ &= other + return self + else: + return self.__object_proxy__(self.__wrapped__ & other) def __ixor__(self, other): - self.__wrapped__ ^= other - return self + if hasattr(self.__wrapped__, "__ixor__"): + self.__wrapped__ ^= other + return self + else: + return self.__object_proxy__(self.__wrapped__ ^ other) def __ior__(self, other): - self.__wrapped__ |= other - return self + if hasattr(self.__wrapped__, "__ior__"): + self.__wrapped__ |= other + return self + else: + return self.__object_proxy__(self.__wrapped__ | other) def __neg__(self): return -self.__wrapped__ @@ -378,9 +468,6 @@ def __invert__(self): def __int__(self): return int(self.__wrapped__) - def __long__(self): - return long(self.__wrapped__) - def __float__(self): return float(self.__wrapped__) @@ -396,6 +483,19 @@ def __hex__(self): def __index__(self): return operator.index(self.__wrapped__) + def __matmul__(self, other): + return self.__wrapped__ @ other + + def __rmatmul__(self, other): + return other @ self.__wrapped__ + + def __imatmul__(self, other): + if hasattr(self.__wrapped__, "__imatmul__"): + self.__wrapped__ @= other + return self + else: + return self.__object_proxy__(self.__wrapped__ @ other) + def __len__(self): return len(self.__wrapped__) @@ -426,22 +526,24 @@ def __enter__(self): def __exit__(self, *args, **kwargs): return self.__wrapped__.__exit__(*args, **kwargs) - def __iter__(self): - return iter(self.__wrapped__) + def __aenter__(self): + return self.__wrapped__.__aenter__() + + def __aexit__(self, *args, **kwargs): + return self.__wrapped__.__aexit__(*args, **kwargs) def __copy__(self): - raise NotImplementedError('object proxy must define __copy__()') + raise NotImplementedError("object proxy must define __copy__()") def __deepcopy__(self, memo): - raise NotImplementedError('object proxy must define __deepcopy__()') + raise NotImplementedError("object proxy must define __deepcopy__()") def __reduce__(self): - raise NotImplementedError( - 'object proxy must define __reduce_ex__()') + raise NotImplementedError("object proxy must define __reduce__()") def __reduce_ex__(self, protocol): - raise NotImplementedError( - 'object proxy must define __reduce_ex__()') + raise NotImplementedError("object proxy must define __reduce_ex__()") + class CallableObjectProxy(ObjectProxy): @@ -453,21 +555,31 @@ def _unpack_self(self, *args): return self.__wrapped__(*args, **kwargs) + class PartialCallableObjectProxy(ObjectProxy): + """A callable object proxy that supports partial application of arguments + and keywords. + """ def __init__(*args, **kwargs): + """Create a callable object proxy with partial application of the given + arguments and keywords. This behaves the same as `functools.partial`, but + implemented using the `ObjectProxy` class to provide better support for + introspection. + """ + def _unpack_self(self, *args): return self, args self, args = _unpack_self(*args) if len(args) < 1: - raise TypeError('partial type takes at least one argument') + raise TypeError("partial type takes at least one argument") wrapped, args = args[0], args[1:] if not callable(wrapped): - raise TypeError('the first argument must be callable') + raise TypeError("the first argument must be callable") super(PartialCallableObjectProxy, self).__init__(wrapped) @@ -479,7 +591,7 @@ def _unpack_self(self, *args): return self, args self, args = _unpack_self(*args) - + _args = self._self_args + args _kwargs = dict(self._self_kwargs) @@ -487,75 +599,112 @@ def _unpack_self(self, *args): return self.__wrapped__(*_args, **_kwargs) -class _FunctionWrapperBase(ObjectProxy): - __slots__ = ('_self_instance', '_self_wrapper', '_self_enabled', - '_self_binding', '_self_parent') +class _FunctionWrapperBase(ObjectProxy): - def __init__(self, wrapped, instance, wrapper, enabled=None, - binding='function', parent=None): + __slots__ = ( + "_self_instance", + "_self_wrapper", + "_self_enabled", + "_self_binding", + "_self_parent", + "_self_owner", + ) + + def __init__( + self, + wrapped, + instance, + wrapper, + enabled=None, + binding="callable", + parent=None, + owner=None, + ): super(_FunctionWrapperBase, self).__init__(wrapped) - object.__setattr__(self, '_self_instance', instance) - object.__setattr__(self, '_self_wrapper', wrapper) - object.__setattr__(self, '_self_enabled', enabled) - object.__setattr__(self, '_self_binding', binding) - object.__setattr__(self, '_self_parent', parent) + object.__setattr__(self, "_self_instance", instance) + object.__setattr__(self, "_self_wrapper", wrapper) + object.__setattr__(self, "_self_enabled", enabled) + object.__setattr__(self, "_self_binding", binding) + object.__setattr__(self, "_self_parent", parent) + object.__setattr__(self, "_self_owner", owner) def __get__(self, instance, owner): - # This method is actually doing double duty for both unbound and - # bound derived wrapper classes. It should possibly be broken up - # and the distinct functionality moved into the derived classes. - # Can't do that straight away due to some legacy code which is - # relying on it being here in this base class. + # This method is actually doing double duty for both unbound and bound + # derived wrapper classes. It should possibly be broken up and the + # distinct functionality moved into the derived classes. Can't do that + # straight away due to some legacy code which is relying on it being + # here in this base class. # - # The distinguishing attribute which determines whether we are - # being called in an unbound or bound wrapper is the parent - # attribute. If binding has never occurred, then the parent will - # be None. + # The distinguishing attribute which determines whether we are being + # called in an unbound or bound wrapper is the parent attribute. If + # binding has never occurred, then the parent will be None. # - # First therefore, is if we are called in an unbound wrapper. In - # this case we perform the binding. + # First therefore, is if we are called in an unbound wrapper. In this + # case we perform the binding. # - # We have one special case to worry about here. This is where we - # are decorating a nested class. In this case the wrapped class - # would not have a __get__() method to call. In that case we - # simply return self. + # We have two special cases to worry about here. These are where we are + # decorating a class or builtin function as neither provide a __get__() + # method to call. In this case we simply return self. # - # Note that we otherwise still do binding even if instance is - # None and accessing an unbound instance method from a class. - # This is because we need to be able to later detect that - # specific case as we will need to extract the instance from the - # first argument of those passed in. + # Note that we otherwise still do binding even if instance is None and + # accessing an unbound instance method from a class. This is because we + # need to be able to later detect that specific case as we will need to + # extract the instance from the first argument of those passed in. if self._self_parent is None: - if not inspect.isclass(self.__wrapped__): - descriptor = self.__wrapped__.__get__(instance, owner) + # Technically can probably just check for existence of __get__ on + # the wrapped object, but this is more explicit. - return self.__bound_function_wrapper__(descriptor, instance, - self._self_wrapper, self._self_enabled, - self._self_binding, self) + if self._self_binding == "builtin": + return self - return self + if self._self_binding == "class": + return self + + binder = getattr(self.__wrapped__, "__get__", None) + + if binder is None: + return self - # Now we have the case of binding occurring a second time on what - # was already a bound function. In this case we would usually - # return ourselves again. This mirrors what Python does. + descriptor = binder(instance, owner) + + return self.__bound_function_wrapper__( + descriptor, + instance, + self._self_wrapper, + self._self_enabled, + self._self_binding, + self, + owner, + ) + + # Now we have the case of binding occurring a second time on what was + # already a bound function. In this case we would usually return + # ourselves again. This mirrors what Python does. # - # The special case this time is where we were originally bound - # with an instance of None and we were likely an instance - # method. In that case we rebind against the original wrapped - # function from the parent again. + # The special case this time is where we were originally bound with an + # instance of None and we were likely an instance method. In that case + # we rebind against the original wrapped function from the parent again. - if self._self_instance is None and self._self_binding == 'function': - descriptor = self._self_parent.__wrapped__.__get__( - instance, owner) + if self._self_instance is None and self._self_binding in ( + "function", + "instancemethod", + "callable", + ): + descriptor = self._self_parent.__wrapped__.__get__(instance, owner) return self._self_parent.__bound_function_wrapper__( - descriptor, instance, self._self_wrapper, - self._self_enabled, self._self_binding, - self._self_parent) + descriptor, + instance, + self._self_wrapper, + self._self_enabled, + self._self_binding, + self._self_parent, + owner, + ) return self @@ -582,12 +731,16 @@ def _unpack_self(self, *args): # a function that was already bound to an instance. In that case # we want to extract the instance from the function and use it. - if self._self_binding in ('function', 'classmethod'): + if self._self_binding in ( + "function", + "instancemethod", + "classmethod", + "callable", + ): if self._self_instance is None: - instance = getattr(self.__wrapped__, '__self__', None) + instance = getattr(self.__wrapped__, "__self__", None) if instance is not None: - return self._self_wrapper(self.__wrapped__, instance, - args, kwargs) + return self._self_wrapper(self.__wrapped__, instance, args, kwargs) # This is generally invoked when the wrapped function is being # called as a normal function and is not bound to a class as an @@ -595,8 +748,7 @@ def _unpack_self(self, *args): # wrapped function was a method, but this wrapper was in turn # wrapped using the staticmethod decorator. - return self._self_wrapper(self.__wrapped__, self._self_instance, - args, kwargs) + return self._self_wrapper(self.__wrapped__, self._self_instance, args, kwargs) def __set_name__(self, owner, name): # This is a special method use to supply information to @@ -625,6 +777,7 @@ def __subclasscheck__(self, subclass): else: return issubclass(subclass, self.__wrapped__) + class BoundFunctionWrapper(_FunctionWrapperBase): def __call__(*args, **kwargs): @@ -633,11 +786,11 @@ def _unpack_self(self, *args): self, args = _unpack_self(*args) - # If enabled has been specified, then evaluate it at this point - # and if the wrapper is not to be executed, then simply return - # the bound function rather than a bound wrapper for the bound - # function. When evaluating enabled, if it is callable we call - # it, otherwise we evaluate it as a boolean. + # If enabled has been specified, then evaluate it at this point and if + # the wrapper is not to be executed, then simply return the bound + # function rather than a bound wrapper for the bound function. When + # evaluating enabled, if it is callable we call it, otherwise we + # evaluate it as a boolean. if self._self_enabled is not None: if callable(self._self_enabled): @@ -646,28 +799,39 @@ def _unpack_self(self, *args): elif not self._self_enabled: return self.__wrapped__(*args, **kwargs) - # We need to do things different depending on whether we are - # likely wrapping an instance method vs a static method or class - # method. + # We need to do things different depending on whether we are likely + # wrapping an instance method vs a static method or class method. + + if self._self_binding == "function": + if self._self_instance is None and args: + instance, newargs = args[0], args[1:] + if isinstance(instance, self._self_owner): + wrapped = PartialCallableObjectProxy(self.__wrapped__, instance) + return self._self_wrapper(wrapped, instance, newargs, kwargs) - if self._self_binding == 'function': + return self._self_wrapper( + self.__wrapped__, self._self_instance, args, kwargs + ) + + elif self._self_binding == "callable": if self._self_instance is None: # This situation can occur where someone is calling the - # instancemethod via the class type and passing the instance - # as the first argument. We need to shift the args before - # making the call to the wrapper and effectively bind the - # instance to the wrapped function using a partial so the - # wrapper doesn't see anything as being different. + # instancemethod via the class type and passing the instance as + # the first argument. We need to shift the args before making + # the call to the wrapper and effectively bind the instance to + # the wrapped function using a partial so the wrapper doesn't + # see anything as being different. if not args: - raise TypeError('missing 1 required positional argument') + raise TypeError("missing 1 required positional argument") instance, args = args[0], args[1:] wrapped = PartialCallableObjectProxy(self.__wrapped__, instance) return self._self_wrapper(wrapped, instance, args, kwargs) - return self._self_wrapper(self.__wrapped__, self._self_instance, - args, kwargs) + return self._self_wrapper( + self.__wrapped__, self._self_instance, args, kwargs + ) else: # As in this case we would be dealing with a classmethod or @@ -683,16 +847,32 @@ def _unpack_self(self, *args): # class type, as it reflects what they have available in the # decoratored function. - instance = getattr(self.__wrapped__, '__self__', None) + instance = getattr(self.__wrapped__, "__self__", None) + + return self._self_wrapper(self.__wrapped__, instance, args, kwargs) - return self._self_wrapper(self.__wrapped__, instance, args, - kwargs) class FunctionWrapper(_FunctionWrapperBase): + """ + A wrapper for callable objects that can be used to apply decorators to + functions, methods, classmethods, and staticmethods, or any other callable. + It handles binding and unbinding of methods, and allows for the wrapper to + be enabled or disabled. + """ __bound_function_wrapper__ = BoundFunctionWrapper def __init__(self, wrapped, wrapper, enabled=None): + """ + Initialize the `FunctionWrapper` with the `wrapped` callable, the + `wrapper` function, and an optional `enabled` argument. The `enabled` + argument can be a boolean or a callable that returns a boolean. When a + callable is provided, it will be called each time the wrapper is + invoked to determine if the wrapper function should be executed or + whether the wrapped function should be called directly. If `enabled` + is not provided, the wrapper is enabled by default. + """ + # What it is we are wrapping here could be anything. We need to # try and detect specific cases though. In particular, we need # to detect when we are given something that is a method of a @@ -733,7 +913,7 @@ def __init__(self, wrapped, wrapper, enabled=None): # # 4. The wrapper is being applied when performing monkey # patching of an instance of a class. In this case binding will - # have been perfomed where the instance was not None. + # have been performed where the instance was not None. # # This case is a problem because we can no longer tell if the # method was a static method. @@ -759,26 +939,42 @@ def __init__(self, wrapped, wrapper, enabled=None): # or patch it in the __dict__ of the class type. # # So to get the best outcome we can, whenever we aren't sure what - # it is, we label it as a 'function'. If it was already bound and + # it is, we label it as a 'callable'. If it was already bound and # that is rebound later, we assume that it will be an instance - # method and try an cope with the possibility that the 'self' + # method and try and cope with the possibility that the 'self' # argument it being passed as an explicit argument and shuffle # the arguments around to extract 'self' for use as the instance. - if isinstance(wrapped, classmethod): - binding = 'classmethod' + binding = None - elif isinstance(wrapped, staticmethod): - binding = 'staticmethod' + if isinstance(wrapped, _FunctionWrapperBase): + binding = wrapped._self_binding - elif hasattr(wrapped, '__self__'): - if inspect.isclass(wrapped.__self__): - binding = 'classmethod' - else: - binding = 'function' + if not binding: + if inspect.isbuiltin(wrapped): + binding = "builtin" - else: - binding = 'function' + elif inspect.isfunction(wrapped): + binding = "function" + + elif inspect.isclass(wrapped): + binding = "class" + + elif isinstance(wrapped, classmethod): + binding = "classmethod" + + elif isinstance(wrapped, staticmethod): + binding = "staticmethod" + + elif hasattr(wrapped, "__self__"): + if inspect.isclass(wrapped.__self__): + binding = "classmethod" + elif inspect.ismethod(wrapped): + binding = "instancemethod" + else: + binding = "callable" + + else: + binding = "callable" - super(FunctionWrapper, self).__init__(wrapped, None, wrapper, - enabled, binding) + super(FunctionWrapper, self).__init__(wrapped, None, wrapper, enabled, binding) diff --git a/tests/datastore_psycopg/test_cursor.py b/tests/datastore_psycopg/test_cursor.py index ef5eb939f9..f37f00710e 100644 --- a/tests/datastore_psycopg/test_cursor.py +++ b/tests/datastore_psycopg/test_cursor.py @@ -98,7 +98,7 @@ async def _execute(connection, cursor, row_type, wrapper): # Consume inserted records to check that returning param functions records = [] while True: - records.append(cursor.fetchone()) + records.append(await maybe_await(cursor.fetchone())) if not cursor.nextset(): break assert len(records) == len(params) @@ -140,7 +140,7 @@ async def _exercise_db(connection, row_factory=None, use_cur_context=False, row_ try: cursor = connection.cursor(**kwargs) if use_cur_context: - if hasattr(cursor, "__aenter__"): + if hasattr(cursor.__wrapped__, "__aenter__"): async with cursor: await _execute(connection, cursor, row_type, wrapper) else: diff --git a/tests/datastore_psycopg/test_register.py b/tests/datastore_psycopg/test_register.py index 46ea9dfcb4..dd605774f8 100644 --- a/tests/datastore_psycopg/test_register.py +++ b/tests/datastore_psycopg/test_register.py @@ -32,7 +32,7 @@ def test(): psycopg.types.json.set_json_loads(loads=lambda x: x, context=connection) psycopg.types.json.set_json_loads(loads=lambda x: x, context=cursor) - if hasattr(connection, "__aenter__"): + if hasattr(connection.__wrapped__, "__aenter__"): async def coro(): async with connection: @@ -69,7 +69,7 @@ async def test(): await maybe_await(cursor.execute(f"DROP TYPE if exists {type_name}")) - if hasattr(connection, "__aenter__"): + if hasattr(connection.__wrapped__, "__aenter__"): async def coro(): async with connection: diff --git a/tests/datastore_psycopg/test_rollback.py b/tests/datastore_psycopg/test_rollback.py index 2d652ee1ee..41849fa8e3 100644 --- a/tests/datastore_psycopg/test_rollback.py +++ b/tests/datastore_psycopg/test_rollback.py @@ -57,7 +57,7 @@ async def _exercise_db(connection): try: - if hasattr(connection, "__aenter__"): + if hasattr(connection.__wrapped__, "__aenter__"): async with connection: raise RuntimeError("error") else: diff --git a/tox.ini b/tox.ini index e27ce2ef83..10b69447c3 100644 --- a/tox.ini +++ b/tox.ini @@ -20,7 +20,7 @@ ; framework_aiohttp-aiohttp01: aiohttp<2 ; framework_aiohttp-aiohttp0202: aiohttp<2.3 ; 3. Python version required. Uses the standard tox definitions. (https://tox.readthedocs.io/en/latest/config.html#tox-environments) -; Examples: py38,py39,py310,py311,py312,py313,py314,pypy311 +; Examples: py38,py39,py310,py311,py312,py313,py314,py314t,pypy311 ; 4. Library and version (Optional). Used when testing multiple versions of the library, and may be omitted when only testing a single version. ; Versions should be specified with 2 digits per version number, so <3 becomes 02 and <3.5 becomes 0304. latest and master are also acceptable versions. ; Examples: uvicorn03, CherryPy0302, uvicornlatest @@ -61,157 +61,157 @@ envlist = {linux,linux_arm64}-cross_agent-pypy311-without_extensions, # Windows Core Agent Test Suite - {windows,windows_arm64}-agent_features-{py313,py314}-{with,without}_extensions, + {windows,windows_arm64}-agent_features-{py313,py314,py314t}-{with,without}_extensions, # Windows grpcio wheels don't appear to be installable for Arm64 despite being available windows-agent_streaming-{py313,py314}-protobuf06-{with,without}_extensions, - {windows,windows_arm64}-agent_unittests-{py313,py314}-{with,without}_extensions, - {windows,windows_arm64}-cross_agent-{py313,py314}-{with,without}_extensions, + {windows,windows_arm64}-agent_unittests-{py313,py314,py314t}-{with,without}_extensions, + {windows,windows_arm64}-cross_agent-{py313,py314,py314t}-{with,without}_extensions, # Integration Tests (only run on Linux) cassandra-datastore_cassandradriver-py38-cassandra032903, cassandra-datastore_cassandradriver-{py39,py310,py311,py312,pypy311}-cassandralatest, - elasticsearchserver07-datastore_elasticsearch-{py38,py39,py310,py311,py312,py313,py314,pypy311}-elasticsearch07, - elasticsearchserver08-datastore_elasticsearch-{py38,py39,py310,py311,py312,py313,py314,pypy311}-elasticsearch08, - firestore-datastore_firestore-{py38,py39,py310,py311,py312,py313,py314}, - grpc-framework_grpc-{py39,py310,py311,py312,py313,py314}-grpclatest, + elasticsearchserver07-datastore_elasticsearch-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-elasticsearch07, + elasticsearchserver08-datastore_elasticsearch-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-elasticsearch08, + firestore-datastore_firestore-{py38,py39,py310,py311,py312,py313,py314,py314t}, + grpc-framework_grpc-{py39,py310,py311,py312,py313,py314,py314t}-grpclatest, kafka-messagebroker_confluentkafka-py39-confluentkafka{0108,0107,0106}, kafka-messagebroker_confluentkafka-{py38,py39,py310,py311,py312,py313}-confluentkafkalatest, ;; Package not ready for Python 3.14 (confluent-kafka wheels not released) - ; kafka-messagebroker_confluentkafka-py314-confluentkafkalatest, - kafka-messagebroker_kafkapython-{py38,py39,py310,py311,py312,py313,py314,pypy311}-kafkapythonlatest, - kafka-messagebroker_kafkapython-{py38,py39,py310,py311,py312,py313,py314,pypy311}-kafkapythonnglatest, - memcached-datastore_aiomcache-{py38,py39,py310,py311,py312,py313,py314}, - memcached-datastore_bmemcached-{py38,py39,py310,py311,py312,py313,py314}, - memcached-datastore_memcache-{py38,py39,py310,py311,py312,py313,py314,pypy311}-memcached01, + ; kafka-messagebroker_confluentkafka-{py314,py314t}-confluentkafkalatest, + kafka-messagebroker_kafkapython-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-kafkapythonlatest, + kafka-messagebroker_kafkapython-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-kafkapythonnglatest, + memcached-datastore_aiomcache-{py38,py39,py310,py311,py312,py313,py314,py314t}, + memcached-datastore_bmemcached-{py38,py39,py310,py311,py312,py313,py314,py314t}, + memcached-datastore_memcache-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-memcached01, memcached-datastore_pylibmc-{py38,py39,py310,py311}, - memcached-datastore_pymemcache-{py38,py39,py310,py311,py312,py313,py314,pypy311}, - mongodb8-datastore_motor-{py38,py39,py310,py311,py312,py313,py314}-motorlatest, + memcached-datastore_pymemcache-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, + mongodb8-datastore_motor-{py38,py39,py310,py311,py312,py313,py314,py314t}-motorlatest, mongodb3-datastore_pymongo-{py38,py39,py310,py311,py312}-pymongo03, - mongodb8-datastore_pymongo-{py38,py39,py310,py311,py312,py313,py314,pypy311}-pymongo04, - mysql-datastore_aiomysql-{py38,py39,py310,py311,py312,py313,py314,pypy311}, - mssql-datastore_pymssql-pymssqllatest-{py39,py310,py311,py312,py313,py314}, + mongodb8-datastore_pymongo-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-pymongo04, + mysql-datastore_aiomysql-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, + mssql-datastore_pymssql-pymssqllatest-{py39,py310,py311,py312,py313,py314,py314t}, mssql-datastore_pymssql-pymssql020301-py38, - mysql-datastore_mysql-mysqllatest-{py38,py39,py310,py311,py312,py313,py314}, - mysql-datastore_mysqldb-{py38,py39,py310,py311,py312,py313,py314}, - mysql-datastore_pymysql-{py38,py39,py310,py311,py312,py313,py314,pypy311}, - oracledb-datastore_oracledb-{py39,py310,py311,py312,py313,py314}-oracledblatest, - oracledb-datastore_oracledb-{py39,py313,py314}-oracledb02, + mysql-datastore_mysql-mysqllatest-{py38,py39,py310,py311,py312,py313,py314,py314t}, + mysql-datastore_mysqldb-{py38,py39,py310,py311,py312,py313,py314,py314t}, + mysql-datastore_pymysql-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, + oracledb-datastore_oracledb-{py39,py310,py311,py312,py313,py314,py314t}-oracledblatest, + oracledb-datastore_oracledb-{py39,py313,py314,py314t}-oracledb02, oracledb-datastore_oracledb-{py39,py312}-oracledb01, - nginx-external_httpx-{py38,py39,py310,py311,py312,py313,py314}, - postgres16-datastore_asyncpg-{py38,py39,py310,py311,py312,py313,py314}, - postgres16-datastore_psycopg-{py38,py39,py310,py311,py312,py313,py314,pypy311}-psycopglatest, + nginx-external_httpx-{py38,py39,py310,py311,py312,py313,py314,py314t}, + postgres16-datastore_asyncpg-{py38,py39,py310,py311,py312,py313,py314,py314t}, + postgres16-datastore_psycopg-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-psycopglatest, postgres16-datastore_psycopg-py312-psycopg_{purepython,binary,compiled}0301, postgres16-datastore_psycopg2-{py38,py39,py310,py311,py312}-psycopg2latest, postgres16-datastore_psycopg2cffi-{py38,py39,py310,py311,py312}-psycopg2cffilatest, - postgres16-datastore_pyodbc-{py38,py39,py310,py311,py312,py313,py314}-pyodbclatest, - postgres9-datastore_postgresql-{py38,py39,py310,py311,py312,py313,py314}, - python-adapter_asgiref-{py38,py39,py310,py311,py312,py313,py314,pypy311}-asgireflatest, + postgres16-datastore_pyodbc-{py38,py39,py310,py311,py312,py313,py314,py314t}-pyodbclatest, + postgres9-datastore_postgresql-{py38,py39,py310,py311,py312,py313,py314,py314t}, + python-adapter_asgiref-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-asgireflatest, python-adapter_asgiref-py310-asgiref{0303,0304,0305,0306,0307}, - python-adapter_cheroot-{py38,py39,py310,py311,py312,py313,py314}, - python-adapter_daphne-{py38,py39,py310,py311,py312,py313,py314}-daphnelatest, - python-adapter_gevent-{py38,py310,py311,py312,py313,py314}, + python-adapter_cheroot-{py38,py39,py310,py311,py312,py313,py314,py314t}, + python-adapter_daphne-{py38,py39,py310,py311,py312,py313,py314,py314t}-daphnelatest, + python-adapter_gevent-{py38,py310,py311,py312,py313,py314,py314t}, python-adapter_gunicorn-{py38,py39,py310,py311,py312,py313}-aiohttp03-gunicornlatest, ;; Package not ready for Python 3.14 (aiohttp's worker not updated) - ; python-adapter_gunicorn-py314-aiohttp03-gunicornlatest, - python-adapter_hypercorn-{py310,py311,py312,py313,py314}-hypercornlatest, - python-adapter_hypercorn-{py38,py39}-hypercorn{0010,0011,0012,0013}, - python-adapter_mcp-{py310,py311,py312,py313,py314}, - python-adapter_uvicorn-{py38,py39,py310,py311,py312,py313,py314}-uvicornlatest, + ; python-adapter_gunicorn-{py314,py314t}-aiohttp03-gunicornlatest, + python-adapter_hypercorn-{py38,py39,py310,py311,py312,py313,py314,py314t}-hypercornlatest, + python-adapter_hypercorn-py38-hypercorn{0010,0011,0012,0013}, + python-adapter_mcp-{py310,py311,py312,py313,py314,py314t}, + python-adapter_uvicorn-{py38,py39,py310,py311,py312,py313,py314,py314t}-uvicornlatest, python-adapter_uvicorn-py38-uvicorn014, - python-adapter_waitress-{py38,py39,py310,py311,py312,py313,py314}-waitresslatest, - python-application_celery-{py38,py39,py310,py311,py312,py313,py314,pypy311}-celerylatest, + python-adapter_waitress-{py38,py39,py310,py311,py312,py313,py314,py314t}-waitresslatest, + python-application_celery-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-celerylatest, python-application_celery-py311-celery{0504,0503,0502}, - python-component_djangorestframework-{py38,py39,py310,py311,py312,py313,py314}-djangorestframeworklatest, - python-component_flask_rest-{py38,py39,py310,py311,py312,py313,py314,pypy311}-flaskrestxlatest, + python-component_djangorestframework-{py38,py39,py310,py311,py312,py313,py314,py314t}-djangorestframeworklatest, + python-component_flask_rest-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-flaskrestxlatest, python-component_graphqlserver-{py38,py39,py310,py311,py312}, ;; Tests need to be updated to support newer graphql-server/sanic versions - ; python-component_graphqlserver-{py313,py314}, - python-component_tastypie-{py38,py39,py310,py311,py312,py313,py314,pypy311}-tastypielatest, - python-coroutines_asyncio-{py38,py39,py310,py311,py312,py313,py314,pypy311}, - python-datastore_sqlite-{py38,py39,py310,py311,py312,py313,py314,pypy311}, + ; python-component_graphqlserver-{py313,py314,py314t}, + python-component_tastypie-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-tastypielatest, + python-coroutines_asyncio-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, + python-datastore_sqlite-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, python-external_aiobotocore-{py38,py39,py310,py311,py312,py313}-aiobotocorelatest, ;; Package not ready for Python 3.14 (hangs when running) - ; python-external_aiobotocore-py314-aiobotocorelatest, - python-external_botocore-{py38,py39,py310,py311,py312,py313,py314}-botocorelatest, + ; python-external_aiobotocore-{py314,py314t}-aiobotocorelatest, + python-external_botocore-{py38,py39,py310,py311,py312,py313,py314,py314t}-botocorelatest, python-external_botocore-{py311}-botocorelatest-langchain, python-external_botocore-py310-botocore0125, python-external_botocore-py311-botocore0128, - python-external_feedparser-{py38,py39,py310,py311,py312,py313,py314}-feedparser06, - python-external_http-{py38,py39,py310,py311,py312,py313,py314}, - python-external_httplib-{py38,py39,py310,py311,py312,py313,py314,pypy311}, - python-external_httplib2-{py38,py39,py310,py311,py312,py313,py314,pypy311}, + python-external_feedparser-{py38,py39,py310,py311,py312,py313,py314,py314t}-feedparser06, + python-external_http-{py38,py39,py310,py311,py312,py313,py314,py314t}, + python-external_httplib-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, + python-external_httplib2-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, # pyzeebe requires grpcio which does not support pypy - python-external_pyzeebe-{py39,py310,py311,py312,py313,py314}, - python-external_requests-{py38,py39,py310,py311,py312,py313,py314,pypy311}, - python-external_urllib3-{py38,py39,py310,py311,py312,py313,py314,pypy311}-urllib3latest, - python-external_urllib3-{py312,py313,py314,pypy311}-urllib30126, - python-framework_aiohttp-{py38,py39,py310,py311,py312,py313,py314,pypy311}-aiohttp03, - python-framework_ariadne-{py38,py39,py310,py311,py312,py313,py314}-ariadnelatest, + python-external_pyzeebe-{py39,py310,py311,py312,py313,py314,py314t}, + python-external_requests-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, + python-external_urllib3-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-urllib3latest, + python-external_urllib3-{py312,py313,py314,py314t,pypy311}-urllib30126, + python-framework_aiohttp-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-aiohttp03, + python-framework_ariadne-{py38,py39,py310,py311,py312,py313,py314,py314t}-ariadnelatest, python-framework_azurefunctions-{py39,py310,py311,py312}, - python-framework_bottle-{py38,py39,py310,py311,py312,py313,py314,pypy311}-bottle0012, - python-framework_cherrypy-{py38,py39,py310,py311,py312,py313,py314,pypy311}-CherryPylatest, - python-framework_django-{py38,py39,py310,py311,py312,py313,py314}-Djangolatest, + python-framework_bottle-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-bottle0012, + python-framework_cherrypy-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-CherryPylatest, + python-framework_django-{py38,py39,py310,py311,py312,py313,py314,py314t}-Djangolatest, python-framework_django-py39-Django{0202,0300,0301,0302,0401}, - python-framework_falcon-{py39,py310,py311,py312,py313,py314,pypy311}-falconlatest, + python-framework_falcon-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-falconlatest, python-framework_falcon-py38-falcon0410, - python-framework_falcon-{py39,py310,py311,py312,py313,py314,pypy311}-falconmaster, - python-framework_fastapi-{py38,py39,py310,py311,py312,py313,py314}, + python-framework_falcon-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-falconmaster, + python-framework_fastapi-{py38,py39,py310,py311,py312,py313,py314,py314t}, python-framework_flask-{py38,py39,py310,py311,py312,pypy311}-flask02, ; python-framework_flask-py38-flaskmaster fails, even with Flask-Compress<1.16 and coverage==7.61 for py38 python-framework_flask-py38-flasklatest, ; flaskmaster tests disabled until they can be fixed - python-framework_flask-{py39,py310,py311,py312,py313,py314,pypy311}-flask{latest}, - python-framework_graphene-{py38,py39,py310,py311,py312,py313,py314}-graphenelatest, - python-component_graphenedjango-{py38,py39,py310,py311,py312,py313,py314}-graphenedjangolatest, - python-framework_graphql-{py38,py39,py310,py311,py312,py313,py314,pypy311}-graphql03, - python-framework_graphql-{py38,py39,py310,py311,py312,py313,py314,pypy311}-graphqllatest, - python-framework_pyramid-{py38,py39,py310,py311,py312,py313,py314,pypy311}-Pyramidlatest, - python-framework_pyramid-{py38,py39,py310,py311,py312,py313,py314,pypy311}-cornicelatest, + python-framework_flask-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-flask{latest}, + python-framework_graphene-{py38,py39,py310,py311,py312,py313,py314,py314t}-graphenelatest, + python-component_graphenedjango-{py38,py39,py310,py311,py312,py313,py314,py314t}-graphenedjangolatest, + python-framework_graphql-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-graphql03, + python-framework_graphql-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-graphqllatest, + python-framework_pyramid-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-Pyramidlatest, + python-framework_pyramid-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-cornicelatest, python-framework_sanic-py38-sanic2406, - python-framework_sanic-{py39,py310,py311,py312,py313,py314,pypy311}-saniclatest, + python-framework_sanic-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-saniclatest, python-framework_sanic-py38-sanic2290, python-framework_starlette-{py310,pypy311}-starlette{0014,0015,0019,0028}, - python-framework_starlette-{py38,py39,py310,py311,py312,py313,py314,pypy311}-starlettelatest, + python-framework_starlette-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-starlettelatest, python-framework_starlette-{py38}-starlette002001, python-framework_strawberry-{py38,py39,py310,py311,py312}-strawberry02352, - python-framework_strawberry-{py38,py39,py310,py311,py312,py313,py314}-strawberrylatest, - python-framework_tornado-{py38,py39,py310,py311,py312,py313,py314}-tornadolatest, - ; Remove `python-framework_tornado-py314-tornadomaster` temporarily + python-framework_strawberry-{py38,py39,py310,py311,py312,py313,py314,py314t}-strawberrylatest, + python-framework_tornado-{py38,py39,py310,py311,py312,py313,py314,py314t}-tornadolatest, + ; Remove `python-framework_tornado-{py314,py314t}-tornadomaster` temporarily python-framework_tornado-{py310,py311,py312,py313}-tornadomaster, - python-logger_logging-{py38,py39,py310,py311,py312,py313,py314,pypy311}, - python-logger_loguru-{py38,py39,py310,py311,py312,py313,py314,pypy311}-logurulatest, - python-logger_structlog-{py38,py39,py310,py311,py312,py313,py314,pypy311}-structloglatest, - python-mlmodel_autogen-{py310,py311,py312,py313,py314,pypy311}-autogen061, - python-mlmodel_autogen-{py310,py311,py312,py313,py314,pypy311}-autogenlatest, - python-mlmodel_gemini-{py39,py310,py311,py312,py313,py314}, + python-logger_logging-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, + python-logger_loguru-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-logurulatest, + python-logger_structlog-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-structloglatest, + python-mlmodel_autogen-{py310,py311,py312,py313,py314,py314t,pypy311}-autogen061, + python-mlmodel_autogen-{py310,py311,py312,py313,py314,py314t,pypy311}-autogenlatest, + python-mlmodel_gemini-{py39,py310,py311,py312,py313,py314,py314t}, python-mlmodel_langchain-{py39,py310,py311,py312,py313}, ;; Package not ready for Python 3.14 (type annotations not updated) - ; python-mlmodel_langchain-py314, + ; python-mlmodel_langchain-{py314,py314t}, python-mlmodel_openai-openai0-{py38,py39,py310,py311,py312}, python-mlmodel_openai-openai107-py312, - python-mlmodel_openai-openailatest-{py38,py39,py310,py311,py312,py313,py314}, - python-mlmodel_sklearn-{py38,py39,py310,py311,py312,py313,py314}-scikitlearnlatest, - python-template_genshi-{py38,py39,py310,py311,py312,py313,py314}-genshilatest, - python-template_jinja2-{py38,py39,py310,py311,py312,py313,py314}-jinja2latest, - python-template_mako-{py38,py39,py310,py311,py312,py313,py314}, - rabbitmq-messagebroker_pika-{py38,py39,py310,py311,py312,py313,py314,pypy311}-pikalatest, - rabbitmq-messagebroker_kombu-{py38,py39,py310,py311,py312,py313,py314,pypy311}-kombulatest, + python-mlmodel_openai-openailatest-{py38,py39,py310,py311,py312,py313,py314,py314t}, + python-mlmodel_sklearn-{py38,py39,py310,py311,py312,py313,py314,py314t}-scikitlearnlatest, + python-template_genshi-{py38,py39,py310,py311,py312,py313,py314,py314t}-genshilatest, + python-template_jinja2-{py38,py39,py310,py311,py312,py313,py314,py314t}-jinja2latest, + python-template_mako-{py38,py39,py310,py311,py312,py313,py314,py314t}, + rabbitmq-messagebroker_pika-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-pikalatest, + rabbitmq-messagebroker_kombu-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-kombulatest, rabbitmq-messagebroker_kombu-{py38,py39,py310,pypy311}-kombu050204, redis-datastore_redis-{py38,py39,py310,py311,pypy311}-redis04, redis-datastore_redis-{py38,py39,py310,py311,py312,pypy311}-redis05, - redis-datastore_redis-{py38,py39,py310,py311,py312,py313,py314,pypy311}-redislatest, - rediscluster-datastore_rediscluster-{py312,py313,py314,pypy311}-redislatest, - valkey-datastore_valkey-{py38,py39,py310,py311,py312,py313,py314,pypy311}-valkeylatest, - solr-datastore_pysolr-{py38,py39,py310,py311,py312,py313,py314,pypy311}, + redis-datastore_redis-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-redislatest, + rediscluster-datastore_rediscluster-{py312,py313,py314,py314t,pypy311}-redislatest, + valkey-datastore_valkey-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-valkeylatest, + solr-datastore_pysolr-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, [testenv] deps = # Base Dependencies - {py39,py310,py311,py312,py313,py314,pypy311}: pytest==8.4.1 + {py39,py310,py311,py312,py313,py314,py314t,pypy311}: pytest==8.4.1 py38: pytest==8.3.5 - {py39,py310,py311,py312,py313,py314,pypy311}: WebTest==3.0.6 + {py39,py310,py311,py312,py313,py314,py314t,pypy311}: WebTest==3.0.6 py38: WebTest==3.0.1 - py313,py314: legacy-cgi==2.6.1 # cgi was removed from the stdlib in 3.13, and is required for WebTest + py313,py314,py314t: legacy-cgi==2.6.1 # cgi was removed from the stdlib in 3.13, and is required for WebTest iniconfig coverage @@ -276,7 +276,7 @@ deps = component_tastypie-tastypielatest: django-tastypie component_tastypie-tastypielatest: django<4.1 component_tastypie-tastypielatest: asgiref<3.7.1 # asgiref==3.7.1 only suppport Python 3.10+ - coroutines_asyncio-{py38,py39,py310,py311,py312,py313,py314}: uvloop + coroutines_asyncio-{py38,py39,py310,py311,py312,py313,py314,py314t}: uvloop cross_agent: requests datastore_asyncpg: asyncpg datastore_aiomcache: aiomcache From b7348dccfbf1dc5754c67903b300be53a254d5df Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 16 Dec 2025 11:18:11 -0500 Subject: [PATCH 037/124] Bump the github_actions group across 1 directory with 6 updates (#1609) Bumps the github_actions group with 6 updates in the / directory: | Package | From | To | | --- | --- | --- | | [actions/checkout](https://github.com/actions/checkout) | `6.0.0` | `6.0.1` | | [actions/upload-artifact](https://github.com/actions/upload-artifact) | `5.0.0` | `6.0.0` | | [actions/download-artifact](https://github.com/actions/download-artifact) | `6.0.0` | `7.0.0` | | [codecov/codecov-action](https://github.com/codecov/codecov-action) | `5.5.1` | `5.5.2` | | [astral-sh/setup-uv](https://github.com/astral-sh/setup-uv) | `7.1.4` | `7.1.6` | | [github/codeql-action](https://github.com/github/codeql-action) | `4.31.6` | `4.31.8` | Updates `actions/checkout` from 6.0.0 to 6.0.1 - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/1af3b93b6815bc44a9784bd300feb67ff0d1eeb3...8e8c483db84b4bee98b60c0593521ed34d9990e8) Updates `actions/upload-artifact` from 5.0.0 to 6.0.0 - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](https://github.com/actions/upload-artifact/compare/330a01c490aca151604b8cf639adc76d48f6c5d4...b7c566a772e6b6bfb58ed0dc250532a479d7789f) Updates `actions/download-artifact` from 6.0.0 to 7.0.0 - [Release notes](https://github.com/actions/download-artifact/releases) - [Commits](https://github.com/actions/download-artifact/compare/018cc2cf5baa6db3ef3c5f8a56943fffe632ef53...37930b1c2abaa49bbe596cd826c3c89aef350131) Updates `codecov/codecov-action` from 5.5.1 to 5.5.2 - [Release notes](https://github.com/codecov/codecov-action/releases) - [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/codecov/codecov-action/compare/5a1091511ad55cbe89839c7260b706298ca349f7...671740ac38dd9b0130fbe1cec585b89eea48d3de) Updates `astral-sh/setup-uv` from 7.1.4 to 7.1.6 - [Release notes](https://github.com/astral-sh/setup-uv/releases) - [Commits](https://github.com/astral-sh/setup-uv/compare/1e862dfacbd1d6d858c55d9b792c756523627244...681c641aba71e4a1c380be3ab5e12ad51f415867) Updates `github/codeql-action` from 4.31.6 to 4.31.8 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/github/codeql-action/compare/fe4161a26a8629af62121b670040955b330f9af2...1b168cd39490f61582a9beae412bb7057a6b2c4e) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: 6.0.1 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions - dependency-name: actions/upload-artifact dependency-version: 6.0.0 dependency-type: direct:production update-type: version-update:semver-major dependency-group: github_actions - dependency-name: actions/download-artifact dependency-version: 7.0.0 dependency-type: direct:production update-type: version-update:semver-major dependency-group: github_actions - dependency-name: codecov/codecov-action dependency-version: 5.5.2 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions - dependency-name: astral-sh/setup-uv dependency-version: 7.1.6 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions - dependency-name: github/codeql-action dependency-version: 4.31.8 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/addlicense.yml | 2 +- .github/workflows/benchmarks.yml | 2 +- .github/workflows/build-ci-image.yml | 6 +- .github/workflows/deploy.yml | 10 +- .github/workflows/mega-linter.yml | 4 +- .github/workflows/tests.yml | 164 +++++++++++++-------------- .github/workflows/trivy.yml | 4 +- 7 files changed, 96 insertions(+), 96 deletions(-) diff --git a/.github/workflows/addlicense.yml b/.github/workflows/addlicense.yml index 171cbf7f59..e57534cc77 100644 --- a/.github/workflows/addlicense.yml +++ b/.github/workflows/addlicense.yml @@ -39,7 +39,7 @@ jobs: permissions: contents: read steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | diff --git a/.github/workflows/benchmarks.yml b/.github/workflows/benchmarks.yml index d66254bd9e..4bfbaf5e94 100644 --- a/.github/workflows/benchmarks.yml +++ b/.github/workflows/benchmarks.yml @@ -38,7 +38,7 @@ jobs: BASE_SHA: ${{ github.event.pull_request.base.sha }} steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 with: fetch-depth: 0 diff --git a/.github/workflows/build-ci-image.yml b/.github/workflows/build-ci-image.yml index ee867679ae..28d7677521 100644 --- a/.github/workflows/build-ci-image.yml +++ b/.github/workflows/build-ci-image.yml @@ -43,7 +43,7 @@ jobs: name: Docker Build ${{ matrix.platform }} steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 with: persist-credentials: false fetch-depth: 0 @@ -97,7 +97,7 @@ jobs: touch "${{ runner.temp }}/digests/${digest#sha256:}" - name: Upload Digest - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 with: name: digests-${{ matrix.cache_tag }} path: ${{ runner.temp }}/digests/* @@ -114,7 +114,7 @@ jobs: steps: - name: Download Digests - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # 6.0.0 + uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # 7.0.0 with: path: ${{ runner.temp }}/digests pattern: digests-* diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index c82c1d0654..488f3348d9 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -69,7 +69,7 @@ jobs: runs-on: ${{ matrix.os }} steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 with: persist-credentials: false fetch-depth: 0 @@ -97,7 +97,7 @@ jobs: CIBW_TEST_SKIP: "*-win_arm64" - name: Upload Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 with: name: ${{ github.job }}-${{ matrix.wheel }} path: ./wheelhouse/*.whl @@ -109,7 +109,7 @@ jobs: runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 with: persist-credentials: false fetch-depth: 0 @@ -134,7 +134,7 @@ jobs: openssl md5 -binary "dist/${tarball}" | xxd -p | tr -d '\n' > "dist/${md5_file}" - name: Upload Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 with: name: ${{ github.job }}-sdist path: | @@ -166,7 +166,7 @@ jobs: environment: ${{ matrix.pypi-instance }} steps: - - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # 6.0.0 + - uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # 7.0.0 with: path: ./dist/ merge-multiple: true diff --git a/.github/workflows/mega-linter.yml b/.github/workflows/mega-linter.yml index 76f6ea74b4..d3dfb4e7fd 100644 --- a/.github/workflows/mega-linter.yml +++ b/.github/workflows/mega-linter.yml @@ -45,7 +45,7 @@ jobs: steps: # Git Checkout - name: Checkout Code - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 with: token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }} fetch-depth: 0 # Required for pushing commits to PRs @@ -68,7 +68,7 @@ jobs: # Upload MegaLinter artifacts - name: Archive production artifacts if: success() || failure() - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 with: name: MegaLinter reports include-hidden-files: "true" diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index fcb9289971..3df2f338a4 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -93,14 +93,14 @@ jobs: - tests steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # 6.1.0 with: python-version: "3.13" architecture: x64 - name: Download Coverage Artifacts - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # 6.0.0 + uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # 7.0.0 with: pattern: coverage-* path: ./ @@ -113,7 +113,7 @@ jobs: coverage xml - name: Upload Coverage to Codecov - uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7 # 5.5.1 + uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # 5.5.2 with: files: coverage.xml fail_ci_if_error: true @@ -127,14 +127,14 @@ jobs: - tests steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # 6.1.0 with: python-version: "3.13" architecture: x64 - name: Download Results Artifacts - uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # 6.0.0 + uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # 7.0.0 with: pattern: results-* path: ./ @@ -166,7 +166,7 @@ jobs: --add-host=host.docker.internal:host-gateway timeout-minutes: 30 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -196,7 +196,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -206,7 +206,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -231,7 +231,7 @@ jobs: --add-host=host.docker.internal:host-gateway timeout-minutes: 30 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -261,7 +261,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -271,7 +271,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -294,14 +294,14 @@ jobs: runs-on: windows-2025 timeout-minutes: 30 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | git fetch --tags origin - name: Install uv - uses: astral-sh/setup-uv@1e862dfacbd1d6d858c55d9b792c756523627244 # 7.1.4 + uses: astral-sh/setup-uv@681c641aba71e4a1c380be3ab5e12ad51f415867 # 7.1.6 - name: Install Python run: | @@ -330,7 +330,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -340,7 +340,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -363,14 +363,14 @@ jobs: runs-on: windows-11-arm timeout-minutes: 30 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | git fetch --tags origin - name: Install uv - uses: astral-sh/setup-uv@1e862dfacbd1d6d858c55d9b792c756523627244 # 7.1.4 + uses: astral-sh/setup-uv@681c641aba71e4a1c380be3ab5e12ad51f415867 # 7.1.6 - name: Install Python run: | @@ -403,7 +403,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -413,7 +413,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -443,7 +443,7 @@ jobs: --add-host=host.docker.internal:host-gateway timeout-minutes: 30 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -473,7 +473,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -483,7 +483,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -526,7 +526,7 @@ jobs: --health-retries 10 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -556,7 +556,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -566,7 +566,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -606,7 +606,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -636,7 +636,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -646,7 +646,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -687,7 +687,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -717,7 +717,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -727,7 +727,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -772,7 +772,7 @@ jobs: # from every being executed as bash commands. steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -802,7 +802,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -812,7 +812,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -837,7 +837,7 @@ jobs: --add-host=host.docker.internal:host-gateway timeout-minutes: 30 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -867,7 +867,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -877,7 +877,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -927,7 +927,7 @@ jobs: KAFKA_CFG_INTER_BROKER_LISTENER_NAME: L3 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -957,7 +957,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -967,7 +967,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -1005,7 +1005,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -1035,7 +1035,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -1045,7 +1045,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -1083,7 +1083,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -1113,7 +1113,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -1123,7 +1123,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -1161,7 +1161,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -1191,7 +1191,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -1201,7 +1201,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -1244,7 +1244,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -1274,7 +1274,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -1284,7 +1284,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -1327,7 +1327,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -1357,7 +1357,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -1367,7 +1367,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -1406,7 +1406,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -1436,7 +1436,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -1446,7 +1446,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -1487,7 +1487,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -1517,7 +1517,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -1527,7 +1527,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -1567,7 +1567,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -1597,7 +1597,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -1607,7 +1607,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -1647,7 +1647,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -1677,7 +1677,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -1687,7 +1687,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -1726,7 +1726,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -1756,7 +1756,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -1766,7 +1766,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -1804,7 +1804,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -1834,7 +1834,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -1844,7 +1844,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -1923,7 +1923,7 @@ jobs: --add-host=host.docker.internal:host-gateway steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -1953,7 +1953,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -1963,7 +1963,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -2003,7 +2003,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -2033,7 +2033,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -2043,7 +2043,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} @@ -2081,7 +2081,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - name: Fetch git tags run: | @@ -2111,7 +2111,7 @@ jobs: FORCE_COLOR: "true" - name: Upload Coverage Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: coverage-${{ github.job }}-${{ strategy.job-index }} @@ -2121,7 +2121,7 @@ jobs: retention-days: 1 - name: Upload Results Artifacts - uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # 5.0.0 + uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # 6.0.0 if: always() with: name: results-${{ github.job }}-${{ strategy.job-index }} diff --git a/.github/workflows/trivy.yml b/.github/workflows/trivy.yml index a485674e55..99342be037 100644 --- a/.github/workflows/trivy.yml +++ b/.github/workflows/trivy.yml @@ -32,7 +32,7 @@ jobs: steps: # Git Checkout - name: Checkout Code - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # 6.0.0 + uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 with: token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }} fetch-depth: 0 @@ -61,6 +61,6 @@ jobs: - name: Upload Trivy scan results to GitHub Security tab if: ${{ github.event_name == 'schedule' }} - uses: github/codeql-action/upload-sarif@fe4161a26a8629af62121b670040955b330f9af2 # 4.31.6 + uses: github/codeql-action/upload-sarif@1b168cd39490f61582a9beae412bb7057a6b2c4e # 4.31.8 with: sarif_file: "trivy-results.sarif" From f8b4068eb4e5fc00ed3b69368a1081df1aee6065 Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Tue, 16 Dec 2025 21:32:13 -0500 Subject: [PATCH 038/124] Update list of trivy ignored cves (#1610) --- .github/.trivyignore | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/.github/.trivyignore b/.github/.trivyignore index 1f9f11bd30..b418eb9779 100644 --- a/.github/.trivyignore +++ b/.github/.trivyignore @@ -1,9 +1,15 @@ +# ============================= +# Accepted Risk Vulnerabilities +# ============================= + +# Accepting risk due to Python 3.8 support. +CVE-2025-50181 # Requires misconfiguration of urllib3, which agent does not do without intervention +CVE-2025-66418 # Malicious servers could cause high resource consumption +CVE-2025-66471 # Malicious servers could cause high resource consumption + # ======================= # Ignored Vulnerabilities # ======================= -# Accepting risk due to Python 3.8 support. -CVE-2025-50181 - # Not relevant, only affects Pyodide CVE-2025-50182 From 9d32c3616245205cfd0a83be0a905621743cf690 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 22 Dec 2025 12:14:48 -0500 Subject: [PATCH 039/124] Bump the github_actions group with 4 updates (#1614) Bumps the github_actions group with 4 updates: [docker/setup-buildx-action](https://github.com/docker/setup-buildx-action), [actions/attest-build-provenance](https://github.com/actions/attest-build-provenance), [stefanzweifel/git-auto-commit-action](https://github.com/stefanzweifel/git-auto-commit-action) and [github/codeql-action](https://github.com/github/codeql-action). Updates `docker/setup-buildx-action` from 3.11.1 to 3.12.0 - [Release notes](https://github.com/docker/setup-buildx-action/releases) - [Commits](https://github.com/docker/setup-buildx-action/compare/e468171a9de216ec08956ac3ada2f0791b6bd435...8d2750c68a42422c14e847fe6c8ac0403b4cbd6f) Updates `actions/attest-build-provenance` from 3.0.0 to 3.1.0 - [Release notes](https://github.com/actions/attest-build-provenance/releases) - [Changelog](https://github.com/actions/attest-build-provenance/blob/main/RELEASE.md) - [Commits](https://github.com/actions/attest-build-provenance/compare/977bb373ede98d70efdf65b84cb5f73e068dcc2a...00014ed6ed5efc5b1ab7f7f34a39eb55d41aa4f8) Updates `stefanzweifel/git-auto-commit-action` from 7.0.0 to 7.1.0 - [Release notes](https://github.com/stefanzweifel/git-auto-commit-action/releases) - [Changelog](https://github.com/stefanzweifel/git-auto-commit-action/blob/master/CHANGELOG.md) - [Commits](https://github.com/stefanzweifel/git-auto-commit-action/compare/28e16e81777b558cc906c8750092100bbb34c5e3...04702edda442b2e678b25b537cec683a1493fcb9) Updates `github/codeql-action` from 4.31.8 to 4.31.9 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/github/codeql-action/compare/1b168cd39490f61582a9beae412bb7057a6b2c4e...5d4e8d1aca955e8d8589aabd499c5cae939e33c7) --- updated-dependencies: - dependency-name: docker/setup-buildx-action dependency-version: 3.12.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: actions/attest-build-provenance dependency-version: 3.1.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: stefanzweifel/git-auto-commit-action dependency-version: 7.1.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: github/codeql-action dependency-version: 4.31.9 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/build-ci-image.yml | 4 ++-- .github/workflows/deploy.yml | 2 +- .github/workflows/mega-linter.yml | 2 +- .github/workflows/trivy.yml | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/build-ci-image.yml b/.github/workflows/build-ci-image.yml index 28d7677521..406922b543 100644 --- a/.github/workflows/build-ci-image.yml +++ b/.github/workflows/build-ci-image.yml @@ -50,7 +50,7 @@ jobs: - name: Set up Docker Buildx id: buildx - uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # 3.11.1 + uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # 3.12.0 # Lowercase image name and append -ci - name: Generate Image Name @@ -129,7 +129,7 @@ jobs: password: ${{ secrets.GITHUB_TOKEN }} - name: Set up Docker Buildx - uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # 3.11.1 + uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # 3.12.0 # Lowercase image name and append -ci - name: Generate Image Name diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 488f3348d9..4d7e32aeeb 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -196,7 +196,7 @@ jobs: repository-url: https://test.pypi.org/legacy/ - name: Attest - uses: actions/attest-build-provenance@977bb373ede98d70efdf65b84cb5f73e068dcc2a # 3.0.0 + uses: actions/attest-build-provenance@00014ed6ed5efc5b1ab7f7f34a39eb55d41aa4f8 # 3.1.0 id: attest with: subject-path: | diff --git a/.github/workflows/mega-linter.yml b/.github/workflows/mega-linter.yml index d3dfb4e7fd..25f8f4e8d5 100644 --- a/.github/workflows/mega-linter.yml +++ b/.github/workflows/mega-linter.yml @@ -109,7 +109,7 @@ jobs: run: sudo chown -Rc $UID .git/ - name: Commit and push applied linter fixes - uses: stefanzweifel/git-auto-commit-action@28e16e81777b558cc906c8750092100bbb34c5e3 # 7.0.0 + uses: stefanzweifel/git-auto-commit-action@04702edda442b2e678b25b537cec683a1493fcb9 # 7.1.0 if: env.APPLY_FIXES_IF_COMMIT == 'true' with: branch: >- diff --git a/.github/workflows/trivy.yml b/.github/workflows/trivy.yml index 99342be037..89747c7b30 100644 --- a/.github/workflows/trivy.yml +++ b/.github/workflows/trivy.yml @@ -61,6 +61,6 @@ jobs: - name: Upload Trivy scan results to GitHub Security tab if: ${{ github.event_name == 'schedule' }} - uses: github/codeql-action/upload-sarif@1b168cd39490f61582a9beae412bb7057a6b2c4e # 4.31.8 + uses: github/codeql-action/upload-sarif@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # 4.31.9 with: sarif_file: "trivy-results.sarif" From d0598f9a92252b33397ec0701503d987f08b2038 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 5 Jan 2026 21:57:27 +0000 Subject: [PATCH 040/124] Bump oxsecurity/megalinter in the github_actions group (#1621) Bumps the github_actions group with 1 update: [oxsecurity/megalinter](https://github.com/oxsecurity/megalinter). Updates `oxsecurity/megalinter` from 9.2.0 to 9.3.0 - [Release notes](https://github.com/oxsecurity/megalinter/releases) - [Changelog](https://github.com/oxsecurity/megalinter/blob/main/CHANGELOG.md) - [Commits](https://github.com/oxsecurity/megalinter/compare/55a59b24a441e0e1943080d4a512d827710d4a9d...42bb470545e359597e7f12156947c436e4e3fb9a) --- updated-dependencies: - dependency-name: oxsecurity/megalinter dependency-version: 9.3.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/mega-linter.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/mega-linter.yml b/.github/workflows/mega-linter.yml index 25f8f4e8d5..38d972ee85 100644 --- a/.github/workflows/mega-linter.yml +++ b/.github/workflows/mega-linter.yml @@ -53,7 +53,7 @@ jobs: # MegaLinter - name: MegaLinter id: ml - uses: oxsecurity/megalinter/flavors/python@55a59b24a441e0e1943080d4a512d827710d4a9d # 9.2.0 + uses: oxsecurity/megalinter/flavors/python@42bb470545e359597e7f12156947c436e4e3fb9a # 9.3.0 env: # All available variables are described in documentation # https://megalinter.io/latest/configuration/ From 854e966088afee4afdf5bdfa40091ad35716b01d Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Thu, 8 Jan 2026 12:35:35 -0800 Subject: [PATCH 041/124] Update tests and instrumentation for gpt-5.1. (#1620) * Update tests and instrumetation for gpt-5.1. * [MegaLinter] Apply linters fixes * Update embedding tests with new mock server response data. * Update error streaming tests error message. * Use max_tokens. * [MegaLinter] Apply linters fixes * Remove testing for v1.7 to avoid max_token param conflicts. * [MegaLinter] Apply linters fixes * Bump tests --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Tim Pansino --- newrelic/hooks/mlmodel_openai.py | 9 +- .../_mock_external_openai_server.py | 257 +++++++++--------- .../test_chat_completion_error_v1.py | 50 ++-- .../test_chat_completion_stream_error_v1.py | 45 +-- .../test_chat_completion_stream_v1.py | 118 ++++---- .../mlmodel_openai/test_chat_completion_v1.py | 94 ++++--- tests/mlmodel_openai/test_embeddings_v1.py | 42 +-- tox.ini | 3 - 8 files changed, 323 insertions(+), 295 deletions(-) diff --git a/newrelic/hooks/mlmodel_openai.py b/newrelic/hooks/mlmodel_openai.py index 59f7060394..8ac37ca38d 100644 --- a/newrelic/hooks/mlmodel_openai.py +++ b/newrelic/hooks/mlmodel_openai.py @@ -303,7 +303,7 @@ def _record_embedding_success(transaction, embedding_id, linking_metadata, kwarg "duration": ft.duration * 1000, "response.model": response_model, "response.organization": organization, - "response.headers.llmVersion": response_headers.get("openai-version"), + "response.headers.llmVersion": response_headers.get("openai-version") or None, "response.headers.ratelimitLimitRequests": check_rate_limit_header( response_headers, "x-ratelimit-limit-requests", True ), @@ -459,7 +459,7 @@ def _handle_completion_success( return_val._nr_openai_attrs = getattr(return_val, "_nr_openai_attrs", {}) return_val._nr_openai_attrs["messages"] = kwargs.get("messages", []) return_val._nr_openai_attrs["temperature"] = kwargs.get("temperature") - return_val._nr_openai_attrs["max_tokens"] = kwargs.get("max_tokens") + return_val._nr_openai_attrs["max_tokens"] = kwargs.get("max_tokens") or kwargs.get("max_completion_tokens") return_val._nr_openai_attrs["model"] = kwargs.get("model") or kwargs.get("engine") return except Exception: @@ -532,7 +532,8 @@ def _record_completion_success( "trace_id": trace_id, "request.model": request_model, "request.temperature": kwargs.get("temperature"), - "request.max_tokens": kwargs.get("max_tokens"), + # Later gpt models may use "max_completion_tokens" instead of "max_tokens" + "request.max_tokens": kwargs.get("max_tokens") or kwargs.get("max_completion_tokens"), "vendor": "openai", "ingest_source": "Python", "request_id": request_id, @@ -648,7 +649,7 @@ def _record_completion_error(transaction, linking_metadata, completion_id, kwarg "response.number_of_messages": len(request_message_list), "request.model": request_model, "request.temperature": kwargs.get("temperature"), - "request.max_tokens": kwargs.get("max_tokens"), + "request.max_tokens": kwargs.get("max_tokens") or kwargs.get("max_completion_tokens"), "vendor": "openai", "ingest_source": "Python", "response.organization": exc_organization, diff --git a/tests/mlmodel_openai/_mock_external_openai_server.py b/tests/mlmodel_openai/_mock_external_openai_server.py index ec3bda2028..5b22133141 100644 --- a/tests/mlmodel_openai/_mock_external_openai_server.py +++ b/tests/mlmodel_openai/_mock_external_openai_server.py @@ -233,7 +233,7 @@ }, ], "Invalid API key.": [ - {"content-type": "application/json; charset=utf-8", "x-request-id": "req_7ffd0e41c0d751be15275b1df6b2644c"}, + {"content-type": "application/json; charset=utf-8", "x-request-id": "req_444007a576dc4971a009b0de4967fb60"}, 401, { "error": { @@ -247,84 +247,111 @@ "You are a scientist.": [ { "content-type": "application/json", - "openai-organization": "new-relic-nkmd8b", - "openai-processing-ms": "1676", + "openai-organization": "nr-test-org", + "openai-processing-ms": "978", + "openai-project": "proj_id", "openai-version": "2020-10-01", - "x-ratelimit-limit-requests": "10000", - "x-ratelimit-limit-tokens": "60000", - "x-ratelimit-remaining-requests": "9993", - "x-ratelimit-remaining-tokens": "59880", - "x-ratelimit-reset-requests": "54.889s", - "x-ratelimit-reset-tokens": "120ms", - "x-request-id": "req_25be7e064e0c590cd65709c85385c796", + "x-ratelimit-limit-requests": "15000", + "x-ratelimit-limit-tokens": "40000000", + "x-ratelimit-remaining-requests": "14999", + "x-ratelimit-remaining-tokens": "39999979", + "x-ratelimit-reset-requests": "4ms", + "x-ratelimit-reset-tokens": "0s", + "x-request-id": "req_983c5abb07aa4f51b858f855fc614d08", }, 200, { - "id": "chatcmpl-9NPYxI4Zk5ztxNwW5osYdpevgoiBQ", + "id": "chatcmpl-CoLlpfFdbk9D0AbjizzpQ8hMwX9AY", "object": "chat.completion", - "created": 1715366835, - "model": "gpt-3.5-turbo-0125", + "created": 1766116121, + "model": "gpt-5.1-2025-11-13", "choices": [ { "index": 0, "message": { "role": "assistant", - "content": "212 degrees Fahrenheit is equivalent to 100 degrees Celsius. \n\nThe formula to convert Fahrenheit to Celsius is: \n\n\\[Celsius = (Fahrenheit - 32) \\times \\frac{5}{9}\\]\n\nSo, for 212 degrees Fahrenheit:\n\n\\[Celsius = (212 - 32) \\times \\frac{5}{9} = 100\\]", + "content": "212\u00b0F is 100\u00b0C.", + "refusal": None, + "annotations": [], }, - "logprobs": None, "finish_reason": "stop", } ], - "usage": {"prompt_tokens": 26, "completion_tokens": 75, "total_tokens": 101}, + "usage": { + "prompt_tokens": 25, + "completion_tokens": 16, + "total_tokens": 41, + "prompt_tokens_details": {"cached_tokens": 0, "audio_tokens": 0}, + "completion_tokens_details": { + "reasoning_tokens": 0, + "audio_tokens": 0, + "accepted_prediction_tokens": 0, + "rejected_prediction_tokens": 0, + }, + }, + "service_tier": "default", "system_fingerprint": None, }, ], "No usage data": [ { "content-type": "application/json", - "openai-organization": "new-relic-nkmd8b", - "openai-processing-ms": "324", + "openai-organization": "nr-test-org", + "openai-processing-ms": "2108", + "openai-project": "proj_id", "openai-version": "2020-10-01", - "x-ratelimit-limit-requests": "10000", - "x-ratelimit-limit-tokens": "60000", - "x-ratelimit-remaining-requests": "9986", - "x-ratelimit-remaining-tokens": "59895", - "x-ratelimit-reset-requests": "1m55.869s", - "x-ratelimit-reset-tokens": "105ms", - "x-request-id": "req_2c8bb96fe67d2ccfa8305923f04759a2", + "x-ratelimit-limit-requests": "15000", + "x-ratelimit-limit-tokens": "40000000", + "x-ratelimit-remaining-requests": "14999", + "x-ratelimit-remaining-tokens": "39999994", + "x-ratelimit-reset-requests": "4ms", + "x-ratelimit-reset-tokens": "0s", + "x-request-id": "req_ed0c7fcff6954a85ab0956c448163b9f", }, 200, { - "id": "chatcmpl-9NPZEmq5Loals5BA3Uw2GsSLhmlNH", + "id": "chatcmpl-CobAB9gf7iGzucSqbtQZCUKWQolUq", "object": "chat.completion", - "created": 1715366852, - "model": "gpt-3.5-turbo-0125", + "created": 1766175291, + "model": "gpt-5.1-2025-11-13", "choices": [ { "index": 0, - "message": {"role": "assistant", "content": "Hello! How can I assist you today?"}, - "logprobs": None, - "finish_reason": "stop", + "message": {"role": "assistant", "content": "", "refusal": None, "annotations": []}, + "finish_reason": "length", } ], - "usage": {"prompt_tokens": 10, "completion_tokens": 9, "total_tokens": 19}, + "usage": { + "prompt_tokens": 9, + "completion_tokens": 100, + "total_tokens": 109, + "prompt_tokens_details": {"cached_tokens": 0, "audio_tokens": 0}, + "completion_tokens_details": { + "reasoning_tokens": 100, + "audio_tokens": 0, + "accepted_prediction_tokens": 0, + "rejected_prediction_tokens": 0, + }, + }, + "service_tier": "default", "system_fingerprint": None, }, ], "This is an embedding test.": [ { "content-type": "application/json", - "openai-model": "text-embedding-ada-002", - "openai-organization": "new-relic-nkmd8b", - "openai-processing-ms": "17", + "openai-model": "text-embedding-3-small", + "openai-organization": "nr-test-org", + "openai-processing-ms": "147", + "openai-project": "proj_id", "openai-version": "2020-10-01", - "x-ratelimit-limit-requests": "3000", - "x-ratelimit-limit-tokens": "1000000", - "x-ratelimit-remaining-requests": "2999", - "x-ratelimit-remaining-tokens": "999994", - "x-ratelimit-reset-requests": "20ms", + "x-ratelimit-limit-requests": "10000", + "x-ratelimit-limit-tokens": "10000000", + "x-ratelimit-remaining-requests": "9999", + "x-ratelimit-remaining-tokens": "9999994", + "x-ratelimit-reset-requests": "6ms", "x-ratelimit-reset-tokens": "0s", - "x-request-id": "req_eb2b9f2d23a671ad0d69545044437d68", + "x-request-id": "req_215501af84244a0891dc2c7828e36c28", }, 200, { @@ -333,10 +360,10 @@ { "object": "embedding", "index": 0, - "embedding": "/PewvOJoiTsN5zg7gDeTOxfbo7tzJus7JK3uu3QArbyKlLe8FL7mvOAljruL17I87jgFvDDiBTqEmZq7PQicPJDQgDz0M6I7x91/PMwqmbxwStq7vX6MO7JJdbsNk+27GWEavNIlNrycs5s8HYL1vPa5GDzuOIW8gOPHOy5eXrxUzAK8BlMGvb8Z8bvoqPA5+YIKPEV2EL2sTtg8MSfQu6/BLzyhAgS7cEgLO+MD7ryJUTy7ikBsOz6hsTeuKJq86KYhvIrqUTyhrrg8hdyVu4RDAL1jzik7zNZNO0JZUzzFqQW7dplCPHwrpjtA0Y287fWJvK/BrzzCNi68/9PBO7jZCbwfBp26vDuRO7ukSjxX6448nLMbPLv65Dz7Xps8A4qUu4d1K7q1vMw87V7DutssQLwSjLu7Rg8mPPg/DzyKlLc6AbDSvLw9YLx3Mtg8ugu1OUmXa7szA2G8ZgDVPGkdEryNB4+5DxcVPAv4iLod1sA7UkjbO+osGLyrC908x4WWu2v5ojzBSU08QllTvHpR5Lu/w1Y7oNT2ulhBKbwfsAK90YwgvISZmjp/oEy8FL7mPAGugzxeK/a7rigauXGLBrwG/zq9xuwAO5EVSzzoUlY7P5DhvL+wN7xiN2O7rKTyPEy29zyVdQM8e5KQvDsu2jwYHp+5NJz2uw8XFb2olra8ul+AvJDl7jvOsI88b1uqPKkvTDzJY/a8wAbSPDF7m7yOoKQ87+Q5vaxOWLwILxc8ZkGBPExejry6tRq8SZfru9wZoTzUqyy64mrYOnyBwDusoqO8X2yiOfteG7sxfWq6Zqo6PFEDkbsZCwA9weATPKZkC7wbUMq87Uuku8PPQ7o3Y5k8rPg9vCWYALwusqk8gxXzPIwaLjycsxu62pMqPGl1e7xN96O802ixPOnpHL2lIRA88/L1Oq9rFbv1eOw7GvqvuwyRnry4hb68gY/8vFOJhzx7kpA8xBI/PPTdB7zz8Ka8g6w5PMuT0rs2zFI77AipvLJJ9TyKQOw8jkoKPKykcjoPbS+/fNfauWFIMz1O5IS8N7mzPAfu6jwWRF08UzW8vCzYZ7xdPMY8BM0PvFBsSrzbLMC8GN1yvNwZoTvFqYW7sfGLuzsu2rwv93M8iLr1PPf8E7znY6Y8U4tWPBHzpbuNXSm7z/MKPMbsADwp+oe8/PewPCzY5zoYyIS8Mr6WPHMmazzGRGo85EQaPZyzm7wLt9y8jkoKO+732DqZlt48Bv+6vM9cxDj4P488jMSTugGug7xLca08m8Y6uyd0kbtt1bO6s4qhOgw7BLwsgs08SxsTvHJ6trvxarA796jIvNuC2jwD4C48n9KnPMwqGTxHUqG7n3yNPHaZQrw+obG6QWzyvKa6pTyHdau8eqUvPVrHnzsIhTG9UQVgPIYyMDtRW/q7YFtSu3aZwjzOBio9pXl5PMAGUrwl7hq8ul+APLdCwzuqcke81K17vNMUZjyqcsc7ZpcbO/OaDL2V3rw6s+C7O4NWnzvKpKI8tqmtO/QzIr0eb9a8mtcKvAlyEjxac1Q8yMiRPHZF9zymuqW7cTe7uxcxvrsqpjw8v8PWO/XMtzzhffe7uIU+uuMBnzxD8ui7gDeTvKjqAb1P0zS8vSrBu/hB3jondJG8C04jvVkwWTxgWYM8WwxqPGjcZbz3/uI7m8a6O4K9iTw/5ns87LKOu19sIrvzmow63BmhvOimIbys+D08jMZiuycgxrvTEpc8G/x+vPz3sDyz4Ds8ebhOPBS8l7vNbRQ8fluCvByTxbqIYow8HSzbOmtPPbwFaPS81yDTOglyEr3k8E47B+5quopAbLs6Qfm4VbuyOyGOYrsv9aQ7x9swvLfsKLx9cPC7aranvIhiDDs8xaC8riiaug/DyTwPGWS8mKl9u6tfKLznDYw7cyZrvN5e6zzAnZi8XxYIvfJZYLvGQpu8W7QAO2HyGDylzUS7Kj2DPPiVqbyZlI+8HdbAu5y16ryPj1S7OKaUugUQizpwSlo7YosuPKf/bzxGDyY87fUJPD2ygTp279w7+dgkuxkLgDzc2PS8ghMkPB2C9btml5s7U98hvETfyTttf5k74CUOPOmTAj1pycY7PHHVuqFYHjutO7m6wUnNvAykvbxpcyy8EFzfPOhSVjx6+8k80PVZu2LhyLzbgto7ABe9O598jTzjA+67a/kiPAUQC7ytj4S8tWayvJtwIDsWmKg8RXYQOYY0f7xYLgo8ybdBPLM2Vjy429g8MDggvYqUt7uPj9Q8Vv6tPOK+ozxBbHI8cs6BvE99mjyIYgw84X33PMs9uDt/9Bc8WYbzPMGf5zzKToi8eMvtPFOJhzww4gU9YZ5NPAyRnrsFvL88/uZgvDZ2ODsyass7reUePAZTBj2429i7PqGxvFR4tzuqxpI8QWojPZ7lxjseb9Y7mKl9ur3UpjpFzKo88RSWvMkNXLyvKuk54CWOvBAGxTvjq4S8E882vN/ikjuViKK72LnoO34HNzubGgY9lw4ZPIi6dTzUrfs7eHVTO/2j5byANxM9YZ5Nuy0ZFLz897C8OajjvL8Z8Tsb55C82VCvO6Tg47lGD6Y8UQXgPEwKw7wSOPA7elHkPD6hsTy/sLc7TaGJO1DAlbztXkO6lTTXuzF96jvCOP26Ff+SPPFs/7thns268llgvD1etrxWZ+c75PDOO5U0VzyXDpm8BRLau2AFuDxco7A8jV/4u7ZTEzyOoKQ8xLwkPK8qabyrCY68Bby/u4cfkTyj3hQ9OuvePBX/kjtdkuC7pODju62PBLwfBh29/icNPEYPJruhWB48h3WrvJV1g7xEia88dkX3u4rqUTwiJ/g7tRAYunNnF7ynUzs8JFdUO3zVC7wFElq8QH3Cu9GO77rXdB48TjzuvFM1PDy8PeA6QNGNOr1+DL0CR5k7TjqfPDosC7zc2PQ4EuAGvDimFD0sgs07H7LRPP46rDxvW6o6t5hdO/z3MDwV/xK8+dgkPN5e6zu42Qm8uRyFvJnqKbp81Qu7ld68u1yjsDzenxe6sp3AvIMAhbxrowg8aR2SOw/DSbxHUiG8xzFLvJ32Fr3wfc+8e+p5vAJJ6Lt/9ua8M63GvBbuwrx9cHC8NyJtvNaHvbqIuCa8ek8Vu1JGjLxh8hi97jgFvTNXLDr/Kdw77AipPEPwGbxr+/G7EfMlvB+y0TuIDsG7oQIEPJDQgLyHH5G7qh58PO97gLuIuvU6vheiuoxwSLx2mcI8pc1EPAGuAzvujp+868UtPIY0/7oZYRo88WqwPFfrjrvGQpu8YLHsO85v47wQXF87pSGQu+k/NzyziqE5QNNcuwBrCDzYt5m87k3zOnYwibybxjq8y+lsu8WpBboCSeg8wyMPvNGMILzrb5M8L/dzvMgerLuqHK26GMgEvCBJGDyUm0E8skl1O1jt3TwUvma8bOhSuzwbu7ya1wo8wozIvL/D1jz5goq8TuSEvMMjD7wYytO8aranvE2j2DohjuI7VHg3O6f/b7wUErI7f6DMuldUSLw8G7u8B5jQvKrGEr1LHeI8lJvBvHvqeTthSDM8rtROPGtPvbzbgAu9CIUxO6Pxs7xUeLe8qsaSPAsN9zxYl0M8c70xPWBbUryK6II8k+8MPDe5MzrNbZQ8UQMROSMSirzGmLW6f/QXO3XtjTz/08G7HSxbO2v5ojtbChs82VCvPNzDBr3cw4Y7c2cXvC/387tLG5O80xTmPGZBgbxNo9g77zrUvAPgLrxBFAm5Wh06PLKdQDzc2HQ8iuiCPFsM6rtWEc06Nna4O+6OH7w8bwa8s+A7vDRGXLxac1S8a6OIPC/387ozrcY8TuSEvP2j5Tw6QXk76KhwPGfaFrxqYA28pXeqOy9LP7qXDpm8he80vasJDr0FZiW852OmuqGuuDyMxuK8sUcmPIRDgLwDNsm7hjT/u4chYDyQ0k895TNKO0Fs8jxBFtg8EZ/auvXMN7zGROo8BqkgOis/0joD4v08ebjOPHzVi7xEia+8EFzfuKV3KrymuqU7zrCPvKTgYzyNBw889mXNvL4XorumZlo7xzFLvd5e6zr1dp28eMvtu1TO0bylzUS7yvq8vGzmAz0yasu8Q0a0PGI1FLvsx/y7DKS9u2nJxjsjFFm7bwUQO3LOAT0H7uo8KA0nvPIDxrtlvVk8JK3uO7b/x7qP4588pmZavEcR9TwcPau8cEiLvHZFdzw4/K48IPVMPGpgjTshjmI7lJvBvKdTu7v03Ye7YLHsPFDCZLw2IB67jMbiu/SJPLzmIno8nUyxu3HhoLylIZC7kwT7vMCdmLsfXLc7u6TKuvB9zzxqtie8Ses2vMgerDxT36E8AkeZvNd0Hrtk0Hg8+7Q1PJDQgLuDrDm8WC4KPGl1e7xl/oU8Is+OvK8q6brnDQy9A4oUvDTwQTy7+BW7SxuTvO97gLwWmCi8t+53PJYhuLun/SC8DxcVO6Zki7vB87I7jMZiPDYgHrviFL46TaNYujzFIDsX2yM7wyXevMMl3rtWqBM8Wdq+PIF6Drt+W4K8VOHwvI+NhbsYdDm8F4WJPHgfubuqHny8WwobPF08xjuGNP86Ff8SO1kw2byiWm27PMdvvJe6zbr5l/i8y+nsukV2kLtU4fA7AbBSPD86x7x3Mti8sfELOpbLHb1819q8fXDwu73UJrw2zFI6KpOdPADDcbx6TxU9Oy5aPMHzsjz5Lr+8M63GOzSaJzuzdwK9AGuIvJtwIDz+kMa8WYQkvHeGIzss2Oc6FavHO6ZkCz0Y3fI69XhsvL1+jLqej6w7bYHoOy+fijvv5Dk8Y86pu/3kETwtby671yDTNxN5HLuoQBy8DJGeO5dksznq2Ew8wZ/nvOA4LTxXAH2880ZBvMjIkTy7+uS7CC8XvJDQAD0Abdc8MmpLu7znRbxs5oM8OemPvEOczryNX3g7MXubvOhQB70fCOy8DT3TujzHb7xWEU250iW2O4DjR7zPCPm7XimnPE7kBDwqUvG846sEvGfttbxU4fA7e+iqvO97gLtWZ2c7VqiTuZWKcTxCV4Q8xakFO2v5Irv4Qd47njmSPIQCVLo/jpI8TGBdPsZEarwH7Bu7BqmgPP4njTuUMgg8s3eCOEXMKjsMO4S7GQsAPBKMuzzdBgI87UskulBsSrtWqBO8du9cvNYzcrwS4Ia8XearvLyRq7xOPO67GB6fvJG/MDwX26O8A4qUPDF7G7xP0zS8lxDouy9LPzxGeN88iLgmvP8p3DvGROo8k+8MOx8GnbzF/5+74r6jPGySODzLPbg8Z+21Oz+OEj1sPJ68vX4MPH5bArvheyg8U4kHPIuBmLyNCV67IxIKuzsu2jxGDyY7he80vFKcpjzbgIs8BHlEu0xgXbz7tLU8Gg1PO/g/jzyT7wy8xpg1OuIUPjxEMxW89XhsPP2jZbzQNoY8GN3yvHm4zjsRnQs8K+k3PAw7BDwUvua7cJ4lPAFauLs2ygO9/aPlvINWHz3W3dc83+ISPcCdmDzb1qW7ryrpuwGuA7w+obG8kb8wvYn7Ib0PGWQ8cTe7vCfKqzotxci8cY1Vu0sdYju0edG7hEOAvJmW3jpdkBE8sfGLPJOu4DxP07Q7hAJUvAphwrynpwY9X2wiPZmW3rtc+co6iGRbPKpyx7xXAH28n3yNOwJJ6LqCEyS8TuQEvbDD/jt9xLu8pmSLu3aZQjwLDfc8wjj9u3uUXzz8oRa8SoTMvF7TDDwdgnW7WYZzPO6hvjrEvnO8TpC5vDosC7xPJwA88NNpvGl1ezwi0d27cYuGPG1/mTvw0+m6UMJkPGI1lDsxe5s89DOivMgeLDyTruA8PMUgvEvHR7xRW/q6+sWFvKQ0r7y6Yc88jBouujWHiDvyV5G8mxoGvSfKK7zenxc7bYFouxGf2jyK6IK8hJkavKPxM70xJ9C7F4UJvAW8P72ySXW7jBquPPpxurznDYy8QlcEvMHzMr4S4tU7opsZPNGMIL2DVp+7H7LRug6ATjxTiYe8FGhMvI/jH7wxJ1A8riiavA2T7byJp1a8sfGLu6ZkizyQ5W67cY3VvNSrLD1OPG48nyjCPD2yAb3YuWg8nLXquhh0ubsO1Jm7aXV7u12QET0kATo8cEgLvDUzPTwV/xK8cYsGPVxNlrssLLM70J8/POTwTj3dsja8fl3Ruh8I7Dua14o8EjYhPIzG4rxHUiE8+OvDOzA4oDwxJQE9T9O0u/yhFj1lvVm84mgJPNO+y7wjvj48hjKwO9zDhjymZIs7mZQPu1odujwkrW48c2eXu4WbaTxGuQu95w/bOhtQyrz6G6C8oVievMWpBb0+TeY7H7ACOkIDuTrIdEa83VwcuEWLfjxBwL07iGKMOwsN9zxket67+dikPPf8E7tmQQE8ifuhuzREDT1mqjo8fRiHO5cQ6DsG/zq8r2sVPPkuPzinqdW8QWzyu9bdVzwUEjK9dzLYuiLRXbyJ+6E79SCDPOREGrvOsI87aIbLO9ceBLu5HIW82GPOu0cRdbx3Mtg81yDTPPSJPDtGZUC8/pBGPMcxSz1BwD257fWJOi6yqbyBJsM87V7DPC6yqTte1ds8uXTuOrHxi7yzdwI8HSxbO3aZQj1LG5O7a/vxvOHRwjyKPh27tlOTvE8pz70nyqu8t5aOPKZkCz0aY2m7uNkJPff+YjzxarA891KuvNo/Xzy2qa28s3cCvWZBgbxmVm+8xu7PvLkcBTvTFOY8Xn/BO5Z30rwSNiE9pXl5u/ZlTbxFdhA9RN/JvIzGYrpgBTg85PDOvN/iEjymuiU830tMOhjd8rq9KsG8rPg9udfKuLz1dh26KpMdvB4ZPLx1Qyi80YwgPb2Terxk0Hg8rZFTOjRGXLyfKEK8ZVSgux3WwDpBFIm8xakFuz+Q4bsFaPS8s+C7vLPgOzvpP7e8JjGWPIvXsjwh4q08zm9jPO31Cbwew6G8a089Oa9rFb1Vu7K76y7nvABtV7seb9Y7mKcuO9/1Mb1OOh+80xTmu/OcWzzakyq8LNYYOz6hsbvKpKI89/7ivOhQhzqRaZa8k+8MvQb/ujwAwSK6WC6KvLeY3bvZ+pQ85iL6vC4IRLnNw647dBNMvFQiHTz+5mA61FUSvcVVujgiJSk8OkH5PBeFCb2lefm8YyREO7Pgu7tYl0O8qOzQO5B8NTy+F6K8KVAivGW9Wb0izw48c70xO9A2Br2pg5e8cEpau18WCLxac9S77bTdOmZBAT3xFBY7kNAAPFYRzbu6X4A8wyOPvLZTE7y9k/o8RrkLOwZThjy8PeA8oa64uwOKlLy9k3o6vOfFPBw9K7w8xSC8YLFsvDDkVDwmM+W8IPXMux8GnTvdBgK9+Zd4vPTdhzyww367JjPlu51MMTxIqLs8PqExPbkeVDz4lSm8opsZvbCukDxZ2j67VWUYvH6xnDw/Oke8U4tWun1w8DvEvvM7JjNlPH/0l7uWITi8kNAAPKjs0LteKae7ifshPBGdCzlVuzI8LrIpvLFaRT1xi4Y86KhwPFylfzvt9Qk82yxAPAEEHrxD8Jm70ntQPD2yAbwQXN+71ZpcOzUzPTzyVxE8svNaPOsbSDz5goo8cY1Vu7OKIbyOoKQ8ZLuKPJqDvzsG/zq8phBAPF08RjwYHp88njmSOoSZmjyzd4K7L/UkvIK9ibzkmjQ8jqAkPGQRJbtaHbq8uC8kvAb/ujlwnqU8vDsRPVEDkTyNXSk9s+A7PP2j5bv2DzO9vSpBvEUixTu2VeK7KHbgvJEVyzuww345bOjSOpPvjLusTti8RrkLPPa5GLzjAR+8iugCvHyBwLv1IAO9h8vFPL0qQbxO5IQ7OVLJPPJZYDy/GfE8NEQNu2S7CjyySfW7YfKYPKQ0L7tgsey7elHkO+hQh7zYDTQ7YFmDvPrFBTq7+uS8o94UPKHB1zvNbZQ9qdmxPF/CPLwkV1Q8YK8dvDzH7zuiBNM8rEwJPOYierzGQpu8a0+9O8pOCDsvSz+8O4Ilvaa6pbz3Uq67umFPO6V3KjzUV2G8Nd2iPK9rFTybcKA8xzHLPGYAVTyXEOi7a/txPBS+5jy+F6K83MOGvL0qQbytkVM8LNjnO1yjML3dXJy88H1PPLHxi7vQNoY6bwWQuvYPszzzRkE8BqmgPFfrDj29gNu8Wscfu2KLLjxmqjo7hohKvK8qabzVmA28", + "embedding": "zlU9PHv2LjwB3TA9x9sdveql8DvqK4e84xQvPR3/Hzv1zOG74ZzgPCW8Cj32tb87b+ZfvMuRybw7Kmk7BmWYPAxn6ToRBvM5cRtjOiCASD2xjTs9eiRzvd8EFjz+Wwg9aFUePNXmfr0i+Ba6c/b4PAY57zzu+NS7PBNHPFe957z4kNU73wSWvFAsprxLjRw8un+pu3TIND10IiK9pIu0PPPaKToGIs27cLgbvTsqaTzihT67xvK/PDLVM73ayFO9Uge8uVk1Nj1sfFm9+mvrueE5GbwuKGK7XYiavPKOBD1HOji8mtwRPVHSuLxEuY+40RkxPWAJw7zG8j+7ocdAPF+9nTu3/oA7K6e5vP6+Tz1PnTU81YM3vOANcD2hCow8+vEBveql8DyA2AM9j4l3POCqKLr2W9I8HdN2vAmj9bw9/KQ6Z8atPGnkDr2DQgo8e1n2u0rnCbtiJ6S9CozTO9mT0LwZBim9XtQ/vcI8FL1bEEy9iDsBO2wi7DtlTl+8314DvYnhE70WK5O87AYdPUq7YDzYBOC8L/odveorh7tVyy88t/6AvZLz/TxV4tE6VSUdvfM0F73JzdW8CSkMvPdEMLvhORk9yCdDPZwoN7wQ/Zg7XtQ/vXdg/7wYdzi9T+CAvNJl1rzOVT09Ad0wvXDPvbmrHPa8PaK3vKJWMbydXTq9ID39vInhk7x3YP+7AcYOPEBmKz2a87O8w3GXu3vfjL1734w8h1IjvYbDMj1p5I6816GYu5X6vDyAUm28QlhjvAkpjLz68YG8froiPfctDj1d62G8o/zDOyxNTDwVcHm9snYZvFzih713jCi9Q43mu9SaWbx7WfY8RpSlPL7prztYjyO7A7hGPYV3DTx0yDS9qEHgPHNQ5jwFk1y8K6e5vBKV47rDLky8YMZ3vLp/qbybgqQ8zpgIvM0JmLozx2u8tm+QvWgp9TyrHHa8f0kTvclz6Dw+Mai8i6WHPLfSV7336sI8wuImu0d9Az1lTt88w8uEu3ok87z+AZs8+R9GPQ32WTxtThW9lT2IvI3xLD1y7Z482DCJPYbDsrzbsbG7P5RvPRVZ17l8QtS5naAFPVzihzxsqAK9pmbKvHfmFb0pL2u6bt0FPQYizbv/kAs9aCl1PONunLzCn9s8EBS7vGInpLsW6Ec8r5uDux+OkLyW4xo9kUSRPVJhqbs8VpK9JggwPc8+mzu4Yci8INo1PKtIH7y30le84xQvvUUFtbxJLPC8WGN6PKFtUzy+0g29g7zzuw6c7LxZ8mq8vkz3vPPxSzxkv+480nz4vEON5ruCDQe9vZ0KO4WOL71wEgk7cqrTPEyW9jw0Vlw82DCJu2n7ML1GlCW990SwvOWs+bxsImw9xQCIPG1OFbyGHSC9sOeovASKgr063sO8ly/AOjTzFL3NCRg9y5HJvBN+QTvmlVe97AYdvFRT4bsY2v88A/sRvGOKa730Js88t3jqvIotubx8KzK89y2OO8eY0rvZOWO9ZZEqvHxCVD2w5yi9xBcqvbo83jsleb+8OOyLvN3mNDwYYBa9sUrwvEr+qz0cypw7QfUbvcGWgTy2b5A8Cs+eO6AhLj3nZxO9rKtmPHh1Br3SfHg7TJZ2PY49UrwvVAs9DoVKu/v62zwTwQw9KCYRvfquNr0qW5Q8JgiwvKQxRz2SkDa7JJBhPGWRKj1hPka56ZwWPfctDr0fjhA90qghvOHfqztkArq8eqoJvCDatTu2LEW85az5PLxx4bv8oG473P3WOUmyBrxKu+A8uw6avJLzfbyKcAS9r2/avKsFVDxNwh887MPRPMsugr1zkzG8Ge8GPRC6Tbw085Q7pHQSPTBGw7zGr3Q82ZNQPahBYL36xdi7WxBMPDwTRzvw02o8fCsyPfuXFL2juXi79viKu1YX1TvYqvK8sKTdu2Mwfjx1sRK7s8I+PQcLqzzeMtq73nUlvdKoobtBT4k80XOePDTzFL0ggEg9geFdu9uxsblY6RC9ngNNPArPnjzwWQE9qxz2PBYrkzyuI7U8a9ZGuiunObx7nEG9AhK0PFtTFzxng+I83wSWvHLtHr0Ro6u7ylzGPIbDMr3QzYs8a+1ovRxwLz2c5es8gSSpPNxAojzEF6o6knmUPEbuEr2zaFG9Br8FvXh1BjykdBI8ZnoIPBWzRDx+YDW9J5cgPLRRr7xkRQW8HRbCvMpFJD3nfjW9uTMEvPaeHT10hek7aCl1vJwRlTyHUiM9mU2hvPG8SL3FAAi9pziGPHM5xDyiVjG8r2/aPXWxErwOIgM9/CaFvVT587w2zqq8t9LXPJbjGj1iJyS92shTPFIHPD36CCQ8A15ZvKV9bDzeMtq7mHtluwYizbxQLCa9wa0jvTHs1bw085S8IB0BvIxLGrzGNQu95e9EPBPBDL1gxne7/OM5vcYJ4jvAxEW91nVvPKnn8rp+d1c9HzQju88+Gzyc5eu77jugvOfBgD0FMBU99GmavL7SDTukdJK6WOkQPZW3cbtLjZy7QQw+PB5iZzvmldc8s8I+vAA3nryj5aE7vzXVvEFPCb135pW9ZBlcvMqfEb3yCG69HC1kvJLzfbumI/89LxHAvG6aursAN547HRbCvNICjzvBEGs7pQODvBPBjLwt3Lw8knkUvFa0DbqZpw69naAFPWcgG72xSvC8e9+MPN8buLrBUzY9mNVSPZqZRrwoPTO9oQqMPHIEQbwlYp08HzSjvGqKIbtEdsS8mQpWPIcm+jvz8cu8v9vnu0AjYD1kGVw68gjuvJpW+zx4Gxm8cgTBOjttNL3XXk28p08oPDzQ+7y7aIe9OMBivHb9t7wd/x+9OiGPvMpcxjzo9gO82TljvRr44DviQnO8CozTPAP7ETw2i9+7r7IlPeNunLuhbVM7iDuBuhBXhrzyYls92mWMPBbox7wrvls7O200PHfmlTzABxG9RqtHPTzQe7xvKas7vZ2KPGivCz1tTpW8Ad0wvQcLKzzTTrS6vQDSPPctDj1cXPE8fmA1vf5bCD2Ugm48ID39uqcMXT230lc8MntGvfH/k7ti5Ni8IVIEPVhM2LuuDBM88mLbuzohDzyw56i6LR+IvHNQZrrJEKG8eDK7u2nkDjxdLq05X2OwO4rqbTwFMBU8OKnAvO/KED2kMUc9TWgyO5zOyTwJKQy9RHZEPYTonLyKFhc9+R/GOxaFALx5fuA8HVkNPW+DGDxR0rg8H46QPCNb3jy0Og09d6PKvCxNzDzSqCE85341vDSZJ71ZNTa9gsq7OmQZXLuhCow82O29PLbp+buBJCk8URUEPU/gALwcLWS8xWNPvFzihzwlH9I852cTvcWmmjxzOUQ8U/AZvPdEMLuE6Jw89p6dvE0l5ztHfYM8LoLPvDhm9bvrjs686PYDvWuT+zxT8Jk7wy5MvMK2fbomCLC7VDy/PKsFVDwvVAu70gIPPOizuDyLed67eX5gvOHfq7yHacU8NJknvW1OFbtlkSq8juPku03CH73Iag69y9SUvCA9fbxEM/m8e1l2PDca0Dyc5Ws8TcIfvcQXKrsKzx49ZEWFvZfs9DvedaW6ohNmvIF+Frzz2qm8xaYaPS0fCL2I+LU8vkx3vAducjtgxne8nXTcvKP8wzwGZRi9nV06u5X6vLx3Sd282iLBOr6m5LvZOeM8z/vPPEyW9js5kp68SIZdvVjpEDzBEOs89y0OuyNb3rswRkM9xz7lPMvUlDx7Wfa7juPkvI6AnToaO6w7ZZGqvLvLzrxFwmk7ENFvvfaenbsugs88tA5kPe47ILyDvPO8q19Bu9XmfjrfBJa6B7G9PD/Xuryc5Ws5mU0hvPctjjzMN9w7YYERvfG8SDtG7hK88Ba2vAWq/rm/HjO9ufC4OuaVVztBTwk8rgyTvDzQ+7tnxi072t91vE9a6rsGIk08j8zCOuMUr7w/lO88rmYAvSfxDbxl6xe90dblPNrfdT1lkSo8gJW4vLqWSz32cvQ8CwSiPOaV1zxzfI+8JNMsvKyrZjx0IiK8JTb0PGXrF71LStG8AUB4PRGjK73DLsy8f0mTPDwTxzzJtrM8g1msPGS/7jm098E8pzgGvfXMYbukSOm8ZBlcPVjpED2gONA8rgwTveSjn7sGOW85aCl1PQGDQ7y4pBO9URUEPK6GfLwQus089CbPvGCv1TpWcUI8P5TvvMKfW7wv+p08TJZ2PBTKZjyzwr68CFdQvYi16rz3RLC8M02COlYX1bwYugM9+gikvKB7G71+YLW9qRMcvVR/ijynDN28e5xBvF4XCz3nfrU78Xl9PPBZgbyRp9g7TJZ2vMI8lLxWF9W6EP2YvJGn2Dy/22e8UkoHPQHGDrzdzxK8dAsAPH5gNbyp5/I7T501PW/mXzzGr3S9K2RuPMgnw7wugk88mL4wOyW8irwN9lk82t91PPqutjyuZoA87Q93OxwtZLsZBqm8XhcLOwXWJz3SfHi7YzD+u5PcW7xp5I68upZLOu+eZz13YH+82DCJu2uT+7pNwp88E8EMvAqM0zxPnTW8Wq2EPGswtLzulY05+dz6PKAhLjzW+wU8qN6YPHtZ9ju+TPe8lfq8OuRg1Dzgqqi8s39zPHTfVjxHnX+8V73nPPZbUr1jc0m8QU8JPU/ggLwImhs9JC0au92j6bx039a7YxCCPEtK0bqPife8Z8YtPXwrMj0QVwY9gNiDO+KFPj2OPdK80M0LtwHdsLyYe+W82KpyuzuEVjbgDfA8hw/YvOlZSzx5fuA7RHbEvP7VcTshDzm8vx4zvTYoGD13jKg6zHonPe2sL7oUDbK86HDtO8m2M71MHI27Ugc8O8AHkTxctt674siJvDEvoTty7R68i3leOuE5GTpzfI+8SMkoOzvHobsOyBU9+/pbO+wGHbyOgJ08QyofPW/m3ztgTA69GGCWvd2jabx0hWk80mXWu0R2xLtMHI084yvRPL1DnT1FSAA8mU0hvaA4UDyDWSy82t91PPpr6zsk6k694xQvvFcAMzuD/768GlJOO7e7NbumZkq9GvjgOVnyar2KFhc9Q43mvB281Lso+uc8+5cUPWQZXLz7Pae6SIbdPHLtnjurHHY8a5P7vEiG3brulQ09jdqKvJLz/Txc+Sm7Srvgu1JhKT27Dpo6zq+qvHTItDwbJAq9n9WIPAkpDLy/HrM8/hi9u7Q6Dbw6OLE7ykUkPbOrHLyT3Fs9IMMTO3ejSrwi+JY8oN5iPXWxErz3RLA8GHc4PZ+SPTuTH6c8yp8RuxyH0Tp3YH87y+u2O2cgGz15fmC8zlW9vMKf27s085S89cxhvEd9AzyZZEM7Y3PJu8kQITxjMP47SrtgPI8PDr0BmuW863esvIYdoDwfjhC8n+yqvBr4YDvdjEe8YK9VvKq5Lj3KRaQ6Y7YUO46AnTw80Hu9GGAWO2+DmDzL1JS6+dx6PPg26Lwk6k68vHFhO3jYzbxi5Ng7vzXVPBwt5Lx2QAO7hsMyO3IEwbwF1qc8iPg1POql8Lvvnmc7lkZivC3cvLwQV4a8mpnGPPh5M7ziQnM8HRbCPLy0LLt/w/y7CJqbu4dpRTyBO0s9Y7aUPAOhJLzBrSM8PouVPHVuR7xYjyM83eY0vZUR3zoaUs680TBTvOCTBr3m2KI8JNOsu01/VLwS2K482EerO9J8+Lzo9oO8yRChPJVUKru+TPe81eZ+vKA4ULqKLTk99GmaPPII7jzp/107mz9ZvLxxYTz3LY66EtguPJs/2TxIhl283SkAvSsBp7zpQqk8sdCGvCTTrLl7s+O70OStvM6YiLtByfI88HAjPFAsJrwpidg8Y822ur0A0rwrvls7ufA4POwGnbvSqKG7o6JWPSfxDTzr0Zk8QQw+PMGto7zfBBa9X2Mwu18gZTwrvls8XS6tO6tIH7wYYJa8B7E9PJ5GmLwzx+s7NLDJvJ5GmDz7l5Q8XtQ/PFAA/bytfSK5As/oO0myBr3Vgze8kpC2vAZ8Oj30PfG7EP0YPbd46jwKMma8cV4uOzmSHrvU3SS8LmutuuwGHTwBmmU7XtS/vPb4ijtIySi9wvnIvAn9Yr2DQgq8URWEvCW8CjwtH4i8bU6VvPKlprxFSIC763esPNVA7DzAxMU7TWiyPD7u3D368QE8jj3SPKOi1jtVJR08OiEPvN3Pkjt9FJA8luMavelCqbq30te8+vGBPIpwBD3vnme8aFUePG+DmDtHfYO8E8GMvOgNpjwVs8Q6iDuBPOdnE70bJAo8jiYwPeCTBr3Fvby7Wmq5vDhm9TwYd7g8DQ18PNKooToTfkE8WTU2u4mHJj09orc8SRVOPN9eA72lAwM9OU9TO2InpLuCyjs8rX0iu0edf7xcnzy88Xl9vK0617x73wy9xq/0vMTUXjxjzTa8HC1kuxpSTj3do+m8VwAzPV+9nTwlYh282ARgu4VLZDw5kh49H0vFvCNEvDwD+5E8lMW5vOT9jDwGIs07WGN6vOSjnzulwLc8R32DvOMUrzyK6m08nRpvPDRW3LtFSIC8vkx3u7FK8DohUgQ9B8jfu/fqwryuDJO7h1KjvOizODw4Ay48FXD5PML5SLwJ5sC5wp/bu6ibzbxwjHK8R30DPbYsxbx6DdG84JMGu2sZkrst3Lw7GcNdO7gHW7z68QG98gjuPBX2jzyvWLg8BdYnu6R0Er0alRk95KMfuwtejzzKAlm95yRIPB3Tdrz1Dy08/gEbPD/AmLtIhl08Q9Cxu+UykLzKXEY8DfZZvIcP2Dz84zm8bL8kvdXGAjzFAIg8IQ85u5kKVrxrk3s89+rCvLvicDwVcPm7KluUu8uoa7zC+Ug9OvVlvI3aijyjP4+7h2nFPFe9Z7x/Bki7KS/rvEBmqzhHfQM8UXjLPFHSuLsJo/U6DpzsvM1jBT3nwYC8DQ18PAa/BbyKFhe9DpzsO7OrnLxJb7u8CFdQOzSwybs4ZvW6E37Bu76PQjzXoZg89nJ0ug7IlbydXbo8R+BKOho7rLsccK88vx6zPJuCJLzVKcq7uAfbuyxNTDxmegi8rNePuyAdgbzRMNM8t3hqPEarx7xHIxa9NigYOdML6TymI3+9YEwOvCAdgTxjiuu8TSXnvD7u3DytfSK6UIaTPER2xDzlMhC9TNnBOQWT3LsCErQ8loktvcGto7wKzx484sgJPAexvbtRuxa9fELUuD6LlbvoDaY8hY6vO2xlNzywQRY9CwQiPCK1SzxLjRw96ui7u39JkzuDWay8wZYBO5ByVT1SHt68NJmnvBX2D7y9Q5080r9Du4NCCrwaO6y8Br8FuwJsITxwEok8wrb9u17Uvzsugk+9t9LXu9l8LjzPPhs9eBuZvP1yqrsO37c78FkBvcYJ4ryzaFG96MpaOzaLX7yS0wG8VhdVuoNCCj3VKUq8L/qdOz8aBr3oylo8kx+nPNICDz0gw5O8B/SIO6UapbwLG8Q8U/CZvN1JfLvDywQ9ykWkPHASCTsOIgO9tPfBvC6Cz7w69WU82Tlju6p24zt039a8gSQpvYdpxTzDywQ9MIkOu0Qz+Txcnzy9dCIiPOc7ajx6Zz67P8CYPD3lgrvNYwW9VPnzvD6LlbzN3e68oz8PPRN+QbyT3Fu83aNpvAD00ryK08u7As9ovFkeFL2qua47LoLPOw9uKDxJb7s8ly9APAO4Rrxg8iC8X2MwulLEcLw3dL28lqDPuzipQLzdzxI8VnFCO43xLLtSYSm9W1OXu5aJLb29nQo9P33NPLf+AL2XL0C7MtWzO9rf9bvfBBY9olYxvDblzDx4Mru8f6xaO8UACDxSHt47sKRdu/DTarwgPf06QGarPIV3jTs9X2w8u+JwvIJwzjr84zk6P8AYPIU0wjw4ZvW8hh2gPHOTsTz/kIs8P8CYPPJi2zwUZ586ZBncPJLTgTpH4Eo9KbWBO2nkjrmkSGk5piN/PL1DHb3SqKG8bCLsPCQtmjwvEUC84JMGPXpnvjyt4Gm78FkBvZJ5lDwy1bO8IIBIvF7UvzwpiVg9VhdVvXzo5rshaSY8qEFgPd1JfLyK6u26JJBhvG2x3DvjK9G7FoWAPBYrk7yVVKo7fRQQPUks8Lzkox87t/6APDPHa7wCz+i84oW+PI3xLDtdiBq8UAD9PCvqBLxsZTe9IIDIvNXGArvuUkK96ZyWvNuxsbjJzVW8Mwq3uxIynDysq2a6+z2nvER2xLxlkSo8", } ], - "model": "text-embedding-ada-002", + "model": "text-embedding-3-small", "usage": {"prompt_tokens": 6, "total_tokens": 6}, }, ], @@ -360,7 +387,7 @@ 404, { "error": { - "message": "The model `does-not-exist` does not exist", + "message": "The model `does-not-exist` does not exist or you do not have access to it.", "type": "invalid_request_error", "param": None, "code": "model_not_found", @@ -369,126 +396,112 @@ ], "You are a scientist.": [ { - "content-type": "text/event-stream", - "openai-model": "gpt-3.5-turbo-0613", - "openai-organization": "new-relic-nkmd8b", - "openai-processing-ms": "6326", + "content-type": "text/event-stream; charset=utf-8", + "openai-organization": "nr-test-org", + "openai-processing-ms": "386", + "openai-project": "proj_id", "openai-version": "2020-10-01", - "x-ratelimit-limit-requests": "200", + "x-ratelimit-limit-requests": "15000", "x-ratelimit-limit-tokens": "40000", - "x-ratelimit-remaining-requests": "198", - "x-ratelimit-remaining-tokens": "39880", - "x-ratelimit-reset-requests": "11m32.334s", - "x-ratelimit-reset-tokens": "180ms", - "x-request-id": "f8d0f53b6881c5c0a3698e55f8f410ac", + "x-ratelimit-remaining-requests": "14999", + "x-ratelimit-remaining-tokens": "39999978", + "x-ratelimit-reset-requests": "4ms", + "x-ratelimit-reset-tokens": "0s", + "x-request-id": "req_f821c73df45f4e30821a81a2d751fe64", }, 200, [ { - "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug", + "id": "chatcmpl-CocmvmDih6DGKIgPUbrzKFxGnMyco", "object": "chat.completion.chunk", - "created": 1707867026, - "model": "gpt-3.5-turbo-0613", + "created": 1766181537, + "model": "gpt-5.1-2025-11-13", + "service_tier": "default", "system_fingerprint": None, "choices": [ - {"index": 0, "delta": {"role": "assistant", "content": ""}, "logprobs": None, "finish_reason": None} + {"index": 0, "delta": {"role": "assistant", "content": "", "refusal": None}, "finish_reason": None} ], + "obfuscation": "7AdzF", }, { - "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug", + "id": "chatcmpl-CocmvmDih6DGKIgPUbrzKFxGnMyco", "object": "chat.completion.chunk", - "created": 1707867026, - "model": "gpt-3.5-turbo-0613", + "created": 1766181537, + "model": "gpt-5.1-2025-11-13", + "service_tier": "default", "system_fingerprint": None, - "choices": [{"index": 0, "delta": {"content": "212"}, "logprobs": None, "finish_reason": None}], + "choices": [{"index": 0, "delta": {"content": "212"}, "finish_reason": None}], + "obfuscation": "4FR1", }, { - "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug", + "id": "chatcmpl-CocmvmDih6DGKIgPUbrzKFxGnMyco", "object": "chat.completion.chunk", - "created": 1707867026, - "model": "gpt-3.5-turbo-0613", + "created": 1766181537, + "model": "gpt-5.1-2025-11-13", + "service_tier": "default", "system_fingerprint": None, - "choices": [{"index": 0, "delta": {"content": " degrees"}, "logprobs": None, "finish_reason": None}], + "choices": [{"index": 0, "delta": {"content": "\u00b0F"}, "finish_reason": None}], + "obfuscation": "BIIOg", }, { - "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug", + "id": "chatcmpl-CocmvmDih6DGKIgPUbrzKFxGnMyco", "object": "chat.completion.chunk", - "created": 1707867026, - "model": "gpt-3.5-turbo-0613", + "created": 1766181537, + "model": "gpt-5.1-2025-11-13", + "service_tier": "default", "system_fingerprint": None, - "choices": [{"index": 0, "delta": {"content": " Fahrenheit"}, "logprobs": None, "finish_reason": None}], + "choices": [{"index": 0, "delta": {"content": " is"}, "finish_reason": None}], + "obfuscation": "lp2C", }, { - "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug", + "id": "chatcmpl-CocmvmDih6DGKIgPUbrzKFxGnMyco", "object": "chat.completion.chunk", - "created": 1707867026, - "model": "gpt-3.5-turbo-0613", + "created": 1766181537, + "model": "gpt-5.1-2025-11-13", + "service_tier": "default", "system_fingerprint": None, - "choices": [{"index": 0, "delta": {"content": " is"}, "logprobs": None, "finish_reason": None}], + "choices": [{"index": 0, "delta": {"content": " "}, "finish_reason": None}], + "obfuscation": "UCIK6d", }, { - "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug", + "id": "chatcmpl-CocmvmDih6DGKIgPUbrzKFxGnMyco", "object": "chat.completion.chunk", - "created": 1707867026, - "model": "gpt-3.5-turbo-0613", - "system_fingerprint": None, - "choices": [{"index": 0, "delta": {"content": " equal"}, "logprobs": None, "finish_reason": None}], - }, - { - "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug", - "object": "chat.completion.chunk", - "created": 1707867026, - "model": "gpt-3.5-turbo-0613", - "system_fingerprint": None, - "choices": [{"index": 0, "delta": {"content": " to"}, "logprobs": None, "finish_reason": None}], - }, - { - "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug", - "object": "chat.completion.chunk", - "created": 1707867026, - "model": "gpt-3.5-turbo-0613", - "system_fingerprint": None, - "choices": [{"index": 0, "delta": {"content": " "}, "logprobs": None, "finish_reason": None}], - }, - { - "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug", - "object": "chat.completion.chunk", - "created": 1707867026, - "model": "gpt-3.5-turbo-0613", - "system_fingerprint": None, - "choices": [{"index": 0, "delta": {"content": "100"}, "logprobs": None, "finish_reason": None}], - }, - { - "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug", - "object": "chat.completion.chunk", - "created": 1707867026, - "model": "gpt-3.5-turbo-0613", + "created": 1766181537, + "model": "gpt-5.1-2025-11-13", + "service_tier": "default", "system_fingerprint": None, - "choices": [{"index": 0, "delta": {"content": " degrees"}, "logprobs": None, "finish_reason": None}], + "choices": [{"index": 0, "delta": {"content": "100"}, "finish_reason": None}], + "obfuscation": "VIpm", }, { - "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug", + "id": "chatcmpl-CocmvmDih6DGKIgPUbrzKFxGnMyco", "object": "chat.completion.chunk", - "created": 1707867026, - "model": "gpt-3.5-turbo-0613", + "created": 1766181537, + "model": "gpt-5.1-2025-11-13", + "service_tier": "default", "system_fingerprint": None, - "choices": [{"index": 0, "delta": {"content": " Celsius"}, "logprobs": None, "finish_reason": None}], + "choices": [{"index": 0, "delta": {"content": "\u00b0C"}, "finish_reason": None}], + "obfuscation": "uHzcW", }, { - "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug", + "id": "chatcmpl-CocmvmDih6DGKIgPUbrzKFxGnMyco", "object": "chat.completion.chunk", - "created": 1707867026, - "model": "gpt-3.5-turbo-0613", + "created": 1766181537, + "model": "gpt-5.1-2025-11-13", + "service_tier": "default", "system_fingerprint": None, - "choices": [{"index": 0, "delta": {"content": "."}, "logprobs": None, "finish_reason": None}], + "choices": [{"index": 0, "delta": {"content": "."}, "finish_reason": None}], + "obfuscation": "WDub1R", }, { - "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug", + "id": "chatcmpl-CocmvmDih6DGKIgPUbrzKFxGnMyco", "object": "chat.completion.chunk", - "created": 1707867026, - "model": "gpt-3.5-turbo-0613", + "created": 1766181537, + "model": "gpt-5.1-2025-11-13", + "service_tier": "default", "system_fingerprint": None, - "choices": [{"index": 0, "delta": {}, "logprobs": None, "finish_reason": "stop"}], + "choices": [{"index": 0, "delta": {}, "finish_reason": "stop"}], + "obfuscation": "2", }, ], ], diff --git a/tests/mlmodel_openai/test_chat_completion_error_v1.py b/tests/mlmodel_openai/test_chat_completion_error_v1.py index 848ad57add..555001a702 100644 --- a/tests/mlmodel_openai/test_chat_completion_error_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_error_v1.py @@ -115,7 +115,7 @@ def test_chat_completion_invalid_request_error_no_model(set_trace_info, sync_ope add_custom_attribute("llm.conversation_id", "my-awesome-id") with WithLlmCustomAttributes({"context": "attr"}): sync_openai_client.chat.completions.create( - messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) @@ -141,7 +141,7 @@ def test_chat_completion_invalid_request_error_no_model_no_content(set_trace_inf with pytest.raises(TypeError): add_custom_attribute("llm.conversation_id", "my-awesome-id") sync_openai_client.chat.completions.create( - messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) @@ -170,7 +170,7 @@ def test_chat_completion_invalid_request_error_no_model_async(loop, set_trace_in with WithLlmCustomAttributes({"context": "attr"}): loop.run_until_complete( async_openai_client.chat.completions.create( - messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) ) @@ -198,7 +198,7 @@ def test_chat_completion_invalid_request_error_no_model_async_no_content(loop, s add_custom_attribute("llm.conversation_id", "my-awesome-id") loop.run_until_complete( async_openai_client.chat.completions.create( - messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) ) @@ -267,7 +267,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info, syn model="does-not-exist", messages=({"role": "user", "content": "Model does not exist."},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, ) @@ -298,7 +298,7 @@ def test_chat_completion_invalid_request_error_invalid_model_with_token_count(se model="does-not-exist", messages=({"role": "user", "content": "Model does not exist."},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, ) @@ -329,7 +329,7 @@ def test_chat_completion_invalid_request_error_invalid_model_async(loop, set_tra model="does-not-exist", messages=({"role": "user", "content": "Model does not exist."},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, ) ) @@ -364,7 +364,7 @@ def test_chat_completion_invalid_request_error_invalid_model_with_token_count_as model="does-not-exist", messages=({"role": "user", "content": "Model does not exist."},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, ) ) @@ -378,7 +378,7 @@ def test_chat_completion_invalid_request_error_invalid_model_with_token_count_as "span_id": None, "trace_id": "trace-id", "duration": None, # Response time varies each test run - "request.model": "gpt-3.5-turbo", + "request.model": "gpt-5.1", "request.temperature": 0.7, "request.max_tokens": 100, "response.number_of_messages": 1, @@ -430,10 +430,10 @@ def test_chat_completion_wrong_api_key_error(monkeypatch, set_trace_info, sync_o monkeypatch.setattr(sync_openai_client, "api_key", "DEADBEEF") with pytest.raises(openai.AuthenticationError): sync_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=({"role": "user", "content": "Invalid API key."},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, ) @@ -463,10 +463,10 @@ def test_chat_completion_wrong_api_key_error_async(loop, monkeypatch, set_trace_ with pytest.raises(openai.AuthenticationError): loop.run_until_complete( async_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=({"role": "user", "content": "Invalid API key."},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, ) ) @@ -493,7 +493,7 @@ def test_chat_completion_invalid_request_error_no_model_with_raw_response(set_tr with pytest.raises(TypeError): add_custom_attribute("llm.conversation_id", "my-awesome-id") sync_openai_client.chat.completions.with_raw_response.create( - messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) @@ -522,7 +522,7 @@ def test_chat_completion_invalid_request_error_no_model_no_content_with_raw_resp with pytest.raises(TypeError): add_custom_attribute("llm.conversation_id", "my-awesome-id") sync_openai_client.chat.completions.with_raw_response.create( - messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) @@ -551,7 +551,7 @@ def test_chat_completion_invalid_request_error_no_model_async_with_raw_response( add_custom_attribute("llm.conversation_id", "my-awesome-id") loop.run_until_complete( async_openai_client.chat.completions.with_raw_response.create( - messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) ) @@ -582,7 +582,7 @@ def test_chat_completion_invalid_request_error_no_model_async_no_content_with_ra add_custom_attribute("llm.conversation_id", "my-awesome-id") loop.run_until_complete( async_openai_client.chat.completions.with_raw_response.create( - messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) ) @@ -613,7 +613,7 @@ def test_chat_completion_invalid_request_error_invalid_model_with_raw_response(s model="does-not-exist", messages=({"role": "user", "content": "Model does not exist."},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, ) @@ -646,7 +646,7 @@ def test_chat_completion_invalid_request_error_invalid_model_with_token_count_wi model="does-not-exist", messages=({"role": "user", "content": "Model does not exist."},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, ) @@ -679,7 +679,7 @@ def test_chat_completion_invalid_request_error_invalid_model_async_with_raw_resp model="does-not-exist", messages=({"role": "user", "content": "Model does not exist."},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, ) ) @@ -714,7 +714,7 @@ def test_chat_completion_invalid_request_error_invalid_model_with_token_count_as model="does-not-exist", messages=({"role": "user", "content": "Model does not exist."},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, ) ) @@ -744,10 +744,10 @@ def test_chat_completion_wrong_api_key_error_with_raw_response(monkeypatch, set_ monkeypatch.setattr(sync_openai_client, "api_key", "DEADBEEF") with pytest.raises(openai.AuthenticationError): sync_openai_client.chat.completions.with_raw_response.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=({"role": "user", "content": "Invalid API key."},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, ) @@ -779,9 +779,9 @@ def test_chat_completion_wrong_api_key_error_async_with_raw_response( with pytest.raises(openai.AuthenticationError): loop.run_until_complete( async_openai_client.chat.completions.with_raw_response.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=({"role": "user", "content": "Invalid API key."},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, ) ) diff --git a/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py b/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py index 5d06dc2a28..ce3ce8061e 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_stream_error_v1.py @@ -116,7 +116,7 @@ def test_chat_completion_invalid_request_error_no_model(set_trace_info, sync_ope add_custom_attribute("llm.conversation_id", "my-awesome-id") with WithLlmCustomAttributes({"context": "attr"}): generator = sync_openai_client.chat.completions.create( - messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100, stream=True + messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100, stream=True ) for resp in generator: assert resp @@ -145,7 +145,7 @@ def test_chat_completion_invalid_request_error_no_model_no_content(set_trace_inf with pytest.raises(TypeError): add_custom_attribute("llm.conversation_id", "my-awesome-id") generator = sync_openai_client.chat.completions.create( - messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100, stream=True + messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100, stream=True ) for resp in generator: assert resp @@ -176,7 +176,10 @@ def test_chat_completion_invalid_request_error_no_model_async(loop, set_trace_in async def consumer(): generator = await async_openai_client.chat.completions.create( - messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100, stream=True + messages=_test_openai_chat_completion_messages, + temperature=0.7, + max_completion_tokens=100, + stream=True, ) async for resp in generator: assert resp @@ -209,7 +212,7 @@ def test_chat_completion_invalid_request_error_no_model_async_no_content(loop, s async def consumer(): generator = await async_openai_client.chat.completions.create( - messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100, stream=True + messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100, stream=True ) async for resp in generator: assert resp @@ -261,7 +264,9 @@ async def consumer(): callable_name(openai.NotFoundError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, ) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) +@validate_span_events( + exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} +) @validate_transaction_metrics( "test_chat_completion_stream_error_v1:test_chat_completion_invalid_request_error_invalid_model", scoped_metrics=[("Llm/completion/OpenAI/create", 1)], @@ -279,7 +284,7 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info, syn model="does-not-exist", messages=({"role": "user", "content": "Model does not exist."},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) for resp in generator: @@ -293,7 +298,9 @@ def test_chat_completion_invalid_request_error_invalid_model(set_trace_info, syn callable_name(openai.NotFoundError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, ) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) +@validate_span_events( + exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} +) @validate_transaction_metrics( "test_chat_completion_stream_error_v1:test_chat_completion_invalid_request_error_invalid_model_with_token_count", scoped_metrics=[("Llm/completion/OpenAI/create", 1)], @@ -312,7 +319,7 @@ def test_chat_completion_invalid_request_error_invalid_model_with_token_count(se model="does-not-exist", messages=({"role": "user", "content": "Model does not exist."},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) for resp in generator: @@ -326,7 +333,9 @@ def test_chat_completion_invalid_request_error_invalid_model_with_token_count(se callable_name(openai.NotFoundError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, ) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) +@validate_span_events( + exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} +) @validate_transaction_metrics( "test_chat_completion_stream_error_v1:test_chat_completion_invalid_request_error_invalid_model_async_with_token_count", scoped_metrics=[("Llm/completion/OpenAI/create", 1)], @@ -348,7 +357,7 @@ async def consumer(): model="does-not-exist", messages=({"role": "user", "content": "Model does not exist."},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) async for resp in generator: @@ -363,7 +372,9 @@ async def consumer(): callable_name(openai.NotFoundError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {"error.code": "model_not_found", "http.statusCode": 404}}, ) -@validate_span_events(exact_agents={"error.message": "The model `does-not-exist` does not exist"}) +@validate_span_events( + exact_agents={"error.message": "The model `does-not-exist` does not exist or you do not have access to it."} +) @validate_transaction_metrics( "test_chat_completion_stream_error_v1:test_chat_completion_invalid_request_error_invalid_model_async", scoped_metrics=[("Llm/completion/OpenAI/create", 1)], @@ -383,7 +394,7 @@ async def consumer(): model="does-not-exist", messages=({"role": "user", "content": "Model does not exist."},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) async for resp in generator: @@ -401,7 +412,7 @@ async def consumer(): "span_id": None, "trace_id": "trace-id", "duration": None, # Response time varies each test run - "request.model": "gpt-3.5-turbo", + "request.model": "gpt-5.1", "request.temperature": 0.7, "request.max_tokens": 100, "response.number_of_messages": 1, @@ -453,10 +464,10 @@ def test_chat_completion_wrong_api_key_error(monkeypatch, set_trace_info, sync_o monkeypatch.setattr(sync_openai_client, "api_key", "DEADBEEF") with pytest.raises(openai.AuthenticationError): generator = sync_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=({"role": "user", "content": "Invalid API key."},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) for resp in generator: @@ -490,10 +501,10 @@ def test_chat_completion_wrong_api_key_error_async(loop, monkeypatch, set_trace_ async def consumer(): generator = await async_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=({"role": "user", "content": "Invalid API key."},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) async for resp in generator: diff --git a/tests/mlmodel_openai/test_chat_completion_stream_v1.py b/tests/mlmodel_openai/test_chat_completion_stream_v1.py index 6fc5d58f28..f5995399f7 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_stream_v1.py @@ -59,22 +59,22 @@ "llm.foo": "bar", "span_id": None, "trace_id": "trace-id", - "request_id": "f8d0f53b6881c5c0a3698e55f8f410ac", + "request_id": "req_f821c73df45f4e30821a81a2d751fe64", "duration": None, # Response time varies each test run - "request.model": "gpt-3.5-turbo", - "response.model": "gpt-3.5-turbo-0613", - "response.organization": "new-relic-nkmd8b", + "request.model": "gpt-5.1", + "response.model": "gpt-5.1-2025-11-13", + "response.organization": "nr-test-org", # Usage tokens aren't available when streaming. "request.temperature": 0.7, "request.max_tokens": 100, "response.choices.finish_reason": "stop", "response.headers.llmVersion": "2020-10-01", - "response.headers.ratelimitLimitRequests": 200, + "response.headers.ratelimitLimitRequests": 15000, "response.headers.ratelimitLimitTokens": 40000, - "response.headers.ratelimitResetTokens": "180ms", - "response.headers.ratelimitResetRequests": "11m32.334s", - "response.headers.ratelimitRemainingTokens": 39880, - "response.headers.ratelimitRemainingRequests": 198, + "response.headers.ratelimitResetTokens": "0s", + "response.headers.ratelimitResetRequests": "4ms", + "response.headers.ratelimitRemainingTokens": 39999978, + "response.headers.ratelimitRemainingRequests": 14999, "vendor": "openai", "ingest_source": "Python", "response.number_of_messages": 3, @@ -83,18 +83,18 @@ ( {"type": "LlmChatCompletionMessage"}, { - "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug-0", + "id": "chatcmpl-CocmvmDih6DGKIgPUbrzKFxGnMyco-0", "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", - "request_id": "f8d0f53b6881c5c0a3698e55f8f410ac", + "request_id": "req_f821c73df45f4e30821a81a2d751fe64", "span_id": None, "trace_id": "trace-id", "content": "You are a scientist.", "role": "system", "completion_id": None, "sequence": 0, - "response.model": "gpt-3.5-turbo-0613", + "response.model": "gpt-5.1-2025-11-13", "vendor": "openai", "ingest_source": "Python", }, @@ -102,18 +102,18 @@ ( {"type": "LlmChatCompletionMessage"}, { - "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug-1", + "id": "chatcmpl-CocmvmDih6DGKIgPUbrzKFxGnMyco-1", "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", - "request_id": "f8d0f53b6881c5c0a3698e55f8f410ac", + "request_id": "req_f821c73df45f4e30821a81a2d751fe64", "span_id": None, "trace_id": "trace-id", "content": "What is 212 degrees Fahrenheit converted to Celsius?", "role": "user", "completion_id": None, "sequence": 1, - "response.model": "gpt-3.5-turbo-0613", + "response.model": "gpt-5.1-2025-11-13", "vendor": "openai", "ingest_source": "Python", }, @@ -121,18 +121,18 @@ ( {"type": "LlmChatCompletionMessage"}, { - "id": "chatcmpl-8TJ9dS50zgQM7XicE8PLnCyEihRug-2", + "id": "chatcmpl-CocmvmDih6DGKIgPUbrzKFxGnMyco-2", "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", - "request_id": "f8d0f53b6881c5c0a3698e55f8f410ac", + "request_id": "req_f821c73df45f4e30821a81a2d751fe64", "span_id": None, "trace_id": "trace-id", - "content": "212 degrees Fahrenheit is equal to 100 degrees Celsius.", + "content": "212°F is 100°C.", "role": "assistant", "completion_id": None, "sequence": 2, - "response.model": "gpt-3.5-turbo-0613", + "response.model": "gpt-5.1-2025-11-13", "vendor": "openai", "is_response": True, "ingest_source": "Python", @@ -160,10 +160,10 @@ def test_openai_chat_completion_sync_with_llm_metadata(set_trace_info, sync_open with WithLlmCustomAttributes({"context": "attr"}): generator = sync_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) @@ -192,10 +192,10 @@ def test_openai_chat_completion_sync_with_llm_metadata_with_streaming_response_l add_custom_attribute("non_llm_attr", "python-agent") create_dict = { - "model": "gpt-3.5-turbo", + "model": "gpt-5.1", "messages": _test_openai_chat_completion_messages, "temperature": 0.7, - "max_tokens": 100, + "max_completion_tokens": 100, } if stream_set: create_dict["stream"] = stream_val @@ -226,10 +226,10 @@ def test_openai_chat_completion_sync_with_llm_metadata_with_streaming_response_b add_custom_attribute("non_llm_attr", "python-agent") create_dict = { - "model": "gpt-3.5-turbo", + "model": "gpt-5.1", "messages": _test_openai_chat_completion_messages, "temperature": 0.7, - "max_tokens": 100, + "max_completion_tokens": 100, } if stream_set: create_dict["stream"] = stream_val @@ -260,10 +260,10 @@ def test_openai_chat_completion_sync_with_llm_metadata_with_streaming_response_t add_custom_attribute("non_llm_attr", "python-agent") create_dict = { - "model": "gpt-3.5-turbo", + "model": "gpt-5.1", "messages": _test_openai_chat_completion_messages, "temperature": 0.7, - "max_tokens": 100, + "max_completion_tokens": 100, } if stream_set: create_dict["stream"] = stream_val @@ -291,10 +291,10 @@ def test_openai_chat_completion_sync_no_content(set_trace_info, sync_openai_clie add_custom_attribute("llm.foo", "bar") generator = sync_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) @@ -320,10 +320,10 @@ def test_openai_chat_completion_sync_in_txn_with_llm_metadata_with_token_count(s add_custom_attribute("llm.foo", "bar") generator = sync_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) for resp in generator: @@ -345,10 +345,10 @@ def test_openai_chat_completion_sync_no_llm_metadata(set_trace_info, sync_openai set_trace_info() generator = sync_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) @@ -369,10 +369,10 @@ def test_openai_chat_completion_sync_no_llm_metadata(set_trace_info, sync_openai @background_task() def test_openai_chat_completion_sync_ai_monitoring_streaming_disabled(sync_openai_client): generator = sync_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) @@ -384,10 +384,10 @@ def test_openai_chat_completion_sync_ai_monitoring_streaming_disabled(sync_opena @validate_custom_event_count(count=0) def test_openai_chat_completion_sync_outside_txn(sync_openai_client): generator = sync_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) @@ -401,10 +401,10 @@ def test_openai_chat_completion_sync_outside_txn(sync_openai_client): @background_task() def test_openai_chat_completion_sync_ai_monitoring_disabled(sync_openai_client): generator = sync_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) @@ -427,10 +427,10 @@ def test_openai_chat_completion_async_no_llm_metadata(loop, set_trace_info, asyn async def consumer(): generator = await async_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) async for resp in generator: @@ -459,10 +459,10 @@ def test_openai_chat_completion_async_with_llm_metadata(loop, set_trace_info, as async def consumer(): generator = await async_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) async for resp in generator: @@ -496,10 +496,10 @@ def test_openai_chat_completion_async_with_llm_metadata_with_streaming_response_ add_custom_attribute("llm.foo", "bar") add_custom_attribute("non_llm_attr", "python-agent") create_dict = { - "model": "gpt-3.5-turbo", + "model": "gpt-5.1", "messages": _test_openai_chat_completion_messages, "temperature": 0.7, - "max_tokens": 100, + "max_completion_tokens": 100, } if stream_set: create_dict["stream"] = stream_val @@ -536,10 +536,10 @@ def test_openai_chat_completion_async_with_llm_metadata_with_streaming_response_ add_custom_attribute("llm.foo", "bar") add_custom_attribute("non_llm_attr", "python-agent") create_dict = { - "model": "gpt-3.5-turbo", + "model": "gpt-5.1", "messages": _test_openai_chat_completion_messages, "temperature": 0.7, - "max_tokens": 100, + "max_completion_tokens": 100, } if stream_set: create_dict["stream"] = stream_val @@ -576,10 +576,10 @@ def test_openai_chat_completion_async_with_llm_metadata_with_streaming_response_ add_custom_attribute("llm.foo", "bar") add_custom_attribute("non_llm_attr", "python-agent") create_dict = { - "model": "gpt-3.5-turbo", + "model": "gpt-5.1", "messages": _test_openai_chat_completion_messages, "temperature": 0.7, - "max_tokens": 100, + "max_completion_tokens": 100, } if stream_set: create_dict["stream"] = stream_val @@ -612,10 +612,10 @@ def test_openai_chat_completion_async_no_content(loop, set_trace_info, async_ope async def consumer(): generator = await async_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) async for resp in generator: @@ -643,10 +643,10 @@ def test_openai_chat_completion_async_with_token_count(set_trace_info, loop, asy async def consumer(): generator = await async_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) async for resp in generator: @@ -669,10 +669,10 @@ async def consumer(): def test_openai_chat_completion_async_ai_monitoring_streaming_disabled(loop, async_openai_client): async def consumer(): generator = await async_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) async for resp in generator: @@ -686,10 +686,10 @@ async def consumer(): def test_openai_chat_completion_async_outside_transaction(loop, async_openai_client): async def consumer(): generator = await async_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) async for resp in generator: @@ -705,10 +705,10 @@ async def consumer(): def test_openai_chat_completion_async_disabled_ai_monitoring_settings(loop, async_openai_client): async def consumer(): generator = await async_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, - max_tokens=100, + max_completion_tokens=100, stream=True, ) async for resp in generator: diff --git a/tests/mlmodel_openai/test_chat_completion_v1.py b/tests/mlmodel_openai/test_chat_completion_v1.py index 5a6793d955..e25829bf40 100644 --- a/tests/mlmodel_openai/test_chat_completion_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_v1.py @@ -48,21 +48,21 @@ "llm.foo": "bar", "span_id": None, "trace_id": "trace-id", - "request_id": "req_25be7e064e0c590cd65709c85385c796", + "request_id": "req_983c5abb07aa4f51b858f855fc614d08", "duration": None, # Response time varies each test run - "request.model": "gpt-3.5-turbo", - "response.model": "gpt-3.5-turbo-0125", - "response.organization": "new-relic-nkmd8b", + "request.model": "gpt-5.1", + "response.model": "gpt-5.1-2025-11-13", + "response.organization": "nr-test-org", "request.temperature": 0.7, "request.max_tokens": 100, "response.choices.finish_reason": "stop", "response.headers.llmVersion": "2020-10-01", - "response.headers.ratelimitLimitRequests": 10000, - "response.headers.ratelimitLimitTokens": 60000, - "response.headers.ratelimitResetTokens": "120ms", - "response.headers.ratelimitResetRequests": "54.889s", - "response.headers.ratelimitRemainingTokens": 59880, - "response.headers.ratelimitRemainingRequests": 9993, + "response.headers.ratelimitLimitRequests": 15000, + "response.headers.ratelimitLimitTokens": 40000000, + "response.headers.ratelimitResetTokens": "0s", + "response.headers.ratelimitResetRequests": "4ms", + "response.headers.ratelimitRemainingTokens": 39999979, + "response.headers.ratelimitRemainingRequests": 14999, "vendor": "openai", "ingest_source": "Python", "response.number_of_messages": 3, @@ -71,18 +71,18 @@ ( {"type": "LlmChatCompletionMessage"}, { - "id": "chatcmpl-9NPYxI4Zk5ztxNwW5osYdpevgoiBQ-0", + "id": "chatcmpl-CoLlpfFdbk9D0AbjizzpQ8hMwX9AY-0", "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", - "request_id": "req_25be7e064e0c590cd65709c85385c796", + "request_id": "req_983c5abb07aa4f51b858f855fc614d08", "span_id": None, "trace_id": "trace-id", "content": "You are a scientist.", "role": "system", "completion_id": None, "sequence": 0, - "response.model": "gpt-3.5-turbo-0125", + "response.model": "gpt-5.1-2025-11-13", "vendor": "openai", "ingest_source": "Python", }, @@ -90,18 +90,18 @@ ( {"type": "LlmChatCompletionMessage"}, { - "id": "chatcmpl-9NPYxI4Zk5ztxNwW5osYdpevgoiBQ-1", + "id": "chatcmpl-CoLlpfFdbk9D0AbjizzpQ8hMwX9AY-1", "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", - "request_id": "req_25be7e064e0c590cd65709c85385c796", + "request_id": "req_983c5abb07aa4f51b858f855fc614d08", "span_id": None, "trace_id": "trace-id", "content": "What is 212 degrees Fahrenheit converted to Celsius?", "role": "user", "completion_id": None, "sequence": 1, - "response.model": "gpt-3.5-turbo-0125", + "response.model": "gpt-5.1-2025-11-13", "vendor": "openai", "ingest_source": "Python", }, @@ -109,18 +109,18 @@ ( {"type": "LlmChatCompletionMessage"}, { - "id": "chatcmpl-9NPYxI4Zk5ztxNwW5osYdpevgoiBQ-2", + "id": "chatcmpl-CoLlpfFdbk9D0AbjizzpQ8hMwX9AY-2", "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", - "request_id": "req_25be7e064e0c590cd65709c85385c796", + "request_id": "req_983c5abb07aa4f51b858f855fc614d08", "span_id": None, "trace_id": "trace-id", - "content": "212 degrees Fahrenheit is equivalent to 100 degrees Celsius. \n\nThe formula to convert Fahrenheit to Celsius is: \n\n\\[Celsius = (Fahrenheit - 32) \\times \\frac{5}{9}\\]\n\nSo, for 212 degrees Fahrenheit:\n\n\\[Celsius = (212 - 32) \\times \\frac{5}{9} = 100\\]", + "content": "212\u00b0F is 100\u00b0C.", "role": "assistant", "completion_id": None, "sequence": 2, - "response.model": "gpt-3.5-turbo-0125", + "response.model": "gpt-5.1-2025-11-13", "vendor": "openai", "is_response": True, "ingest_source": "Python", @@ -147,7 +147,7 @@ def test_openai_chat_completion_sync_with_llm_metadata(set_trace_info, sync_open add_custom_attribute("non_llm_attr", "python-agent") with WithLlmCustomAttributes({"context": "attr"}): sync_openai_client.chat.completions.create( - model="gpt-3.5-turbo", messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) @@ -169,7 +169,7 @@ def test_openai_chat_completion_sync_with_llm_metadata_with_raw_response(set_tra add_custom_attribute("non_llm_attr", "python-agent") sync_openai_client.chat.completions.with_raw_response.create( - model="gpt-3.5-turbo", messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) @@ -191,7 +191,7 @@ def test_openai_chat_completion_sync_no_content(set_trace_info, sync_openai_clie add_custom_attribute("llm.foo", "bar") sync_openai_client.chat.completions.create( - model="gpt-3.5-turbo", messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) @@ -213,7 +213,7 @@ def test_openai_chat_completion_sync_with_token_count(set_trace_info, sync_opena add_custom_attribute("llm.foo", "bar") sync_openai_client.chat.completions.create( - model="gpt-3.5-turbo", messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) @@ -232,7 +232,7 @@ def test_openai_chat_completion_sync_no_llm_metadata(set_trace_info, sync_openai set_trace_info() sync_openai_client.chat.completions.create( - model="gpt-3.5-turbo", messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) @@ -252,7 +252,7 @@ def test_openai_chat_completion_sync_stream_monitoring_disabled(set_trace_info, set_trace_info() sync_openai_client.chat.completions.create( - model="gpt-3.5-turbo", messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) @@ -260,7 +260,7 @@ def test_openai_chat_completion_sync_stream_monitoring_disabled(set_trace_info, @validate_custom_event_count(count=0) def test_openai_chat_completion_sync_outside_txn(sync_openai_client): sync_openai_client.chat.completions.create( - model="gpt-3.5-turbo", messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) @@ -270,7 +270,7 @@ def test_openai_chat_completion_sync_outside_txn(sync_openai_client): @background_task() def test_openai_chat_completion_sync_ai_monitoring_disabled(sync_openai_client): sync_openai_client.chat.completions.create( - model="gpt-3.5-turbo", messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) @@ -289,7 +289,7 @@ def test_openai_chat_completion_async_no_llm_metadata(loop, set_trace_info, asyn loop.run_until_complete( async_openai_client.chat.completions.create( - model="gpt-3.5-turbo", messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) ) @@ -310,7 +310,7 @@ def test_openai_chat_completion_async_stream_monitoring_disabled(loop, set_trace loop.run_until_complete( async_openai_client.chat.completions.create( - model="gpt-3.5-turbo", messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) ) @@ -336,7 +336,10 @@ def test_openai_chat_completion_async_with_llm_metadata(loop, set_trace_info, as with WithLlmCustomAttributes({"context": "attr"}): loop.run_until_complete( async_openai_client.chat.completions.create( - model="gpt-3.5-turbo", messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + model="gpt-5.1", + messages=_test_openai_chat_completion_messages, + temperature=0.7, + max_completion_tokens=100, ) ) @@ -361,7 +364,7 @@ def test_openai_chat_completion_async_with_llm_metadata_with_raw_response(loop, loop.run_until_complete( async_openai_client.chat.completions.with_raw_response.create( - model="gpt-3.5-turbo", messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) ) @@ -386,7 +389,7 @@ def test_openai_chat_completion_async_with_llm_metadata_no_content(loop, set_tra loop.run_until_complete( async_openai_client.chat.completions.create( - model="gpt-3.5-turbo", messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) ) @@ -410,7 +413,7 @@ def test_openai_chat_completion_async_in_txn_with_token_count(set_trace_info, lo loop.run_until_complete( async_openai_client.chat.completions.create( - model="gpt-3.5-turbo", messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) ) @@ -420,7 +423,7 @@ def test_openai_chat_completion_async_in_txn_with_token_count(set_trace_info, lo def test_openai_chat_completion_async_outside_transaction(loop, async_openai_client): loop.run_until_complete( async_openai_client.chat.completions.create( - model="gpt-3.5-turbo", messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) ) @@ -432,27 +435,30 @@ def test_openai_chat_completion_async_outside_transaction(loop, async_openai_cli def test_openai_chat_completion_async_ai_monitoring_disabled(loop, async_openai_client): loop.run_until_complete( async_openai_client.chat.completions.create( - model="gpt-3.5-turbo", messages=_test_openai_chat_completion_messages, temperature=0.7, max_tokens=100 + model="gpt-5.1", messages=_test_openai_chat_completion_messages, temperature=0.7, max_completion_tokens=100 ) ) @reset_core_stats_engine() -# One summary event, one system message, one user message, and one response message from the assistant -@validate_custom_event_count(count=3) +# One summary event and one user message (no assistant message is recorded) +@validate_custom_event_count(count=2) @validate_attributes("agent", ["llm"]) @background_task() -def test_openai_chat_completion_no_usage_data(set_trace_info, sync_openai_client, loop): +def test_openai_chat_completion_no_usage_data(set_trace_info, sync_openai_client): # Only testing that there are events, and there was no exception raised set_trace_info() sync_openai_client.chat.completions.create( - model="gpt-3.5-turbo", messages=({"role": "user", "content": "No usage data"},), temperature=0.7, max_tokens=100 + model="gpt-5.1", + messages=({"role": "user", "content": "No usage data"},), + temperature=0.7, + max_completion_tokens=100, ) @reset_core_stats_engine() -# One summary event, one system message, one user message, and one response message from the assistant -@validate_custom_event_count(count=3) +# One summary event and one user message (no assistant message is recorded) +@validate_custom_event_count(count=2) @validate_attributes("agent", ["llm"]) @background_task() def test_openai_chat_completion_async_no_usage_data(set_trace_info, async_openai_client, loop): @@ -460,9 +466,9 @@ def test_openai_chat_completion_async_no_usage_data(set_trace_info, async_openai set_trace_info() loop.run_until_complete( async_openai_client.chat.completions.create( - model="gpt-3.5-turbo", + model="gpt-5.1", messages=({"role": "user", "content": "No usage data"},), temperature=0.7, - max_tokens=100, + max_completion_tokens=100, ) ) diff --git a/tests/mlmodel_openai/test_embeddings_v1.py b/tests/mlmodel_openai/test_embeddings_v1.py index 405a2a9e5f..9dd10262a5 100644 --- a/tests/mlmodel_openai/test_embeddings_v1.py +++ b/tests/mlmodel_openai/test_embeddings_v1.py @@ -37,17 +37,17 @@ "trace_id": "trace-id", "input": "This is an embedding test.", "duration": None, # Response time varies each test run - "response.model": "text-embedding-ada-002", - "request.model": "text-embedding-ada-002", - "request_id": "req_eb2b9f2d23a671ad0d69545044437d68", - "response.organization": "new-relic-nkmd8b", + "response.model": "text-embedding-3-small", + "request.model": "text-embedding-3-small", + "request_id": "req_215501af84244a0891dc2c7828e36c28", + "response.organization": "nr-test-org", "response.headers.llmVersion": "2020-10-01", - "response.headers.ratelimitLimitRequests": 3000, - "response.headers.ratelimitLimitTokens": 1000000, + "response.headers.ratelimitLimitRequests": 10000, + "response.headers.ratelimitLimitTokens": 10000000, "response.headers.ratelimitResetTokens": "0s", - "response.headers.ratelimitResetRequests": "20ms", - "response.headers.ratelimitRemainingTokens": 999994, - "response.headers.ratelimitRemainingRequests": 2999, + "response.headers.ratelimitResetRequests": "6ms", + "response.headers.ratelimitRemainingTokens": 9999994, + "response.headers.ratelimitRemainingRequests": 9999, "vendor": "openai", "ingest_source": "Python", }, @@ -69,7 +69,7 @@ @background_task() def test_openai_embedding_sync(set_trace_info, sync_openai_client): set_trace_info() - sync_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-ada-002") + sync_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-3-small") @reset_core_stats_engine() @@ -87,7 +87,7 @@ def test_openai_embedding_sync(set_trace_info, sync_openai_client): def test_openai_embedding_sync_with_raw_response(set_trace_info, sync_openai_client): set_trace_info() sync_openai_client.embeddings.with_raw_response.create( - input="This is an embedding test.", model="text-embedding-ada-002" + input="This is an embedding test.", model="text-embedding-3-small" ) @@ -106,7 +106,7 @@ def test_openai_embedding_sync_with_raw_response(set_trace_info, sync_openai_cli @background_task() def test_openai_embedding_sync_no_content(set_trace_info, sync_openai_client): set_trace_info() - sync_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-ada-002") + sync_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-3-small") @reset_core_stats_engine() @@ -124,13 +124,13 @@ def test_openai_embedding_sync_no_content(set_trace_info, sync_openai_client): @background_task() def test_openai_embedding_sync_with_token_count(set_trace_info, sync_openai_client): set_trace_info() - sync_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-ada-002") + sync_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-3-small") @reset_core_stats_engine() @validate_custom_event_count(count=0) def test_openai_embedding_sync_outside_txn(sync_openai_client): - sync_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-ada-002") + sync_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-3-small") @disabled_ai_monitoring_settings @@ -138,7 +138,7 @@ def test_openai_embedding_sync_outside_txn(sync_openai_client): @validate_custom_event_count(count=0) @background_task() def test_openai_embedding_sync_ai_monitoring_disabled(sync_openai_client): - sync_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-ada-002") + sync_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-3-small") @reset_core_stats_engine() @@ -157,7 +157,7 @@ def test_openai_embedding_async(loop, set_trace_info, async_openai_client): set_trace_info() loop.run_until_complete( - async_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-ada-002") + async_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-3-small") ) @@ -178,7 +178,7 @@ def test_openai_embedding_async_with_raw_response(loop, set_trace_info, async_op loop.run_until_complete( async_openai_client.embeddings.with_raw_response.create( - input="This is an embedding test.", model="text-embedding-ada-002" + input="This is an embedding test.", model="text-embedding-3-small" ) ) @@ -200,7 +200,7 @@ def test_openai_embedding_async_no_content(loop, set_trace_info, async_openai_cl set_trace_info() loop.run_until_complete( - async_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-ada-002") + async_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-3-small") ) @@ -220,7 +220,7 @@ def test_openai_embedding_async_no_content(loop, set_trace_info, async_openai_cl def test_openai_embedding_async_with_token_count(set_trace_info, loop, async_openai_client): set_trace_info() loop.run_until_complete( - async_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-ada-002") + async_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-3-small") ) @@ -228,7 +228,7 @@ def test_openai_embedding_async_with_token_count(set_trace_info, loop, async_ope @validate_custom_event_count(count=0) def test_openai_embedding_async_outside_transaction(loop, async_openai_client): loop.run_until_complete( - async_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-ada-002") + async_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-3-small") ) @@ -238,5 +238,5 @@ def test_openai_embedding_async_outside_transaction(loop, async_openai_client): @background_task() def test_openai_embedding_async_ai_monitoring_disabled(loop, async_openai_client): loop.run_until_complete( - async_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-ada-002") + async_openai_client.embeddings.create(input="This is an embedding test.", model="text-embedding-3-small") ) diff --git a/tox.ini b/tox.ini index 11ba696c83..4eb11c4049 100644 --- a/tox.ini +++ b/tox.ini @@ -189,7 +189,6 @@ envlist = ;; Package not ready for Python 3.14 (type annotations not updated) ; python-mlmodel_langchain-py314, python-mlmodel_openai-openai0-{py38,py39,py310,py311,py312}, - python-mlmodel_openai-openai107-py312, python-mlmodel_openai-openailatest-{py38,py39,py310,py311,py312,py313,py314}, python-mlmodel_sklearn-{py38,py39,py310,py311,py312,py313,py314}-scikitlearnlatest, python-template_genshi-{py38,py39,py310,py311,py312,py313,py314}-genshilatest, @@ -429,8 +428,6 @@ deps = mlmodel_autogen: mcp mlmodel_gemini: google-genai mlmodel_openai-openai0: openai[datalib]<1.0 - mlmodel_openai-openai107: openai[datalib]<1.8 - mlmodel_openai-openai107: httpx<0.28 mlmodel_openai-openailatest: openai[datalib] ; Required for openai testing mlmodel_openai: protobuf From c1168fdc7166c702e6d2e2b0050b10931d14823a Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Fri, 9 Jan 2026 14:35:25 -0800 Subject: [PATCH 042/124] Add additional CVE to trivy ignore (#1624) --- .github/.trivyignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/.trivyignore b/.github/.trivyignore index b418eb9779..e9de2222cc 100644 --- a/.github/.trivyignore +++ b/.github/.trivyignore @@ -6,6 +6,7 @@ CVE-2025-50181 # Requires misconfiguration of urllib3, which agent does not do without intervention CVE-2025-66418 # Malicious servers could cause high resource consumption CVE-2025-66471 # Malicious servers could cause high resource consumption +CVE-2026-21441 # Improper Handling of Highly Compressed Data (Data Amplification) # ======================= # Ignored Vulnerabilities From a7ade08004dff2d6d7aa2b3e12f555e587403a96 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 15 Jan 2026 10:51:58 -0800 Subject: [PATCH 043/124] Bump the github_actions group with 2 updates (#1626) Bumps the github_actions group with 2 updates: [astral-sh/setup-uv](https://github.com/astral-sh/setup-uv) and [github/codeql-action](https://github.com/github/codeql-action). Updates `astral-sh/setup-uv` from 7.1.6 to 7.2.0 - [Release notes](https://github.com/astral-sh/setup-uv/releases) - [Commits](https://github.com/astral-sh/setup-uv/compare/681c641aba71e4a1c380be3ab5e12ad51f415867...61cb8a9741eeb8a550a1b8544337180c0fc8476b) Updates `github/codeql-action` from 4.31.9 to 4.31.10 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/github/codeql-action/compare/5d4e8d1aca955e8d8589aabd499c5cae939e33c7...cdefb33c0f6224e58673d9004f47f7cb3e328b89) --- updated-dependencies: - dependency-name: astral-sh/setup-uv dependency-version: 7.2.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: github/codeql-action dependency-version: 4.31.10 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/tests.yml | 4 ++-- .github/workflows/trivy.yml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 3df2f338a4..aa3569ee21 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -301,7 +301,7 @@ jobs: git fetch --tags origin - name: Install uv - uses: astral-sh/setup-uv@681c641aba71e4a1c380be3ab5e12ad51f415867 # 7.1.6 + uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b # 7.2.0 - name: Install Python run: | @@ -370,7 +370,7 @@ jobs: git fetch --tags origin - name: Install uv - uses: astral-sh/setup-uv@681c641aba71e4a1c380be3ab5e12ad51f415867 # 7.1.6 + uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b # 7.2.0 - name: Install Python run: | diff --git a/.github/workflows/trivy.yml b/.github/workflows/trivy.yml index 89747c7b30..0cb037ebc4 100644 --- a/.github/workflows/trivy.yml +++ b/.github/workflows/trivy.yml @@ -61,6 +61,6 @@ jobs: - name: Upload Trivy scan results to GitHub Security tab if: ${{ github.event_name == 'schedule' }} - uses: github/codeql-action/upload-sarif@5d4e8d1aca955e8d8589aabd499c5cae939e33c7 # 4.31.9 + uses: github/codeql-action/upload-sarif@cdefb33c0f6224e58673d9004f47f7cb3e328b89 # 4.31.10 with: sarif_file: "trivy-results.sarif" From 5f3cd806be754bfbf1faf7770b59bfac683712a1 Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Thu, 22 Jan 2026 11:00:08 -0800 Subject: [PATCH 044/124] Fix LangChain Tests (#1631) * Fix langchain tool tests * Remove unnecessary chain test --- tests/mlmodel_langchain/test_chain.py | 84 --------------------------- tests/mlmodel_langchain/test_tool.py | 32 +++------- 2 files changed, 9 insertions(+), 107 deletions(-) diff --git a/tests/mlmodel_langchain/test_chain.py b/tests/mlmodel_langchain/test_chain.py index 2f52f85504..9a8d2cc746 100644 --- a/tests/mlmodel_langchain/test_chain.py +++ b/tests/mlmodel_langchain/test_chain.py @@ -1642,90 +1642,6 @@ def test_async_langchain_chain_outside_transaction( loop.run_until_complete(getattr(runnable, call_function)(input_)) -@pytest.mark.parametrize( - "create_function,call_function,call_function_args,call_function_kwargs,expected_events", - ( - pytest.param( - create_structured_output_runnable, - "ainvoke", - ({"input": "Sally is 13"},), - {"config": {"tags": ["bar"], "metadata": {"id": "123"}}}, - chat_completion_recorded_events_runnable_invoke, - id="runnable_chain.ainvoke-with-args-and-kwargs", - ), - pytest.param( - create_structured_output_chain, - "ainvoke", - ({"input": "Sally is 13"},), - {"config": {"tags": ["bar"], "metadata": {"id": "123"}}, "return_only_outputs": True}, - chat_completion_recorded_events_invoke, - id="chain.ainvoke-with-args-and-kwargs", - ), - ), -) -def test_multiple_async_langchain_chain( - set_trace_info, - json_schema, - prompt, - chat_openai_client, - create_function, - call_function, - call_function_args, - call_function_kwargs, - expected_events, - loop, -): - call1 = events_with_context_attrs(expected_events.copy()) - call1[0][1]["request_id"] = "b1883d9d-10d6-4b67-a911-f72849704e92" - call1[1][1]["request_id"] = "b1883d9d-10d6-4b67-a911-f72849704e92" - call1[2][1]["request_id"] = "b1883d9d-10d6-4b67-a911-f72849704e92" - call2 = events_with_context_attrs(expected_events.copy()) - call2[0][1]["request_id"] = "a58aa0c0-c854-4657-9e7b-4cce442f3b61" - call2[1][1]["request_id"] = "a58aa0c0-c854-4657-9e7b-4cce442f3b61" - call2[2][1]["request_id"] = "a58aa0c0-c854-4657-9e7b-4cce442f3b61" - - @reset_core_stats_engine() - @validate_custom_events(call1 + call2) - # 3 langchain events and 5 openai events. - @validate_custom_event_count(count=16) - @validate_transaction_metrics( - name="test_chain:test_multiple_async_langchain_chain.._test", - scoped_metrics=[(f"Llm/chain/LangChain/{call_function}", 2)], - rollup_metrics=[(f"Llm/chain/LangChain/{call_function}", 2)], - custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], - background_task=True, - ) - @background_task() - def _test(): - with patch("langchain_core.callbacks.manager.uuid", autospec=True) as mock_uuid: - mock_uuid.uuid4.side_effect = [ - uuid.UUID("b1883d9d-10d6-4b67-a911-f72849704e92"), # first call - uuid.UUID("a58aa0c0-c854-4657-9e7b-4cce442f3b61"), - uuid.UUID("a58aa0c0-c854-4657-9e7b-4cce442f3b61"), # second call - uuid.UUID("a58aa0c0-c854-4657-9e7b-4cce442f3b63"), - uuid.UUID("b1883d9d-10d6-4b67-a911-f72849704e93"), - uuid.UUID("a58aa0c0-c854-4657-9e7b-4cce442f3b64"), - uuid.UUID("a58aa0c0-c854-4657-9e7b-4cce442f3b65"), - uuid.UUID("a58aa0c0-c854-4657-9e7b-4cce442f3b66"), - ] - set_trace_info() - add_custom_attribute("llm.conversation_id", "my-awesome-id") - add_custom_attribute("llm.foo", "bar") - add_custom_attribute("non_llm_attr", "python-agent") - - runnable = create_function(json_schema, chat_openai_client, prompt) - with WithLlmCustomAttributes({"context": "attr"}): - call1 = asyncio.ensure_future( - getattr(runnable, call_function)(*call_function_args, **call_function_kwargs), loop=loop - ) - call2 = asyncio.ensure_future( - getattr(runnable, call_function)(*call_function_args, **call_function_kwargs), loop=loop - ) - loop.run_until_complete(asyncio.gather(call1, call2)) - - _test() - - @reset_core_stats_engine() @validate_custom_events(recorded_events_retrieval_chain_response) @validate_custom_event_count(count=17) diff --git a/tests/mlmodel_langchain/test_tool.py b/tests/mlmodel_langchain/test_tool.py index 18882b87d1..9ce8d7c2a5 100644 --- a/tests/mlmodel_langchain/test_tool.py +++ b/tests/mlmodel_langchain/test_tool.py @@ -384,9 +384,7 @@ def test_langchain_tool_disabled_ai_monitoring_events_async(set_trace_info, sing def test_langchain_multiple_async_calls(set_trace_info, single_arg_tool, multi_arg_tool, loop): call1 = single_arg_tool_recorded_events.copy() - call1[0][1]["run_id"] = "b1883d9d-10d6-4b67-a911-f72849704e92" call2 = multi_arg_tool_recorded_events.copy() - call2[0][1]["run_id"] = "a58aa0c0-c854-4657-9e7b-4cce442f3b61" expected_events = call1 + call2 @reset_core_stats_engine() @@ -401,27 +399,15 @@ def test_langchain_multiple_async_calls(set_trace_info, single_arg_tool, multi_a def _test(): set_trace_info() - with patch("langchain_core.callbacks.manager.uuid", autospec=True) as mock_uuid: - mock_uuid.uuid4.side_effect = [ - uuid.UUID("b1883d9d-10d6-4b67-a911-f72849704e92"), # first call - uuid.UUID("a58aa0c0-c854-4657-9e7b-4cce442f3b61"), - uuid.UUID("a58aa0c0-c854-4657-9e7b-4cce442f3b61"), # second call - uuid.UUID("a58aa0c0-c854-4657-9e7b-4cce442f3b63"), - uuid.UUID("b1883d9d-10d6-4b67-a911-f72849704e93"), - uuid.UUID("a58aa0c0-c854-4657-9e7b-4cce442f3b64"), - uuid.UUID("a58aa0c0-c854-4657-9e7b-4cce442f3b65"), - uuid.UUID("a58aa0c0-c854-4657-9e7b-4cce442f3b66"), - ] - - loop.run_until_complete( - asyncio.gather( - single_arg_tool.arun({"query": "Python Agent"}), - multi_arg_tool.arun( - {"first_num": 53, "second_num": 28}, - tags=["python", "test_tags"], - metadata={"test": "langchain", "test_run": True}, - ), - ) + loop.run_until_complete( + asyncio.gather( + single_arg_tool.arun({"query": "Python Agent"}), + multi_arg_tool.arun( + {"first_num": 53, "second_num": 28}, + tags=["python", "test_tags"], + metadata={"test": "langchain", "test_run": True}, + ), ) + ) _test() From 7b65cafda63e3081ab16ecf6045281eb0a3b2011 Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Thu, 22 Jan 2026 11:31:46 -0800 Subject: [PATCH 045/124] Remove Python 3.8 Support (#1611) * Upgrade minimum version to Python 3.8 * Formatter run for Python 3.8 to 3.9 upgrade * Update tox for Python 3.8 removal * Remove unused Python version stdlib lists * Remove ignored UP006 rule --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- .github/containers/Dockerfile | 2 +- .github/workflows/benchmarks.yml | 2 +- .github/workflows/deploy.yml | 4 - asv.conf.json | 2 +- newrelic/admin/__init__.py | 14 +- newrelic/common/package_version_utils.py | 49 ++-- newrelic/config.py | 28 +-- newrelic/core/config.py | 3 +- newrelic/core/environment.py | 8 +- newrelic/hooks/logger_structlog.py | 2 +- pyproject.toml | 5 +- setup.py | 9 +- .../test_package_version_utils.py | 27 +-- tests/framework_starlette/test_application.py | 1 - .../_target_schema_async.py | 4 +- .../_target_schema_sync.py | 10 +- .../mlmodel_sklearn/test_inference_events.py | 8 +- tox.ini | 211 ++++++++---------- 18 files changed, 134 insertions(+), 255 deletions(-) diff --git a/.github/containers/Dockerfile b/.github/containers/Dockerfile index 3f370a4a45..b3016548d7 100644 --- a/.github/containers/Dockerfile +++ b/.github/containers/Dockerfile @@ -115,7 +115,7 @@ RUN mv "${HOME}/.local/bin/python3.11" "${HOME}/.local/bin/pypy3.11" && \ mv "${HOME}/.local/bin/python3.10" "${HOME}/.local/bin/pypy3.10" # Install CPython versions -RUN uv python install -f cp3.14 cp3.14t cp3.13 cp3.12 cp3.11 cp3.10 cp3.9 cp3.8 +RUN uv python install -f cp3.14 cp3.14t cp3.13 cp3.12 cp3.11 cp3.10 cp3.9 # Set default Python version to CPython 3.13 RUN uv python install -f --default cp3.13 diff --git a/.github/workflows/benchmarks.yml b/.github/workflows/benchmarks.yml index 4bfbaf5e94..6f87e39875 100644 --- a/.github/workflows/benchmarks.yml +++ b/.github/workflows/benchmarks.yml @@ -31,7 +31,7 @@ jobs: timeout-minutes: 30 strategy: matrix: - python: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"] + python: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"] env: ASV_FACTOR: "1.1" diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index bda5905108..5acd927905 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -29,8 +29,6 @@ jobs: matrix: include: # Linux glibc - - wheel: cp38-manylinux - os: ubuntu-24.04 - wheel: cp39-manylinux os: ubuntu-24.04 - wheel: cp310-manylinux @@ -48,8 +46,6 @@ jobs: - wheel: cp314t-manylinux os: ubuntu-24.04 # Linux musllibc - - wheel: cp38-musllinux - os: ubuntu-24.04 - wheel: cp39-musllinux os: ubuntu-24.04 - wheel: cp310-musllinux diff --git a/asv.conf.json b/asv.conf.json index 203d52c887..ca6902e314 100644 --- a/asv.conf.json +++ b/asv.conf.json @@ -6,7 +6,7 @@ "repo": ".", "environment_type": "virtualenv", "install_timeout": 120, - "pythons": ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"], + "pythons": ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"], "benchmark_dir": "tests/agent_benchmarks", "env_dir": ".asv/env", "results_dir": ".asv/results", diff --git a/newrelic/admin/__init__.py b/newrelic/admin/__init__.py index 61f3995a3f..fe6433a23e 100644 --- a/newrelic/admin/__init__.py +++ b/newrelic/admin/__init__.py @@ -120,19 +120,7 @@ def load_internal_plugins(): def load_external_plugins(): - try: - # importlib.metadata was introduced into the standard library starting in Python 3.8. - from importlib.metadata import entry_points - except ImportError: - try: - # importlib_metadata is a backport library installable from PyPI. - from importlib_metadata import entry_points - except ImportError: - try: - # Fallback to pkg_resources, which is available in older versions of setuptools. - from pkg_resources import iter_entry_points as entry_points - except ImportError: - return + from importlib.metadata import entry_points group = "newrelic.admin" diff --git a/newrelic/common/package_version_utils.py b/newrelic/common/package_version_utils.py index da40f0dffa..38c85057d0 100644 --- a/newrelic/common/package_version_utils.py +++ b/newrelic/common/package_version_utils.py @@ -12,6 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. +import importlib.metadata as importlib_metadata import sys import warnings from functools import lru_cache @@ -95,37 +96,17 @@ def _get_package_version(name): except Exception: pass - importlib_metadata = None - # importlib.metadata was introduced into the standard library starting in Python 3.8. - importlib_metadata = getattr(sys.modules.get("importlib", None), "metadata", None) - if importlib_metadata is None: - # importlib_metadata is a backport library installable from PyPI. - try: - import importlib_metadata - except ImportError: - pass - - if importlib_metadata is not None: - try: - # In Python 3.10+ packages_distribution can be checked for as well. - if hasattr(importlib_metadata, "packages_distributions"): - distributions = importlib_metadata.packages_distributions() - distribution_name = distributions.get(name, name) - distribution_name = distribution_name[0] if isinstance(distribution_name, list) else distribution_name - else: - distribution_name = name - - version = importlib_metadata.version(distribution_name) - if version not in NULL_VERSIONS: - return version - except Exception: - pass - - # Fallback to pkg_resources, which is available in older versions of setuptools. - if "pkg_resources" in sys.modules: - try: - version = sys.modules["pkg_resources"].get_distribution(name).version - if version not in NULL_VERSIONS: - return version - except Exception: - pass + try: + # In Python 3.10+ packages_distribution can be checked for as well. + if hasattr(importlib_metadata, "packages_distributions"): + distributions = importlib_metadata.packages_distributions() + distribution_name = distributions.get(name, name) + distribution_name = distribution_name[0] if isinstance(distribution_name, list) else distribution_name + else: + distribution_name = name + + version = importlib_metadata.version(distribution_name) + if version not in NULL_VERSIONS: + return version + except Exception: + pass diff --git a/newrelic/config.py b/newrelic/config.py index 4b8627772d..84f642527d 100644 --- a/newrelic/config.py +++ b/newrelic/config.py @@ -4217,19 +4217,7 @@ def _process_module_builtin_defaults(): def _process_module_entry_points(): - try: - # importlib.metadata was introduced into the standard library starting in Python 3.8. - from importlib.metadata import entry_points - except ImportError: - try: - # importlib_metadata is a backport library installable from PyPI. - from importlib_metadata import entry_points - except ImportError: - try: - # Fallback to pkg_resources, which is available in older versions of setuptools. - from pkg_resources import iter_entry_points as entry_points - except ImportError: - return + from importlib.metadata import entry_points group = "newrelic.hooks" @@ -4297,19 +4285,7 @@ def _setup_instrumentation(): def _setup_extensions(): - try: - # importlib.metadata was introduced into the standard library starting in Python 3.8. - from importlib.metadata import entry_points - except ImportError: - try: - # importlib_metadata is a backport library installable from PyPI. - from importlib_metadata import entry_points - except ImportError: - try: - # Fallback to pkg_resources, which is available in older versions of setuptools. - from pkg_resources import iter_entry_points as entry_points - except ImportError: - return + from importlib.metadata import entry_points group = "newrelic.extension" diff --git a/newrelic/core/config.py b/newrelic/core/config.py index 8cfdeda0ae..c6b2d4233e 100644 --- a/newrelic/core/config.py +++ b/newrelic/core/config.py @@ -1119,8 +1119,7 @@ def _flatten(settings, o, name=None): for key, value in vars(o).items(): # Remove any leading underscores on keys accessed through # properties for reporting. - if key.startswith("_"): - key = key[1:] + key = key.removeprefix("_") if name: key = f"{name}.{key}" diff --git a/newrelic/core/environment.py b/newrelic/core/environment.py index 7d3a04f1b6..11203df657 100644 --- a/newrelic/core/environment.py +++ b/newrelic/core/environment.py @@ -248,13 +248,7 @@ def _get_stdlib_builtin_module_names(): # Since sys.stdlib_module_names is not available in versions of python below 3.10, # use isort's hardcoded stdlibs instead. python_version = sys.version_info[0:2] - if python_version < (3,): - stdlibs = isort_stdlibs.py27.stdlib - elif (3, 7) <= python_version < (3, 8): - stdlibs = isort_stdlibs.py37.stdlib - elif python_version < (3, 9): - stdlibs = isort_stdlibs.py38.stdlib - elif python_version < (3, 10): + if python_version < (3, 10): stdlibs = isort_stdlibs.py39.stdlib elif python_version >= (3, 10): stdlibs = sys.stdlib_module_names diff --git a/newrelic/hooks/logger_structlog.py b/newrelic/hooks/logger_structlog.py index 8d9ba3cc5d..66d7102505 100644 --- a/newrelic/hooks/logger_structlog.py +++ b/newrelic/hooks/logger_structlog.py @@ -22,7 +22,7 @@ from newrelic.hooks.logger_logging import add_nr_linking_metadata -@functools.lru_cache(maxsize=None) +@functools.cache def normalize_level_name(method_name): # Look up level number for method name, using result to look up level name for that level number. # Convert result to upper case, and default to UNKNOWN in case of errors or missing values. diff --git a/pyproject.toml b/pyproject.toml index 2dbdb34837..d7a9076a82 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -28,10 +28,9 @@ readme = "README.md" # "LICENSE", # "THIRD_PARTY_NOTICES.md", # ] -requires-python = ">=3.8" # python_requires is also located in setup.py +requires-python = ">=3.9" # python_requires is also located in setup.py classifiers = [ "Development Status :: 5 - Production/Stable", - "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", @@ -105,7 +104,6 @@ git_describe_command = 'git describe --dirty --tags --long --match "*.*.*"' [tool.ruff] output-format = "grouped" line-length = 120 -target-version = "py38" force-exclude = true # Fixes issue with megalinter config preventing exclusion of files extend-exclude = [ "newrelic/packages/", @@ -200,7 +198,6 @@ ignore = [ "PT012", # pytest-raises-with-multiple-statements (too many to fix all at once) # Permanently disabled rules "PLC0415", # import-outside-top-level (intentionally used frequently) - "UP006", # non-pep585-annotation (not compatible with Python 3.8) "D203", # incorrect-blank-line-before-class "D213", # multi-line-summary-second-line "ARG001", # unused-argument diff --git a/setup.py b/setup.py index 4cccb1e437..486ffd778b 100644 --- a/setup.py +++ b/setup.py @@ -17,11 +17,9 @@ python_version = sys.version_info[:2] -if python_version >= (3, 8): - pass -else: +if python_version < (3, 9): error_msg = ( - "The New Relic Python agent only supports Python 3.8+. We recommend upgrading to a newer version of Python." + "The New Relic Python agent only supports Python 3.9+. We recommend upgrading to a newer version of Python." ) try: @@ -34,6 +32,7 @@ (3, 5): "5.24.0.153", (3, 6): "7.16.0.178", (3, 7): "10.17.0", + (3, 8): "11.2.0", } last_supported_version = last_supported_version_lookup.get(python_version, None) @@ -128,7 +127,7 @@ def build_extension(self, ext): kwargs.update( { - "python_requires": ">=3.8", # python_requires is also located in pyproject.toml + "python_requires": ">=3.9", # python_requires is also located in pyproject.toml "zip_safe": False, "packages": packages, "package_data": { diff --git a/tests/agent_unittests/test_package_version_utils.py b/tests/agent_unittests/test_package_version_utils.py index 8add829195..4de504b052 100644 --- a/tests/agent_unittests/test_package_version_utils.py +++ b/tests/agent_unittests/test_package_version_utils.py @@ -27,17 +27,12 @@ ) # Notes: -# importlib.metadata was a provisional addition to the std library in PY38 and PY39 +# importlib.metadata was a provisional addition to the std library in Python 3.8 and 3.9 # while pkg_resources was deprecated. -# importlib.metadata is no longer provisional in PY310+. It added some attributes +# importlib.metadata is no longer provisional in Python 3.10+. It added some attributes # such as distribution_packages and removed pkg_resources. -IS_PY38_PLUS = sys.version_info[:2] >= (3, 8) IS_PY310_PLUS = sys.version_info[:2] >= (3, 10) -SKIP_IF_NOT_IMPORTLIB_METADATA = pytest.mark.skipif(not IS_PY38_PLUS, reason="importlib.metadata is not supported.") -SKIP_IF_IMPORTLIB_METADATA = pytest.mark.skipif( - IS_PY38_PLUS, reason="importlib.metadata is preferred over pkg_resources." -) SKIP_IF_NOT_PY310_PLUS = pytest.mark.skipif(not IS_PY310_PLUS, reason="These features were added in 3.10+") @@ -101,7 +96,6 @@ def test_get_package_version_tuple(monkeypatch, attr, value, expected_value): assert version == expected_value -@SKIP_IF_NOT_IMPORTLIB_METADATA @validate_function_called("importlib.metadata", "version") def test_importlib_dot_metadata(): # Test for importlib.metadata from the standard library. @@ -109,14 +103,6 @@ def test_importlib_dot_metadata(): assert version not in NULL_VERSIONS, version -@SKIP_IF_IMPORTLIB_METADATA -@validate_function_called("importlib_metadata", "version") -def test_importlib_underscore_metadata(): - # Test for importlib_metadata, a backport library available on PyPI. - version = get_package_version("pytest") - assert version not in NULL_VERSIONS, version - - @SKIP_IF_NOT_PY310_PLUS @validate_function_called("importlib.metadata", "packages_distributions") def test_mapping_import_to_distribution_packages(): @@ -124,15 +110,6 @@ def test_mapping_import_to_distribution_packages(): assert version not in NULL_VERSIONS, version -@SKIP_IF_IMPORTLIB_METADATA -@validate_function_called("pkg_resources", "get_distribution") -def test_pkg_resources_metadata(monkeypatch): - # Prevent importlib_metadata from being used by these tests - monkeypatch.setitem(sys.modules, "importlib_metadata", None) - version = get_package_version("pytest") - assert version not in NULL_VERSIONS, version - - def _getattr_deprecation_warning(attr): if attr == "__version__": warnings.warn("Testing deprecation warnings.", DeprecationWarning, stacklevel=2) diff --git a/tests/framework_starlette/test_application.py b/tests/framework_starlette/test_application.py index cd5668fcb8..2005e53c2c 100644 --- a/tests/framework_starlette/test_application.py +++ b/tests/framework_starlette/test_application.py @@ -119,7 +119,6 @@ def test_exception_in_middleware(target_application, app_name): app = target_application[app_name] # Starlette >=0.15 and <0.17 raises an exception group instead of reraising the ValueError - # This only occurs on Python versions >=3.8 if (0, 15, 0) <= starlette_version < (0, 17, 0): from anyio._backends._asyncio import ExceptionGroup diff --git a/tests/framework_strawberry/_target_schema_async.py b/tests/framework_strawberry/_target_schema_async.py index 72234e79a6..e85ef8ae30 100644 --- a/tests/framework_strawberry/_target_schema_async.py +++ b/tests/framework_strawberry/_target_schema_async.py @@ -14,8 +14,6 @@ from __future__ import annotations -from typing import List - import strawberry try: @@ -68,7 +66,7 @@ async def resolve_search(contains: str): class Query: library: Library = field(resolver=resolve_library) hello: str = field(resolver=resolve_hello) - search: List[Item] = field(resolver=resolve_search) + search: list[Item] = field(resolver=resolve_search) echo: str = field(resolver=resolve_echo) storage: Storage = field(resolver=resolve_storage) error: str | None = field(resolver=resolve_error) diff --git a/tests/framework_strawberry/_target_schema_sync.py b/tests/framework_strawberry/_target_schema_sync.py index b4559763e1..1504022af5 100644 --- a/tests/framework_strawberry/_target_schema_sync.py +++ b/tests/framework_strawberry/_target_schema_sync.py @@ -14,7 +14,7 @@ from __future__ import annotations -from typing import List, Union +from typing import Union import strawberry @@ -56,12 +56,12 @@ class Magazine: class Library: id: int branch: str - magazine: List[Magazine] - book: List[Book] + magazine: list[Magazine] + book: list[Book] Item = Union[Book, Magazine] -Storage = List[str] +Storage = list[str] authors = [ @@ -138,7 +138,7 @@ def resolve_search(contains: str): class Query: library: Library = field(resolver=resolve_library) hello: str = field(resolver=resolve_hello) - search: List[Item] = field(resolver=resolve_search) + search: list[Item] = field(resolver=resolve_search) echo: str = field(resolver=resolve_echo) storage: Storage = field(resolver=resolve_storage) error: str | None = field(resolver=resolve_error) diff --git a/tests/mlmodel_sklearn/test_inference_events.py b/tests/mlmodel_sklearn/test_inference_events.py index d1fc0762b0..92b01727b9 100644 --- a/tests/mlmodel_sklearn/test_inference_events.py +++ b/tests/mlmodel_sklearn/test_inference_events.py @@ -59,9 +59,9 @@ def _test(): _test() -label_type = "bool" if sys.version_info < (3, 8) else "numeric" -true_label_value = "True" if sys.version_info < (3, 8) else "1.0" -false_label_value = "False" if sys.version_info < (3, 8) else "0.0" +label_type = "numeric" +true_label_value = "1.0" +false_label_value = "0.0" pandas_df_bool_recorded_custom_events = [ ( {"type": "InferenceData"}, @@ -87,7 +87,7 @@ def test_pandas_df_bool_feature_event(): def _test(): import sklearn.tree - dtype_name = "bool" if sys.version_info < (3, 8) else "boolean" + dtype_name = "boolean" x_train = pd.DataFrame({"col1": [True, False], "col2": [True, False]}, dtype=dtype_name) y_train = pd.DataFrame({"label": [True, False]}, dtype=dtype_name) x_test = pd.DataFrame({"col1": [True], "col2": [True]}, dtype=dtype_name) diff --git a/tox.ini b/tox.ini index c6606e1432..cf86a97e65 100644 --- a/tox.ini +++ b/tox.ini @@ -20,7 +20,7 @@ ; framework_aiohttp-aiohttp01: aiohttp<2 ; framework_aiohttp-aiohttp0202: aiohttp<2.3 ; 3. Python version required. Uses the standard tox definitions. (https://tox.readthedocs.io/en/latest/config.html#tox-environments) -; Examples: py38,py39,py310,py311,py312,py313,py314,py314t,pypy311 +; Examples: py39,py310,py311,py312,py313,py314,py314t,pypy311 ; 4. Library and version (Optional). Used when testing multiple versions of the library, and may be omitted when only testing a single version. ; Versions should be specified with 2 digits per version number, so <3 becomes 02 and <3.5 becomes 0304. latest and master are also acceptable versions. ; Examples: uvicorn03, CherryPy0302, uvicornlatest @@ -40,7 +40,7 @@ ; ; Full Examples: ; - memcached-datastore_bmemcached-py313-memcached030 -; - linux-agent_unittests-py38-with_extensions +; - linux-agent_unittests-py314-with_extensions ; - python-adapter_gevent-py39 [tox] @@ -51,13 +51,13 @@ uv_seed = true skip_missing_interpreters = false envlist = # Linux Core Agent Test Suite - {linux,linux_arm64}-agent_features-{py38,py39,py310,py311,py312,py313,py314}-{with,without}_extensions, + {linux,linux_arm64}-agent_features-{py39,py310,py311,py312,py313,py314}-{with,without}_extensions, {linux,linux_arm64}-agent_features-pypy311-without_extensions, - {linux,linux_arm64}-agent_streaming-{py38,py39,py310,py311,py312,py313,py314}-protobuf06-{with,without}_extensions, + {linux,linux_arm64}-agent_streaming-{py39,py310,py311,py312,py313,py314}-protobuf06-{with,without}_extensions, {linux,linux_arm64}-agent_streaming-py39-protobuf{03,0319,04,05}-{with,without}_extensions, - {linux,linux_arm64}-agent_unittests-{py38,py39,py310,py311,py312,py313,py314}-{with,without}_extensions, + {linux,linux_arm64}-agent_unittests-{py39,py310,py311,py312,py313,py314}-{with,without}_extensions, {linux,linux_arm64}-agent_unittests-pypy311-without_extensions, - {linux,linux_arm64}-cross_agent-{py38,py39,py310,py311,py312,py313,py314}-{with,without}_extensions, + {linux,linux_arm64}-cross_agent-{py39,py310,py311,py312,py313,py314}-{with,without}_extensions, {linux,linux_arm64}-cross_agent-pypy311-without_extensions, # Windows Core Agent Test Suite @@ -68,119 +68,110 @@ envlist = {windows,windows_arm64}-cross_agent-{py313,py314,py314t}-{with,without}_extensions, # Integration Tests (only run on Linux) - cassandra-datastore_cassandradriver-py38-cassandra032903, cassandra-datastore_cassandradriver-{py39,py310,py311,py312,pypy311}-cassandralatest, - elasticsearchserver07-datastore_elasticsearch-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-elasticsearch07, - elasticsearchserver08-datastore_elasticsearch-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-elasticsearch08, - firestore-datastore_firestore-{py38,py39,py310,py311,py312,py313,py314,py314t}, + elasticsearchserver07-datastore_elasticsearch-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-elasticsearch07, + elasticsearchserver08-datastore_elasticsearch-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-elasticsearch08, + firestore-datastore_firestore-{py39,py310,py311,py312,py313,py314,py314t}, grpc-framework_grpc-{py39,py310,py311,py312,py313,py314,py314t}-grpclatest, kafka-messagebroker_confluentkafka-py39-confluentkafka{0108,0107,0106}, - kafka-messagebroker_confluentkafka-{py38,py39,py310,py311,py312,py313}-confluentkafkalatest, + kafka-messagebroker_confluentkafka-{py39,py310,py311,py312,py313}-confluentkafkalatest, ;; Package not ready for Python 3.14 (confluent-kafka wheels not released) ; kafka-messagebroker_confluentkafka-{py314,py314t}-confluentkafkalatest, - kafka-messagebroker_kafkapython-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-kafkapythonlatest, - kafka-messagebroker_kafkapython-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-kafkapythonnglatest, - memcached-datastore_aiomcache-{py38,py39,py310,py311,py312,py313,py314,py314t}, - memcached-datastore_bmemcached-{py38,py39,py310,py311,py312,py313,py314,py314t}, - memcached-datastore_memcache-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-memcached01, - memcached-datastore_pylibmc-{py38,py39,py310,py311}, - memcached-datastore_pymemcache-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, - mongodb8-datastore_motor-{py38,py39,py310,py311,py312,py313,py314,py314t}-motorlatest, - mongodb3-datastore_pymongo-{py38,py39,py310,py311,py312}-pymongo03, - mongodb8-datastore_pymongo-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-pymongo04, - mysql-datastore_aiomysql-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, + kafka-messagebroker_kafkapython-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-kafkapythonlatest, + kafka-messagebroker_kafkapython-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-kafkapythonnglatest, + memcached-datastore_aiomcache-{py39,py310,py311,py312,py313,py314,py314t}, + memcached-datastore_bmemcached-{py39,py310,py311,py312,py313,py314,py314t}, + memcached-datastore_memcache-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-memcached01, + memcached-datastore_pylibmc-{py39,py310,py311}, + memcached-datastore_pymemcache-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, + mongodb8-datastore_motor-{py39,py310,py311,py312,py313,py314,py314t}-motorlatest, + mongodb3-datastore_pymongo-{py39,py310,py311,py312}-pymongo03, + mongodb8-datastore_pymongo-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-pymongo04, + mysql-datastore_aiomysql-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, mssql-datastore_pymssql-pymssqllatest-{py39,py310,py311,py312,py313,py314,py314t}, - mssql-datastore_pymssql-pymssql020301-py38, - mysql-datastore_mysql-mysqllatest-{py38,py39,py310,py311,py312,py313,py314,py314t}, - mysql-datastore_mysqldb-{py38,py39,py310,py311,py312,py313,py314,py314t}, - mysql-datastore_pymysql-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, + mysql-datastore_mysql-mysqllatest-{py39,py310,py311,py312,py313,py314,py314t}, + mysql-datastore_mysqldb-{py39,py310,py311,py312,py313,py314,py314t}, + mysql-datastore_pymysql-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, oracledb-datastore_oracledb-{py39,py310,py311,py312,py313,py314,py314t}-oracledblatest, oracledb-datastore_oracledb-{py39,py313,py314,py314t}-oracledb02, oracledb-datastore_oracledb-{py39,py312}-oracledb01, - nginx-external_httpx-{py38,py39,py310,py311,py312,py313,py314,py314t}, - postgres16-datastore_asyncpg-{py38,py39,py310,py311,py312,py313,py314,py314t}, - postgres16-datastore_psycopg-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-psycopglatest, + nginx-external_httpx-{py39,py310,py311,py312,py313,py314,py314t}, + postgres16-datastore_asyncpg-{py39,py310,py311,py312,py313,py314,py314t}, + postgres16-datastore_psycopg-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-psycopglatest, postgres16-datastore_psycopg-py312-psycopg_{purepython,binary,compiled}0301, - postgres16-datastore_psycopg2-{py38,py39,py310,py311,py312}-psycopg2latest, - postgres16-datastore_psycopg2cffi-{py38,py39,py310,py311,py312}-psycopg2cffilatest, - postgres16-datastore_pyodbc-{py38,py39,py310,py311,py312,py313,py314,py314t}-pyodbclatest, - postgres9-datastore_postgresql-{py38,py39,py310,py311,py312,py313,py314,py314t}, - python-adapter_asgiref-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-asgireflatest, + postgres16-datastore_psycopg2-{py39,py310,py311,py312}-psycopg2latest, + postgres16-datastore_psycopg2cffi-{py39,py310,py311,py312}-psycopg2cffilatest, + postgres16-datastore_pyodbc-{py39,py310,py311,py312,py313,py314,py314t}-pyodbclatest, + postgres9-datastore_postgresql-{py39,py310,py311,py312,py313,py314,py314t}, + python-adapter_asgiref-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-asgireflatest, python-adapter_asgiref-py310-asgiref{0303,0304,0305,0306,0307}, - python-adapter_cheroot-{py38,py39,py310,py311,py312,py313,py314,py314t}, - python-adapter_daphne-{py38,py39,py310,py311,py312,py313,py314,py314t}-daphnelatest, - python-adapter_gevent-{py38,py310,py311,py312,py313,py314,py314t}, - python-adapter_gunicorn-{py38,py39,py310,py311,py312,py313}-aiohttp03-gunicornlatest, + python-adapter_cheroot-{py39,py310,py311,py312,py313,py314,py314t}, + python-adapter_daphne-{py39,py310,py311,py312,py313,py314,py314t}-daphnelatest, + python-adapter_gevent-{py310,py311,py312,py313,py314,py314t}, + python-adapter_gunicorn-{py39,py310,py311,py312,py313}-aiohttp03-gunicornlatest, ;; Package not ready for Python 3.14 (aiohttp's worker not updated) ; python-adapter_gunicorn-{py314,py314t}-aiohttp03-gunicornlatest, - python-adapter_hypercorn-{py38,py39,py310,py311,py312,py313,py314,py314t}-hypercornlatest, - python-adapter_hypercorn-{py38,py39}-hypercorn{0010,0011,0012,0013}, + python-adapter_hypercorn-{py39,py310,py311,py312,py313,py314,py314t}-hypercornlatest, python-adapter_mcp-{py310,py311,py312,py313,py314,py314t}, - python-adapter_uvicorn-{py38,py39,py310,py311,py312,py313,py314,py314t}-uvicornlatest, - python-adapter_uvicorn-py38-uvicorn020, - python-adapter_waitress-{py38,py39,py310,py311,py312,py313,py314,py314t}-waitresslatest, - python-application_celery-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-celerylatest, + python-adapter_uvicorn-{py39,py310,py311,py312,py313,py314,py314t}-uvicornlatest, + python-adapter_waitress-{py39,py310,py311,py312,py313,py314,py314t}-waitresslatest, + python-application_celery-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-celerylatest, python-application_celery-py311-celery{0504,0503,0502}, - python-component_djangorestframework-{py38,py39,py310,py311,py312,py313,py314,py314t}-djangorestframeworklatest, - python-component_flask_rest-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-flaskrestxlatest, - python-component_graphqlserver-{py38,py39,py310,py311,py312}, + python-component_djangorestframework-{py39,py310,py311,py312,py313,py314,py314t}-djangorestframeworklatest, + python-component_flask_rest-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-flaskrestxlatest, + python-component_graphqlserver-{py39,py310,py311,py312}, ;; Tests need to be updated to support newer graphql-server/sanic versions ; python-component_graphqlserver-{py313,py314,py314t}, - python-component_tastypie-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-tastypielatest, - python-coroutines_asyncio-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, - python-datastore_sqlite-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, - python-external_aiobotocore-{py38,py39,py310,py311,py312,py313}-aiobotocorelatest, + python-component_tastypie-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-tastypielatest, + python-coroutines_asyncio-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, + python-datastore_sqlite-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, + python-external_aiobotocore-{py39,py310,py311,py312,py313}-aiobotocorelatest, ;; Package not ready for Python 3.14 (hangs when running) ; python-external_aiobotocore-{py314,py314t}-aiobotocorelatest, - python-external_botocore-{py38,py39,py310,py311,py312,py313,py314,py314t}-botocorelatest, + python-external_botocore-{py39,py310,py311,py312,py313,py314,py314t}-botocorelatest, python-external_botocore-{py311}-botocorelatest-langchain, python-external_botocore-py310-botocore0125, python-external_botocore-py311-botocore0128, - python-external_feedparser-{py38,py39,py310,py311,py312,py313,py314,py314t}-feedparser06, - python-external_http-{py38,py39,py310,py311,py312,py313,py314,py314t}, - python-external_httplib-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, - python-external_httplib2-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, + python-external_feedparser-{py39,py310,py311,py312,py313,py314,py314t}-feedparser06, + python-external_http-{py39,py310,py311,py312,py313,py314,py314t}, + python-external_httplib-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, + python-external_httplib2-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, # pyzeebe requires grpcio which does not support pypy python-external_pyzeebe-{py39,py310,py311,py312,py313,py314,py314t}, - python-external_requests-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, - python-external_urllib3-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-urllib3latest, + python-external_requests-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, + python-external_urllib3-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-urllib3latest, python-external_urllib3-{py312,py313,py314,py314t,pypy311}-urllib30126, - python-framework_aiohttp-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-aiohttp03, - python-framework_ariadne-{py38,py39,py310,py311,py312,py313,py314,py314t}-ariadnelatest, + python-framework_aiohttp-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-aiohttp03, + python-framework_ariadne-{py39,py310,py311,py312,py313,py314,py314t}-ariadnelatest, python-framework_azurefunctions-{py39,py310,py311,py312}, - python-framework_bottle-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-bottle0012, - python-framework_cherrypy-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-CherryPylatest, - python-framework_django-{py38,py39,py310,py311,py312,py313,py314,py314t}-Djangolatest, + python-framework_bottle-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-bottle0012, + python-framework_cherrypy-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-CherryPylatest, + python-framework_django-{py39,py310,py311,py312,py313,py314,py314t}-Djangolatest, python-framework_django-py39-Django{0202,0300,0301,0302,0401}, python-framework_falcon-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-falconlatest, - python-framework_falcon-py38-falcon0410, python-framework_falcon-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-falconmaster, - python-framework_fastapi-{py38,py39,py310,py311,py312,py313,py314,py314t}, - python-framework_flask-{py38,py39,py310,py311,py312,pypy311}-flask02, - ; python-framework_flask-py38-flaskmaster fails, even with Flask-Compress<1.16 and coverage==7.61 for py38 - python-framework_flask-py38-flasklatest, + python-framework_fastapi-{py39,py310,py311,py312,py313,py314,py314t}, + python-framework_flask-{py39,py310,py311,py312,pypy311}-flask02, ; flaskmaster tests disabled until they can be fixed python-framework_flask-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-flask{latest}, - python-framework_graphene-{py38,py39,py310,py311,py312,py313,py314,py314t}-graphenelatest, - python-component_graphenedjango-{py38,py39,py310,py311,py312,py313,py314,py314t}-graphenedjangolatest, - python-framework_graphql-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-graphql03, - python-framework_graphql-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-graphqllatest, - python-framework_pyramid-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-Pyramidlatest, - python-framework_pyramid-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-cornicelatest, - python-framework_sanic-py38-sanic2406, + python-framework_graphene-{py39,py310,py311,py312,py313,py314,py314t}-graphenelatest, + python-component_graphenedjango-{py39,py310,py311,py312,py313,py314,py314t}-graphenedjangolatest, + python-framework_graphql-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-graphql03, + python-framework_graphql-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-graphqllatest, + python-framework_pyramid-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-Pyramidlatest, + python-framework_pyramid-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-cornicelatest, + python-framework_sanic-py311-sanic2406, python-framework_sanic-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-saniclatest, - python-framework_sanic-py38-sanic2290, python-framework_starlette-{py310,pypy311}-starlette{0014,0015,0019,0028}, - python-framework_starlette-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-starlettelatest, - python-framework_starlette-{py38}-starlette002001, - python-framework_strawberry-{py38,py39,py310,py311,py312}-strawberry02352, - python-framework_strawberry-{py38,py39,py310,py311,py312,py313,py314,py314t}-strawberrylatest, - python-framework_tornado-{py38,py39,py310,py311,py312,py313,py314,py314t}-tornadolatest, + python-framework_starlette-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-starlettelatest, + python-framework_strawberry-{py39,py310,py311,py312}-strawberry02352, + python-framework_strawberry-{py39,py310,py311,py312,py313,py314,py314t}-strawberrylatest, + python-framework_tornado-{py39,py310,py311,py312,py313,py314,py314t}-tornadolatest, ; Remove `python-framework_tornado-{py314,py314t}-tornadomaster` temporarily python-framework_tornado-{py310,py311,py312,py313}-tornadomaster, - python-logger_logging-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, - python-logger_loguru-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-logurulatest, - python-logger_structlog-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-structloglatest, + python-logger_logging-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, + python-logger_loguru-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-logurulatest, + python-logger_structlog-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-structloglatest, python-mlmodel_autogen-{py310,py311,py312,py313,py314,py314t,pypy311}-autogen061, python-mlmodel_autogen-{py310,py311,py312,py313,py314,py314t,pypy311}-autogenlatest, python-mlmodel_strands-{py310,py311,py312,py313}-strandslatest, @@ -188,30 +179,28 @@ envlist = python-mlmodel_langchain-{py39,py310,py311,py312,py313}, ;; Package not ready for Python 3.14 (type annotations not updated) ; python-mlmodel_langchain-{py314,py314t}, - python-mlmodel_openai-openai0-{py38,py39,py310,py311,py312}, - python-mlmodel_openai-openailatest-{py38,py39,py310,py311,py312,py313,py314,py314t}, - python-mlmodel_sklearn-{py38,py39,py310,py311,py312,py313,py314,py314t}-scikitlearnlatest, - python-template_genshi-{py38,py39,py310,py311,py312,py313,py314,py314t}-genshilatest, - python-template_jinja2-{py38,py39,py310,py311,py312,py313,py314,py314t}-jinja2latest, - python-template_mako-{py38,py39,py310,py311,py312,py313,py314,py314t}, - rabbitmq-messagebroker_pika-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-pikalatest, - rabbitmq-messagebroker_kombu-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-kombulatest, - rabbitmq-messagebroker_kombu-{py38,py39,py310,pypy311}-kombu050204, - redis-datastore_redis-{py38,py39,py310,py311,pypy311}-redis04, - redis-datastore_redis-{py38,py39,py310,py311,py312,pypy311}-redis05, - redis-datastore_redis-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-redislatest, + python-mlmodel_openai-openai0-{py39,py310,py311,py312}, + python-mlmodel_openai-openailatest-{py39,py310,py311,py312,py313,py314,py314t}, + python-mlmodel_sklearn-{py39,py310,py311,py312,py313,py314,py314t}-scikitlearnlatest, + python-template_genshi-{py39,py310,py311,py312,py313,py314,py314t}-genshilatest, + python-template_jinja2-{py39,py310,py311,py312,py313,py314,py314t}-jinja2latest, + python-template_mako-{py39,py310,py311,py312,py313,py314,py314t}, + rabbitmq-messagebroker_pika-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-pikalatest, + rabbitmq-messagebroker_kombu-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-kombulatest, + rabbitmq-messagebroker_kombu-{py39,py310,pypy311}-kombu050204, + redis-datastore_redis-{py39,py310,py311,pypy311}-redis04, + redis-datastore_redis-{py39,py310,py311,py312,pypy311}-redis05, + redis-datastore_redis-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-redislatest, rediscluster-datastore_rediscluster-{py312,py313,py314,py314t,pypy311}-redislatest, - valkey-datastore_valkey-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}-valkeylatest, - solr-datastore_pysolr-{py38,py39,py310,py311,py312,py313,py314,py314t,pypy311}, + valkey-datastore_valkey-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-valkeylatest, + solr-datastore_pysolr-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, [testenv] deps = # Base Dependencies - {py39,py310,py311,py312,py313,py314,py314t,pypy311}: pytest==8.4.1 - py38: pytest==8.3.5 - {py39,py310,py311,py312,py313,py314,py314t,pypy311}: WebTest==3.0.6 - py38: WebTest==3.0.1 - py313,py314,py314t: legacy-cgi==2.6.1 # cgi was removed from the stdlib in 3.13, and is required for WebTest + {py310,py311,py312,py313,py314,py314t,pypy311}: pytest==9.0.2 + py39: pytest==8.4.2 + WebTest==3.0.7 iniconfig coverage @@ -233,14 +222,8 @@ deps = adapter_gunicorn-gunicorn19: gunicorn<20 adapter_gunicorn-gunicornlatest: gunicorn adapter_hypercorn-hypercornlatest: hypercorn[h3]!=0.18 - adapter_hypercorn-hypercorn0013: hypercorn[h3]<0.14 - adapter_hypercorn-hypercorn0012: hypercorn[h3]<0.13 - adapter_hypercorn-hypercorn0011: hypercorn[h3]<0.12 - adapter_hypercorn-hypercorn0010: hypercorn[h3]<0.11 adapter_hypercorn: niquests adapter_mcp: fastmcp - adapter_uvicorn-uvicorn020: uvicorn<0.21 - adapter_uvicorn-uvicorn020: uvloop<0.20 adapter_uvicorn-uvicornlatest: uvicorn adapter_uvicorn: typing-extensions adapter_uvicorn: uvloop @@ -279,7 +262,7 @@ deps = component_tastypie-tastypielatest: django-tastypie component_tastypie-tastypielatest: django<4.1 component_tastypie-tastypielatest: asgiref<3.7.1 # asgiref==3.7.1 only suppport Python 3.10+ - coroutines_asyncio-{py38,py39,py310,py311,py312,py313,py314,py314t}: uvloop + coroutines_asyncio-{py39,py310,py311,py312,py313,py314,py314t}: uvloop cross_agent: requests datastore_asyncpg: asyncpg datastore_aiomcache: aiomcache @@ -288,7 +271,6 @@ deps = datastore_aiomysql: sqlalchemy<2 datastore_bmemcached: python-binary-memcached datastore_cassandradriver-cassandralatest: cassandra-driver - datastore_cassandradriver-cassandra032903: cassandra-driver<3.29.3 datastore_cassandradriver: twisted datastore_elasticsearch: requests datastore_elasticsearch: httpx @@ -319,7 +301,6 @@ deps = datastore_pymongo-pymongo03: pymongo<4.0 datastore_pymongo-pymongo04: pymongo<5.0 datastore_pymssql-pymssqllatest: pymssql - datastore_pymssql-pymssql020301: pymssql==2.3.1 datastore_pymysql: PyMySQL datastore_pymysql: cryptography datastore_pysolr: pysolr<4.0 @@ -368,7 +349,6 @@ deps = framework_django-Django0401: Django<4.2 framework_django-Djangolatest: Django framework_django-Djangomaster: https://github.com/django/django/archive/main.zip - framework_falcon-falcon0410: falcon<4.2 framework_falcon-falconlatest: falcon framework_falcon-falconmaster: https://github.com/falconry/falcon/archive/master.zip framework_fastapi: fastapi @@ -395,12 +375,8 @@ deps = framework_pyramid: routes framework_pyramid-cornicelatest: cornice framework_pyramid-Pyramidlatest: Pyramid - framework_sanic-sanic2290: sanic<22.9.1 framework_sanic-sanic2406: sanic<24.07 framework_sanic-saniclatest: sanic - ; This is the last version of tracerite that supports Python 3.8 - framework_sanic-sanic{2290,2406}: tracerite<1.1.2 - framework_sanic-sanic2290: websockets<11 ; For test_exception_in_middleware test, anyio is used: ; https://github.com/encode/starlette/pull/1157 ; but anyiolatest creates breaking changes to our tests @@ -410,7 +386,6 @@ deps = framework_starlette-starlette0014: starlette<0.15 framework_starlette-starlette0015: starlette<0.16 framework_starlette-starlette0019: starlette<0.20 - framework_starlette-starlette002001: starlette==0.20.1 framework_starlette-starlette0028: starlette<0.29 framework_starlette-starlettelatest: starlette<0.35 framework_strawberry: starlette From b2c7cf29231fd0ad9bf8ab5ba6838e62d78b4496 Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Thu, 22 Jan 2026 12:07:18 -0800 Subject: [PATCH 046/124] Update output message timestamping. (#1627) * Update output message timestamping. * Fix LangChain tests. --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- newrelic/hooks/external_botocore.py | 2 -- newrelic/hooks/mlmodel_gemini.py | 2 -- newrelic/hooks/mlmodel_langchain.py | 3 +-- newrelic/hooks/mlmodel_openai.py | 2 -- .../_test_bedrock_chat_completion_converse.py | 2 -- ...st_bedrock_chat_completion_invoke_model.py | 24 ------------------- tests/mlmodel_gemini/test_text_generation.py | 1 - tests/mlmodel_langchain/test_chain.py | 10 -------- tests/mlmodel_openai/test_chat_completion.py | 1 - .../test_chat_completion_stream.py | 1 - .../test_chat_completion_stream_v1.py | 1 - .../mlmodel_openai/test_chat_completion_v1.py | 1 - 12 files changed, 1 insertion(+), 49 deletions(-) diff --git a/newrelic/hooks/external_botocore.py b/newrelic/hooks/external_botocore.py index 12dd4153f9..255fd4f225 100644 --- a/newrelic/hooks/external_botocore.py +++ b/newrelic/hooks/external_botocore.py @@ -270,8 +270,6 @@ def create_chat_completion_message_event( if settings.ai_monitoring.record_content.enabled: chat_completion_message_dict["content"] = content - if request_timestamp: - chat_completion_message_dict["timestamp"] = request_timestamp chat_completion_message_dict.update(llm_metadata_dict) diff --git a/newrelic/hooks/mlmodel_gemini.py b/newrelic/hooks/mlmodel_gemini.py index 6fffbebb47..f9de687988 100644 --- a/newrelic/hooks/mlmodel_gemini.py +++ b/newrelic/hooks/mlmodel_gemini.py @@ -564,8 +564,6 @@ def create_chat_completion_message_event( if settings.ai_monitoring.record_content.enabled: chat_completion_output_message_dict["content"] = message_content - if request_timestamp: - chat_completion_output_message_dict["timestamp"] = request_timestamp chat_completion_output_message_dict.update(llm_metadata) diff --git a/newrelic/hooks/mlmodel_langchain.py b/newrelic/hooks/mlmodel_langchain.py index 318e1313a7..3e1317dd7e 100644 --- a/newrelic/hooks/mlmodel_langchain.py +++ b/newrelic/hooks/mlmodel_langchain.py @@ -817,8 +817,7 @@ def create_chat_completion_message_event( } if settings.ai_monitoring.record_content.enabled: chat_completion_output_message_dict["content"] = message - if request_timestamp: - chat_completion_output_message_dict["timestamp"] = request_timestamp + chat_completion_output_message_dict.update(llm_metadata_dict) transaction.record_custom_event("LlmChatCompletionMessage", chat_completion_output_message_dict) diff --git a/newrelic/hooks/mlmodel_openai.py b/newrelic/hooks/mlmodel_openai.py index 8ac37ca38d..deb1ede35b 100644 --- a/newrelic/hooks/mlmodel_openai.py +++ b/newrelic/hooks/mlmodel_openai.py @@ -216,8 +216,6 @@ def create_chat_completion_message_event( if settings.ai_monitoring.record_content.enabled: chat_completion_output_message_dict["content"] = message_content - if request_timestamp: - chat_completion_output_message_dict["timestamp"] = request_timestamp chat_completion_output_message_dict.update(llm_metadata) diff --git a/tests/external_botocore/_test_bedrock_chat_completion_converse.py b/tests/external_botocore/_test_bedrock_chat_completion_converse.py index 7cde46faf8..60319c79dc 100644 --- a/tests/external_botocore/_test_bedrock_chat_completion_converse.py +++ b/tests/external_botocore/_test_bedrock_chat_completion_converse.py @@ -79,7 +79,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "c20d345e-6878-4778-b674-6b187bae8ecf", @@ -161,7 +160,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "f070b880-e0fb-4537-8093-796671c39239", diff --git a/tests/external_botocore/_test_bedrock_chat_completion_invoke_model.py b/tests/external_botocore/_test_bedrock_chat_completion_invoke_model.py index f72b9fa583..f568e48e56 100644 --- a/tests/external_botocore/_test_bedrock_chat_completion_invoke_model.py +++ b/tests/external_botocore/_test_bedrock_chat_completion_invoke_model.py @@ -71,7 +71,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "48c7ee13-7790-461f-959f-04b0a4cf91c8", @@ -133,7 +132,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "81508a1c-33a8-4294-8743-f0c629af2f49", @@ -196,7 +194,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": "1234-1", - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "228ee63f-4eca-4b7d-b679-bc920de63525", @@ -258,7 +255,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "6a886158-b39f-46ce-b214-97458ab76f2f", @@ -320,7 +316,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "ab38295d-df9c-4141-8173-38221651bf46", @@ -383,7 +378,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "12912a17-aa13-45f3-914c-cc82166f3601", @@ -445,7 +439,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "a168214d-742d-4244-bd7f-62214ffa07df", @@ -509,7 +502,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "48c7ee13-7790-461f-959f-04b0a4cf91c8", @@ -569,7 +561,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "884db5c9-18ab-4f27-8892-33656176a2e6", @@ -628,7 +619,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "1a72a1f6-310f-469c-af1d-2c59eb600089", @@ -668,7 +658,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "e8fc1dd7-3d1e-42c6-9c58-535cae563bff", @@ -687,7 +676,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "e8fc1dd7-3d1e-42c6-9c58-535cae563bff", @@ -747,7 +735,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "cce6b34c-812c-4f97-8885-515829aa9639", @@ -811,7 +798,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "48c7ee13-7790-461f-959f-04b0a4cf91c8", @@ -871,7 +857,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "884db5c9-18ab-4f27-8892-33656176a2e6", @@ -931,7 +916,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "1a72a1f6-310f-469c-af1d-2c59eb600089", @@ -991,7 +975,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "96c7306d-2d60-4629-83e9-dbd6befb0e4e", @@ -1051,7 +1034,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "cce6b34c-812c-4f97-8885-515829aa9639", @@ -1116,7 +1098,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "48c7ee13-7790-461f-959f-04b0a4cf91c8", @@ -1178,7 +1159,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "request_id": "b427270f-371a-458d-81b6-a05aafb2704c", "span_id": None, "trace_id": "trace-id", @@ -1240,7 +1220,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "request_id": "a645548f-0b3a-47ce-a675-f51e6e9037de", "span_id": None, "trace_id": "trace-id", @@ -1301,7 +1280,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "1efe6197-80f9-43a6-89a5-bb536c1b822f", @@ -1364,7 +1342,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "request_id": "4f8ab6c5-42d1-4e35-9573-30f9f41f821e", "span_id": None, "trace_id": "trace-id", @@ -1426,7 +1403,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, # UUID that varies with each run - "timestamp": None, "request_id": "6dd99878-0919-4f92-850c-48f50f923b76", "span_id": None, "trace_id": "trace-id", diff --git a/tests/mlmodel_gemini/test_text_generation.py b/tests/mlmodel_gemini/test_text_generation.py index 1c789f8197..a01d10897f 100644 --- a/tests/mlmodel_gemini/test_text_generation.py +++ b/tests/mlmodel_gemini/test_text_generation.py @@ -75,7 +75,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "span_id": None, diff --git a/tests/mlmodel_langchain/test_chain.py b/tests/mlmodel_langchain/test_chain.py index 9a8d2cc746..c6fcf080ba 100644 --- a/tests/mlmodel_langchain/test_chain.py +++ b/tests/mlmodel_langchain/test_chain.py @@ -184,7 +184,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -244,7 +243,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -302,7 +300,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -360,7 +357,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -456,7 +452,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, - "timestamp": None, "request_id": None, "span_id": None, "trace_id": "trace-id", @@ -534,7 +529,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, - "timestamp": None, "request_id": None, "span_id": None, "trace_id": "trace-id", @@ -569,7 +563,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, - "timestamp": None, "request_id": None, "span_id": None, "trace_id": "trace-id", @@ -587,7 +580,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, - "timestamp": None, "request_id": None, "span_id": None, "trace_id": "trace-id", @@ -645,7 +637,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, @@ -704,7 +695,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": None, - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": None, diff --git a/tests/mlmodel_openai/test_chat_completion.py b/tests/mlmodel_openai/test_chat_completion.py index 89208ab268..fc7f7f3852 100644 --- a/tests/mlmodel_openai/test_chat_completion.py +++ b/tests/mlmodel_openai/test_chat_completion.py @@ -111,7 +111,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": "chatcmpl-87sb95K4EF2nuJRcTs43Tm9ntTemv-2", - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "49dbbffbd3c3f4612aa48def69059ccd", diff --git a/tests/mlmodel_openai/test_chat_completion_stream.py b/tests/mlmodel_openai/test_chat_completion_stream.py index 55e8e8fbdb..dc9e352a31 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream.py +++ b/tests/mlmodel_openai/test_chat_completion_stream.py @@ -112,7 +112,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": "chatcmpl-87sb95K4EF2nuJRcTs43Tm9ntTemv-2", - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "49dbbffbd3c3f4612aa48def69059ccd", diff --git a/tests/mlmodel_openai/test_chat_completion_stream_v1.py b/tests/mlmodel_openai/test_chat_completion_stream_v1.py index f5995399f7..a9c6e5551a 100644 --- a/tests/mlmodel_openai/test_chat_completion_stream_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_stream_v1.py @@ -122,7 +122,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": "chatcmpl-CocmvmDih6DGKIgPUbrzKFxGnMyco-2", - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "req_f821c73df45f4e30821a81a2d751fe64", diff --git a/tests/mlmodel_openai/test_chat_completion_v1.py b/tests/mlmodel_openai/test_chat_completion_v1.py index e25829bf40..ec636ca7d2 100644 --- a/tests/mlmodel_openai/test_chat_completion_v1.py +++ b/tests/mlmodel_openai/test_chat_completion_v1.py @@ -110,7 +110,6 @@ {"type": "LlmChatCompletionMessage"}, { "id": "chatcmpl-CoLlpfFdbk9D0AbjizzpQ8hMwX9AY-2", - "timestamp": None, "llm.conversation_id": "my-awesome-id", "llm.foo": "bar", "request_id": "req_983c5abb07aa4f51b858f855fc614d08", From d5bb8179fbfd9ccb4c419828cfd15da9e04c96e4 Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Thu, 22 Jan 2026 12:21:17 -0800 Subject: [PATCH 047/124] Guard Azure Functions Utilization (#1632) * Add guard to azure functions utilization for crashes * Add regression test --- newrelic/common/utilization.py | 28 ++++++++----- .../test_utilization.py | 40 +++++++++++++++++++ 2 files changed, 58 insertions(+), 10 deletions(-) create mode 100644 tests/framework_azurefunctions/test_utilization.py diff --git a/newrelic/common/utilization.py b/newrelic/common/utilization.py index 22b158e3ec..b092dc99b8 100644 --- a/newrelic/common/utilization.py +++ b/newrelic/common/utilization.py @@ -233,21 +233,29 @@ class AzureFunctionUtilization(CommonUtilization): HEADERS = {"Metadata": "true"} # noqa: RUF012 VENDOR_NAME = "azurefunction" - @staticmethod - def fetch(): + @classmethod + def fetch(cls): cloud_region = os.environ.get("REGION_NAME") website_owner_name = os.environ.get("WEBSITE_OWNER_NAME") azure_function_app_name = os.environ.get("WEBSITE_SITE_NAME") if all((cloud_region, website_owner_name, azure_function_app_name)): - if website_owner_name.endswith("-Linux"): - resource_group_name = AZURE_RESOURCE_GROUP_NAME_RE.search(website_owner_name).group(1) - else: - resource_group_name = AZURE_RESOURCE_GROUP_NAME_PARTIAL_RE.search(website_owner_name).group(1) - subscription_id = re.search(r"(?:(?!\+).)*", website_owner_name).group(0) - faas_app_name = f"/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Web/sites/{azure_function_app_name}" - # Only send if all values are present - return (faas_app_name, cloud_region) + try: + if website_owner_name.endswith("-Linux"): + resource_group_name = AZURE_RESOURCE_GROUP_NAME_RE.search(website_owner_name).group(1) + else: + resource_group_name = AZURE_RESOURCE_GROUP_NAME_PARTIAL_RE.search(website_owner_name).group(1) + subscription_id = re.search(r"(?:(?!\+).)*", website_owner_name).group(0) + faas_app_name = f"/subscriptions/{subscription_id}/resourceGroups/{resource_group_name}/providers/Microsoft.Web/sites/{azure_function_app_name}" + # Only send if all values are present + return (faas_app_name, cloud_region) + except Exception: + _logger.debug( + "Unable to determine Azure Functions subscription id from WEBSITE_OWNER_NAME. %r", + website_owner_name, + ) + + return None @classmethod def get_values(cls, response): diff --git a/tests/framework_azurefunctions/test_utilization.py b/tests/framework_azurefunctions/test_utilization.py new file mode 100644 index 0000000000..92349fb907 --- /dev/null +++ b/tests/framework_azurefunctions/test_utilization.py @@ -0,0 +1,40 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from newrelic.common.utilization import AzureFunctionUtilization + + +def test_utilization(monkeypatch): + monkeypatch.setenv("REGION_NAME", "eastus2") + monkeypatch.setenv( + "WEBSITE_OWNER_NAME", "0b0d165f-aaaf-4a3b-b929-5f60588d95a3+testing-python-EastUS2webspace-Linux" + ) + monkeypatch.setenv("WEBSITE_SITE_NAME", "test-func-linux") + + result = AzureFunctionUtilization.fetch() + assert result, "Failed to parse utilization for Azure Functions." + + faas_app_name, cloud_region = result + expected_faas_app_name = "/subscriptions/0b0d165f-aaaf-4a3b-b929-5f60588d95a3/resourceGroups/testing-python/providers/Microsoft.Web/sites/test-func-linux" + assert faas_app_name == expected_faas_app_name + assert cloud_region == "eastus2" + + +def test_utilization_bad_website_owner_name(monkeypatch): + monkeypatch.setenv("REGION_NAME", "eastus2") + monkeypatch.setenv("WEBSITE_OWNER_NAME", "ERROR") + monkeypatch.setenv("WEBSITE_SITE_NAME", "test-func-linux") + + result = AzureFunctionUtilization.fetch() + assert result is None, f"Expected failure but got result instead. {result}" From a8b6bd84ed9a1da53b8f8554a157895adb812285 Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Thu, 22 Jan 2026 13:13:11 -0800 Subject: [PATCH 048/124] Improve Strands Tool Error Capturing (#1623) * Overhaul Strands Agents testing * Add better error instrumentation to strands tools * Expand testing for strands tools * Add better guarding to register_tool instrumentation * Fix up test logic * Add tool_id to all strands errors * Add log message --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- newrelic/config.py | 3 + newrelic/hooks/mlmodel_strands.py | 45 ++- tests/mlmodel_strands/_test_agent.py | 165 ---------- tests/mlmodel_strands/_test_agents.py | 43 +++ tests/mlmodel_strands/_test_tools.py | 132 ++++++++ tests/mlmodel_strands/conftest.py | 20 ++ tests/mlmodel_strands/test_agent.py | 421 -------------------------- tests/mlmodel_strands/test_agents.py | 203 +++++++++++++ tests/mlmodel_strands/test_tools.py | 244 +++++++++++++++ 9 files changed, 687 insertions(+), 589 deletions(-) delete mode 100644 tests/mlmodel_strands/_test_agent.py create mode 100644 tests/mlmodel_strands/_test_agents.py create mode 100644 tests/mlmodel_strands/_test_tools.py delete mode 100644 tests/mlmodel_strands/test_agent.py create mode 100644 tests/mlmodel_strands/test_agents.py create mode 100644 tests/mlmodel_strands/test_tools.py diff --git a/newrelic/config.py b/newrelic/config.py index 4b8627772d..fd7f74649d 100644 --- a/newrelic/config.py +++ b/newrelic/config.py @@ -2957,6 +2957,9 @@ def _process_module_builtin_defaults(): _process_module_definition( "strands.multiagent.swarm", "newrelic.hooks.mlmodel_strands", "instrument_strands_multiagent_swarm" ) + _process_module_definition( + "strands.tools.decorator", "newrelic.hooks.mlmodel_strands", "instrument_strands_tools_decorator" + ) _process_module_definition( "strands.tools.executors._executor", "newrelic.hooks.mlmodel_strands", diff --git a/newrelic/hooks/mlmodel_strands.py b/newrelic/hooks/mlmodel_strands.py index 35374dc4e4..06337f7d21 100644 --- a/newrelic/hooks/mlmodel_strands.py +++ b/newrelic/hooks/mlmodel_strands.py @@ -35,6 +35,7 @@ TOOL_OUTPUT_FAILURE_LOG_MESSAGE = "Exception occurred in Strands instrumentation: Failed to record output of tool call. Please report this issue to New Relic Support." AGENT_EVENT_FAILURE_LOG_MESSAGE = "Exception occurred in Strands instrumentation: Failed to record agent data. Please report this issue to New Relic Support." TOOL_EXTRACTOR_FAILURE_LOG_MESSAGE = "Exception occurred in Strands instrumentation: Failed to extract tool information. If the issue persists, report this issue to New Relic support.\n" +DECORATOR_IMPORT_FAILURE_LOG_MESSAGE = "Exception occurred in Strands instrumentation: Failed to import DecoratedFunctionTool from strands.tools.decorator. Please report this issue to New Relic Support." def wrap_agent__call__(wrapped, instance, args, kwargs): @@ -415,11 +416,25 @@ async def aclose(self): def wrap_ToolRegister_register_tool(wrapped, instance, args, kwargs): - bound_args = bind_args(wrapped, args, kwargs) + try: + from strands.tools.decorator import DecoratedFunctionTool + except ImportError: + _logger.exception(DECORATOR_IMPORT_FAILURE_LOG_MESSAGE) + # If we can't import this to check for double wrapping, return early + return wrapped(*args, **kwargs) + + try: + bound_args = bind_args(wrapped, args, kwargs) + except Exception: + return wrapped(*args, **kwargs) + tool = bound_args.get("tool") - if hasattr(tool, "_tool_func"): - tool._tool_func = ErrorTraceWrapper(tool._tool_func) + # Ensure we don't double capture exceptions by not touching DecoratedFunctionTool instances here. + # Those should be captured with specific instrumentation that properly handles the thread boundaries. + if hasattr(tool, "stream") and not isinstance(tool, DecoratedFunctionTool): + tool.stream = ErrorTraceWrapper(tool.stream) + return wrapped(*args, **kwargs) @@ -464,6 +479,22 @@ def wrap_bedrock_model__stream(wrapped, instance, args, kwargs): return wrapped(*args, **kwargs) +def wrap_decorated_function_tool__wrap_tool_result(wrapped, instance, args, kwargs): + transaction = current_transaction() + if transaction: + exc = sys.exc_info() + try: + if exc: + bound_args = bind_args(wrapped, args, kwargs) + tool_id = bound_args.get("tool_id") + transaction.notice_error(exc, attributes={"tool_id": tool_id}) + finally: + # Delete exc to avoid reference cycles + del exc + + return wrapped(*args, **kwargs) + + def instrument_strands_agent_agent(module): if hasattr(module, "Agent"): if hasattr(module.Agent, "__call__"): # noqa: B004 @@ -490,6 +521,14 @@ def instrument_strands_multiagent_swarm(module): wrap_function_wrapper(module, "Swarm.invoke_async", wrap_agent_invoke_async) +def instrument_strands_tools_decorator(module): + # This instrumentation only exists to pass trace context due to bedrock models using a separate thread. + if hasattr(module, "DecoratedFunctionTool") and hasattr(module.DecoratedFunctionTool, "_wrap_tool_result"): + wrap_function_wrapper( + module, "DecoratedFunctionTool._wrap_tool_result", wrap_decorated_function_tool__wrap_tool_result + ) + + def instrument_strands_tools_executors__executor(module): if hasattr(module, "ToolExecutor"): if hasattr(module.ToolExecutor, "_stream"): diff --git a/tests/mlmodel_strands/_test_agent.py b/tests/mlmodel_strands/_test_agent.py deleted file mode 100644 index 15aa79a5ac..0000000000 --- a/tests/mlmodel_strands/_test_agent.py +++ /dev/null @@ -1,165 +0,0 @@ -# Copyright 2010 New Relic, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import pytest -from strands import tool - -from ._mock_model_provider import MockedModelProvider - - -# Example tool for testing purposes -@tool -async def add_exclamation(message: str) -> str: - return f"{message}!" - - -@tool -async def throw_exception_coro(message: str) -> str: - raise RuntimeError("Oops") - - -@tool -async def throw_exception_agen(message: str) -> str: - raise RuntimeError("Oops") - yield - - -@pytest.fixture -def single_tool_model(): - model = MockedModelProvider( - [ - { - "role": "assistant", - "content": [ - {"text": "Calling add_exclamation tool"}, - {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, - ], - }, - {"role": "assistant", "content": [{"text": "Success!"}]}, - ] - ) - return model - - -@pytest.fixture -def single_tool_model_runtime_error_coro(): - model = MockedModelProvider( - [ - { - "role": "assistant", - "content": [ - {"text": "Calling throw_exception_coro tool"}, - # Set arguments to an invalid type to trigger error in tool - {"toolUse": {"name": "throw_exception_coro", "toolUseId": "123", "input": {"message": "Hello"}}}, - ], - }, - {"role": "assistant", "content": [{"text": "Success!"}]}, - ] - ) - return model - - -@pytest.fixture -def single_tool_model_runtime_error_agen(): - model = MockedModelProvider( - [ - { - "role": "assistant", - "content": [ - {"text": "Calling throw_exception_agen tool"}, - # Set arguments to an invalid type to trigger error in tool - {"toolUse": {"name": "throw_exception_agen", "toolUseId": "123", "input": {"message": "Hello"}}}, - ], - }, - {"role": "assistant", "content": [{"text": "Success!"}]}, - ] - ) - return model - - -@pytest.fixture -def multi_tool_model(): - model = MockedModelProvider( - [ - { - "role": "assistant", - "content": [ - {"text": "Calling add_exclamation tool"}, - {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, - ], - }, - { - "role": "assistant", - "content": [ - {"text": "Calling compute_sum tool"}, - {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 5, "b": 3}}}, - ], - }, - { - "role": "assistant", - "content": [ - {"text": "Calling add_exclamation tool"}, - {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Goodbye"}}}, - ], - }, - { - "role": "assistant", - "content": [ - {"text": "Calling compute_sum tool"}, - {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 123, "b": 2}}}, - ], - }, - {"role": "assistant", "content": [{"text": "Success!"}]}, - ] - ) - return model - - -@pytest.fixture -def multi_tool_model_error(): - model = MockedModelProvider( - [ - { - "role": "assistant", - "content": [ - {"text": "Calling add_exclamation tool"}, - {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, - ], - }, - { - "role": "assistant", - "content": [ - {"text": "Calling compute_sum tool"}, - {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 5, "b": 3}}}, - ], - }, - { - "role": "assistant", - "content": [ - {"text": "Calling add_exclamation tool"}, - {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Goodbye"}}}, - ], - }, - { - "role": "assistant", - "content": [ - {"text": "Calling compute_sum tool"}, - # Set insufficient arguments to trigger error in tool - {"toolUse": {"name": "compute_sum", "toolUseId": "123", "input": {"a": 123}}}, - ], - }, - {"role": "assistant", "content": [{"text": "Success!"}]}, - ] - ) - return model diff --git a/tests/mlmodel_strands/_test_agents.py b/tests/mlmodel_strands/_test_agents.py new file mode 100644 index 0000000000..8dbfec29c4 --- /dev/null +++ b/tests/mlmodel_strands/_test_agents.py @@ -0,0 +1,43 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from strands import tool + +from ._mock_model_provider import MockedModelProvider + + +@tool +async def add_exclamation(message: str) -> str: + """Adds an exclamation mark to the input message.""" + if "exc" in message: + raise RuntimeError("Oops") + return f"{message}!" + + +@pytest.fixture +def single_tool_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model diff --git a/tests/mlmodel_strands/_test_tools.py b/tests/mlmodel_strands/_test_tools.py new file mode 100644 index 0000000000..a8383ed15e --- /dev/null +++ b/tests/mlmodel_strands/_test_tools.py @@ -0,0 +1,132 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from strands import tool +from strands.tools import PythonAgentTool + +from ._mock_model_provider import MockedModelProvider + + +# add_exclamation is implemented 5 different ways, but aliased to the same name. +# The agent will end up reporting identical data for all of them. +@tool(name="add_exclamation") +def add_exclamation_sync(message: str) -> str: + """Adds an exclamation mark to the input message.""" + if "exc" in message: + raise RuntimeError("Oops") + return f"{message}!" + + +@tool(name="add_exclamation") +async def add_exclamation_async(message: str) -> str: + """Adds an exclamation mark to the input message.""" + if "exc" in message: + raise RuntimeError("Oops") + return f"{message}!" + + +@tool(name="add_exclamation") +async def add_exclamation_agen(message: str) -> str: + """Adds an exclamation mark to the input message.""" + if "exc" in message: + raise RuntimeError("Oops") + yield f"{message}!" + + +def add_exclamation_sync_PythonAgentTool(tool_use, **invocation_state): + """Adds an exclamation mark to the input message.""" + message = tool_use["input"]["message"] + if "exc" in message: + raise RuntimeError("Oops") + return {"status": "success", "toolUseId": tool_use["toolUseId"], "content": [{"text": f"{message}!"}]} + + +async def add_exclamation_async_PythonAgentTool(tool_use, **invocation_state): + """Adds an exclamation mark to the input message.""" + message = tool_use["input"]["message"] + if "exc" in message: + raise RuntimeError("Oops") + return {"status": "success", "toolUseId": tool_use["toolUseId"], "content": [{"text": f"{message}!"}]} + + +_tool_spec = { + "name": "add_exclamation", + "description": "Adds an exclamation mark to the input message.", + "inputSchema": { + "json": { + "properties": {"message": {"description": "Parameter message", "type": "string"}}, + "required": ["message"], + "type": "object", + } + }, +} +_tool_spec = add_exclamation_sync._tool_spec + + +@pytest.fixture( + scope="session", params=["sync_@tool", "async_@tool", "agen_@tool", "sync_PythonAgentTool", "async_PythonAgentTool"] +) +def add_exclamation(request): + if request.param == "sync_@tool": + return add_exclamation_sync + elif request.param == "async_@tool": + return add_exclamation_async + elif request.param == "agen_@tool": + return add_exclamation_agen + elif request.param == "sync_PythonAgentTool": + return PythonAgentTool( + tool_name="add_exclamation", tool_spec=_tool_spec, tool_func=add_exclamation_sync_PythonAgentTool + ) + elif request.param == "async_PythonAgentTool": + return PythonAgentTool( + tool_name="add_exclamation", tool_spec=_tool_spec, tool_func=add_exclamation_async_PythonAgentTool + ) + else: + raise NotImplementedError + + +@pytest.fixture +def single_tool_model(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "Hello"}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model + + +@pytest.fixture +def single_tool_model_error(): + model = MockedModelProvider( + [ + { + "role": "assistant", + "content": [ + {"text": "Calling add_exclamation tool"}, + # Set arguments to an invalid type to trigger error in tool + {"toolUse": {"name": "add_exclamation", "toolUseId": "123", "input": {"message": "exc"}}}, + ], + }, + {"role": "assistant", "content": [{"text": "Success!"}]}, + ] + ) + return model diff --git a/tests/mlmodel_strands/conftest.py b/tests/mlmodel_strands/conftest.py index abbc29b969..001adde191 100644 --- a/tests/mlmodel_strands/conftest.py +++ b/tests/mlmodel_strands/conftest.py @@ -12,6 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. +import pytest from testing_support.fixture.event_loop import event_loop as loop from testing_support.fixtures import collector_agent_registration_fixture, collector_available_fixture from testing_support.ml_testing_utils import set_trace_info @@ -29,3 +30,22 @@ collector_agent_registration = collector_agent_registration_fixture( app_name="Python Agent Test (mlmodel_strands)", default_settings=_default_settings ) + + +@pytest.fixture(scope="session", params=["invoke", "invoke_async", "stream_async"]) +def exercise_agent(request, loop): + def _exercise_agent(agent, prompt): + if request.param == "invoke": + return agent(prompt) + elif request.param == "invoke_async": + return loop.run_until_complete(agent.invoke_async(prompt)) + elif request.param == "stream_async": + + async def _exercise_agen(): + return [event async for event in agent.stream_async(prompt)] + + return loop.run_until_complete(_exercise_agen()) + else: + raise NotImplementedError + + return _exercise_agent diff --git a/tests/mlmodel_strands/test_agent.py b/tests/mlmodel_strands/test_agent.py deleted file mode 100644 index 6fa5e56a68..0000000000 --- a/tests/mlmodel_strands/test_agent.py +++ /dev/null @@ -1,421 +0,0 @@ -# Copyright 2010 New Relic, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import pytest -from strands import Agent -from testing_support.fixtures import reset_core_stats_engine, validate_attributes -from testing_support.ml_testing_utils import ( - disabled_ai_monitoring_record_content_settings, - disabled_ai_monitoring_settings, - events_with_context_attrs, - tool_events_sans_content, -) -from testing_support.validators.validate_custom_event import validate_custom_event_count -from testing_support.validators.validate_custom_events import validate_custom_events -from testing_support.validators.validate_error_trace_attributes import validate_error_trace_attributes -from testing_support.validators.validate_transaction_error_event_count import validate_transaction_error_event_count -from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics - -from newrelic.api.background_task import background_task -from newrelic.api.llm_custom_attributes import WithLlmCustomAttributes -from newrelic.common.object_names import callable_name -from newrelic.common.object_wrapper import transient_function_wrapper - -from ._test_agent import ( - add_exclamation, - multi_tool_model, - multi_tool_model_error, - single_tool_model, - single_tool_model_runtime_error_agen, - single_tool_model_runtime_error_coro, - throw_exception_agen, - throw_exception_coro, -) - -tool_recorded_event = [ - ( - {"type": "LlmTool"}, - { - "id": None, - "run_id": "123", - "output": "{'text': 'Hello!'}", - "name": "add_exclamation", - "agent_name": "my_agent", - "span_id": None, - "trace_id": "trace-id", - "input": "{'message': 'Hello'}", - "vendor": "strands", - "ingest_source": "Python", - "duration": None, - }, - ) -] - -tool_recorded_event_forced_internal_error = [ - ( - {"type": "LlmTool"}, - { - "id": None, - "run_id": "123", - "name": "add_exclamation", - "agent_name": "my_agent", - "span_id": None, - "trace_id": "trace-id", - "input": "{'message': 'Hello'}", - "vendor": "strands", - "ingest_source": "Python", - "duration": None, - "error": True, - }, - ) -] - -tool_recorded_event_error_coro = [ - ( - {"type": "LlmTool"}, - { - "id": None, - "run_id": "123", - "name": "throw_exception_coro", - "agent_name": "my_agent", - "span_id": None, - "trace_id": "trace-id", - "input": "{'message': 'Hello'}", - "vendor": "strands", - "ingest_source": "Python", - "error": True, - "output": "{'text': 'Error: RuntimeError - Oops'}", - "duration": None, - }, - ) -] - - -tool_recorded_event_error_agen = [ - ( - {"type": "LlmTool"}, - { - "id": None, - "run_id": "123", - "name": "throw_exception_agen", - "agent_name": "my_agent", - "span_id": None, - "trace_id": "trace-id", - "input": "{'message': 'Hello'}", - "vendor": "strands", - "ingest_source": "Python", - "error": True, - "output": "{'text': 'Error: RuntimeError - Oops'}", - "duration": None, - }, - ) -] - - -agent_recorded_event = [ - ( - {"type": "LlmAgent"}, - { - "id": None, - "name": "my_agent", - "span_id": None, - "trace_id": "trace-id", - "vendor": "strands", - "ingest_source": "Python", - "duration": None, - }, - ) -] - -agent_recorded_event_error = [ - ( - {"type": "LlmAgent"}, - { - "id": None, - "name": "my_agent", - "span_id": None, - "trace_id": "trace-id", - "vendor": "strands", - "ingest_source": "Python", - "error": True, - "duration": None, - }, - ) -] - - -@reset_core_stats_engine() -@validate_custom_events(events_with_context_attrs(tool_recorded_event)) -@validate_custom_events(events_with_context_attrs(agent_recorded_event)) -@validate_custom_event_count(count=2) -@validate_transaction_metrics( - "mlmodel_strands.test_agent:test_agent_invoke", - scoped_metrics=[ - ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), - ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), - ], - rollup_metrics=[ - ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), - ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), - ], - background_task=True, -) -@validate_attributes("agent", ["llm"]) -@background_task() -def test_agent_invoke(set_trace_info, single_tool_model): - set_trace_info() - my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) - - with WithLlmCustomAttributes({"context": "attr"}): - response = my_agent('Add an exclamation to the word "Hello"') - assert response.message["content"][0]["text"] == "Success!" - assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 - - -@reset_core_stats_engine() -@validate_custom_events(tool_recorded_event) -@validate_custom_events(agent_recorded_event) -@validate_custom_event_count(count=2) -@validate_transaction_metrics( - "mlmodel_strands.test_agent:test_agent_invoke_async", - scoped_metrics=[ - ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), - ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), - ], - rollup_metrics=[ - ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), - ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), - ], - background_task=True, -) -@validate_attributes("agent", ["llm"]) -@background_task() -def test_agent_invoke_async(loop, set_trace_info, single_tool_model): - set_trace_info() - my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) - - async def _test(): - response = await my_agent.invoke_async('Add an exclamation to the word "Hello"') - assert response.message["content"][0]["text"] == "Success!" - assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 - - loop.run_until_complete(_test()) - - -@reset_core_stats_engine() -@validate_custom_events(tool_recorded_event) -@validate_custom_events(agent_recorded_event) -@validate_custom_event_count(count=2) -@validate_transaction_metrics( - "mlmodel_strands.test_agent:test_agent_stream_async", - scoped_metrics=[ - ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), - ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), - ], - rollup_metrics=[ - ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), - ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), - ], - background_task=True, -) -@validate_attributes("agent", ["llm"]) -@background_task() -def test_agent_stream_async(loop, set_trace_info, single_tool_model): - set_trace_info() - my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) - - async def _test(): - response = my_agent.stream_async('Add an exclamation to the word "Hello"') - messages = [event["message"]["content"] async for event in response if "message" in event] - - assert len(messages) == 3 - assert messages[0][0]["text"] == "Calling add_exclamation tool" - assert messages[0][1]["toolUse"]["name"] == "add_exclamation" - assert messages[1][0]["toolResult"]["content"][0]["text"] == "Hello!" - assert messages[2][0]["text"] == "Success!" - - loop.run_until_complete(_test()) - - -@reset_core_stats_engine() -@disabled_ai_monitoring_record_content_settings -@validate_custom_events(agent_recorded_event) -@validate_custom_events(tool_events_sans_content(tool_recorded_event)) -@validate_custom_event_count(count=2) -@validate_transaction_metrics( - "mlmodel_strands.test_agent:test_agent_invoke_no_content", - scoped_metrics=[ - ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), - ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), - ], - rollup_metrics=[ - ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), - ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), - ], - background_task=True, -) -@validate_attributes("agent", ["llm"]) -@background_task() -def test_agent_invoke_no_content(set_trace_info, single_tool_model): - set_trace_info() - my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) - - response = my_agent('Add an exclamation to the word "Hello"') - assert response.message["content"][0]["text"] == "Success!" - assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 - - -@disabled_ai_monitoring_settings -@reset_core_stats_engine() -@validate_custom_event_count(count=0) -@background_task() -def test_agent_invoke_disabled_ai_monitoring_events(set_trace_info, single_tool_model): - set_trace_info() - my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) - - response = my_agent('Add an exclamation to the word "Hello"') - assert response.message["content"][0]["text"] == "Success!" - assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 - - -@reset_core_stats_engine() -@validate_transaction_error_event_count(1) -@validate_error_trace_attributes(callable_name(ValueError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) -@validate_custom_events(agent_recorded_event_error) -@validate_custom_event_count(count=1) -@validate_transaction_metrics( - "mlmodel_strands.test_agent:test_agent_invoke_error", - scoped_metrics=[("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1)], - rollup_metrics=[("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1)], - background_task=True, -) -@validate_attributes("agent", ["llm"]) -@background_task() -def test_agent_invoke_error(set_trace_info, single_tool_model): - # Add a wrapper to intentionally force an error in the Agent code - @transient_function_wrapper("strands.agent.agent", "Agent._convert_prompt_to_messages") - def _wrap_convert_prompt_to_messages(wrapped, instance, args, kwargs): - raise ValueError("Oops") - - @_wrap_convert_prompt_to_messages - def _test(): - set_trace_info() - my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) - my_agent('Add an exclamation to the word "Hello"') # raises ValueError - - with pytest.raises(ValueError): - _test() - - -@reset_core_stats_engine() -@validate_transaction_error_event_count(1) -@validate_error_trace_attributes(callable_name(RuntimeError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) -@validate_custom_events(tool_recorded_event_error_coro) -@validate_custom_event_count(count=2) -@validate_transaction_metrics( - "mlmodel_strands.test_agent:test_agent_invoke_tool_coro_runtime_error", - scoped_metrics=[ - ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), - ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/throw_exception_coro", 1), - ], - rollup_metrics=[ - ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), - ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/throw_exception_coro", 1), - ], - background_task=True, -) -@validate_attributes("agent", ["llm"]) -@background_task() -def test_agent_invoke_tool_coro_runtime_error(set_trace_info, single_tool_model_runtime_error_coro): - set_trace_info() - my_agent = Agent(name="my_agent", model=single_tool_model_runtime_error_coro, tools=[throw_exception_coro]) - - response = my_agent('Add an exclamation to the word "Hello"') - assert response.message["content"][0]["text"] == "Success!" - assert response.metrics.tool_metrics["throw_exception_coro"].error_count == 1 - - -@reset_core_stats_engine() -@validate_transaction_error_event_count(1) -@validate_error_trace_attributes(callable_name(RuntimeError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) -@validate_custom_events(tool_recorded_event_error_agen) -@validate_custom_event_count(count=2) -@validate_transaction_metrics( - "mlmodel_strands.test_agent:test_agent_invoke_tool_agen_runtime_error", - scoped_metrics=[ - ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), - ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/throw_exception_agen", 1), - ], - rollup_metrics=[ - ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), - ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/throw_exception_agen", 1), - ], - background_task=True, -) -@validate_attributes("agent", ["llm"]) -@background_task() -def test_agent_invoke_tool_agen_runtime_error(set_trace_info, single_tool_model_runtime_error_agen): - set_trace_info() - my_agent = Agent(name="my_agent", model=single_tool_model_runtime_error_agen, tools=[throw_exception_agen]) - - response = my_agent('Add an exclamation to the word "Hello"') - assert response.message["content"][0]["text"] == "Success!" - assert response.metrics.tool_metrics["throw_exception_agen"].error_count == 1 - - -@reset_core_stats_engine() -@validate_transaction_error_event_count(1) -@validate_error_trace_attributes(callable_name(ValueError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) -@validate_custom_events(agent_recorded_event) -@validate_custom_events(tool_recorded_event_forced_internal_error) -@validate_custom_event_count(count=2) -@validate_transaction_metrics( - "mlmodel_strands.test_agent:test_agent_tool_forced_exception", - scoped_metrics=[ - ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), - ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), - ], - rollup_metrics=[ - ("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1), - ("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1), - ], - background_task=True, -) -@validate_attributes("agent", ["llm"]) -@background_task() -def test_agent_tool_forced_exception(set_trace_info, single_tool_model): - # Add a wrapper to intentionally force an error in the ToolExecutor._stream code to hit the exception path in - # the AsyncGeneratorProxy - @transient_function_wrapper("strands.hooks.events", "BeforeToolCallEvent.__init__") - def _wrap_BeforeToolCallEvent_init(wrapped, instance, args, kwargs): - raise ValueError("Oops") - - @_wrap_BeforeToolCallEvent_init - def _test(): - set_trace_info() - my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) - my_agent('Add an exclamation to the word "Hello"') - - # This will not explicitly raise a ValueError when running the test but we are still able to capture it in the error trace - _test() - - -@reset_core_stats_engine() -@validate_custom_event_count(count=0) -def test_agent_invoke_outside_txn(single_tool_model): - my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) - - response = my_agent('Add an exclamation to the word "Hello"') - assert response.message["content"][0]["text"] == "Success!" - assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 diff --git a/tests/mlmodel_strands/test_agents.py b/tests/mlmodel_strands/test_agents.py new file mode 100644 index 0000000000..b0a1965eea --- /dev/null +++ b/tests/mlmodel_strands/test_agents.py @@ -0,0 +1,203 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from strands import Agent +from testing_support.fixtures import reset_core_stats_engine, validate_attributes +from testing_support.ml_testing_utils import ( + disabled_ai_monitoring_record_content_settings, + disabled_ai_monitoring_settings, + events_with_context_attrs, +) +from testing_support.validators.validate_custom_event import validate_custom_event_count +from testing_support.validators.validate_custom_events import validate_custom_events +from testing_support.validators.validate_error_trace_attributes import validate_error_trace_attributes +from testing_support.validators.validate_transaction_error_event_count import validate_transaction_error_event_count +from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics + +from newrelic.api.background_task import background_task +from newrelic.api.llm_custom_attributes import WithLlmCustomAttributes +from newrelic.common.object_names import callable_name +from newrelic.common.object_wrapper import transient_function_wrapper + +from ._test_agents import add_exclamation, single_tool_model + +agent_recorded_event = [ + ( + {"type": "LlmAgent"}, + { + "id": None, + "name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + "ingest_source": "Python", + "duration": None, + }, + ) +] + +agent_recorded_event_error = [ + ( + {"type": "LlmAgent"}, + { + "id": None, + "name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "vendor": "strands", + "ingest_source": "Python", + "error": True, + "duration": None, + }, + ) +] + + +@reset_core_stats_engine() +@validate_custom_events(events_with_context_attrs(agent_recorded_event)) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "mlmodel_strands.test_agents:test_agent", + scoped_metrics=[("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1)], + rollup_metrics=[("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1)], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent(exercise_agent, set_trace_info, single_tool_model): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + with WithLlmCustomAttributes({"context": "attr"}): + response = exercise_agent(my_agent, 'Add an exclamation to the word "Hello"') + + if isinstance(response, list): + # Streaming returns a list of events + messages = [event["message"]["content"] for event in response if "message" in event] + assert len(messages) == 3 + assert messages[0][0]["text"] == "Calling add_exclamation tool" + assert messages[0][1]["toolUse"]["name"] == "add_exclamation" + assert messages[1][0]["toolResult"]["content"][0]["text"] == "Hello!" + assert messages[2][0]["text"] == "Success!" + else: + # Invoke returns a response object + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 + + +@reset_core_stats_engine() +@disabled_ai_monitoring_record_content_settings +@validate_custom_events(agent_recorded_event) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "mlmodel_strands.test_agents:test_agent_no_content", + scoped_metrics=[("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1)], + rollup_metrics=[("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1)], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent_no_content(exercise_agent, set_trace_info, single_tool_model): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + response = exercise_agent(my_agent, 'Add an exclamation to the word "Hello"') + + if isinstance(response, list): + # Streaming returns a list of events + messages = [event["message"]["content"] for event in response if "message" in event] + assert len(messages) == 3 + assert messages[0][0]["text"] == "Calling add_exclamation tool" + assert messages[0][1]["toolUse"]["name"] == "add_exclamation" + assert messages[1][0]["toolResult"]["content"][0]["text"] == "Hello!" + assert messages[2][0]["text"] == "Success!" + else: + # Invoke returns a response object + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 + + +@reset_core_stats_engine() +@validate_custom_event_count(count=0) +def test_agent_outside_txn(exercise_agent, single_tool_model): + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + response = exercise_agent(my_agent, 'Add an exclamation to the word "Hello"') + + if isinstance(response, list): + # Streaming returns a list of events + messages = [event["message"]["content"] for event in response if "message" in event] + assert len(messages) == 3 + assert messages[0][0]["text"] == "Calling add_exclamation tool" + assert messages[0][1]["toolUse"]["name"] == "add_exclamation" + assert messages[1][0]["toolResult"]["content"][0]["text"] == "Hello!" + assert messages[2][0]["text"] == "Success!" + else: + # Invoke returns a response object + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 + + +@disabled_ai_monitoring_settings +@reset_core_stats_engine() +@validate_custom_event_count(count=0) +@background_task() +def test_agent_disabled_ai_monitoring_events(exercise_agent, set_trace_info, single_tool_model): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + response = exercise_agent(my_agent, 'Add an exclamation to the word "Hello"') + + if isinstance(response, list): + # Streaming returns a list of events + messages = [event["message"]["content"] for event in response if "message" in event] + assert len(messages) == 3 + assert messages[0][0]["text"] == "Calling add_exclamation tool" + assert messages[0][1]["toolUse"]["name"] == "add_exclamation" + assert messages[1][0]["toolResult"]["content"][0]["text"] == "Hello!" + assert messages[2][0]["text"] == "Success!" + else: + # Invoke returns a response object + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 + + +@reset_core_stats_engine() +@validate_transaction_error_event_count(1) +@validate_error_trace_attributes(callable_name(ValueError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) +@validate_custom_events(agent_recorded_event_error) +@validate_custom_event_count(count=1) +@validate_transaction_metrics( + "mlmodel_strands.test_agents:test_agent_execution_error", + scoped_metrics=[("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1)], + rollup_metrics=[("Llm/agent/Strands/strands.agent.agent:Agent.stream_async/my_agent", 1)], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_agent_execution_error(exercise_agent, set_trace_info, single_tool_model): + # Add a wrapper to intentionally force an error in the Agent code + @transient_function_wrapper("strands.agent.agent", "Agent._convert_prompt_to_messages") + def inject_exception(wrapped, instance, args, kwargs): + raise ValueError("Oops") + + @inject_exception + def _test(): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + with pytest.raises(ValueError): + exercise_agent(my_agent, 'Add an exclamation to the word "Hello"') # raises ValueError + + _test() # No output to validate diff --git a/tests/mlmodel_strands/test_tools.py b/tests/mlmodel_strands/test_tools.py new file mode 100644 index 0000000000..a5e62ff3a3 --- /dev/null +++ b/tests/mlmodel_strands/test_tools.py @@ -0,0 +1,244 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from strands import Agent +from testing_support.fixtures import reset_core_stats_engine, validate_attributes +from testing_support.ml_testing_utils import ( + disabled_ai_monitoring_record_content_settings, + events_with_context_attrs, + tool_events_sans_content, +) +from testing_support.validators.validate_custom_event import validate_custom_event_count +from testing_support.validators.validate_custom_events import validate_custom_events +from testing_support.validators.validate_error_trace_attributes import validate_error_trace_attributes +from testing_support.validators.validate_transaction_error_event_count import validate_transaction_error_event_count +from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics + +from newrelic.api.background_task import background_task +from newrelic.api.llm_custom_attributes import WithLlmCustomAttributes +from newrelic.common.object_names import callable_name +from newrelic.common.object_wrapper import transient_function_wrapper + +from ._test_tools import add_exclamation, single_tool_model, single_tool_model_error + +tool_recorded_event = [ + ( + {"type": "LlmTool"}, + { + "id": None, + "run_id": "123", + "output": "{'text': 'Hello!'}", + "name": "add_exclamation", + "agent_name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "input": "{'message': 'Hello'}", + "vendor": "strands", + "ingest_source": "Python", + "duration": None, + }, + ) +] + +tool_recorded_event_execution_error = [ + ( + {"type": "LlmTool"}, + { + "id": None, + "run_id": "123", + "name": "add_exclamation", + "agent_name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "input": "{'message': 'exc'}", + "vendor": "strands", + "ingest_source": "Python", + "error": True, + "output": "{'text': 'Error: RuntimeError - Oops'}", + "duration": None, + }, + ) +] + +tool_recorded_event_forced_internal_error = [ + ( + {"type": "LlmTool"}, + { + "id": None, + "run_id": "123", + "name": "add_exclamation", + "agent_name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "input": "{'message': 'Hello'}", + "vendor": "strands", + "ingest_source": "Python", + "duration": None, + "error": True, + }, + ) +] + +EXPECTED_ERROR_MESSAGES = ["Error: RuntimeError - Oops", "Error: Oops"] + + +@reset_core_stats_engine() +@validate_custom_events(events_with_context_attrs(tool_recorded_event)) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "mlmodel_strands.test_tools:test_tool", + scoped_metrics=[("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1)], + rollup_metrics=[("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1)], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_tool(exercise_agent, set_trace_info, single_tool_model, add_exclamation): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + with WithLlmCustomAttributes({"context": "attr"}): + response = exercise_agent(my_agent, 'Add an exclamation to the word "Hello"') + + if isinstance(response, list): + # Streaming returns a list of events + messages = [event["message"]["content"] for event in response if "message" in event] + assert len(messages) == 3 + assert messages[0][0]["text"] == "Calling add_exclamation tool" + assert messages[0][1]["toolUse"]["name"] == "add_exclamation" + assert messages[1][0]["toolResult"]["content"][0]["text"] == "Hello!" + assert messages[2][0]["text"] == "Success!" + else: + # Invoke returns a response object + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 + + +@reset_core_stats_engine() +@disabled_ai_monitoring_record_content_settings +@validate_custom_events(tool_events_sans_content(tool_recorded_event)) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "mlmodel_strands.test_tools:test_tool_no_content", + scoped_metrics=[("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1)], + rollup_metrics=[("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1)], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_tool_no_content(exercise_agent, set_trace_info, single_tool_model, add_exclamation): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + + response = exercise_agent(my_agent, 'Add an exclamation to the word "Hello"') + + if isinstance(response, list): + # Streaming returns a list of events + messages = [event["message"]["content"] for event in response if "message" in event] + assert len(messages) == 3 + assert messages[0][0]["text"] == "Calling add_exclamation tool" + assert messages[0][1]["toolUse"]["name"] == "add_exclamation" + assert messages[1][0]["toolResult"]["content"][0]["text"] == "Hello!" + assert messages[2][0]["text"] == "Success!" + else: + # Invoke returns a response object + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 + + +@reset_core_stats_engine() +def test_tool_execution_error(exercise_agent, set_trace_info, single_tool_model_error, add_exclamation): + from strands.tools import PythonAgentTool + + err_msg = EXPECTED_ERROR_MESSAGES[1] if isinstance(add_exclamation, PythonAgentTool) else EXPECTED_ERROR_MESSAGES[0] + tool_recorded_event_execution_error[0][1]["output"] = f"{{'text': '{err_msg}'}}" + + @validate_transaction_error_event_count(1) + @validate_error_trace_attributes( + callable_name(RuntimeError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}} + ) + @validate_custom_events(tool_recorded_event_execution_error) + @validate_custom_event_count(count=2) + @validate_transaction_metrics( + "test_tool_execution_error", + scoped_metrics=[("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1)], + rollup_metrics=[("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1)], + background_task=True, + ) + @validate_attributes("agent", ["llm"]) + @background_task(name="test_tool_execution_error") + def _test(): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model_error, tools=[add_exclamation]) + + response = exercise_agent(my_agent, 'Add an exclamation to the word "exc"') + + if isinstance(response, list): + # Streaming returns a list of events + messages = [event["message"]["content"] for event in response if "message" in event] + assert len(messages) == 3 + assert messages[0][0]["text"] == "Calling add_exclamation tool" + assert messages[0][1]["toolUse"]["name"] == "add_exclamation" + assert messages[1][0]["toolResult"]["content"][0]["text"] in EXPECTED_ERROR_MESSAGES + assert messages[2][0]["text"] == "Success!" + else: + # Invoke returns a response object + assert response.message["content"][0]["text"] == "Success!" + assert response.metrics.tool_metrics["add_exclamation"].error_count == 1 + + _test() + + +@reset_core_stats_engine() +@validate_transaction_error_event_count(1) +@validate_error_trace_attributes(callable_name(ValueError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) +@validate_custom_events(tool_recorded_event_forced_internal_error) +@validate_custom_event_count(count=2) +@validate_transaction_metrics( + "mlmodel_strands.test_tools:test_tool_pre_execution_exception", + scoped_metrics=[("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1)], + rollup_metrics=[("Llm/tool/Strands/strands.tools.executors._executor:ToolExecutor._stream/add_exclamation", 1)], + background_task=True, +) +@validate_attributes("agent", ["llm"]) +@background_task() +def test_tool_pre_execution_exception(exercise_agent, set_trace_info, single_tool_model, add_exclamation): + # Add a wrapper to intentionally force an error in the ToolExecutor._stream code to hit the exception path in + # the AsyncGeneratorProxy + @transient_function_wrapper("strands.hooks.events", "BeforeToolCallEvent.__init__") + def inject_exception(wrapped, instance, args, kwargs): + raise ValueError("Oops") + + @inject_exception + def _test(): + set_trace_info() + my_agent = Agent(name="my_agent", model=single_tool_model, tools=[add_exclamation]) + return exercise_agent(my_agent, 'Add an exclamation to the word "Hello"') + + # This will not explicitly raise a ValueError when running the test but we are still able to capture it in the error trace + response = _test() + + if isinstance(response, list): + # Streaming returns a list of events + messages = [event["message"]["content"] for event in response if "message" in event] + assert len(messages) == 3 + assert messages[0][0]["text"] == "Calling add_exclamation tool" + assert messages[0][1]["toolUse"]["name"] == "add_exclamation" + assert not messages[1], "Failed tool invocation should return an empty message." + assert messages[2][0]["text"] == "Success!" + else: + # Invoke returns a response object + assert response.message["content"][0]["text"] == "Success!" + assert not response.metrics.tool_metrics From 002fc853832de2fd6a4a26c93cf22f3ebcc4a554 Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Thu, 22 Jan 2026 14:40:09 -0800 Subject: [PATCH 049/124] Add support for BaseException instances as arguments to notice_error (#1571) * Update implementation of notice_error * Clean up test_notice_error file * Add tests for notice_error with exception instances --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- newrelic/api/time_trace.py | 16 ++-- newrelic/core/stats_engine.py | 17 +++-- tests/agent_features/test_notice_error.py | 91 ++++++++++++----------- 3 files changed, 69 insertions(+), 55 deletions(-) diff --git a/newrelic/api/time_trace.py b/newrelic/api/time_trace.py index fd0f62fdef..800c6f01b7 100644 --- a/newrelic/api/time_trace.py +++ b/newrelic/api/time_trace.py @@ -362,15 +362,19 @@ def _observe_exception(self, exc_info=None, ignore=None, expected=None, status_c def notice_error(self, error=None, attributes=None, expected=None, ignore=None, status_code=None): attributes = attributes if attributes is not None else {} - # If no exception details provided, use current exception. + # If an exception instance is passed, attempt to unpack it into an exception tuple with traceback + if isinstance(error, BaseException): + error = (type(error), error, getattr(error, "__traceback__", None)) - # Pull from sys.exc_info if no exception is passed - if not error or None in error: + # Use current exception from sys.exc_info() if no exception was passed, + # or if the exception tuple is missing components like the traceback + if not error or (isinstance(error, (tuple, list)) and None in error): error = sys.exc_info() - # If no exception to report, exit - if not error or None in error: - return + # Error should be a tuple or list of 3 elements by this point. + # If it's falsey or missing a component like the traceback, quietly exit early. + if not isinstance(error, (tuple, list)) or len(error) != 3 or None in error: + return exc, value, tb = error diff --git a/newrelic/core/stats_engine.py b/newrelic/core/stats_engine.py index f44f82fe13..f4a0e98ff6 100644 --- a/newrelic/core/stats_engine.py +++ b/newrelic/core/stats_engine.py @@ -678,7 +678,6 @@ def record_time_metrics(self, metrics): def notice_error(self, error=None, attributes=None, expected=None, ignore=None, status_code=None): attributes = attributes if attributes is not None else {} settings = self.__settings - if not settings: return @@ -690,13 +689,19 @@ def notice_error(self, error=None, attributes=None, expected=None, ignore=None, if not settings.collect_errors and not settings.collect_error_events: return - # Pull from sys.exc_info if no exception is passed - if not error or None in error: + # If an exception instance is passed, attempt to unpack it into an exception tuple with traceback + if isinstance(error, BaseException): + error = (type(error), error, getattr(error, "__traceback__", None)) + + # Use current exception from sys.exc_info() if no exception was passed, + # or if the exception tuple is missing components like the traceback + if not error or (isinstance(error, (tuple, list)) and None in error): error = sys.exc_info() - # If no exception to report, exit - if not error or None in error: - return + # Error should be a tuple or list of 3 elements by this point. + # If it's falsey or missing a component like the traceback, quietly exit early. + if not isinstance(error, (tuple, list)) or len(error) != 3 or None in error: + return exc, value, tb = error diff --git a/tests/agent_features/test_notice_error.py b/tests/agent_features/test_notice_error.py index e698dee7be..60e617f9de 100644 --- a/tests/agent_features/test_notice_error.py +++ b/tests/agent_features/test_notice_error.py @@ -39,10 +39,8 @@ # =============== Test errors during a transaction =============== -_test_notice_error_sys_exc_info = [(_runtime_error_name, "one")] - -@validate_transaction_errors(errors=_test_notice_error_sys_exc_info) +@validate_transaction_errors(errors=[(_runtime_error_name, "one")]) @background_task() def test_notice_error_sys_exc_info(): try: @@ -51,10 +49,7 @@ def test_notice_error_sys_exc_info(): notice_error(sys.exc_info()) -_test_notice_error_no_exc_info = [(_runtime_error_name, "one")] - - -@validate_transaction_errors(errors=_test_notice_error_no_exc_info) +@validate_transaction_errors(errors=[(_runtime_error_name, "one")]) @background_task() def test_notice_error_no_exc_info(): try: @@ -63,10 +58,44 @@ def test_notice_error_no_exc_info(): notice_error() -_test_notice_error_custom_params = [(_runtime_error_name, "one")] +@validate_transaction_errors(errors=[(_runtime_error_name, "one")]) +@background_task() +def test_notice_error_exception_instance(): + """Test that notice_error works when passed an exception object directly""" + try: + raise RuntimeError("one") + except RuntimeError as e: + exc = e # Reassign name to ensure scope isn't lost + + # Call notice_error outside of try/except block to ensure it's not pulling from sys.exc_info() + notice_error(exc) + + +@validate_transaction_errors(errors=[(_runtime_error_name, "one"), (_type_error_name, "two")]) +@background_task() +def test_notice_error_exception_instance_multiple_exceptions(): + """Test that notice_error reports the passed exception object even when a different exception is active.""" + try: + raise RuntimeError("one") + except RuntimeError as e: + exc1 = e # Reassign name to ensure scope isn't lost + + try: + raise TypeError("two") + except TypeError as exc2: + notice_error(exc1) + notice_error(exc2) + + +@validate_transaction_error_event_count(0) +@background_task() +def test_notice_error_exception_instance_no_traceback(): + """Test that notice_error does not report an exception if it has not been raised as it has no __traceback__""" + exc = RuntimeError("one") + notice_error(exc) # Try once with no active exception -@validate_transaction_errors(errors=_test_notice_error_custom_params, required_params=[("key", "value")]) +@validate_transaction_errors(errors=[(_runtime_error_name, "one")], required_params=[("key", "value")]) @background_task() def test_notice_error_custom_params(): try: @@ -75,10 +104,7 @@ def test_notice_error_custom_params(): notice_error(sys.exc_info(), attributes={"key": "value"}) -_test_notice_error_multiple_different_type = [(_runtime_error_name, "one"), (_type_error_name, "two")] - - -@validate_transaction_errors(errors=_test_notice_error_multiple_different_type) +@validate_transaction_errors(errors=[(_runtime_error_name, "one"), (_type_error_name, "two")]) @background_task() def test_notice_error_multiple_different_type(): try: @@ -92,10 +118,7 @@ def test_notice_error_multiple_different_type(): notice_error() -_test_notice_error_multiple_same_type = [(_runtime_error_name, "one"), (_runtime_error_name, "two")] - - -@validate_transaction_errors(errors=_test_notice_error_multiple_same_type) +@validate_transaction_errors(errors=[(_runtime_error_name, "one"), (_runtime_error_name, "two")]) @background_task() def test_notice_error_multiple_same_type(): try: @@ -111,11 +134,9 @@ def test_notice_error_multiple_same_type(): # =============== Test errors outside a transaction =============== -_test_application_exception = [(_runtime_error_name, "one")] - @reset_core_stats_engine() -@validate_application_errors(errors=_test_application_exception) +@validate_application_errors(errors=[(_runtime_error_name, "one")]) def test_application_exception(): try: raise RuntimeError("one") @@ -124,11 +145,8 @@ def test_application_exception(): notice_error(application=application_instance) -_test_application_exception_sys_exc_info = [(_runtime_error_name, "one")] - - @reset_core_stats_engine() -@validate_application_errors(errors=_test_application_exception_sys_exc_info) +@validate_application_errors(errors=[(_runtime_error_name, "one")]) def test_application_exception_sys_exec_info(): try: raise RuntimeError("one") @@ -137,11 +155,8 @@ def test_application_exception_sys_exec_info(): notice_error(sys.exc_info(), application=application_instance) -_test_application_exception_custom_params = [(_runtime_error_name, "one")] - - @reset_core_stats_engine() -@validate_application_errors(errors=_test_application_exception_custom_params, required_params=[("key", "value")]) +@validate_application_errors(errors=[(_runtime_error_name, "one")], required_params=[("key", "value")]) def test_application_exception_custom_params(): try: raise RuntimeError("one") @@ -150,11 +165,8 @@ def test_application_exception_custom_params(): notice_error(attributes={"key": "value"}, application=application_instance) -_test_application_exception_multiple = [(_runtime_error_name, "one"), (_runtime_error_name, "one")] - - @reset_core_stats_engine() -@validate_application_errors(errors=_test_application_exception_multiple) +@validate_application_errors(errors=[(_runtime_error_name, "one"), (_runtime_error_name, "one")]) @background_task() def test_application_exception_multiple(): """Exceptions submitted straight to the stats engine doesn't check for @@ -174,12 +186,11 @@ def test_application_exception_multiple(): # =============== Test exception message stripping/allowlisting =============== -_test_notice_error_strip_message_disabled = [(_runtime_error_name, "one")] _strip_message_disabled_settings = {"strip_exception_messages.enabled": False} -@validate_transaction_errors(errors=_test_notice_error_strip_message_disabled) +@validate_transaction_errors(errors=[(_runtime_error_name, "one")]) @override_application_settings(_strip_message_disabled_settings) @background_task() def test_notice_error_strip_message_disabled(): @@ -215,12 +226,10 @@ def test_notice_error_strip_message_disabled_outside_transaction(): assert my_error.message == ErrorOne.message -_test_notice_error_strip_message_enabled = [(_runtime_error_name, STRIP_EXCEPTION_MESSAGE)] - _strip_message_enabled_settings = {"strip_exception_messages.enabled": True} -@validate_transaction_errors(errors=_test_notice_error_strip_message_enabled) +@validate_transaction_errors(errors=[(_runtime_error_name, STRIP_EXCEPTION_MESSAGE)]) @override_application_settings(_strip_message_enabled_settings) @background_task() def test_notice_error_strip_message_enabled(): @@ -256,15 +265,13 @@ def test_notice_error_strip_message_enabled_outside_transaction(): assert my_error.message == STRIP_EXCEPTION_MESSAGE -_test_notice_error_strip_message_in_allowlist = [(_runtime_error_name, "original error message")] - _strip_message_in_allowlist_settings = { "strip_exception_messages.enabled": True, "strip_exception_messages.allowlist": [_runtime_error_name], } -@validate_transaction_errors(errors=_test_notice_error_strip_message_in_allowlist) +@validate_transaction_errors(errors=[(_runtime_error_name, "original error message")]) @override_application_settings(_strip_message_in_allowlist_settings) @background_task() def test_notice_error_strip_message_in_allowlist(): @@ -307,15 +314,13 @@ def test_notice_error_strip_message_in_allowlist_outside_transaction(): assert my_error.message == ErrorThree.message -_test_notice_error_strip_message_not_in_allowlist = [(_runtime_error_name, STRIP_EXCEPTION_MESSAGE)] - _strip_message_not_in_allowlist_settings = { "strip_exception_messages.enabled": True, "strip_exception_messages.allowlist": ["FooError", "BarError"], } -@validate_transaction_errors(errors=_test_notice_error_strip_message_not_in_allowlist) +@validate_transaction_errors(errors=[(_runtime_error_name, STRIP_EXCEPTION_MESSAGE)]) @override_application_settings(_strip_message_not_in_allowlist_settings) @background_task() def test_notice_error_strip_message_not_in_allowlist(): From 36a23584692a62984cf363cdb53233ab94e9057d Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Fri, 23 Jan 2026 11:54:13 -0800 Subject: [PATCH 050/124] Update Vendored Packages (#1612) * Update urllib3 to 2.6.3 * Clear out trivy ignore * Update wrapt to 2.0.1 * Update asgiref to 3.11.0 * Update packages section of setup.py and pyproject * Remove unused strict arg from urllib3 connection * Update testing cert for new requirements * Update licenses in 3rd party notices --- .github/.trivyignore | 17 +- THIRD_PARTY_NOTICES.md | 4 +- newrelic/common/agent_http.py | 4 +- newrelic/packages/asgiref_compatibility.py | 14 +- newrelic/packages/requirements.txt | 6 +- newrelic/packages/urllib3/LICENSE.txt | 2 +- newrelic/packages/urllib3/__init__.py | 155 +- newrelic/packages/urllib3/_base_connection.py | 165 +++ newrelic/packages/urllib3/_collections.py | 422 ++++-- .../{request.py => _request_methods.py} | 187 ++- newrelic/packages/urllib3/_version.py | 36 +- newrelic/packages/urllib3/connection.py | 1175 ++++++++++----- newrelic/packages/urllib3/connectionpool.py | 779 +++++----- .../urllib3/contrib/_appengine_environ.py | 36 - .../contrib/_securetransport/__init__.py | 0 .../contrib/_securetransport/bindings.py | 519 ------- .../contrib/_securetransport/low_level.py | 397 ----- .../packages/urllib3/contrib/appengine.py | 314 ---- .../urllib3/contrib/emscripten/__init__.py | 17 + .../urllib3/contrib/emscripten/connection.py | 260 ++++ .../emscripten/emscripten_fetch_worker.js | 110 ++ .../urllib3/contrib/emscripten/fetch.py | 726 +++++++++ .../urllib3/contrib/emscripten/request.py | 22 + .../urllib3/contrib/emscripten/response.py | 277 ++++ newrelic/packages/urllib3/contrib/ntlmpool.py | 130 -- .../packages/urllib3/contrib/pyopenssl.py | 410 +++--- .../urllib3/contrib/securetransport.py | 920 ------------ newrelic/packages/urllib3/contrib/socks.py | 84 +- newrelic/packages/urllib3/exceptions.py | 208 +-- newrelic/packages/urllib3/fields.py | 257 ++-- newrelic/packages/urllib3/filepost.py | 65 +- newrelic/packages/urllib3/http2/__init__.py | 53 + newrelic/packages/urllib3/http2/connection.py | 356 +++++ newrelic/packages/urllib3/http2/probe.py | 87 ++ .../packages/urllib3/packages/__init__.py | 0 .../urllib3/packages/backports/__init__.py | 0 .../urllib3/packages/backports/makefile.py | 51 - .../packages/backports/weakref_finalize.py | 155 -- newrelic/packages/urllib3/packages/six.py | 1076 -------------- newrelic/packages/urllib3/poolmanager.py | 359 +++-- newrelic/packages/urllib3/py.typed | 2 + newrelic/packages/urllib3/response.py | 1295 ++++++++++++----- newrelic/packages/urllib3/util/__init__.py | 19 +- newrelic/packages/urllib3/util/connection.py | 80 +- newrelic/packages/urllib3/util/proxy.py | 38 +- newrelic/packages/urllib3/util/queue.py | 22 - newrelic/packages/urllib3/util/request.py | 177 ++- newrelic/packages/urllib3/util/response.py | 82 +- newrelic/packages/urllib3/util/retry.py | 375 ++--- newrelic/packages/urllib3/util/ssl_.py | 588 ++++---- .../urllib3/util/ssl_match_hostname.py | 96 +- .../packages/urllib3/util/ssltransport.py | 162 ++- newrelic/packages/urllib3/util/timeout.py | 118 +- newrelic/packages/urllib3/util/url.py | 394 ++--- newrelic/packages/urllib3/util/util.py | 42 + newrelic/packages/urllib3/util/wait.py | 90 +- newrelic/packages/wrapt/LICENSE | 2 +- newrelic/packages/wrapt/__init__.py | 3 +- newrelic/packages/wrapt/__init__.pyi | 8 +- newrelic/packages/wrapt/proxies.py | 83 +- pyproject.toml | 9 +- setup.py | 9 +- tests/testing_support/certs/cert.pem | 124 +- 63 files changed, 7064 insertions(+), 6609 deletions(-) create mode 100644 newrelic/packages/urllib3/_base_connection.py rename newrelic/packages/urllib3/{request.py => _request_methods.py} (50%) delete mode 100644 newrelic/packages/urllib3/contrib/_appengine_environ.py delete mode 100644 newrelic/packages/urllib3/contrib/_securetransport/__init__.py delete mode 100644 newrelic/packages/urllib3/contrib/_securetransport/bindings.py delete mode 100644 newrelic/packages/urllib3/contrib/_securetransport/low_level.py delete mode 100644 newrelic/packages/urllib3/contrib/appengine.py create mode 100644 newrelic/packages/urllib3/contrib/emscripten/__init__.py create mode 100644 newrelic/packages/urllib3/contrib/emscripten/connection.py create mode 100644 newrelic/packages/urllib3/contrib/emscripten/emscripten_fetch_worker.js create mode 100644 newrelic/packages/urllib3/contrib/emscripten/fetch.py create mode 100644 newrelic/packages/urllib3/contrib/emscripten/request.py create mode 100644 newrelic/packages/urllib3/contrib/emscripten/response.py delete mode 100644 newrelic/packages/urllib3/contrib/ntlmpool.py delete mode 100644 newrelic/packages/urllib3/contrib/securetransport.py create mode 100644 newrelic/packages/urllib3/http2/__init__.py create mode 100644 newrelic/packages/urllib3/http2/connection.py create mode 100644 newrelic/packages/urllib3/http2/probe.py delete mode 100644 newrelic/packages/urllib3/packages/__init__.py delete mode 100644 newrelic/packages/urllib3/packages/backports/__init__.py delete mode 100644 newrelic/packages/urllib3/packages/backports/makefile.py delete mode 100644 newrelic/packages/urllib3/packages/backports/weakref_finalize.py delete mode 100644 newrelic/packages/urllib3/packages/six.py create mode 100644 newrelic/packages/urllib3/py.typed delete mode 100644 newrelic/packages/urllib3/util/queue.py create mode 100644 newrelic/packages/urllib3/util/util.py diff --git a/.github/.trivyignore b/.github/.trivyignore index e9de2222cc..fd69f0b5d6 100644 --- a/.github/.trivyignore +++ b/.github/.trivyignore @@ -1,16 +1 @@ -# ============================= -# Accepted Risk Vulnerabilities -# ============================= - -# Accepting risk due to Python 3.8 support. -CVE-2025-50181 # Requires misconfiguration of urllib3, which agent does not do without intervention -CVE-2025-66418 # Malicious servers could cause high resource consumption -CVE-2025-66471 # Malicious servers could cause high resource consumption -CVE-2026-21441 # Improper Handling of Highly Compressed Data (Data Amplification) - -# ======================= -# Ignored Vulnerabilities -# ======================= - -# Not relevant, only affects Pyodide -CVE-2025-50182 +# Empty for now diff --git a/THIRD_PARTY_NOTICES.md b/THIRD_PARTY_NOTICES.md index 2aceaea9fa..312328b613 100644 --- a/THIRD_PARTY_NOTICES.md +++ b/THIRD_PARTY_NOTICES.md @@ -37,7 +37,7 @@ Distributed under the following license(s): ## [urllib3](https://pypi.org/project/urllib3) -Copyright (c) 2008-2019 Andrey Petrov and contributors (see CONTRIBUTORS.txt) +Copyright (c) 2008-2020 Andrey Petrov and contributors. Distributed under the following license(s): @@ -46,7 +46,7 @@ Distributed under the following license(s): ## [wrapt](https://pypi.org/project/wrapt) -Copyright (c) 2013-2019, Graham Dumpleton +Copyright (c) 2013-2025, Graham Dumpleton All rights reserved. Distributed under the following license(s): diff --git a/newrelic/common/agent_http.py b/newrelic/common/agent_http.py index 7f054cb3c7..4bca7437cd 100644 --- a/newrelic/common/agent_http.py +++ b/newrelic/common/agent_http.py @@ -354,9 +354,7 @@ def _connection(self): return self._connection_attr retries = urllib3.Retry(total=False, connect=None, read=None, redirect=0, status=None) - self._connection_attr = self.CONNECTION_CLS( - self._host, self._port, strict=True, retries=retries, **self._connection_kwargs - ) + self._connection_attr = self.CONNECTION_CLS(self._host, self._port, retries=retries, **self._connection_kwargs) return self._connection_attr def close_connection(self): diff --git a/newrelic/packages/asgiref_compatibility.py b/newrelic/packages/asgiref_compatibility.py index f5b029b1da..444fa52582 100644 --- a/newrelic/packages/asgiref_compatibility.py +++ b/newrelic/packages/asgiref_compatibility.py @@ -30,6 +30,16 @@ import inspect +# Python 3.12 deprecates asyncio.iscoroutinefunction() as an alias for +# inspect.iscoroutinefunction(), whilst also removing the _is_coroutine marker. +# The latter is replaced with the inspect.markcoroutinefunction decorator. +# Until 3.12 is the minimum supported Python version, provide a shim. + +if hasattr(inspect, "iscoroutinefunction"): + iscoroutinefunction = inspect.iscoroutinefunction +else: + iscoroutinefunction = asyncio.iscoroutinefunction # type: ignore[assignment] + def is_double_callable(application): """ Tests to see if an application is a legacy-style (double-callable) application. @@ -46,10 +56,10 @@ def is_double_callable(application): if hasattr(application, "__call__"): # We only check to see if its __call__ is a coroutine function - # if it's not, it still might be a coroutine function itself. - if asyncio.iscoroutinefunction(application.__call__): + if iscoroutinefunction(application.__call__): return False # Non-classes we just check directly - return not asyncio.iscoroutinefunction(application) + return not iscoroutinefunction(application) def double_to_single_callable(application): diff --git a/newrelic/packages/requirements.txt b/newrelic/packages/requirements.txt index b3820134f3..9a251fb557 100644 --- a/newrelic/packages/requirements.txt +++ b/newrelic/packages/requirements.txt @@ -3,6 +3,6 @@ # This file is used by dependabot to keep track of and recommend updates # to the New Relic Python Agent's dependencies in newrelic/packages/. opentelemetry_proto==1.32.1 -urllib3==1.26.19 -wrapt==2.0.0 -asgiref==3.6.0 # We only vendor asgiref.compatibility.py +urllib3==2.6.3 +wrapt==2.0.1 +asgiref==3.11.0 # We only vendor asgiref.compatibility.py diff --git a/newrelic/packages/urllib3/LICENSE.txt b/newrelic/packages/urllib3/LICENSE.txt index 429a1767e4..e6183d0276 100644 --- a/newrelic/packages/urllib3/LICENSE.txt +++ b/newrelic/packages/urllib3/LICENSE.txt @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2008-2020 Andrey Petrov and contributors (see CONTRIBUTORS.txt) +Copyright (c) 2008-2020 Andrey Petrov and contributors. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/newrelic/packages/urllib3/__init__.py b/newrelic/packages/urllib3/__init__.py index c6fa38212f..3fe782c8a4 100644 --- a/newrelic/packages/urllib3/__init__.py +++ b/newrelic/packages/urllib3/__init__.py @@ -1,40 +1,49 @@ """ Python HTTP library with thread-safe connection pooling, file post support, user friendly, and more """ -from __future__ import absolute_import + +from __future__ import annotations # Set default logging handler to avoid "No handler found" warnings. import logging +import sys +import typing import warnings from logging import NullHandler from . import exceptions +from ._base_connection import _TYPE_BODY +from ._collections import HTTPHeaderDict from ._version import __version__ from .connectionpool import HTTPConnectionPool, HTTPSConnectionPool, connection_from_url -from .filepost import encode_multipart_formdata +from .filepost import _TYPE_FIELDS, encode_multipart_formdata from .poolmanager import PoolManager, ProxyManager, proxy_from_url -from .response import HTTPResponse +from .response import BaseHTTPResponse, HTTPResponse from .util.request import make_headers from .util.retry import Retry from .util.timeout import Timeout -from .util.url import get_host -# === NOTE TO REPACKAGERS AND VENDORS === -# Please delete this block, this logic is only -# for urllib3 being distributed via PyPI. -# See: https://github.com/urllib3/urllib3/issues/2680 +# Ensure that Python is compiled with OpenSSL 1.1.1+ +# If the 'ssl' module isn't available at all that's +# fine, we only care if the module is available. try: - import urllib3_secure_extra # type: ignore # noqa: F401 + import ssl except ImportError: pass else: - warnings.warn( - "'urllib3[secure]' extra is deprecated and will be removed " - "in a future release of urllib3 2.x. Read more in this issue: " - "https://github.com/urllib3/urllib3/issues/2680", - category=DeprecationWarning, - stacklevel=2, - ) + if not ssl.OPENSSL_VERSION.startswith("OpenSSL "): # Defensive: + warnings.warn( + "urllib3 v2 only supports OpenSSL 1.1.1+, currently " + f"the 'ssl' module is compiled with {ssl.OPENSSL_VERSION!r}. " + "See: https://github.com/urllib3/urllib3/issues/3020", + exceptions.NotOpenSSLWarning, + ) + elif ssl.OPENSSL_VERSION_INFO < (1, 1, 1): # Defensive: + raise ImportError( + "urllib3 v2 only supports OpenSSL 1.1.1+, currently " + f"the 'ssl' module is compiled with {ssl.OPENSSL_VERSION!r}. " + "See: https://github.com/urllib3/urllib3/issues/2168" + ) __author__ = "Andrey Petrov (andrey.petrov@shazow.net)" __license__ = "MIT" @@ -42,6 +51,7 @@ __all__ = ( "HTTPConnectionPool", + "HTTPHeaderDict", "HTTPSConnectionPool", "PoolManager", "ProxyManager", @@ -52,15 +62,18 @@ "connection_from_url", "disable_warnings", "encode_multipart_formdata", - "get_host", "make_headers", "proxy_from_url", + "request", + "BaseHTTPResponse", ) logging.getLogger(__name__).addHandler(NullHandler()) -def add_stderr_logger(level=logging.DEBUG): +def add_stderr_logger( + level: int = logging.DEBUG, +) -> logging.StreamHandler[typing.TextIO]: """ Helper for quickly adding a StreamHandler to the logger. Useful for debugging. @@ -87,16 +100,112 @@ def add_stderr_logger(level=logging.DEBUG): # mechanisms to silence them. # SecurityWarning's always go off by default. warnings.simplefilter("always", exceptions.SecurityWarning, append=True) -# SubjectAltNameWarning's should go off once per host -warnings.simplefilter("default", exceptions.SubjectAltNameWarning, append=True) # InsecurePlatformWarning's don't vary between requests, so we keep it default. warnings.simplefilter("default", exceptions.InsecurePlatformWarning, append=True) -# SNIMissingWarnings should go off only once. -warnings.simplefilter("default", exceptions.SNIMissingWarning, append=True) -def disable_warnings(category=exceptions.HTTPWarning): +def disable_warnings(category: type[Warning] = exceptions.HTTPWarning) -> None: """ Helper for quickly disabling all urllib3 warnings. """ warnings.simplefilter("ignore", category) + + +_DEFAULT_POOL = PoolManager() + + +def request( + method: str, + url: str, + *, + body: _TYPE_BODY | None = None, + fields: _TYPE_FIELDS | None = None, + headers: typing.Mapping[str, str] | None = None, + preload_content: bool | None = True, + decode_content: bool | None = True, + redirect: bool | None = True, + retries: Retry | bool | int | None = None, + timeout: Timeout | float | int | None = 3, + json: typing.Any | None = None, +) -> BaseHTTPResponse: + """ + A convenience, top-level request method. It uses a module-global ``PoolManager`` instance. + Therefore, its side effects could be shared across dependencies relying on it. + To avoid side effects create a new ``PoolManager`` instance and use it instead. + The method does not accept low-level ``**urlopen_kw`` keyword arguments. + + :param method: + HTTP request method (such as GET, POST, PUT, etc.) + + :param url: + The URL to perform the request on. + + :param body: + Data to send in the request body, either :class:`str`, :class:`bytes`, + an iterable of :class:`str`/:class:`bytes`, or a file-like object. + + :param fields: + Data to encode and send in the request body. + + :param headers: + Dictionary of custom headers to send, such as User-Agent, + If-None-Match, etc. + + :param bool preload_content: + If True, the response's body will be preloaded into memory. + + :param bool decode_content: + If True, will attempt to decode the body based on the + 'content-encoding' header. + + :param redirect: + If True, automatically handle redirects (status codes 301, 302, + 303, 307, 308). Each redirect counts as a retry. Disabling retries + will disable redirect, too. + + :param retries: + Configure the number of retries to allow before raising a + :class:`~urllib3.exceptions.MaxRetryError` exception. + + If ``None`` (default) will retry 3 times, see ``Retry.DEFAULT``. Pass a + :class:`~urllib3.util.retry.Retry` object for fine-grained control + over different types of retries. + Pass an integer number to retry connection errors that many times, + but no other types of errors. Pass zero to never retry. + + If ``False``, then retries are disabled and any exception is raised + immediately. Also, instead of raising a MaxRetryError on redirects, + the redirect response will be returned. + + :type retries: :class:`~urllib3.util.retry.Retry`, False, or an int. + + :param timeout: + If specified, overrides the default timeout for this one + request. It may be a float (in seconds) or an instance of + :class:`urllib3.util.Timeout`. + + :param json: + Data to encode and send as JSON with UTF-encoded in the request body. + The ``"Content-Type"`` header will be set to ``"application/json"`` + unless specified otherwise. + """ + + return _DEFAULT_POOL.request( + method, + url, + body=body, + fields=fields, + headers=headers, + preload_content=preload_content, + decode_content=decode_content, + redirect=redirect, + retries=retries, + timeout=timeout, + json=json, + ) + + +if sys.platform == "emscripten": + from .contrib.emscripten import inject_into_urllib3 # noqa: 401 + + inject_into_urllib3() diff --git a/newrelic/packages/urllib3/_base_connection.py b/newrelic/packages/urllib3/_base_connection.py new file mode 100644 index 0000000000..dc0f318c0b --- /dev/null +++ b/newrelic/packages/urllib3/_base_connection.py @@ -0,0 +1,165 @@ +from __future__ import annotations + +import typing + +from .util.connection import _TYPE_SOCKET_OPTIONS +from .util.timeout import _DEFAULT_TIMEOUT, _TYPE_TIMEOUT +from .util.url import Url + +_TYPE_BODY = typing.Union[bytes, typing.IO[typing.Any], typing.Iterable[bytes], str] + + +class ProxyConfig(typing.NamedTuple): + ssl_context: ssl.SSLContext | None + use_forwarding_for_https: bool + assert_hostname: None | str | typing.Literal[False] + assert_fingerprint: str | None + + +class _ResponseOptions(typing.NamedTuple): + # TODO: Remove this in favor of a better + # HTTP request/response lifecycle tracking. + request_method: str + request_url: str + preload_content: bool + decode_content: bool + enforce_content_length: bool + + +if typing.TYPE_CHECKING: + import ssl + from typing import Protocol + + from .response import BaseHTTPResponse + + class BaseHTTPConnection(Protocol): + default_port: typing.ClassVar[int] + default_socket_options: typing.ClassVar[_TYPE_SOCKET_OPTIONS] + + host: str + port: int + timeout: None | ( + float + ) # Instance doesn't store _DEFAULT_TIMEOUT, must be resolved. + blocksize: int + source_address: tuple[str, int] | None + socket_options: _TYPE_SOCKET_OPTIONS | None + + proxy: Url | None + proxy_config: ProxyConfig | None + + is_verified: bool + proxy_is_verified: bool | None + + def __init__( + self, + host: str, + port: int | None = None, + *, + timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, + source_address: tuple[str, int] | None = None, + blocksize: int = 8192, + socket_options: _TYPE_SOCKET_OPTIONS | None = ..., + proxy: Url | None = None, + proxy_config: ProxyConfig | None = None, + ) -> None: ... + + def set_tunnel( + self, + host: str, + port: int | None = None, + headers: typing.Mapping[str, str] | None = None, + scheme: str = "http", + ) -> None: ... + + def connect(self) -> None: ... + + def request( + self, + method: str, + url: str, + body: _TYPE_BODY | None = None, + headers: typing.Mapping[str, str] | None = None, + # We know *at least* botocore is depending on the order of the + # first 3 parameters so to be safe we only mark the later ones + # as keyword-only to ensure we have space to extend. + *, + chunked: bool = False, + preload_content: bool = True, + decode_content: bool = True, + enforce_content_length: bool = True, + ) -> None: ... + + def getresponse(self) -> BaseHTTPResponse: ... + + def close(self) -> None: ... + + @property + def is_closed(self) -> bool: + """Whether the connection either is brand new or has been previously closed. + If this property is True then both ``is_connected`` and ``has_connected_to_proxy`` + properties must be False. + """ + + @property + def is_connected(self) -> bool: + """Whether the connection is actively connected to any origin (proxy or target)""" + + @property + def has_connected_to_proxy(self) -> bool: + """Whether the connection has successfully connected to its proxy. + This returns False if no proxy is in use. Used to determine whether + errors are coming from the proxy layer or from tunnelling to the target origin. + """ + + class BaseHTTPSConnection(BaseHTTPConnection, Protocol): + default_port: typing.ClassVar[int] + default_socket_options: typing.ClassVar[_TYPE_SOCKET_OPTIONS] + + # Certificate verification methods + cert_reqs: int | str | None + assert_hostname: None | str | typing.Literal[False] + assert_fingerprint: str | None + ssl_context: ssl.SSLContext | None + + # Trusted CAs + ca_certs: str | None + ca_cert_dir: str | None + ca_cert_data: None | str | bytes + + # TLS version + ssl_minimum_version: int | None + ssl_maximum_version: int | None + ssl_version: int | str | None # Deprecated + + # Client certificates + cert_file: str | None + key_file: str | None + key_password: str | None + + def __init__( + self, + host: str, + port: int | None = None, + *, + timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, + source_address: tuple[str, int] | None = None, + blocksize: int = 16384, + socket_options: _TYPE_SOCKET_OPTIONS | None = ..., + proxy: Url | None = None, + proxy_config: ProxyConfig | None = None, + cert_reqs: int | str | None = None, + assert_hostname: None | str | typing.Literal[False] = None, + assert_fingerprint: str | None = None, + server_hostname: str | None = None, + ssl_context: ssl.SSLContext | None = None, + ca_certs: str | None = None, + ca_cert_dir: str | None = None, + ca_cert_data: None | str | bytes = None, + ssl_minimum_version: int | None = None, + ssl_maximum_version: int | None = None, + ssl_version: int | str | None = None, # Deprecated + cert_file: str | None = None, + key_file: str | None = None, + key_password: str | None = None, + ) -> None: ... diff --git a/newrelic/packages/urllib3/_collections.py b/newrelic/packages/urllib3/_collections.py index bceb8451f0..0378aab1b1 100644 --- a/newrelic/packages/urllib3/_collections.py +++ b/newrelic/packages/urllib3/_collections.py @@ -1,34 +1,66 @@ -from __future__ import absolute_import - -try: - from collections.abc import Mapping, MutableMapping -except ImportError: - from collections import Mapping, MutableMapping -try: - from threading import RLock -except ImportError: # Platform-specific: No threads available - - class RLock: - def __enter__(self): - pass +from __future__ import annotations - def __exit__(self, exc_type, exc_value, traceback): - pass +import typing +from collections import OrderedDict +from enum import Enum, auto +from threading import RLock +if typing.TYPE_CHECKING: + # We can only import Protocol if TYPE_CHECKING because it's a development + # dependency, and is not available at runtime. + from typing import Protocol -from collections import OrderedDict + from typing_extensions import Self -from .exceptions import InvalidHeader -from .packages import six -from .packages.six import iterkeys, itervalues + class HasGettableStringKeys(Protocol): + def keys(self) -> typing.Iterator[str]: ... -__all__ = ["RecentlyUsedContainer", "HTTPHeaderDict"] + def __getitem__(self, key: str) -> str: ... -_Null = object() +__all__ = ["RecentlyUsedContainer", "HTTPHeaderDict"] -class RecentlyUsedContainer(MutableMapping): +# Key type +_KT = typing.TypeVar("_KT") +# Value type +_VT = typing.TypeVar("_VT") +# Default type +_DT = typing.TypeVar("_DT") + +ValidHTTPHeaderSource = typing.Union[ + "HTTPHeaderDict", + typing.Mapping[str, str], + typing.Iterable[tuple[str, str]], + "HasGettableStringKeys", +] + + +class _Sentinel(Enum): + not_passed = auto() + + +def ensure_can_construct_http_header_dict( + potential: object, +) -> ValidHTTPHeaderSource | None: + if isinstance(potential, HTTPHeaderDict): + return potential + elif isinstance(potential, typing.Mapping): + # Full runtime checking of the contents of a Mapping is expensive, so for the + # purposes of typechecking, we assume that any Mapping is the right shape. + return typing.cast(typing.Mapping[str, str], potential) + elif isinstance(potential, typing.Iterable): + # Similarly to Mapping, full runtime checking of the contents of an Iterable is + # expensive, so for the purposes of typechecking, we assume that any Iterable + # is the right shape. + return typing.cast(typing.Iterable[tuple[str, str]], potential) + elif hasattr(potential, "keys") and hasattr(potential, "__getitem__"): + return typing.cast("HasGettableStringKeys", potential) + else: + return None + + +class RecentlyUsedContainer(typing.Generic[_KT, _VT], typing.MutableMapping[_KT, _VT]): """ Provides a thread-safe dict-like container which maintains up to ``maxsize`` keys while throwing away the least-recently-used keys beyond @@ -42,69 +74,134 @@ class RecentlyUsedContainer(MutableMapping): ``dispose_func(value)`` is called. Callback which will get called """ - ContainerCls = OrderedDict - - def __init__(self, maxsize=10, dispose_func=None): + _container: typing.OrderedDict[_KT, _VT] + _maxsize: int + dispose_func: typing.Callable[[_VT], None] | None + lock: RLock + + def __init__( + self, + maxsize: int = 10, + dispose_func: typing.Callable[[_VT], None] | None = None, + ) -> None: + super().__init__() self._maxsize = maxsize self.dispose_func = dispose_func - - self._container = self.ContainerCls() + self._container = OrderedDict() self.lock = RLock() - def __getitem__(self, key): + def __getitem__(self, key: _KT) -> _VT: # Re-insert the item, moving it to the end of the eviction line. with self.lock: item = self._container.pop(key) self._container[key] = item return item - def __setitem__(self, key, value): - evicted_value = _Null + def __setitem__(self, key: _KT, value: _VT) -> None: + evicted_item = None with self.lock: # Possibly evict the existing value of 'key' - evicted_value = self._container.get(key, _Null) - self._container[key] = value - - # If we didn't evict an existing value, we might have to evict the - # least recently used item from the beginning of the container. - if len(self._container) > self._maxsize: - _key, evicted_value = self._container.popitem(last=False) - - if self.dispose_func and evicted_value is not _Null: + try: + # If the key exists, we'll overwrite it, which won't change the + # size of the pool. Because accessing a key should move it to + # the end of the eviction line, we pop it out first. + evicted_item = key, self._container.pop(key) + self._container[key] = value + except KeyError: + # When the key does not exist, we insert the value first so that + # evicting works in all cases, including when self._maxsize is 0 + self._container[key] = value + if len(self._container) > self._maxsize: + # If we didn't evict an existing value, and we've hit our maximum + # size, then we have to evict the least recently used item from + # the beginning of the container. + evicted_item = self._container.popitem(last=False) + + # After releasing the lock on the pool, dispose of any evicted value. + if evicted_item is not None and self.dispose_func: + _, evicted_value = evicted_item self.dispose_func(evicted_value) - def __delitem__(self, key): + def __delitem__(self, key: _KT) -> None: with self.lock: value = self._container.pop(key) if self.dispose_func: self.dispose_func(value) - def __len__(self): + def __len__(self) -> int: with self.lock: return len(self._container) - def __iter__(self): + def __iter__(self) -> typing.NoReturn: raise NotImplementedError( "Iteration over this class is unlikely to be threadsafe." ) - def clear(self): + def clear(self) -> None: with self.lock: # Copy pointers to all values, then wipe the mapping - values = list(itervalues(self._container)) + values = list(self._container.values()) self._container.clear() if self.dispose_func: for value in values: self.dispose_func(value) - def keys(self): + def keys(self) -> set[_KT]: # type: ignore[override] with self.lock: - return list(iterkeys(self._container)) + return set(self._container.keys()) + +class HTTPHeaderDictItemView(set[tuple[str, str]]): + """ + HTTPHeaderDict is unusual for a Mapping[str, str] in that it has two modes of + address. + + If we directly try to get an item with a particular name, we will get a string + back that is the concatenated version of all the values: + + >>> d['X-Header-Name'] + 'Value1, Value2, Value3' + + However, if we iterate over an HTTPHeaderDict's items, we will optionally combine + these values based on whether combine=True was called when building up the dictionary + + >>> d = HTTPHeaderDict({"A": "1", "B": "foo"}) + >>> d.add("A", "2", combine=True) + >>> d.add("B", "bar") + >>> list(d.items()) + [ + ('A', '1, 2'), + ('B', 'foo'), + ('B', 'bar'), + ] + + This class conforms to the interface required by the MutableMapping ABC while + also giving us the nonstandard iteration behavior we want; items with duplicate + keys, ordered by time of first insertion. + """ + + _headers: HTTPHeaderDict + + def __init__(self, headers: HTTPHeaderDict) -> None: + self._headers = headers + + def __len__(self) -> int: + return len(list(self._headers.iteritems())) + + def __iter__(self) -> typing.Iterator[tuple[str, str]]: + return self._headers.iteritems() -class HTTPHeaderDict(MutableMapping): + def __contains__(self, item: object) -> bool: + if isinstance(item, tuple) and len(item) == 2: + passed_key, passed_val = item + if isinstance(passed_key, str) and isinstance(passed_val, str): + return self._headers._has_value_for_header(passed_key, passed_val) + return False + + +class HTTPHeaderDict(typing.MutableMapping[str, str]): """ :param headers: An iterable of field-value pairs. Must not contain multiple field names @@ -138,9 +235,11 @@ class HTTPHeaderDict(MutableMapping): '7' """ - def __init__(self, headers=None, **kwargs): - super(HTTPHeaderDict, self).__init__() - self._container = OrderedDict() + _container: typing.MutableMapping[str, list[str]] + + def __init__(self, headers: ValidHTTPHeaderSource | None = None, **kwargs: str): + super().__init__() + self._container = {} # 'dict' is insert-ordered if headers is not None: if isinstance(headers, HTTPHeaderDict): self._copy_from(headers) @@ -149,126 +248,156 @@ def __init__(self, headers=None, **kwargs): if kwargs: self.extend(kwargs) - def __setitem__(self, key, val): + def __setitem__(self, key: str, val: str) -> None: + # avoid a bytes/str comparison by decoding before httplib + if isinstance(key, bytes): + key = key.decode("latin-1") self._container[key.lower()] = [key, val] - return self._container[key.lower()] - def __getitem__(self, key): + def __getitem__(self, key: str) -> str: + if isinstance(key, bytes): + key = key.decode("latin-1") val = self._container[key.lower()] return ", ".join(val[1:]) - def __delitem__(self, key): + def __delitem__(self, key: str) -> None: + if isinstance(key, bytes): + key = key.decode("latin-1") del self._container[key.lower()] - def __contains__(self, key): - return key.lower() in self._container + def __contains__(self, key: object) -> bool: + if isinstance(key, bytes): + key = key.decode("latin-1") + if isinstance(key, str): + return key.lower() in self._container + return False - def __eq__(self, other): - if not isinstance(other, Mapping) and not hasattr(other, "keys"): - return False - if not isinstance(other, type(self)): - other = type(self)(other) - return dict((k.lower(), v) for k, v in self.itermerged()) == dict( - (k.lower(), v) for k, v in other.itermerged() - ) + def setdefault(self, key: str, default: str = "") -> str: + return super().setdefault(key, default) - def __ne__(self, other): - return not self.__eq__(other) + def __eq__(self, other: object) -> bool: + maybe_constructable = ensure_can_construct_http_header_dict(other) + if maybe_constructable is None: + return False + else: + other_as_http_header_dict = type(self)(maybe_constructable) - if six.PY2: # Python 2 - iterkeys = MutableMapping.iterkeys - itervalues = MutableMapping.itervalues + return {k.lower(): v for k, v in self.itermerged()} == { + k.lower(): v for k, v in other_as_http_header_dict.itermerged() + } - __marker = object() + def __ne__(self, other: object) -> bool: + return not self.__eq__(other) - def __len__(self): + def __len__(self) -> int: return len(self._container) - def __iter__(self): + def __iter__(self) -> typing.Iterator[str]: # Only provide the originally cased names for vals in self._container.values(): yield vals[0] - def pop(self, key, default=__marker): - """D.pop(k[,d]) -> v, remove specified key and return the corresponding value. - If key is not found, d is returned if given, otherwise KeyError is raised. - """ - # Using the MutableMapping function directly fails due to the private marker. - # Using ordinary dict.pop would expose the internal structures. - # So let's reinvent the wheel. - try: - value = self[key] - except KeyError: - if default is self.__marker: - raise - return default - else: - del self[key] - return value - - def discard(self, key): + def discard(self, key: str) -> None: try: del self[key] except KeyError: pass - def add(self, key, val): + def add(self, key: str, val: str, *, combine: bool = False) -> None: """Adds a (name, value) pair, doesn't overwrite the value if it already exists. + If this is called with combine=True, instead of adding a new header value + as a distinct item during iteration, this will instead append the value to + any existing header value with a comma. If no existing header value exists + for the key, then the value will simply be added, ignoring the combine parameter. + >>> headers = HTTPHeaderDict(foo='bar') >>> headers.add('Foo', 'baz') >>> headers['foo'] 'bar, baz' + >>> list(headers.items()) + [('foo', 'bar'), ('foo', 'baz')] + >>> headers.add('foo', 'quz', combine=True) + >>> list(headers.items()) + [('foo', 'bar, baz, quz')] """ + # avoid a bytes/str comparison by decoding before httplib + if isinstance(key, bytes): + key = key.decode("latin-1") key_lower = key.lower() new_vals = [key, val] # Keep the common case aka no item present as fast as possible vals = self._container.setdefault(key_lower, new_vals) if new_vals is not vals: - vals.append(val) + # if there are values here, then there is at least the initial + # key/value pair + assert len(vals) >= 2 + if combine: + vals[-1] = vals[-1] + ", " + val + else: + vals.append(val) - def extend(self, *args, **kwargs): + def extend(self, *args: ValidHTTPHeaderSource, **kwargs: str) -> None: """Generic import function for any type of header-like object. Adapted version of MutableMapping.update in order to insert items with self.add instead of self.__setitem__ """ if len(args) > 1: raise TypeError( - "extend() takes at most 1 positional " - "arguments ({0} given)".format(len(args)) + f"extend() takes at most 1 positional arguments ({len(args)} given)" ) other = args[0] if len(args) >= 1 else () if isinstance(other, HTTPHeaderDict): for key, val in other.iteritems(): self.add(key, val) - elif isinstance(other, Mapping): - for key in other: - self.add(key, other[key]) - elif hasattr(other, "keys"): - for key in other.keys(): - self.add(key, other[key]) - else: + elif isinstance(other, typing.Mapping): + for key, val in other.items(): + self.add(key, val) + elif isinstance(other, typing.Iterable): + other = typing.cast(typing.Iterable[tuple[str, str]], other) for key, value in other: self.add(key, value) + elif hasattr(other, "keys") and hasattr(other, "__getitem__"): + # THIS IS NOT A TYPESAFE BRANCH + # In this branch, the object has a `keys` attr but is not a Mapping or any of + # the other types indicated in the method signature. We do some stuff with + # it as though it partially implements the Mapping interface, but we're not + # doing that stuff safely AT ALL. + for key in other.keys(): + self.add(key, other[key]) for key, value in kwargs.items(): self.add(key, value) - def getlist(self, key, default=__marker): + @typing.overload + def getlist(self, key: str) -> list[str]: ... + + @typing.overload + def getlist(self, key: str, default: _DT) -> list[str] | _DT: ... + + def getlist( + self, key: str, default: _Sentinel | _DT = _Sentinel.not_passed + ) -> list[str] | _DT: """Returns a list of all the values for the named field. Returns an empty list if the key doesn't exist.""" + if isinstance(key, bytes): + key = key.decode("latin-1") try: vals = self._container[key.lower()] except KeyError: - if default is self.__marker: + if default is _Sentinel.not_passed: + # _DT is unbound; empty list is instance of List[str] return [] + # _DT is bound; default is instance of _DT return default else: + # _DT may or may not be bound; vals[1:] is instance of List[str], which + # meets our external interface requirement of `Union[List[str], _DT]`. return vals[1:] - def _prepare_for_method_change(self): + def _prepare_for_method_change(self) -> Self: """ Remove content-specific header fields before changing the request method to GET or HEAD according to RFC 9110, Section 15.4. @@ -294,62 +423,65 @@ def _prepare_for_method_change(self): # Backwards compatibility for http.cookiejar get_all = getlist - def __repr__(self): - return "%s(%s)" % (type(self).__name__, dict(self.itermerged())) + def __repr__(self) -> str: + return f"{type(self).__name__}({dict(self.itermerged())})" - def _copy_from(self, other): + def _copy_from(self, other: HTTPHeaderDict) -> None: for key in other: val = other.getlist(key) - if isinstance(val, list): - # Don't need to convert tuples - val = list(val) - self._container[key.lower()] = [key] + val + self._container[key.lower()] = [key, *val] - def copy(self): + def copy(self) -> Self: clone = type(self)() clone._copy_from(self) return clone - def iteritems(self): + def iteritems(self) -> typing.Iterator[tuple[str, str]]: """Iterate over all header lines, including duplicate ones.""" for key in self: vals = self._container[key.lower()] for val in vals[1:]: yield vals[0], val - def itermerged(self): + def itermerged(self) -> typing.Iterator[tuple[str, str]]: """Iterate over all headers, merging duplicate ones together.""" for key in self: val = self._container[key.lower()] yield val[0], ", ".join(val[1:]) - def items(self): - return list(self.iteritems()) - - @classmethod - def from_httplib(cls, message): # Python 2 - """Read headers from a Python 2 httplib message object.""" - # python2.7 does not expose a proper API for exporting multiheaders - # efficiently. This function re-reads raw lines from the message - # object and extracts the multiheaders properly. - obs_fold_continued_leaders = (" ", "\t") - headers = [] - - for line in message.headers: - if line.startswith(obs_fold_continued_leaders): - if not headers: - # We received a header line that starts with OWS as described - # in RFC-7230 S3.2.4. This indicates a multiline header, but - # there exists no previous header to which we can attach it. - raise InvalidHeader( - "Header continuation with no previous header: %s" % line - ) - else: - key, value = headers[-1] - headers[-1] = (key, value + " " + line.strip()) - continue - - key, value = line.split(":", 1) - headers.append((key, value.strip())) - - return cls(headers) + def items(self) -> HTTPHeaderDictItemView: # type: ignore[override] + return HTTPHeaderDictItemView(self) + + def _has_value_for_header(self, header_name: str, potential_value: str) -> bool: + if header_name in self: + return potential_value in self._container[header_name.lower()][1:] + return False + + def __ior__(self, other: object) -> HTTPHeaderDict: + # Supports extending a header dict in-place using operator |= + # combining items with add instead of __setitem__ + maybe_constructable = ensure_can_construct_http_header_dict(other) + if maybe_constructable is None: + return NotImplemented + self.extend(maybe_constructable) + return self + + def __or__(self, other: object) -> Self: + # Supports merging header dicts using operator | + # combining items with add instead of __setitem__ + maybe_constructable = ensure_can_construct_http_header_dict(other) + if maybe_constructable is None: + return NotImplemented + result = self.copy() + result.extend(maybe_constructable) + return result + + def __ror__(self, other: object) -> Self: + # Supports merging header dicts using operator | when other is on left side + # combining items with add instead of __setitem__ + maybe_constructable = ensure_can_construct_http_header_dict(other) + if maybe_constructable is None: + return NotImplemented + result = type(self)(maybe_constructable) + result.extend(self) + return result diff --git a/newrelic/packages/urllib3/request.py b/newrelic/packages/urllib3/_request_methods.py similarity index 50% rename from newrelic/packages/urllib3/request.py rename to newrelic/packages/urllib3/_request_methods.py index 3b4cf99922..297c271bf4 100644 --- a/newrelic/packages/urllib3/request.py +++ b/newrelic/packages/urllib3/_request_methods.py @@ -1,15 +1,23 @@ -from __future__ import absolute_import +from __future__ import annotations -import sys +import json as _json +import typing +from urllib.parse import urlencode -from .filepost import encode_multipart_formdata -from .packages import six -from .packages.six.moves.urllib.parse import urlencode +from ._base_connection import _TYPE_BODY +from ._collections import HTTPHeaderDict +from .filepost import _TYPE_FIELDS, encode_multipart_formdata +from .response import BaseHTTPResponse __all__ = ["RequestMethods"] +_TYPE_ENCODE_URL_FIELDS = typing.Union[ + typing.Sequence[tuple[str, typing.Union[str, bytes]]], + typing.Mapping[str, typing.Union[str, bytes]], +] -class RequestMethods(object): + +class RequestMethods: """ Convenience mixin for classes who implement a :meth:`urlopen` method, such as :class:`urllib3.HTTPConnectionPool` and @@ -40,25 +48,34 @@ class RequestMethods(object): _encode_url_methods = {"DELETE", "GET", "HEAD", "OPTIONS"} - def __init__(self, headers=None): + def __init__(self, headers: typing.Mapping[str, str] | None = None) -> None: self.headers = headers or {} def urlopen( self, - method, - url, - body=None, - headers=None, - encode_multipart=True, - multipart_boundary=None, - **kw - ): # Abstract + method: str, + url: str, + body: _TYPE_BODY | None = None, + headers: typing.Mapping[str, str] | None = None, + encode_multipart: bool = True, + multipart_boundary: str | None = None, + **kw: typing.Any, + ) -> BaseHTTPResponse: # Abstract raise NotImplementedError( "Classes extending RequestMethods must implement " "their own ``urlopen`` method." ) - def request(self, method, url, fields=None, headers=None, **urlopen_kw): + def request( + self, + method: str, + url: str, + body: _TYPE_BODY | None = None, + fields: _TYPE_FIELDS | None = None, + headers: typing.Mapping[str, str] | None = None, + json: typing.Any | None = None, + **urlopen_kw: typing.Any, + ) -> BaseHTTPResponse: """ Make a request using :meth:`urlopen` with the appropriate encoding of ``fields`` based on the ``method`` used. @@ -68,29 +85,95 @@ def request(self, method, url, fields=None, headers=None, **urlopen_kw): option to drop down to more specific methods when necessary, such as :meth:`request_encode_url`, :meth:`request_encode_body`, or even the lowest level :meth:`urlopen`. + + :param method: + HTTP request method (such as GET, POST, PUT, etc.) + + :param url: + The URL to perform the request on. + + :param body: + Data to send in the request body, either :class:`str`, :class:`bytes`, + an iterable of :class:`str`/:class:`bytes`, or a file-like object. + + :param fields: + Data to encode and send in the URL or request body, depending on ``method``. + + :param headers: + Dictionary of custom headers to send, such as User-Agent, + If-None-Match, etc. If None, pool headers are used. If provided, + these headers completely replace any pool-specific headers. + + :param json: + Data to encode and send as JSON with UTF-encoded in the request body. + The ``"Content-Type"`` header will be set to ``"application/json"`` + unless specified otherwise. """ method = method.upper() - urlopen_kw["request_url"] = url + if json is not None and body is not None: + raise TypeError( + "request got values for both 'body' and 'json' parameters which are mutually exclusive" + ) + + if json is not None: + if headers is None: + headers = self.headers + + if not ("content-type" in map(str.lower, headers.keys())): + headers = HTTPHeaderDict(headers) + headers["Content-Type"] = "application/json" + + body = _json.dumps(json, separators=(",", ":"), ensure_ascii=False).encode( + "utf-8" + ) + + if body is not None: + urlopen_kw["body"] = body if method in self._encode_url_methods: return self.request_encode_url( - method, url, fields=fields, headers=headers, **urlopen_kw + method, + url, + fields=fields, # type: ignore[arg-type] + headers=headers, + **urlopen_kw, ) else: return self.request_encode_body( method, url, fields=fields, headers=headers, **urlopen_kw ) - def request_encode_url(self, method, url, fields=None, headers=None, **urlopen_kw): + def request_encode_url( + self, + method: str, + url: str, + fields: _TYPE_ENCODE_URL_FIELDS | None = None, + headers: typing.Mapping[str, str] | None = None, + **urlopen_kw: str, + ) -> BaseHTTPResponse: """ Make a request using :meth:`urlopen` with the ``fields`` encoded in the url. This is useful for request methods like GET, HEAD, DELETE, etc. + + :param method: + HTTP request method (such as GET, POST, PUT, etc.) + + :param url: + The URL to perform the request on. + + :param fields: + Data to encode and send in the URL. + + :param headers: + Dictionary of custom headers to send, such as User-Agent, + If-None-Match, etc. If None, pool headers are used. If provided, + these headers completely replace any pool-specific headers. """ if headers is None: headers = self.headers - extra_kw = {"headers": headers} + extra_kw: dict[str, typing.Any] = {"headers": headers} extra_kw.update(urlopen_kw) if fields: @@ -100,14 +183,14 @@ def request_encode_url(self, method, url, fields=None, headers=None, **urlopen_k def request_encode_body( self, - method, - url, - fields=None, - headers=None, - encode_multipart=True, - multipart_boundary=None, - **urlopen_kw - ): + method: str, + url: str, + fields: _TYPE_FIELDS | None = None, + headers: typing.Mapping[str, str] | None = None, + encode_multipart: bool = True, + multipart_boundary: str | None = None, + **urlopen_kw: str, + ) -> BaseHTTPResponse: """ Make a request using :meth:`urlopen` with the ``fields`` encoded in the body. This is useful for request methods like POST, PUT, PATCH, etc. @@ -142,11 +225,34 @@ def request_encode_body( be overwritten because it depends on the dynamic random boundary string which is used to compose the body of the request. The random boundary string can be explicitly set with the ``multipart_boundary`` parameter. + + :param method: + HTTP request method (such as GET, POST, PUT, etc.) + + :param url: + The URL to perform the request on. + + :param fields: + Data to encode and send in the request body. + + :param headers: + Dictionary of custom headers to send, such as User-Agent, + If-None-Match, etc. If None, pool headers are used. If provided, + these headers completely replace any pool-specific headers. + + :param encode_multipart: + If True, encode the ``fields`` using the multipart/form-data MIME + format. + + :param multipart_boundary: + If not specified, then a random boundary will be generated using + :func:`urllib3.filepost.choose_boundary`. """ if headers is None: headers = self.headers - extra_kw = {"headers": {}} + extra_kw: dict[str, typing.Any] = {"headers": HTTPHeaderDict(headers)} + body: bytes | str if fields: if "body" in urlopen_kw: @@ -160,32 +266,13 @@ def request_encode_body( ) else: body, content_type = ( - urlencode(fields), + urlencode(fields), # type: ignore[arg-type] "application/x-www-form-urlencoded", ) extra_kw["body"] = body - extra_kw["headers"] = {"Content-Type": content_type} + extra_kw["headers"].setdefault("Content-Type", content_type) - extra_kw["headers"].update(headers) extra_kw.update(urlopen_kw) return self.urlopen(method, url, **extra_kw) - - -if not six.PY2: - - class RequestModule(sys.modules[__name__].__class__): - def __call__(self, *args, **kwargs): - """ - If user tries to call this module directly urllib3 v2.x style raise an error to the user - suggesting they may need urllib3 v2 - """ - raise TypeError( - "'module' object is not callable\n" - "urllib3.request() method is not supported in this release, " - "upgrade to urllib3 v2 to use it\n" - "see https://urllib3.readthedocs.io/en/stable/v2-migration-guide.html" - ) - - sys.modules[__name__].__class__ = RequestModule diff --git a/newrelic/packages/urllib3/_version.py b/newrelic/packages/urllib3/_version.py index c40db86d0a..268d3b984d 100644 --- a/newrelic/packages/urllib3/_version.py +++ b/newrelic/packages/urllib3/_version.py @@ -1,2 +1,34 @@ -# This file is protected via CODEOWNERS -__version__ = "1.26.19" +# file generated by setuptools-scm +# don't change, don't track in version control + +__all__ = [ + "__version__", + "__version_tuple__", + "version", + "version_tuple", + "__commit_id__", + "commit_id", +] + +TYPE_CHECKING = False +if TYPE_CHECKING: + from typing import Tuple + from typing import Union + + VERSION_TUPLE = Tuple[Union[int, str], ...] + COMMIT_ID = Union[str, None] +else: + VERSION_TUPLE = object + COMMIT_ID = object + +version: str +__version__: str +__version_tuple__: VERSION_TUPLE +version_tuple: VERSION_TUPLE +commit_id: COMMIT_ID +__commit_id__: COMMIT_ID + +__version__ = version = '2.6.3' +__version_tuple__ = version_tuple = (2, 6, 3) + +__commit_id__ = commit_id = None diff --git a/newrelic/packages/urllib3/connection.py b/newrelic/packages/urllib3/connection.py index de35b63d67..2ceeb0a548 100644 --- a/newrelic/packages/urllib3/connection.py +++ b/newrelic/packages/urllib3/connection.py @@ -1,59 +1,59 @@ -from __future__ import absolute_import +from __future__ import annotations import datetime +import http.client import logging import os import re import socket +import sys +import threading +import typing import warnings -from socket import error as SocketError +from http.client import HTTPConnection as _HTTPConnection +from http.client import HTTPException as HTTPException # noqa: F401 +from http.client import ResponseNotReady from socket import timeout as SocketTimeout -from .packages import six -from .packages.six.moves.http_client import HTTPConnection as _HTTPConnection -from .packages.six.moves.http_client import HTTPException # noqa: F401 -from .util.proxy import create_proxy_ssl_context +if typing.TYPE_CHECKING: + from .response import HTTPResponse + from .util.ssl_ import _TYPE_PEER_CERT_RET_DICT + from .util.ssltransport import SSLTransport + +from ._collections import HTTPHeaderDict +from .http2 import probe as http2_probe +from .util.response import assert_header_parsing +from .util.timeout import _DEFAULT_TIMEOUT, _TYPE_TIMEOUT, Timeout +from .util.util import to_str +from .util.wait import wait_for_read try: # Compiled with SSL? import ssl BaseSSLError = ssl.SSLError -except (ImportError, AttributeError): # Platform-specific: No SSL. - ssl = None - - class BaseSSLError(BaseException): - pass - - -try: - # Python 3: not a no-op, we're adding this to the namespace so it can be imported. - ConnectionError = ConnectionError -except NameError: - # Python 2 - class ConnectionError(Exception): - pass - - -try: # Python 3: - # Not a no-op, we're adding this to the namespace so it can be imported. - BrokenPipeError = BrokenPipeError -except NameError: # Python 2: +except (ImportError, AttributeError): + ssl = None # type: ignore[assignment] - class BrokenPipeError(Exception): + class BaseSSLError(BaseException): # type: ignore[no-redef] pass -from ._collections import HTTPHeaderDict # noqa (historical, removed in v2) +from ._base_connection import _TYPE_BODY +from ._base_connection import ProxyConfig as ProxyConfig +from ._base_connection import _ResponseOptions as _ResponseOptions from ._version import __version__ from .exceptions import ( ConnectTimeoutError, + HeaderParsingError, + NameResolutionError, NewConnectionError, - SubjectAltNameWarning, + ProxyError, SystemTimeWarning, ) -from .util import SKIP_HEADER, SKIPPABLE_HEADERS, connection +from .util import SKIP_HEADER, SKIPPABLE_HEADERS, connection, ssl_ +from .util.request import body_to_chunks +from .util.ssl_ import assert_fingerprint as _assert_fingerprint from .util.ssl_ import ( - assert_fingerprint, create_urllib3_context, is_ipaddress, resolve_cert_reqs, @@ -61,6 +61,12 @@ class BrokenPipeError(Exception): ssl_wrap_socket, ) from .util.ssl_match_hostname import CertificateError, match_hostname +from .util.url import Url + +# Not a no-op, we're adding this to the namespace so it can be imported. +ConnectionError = ConnectionError +BrokenPipeError = BrokenPipeError + log = logging.getLogger(__name__) @@ -68,12 +74,12 @@ class BrokenPipeError(Exception): # When it comes time to update this value as a part of regular maintenance # (ie test_recent_date is failing) update it to ~6 months before the current date. -RECENT_DATE = datetime.date(2024, 1, 1) +RECENT_DATE = datetime.date(2025, 1, 1) _CONTAINS_CONTROL_CHAR_RE = re.compile(r"[^-!#$%&'*+.^_`|~0-9a-zA-Z]") -class HTTPConnection(_HTTPConnection, object): +class HTTPConnection(_HTTPConnection): """ Based on :class:`http.client.HTTPConnection` but provides an extra constructor backwards-compatibility layer between older and newer Pythons. @@ -81,7 +87,6 @@ class HTTPConnection(_HTTPConnection, object): Additional keyword parameters are used to configure attributes of the connection. Accepted parameters include: - - ``strict``: See the documentation on :class:`urllib3.connectionpool.HTTPConnectionPool` - ``source_address``: Set the source address for the current connection. - ``socket_options``: Set specific options on the underlying socket. If not specified, then defaults are loaded from ``HTTPConnection.default_socket_options`` which includes disabling @@ -99,38 +104,70 @@ class HTTPConnection(_HTTPConnection, object): Or you may want to disable the defaults by passing an empty list (e.g., ``[]``). """ - default_port = port_by_scheme["http"] + default_port: typing.ClassVar[int] = port_by_scheme["http"] # type: ignore[misc] #: Disable Nagle's algorithm by default. #: ``[(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)]`` - default_socket_options = [(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)] + default_socket_options: typing.ClassVar[connection._TYPE_SOCKET_OPTIONS] = [ + (socket.IPPROTO_TCP, socket.TCP_NODELAY, 1) + ] #: Whether this connection verifies the host's certificate. - is_verified = False + is_verified: bool = False - #: Whether this proxy connection (if used) verifies the proxy host's - #: certificate. - proxy_is_verified = None + #: Whether this proxy connection verified the proxy host's certificate. + # If no proxy is currently connected to the value will be ``None``. + proxy_is_verified: bool | None = None - def __init__(self, *args, **kw): - if not six.PY2: - kw.pop("strict", None) + blocksize: int + source_address: tuple[str, int] | None + socket_options: connection._TYPE_SOCKET_OPTIONS | None - # Pre-set source_address. - self.source_address = kw.get("source_address") + _has_connected_to_proxy: bool + _response_options: _ResponseOptions | None + _tunnel_host: str | None + _tunnel_port: int | None + _tunnel_scheme: str | None - #: The socket options provided by the user. If no options are - #: provided, we use the default options. - self.socket_options = kw.pop("socket_options", self.default_socket_options) + def __init__( + self, + host: str, + port: int | None = None, + *, + timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, + source_address: tuple[str, int] | None = None, + blocksize: int = 16384, + socket_options: None | ( + connection._TYPE_SOCKET_OPTIONS + ) = default_socket_options, + proxy: Url | None = None, + proxy_config: ProxyConfig | None = None, + ) -> None: + super().__init__( + host=host, + port=port, + timeout=Timeout.resolve_default_timeout(timeout), + source_address=source_address, + blocksize=blocksize, + ) + self.socket_options = socket_options + self.proxy = proxy + self.proxy_config = proxy_config - # Proxy options provided by the user. - self.proxy = kw.pop("proxy", None) - self.proxy_config = kw.pop("proxy_config", None) + self._has_connected_to_proxy = False + self._response_options = None + self._tunnel_host: str | None = None + self._tunnel_port: int | None = None + self._tunnel_scheme: str | None = None - _HTTPConnection.__init__(self, *args, **kw) + def __str__(self) -> str: + return f"{type(self).__name__}(host={self.host!r}, port={self.port!r})" + + def __repr__(self) -> str: + return f"<{self} at {id(self):#x}>" @property - def host(self): + def host(self) -> str: """ Getter method to remove any trailing dots that indicate the hostname is an FQDN. @@ -149,7 +186,7 @@ def host(self): return self._dns_host.rstrip(".") @host.setter - def host(self, value): + def host(self, value: str) -> None: """ Setter for the `host` property. @@ -158,129 +195,409 @@ def host(self, value): """ self._dns_host = value - def _new_conn(self): + def _new_conn(self) -> socket.socket: """Establish a socket connection and set nodelay settings on it. :return: New socket connection. """ - extra_kw = {} - if self.source_address: - extra_kw["source_address"] = self.source_address - - if self.socket_options: - extra_kw["socket_options"] = self.socket_options - try: - conn = connection.create_connection( - (self._dns_host, self.port), self.timeout, **extra_kw + sock = connection.create_connection( + (self._dns_host, self.port), + self.timeout, + source_address=self.source_address, + socket_options=self.socket_options, ) - - except SocketTimeout: + except socket.gaierror as e: + raise NameResolutionError(self.host, self, e) from e + except SocketTimeout as e: raise ConnectTimeoutError( self, - "Connection to %s timed out. (connect timeout=%s)" - % (self.host, self.timeout), - ) + f"Connection to {self.host} timed out. (connect timeout={self.timeout})", + ) from e - except SocketError as e: + except OSError as e: raise NewConnectionError( - self, "Failed to establish a new connection: %s" % e - ) + self, f"Failed to establish a new connection: {e}" + ) from e + + sys.audit("http.client.connect", self, self.host, self.port) - return conn + return sock - def _is_using_tunnel(self): - # Google App Engine's httplib does not define _tunnel_host - return getattr(self, "_tunnel_host", None) + def set_tunnel( + self, + host: str, + port: int | None = None, + headers: typing.Mapping[str, str] | None = None, + scheme: str = "http", + ) -> None: + if scheme not in ("http", "https"): + raise ValueError( + f"Invalid proxy scheme for tunneling: {scheme!r}, must be either 'http' or 'https'" + ) + super().set_tunnel(host, port=port, headers=headers) + self._tunnel_scheme = scheme + + if sys.version_info < (3, 11, 9) or ((3, 12) <= sys.version_info < (3, 12, 3)): + # Taken from python/cpython#100986 which was backported in 3.11.9 and 3.12.3. + # When using connection_from_host, host will come without brackets. + def _wrap_ipv6(self, ip: bytes) -> bytes: + if b":" in ip and ip[0] != b"["[0]: + return b"[" + ip + b"]" + return ip + + if sys.version_info < (3, 11, 9): + # `_tunnel` copied from 3.11.13 backporting + # https://github.com/python/cpython/commit/0d4026432591d43185568dd31cef6a034c4b9261 + # and https://github.com/python/cpython/commit/6fbc61070fda2ffb8889e77e3b24bca4249ab4d1 + def _tunnel(self) -> None: + _MAXLINE = http.client._MAXLINE # type: ignore[attr-defined] + connect = b"CONNECT %s:%d HTTP/1.0\r\n" % ( # type: ignore[str-format] + self._wrap_ipv6(self._tunnel_host.encode("ascii")), # type: ignore[union-attr] + self._tunnel_port, + ) + headers = [connect] + for header, value in self._tunnel_headers.items(): # type: ignore[attr-defined] + headers.append(f"{header}: {value}\r\n".encode("latin-1")) + headers.append(b"\r\n") + # Making a single send() call instead of one per line encourages + # the host OS to use a more optimal packet size instead of + # potentially emitting a series of small packets. + self.send(b"".join(headers)) + del headers + + response = self.response_class(self.sock, method=self._method) # type: ignore[attr-defined] + try: + (version, code, message) = response._read_status() # type: ignore[attr-defined] + + if code != http.HTTPStatus.OK: + self.close() + raise OSError( + f"Tunnel connection failed: {code} {message.strip()}" + ) + while True: + line = response.fp.readline(_MAXLINE + 1) + if len(line) > _MAXLINE: + raise http.client.LineTooLong("header line") + if not line: + # for sites which EOF without sending a trailer + break + if line in (b"\r\n", b"\n", b""): + break + + if self.debuglevel > 0: + print("header:", line.decode()) + finally: + response.close() + + elif (3, 12) <= sys.version_info < (3, 12, 3): + # `_tunnel` copied from 3.12.11 backporting + # https://github.com/python/cpython/commit/23aef575c7629abcd4aaf028ebd226fb41a4b3c8 + def _tunnel(self) -> None: # noqa: F811 + connect = b"CONNECT %s:%d HTTP/1.1\r\n" % ( # type: ignore[str-format] + self._wrap_ipv6(self._tunnel_host.encode("idna")), # type: ignore[union-attr] + self._tunnel_port, + ) + headers = [connect] + for header, value in self._tunnel_headers.items(): # type: ignore[attr-defined] + headers.append(f"{header}: {value}\r\n".encode("latin-1")) + headers.append(b"\r\n") + # Making a single send() call instead of one per line encourages + # the host OS to use a more optimal packet size instead of + # potentially emitting a series of small packets. + self.send(b"".join(headers)) + del headers + + response = self.response_class(self.sock, method=self._method) # type: ignore[attr-defined] + try: + (version, code, message) = response._read_status() # type: ignore[attr-defined] + + self._raw_proxy_headers = http.client._read_headers(response.fp) # type: ignore[attr-defined] + + if self.debuglevel > 0: + for header in self._raw_proxy_headers: + print("header:", header.decode()) + + if code != http.HTTPStatus.OK: + self.close() + raise OSError( + f"Tunnel connection failed: {code} {message.strip()}" + ) + + finally: + response.close() + + def connect(self) -> None: + self.sock = self._new_conn() + if self._tunnel_host: + # If we're tunneling it means we're connected to our proxy. + self._has_connected_to_proxy = True - def _prepare_conn(self, conn): - self.sock = conn - if self._is_using_tunnel(): # TODO: Fix tunnel so it doesn't depend on self.sock state. self._tunnel() - # Mark this connection as not reusable - self.auto_open = 0 - def connect(self): - conn = self._new_conn() - self._prepare_conn(conn) + # If there's a proxy to be connected to we are fully connected. + # This is set twice (once above and here) due to forwarding proxies + # not using tunnelling. + self._has_connected_to_proxy = bool(self.proxy) + + if self._has_connected_to_proxy: + self.proxy_is_verified = False + + @property + def is_closed(self) -> bool: + return self.sock is None + + @property + def is_connected(self) -> bool: + if self.sock is None: + return False + return not wait_for_read(self.sock, timeout=0.0) + + @property + def has_connected_to_proxy(self) -> bool: + return self._has_connected_to_proxy + + @property + def proxy_is_forwarding(self) -> bool: + """ + Return True if a forwarding proxy is configured, else return False + """ + return bool(self.proxy) and self._tunnel_host is None + + @property + def proxy_is_tunneling(self) -> bool: + """ + Return True if a tunneling proxy is configured, else return False + """ + return self._tunnel_host is not None - def putrequest(self, method, url, *args, **kwargs): - """ """ + def close(self) -> None: + try: + super().close() + finally: + # Reset all stateful properties so connection + # can be re-used without leaking prior configs. + self.sock = None + self.is_verified = False + self.proxy_is_verified = None + self._has_connected_to_proxy = False + self._response_options = None + self._tunnel_host = None + self._tunnel_port = None + self._tunnel_scheme = None + + def putrequest( + self, + method: str, + url: str, + skip_host: bool = False, + skip_accept_encoding: bool = False, + ) -> None: + """""" # Empty docstring because the indentation of CPython's implementation # is broken but we don't want this method in our documentation. match = _CONTAINS_CONTROL_CHAR_RE.search(method) if match: raise ValueError( - "Method cannot contain non-token characters %r (found at least %r)" - % (method, match.group()) + f"Method cannot contain non-token characters {method!r} (found at least {match.group()!r})" ) - return _HTTPConnection.putrequest(self, method, url, *args, **kwargs) + return super().putrequest( + method, url, skip_host=skip_host, skip_accept_encoding=skip_accept_encoding + ) - def putheader(self, header, *values): - """ """ + def putheader(self, header: str, *values: str) -> None: # type: ignore[override] + """""" if not any(isinstance(v, str) and v == SKIP_HEADER for v in values): - _HTTPConnection.putheader(self, header, *values) - elif six.ensure_str(header.lower()) not in SKIPPABLE_HEADERS: + super().putheader(header, *values) + elif to_str(header.lower()) not in SKIPPABLE_HEADERS: + skippable_headers = "', '".join( + [str.title(header) for header in sorted(SKIPPABLE_HEADERS)] + ) raise ValueError( - "urllib3.util.SKIP_HEADER only supports '%s'" - % ("', '".join(map(str.title, sorted(SKIPPABLE_HEADERS))),) + f"urllib3.util.SKIP_HEADER only supports '{skippable_headers}'" ) - def request(self, method, url, body=None, headers=None): + # `request` method's signature intentionally violates LSP. + # urllib3's API is different from `http.client.HTTPConnection` and the subclassing is only incidental. + def request( # type: ignore[override] + self, + method: str, + url: str, + body: _TYPE_BODY | None = None, + headers: typing.Mapping[str, str] | None = None, + *, + chunked: bool = False, + preload_content: bool = True, + decode_content: bool = True, + enforce_content_length: bool = True, + ) -> None: # Update the inner socket's timeout value to send the request. # This only triggers if the connection is re-used. - if getattr(self, "sock", None) is not None: + if self.sock is not None: self.sock.settimeout(self.timeout) + # Store these values to be fed into the HTTPResponse + # object later. TODO: Remove this in favor of a real + # HTTP lifecycle mechanism. + + # We have to store these before we call .request() + # because sometimes we can still salvage a response + # off the wire even if we aren't able to completely + # send the request body. + self._response_options = _ResponseOptions( + request_method=method, + request_url=url, + preload_content=preload_content, + decode_content=decode_content, + enforce_content_length=enforce_content_length, + ) + if headers is None: headers = {} - else: - # Avoid modifying the headers passed into .request() - headers = headers.copy() - if "user-agent" not in (six.ensure_str(k.lower()) for k in headers): - headers["User-Agent"] = _get_default_user_agent() - super(HTTPConnection, self).request(method, url, body=body, headers=headers) - - def request_chunked(self, method, url, body=None, headers=None): - """ - Alternative to the common request method, which sends the - body with chunked encoding and not as one block - """ - headers = headers or {} - header_keys = set([six.ensure_str(k.lower()) for k in headers]) + header_keys = frozenset(to_str(k.lower()) for k in headers) skip_accept_encoding = "accept-encoding" in header_keys skip_host = "host" in header_keys self.putrequest( method, url, skip_accept_encoding=skip_accept_encoding, skip_host=skip_host ) + + # Transform the body into an iterable of sendall()-able chunks + # and detect if an explicit Content-Length is doable. + chunks_and_cl = body_to_chunks(body, method=method, blocksize=self.blocksize) + chunks = chunks_and_cl.chunks + content_length = chunks_and_cl.content_length + + # When chunked is explicit set to 'True' we respect that. + if chunked: + if "transfer-encoding" not in header_keys: + self.putheader("Transfer-Encoding", "chunked") + else: + # Detect whether a framing mechanism is already in use. If so + # we respect that value, otherwise we pick chunked vs content-length + # depending on the type of 'body'. + if "content-length" in header_keys: + chunked = False + elif "transfer-encoding" in header_keys: + chunked = True + + # Otherwise we go off the recommendation of 'body_to_chunks()'. + else: + chunked = False + if content_length is None: + if chunks is not None: + chunked = True + self.putheader("Transfer-Encoding", "chunked") + else: + self.putheader("Content-Length", str(content_length)) + + # Now that framing headers are out of the way we send all the other headers. if "user-agent" not in header_keys: self.putheader("User-Agent", _get_default_user_agent()) for header, value in headers.items(): self.putheader(header, value) - if "transfer-encoding" not in header_keys: - self.putheader("Transfer-Encoding", "chunked") self.endheaders() - if body is not None: - stringish_types = six.string_types + (bytes,) - if isinstance(body, stringish_types): - body = (body,) - for chunk in body: + # If we're given a body we start sending that in chunks. + if chunks is not None: + for chunk in chunks: + # Sending empty chunks isn't allowed for TE: chunked + # as it indicates the end of the body. if not chunk: continue - if not isinstance(chunk, bytes): - chunk = chunk.encode("utf8") - len_str = hex(len(chunk))[2:] - to_send = bytearray(len_str.encode()) - to_send += b"\r\n" - to_send += chunk - to_send += b"\r\n" - self.send(to_send) + if isinstance(chunk, str): + chunk = chunk.encode("utf-8") + if chunked: + self.send(b"%x\r\n%b\r\n" % (len(chunk), chunk)) + else: + self.send(chunk) + + # Regardless of whether we have a body or not, if we're in + # chunked mode we want to send an explicit empty chunk. + if chunked: + self.send(b"0\r\n\r\n") + + def request_chunked( + self, + method: str, + url: str, + body: _TYPE_BODY | None = None, + headers: typing.Mapping[str, str] | None = None, + ) -> None: + """ + Alternative to the common request method, which sends the + body with chunked encoding and not as one block + """ + warnings.warn( + "HTTPConnection.request_chunked() is deprecated and will be removed " + "in urllib3 v2.1.0. Instead use HTTPConnection.request(..., chunked=True).", + category=DeprecationWarning, + stacklevel=2, + ) + self.request(method, url, body=body, headers=headers, chunked=True) + + def getresponse( # type: ignore[override] + self, + ) -> HTTPResponse: + """ + Get the response from the server. + + If the HTTPConnection is in the correct state, returns an instance of HTTPResponse or of whatever object is returned by the response_class variable. + + If a request has not been sent or if a previous response has not be handled, ResponseNotReady is raised. If the HTTP response indicates that the connection should be closed, then it will be closed before the response is returned. When the connection is closed, the underlying socket is closed. + """ + # Raise the same error as http.client.HTTPConnection + if self._response_options is None: + raise ResponseNotReady() + + # Reset this attribute for being used again. + resp_options = self._response_options + self._response_options = None - # After the if clause, to always have a closed body - self.send(b"0\r\n\r\n") + # Since the connection's timeout value may have been updated + # we need to set the timeout on the socket. + self.sock.settimeout(self.timeout) + + # This is needed here to avoid circular import errors + from .response import HTTPResponse + + # Save a reference to the shutdown function before ownership is passed + # to httplib_response + # TODO should we implement it everywhere? + _shutdown = getattr(self.sock, "shutdown", None) + + # Get the response from http.client.HTTPConnection + httplib_response = super().getresponse() + + try: + assert_header_parsing(httplib_response.msg) + except (HeaderParsingError, TypeError) as hpe: + log.warning( + "Failed to parse headers (url=%s): %s", + _url_from_connection(self, resp_options.request_url), + hpe, + exc_info=True, + ) + + headers = HTTPHeaderDict(httplib_response.msg.items()) + + response = HTTPResponse( + body=httplib_response, + headers=headers, + status=httplib_response.status, + version=httplib_response.version, + version_string=getattr(self, "_http_vsn_str", "HTTP/?"), + reason=httplib_response.reason, + preload_content=resp_options.preload_content, + decode_content=resp_options.decode_content, + original_response=httplib_response, + enforce_content_length=resp_options.enforce_content_length, + request_method=resp_options.request_method, + request_url=resp_options.request_url, + sock_shutdown=_shutdown, + ) + return response class HTTPSConnection(HTTPConnection): @@ -289,57 +606,103 @@ class HTTPSConnection(HTTPConnection): socket by means of :py:func:`urllib3.util.ssl_wrap_socket`. """ - default_port = port_by_scheme["https"] + default_port = port_by_scheme["https"] # type: ignore[misc] - cert_reqs = None - ca_certs = None - ca_cert_dir = None - ca_cert_data = None - ssl_version = None - assert_fingerprint = None - tls_in_tls_required = False + cert_reqs: int | str | None = None + ca_certs: str | None = None + ca_cert_dir: str | None = None + ca_cert_data: None | str | bytes = None + ssl_version: int | str | None = None + ssl_minimum_version: int | None = None + ssl_maximum_version: int | None = None + assert_fingerprint: str | None = None + _connect_callback: typing.Callable[..., None] | None = None def __init__( self, - host, - port=None, - key_file=None, - cert_file=None, - key_password=None, - strict=None, - timeout=socket._GLOBAL_DEFAULT_TIMEOUT, - ssl_context=None, - server_hostname=None, - **kw - ): - - HTTPConnection.__init__(self, host, port, strict=strict, timeout=timeout, **kw) + host: str, + port: int | None = None, + *, + timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, + source_address: tuple[str, int] | None = None, + blocksize: int = 16384, + socket_options: None | ( + connection._TYPE_SOCKET_OPTIONS + ) = HTTPConnection.default_socket_options, + proxy: Url | None = None, + proxy_config: ProxyConfig | None = None, + cert_reqs: int | str | None = None, + assert_hostname: None | str | typing.Literal[False] = None, + assert_fingerprint: str | None = None, + server_hostname: str | None = None, + ssl_context: ssl.SSLContext | None = None, + ca_certs: str | None = None, + ca_cert_dir: str | None = None, + ca_cert_data: None | str | bytes = None, + ssl_minimum_version: int | None = None, + ssl_maximum_version: int | None = None, + ssl_version: int | str | None = None, # Deprecated + cert_file: str | None = None, + key_file: str | None = None, + key_password: str | None = None, + ) -> None: + super().__init__( + host, + port=port, + timeout=timeout, + source_address=source_address, + blocksize=blocksize, + socket_options=socket_options, + proxy=proxy, + proxy_config=proxy_config, + ) self.key_file = key_file self.cert_file = cert_file self.key_password = key_password self.ssl_context = ssl_context self.server_hostname = server_hostname + self.assert_hostname = assert_hostname + self.assert_fingerprint = assert_fingerprint + self.ssl_version = ssl_version + self.ssl_minimum_version = ssl_minimum_version + self.ssl_maximum_version = ssl_maximum_version + self.ca_certs = ca_certs and os.path.expanduser(ca_certs) + self.ca_cert_dir = ca_cert_dir and os.path.expanduser(ca_cert_dir) + self.ca_cert_data = ca_cert_data - # Required property for Google AppEngine 1.9.0 which otherwise causes - # HTTPS requests to go out as HTTP. (See Issue #356) - self._protocol = "https" + # cert_reqs depends on ssl_context so calculate last. + if cert_reqs is None: + if self.ssl_context is not None: + cert_reqs = self.ssl_context.verify_mode + else: + cert_reqs = resolve_cert_reqs(None) + self.cert_reqs = cert_reqs + self._connect_callback = None def set_cert( self, - key_file=None, - cert_file=None, - cert_reqs=None, - key_password=None, - ca_certs=None, - assert_hostname=None, - assert_fingerprint=None, - ca_cert_dir=None, - ca_cert_data=None, - ): + key_file: str | None = None, + cert_file: str | None = None, + cert_reqs: int | str | None = None, + key_password: str | None = None, + ca_certs: str | None = None, + assert_hostname: None | str | typing.Literal[False] = None, + assert_fingerprint: str | None = None, + ca_cert_dir: str | None = None, + ca_cert_data: None | str | bytes = None, + ) -> None: """ This method should only be called once, before the connection is used. """ + warnings.warn( + "HTTPSConnection.set_cert() is deprecated and will be removed " + "in urllib3 v2.1.0. Instead provide the parameters to the " + "HTTPSConnection constructor.", + category=DeprecationWarning, + stacklevel=2, + ) + # If cert_reqs is not provided we'll assume CERT_REQUIRED unless we also # have an SSLContext object in which case we'll use its verify_mode. if cert_reqs is None: @@ -358,191 +721,322 @@ def set_cert( self.ca_cert_dir = ca_cert_dir and os.path.expanduser(ca_cert_dir) self.ca_cert_data = ca_cert_data - def connect(self): - # Add certificate verification - self.sock = conn = self._new_conn() - hostname = self.host - tls_in_tls = False - - if self._is_using_tunnel(): - if self.tls_in_tls_required: - self.sock = conn = self._connect_tls_proxy(hostname, conn) - tls_in_tls = True - - # Calls self._set_hostport(), so self.host is - # self._tunnel_host below. - self._tunnel() - # Mark this connection as not reusable - self.auto_open = 0 - - # Override the host with the one we're requesting data from. - hostname = self._tunnel_host - - server_hostname = hostname - if self.server_hostname is not None: - server_hostname = self.server_hostname - - is_time_off = datetime.date.today() < RECENT_DATE - if is_time_off: - warnings.warn( - ( - "System time is way off (before {0}). This will probably " - "lead to SSL verification errors" - ).format(RECENT_DATE), - SystemTimeWarning, - ) - - # Wrap socket using verification with the root certs in - # trusted_root_certs - default_ssl_context = False - if self.ssl_context is None: - default_ssl_context = True - self.ssl_context = create_urllib3_context( - ssl_version=resolve_ssl_version(self.ssl_version), - cert_reqs=resolve_cert_reqs(self.cert_reqs), + def connect(self) -> None: + # Today we don't need to be doing this step before the /actual/ socket + # connection, however in the future we'll need to decide whether to + # create a new socket or re-use an existing "shared" socket as a part + # of the HTTP/2 handshake dance. + if self._tunnel_host is not None and self._tunnel_port is not None: + probe_http2_host = self._tunnel_host + probe_http2_port = self._tunnel_port + else: + probe_http2_host = self.host + probe_http2_port = self.port + + # Check if the target origin supports HTTP/2. + # If the value comes back as 'None' it means that the current thread + # is probing for HTTP/2 support. Otherwise, we're waiting for another + # probe to complete, or we get a value right away. + target_supports_http2: bool | None + if "h2" in ssl_.ALPN_PROTOCOLS: + target_supports_http2 = http2_probe.acquire_and_get( + host=probe_http2_host, port=probe_http2_port ) - - context = self.ssl_context - context.verify_mode = resolve_cert_reqs(self.cert_reqs) - - # Try to load OS default certs if none are given. - # Works well on Windows (requires Python3.4+) - if ( - not self.ca_certs - and not self.ca_cert_dir - and not self.ca_cert_data - and default_ssl_context - and hasattr(context, "load_default_certs") - ): - context.load_default_certs() - - self.sock = ssl_wrap_socket( - sock=conn, - keyfile=self.key_file, - certfile=self.cert_file, - key_password=self.key_password, - ca_certs=self.ca_certs, - ca_cert_dir=self.ca_cert_dir, - ca_cert_data=self.ca_cert_data, - server_hostname=server_hostname, - ssl_context=context, - tls_in_tls=tls_in_tls, - ) - - # If we're using all defaults and the connection - # is TLSv1 or TLSv1.1 we throw a DeprecationWarning - # for the host. - if ( - default_ssl_context - and self.ssl_version is None - and hasattr(self.sock, "version") - and self.sock.version() in {"TLSv1", "TLSv1.1"} - ): # Defensive: - warnings.warn( - "Negotiating TLSv1/TLSv1.1 by default is deprecated " - "and will be disabled in urllib3 v2.0.0. Connecting to " - "'%s' with '%s' can be enabled by explicitly opting-in " - "with 'ssl_version'" % (self.host, self.sock.version()), - DeprecationWarning, + else: + # If HTTP/2 isn't going to be offered it doesn't matter if + # the target supports HTTP/2. Don't want to make a probe. + target_supports_http2 = False + + if self._connect_callback is not None: + self._connect_callback( + "before connect", + thread_id=threading.get_ident(), + target_supports_http2=target_supports_http2, ) - if self.assert_fingerprint: - assert_fingerprint( - self.sock.getpeercert(binary_form=True), self.assert_fingerprint - ) - elif ( - context.verify_mode != ssl.CERT_NONE - and not getattr(context, "check_hostname", False) - and self.assert_hostname is not False - ): - # While urllib3 attempts to always turn off hostname matching from - # the TLS library, this cannot always be done. So we check whether - # the TLS Library still thinks it's matching hostnames. - cert = self.sock.getpeercert() - if not cert.get("subjectAltName", ()): + try: + sock: socket.socket | ssl.SSLSocket + self.sock = sock = self._new_conn() + server_hostname: str = self.host + tls_in_tls = False + + # Do we need to establish a tunnel? + if self.proxy_is_tunneling: + # We're tunneling to an HTTPS origin so need to do TLS-in-TLS. + if self._tunnel_scheme == "https": + # _connect_tls_proxy will verify and assign proxy_is_verified + self.sock = sock = self._connect_tls_proxy(self.host, sock) + tls_in_tls = True + elif self._tunnel_scheme == "http": + self.proxy_is_verified = False + + # If we're tunneling it means we're connected to our proxy. + self._has_connected_to_proxy = True + + self._tunnel() + # Override the host with the one we're requesting data from. + server_hostname = typing.cast(str, self._tunnel_host) + + if self.server_hostname is not None: + server_hostname = self.server_hostname + + is_time_off = datetime.date.today() < RECENT_DATE + if is_time_off: warnings.warn( ( - "Certificate for {0} has no `subjectAltName`, falling back to check for a " - "`commonName` for now. This feature is being removed by major browsers and " - "deprecated by RFC 2818. (See https://github.com/urllib3/urllib3/issues/497 " - "for details.)".format(hostname) + f"System time is way off (before {RECENT_DATE}). This will probably " + "lead to SSL verification errors" ), - SubjectAltNameWarning, + SystemTimeWarning, ) - _match_hostname(cert, self.assert_hostname or server_hostname) - self.is_verified = ( - context.verify_mode == ssl.CERT_REQUIRED - or self.assert_fingerprint is not None - ) + # Remove trailing '.' from fqdn hostnames to allow certificate validation + server_hostname_rm_dot = server_hostname.rstrip(".") + + sock_and_verified = _ssl_wrap_socket_and_match_hostname( + sock=sock, + cert_reqs=self.cert_reqs, + ssl_version=self.ssl_version, + ssl_minimum_version=self.ssl_minimum_version, + ssl_maximum_version=self.ssl_maximum_version, + ca_certs=self.ca_certs, + ca_cert_dir=self.ca_cert_dir, + ca_cert_data=self.ca_cert_data, + cert_file=self.cert_file, + key_file=self.key_file, + key_password=self.key_password, + server_hostname=server_hostname_rm_dot, + ssl_context=self.ssl_context, + tls_in_tls=tls_in_tls, + assert_hostname=self.assert_hostname, + assert_fingerprint=self.assert_fingerprint, + ) + self.sock = sock_and_verified.socket + + # If an error occurs during connection/handshake we may need to release + # our lock so another connection can probe the origin. + except BaseException: + if self._connect_callback is not None: + self._connect_callback( + "after connect failure", + thread_id=threading.get_ident(), + target_supports_http2=target_supports_http2, + ) - def _connect_tls_proxy(self, hostname, conn): + if target_supports_http2 is None: + http2_probe.set_and_release( + host=probe_http2_host, port=probe_http2_port, supports_http2=None + ) + raise + + # If this connection doesn't know if the origin supports HTTP/2 + # we report back to the HTTP/2 probe our result. + if target_supports_http2 is None: + supports_http2 = sock_and_verified.socket.selected_alpn_protocol() == "h2" + http2_probe.set_and_release( + host=probe_http2_host, + port=probe_http2_port, + supports_http2=supports_http2, + ) + + # Forwarding proxies can never have a verified target since + # the proxy is the one doing the verification. Should instead + # use a CONNECT tunnel in order to verify the target. + # See: https://github.com/urllib3/urllib3/issues/3267. + if self.proxy_is_forwarding: + self.is_verified = False + else: + self.is_verified = sock_and_verified.is_verified + + # If there's a proxy to be connected to we are fully connected. + # This is set twice (once above and here) due to forwarding proxies + # not using tunnelling. + self._has_connected_to_proxy = bool(self.proxy) + + # Set `self.proxy_is_verified` unless it's already set while + # establishing a tunnel. + if self._has_connected_to_proxy and self.proxy_is_verified is None: + self.proxy_is_verified = sock_and_verified.is_verified + + def _connect_tls_proxy(self, hostname: str, sock: socket.socket) -> ssl.SSLSocket: """ Establish a TLS connection to the proxy using the provided SSL context. """ - proxy_config = self.proxy_config + # `_connect_tls_proxy` is called when self._tunnel_host is truthy. + proxy_config = typing.cast(ProxyConfig, self.proxy_config) ssl_context = proxy_config.ssl_context - if ssl_context: - # If the user provided a proxy context, we assume CA and client - # certificates have already been set - return ssl_wrap_socket( - sock=conn, - server_hostname=hostname, - ssl_context=ssl_context, - ) - - ssl_context = create_proxy_ssl_context( - self.ssl_version, - self.cert_reqs, - self.ca_certs, - self.ca_cert_dir, - self.ca_cert_data, - ) - - # If no cert was provided, use only the default options for server - # certificate validation - socket = ssl_wrap_socket( - sock=conn, + sock_and_verified = _ssl_wrap_socket_and_match_hostname( + sock, + cert_reqs=self.cert_reqs, + ssl_version=self.ssl_version, + ssl_minimum_version=self.ssl_minimum_version, + ssl_maximum_version=self.ssl_maximum_version, ca_certs=self.ca_certs, ca_cert_dir=self.ca_cert_dir, ca_cert_data=self.ca_cert_data, server_hostname=hostname, ssl_context=ssl_context, + assert_hostname=proxy_config.assert_hostname, + assert_fingerprint=proxy_config.assert_fingerprint, + # Features that aren't implemented for proxies yet: + cert_file=None, + key_file=None, + key_password=None, + tls_in_tls=False, ) + self.proxy_is_verified = sock_and_verified.is_verified + return sock_and_verified.socket # type: ignore[return-value] - if ssl_context.verify_mode != ssl.CERT_NONE and not getattr( - ssl_context, "check_hostname", False + +class _WrappedAndVerifiedSocket(typing.NamedTuple): + """ + Wrapped socket and whether the connection is + verified after the TLS handshake + """ + + socket: ssl.SSLSocket | SSLTransport + is_verified: bool + + +def _ssl_wrap_socket_and_match_hostname( + sock: socket.socket, + *, + cert_reqs: None | str | int, + ssl_version: None | str | int, + ssl_minimum_version: int | None, + ssl_maximum_version: int | None, + cert_file: str | None, + key_file: str | None, + key_password: str | None, + ca_certs: str | None, + ca_cert_dir: str | None, + ca_cert_data: None | str | bytes, + assert_hostname: None | str | typing.Literal[False], + assert_fingerprint: str | None, + server_hostname: str | None, + ssl_context: ssl.SSLContext | None, + tls_in_tls: bool = False, +) -> _WrappedAndVerifiedSocket: + """Logic for constructing an SSLContext from all TLS parameters, passing + that down into ssl_wrap_socket, and then doing certificate verification + either via hostname or fingerprint. This function exists to guarantee + that both proxies and targets have the same behavior when connecting via TLS. + """ + default_ssl_context = False + if ssl_context is None: + default_ssl_context = True + context = create_urllib3_context( + ssl_version=resolve_ssl_version(ssl_version), + ssl_minimum_version=ssl_minimum_version, + ssl_maximum_version=ssl_maximum_version, + cert_reqs=resolve_cert_reqs(cert_reqs), + ) + else: + context = ssl_context + + context.verify_mode = resolve_cert_reqs(cert_reqs) + + # In some cases, we want to verify hostnames ourselves + if ( + # `ssl` can't verify fingerprints or alternate hostnames + assert_fingerprint + or assert_hostname + # assert_hostname can be set to False to disable hostname checking + or assert_hostname is False + # We still support OpenSSL 1.0.2, which prevents us from verifying + # hostnames easily: https://github.com/pyca/pyopenssl/pull/933 + or ssl_.IS_PYOPENSSL + or not ssl_.HAS_NEVER_CHECK_COMMON_NAME + ): + context.check_hostname = False + + # Try to load OS default certs if none are given. We need to do the hasattr() check + # for custom pyOpenSSL SSLContext objects because they don't support + # load_default_certs(). + if ( + not ca_certs + and not ca_cert_dir + and not ca_cert_data + and default_ssl_context + and hasattr(context, "load_default_certs") + ): + context.load_default_certs() + + # Ensure that IPv6 addresses are in the proper format and don't have a + # scope ID. Python's SSL module fails to recognize scoped IPv6 addresses + # and interprets them as DNS hostnames. + if server_hostname is not None: + normalized = server_hostname.strip("[]") + if "%" in normalized: + normalized = normalized[: normalized.rfind("%")] + if is_ipaddress(normalized): + server_hostname = normalized + + ssl_sock = ssl_wrap_socket( + sock=sock, + keyfile=key_file, + certfile=cert_file, + key_password=key_password, + ca_certs=ca_certs, + ca_cert_dir=ca_cert_dir, + ca_cert_data=ca_cert_data, + server_hostname=server_hostname, + ssl_context=context, + tls_in_tls=tls_in_tls, + ) + + try: + if assert_fingerprint: + _assert_fingerprint( + ssl_sock.getpeercert(binary_form=True), assert_fingerprint + ) + elif ( + context.verify_mode != ssl.CERT_NONE + and not context.check_hostname + and assert_hostname is not False ): - # While urllib3 attempts to always turn off hostname matching from - # the TLS library, this cannot always be done. So we check whether - # the TLS Library still thinks it's matching hostnames. - cert = socket.getpeercert() - if not cert.get("subjectAltName", ()): - warnings.warn( - ( - "Certificate for {0} has no `subjectAltName`, falling back to check for a " - "`commonName` for now. This feature is being removed by major browsers and " - "deprecated by RFC 2818. (See https://github.com/urllib3/urllib3/issues/497 " - "for details.)".format(hostname) - ), - SubjectAltNameWarning, + cert: _TYPE_PEER_CERT_RET_DICT = ssl_sock.getpeercert() # type: ignore[assignment] + + # Need to signal to our match_hostname whether to use 'commonName' or not. + # If we're using our own constructed SSLContext we explicitly set 'False' + # because PyPy hard-codes 'True' from SSLContext.hostname_checks_common_name. + if default_ssl_context: + hostname_checks_common_name = False + else: + hostname_checks_common_name = ( + getattr(context, "hostname_checks_common_name", False) or False ) - _match_hostname(cert, hostname) - self.proxy_is_verified = ssl_context.verify_mode == ssl.CERT_REQUIRED - return socket + _match_hostname( + cert, + assert_hostname or server_hostname, # type: ignore[arg-type] + hostname_checks_common_name, + ) + + return _WrappedAndVerifiedSocket( + socket=ssl_sock, + is_verified=context.verify_mode == ssl.CERT_REQUIRED + or bool(assert_fingerprint), + ) + except BaseException: + ssl_sock.close() + raise -def _match_hostname(cert, asserted_hostname): +def _match_hostname( + cert: _TYPE_PEER_CERT_RET_DICT | None, + asserted_hostname: str, + hostname_checks_common_name: bool = False, +) -> None: # Our upstream implementation of ssl.match_hostname() # only applies this normalization to IP addresses so it doesn't # match DNS SANs so we do the same thing! - stripped_hostname = asserted_hostname.strip("u[]") + stripped_hostname = asserted_hostname.strip("[]") if is_ipaddress(stripped_hostname): asserted_hostname = stripped_hostname try: - match_hostname(cert, asserted_hostname) + match_hostname(cert, asserted_hostname, hostname_checks_common_name) except CertificateError as e: log.warning( "Certificate did not match expected hostname: %s. Certificate: %s", @@ -551,22 +1045,55 @@ def _match_hostname(cert, asserted_hostname): ) # Add cert to exception and reraise so client code can inspect # the cert when catching the exception, if they want to - e._peer_cert = cert + e._peer_cert = cert # type: ignore[attr-defined] raise -def _get_default_user_agent(): - return "python-urllib3/%s" % __version__ - - -class DummyConnection(object): +def _wrap_proxy_error(err: Exception, proxy_scheme: str | None) -> ProxyError: + # Look for the phrase 'wrong version number', if found + # then we should warn the user that we're very sure that + # this proxy is HTTP-only and they have a configuration issue. + error_normalized = " ".join(re.split("[^a-z]", str(err).lower())) + is_likely_http_proxy = ( + "wrong version number" in error_normalized + or "unknown protocol" in error_normalized + or "record layer failure" in error_normalized + ) + http_proxy_warning = ( + ". Your proxy appears to only use HTTP and not HTTPS, " + "try changing your proxy URL to be HTTP. See: " + "https://urllib3.readthedocs.io/en/latest/advanced-usage.html" + "#https-proxy-error-http-proxy" + ) + new_err = ProxyError( + f"Unable to connect to proxy" + f"{http_proxy_warning if is_likely_http_proxy and proxy_scheme == 'https' else ''}", + err, + ) + new_err.__cause__ = err + return new_err + + +def _get_default_user_agent() -> str: + return f"python-urllib3/{__version__}" + + +class DummyConnection: """Used to detect a failed ConnectionCls import.""" - pass - if not ssl: - HTTPSConnection = DummyConnection # noqa: F811 + HTTPSConnection = DummyConnection # type: ignore[misc, assignment] # noqa: F811 VerifiedHTTPSConnection = HTTPSConnection + + +def _url_from_connection( + conn: HTTPConnection | HTTPSConnection, path: str | None = None +) -> str: + """Returns the URL from a given connection. This is mainly used for testing and logging.""" + + scheme = "https" if isinstance(conn, HTTPSConnection) else "http" + + return Url(scheme=scheme, host=conn.host, port=conn.port, path=path).url diff --git a/newrelic/packages/urllib3/connectionpool.py b/newrelic/packages/urllib3/connectionpool.py index 402bf670da..3a0685b4cd 100644 --- a/newrelic/packages/urllib3/connectionpool.py +++ b/newrelic/packages/urllib3/connectionpool.py @@ -1,15 +1,18 @@ -from __future__ import absolute_import +from __future__ import annotations import errno import logging -import re -import socket +import queue import sys +import typing import warnings -from socket import error as SocketError +import weakref from socket import timeout as SocketTimeout +from types import TracebackType +from ._base_connection import _TYPE_BODY from ._collections import HTTPHeaderDict +from ._request_methods import RequestMethods from .connection import ( BaseSSLError, BrokenPipeError, @@ -17,13 +20,14 @@ HTTPConnection, HTTPException, HTTPSConnection, - VerifiedHTTPSConnection, - port_by_scheme, + ProxyConfig, + _wrap_proxy_error, ) +from .connection import port_by_scheme as port_by_scheme from .exceptions import ( ClosedPoolError, EmptyPoolError, - HeaderParsingError, + FullPoolError, HostChangedError, InsecureRequestWarning, LocationValueError, @@ -35,38 +39,32 @@ SSLError, TimeoutError, ) -from .packages import six -from .packages.six.moves import queue -from .request import RequestMethods -from .response import HTTPResponse +from .response import BaseHTTPResponse from .util.connection import is_connection_dropped from .util.proxy import connection_requires_http_tunnel -from .util.queue import LifoQueue -from .util.request import set_file_position -from .util.response import assert_header_parsing +from .util.request import _TYPE_BODY_POSITION, set_file_position from .util.retry import Retry from .util.ssl_match_hostname import CertificateError -from .util.timeout import Timeout +from .util.timeout import _DEFAULT_TIMEOUT, _TYPE_DEFAULT, Timeout from .util.url import Url, _encode_target from .util.url import _normalize_host as normalize_host -from .util.url import get_host, parse_url +from .util.url import parse_url +from .util.util import to_str -try: # Platform-specific: Python 3 - import weakref +if typing.TYPE_CHECKING: + import ssl - weakref_finalize = weakref.finalize -except AttributeError: # Platform-specific: Python 2 - from .packages.backports.weakref_finalize import weakref_finalize + from typing_extensions import Self -xrange = six.moves.xrange + from ._base_connection import BaseHTTPConnection, BaseHTTPSConnection log = logging.getLogger(__name__) -_Default = object() +_TYPE_TIMEOUT = typing.Union[Timeout, float, _TYPE_DEFAULT, None] # Pool objects -class ConnectionPool(object): +class ConnectionPool: """ Base class for all connection pools, such as :class:`.HTTPConnectionPool` and :class:`.HTTPSConnectionPool`. @@ -77,33 +75,42 @@ class ConnectionPool(object): target URIs. """ - scheme = None - QueueCls = LifoQueue + scheme: str | None = None + QueueCls = queue.LifoQueue - def __init__(self, host, port=None): + def __init__(self, host: str, port: int | None = None) -> None: if not host: raise LocationValueError("No host specified.") self.host = _normalize_host(host, scheme=self.scheme) - self._proxy_host = host.lower() self.port = port - def __str__(self): - return "%s(host=%r, port=%r)" % (type(self).__name__, self.host, self.port) + # This property uses 'normalize_host()' (not '_normalize_host()') + # to avoid removing square braces around IPv6 addresses. + # This value is sent to `HTTPConnection.set_tunnel()` if called + # because square braces are required for HTTP CONNECT tunneling. + self._tunnel_host = normalize_host(host, scheme=self.scheme).lower() - def __enter__(self): + def __str__(self) -> str: + return f"{type(self).__name__}(host={self.host!r}, port={self.port!r})" + + def __enter__(self) -> Self: return self - def __exit__(self, exc_type, exc_val, exc_tb): + def __exit__( + self, + exc_type: type[BaseException] | None, + exc_val: BaseException | None, + exc_tb: TracebackType | None, + ) -> typing.Literal[False]: self.close() # Return False to re-raise any potential exceptions return False - def close(self): + def close(self) -> None: """ Close all pooled connections and disable the pool. """ - pass # This is taken from http://hg.python.org/cpython/file/7aaba721ebc0/Lib/socket.py#l252 @@ -122,14 +129,6 @@ class HTTPConnectionPool(ConnectionPool, RequestMethods): Port used for this HTTP Connection (None is equivalent to 80), passed into :class:`http.client.HTTPConnection`. - :param strict: - Causes BadStatusLine to be raised if the status line can't be parsed - as a valid HTTP/1.0 or 1.1 status line, passed into - :class:`http.client.HTTPConnection`. - - .. note:: - Only works in Python 2. This parameter is ignored in Python 3. - :param timeout: Socket timeout in seconds for each individual connection. This can be a float or integer, which sets the timeout for the HTTP request, @@ -171,29 +170,25 @@ class HTTPConnectionPool(ConnectionPool, RequestMethods): """ scheme = "http" - ConnectionCls = HTTPConnection - ResponseCls = HTTPResponse + ConnectionCls: type[BaseHTTPConnection] | type[BaseHTTPSConnection] = HTTPConnection def __init__( self, - host, - port=None, - strict=False, - timeout=Timeout.DEFAULT_TIMEOUT, - maxsize=1, - block=False, - headers=None, - retries=None, - _proxy=None, - _proxy_headers=None, - _proxy_config=None, - **conn_kw + host: str, + port: int | None = None, + timeout: _TYPE_TIMEOUT | None = _DEFAULT_TIMEOUT, + maxsize: int = 1, + block: bool = False, + headers: typing.Mapping[str, str] | None = None, + retries: Retry | bool | int | None = None, + _proxy: Url | None = None, + _proxy_headers: typing.Mapping[str, str] | None = None, + _proxy_config: ProxyConfig | None = None, + **conn_kw: typing.Any, ): ConnectionPool.__init__(self, host, port) RequestMethods.__init__(self, headers) - self.strict = strict - if not isinstance(timeout, Timeout): timeout = Timeout.from_float(timeout) @@ -203,7 +198,7 @@ def __init__( self.timeout = timeout self.retries = retries - self.pool = self.QueueCls(maxsize) + self.pool: queue.LifoQueue[typing.Any] | None = self.QueueCls(maxsize) self.block = block self.proxy = _proxy @@ -211,7 +206,7 @@ def __init__( self.proxy_config = _proxy_config # Fill the queue up so that doing get() on it will block properly - for _ in xrange(maxsize): + for _ in range(maxsize): self.pool.put(None) # These are mostly for testing and debugging purposes. @@ -236,9 +231,9 @@ def __init__( # Close all the HTTPConnections in the pool before the # HTTPConnectionPool object is garbage collected. - weakref_finalize(self, _close_pool_connections, pool) + weakref.finalize(self, _close_pool_connections, pool) - def _new_conn(self): + def _new_conn(self) -> BaseHTTPConnection: """ Return a fresh :class:`HTTPConnection`. """ @@ -254,12 +249,11 @@ def _new_conn(self): host=self.host, port=self.port, timeout=self.timeout.connect_timeout, - strict=self.strict, - **self.conn_kw + **self.conn_kw, ) return conn - def _get_conn(self, timeout=None): + def _get_conn(self, timeout: float | None = None) -> BaseHTTPConnection: """ Get a connection. Will return a pooled connection if one is available. @@ -272,33 +266,32 @@ def _get_conn(self, timeout=None): :prop:`.block` is ``True``. """ conn = None + + if self.pool is None: + raise ClosedPoolError(self, "Pool is closed.") + try: conn = self.pool.get(block=self.block, timeout=timeout) except AttributeError: # self.pool is None - raise ClosedPoolError(self, "Pool is closed.") + raise ClosedPoolError(self, "Pool is closed.") from None # Defensive: except queue.Empty: if self.block: raise EmptyPoolError( self, - "Pool reached maximum size and no more connections are allowed.", - ) + "Pool is empty and a new connection can't be opened due to blocking mode.", + ) from None pass # Oh well, we'll create a new connection then # If this is a persistent connection, check if it got disconnected if conn and is_connection_dropped(conn): log.debug("Resetting dropped connection: %s", self.host) conn.close() - if getattr(conn, "auto_open", 1) == 0: - # This is a proxied connection that has been mutated by - # http.client._tunnel() and cannot be reused (since it would - # attempt to bypass the proxy) - conn = None return conn or self._new_conn() - def _put_conn(self, conn): + def _put_conn(self, conn: BaseHTTPConnection | None) -> None: """ Put a connection back into the pool. @@ -312,36 +305,47 @@ def _put_conn(self, conn): If the pool is closed, then the connection will be closed and discarded. """ - try: - self.pool.put(conn, block=False) - return # Everything is dandy, done. - except AttributeError: - # self.pool is None. - pass - except queue.Full: - # This should never happen if self.block == True - log.warning( - "Connection pool is full, discarding connection: %s. Connection pool size: %s", - self.host, - self.pool.qsize(), - ) + if self.pool is not None: + try: + self.pool.put(conn, block=False) + return # Everything is dandy, done. + except AttributeError: + # self.pool is None. + pass + except queue.Full: + # Connection never got put back into the pool, close it. + if conn: + conn.close() + + if self.block: + # This should never happen if you got the conn from self._get_conn + raise FullPoolError( + self, + "Pool reached maximum size and no more connections are allowed.", + ) from None + + log.warning( + "Connection pool is full, discarding connection: %s. Connection pool size: %s", + self.host, + self.pool.qsize(), + ) + # Connection never got put back into the pool, close it. if conn: conn.close() - def _validate_conn(self, conn): + def _validate_conn(self, conn: BaseHTTPConnection) -> None: """ Called right before a request is made, after the socket is created. """ - pass - def _prepare_proxy(self, conn): + def _prepare_proxy(self, conn: BaseHTTPConnection) -> None: # Nothing to do for HTTP connections. pass - def _get_timeout(self, timeout): + def _get_timeout(self, timeout: _TYPE_TIMEOUT) -> Timeout: """Helper that always returns a :class:`urllib3.util.Timeout`""" - if timeout is _Default: + if timeout is _DEFAULT_TIMEOUT: return self.timeout.clone() if isinstance(timeout, Timeout): @@ -351,34 +355,40 @@ def _get_timeout(self, timeout): # can be removed later return Timeout.from_float(timeout) - def _raise_timeout(self, err, url, timeout_value): + def _raise_timeout( + self, + err: BaseSSLError | OSError | SocketTimeout, + url: str, + timeout_value: _TYPE_TIMEOUT | None, + ) -> None: """Is the error actually a timeout? Will raise a ReadTimeout or pass""" if isinstance(err, SocketTimeout): raise ReadTimeoutError( - self, url, "Read timed out. (read timeout=%s)" % timeout_value - ) + self, url, f"Read timed out. (read timeout={timeout_value})" + ) from err - # See the above comment about EAGAIN in Python 3. In Python 2 we have - # to specifically catch it and throw the timeout error + # See the above comment about EAGAIN in Python 3. if hasattr(err, "errno") and err.errno in _blocking_errnos: raise ReadTimeoutError( - self, url, "Read timed out. (read timeout=%s)" % timeout_value - ) - - # Catch possible read timeouts thrown as SSL errors. If not the - # case, rethrow the original. We need to do this because of: - # http://bugs.python.org/issue10272 - if "timed out" in str(err) or "did not complete (read)" in str( - err - ): # Python < 2.7.4 - raise ReadTimeoutError( - self, url, "Read timed out. (read timeout=%s)" % timeout_value - ) + self, url, f"Read timed out. (read timeout={timeout_value})" + ) from err def _make_request( - self, conn, method, url, timeout=_Default, chunked=False, **httplib_request_kw - ): + self, + conn: BaseHTTPConnection, + method: str, + url: str, + body: _TYPE_BODY | None = None, + headers: typing.Mapping[str, str] | None = None, + retries: Retry | None = None, + timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, + chunked: bool = False, + response_conn: BaseHTTPConnection | None = None, + preload_content: bool = True, + decode_content: bool = True, + enforce_content_length: bool = True, + ) -> BaseHTTPResponse: """ Perform a request on a given urllib connection object taken from our pool. @@ -386,12 +396,61 @@ def _make_request( :param conn: a connection from one of our connection pools + :param method: + HTTP request method (such as GET, POST, PUT, etc.) + + :param url: + The URL to perform the request on. + + :param body: + Data to send in the request body, either :class:`str`, :class:`bytes`, + an iterable of :class:`str`/:class:`bytes`, or a file-like object. + + :param headers: + Dictionary of custom headers to send, such as User-Agent, + If-None-Match, etc. If None, pool headers are used. If provided, + these headers completely replace any pool-specific headers. + + :param retries: + Configure the number of retries to allow before raising a + :class:`~urllib3.exceptions.MaxRetryError` exception. + + Pass ``None`` to retry until you receive a response. Pass a + :class:`~urllib3.util.retry.Retry` object for fine-grained control + over different types of retries. + Pass an integer number to retry connection errors that many times, + but no other types of errors. Pass zero to never retry. + + If ``False``, then retries are disabled and any exception is raised + immediately. Also, instead of raising a MaxRetryError on redirects, + the redirect response will be returned. + + :type retries: :class:`~urllib3.util.retry.Retry`, False, or an int. + :param timeout: - Socket timeout in seconds for the request. This can be a - float or integer, which will set the same timeout value for - the socket connect and the socket read, or an instance of - :class:`urllib3.util.Timeout`, which gives you more fine-grained - control over your timeouts. + If specified, overrides the default timeout for this one + request. It may be a float (in seconds) or an instance of + :class:`urllib3.util.Timeout`. + + :param chunked: + If True, urllib3 will send the body using chunked transfer + encoding. Otherwise, urllib3 will send the body using the standard + content-length form. Defaults to False. + + :param response_conn: + Set this to ``None`` if you will handle releasing the connection or + set the connection to have the response release it. + + :param preload_content: + If True, the response's body will be preloaded during construction. + + :param decode_content: + If True, will attempt to decode the body based on the + 'content-encoding' header. + + :param enforce_content_length: + Enforce content length checking. Body returned by server must match + value of Content-Length header, if present. Otherwise, raise error. """ self.num_requests += 1 @@ -399,44 +458,66 @@ def _make_request( timeout_obj.start_connect() conn.timeout = Timeout.resolve_default_timeout(timeout_obj.connect_timeout) - # Trigger any extra validation we need to do. try: - self._validate_conn(conn) - except (SocketTimeout, BaseSSLError) as e: - # Py2 raises this as a BaseSSLError, Py3 raises it as socket timeout. - self._raise_timeout(err=e, url=url, timeout_value=conn.timeout) - raise + # Trigger any extra validation we need to do. + try: + self._validate_conn(conn) + except (SocketTimeout, BaseSSLError) as e: + self._raise_timeout(err=e, url=url, timeout_value=conn.timeout) + raise + + # _validate_conn() starts the connection to an HTTPS proxy + # so we need to wrap errors with 'ProxyError' here too. + except ( + OSError, + NewConnectionError, + TimeoutError, + BaseSSLError, + CertificateError, + SSLError, + ) as e: + new_e: Exception = e + if isinstance(e, (BaseSSLError, CertificateError)): + new_e = SSLError(e) + # If the connection didn't successfully connect to it's proxy + # then there + if isinstance( + new_e, (OSError, NewConnectionError, TimeoutError, SSLError) + ) and (conn and conn.proxy and not conn.has_connected_to_proxy): + new_e = _wrap_proxy_error(new_e, conn.proxy.scheme) + raise new_e # conn.request() calls http.client.*.request, not the method in # urllib3.request. It also calls makefile (recv) on the socket. try: - if chunked: - conn.request_chunked(method, url, **httplib_request_kw) - else: - conn.request(method, url, **httplib_request_kw) + conn.request( + method, + url, + body=body, + headers=headers, + chunked=chunked, + preload_content=preload_content, + decode_content=decode_content, + enforce_content_length=enforce_content_length, + ) # We are swallowing BrokenPipeError (errno.EPIPE) since the server is # legitimately able to close the connection after sending a valid response. # With this behaviour, the received response is still readable. except BrokenPipeError: - # Python 3 pass - except IOError as e: - # Python 2 and macOS/Linux - # EPIPE and ESHUTDOWN are BrokenPipeError on Python 2, and EPROTOTYPE is needed on macOS + except OSError as e: + # MacOS/Linux + # EPROTOTYPE and ECONNRESET are needed on macOS # https://erickt.github.io/blog/2014/11/19/adventures-in-debugging-a-potential-osx-kernel-bug/ - if e.errno not in { - errno.EPIPE, - errno.ESHUTDOWN, - errno.EPROTOTYPE, - }: + # Condition changed later to emit ECONNRESET instead of only EPROTOTYPE. + if e.errno != errno.EPROTOTYPE and e.errno != errno.ECONNRESET: raise # Reset the timeout for the recv() on the socket read_timeout = timeout_obj.read_timeout - # App Engine doesn't have a sock attr - if getattr(conn, "sock", None): + if not conn.is_closed: # In Python 3 socket.py will catch EAGAIN and return None when you # try and read into the file pointer created by http.client, which # instead raises a BadStatusLine exception. Instead of catching @@ -444,33 +525,22 @@ def _make_request( # timeouts, check for a zero timeout before making the request. if read_timeout == 0: raise ReadTimeoutError( - self, url, "Read timed out. (read timeout=%s)" % read_timeout + self, url, f"Read timed out. (read timeout={read_timeout})" ) - if read_timeout is Timeout.DEFAULT_TIMEOUT: - conn.sock.settimeout(socket.getdefaulttimeout()) - else: # None or a value - conn.sock.settimeout(read_timeout) + conn.timeout = read_timeout # Receive the response from the server try: - try: - # Python 2.7, use buffering of HTTP responses - httplib_response = conn.getresponse(buffering=True) - except TypeError: - # Python 3 - try: - httplib_response = conn.getresponse() - except BaseException as e: - # Remove the TypeError from the exception chain in - # Python 3 (including for exceptions like SystemExit). - # Otherwise it looks like a bug in the code. - six.raise_from(e, None) - except (SocketTimeout, BaseSSLError, SocketError) as e: + response = conn.getresponse() + except (BaseSSLError, OSError) as e: self._raise_timeout(err=e, url=url, timeout_value=read_timeout) raise - # AppEngine doesn't have a version attr. - http_version = getattr(conn, "_http_vsn_str", "HTTP/?") + # Set properties that are used by the pooling layer. + response.retries = retries + response._connection = response_conn # type: ignore[attr-defined] + response._pool = self # type: ignore[attr-defined] + log.debug( '%s://%s:%s "%s %s %s" %s %s', self.scheme, @@ -478,27 +548,14 @@ def _make_request( self.port, method, url, - http_version, - httplib_response.status, - httplib_response.length, + response.version_string, + response.status, + response.length_remaining, ) - try: - assert_header_parsing(httplib_response.msg) - except (HeaderParsingError, TypeError) as hpe: # Platform-specific: Python 3 - log.warning( - "Failed to parse headers (url=%s): %s", - self._absolute_url(url), - hpe, - exc_info=True, - ) - - return httplib_response - - def _absolute_url(self, path): - return Url(scheme=self.scheme, host=self.host, port=self.port, path=path).url + return response - def close(self): + def close(self) -> None: """ Close all pooled connections and disable the pool. """ @@ -510,7 +567,7 @@ def close(self): # Close all the HTTPConnections in the pool. _close_pool_connections(old_pool) - def is_same_host(self, url): + def is_same_host(self, url: str) -> bool: """ Check if the given ``url`` is a member of the same host as this connection pool. @@ -519,7 +576,8 @@ def is_same_host(self, url): return True # TODO: Add optional support for socket.gethostbyname checking. - scheme, host, port = get_host(url) + scheme, _, host, port, *_ = parse_url(url) + scheme = scheme or "http" if host is not None: host = _normalize_host(host, scheme=scheme) @@ -531,22 +589,24 @@ def is_same_host(self, url): return (scheme, host, port) == (self.scheme, self.host, self.port) - def urlopen( + def urlopen( # type: ignore[override] self, - method, - url, - body=None, - headers=None, - retries=None, - redirect=True, - assert_same_host=True, - timeout=_Default, - pool_timeout=None, - release_conn=None, - chunked=False, - body_pos=None, - **response_kw - ): + method: str, + url: str, + body: _TYPE_BODY | None = None, + headers: typing.Mapping[str, str] | None = None, + retries: Retry | bool | int | None = None, + redirect: bool = True, + assert_same_host: bool = True, + timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, + pool_timeout: int | None = None, + release_conn: bool | None = None, + chunked: bool = False, + body_pos: _TYPE_BODY_POSITION | None = None, + preload_content: bool = True, + decode_content: bool = True, + **response_kw: typing.Any, + ) -> BaseHTTPResponse: """ Get a connection from the pool and perform an HTTP request. This is the lowest level call for making a request, so you'll need to specify all @@ -554,8 +614,8 @@ def urlopen( .. note:: - More commonly, it's appropriate to use a convenience method provided - by :class:`.RequestMethods`, such as :meth:`request`. + More commonly, it's appropriate to use a convenience method + such as :meth:`request`. .. note:: @@ -583,7 +643,7 @@ def urlopen( Configure the number of retries to allow before raising a :class:`~urllib3.exceptions.MaxRetryError` exception. - Pass ``None`` to retry until you receive a response. Pass a + If ``None`` (default) will retry 3 times, see ``Retry.DEFAULT``. Pass a :class:`~urllib3.util.retry.Retry` object for fine-grained control over different types of retries. Pass an integer number to retry connection errors that many times, @@ -615,6 +675,13 @@ def urlopen( block for ``pool_timeout`` seconds and raise EmptyPoolError if no connection is available within the time period. + :param bool preload_content: + If True, the response's body will be preloaded into memory. + + :param bool decode_content: + If True, will attempt to decode the body based on the + 'content-encoding' header. + :param release_conn: If False, then the urlopen call will not release the connection back into the pool once a response is received (but will release if @@ -622,10 +689,10 @@ def urlopen( `preload_content=True`). This is useful if you're not preloading the response's content immediately. You will need to call ``r.release_conn()`` on the response ``r`` to return the connection - back into the pool. If None, it takes the value of - ``response_kw.get('preload_content', True)``. + back into the pool. If None, it takes the value of ``preload_content`` + which defaults to ``True``. - :param chunked: + :param bool chunked: If True, urllib3 will send the body using chunked transfer encoding. Otherwise, urllib3 will send the body using the standard content-length form. Defaults to False. @@ -634,12 +701,7 @@ def urlopen( Position to seek to in file-like body in the event of a retry or redirect. Typically this won't need to be set because urllib3 will auto-populate the value when needed. - - :param \\**response_kw: - Additional parameters are passed to - :meth:`urllib3.response.HTTPResponse.from_httplib` """ - parsed_url = parse_url(url) destination_scheme = parsed_url.scheme @@ -650,7 +712,7 @@ def urlopen( retries = Retry.from_int(retries, redirect=redirect, default=self.retries) if release_conn is None: - release_conn = response_kw.get("preload_content", True) + release_conn = preload_content # Check host if assert_same_host and not self.is_same_host(url): @@ -658,9 +720,9 @@ def urlopen( # Ensure that the URL we're connecting to is properly encoded if url.startswith("/"): - url = six.ensure_str(_encode_target(url)) + url = to_str(_encode_target(url)) else: - url = six.ensure_str(parsed_url.url) + url = to_str(parsed_url.url) conn = None @@ -683,8 +745,8 @@ def urlopen( # have to copy the headers dict so we can safely change it without those # changes being reflected in anyone else's copy. if not http_tunnel_required: - headers = headers.copy() - headers.update(self.proxy_headers) + headers = headers.copy() # type: ignore[attr-defined] + headers.update(self.proxy_headers) # type: ignore[union-attr] # Must keep the exception bound to a separate variable or else Python 3 # complains about UnboundLocalError. @@ -703,16 +765,26 @@ def urlopen( timeout_obj = self._get_timeout(timeout) conn = self._get_conn(timeout=pool_timeout) - conn.timeout = timeout_obj.connect_timeout + conn.timeout = timeout_obj.connect_timeout # type: ignore[assignment] - is_new_proxy_conn = self.proxy is not None and not getattr( - conn, "sock", None - ) - if is_new_proxy_conn and http_tunnel_required: - self._prepare_proxy(conn) + # Is this a closed/new connection that requires CONNECT tunnelling? + if self.proxy is not None and http_tunnel_required and conn.is_closed: + try: + self._prepare_proxy(conn) + except (BaseSSLError, OSError, SocketTimeout) as e: + self._raise_timeout( + err=e, url=self.proxy.url, timeout_value=conn.timeout + ) + raise + + # If we're going to release the connection in ``finally:``, then + # the response doesn't need to know about the connection. Otherwise + # it will also try to release it and we'll have a double-release + # mess. + response_conn = conn if not release_conn else None - # Make the request on the httplib connection object. - httplib_response = self._make_request( + # Make the request on the HTTPConnection object + response = self._make_request( conn, method, url, @@ -720,24 +792,11 @@ def urlopen( body=body, headers=headers, chunked=chunked, - ) - - # If we're going to release the connection in ``finally:``, then - # the response doesn't need to know about the connection. Otherwise - # it will also try to release it and we'll have a double-release - # mess. - response_conn = conn if not release_conn else None - - # Pass method to Response for length checking - response_kw["request_method"] = method - - # Import httplib's response into our own wrapper object - response = self.ResponseCls.from_httplib( - httplib_response, - pool=self, - connection=response_conn, retries=retries, - **response_kw + response_conn=response_conn, + preload_content=preload_content, + decode_content=decode_content, + **response_kw, ) # Everything went great! @@ -752,54 +811,35 @@ def urlopen( except ( TimeoutError, HTTPException, - SocketError, + OSError, ProtocolError, BaseSSLError, SSLError, CertificateError, + ProxyError, ) as e: # Discard the connection for these exceptions. It will be # replaced during the next _get_conn() call. clean_exit = False - - def _is_ssl_error_message_from_http_proxy(ssl_error): - # We're trying to detect the message 'WRONG_VERSION_NUMBER' but - # SSLErrors are kinda all over the place when it comes to the message, - # so we try to cover our bases here! - message = " ".join(re.split("[^a-z]", str(ssl_error).lower())) - return ( - "wrong version number" in message - or "unknown protocol" in message - or "record layer failure" in message - ) - - # Try to detect a common user error with proxies which is to - # set an HTTP proxy to be HTTPS when it should be 'http://' - # (ie {'http': 'http://proxy', 'https': 'https://proxy'}) - # Instead we add a nice error message and point to a URL. - if ( - isinstance(e, BaseSSLError) - and self.proxy - and _is_ssl_error_message_from_http_proxy(e) - and conn.proxy - and conn.proxy.scheme == "https" - ): - e = ProxyError( - "Your proxy appears to only use HTTP and not HTTPS, " - "try changing your proxy URL to be HTTP. See: " - "https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html" - "#https-proxy-error-http-proxy", - SSLError(e), - ) - elif isinstance(e, (BaseSSLError, CertificateError)): - e = SSLError(e) - elif isinstance(e, (SocketError, NewConnectionError)) and self.proxy: - e = ProxyError("Cannot connect to proxy.", e) - elif isinstance(e, (SocketError, HTTPException)): - e = ProtocolError("Connection aborted.", e) + new_e: Exception = e + if isinstance(e, (BaseSSLError, CertificateError)): + new_e = SSLError(e) + if isinstance( + new_e, + ( + OSError, + NewConnectionError, + TimeoutError, + SSLError, + HTTPException, + ), + ) and (conn and conn.proxy and not conn.has_connected_to_proxy): + new_e = _wrap_proxy_error(new_e, conn.proxy.scheme) + elif isinstance(new_e, (OSError, HTTPException)): + new_e = ProtocolError("Connection aborted.", new_e) retries = retries.increment( - method, url, error=e, _pool=self, _stacktrace=sys.exc_info()[2] + method, url, error=new_e, _pool=self, _stacktrace=sys.exc_info()[2] ) retries.sleep() @@ -812,7 +852,9 @@ def _is_ssl_error_message_from_http_proxy(ssl_error): # to throw the connection away unless explicitly told not to. # Close the connection, set the variable to None, and make sure # we put the None back in the pool to avoid leaking it. - conn = conn and conn.close() + if conn: + conn.close() + conn = None release_this_conn = True if release_this_conn: @@ -839,7 +881,9 @@ def _is_ssl_error_message_from_http_proxy(ssl_error): release_conn=release_conn, chunked=chunked, body_pos=body_pos, - **response_kw + preload_content=preload_content, + decode_content=decode_content, + **response_kw, ) # Handle redirect? @@ -876,7 +920,9 @@ def _is_ssl_error_message_from_http_proxy(ssl_error): release_conn=release_conn, chunked=chunked, body_pos=body_pos, - **response_kw + preload_content=preload_content, + decode_content=decode_content, + **response_kw, ) # Check if we should retry the HTTP response. @@ -906,7 +952,9 @@ def _is_ssl_error_message_from_http_proxy(ssl_error): release_conn=release_conn, chunked=chunked, body_pos=body_pos, - **response_kw + preload_content=preload_content, + decode_content=decode_content, + **response_kw, ) return response @@ -927,37 +975,35 @@ class HTTPSConnectionPool(HTTPConnectionPool): """ scheme = "https" - ConnectionCls = HTTPSConnection + ConnectionCls: type[BaseHTTPSConnection] = HTTPSConnection def __init__( self, - host, - port=None, - strict=False, - timeout=Timeout.DEFAULT_TIMEOUT, - maxsize=1, - block=False, - headers=None, - retries=None, - _proxy=None, - _proxy_headers=None, - key_file=None, - cert_file=None, - cert_reqs=None, - key_password=None, - ca_certs=None, - ssl_version=None, - assert_hostname=None, - assert_fingerprint=None, - ca_cert_dir=None, - **conn_kw - ): - - HTTPConnectionPool.__init__( - self, + host: str, + port: int | None = None, + timeout: _TYPE_TIMEOUT | None = _DEFAULT_TIMEOUT, + maxsize: int = 1, + block: bool = False, + headers: typing.Mapping[str, str] | None = None, + retries: Retry | bool | int | None = None, + _proxy: Url | None = None, + _proxy_headers: typing.Mapping[str, str] | None = None, + key_file: str | None = None, + cert_file: str | None = None, + cert_reqs: int | str | None = None, + key_password: str | None = None, + ca_certs: str | None = None, + ssl_version: int | str | None = None, + ssl_minimum_version: ssl.TLSVersion | None = None, + ssl_maximum_version: ssl.TLSVersion | None = None, + assert_hostname: str | typing.Literal[False] | None = None, + assert_fingerprint: str | None = None, + ca_cert_dir: str | None = None, + **conn_kw: typing.Any, + ) -> None: + super().__init__( host, port, - strict, timeout, maxsize, block, @@ -965,7 +1011,7 @@ def __init__( retries, _proxy, _proxy_headers, - **conn_kw + **conn_kw, ) self.key_file = key_file @@ -975,47 +1021,29 @@ def __init__( self.ca_certs = ca_certs self.ca_cert_dir = ca_cert_dir self.ssl_version = ssl_version + self.ssl_minimum_version = ssl_minimum_version + self.ssl_maximum_version = ssl_maximum_version self.assert_hostname = assert_hostname self.assert_fingerprint = assert_fingerprint - def _prepare_conn(self, conn): - """ - Prepare the ``connection`` for :meth:`urllib3.util.ssl_wrap_socket` - and establish the tunnel if proxy is used. - """ - - if isinstance(conn, VerifiedHTTPSConnection): - conn.set_cert( - key_file=self.key_file, - key_password=self.key_password, - cert_file=self.cert_file, - cert_reqs=self.cert_reqs, - ca_certs=self.ca_certs, - ca_cert_dir=self.ca_cert_dir, - assert_hostname=self.assert_hostname, - assert_fingerprint=self.assert_fingerprint, - ) - conn.ssl_version = self.ssl_version - return conn - - def _prepare_proxy(self, conn): - """ - Establishes a tunnel connection through HTTP CONNECT. - - Tunnel connection is established early because otherwise httplib would - improperly set Host: header to proxy's IP:port. - """ - - conn.set_tunnel(self._proxy_host, self.port, self.proxy_headers) - - if self.proxy.scheme == "https": - conn.tls_in_tls_required = True + def _prepare_proxy(self, conn: HTTPSConnection) -> None: # type: ignore[override] + """Establishes a tunnel connection through HTTP CONNECT.""" + if self.proxy and self.proxy.scheme == "https": + tunnel_scheme = "https" + else: + tunnel_scheme = "http" + conn.set_tunnel( + scheme=tunnel_scheme, + host=self._tunnel_host, + port=self.port, + headers=self.proxy_headers, + ) conn.connect() - def _new_conn(self): + def _new_conn(self) -> BaseHTTPSConnection: """ - Return a fresh :class:`http.client.HTTPSConnection`. + Return a fresh :class:`urllib3.connection.HTTPConnection`. """ self.num_connections += 1 log.debug( @@ -1025,64 +1053,59 @@ def _new_conn(self): self.port or "443", ) - if not self.ConnectionCls or self.ConnectionCls is DummyConnection: - raise SSLError( + if not self.ConnectionCls or self.ConnectionCls is DummyConnection: # type: ignore[comparison-overlap] + raise ImportError( "Can't connect to HTTPS URL because the SSL module is not available." ) - actual_host = self.host + actual_host: str = self.host actual_port = self.port - if self.proxy is not None: + if self.proxy is not None and self.proxy.host is not None: actual_host = self.proxy.host actual_port = self.proxy.port - conn = self.ConnectionCls( + return self.ConnectionCls( host=actual_host, port=actual_port, timeout=self.timeout.connect_timeout, - strict=self.strict, cert_file=self.cert_file, key_file=self.key_file, key_password=self.key_password, - **self.conn_kw + cert_reqs=self.cert_reqs, + ca_certs=self.ca_certs, + ca_cert_dir=self.ca_cert_dir, + assert_hostname=self.assert_hostname, + assert_fingerprint=self.assert_fingerprint, + ssl_version=self.ssl_version, + ssl_minimum_version=self.ssl_minimum_version, + ssl_maximum_version=self.ssl_maximum_version, + **self.conn_kw, ) - return self._prepare_conn(conn) - - def _validate_conn(self, conn): + def _validate_conn(self, conn: BaseHTTPConnection) -> None: """ Called right before a request is made, after the socket is created. """ - super(HTTPSConnectionPool, self)._validate_conn(conn) + super()._validate_conn(conn) # Force connect early to allow us to validate the connection. - if not getattr(conn, "sock", None): # AppEngine might not have `.sock` + if conn.is_closed: conn.connect() - if not conn.is_verified: - warnings.warn( - ( - "Unverified HTTPS request is being made to host '%s'. " - "Adding certificate verification is strongly advised. See: " - "https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html" - "#ssl-warnings" % conn.host - ), - InsecureRequestWarning, - ) - - if getattr(conn, "proxy_is_verified", None) is False: + # TODO revise this, see https://github.com/urllib3/urllib3/issues/2791 + if not conn.is_verified and not conn.proxy_is_verified: warnings.warn( ( - "Unverified HTTPS connection done to an HTTPS proxy. " + f"Unverified HTTPS request is being made to host '{conn.host}'. " "Adding certificate verification is strongly advised. See: " - "https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html" - "#ssl-warnings" + "https://urllib3.readthedocs.io/en/latest/advanced-usage.html" + "#tls-warnings" ), InsecureRequestWarning, ) -def connection_from_url(url, **kw): +def connection_from_url(url: str, **kw: typing.Any) -> HTTPConnectionPool: """ Given a url, return an :class:`.ConnectionPool` instance of its host. @@ -1102,15 +1125,24 @@ def connection_from_url(url, **kw): >>> conn = connection_from_url('http://google.com/') >>> r = conn.request('GET', '/') """ - scheme, host, port = get_host(url) + scheme, _, host, port, *_ = parse_url(url) + scheme = scheme or "http" port = port or port_by_scheme.get(scheme, 80) if scheme == "https": - return HTTPSConnectionPool(host, port=port, **kw) + return HTTPSConnectionPool(host, port=port, **kw) # type: ignore[arg-type] else: - return HTTPConnectionPool(host, port=port, **kw) + return HTTPConnectionPool(host, port=port, **kw) # type: ignore[arg-type] + +@typing.overload +def _normalize_host(host: None, scheme: str | None) -> None: ... -def _normalize_host(host, scheme): + +@typing.overload +def _normalize_host(host: str, scheme: str | None) -> str: ... + + +def _normalize_host(host: str | None, scheme: str | None) -> str | None: """ Normalize hosts for comparisons and use with sockets. """ @@ -1123,12 +1155,19 @@ def _normalize_host(host, scheme): # Instead, we need to make sure we never pass ``None`` as the port. # However, for backward compatibility reasons we can't actually # *assert* that. See http://bugs.python.org/issue28539 - if host.startswith("[") and host.endswith("]"): + if host and host.startswith("[") and host.endswith("]"): host = host[1:-1] return host -def _close_pool_connections(pool): +def _url_from_pool( + pool: HTTPConnectionPool | HTTPSConnectionPool, path: str | None = None +) -> str: + """Returns the URL from a given connection pool. This is mainly used for testing and logging.""" + return Url(scheme=pool.scheme, host=pool.host, port=pool.port, path=path).url + + +def _close_pool_connections(pool: queue.LifoQueue[typing.Any]) -> None: """Drains a queue of connections and closes each one.""" try: while True: diff --git a/newrelic/packages/urllib3/contrib/_appengine_environ.py b/newrelic/packages/urllib3/contrib/_appengine_environ.py deleted file mode 100644 index 8765b907d7..0000000000 --- a/newrelic/packages/urllib3/contrib/_appengine_environ.py +++ /dev/null @@ -1,36 +0,0 @@ -""" -This module provides means to detect the App Engine environment. -""" - -import os - - -def is_appengine(): - return is_local_appengine() or is_prod_appengine() - - -def is_appengine_sandbox(): - """Reports if the app is running in the first generation sandbox. - - The second generation runtimes are technically still in a sandbox, but it - is much less restrictive, so generally you shouldn't need to check for it. - see https://cloud.google.com/appengine/docs/standard/runtimes - """ - return is_appengine() and os.environ["APPENGINE_RUNTIME"] == "python27" - - -def is_local_appengine(): - return "APPENGINE_RUNTIME" in os.environ and os.environ.get( - "SERVER_SOFTWARE", "" - ).startswith("Development/") - - -def is_prod_appengine(): - return "APPENGINE_RUNTIME" in os.environ and os.environ.get( - "SERVER_SOFTWARE", "" - ).startswith("Google App Engine/") - - -def is_prod_appengine_mvms(): - """Deprecated.""" - return False diff --git a/newrelic/packages/urllib3/contrib/_securetransport/__init__.py b/newrelic/packages/urllib3/contrib/_securetransport/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/newrelic/packages/urllib3/contrib/_securetransport/bindings.py b/newrelic/packages/urllib3/contrib/_securetransport/bindings.py deleted file mode 100644 index 264d564dbd..0000000000 --- a/newrelic/packages/urllib3/contrib/_securetransport/bindings.py +++ /dev/null @@ -1,519 +0,0 @@ -""" -This module uses ctypes to bind a whole bunch of functions and constants from -SecureTransport. The goal here is to provide the low-level API to -SecureTransport. These are essentially the C-level functions and constants, and -they're pretty gross to work with. - -This code is a bastardised version of the code found in Will Bond's oscrypto -library. An enormous debt is owed to him for blazing this trail for us. For -that reason, this code should be considered to be covered both by urllib3's -license and by oscrypto's: - - Copyright (c) 2015-2016 Will Bond - - Permission is hereby granted, free of charge, to any person obtaining a - copy of this software and associated documentation files (the "Software"), - to deal in the Software without restriction, including without limitation - the rights to use, copy, modify, merge, publish, distribute, sublicense, - and/or sell copies of the Software, and to permit persons to whom the - Software is furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice shall be included in - all copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING - FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER - DEALINGS IN THE SOFTWARE. -""" -from __future__ import absolute_import - -import platform -from ctypes import ( - CDLL, - CFUNCTYPE, - POINTER, - c_bool, - c_byte, - c_char_p, - c_int32, - c_long, - c_size_t, - c_uint32, - c_ulong, - c_void_p, -) -from ctypes.util import find_library - -from ...packages.six import raise_from - -if platform.system() != "Darwin": - raise ImportError("Only macOS is supported") - -version = platform.mac_ver()[0] -version_info = tuple(map(int, version.split("."))) -if version_info < (10, 8): - raise OSError( - "Only OS X 10.8 and newer are supported, not %s.%s" - % (version_info[0], version_info[1]) - ) - - -def load_cdll(name, macos10_16_path): - """Loads a CDLL by name, falling back to known path on 10.16+""" - try: - # Big Sur is technically 11 but we use 10.16 due to the Big Sur - # beta being labeled as 10.16. - if version_info >= (10, 16): - path = macos10_16_path - else: - path = find_library(name) - if not path: - raise OSError # Caught and reraised as 'ImportError' - return CDLL(path, use_errno=True) - except OSError: - raise_from(ImportError("The library %s failed to load" % name), None) - - -Security = load_cdll( - "Security", "/System/Library/Frameworks/Security.framework/Security" -) -CoreFoundation = load_cdll( - "CoreFoundation", - "/System/Library/Frameworks/CoreFoundation.framework/CoreFoundation", -) - - -Boolean = c_bool -CFIndex = c_long -CFStringEncoding = c_uint32 -CFData = c_void_p -CFString = c_void_p -CFArray = c_void_p -CFMutableArray = c_void_p -CFDictionary = c_void_p -CFError = c_void_p -CFType = c_void_p -CFTypeID = c_ulong - -CFTypeRef = POINTER(CFType) -CFAllocatorRef = c_void_p - -OSStatus = c_int32 - -CFDataRef = POINTER(CFData) -CFStringRef = POINTER(CFString) -CFArrayRef = POINTER(CFArray) -CFMutableArrayRef = POINTER(CFMutableArray) -CFDictionaryRef = POINTER(CFDictionary) -CFArrayCallBacks = c_void_p -CFDictionaryKeyCallBacks = c_void_p -CFDictionaryValueCallBacks = c_void_p - -SecCertificateRef = POINTER(c_void_p) -SecExternalFormat = c_uint32 -SecExternalItemType = c_uint32 -SecIdentityRef = POINTER(c_void_p) -SecItemImportExportFlags = c_uint32 -SecItemImportExportKeyParameters = c_void_p -SecKeychainRef = POINTER(c_void_p) -SSLProtocol = c_uint32 -SSLCipherSuite = c_uint32 -SSLContextRef = POINTER(c_void_p) -SecTrustRef = POINTER(c_void_p) -SSLConnectionRef = c_uint32 -SecTrustResultType = c_uint32 -SecTrustOptionFlags = c_uint32 -SSLProtocolSide = c_uint32 -SSLConnectionType = c_uint32 -SSLSessionOption = c_uint32 - - -try: - Security.SecItemImport.argtypes = [ - CFDataRef, - CFStringRef, - POINTER(SecExternalFormat), - POINTER(SecExternalItemType), - SecItemImportExportFlags, - POINTER(SecItemImportExportKeyParameters), - SecKeychainRef, - POINTER(CFArrayRef), - ] - Security.SecItemImport.restype = OSStatus - - Security.SecCertificateGetTypeID.argtypes = [] - Security.SecCertificateGetTypeID.restype = CFTypeID - - Security.SecIdentityGetTypeID.argtypes = [] - Security.SecIdentityGetTypeID.restype = CFTypeID - - Security.SecKeyGetTypeID.argtypes = [] - Security.SecKeyGetTypeID.restype = CFTypeID - - Security.SecCertificateCreateWithData.argtypes = [CFAllocatorRef, CFDataRef] - Security.SecCertificateCreateWithData.restype = SecCertificateRef - - Security.SecCertificateCopyData.argtypes = [SecCertificateRef] - Security.SecCertificateCopyData.restype = CFDataRef - - Security.SecCopyErrorMessageString.argtypes = [OSStatus, c_void_p] - Security.SecCopyErrorMessageString.restype = CFStringRef - - Security.SecIdentityCreateWithCertificate.argtypes = [ - CFTypeRef, - SecCertificateRef, - POINTER(SecIdentityRef), - ] - Security.SecIdentityCreateWithCertificate.restype = OSStatus - - Security.SecKeychainCreate.argtypes = [ - c_char_p, - c_uint32, - c_void_p, - Boolean, - c_void_p, - POINTER(SecKeychainRef), - ] - Security.SecKeychainCreate.restype = OSStatus - - Security.SecKeychainDelete.argtypes = [SecKeychainRef] - Security.SecKeychainDelete.restype = OSStatus - - Security.SecPKCS12Import.argtypes = [ - CFDataRef, - CFDictionaryRef, - POINTER(CFArrayRef), - ] - Security.SecPKCS12Import.restype = OSStatus - - SSLReadFunc = CFUNCTYPE(OSStatus, SSLConnectionRef, c_void_p, POINTER(c_size_t)) - SSLWriteFunc = CFUNCTYPE( - OSStatus, SSLConnectionRef, POINTER(c_byte), POINTER(c_size_t) - ) - - Security.SSLSetIOFuncs.argtypes = [SSLContextRef, SSLReadFunc, SSLWriteFunc] - Security.SSLSetIOFuncs.restype = OSStatus - - Security.SSLSetPeerID.argtypes = [SSLContextRef, c_char_p, c_size_t] - Security.SSLSetPeerID.restype = OSStatus - - Security.SSLSetCertificate.argtypes = [SSLContextRef, CFArrayRef] - Security.SSLSetCertificate.restype = OSStatus - - Security.SSLSetCertificateAuthorities.argtypes = [SSLContextRef, CFTypeRef, Boolean] - Security.SSLSetCertificateAuthorities.restype = OSStatus - - Security.SSLSetConnection.argtypes = [SSLContextRef, SSLConnectionRef] - Security.SSLSetConnection.restype = OSStatus - - Security.SSLSetPeerDomainName.argtypes = [SSLContextRef, c_char_p, c_size_t] - Security.SSLSetPeerDomainName.restype = OSStatus - - Security.SSLHandshake.argtypes = [SSLContextRef] - Security.SSLHandshake.restype = OSStatus - - Security.SSLRead.argtypes = [SSLContextRef, c_char_p, c_size_t, POINTER(c_size_t)] - Security.SSLRead.restype = OSStatus - - Security.SSLWrite.argtypes = [SSLContextRef, c_char_p, c_size_t, POINTER(c_size_t)] - Security.SSLWrite.restype = OSStatus - - Security.SSLClose.argtypes = [SSLContextRef] - Security.SSLClose.restype = OSStatus - - Security.SSLGetNumberSupportedCiphers.argtypes = [SSLContextRef, POINTER(c_size_t)] - Security.SSLGetNumberSupportedCiphers.restype = OSStatus - - Security.SSLGetSupportedCiphers.argtypes = [ - SSLContextRef, - POINTER(SSLCipherSuite), - POINTER(c_size_t), - ] - Security.SSLGetSupportedCiphers.restype = OSStatus - - Security.SSLSetEnabledCiphers.argtypes = [ - SSLContextRef, - POINTER(SSLCipherSuite), - c_size_t, - ] - Security.SSLSetEnabledCiphers.restype = OSStatus - - Security.SSLGetNumberEnabledCiphers.argtype = [SSLContextRef, POINTER(c_size_t)] - Security.SSLGetNumberEnabledCiphers.restype = OSStatus - - Security.SSLGetEnabledCiphers.argtypes = [ - SSLContextRef, - POINTER(SSLCipherSuite), - POINTER(c_size_t), - ] - Security.SSLGetEnabledCiphers.restype = OSStatus - - Security.SSLGetNegotiatedCipher.argtypes = [SSLContextRef, POINTER(SSLCipherSuite)] - Security.SSLGetNegotiatedCipher.restype = OSStatus - - Security.SSLGetNegotiatedProtocolVersion.argtypes = [ - SSLContextRef, - POINTER(SSLProtocol), - ] - Security.SSLGetNegotiatedProtocolVersion.restype = OSStatus - - Security.SSLCopyPeerTrust.argtypes = [SSLContextRef, POINTER(SecTrustRef)] - Security.SSLCopyPeerTrust.restype = OSStatus - - Security.SecTrustSetAnchorCertificates.argtypes = [SecTrustRef, CFArrayRef] - Security.SecTrustSetAnchorCertificates.restype = OSStatus - - Security.SecTrustSetAnchorCertificatesOnly.argstypes = [SecTrustRef, Boolean] - Security.SecTrustSetAnchorCertificatesOnly.restype = OSStatus - - Security.SecTrustEvaluate.argtypes = [SecTrustRef, POINTER(SecTrustResultType)] - Security.SecTrustEvaluate.restype = OSStatus - - Security.SecTrustGetCertificateCount.argtypes = [SecTrustRef] - Security.SecTrustGetCertificateCount.restype = CFIndex - - Security.SecTrustGetCertificateAtIndex.argtypes = [SecTrustRef, CFIndex] - Security.SecTrustGetCertificateAtIndex.restype = SecCertificateRef - - Security.SSLCreateContext.argtypes = [ - CFAllocatorRef, - SSLProtocolSide, - SSLConnectionType, - ] - Security.SSLCreateContext.restype = SSLContextRef - - Security.SSLSetSessionOption.argtypes = [SSLContextRef, SSLSessionOption, Boolean] - Security.SSLSetSessionOption.restype = OSStatus - - Security.SSLSetProtocolVersionMin.argtypes = [SSLContextRef, SSLProtocol] - Security.SSLSetProtocolVersionMin.restype = OSStatus - - Security.SSLSetProtocolVersionMax.argtypes = [SSLContextRef, SSLProtocol] - Security.SSLSetProtocolVersionMax.restype = OSStatus - - try: - Security.SSLSetALPNProtocols.argtypes = [SSLContextRef, CFArrayRef] - Security.SSLSetALPNProtocols.restype = OSStatus - except AttributeError: - # Supported only in 10.12+ - pass - - Security.SecCopyErrorMessageString.argtypes = [OSStatus, c_void_p] - Security.SecCopyErrorMessageString.restype = CFStringRef - - Security.SSLReadFunc = SSLReadFunc - Security.SSLWriteFunc = SSLWriteFunc - Security.SSLContextRef = SSLContextRef - Security.SSLProtocol = SSLProtocol - Security.SSLCipherSuite = SSLCipherSuite - Security.SecIdentityRef = SecIdentityRef - Security.SecKeychainRef = SecKeychainRef - Security.SecTrustRef = SecTrustRef - Security.SecTrustResultType = SecTrustResultType - Security.SecExternalFormat = SecExternalFormat - Security.OSStatus = OSStatus - - Security.kSecImportExportPassphrase = CFStringRef.in_dll( - Security, "kSecImportExportPassphrase" - ) - Security.kSecImportItemIdentity = CFStringRef.in_dll( - Security, "kSecImportItemIdentity" - ) - - # CoreFoundation time! - CoreFoundation.CFRetain.argtypes = [CFTypeRef] - CoreFoundation.CFRetain.restype = CFTypeRef - - CoreFoundation.CFRelease.argtypes = [CFTypeRef] - CoreFoundation.CFRelease.restype = None - - CoreFoundation.CFGetTypeID.argtypes = [CFTypeRef] - CoreFoundation.CFGetTypeID.restype = CFTypeID - - CoreFoundation.CFStringCreateWithCString.argtypes = [ - CFAllocatorRef, - c_char_p, - CFStringEncoding, - ] - CoreFoundation.CFStringCreateWithCString.restype = CFStringRef - - CoreFoundation.CFStringGetCStringPtr.argtypes = [CFStringRef, CFStringEncoding] - CoreFoundation.CFStringGetCStringPtr.restype = c_char_p - - CoreFoundation.CFStringGetCString.argtypes = [ - CFStringRef, - c_char_p, - CFIndex, - CFStringEncoding, - ] - CoreFoundation.CFStringGetCString.restype = c_bool - - CoreFoundation.CFDataCreate.argtypes = [CFAllocatorRef, c_char_p, CFIndex] - CoreFoundation.CFDataCreate.restype = CFDataRef - - CoreFoundation.CFDataGetLength.argtypes = [CFDataRef] - CoreFoundation.CFDataGetLength.restype = CFIndex - - CoreFoundation.CFDataGetBytePtr.argtypes = [CFDataRef] - CoreFoundation.CFDataGetBytePtr.restype = c_void_p - - CoreFoundation.CFDictionaryCreate.argtypes = [ - CFAllocatorRef, - POINTER(CFTypeRef), - POINTER(CFTypeRef), - CFIndex, - CFDictionaryKeyCallBacks, - CFDictionaryValueCallBacks, - ] - CoreFoundation.CFDictionaryCreate.restype = CFDictionaryRef - - CoreFoundation.CFDictionaryGetValue.argtypes = [CFDictionaryRef, CFTypeRef] - CoreFoundation.CFDictionaryGetValue.restype = CFTypeRef - - CoreFoundation.CFArrayCreate.argtypes = [ - CFAllocatorRef, - POINTER(CFTypeRef), - CFIndex, - CFArrayCallBacks, - ] - CoreFoundation.CFArrayCreate.restype = CFArrayRef - - CoreFoundation.CFArrayCreateMutable.argtypes = [ - CFAllocatorRef, - CFIndex, - CFArrayCallBacks, - ] - CoreFoundation.CFArrayCreateMutable.restype = CFMutableArrayRef - - CoreFoundation.CFArrayAppendValue.argtypes = [CFMutableArrayRef, c_void_p] - CoreFoundation.CFArrayAppendValue.restype = None - - CoreFoundation.CFArrayGetCount.argtypes = [CFArrayRef] - CoreFoundation.CFArrayGetCount.restype = CFIndex - - CoreFoundation.CFArrayGetValueAtIndex.argtypes = [CFArrayRef, CFIndex] - CoreFoundation.CFArrayGetValueAtIndex.restype = c_void_p - - CoreFoundation.kCFAllocatorDefault = CFAllocatorRef.in_dll( - CoreFoundation, "kCFAllocatorDefault" - ) - CoreFoundation.kCFTypeArrayCallBacks = c_void_p.in_dll( - CoreFoundation, "kCFTypeArrayCallBacks" - ) - CoreFoundation.kCFTypeDictionaryKeyCallBacks = c_void_p.in_dll( - CoreFoundation, "kCFTypeDictionaryKeyCallBacks" - ) - CoreFoundation.kCFTypeDictionaryValueCallBacks = c_void_p.in_dll( - CoreFoundation, "kCFTypeDictionaryValueCallBacks" - ) - - CoreFoundation.CFTypeRef = CFTypeRef - CoreFoundation.CFArrayRef = CFArrayRef - CoreFoundation.CFStringRef = CFStringRef - CoreFoundation.CFDictionaryRef = CFDictionaryRef - -except (AttributeError): - raise ImportError("Error initializing ctypes") - - -class CFConst(object): - """ - A class object that acts as essentially a namespace for CoreFoundation - constants. - """ - - kCFStringEncodingUTF8 = CFStringEncoding(0x08000100) - - -class SecurityConst(object): - """ - A class object that acts as essentially a namespace for Security constants. - """ - - kSSLSessionOptionBreakOnServerAuth = 0 - - kSSLProtocol2 = 1 - kSSLProtocol3 = 2 - kTLSProtocol1 = 4 - kTLSProtocol11 = 7 - kTLSProtocol12 = 8 - # SecureTransport does not support TLS 1.3 even if there's a constant for it - kTLSProtocol13 = 10 - kTLSProtocolMaxSupported = 999 - - kSSLClientSide = 1 - kSSLStreamType = 0 - - kSecFormatPEMSequence = 10 - - kSecTrustResultInvalid = 0 - kSecTrustResultProceed = 1 - # This gap is present on purpose: this was kSecTrustResultConfirm, which - # is deprecated. - kSecTrustResultDeny = 3 - kSecTrustResultUnspecified = 4 - kSecTrustResultRecoverableTrustFailure = 5 - kSecTrustResultFatalTrustFailure = 6 - kSecTrustResultOtherError = 7 - - errSSLProtocol = -9800 - errSSLWouldBlock = -9803 - errSSLClosedGraceful = -9805 - errSSLClosedNoNotify = -9816 - errSSLClosedAbort = -9806 - - errSSLXCertChainInvalid = -9807 - errSSLCrypto = -9809 - errSSLInternal = -9810 - errSSLCertExpired = -9814 - errSSLCertNotYetValid = -9815 - errSSLUnknownRootCert = -9812 - errSSLNoRootCert = -9813 - errSSLHostNameMismatch = -9843 - errSSLPeerHandshakeFail = -9824 - errSSLPeerUserCancelled = -9839 - errSSLWeakPeerEphemeralDHKey = -9850 - errSSLServerAuthCompleted = -9841 - errSSLRecordOverflow = -9847 - - errSecVerifyFailed = -67808 - errSecNoTrustSettings = -25263 - errSecItemNotFound = -25300 - errSecInvalidTrustSettings = -25262 - - # Cipher suites. We only pick the ones our default cipher string allows. - # Source: https://developer.apple.com/documentation/security/1550981-ssl_cipher_suite_values - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 = 0xC02C - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 = 0xC030 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 = 0xC02B - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 = 0xC02F - TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 = 0xCCA9 - TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 = 0xCCA8 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 = 0x009F - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 = 0x009E - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 = 0xC024 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 = 0xC028 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA = 0xC00A - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA = 0xC014 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 = 0x006B - TLS_DHE_RSA_WITH_AES_256_CBC_SHA = 0x0039 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 = 0xC023 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 = 0xC027 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 0xC009 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA = 0xC013 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 = 0x0067 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA = 0x0033 - TLS_RSA_WITH_AES_256_GCM_SHA384 = 0x009D - TLS_RSA_WITH_AES_128_GCM_SHA256 = 0x009C - TLS_RSA_WITH_AES_256_CBC_SHA256 = 0x003D - TLS_RSA_WITH_AES_128_CBC_SHA256 = 0x003C - TLS_RSA_WITH_AES_256_CBC_SHA = 0x0035 - TLS_RSA_WITH_AES_128_CBC_SHA = 0x002F - TLS_AES_128_GCM_SHA256 = 0x1301 - TLS_AES_256_GCM_SHA384 = 0x1302 - TLS_AES_128_CCM_8_SHA256 = 0x1305 - TLS_AES_128_CCM_SHA256 = 0x1304 diff --git a/newrelic/packages/urllib3/contrib/_securetransport/low_level.py b/newrelic/packages/urllib3/contrib/_securetransport/low_level.py deleted file mode 100644 index fa0b245d27..0000000000 --- a/newrelic/packages/urllib3/contrib/_securetransport/low_level.py +++ /dev/null @@ -1,397 +0,0 @@ -""" -Low-level helpers for the SecureTransport bindings. - -These are Python functions that are not directly related to the high-level APIs -but are necessary to get them to work. They include a whole bunch of low-level -CoreFoundation messing about and memory management. The concerns in this module -are almost entirely about trying to avoid memory leaks and providing -appropriate and useful assistance to the higher-level code. -""" -import base64 -import ctypes -import itertools -import os -import re -import ssl -import struct -import tempfile - -from .bindings import CFConst, CoreFoundation, Security - -# This regular expression is used to grab PEM data out of a PEM bundle. -_PEM_CERTS_RE = re.compile( - b"-----BEGIN CERTIFICATE-----\n(.*?)\n-----END CERTIFICATE-----", re.DOTALL -) - - -def _cf_data_from_bytes(bytestring): - """ - Given a bytestring, create a CFData object from it. This CFData object must - be CFReleased by the caller. - """ - return CoreFoundation.CFDataCreate( - CoreFoundation.kCFAllocatorDefault, bytestring, len(bytestring) - ) - - -def _cf_dictionary_from_tuples(tuples): - """ - Given a list of Python tuples, create an associated CFDictionary. - """ - dictionary_size = len(tuples) - - # We need to get the dictionary keys and values out in the same order. - keys = (t[0] for t in tuples) - values = (t[1] for t in tuples) - cf_keys = (CoreFoundation.CFTypeRef * dictionary_size)(*keys) - cf_values = (CoreFoundation.CFTypeRef * dictionary_size)(*values) - - return CoreFoundation.CFDictionaryCreate( - CoreFoundation.kCFAllocatorDefault, - cf_keys, - cf_values, - dictionary_size, - CoreFoundation.kCFTypeDictionaryKeyCallBacks, - CoreFoundation.kCFTypeDictionaryValueCallBacks, - ) - - -def _cfstr(py_bstr): - """ - Given a Python binary data, create a CFString. - The string must be CFReleased by the caller. - """ - c_str = ctypes.c_char_p(py_bstr) - cf_str = CoreFoundation.CFStringCreateWithCString( - CoreFoundation.kCFAllocatorDefault, - c_str, - CFConst.kCFStringEncodingUTF8, - ) - return cf_str - - -def _create_cfstring_array(lst): - """ - Given a list of Python binary data, create an associated CFMutableArray. - The array must be CFReleased by the caller. - - Raises an ssl.SSLError on failure. - """ - cf_arr = None - try: - cf_arr = CoreFoundation.CFArrayCreateMutable( - CoreFoundation.kCFAllocatorDefault, - 0, - ctypes.byref(CoreFoundation.kCFTypeArrayCallBacks), - ) - if not cf_arr: - raise MemoryError("Unable to allocate memory!") - for item in lst: - cf_str = _cfstr(item) - if not cf_str: - raise MemoryError("Unable to allocate memory!") - try: - CoreFoundation.CFArrayAppendValue(cf_arr, cf_str) - finally: - CoreFoundation.CFRelease(cf_str) - except BaseException as e: - if cf_arr: - CoreFoundation.CFRelease(cf_arr) - raise ssl.SSLError("Unable to allocate array: %s" % (e,)) - return cf_arr - - -def _cf_string_to_unicode(value): - """ - Creates a Unicode string from a CFString object. Used entirely for error - reporting. - - Yes, it annoys me quite a lot that this function is this complex. - """ - value_as_void_p = ctypes.cast(value, ctypes.POINTER(ctypes.c_void_p)) - - string = CoreFoundation.CFStringGetCStringPtr( - value_as_void_p, CFConst.kCFStringEncodingUTF8 - ) - if string is None: - buffer = ctypes.create_string_buffer(1024) - result = CoreFoundation.CFStringGetCString( - value_as_void_p, buffer, 1024, CFConst.kCFStringEncodingUTF8 - ) - if not result: - raise OSError("Error copying C string from CFStringRef") - string = buffer.value - if string is not None: - string = string.decode("utf-8") - return string - - -def _assert_no_error(error, exception_class=None): - """ - Checks the return code and throws an exception if there is an error to - report - """ - if error == 0: - return - - cf_error_string = Security.SecCopyErrorMessageString(error, None) - output = _cf_string_to_unicode(cf_error_string) - CoreFoundation.CFRelease(cf_error_string) - - if output is None or output == u"": - output = u"OSStatus %s" % error - - if exception_class is None: - exception_class = ssl.SSLError - - raise exception_class(output) - - -def _cert_array_from_pem(pem_bundle): - """ - Given a bundle of certs in PEM format, turns them into a CFArray of certs - that can be used to validate a cert chain. - """ - # Normalize the PEM bundle's line endings. - pem_bundle = pem_bundle.replace(b"\r\n", b"\n") - - der_certs = [ - base64.b64decode(match.group(1)) for match in _PEM_CERTS_RE.finditer(pem_bundle) - ] - if not der_certs: - raise ssl.SSLError("No root certificates specified") - - cert_array = CoreFoundation.CFArrayCreateMutable( - CoreFoundation.kCFAllocatorDefault, - 0, - ctypes.byref(CoreFoundation.kCFTypeArrayCallBacks), - ) - if not cert_array: - raise ssl.SSLError("Unable to allocate memory!") - - try: - for der_bytes in der_certs: - certdata = _cf_data_from_bytes(der_bytes) - if not certdata: - raise ssl.SSLError("Unable to allocate memory!") - cert = Security.SecCertificateCreateWithData( - CoreFoundation.kCFAllocatorDefault, certdata - ) - CoreFoundation.CFRelease(certdata) - if not cert: - raise ssl.SSLError("Unable to build cert object!") - - CoreFoundation.CFArrayAppendValue(cert_array, cert) - CoreFoundation.CFRelease(cert) - except Exception: - # We need to free the array before the exception bubbles further. - # We only want to do that if an error occurs: otherwise, the caller - # should free. - CoreFoundation.CFRelease(cert_array) - raise - - return cert_array - - -def _is_cert(item): - """ - Returns True if a given CFTypeRef is a certificate. - """ - expected = Security.SecCertificateGetTypeID() - return CoreFoundation.CFGetTypeID(item) == expected - - -def _is_identity(item): - """ - Returns True if a given CFTypeRef is an identity. - """ - expected = Security.SecIdentityGetTypeID() - return CoreFoundation.CFGetTypeID(item) == expected - - -def _temporary_keychain(): - """ - This function creates a temporary Mac keychain that we can use to work with - credentials. This keychain uses a one-time password and a temporary file to - store the data. We expect to have one keychain per socket. The returned - SecKeychainRef must be freed by the caller, including calling - SecKeychainDelete. - - Returns a tuple of the SecKeychainRef and the path to the temporary - directory that contains it. - """ - # Unfortunately, SecKeychainCreate requires a path to a keychain. This - # means we cannot use mkstemp to use a generic temporary file. Instead, - # we're going to create a temporary directory and a filename to use there. - # This filename will be 8 random bytes expanded into base64. We also need - # some random bytes to password-protect the keychain we're creating, so we - # ask for 40 random bytes. - random_bytes = os.urandom(40) - filename = base64.b16encode(random_bytes[:8]).decode("utf-8") - password = base64.b16encode(random_bytes[8:]) # Must be valid UTF-8 - tempdirectory = tempfile.mkdtemp() - - keychain_path = os.path.join(tempdirectory, filename).encode("utf-8") - - # We now want to create the keychain itself. - keychain = Security.SecKeychainRef() - status = Security.SecKeychainCreate( - keychain_path, len(password), password, False, None, ctypes.byref(keychain) - ) - _assert_no_error(status) - - # Having created the keychain, we want to pass it off to the caller. - return keychain, tempdirectory - - -def _load_items_from_file(keychain, path): - """ - Given a single file, loads all the trust objects from it into arrays and - the keychain. - Returns a tuple of lists: the first list is a list of identities, the - second a list of certs. - """ - certificates = [] - identities = [] - result_array = None - - with open(path, "rb") as f: - raw_filedata = f.read() - - try: - filedata = CoreFoundation.CFDataCreate( - CoreFoundation.kCFAllocatorDefault, raw_filedata, len(raw_filedata) - ) - result_array = CoreFoundation.CFArrayRef() - result = Security.SecItemImport( - filedata, # cert data - None, # Filename, leaving it out for now - None, # What the type of the file is, we don't care - None, # what's in the file, we don't care - 0, # import flags - None, # key params, can include passphrase in the future - keychain, # The keychain to insert into - ctypes.byref(result_array), # Results - ) - _assert_no_error(result) - - # A CFArray is not very useful to us as an intermediary - # representation, so we are going to extract the objects we want - # and then free the array. We don't need to keep hold of keys: the - # keychain already has them! - result_count = CoreFoundation.CFArrayGetCount(result_array) - for index in range(result_count): - item = CoreFoundation.CFArrayGetValueAtIndex(result_array, index) - item = ctypes.cast(item, CoreFoundation.CFTypeRef) - - if _is_cert(item): - CoreFoundation.CFRetain(item) - certificates.append(item) - elif _is_identity(item): - CoreFoundation.CFRetain(item) - identities.append(item) - finally: - if result_array: - CoreFoundation.CFRelease(result_array) - - CoreFoundation.CFRelease(filedata) - - return (identities, certificates) - - -def _load_client_cert_chain(keychain, *paths): - """ - Load certificates and maybe keys from a number of files. Has the end goal - of returning a CFArray containing one SecIdentityRef, and then zero or more - SecCertificateRef objects, suitable for use as a client certificate trust - chain. - """ - # Ok, the strategy. - # - # This relies on knowing that macOS will not give you a SecIdentityRef - # unless you have imported a key into a keychain. This is a somewhat - # artificial limitation of macOS (for example, it doesn't necessarily - # affect iOS), but there is nothing inside Security.framework that lets you - # get a SecIdentityRef without having a key in a keychain. - # - # So the policy here is we take all the files and iterate them in order. - # Each one will use SecItemImport to have one or more objects loaded from - # it. We will also point at a keychain that macOS can use to work with the - # private key. - # - # Once we have all the objects, we'll check what we actually have. If we - # already have a SecIdentityRef in hand, fab: we'll use that. Otherwise, - # we'll take the first certificate (which we assume to be our leaf) and - # ask the keychain to give us a SecIdentityRef with that cert's associated - # key. - # - # We'll then return a CFArray containing the trust chain: one - # SecIdentityRef and then zero-or-more SecCertificateRef objects. The - # responsibility for freeing this CFArray will be with the caller. This - # CFArray must remain alive for the entire connection, so in practice it - # will be stored with a single SSLSocket, along with the reference to the - # keychain. - certificates = [] - identities = [] - - # Filter out bad paths. - paths = (path for path in paths if path) - - try: - for file_path in paths: - new_identities, new_certs = _load_items_from_file(keychain, file_path) - identities.extend(new_identities) - certificates.extend(new_certs) - - # Ok, we have everything. The question is: do we have an identity? If - # not, we want to grab one from the first cert we have. - if not identities: - new_identity = Security.SecIdentityRef() - status = Security.SecIdentityCreateWithCertificate( - keychain, certificates[0], ctypes.byref(new_identity) - ) - _assert_no_error(status) - identities.append(new_identity) - - # We now want to release the original certificate, as we no longer - # need it. - CoreFoundation.CFRelease(certificates.pop(0)) - - # We now need to build a new CFArray that holds the trust chain. - trust_chain = CoreFoundation.CFArrayCreateMutable( - CoreFoundation.kCFAllocatorDefault, - 0, - ctypes.byref(CoreFoundation.kCFTypeArrayCallBacks), - ) - for item in itertools.chain(identities, certificates): - # ArrayAppendValue does a CFRetain on the item. That's fine, - # because the finally block will release our other refs to them. - CoreFoundation.CFArrayAppendValue(trust_chain, item) - - return trust_chain - finally: - for obj in itertools.chain(identities, certificates): - CoreFoundation.CFRelease(obj) - - -TLS_PROTOCOL_VERSIONS = { - "SSLv2": (0, 2), - "SSLv3": (3, 0), - "TLSv1": (3, 1), - "TLSv1.1": (3, 2), - "TLSv1.2": (3, 3), -} - - -def _build_tls_unknown_ca_alert(version): - """ - Builds a TLS alert record for an unknown CA. - """ - ver_maj, ver_min = TLS_PROTOCOL_VERSIONS[version] - severity_fatal = 0x02 - description_unknown_ca = 0x30 - msg = struct.pack(">BB", severity_fatal, description_unknown_ca) - msg_len = len(msg) - record_type_alert = 0x15 - record = struct.pack(">BBBH", record_type_alert, ver_maj, ver_min, msg_len) + msg - return record diff --git a/newrelic/packages/urllib3/contrib/appengine.py b/newrelic/packages/urllib3/contrib/appengine.py deleted file mode 100644 index a5a6d91035..0000000000 --- a/newrelic/packages/urllib3/contrib/appengine.py +++ /dev/null @@ -1,314 +0,0 @@ -""" -This module provides a pool manager that uses Google App Engine's -`URLFetch Service `_. - -Example usage:: - - from urllib3 import PoolManager - from urllib3.contrib.appengine import AppEngineManager, is_appengine_sandbox - - if is_appengine_sandbox(): - # AppEngineManager uses AppEngine's URLFetch API behind the scenes - http = AppEngineManager() - else: - # PoolManager uses a socket-level API behind the scenes - http = PoolManager() - - r = http.request('GET', 'https://google.com/') - -There are `limitations `_ to the URLFetch service and it may not be -the best choice for your application. There are three options for using -urllib3 on Google App Engine: - -1. You can use :class:`AppEngineManager` with URLFetch. URLFetch is - cost-effective in many circumstances as long as your usage is within the - limitations. -2. You can use a normal :class:`~urllib3.PoolManager` by enabling sockets. - Sockets also have `limitations and restrictions - `_ and have a lower free quota than URLFetch. - To use sockets, be sure to specify the following in your ``app.yaml``:: - - env_variables: - GAE_USE_SOCKETS_HTTPLIB : 'true' - -3. If you are using `App Engine Flexible -`_, you can use the standard -:class:`PoolManager` without any configuration or special environment variables. -""" - -from __future__ import absolute_import - -import io -import logging -import warnings - -from ..exceptions import ( - HTTPError, - HTTPWarning, - MaxRetryError, - ProtocolError, - SSLError, - TimeoutError, -) -from ..packages.six.moves.urllib.parse import urljoin -from ..request import RequestMethods -from ..response import HTTPResponse -from ..util.retry import Retry -from ..util.timeout import Timeout -from . import _appengine_environ - -try: - from google.appengine.api import urlfetch -except ImportError: - urlfetch = None - - -log = logging.getLogger(__name__) - - -class AppEnginePlatformWarning(HTTPWarning): - pass - - -class AppEnginePlatformError(HTTPError): - pass - - -class AppEngineManager(RequestMethods): - """ - Connection manager for Google App Engine sandbox applications. - - This manager uses the URLFetch service directly instead of using the - emulated httplib, and is subject to URLFetch limitations as described in - the App Engine documentation `here - `_. - - Notably it will raise an :class:`AppEnginePlatformError` if: - * URLFetch is not available. - * If you attempt to use this on App Engine Flexible, as full socket - support is available. - * If a request size is more than 10 megabytes. - * If a response size is more than 32 megabytes. - * If you use an unsupported request method such as OPTIONS. - - Beyond those cases, it will raise normal urllib3 errors. - """ - - def __init__( - self, - headers=None, - retries=None, - validate_certificate=True, - urlfetch_retries=True, - ): - if not urlfetch: - raise AppEnginePlatformError( - "URLFetch is not available in this environment." - ) - - warnings.warn( - "urllib3 is using URLFetch on Google App Engine sandbox instead " - "of sockets. To use sockets directly instead of URLFetch see " - "https://urllib3.readthedocs.io/en/1.26.x/reference/urllib3.contrib.html.", - AppEnginePlatformWarning, - ) - - RequestMethods.__init__(self, headers) - self.validate_certificate = validate_certificate - self.urlfetch_retries = urlfetch_retries - - self.retries = retries or Retry.DEFAULT - - def __enter__(self): - return self - - def __exit__(self, exc_type, exc_val, exc_tb): - # Return False to re-raise any potential exceptions - return False - - def urlopen( - self, - method, - url, - body=None, - headers=None, - retries=None, - redirect=True, - timeout=Timeout.DEFAULT_TIMEOUT, - **response_kw - ): - - retries = self._get_retries(retries, redirect) - - try: - follow_redirects = redirect and retries.redirect != 0 and retries.total - response = urlfetch.fetch( - url, - payload=body, - method=method, - headers=headers or {}, - allow_truncated=False, - follow_redirects=self.urlfetch_retries and follow_redirects, - deadline=self._get_absolute_timeout(timeout), - validate_certificate=self.validate_certificate, - ) - except urlfetch.DeadlineExceededError as e: - raise TimeoutError(self, e) - - except urlfetch.InvalidURLError as e: - if "too large" in str(e): - raise AppEnginePlatformError( - "URLFetch request too large, URLFetch only " - "supports requests up to 10mb in size.", - e, - ) - raise ProtocolError(e) - - except urlfetch.DownloadError as e: - if "Too many redirects" in str(e): - raise MaxRetryError(self, url, reason=e) - raise ProtocolError(e) - - except urlfetch.ResponseTooLargeError as e: - raise AppEnginePlatformError( - "URLFetch response too large, URLFetch only supports" - "responses up to 32mb in size.", - e, - ) - - except urlfetch.SSLCertificateError as e: - raise SSLError(e) - - except urlfetch.InvalidMethodError as e: - raise AppEnginePlatformError( - "URLFetch does not support method: %s" % method, e - ) - - http_response = self._urlfetch_response_to_http_response( - response, retries=retries, **response_kw - ) - - # Handle redirect? - redirect_location = redirect and http_response.get_redirect_location() - if redirect_location: - # Check for redirect response - if self.urlfetch_retries and retries.raise_on_redirect: - raise MaxRetryError(self, url, "too many redirects") - else: - if http_response.status == 303: - method = "GET" - - try: - retries = retries.increment( - method, url, response=http_response, _pool=self - ) - except MaxRetryError: - if retries.raise_on_redirect: - raise MaxRetryError(self, url, "too many redirects") - return http_response - - retries.sleep_for_retry(http_response) - log.debug("Redirecting %s -> %s", url, redirect_location) - redirect_url = urljoin(url, redirect_location) - return self.urlopen( - method, - redirect_url, - body, - headers, - retries=retries, - redirect=redirect, - timeout=timeout, - **response_kw - ) - - # Check if we should retry the HTTP response. - has_retry_after = bool(http_response.headers.get("Retry-After")) - if retries.is_retry(method, http_response.status, has_retry_after): - retries = retries.increment(method, url, response=http_response, _pool=self) - log.debug("Retry: %s", url) - retries.sleep(http_response) - return self.urlopen( - method, - url, - body=body, - headers=headers, - retries=retries, - redirect=redirect, - timeout=timeout, - **response_kw - ) - - return http_response - - def _urlfetch_response_to_http_response(self, urlfetch_resp, **response_kw): - - if is_prod_appengine(): - # Production GAE handles deflate encoding automatically, but does - # not remove the encoding header. - content_encoding = urlfetch_resp.headers.get("content-encoding") - - if content_encoding == "deflate": - del urlfetch_resp.headers["content-encoding"] - - transfer_encoding = urlfetch_resp.headers.get("transfer-encoding") - # We have a full response's content, - # so let's make sure we don't report ourselves as chunked data. - if transfer_encoding == "chunked": - encodings = transfer_encoding.split(",") - encodings.remove("chunked") - urlfetch_resp.headers["transfer-encoding"] = ",".join(encodings) - - original_response = HTTPResponse( - # In order for decoding to work, we must present the content as - # a file-like object. - body=io.BytesIO(urlfetch_resp.content), - msg=urlfetch_resp.header_msg, - headers=urlfetch_resp.headers, - status=urlfetch_resp.status_code, - **response_kw - ) - - return HTTPResponse( - body=io.BytesIO(urlfetch_resp.content), - headers=urlfetch_resp.headers, - status=urlfetch_resp.status_code, - original_response=original_response, - **response_kw - ) - - def _get_absolute_timeout(self, timeout): - if timeout is Timeout.DEFAULT_TIMEOUT: - return None # Defer to URLFetch's default. - if isinstance(timeout, Timeout): - if timeout._read is not None or timeout._connect is not None: - warnings.warn( - "URLFetch does not support granular timeout settings, " - "reverting to total or default URLFetch timeout.", - AppEnginePlatformWarning, - ) - return timeout.total - return timeout - - def _get_retries(self, retries, redirect): - if not isinstance(retries, Retry): - retries = Retry.from_int(retries, redirect=redirect, default=self.retries) - - if retries.connect or retries.read or retries.redirect: - warnings.warn( - "URLFetch only supports total retries and does not " - "recognize connect, read, or redirect retry parameters.", - AppEnginePlatformWarning, - ) - - return retries - - -# Alias methods from _appengine_environ to maintain public API interface. - -is_appengine = _appengine_environ.is_appengine -is_appengine_sandbox = _appengine_environ.is_appengine_sandbox -is_local_appengine = _appengine_environ.is_local_appengine -is_prod_appengine = _appengine_environ.is_prod_appengine -is_prod_appengine_mvms = _appengine_environ.is_prod_appengine_mvms diff --git a/newrelic/packages/urllib3/contrib/emscripten/__init__.py b/newrelic/packages/urllib3/contrib/emscripten/__init__.py new file mode 100644 index 0000000000..e5b62b25e9 --- /dev/null +++ b/newrelic/packages/urllib3/contrib/emscripten/__init__.py @@ -0,0 +1,17 @@ +from __future__ import annotations + +import urllib3.connection + +from ...connectionpool import HTTPConnectionPool, HTTPSConnectionPool +from .connection import EmscriptenHTTPConnection, EmscriptenHTTPSConnection + + +def inject_into_urllib3() -> None: + # override connection classes to use emscripten specific classes + # n.b. mypy complains about the overriding of classes below + # if it isn't ignored + HTTPConnectionPool.ConnectionCls = EmscriptenHTTPConnection + HTTPSConnectionPool.ConnectionCls = EmscriptenHTTPSConnection + urllib3.connection.HTTPConnection = EmscriptenHTTPConnection # type: ignore[misc,assignment] + urllib3.connection.HTTPSConnection = EmscriptenHTTPSConnection # type: ignore[misc,assignment] + urllib3.connection.VerifiedHTTPSConnection = EmscriptenHTTPSConnection # type: ignore[assignment] diff --git a/newrelic/packages/urllib3/contrib/emscripten/connection.py b/newrelic/packages/urllib3/contrib/emscripten/connection.py new file mode 100644 index 0000000000..63f79dd3be --- /dev/null +++ b/newrelic/packages/urllib3/contrib/emscripten/connection.py @@ -0,0 +1,260 @@ +from __future__ import annotations + +import os +import typing + +# use http.client.HTTPException for consistency with non-emscripten +from http.client import HTTPException as HTTPException # noqa: F401 +from http.client import ResponseNotReady + +from ..._base_connection import _TYPE_BODY +from ...connection import HTTPConnection, ProxyConfig, port_by_scheme +from ...exceptions import TimeoutError +from ...response import BaseHTTPResponse +from ...util.connection import _TYPE_SOCKET_OPTIONS +from ...util.timeout import _DEFAULT_TIMEOUT, _TYPE_TIMEOUT +from ...util.url import Url +from .fetch import _RequestError, _TimeoutError, send_request, send_streaming_request +from .request import EmscriptenRequest +from .response import EmscriptenHttpResponseWrapper, EmscriptenResponse + +if typing.TYPE_CHECKING: + from ..._base_connection import BaseHTTPConnection, BaseHTTPSConnection + + +class EmscriptenHTTPConnection: + default_port: typing.ClassVar[int] = port_by_scheme["http"] + default_socket_options: typing.ClassVar[_TYPE_SOCKET_OPTIONS] + + timeout: None | (float) + + host: str + port: int + blocksize: int + source_address: tuple[str, int] | None + socket_options: _TYPE_SOCKET_OPTIONS | None + + proxy: Url | None + proxy_config: ProxyConfig | None + + is_verified: bool = False + proxy_is_verified: bool | None = None + + response_class: type[BaseHTTPResponse] = EmscriptenHttpResponseWrapper + _response: EmscriptenResponse | None + + def __init__( + self, + host: str, + port: int = 0, + *, + timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, + source_address: tuple[str, int] | None = None, + blocksize: int = 8192, + socket_options: _TYPE_SOCKET_OPTIONS | None = None, + proxy: Url | None = None, + proxy_config: ProxyConfig | None = None, + ) -> None: + self.host = host + self.port = port + self.timeout = timeout if isinstance(timeout, float) else 0.0 + self.scheme = "http" + self._closed = True + self._response = None + # ignore these things because we don't + # have control over that stuff + self.proxy = None + self.proxy_config = None + self.blocksize = blocksize + self.source_address = None + self.socket_options = None + self.is_verified = False + + def set_tunnel( + self, + host: str, + port: int | None = 0, + headers: typing.Mapping[str, str] | None = None, + scheme: str = "http", + ) -> None: + pass + + def connect(self) -> None: + pass + + def request( + self, + method: str, + url: str, + body: _TYPE_BODY | None = None, + headers: typing.Mapping[str, str] | None = None, + # We know *at least* botocore is depending on the order of the + # first 3 parameters so to be safe we only mark the later ones + # as keyword-only to ensure we have space to extend. + *, + chunked: bool = False, + preload_content: bool = True, + decode_content: bool = True, + enforce_content_length: bool = True, + ) -> None: + self._closed = False + if url.startswith("/"): + if self.port is not None: + port = f":{self.port}" + else: + port = "" + # no scheme / host / port included, make a full url + url = f"{self.scheme}://{self.host}{port}{url}" + request = EmscriptenRequest( + url=url, + method=method, + timeout=self.timeout if self.timeout else 0, + decode_content=decode_content, + ) + request.set_body(body) + if headers: + for k, v in headers.items(): + request.set_header(k, v) + self._response = None + try: + if not preload_content: + self._response = send_streaming_request(request) + if self._response is None: + self._response = send_request(request) + except _TimeoutError as e: + raise TimeoutError(e.message) from e + except _RequestError as e: + raise HTTPException(e.message) from e + + def getresponse(self) -> BaseHTTPResponse: + if self._response is not None: + return EmscriptenHttpResponseWrapper( + internal_response=self._response, + url=self._response.request.url, + connection=self, + ) + else: + raise ResponseNotReady() + + def close(self) -> None: + self._closed = True + self._response = None + + @property + def is_closed(self) -> bool: + """Whether the connection either is brand new or has been previously closed. + If this property is True then both ``is_connected`` and ``has_connected_to_proxy`` + properties must be False. + """ + return self._closed + + @property + def is_connected(self) -> bool: + """Whether the connection is actively connected to any origin (proxy or target)""" + return True + + @property + def has_connected_to_proxy(self) -> bool: + """Whether the connection has successfully connected to its proxy. + This returns False if no proxy is in use. Used to determine whether + errors are coming from the proxy layer or from tunnelling to the target origin. + """ + return False + + +class EmscriptenHTTPSConnection(EmscriptenHTTPConnection): + default_port = port_by_scheme["https"] + # all this is basically ignored, as browser handles https + cert_reqs: int | str | None = None + ca_certs: str | None = None + ca_cert_dir: str | None = None + ca_cert_data: None | str | bytes = None + cert_file: str | None + key_file: str | None + key_password: str | None + ssl_context: typing.Any | None + ssl_version: int | str | None = None + ssl_minimum_version: int | None = None + ssl_maximum_version: int | None = None + assert_hostname: None | str | typing.Literal[False] + assert_fingerprint: str | None = None + + def __init__( + self, + host: str, + port: int = 0, + *, + timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, + source_address: tuple[str, int] | None = None, + blocksize: int = 16384, + socket_options: ( + None | _TYPE_SOCKET_OPTIONS + ) = HTTPConnection.default_socket_options, + proxy: Url | None = None, + proxy_config: ProxyConfig | None = None, + cert_reqs: int | str | None = None, + assert_hostname: None | str | typing.Literal[False] = None, + assert_fingerprint: str | None = None, + server_hostname: str | None = None, + ssl_context: typing.Any | None = None, + ca_certs: str | None = None, + ca_cert_dir: str | None = None, + ca_cert_data: None | str | bytes = None, + ssl_minimum_version: int | None = None, + ssl_maximum_version: int | None = None, + ssl_version: int | str | None = None, # Deprecated + cert_file: str | None = None, + key_file: str | None = None, + key_password: str | None = None, + ) -> None: + super().__init__( + host, + port=port, + timeout=timeout, + source_address=source_address, + blocksize=blocksize, + socket_options=socket_options, + proxy=proxy, + proxy_config=proxy_config, + ) + self.scheme = "https" + + self.key_file = key_file + self.cert_file = cert_file + self.key_password = key_password + self.ssl_context = ssl_context + self.server_hostname = server_hostname + self.assert_hostname = assert_hostname + self.assert_fingerprint = assert_fingerprint + self.ssl_version = ssl_version + self.ssl_minimum_version = ssl_minimum_version + self.ssl_maximum_version = ssl_maximum_version + self.ca_certs = ca_certs and os.path.expanduser(ca_certs) + self.ca_cert_dir = ca_cert_dir and os.path.expanduser(ca_cert_dir) + self.ca_cert_data = ca_cert_data + + self.cert_reqs = None + + # The browser will automatically verify all requests. + # We have no control over that setting. + self.is_verified = True + + def set_cert( + self, + key_file: str | None = None, + cert_file: str | None = None, + cert_reqs: int | str | None = None, + key_password: str | None = None, + ca_certs: str | None = None, + assert_hostname: None | str | typing.Literal[False] = None, + assert_fingerprint: str | None = None, + ca_cert_dir: str | None = None, + ca_cert_data: None | str | bytes = None, + ) -> None: + pass + + +# verify that this class implements BaseHTTP(s) connection correctly +if typing.TYPE_CHECKING: + _supports_http_protocol: BaseHTTPConnection = EmscriptenHTTPConnection("", 0) + _supports_https_protocol: BaseHTTPSConnection = EmscriptenHTTPSConnection("", 0) diff --git a/newrelic/packages/urllib3/contrib/emscripten/emscripten_fetch_worker.js b/newrelic/packages/urllib3/contrib/emscripten/emscripten_fetch_worker.js new file mode 100644 index 0000000000..faf141e1fa --- /dev/null +++ b/newrelic/packages/urllib3/contrib/emscripten/emscripten_fetch_worker.js @@ -0,0 +1,110 @@ +let Status = { + SUCCESS_HEADER: -1, + SUCCESS_EOF: -2, + ERROR_TIMEOUT: -3, + ERROR_EXCEPTION: -4, +}; + +let connections = new Map(); +let nextConnectionID = 1; +const encoder = new TextEncoder(); + +self.addEventListener("message", async function (event) { + if (event.data.close) { + let connectionID = event.data.close; + connections.delete(connectionID); + return; + } else if (event.data.getMore) { + let connectionID = event.data.getMore; + let { curOffset, value, reader, intBuffer, byteBuffer } = + connections.get(connectionID); + // if we still have some in buffer, then just send it back straight away + if (!value || curOffset >= value.length) { + // read another buffer if required + try { + let readResponse = await reader.read(); + + if (readResponse.done) { + // read everything - clear connection and return + connections.delete(connectionID); + Atomics.store(intBuffer, 0, Status.SUCCESS_EOF); + Atomics.notify(intBuffer, 0); + // finished reading successfully + // return from event handler + return; + } + curOffset = 0; + connections.get(connectionID).value = readResponse.value; + value = readResponse.value; + } catch (error) { + console.log("Request exception:", error); + let errorBytes = encoder.encode(error.message); + let written = errorBytes.length; + byteBuffer.set(errorBytes); + intBuffer[1] = written; + Atomics.store(intBuffer, 0, Status.ERROR_EXCEPTION); + Atomics.notify(intBuffer, 0); + } + } + + // send as much buffer as we can + let curLen = value.length - curOffset; + if (curLen > byteBuffer.length) { + curLen = byteBuffer.length; + } + byteBuffer.set(value.subarray(curOffset, curOffset + curLen), 0); + + Atomics.store(intBuffer, 0, curLen); // store current length in bytes + Atomics.notify(intBuffer, 0); + curOffset += curLen; + connections.get(connectionID).curOffset = curOffset; + + return; + } else { + // start fetch + let connectionID = nextConnectionID; + nextConnectionID += 1; + const intBuffer = new Int32Array(event.data.buffer); + const byteBuffer = new Uint8Array(event.data.buffer, 8); + try { + const response = await fetch(event.data.url, event.data.fetchParams); + // return the headers first via textencoder + var headers = []; + for (const pair of response.headers.entries()) { + headers.push([pair[0], pair[1]]); + } + let headerObj = { + headers: headers, + status: response.status, + connectionID, + }; + const headerText = JSON.stringify(headerObj); + let headerBytes = encoder.encode(headerText); + let written = headerBytes.length; + byteBuffer.set(headerBytes); + intBuffer[1] = written; + // make a connection + connections.set(connectionID, { + reader: response.body.getReader(), + intBuffer: intBuffer, + byteBuffer: byteBuffer, + value: undefined, + curOffset: 0, + }); + // set header ready + Atomics.store(intBuffer, 0, Status.SUCCESS_HEADER); + Atomics.notify(intBuffer, 0); + // all fetching after this goes through a new postmessage call with getMore + // this allows for parallel requests + } catch (error) { + console.log("Request exception:", error); + let errorBytes = encoder.encode(error.message); + let written = errorBytes.length; + byteBuffer.set(errorBytes); + intBuffer[1] = written; + Atomics.store(intBuffer, 0, Status.ERROR_EXCEPTION); + Atomics.notify(intBuffer, 0); + } + } +}); +self.postMessage({ inited: true }); diff --git a/newrelic/packages/urllib3/contrib/emscripten/fetch.py b/newrelic/packages/urllib3/contrib/emscripten/fetch.py new file mode 100644 index 0000000000..612cfddc4c --- /dev/null +++ b/newrelic/packages/urllib3/contrib/emscripten/fetch.py @@ -0,0 +1,726 @@ +""" +Support for streaming http requests in emscripten. + +A few caveats - + +If your browser (or Node.js) has WebAssembly JavaScript Promise Integration enabled +https://github.com/WebAssembly/js-promise-integration/blob/main/proposals/js-promise-integration/Overview.md +*and* you launch pyodide using `pyodide.runPythonAsync`, this will fetch data using the +JavaScript asynchronous fetch api (wrapped via `pyodide.ffi.call_sync`). In this case +timeouts and streaming should just work. + +Otherwise, it uses a combination of XMLHttpRequest and a web-worker for streaming. + +This approach has several caveats: + +Firstly, you can't do streaming http in the main UI thread, because atomics.wait isn't allowed. +Streaming only works if you're running pyodide in a web worker. + +Secondly, this uses an extra web worker and SharedArrayBuffer to do the asynchronous fetch +operation, so it requires that you have crossOriginIsolation enabled, by serving over https +(or from localhost) with the two headers below set: + + Cross-Origin-Opener-Policy: same-origin + Cross-Origin-Embedder-Policy: require-corp + +You can tell if cross origin isolation is successfully enabled by looking at the global crossOriginIsolated variable in +JavaScript console. If it isn't, streaming requests will fallback to XMLHttpRequest, i.e. getting the whole +request into a buffer and then returning it. it shows a warning in the JavaScript console in this case. + +Finally, the webworker which does the streaming fetch is created on initial import, but will only be started once +control is returned to javascript. Call `await wait_for_streaming_ready()` to wait for streaming fetch. + +NB: in this code, there are a lot of JavaScript objects. They are named js_* +to make it clear what type of object they are. +""" + +from __future__ import annotations + +import io +import json +from email.parser import Parser +from importlib.resources import files +from typing import TYPE_CHECKING, Any + +import js # type: ignore[import-not-found] +from pyodide.ffi import ( # type: ignore[import-not-found] + JsArray, + JsException, + JsProxy, + to_js, +) + +if TYPE_CHECKING: + from typing_extensions import Buffer + +from .request import EmscriptenRequest +from .response import EmscriptenResponse + +""" +There are some headers that trigger unintended CORS preflight requests. +See also https://github.com/koenvo/pyodide-http/issues/22 +""" +HEADERS_TO_IGNORE = ("user-agent",) + +SUCCESS_HEADER = -1 +SUCCESS_EOF = -2 +ERROR_TIMEOUT = -3 +ERROR_EXCEPTION = -4 + + +class _RequestError(Exception): + def __init__( + self, + message: str | None = None, + *, + request: EmscriptenRequest | None = None, + response: EmscriptenResponse | None = None, + ): + self.request = request + self.response = response + self.message = message + super().__init__(self.message) + + +class _StreamingError(_RequestError): + pass + + +class _TimeoutError(_RequestError): + pass + + +def _obj_from_dict(dict_val: dict[str, Any]) -> JsProxy: + return to_js(dict_val, dict_converter=js.Object.fromEntries) + + +class _ReadStream(io.RawIOBase): + def __init__( + self, + int_buffer: JsArray, + byte_buffer: JsArray, + timeout: float, + worker: JsProxy, + connection_id: int, + request: EmscriptenRequest, + ): + self.int_buffer = int_buffer + self.byte_buffer = byte_buffer + self.read_pos = 0 + self.read_len = 0 + self.connection_id = connection_id + self.worker = worker + self.timeout = int(1000 * timeout) if timeout > 0 else None + self.is_live = True + self._is_closed = False + self.request: EmscriptenRequest | None = request + + def __del__(self) -> None: + self.close() + + # this is compatible with _base_connection + def is_closed(self) -> bool: + return self._is_closed + + # for compatibility with RawIOBase + @property + def closed(self) -> bool: + return self.is_closed() + + def close(self) -> None: + if self.is_closed(): + return + self.read_len = 0 + self.read_pos = 0 + self.int_buffer = None + self.byte_buffer = None + self._is_closed = True + self.request = None + if self.is_live: + self.worker.postMessage(_obj_from_dict({"close": self.connection_id})) + self.is_live = False + super().close() + + def readable(self) -> bool: + return True + + def writable(self) -> bool: + return False + + def seekable(self) -> bool: + return False + + def readinto(self, byte_obj: Buffer) -> int: + if not self.int_buffer: + raise _StreamingError( + "No buffer for stream in _ReadStream.readinto", + request=self.request, + response=None, + ) + if self.read_len == 0: + # wait for the worker to send something + js.Atomics.store(self.int_buffer, 0, ERROR_TIMEOUT) + self.worker.postMessage(_obj_from_dict({"getMore": self.connection_id})) + if ( + js.Atomics.wait(self.int_buffer, 0, ERROR_TIMEOUT, self.timeout) + == "timed-out" + ): + raise _TimeoutError + data_len = self.int_buffer[0] + if data_len > 0: + self.read_len = data_len + self.read_pos = 0 + elif data_len == ERROR_EXCEPTION: + string_len = self.int_buffer[1] + # decode the error string + js_decoder = js.TextDecoder.new() + json_str = js_decoder.decode(self.byte_buffer.slice(0, string_len)) + raise _StreamingError( + f"Exception thrown in fetch: {json_str}", + request=self.request, + response=None, + ) + else: + # EOF, free the buffers and return zero + # and free the request + self.is_live = False + self.close() + return 0 + # copy from int32array to python bytes + ret_length = min(self.read_len, len(memoryview(byte_obj))) + subarray = self.byte_buffer.subarray( + self.read_pos, self.read_pos + ret_length + ).to_py() + memoryview(byte_obj)[0:ret_length] = subarray + self.read_len -= ret_length + self.read_pos += ret_length + return ret_length + + +class _StreamingFetcher: + def __init__(self) -> None: + # make web-worker and data buffer on startup + self.streaming_ready = False + streaming_worker_code = ( + files(__package__) + .joinpath("emscripten_fetch_worker.js") + .read_text(encoding="utf-8") + ) + js_data_blob = js.Blob.new( + to_js([streaming_worker_code], create_pyproxies=False), + _obj_from_dict({"type": "application/javascript"}), + ) + + def promise_resolver(js_resolve_fn: JsProxy, js_reject_fn: JsProxy) -> None: + def onMsg(e: JsProxy) -> None: + self.streaming_ready = True + js_resolve_fn(e) + + def onErr(e: JsProxy) -> None: + js_reject_fn(e) # Defensive: never happens in ci + + self.js_worker.onmessage = onMsg + self.js_worker.onerror = onErr + + js_data_url = js.URL.createObjectURL(js_data_blob) + self.js_worker = js.globalThis.Worker.new(js_data_url) + self.js_worker_ready_promise = js.globalThis.Promise.new(promise_resolver) + + def send(self, request: EmscriptenRequest) -> EmscriptenResponse: + headers = { + k: v for k, v in request.headers.items() if k not in HEADERS_TO_IGNORE + } + + body = request.body + fetch_data = {"headers": headers, "body": to_js(body), "method": request.method} + # start the request off in the worker + timeout = int(1000 * request.timeout) if request.timeout > 0 else None + js_shared_buffer = js.SharedArrayBuffer.new(1048576) + js_int_buffer = js.Int32Array.new(js_shared_buffer) + js_byte_buffer = js.Uint8Array.new(js_shared_buffer, 8) + + js.Atomics.store(js_int_buffer, 0, ERROR_TIMEOUT) + js.Atomics.notify(js_int_buffer, 0) + js_absolute_url = js.URL.new(request.url, js.location).href + self.js_worker.postMessage( + _obj_from_dict( + { + "buffer": js_shared_buffer, + "url": js_absolute_url, + "fetchParams": fetch_data, + } + ) + ) + # wait for the worker to send something + js.Atomics.wait(js_int_buffer, 0, ERROR_TIMEOUT, timeout) + if js_int_buffer[0] == ERROR_TIMEOUT: + raise _TimeoutError( + "Timeout connecting to streaming request", + request=request, + response=None, + ) + elif js_int_buffer[0] == SUCCESS_HEADER: + # got response + # header length is in second int of intBuffer + string_len = js_int_buffer[1] + # decode the rest to a JSON string + js_decoder = js.TextDecoder.new() + # this does a copy (the slice) because decode can't work on shared array + # for some silly reason + json_str = js_decoder.decode(js_byte_buffer.slice(0, string_len)) + # get it as an object + response_obj = json.loads(json_str) + return EmscriptenResponse( + request=request, + status_code=response_obj["status"], + headers=response_obj["headers"], + body=_ReadStream( + js_int_buffer, + js_byte_buffer, + request.timeout, + self.js_worker, + response_obj["connectionID"], + request, + ), + ) + elif js_int_buffer[0] == ERROR_EXCEPTION: + string_len = js_int_buffer[1] + # decode the error string + js_decoder = js.TextDecoder.new() + json_str = js_decoder.decode(js_byte_buffer.slice(0, string_len)) + raise _StreamingError( + f"Exception thrown in fetch: {json_str}", request=request, response=None + ) + else: + raise _StreamingError( + f"Unknown status from worker in fetch: {js_int_buffer[0]}", + request=request, + response=None, + ) + + +class _JSPIReadStream(io.RawIOBase): + """ + A read stream that uses pyodide.ffi.run_sync to read from a JavaScript fetch + response. This requires support for WebAssembly JavaScript Promise Integration + in the containing browser, and for pyodide to be launched via runPythonAsync. + + :param js_read_stream: + The JavaScript stream reader + + :param timeout: + Timeout in seconds + + :param request: + The request we're handling + + :param response: + The response this stream relates to + + :param js_abort_controller: + A JavaScript AbortController object, used for timeouts + """ + + def __init__( + self, + js_read_stream: Any, + timeout: float, + request: EmscriptenRequest, + response: EmscriptenResponse, + js_abort_controller: Any, # JavaScript AbortController for timeouts + ): + self.js_read_stream = js_read_stream + self.timeout = timeout + self._is_closed = False + self._is_done = False + self.request: EmscriptenRequest | None = request + self.response: EmscriptenResponse | None = response + self.current_buffer = None + self.current_buffer_pos = 0 + self.js_abort_controller = js_abort_controller + + def __del__(self) -> None: + self.close() + + # this is compatible with _base_connection + def is_closed(self) -> bool: + return self._is_closed + + # for compatibility with RawIOBase + @property + def closed(self) -> bool: + return self.is_closed() + + def close(self) -> None: + if self.is_closed(): + return + self.read_len = 0 + self.read_pos = 0 + self.js_read_stream.cancel() + self.js_read_stream = None + self._is_closed = True + self._is_done = True + self.request = None + self.response = None + super().close() + + def readable(self) -> bool: + return True + + def writable(self) -> bool: + return False + + def seekable(self) -> bool: + return False + + def _get_next_buffer(self) -> bool: + result_js = _run_sync_with_timeout( + self.js_read_stream.read(), + self.timeout, + self.js_abort_controller, + request=self.request, + response=self.response, + ) + if result_js.done: + self._is_done = True + return False + else: + self.current_buffer = result_js.value.to_py() + self.current_buffer_pos = 0 + return True + + def readinto(self, byte_obj: Buffer) -> int: + if self.current_buffer is None: + if not self._get_next_buffer() or self.current_buffer is None: + self.close() + return 0 + ret_length = min( + len(byte_obj), len(self.current_buffer) - self.current_buffer_pos + ) + byte_obj[0:ret_length] = self.current_buffer[ + self.current_buffer_pos : self.current_buffer_pos + ret_length + ] + self.current_buffer_pos += ret_length + if self.current_buffer_pos == len(self.current_buffer): + self.current_buffer = None + return ret_length + + +# check if we are in a worker or not +def is_in_browser_main_thread() -> bool: + return hasattr(js, "window") and hasattr(js, "self") and js.self == js.window + + +def is_cross_origin_isolated() -> bool: + return hasattr(js, "crossOriginIsolated") and js.crossOriginIsolated + + +def is_in_node() -> bool: + return ( + hasattr(js, "process") + and hasattr(js.process, "release") + and hasattr(js.process.release, "name") + and js.process.release.name == "node" + ) + + +def is_worker_available() -> bool: + return hasattr(js, "Worker") and hasattr(js, "Blob") + + +_fetcher: _StreamingFetcher | None = None + +if is_worker_available() and ( + (is_cross_origin_isolated() and not is_in_browser_main_thread()) + and (not is_in_node()) +): + _fetcher = _StreamingFetcher() +else: + _fetcher = None + + +NODE_JSPI_ERROR = ( + "urllib3 only works in Node.js with pyodide.runPythonAsync" + " and requires the flag --experimental-wasm-stack-switching in " + " versions of node <24." +) + + +def send_streaming_request(request: EmscriptenRequest) -> EmscriptenResponse | None: + if has_jspi(): + return send_jspi_request(request, True) + elif is_in_node(): + raise _RequestError( + message=NODE_JSPI_ERROR, + request=request, + response=None, + ) + + if _fetcher and streaming_ready(): + return _fetcher.send(request) + else: + _show_streaming_warning() + return None + + +_SHOWN_TIMEOUT_WARNING = False + + +def _show_timeout_warning() -> None: + global _SHOWN_TIMEOUT_WARNING + if not _SHOWN_TIMEOUT_WARNING: + _SHOWN_TIMEOUT_WARNING = True + message = "Warning: Timeout is not available on main browser thread" + js.console.warn(message) + + +_SHOWN_STREAMING_WARNING = False + + +def _show_streaming_warning() -> None: + global _SHOWN_STREAMING_WARNING + if not _SHOWN_STREAMING_WARNING: + _SHOWN_STREAMING_WARNING = True + message = "Can't stream HTTP requests because: \n" + if not is_cross_origin_isolated(): + message += " Page is not cross-origin isolated\n" + if is_in_browser_main_thread(): + message += " Python is running in main browser thread\n" + if not is_worker_available(): + message += " Worker or Blob classes are not available in this environment." # Defensive: this is always False in browsers that we test in + if streaming_ready() is False: + message += """ Streaming fetch worker isn't ready. If you want to be sure that streaming fetch +is working, you need to call: 'await urllib3.contrib.emscripten.fetch.wait_for_streaming_ready()`""" + from js import console + + console.warn(message) + + +def send_request(request: EmscriptenRequest) -> EmscriptenResponse: + if has_jspi(): + return send_jspi_request(request, False) + elif is_in_node(): + raise _RequestError( + message=NODE_JSPI_ERROR, + request=request, + response=None, + ) + try: + js_xhr = js.XMLHttpRequest.new() + + if not is_in_browser_main_thread(): + js_xhr.responseType = "arraybuffer" + if request.timeout: + js_xhr.timeout = int(request.timeout * 1000) + else: + js_xhr.overrideMimeType("text/plain; charset=ISO-8859-15") + if request.timeout: + # timeout isn't available on the main thread - show a warning in console + # if it is set + _show_timeout_warning() + + js_xhr.open(request.method, request.url, False) + for name, value in request.headers.items(): + if name.lower() not in HEADERS_TO_IGNORE: + js_xhr.setRequestHeader(name, value) + + js_xhr.send(to_js(request.body)) + + headers = dict(Parser().parsestr(js_xhr.getAllResponseHeaders())) + + if not is_in_browser_main_thread(): + body = js_xhr.response.to_py().tobytes() + else: + body = js_xhr.response.encode("ISO-8859-15") + return EmscriptenResponse( + status_code=js_xhr.status, headers=headers, body=body, request=request + ) + except JsException as err: + if err.name == "TimeoutError": + raise _TimeoutError(err.message, request=request) + elif err.name == "NetworkError": + raise _RequestError(err.message, request=request) + else: + # general http error + raise _RequestError(err.message, request=request) + + +def send_jspi_request( + request: EmscriptenRequest, streaming: bool +) -> EmscriptenResponse: + """ + Send a request using WebAssembly JavaScript Promise Integration + to wrap the asynchronous JavaScript fetch api (experimental). + + :param request: + Request to send + + :param streaming: + Whether to stream the response + + :return: The response object + :rtype: EmscriptenResponse + """ + timeout = request.timeout + js_abort_controller = js.AbortController.new() + headers = {k: v for k, v in request.headers.items() if k not in HEADERS_TO_IGNORE} + req_body = request.body + fetch_data = { + "headers": headers, + "body": to_js(req_body), + "method": request.method, + "signal": js_abort_controller.signal, + } + # Node.js returns the whole response (unlike opaqueredirect in browsers), + # so urllib3 can set `redirect: manual` to control redirects itself. + # https://stackoverflow.com/a/78524615 + if _is_node_js(): + fetch_data["redirect"] = "manual" + # Call JavaScript fetch (async api, returns a promise) + fetcher_promise_js = js.fetch(request.url, _obj_from_dict(fetch_data)) + # Now suspend WebAssembly until we resolve that promise + # or time out. + response_js = _run_sync_with_timeout( + fetcher_promise_js, + timeout, + js_abort_controller, + request=request, + response=None, + ) + headers = {} + header_iter = response_js.headers.entries() + while True: + iter_value_js = header_iter.next() + if getattr(iter_value_js, "done", False): + break + else: + headers[str(iter_value_js.value[0])] = str(iter_value_js.value[1]) + status_code = response_js.status + body: bytes | io.RawIOBase = b"" + + response = EmscriptenResponse( + status_code=status_code, headers=headers, body=b"", request=request + ) + if streaming: + # get via inputstream + if response_js.body is not None: + # get a reader from the fetch response + body_stream_js = response_js.body.getReader() + body = _JSPIReadStream( + body_stream_js, timeout, request, response, js_abort_controller + ) + else: + # get directly via arraybuffer + # n.b. this is another async JavaScript call. + body = _run_sync_with_timeout( + response_js.arrayBuffer(), + timeout, + js_abort_controller, + request=request, + response=response, + ).to_py() + response.body = body + return response + + +def _run_sync_with_timeout( + promise: Any, + timeout: float, + js_abort_controller: Any, + request: EmscriptenRequest | None, + response: EmscriptenResponse | None, +) -> Any: + """ + Await a JavaScript promise synchronously with a timeout which is implemented + via the AbortController + + :param promise: + Javascript promise to await + + :param timeout: + Timeout in seconds + + :param js_abort_controller: + A JavaScript AbortController object, used on timeout + + :param request: + The request being handled + + :param response: + The response being handled (if it exists yet) + + :raises _TimeoutError: If the request times out + :raises _RequestError: If the request raises a JavaScript exception + + :return: The result of awaiting the promise. + """ + timer_id = None + if timeout > 0: + timer_id = js.setTimeout( + js_abort_controller.abort.bind(js_abort_controller), int(timeout * 1000) + ) + try: + from pyodide.ffi import run_sync + + # run_sync here uses WebAssembly JavaScript Promise Integration to + # suspend python until the JavaScript promise resolves. + return run_sync(promise) + except JsException as err: + if err.name == "AbortError": + raise _TimeoutError( + message="Request timed out", request=request, response=response + ) + else: + raise _RequestError(message=err.message, request=request, response=response) + finally: + if timer_id is not None: + js.clearTimeout(timer_id) + + +def has_jspi() -> bool: + """ + Return true if jspi can be used. + + This requires both browser support and also WebAssembly + to be in the correct state - i.e. that the javascript + call into python was async not sync. + + :return: True if jspi can be used. + :rtype: bool + """ + try: + from pyodide.ffi import can_run_sync, run_sync # noqa: F401 + + return bool(can_run_sync()) + except ImportError: + return False + + +def _is_node_js() -> bool: + """ + Check if we are in Node.js. + + :return: True if we are in Node.js. + :rtype: bool + """ + return ( + hasattr(js, "process") + and hasattr(js.process, "release") + # According to the Node.js documentation, the release name is always "node". + and js.process.release.name == "node" + ) + + +def streaming_ready() -> bool | None: + if _fetcher: + return _fetcher.streaming_ready + else: + return None # no fetcher, return None to signify that + + +async def wait_for_streaming_ready() -> bool: + if _fetcher: + await _fetcher.js_worker_ready_promise + return True + else: + return False diff --git a/newrelic/packages/urllib3/contrib/emscripten/request.py b/newrelic/packages/urllib3/contrib/emscripten/request.py new file mode 100644 index 0000000000..e692e692bd --- /dev/null +++ b/newrelic/packages/urllib3/contrib/emscripten/request.py @@ -0,0 +1,22 @@ +from __future__ import annotations + +from dataclasses import dataclass, field + +from ..._base_connection import _TYPE_BODY + + +@dataclass +class EmscriptenRequest: + method: str + url: str + params: dict[str, str] | None = None + body: _TYPE_BODY | None = None + headers: dict[str, str] = field(default_factory=dict) + timeout: float = 0 + decode_content: bool = True + + def set_header(self, name: str, value: str) -> None: + self.headers[name.capitalize()] = value + + def set_body(self, body: _TYPE_BODY | None) -> None: + self.body = body diff --git a/newrelic/packages/urllib3/contrib/emscripten/response.py b/newrelic/packages/urllib3/contrib/emscripten/response.py new file mode 100644 index 0000000000..cb1088a182 --- /dev/null +++ b/newrelic/packages/urllib3/contrib/emscripten/response.py @@ -0,0 +1,277 @@ +from __future__ import annotations + +import json as _json +import logging +import typing +from contextlib import contextmanager +from dataclasses import dataclass +from http.client import HTTPException as HTTPException +from io import BytesIO, IOBase + +from ...exceptions import InvalidHeader, TimeoutError +from ...response import BaseHTTPResponse +from ...util.retry import Retry +from .request import EmscriptenRequest + +if typing.TYPE_CHECKING: + from ..._base_connection import BaseHTTPConnection, BaseHTTPSConnection + +log = logging.getLogger(__name__) + + +@dataclass +class EmscriptenResponse: + status_code: int + headers: dict[str, str] + body: IOBase | bytes + request: EmscriptenRequest + + +class EmscriptenHttpResponseWrapper(BaseHTTPResponse): + def __init__( + self, + internal_response: EmscriptenResponse, + url: str | None = None, + connection: BaseHTTPConnection | BaseHTTPSConnection | None = None, + ): + self._pool = None # set by pool class + self._body = None + self._response = internal_response + self._url = url + self._connection = connection + self._closed = False + super().__init__( + headers=internal_response.headers, + status=internal_response.status_code, + request_url=url, + version=0, + version_string="HTTP/?", + reason="", + decode_content=True, + ) + self.length_remaining = self._init_length(self._response.request.method) + self.length_is_certain = False + + @property + def url(self) -> str | None: + return self._url + + @url.setter + def url(self, url: str | None) -> None: + self._url = url + + @property + def connection(self) -> BaseHTTPConnection | BaseHTTPSConnection | None: + return self._connection + + @property + def retries(self) -> Retry | None: + return self._retries + + @retries.setter + def retries(self, retries: Retry | None) -> None: + # Override the request_url if retries has a redirect location. + self._retries = retries + + def stream( + self, amt: int | None = 2**16, decode_content: bool | None = None + ) -> typing.Generator[bytes]: + """ + A generator wrapper for the read() method. A call will block until + ``amt`` bytes have been read from the connection or until the + connection is closed. + + :param amt: + How much of the content to read. The generator will return up to + much data per iteration, but may return less. This is particularly + likely when using compressed data. However, the empty string will + never be returned. + + :param decode_content: + If True, will attempt to decode the body based on the + 'content-encoding' header. + """ + while True: + data = self.read(amt=amt, decode_content=decode_content) + + if data: + yield data + else: + break + + def _init_length(self, request_method: str | None) -> int | None: + length: int | None + content_length: str | None = self.headers.get("content-length") + + if content_length is not None: + try: + # RFC 7230 section 3.3.2 specifies multiple content lengths can + # be sent in a single Content-Length header + # (e.g. Content-Length: 42, 42). This line ensures the values + # are all valid ints and that as long as the `set` length is 1, + # all values are the same. Otherwise, the header is invalid. + lengths = {int(val) for val in content_length.split(",")} + if len(lengths) > 1: + raise InvalidHeader( + "Content-Length contained multiple " + "unmatching values (%s)" % content_length + ) + length = lengths.pop() + except ValueError: + length = None + else: + if length < 0: + length = None + + else: # if content_length is None + length = None + + # Check for responses that shouldn't include a body + if ( + self.status in (204, 304) + or 100 <= self.status < 200 + or request_method == "HEAD" + ): + length = 0 + + return length + + def read( + self, + amt: int | None = None, + decode_content: bool | None = None, # ignored because browser decodes always + cache_content: bool = False, + ) -> bytes: + if ( + self._closed + or self._response is None + or (isinstance(self._response.body, IOBase) and self._response.body.closed) + ): + return b"" + + with self._error_catcher(): + # body has been preloaded as a string by XmlHttpRequest + if not isinstance(self._response.body, IOBase): + self.length_remaining = len(self._response.body) + self.length_is_certain = True + # wrap body in IOStream + self._response.body = BytesIO(self._response.body) + if amt is not None and amt >= 0: + # don't cache partial content + cache_content = False + data = self._response.body.read(amt) + else: # read all we can (and cache it) + data = self._response.body.read() + if cache_content: + self._body = data + if self.length_remaining is not None: + self.length_remaining = max(self.length_remaining - len(data), 0) + if len(data) == 0 or ( + self.length_is_certain and self.length_remaining == 0 + ): + # definitely finished reading, close response stream + self._response.body.close() + return typing.cast(bytes, data) + + def read_chunked( + self, + amt: int | None = None, + decode_content: bool | None = None, + ) -> typing.Generator[bytes]: + # chunked is handled by browser + while True: + bytes = self.read(amt, decode_content) + if not bytes: + break + yield bytes + + def release_conn(self) -> None: + if not self._pool or not self._connection: + return None + + self._pool._put_conn(self._connection) + self._connection = None + + def drain_conn(self) -> None: + self.close() + + @property + def data(self) -> bytes: + if self._body: + return self._body + else: + return self.read(cache_content=True) + + def json(self) -> typing.Any: + """ + Deserializes the body of the HTTP response as a Python object. + + The body of the HTTP response must be encoded using UTF-8, as per + `RFC 8529 Section 8.1 `_. + + To use a custom JSON decoder pass the result of :attr:`HTTPResponse.data` to + your custom decoder instead. + + If the body of the HTTP response is not decodable to UTF-8, a + `UnicodeDecodeError` will be raised. If the body of the HTTP response is not a + valid JSON document, a `json.JSONDecodeError` will be raised. + + Read more :ref:`here `. + + :returns: The body of the HTTP response as a Python object. + """ + data = self.data.decode("utf-8") + return _json.loads(data) + + def close(self) -> None: + if not self._closed: + if isinstance(self._response.body, IOBase): + self._response.body.close() + if self._connection: + self._connection.close() + self._connection = None + self._closed = True + + @contextmanager + def _error_catcher(self) -> typing.Generator[None]: + """ + Catch Emscripten specific exceptions thrown by fetch.py, + instead re-raising urllib3 variants, so that low-level exceptions + are not leaked in the high-level api. + + On exit, release the connection back to the pool. + """ + from .fetch import _RequestError, _TimeoutError # avoid circular import + + clean_exit = False + + try: + yield + # If no exception is thrown, we should avoid cleaning up + # unnecessarily. + clean_exit = True + except _TimeoutError as e: + raise TimeoutError(str(e)) + except _RequestError as e: + raise HTTPException(str(e)) + finally: + # If we didn't terminate cleanly, we need to throw away our + # connection. + if not clean_exit: + # The response may not be closed but we're not going to use it + # anymore so close it now + if ( + isinstance(self._response.body, IOBase) + and not self._response.body.closed + ): + self._response.body.close() + # release the connection back to the pool + self.release_conn() + else: + # If we have read everything from the response stream, + # return the connection back to the pool. + if ( + isinstance(self._response.body, IOBase) + and self._response.body.closed + ): + self.release_conn() diff --git a/newrelic/packages/urllib3/contrib/ntlmpool.py b/newrelic/packages/urllib3/contrib/ntlmpool.py deleted file mode 100644 index 471665754e..0000000000 --- a/newrelic/packages/urllib3/contrib/ntlmpool.py +++ /dev/null @@ -1,130 +0,0 @@ -""" -NTLM authenticating pool, contributed by erikcederstran - -Issue #10, see: http://code.google.com/p/urllib3/issues/detail?id=10 -""" -from __future__ import absolute_import - -import warnings -from logging import getLogger - -from ntlm import ntlm - -from .. import HTTPSConnectionPool -from ..packages.six.moves.http_client import HTTPSConnection - -warnings.warn( - "The 'urllib3.contrib.ntlmpool' module is deprecated and will be removed " - "in urllib3 v2.0 release, urllib3 is not able to support it properly due " - "to reasons listed in issue: https://github.com/urllib3/urllib3/issues/2282. " - "If you are a user of this module please comment in the mentioned issue.", - DeprecationWarning, -) - -log = getLogger(__name__) - - -class NTLMConnectionPool(HTTPSConnectionPool): - """ - Implements an NTLM authentication version of an urllib3 connection pool - """ - - scheme = "https" - - def __init__(self, user, pw, authurl, *args, **kwargs): - """ - authurl is a random URL on the server that is protected by NTLM. - user is the Windows user, probably in the DOMAIN\\username format. - pw is the password for the user. - """ - super(NTLMConnectionPool, self).__init__(*args, **kwargs) - self.authurl = authurl - self.rawuser = user - user_parts = user.split("\\", 1) - self.domain = user_parts[0].upper() - self.user = user_parts[1] - self.pw = pw - - def _new_conn(self): - # Performs the NTLM handshake that secures the connection. The socket - # must be kept open while requests are performed. - self.num_connections += 1 - log.debug( - "Starting NTLM HTTPS connection no. %d: https://%s%s", - self.num_connections, - self.host, - self.authurl, - ) - - headers = {"Connection": "Keep-Alive"} - req_header = "Authorization" - resp_header = "www-authenticate" - - conn = HTTPSConnection(host=self.host, port=self.port) - - # Send negotiation message - headers[req_header] = "NTLM %s" % ntlm.create_NTLM_NEGOTIATE_MESSAGE( - self.rawuser - ) - log.debug("Request headers: %s", headers) - conn.request("GET", self.authurl, None, headers) - res = conn.getresponse() - reshdr = dict(res.headers) - log.debug("Response status: %s %s", res.status, res.reason) - log.debug("Response headers: %s", reshdr) - log.debug("Response data: %s [...]", res.read(100)) - - # Remove the reference to the socket, so that it can not be closed by - # the response object (we want to keep the socket open) - res.fp = None - - # Server should respond with a challenge message - auth_header_values = reshdr[resp_header].split(", ") - auth_header_value = None - for s in auth_header_values: - if s[:5] == "NTLM ": - auth_header_value = s[5:] - if auth_header_value is None: - raise Exception( - "Unexpected %s response header: %s" % (resp_header, reshdr[resp_header]) - ) - - # Send authentication message - ServerChallenge, NegotiateFlags = ntlm.parse_NTLM_CHALLENGE_MESSAGE( - auth_header_value - ) - auth_msg = ntlm.create_NTLM_AUTHENTICATE_MESSAGE( - ServerChallenge, self.user, self.domain, self.pw, NegotiateFlags - ) - headers[req_header] = "NTLM %s" % auth_msg - log.debug("Request headers: %s", headers) - conn.request("GET", self.authurl, None, headers) - res = conn.getresponse() - log.debug("Response status: %s %s", res.status, res.reason) - log.debug("Response headers: %s", dict(res.headers)) - log.debug("Response data: %s [...]", res.read()[:100]) - if res.status != 200: - if res.status == 401: - raise Exception("Server rejected request: wrong username or password") - raise Exception("Wrong server response: %s %s" % (res.status, res.reason)) - - res.fp = None - log.debug("Connection established") - return conn - - def urlopen( - self, - method, - url, - body=None, - headers=None, - retries=3, - redirect=True, - assert_same_host=True, - ): - if headers is None: - headers = {} - headers["Connection"] = "Keep-Alive" - return super(NTLMConnectionPool, self).urlopen( - method, url, body, headers, retries, redirect, assert_same_host - ) diff --git a/newrelic/packages/urllib3/contrib/pyopenssl.py b/newrelic/packages/urllib3/contrib/pyopenssl.py index 1ed214b1d7..8e05d3d785 100644 --- a/newrelic/packages/urllib3/contrib/pyopenssl.py +++ b/newrelic/packages/urllib3/contrib/pyopenssl.py @@ -1,17 +1,17 @@ """ -TLS with SNI_-support for Python 2. Follow these instructions if you would -like to verify TLS certificates in Python 2. Note, the default libraries do -*not* do certificate checking; you need to do additional work to validate -certificates yourself. +Module for using pyOpenSSL as a TLS backend. This module was relevant before +the standard library ``ssl`` module supported SNI, but now that we've dropped +support for Python 2.7 all relevant Python versions support SNI so +**this module is no longer recommended**. This needs the following packages installed: * `pyOpenSSL`_ (tested with 16.0.0) * `cryptography`_ (minimum 1.3.4, from pyopenssl) -* `idna`_ (minimum 2.0, from cryptography) +* `idna`_ (minimum 2.0) -However, pyopenssl depends on cryptography, which depends on idna, so while we -use all three directly here we end up having relatively few packages required. +However, pyOpenSSL depends on cryptography, so while we use all three directly here we +end up having relatively few packages required. You can install them with the following command: @@ -33,75 +33,46 @@ except ImportError: pass -Now you can use :mod:`urllib3` as you normally would, and it will support SNI -when the required modules are installed. - -Activating this module also has the positive side effect of disabling SSL/TLS -compression in Python 2 (see `CRIME attack`_). - -.. _sni: https://en.wikipedia.org/wiki/Server_Name_Indication -.. _crime attack: https://en.wikipedia.org/wiki/CRIME_(security_exploit) .. _pyopenssl: https://www.pyopenssl.org .. _cryptography: https://cryptography.io .. _idna: https://github.com/kjd/idna """ -from __future__ import absolute_import -import OpenSSL.crypto -import OpenSSL.SSL +from __future__ import annotations + +import OpenSSL.SSL # type: ignore[import-not-found] from cryptography import x509 -from cryptography.hazmat.backends.openssl import backend as openssl_backend try: - from cryptography.x509 import UnsupportedExtension + from cryptography.x509 import UnsupportedExtension # type: ignore[attr-defined] except ImportError: # UnsupportedExtension is gone in cryptography >= 2.1.0 - class UnsupportedExtension(Exception): + class UnsupportedExtension(Exception): # type: ignore[no-redef] pass +import logging +import ssl +import typing from io import BytesIO -from socket import error as SocketError +from socket import socket as socket_cls from socket import timeout -try: # Platform-specific: Python 2 - from socket import _fileobject -except ImportError: # Platform-specific: Python 3 - _fileobject = None - from ..packages.backports.makefile import backport_makefile +from .. import util -import logging -import ssl -import sys -import warnings +if typing.TYPE_CHECKING: + from OpenSSL.crypto import X509 # type: ignore[import-not-found] -from .. import util -from ..packages import six -from ..util.ssl_ import PROTOCOL_TLS_CLIENT - -warnings.warn( - "'urllib3.contrib.pyopenssl' module is deprecated and will be removed " - "in a future release of urllib3 2.x. Read more in this issue: " - "https://github.com/urllib3/urllib3/issues/2680", - category=DeprecationWarning, - stacklevel=2, -) __all__ = ["inject_into_urllib3", "extract_from_urllib3"] -# SNI always works. -HAS_SNI = True - # Map from urllib3 to PyOpenSSL compatible parameter-values. -_openssl_versions = { - util.PROTOCOL_TLS: OpenSSL.SSL.SSLv23_METHOD, - PROTOCOL_TLS_CLIENT: OpenSSL.SSL.SSLv23_METHOD, +_openssl_versions: dict[int, int] = { + util.ssl_.PROTOCOL_TLS: OpenSSL.SSL.SSLv23_METHOD, # type: ignore[attr-defined] + util.ssl_.PROTOCOL_TLS_CLIENT: OpenSSL.SSL.SSLv23_METHOD, # type: ignore[attr-defined] ssl.PROTOCOL_TLSv1: OpenSSL.SSL.TLSv1_METHOD, } -if hasattr(ssl, "PROTOCOL_SSLv3") and hasattr(OpenSSL.SSL, "SSLv3_METHOD"): - _openssl_versions[ssl.PROTOCOL_SSLv3] = OpenSSL.SSL.SSLv3_METHOD - if hasattr(ssl, "PROTOCOL_TLSv1_1") and hasattr(OpenSSL.SSL, "TLSv1_1_METHOD"): _openssl_versions[ssl.PROTOCOL_TLSv1_1] = OpenSSL.SSL.TLSv1_1_METHOD @@ -115,43 +86,77 @@ class UnsupportedExtension(Exception): ssl.CERT_REQUIRED: OpenSSL.SSL.VERIFY_PEER + OpenSSL.SSL.VERIFY_FAIL_IF_NO_PEER_CERT, } -_openssl_to_stdlib_verify = dict((v, k) for k, v in _stdlib_to_openssl_verify.items()) +_openssl_to_stdlib_verify = {v: k for k, v in _stdlib_to_openssl_verify.items()} + +# The SSLvX values are the most likely to be missing in the future +# but we check them all just to be sure. +_OP_NO_SSLv2_OR_SSLv3: int = getattr(OpenSSL.SSL, "OP_NO_SSLv2", 0) | getattr( + OpenSSL.SSL, "OP_NO_SSLv3", 0 +) +_OP_NO_TLSv1: int = getattr(OpenSSL.SSL, "OP_NO_TLSv1", 0) +_OP_NO_TLSv1_1: int = getattr(OpenSSL.SSL, "OP_NO_TLSv1_1", 0) +_OP_NO_TLSv1_2: int = getattr(OpenSSL.SSL, "OP_NO_TLSv1_2", 0) +_OP_NO_TLSv1_3: int = getattr(OpenSSL.SSL, "OP_NO_TLSv1_3", 0) + +_openssl_to_ssl_minimum_version: dict[int, int] = { + ssl.TLSVersion.MINIMUM_SUPPORTED: _OP_NO_SSLv2_OR_SSLv3, + ssl.TLSVersion.TLSv1: _OP_NO_SSLv2_OR_SSLv3, + ssl.TLSVersion.TLSv1_1: _OP_NO_SSLv2_OR_SSLv3 | _OP_NO_TLSv1, + ssl.TLSVersion.TLSv1_2: _OP_NO_SSLv2_OR_SSLv3 | _OP_NO_TLSv1 | _OP_NO_TLSv1_1, + ssl.TLSVersion.TLSv1_3: ( + _OP_NO_SSLv2_OR_SSLv3 | _OP_NO_TLSv1 | _OP_NO_TLSv1_1 | _OP_NO_TLSv1_2 + ), + ssl.TLSVersion.MAXIMUM_SUPPORTED: ( + _OP_NO_SSLv2_OR_SSLv3 | _OP_NO_TLSv1 | _OP_NO_TLSv1_1 | _OP_NO_TLSv1_2 + ), +} +_openssl_to_ssl_maximum_version: dict[int, int] = { + ssl.TLSVersion.MINIMUM_SUPPORTED: ( + _OP_NO_SSLv2_OR_SSLv3 + | _OP_NO_TLSv1 + | _OP_NO_TLSv1_1 + | _OP_NO_TLSv1_2 + | _OP_NO_TLSv1_3 + ), + ssl.TLSVersion.TLSv1: ( + _OP_NO_SSLv2_OR_SSLv3 | _OP_NO_TLSv1_1 | _OP_NO_TLSv1_2 | _OP_NO_TLSv1_3 + ), + ssl.TLSVersion.TLSv1_1: _OP_NO_SSLv2_OR_SSLv3 | _OP_NO_TLSv1_2 | _OP_NO_TLSv1_3, + ssl.TLSVersion.TLSv1_2: _OP_NO_SSLv2_OR_SSLv3 | _OP_NO_TLSv1_3, + ssl.TLSVersion.TLSv1_3: _OP_NO_SSLv2_OR_SSLv3, + ssl.TLSVersion.MAXIMUM_SUPPORTED: _OP_NO_SSLv2_OR_SSLv3, +} # OpenSSL will only write 16K at a time SSL_WRITE_BLOCKSIZE = 16384 -orig_util_HAS_SNI = util.HAS_SNI orig_util_SSLContext = util.ssl_.SSLContext log = logging.getLogger(__name__) -def inject_into_urllib3(): +def inject_into_urllib3() -> None: "Monkey-patch urllib3 with PyOpenSSL-backed SSL-support." _validate_dependencies_met() - util.SSLContext = PyOpenSSLContext - util.ssl_.SSLContext = PyOpenSSLContext - util.HAS_SNI = HAS_SNI - util.ssl_.HAS_SNI = HAS_SNI + util.SSLContext = PyOpenSSLContext # type: ignore[assignment] + util.ssl_.SSLContext = PyOpenSSLContext # type: ignore[assignment] util.IS_PYOPENSSL = True util.ssl_.IS_PYOPENSSL = True -def extract_from_urllib3(): +def extract_from_urllib3() -> None: "Undo monkey-patching by :func:`inject_into_urllib3`." util.SSLContext = orig_util_SSLContext util.ssl_.SSLContext = orig_util_SSLContext - util.HAS_SNI = orig_util_HAS_SNI - util.ssl_.HAS_SNI = orig_util_HAS_SNI util.IS_PYOPENSSL = False util.ssl_.IS_PYOPENSSL = False -def _validate_dependencies_met(): +def _validate_dependencies_met() -> None: """ Verifies that PyOpenSSL's package-level dependencies have been met. Throws `ImportError` if they are not met. @@ -177,7 +182,7 @@ def _validate_dependencies_met(): ) -def _dnsname_to_stdlib(name): +def _dnsname_to_stdlib(name: str) -> str | None: """ Converts a dNSName SubjectAlternativeName field to the form used by the standard library on the given Python version. @@ -191,7 +196,7 @@ def _dnsname_to_stdlib(name): the name given should be skipped. """ - def idna_encode(name): + def idna_encode(name: str) -> bytes | None: """ Borrowed wholesale from the Python Cryptography Project. It turns out that we can't just safely call `idna.encode`: it can explode for @@ -200,7 +205,7 @@ def idna_encode(name): import idna try: - for prefix in [u"*.", u"."]: + for prefix in ["*.", "."]: if name.startswith(prefix): name = name[len(prefix) :] return prefix.encode("ascii") + idna.encode(name) @@ -212,24 +217,17 @@ def idna_encode(name): if ":" in name: return name - name = idna_encode(name) - if name is None: + encoded_name = idna_encode(name) + if encoded_name is None: return None - elif sys.version_info >= (3, 0): - name = name.decode("utf-8") - return name + return encoded_name.decode("utf-8") -def get_subj_alt_name(peer_cert): +def get_subj_alt_name(peer_cert: X509) -> list[tuple[str, str]]: """ Given an PyOpenSSL certificate, provides all the subject alternative names. """ - # Pass the cert to cryptography, which has much better APIs for this. - if hasattr(peer_cert, "to_cryptography"): - cert = peer_cert.to_cryptography() - else: - der = OpenSSL.crypto.dump_certificate(OpenSSL.crypto.FILETYPE_ASN1, peer_cert) - cert = x509.load_der_x509_certificate(der, openssl_backend) + cert = peer_cert.to_cryptography() # We want to find the SAN extension. Ask Cryptography to locate it (it's # faster than looping in Python) @@ -273,93 +271,94 @@ def get_subj_alt_name(peer_cert): return names -class WrappedSocket(object): - """API-compatibility wrapper for Python OpenSSL's Connection-class. +class WrappedSocket: + """API-compatibility wrapper for Python OpenSSL's Connection-class.""" - Note: _makefile_refs, _drop() and _reuse() are needed for the garbage - collector of pypy. - """ - - def __init__(self, connection, socket, suppress_ragged_eofs=True): + def __init__( + self, + connection: OpenSSL.SSL.Connection, + socket: socket_cls, + suppress_ragged_eofs: bool = True, + ) -> None: self.connection = connection self.socket = socket self.suppress_ragged_eofs = suppress_ragged_eofs - self._makefile_refs = 0 + self._io_refs = 0 self._closed = False - def fileno(self): + def fileno(self) -> int: return self.socket.fileno() # Copy-pasted from Python 3.5 source code - def _decref_socketios(self): - if self._makefile_refs > 0: - self._makefile_refs -= 1 + def _decref_socketios(self) -> None: + if self._io_refs > 0: + self._io_refs -= 1 if self._closed: self.close() - def recv(self, *args, **kwargs): + def recv(self, *args: typing.Any, **kwargs: typing.Any) -> bytes: try: data = self.connection.recv(*args, **kwargs) except OpenSSL.SSL.SysCallError as e: if self.suppress_ragged_eofs and e.args == (-1, "Unexpected EOF"): return b"" else: - raise SocketError(str(e)) + raise OSError(e.args[0], str(e)) from e except OpenSSL.SSL.ZeroReturnError: if self.connection.get_shutdown() == OpenSSL.SSL.RECEIVED_SHUTDOWN: return b"" else: raise - except OpenSSL.SSL.WantReadError: + except OpenSSL.SSL.WantReadError as e: if not util.wait_for_read(self.socket, self.socket.gettimeout()): - raise timeout("The read operation timed out") + raise timeout("The read operation timed out") from e else: return self.recv(*args, **kwargs) # TLS 1.3 post-handshake authentication except OpenSSL.SSL.Error as e: - raise ssl.SSLError("read error: %r" % e) + raise ssl.SSLError(f"read error: {e!r}") from e else: - return data + return data # type: ignore[no-any-return] - def recv_into(self, *args, **kwargs): + def recv_into(self, *args: typing.Any, **kwargs: typing.Any) -> int: try: - return self.connection.recv_into(*args, **kwargs) + return self.connection.recv_into(*args, **kwargs) # type: ignore[no-any-return] except OpenSSL.SSL.SysCallError as e: if self.suppress_ragged_eofs and e.args == (-1, "Unexpected EOF"): return 0 else: - raise SocketError(str(e)) + raise OSError(e.args[0], str(e)) from e except OpenSSL.SSL.ZeroReturnError: if self.connection.get_shutdown() == OpenSSL.SSL.RECEIVED_SHUTDOWN: return 0 else: raise - except OpenSSL.SSL.WantReadError: + except OpenSSL.SSL.WantReadError as e: if not util.wait_for_read(self.socket, self.socket.gettimeout()): - raise timeout("The read operation timed out") + raise timeout("The read operation timed out") from e else: return self.recv_into(*args, **kwargs) # TLS 1.3 post-handshake authentication except OpenSSL.SSL.Error as e: - raise ssl.SSLError("read error: %r" % e) + raise ssl.SSLError(f"read error: {e!r}") from e - def settimeout(self, timeout): + def settimeout(self, timeout: float) -> None: return self.socket.settimeout(timeout) - def _send_until_done(self, data): + def _send_until_done(self, data: bytes) -> int: while True: try: - return self.connection.send(data) - except OpenSSL.SSL.WantWriteError: + return self.connection.send(data) # type: ignore[no-any-return] + except OpenSSL.SSL.WantWriteError as e: if not util.wait_for_write(self.socket, self.socket.gettimeout()): - raise timeout() + raise timeout() from e continue except OpenSSL.SSL.SysCallError as e: - raise SocketError(str(e)) + raise OSError(e.args[0], str(e)) from e - def sendall(self, data): + def sendall(self, data: bytes) -> None: total_sent = 0 while total_sent < len(data): sent = self._send_until_done( @@ -367,135 +366,151 @@ def sendall(self, data): ) total_sent += sent - def shutdown(self): - # FIXME rethrow compatible exceptions should we ever use this - self.connection.shutdown() + def shutdown(self, how: int) -> None: + try: + self.connection.shutdown() + except OpenSSL.SSL.Error as e: + raise ssl.SSLError(f"shutdown error: {e!r}") from e - def close(self): - if self._makefile_refs < 1: - try: - self._closed = True - return self.connection.close() - except OpenSSL.SSL.Error: - return - else: - self._makefile_refs -= 1 + def close(self) -> None: + self._closed = True + if self._io_refs <= 0: + self._real_close() + + def _real_close(self) -> None: + try: + return self.connection.close() # type: ignore[no-any-return] + except OpenSSL.SSL.Error: + return - def getpeercert(self, binary_form=False): + def getpeercert( + self, binary_form: bool = False + ) -> dict[str, list[typing.Any]] | None: x509 = self.connection.get_peer_certificate() if not x509: - return x509 + return x509 # type: ignore[no-any-return] if binary_form: - return OpenSSL.crypto.dump_certificate(OpenSSL.crypto.FILETYPE_ASN1, x509) + return OpenSSL.crypto.dump_certificate(OpenSSL.crypto.FILETYPE_ASN1, x509) # type: ignore[no-any-return] return { - "subject": ((("commonName", x509.get_subject().CN),),), + "subject": ((("commonName", x509.get_subject().CN),),), # type: ignore[dict-item] "subjectAltName": get_subj_alt_name(x509), } - def version(self): - return self.connection.get_protocol_version_name() + def version(self) -> str: + return self.connection.get_protocol_version_name() # type: ignore[no-any-return] - def _reuse(self): - self._makefile_refs += 1 - - def _drop(self): - if self._makefile_refs < 1: - self.close() - else: - self._makefile_refs -= 1 + def selected_alpn_protocol(self) -> str | None: + alpn_proto = self.connection.get_alpn_proto_negotiated() + return alpn_proto.decode() if alpn_proto else None -if _fileobject: # Platform-specific: Python 2 +WrappedSocket.makefile = socket_cls.makefile # type: ignore[attr-defined] - def makefile(self, mode, bufsize=-1): - self._makefile_refs += 1 - return _fileobject(self, mode, bufsize, close=True) -else: # Platform-specific: Python 3 - makefile = backport_makefile - -WrappedSocket.makefile = makefile - - -class PyOpenSSLContext(object): +class PyOpenSSLContext: """ I am a wrapper class for the PyOpenSSL ``Context`` object. I am responsible for translating the interface of the standard library ``SSLContext`` object to calls into PyOpenSSL. """ - def __init__(self, protocol): + def __init__(self, protocol: int) -> None: self.protocol = _openssl_versions[protocol] self._ctx = OpenSSL.SSL.Context(self.protocol) self._options = 0 self.check_hostname = False + self._minimum_version: int = ssl.TLSVersion.MINIMUM_SUPPORTED + self._maximum_version: int = ssl.TLSVersion.MAXIMUM_SUPPORTED + self._verify_flags: int = ssl.VERIFY_X509_TRUSTED_FIRST @property - def options(self): + def options(self) -> int: return self._options @options.setter - def options(self, value): + def options(self, value: int) -> None: self._options = value - self._ctx.set_options(value) + self._set_ctx_options() + + @property + def verify_flags(self) -> int: + return self._verify_flags + + @verify_flags.setter + def verify_flags(self, value: int) -> None: + self._verify_flags = value + self._ctx.get_cert_store().set_flags(self._verify_flags) @property - def verify_mode(self): + def verify_mode(self) -> int: return _openssl_to_stdlib_verify[self._ctx.get_verify_mode()] @verify_mode.setter - def verify_mode(self, value): + def verify_mode(self, value: ssl.VerifyMode) -> None: self._ctx.set_verify(_stdlib_to_openssl_verify[value], _verify_callback) - def set_default_verify_paths(self): + def set_default_verify_paths(self) -> None: self._ctx.set_default_verify_paths() - def set_ciphers(self, ciphers): - if isinstance(ciphers, six.text_type): + def set_ciphers(self, ciphers: bytes | str) -> None: + if isinstance(ciphers, str): ciphers = ciphers.encode("utf-8") self._ctx.set_cipher_list(ciphers) - def load_verify_locations(self, cafile=None, capath=None, cadata=None): + def load_verify_locations( + self, + cafile: str | None = None, + capath: str | None = None, + cadata: bytes | None = None, + ) -> None: if cafile is not None: - cafile = cafile.encode("utf-8") + cafile = cafile.encode("utf-8") # type: ignore[assignment] if capath is not None: - capath = capath.encode("utf-8") + capath = capath.encode("utf-8") # type: ignore[assignment] try: self._ctx.load_verify_locations(cafile, capath) if cadata is not None: self._ctx.load_verify_locations(BytesIO(cadata)) except OpenSSL.SSL.Error as e: - raise ssl.SSLError("unable to load trusted certificates: %r" % e) + raise ssl.SSLError(f"unable to load trusted certificates: {e!r}") from e - def load_cert_chain(self, certfile, keyfile=None, password=None): - self._ctx.use_certificate_chain_file(certfile) - if password is not None: - if not isinstance(password, six.binary_type): - password = password.encode("utf-8") - self._ctx.set_passwd_cb(lambda *_: password) - self._ctx.use_privatekey_file(keyfile or certfile) + def load_cert_chain( + self, + certfile: str, + keyfile: str | None = None, + password: str | None = None, + ) -> None: + try: + self._ctx.use_certificate_chain_file(certfile) + if password is not None: + if not isinstance(password, bytes): + password = password.encode("utf-8") # type: ignore[assignment] + self._ctx.set_passwd_cb(lambda *_: password) + self._ctx.use_privatekey_file(keyfile or certfile) + except OpenSSL.SSL.Error as e: + raise ssl.SSLError(f"Unable to load certificate chain: {e!r}") from e - def set_alpn_protocols(self, protocols): - protocols = [six.ensure_binary(p) for p in protocols] - return self._ctx.set_alpn_protos(protocols) + def set_alpn_protocols(self, protocols: list[bytes | str]) -> None: + protocols = [util.util.to_bytes(p, "ascii") for p in protocols] + return self._ctx.set_alpn_protos(protocols) # type: ignore[no-any-return] def wrap_socket( self, - sock, - server_side=False, - do_handshake_on_connect=True, - suppress_ragged_eofs=True, - server_hostname=None, - ): + sock: socket_cls, + server_side: bool = False, + do_handshake_on_connect: bool = True, + suppress_ragged_eofs: bool = True, + server_hostname: bytes | str | None = None, + ) -> WrappedSocket: cnx = OpenSSL.SSL.Connection(self._ctx, sock) - if isinstance(server_hostname, six.text_type): # Platform-specific: Python 3 - server_hostname = server_hostname.encode("utf-8") - - if server_hostname is not None: + # If server_hostname is an IP, don't use it for SNI, per RFC6066 Section 3 + if server_hostname and not util.ssl_.is_ipaddress(server_hostname): + if isinstance(server_hostname, str): + server_hostname = server_hostname.encode("utf-8") cnx.set_tlsext_host_name(server_hostname) cnx.set_connect_state() @@ -503,16 +518,47 @@ def wrap_socket( while True: try: cnx.do_handshake() - except OpenSSL.SSL.WantReadError: + except OpenSSL.SSL.WantReadError as e: if not util.wait_for_read(sock, sock.gettimeout()): - raise timeout("select timed out") + raise timeout("select timed out") from e continue except OpenSSL.SSL.Error as e: - raise ssl.SSLError("bad handshake: %r" % e) + raise ssl.SSLError(f"bad handshake: {e!r}") from e break return WrappedSocket(cnx, sock) + def _set_ctx_options(self) -> None: + self._ctx.set_options( + self._options + | _openssl_to_ssl_minimum_version[self._minimum_version] + | _openssl_to_ssl_maximum_version[self._maximum_version] + ) + + @property + def minimum_version(self) -> int: + return self._minimum_version -def _verify_callback(cnx, x509, err_no, err_depth, return_code): + @minimum_version.setter + def minimum_version(self, minimum_version: int) -> None: + self._minimum_version = minimum_version + self._set_ctx_options() + + @property + def maximum_version(self) -> int: + return self._maximum_version + + @maximum_version.setter + def maximum_version(self, maximum_version: int) -> None: + self._maximum_version = maximum_version + self._set_ctx_options() + + +def _verify_callback( + cnx: OpenSSL.SSL.Connection, + x509: X509, + err_no: int, + err_depth: int, + return_code: int, +) -> bool: return err_no == 0 diff --git a/newrelic/packages/urllib3/contrib/securetransport.py b/newrelic/packages/urllib3/contrib/securetransport.py deleted file mode 100644 index e311c0c899..0000000000 --- a/newrelic/packages/urllib3/contrib/securetransport.py +++ /dev/null @@ -1,920 +0,0 @@ -""" -SecureTranport support for urllib3 via ctypes. - -This makes platform-native TLS available to urllib3 users on macOS without the -use of a compiler. This is an important feature because the Python Package -Index is moving to become a TLSv1.2-or-higher server, and the default OpenSSL -that ships with macOS is not capable of doing TLSv1.2. The only way to resolve -this is to give macOS users an alternative solution to the problem, and that -solution is to use SecureTransport. - -We use ctypes here because this solution must not require a compiler. That's -because pip is not allowed to require a compiler either. - -This is not intended to be a seriously long-term solution to this problem. -The hope is that PEP 543 will eventually solve this issue for us, at which -point we can retire this contrib module. But in the short term, we need to -solve the impending tire fire that is Python on Mac without this kind of -contrib module. So...here we are. - -To use this module, simply import and inject it:: - - import urllib3.contrib.securetransport - urllib3.contrib.securetransport.inject_into_urllib3() - -Happy TLSing! - -This code is a bastardised version of the code found in Will Bond's oscrypto -library. An enormous debt is owed to him for blazing this trail for us. For -that reason, this code should be considered to be covered both by urllib3's -license and by oscrypto's: - -.. code-block:: - - Copyright (c) 2015-2016 Will Bond - - Permission is hereby granted, free of charge, to any person obtaining a - copy of this software and associated documentation files (the "Software"), - to deal in the Software without restriction, including without limitation - the rights to use, copy, modify, merge, publish, distribute, sublicense, - and/or sell copies of the Software, and to permit persons to whom the - Software is furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice shall be included in - all copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING - FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER - DEALINGS IN THE SOFTWARE. -""" -from __future__ import absolute_import - -import contextlib -import ctypes -import errno -import os.path -import shutil -import socket -import ssl -import struct -import threading -import weakref - -from .. import util -from ..packages import six -from ..util.ssl_ import PROTOCOL_TLS_CLIENT -from ._securetransport.bindings import CoreFoundation, Security, SecurityConst -from ._securetransport.low_level import ( - _assert_no_error, - _build_tls_unknown_ca_alert, - _cert_array_from_pem, - _create_cfstring_array, - _load_client_cert_chain, - _temporary_keychain, -) - -try: # Platform-specific: Python 2 - from socket import _fileobject -except ImportError: # Platform-specific: Python 3 - _fileobject = None - from ..packages.backports.makefile import backport_makefile - -__all__ = ["inject_into_urllib3", "extract_from_urllib3"] - -# SNI always works -HAS_SNI = True - -orig_util_HAS_SNI = util.HAS_SNI -orig_util_SSLContext = util.ssl_.SSLContext - -# This dictionary is used by the read callback to obtain a handle to the -# calling wrapped socket. This is a pretty silly approach, but for now it'll -# do. I feel like I should be able to smuggle a handle to the wrapped socket -# directly in the SSLConnectionRef, but for now this approach will work I -# guess. -# -# We need to lock around this structure for inserts, but we don't do it for -# reads/writes in the callbacks. The reasoning here goes as follows: -# -# 1. It is not possible to call into the callbacks before the dictionary is -# populated, so once in the callback the id must be in the dictionary. -# 2. The callbacks don't mutate the dictionary, they only read from it, and -# so cannot conflict with any of the insertions. -# -# This is good: if we had to lock in the callbacks we'd drastically slow down -# the performance of this code. -_connection_refs = weakref.WeakValueDictionary() -_connection_ref_lock = threading.Lock() - -# Limit writes to 16kB. This is OpenSSL's limit, but we'll cargo-cult it over -# for no better reason than we need *a* limit, and this one is right there. -SSL_WRITE_BLOCKSIZE = 16384 - -# This is our equivalent of util.ssl_.DEFAULT_CIPHERS, but expanded out to -# individual cipher suites. We need to do this because this is how -# SecureTransport wants them. -CIPHER_SUITES = [ - SecurityConst.TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, - SecurityConst.TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, - SecurityConst.TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, - SecurityConst.TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, - SecurityConst.TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256, - SecurityConst.TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256, - SecurityConst.TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, - SecurityConst.TLS_DHE_RSA_WITH_AES_128_GCM_SHA256, - SecurityConst.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, - SecurityConst.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, - SecurityConst.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, - SecurityConst.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, - SecurityConst.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, - SecurityConst.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, - SecurityConst.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, - SecurityConst.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, - SecurityConst.TLS_DHE_RSA_WITH_AES_256_CBC_SHA256, - SecurityConst.TLS_DHE_RSA_WITH_AES_256_CBC_SHA, - SecurityConst.TLS_DHE_RSA_WITH_AES_128_CBC_SHA256, - SecurityConst.TLS_DHE_RSA_WITH_AES_128_CBC_SHA, - SecurityConst.TLS_AES_256_GCM_SHA384, - SecurityConst.TLS_AES_128_GCM_SHA256, - SecurityConst.TLS_RSA_WITH_AES_256_GCM_SHA384, - SecurityConst.TLS_RSA_WITH_AES_128_GCM_SHA256, - SecurityConst.TLS_AES_128_CCM_8_SHA256, - SecurityConst.TLS_AES_128_CCM_SHA256, - SecurityConst.TLS_RSA_WITH_AES_256_CBC_SHA256, - SecurityConst.TLS_RSA_WITH_AES_128_CBC_SHA256, - SecurityConst.TLS_RSA_WITH_AES_256_CBC_SHA, - SecurityConst.TLS_RSA_WITH_AES_128_CBC_SHA, -] - -# Basically this is simple: for PROTOCOL_SSLv23 we turn it into a low of -# TLSv1 and a high of TLSv1.2. For everything else, we pin to that version. -# TLSv1 to 1.2 are supported on macOS 10.8+ -_protocol_to_min_max = { - util.PROTOCOL_TLS: (SecurityConst.kTLSProtocol1, SecurityConst.kTLSProtocol12), - PROTOCOL_TLS_CLIENT: (SecurityConst.kTLSProtocol1, SecurityConst.kTLSProtocol12), -} - -if hasattr(ssl, "PROTOCOL_SSLv2"): - _protocol_to_min_max[ssl.PROTOCOL_SSLv2] = ( - SecurityConst.kSSLProtocol2, - SecurityConst.kSSLProtocol2, - ) -if hasattr(ssl, "PROTOCOL_SSLv3"): - _protocol_to_min_max[ssl.PROTOCOL_SSLv3] = ( - SecurityConst.kSSLProtocol3, - SecurityConst.kSSLProtocol3, - ) -if hasattr(ssl, "PROTOCOL_TLSv1"): - _protocol_to_min_max[ssl.PROTOCOL_TLSv1] = ( - SecurityConst.kTLSProtocol1, - SecurityConst.kTLSProtocol1, - ) -if hasattr(ssl, "PROTOCOL_TLSv1_1"): - _protocol_to_min_max[ssl.PROTOCOL_TLSv1_1] = ( - SecurityConst.kTLSProtocol11, - SecurityConst.kTLSProtocol11, - ) -if hasattr(ssl, "PROTOCOL_TLSv1_2"): - _protocol_to_min_max[ssl.PROTOCOL_TLSv1_2] = ( - SecurityConst.kTLSProtocol12, - SecurityConst.kTLSProtocol12, - ) - - -def inject_into_urllib3(): - """ - Monkey-patch urllib3 with SecureTransport-backed SSL-support. - """ - util.SSLContext = SecureTransportContext - util.ssl_.SSLContext = SecureTransportContext - util.HAS_SNI = HAS_SNI - util.ssl_.HAS_SNI = HAS_SNI - util.IS_SECURETRANSPORT = True - util.ssl_.IS_SECURETRANSPORT = True - - -def extract_from_urllib3(): - """ - Undo monkey-patching by :func:`inject_into_urllib3`. - """ - util.SSLContext = orig_util_SSLContext - util.ssl_.SSLContext = orig_util_SSLContext - util.HAS_SNI = orig_util_HAS_SNI - util.ssl_.HAS_SNI = orig_util_HAS_SNI - util.IS_SECURETRANSPORT = False - util.ssl_.IS_SECURETRANSPORT = False - - -def _read_callback(connection_id, data_buffer, data_length_pointer): - """ - SecureTransport read callback. This is called by ST to request that data - be returned from the socket. - """ - wrapped_socket = None - try: - wrapped_socket = _connection_refs.get(connection_id) - if wrapped_socket is None: - return SecurityConst.errSSLInternal - base_socket = wrapped_socket.socket - - requested_length = data_length_pointer[0] - - timeout = wrapped_socket.gettimeout() - error = None - read_count = 0 - - try: - while read_count < requested_length: - if timeout is None or timeout >= 0: - if not util.wait_for_read(base_socket, timeout): - raise socket.error(errno.EAGAIN, "timed out") - - remaining = requested_length - read_count - buffer = (ctypes.c_char * remaining).from_address( - data_buffer + read_count - ) - chunk_size = base_socket.recv_into(buffer, remaining) - read_count += chunk_size - if not chunk_size: - if not read_count: - return SecurityConst.errSSLClosedGraceful - break - except (socket.error) as e: - error = e.errno - - if error is not None and error != errno.EAGAIN: - data_length_pointer[0] = read_count - if error == errno.ECONNRESET or error == errno.EPIPE: - return SecurityConst.errSSLClosedAbort - raise - - data_length_pointer[0] = read_count - - if read_count != requested_length: - return SecurityConst.errSSLWouldBlock - - return 0 - except Exception as e: - if wrapped_socket is not None: - wrapped_socket._exception = e - return SecurityConst.errSSLInternal - - -def _write_callback(connection_id, data_buffer, data_length_pointer): - """ - SecureTransport write callback. This is called by ST to request that data - actually be sent on the network. - """ - wrapped_socket = None - try: - wrapped_socket = _connection_refs.get(connection_id) - if wrapped_socket is None: - return SecurityConst.errSSLInternal - base_socket = wrapped_socket.socket - - bytes_to_write = data_length_pointer[0] - data = ctypes.string_at(data_buffer, bytes_to_write) - - timeout = wrapped_socket.gettimeout() - error = None - sent = 0 - - try: - while sent < bytes_to_write: - if timeout is None or timeout >= 0: - if not util.wait_for_write(base_socket, timeout): - raise socket.error(errno.EAGAIN, "timed out") - chunk_sent = base_socket.send(data) - sent += chunk_sent - - # This has some needless copying here, but I'm not sure there's - # much value in optimising this data path. - data = data[chunk_sent:] - except (socket.error) as e: - error = e.errno - - if error is not None and error != errno.EAGAIN: - data_length_pointer[0] = sent - if error == errno.ECONNRESET or error == errno.EPIPE: - return SecurityConst.errSSLClosedAbort - raise - - data_length_pointer[0] = sent - - if sent != bytes_to_write: - return SecurityConst.errSSLWouldBlock - - return 0 - except Exception as e: - if wrapped_socket is not None: - wrapped_socket._exception = e - return SecurityConst.errSSLInternal - - -# We need to keep these two objects references alive: if they get GC'd while -# in use then SecureTransport could attempt to call a function that is in freed -# memory. That would be...uh...bad. Yeah, that's the word. Bad. -_read_callback_pointer = Security.SSLReadFunc(_read_callback) -_write_callback_pointer = Security.SSLWriteFunc(_write_callback) - - -class WrappedSocket(object): - """ - API-compatibility wrapper for Python's OpenSSL wrapped socket object. - - Note: _makefile_refs, _drop(), and _reuse() are needed for the garbage - collector of PyPy. - """ - - def __init__(self, socket): - self.socket = socket - self.context = None - self._makefile_refs = 0 - self._closed = False - self._exception = None - self._keychain = None - self._keychain_dir = None - self._client_cert_chain = None - - # We save off the previously-configured timeout and then set it to - # zero. This is done because we use select and friends to handle the - # timeouts, but if we leave the timeout set on the lower socket then - # Python will "kindly" call select on that socket again for us. Avoid - # that by forcing the timeout to zero. - self._timeout = self.socket.gettimeout() - self.socket.settimeout(0) - - @contextlib.contextmanager - def _raise_on_error(self): - """ - A context manager that can be used to wrap calls that do I/O from - SecureTransport. If any of the I/O callbacks hit an exception, this - context manager will correctly propagate the exception after the fact. - This avoids silently swallowing those exceptions. - - It also correctly forces the socket closed. - """ - self._exception = None - - # We explicitly don't catch around this yield because in the unlikely - # event that an exception was hit in the block we don't want to swallow - # it. - yield - if self._exception is not None: - exception, self._exception = self._exception, None - self.close() - raise exception - - def _set_ciphers(self): - """ - Sets up the allowed ciphers. By default this matches the set in - util.ssl_.DEFAULT_CIPHERS, at least as supported by macOS. This is done - custom and doesn't allow changing at this time, mostly because parsing - OpenSSL cipher strings is going to be a freaking nightmare. - """ - ciphers = (Security.SSLCipherSuite * len(CIPHER_SUITES))(*CIPHER_SUITES) - result = Security.SSLSetEnabledCiphers( - self.context, ciphers, len(CIPHER_SUITES) - ) - _assert_no_error(result) - - def _set_alpn_protocols(self, protocols): - """ - Sets up the ALPN protocols on the context. - """ - if not protocols: - return - protocols_arr = _create_cfstring_array(protocols) - try: - result = Security.SSLSetALPNProtocols(self.context, protocols_arr) - _assert_no_error(result) - finally: - CoreFoundation.CFRelease(protocols_arr) - - def _custom_validate(self, verify, trust_bundle): - """ - Called when we have set custom validation. We do this in two cases: - first, when cert validation is entirely disabled; and second, when - using a custom trust DB. - Raises an SSLError if the connection is not trusted. - """ - # If we disabled cert validation, just say: cool. - if not verify: - return - - successes = ( - SecurityConst.kSecTrustResultUnspecified, - SecurityConst.kSecTrustResultProceed, - ) - try: - trust_result = self._evaluate_trust(trust_bundle) - if trust_result in successes: - return - reason = "error code: %d" % (trust_result,) - except Exception as e: - # Do not trust on error - reason = "exception: %r" % (e,) - - # SecureTransport does not send an alert nor shuts down the connection. - rec = _build_tls_unknown_ca_alert(self.version()) - self.socket.sendall(rec) - # close the connection immediately - # l_onoff = 1, activate linger - # l_linger = 0, linger for 0 seoncds - opts = struct.pack("ii", 1, 0) - self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_LINGER, opts) - self.close() - raise ssl.SSLError("certificate verify failed, %s" % reason) - - def _evaluate_trust(self, trust_bundle): - # We want data in memory, so load it up. - if os.path.isfile(trust_bundle): - with open(trust_bundle, "rb") as f: - trust_bundle = f.read() - - cert_array = None - trust = Security.SecTrustRef() - - try: - # Get a CFArray that contains the certs we want. - cert_array = _cert_array_from_pem(trust_bundle) - - # Ok, now the hard part. We want to get the SecTrustRef that ST has - # created for this connection, shove our CAs into it, tell ST to - # ignore everything else it knows, and then ask if it can build a - # chain. This is a buuuunch of code. - result = Security.SSLCopyPeerTrust(self.context, ctypes.byref(trust)) - _assert_no_error(result) - if not trust: - raise ssl.SSLError("Failed to copy trust reference") - - result = Security.SecTrustSetAnchorCertificates(trust, cert_array) - _assert_no_error(result) - - result = Security.SecTrustSetAnchorCertificatesOnly(trust, True) - _assert_no_error(result) - - trust_result = Security.SecTrustResultType() - result = Security.SecTrustEvaluate(trust, ctypes.byref(trust_result)) - _assert_no_error(result) - finally: - if trust: - CoreFoundation.CFRelease(trust) - - if cert_array is not None: - CoreFoundation.CFRelease(cert_array) - - return trust_result.value - - def handshake( - self, - server_hostname, - verify, - trust_bundle, - min_version, - max_version, - client_cert, - client_key, - client_key_passphrase, - alpn_protocols, - ): - """ - Actually performs the TLS handshake. This is run automatically by - wrapped socket, and shouldn't be needed in user code. - """ - # First, we do the initial bits of connection setup. We need to create - # a context, set its I/O funcs, and set the connection reference. - self.context = Security.SSLCreateContext( - None, SecurityConst.kSSLClientSide, SecurityConst.kSSLStreamType - ) - result = Security.SSLSetIOFuncs( - self.context, _read_callback_pointer, _write_callback_pointer - ) - _assert_no_error(result) - - # Here we need to compute the handle to use. We do this by taking the - # id of self modulo 2**31 - 1. If this is already in the dictionary, we - # just keep incrementing by one until we find a free space. - with _connection_ref_lock: - handle = id(self) % 2147483647 - while handle in _connection_refs: - handle = (handle + 1) % 2147483647 - _connection_refs[handle] = self - - result = Security.SSLSetConnection(self.context, handle) - _assert_no_error(result) - - # If we have a server hostname, we should set that too. - if server_hostname: - if not isinstance(server_hostname, bytes): - server_hostname = server_hostname.encode("utf-8") - - result = Security.SSLSetPeerDomainName( - self.context, server_hostname, len(server_hostname) - ) - _assert_no_error(result) - - # Setup the ciphers. - self._set_ciphers() - - # Setup the ALPN protocols. - self._set_alpn_protocols(alpn_protocols) - - # Set the minimum and maximum TLS versions. - result = Security.SSLSetProtocolVersionMin(self.context, min_version) - _assert_no_error(result) - - result = Security.SSLSetProtocolVersionMax(self.context, max_version) - _assert_no_error(result) - - # If there's a trust DB, we need to use it. We do that by telling - # SecureTransport to break on server auth. We also do that if we don't - # want to validate the certs at all: we just won't actually do any - # authing in that case. - if not verify or trust_bundle is not None: - result = Security.SSLSetSessionOption( - self.context, SecurityConst.kSSLSessionOptionBreakOnServerAuth, True - ) - _assert_no_error(result) - - # If there's a client cert, we need to use it. - if client_cert: - self._keychain, self._keychain_dir = _temporary_keychain() - self._client_cert_chain = _load_client_cert_chain( - self._keychain, client_cert, client_key - ) - result = Security.SSLSetCertificate(self.context, self._client_cert_chain) - _assert_no_error(result) - - while True: - with self._raise_on_error(): - result = Security.SSLHandshake(self.context) - - if result == SecurityConst.errSSLWouldBlock: - raise socket.timeout("handshake timed out") - elif result == SecurityConst.errSSLServerAuthCompleted: - self._custom_validate(verify, trust_bundle) - continue - else: - _assert_no_error(result) - break - - def fileno(self): - return self.socket.fileno() - - # Copy-pasted from Python 3.5 source code - def _decref_socketios(self): - if self._makefile_refs > 0: - self._makefile_refs -= 1 - if self._closed: - self.close() - - def recv(self, bufsiz): - buffer = ctypes.create_string_buffer(bufsiz) - bytes_read = self.recv_into(buffer, bufsiz) - data = buffer[:bytes_read] - return data - - def recv_into(self, buffer, nbytes=None): - # Read short on EOF. - if self._closed: - return 0 - - if nbytes is None: - nbytes = len(buffer) - - buffer = (ctypes.c_char * nbytes).from_buffer(buffer) - processed_bytes = ctypes.c_size_t(0) - - with self._raise_on_error(): - result = Security.SSLRead( - self.context, buffer, nbytes, ctypes.byref(processed_bytes) - ) - - # There are some result codes that we want to treat as "not always - # errors". Specifically, those are errSSLWouldBlock, - # errSSLClosedGraceful, and errSSLClosedNoNotify. - if result == SecurityConst.errSSLWouldBlock: - # If we didn't process any bytes, then this was just a time out. - # However, we can get errSSLWouldBlock in situations when we *did* - # read some data, and in those cases we should just read "short" - # and return. - if processed_bytes.value == 0: - # Timed out, no data read. - raise socket.timeout("recv timed out") - elif result in ( - SecurityConst.errSSLClosedGraceful, - SecurityConst.errSSLClosedNoNotify, - ): - # The remote peer has closed this connection. We should do so as - # well. Note that we don't actually return here because in - # principle this could actually be fired along with return data. - # It's unlikely though. - self.close() - else: - _assert_no_error(result) - - # Ok, we read and probably succeeded. We should return whatever data - # was actually read. - return processed_bytes.value - - def settimeout(self, timeout): - self._timeout = timeout - - def gettimeout(self): - return self._timeout - - def send(self, data): - processed_bytes = ctypes.c_size_t(0) - - with self._raise_on_error(): - result = Security.SSLWrite( - self.context, data, len(data), ctypes.byref(processed_bytes) - ) - - if result == SecurityConst.errSSLWouldBlock and processed_bytes.value == 0: - # Timed out - raise socket.timeout("send timed out") - else: - _assert_no_error(result) - - # We sent, and probably succeeded. Tell them how much we sent. - return processed_bytes.value - - def sendall(self, data): - total_sent = 0 - while total_sent < len(data): - sent = self.send(data[total_sent : total_sent + SSL_WRITE_BLOCKSIZE]) - total_sent += sent - - def shutdown(self): - with self._raise_on_error(): - Security.SSLClose(self.context) - - def close(self): - # TODO: should I do clean shutdown here? Do I have to? - if self._makefile_refs < 1: - self._closed = True - if self.context: - CoreFoundation.CFRelease(self.context) - self.context = None - if self._client_cert_chain: - CoreFoundation.CFRelease(self._client_cert_chain) - self._client_cert_chain = None - if self._keychain: - Security.SecKeychainDelete(self._keychain) - CoreFoundation.CFRelease(self._keychain) - shutil.rmtree(self._keychain_dir) - self._keychain = self._keychain_dir = None - return self.socket.close() - else: - self._makefile_refs -= 1 - - def getpeercert(self, binary_form=False): - # Urgh, annoying. - # - # Here's how we do this: - # - # 1. Call SSLCopyPeerTrust to get hold of the trust object for this - # connection. - # 2. Call SecTrustGetCertificateAtIndex for index 0 to get the leaf. - # 3. To get the CN, call SecCertificateCopyCommonName and process that - # string so that it's of the appropriate type. - # 4. To get the SAN, we need to do something a bit more complex: - # a. Call SecCertificateCopyValues to get the data, requesting - # kSecOIDSubjectAltName. - # b. Mess about with this dictionary to try to get the SANs out. - # - # This is gross. Really gross. It's going to be a few hundred LoC extra - # just to repeat something that SecureTransport can *already do*. So my - # operating assumption at this time is that what we want to do is - # instead to just flag to urllib3 that it shouldn't do its own hostname - # validation when using SecureTransport. - if not binary_form: - raise ValueError("SecureTransport only supports dumping binary certs") - trust = Security.SecTrustRef() - certdata = None - der_bytes = None - - try: - # Grab the trust store. - result = Security.SSLCopyPeerTrust(self.context, ctypes.byref(trust)) - _assert_no_error(result) - if not trust: - # Probably we haven't done the handshake yet. No biggie. - return None - - cert_count = Security.SecTrustGetCertificateCount(trust) - if not cert_count: - # Also a case that might happen if we haven't handshaked. - # Handshook? Handshaken? - return None - - leaf = Security.SecTrustGetCertificateAtIndex(trust, 0) - assert leaf - - # Ok, now we want the DER bytes. - certdata = Security.SecCertificateCopyData(leaf) - assert certdata - - data_length = CoreFoundation.CFDataGetLength(certdata) - data_buffer = CoreFoundation.CFDataGetBytePtr(certdata) - der_bytes = ctypes.string_at(data_buffer, data_length) - finally: - if certdata: - CoreFoundation.CFRelease(certdata) - if trust: - CoreFoundation.CFRelease(trust) - - return der_bytes - - def version(self): - protocol = Security.SSLProtocol() - result = Security.SSLGetNegotiatedProtocolVersion( - self.context, ctypes.byref(protocol) - ) - _assert_no_error(result) - if protocol.value == SecurityConst.kTLSProtocol13: - raise ssl.SSLError("SecureTransport does not support TLS 1.3") - elif protocol.value == SecurityConst.kTLSProtocol12: - return "TLSv1.2" - elif protocol.value == SecurityConst.kTLSProtocol11: - return "TLSv1.1" - elif protocol.value == SecurityConst.kTLSProtocol1: - return "TLSv1" - elif protocol.value == SecurityConst.kSSLProtocol3: - return "SSLv3" - elif protocol.value == SecurityConst.kSSLProtocol2: - return "SSLv2" - else: - raise ssl.SSLError("Unknown TLS version: %r" % protocol) - - def _reuse(self): - self._makefile_refs += 1 - - def _drop(self): - if self._makefile_refs < 1: - self.close() - else: - self._makefile_refs -= 1 - - -if _fileobject: # Platform-specific: Python 2 - - def makefile(self, mode, bufsize=-1): - self._makefile_refs += 1 - return _fileobject(self, mode, bufsize, close=True) - -else: # Platform-specific: Python 3 - - def makefile(self, mode="r", buffering=None, *args, **kwargs): - # We disable buffering with SecureTransport because it conflicts with - # the buffering that ST does internally (see issue #1153 for more). - buffering = 0 - return backport_makefile(self, mode, buffering, *args, **kwargs) - - -WrappedSocket.makefile = makefile - - -class SecureTransportContext(object): - """ - I am a wrapper class for the SecureTransport library, to translate the - interface of the standard library ``SSLContext`` object to calls into - SecureTransport. - """ - - def __init__(self, protocol): - self._min_version, self._max_version = _protocol_to_min_max[protocol] - self._options = 0 - self._verify = False - self._trust_bundle = None - self._client_cert = None - self._client_key = None - self._client_key_passphrase = None - self._alpn_protocols = None - - @property - def check_hostname(self): - """ - SecureTransport cannot have its hostname checking disabled. For more, - see the comment on getpeercert() in this file. - """ - return True - - @check_hostname.setter - def check_hostname(self, value): - """ - SecureTransport cannot have its hostname checking disabled. For more, - see the comment on getpeercert() in this file. - """ - pass - - @property - def options(self): - # TODO: Well, crap. - # - # So this is the bit of the code that is the most likely to cause us - # trouble. Essentially we need to enumerate all of the SSL options that - # users might want to use and try to see if we can sensibly translate - # them, or whether we should just ignore them. - return self._options - - @options.setter - def options(self, value): - # TODO: Update in line with above. - self._options = value - - @property - def verify_mode(self): - return ssl.CERT_REQUIRED if self._verify else ssl.CERT_NONE - - @verify_mode.setter - def verify_mode(self, value): - self._verify = True if value == ssl.CERT_REQUIRED else False - - def set_default_verify_paths(self): - # So, this has to do something a bit weird. Specifically, what it does - # is nothing. - # - # This means that, if we had previously had load_verify_locations - # called, this does not undo that. We need to do that because it turns - # out that the rest of the urllib3 code will attempt to load the - # default verify paths if it hasn't been told about any paths, even if - # the context itself was sometime earlier. We resolve that by just - # ignoring it. - pass - - def load_default_certs(self): - return self.set_default_verify_paths() - - def set_ciphers(self, ciphers): - # For now, we just require the default cipher string. - if ciphers != util.ssl_.DEFAULT_CIPHERS: - raise ValueError("SecureTransport doesn't support custom cipher strings") - - def load_verify_locations(self, cafile=None, capath=None, cadata=None): - # OK, we only really support cadata and cafile. - if capath is not None: - raise ValueError("SecureTransport does not support cert directories") - - # Raise if cafile does not exist. - if cafile is not None: - with open(cafile): - pass - - self._trust_bundle = cafile or cadata - - def load_cert_chain(self, certfile, keyfile=None, password=None): - self._client_cert = certfile - self._client_key = keyfile - self._client_cert_passphrase = password - - def set_alpn_protocols(self, protocols): - """ - Sets the ALPN protocols that will later be set on the context. - - Raises a NotImplementedError if ALPN is not supported. - """ - if not hasattr(Security, "SSLSetALPNProtocols"): - raise NotImplementedError( - "SecureTransport supports ALPN only in macOS 10.12+" - ) - self._alpn_protocols = [six.ensure_binary(p) for p in protocols] - - def wrap_socket( - self, - sock, - server_side=False, - do_handshake_on_connect=True, - suppress_ragged_eofs=True, - server_hostname=None, - ): - # So, what do we do here? Firstly, we assert some properties. This is a - # stripped down shim, so there is some functionality we don't support. - # See PEP 543 for the real deal. - assert not server_side - assert do_handshake_on_connect - assert suppress_ragged_eofs - - # Ok, we're good to go. Now we want to create the wrapped socket object - # and store it in the appropriate place. - wrapped_socket = WrappedSocket(sock) - - # Now we can handshake - wrapped_socket.handshake( - server_hostname, - self._verify, - self._trust_bundle, - self._min_version, - self._max_version, - self._client_cert, - self._client_key, - self._client_key_passphrase, - self._alpn_protocols, - ) - return wrapped_socket diff --git a/newrelic/packages/urllib3/contrib/socks.py b/newrelic/packages/urllib3/contrib/socks.py index c326e80dd1..e3239b569d 100644 --- a/newrelic/packages/urllib3/contrib/socks.py +++ b/newrelic/packages/urllib3/contrib/socks.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- """ This module contains provisional support for SOCKS proxies from within urllib3. This module supports SOCKS4, SOCKS4A (an extension of SOCKS4), and @@ -38,10 +37,11 @@ proxy_url="socks5h://:@proxy-host" """ -from __future__ import absolute_import + +from __future__ import annotations try: - import socks + import socks # type: ignore[import-untyped] except ImportError: import warnings @@ -51,13 +51,13 @@ ( "SOCKS support in urllib3 requires the installation of optional " "dependencies: specifically, PySocks. For more information, see " - "https://urllib3.readthedocs.io/en/1.26.x/contrib.html#socks-proxies" + "https://urllib3.readthedocs.io/en/latest/advanced-usage.html#socks-proxies" ), DependencyWarning, ) raise -from socket import error as SocketError +import typing from socket import timeout as SocketTimeout from ..connection import HTTPConnection, HTTPSConnection @@ -69,7 +69,16 @@ try: import ssl except ImportError: - ssl = None + ssl = None # type: ignore[assignment] + + +class _TYPE_SOCKS_OPTIONS(typing.TypedDict): + socks_version: int + proxy_host: str | None + proxy_port: str | None + username: str | None + password: str | None + rdns: bool class SOCKSConnection(HTTPConnection): @@ -77,15 +86,20 @@ class SOCKSConnection(HTTPConnection): A plain-text HTTP connection that connects via a SOCKS proxy. """ - def __init__(self, *args, **kwargs): - self._socks_options = kwargs.pop("_socks_options") - super(SOCKSConnection, self).__init__(*args, **kwargs) - - def _new_conn(self): + def __init__( + self, + _socks_options: _TYPE_SOCKS_OPTIONS, + *args: typing.Any, + **kwargs: typing.Any, + ) -> None: + self._socks_options = _socks_options + super().__init__(*args, **kwargs) + + def _new_conn(self) -> socks.socksocket: """ Establish a new connection via the SOCKS proxy. """ - extra_kw = {} + extra_kw: dict[str, typing.Any] = {} if self.source_address: extra_kw["source_address"] = self.source_address @@ -102,15 +116,14 @@ def _new_conn(self): proxy_password=self._socks_options["password"], proxy_rdns=self._socks_options["rdns"], timeout=self.timeout, - **extra_kw + **extra_kw, ) - except SocketTimeout: + except SocketTimeout as e: raise ConnectTimeoutError( self, - "Connection to %s timed out. (connect timeout=%s)" - % (self.host, self.timeout), - ) + f"Connection to {self.host} timed out. (connect timeout={self.timeout})", + ) from e except socks.ProxyError as e: # This is fragile as hell, but it seems to be the only way to raise @@ -120,22 +133,23 @@ def _new_conn(self): if isinstance(error, SocketTimeout): raise ConnectTimeoutError( self, - "Connection to %s timed out. (connect timeout=%s)" - % (self.host, self.timeout), - ) + f"Connection to {self.host} timed out. (connect timeout={self.timeout})", + ) from e else: + # Adding `from e` messes with coverage somehow, so it's omitted. + # See #2386. raise NewConnectionError( - self, "Failed to establish a new connection: %s" % error + self, f"Failed to establish a new connection: {error}" ) else: raise NewConnectionError( - self, "Failed to establish a new connection: %s" % e - ) + self, f"Failed to establish a new connection: {e}" + ) from e - except SocketError as e: # Defensive: PySocks should catch all these. + except OSError as e: # Defensive: PySocks should catch all these. raise NewConnectionError( - self, "Failed to establish a new connection: %s" % e - ) + self, f"Failed to establish a new connection: {e}" + ) from e return conn @@ -169,12 +183,12 @@ class SOCKSProxyManager(PoolManager): def __init__( self, - proxy_url, - username=None, - password=None, - num_pools=10, - headers=None, - **connection_pool_kw + proxy_url: str, + username: str | None = None, + password: str | None = None, + num_pools: int = 10, + headers: typing.Mapping[str, str] | None = None, + **connection_pool_kw: typing.Any, ): parsed = parse_url(proxy_url) @@ -195,7 +209,7 @@ def __init__( socks_version = socks.PROXY_TYPE_SOCKS4 rdns = True else: - raise ValueError("Unable to determine SOCKS version from %s" % proxy_url) + raise ValueError(f"Unable to determine SOCKS version from {proxy_url}") self.proxy_url = proxy_url @@ -209,8 +223,6 @@ def __init__( } connection_pool_kw["_socks_options"] = socks_options - super(SOCKSProxyManager, self).__init__( - num_pools, headers, **connection_pool_kw - ) + super().__init__(num_pools, headers, **connection_pool_kw) self.pool_classes_by_scheme = SOCKSProxyManager.pool_classes_by_scheme diff --git a/newrelic/packages/urllib3/exceptions.py b/newrelic/packages/urllib3/exceptions.py index cba6f3f560..58723faeb0 100644 --- a/newrelic/packages/urllib3/exceptions.py +++ b/newrelic/packages/urllib3/exceptions.py @@ -1,6 +1,16 @@ -from __future__ import absolute_import +from __future__ import annotations -from .packages.six.moves.http_client import IncompleteRead as httplib_IncompleteRead +import socket +import typing +import warnings +from email.errors import MessageDefect +from http.client import IncompleteRead as httplib_IncompleteRead + +if typing.TYPE_CHECKING: + from .connection import HTTPConnection + from .connectionpool import ConnectionPool + from .response import HTTPResponse + from .util.retry import Retry # Base Exceptions @@ -8,64 +18,61 @@ class HTTPError(Exception): """Base exception used by this module.""" - pass - class HTTPWarning(Warning): """Base warning used by this module.""" - pass + +_TYPE_REDUCE_RESULT = tuple[typing.Callable[..., object], tuple[object, ...]] class PoolError(HTTPError): """Base exception for errors caused within a pool.""" - def __init__(self, pool, message): + def __init__(self, pool: ConnectionPool, message: str) -> None: self.pool = pool - HTTPError.__init__(self, "%s: %s" % (pool, message)) + self._message = message + super().__init__(f"{pool}: {message}") - def __reduce__(self): + def __reduce__(self) -> _TYPE_REDUCE_RESULT: # For pickling purposes. - return self.__class__, (None, None) + return self.__class__, (None, self._message) class RequestError(PoolError): """Base exception for PoolErrors that have associated URLs.""" - def __init__(self, pool, url, message): + def __init__(self, pool: ConnectionPool, url: str | None, message: str) -> None: self.url = url - PoolError.__init__(self, pool, message) + super().__init__(pool, message) - def __reduce__(self): + def __reduce__(self) -> _TYPE_REDUCE_RESULT: # For pickling purposes. - return self.__class__, (None, self.url, None) + return self.__class__, (None, self.url, self._message) class SSLError(HTTPError): """Raised when SSL certificate fails in an HTTPS connection.""" - pass - class ProxyError(HTTPError): """Raised when the connection to a proxy fails.""" - def __init__(self, message, error, *args): - super(ProxyError, self).__init__(message, error, *args) + # The original error is also available as __cause__. + original_error: Exception + + def __init__(self, message: str, error: Exception) -> None: + super().__init__(message, error) self.original_error = error class DecodeError(HTTPError): """Raised when automatic decoding based on Content-Type fails.""" - pass - class ProtocolError(HTTPError): """Raised when something unexpected happens mid-request/response.""" - pass - #: Renamed to ProtocolError but aliased for backwards compatibility. ConnectionError = ProtocolError @@ -79,33 +86,40 @@ class MaxRetryError(RequestError): :param pool: The connection pool :type pool: :class:`~urllib3.connectionpool.HTTPConnectionPool` - :param string url: The requested Url - :param exceptions.Exception reason: The underlying error + :param str url: The requested Url + :param reason: The underlying error + :type reason: :class:`Exception` """ - def __init__(self, pool, url, reason=None): + def __init__( + self, pool: ConnectionPool, url: str | None, reason: Exception | None = None + ) -> None: self.reason = reason - message = "Max retries exceeded with url: %s (Caused by %r)" % (url, reason) + message = f"Max retries exceeded with url: {url} (Caused by {reason!r})" + + super().__init__(pool, url, message) - RequestError.__init__(self, pool, url, message) + def __reduce__(self) -> _TYPE_REDUCE_RESULT: + # For pickling purposes. + return self.__class__, (None, self.url, self.reason) class HostChangedError(RequestError): """Raised when an existing pool gets a request for a foreign host.""" - def __init__(self, pool, url, retries=3): - message = "Tried to open a foreign host with url: %s" % url - RequestError.__init__(self, pool, url, message) + def __init__( + self, pool: ConnectionPool, url: str, retries: Retry | int = 3 + ) -> None: + message = f"Tried to open a foreign host with url: {url}" + super().__init__(pool, url, message) self.retries = retries class TimeoutStateError(HTTPError): """Raised when passing an invalid state to a timeout""" - pass - class TimeoutError(HTTPError): """Raised when a socket timeout error occurs. @@ -114,53 +128,77 @@ class TimeoutError(HTTPError): ` and :exc:`ConnectTimeoutErrors `. """ - pass - class ReadTimeoutError(TimeoutError, RequestError): """Raised when a socket timeout occurs while receiving data from a server""" - pass - # This timeout error does not have a URL attached and needs to inherit from the # base HTTPError class ConnectTimeoutError(TimeoutError): """Raised when a socket timeout occurs while connecting to a server""" - pass - -class NewConnectionError(ConnectTimeoutError, PoolError): +class NewConnectionError(ConnectTimeoutError, HTTPError): """Raised when we fail to establish a new connection. Usually ECONNREFUSED.""" - pass + def __init__(self, conn: HTTPConnection, message: str) -> None: + self.conn = conn + self._message = message + super().__init__(f"{conn}: {message}") + + def __reduce__(self) -> _TYPE_REDUCE_RESULT: + # For pickling purposes. + return self.__class__, (None, self._message) + + @property + def pool(self) -> HTTPConnection: + warnings.warn( + "The 'pool' property is deprecated and will be removed " + "in urllib3 v2.1.0. Use 'conn' instead.", + DeprecationWarning, + stacklevel=2, + ) + + return self.conn + + +class NameResolutionError(NewConnectionError): + """Raised when host name resolution fails.""" + + def __init__(self, host: str, conn: HTTPConnection, reason: socket.gaierror): + message = f"Failed to resolve '{host}' ({reason})" + self._host = host + self._reason = reason + super().__init__(conn, message) + + def __reduce__(self) -> _TYPE_REDUCE_RESULT: + # For pickling purposes. + return self.__class__, (self._host, None, self._reason) class EmptyPoolError(PoolError): """Raised when a pool runs out of connections and no more are allowed.""" - pass + +class FullPoolError(PoolError): + """Raised when we try to add a connection to a full pool in blocking mode.""" class ClosedPoolError(PoolError): """Raised when a request enters a pool after the pool has been closed.""" - pass - class LocationValueError(ValueError, HTTPError): """Raised when there is something wrong with a given URL input.""" - pass - class LocationParseError(LocationValueError): """Raised when get_host or similar fails to parse the URL input.""" - def __init__(self, location): - message = "Failed to parse: %s" % location - HTTPError.__init__(self, message) + def __init__(self, location: str) -> None: + message = f"Failed to parse: {location}" + super().__init__(message) self.location = location @@ -168,9 +206,9 @@ def __init__(self, location): class URLSchemeUnknown(LocationValueError): """Raised when a URL input has an unsupported scheme.""" - def __init__(self, scheme): - message = "Not supported URL scheme %s" % scheme - super(URLSchemeUnknown, self).__init__(message) + def __init__(self, scheme: str): + message = f"Not supported URL scheme {scheme}" + super().__init__(message) self.scheme = scheme @@ -185,38 +223,22 @@ class ResponseError(HTTPError): class SecurityWarning(HTTPWarning): """Warned when performing security reducing actions""" - pass - - -class SubjectAltNameWarning(SecurityWarning): - """Warned when connecting to a host with a certificate missing a SAN.""" - - pass - class InsecureRequestWarning(SecurityWarning): """Warned when making an unverified HTTPS request.""" - pass + +class NotOpenSSLWarning(SecurityWarning): + """Warned when using unsupported SSL library""" class SystemTimeWarning(SecurityWarning): """Warned when system time is suspected to be wrong""" - pass - class InsecurePlatformWarning(SecurityWarning): """Warned when certain TLS/SSL configuration is not available on a platform.""" - pass - - -class SNIMissingWarning(HTTPWarning): - """Warned when making a HTTPS request without SNI available.""" - - pass - class DependencyWarning(HTTPWarning): """ @@ -224,14 +246,10 @@ class DependencyWarning(HTTPWarning): dependencies. """ - pass - class ResponseNotChunked(ProtocolError, ValueError): """Response needs to be chunked in order to read it as chunks.""" - pass - class BodyNotHttplibCompatible(HTTPError): """ @@ -239,8 +257,6 @@ class BodyNotHttplibCompatible(HTTPError): (have an fp attribute which returns raw chunks) for read_chunked(). """ - pass - class IncompleteRead(HTTPError, httplib_IncompleteRead): """ @@ -250,10 +266,14 @@ class IncompleteRead(HTTPError, httplib_IncompleteRead): for ``partial`` to avoid creating large objects on streamed reads. """ - def __init__(self, partial, expected): - super(IncompleteRead, self).__init__(partial, expected) + partial: int # type: ignore[assignment] + expected: int - def __repr__(self): + def __init__(self, partial: int, expected: int) -> None: + self.partial = partial + self.expected = expected + + def __repr__(self) -> str: return "IncompleteRead(%i bytes read, %i more expected)" % ( self.partial, self.expected, @@ -263,14 +283,13 @@ def __repr__(self): class InvalidChunkLength(HTTPError, httplib_IncompleteRead): """Invalid chunk length in a chunked response.""" - def __init__(self, response, length): - super(InvalidChunkLength, self).__init__( - response.tell(), response.length_remaining - ) + def __init__(self, response: HTTPResponse, length: bytes) -> None: + self.partial: int = response.tell() # type: ignore[assignment] + self.expected: int | None = response.length_remaining self.response = response self.length = length - def __repr__(self): + def __repr__(self) -> str: return "InvalidChunkLength(got length %r, %i bytes read)" % ( self.length, self.partial, @@ -280,15 +299,13 @@ def __repr__(self): class InvalidHeader(HTTPError): """The header provided was somehow invalid.""" - pass - class ProxySchemeUnknown(AssertionError, URLSchemeUnknown): """ProxyManager does not support the supplied scheme""" # TODO(t-8ch): Stop inheriting from AssertionError in v2.0. - def __init__(self, scheme): + def __init__(self, scheme: str | None) -> None: # 'localhost' is here because our URL parser parses # localhost:8080 -> scheme=localhost, remove if we fix this. if scheme == "localhost": @@ -296,28 +313,23 @@ def __init__(self, scheme): if scheme is None: message = "Proxy URL had no scheme, should start with http:// or https://" else: - message = ( - "Proxy URL had unsupported scheme %s, should use http:// or https://" - % scheme - ) - super(ProxySchemeUnknown, self).__init__(message) + message = f"Proxy URL had unsupported scheme {scheme}, should use http:// or https://" + super().__init__(message) class ProxySchemeUnsupported(ValueError): """Fetching HTTPS resources through HTTPS proxies is unsupported""" - pass - class HeaderParsingError(HTTPError): """Raised by assert_header_parsing, but we convert it to a log.warning statement.""" - def __init__(self, defects, unparsed_data): - message = "%s, unparsed data: %r" % (defects or "Unknown", unparsed_data) - super(HeaderParsingError, self).__init__(message) + def __init__( + self, defects: list[MessageDefect], unparsed_data: bytes | str | None + ) -> None: + message = f"{defects or 'Unknown'}, unparsed data: {unparsed_data!r}" + super().__init__(message) class UnrewindableBodyError(HTTPError): """urllib3 encountered an error when trying to rewind a body""" - - pass diff --git a/newrelic/packages/urllib3/fields.py b/newrelic/packages/urllib3/fields.py index 9d630f491d..97c4730cff 100644 --- a/newrelic/packages/urllib3/fields.py +++ b/newrelic/packages/urllib3/fields.py @@ -1,13 +1,20 @@ -from __future__ import absolute_import +from __future__ import annotations import email.utils import mimetypes -import re +import typing -from .packages import six +_TYPE_FIELD_VALUE = typing.Union[str, bytes] +_TYPE_FIELD_VALUE_TUPLE = typing.Union[ + _TYPE_FIELD_VALUE, + tuple[str, _TYPE_FIELD_VALUE], + tuple[str, _TYPE_FIELD_VALUE, str], +] -def guess_content_type(filename, default="application/octet-stream"): +def guess_content_type( + filename: str | None, default: str = "application/octet-stream" +) -> str: """ Guess the "Content-Type" of a file. @@ -21,7 +28,7 @@ def guess_content_type(filename, default="application/octet-stream"): return default -def format_header_param_rfc2231(name, value): +def format_header_param_rfc2231(name: str, value: _TYPE_FIELD_VALUE) -> str: """ Helper function to format and quote a single header parameter using the strategy defined in RFC 2231. @@ -34,14 +41,28 @@ def format_header_param_rfc2231(name, value): The name of the parameter, a string expected to be ASCII only. :param value: The value of the parameter, provided as ``bytes`` or `str``. - :ret: + :returns: An RFC-2231-formatted unicode string. + + .. deprecated:: 2.0.0 + Will be removed in urllib3 v2.1.0. This is not valid for + ``multipart/form-data`` header parameters. """ - if isinstance(value, six.binary_type): + import warnings + + warnings.warn( + "'format_header_param_rfc2231' is deprecated and will be " + "removed in urllib3 v2.1.0. This is not valid for " + "multipart/form-data header parameters.", + DeprecationWarning, + stacklevel=2, + ) + + if isinstance(value, bytes): value = value.decode("utf-8") if not any(ch in value for ch in '"\\\r\n'): - result = u'%s="%s"' % (name, value) + result = f'{name}="{value}"' try: result.encode("ascii") except (UnicodeEncodeError, UnicodeDecodeError): @@ -49,81 +70,87 @@ def format_header_param_rfc2231(name, value): else: return result - if six.PY2: # Python 2: - value = value.encode("utf-8") - - # encode_rfc2231 accepts an encoded string and returns an ascii-encoded - # string in Python 2 but accepts and returns unicode strings in Python 3 value = email.utils.encode_rfc2231(value, "utf-8") - value = "%s*=%s" % (name, value) - - if six.PY2: # Python 2: - value = value.decode("utf-8") + value = f"{name}*={value}" return value -_HTML5_REPLACEMENTS = { - u"\u0022": u"%22", - # Replace "\" with "\\". - u"\u005C": u"\u005C\u005C", -} - -# All control characters from 0x00 to 0x1F *except* 0x1B. -_HTML5_REPLACEMENTS.update( - { - six.unichr(cc): u"%{:02X}".format(cc) - for cc in range(0x00, 0x1F + 1) - if cc not in (0x1B,) - } -) - - -def _replace_multiple(value, needles_and_replacements): - def replacer(match): - return needles_and_replacements[match.group(0)] - - pattern = re.compile( - r"|".join([re.escape(needle) for needle in needles_and_replacements.keys()]) - ) - - result = pattern.sub(replacer, value) - - return result - - -def format_header_param_html5(name, value): +def format_multipart_header_param(name: str, value: _TYPE_FIELD_VALUE) -> str: """ - Helper function to format and quote a single header parameter using the - HTML5 strategy. + Format and quote a single multipart header parameter. - Particularly useful for header parameters which might contain - non-ASCII values, like file names. This follows the `HTML5 Working Draft - Section 4.10.22.7`_ and matches the behavior of curl and modern browsers. + This follows the `WHATWG HTML Standard`_ as of 2021/06/10, matching + the behavior of current browser and curl versions. Values are + assumed to be UTF-8. The ``\\n``, ``\\r``, and ``"`` characters are + percent encoded. - .. _HTML5 Working Draft Section 4.10.22.7: - https://w3c.github.io/html/sec-forms.html#multipart-form-data + .. _WHATWG HTML Standard: + https://html.spec.whatwg.org/multipage/ + form-control-infrastructure.html#multipart-form-data :param name: - The name of the parameter, a string expected to be ASCII only. + The name of the parameter, an ASCII-only ``str``. :param value: - The value of the parameter, provided as ``bytes`` or `str``. - :ret: - A unicode string, stripped of troublesome characters. + The value of the parameter, a ``str`` or UTF-8 encoded + ``bytes``. + :returns: + A string ``name="value"`` with the escaped value. + + .. versionchanged:: 2.0.0 + Matches the WHATWG HTML Standard as of 2021/06/10. Control + characters are no longer percent encoded. + + .. versionchanged:: 2.0.0 + Renamed from ``format_header_param_html5`` and + ``format_header_param``. The old names will be removed in + urllib3 v2.1.0. """ - if isinstance(value, six.binary_type): + if isinstance(value, bytes): value = value.decode("utf-8") - value = _replace_multiple(value, _HTML5_REPLACEMENTS) + # percent encode \n \r " + value = value.translate({10: "%0A", 13: "%0D", 34: "%22"}) + return f'{name}="{value}"' - return u'%s="%s"' % (name, value) + +def format_header_param_html5(name: str, value: _TYPE_FIELD_VALUE) -> str: + """ + .. deprecated:: 2.0.0 + Renamed to :func:`format_multipart_header_param`. Will be + removed in urllib3 v2.1.0. + """ + import warnings + + warnings.warn( + "'format_header_param_html5' has been renamed to " + "'format_multipart_header_param'. The old name will be " + "removed in urllib3 v2.1.0.", + DeprecationWarning, + stacklevel=2, + ) + return format_multipart_header_param(name, value) -# For backwards-compatibility. -format_header_param = format_header_param_html5 +def format_header_param(name: str, value: _TYPE_FIELD_VALUE) -> str: + """ + .. deprecated:: 2.0.0 + Renamed to :func:`format_multipart_header_param`. Will be + removed in urllib3 v2.1.0. + """ + import warnings + + warnings.warn( + "'format_header_param' has been renamed to " + "'format_multipart_header_param'. The old name will be " + "removed in urllib3 v2.1.0.", + DeprecationWarning, + stacklevel=2, + ) + return format_multipart_header_param(name, value) -class RequestField(object): +class RequestField: """ A data container for request body parameters. @@ -135,29 +162,47 @@ class RequestField(object): An optional filename of the request field. Must be unicode. :param headers: An optional dict-like object of headers to initially use for the field. - :param header_formatter: - An optional callable that is used to encode and format the headers. By - default, this is :func:`format_header_param_html5`. + + .. versionchanged:: 2.0.0 + The ``header_formatter`` parameter is deprecated and will + be removed in urllib3 v2.1.0. """ def __init__( self, - name, - data, - filename=None, - headers=None, - header_formatter=format_header_param_html5, + name: str, + data: _TYPE_FIELD_VALUE, + filename: str | None = None, + headers: typing.Mapping[str, str] | None = None, + header_formatter: typing.Callable[[str, _TYPE_FIELD_VALUE], str] | None = None, ): self._name = name self._filename = filename self.data = data - self.headers = {} + self.headers: dict[str, str | None] = {} if headers: self.headers = dict(headers) - self.header_formatter = header_formatter + + if header_formatter is not None: + import warnings + + warnings.warn( + "The 'header_formatter' parameter is deprecated and " + "will be removed in urllib3 v2.1.0.", + DeprecationWarning, + stacklevel=2, + ) + self.header_formatter = header_formatter + else: + self.header_formatter = format_multipart_header_param @classmethod - def from_tuples(cls, fieldname, value, header_formatter=format_header_param_html5): + def from_tuples( + cls, + fieldname: str, + value: _TYPE_FIELD_VALUE_TUPLE, + header_formatter: typing.Callable[[str, _TYPE_FIELD_VALUE], str] | None = None, + ) -> RequestField: """ A :class:`~urllib3.fields.RequestField` factory from old-style tuple parameters. @@ -174,6 +219,10 @@ def from_tuples(cls, fieldname, value, header_formatter=format_header_param_html Field names and filenames must be unicode. """ + filename: str | None + content_type: str | None + data: _TYPE_FIELD_VALUE + if isinstance(value, tuple): if len(value) == 3: filename, data, content_type = value @@ -192,20 +241,29 @@ def from_tuples(cls, fieldname, value, header_formatter=format_header_param_html return request_param - def _render_part(self, name, value): + def _render_part(self, name: str, value: _TYPE_FIELD_VALUE) -> str: """ - Overridable helper function to format a single header parameter. By - default, this calls ``self.header_formatter``. + Override this method to change how each multipart header + parameter is formatted. By default, this calls + :func:`format_multipart_header_param`. :param name: - The name of the parameter, a string expected to be ASCII only. + The name of the parameter, an ASCII-only ``str``. :param value: - The value of the parameter, provided as a unicode string. - """ + The value of the parameter, a ``str`` or UTF-8 encoded + ``bytes``. + :meta public: + """ return self.header_formatter(name, value) - def _render_parts(self, header_parts): + def _render_parts( + self, + header_parts: ( + dict[str, _TYPE_FIELD_VALUE | None] + | typing.Sequence[tuple[str, _TYPE_FIELD_VALUE | None]] + ), + ) -> str: """ Helper function to format and quote a single header. @@ -216,18 +274,21 @@ def _render_parts(self, header_parts): A sequence of (k, v) tuples or a :class:`dict` of (k, v) to format as `k1="v1"; k2="v2"; ...`. """ + iterable: typing.Iterable[tuple[str, _TYPE_FIELD_VALUE | None]] + parts = [] - iterable = header_parts if isinstance(header_parts, dict): iterable = header_parts.items() + else: + iterable = header_parts for name, value in iterable: if value is not None: parts.append(self._render_part(name, value)) - return u"; ".join(parts) + return "; ".join(parts) - def render_headers(self): + def render_headers(self) -> str: """ Renders the headers for this request field. """ @@ -236,39 +297,45 @@ def render_headers(self): sort_keys = ["Content-Disposition", "Content-Type", "Content-Location"] for sort_key in sort_keys: if self.headers.get(sort_key, False): - lines.append(u"%s: %s" % (sort_key, self.headers[sort_key])) + lines.append(f"{sort_key}: {self.headers[sort_key]}") for header_name, header_value in self.headers.items(): if header_name not in sort_keys: if header_value: - lines.append(u"%s: %s" % (header_name, header_value)) + lines.append(f"{header_name}: {header_value}") - lines.append(u"\r\n") - return u"\r\n".join(lines) + lines.append("\r\n") + return "\r\n".join(lines) def make_multipart( - self, content_disposition=None, content_type=None, content_location=None - ): + self, + content_disposition: str | None = None, + content_type: str | None = None, + content_location: str | None = None, + ) -> None: """ Makes this request field into a multipart request field. This method overrides "Content-Disposition", "Content-Type" and "Content-Location" headers to the request parameter. + :param content_disposition: + The 'Content-Disposition' of the request body. Defaults to 'form-data' :param content_type: The 'Content-Type' of the request body. :param content_location: The 'Content-Location' of the request body. """ - self.headers["Content-Disposition"] = content_disposition or u"form-data" - self.headers["Content-Disposition"] += u"; ".join( + content_disposition = (content_disposition or "form-data") + "; ".join( [ - u"", + "", self._render_parts( - ((u"name", self._name), (u"filename", self._filename)) + (("name", self._name), ("filename", self._filename)) ), ] ) + + self.headers["Content-Disposition"] = content_disposition self.headers["Content-Type"] = content_type self.headers["Content-Location"] = content_location diff --git a/newrelic/packages/urllib3/filepost.py b/newrelic/packages/urllib3/filepost.py index 36c9252c64..14f70b05b4 100644 --- a/newrelic/packages/urllib3/filepost.py +++ b/newrelic/packages/urllib3/filepost.py @@ -1,28 +1,32 @@ -from __future__ import absolute_import +from __future__ import annotations import binascii import codecs import os +import typing from io import BytesIO -from .fields import RequestField -from .packages import six -from .packages.six import b +from .fields import _TYPE_FIELD_VALUE_TUPLE, RequestField writer = codecs.lookup("utf-8")[3] +_TYPE_FIELDS_SEQUENCE = typing.Sequence[ + typing.Union[tuple[str, _TYPE_FIELD_VALUE_TUPLE], RequestField] +] +_TYPE_FIELDS = typing.Union[ + _TYPE_FIELDS_SEQUENCE, + typing.Mapping[str, _TYPE_FIELD_VALUE_TUPLE], +] -def choose_boundary(): + +def choose_boundary() -> str: """ Our embarrassingly-simple replacement for mimetools.choose_boundary. """ - boundary = binascii.hexlify(os.urandom(16)) - if not six.PY2: - boundary = boundary.decode("ascii") - return boundary + return binascii.hexlify(os.urandom(16)).decode() -def iter_field_objects(fields): +def iter_field_objects(fields: _TYPE_FIELDS) -> typing.Iterable[RequestField]: """ Iterate over fields. @@ -30,42 +34,29 @@ def iter_field_objects(fields): :class:`~urllib3.fields.RequestField`. """ - if isinstance(fields, dict): - i = six.iteritems(fields) + iterable: typing.Iterable[RequestField | tuple[str, _TYPE_FIELD_VALUE_TUPLE]] + + if isinstance(fields, typing.Mapping): + iterable = fields.items() else: - i = iter(fields) + iterable = fields - for field in i: + for field in iterable: if isinstance(field, RequestField): yield field else: yield RequestField.from_tuples(*field) -def iter_fields(fields): - """ - .. deprecated:: 1.6 - - Iterate over fields. - - The addition of :class:`~urllib3.fields.RequestField` makes this function - obsolete. Instead, use :func:`iter_field_objects`, which returns - :class:`~urllib3.fields.RequestField` objects. - - Supports list of (k, v) tuples and dicts. - """ - if isinstance(fields, dict): - return ((k, v) for k, v in six.iteritems(fields)) - - return ((k, v) for k, v in fields) - - -def encode_multipart_formdata(fields, boundary=None): +def encode_multipart_formdata( + fields: _TYPE_FIELDS, boundary: str | None = None +) -> tuple[bytes, str]: """ Encode a dictionary of ``fields`` using the multipart/form-data MIME format. :param fields: Dictionary of fields or list of (key, :class:`~urllib3.fields.RequestField`). + Values are processed by :func:`urllib3.fields.RequestField.from_tuples`. :param boundary: If not specified, then a random boundary will be generated using @@ -76,7 +67,7 @@ def encode_multipart_formdata(fields, boundary=None): boundary = choose_boundary() for field in iter_field_objects(fields): - body.write(b("--%s\r\n" % (boundary))) + body.write(f"--{boundary}\r\n".encode("latin-1")) writer(body).write(field.render_headers()) data = field.data @@ -84,15 +75,15 @@ def encode_multipart_formdata(fields, boundary=None): if isinstance(data, int): data = str(data) # Backwards compatibility - if isinstance(data, six.text_type): + if isinstance(data, str): writer(body).write(data) else: body.write(data) body.write(b"\r\n") - body.write(b("--%s--\r\n" % (boundary))) + body.write(f"--{boundary}--\r\n".encode("latin-1")) - content_type = str("multipart/form-data; boundary=%s" % boundary) + content_type = f"multipart/form-data; boundary={boundary}" return body.getvalue(), content_type diff --git a/newrelic/packages/urllib3/http2/__init__.py b/newrelic/packages/urllib3/http2/__init__.py new file mode 100644 index 0000000000..133e1d8f23 --- /dev/null +++ b/newrelic/packages/urllib3/http2/__init__.py @@ -0,0 +1,53 @@ +from __future__ import annotations + +from importlib.metadata import version + +__all__ = [ + "inject_into_urllib3", + "extract_from_urllib3", +] + +import typing + +orig_HTTPSConnection: typing.Any = None + + +def inject_into_urllib3() -> None: + # First check if h2 version is valid + h2_version = version("h2") + if not h2_version.startswith("4."): + raise ImportError( + "urllib3 v2 supports h2 version 4.x.x, currently " + f"the 'h2' module is compiled with {h2_version!r}. " + "See: https://github.com/urllib3/urllib3/issues/3290" + ) + + # Import here to avoid circular dependencies. + from .. import connection as urllib3_connection + from .. import util as urllib3_util + from ..connectionpool import HTTPSConnectionPool + from ..util import ssl_ as urllib3_util_ssl + from .connection import HTTP2Connection + + global orig_HTTPSConnection + orig_HTTPSConnection = urllib3_connection.HTTPSConnection + + HTTPSConnectionPool.ConnectionCls = HTTP2Connection + urllib3_connection.HTTPSConnection = HTTP2Connection # type: ignore[misc] + + # TODO: Offer 'http/1.1' as well, but for testing purposes this is handy. + urllib3_util.ALPN_PROTOCOLS = ["h2"] + urllib3_util_ssl.ALPN_PROTOCOLS = ["h2"] + + +def extract_from_urllib3() -> None: + from .. import connection as urllib3_connection + from .. import util as urllib3_util + from ..connectionpool import HTTPSConnectionPool + from ..util import ssl_ as urllib3_util_ssl + + HTTPSConnectionPool.ConnectionCls = orig_HTTPSConnection + urllib3_connection.HTTPSConnection = orig_HTTPSConnection # type: ignore[misc] + + urllib3_util.ALPN_PROTOCOLS = ["http/1.1"] + urllib3_util_ssl.ALPN_PROTOCOLS = ["http/1.1"] diff --git a/newrelic/packages/urllib3/http2/connection.py b/newrelic/packages/urllib3/http2/connection.py new file mode 100644 index 0000000000..0a026da0a8 --- /dev/null +++ b/newrelic/packages/urllib3/http2/connection.py @@ -0,0 +1,356 @@ +from __future__ import annotations + +import logging +import re +import threading +import types +import typing + +import h2.config +import h2.connection +import h2.events + +from .._base_connection import _TYPE_BODY +from .._collections import HTTPHeaderDict +from ..connection import HTTPSConnection, _get_default_user_agent +from ..exceptions import ConnectionError +from ..response import BaseHTTPResponse + +orig_HTTPSConnection = HTTPSConnection + +T = typing.TypeVar("T") + +log = logging.getLogger(__name__) + +RE_IS_LEGAL_HEADER_NAME = re.compile(rb"^[!#$%&'*+\-.^_`|~0-9a-z]+$") +RE_IS_ILLEGAL_HEADER_VALUE = re.compile(rb"[\0\x00\x0a\x0d\r\n]|^[ \r\n\t]|[ \r\n\t]$") + + +def _is_legal_header_name(name: bytes) -> bool: + """ + "An implementation that validates fields according to the definitions in Sections + 5.1 and 5.5 of [HTTP] only needs an additional check that field names do not + include uppercase characters." (https://httpwg.org/specs/rfc9113.html#n-field-validity) + + `http.client._is_legal_header_name` does not validate the field name according to the + HTTP 1.1 spec, so we do that here, in addition to checking for uppercase characters. + + This does not allow for the `:` character in the header name, so should not + be used to validate pseudo-headers. + """ + return bool(RE_IS_LEGAL_HEADER_NAME.match(name)) + + +def _is_illegal_header_value(value: bytes) -> bool: + """ + "A field value MUST NOT contain the zero value (ASCII NUL, 0x00), line feed + (ASCII LF, 0x0a), or carriage return (ASCII CR, 0x0d) at any position. A field + value MUST NOT start or end with an ASCII whitespace character (ASCII SP or HTAB, + 0x20 or 0x09)." (https://httpwg.org/specs/rfc9113.html#n-field-validity) + """ + return bool(RE_IS_ILLEGAL_HEADER_VALUE.search(value)) + + +class _LockedObject(typing.Generic[T]): + """ + A wrapper class that hides a specific object behind a lock. + The goal here is to provide a simple way to protect access to an object + that cannot safely be simultaneously accessed from multiple threads. The + intended use of this class is simple: take hold of it with a context + manager, which returns the protected object. + """ + + __slots__ = ( + "lock", + "_obj", + ) + + def __init__(self, obj: T): + self.lock = threading.RLock() + self._obj = obj + + def __enter__(self) -> T: + self.lock.acquire() + return self._obj + + def __exit__( + self, + exc_type: type[BaseException] | None, + exc_val: BaseException | None, + exc_tb: types.TracebackType | None, + ) -> None: + self.lock.release() + + +class HTTP2Connection(HTTPSConnection): + def __init__( + self, host: str, port: int | None = None, **kwargs: typing.Any + ) -> None: + self._h2_conn = self._new_h2_conn() + self._h2_stream: int | None = None + self._headers: list[tuple[bytes, bytes]] = [] + + if "proxy" in kwargs or "proxy_config" in kwargs: # Defensive: + raise NotImplementedError("Proxies aren't supported with HTTP/2") + + super().__init__(host, port, **kwargs) + + if self._tunnel_host is not None: + raise NotImplementedError("Tunneling isn't supported with HTTP/2") + + def _new_h2_conn(self) -> _LockedObject[h2.connection.H2Connection]: + config = h2.config.H2Configuration(client_side=True) + return _LockedObject(h2.connection.H2Connection(config=config)) + + def connect(self) -> None: + super().connect() + with self._h2_conn as conn: + conn.initiate_connection() + if data_to_send := conn.data_to_send(): + self.sock.sendall(data_to_send) + + def putrequest( # type: ignore[override] + self, + method: str, + url: str, + **kwargs: typing.Any, + ) -> None: + """putrequest + This deviates from the HTTPConnection method signature since we never need to override + sending accept-encoding headers or the host header. + """ + if "skip_host" in kwargs: + raise NotImplementedError("`skip_host` isn't supported") + if "skip_accept_encoding" in kwargs: + raise NotImplementedError("`skip_accept_encoding` isn't supported") + + self._request_url = url or "/" + self._validate_path(url) # type: ignore[attr-defined] + + if ":" in self.host: + authority = f"[{self.host}]:{self.port or 443}" + else: + authority = f"{self.host}:{self.port or 443}" + + self._headers.append((b":scheme", b"https")) + self._headers.append((b":method", method.encode())) + self._headers.append((b":authority", authority.encode())) + self._headers.append((b":path", url.encode())) + + with self._h2_conn as conn: + self._h2_stream = conn.get_next_available_stream_id() + + def putheader(self, header: str | bytes, *values: str | bytes) -> None: # type: ignore[override] + # TODO SKIPPABLE_HEADERS from urllib3 are ignored. + header = header.encode() if isinstance(header, str) else header + header = header.lower() # A lot of upstream code uses capitalized headers. + if not _is_legal_header_name(header): + raise ValueError(f"Illegal header name {str(header)}") + + for value in values: + value = value.encode() if isinstance(value, str) else value + if _is_illegal_header_value(value): + raise ValueError(f"Illegal header value {str(value)}") + self._headers.append((header, value)) + + def endheaders(self, message_body: typing.Any = None) -> None: # type: ignore[override] + if self._h2_stream is None: + raise ConnectionError("Must call `putrequest` first.") + + with self._h2_conn as conn: + conn.send_headers( + stream_id=self._h2_stream, + headers=self._headers, + end_stream=(message_body is None), + ) + if data_to_send := conn.data_to_send(): + self.sock.sendall(data_to_send) + self._headers = [] # Reset headers for the next request. + + def send(self, data: typing.Any) -> None: + """Send data to the server. + `data` can be: `str`, `bytes`, an iterable, or file-like objects + that support a .read() method. + """ + if self._h2_stream is None: + raise ConnectionError("Must call `putrequest` first.") + + with self._h2_conn as conn: + if data_to_send := conn.data_to_send(): + self.sock.sendall(data_to_send) + + if hasattr(data, "read"): # file-like objects + while True: + chunk = data.read(self.blocksize) + if not chunk: + break + if isinstance(chunk, str): + chunk = chunk.encode() + conn.send_data(self._h2_stream, chunk, end_stream=False) + if data_to_send := conn.data_to_send(): + self.sock.sendall(data_to_send) + conn.end_stream(self._h2_stream) + return + + if isinstance(data, str): # str -> bytes + data = data.encode() + + try: + if isinstance(data, bytes): + conn.send_data(self._h2_stream, data, end_stream=True) + if data_to_send := conn.data_to_send(): + self.sock.sendall(data_to_send) + else: + for chunk in data: + conn.send_data(self._h2_stream, chunk, end_stream=False) + if data_to_send := conn.data_to_send(): + self.sock.sendall(data_to_send) + conn.end_stream(self._h2_stream) + except TypeError: + raise TypeError( + "`data` should be str, bytes, iterable, or file. got %r" + % type(data) + ) + + def set_tunnel( + self, + host: str, + port: int | None = None, + headers: typing.Mapping[str, str] | None = None, + scheme: str = "http", + ) -> None: + raise NotImplementedError( + "HTTP/2 does not support setting up a tunnel through a proxy" + ) + + def getresponse( # type: ignore[override] + self, + ) -> HTTP2Response: + status = None + data = bytearray() + with self._h2_conn as conn: + end_stream = False + while not end_stream: + # TODO: Arbitrary read value. + if received_data := self.sock.recv(65535): + events = conn.receive_data(received_data) + for event in events: + if isinstance(event, h2.events.ResponseReceived): + headers = HTTPHeaderDict() + for header, value in event.headers: + if header == b":status": + status = int(value.decode()) + else: + headers.add( + header.decode("ascii"), value.decode("ascii") + ) + + elif isinstance(event, h2.events.DataReceived): + data += event.data + conn.acknowledge_received_data( + event.flow_controlled_length, event.stream_id + ) + + elif isinstance(event, h2.events.StreamEnded): + end_stream = True + + if data_to_send := conn.data_to_send(): + self.sock.sendall(data_to_send) + + assert status is not None + return HTTP2Response( + status=status, + headers=headers, + request_url=self._request_url, + data=bytes(data), + ) + + def request( # type: ignore[override] + self, + method: str, + url: str, + body: _TYPE_BODY | None = None, + headers: typing.Mapping[str, str] | None = None, + *, + preload_content: bool = True, + decode_content: bool = True, + enforce_content_length: bool = True, + **kwargs: typing.Any, + ) -> None: + """Send an HTTP/2 request""" + if "chunked" in kwargs: + # TODO this is often present from upstream. + # raise NotImplementedError("`chunked` isn't supported with HTTP/2") + pass + + if self.sock is not None: + self.sock.settimeout(self.timeout) + + self.putrequest(method, url) + + headers = headers or {} + for k, v in headers.items(): + if k.lower() == "transfer-encoding" and v == "chunked": + continue + else: + self.putheader(k, v) + + if b"user-agent" not in dict(self._headers): + self.putheader(b"user-agent", _get_default_user_agent()) + + if body: + self.endheaders(message_body=body) + self.send(body) + else: + self.endheaders() + + def close(self) -> None: + with self._h2_conn as conn: + try: + conn.close_connection() + if data := conn.data_to_send(): + self.sock.sendall(data) + except Exception: + pass + + # Reset all our HTTP/2 connection state. + self._h2_conn = self._new_h2_conn() + self._h2_stream = None + self._headers = [] + + super().close() + + +class HTTP2Response(BaseHTTPResponse): + # TODO: This is a woefully incomplete response object, but works for non-streaming. + def __init__( + self, + status: int, + headers: HTTPHeaderDict, + request_url: str, + data: bytes, + decode_content: bool = False, # TODO: support decoding + ) -> None: + super().__init__( + status=status, + headers=headers, + # Following CPython, we map HTTP versions to major * 10 + minor integers + version=20, + version_string="HTTP/2", + # No reason phrase in HTTP/2 + reason=None, + decode_content=decode_content, + request_url=request_url, + ) + self._data = data + self.length_remaining = 0 + + @property + def data(self) -> bytes: + return self._data + + def get_redirect_location(self) -> None: + return None + + def close(self) -> None: + pass diff --git a/newrelic/packages/urllib3/http2/probe.py b/newrelic/packages/urllib3/http2/probe.py new file mode 100644 index 0000000000..9ea900764f --- /dev/null +++ b/newrelic/packages/urllib3/http2/probe.py @@ -0,0 +1,87 @@ +from __future__ import annotations + +import threading + + +class _HTTP2ProbeCache: + __slots__ = ( + "_lock", + "_cache_locks", + "_cache_values", + ) + + def __init__(self) -> None: + self._lock = threading.Lock() + self._cache_locks: dict[tuple[str, int], threading.RLock] = {} + self._cache_values: dict[tuple[str, int], bool | None] = {} + + def acquire_and_get(self, host: str, port: int) -> bool | None: + # By the end of this block we know that + # _cache_[values,locks] is available. + value = None + with self._lock: + key = (host, port) + try: + value = self._cache_values[key] + # If it's a known value we return right away. + if value is not None: + return value + except KeyError: + self._cache_locks[key] = threading.RLock() + self._cache_values[key] = None + + # If the value is unknown, we acquire the lock to signal + # to the requesting thread that the probe is in progress + # or that the current thread needs to return their findings. + key_lock = self._cache_locks[key] + key_lock.acquire() + try: + # If the by the time we get the lock the value has been + # updated we want to return the updated value. + value = self._cache_values[key] + + # In case an exception like KeyboardInterrupt is raised here. + except BaseException as e: # Defensive: + assert not isinstance(e, KeyError) # KeyError shouldn't be possible. + key_lock.release() + raise + + return value + + def set_and_release( + self, host: str, port: int, supports_http2: bool | None + ) -> None: + key = (host, port) + key_lock = self._cache_locks[key] + with key_lock: # Uses an RLock, so can be locked again from same thread. + if supports_http2 is None and self._cache_values[key] is not None: + raise ValueError( + "Cannot reset HTTP/2 support for origin after value has been set." + ) # Defensive: not expected in normal usage + + self._cache_values[key] = supports_http2 + key_lock.release() + + def _values(self) -> dict[tuple[str, int], bool | None]: + """This function is for testing purposes only. Gets the current state of the probe cache""" + with self._lock: + return {k: v for k, v in self._cache_values.items()} + + def _reset(self) -> None: + """This function is for testing purposes only. Reset the cache values""" + with self._lock: + self._cache_locks = {} + self._cache_values = {} + + +_HTTP2_PROBE_CACHE = _HTTP2ProbeCache() + +set_and_release = _HTTP2_PROBE_CACHE.set_and_release +acquire_and_get = _HTTP2_PROBE_CACHE.acquire_and_get +_values = _HTTP2_PROBE_CACHE._values +_reset = _HTTP2_PROBE_CACHE._reset + +__all__ = [ + "set_and_release", + "acquire_and_get", +] diff --git a/newrelic/packages/urllib3/packages/__init__.py b/newrelic/packages/urllib3/packages/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/newrelic/packages/urllib3/packages/backports/__init__.py b/newrelic/packages/urllib3/packages/backports/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/newrelic/packages/urllib3/packages/backports/makefile.py b/newrelic/packages/urllib3/packages/backports/makefile.py deleted file mode 100644 index b8fb2154b6..0000000000 --- a/newrelic/packages/urllib3/packages/backports/makefile.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -""" -backports.makefile -~~~~~~~~~~~~~~~~~~ - -Backports the Python 3 ``socket.makefile`` method for use with anything that -wants to create a "fake" socket object. -""" -import io -from socket import SocketIO - - -def backport_makefile( - self, mode="r", buffering=None, encoding=None, errors=None, newline=None -): - """ - Backport of ``socket.makefile`` from Python 3.5. - """ - if not set(mode) <= {"r", "w", "b"}: - raise ValueError("invalid mode %r (only r, w, b allowed)" % (mode,)) - writing = "w" in mode - reading = "r" in mode or not writing - assert reading or writing - binary = "b" in mode - rawmode = "" - if reading: - rawmode += "r" - if writing: - rawmode += "w" - raw = SocketIO(self, rawmode) - self._makefile_refs += 1 - if buffering is None: - buffering = -1 - if buffering < 0: - buffering = io.DEFAULT_BUFFER_SIZE - if buffering == 0: - if not binary: - raise ValueError("unbuffered streams must be binary") - return raw - if reading and writing: - buffer = io.BufferedRWPair(raw, raw, buffering) - elif reading: - buffer = io.BufferedReader(raw, buffering) - else: - assert writing - buffer = io.BufferedWriter(raw, buffering) - if binary: - return buffer - text = io.TextIOWrapper(buffer, encoding, errors, newline) - text.mode = mode - return text diff --git a/newrelic/packages/urllib3/packages/backports/weakref_finalize.py b/newrelic/packages/urllib3/packages/backports/weakref_finalize.py deleted file mode 100644 index a2f2966e54..0000000000 --- a/newrelic/packages/urllib3/packages/backports/weakref_finalize.py +++ /dev/null @@ -1,155 +0,0 @@ -# -*- coding: utf-8 -*- -""" -backports.weakref_finalize -~~~~~~~~~~~~~~~~~~ - -Backports the Python 3 ``weakref.finalize`` method. -""" -from __future__ import absolute_import - -import itertools -import sys -from weakref import ref - -__all__ = ["weakref_finalize"] - - -class weakref_finalize(object): - """Class for finalization of weakrefable objects - finalize(obj, func, *args, **kwargs) returns a callable finalizer - object which will be called when obj is garbage collected. The - first time the finalizer is called it evaluates func(*arg, **kwargs) - and returns the result. After this the finalizer is dead, and - calling it just returns None. - When the program exits any remaining finalizers for which the - atexit attribute is true will be run in reverse order of creation. - By default atexit is true. - """ - - # Finalizer objects don't have any state of their own. They are - # just used as keys to lookup _Info objects in the registry. This - # ensures that they cannot be part of a ref-cycle. - - __slots__ = () - _registry = {} - _shutdown = False - _index_iter = itertools.count() - _dirty = False - _registered_with_atexit = False - - class _Info(object): - __slots__ = ("weakref", "func", "args", "kwargs", "atexit", "index") - - def __init__(self, obj, func, *args, **kwargs): - if not self._registered_with_atexit: - # We may register the exit function more than once because - # of a thread race, but that is harmless - import atexit - - atexit.register(self._exitfunc) - weakref_finalize._registered_with_atexit = True - info = self._Info() - info.weakref = ref(obj, self) - info.func = func - info.args = args - info.kwargs = kwargs or None - info.atexit = True - info.index = next(self._index_iter) - self._registry[self] = info - weakref_finalize._dirty = True - - def __call__(self, _=None): - """If alive then mark as dead and return func(*args, **kwargs); - otherwise return None""" - info = self._registry.pop(self, None) - if info and not self._shutdown: - return info.func(*info.args, **(info.kwargs or {})) - - def detach(self): - """If alive then mark as dead and return (obj, func, args, kwargs); - otherwise return None""" - info = self._registry.get(self) - obj = info and info.weakref() - if obj is not None and self._registry.pop(self, None): - return (obj, info.func, info.args, info.kwargs or {}) - - def peek(self): - """If alive then return (obj, func, args, kwargs); - otherwise return None""" - info = self._registry.get(self) - obj = info and info.weakref() - if obj is not None: - return (obj, info.func, info.args, info.kwargs or {}) - - @property - def alive(self): - """Whether finalizer is alive""" - return self in self._registry - - @property - def atexit(self): - """Whether finalizer should be called at exit""" - info = self._registry.get(self) - return bool(info) and info.atexit - - @atexit.setter - def atexit(self, value): - info = self._registry.get(self) - if info: - info.atexit = bool(value) - - def __repr__(self): - info = self._registry.get(self) - obj = info and info.weakref() - if obj is None: - return "<%s object at %#x; dead>" % (type(self).__name__, id(self)) - else: - return "<%s object at %#x; for %r at %#x>" % ( - type(self).__name__, - id(self), - type(obj).__name__, - id(obj), - ) - - @classmethod - def _select_for_exit(cls): - # Return live finalizers marked for exit, oldest first - L = [(f, i) for (f, i) in cls._registry.items() if i.atexit] - L.sort(key=lambda item: item[1].index) - return [f for (f, i) in L] - - @classmethod - def _exitfunc(cls): - # At shutdown invoke finalizers for which atexit is true. - # This is called once all other non-daemonic threads have been - # joined. - reenable_gc = False - try: - if cls._registry: - import gc - - if gc.isenabled(): - reenable_gc = True - gc.disable() - pending = None - while True: - if pending is None or weakref_finalize._dirty: - pending = cls._select_for_exit() - weakref_finalize._dirty = False - if not pending: - break - f = pending.pop() - try: - # gc is disabled, so (assuming no daemonic - # threads) the following is the only line in - # this function which might trigger creation - # of a new finalizer - f() - except Exception: - sys.excepthook(*sys.exc_info()) - assert f not in cls._registry - finally: - # prevent any more finalizers from executing during shutdown - weakref_finalize._shutdown = True - if reenable_gc: - gc.enable() diff --git a/newrelic/packages/urllib3/packages/six.py b/newrelic/packages/urllib3/packages/six.py deleted file mode 100644 index f099a3dcd2..0000000000 --- a/newrelic/packages/urllib3/packages/six.py +++ /dev/null @@ -1,1076 +0,0 @@ -# Copyright (c) 2010-2020 Benjamin Peterson -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -"""Utilities for writing code that runs on Python 2 and 3""" - -from __future__ import absolute_import - -import functools -import itertools -import operator -import sys -import types - -__author__ = "Benjamin Peterson " -__version__ = "1.16.0" - - -# Useful for very coarse version differentiation. -PY2 = sys.version_info[0] == 2 -PY3 = sys.version_info[0] == 3 -PY34 = sys.version_info[0:2] >= (3, 4) - -if PY3: - string_types = (str,) - integer_types = (int,) - class_types = (type,) - text_type = str - binary_type = bytes - - MAXSIZE = sys.maxsize -else: - string_types = (basestring,) - integer_types = (int, long) - class_types = (type, types.ClassType) - text_type = unicode - binary_type = str - - if sys.platform.startswith("java"): - # Jython always uses 32 bits. - MAXSIZE = int((1 << 31) - 1) - else: - # It's possible to have sizeof(long) != sizeof(Py_ssize_t). - class X(object): - def __len__(self): - return 1 << 31 - - try: - len(X()) - except OverflowError: - # 32-bit - MAXSIZE = int((1 << 31) - 1) - else: - # 64-bit - MAXSIZE = int((1 << 63) - 1) - del X - -if PY34: - from importlib.util import spec_from_loader -else: - spec_from_loader = None - - -def _add_doc(func, doc): - """Add documentation to a function.""" - func.__doc__ = doc - - -def _import_module(name): - """Import module, returning the module after the last dot.""" - __import__(name) - return sys.modules[name] - - -class _LazyDescr(object): - def __init__(self, name): - self.name = name - - def __get__(self, obj, tp): - result = self._resolve() - setattr(obj, self.name, result) # Invokes __set__. - try: - # This is a bit ugly, but it avoids running this again by - # removing this descriptor. - delattr(obj.__class__, self.name) - except AttributeError: - pass - return result - - -class MovedModule(_LazyDescr): - def __init__(self, name, old, new=None): - super(MovedModule, self).__init__(name) - if PY3: - if new is None: - new = name - self.mod = new - else: - self.mod = old - - def _resolve(self): - return _import_module(self.mod) - - def __getattr__(self, attr): - _module = self._resolve() - value = getattr(_module, attr) - setattr(self, attr, value) - return value - - -class _LazyModule(types.ModuleType): - def __init__(self, name): - super(_LazyModule, self).__init__(name) - self.__doc__ = self.__class__.__doc__ - - def __dir__(self): - attrs = ["__doc__", "__name__"] - attrs += [attr.name for attr in self._moved_attributes] - return attrs - - # Subclasses should override this - _moved_attributes = [] - - -class MovedAttribute(_LazyDescr): - def __init__(self, name, old_mod, new_mod, old_attr=None, new_attr=None): - super(MovedAttribute, self).__init__(name) - if PY3: - if new_mod is None: - new_mod = name - self.mod = new_mod - if new_attr is None: - if old_attr is None: - new_attr = name - else: - new_attr = old_attr - self.attr = new_attr - else: - self.mod = old_mod - if old_attr is None: - old_attr = name - self.attr = old_attr - - def _resolve(self): - module = _import_module(self.mod) - return getattr(module, self.attr) - - -class _SixMetaPathImporter(object): - - """ - A meta path importer to import six.moves and its submodules. - - This class implements a PEP302 finder and loader. It should be compatible - with Python 2.5 and all existing versions of Python3 - """ - - def __init__(self, six_module_name): - self.name = six_module_name - self.known_modules = {} - - def _add_module(self, mod, *fullnames): - for fullname in fullnames: - self.known_modules[self.name + "." + fullname] = mod - - def _get_module(self, fullname): - return self.known_modules[self.name + "." + fullname] - - def find_module(self, fullname, path=None): - if fullname in self.known_modules: - return self - return None - - def find_spec(self, fullname, path, target=None): - if fullname in self.known_modules: - return spec_from_loader(fullname, self) - return None - - def __get_module(self, fullname): - try: - return self.known_modules[fullname] - except KeyError: - raise ImportError("This loader does not know module " + fullname) - - def load_module(self, fullname): - try: - # in case of a reload - return sys.modules[fullname] - except KeyError: - pass - mod = self.__get_module(fullname) - if isinstance(mod, MovedModule): - mod = mod._resolve() - else: - mod.__loader__ = self - sys.modules[fullname] = mod - return mod - - def is_package(self, fullname): - """ - Return true, if the named module is a package. - - We need this method to get correct spec objects with - Python 3.4 (see PEP451) - """ - return hasattr(self.__get_module(fullname), "__path__") - - def get_code(self, fullname): - """Return None - - Required, if is_package is implemented""" - self.__get_module(fullname) # eventually raises ImportError - return None - - get_source = get_code # same as get_code - - def create_module(self, spec): - return self.load_module(spec.name) - - def exec_module(self, module): - pass - - -_importer = _SixMetaPathImporter(__name__) - - -class _MovedItems(_LazyModule): - - """Lazy loading of moved objects""" - - __path__ = [] # mark as package - - -_moved_attributes = [ - MovedAttribute("cStringIO", "cStringIO", "io", "StringIO"), - MovedAttribute("filter", "itertools", "builtins", "ifilter", "filter"), - MovedAttribute( - "filterfalse", "itertools", "itertools", "ifilterfalse", "filterfalse" - ), - MovedAttribute("input", "__builtin__", "builtins", "raw_input", "input"), - MovedAttribute("intern", "__builtin__", "sys"), - MovedAttribute("map", "itertools", "builtins", "imap", "map"), - MovedAttribute("getcwd", "os", "os", "getcwdu", "getcwd"), - MovedAttribute("getcwdb", "os", "os", "getcwd", "getcwdb"), - MovedAttribute("getoutput", "commands", "subprocess"), - MovedAttribute("range", "__builtin__", "builtins", "xrange", "range"), - MovedAttribute( - "reload_module", "__builtin__", "importlib" if PY34 else "imp", "reload" - ), - MovedAttribute("reduce", "__builtin__", "functools"), - MovedAttribute("shlex_quote", "pipes", "shlex", "quote"), - MovedAttribute("StringIO", "StringIO", "io"), - MovedAttribute("UserDict", "UserDict", "collections"), - MovedAttribute("UserList", "UserList", "collections"), - MovedAttribute("UserString", "UserString", "collections"), - MovedAttribute("xrange", "__builtin__", "builtins", "xrange", "range"), - MovedAttribute("zip", "itertools", "builtins", "izip", "zip"), - MovedAttribute( - "zip_longest", "itertools", "itertools", "izip_longest", "zip_longest" - ), - MovedModule("builtins", "__builtin__"), - MovedModule("configparser", "ConfigParser"), - MovedModule( - "collections_abc", - "collections", - "collections.abc" if sys.version_info >= (3, 3) else "collections", - ), - MovedModule("copyreg", "copy_reg"), - MovedModule("dbm_gnu", "gdbm", "dbm.gnu"), - MovedModule("dbm_ndbm", "dbm", "dbm.ndbm"), - MovedModule( - "_dummy_thread", - "dummy_thread", - "_dummy_thread" if sys.version_info < (3, 9) else "_thread", - ), - MovedModule("http_cookiejar", "cookielib", "http.cookiejar"), - MovedModule("http_cookies", "Cookie", "http.cookies"), - MovedModule("html_entities", "htmlentitydefs", "html.entities"), - MovedModule("html_parser", "HTMLParser", "html.parser"), - MovedModule("http_client", "httplib", "http.client"), - MovedModule("email_mime_base", "email.MIMEBase", "email.mime.base"), - MovedModule("email_mime_image", "email.MIMEImage", "email.mime.image"), - MovedModule("email_mime_multipart", "email.MIMEMultipart", "email.mime.multipart"), - MovedModule( - "email_mime_nonmultipart", "email.MIMENonMultipart", "email.mime.nonmultipart" - ), - MovedModule("email_mime_text", "email.MIMEText", "email.mime.text"), - MovedModule("BaseHTTPServer", "BaseHTTPServer", "http.server"), - MovedModule("CGIHTTPServer", "CGIHTTPServer", "http.server"), - MovedModule("SimpleHTTPServer", "SimpleHTTPServer", "http.server"), - MovedModule("cPickle", "cPickle", "pickle"), - MovedModule("queue", "Queue"), - MovedModule("reprlib", "repr"), - MovedModule("socketserver", "SocketServer"), - MovedModule("_thread", "thread", "_thread"), - MovedModule("tkinter", "Tkinter"), - MovedModule("tkinter_dialog", "Dialog", "tkinter.dialog"), - MovedModule("tkinter_filedialog", "FileDialog", "tkinter.filedialog"), - MovedModule("tkinter_scrolledtext", "ScrolledText", "tkinter.scrolledtext"), - MovedModule("tkinter_simpledialog", "SimpleDialog", "tkinter.simpledialog"), - MovedModule("tkinter_tix", "Tix", "tkinter.tix"), - MovedModule("tkinter_ttk", "ttk", "tkinter.ttk"), - MovedModule("tkinter_constants", "Tkconstants", "tkinter.constants"), - MovedModule("tkinter_dnd", "Tkdnd", "tkinter.dnd"), - MovedModule("tkinter_colorchooser", "tkColorChooser", "tkinter.colorchooser"), - MovedModule("tkinter_commondialog", "tkCommonDialog", "tkinter.commondialog"), - MovedModule("tkinter_tkfiledialog", "tkFileDialog", "tkinter.filedialog"), - MovedModule("tkinter_font", "tkFont", "tkinter.font"), - MovedModule("tkinter_messagebox", "tkMessageBox", "tkinter.messagebox"), - MovedModule("tkinter_tksimpledialog", "tkSimpleDialog", "tkinter.simpledialog"), - MovedModule("urllib_parse", __name__ + ".moves.urllib_parse", "urllib.parse"), - MovedModule("urllib_error", __name__ + ".moves.urllib_error", "urllib.error"), - MovedModule("urllib", __name__ + ".moves.urllib", __name__ + ".moves.urllib"), - MovedModule("urllib_robotparser", "robotparser", "urllib.robotparser"), - MovedModule("xmlrpc_client", "xmlrpclib", "xmlrpc.client"), - MovedModule("xmlrpc_server", "SimpleXMLRPCServer", "xmlrpc.server"), -] -# Add windows specific modules. -if sys.platform == "win32": - _moved_attributes += [ - MovedModule("winreg", "_winreg"), - ] - -for attr in _moved_attributes: - setattr(_MovedItems, attr.name, attr) - if isinstance(attr, MovedModule): - _importer._add_module(attr, "moves." + attr.name) -del attr - -_MovedItems._moved_attributes = _moved_attributes - -moves = _MovedItems(__name__ + ".moves") -_importer._add_module(moves, "moves") - - -class Module_six_moves_urllib_parse(_LazyModule): - - """Lazy loading of moved objects in six.moves.urllib_parse""" - - -_urllib_parse_moved_attributes = [ - MovedAttribute("ParseResult", "urlparse", "urllib.parse"), - MovedAttribute("SplitResult", "urlparse", "urllib.parse"), - MovedAttribute("parse_qs", "urlparse", "urllib.parse"), - MovedAttribute("parse_qsl", "urlparse", "urllib.parse"), - MovedAttribute("urldefrag", "urlparse", "urllib.parse"), - MovedAttribute("urljoin", "urlparse", "urllib.parse"), - MovedAttribute("urlparse", "urlparse", "urllib.parse"), - MovedAttribute("urlsplit", "urlparse", "urllib.parse"), - MovedAttribute("urlunparse", "urlparse", "urllib.parse"), - MovedAttribute("urlunsplit", "urlparse", "urllib.parse"), - MovedAttribute("quote", "urllib", "urllib.parse"), - MovedAttribute("quote_plus", "urllib", "urllib.parse"), - MovedAttribute("unquote", "urllib", "urllib.parse"), - MovedAttribute("unquote_plus", "urllib", "urllib.parse"), - MovedAttribute( - "unquote_to_bytes", "urllib", "urllib.parse", "unquote", "unquote_to_bytes" - ), - MovedAttribute("urlencode", "urllib", "urllib.parse"), - MovedAttribute("splitquery", "urllib", "urllib.parse"), - MovedAttribute("splittag", "urllib", "urllib.parse"), - MovedAttribute("splituser", "urllib", "urllib.parse"), - MovedAttribute("splitvalue", "urllib", "urllib.parse"), - MovedAttribute("uses_fragment", "urlparse", "urllib.parse"), - MovedAttribute("uses_netloc", "urlparse", "urllib.parse"), - MovedAttribute("uses_params", "urlparse", "urllib.parse"), - MovedAttribute("uses_query", "urlparse", "urllib.parse"), - MovedAttribute("uses_relative", "urlparse", "urllib.parse"), -] -for attr in _urllib_parse_moved_attributes: - setattr(Module_six_moves_urllib_parse, attr.name, attr) -del attr - -Module_six_moves_urllib_parse._moved_attributes = _urllib_parse_moved_attributes - -_importer._add_module( - Module_six_moves_urllib_parse(__name__ + ".moves.urllib_parse"), - "moves.urllib_parse", - "moves.urllib.parse", -) - - -class Module_six_moves_urllib_error(_LazyModule): - - """Lazy loading of moved objects in six.moves.urllib_error""" - - -_urllib_error_moved_attributes = [ - MovedAttribute("URLError", "urllib2", "urllib.error"), - MovedAttribute("HTTPError", "urllib2", "urllib.error"), - MovedAttribute("ContentTooShortError", "urllib", "urllib.error"), -] -for attr in _urllib_error_moved_attributes: - setattr(Module_six_moves_urllib_error, attr.name, attr) -del attr - -Module_six_moves_urllib_error._moved_attributes = _urllib_error_moved_attributes - -_importer._add_module( - Module_six_moves_urllib_error(__name__ + ".moves.urllib.error"), - "moves.urllib_error", - "moves.urllib.error", -) - - -class Module_six_moves_urllib_request(_LazyModule): - - """Lazy loading of moved objects in six.moves.urllib_request""" - - -_urllib_request_moved_attributes = [ - MovedAttribute("urlopen", "urllib2", "urllib.request"), - MovedAttribute("install_opener", "urllib2", "urllib.request"), - MovedAttribute("build_opener", "urllib2", "urllib.request"), - MovedAttribute("pathname2url", "urllib", "urllib.request"), - MovedAttribute("url2pathname", "urllib", "urllib.request"), - MovedAttribute("getproxies", "urllib", "urllib.request"), - MovedAttribute("Request", "urllib2", "urllib.request"), - MovedAttribute("OpenerDirector", "urllib2", "urllib.request"), - MovedAttribute("HTTPDefaultErrorHandler", "urllib2", "urllib.request"), - MovedAttribute("HTTPRedirectHandler", "urllib2", "urllib.request"), - MovedAttribute("HTTPCookieProcessor", "urllib2", "urllib.request"), - MovedAttribute("ProxyHandler", "urllib2", "urllib.request"), - MovedAttribute("BaseHandler", "urllib2", "urllib.request"), - MovedAttribute("HTTPPasswordMgr", "urllib2", "urllib.request"), - MovedAttribute("HTTPPasswordMgrWithDefaultRealm", "urllib2", "urllib.request"), - MovedAttribute("AbstractBasicAuthHandler", "urllib2", "urllib.request"), - MovedAttribute("HTTPBasicAuthHandler", "urllib2", "urllib.request"), - MovedAttribute("ProxyBasicAuthHandler", "urllib2", "urllib.request"), - MovedAttribute("AbstractDigestAuthHandler", "urllib2", "urllib.request"), - MovedAttribute("HTTPDigestAuthHandler", "urllib2", "urllib.request"), - MovedAttribute("ProxyDigestAuthHandler", "urllib2", "urllib.request"), - MovedAttribute("HTTPHandler", "urllib2", "urllib.request"), - MovedAttribute("HTTPSHandler", "urllib2", "urllib.request"), - MovedAttribute("FileHandler", "urllib2", "urllib.request"), - MovedAttribute("FTPHandler", "urllib2", "urllib.request"), - MovedAttribute("CacheFTPHandler", "urllib2", "urllib.request"), - MovedAttribute("UnknownHandler", "urllib2", "urllib.request"), - MovedAttribute("HTTPErrorProcessor", "urllib2", "urllib.request"), - MovedAttribute("urlretrieve", "urllib", "urllib.request"), - MovedAttribute("urlcleanup", "urllib", "urllib.request"), - MovedAttribute("URLopener", "urllib", "urllib.request"), - MovedAttribute("FancyURLopener", "urllib", "urllib.request"), - MovedAttribute("proxy_bypass", "urllib", "urllib.request"), - MovedAttribute("parse_http_list", "urllib2", "urllib.request"), - MovedAttribute("parse_keqv_list", "urllib2", "urllib.request"), -] -for attr in _urllib_request_moved_attributes: - setattr(Module_six_moves_urllib_request, attr.name, attr) -del attr - -Module_six_moves_urllib_request._moved_attributes = _urllib_request_moved_attributes - -_importer._add_module( - Module_six_moves_urllib_request(__name__ + ".moves.urllib.request"), - "moves.urllib_request", - "moves.urllib.request", -) - - -class Module_six_moves_urllib_response(_LazyModule): - - """Lazy loading of moved objects in six.moves.urllib_response""" - - -_urllib_response_moved_attributes = [ - MovedAttribute("addbase", "urllib", "urllib.response"), - MovedAttribute("addclosehook", "urllib", "urllib.response"), - MovedAttribute("addinfo", "urllib", "urllib.response"), - MovedAttribute("addinfourl", "urllib", "urllib.response"), -] -for attr in _urllib_response_moved_attributes: - setattr(Module_six_moves_urllib_response, attr.name, attr) -del attr - -Module_six_moves_urllib_response._moved_attributes = _urllib_response_moved_attributes - -_importer._add_module( - Module_six_moves_urllib_response(__name__ + ".moves.urllib.response"), - "moves.urllib_response", - "moves.urllib.response", -) - - -class Module_six_moves_urllib_robotparser(_LazyModule): - - """Lazy loading of moved objects in six.moves.urllib_robotparser""" - - -_urllib_robotparser_moved_attributes = [ - MovedAttribute("RobotFileParser", "robotparser", "urllib.robotparser"), -] -for attr in _urllib_robotparser_moved_attributes: - setattr(Module_six_moves_urllib_robotparser, attr.name, attr) -del attr - -Module_six_moves_urllib_robotparser._moved_attributes = ( - _urllib_robotparser_moved_attributes -) - -_importer._add_module( - Module_six_moves_urllib_robotparser(__name__ + ".moves.urllib.robotparser"), - "moves.urllib_robotparser", - "moves.urllib.robotparser", -) - - -class Module_six_moves_urllib(types.ModuleType): - - """Create a six.moves.urllib namespace that resembles the Python 3 namespace""" - - __path__ = [] # mark as package - parse = _importer._get_module("moves.urllib_parse") - error = _importer._get_module("moves.urllib_error") - request = _importer._get_module("moves.urllib_request") - response = _importer._get_module("moves.urllib_response") - robotparser = _importer._get_module("moves.urllib_robotparser") - - def __dir__(self): - return ["parse", "error", "request", "response", "robotparser"] - - -_importer._add_module( - Module_six_moves_urllib(__name__ + ".moves.urllib"), "moves.urllib" -) - - -def add_move(move): - """Add an item to six.moves.""" - setattr(_MovedItems, move.name, move) - - -def remove_move(name): - """Remove item from six.moves.""" - try: - delattr(_MovedItems, name) - except AttributeError: - try: - del moves.__dict__[name] - except KeyError: - raise AttributeError("no such move, %r" % (name,)) - - -if PY3: - _meth_func = "__func__" - _meth_self = "__self__" - - _func_closure = "__closure__" - _func_code = "__code__" - _func_defaults = "__defaults__" - _func_globals = "__globals__" -else: - _meth_func = "im_func" - _meth_self = "im_self" - - _func_closure = "func_closure" - _func_code = "func_code" - _func_defaults = "func_defaults" - _func_globals = "func_globals" - - -try: - advance_iterator = next -except NameError: - - def advance_iterator(it): - return it.next() - - -next = advance_iterator - - -try: - callable = callable -except NameError: - - def callable(obj): - return any("__call__" in klass.__dict__ for klass in type(obj).__mro__) - - -if PY3: - - def get_unbound_function(unbound): - return unbound - - create_bound_method = types.MethodType - - def create_unbound_method(func, cls): - return func - - Iterator = object -else: - - def get_unbound_function(unbound): - return unbound.im_func - - def create_bound_method(func, obj): - return types.MethodType(func, obj, obj.__class__) - - def create_unbound_method(func, cls): - return types.MethodType(func, None, cls) - - class Iterator(object): - def next(self): - return type(self).__next__(self) - - callable = callable -_add_doc( - get_unbound_function, """Get the function out of a possibly unbound function""" -) - - -get_method_function = operator.attrgetter(_meth_func) -get_method_self = operator.attrgetter(_meth_self) -get_function_closure = operator.attrgetter(_func_closure) -get_function_code = operator.attrgetter(_func_code) -get_function_defaults = operator.attrgetter(_func_defaults) -get_function_globals = operator.attrgetter(_func_globals) - - -if PY3: - - def iterkeys(d, **kw): - return iter(d.keys(**kw)) - - def itervalues(d, **kw): - return iter(d.values(**kw)) - - def iteritems(d, **kw): - return iter(d.items(**kw)) - - def iterlists(d, **kw): - return iter(d.lists(**kw)) - - viewkeys = operator.methodcaller("keys") - - viewvalues = operator.methodcaller("values") - - viewitems = operator.methodcaller("items") -else: - - def iterkeys(d, **kw): - return d.iterkeys(**kw) - - def itervalues(d, **kw): - return d.itervalues(**kw) - - def iteritems(d, **kw): - return d.iteritems(**kw) - - def iterlists(d, **kw): - return d.iterlists(**kw) - - viewkeys = operator.methodcaller("viewkeys") - - viewvalues = operator.methodcaller("viewvalues") - - viewitems = operator.methodcaller("viewitems") - -_add_doc(iterkeys, "Return an iterator over the keys of a dictionary.") -_add_doc(itervalues, "Return an iterator over the values of a dictionary.") -_add_doc(iteritems, "Return an iterator over the (key, value) pairs of a dictionary.") -_add_doc( - iterlists, "Return an iterator over the (key, [values]) pairs of a dictionary." -) - - -if PY3: - - def b(s): - return s.encode("latin-1") - - def u(s): - return s - - unichr = chr - import struct - - int2byte = struct.Struct(">B").pack - del struct - byte2int = operator.itemgetter(0) - indexbytes = operator.getitem - iterbytes = iter - import io - - StringIO = io.StringIO - BytesIO = io.BytesIO - del io - _assertCountEqual = "assertCountEqual" - if sys.version_info[1] <= 1: - _assertRaisesRegex = "assertRaisesRegexp" - _assertRegex = "assertRegexpMatches" - _assertNotRegex = "assertNotRegexpMatches" - else: - _assertRaisesRegex = "assertRaisesRegex" - _assertRegex = "assertRegex" - _assertNotRegex = "assertNotRegex" -else: - - def b(s): - return s - - # Workaround for standalone backslash - - def u(s): - return unicode(s.replace(r"\\", r"\\\\"), "unicode_escape") - - unichr = unichr - int2byte = chr - - def byte2int(bs): - return ord(bs[0]) - - def indexbytes(buf, i): - return ord(buf[i]) - - iterbytes = functools.partial(itertools.imap, ord) - import StringIO - - StringIO = BytesIO = StringIO.StringIO - _assertCountEqual = "assertItemsEqual" - _assertRaisesRegex = "assertRaisesRegexp" - _assertRegex = "assertRegexpMatches" - _assertNotRegex = "assertNotRegexpMatches" -_add_doc(b, """Byte literal""") -_add_doc(u, """Text literal""") - - -def assertCountEqual(self, *args, **kwargs): - return getattr(self, _assertCountEqual)(*args, **kwargs) - - -def assertRaisesRegex(self, *args, **kwargs): - return getattr(self, _assertRaisesRegex)(*args, **kwargs) - - -def assertRegex(self, *args, **kwargs): - return getattr(self, _assertRegex)(*args, **kwargs) - - -def assertNotRegex(self, *args, **kwargs): - return getattr(self, _assertNotRegex)(*args, **kwargs) - - -if PY3: - exec_ = getattr(moves.builtins, "exec") - - def reraise(tp, value, tb=None): - try: - if value is None: - value = tp() - if value.__traceback__ is not tb: - raise value.with_traceback(tb) - raise value - finally: - value = None - tb = None - -else: - - def exec_(_code_, _globs_=None, _locs_=None): - """Execute code in a namespace.""" - if _globs_ is None: - frame = sys._getframe(1) - _globs_ = frame.f_globals - if _locs_ is None: - _locs_ = frame.f_locals - del frame - elif _locs_ is None: - _locs_ = _globs_ - exec ("""exec _code_ in _globs_, _locs_""") - - exec_( - """def reraise(tp, value, tb=None): - try: - raise tp, value, tb - finally: - tb = None -""" - ) - - -if sys.version_info[:2] > (3,): - exec_( - """def raise_from(value, from_value): - try: - raise value from from_value - finally: - value = None -""" - ) -else: - - def raise_from(value, from_value): - raise value - - -print_ = getattr(moves.builtins, "print", None) -if print_ is None: - - def print_(*args, **kwargs): - """The new-style print function for Python 2.4 and 2.5.""" - fp = kwargs.pop("file", sys.stdout) - if fp is None: - return - - def write(data): - if not isinstance(data, basestring): - data = str(data) - # If the file has an encoding, encode unicode with it. - if ( - isinstance(fp, file) - and isinstance(data, unicode) - and fp.encoding is not None - ): - errors = getattr(fp, "errors", None) - if errors is None: - errors = "strict" - data = data.encode(fp.encoding, errors) - fp.write(data) - - want_unicode = False - sep = kwargs.pop("sep", None) - if sep is not None: - if isinstance(sep, unicode): - want_unicode = True - elif not isinstance(sep, str): - raise TypeError("sep must be None or a string") - end = kwargs.pop("end", None) - if end is not None: - if isinstance(end, unicode): - want_unicode = True - elif not isinstance(end, str): - raise TypeError("end must be None or a string") - if kwargs: - raise TypeError("invalid keyword arguments to print()") - if not want_unicode: - for arg in args: - if isinstance(arg, unicode): - want_unicode = True - break - if want_unicode: - newline = unicode("\n") - space = unicode(" ") - else: - newline = "\n" - space = " " - if sep is None: - sep = space - if end is None: - end = newline - for i, arg in enumerate(args): - if i: - write(sep) - write(arg) - write(end) - - -if sys.version_info[:2] < (3, 3): - _print = print_ - - def print_(*args, **kwargs): - fp = kwargs.get("file", sys.stdout) - flush = kwargs.pop("flush", False) - _print(*args, **kwargs) - if flush and fp is not None: - fp.flush() - - -_add_doc(reraise, """Reraise an exception.""") - -if sys.version_info[0:2] < (3, 4): - # This does exactly the same what the :func:`py3:functools.update_wrapper` - # function does on Python versions after 3.2. It sets the ``__wrapped__`` - # attribute on ``wrapper`` object and it doesn't raise an error if any of - # the attributes mentioned in ``assigned`` and ``updated`` are missing on - # ``wrapped`` object. - def _update_wrapper( - wrapper, - wrapped, - assigned=functools.WRAPPER_ASSIGNMENTS, - updated=functools.WRAPPER_UPDATES, - ): - for attr in assigned: - try: - value = getattr(wrapped, attr) - except AttributeError: - continue - else: - setattr(wrapper, attr, value) - for attr in updated: - getattr(wrapper, attr).update(getattr(wrapped, attr, {})) - wrapper.__wrapped__ = wrapped - return wrapper - - _update_wrapper.__doc__ = functools.update_wrapper.__doc__ - - def wraps( - wrapped, - assigned=functools.WRAPPER_ASSIGNMENTS, - updated=functools.WRAPPER_UPDATES, - ): - return functools.partial( - _update_wrapper, wrapped=wrapped, assigned=assigned, updated=updated - ) - - wraps.__doc__ = functools.wraps.__doc__ - -else: - wraps = functools.wraps - - -def with_metaclass(meta, *bases): - """Create a base class with a metaclass.""" - # This requires a bit of explanation: the basic idea is to make a dummy - # metaclass for one level of class instantiation that replaces itself with - # the actual metaclass. - class metaclass(type): - def __new__(cls, name, this_bases, d): - if sys.version_info[:2] >= (3, 7): - # This version introduced PEP 560 that requires a bit - # of extra care (we mimic what is done by __build_class__). - resolved_bases = types.resolve_bases(bases) - if resolved_bases is not bases: - d["__orig_bases__"] = bases - else: - resolved_bases = bases - return meta(name, resolved_bases, d) - - @classmethod - def __prepare__(cls, name, this_bases): - return meta.__prepare__(name, bases) - - return type.__new__(metaclass, "temporary_class", (), {}) - - -def add_metaclass(metaclass): - """Class decorator for creating a class with a metaclass.""" - - def wrapper(cls): - orig_vars = cls.__dict__.copy() - slots = orig_vars.get("__slots__") - if slots is not None: - if isinstance(slots, str): - slots = [slots] - for slots_var in slots: - orig_vars.pop(slots_var) - orig_vars.pop("__dict__", None) - orig_vars.pop("__weakref__", None) - if hasattr(cls, "__qualname__"): - orig_vars["__qualname__"] = cls.__qualname__ - return metaclass(cls.__name__, cls.__bases__, orig_vars) - - return wrapper - - -def ensure_binary(s, encoding="utf-8", errors="strict"): - """Coerce **s** to six.binary_type. - - For Python 2: - - `unicode` -> encoded to `str` - - `str` -> `str` - - For Python 3: - - `str` -> encoded to `bytes` - - `bytes` -> `bytes` - """ - if isinstance(s, binary_type): - return s - if isinstance(s, text_type): - return s.encode(encoding, errors) - raise TypeError("not expecting type '%s'" % type(s)) - - -def ensure_str(s, encoding="utf-8", errors="strict"): - """Coerce *s* to `str`. - - For Python 2: - - `unicode` -> encoded to `str` - - `str` -> `str` - - For Python 3: - - `str` -> `str` - - `bytes` -> decoded to `str` - """ - # Optimization: Fast return for the common case. - if type(s) is str: - return s - if PY2 and isinstance(s, text_type): - return s.encode(encoding, errors) - elif PY3 and isinstance(s, binary_type): - return s.decode(encoding, errors) - elif not isinstance(s, (text_type, binary_type)): - raise TypeError("not expecting type '%s'" % type(s)) - return s - - -def ensure_text(s, encoding="utf-8", errors="strict"): - """Coerce *s* to six.text_type. - - For Python 2: - - `unicode` -> `unicode` - - `str` -> `unicode` - - For Python 3: - - `str` -> `str` - - `bytes` -> decoded to `str` - """ - if isinstance(s, binary_type): - return s.decode(encoding, errors) - elif isinstance(s, text_type): - return s - else: - raise TypeError("not expecting type '%s'" % type(s)) - - -def python_2_unicode_compatible(klass): - """ - A class decorator that defines __unicode__ and __str__ methods under Python 2. - Under Python 3 it does nothing. - - To support Python 2 and 3 with a single code base, define a __str__ method - returning text and apply this decorator to the class. - """ - if PY2: - if "__str__" not in klass.__dict__: - raise ValueError( - "@python_2_unicode_compatible cannot be applied " - "to %s because it doesn't define __str__()." % klass.__name__ - ) - klass.__unicode__ = klass.__str__ - klass.__str__ = lambda self: self.__unicode__().encode("utf-8") - return klass - - -# Complete the moves implementation. -# This code is at the end of this module to speed up module loading. -# Turn this module into a package. -__path__ = [] # required for PEP 302 and PEP 451 -__package__ = __name__ # see PEP 366 @ReservedAssignment -if globals().get("__spec__") is not None: - __spec__.submodule_search_locations = [] # PEP 451 @UndefinedVariable -# Remove other six meta path importers, since they cause problems. This can -# happen if six is removed from sys.modules and then reloaded. (Setuptools does -# this for some reason.) -if sys.meta_path: - for i, importer in enumerate(sys.meta_path): - # Here's some real nastiness: Another "instance" of the six module might - # be floating around. Therefore, we can't use isinstance() to check for - # the six meta path importer, since the other six instance will have - # inserted an importer with different class. - if ( - type(importer).__name__ == "_SixMetaPathImporter" - and importer.name == __name__ - ): - del sys.meta_path[i] - break - del i, importer -# Finally, add the importer to the meta path import hook. -sys.meta_path.append(_importer) diff --git a/newrelic/packages/urllib3/poolmanager.py b/newrelic/packages/urllib3/poolmanager.py index fb51bf7d96..28ec82f016 100644 --- a/newrelic/packages/urllib3/poolmanager.py +++ b/newrelic/packages/urllib3/poolmanager.py @@ -1,24 +1,33 @@ -from __future__ import absolute_import +from __future__ import annotations -import collections import functools import logging +import typing +import warnings +from types import TracebackType +from urllib.parse import urljoin from ._collections import HTTPHeaderDict, RecentlyUsedContainer +from ._request_methods import RequestMethods +from .connection import ProxyConfig from .connectionpool import HTTPConnectionPool, HTTPSConnectionPool, port_by_scheme from .exceptions import ( LocationValueError, MaxRetryError, ProxySchemeUnknown, - ProxySchemeUnsupported, URLSchemeUnknown, ) -from .packages import six -from .packages.six.moves.urllib.parse import urljoin -from .request import RequestMethods +from .response import BaseHTTPResponse +from .util.connection import _TYPE_SOCKET_OPTIONS from .util.proxy import connection_requires_http_tunnel from .util.retry import Retry -from .util.url import parse_url +from .util.timeout import Timeout +from .util.url import Url, parse_url + +if typing.TYPE_CHECKING: + import ssl + + from typing_extensions import Self __all__ = ["PoolManager", "ProxyManager", "proxy_from_url"] @@ -30,53 +39,62 @@ "cert_file", "cert_reqs", "ca_certs", + "ca_cert_data", "ssl_version", + "ssl_minimum_version", + "ssl_maximum_version", "ca_cert_dir", "ssl_context", "key_password", "server_hostname", ) +# Default value for `blocksize` - a new parameter introduced to +# http.client.HTTPConnection & http.client.HTTPSConnection in Python 3.7 +_DEFAULT_BLOCKSIZE = 16384 -# All known keyword arguments that could be provided to the pool manager, its -# pools, or the underlying connections. This is used to construct a pool key. -_key_fields = ( - "key_scheme", # str - "key_host", # str - "key_port", # int - "key_timeout", # int or float or Timeout - "key_retries", # int or Retry - "key_strict", # bool - "key_block", # bool - "key_source_address", # str - "key_key_file", # str - "key_key_password", # str - "key_cert_file", # str - "key_cert_reqs", # str - "key_ca_certs", # str - "key_ssl_version", # str - "key_ca_cert_dir", # str - "key_ssl_context", # instance of ssl.SSLContext or urllib3.util.ssl_.SSLContext - "key_maxsize", # int - "key_headers", # dict - "key__proxy", # parsed proxy url - "key__proxy_headers", # dict - "key__proxy_config", # class - "key_socket_options", # list of (level (int), optname (int), value (int or str)) tuples - "key__socks_options", # dict - "key_assert_hostname", # bool or string - "key_assert_fingerprint", # str - "key_server_hostname", # str -) - -#: The namedtuple class used to construct keys for the connection pool. -#: All custom key schemes should include the fields in this key at a minimum. -PoolKey = collections.namedtuple("PoolKey", _key_fields) -_proxy_config_fields = ("ssl_context", "use_forwarding_for_https") -ProxyConfig = collections.namedtuple("ProxyConfig", _proxy_config_fields) +class PoolKey(typing.NamedTuple): + """ + All known keyword arguments that could be provided to the pool manager, its + pools, or the underlying connections. + All custom key schemes should include the fields in this key at a minimum. + """ -def _default_key_normalizer(key_class, request_context): + key_scheme: str + key_host: str + key_port: int | None + key_timeout: Timeout | float | int | None + key_retries: Retry | bool | int | None + key_block: bool | None + key_source_address: tuple[str, int] | None + key_key_file: str | None + key_key_password: str | None + key_cert_file: str | None + key_cert_reqs: str | None + key_ca_certs: str | None + key_ca_cert_data: str | bytes | None + key_ssl_version: int | str | None + key_ssl_minimum_version: ssl.TLSVersion | None + key_ssl_maximum_version: ssl.TLSVersion | None + key_ca_cert_dir: str | None + key_ssl_context: ssl.SSLContext | None + key_maxsize: int | None + key_headers: frozenset[tuple[str, str]] | None + key__proxy: Url | None + key__proxy_headers: frozenset[tuple[str, str]] | None + key__proxy_config: ProxyConfig | None + key_socket_options: _TYPE_SOCKET_OPTIONS | None + key__socks_options: frozenset[tuple[str, str]] | None + key_assert_hostname: bool | str | None + key_assert_fingerprint: str | None + key_server_hostname: str | None + key_blocksize: int | None + + +def _default_key_normalizer( + key_class: type[PoolKey], request_context: dict[str, typing.Any] +) -> PoolKey: """ Create a pool key out of a request context dictionary. @@ -122,6 +140,10 @@ def _default_key_normalizer(key_class, request_context): if field not in context: context[field] = None + # Default key_blocksize to _DEFAULT_BLOCKSIZE if missing from the context + if context.get("key_blocksize") is None: + context["key_blocksize"] = _DEFAULT_BLOCKSIZE + return key_class(**context) @@ -154,23 +176,50 @@ class PoolManager(RequestMethods): Additional parameters are used to create fresh :class:`urllib3.connectionpool.ConnectionPool` instances. - Example:: + Example: + + .. code-block:: python + + import urllib3 + + http = urllib3.PoolManager(num_pools=2) - >>> manager = PoolManager(num_pools=2) - >>> r = manager.request('GET', 'http://google.com/') - >>> r = manager.request('GET', 'http://google.com/mail') - >>> r = manager.request('GET', 'http://yahoo.com/') - >>> len(manager.pools) - 2 + resp1 = http.request("GET", "https://google.com/") + resp2 = http.request("GET", "https://google.com/mail") + resp3 = http.request("GET", "https://yahoo.com/") + + print(len(http.pools)) + # 2 """ - proxy = None - proxy_config = None + proxy: Url | None = None + proxy_config: ProxyConfig | None = None - def __init__(self, num_pools=10, headers=None, **connection_pool_kw): - RequestMethods.__init__(self, headers) + def __init__( + self, + num_pools: int = 10, + headers: typing.Mapping[str, str] | None = None, + **connection_pool_kw: typing.Any, + ) -> None: + super().__init__(headers) + # PoolManager handles redirects itself in PoolManager.urlopen(). + # It always passes redirect=False to the underlying connection pool to + # suppress per-pool redirect handling. If the user supplied a non-Retry + # value (int/bool/etc) for retries and we let the pool normalize it + # while redirect=False, the resulting Retry object would have redirect + # handling disabled, which can interfere with PoolManager's own + # redirect logic. Normalize here so redirects remain governed solely by + # PoolManager logic. + if "retries" in connection_pool_kw: + retries = connection_pool_kw["retries"] + if not isinstance(retries, Retry): + retries = Retry.from_int(retries) + connection_pool_kw = connection_pool_kw.copy() + connection_pool_kw["retries"] = retries self.connection_pool_kw = connection_pool_kw + + self.pools: RecentlyUsedContainer[PoolKey, HTTPConnectionPool] self.pools = RecentlyUsedContainer(num_pools) # Locally set the pool classes and keys so other PoolManagers can @@ -178,15 +227,26 @@ def __init__(self, num_pools=10, headers=None, **connection_pool_kw): self.pool_classes_by_scheme = pool_classes_by_scheme self.key_fn_by_scheme = key_fn_by_scheme.copy() - def __enter__(self): + def __enter__(self) -> Self: return self - def __exit__(self, exc_type, exc_val, exc_tb): + def __exit__( + self, + exc_type: type[BaseException] | None, + exc_val: BaseException | None, + exc_tb: TracebackType | None, + ) -> typing.Literal[False]: self.clear() # Return False to re-raise any potential exceptions return False - def _new_pool(self, scheme, host, port, request_context=None): + def _new_pool( + self, + scheme: str, + host: str, + port: int, + request_context: dict[str, typing.Any] | None = None, + ) -> HTTPConnectionPool: """ Create a new :class:`urllib3.connectionpool.ConnectionPool` based on host, port, scheme, and any additional pool keyword arguments. @@ -196,10 +256,15 @@ def _new_pool(self, scheme, host, port, request_context=None): connection pools handed out by :meth:`connection_from_url` and companion methods. It is intended to be overridden for customization. """ - pool_cls = self.pool_classes_by_scheme[scheme] + pool_cls: type[HTTPConnectionPool] = self.pool_classes_by_scheme[scheme] if request_context is None: request_context = self.connection_pool_kw.copy() + # Default blocksize to _DEFAULT_BLOCKSIZE if missing or explicitly + # set to 'None' in the request_context. + if request_context.get("blocksize") is None: + request_context["blocksize"] = _DEFAULT_BLOCKSIZE + # Although the context has everything necessary to create the pool, # this function has historically only used the scheme, host, and port # in the positional args. When an API change is acceptable these can @@ -213,7 +278,7 @@ def _new_pool(self, scheme, host, port, request_context=None): return pool_cls(host, port, **request_context) - def clear(self): + def clear(self) -> None: """ Empty our store of pools and direct them all to close. @@ -222,7 +287,13 @@ def clear(self): """ self.pools.clear() - def connection_from_host(self, host, port=None, scheme="http", pool_kwargs=None): + def connection_from_host( + self, + host: str | None, + port: int | None = None, + scheme: str | None = "http", + pool_kwargs: dict[str, typing.Any] | None = None, + ) -> HTTPConnectionPool: """ Get a :class:`urllib3.connectionpool.ConnectionPool` based on the host, port, and scheme. @@ -245,13 +316,23 @@ def connection_from_host(self, host, port=None, scheme="http", pool_kwargs=None) return self.connection_from_context(request_context) - def connection_from_context(self, request_context): + def connection_from_context( + self, request_context: dict[str, typing.Any] + ) -> HTTPConnectionPool: """ Get a :class:`urllib3.connectionpool.ConnectionPool` based on the request context. ``request_context`` must at least contain the ``scheme`` key and its value must be a key in ``key_fn_by_scheme`` instance variable. """ + if "strict" in request_context: + warnings.warn( + "The 'strict' parameter is no longer needed on Python 3+. " + "This will raise an error in urllib3 v2.1.0.", + DeprecationWarning, + ) + request_context.pop("strict") + scheme = request_context["scheme"].lower() pool_key_constructor = self.key_fn_by_scheme.get(scheme) if not pool_key_constructor: @@ -260,7 +341,9 @@ def connection_from_context(self, request_context): return self.connection_from_pool_key(pool_key, request_context=request_context) - def connection_from_pool_key(self, pool_key, request_context=None): + def connection_from_pool_key( + self, pool_key: PoolKey, request_context: dict[str, typing.Any] + ) -> HTTPConnectionPool: """ Get a :class:`urllib3.connectionpool.ConnectionPool` based on the provided pool key. @@ -284,7 +367,9 @@ def connection_from_pool_key(self, pool_key, request_context=None): return pool - def connection_from_url(self, url, pool_kwargs=None): + def connection_from_url( + self, url: str, pool_kwargs: dict[str, typing.Any] | None = None + ) -> HTTPConnectionPool: """ Similar to :func:`urllib3.connectionpool.connection_from_url`. @@ -300,7 +385,9 @@ def connection_from_url(self, url, pool_kwargs=None): u.host, port=u.port, scheme=u.scheme, pool_kwargs=pool_kwargs ) - def _merge_pool_kwargs(self, override): + def _merge_pool_kwargs( + self, override: dict[str, typing.Any] | None + ) -> dict[str, typing.Any]: """ Merge a dictionary of override values for self.connection_pool_kw. @@ -320,7 +407,7 @@ def _merge_pool_kwargs(self, override): base_pool_kwargs[key] = value return base_pool_kwargs - def _proxy_requires_url_absolute_form(self, parsed_url): + def _proxy_requires_url_absolute_form(self, parsed_url: Url) -> bool: """ Indicates if the proxy requires the complete destination URL in the request. Normally this is only needed when not using an HTTP CONNECT @@ -333,24 +420,9 @@ def _proxy_requires_url_absolute_form(self, parsed_url): self.proxy, self.proxy_config, parsed_url.scheme ) - def _validate_proxy_scheme_url_selection(self, url_scheme): - """ - Validates that were not attempting to do TLS in TLS connections on - Python2 or with unsupported SSL implementations. - """ - if self.proxy is None or url_scheme != "https": - return - - if self.proxy.scheme != "https": - return - - if six.PY2 and not self.proxy_config.use_forwarding_for_https: - raise ProxySchemeUnsupported( - "Contacting HTTPS destinations through HTTPS proxies " - "'via CONNECT tunnels' is not supported in Python 2" - ) - - def urlopen(self, method, url, redirect=True, **kw): + def urlopen( # type: ignore[override] + self, method: str, url: str, redirect: bool = True, **kw: typing.Any + ) -> BaseHTTPResponse: """ Same as :meth:`urllib3.HTTPConnectionPool.urlopen` with custom cross-host redirect logic and only sends the request-uri @@ -360,7 +432,16 @@ def urlopen(self, method, url, redirect=True, **kw): :class:`urllib3.connectionpool.ConnectionPool` can be chosen for it. """ u = parse_url(url) - self._validate_proxy_scheme_url_selection(u.scheme) + + if u.scheme is None: + warnings.warn( + "URLs without a scheme (ie 'https://') are deprecated and will raise an error " + "in a future version of urllib3. To avoid this DeprecationWarning ensure all URLs " + "start with 'https://' or 'http://'. Read more in this issue: " + "https://github.com/urllib3/urllib3/issues/2920", + category=DeprecationWarning, + stacklevel=2, + ) conn = self.connection_from_host(u.host, port=u.port, scheme=u.scheme) @@ -368,7 +449,7 @@ def urlopen(self, method, url, redirect=True, **kw): kw["redirect"] = False if "headers" not in kw: - kw["headers"] = self.headers.copy() + kw["headers"] = self.headers if self._proxy_requires_url_absolute_form(u): response = conn.urlopen(method, url, **kw) @@ -389,7 +470,7 @@ def urlopen(self, method, url, redirect=True, **kw): kw["body"] = None kw["headers"] = HTTPHeaderDict(kw["headers"])._prepare_for_method_change() - retries = kw.get("retries") + retries = kw.get("retries", response.retries) if not isinstance(retries, Retry): retries = Retry.from_int(retries, redirect=redirect) @@ -399,10 +480,11 @@ def urlopen(self, method, url, redirect=True, **kw): if retries.remove_headers_on_redirect and not conn.is_same_host( redirect_location ): - headers = list(six.iterkeys(kw["headers"])) - for header in headers: + new_headers = kw["headers"].copy() + for header in kw["headers"]: if header.lower() in retries.remove_headers_on_redirect: - kw["headers"].pop(header, None) + new_headers.pop(header, None) + kw["headers"] = new_headers try: retries = retries.increment(method, url, response=response, _pool=conn) @@ -448,37 +530,51 @@ class ProxyManager(PoolManager): private. IP address, target hostname, SNI, and port are always visible to an HTTPS proxy even when this flag is disabled. + :param proxy_assert_hostname: + The hostname of the certificate to verify against. + + :param proxy_assert_fingerprint: + The fingerprint of the certificate to verify against. + Example: - >>> proxy = urllib3.ProxyManager('http://localhost:3128/') - >>> r1 = proxy.request('GET', 'http://google.com/') - >>> r2 = proxy.request('GET', 'http://httpbin.org/') - >>> len(proxy.pools) - 1 - >>> r3 = proxy.request('GET', 'https://httpbin.org/') - >>> r4 = proxy.request('GET', 'https://twitter.com/') - >>> len(proxy.pools) - 3 + + .. code-block:: python + + import urllib3 + + proxy = urllib3.ProxyManager("https://localhost:3128/") + + resp1 = proxy.request("GET", "https://google.com/") + resp2 = proxy.request("GET", "https://httpbin.org/") + + print(len(proxy.pools)) + # 1 + + resp3 = proxy.request("GET", "https://httpbin.org/") + resp4 = proxy.request("GET", "https://twitter.com/") + + print(len(proxy.pools)) + # 3 """ def __init__( self, - proxy_url, - num_pools=10, - headers=None, - proxy_headers=None, - proxy_ssl_context=None, - use_forwarding_for_https=False, - **connection_pool_kw - ): - + proxy_url: str, + num_pools: int = 10, + headers: typing.Mapping[str, str] | None = None, + proxy_headers: typing.Mapping[str, str] | None = None, + proxy_ssl_context: ssl.SSLContext | None = None, + use_forwarding_for_https: bool = False, + proxy_assert_hostname: None | str | typing.Literal[False] = None, + proxy_assert_fingerprint: str | None = None, + **connection_pool_kw: typing.Any, + ) -> None: if isinstance(proxy_url, HTTPConnectionPool): - proxy_url = "%s://%s:%i" % ( - proxy_url.scheme, - proxy_url.host, - proxy_url.port, - ) - proxy = parse_url(proxy_url) + str_proxy_url = f"{proxy_url.scheme}://{proxy_url.host}:{proxy_url.port}" + else: + str_proxy_url = proxy_url + proxy = parse_url(str_proxy_url) if proxy.scheme not in ("http", "https"): raise ProxySchemeUnknown(proxy.scheme) @@ -490,25 +586,38 @@ def __init__( self.proxy = proxy self.proxy_headers = proxy_headers or {} self.proxy_ssl_context = proxy_ssl_context - self.proxy_config = ProxyConfig(proxy_ssl_context, use_forwarding_for_https) + self.proxy_config = ProxyConfig( + proxy_ssl_context, + use_forwarding_for_https, + proxy_assert_hostname, + proxy_assert_fingerprint, + ) connection_pool_kw["_proxy"] = self.proxy connection_pool_kw["_proxy_headers"] = self.proxy_headers connection_pool_kw["_proxy_config"] = self.proxy_config - super(ProxyManager, self).__init__(num_pools, headers, **connection_pool_kw) + super().__init__(num_pools, headers, **connection_pool_kw) - def connection_from_host(self, host, port=None, scheme="http", pool_kwargs=None): + def connection_from_host( + self, + host: str | None, + port: int | None = None, + scheme: str | None = "http", + pool_kwargs: dict[str, typing.Any] | None = None, + ) -> HTTPConnectionPool: if scheme == "https": - return super(ProxyManager, self).connection_from_host( + return super().connection_from_host( host, port, scheme, pool_kwargs=pool_kwargs ) - return super(ProxyManager, self).connection_from_host( - self.proxy.host, self.proxy.port, self.proxy.scheme, pool_kwargs=pool_kwargs + return super().connection_from_host( + self.proxy.host, self.proxy.port, self.proxy.scheme, pool_kwargs=pool_kwargs # type: ignore[union-attr] ) - def _set_proxy_headers(self, url, headers=None): + def _set_proxy_headers( + self, url: str, headers: typing.Mapping[str, str] | None = None + ) -> typing.Mapping[str, str]: """ Sets headers needed by proxies: specifically, the Accept and Host headers. Only sets headers not provided by the user. @@ -523,7 +632,9 @@ def _set_proxy_headers(self, url, headers=None): headers_.update(headers) return headers_ - def urlopen(self, method, url, redirect=True, **kw): + def urlopen( # type: ignore[override] + self, method: str, url: str, redirect: bool = True, **kw: typing.Any + ) -> BaseHTTPResponse: "Same as HTTP(S)ConnectionPool.urlopen, ``url`` must be absolute." u = parse_url(url) if not connection_requires_http_tunnel(self.proxy, self.proxy_config, u.scheme): @@ -533,8 +644,8 @@ def urlopen(self, method, url, redirect=True, **kw): headers = kw.get("headers", self.headers) kw["headers"] = self._set_proxy_headers(url, headers) - return super(ProxyManager, self).urlopen(method, url, redirect=redirect, **kw) + return super().urlopen(method, url, redirect=redirect, **kw) -def proxy_from_url(url, **kw): +def proxy_from_url(url: str, **kw: typing.Any) -> ProxyManager: return ProxyManager(proxy_url=url, **kw) diff --git a/newrelic/packages/urllib3/py.typed b/newrelic/packages/urllib3/py.typed new file mode 100644 index 0000000000..5f3ea3d919 --- /dev/null +++ b/newrelic/packages/urllib3/py.typed @@ -0,0 +1,2 @@ +# Instruct type checkers to look for inline type annotations in this package. +# See PEP 561. diff --git a/newrelic/packages/urllib3/response.py b/newrelic/packages/urllib3/response.py index 0bd13d40b8..ff6d1f4911 100644 --- a/newrelic/packages/urllib3/response.py +++ b/newrelic/packages/urllib3/response.py @@ -1,28 +1,38 @@ -from __future__ import absolute_import +from __future__ import annotations +import collections import io +import json as _json import logging +import socket import sys +import typing import warnings import zlib from contextlib import contextmanager -from socket import error as SocketError +from http.client import HTTPMessage as _HttplibHTTPMessage +from http.client import HTTPResponse as _HttplibHTTPResponse from socket import timeout as SocketTimeout +if typing.TYPE_CHECKING: + from ._base_connection import BaseHTTPConnection + try: try: - import brotlicffi as brotli + import brotlicffi as brotli # type: ignore[import-not-found] except ImportError: - import brotli + import brotli # type: ignore[import-not-found] except ImportError: brotli = None from . import util +from ._base_connection import _TYPE_BODY from ._collections import HTTPHeaderDict -from .connection import BaseSSLError, HTTPException +from .connection import BaseSSLError, HTTPConnection, HTTPException from .exceptions import ( BodyNotHttplibCompatible, DecodeError, + DependencyWarning, HTTPError, IncompleteRead, InvalidChunkLength, @@ -32,101 +42,262 @@ ResponseNotChunked, SSLError, ) -from .packages import six from .util.response import is_fp_closed, is_response_to_head +from .util.retry import Retry + +if typing.TYPE_CHECKING: + from .connectionpool import HTTPConnectionPool log = logging.getLogger(__name__) -class DeflateDecoder(object): - def __init__(self): +class ContentDecoder: + def decompress(self, data: bytes, max_length: int = -1) -> bytes: + raise NotImplementedError() + + @property + def has_unconsumed_tail(self) -> bool: + raise NotImplementedError() + + def flush(self) -> bytes: + raise NotImplementedError() + + +class DeflateDecoder(ContentDecoder): + def __init__(self) -> None: self._first_try = True - self._data = b"" + self._first_try_data = b"" + self._unfed_data = b"" self._obj = zlib.decompressobj() - def __getattr__(self, name): - return getattr(self._obj, name) - - def decompress(self, data): - if not data: + def decompress(self, data: bytes, max_length: int = -1) -> bytes: + data = self._unfed_data + data + self._unfed_data = b"" + if not data and not self._obj.unconsumed_tail: return data + original_max_length = max_length + if original_max_length < 0: + max_length = 0 + elif original_max_length == 0: + # We should not pass 0 to the zlib decompressor because 0 is + # the default value that will make zlib decompress without a + # length limit. + # Data should be stored for subsequent calls. + self._unfed_data = data + return b"" + # Subsequent calls always reuse `self._obj`. zlib requires + # passing the unconsumed tail if decompression is to continue. if not self._first_try: - return self._obj.decompress(data) + return self._obj.decompress( + self._obj.unconsumed_tail + data, max_length=max_length + ) - self._data += data + # First call tries with RFC 1950 ZLIB format. + self._first_try_data += data try: - decompressed = self._obj.decompress(data) + decompressed = self._obj.decompress(data, max_length=max_length) if decompressed: self._first_try = False - self._data = None + self._first_try_data = b"" return decompressed + # On failure, it falls back to RFC 1951 DEFLATE format. except zlib.error: self._first_try = False self._obj = zlib.decompressobj(-zlib.MAX_WBITS) try: - return self.decompress(self._data) + return self.decompress( + self._first_try_data, max_length=original_max_length + ) finally: - self._data = None + self._first_try_data = b"" + @property + def has_unconsumed_tail(self) -> bool: + return bool(self._unfed_data) or ( + bool(self._obj.unconsumed_tail) and not self._first_try + ) -class GzipDecoderState(object): + def flush(self) -> bytes: + return self._obj.flush() + +class GzipDecoderState: FIRST_MEMBER = 0 OTHER_MEMBERS = 1 SWALLOW_DATA = 2 -class GzipDecoder(object): - def __init__(self): +class GzipDecoder(ContentDecoder): + def __init__(self) -> None: self._obj = zlib.decompressobj(16 + zlib.MAX_WBITS) self._state = GzipDecoderState.FIRST_MEMBER + self._unconsumed_tail = b"" - def __getattr__(self, name): - return getattr(self._obj, name) - - def decompress(self, data): + def decompress(self, data: bytes, max_length: int = -1) -> bytes: ret = bytearray() - if self._state == GzipDecoderState.SWALLOW_DATA or not data: + if self._state == GzipDecoderState.SWALLOW_DATA: + return bytes(ret) + + if max_length == 0: + # We should not pass 0 to the zlib decompressor because 0 is + # the default value that will make zlib decompress without a + # length limit. + # Data should be stored for subsequent calls. + self._unconsumed_tail += data + return b"" + + # zlib requires passing the unconsumed tail to the subsequent + # call if decompression is to continue. + data = self._unconsumed_tail + data + if not data and self._obj.eof: return bytes(ret) + while True: try: - ret += self._obj.decompress(data) + ret += self._obj.decompress( + data, max_length=max(max_length - len(ret), 0) + ) except zlib.error: previous_state = self._state # Ignore data after the first error self._state = GzipDecoderState.SWALLOW_DATA + self._unconsumed_tail = b"" if previous_state == GzipDecoderState.OTHER_MEMBERS: # Allow trailing garbage acceptable in other gzip clients return bytes(ret) raise - data = self._obj.unused_data + + self._unconsumed_tail = data = ( + self._obj.unconsumed_tail or self._obj.unused_data + ) + if max_length > 0 and len(ret) >= max_length: + break + if not data: return bytes(ret) - self._state = GzipDecoderState.OTHER_MEMBERS - self._obj = zlib.decompressobj(16 + zlib.MAX_WBITS) + # When the end of a gzip member is reached, a new decompressor + # must be created for unused (possibly future) data. + if self._obj.eof: + self._state = GzipDecoderState.OTHER_MEMBERS + self._obj = zlib.decompressobj(16 + zlib.MAX_WBITS) + + return bytes(ret) + + @property + def has_unconsumed_tail(self) -> bool: + return bool(self._unconsumed_tail) + + def flush(self) -> bytes: + return self._obj.flush() if brotli is not None: - class BrotliDecoder(object): + class BrotliDecoder(ContentDecoder): # Supports both 'brotlipy' and 'Brotli' packages # since they share an import name. The top branches # are for 'brotlipy' and bottom branches for 'Brotli' - def __init__(self): + def __init__(self) -> None: self._obj = brotli.Decompressor() if hasattr(self._obj, "decompress"): - self.decompress = self._obj.decompress + setattr(self, "_decompress", self._obj.decompress) else: - self.decompress = self._obj.process + setattr(self, "_decompress", self._obj.process) + + # Requires Brotli >= 1.2.0 for `output_buffer_limit`. + def _decompress(self, data: bytes, output_buffer_limit: int = -1) -> bytes: + raise NotImplementedError() + + def decompress(self, data: bytes, max_length: int = -1) -> bytes: + try: + if max_length > 0: + return self._decompress(data, output_buffer_limit=max_length) + else: + return self._decompress(data) + except TypeError: + # Fallback for Brotli/brotlicffi/brotlipy versions without + # the `output_buffer_limit` parameter. + warnings.warn( + "Brotli >= 1.2.0 is required to prevent decompression bombs.", + DependencyWarning, + ) + return self._decompress(data) + + @property + def has_unconsumed_tail(self) -> bool: + try: + return not self._obj.can_accept_more_data() + except AttributeError: + return False - def flush(self): + def flush(self) -> bytes: if hasattr(self._obj, "flush"): - return self._obj.flush() + return self._obj.flush() # type: ignore[no-any-return] + return b"" + + +try: + if sys.version_info >= (3, 14): + from compression import zstd + else: + from backports import zstd +except ImportError: + HAS_ZSTD = False +else: + HAS_ZSTD = True + + class ZstdDecoder(ContentDecoder): + def __init__(self) -> None: + self._obj = zstd.ZstdDecompressor() + + def decompress(self, data: bytes, max_length: int = -1) -> bytes: + if not data and not self.has_unconsumed_tail: + return b"" + if self._obj.eof: + data = self._obj.unused_data + data + self._obj = zstd.ZstdDecompressor() + part = self._obj.decompress(data, max_length=max_length) + length = len(part) + data_parts = [part] + # Every loop iteration is supposed to read data from a separate frame. + # The loop breaks when: + # - enough data is read; + # - no more unused data is available; + # - end of the last read frame has not been reached (i.e., + # more data has to be fed). + while ( + self._obj.eof + and self._obj.unused_data + and (max_length < 0 or length < max_length) + ): + unused_data = self._obj.unused_data + if not self._obj.needs_input: + self._obj = zstd.ZstdDecompressor() + part = self._obj.decompress( + unused_data, + max_length=(max_length - length) if max_length > 0 else -1, + ) + if part_length := len(part): + data_parts.append(part) + length += part_length + elif self._obj.needs_input: + break + return b"".join(data_parts) + + @property + def has_unconsumed_tail(self) -> bool: + return not (self._obj.needs_input or self._obj.eof) or bool( + self._obj.unused_data + ) + + def flush(self) -> bytes: + if not self._obj.eof: + raise DecodeError("Zstandard data is incomplete") return b"" -class MultiDecoder(object): +class MultiDecoder(ContentDecoder): """ From RFC7231: If one or more encodings have been applied to a representation, the @@ -135,32 +306,387 @@ class MultiDecoder(object): they were applied. """ - def __init__(self, modes): - self._decoders = [_get_decoder(m.strip()) for m in modes.split(",")] + # Maximum allowed number of chained HTTP encodings in the + # Content-Encoding header. + max_decode_links = 5 + + def __init__(self, modes: str) -> None: + encodings = [m.strip() for m in modes.split(",")] + if len(encodings) > self.max_decode_links: + raise DecodeError( + "Too many content encodings in the chain: " + f"{len(encodings)} > {self.max_decode_links}" + ) + self._decoders = [_get_decoder(e) for e in encodings] - def flush(self): + def flush(self) -> bytes: return self._decoders[0].flush() - def decompress(self, data): - for d in reversed(self._decoders): - data = d.decompress(data) - return data + def decompress(self, data: bytes, max_length: int = -1) -> bytes: + if max_length <= 0: + for d in reversed(self._decoders): + data = d.decompress(data) + return data + + ret = bytearray() + # Every while loop iteration goes through all decoders once. + # It exits when enough data is read or no more data can be read. + # It is possible that the while loop iteration does not produce + # any data because we retrieve up to `max_length` from every + # decoder, and the amount of bytes may be insufficient for the + # next decoder to produce enough/any output. + while True: + any_data = False + for d in reversed(self._decoders): + data = d.decompress(data, max_length=max_length - len(ret)) + if data: + any_data = True + # We should not break when no data is returned because + # next decoders may produce data even with empty input. + ret += data + if not any_data or len(ret) >= max_length: + return bytes(ret) + data = b"" + + @property + def has_unconsumed_tail(self) -> bool: + return any(d.has_unconsumed_tail for d in self._decoders) -def _get_decoder(mode): +def _get_decoder(mode: str) -> ContentDecoder: if "," in mode: return MultiDecoder(mode) - if mode == "gzip": + # According to RFC 9110 section 8.4.1.3, recipients should + # consider x-gzip equivalent to gzip + if mode in ("gzip", "x-gzip"): return GzipDecoder() if brotli is not None and mode == "br": return BrotliDecoder() + if HAS_ZSTD and mode == "zstd": + return ZstdDecoder() + return DeflateDecoder() -class HTTPResponse(io.IOBase): +class BytesQueueBuffer: + """Memory-efficient bytes buffer + + To return decoded data in read() and still follow the BufferedIOBase API, we need a + buffer to always return the correct amount of bytes. + + This buffer should be filled using calls to put() + + Our maximum memory usage is determined by the sum of the size of: + + * self.buffer, which contains the full data + * the largest chunk that we will copy in get() + """ + + def __init__(self) -> None: + self.buffer: typing.Deque[bytes | memoryview[bytes]] = collections.deque() + self._size: int = 0 + + def __len__(self) -> int: + return self._size + + def put(self, data: bytes) -> None: + self.buffer.append(data) + self._size += len(data) + + def get(self, n: int) -> bytes: + if n == 0: + return b"" + elif not self.buffer: + raise RuntimeError("buffer is empty") + elif n < 0: + raise ValueError("n should be > 0") + + if len(self.buffer[0]) == n and isinstance(self.buffer[0], bytes): + self._size -= n + return self.buffer.popleft() + + fetched = 0 + ret = io.BytesIO() + while fetched < n: + remaining = n - fetched + chunk = self.buffer.popleft() + chunk_length = len(chunk) + if remaining < chunk_length: + chunk = memoryview(chunk) + left_chunk, right_chunk = chunk[:remaining], chunk[remaining:] + ret.write(left_chunk) + self.buffer.appendleft(right_chunk) + self._size -= remaining + break + else: + ret.write(chunk) + self._size -= chunk_length + fetched += chunk_length + + if not self.buffer: + break + + return ret.getvalue() + + def get_all(self) -> bytes: + buffer = self.buffer + if not buffer: + assert self._size == 0 + return b"" + if len(buffer) == 1: + result = buffer.pop() + if isinstance(result, memoryview): + result = result.tobytes() + else: + ret = io.BytesIO() + ret.writelines(buffer.popleft() for _ in range(len(buffer))) + result = ret.getvalue() + self._size = 0 + return result + + +class BaseHTTPResponse(io.IOBase): + CONTENT_DECODERS = ["gzip", "x-gzip", "deflate"] + if brotli is not None: + CONTENT_DECODERS += ["br"] + if HAS_ZSTD: + CONTENT_DECODERS += ["zstd"] + REDIRECT_STATUSES = [301, 302, 303, 307, 308] + + DECODER_ERROR_CLASSES: tuple[type[Exception], ...] = (IOError, zlib.error) + if brotli is not None: + DECODER_ERROR_CLASSES += (brotli.error,) + + if HAS_ZSTD: + DECODER_ERROR_CLASSES += (zstd.ZstdError,) + + def __init__( + self, + *, + headers: typing.Mapping[str, str] | typing.Mapping[bytes, bytes] | None = None, + status: int, + version: int, + version_string: str, + reason: str | None, + decode_content: bool, + request_url: str | None, + retries: Retry | None = None, + ) -> None: + if isinstance(headers, HTTPHeaderDict): + self.headers = headers + else: + self.headers = HTTPHeaderDict(headers) # type: ignore[arg-type] + self.status = status + self.version = version + self.version_string = version_string + self.reason = reason + self.decode_content = decode_content + self._has_decoded_content = False + self._request_url: str | None = request_url + self.retries = retries + + self.chunked = False + tr_enc = self.headers.get("transfer-encoding", "").lower() + # Don't incur the penalty of creating a list and then discarding it + encodings = (enc.strip() for enc in tr_enc.split(",")) + if "chunked" in encodings: + self.chunked = True + + self._decoder: ContentDecoder | None = None + self.length_remaining: int | None + + def get_redirect_location(self) -> str | None | typing.Literal[False]: + """ + Should we redirect and where to? + + :returns: Truthy redirect location string if we got a redirect status + code and valid location. ``None`` if redirect status and no + location. ``False`` if not a redirect status code. + """ + if self.status in self.REDIRECT_STATUSES: + return self.headers.get("location") + return False + + @property + def data(self) -> bytes: + raise NotImplementedError() + + def json(self) -> typing.Any: + """ + Deserializes the body of the HTTP response as a Python object. + + The body of the HTTP response must be encoded using UTF-8, as per + `RFC 8529 Section 8.1 `_. + + To use a custom JSON decoder pass the result of :attr:`HTTPResponse.data` to + your custom decoder instead. + + If the body of the HTTP response is not decodable to UTF-8, a + `UnicodeDecodeError` will be raised. If the body of the HTTP response is not a + valid JSON document, a `json.JSONDecodeError` will be raised. + + Read more :ref:`here `. + + :returns: The body of the HTTP response as a Python object. + """ + data = self.data.decode("utf-8") + return _json.loads(data) + + @property + def url(self) -> str | None: + raise NotImplementedError() + + @url.setter + def url(self, url: str | None) -> None: + raise NotImplementedError() + + @property + def connection(self) -> BaseHTTPConnection | None: + raise NotImplementedError() + + @property + def retries(self) -> Retry | None: + return self._retries + + @retries.setter + def retries(self, retries: Retry | None) -> None: + # Override the request_url if retries has a redirect location. + if retries is not None and retries.history: + self.url = retries.history[-1].redirect_location + self._retries = retries + + def stream( + self, amt: int | None = 2**16, decode_content: bool | None = None + ) -> typing.Iterator[bytes]: + raise NotImplementedError() + + def read( + self, + amt: int | None = None, + decode_content: bool | None = None, + cache_content: bool = False, + ) -> bytes: + raise NotImplementedError() + + def read1( + self, + amt: int | None = None, + decode_content: bool | None = None, + ) -> bytes: + raise NotImplementedError() + + def read_chunked( + self, + amt: int | None = None, + decode_content: bool | None = None, + ) -> typing.Iterator[bytes]: + raise NotImplementedError() + + def release_conn(self) -> None: + raise NotImplementedError() + + def drain_conn(self) -> None: + raise NotImplementedError() + + def shutdown(self) -> None: + raise NotImplementedError() + + def close(self) -> None: + raise NotImplementedError() + + def _init_decoder(self) -> None: + """ + Set-up the _decoder attribute if necessary. + """ + # Note: content-encoding value should be case-insensitive, per RFC 7230 + # Section 3.2 + content_encoding = self.headers.get("content-encoding", "").lower() + if self._decoder is None: + if content_encoding in self.CONTENT_DECODERS: + self._decoder = _get_decoder(content_encoding) + elif "," in content_encoding: + encodings = [ + e.strip() + for e in content_encoding.split(",") + if e.strip() in self.CONTENT_DECODERS + ] + if encodings: + self._decoder = _get_decoder(content_encoding) + + def _decode( + self, + data: bytes, + decode_content: bool | None, + flush_decoder: bool, + max_length: int | None = None, + ) -> bytes: + """ + Decode the data passed in and potentially flush the decoder. + """ + if not decode_content: + if self._has_decoded_content: + raise RuntimeError( + "Calling read(decode_content=False) is not supported after " + "read(decode_content=True) was called." + ) + return data + + if max_length is None or flush_decoder: + max_length = -1 + + try: + if self._decoder: + data = self._decoder.decompress(data, max_length=max_length) + self._has_decoded_content = True + except self.DECODER_ERROR_CLASSES as e: + content_encoding = self.headers.get("content-encoding", "").lower() + raise DecodeError( + "Received response with content-encoding: %s, but " + "failed to decode it." % content_encoding, + e, + ) from e + if flush_decoder: + data += self._flush_decoder() + + return data + + def _flush_decoder(self) -> bytes: + """ + Flushes the decoder. Should only be called if the decoder is actually + being used. + """ + if self._decoder: + return self._decoder.decompress(b"") + self._decoder.flush() + return b"" + + # Compatibility methods for `io` module + def readinto(self, b: bytearray) -> int: + temp = self.read(len(b)) + if len(temp) == 0: + return 0 + else: + b[: len(temp)] = temp + return len(temp) + + # Methods used by dependent libraries + def getheaders(self) -> HTTPHeaderDict: + return self.headers + + def getheader(self, name: str, default: str | None = None) -> str | None: + return self.headers.get(name, default) + + # Compatibility method for http.cookiejar + def info(self) -> HTTPHeaderDict: + return self.headers + + def geturl(self) -> str | None: + return self.url + + +class HTTPResponse(BaseHTTPResponse): """ HTTP Response container. @@ -193,126 +719,111 @@ class is also compatible with the Python standard library's :mod:`io` value of Content-Length header, if present. Otherwise, raise error. """ - CONTENT_DECODERS = ["gzip", "deflate"] - if brotli is not None: - CONTENT_DECODERS += ["br"] - REDIRECT_STATUSES = [301, 302, 303, 307, 308] - def __init__( self, - body="", - headers=None, - status=0, - version=0, - reason=None, - strict=0, - preload_content=True, - decode_content=True, - original_response=None, - pool=None, - connection=None, - msg=None, - retries=None, - enforce_content_length=False, - request_method=None, - request_url=None, - auto_close=True, - ): + body: _TYPE_BODY = "", + headers: typing.Mapping[str, str] | typing.Mapping[bytes, bytes] | None = None, + status: int = 0, + version: int = 0, + version_string: str = "HTTP/?", + reason: str | None = None, + preload_content: bool = True, + decode_content: bool = True, + original_response: _HttplibHTTPResponse | None = None, + pool: HTTPConnectionPool | None = None, + connection: HTTPConnection | None = None, + msg: _HttplibHTTPMessage | None = None, + retries: Retry | None = None, + enforce_content_length: bool = True, + request_method: str | None = None, + request_url: str | None = None, + auto_close: bool = True, + sock_shutdown: typing.Callable[[int], None] | None = None, + ) -> None: + super().__init__( + headers=headers, + status=status, + version=version, + version_string=version_string, + reason=reason, + decode_content=decode_content, + request_url=request_url, + retries=retries, + ) - if isinstance(headers, HTTPHeaderDict): - self.headers = headers - else: - self.headers = HTTPHeaderDict(headers) - self.status = status - self.version = version - self.reason = reason - self.strict = strict - self.decode_content = decode_content - self.retries = retries self.enforce_content_length = enforce_content_length self.auto_close = auto_close - self._decoder = None self._body = None - self._fp = None + self._fp: _HttplibHTTPResponse | None = None self._original_response = original_response self._fp_bytes_read = 0 self.msg = msg - self._request_url = request_url - if body and isinstance(body, (six.string_types, bytes)): + if body and isinstance(body, (str, bytes)): self._body = body self._pool = pool self._connection = connection if hasattr(body, "read"): - self._fp = body + self._fp = body # type: ignore[assignment] + self._sock_shutdown = sock_shutdown # Are we using the chunked-style of transfer encoding? - self.chunked = False - self.chunk_left = None - tr_enc = self.headers.get("transfer-encoding", "").lower() - # Don't incur the penalty of creating a list and then discarding it - encodings = (enc.strip() for enc in tr_enc.split(",")) - if "chunked" in encodings: - self.chunked = True + self.chunk_left: int | None = None # Determine length of response self.length_remaining = self._init_length(request_method) + # Used to return the correct amount of bytes for partial read()s + self._decoded_buffer = BytesQueueBuffer() + # If requested, preload the body. if preload_content and not self._body: self._body = self.read(decode_content=decode_content) - def get_redirect_location(self): - """ - Should we redirect and where to? - - :returns: Truthy redirect location string if we got a redirect status - code and valid location. ``None`` if redirect status and no - location. ``False`` if not a redirect status code. - """ - if self.status in self.REDIRECT_STATUSES: - return self.headers.get("location") - - return False - - def release_conn(self): + def release_conn(self) -> None: if not self._pool or not self._connection: - return + return None self._pool._put_conn(self._connection) self._connection = None - def drain_conn(self): + def drain_conn(self) -> None: """ Read and discard any remaining HTTP response data in the response connection. Unread data in the HTTPResponse connection blocks the connection from being released back to the pool. """ try: - self.read() - except (HTTPError, SocketError, BaseSSLError, HTTPException): + self.read( + # Do not spend resources decoding the content unless + # decoding has already been initiated. + decode_content=self._has_decoded_content, + ) + except (HTTPError, OSError, BaseSSLError, HTTPException): pass @property - def data(self): + def data(self) -> bytes: # For backwards-compat with earlier urllib3 0.4 and earlier. if self._body: - return self._body + return self._body # type: ignore[return-value] if self._fp: return self.read(cache_content=True) + return None # type: ignore[return-value] + @property - def connection(self): + def connection(self) -> HTTPConnection | None: return self._connection - def isclosed(self): + def isclosed(self) -> bool: return is_fp_closed(self._fp) - def tell(self): + def tell(self) -> int: """ Obtain the number of bytes pulled over the wire so far. May differ from the amount of content returned by :meth:``urllib3.response.HTTPResponse.read`` @@ -320,13 +831,14 @@ def tell(self): """ return self._fp_bytes_read - def _init_length(self, request_method): + def _init_length(self, request_method: str | None) -> int | None: """ Set initial length value for Response content if available. """ - length = self.headers.get("content-length") + length: int | None + content_length: str | None = self.headers.get("content-length") - if length is not None: + if content_length is not None: if self.chunked: # This Response will fail with an IncompleteRead if it can't be # received as chunked. This method falls back to attempt reading @@ -346,11 +858,11 @@ def _init_length(self, request_method): # (e.g. Content-Length: 42, 42). This line ensures the values # are all valid ints and that as long as the `set` length is 1, # all values are the same. Otherwise, the header is invalid. - lengths = set([int(val) for val in length.split(",")]) + lengths = {int(val) for val in content_length.split(",")} if len(lengths) > 1: raise InvalidHeader( "Content-Length contained multiple " - "unmatching values (%s)" % length + "unmatching values (%s)" % content_length ) length = lengths.pop() except ValueError: @@ -359,6 +871,9 @@ def _init_length(self, request_method): if length < 0: length = None + else: # if content_length is None + length = None + # Convert status to int for comparison # In some cases, httplib returns a status of "_UNKNOWN" try: @@ -372,64 +887,8 @@ def _init_length(self, request_method): return length - def _init_decoder(self): - """ - Set-up the _decoder attribute if necessary. - """ - # Note: content-encoding value should be case-insensitive, per RFC 7230 - # Section 3.2 - content_encoding = self.headers.get("content-encoding", "").lower() - if self._decoder is None: - if content_encoding in self.CONTENT_DECODERS: - self._decoder = _get_decoder(content_encoding) - elif "," in content_encoding: - encodings = [ - e.strip() - for e in content_encoding.split(",") - if e.strip() in self.CONTENT_DECODERS - ] - if len(encodings): - self._decoder = _get_decoder(content_encoding) - - DECODER_ERROR_CLASSES = (IOError, zlib.error) - if brotli is not None: - DECODER_ERROR_CLASSES += (brotli.error,) - - def _decode(self, data, decode_content, flush_decoder): - """ - Decode the data passed in and potentially flush the decoder. - """ - if not decode_content: - return data - - try: - if self._decoder: - data = self._decoder.decompress(data) - except self.DECODER_ERROR_CLASSES as e: - content_encoding = self.headers.get("content-encoding", "").lower() - raise DecodeError( - "Received response with content-encoding: %s, but " - "failed to decode it." % content_encoding, - e, - ) - if flush_decoder: - data += self._flush_decoder() - - return data - - def _flush_decoder(self): - """ - Flushes the decoder. Should only be called if the decoder is actually - being used. - """ - if self._decoder: - buf = self._decoder.decompress(b"") - return buf + self._decoder.flush() - - return b"" - @contextmanager - def _error_catcher(self): + def _error_catcher(self) -> typing.Generator[None]: """ Catch low-level python exceptions, instead re-raising urllib3 variants, so that low-level exceptions are not leaked in the @@ -443,22 +902,32 @@ def _error_catcher(self): try: yield - except SocketTimeout: + except SocketTimeout as e: # FIXME: Ideally we'd like to include the url in the ReadTimeoutError but # there is yet no clean way to get at it from this context. - raise ReadTimeoutError(self._pool, None, "Read timed out.") + raise ReadTimeoutError(self._pool, None, "Read timed out.") from e # type: ignore[arg-type] except BaseSSLError as e: # FIXME: Is there a better way to differentiate between SSLErrors? if "read operation timed out" not in str(e): # SSL errors related to framing/MAC get wrapped and reraised here - raise SSLError(e) + raise SSLError(e) from e + + raise ReadTimeoutError(self._pool, None, "Read timed out.") from e # type: ignore[arg-type] - raise ReadTimeoutError(self._pool, None, "Read timed out.") + except IncompleteRead as e: + if ( + e.expected is not None + and e.partial is not None + and e.expected == -e.partial + ): + arg = "Response may not contain content." + else: + arg = f"Connection broken: {e!r}" + raise ProtocolError(arg, e) from e - except (HTTPException, SocketError) as e: - # This includes IncompleteRead. - raise ProtocolError("Connection broken: %r" % e, e) + except (HTTPException, OSError) as e: + raise ProtocolError(f"Connection broken: {e!r}", e) from e # If no exception is thrown, we should avoid cleaning up # unnecessarily. @@ -484,7 +953,12 @@ def _error_catcher(self): if self._original_response and self._original_response.isclosed(): self.release_conn() - def _fp_read(self, amt): + def _fp_read( + self, + amt: int | None = None, + *, + read1: bool = False, + ) -> bytes: """ Read a response with the thought that reading the number of bytes larger than can fit in a 32-bit int at a time via SSL in some @@ -493,21 +967,23 @@ def _fp_read(self, amt): happen. The known cases: - * 3.8 <= CPython < 3.9.7 because of a bug + * CPython < 3.9.7 because of a bug https://github.com/urllib3/urllib3/issues/2513#issuecomment-1152559900. * urllib3 injected with pyOpenSSL-backed SSL-support. * CPython < 3.10 only when `amt` does not fit 32-bit int. """ assert self._fp - c_int_max = 2 ** 31 - 1 + c_int_max = 2**31 - 1 if ( - ( - (amt and amt > c_int_max) - or (self.length_remaining and self.length_remaining > c_int_max) + (amt and amt > c_int_max) + or ( + amt is None + and self.length_remaining + and self.length_remaining > c_int_max ) - and not util.IS_SECURETRANSPORT - and (util.IS_PYOPENSSL or sys.version_info < (3, 10)) - ): + ) and (util.IS_PYOPENSSL or sys.version_info < (3, 10)): + if read1: + return self._fp.read1(c_int_max) buffer = io.BytesIO() # Besides `max_chunk_amt` being a maximum chunk size, it # affects memory overhead of reading a response by this @@ -515,7 +991,7 @@ def _fp_read(self, amt): # `c_int_max` equal to 2 GiB - 1 byte is the actual maximum # chunk size that does not lead to an overflow error, but # 256 MiB is a compromise. - max_chunk_amt = 2 ** 28 + max_chunk_amt = 2**28 while amt is None or amt != 0: if amt is not None: chunk_amt = min(amt, max_chunk_amt) @@ -528,11 +1004,70 @@ def _fp_read(self, amt): buffer.write(data) del data # to reduce peak memory usage by `max_chunk_amt`. return buffer.getvalue() + elif read1: + return self._fp.read1(amt) if amt is not None else self._fp.read1() else: # StringIO doesn't like amt=None return self._fp.read(amt) if amt is not None else self._fp.read() - def read(self, amt=None, decode_content=None, cache_content=False): + def _raw_read( + self, + amt: int | None = None, + *, + read1: bool = False, + ) -> bytes: + """ + Reads `amt` of bytes from the socket. + """ + if self._fp is None: + return None # type: ignore[return-value] + + fp_closed = getattr(self._fp, "closed", False) + + with self._error_catcher(): + data = self._fp_read(amt, read1=read1) if not fp_closed else b"" + if amt is not None and amt != 0 and not data: + # Platform-specific: Buggy versions of Python. + # Close the connection when no data is returned + # + # This is redundant to what httplib/http.client _should_ + # already do. However, versions of python released before + # December 15, 2012 (http://bugs.python.org/issue16298) do + # not properly close the connection in all cases. There is + # no harm in redundantly calling close. + self._fp.close() + if ( + self.enforce_content_length + and self.length_remaining is not None + and self.length_remaining != 0 + ): + # This is an edge case that httplib failed to cover due + # to concerns of backward compatibility. We're + # addressing it here to make sure IncompleteRead is + # raised during streaming, so all calls with incorrect + # Content-Length are caught. + raise IncompleteRead(self._fp_bytes_read, self.length_remaining) + elif read1 and ( + (amt != 0 and not data) or self.length_remaining == len(data) + ): + # All data has been read, but `self._fp.read1` in + # CPython 3.12 and older doesn't always close + # `http.client.HTTPResponse`, so we close it here. + # See https://github.com/python/cpython/issues/113199 + self._fp.close() + + if data: + self._fp_bytes_read += len(data) + if self.length_remaining is not None: + self.length_remaining -= len(data) + return data + + def read( + self, + amt: int | None = None, + decode_content: bool | None = None, + cache_content: bool = False, + ) -> bytes: """ Similar to :meth:`http.client.HTTPResponse.read`, but with two additional parameters: ``decode_content`` and ``cache_content``. @@ -557,54 +1092,145 @@ def read(self, amt=None, decode_content=None, cache_content=False): if decode_content is None: decode_content = self.decode_content - if self._fp is None: - return + if amt and amt < 0: + # Negative numbers and `None` should be treated the same. + amt = None + elif amt is not None: + cache_content = False + + if self._decoder and self._decoder.has_unconsumed_tail: + decoded_data = self._decode( + b"", + decode_content, + flush_decoder=False, + max_length=amt - len(self._decoded_buffer), + ) + self._decoded_buffer.put(decoded_data) + if len(self._decoded_buffer) >= amt: + return self._decoded_buffer.get(amt) - flush_decoder = False - fp_closed = getattr(self._fp, "closed", False) + data = self._raw_read(amt) - with self._error_catcher(): - data = self._fp_read(amt) if not fp_closed else b"" - if amt is None: - flush_decoder = True - else: - cache_content = False - if ( - amt != 0 and not data - ): # Platform-specific: Buggy versions of Python. - # Close the connection when no data is returned - # - # This is redundant to what httplib/http.client _should_ - # already do. However, versions of python released before - # December 15, 2012 (http://bugs.python.org/issue16298) do - # not properly close the connection in all cases. There is - # no harm in redundantly calling close. - self._fp.close() - flush_decoder = True - if self.enforce_content_length and self.length_remaining not in ( - 0, - None, - ): - # This is an edge case that httplib failed to cover due - # to concerns of backward compatibility. We're - # addressing it here to make sure IncompleteRead is - # raised during streaming, so all calls with incorrect - # Content-Length are caught. - raise IncompleteRead(self._fp_bytes_read, self.length_remaining) + flush_decoder = amt is None or (amt != 0 and not data) - if data: - self._fp_bytes_read += len(data) - if self.length_remaining is not None: - self.length_remaining -= len(data) + if ( + not data + and len(self._decoded_buffer) == 0 + and not (self._decoder and self._decoder.has_unconsumed_tail) + ): + return data + if amt is None: data = self._decode(data, decode_content, flush_decoder) - if cache_content: self._body = data + else: + # do not waste memory on buffer when not decoding + if not decode_content: + if self._has_decoded_content: + raise RuntimeError( + "Calling read(decode_content=False) is not supported after " + "read(decode_content=True) was called." + ) + return data + + decoded_data = self._decode( + data, + decode_content, + flush_decoder, + max_length=amt - len(self._decoded_buffer), + ) + self._decoded_buffer.put(decoded_data) + + while len(self._decoded_buffer) < amt and data: + # TODO make sure to initially read enough data to get past the headers + # For example, the GZ file header takes 10 bytes, we don't want to read + # it one byte at a time + data = self._raw_read(amt) + decoded_data = self._decode( + data, + decode_content, + flush_decoder, + max_length=amt - len(self._decoded_buffer), + ) + self._decoded_buffer.put(decoded_data) + data = self._decoded_buffer.get(amt) return data - def stream(self, amt=2 ** 16, decode_content=None): + def read1( + self, + amt: int | None = None, + decode_content: bool | None = None, + ) -> bytes: + """ + Similar to ``http.client.HTTPResponse.read1`` and documented + in :meth:`io.BufferedReader.read1`, but with an additional parameter: + ``decode_content``. + + :param amt: + How much of the content to read. + + :param decode_content: + If True, will attempt to decode the body based on the + 'content-encoding' header. + """ + if decode_content is None: + decode_content = self.decode_content + if amt and amt < 0: + # Negative numbers and `None` should be treated the same. + amt = None + # try and respond without going to the network + if self._has_decoded_content: + if not decode_content: + raise RuntimeError( + "Calling read1(decode_content=False) is not supported after " + "read1(decode_content=True) was called." + ) + if ( + self._decoder + and self._decoder.has_unconsumed_tail + and (amt is None or len(self._decoded_buffer) < amt) + ): + decoded_data = self._decode( + b"", + decode_content, + flush_decoder=False, + max_length=( + amt - len(self._decoded_buffer) if amt is not None else None + ), + ) + self._decoded_buffer.put(decoded_data) + if len(self._decoded_buffer) > 0: + if amt is None: + return self._decoded_buffer.get_all() + return self._decoded_buffer.get(amt) + if amt == 0: + return b"" + + # FIXME, this method's type doesn't say returning None is possible + data = self._raw_read(amt, read1=True) + if not decode_content or data is None: + return data + + self._init_decoder() + while True: + flush_decoder = not data + decoded_data = self._decode( + data, decode_content, flush_decoder, max_length=amt + ) + self._decoded_buffer.put(decoded_data) + if decoded_data or flush_decoder: + break + data = self._raw_read(8192, read1=True) + + if amt is None: + return self._decoded_buffer.get_all() + return self._decoded_buffer.get(amt) + + def stream( + self, amt: int | None = 2**16, decode_content: bool | None = None + ) -> typing.Generator[bytes]: """ A generator wrapper for the read() method. A call will block until ``amt`` bytes have been read from the connection or until the @@ -621,73 +1247,35 @@ def stream(self, amt=2 ** 16, decode_content=None): 'content-encoding' header. """ if self.chunked and self.supports_chunked_reads(): - for line in self.read_chunked(amt, decode_content=decode_content): - yield line + yield from self.read_chunked(amt, decode_content=decode_content) else: - while not is_fp_closed(self._fp): + while ( + not is_fp_closed(self._fp) + or len(self._decoded_buffer) > 0 + or (self._decoder and self._decoder.has_unconsumed_tail) + ): data = self.read(amt=amt, decode_content=decode_content) if data: yield data - @classmethod - def from_httplib(ResponseCls, r, **response_kw): - """ - Given an :class:`http.client.HTTPResponse` instance ``r``, return a - corresponding :class:`urllib3.response.HTTPResponse` object. - - Remaining parameters are passed to the HTTPResponse constructor, along - with ``original_response=r``. - """ - headers = r.msg - - if not isinstance(headers, HTTPHeaderDict): - if six.PY2: - # Python 2.7 - headers = HTTPHeaderDict.from_httplib(headers) - else: - headers = HTTPHeaderDict(headers.items()) - - # HTTPResponse objects in Python 3 don't have a .strict attribute - strict = getattr(r, "strict", 0) - resp = ResponseCls( - body=r, - headers=headers, - status=r.status, - version=r.version, - reason=r.reason, - strict=strict, - original_response=r, - **response_kw - ) - return resp - - # Backwards-compatibility methods for http.client.HTTPResponse - def getheaders(self): - warnings.warn( - "HTTPResponse.getheaders() is deprecated and will be removed " - "in urllib3 v2.1.0. Instead access HTTPResponse.headers directly.", - category=DeprecationWarning, - stacklevel=2, - ) - return self.headers + # Overrides from io.IOBase + def readable(self) -> bool: + return True - def getheader(self, name, default=None): - warnings.warn( - "HTTPResponse.getheader() is deprecated and will be removed " - "in urllib3 v2.1.0. Instead use HTTPResponse.headers.get(name, default).", - category=DeprecationWarning, - stacklevel=2, - ) - return self.headers.get(name, default) + def shutdown(self) -> None: + if not self._sock_shutdown: + raise ValueError("Cannot shutdown socket as self._sock_shutdown is not set") + if self._connection is None: + raise RuntimeError( + "Cannot shutdown as connection has already been released to the pool" + ) + self._sock_shutdown(socket.SHUT_RD) - # Backwards compatibility for http.cookiejar - def info(self): - return self.headers + def close(self) -> None: + self._sock_shutdown = None - # Overrides from io.IOBase - def close(self): - if not self.closed: + if not self.closed and self._fp: self._fp.close() if self._connection: @@ -697,9 +1285,9 @@ def close(self): io.IOBase.close(self) @property - def closed(self): + def closed(self) -> bool: if not self.auto_close: - return io.IOBase.closed.__get__(self) + return io.IOBase.closed.__get__(self) # type: ignore[no-any-return] elif self._fp is None: return True elif hasattr(self._fp, "isclosed"): @@ -709,18 +1297,18 @@ def closed(self): else: return True - def fileno(self): + def fileno(self) -> int: if self._fp is None: - raise IOError("HTTPResponse has no file to get a fileno from") + raise OSError("HTTPResponse has no file to get a fileno from") elif hasattr(self._fp, "fileno"): return self._fp.fileno() else: - raise IOError( + raise OSError( "The file-like object this HTTPResponse is wrapped " "around has no file descriptor" ) - def flush(self): + def flush(self) -> None: if ( self._fp is not None and hasattr(self._fp, "flush") @@ -728,20 +1316,7 @@ def flush(self): ): return self._fp.flush() - def readable(self): - # This method is required for `io` module compatibility. - return True - - def readinto(self, b): - # This method is required for `io` module compatibility. - temp = self.read(len(b)) - if len(temp) == 0: - return 0 - else: - b[: len(temp)] = temp - return len(temp) - - def supports_chunked_reads(self): + def supports_chunked_reads(self) -> bool: """ Checks if the underlying file-like object looks like a :class:`http.client.HTTPResponse` object. We do this by testing for @@ -750,43 +1325,49 @@ def supports_chunked_reads(self): """ return hasattr(self._fp, "fp") - def _update_chunk_length(self): + def _update_chunk_length(self) -> None: # First, we'll figure out length of a chunk and then # we'll try to read it from socket. if self.chunk_left is not None: - return - line = self._fp.fp.readline() + return None + line = self._fp.fp.readline() # type: ignore[union-attr] line = line.split(b";", 1)[0] try: self.chunk_left = int(line, 16) except ValueError: - # Invalid chunked protocol response, abort. self.close() - raise InvalidChunkLength(self, line) + if line: + # Invalid chunked protocol response, abort. + raise InvalidChunkLength(self, line) from None + else: + # Truncated at start of next chunk + raise ProtocolError("Response ended prematurely") from None - def _handle_chunk(self, amt): + def _handle_chunk(self, amt: int | None) -> bytes: returned_chunk = None if amt is None: - chunk = self._fp._safe_read(self.chunk_left) + chunk = self._fp._safe_read(self.chunk_left) # type: ignore[union-attr] returned_chunk = chunk - self._fp._safe_read(2) # Toss the CRLF at the end of the chunk. + self._fp._safe_read(2) # type: ignore[union-attr] # Toss the CRLF at the end of the chunk. self.chunk_left = None - elif amt < self.chunk_left: - value = self._fp._safe_read(amt) + elif self.chunk_left is not None and amt < self.chunk_left: + value = self._fp._safe_read(amt) # type: ignore[union-attr] self.chunk_left = self.chunk_left - amt returned_chunk = value elif amt == self.chunk_left: - value = self._fp._safe_read(amt) - self._fp._safe_read(2) # Toss the CRLF at the end of the chunk. + value = self._fp._safe_read(amt) # type: ignore[union-attr] + self._fp._safe_read(2) # type: ignore[union-attr] # Toss the CRLF at the end of the chunk. self.chunk_left = None returned_chunk = value else: # amt > self.chunk_left - returned_chunk = self._fp._safe_read(self.chunk_left) - self._fp._safe_read(2) # Toss the CRLF at the end of the chunk. + returned_chunk = self._fp._safe_read(self.chunk_left) # type: ignore[union-attr] + self._fp._safe_read(2) # type: ignore[union-attr] # Toss the CRLF at the end of the chunk. self.chunk_left = None - return returned_chunk + return returned_chunk # type: ignore[no-any-return] - def read_chunked(self, amt=None, decode_content=None): + def read_chunked( + self, amt: int | None = None, decode_content: bool | None = None + ) -> typing.Generator[bytes]: """ Similar to :meth:`HTTPResponse.read`, but with an additional parameter: ``decode_content``. @@ -817,20 +1398,32 @@ def read_chunked(self, amt=None, decode_content=None): # Don't bother reading the body of a HEAD request. if self._original_response and is_response_to_head(self._original_response): self._original_response.close() - return + return None # If a response is already read and closed # then return immediately. - if self._fp.fp is None: - return + if self._fp.fp is None: # type: ignore[union-attr] + return None + + if amt and amt < 0: + # Negative numbers and `None` should be treated the same, + # but httplib handles only `None` correctly. + amt = None while True: - self._update_chunk_length() - if self.chunk_left == 0: - break - chunk = self._handle_chunk(amt) + # First, check if any data is left in the decoder's buffer. + if self._decoder and self._decoder.has_unconsumed_tail: + chunk = b"" + else: + self._update_chunk_length() + if self.chunk_left == 0: + break + chunk = self._handle_chunk(amt) decoded = self._decode( - chunk, decode_content=decode_content, flush_decoder=False + chunk, + decode_content=decode_content, + flush_decoder=False, + max_length=amt, ) if decoded: yield decoded @@ -844,7 +1437,7 @@ def read_chunked(self, amt=None, decode_content=None): yield decoded # Chunk content ends with \r\n: discard it. - while True: + while self._fp is not None: line = self._fp.fp.readline() if not line: # Some sites may not end with '\r\n'. @@ -856,27 +1449,29 @@ def read_chunked(self, amt=None, decode_content=None): if self._original_response: self._original_response.close() - def geturl(self): + @property + def url(self) -> str | None: """ Returns the URL that was the source of this response. If the request that generated this response redirected, this method will return the final redirect location. """ - if self.retries is not None and len(self.retries.history): - return self.retries.history[-1].redirect_location - else: - return self._request_url + return self._request_url + + @url.setter + def url(self, url: str | None) -> None: + self._request_url = url - def __iter__(self): - buffer = [] + def __iter__(self) -> typing.Iterator[bytes]: + buffer: list[bytes] = [] for chunk in self.stream(decode_content=True): if b"\n" in chunk: - chunk = chunk.split(b"\n") - yield b"".join(buffer) + chunk[0] + b"\n" - for x in chunk[1:-1]: + chunks = chunk.split(b"\n") + yield b"".join(buffer) + chunks[0] + b"\n" + for x in chunks[1:-1]: yield x + b"\n" - if chunk[-1]: - buffer = [chunk[-1]] + if chunks[-1]: + buffer = [chunks[-1]] else: buffer = [] else: diff --git a/newrelic/packages/urllib3/util/__init__.py b/newrelic/packages/urllib3/util/__init__.py index 4547fc522b..534126033c 100644 --- a/newrelic/packages/urllib3/util/__init__.py +++ b/newrelic/packages/urllib3/util/__init__.py @@ -1,46 +1,39 @@ -from __future__ import absolute_import - # For backwards compatibility, provide imports that used to be here. +from __future__ import annotations + from .connection import is_connection_dropped from .request import SKIP_HEADER, SKIPPABLE_HEADERS, make_headers from .response import is_fp_closed from .retry import Retry from .ssl_ import ( ALPN_PROTOCOLS, - HAS_SNI, IS_PYOPENSSL, - IS_SECURETRANSPORT, - PROTOCOL_TLS, SSLContext, assert_fingerprint, + create_urllib3_context, resolve_cert_reqs, resolve_ssl_version, ssl_wrap_socket, ) -from .timeout import Timeout, current_time -from .url import Url, get_host, parse_url, split_first +from .timeout import Timeout +from .url import Url, parse_url from .wait import wait_for_read, wait_for_write __all__ = ( - "HAS_SNI", "IS_PYOPENSSL", - "IS_SECURETRANSPORT", "SSLContext", - "PROTOCOL_TLS", "ALPN_PROTOCOLS", "Retry", "Timeout", "Url", "assert_fingerprint", - "current_time", + "create_urllib3_context", "is_connection_dropped", "is_fp_closed", - "get_host", "parse_url", "make_headers", "resolve_cert_reqs", "resolve_ssl_version", - "split_first", "ssl_wrap_socket", "wait_for_read", "wait_for_write", diff --git a/newrelic/packages/urllib3/util/connection.py b/newrelic/packages/urllib3/util/connection.py index 6af1138f26..f92519ee91 100644 --- a/newrelic/packages/urllib3/util/connection.py +++ b/newrelic/packages/urllib3/util/connection.py @@ -1,33 +1,23 @@ -from __future__ import absolute_import +from __future__ import annotations import socket +import typing -from ..contrib import _appengine_environ from ..exceptions import LocationParseError -from ..packages import six -from .wait import NoWayToWaitForSocketError, wait_for_read +from .timeout import _DEFAULT_TIMEOUT, _TYPE_TIMEOUT +_TYPE_SOCKET_OPTIONS = list[tuple[int, int, typing.Union[int, bytes]]] -def is_connection_dropped(conn): # Platform-specific - """ - Returns True if the connection is dropped and should be closed. +if typing.TYPE_CHECKING: + from .._base_connection import BaseHTTPConnection - :param conn: - :class:`http.client.HTTPConnection` object. - Note: For platforms like AppEngine, this will always return ``False`` to - let the platform handle connection recycling transparently for us. +def is_connection_dropped(conn: BaseHTTPConnection) -> bool: # Platform-specific """ - sock = getattr(conn, "sock", False) - if sock is False: # Platform-specific: AppEngine - return False - if sock is None: # Connection already closed (such as by httplib). - return True - try: - # Returns True if readable, which here means it's been dropped - return wait_for_read(sock, timeout=0.0) - except NoWayToWaitForSocketError: # Platform-specific: AppEngine - return False + Returns True if the connection is dropped and should be closed. + :param conn: :class:`urllib3.connection.HTTPConnection` object. + """ + return not conn.is_connected # This function is copied from socket.py in the Python 2.7 standard @@ -35,11 +25,11 @@ def is_connection_dropped(conn): # Platform-specific # One additional modification is that we avoid binding to IPv6 servers # discovered in DNS if the system doesn't have IPv6 functionality. def create_connection( - address, - timeout=socket._GLOBAL_DEFAULT_TIMEOUT, - source_address=None, - socket_options=None, -): + address: tuple[str, int], + timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, + source_address: tuple[str, int] | None = None, + socket_options: _TYPE_SOCKET_OPTIONS | None = None, +) -> socket.socket: """Connect to *address* and return the socket object. Convenience function. Connect to *address* (a 2-tuple ``(host, @@ -65,9 +55,7 @@ def create_connection( try: host.encode("idna") except UnicodeError: - return six.raise_from( - LocationParseError(u"'%s', label empty or too long" % host), None - ) + raise LocationParseError(f"'{host}', label empty or too long") from None for res in socket.getaddrinfo(host, port, family, socket.SOCK_STREAM): af, socktype, proto, canonname, sa = res @@ -78,26 +66,33 @@ def create_connection( # If provided, set socket level options before connecting. _set_socket_options(sock, socket_options) - if timeout is not socket._GLOBAL_DEFAULT_TIMEOUT: + if timeout is not _DEFAULT_TIMEOUT: sock.settimeout(timeout) if source_address: sock.bind(source_address) sock.connect(sa) + # Break explicitly a reference cycle + err = None return sock - except socket.error as e: - err = e + except OSError as _: + err = _ if sock is not None: sock.close() - sock = None if err is not None: - raise err - - raise socket.error("getaddrinfo returns an empty list") + try: + raise err + finally: + # Break explicitly a reference cycle + err = None + else: + raise OSError("getaddrinfo returns an empty list") -def _set_socket_options(sock, options): +def _set_socket_options( + sock: socket.socket, options: _TYPE_SOCKET_OPTIONS | None +) -> None: if options is None: return @@ -105,7 +100,7 @@ def _set_socket_options(sock, options): sock.setsockopt(*opt) -def allowed_gai_family(): +def allowed_gai_family() -> socket.AddressFamily: """This function is designed to work in the context of getaddrinfo, where family=socket.AF_UNSPEC is the default and will perform a DNS search for both IPv6 and IPv4 records.""" @@ -116,18 +111,11 @@ def allowed_gai_family(): return family -def _has_ipv6(host): +def _has_ipv6(host: str) -> bool: """Returns True if the system can bind an IPv6 address.""" sock = None has_ipv6 = False - # App Engine doesn't support IPV6 sockets and actually has a quota on the - # number of sockets that can be used, so just early out here instead of - # creating a socket needlessly. - # See https://github.com/urllib3/urllib3/issues/1446 - if _appengine_environ.is_appengine_sandbox(): - return False - if socket.has_ipv6: # has_ipv6 returns true if cPython was compiled with IPv6 support. # It does not tell us if the system has IPv6 support enabled. To diff --git a/newrelic/packages/urllib3/util/proxy.py b/newrelic/packages/urllib3/util/proxy.py index 2199cc7b7f..908fc6621d 100644 --- a/newrelic/packages/urllib3/util/proxy.py +++ b/newrelic/packages/urllib3/util/proxy.py @@ -1,9 +1,18 @@ -from .ssl_ import create_urllib3_context, resolve_cert_reqs, resolve_ssl_version +from __future__ import annotations + +import typing + +from .url import Url + +if typing.TYPE_CHECKING: + from ..connection import ProxyConfig def connection_requires_http_tunnel( - proxy_url=None, proxy_config=None, destination_scheme=None -): + proxy_url: Url | None = None, + proxy_config: ProxyConfig | None = None, + destination_scheme: str | None = None, +) -> bool: """ Returns True if the connection requires an HTTP CONNECT through the proxy. @@ -32,26 +41,3 @@ def connection_requires_http_tunnel( # Otherwise always use a tunnel. return True - - -def create_proxy_ssl_context( - ssl_version, cert_reqs, ca_certs=None, ca_cert_dir=None, ca_cert_data=None -): - """ - Generates a default proxy ssl context if one hasn't been provided by the - user. - """ - ssl_context = create_urllib3_context( - ssl_version=resolve_ssl_version(ssl_version), - cert_reqs=resolve_cert_reqs(cert_reqs), - ) - - if ( - not ca_certs - and not ca_cert_dir - and not ca_cert_data - and hasattr(ssl_context, "load_default_certs") - ): - ssl_context.load_default_certs() - - return ssl_context diff --git a/newrelic/packages/urllib3/util/queue.py b/newrelic/packages/urllib3/util/queue.py deleted file mode 100644 index 41784104ee..0000000000 --- a/newrelic/packages/urllib3/util/queue.py +++ /dev/null @@ -1,22 +0,0 @@ -import collections - -from ..packages import six -from ..packages.six.moves import queue - -if six.PY2: - # Queue is imported for side effects on MS Windows. See issue #229. - import Queue as _unused_module_Queue # noqa: F401 - - -class LifoQueue(queue.Queue): - def _init(self, _): - self.queue = collections.deque() - - def _qsize(self, len=len): - return len(self.queue) - - def _put(self, item): - self.queue.append(item) - - def _get(self): - return self.queue.pop() diff --git a/newrelic/packages/urllib3/util/request.py b/newrelic/packages/urllib3/util/request.py index b574b081e9..6c2372ba7e 100644 --- a/newrelic/packages/urllib3/util/request.py +++ b/newrelic/packages/urllib3/util/request.py @@ -1,9 +1,16 @@ -from __future__ import absolute_import +from __future__ import annotations +import io +import sys +import typing from base64 import b64encode +from enum import Enum from ..exceptions import UnrewindableBodyError -from ..packages.six import b, integer_types +from .util import to_bytes + +if typing.TYPE_CHECKING: + from typing import Final # Pass as a value within ``headers`` to skip # emitting some HTTP headers that are added automatically. @@ -15,25 +22,49 @@ ACCEPT_ENCODING = "gzip,deflate" try: try: - import brotlicffi as _unused_module_brotli # noqa: F401 + import brotlicffi as _unused_module_brotli # type: ignore[import-not-found] # noqa: F401 except ImportError: - import brotli as _unused_module_brotli # noqa: F401 + import brotli as _unused_module_brotli # type: ignore[import-not-found] # noqa: F401 except ImportError: pass else: ACCEPT_ENCODING += ",br" -_FAILEDTELL = object() +try: + if sys.version_info >= (3, 14): + from compression import zstd as _unused_module_zstd # noqa: F401 + else: + from backports import zstd as _unused_module_zstd # noqa: F401 +except ImportError: + pass +else: + ACCEPT_ENCODING += ",zstd" + + +class _TYPE_FAILEDTELL(Enum): + token = 0 + + +_FAILEDTELL: Final[_TYPE_FAILEDTELL] = _TYPE_FAILEDTELL.token + +_TYPE_BODY_POSITION = typing.Union[int, _TYPE_FAILEDTELL] + +# When sending a request with these methods we aren't expecting +# a body so don't need to set an explicit 'Content-Length: 0' +# The reason we do this in the negative instead of tracking methods +# which 'should' have a body is because unknown methods should be +# treated as if they were 'POST' which *does* expect a body. +_METHODS_NOT_EXPECTING_BODY = {"GET", "HEAD", "DELETE", "TRACE", "OPTIONS", "CONNECT"} def make_headers( - keep_alive=None, - accept_encoding=None, - user_agent=None, - basic_auth=None, - proxy_basic_auth=None, - disable_cache=None, -): + keep_alive: bool | None = None, + accept_encoding: bool | list[str] | str | None = None, + user_agent: str | None = None, + basic_auth: str | None = None, + proxy_basic_auth: str | None = None, + disable_cache: bool | None = None, +) -> dict[str, str]: """ Shortcuts for generating request headers. @@ -42,7 +73,11 @@ def make_headers( :param accept_encoding: Can be a boolean, list, or string. - ``True`` translates to 'gzip,deflate'. + ``True`` translates to 'gzip,deflate'. If the dependencies for + Brotli (either the ``brotli`` or ``brotlicffi`` package) and/or + Zstandard (the ``backports.zstd`` package for Python before 3.14) + algorithms are installed, then their encodings are + included in the string ('br' and 'zstd', respectively). List will get joined by comma. String will be used as provided. @@ -61,14 +96,18 @@ def make_headers( :param disable_cache: If ``True``, adds 'cache-control: no-cache' header. - Example:: + Example: + + .. code-block:: python - >>> make_headers(keep_alive=True, user_agent="Batman/1.0") - {'connection': 'keep-alive', 'user-agent': 'Batman/1.0'} - >>> make_headers(accept_encoding=True) - {'accept-encoding': 'gzip,deflate'} + import urllib3 + + print(urllib3.util.make_headers(keep_alive=True, user_agent="Batman/1.0")) + # {'connection': 'keep-alive', 'user-agent': 'Batman/1.0'} + print(urllib3.util.make_headers(accept_encoding=True)) + # {'accept-encoding': 'gzip,deflate'} """ - headers = {} + headers: dict[str, str] = {} if accept_encoding: if isinstance(accept_encoding, str): pass @@ -85,12 +124,14 @@ def make_headers( headers["connection"] = "keep-alive" if basic_auth: - headers["authorization"] = "Basic " + b64encode(b(basic_auth)).decode("utf-8") + headers["authorization"] = ( + f"Basic {b64encode(basic_auth.encode('latin-1')).decode()}" + ) if proxy_basic_auth: - headers["proxy-authorization"] = "Basic " + b64encode( - b(proxy_basic_auth) - ).decode("utf-8") + headers["proxy-authorization"] = ( + f"Basic {b64encode(proxy_basic_auth.encode('latin-1')).decode()}" + ) if disable_cache: headers["cache-control"] = "no-cache" @@ -98,7 +139,9 @@ def make_headers( return headers -def set_file_position(body, pos): +def set_file_position( + body: typing.Any, pos: _TYPE_BODY_POSITION | None +) -> _TYPE_BODY_POSITION | None: """ If a position is provided, move file to that point. Otherwise, we'll attempt to record a position for future use. @@ -108,7 +151,7 @@ def set_file_position(body, pos): elif getattr(body, "tell", None) is not None: try: pos = body.tell() - except (IOError, OSError): + except OSError: # This differentiates from None, allowing us to catch # a failed `tell()` later when trying to rewind the body. pos = _FAILEDTELL @@ -116,7 +159,7 @@ def set_file_position(body, pos): return pos -def rewind_body(body, body_pos): +def rewind_body(body: typing.IO[typing.AnyStr], body_pos: _TYPE_BODY_POSITION) -> None: """ Attempt to rewind body to a certain position. Primarily used for request redirects and retries. @@ -128,13 +171,13 @@ def rewind_body(body, body_pos): Position to seek to in file. """ body_seek = getattr(body, "seek", None) - if body_seek is not None and isinstance(body_pos, integer_types): + if body_seek is not None and isinstance(body_pos, int): try: body_seek(body_pos) - except (IOError, OSError): + except OSError as e: raise UnrewindableBodyError( "An error occurred when rewinding request body for redirect/retry." - ) + ) from e elif body_pos is _FAILEDTELL: raise UnrewindableBodyError( "Unable to record file position for rewinding " @@ -142,5 +185,79 @@ def rewind_body(body, body_pos): ) else: raise ValueError( - "body_pos must be of type integer, instead it was %s." % type(body_pos) + f"body_pos must be of type integer, instead it was {type(body_pos)}." ) + + +class ChunksAndContentLength(typing.NamedTuple): + chunks: typing.Iterable[bytes] | None + content_length: int | None + + +def body_to_chunks( + body: typing.Any | None, method: str, blocksize: int +) -> ChunksAndContentLength: + """Takes the HTTP request method, body, and blocksize and + transforms them into an iterable of chunks to pass to + socket.sendall() and an optional 'Content-Length' header. + + A 'Content-Length' of 'None' indicates the length of the body + can't be determined so should use 'Transfer-Encoding: chunked' + for framing instead. + """ + + chunks: typing.Iterable[bytes] | None + content_length: int | None + + # No body, we need to make a recommendation on 'Content-Length' + # based on whether that request method is expected to have + # a body or not. + if body is None: + chunks = None + if method.upper() not in _METHODS_NOT_EXPECTING_BODY: + content_length = 0 + else: + content_length = None + + # Bytes or strings become bytes + elif isinstance(body, (str, bytes)): + chunks = (to_bytes(body),) + content_length = len(chunks[0]) + + # File-like object, TODO: use seek() and tell() for length? + elif hasattr(body, "read"): + + def chunk_readable() -> typing.Iterable[bytes]: + encode = isinstance(body, io.TextIOBase) + while True: + datablock = body.read(blocksize) + if not datablock: + break + if encode: + datablock = datablock.encode("utf-8") + yield datablock + + chunks = chunk_readable() + content_length = None + + # Otherwise we need to start checking via duck-typing. + else: + try: + # Check if the body implements the buffer API. + mv = memoryview(body) + except TypeError: + try: + # Check if the body is an iterable + chunks = iter(body) + content_length = None + except TypeError: + raise TypeError( + f"'body' must be a bytes-like object, file-like " + f"object, or iterable. Instead was {body!r}" + ) from None + else: + # Since it implements the buffer API can be passed directly to socket.sendall() + chunks = (body,) + content_length = mv.nbytes + + return ChunksAndContentLength(chunks=chunks, content_length=content_length) diff --git a/newrelic/packages/urllib3/util/response.py b/newrelic/packages/urllib3/util/response.py index 5ea609cced..0f4578696f 100644 --- a/newrelic/packages/urllib3/util/response.py +++ b/newrelic/packages/urllib3/util/response.py @@ -1,12 +1,12 @@ -from __future__ import absolute_import +from __future__ import annotations +import http.client as httplib from email.errors import MultipartInvariantViolationDefect, StartBoundaryNotFoundDefect from ..exceptions import HeaderParsingError -from ..packages.six.moves import http_client as httplib -def is_fp_closed(obj): +def is_fp_closed(obj: object) -> bool: """ Checks whether a given file-like object is closed. @@ -17,27 +17,27 @@ def is_fp_closed(obj): try: # Check `isclosed()` first, in case Python3 doesn't set `closed`. # GH Issue #928 - return obj.isclosed() + return obj.isclosed() # type: ignore[no-any-return, attr-defined] except AttributeError: pass try: # Check via the official file-like-object way. - return obj.closed + return obj.closed # type: ignore[no-any-return, attr-defined] except AttributeError: pass try: # Check if the object is a container for another file-like object that # gets released on exhaustion (e.g. HTTPResponse). - return obj.fp is None + return obj.fp is None # type: ignore[attr-defined] except AttributeError: pass raise ValueError("Unable to determine whether fp is closed.") -def assert_header_parsing(headers): +def assert_header_parsing(headers: httplib.HTTPMessage) -> None: """ Asserts whether all headers have been successfully parsed. Extracts encountered errors from the result of parsing headers. @@ -53,55 +53,49 @@ def assert_header_parsing(headers): # This will fail silently if we pass in the wrong kind of parameter. # To make debugging easier add an explicit check. if not isinstance(headers, httplib.HTTPMessage): - raise TypeError("expected httplib.Message, got {0}.".format(type(headers))) - - defects = getattr(headers, "defects", None) - get_payload = getattr(headers, "get_payload", None) + raise TypeError(f"expected httplib.Message, got {type(headers)}.") unparsed_data = None - if get_payload: - # get_payload is actually email.message.Message.get_payload; - # we're only interested in the result if it's not a multipart message - if not headers.is_multipart(): - payload = get_payload() - - if isinstance(payload, (bytes, str)): - unparsed_data = payload - if defects: - # httplib is assuming a response body is available - # when parsing headers even when httplib only sends - # header data to parse_headers() This results in - # defects on multipart responses in particular. - # See: https://github.com/urllib3/urllib3/issues/800 - - # So we ignore the following defects: - # - StartBoundaryNotFoundDefect: - # The claimed start boundary was never found. - # - MultipartInvariantViolationDefect: - # A message claimed to be a multipart but no subparts were found. - defects = [ - defect - for defect in defects - if not isinstance( - defect, (StartBoundaryNotFoundDefect, MultipartInvariantViolationDefect) - ) - ] + + # get_payload is actually email.message.Message.get_payload; + # we're only interested in the result if it's not a multipart message + if not headers.is_multipart(): + payload = headers.get_payload() + + if isinstance(payload, (bytes, str)): + unparsed_data = payload + + # httplib is assuming a response body is available + # when parsing headers even when httplib only sends + # header data to parse_headers() This results in + # defects on multipart responses in particular. + # See: https://github.com/urllib3/urllib3/issues/800 + + # So we ignore the following defects: + # - StartBoundaryNotFoundDefect: + # The claimed start boundary was never found. + # - MultipartInvariantViolationDefect: + # A message claimed to be a multipart but no subparts were found. + defects = [ + defect + for defect in headers.defects + if not isinstance( + defect, (StartBoundaryNotFoundDefect, MultipartInvariantViolationDefect) + ) + ] if defects or unparsed_data: raise HeaderParsingError(defects=defects, unparsed_data=unparsed_data) -def is_response_to_head(response): +def is_response_to_head(response: httplib.HTTPResponse) -> bool: """ Checks whether the request of a response has been a HEAD-request. - Handles the quirks of AppEngine. :param http.client.HTTPResponse response: Response to check if the originating request used 'HEAD' as a method. """ # FIXME: Can we do this somehow without accessing private httplib _method? - method = response._method - if isinstance(method, int): # Platform-specific: Appengine - return method == 3 - return method.upper() == "HEAD" + method_str = response._method # type: str # type: ignore[attr-defined] + return method_str.upper() == "HEAD" diff --git a/newrelic/packages/urllib3/util/retry.py b/newrelic/packages/urllib3/util/retry.py index 9a1e90d0b2..b21b4b64eb 100644 --- a/newrelic/packages/urllib3/util/retry.py +++ b/newrelic/packages/urllib3/util/retry.py @@ -1,12 +1,13 @@ -from __future__ import absolute_import +from __future__ import annotations import email import logging +import random import re import time -import warnings -from collections import namedtuple +import typing from itertools import takewhile +from types import TracebackType from ..exceptions import ( ConnectTimeoutError, @@ -17,97 +18,51 @@ ReadTimeoutError, ResponseError, ) -from ..packages import six +from .util import reraise -log = logging.getLogger(__name__) - - -# Data structure for representing the metadata of requests that result in a retry. -RequestHistory = namedtuple( - "RequestHistory", ["method", "url", "error", "status", "redirect_location"] -) +if typing.TYPE_CHECKING: + from typing_extensions import Self + from ..connectionpool import ConnectionPool + from ..response import BaseHTTPResponse -# TODO: In v2 we can remove this sentinel and metaclass with deprecated options. -_Default = object() +log = logging.getLogger(__name__) -class _RetryMeta(type): - @property - def DEFAULT_METHOD_WHITELIST(cls): - warnings.warn( - "Using 'Retry.DEFAULT_METHOD_WHITELIST' is deprecated and " - "will be removed in v2.0. Use 'Retry.DEFAULT_ALLOWED_METHODS' instead", - DeprecationWarning, - ) - return cls.DEFAULT_ALLOWED_METHODS - - @DEFAULT_METHOD_WHITELIST.setter - def DEFAULT_METHOD_WHITELIST(cls, value): - warnings.warn( - "Using 'Retry.DEFAULT_METHOD_WHITELIST' is deprecated and " - "will be removed in v2.0. Use 'Retry.DEFAULT_ALLOWED_METHODS' instead", - DeprecationWarning, - ) - cls.DEFAULT_ALLOWED_METHODS = value - - @property - def DEFAULT_REDIRECT_HEADERS_BLACKLIST(cls): - warnings.warn( - "Using 'Retry.DEFAULT_REDIRECT_HEADERS_BLACKLIST' is deprecated and " - "will be removed in v2.0. Use 'Retry.DEFAULT_REMOVE_HEADERS_ON_REDIRECT' instead", - DeprecationWarning, - ) - return cls.DEFAULT_REMOVE_HEADERS_ON_REDIRECT - - @DEFAULT_REDIRECT_HEADERS_BLACKLIST.setter - def DEFAULT_REDIRECT_HEADERS_BLACKLIST(cls, value): - warnings.warn( - "Using 'Retry.DEFAULT_REDIRECT_HEADERS_BLACKLIST' is deprecated and " - "will be removed in v2.0. Use 'Retry.DEFAULT_REMOVE_HEADERS_ON_REDIRECT' instead", - DeprecationWarning, - ) - cls.DEFAULT_REMOVE_HEADERS_ON_REDIRECT = value - - @property - def BACKOFF_MAX(cls): - warnings.warn( - "Using 'Retry.BACKOFF_MAX' is deprecated and " - "will be removed in v2.0. Use 'Retry.DEFAULT_BACKOFF_MAX' instead", - DeprecationWarning, - ) - return cls.DEFAULT_BACKOFF_MAX - - @BACKOFF_MAX.setter - def BACKOFF_MAX(cls, value): - warnings.warn( - "Using 'Retry.BACKOFF_MAX' is deprecated and " - "will be removed in v2.0. Use 'Retry.DEFAULT_BACKOFF_MAX' instead", - DeprecationWarning, - ) - cls.DEFAULT_BACKOFF_MAX = value +# Data structure for representing the metadata of requests that result in a retry. +class RequestHistory(typing.NamedTuple): + method: str | None + url: str | None + error: Exception | None + status: int | None + redirect_location: str | None -@six.add_metaclass(_RetryMeta) -class Retry(object): +class Retry: """Retry configuration. Each retry attempt will create a new Retry object with updated values, so they can be safely reused. - Retries can be defined as a default for a pool:: + Retries can be defined as a default for a pool: + + .. code-block:: python retries = Retry(connect=5, read=2, redirect=5) http = PoolManager(retries=retries) - response = http.request('GET', 'http://example.com/') + response = http.request("GET", "https://example.com/") - Or per-request (which overrides the default for the pool):: + Or per-request (which overrides the default for the pool): - response = http.request('GET', 'http://example.com/', retries=Retry(10)) + .. code-block:: python - Retries can be disabled by passing ``False``:: + response = http.request("GET", "https://example.com/", retries=Retry(10)) - response = http.request('GET', 'http://example.com/', retries=False) + Retries can be disabled by passing ``False``: + + .. code-block:: python + + response = http.request("GET", "https://example.com/", retries=False) Errors will be wrapped in :class:`~urllib3.exceptions.MaxRetryError` unless retries are disabled, in which case the causing exception will be raised. @@ -169,21 +124,16 @@ class Retry(object): If ``total`` is not set, it's a good idea to set this to 0 to account for unexpected edge cases and avoid infinite retry loops. - :param iterable allowed_methods: + :param Collection allowed_methods: Set of uppercased HTTP method verbs that we should retry on. By default, we only retry on methods which are considered to be idempotent (multiple requests with the same parameters end with the same state). See :attr:`Retry.DEFAULT_ALLOWED_METHODS`. - Set to a ``False`` value to retry on any verb. - - .. warning:: - - Previously this parameter was named ``method_whitelist``, that - usage is deprecated in v1.26.0 and will be removed in v2.0. + Set to a ``None`` value to retry on any verb. - :param iterable status_forcelist: + :param Collection status_forcelist: A set of integer HTTP status codes that we should force a retry on. A retry is initiated if the request method is in ``allowed_methods`` and the response status code is in ``status_forcelist``. @@ -195,13 +145,17 @@ class Retry(object): (most errors are resolved immediately by a second try without a delay). urllib3 will sleep for:: - {backoff factor} * (2 ** ({number of total retries} - 1)) + {backoff factor} * (2 ** ({number of previous retries})) - seconds. If the backoff_factor is 0.1, then :func:`.sleep` will sleep - for [0.0s, 0.2s, 0.4s, ...] between retries. It will never be longer - than :attr:`Retry.DEFAULT_BACKOFF_MAX`. + seconds. If `backoff_jitter` is non-zero, this sleep is extended by:: - By default, backoff is disabled (set to 0). + random.uniform(0, {backoff jitter}) + + seconds. For example, if the backoff_factor is 0.1, then :func:`Retry.sleep` will + sleep for [0.0s, 0.2s, 0.4s, 0.8s, ...] between retries. No backoff will ever + be longer than `backoff_max`. + + By default, backoff is disabled (factor set to 0). :param bool raise_on_redirect: Whether, if the number of redirects is exhausted, to raise a MaxRetryError, or to return a response with a @@ -220,10 +174,15 @@ class Retry(object): Whether to respect Retry-After header on status codes defined as :attr:`Retry.RETRY_AFTER_STATUS_CODES` or not. - :param iterable remove_headers_on_redirect: + :param Collection remove_headers_on_redirect: Sequence of headers to remove from the request when a response indicating a redirect is returned before firing off the redirected request. + + :param int retry_after_max: Number of seconds to allow as the maximum for + Retry-After headers. Defaults to :attr:`Retry.DEFAULT_RETRY_AFTER_MAX`. + Any Retry-After headers larger than this value will be limited to this + value. """ #: Default methods to be used for ``allowed_methods`` @@ -239,48 +198,38 @@ class Retry(object): ["Cookie", "Authorization", "Proxy-Authorization"] ) - #: Maximum backoff time. + #: Default maximum backoff time. DEFAULT_BACKOFF_MAX = 120 + # This is undocumented in the RFC. Setting to 6 hours matches other popular libraries. + #: Default maximum allowed value for Retry-After headers in seconds + DEFAULT_RETRY_AFTER_MAX: typing.Final[int] = 21600 + + # Backward compatibility; assigned outside of the class. + DEFAULT: typing.ClassVar[Retry] + def __init__( self, - total=10, - connect=None, - read=None, - redirect=None, - status=None, - other=None, - allowed_methods=_Default, - status_forcelist=None, - backoff_factor=0, - raise_on_redirect=True, - raise_on_status=True, - history=None, - respect_retry_after_header=True, - remove_headers_on_redirect=_Default, - # TODO: Deprecated, remove in v2.0 - method_whitelist=_Default, - ): - - if method_whitelist is not _Default: - if allowed_methods is not _Default: - raise ValueError( - "Using both 'allowed_methods' and " - "'method_whitelist' together is not allowed. " - "Instead only use 'allowed_methods'" - ) - warnings.warn( - "Using 'method_whitelist' with Retry is deprecated and " - "will be removed in v2.0. Use 'allowed_methods' instead", - DeprecationWarning, - stacklevel=2, - ) - allowed_methods = method_whitelist - if allowed_methods is _Default: - allowed_methods = self.DEFAULT_ALLOWED_METHODS - if remove_headers_on_redirect is _Default: - remove_headers_on_redirect = self.DEFAULT_REMOVE_HEADERS_ON_REDIRECT - + total: bool | int | None = 10, + connect: int | None = None, + read: int | None = None, + redirect: bool | int | None = None, + status: int | None = None, + other: int | None = None, + allowed_methods: typing.Collection[str] | None = DEFAULT_ALLOWED_METHODS, + status_forcelist: typing.Collection[int] | None = None, + backoff_factor: float = 0, + backoff_max: float = DEFAULT_BACKOFF_MAX, + raise_on_redirect: bool = True, + raise_on_status: bool = True, + history: tuple[RequestHistory, ...] | None = None, + respect_retry_after_header: bool = True, + remove_headers_on_redirect: typing.Collection[ + str + ] = DEFAULT_REMOVE_HEADERS_ON_REDIRECT, + backoff_jitter: float = 0.0, + retry_after_max: int = DEFAULT_RETRY_AFTER_MAX, + ) -> None: self.total = total self.connect = connect self.read = read @@ -295,15 +244,18 @@ def __init__( self.status_forcelist = status_forcelist or set() self.allowed_methods = allowed_methods self.backoff_factor = backoff_factor + self.backoff_max = backoff_max + self.retry_after_max = retry_after_max self.raise_on_redirect = raise_on_redirect self.raise_on_status = raise_on_status - self.history = history or tuple() + self.history = history or () self.respect_retry_after_header = respect_retry_after_header self.remove_headers_on_redirect = frozenset( - [h.lower() for h in remove_headers_on_redirect] + h.lower() for h in remove_headers_on_redirect ) + self.backoff_jitter = backoff_jitter - def new(self, **kw): + def new(self, **kw: typing.Any) -> Self: params = dict( total=self.total, connect=self.connect, @@ -311,36 +263,29 @@ def new(self, **kw): redirect=self.redirect, status=self.status, other=self.other, + allowed_methods=self.allowed_methods, status_forcelist=self.status_forcelist, backoff_factor=self.backoff_factor, + backoff_max=self.backoff_max, + retry_after_max=self.retry_after_max, raise_on_redirect=self.raise_on_redirect, raise_on_status=self.raise_on_status, history=self.history, remove_headers_on_redirect=self.remove_headers_on_redirect, respect_retry_after_header=self.respect_retry_after_header, + backoff_jitter=self.backoff_jitter, ) - # TODO: If already given in **kw we use what's given to us - # If not given we need to figure out what to pass. We decide - # based on whether our class has the 'method_whitelist' property - # and if so we pass the deprecated 'method_whitelist' otherwise - # we use 'allowed_methods'. Remove in v2.0 - if "method_whitelist" not in kw and "allowed_methods" not in kw: - if "method_whitelist" in self.__dict__: - warnings.warn( - "Using 'method_whitelist' with Retry is deprecated and " - "will be removed in v2.0. Use 'allowed_methods' instead", - DeprecationWarning, - ) - params["method_whitelist"] = self.allowed_methods - else: - params["allowed_methods"] = self.allowed_methods - params.update(kw) - return type(self)(**params) + return type(self)(**params) # type: ignore[arg-type] @classmethod - def from_int(cls, retries, redirect=True, default=None): + def from_int( + cls, + retries: Retry | bool | int | None, + redirect: bool | int | None = True, + default: Retry | bool | int | None = None, + ) -> Retry: """Backwards-compatibility for the old retries format.""" if retries is None: retries = default if default is not None else cls.DEFAULT @@ -353,7 +298,7 @@ def from_int(cls, retries, redirect=True, default=None): log.debug("Converted retries value: %r -> %r", retries, new_retries) return new_retries - def get_backoff_time(self): + def get_backoff_time(self) -> float: """Formula for computing the current backoff :rtype: float @@ -368,32 +313,32 @@ def get_backoff_time(self): return 0 backoff_value = self.backoff_factor * (2 ** (consecutive_errors_len - 1)) - return min(self.DEFAULT_BACKOFF_MAX, backoff_value) + if self.backoff_jitter != 0.0: + backoff_value += random.random() * self.backoff_jitter + return float(max(0, min(self.backoff_max, backoff_value))) - def parse_retry_after(self, retry_after): + def parse_retry_after(self, retry_after: str) -> float: + seconds: float # Whitespace: https://tools.ietf.org/html/rfc7230#section-3.2.4 if re.match(r"^\s*[0-9]+\s*$", retry_after): seconds = int(retry_after) else: retry_date_tuple = email.utils.parsedate_tz(retry_after) if retry_date_tuple is None: - raise InvalidHeader("Invalid Retry-After header: %s" % retry_after) - if retry_date_tuple[9] is None: # Python 2 - # Assume UTC if no timezone was specified - # On Python2.7, parsedate_tz returns None for a timezone offset - # instead of 0 if no timezone is given, where mktime_tz treats - # a None timezone offset as local time. - retry_date_tuple = retry_date_tuple[:9] + (0,) + retry_date_tuple[10:] + raise InvalidHeader(f"Invalid Retry-After header: {retry_after}") retry_date = email.utils.mktime_tz(retry_date_tuple) seconds = retry_date - time.time() - if seconds < 0: - seconds = 0 + seconds = max(seconds, 0) + + # Check the seconds do not exceed the specified maximum + if seconds > self.retry_after_max: + seconds = self.retry_after_max return seconds - def get_retry_after(self, response): + def get_retry_after(self, response: BaseHTTPResponse) -> float | None: """Get the value of Retry-After in seconds.""" retry_after = response.headers.get("Retry-After") @@ -403,7 +348,7 @@ def get_retry_after(self, response): return self.parse_retry_after(retry_after) - def sleep_for_retry(self, response=None): + def sleep_for_retry(self, response: BaseHTTPResponse) -> bool: retry_after = self.get_retry_after(response) if retry_after: time.sleep(retry_after) @@ -411,13 +356,13 @@ def sleep_for_retry(self, response=None): return False - def _sleep_backoff(self): + def _sleep_backoff(self) -> None: backoff = self.get_backoff_time() if backoff <= 0: return time.sleep(backoff) - def sleep(self, response=None): + def sleep(self, response: BaseHTTPResponse | None = None) -> None: """Sleep between retry attempts. This method will respect a server's ``Retry-After`` response header @@ -433,7 +378,7 @@ def sleep(self, response=None): self._sleep_backoff() - def _is_connection_error(self, err): + def _is_connection_error(self, err: Exception) -> bool: """Errors when we're fairly sure that the server did not receive the request, so it should be safe to retry. """ @@ -441,33 +386,23 @@ def _is_connection_error(self, err): err = err.original_error return isinstance(err, ConnectTimeoutError) - def _is_read_error(self, err): + def _is_read_error(self, err: Exception) -> bool: """Errors that occur after the request has been started, so we should assume that the server began processing it. """ return isinstance(err, (ReadTimeoutError, ProtocolError)) - def _is_method_retryable(self, method): + def _is_method_retryable(self, method: str) -> bool: """Checks if a given HTTP method should be retried upon, depending if it is included in the allowed_methods """ - # TODO: For now favor if the Retry implementation sets its own method_whitelist - # property outside of our constructor to avoid breaking custom implementations. - if "method_whitelist" in self.__dict__: - warnings.warn( - "Using 'method_whitelist' with Retry is deprecated and " - "will be removed in v2.0. Use 'allowed_methods' instead", - DeprecationWarning, - ) - allowed_methods = self.method_whitelist - else: - allowed_methods = self.allowed_methods - - if allowed_methods and method.upper() not in allowed_methods: + if self.allowed_methods and method.upper() not in self.allowed_methods: return False return True - def is_retry(self, method, status_code, has_retry_after=False): + def is_retry( + self, method: str, status_code: int, has_retry_after: bool = False + ) -> bool: """Is this method/status code retryable? (Based on allowlists and control variables such as the number of total retries to allow, whether to respect the Retry-After header, whether this header is present, and @@ -480,24 +415,27 @@ def is_retry(self, method, status_code, has_retry_after=False): if self.status_forcelist and status_code in self.status_forcelist: return True - return ( + return bool( self.total and self.respect_retry_after_header and has_retry_after and (status_code in self.RETRY_AFTER_STATUS_CODES) ) - def is_exhausted(self): + def is_exhausted(self) -> bool: """Are we out of retries?""" - retry_counts = ( - self.total, - self.connect, - self.read, - self.redirect, - self.status, - self.other, - ) - retry_counts = list(filter(None, retry_counts)) + retry_counts = [ + x + for x in ( + self.total, + self.connect, + self.read, + self.redirect, + self.status, + self.other, + ) + if x + ] if not retry_counts: return False @@ -505,18 +443,18 @@ def is_exhausted(self): def increment( self, - method=None, - url=None, - response=None, - error=None, - _pool=None, - _stacktrace=None, - ): + method: str | None = None, + url: str | None = None, + response: BaseHTTPResponse | None = None, + error: Exception | None = None, + _pool: ConnectionPool | None = None, + _stacktrace: TracebackType | None = None, + ) -> Self: """Return a new Retry object with incremented retry counters. :param response: A response object, or None, if the server did not return a response. - :type response: :class:`~urllib3.response.HTTPResponse` + :type response: :class:`~urllib3.response.BaseHTTPResponse` :param Exception error: An error encountered during the request, or None if the response was received successfully. @@ -524,7 +462,7 @@ def increment( """ if self.total is False and error: # Disabled, indicate to re-raise the error. - raise six.reraise(type(error), error, _stacktrace) + raise reraise(type(error), error, _stacktrace) total = self.total if total is not None: @@ -542,14 +480,14 @@ def increment( if error and self._is_connection_error(error): # Connect retry? if connect is False: - raise six.reraise(type(error), error, _stacktrace) + raise reraise(type(error), error, _stacktrace) elif connect is not None: connect -= 1 elif error and self._is_read_error(error): # Read retry? - if read is False or not self._is_method_retryable(method): - raise six.reraise(type(error), error, _stacktrace) + if read is False or method is None or not self._is_method_retryable(method): + raise reraise(type(error), error, _stacktrace) elif read is not None: read -= 1 @@ -563,7 +501,9 @@ def increment( if redirect is not None: redirect -= 1 cause = "too many redirects" - redirect_location = response.get_redirect_location() + response_redirect_location = response.get_redirect_location() + if response_redirect_location: + redirect_location = response_redirect_location status = response.status else: @@ -591,31 +531,18 @@ def increment( ) if new_retry.is_exhausted(): - raise MaxRetryError(_pool, url, error or ResponseError(cause)) + reason = error or ResponseError(cause) + raise MaxRetryError(_pool, url, reason) from reason # type: ignore[arg-type] log.debug("Incremented Retry for (url='%s'): %r", url, new_retry) return new_retry - def __repr__(self): + def __repr__(self) -> str: return ( - "{cls.__name__}(total={self.total}, connect={self.connect}, " - "read={self.read}, redirect={self.redirect}, status={self.status})" - ).format(cls=type(self), self=self) - - def __getattr__(self, item): - if item == "method_whitelist": - # TODO: Remove this deprecated alias in v2.0 - warnings.warn( - "Using 'method_whitelist' with Retry is deprecated and " - "will be removed in v2.0. Use 'allowed_methods' instead", - DeprecationWarning, - ) - return self.allowed_methods - try: - return getattr(super(Retry, self), item) - except AttributeError: - return getattr(Retry, item) + f"{type(self).__name__}(total={self.total}, connect={self.connect}, " + f"read={self.read}, redirect={self.redirect}, status={self.status})" + ) # For backwards compatibility (equivalent to pre-v1.9): diff --git a/newrelic/packages/urllib3/util/ssl_.py b/newrelic/packages/urllib3/util/ssl_.py index 8f867812a5..56fe9093ad 100644 --- a/newrelic/packages/urllib3/util/ssl_.py +++ b/newrelic/packages/urllib3/util/ssl_.py @@ -1,185 +1,155 @@ -from __future__ import absolute_import +from __future__ import annotations +import hashlib import hmac import os +import socket import sys +import typing import warnings -from binascii import hexlify, unhexlify -from hashlib import md5, sha1, sha256 - -from ..exceptions import ( - InsecurePlatformWarning, - ProxySchemeUnsupported, - SNIMissingWarning, - SSLError, -) -from ..packages import six -from .url import BRACELESS_IPV6_ADDRZ_RE, IPV4_RE +from binascii import unhexlify + +from ..exceptions import ProxySchemeUnsupported, SSLError +from .url import _BRACELESS_IPV6_ADDRZ_RE, _IPV4_RE SSLContext = None SSLTransport = None -HAS_SNI = False +HAS_NEVER_CHECK_COMMON_NAME = False IS_PYOPENSSL = False -IS_SECURETRANSPORT = False ALPN_PROTOCOLS = ["http/1.1"] -# Maps the length of a digest to a possible hash function producing this digest -HASHFUNC_MAP = {32: md5, 40: sha1, 64: sha256} - - -def _const_compare_digest_backport(a, b): - """ - Compare two digests of equal length in constant time. +_TYPE_VERSION_INFO = tuple[int, int, int, str, int] - The digests must be of type str/bytes. - Returns True if the digests match, and False otherwise. +# Maps the length of a digest to a possible hash function producing this digest +HASHFUNC_MAP = { + length: getattr(hashlib, algorithm, None) + for length, algorithm in ((32, "md5"), (40, "sha1"), (64, "sha256")) +} + + +def _is_bpo_43522_fixed( + implementation_name: str, + version_info: _TYPE_VERSION_INFO, + pypy_version_info: _TYPE_VERSION_INFO | None, +) -> bool: + """Return True for CPython 3.9.3+ or 3.10+ and PyPy 7.3.8+ where + setting SSLContext.hostname_checks_common_name to False works. + + Outside of CPython and PyPy we don't know which implementations work + or not so we conservatively use our hostname matching as we know that works + on all implementations. + + https://github.com/urllib3/urllib3/issues/2192#issuecomment-821832963 + https://foss.heptapod.net/pypy/pypy/-/issues/3539 """ - result = abs(len(a) - len(b)) - for left, right in zip(bytearray(a), bytearray(b)): - result |= left ^ right - return result == 0 + if implementation_name == "pypy": + # https://foss.heptapod.net/pypy/pypy/-/issues/3129 + return pypy_version_info >= (7, 3, 8) # type: ignore[operator] + elif implementation_name == "cpython": + major_minor = version_info[:2] + micro = version_info[2] + return (major_minor == (3, 9) and micro >= 3) or major_minor >= (3, 10) + else: # Defensive: + return False + + +def _is_has_never_check_common_name_reliable( + openssl_version: str, + openssl_version_number: int, + implementation_name: str, + version_info: _TYPE_VERSION_INFO, + pypy_version_info: _TYPE_VERSION_INFO | None, +) -> bool: + # As of May 2023, all released versions of LibreSSL fail to reject certificates with + # only common names, see https://github.com/urllib3/urllib3/pull/3024 + is_openssl = openssl_version.startswith("OpenSSL ") + # Before fixing OpenSSL issue #14579, the SSL_new() API was not copying hostflags + # like X509_CHECK_FLAG_NEVER_CHECK_SUBJECT, which tripped up CPython. + # https://github.com/openssl/openssl/issues/14579 + # This was released in OpenSSL 1.1.1l+ (>=0x101010cf) + is_openssl_issue_14579_fixed = openssl_version_number >= 0x101010CF + + return is_openssl and ( + is_openssl_issue_14579_fixed + or _is_bpo_43522_fixed(implementation_name, version_info, pypy_version_info) + ) -_const_compare_digest = getattr(hmac, "compare_digest", _const_compare_digest_backport) +if typing.TYPE_CHECKING: + from ssl import VerifyMode + from typing import TypedDict -try: # Test for SSL features - import ssl - from ssl import CERT_REQUIRED, wrap_socket -except ImportError: - pass + from .ssltransport import SSLTransport as SSLTransportType -try: - from ssl import HAS_SNI # Has SNI? -except ImportError: - pass + class _TYPE_PEER_CERT_RET_DICT(TypedDict, total=False): + subjectAltName: tuple[tuple[str, str], ...] + subject: tuple[tuple[tuple[str, str], ...], ...] + serialNumber: str -try: - from .ssltransport import SSLTransport -except ImportError: - pass +# Mapping from 'ssl.PROTOCOL_TLSX' to 'TLSVersion.X' +_SSL_VERSION_TO_TLS_VERSION: dict[int, int] = {} -try: # Platform-specific: Python 3.6 - from ssl import PROTOCOL_TLS +try: # Do we have ssl at all? + import ssl + from ssl import ( # type: ignore[assignment] + CERT_REQUIRED, + HAS_NEVER_CHECK_COMMON_NAME, + OP_NO_COMPRESSION, + OP_NO_TICKET, + OPENSSL_VERSION, + OPENSSL_VERSION_NUMBER, + PROTOCOL_TLS, + PROTOCOL_TLS_CLIENT, + VERIFY_X509_STRICT, + OP_NO_SSLv2, + OP_NO_SSLv3, + SSLContext, + TLSVersion, + ) PROTOCOL_SSLv23 = PROTOCOL_TLS -except ImportError: - try: - from ssl import PROTOCOL_SSLv23 as PROTOCOL_TLS - - PROTOCOL_SSLv23 = PROTOCOL_TLS - except ImportError: - PROTOCOL_SSLv23 = PROTOCOL_TLS = 2 - -try: - from ssl import PROTOCOL_TLS_CLIENT -except ImportError: - PROTOCOL_TLS_CLIENT = PROTOCOL_TLS - - -try: - from ssl import OP_NO_COMPRESSION, OP_NO_SSLv2, OP_NO_SSLv3 -except ImportError: - OP_NO_SSLv2, OP_NO_SSLv3 = 0x1000000, 0x2000000 - OP_NO_COMPRESSION = 0x20000 + # Needed for Python 3.9 which does not define this + VERIFY_X509_PARTIAL_CHAIN = getattr(ssl, "VERIFY_X509_PARTIAL_CHAIN", 0x80000) + + # Setting SSLContext.hostname_checks_common_name = False didn't work before CPython + # 3.9.3, and 3.10 (but OK on PyPy) or OpenSSL 1.1.1l+ + if HAS_NEVER_CHECK_COMMON_NAME and not _is_has_never_check_common_name_reliable( + OPENSSL_VERSION, + OPENSSL_VERSION_NUMBER, + sys.implementation.name, + sys.version_info, + sys.pypy_version_info if sys.implementation.name == "pypy" else None, # type: ignore[attr-defined] + ): # Defensive: for Python < 3.9.3 + HAS_NEVER_CHECK_COMMON_NAME = False + + # Need to be careful here in case old TLS versions get + # removed in future 'ssl' module implementations. + for attr in ("TLSv1", "TLSv1_1", "TLSv1_2"): + try: + _SSL_VERSION_TO_TLS_VERSION[getattr(ssl, f"PROTOCOL_{attr}")] = getattr( + TLSVersion, attr + ) + except AttributeError: # Defensive: + continue -try: # OP_NO_TICKET was added in Python 3.6 - from ssl import OP_NO_TICKET + from .ssltransport import SSLTransport # type: ignore[assignment] except ImportError: - OP_NO_TICKET = 0x4000 - - -# A secure default. -# Sources for more information on TLS ciphers: -# -# - https://wiki.mozilla.org/Security/Server_Side_TLS -# - https://www.ssllabs.com/projects/best-practices/index.html -# - https://hynek.me/articles/hardening-your-web-servers-ssl-ciphers/ -# -# The general intent is: -# - prefer cipher suites that offer perfect forward secrecy (DHE/ECDHE), -# - prefer ECDHE over DHE for better performance, -# - prefer any AES-GCM and ChaCha20 over any AES-CBC for better performance and -# security, -# - prefer AES-GCM over ChaCha20 because hardware-accelerated AES is common, -# - disable NULL authentication, MD5 MACs, DSS, and other -# insecure ciphers for security reasons. -# - NOTE: TLS 1.3 cipher suites are managed through a different interface -# not exposed by CPython (yet!) and are enabled by default if they're available. -DEFAULT_CIPHERS = ":".join( - [ - "ECDHE+AESGCM", - "ECDHE+CHACHA20", - "DHE+AESGCM", - "DHE+CHACHA20", - "ECDH+AESGCM", - "DH+AESGCM", - "ECDH+AES", - "DH+AES", - "RSA+AESGCM", - "RSA+AES", - "!aNULL", - "!eNULL", - "!MD5", - "!DSS", - ] -) - -try: - from ssl import SSLContext # Modern SSL? -except ImportError: - - class SSLContext(object): # Platform-specific: Python 2 - def __init__(self, protocol_version): - self.protocol = protocol_version - # Use default values from a real SSLContext - self.check_hostname = False - self.verify_mode = ssl.CERT_NONE - self.ca_certs = None - self.options = 0 - self.certfile = None - self.keyfile = None - self.ciphers = None - - def load_cert_chain(self, certfile, keyfile): - self.certfile = certfile - self.keyfile = keyfile - - def load_verify_locations(self, cafile=None, capath=None, cadata=None): - self.ca_certs = cafile + OP_NO_COMPRESSION = 0x20000 # type: ignore[assignment, misc] + OP_NO_TICKET = 0x4000 # type: ignore[assignment, misc] + OP_NO_SSLv2 = 0x1000000 # type: ignore[assignment, misc] + OP_NO_SSLv3 = 0x2000000 # type: ignore[assignment, misc] + PROTOCOL_SSLv23 = PROTOCOL_TLS = 2 # type: ignore[assignment, misc] + PROTOCOL_TLS_CLIENT = 16 # type: ignore[assignment, misc] + VERIFY_X509_PARTIAL_CHAIN = 0x80000 + VERIFY_X509_STRICT = 0x20 # type: ignore[assignment, misc] - if capath is not None: - raise SSLError("CA directories not supported in older Pythons") - if cadata is not None: - raise SSLError("CA data not supported in older Pythons") +_TYPE_PEER_CERT_RET = typing.Union["_TYPE_PEER_CERT_RET_DICT", bytes, None] - def set_ciphers(self, cipher_suite): - self.ciphers = cipher_suite - def wrap_socket(self, socket, server_hostname=None, server_side=False): - warnings.warn( - "A true SSLContext object is not available. This prevents " - "urllib3 from configuring SSL appropriately and may cause " - "certain SSL connections to fail. You can upgrade to a newer " - "version of Python to solve this. For more information, see " - "https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html" - "#ssl-warnings", - InsecurePlatformWarning, - ) - kwargs = { - "keyfile": self.keyfile, - "certfile": self.certfile, - "ca_certs": self.ca_certs, - "cert_reqs": self.verify_mode, - "ssl_version": self.protocol, - "server_side": server_side, - } - return wrap_socket(socket, ciphers=self.ciphers, **kwargs) - - -def assert_fingerprint(cert, fingerprint): +def assert_fingerprint(cert: bytes | None, fingerprint: str) -> None: """ Checks if given fingerprint matches the supplied certificate. @@ -189,26 +159,31 @@ def assert_fingerprint(cert, fingerprint): Fingerprint as string of hexdigits, can be interspersed by colons. """ + if cert is None: + raise SSLError("No certificate for the peer.") + fingerprint = fingerprint.replace(":", "").lower() digest_length = len(fingerprint) + if digest_length not in HASHFUNC_MAP: + raise SSLError(f"Fingerprint of invalid length: {fingerprint}") hashfunc = HASHFUNC_MAP.get(digest_length) - if not hashfunc: - raise SSLError("Fingerprint of invalid length: {0}".format(fingerprint)) + if hashfunc is None: + raise SSLError( + f"Hash function implementation unavailable for fingerprint length: {digest_length}" + ) # We need encode() here for py32; works on py2 and p33. fingerprint_bytes = unhexlify(fingerprint.encode()) cert_digest = hashfunc(cert).digest() - if not _const_compare_digest(cert_digest, fingerprint_bytes): + if not hmac.compare_digest(cert_digest, fingerprint_bytes): raise SSLError( - 'Fingerprints did not match. Expected "{0}", got "{1}".'.format( - fingerprint, hexlify(cert_digest) - ) + f'Fingerprints did not match. Expected "{fingerprint}", got "{cert_digest.hex()}"' ) -def resolve_cert_reqs(candidate): +def resolve_cert_reqs(candidate: None | int | str) -> VerifyMode: """ Resolves the argument to a numeric constant, which can be passed to the wrap_socket function/method from the ssl module. @@ -226,12 +201,12 @@ def resolve_cert_reqs(candidate): res = getattr(ssl, candidate, None) if res is None: res = getattr(ssl, "CERT_" + candidate) - return res + return res # type: ignore[no-any-return] - return candidate + return candidate # type: ignore[return-value] -def resolve_ssl_version(candidate): +def resolve_ssl_version(candidate: None | int | str) -> int: """ like resolve_cert_reqs """ @@ -242,35 +217,34 @@ def resolve_ssl_version(candidate): res = getattr(ssl, candidate, None) if res is None: res = getattr(ssl, "PROTOCOL_" + candidate) - return res + return typing.cast(int, res) return candidate def create_urllib3_context( - ssl_version=None, cert_reqs=None, options=None, ciphers=None -): - """All arguments have the same meaning as ``ssl_wrap_socket``. - - By default, this function does a lot of the same work that - ``ssl.create_default_context`` does on Python 3.4+. It: - - - Disables SSLv2, SSLv3, and compression - - Sets a restricted set of server ciphers - - If you wish to enable SSLv3, you can do:: - - from urllib3.util import ssl_ - context = ssl_.create_urllib3_context() - context.options &= ~ssl_.OP_NO_SSLv3 - - You can do the same to enable compression (substituting ``COMPRESSION`` - for ``SSLv3`` in the last line above). + ssl_version: int | None = None, + cert_reqs: int | None = None, + options: int | None = None, + ciphers: str | None = None, + ssl_minimum_version: int | None = None, + ssl_maximum_version: int | None = None, + verify_flags: int | None = None, +) -> ssl.SSLContext: + """Creates and configures an :class:`ssl.SSLContext` instance for use with urllib3. :param ssl_version: The desired protocol version to use. This will default to PROTOCOL_SSLv23 which will negotiate the highest protocol that both the server and your installation of OpenSSL support. + + This parameter is deprecated instead use 'ssl_minimum_version'. + :param ssl_minimum_version: + The minimum version of TLS to be used. Use the 'ssl.TLSVersion' enum for specifying the value. + :param ssl_maximum_version: + The maximum version of TLS to be used. Use the 'ssl.TLSVersion' enum for specifying the value. + Not recommended to set to anything other than 'ssl.TLSVersion.MAXIMUM_SUPPORTED' which is the + default value. :param cert_reqs: Whether to require the certificate verification. This defaults to ``ssl.CERT_REQUIRED``. @@ -278,18 +252,63 @@ def create_urllib3_context( Specific OpenSSL options. These default to ``ssl.OP_NO_SSLv2``, ``ssl.OP_NO_SSLv3``, ``ssl.OP_NO_COMPRESSION``, and ``ssl.OP_NO_TICKET``. :param ciphers: - Which cipher suites to allow the server to select. + Which cipher suites to allow the server to select. Defaults to either system configured + ciphers if OpenSSL 1.1.1+, otherwise uses a secure default set of ciphers. + :param verify_flags: + The flags for certificate verification operations. These default to + ``ssl.VERIFY_X509_PARTIAL_CHAIN`` and ``ssl.VERIFY_X509_STRICT`` for Python 3.13+. :returns: Constructed SSLContext object with specified options :rtype: SSLContext """ - # PROTOCOL_TLS is deprecated in Python 3.10 - if not ssl_version or ssl_version == PROTOCOL_TLS: - ssl_version = PROTOCOL_TLS_CLIENT + if SSLContext is None: + raise TypeError("Can't create an SSLContext object without an ssl module") + + # This means 'ssl_version' was specified as an exact value. + if ssl_version not in (None, PROTOCOL_TLS, PROTOCOL_TLS_CLIENT): + # Disallow setting 'ssl_version' and 'ssl_minimum|maximum_version' + # to avoid conflicts. + if ssl_minimum_version is not None or ssl_maximum_version is not None: + raise ValueError( + "Can't specify both 'ssl_version' and either " + "'ssl_minimum_version' or 'ssl_maximum_version'" + ) - context = SSLContext(ssl_version) + # 'ssl_version' is deprecated and will be removed in the future. + else: + # Use 'ssl_minimum_version' and 'ssl_maximum_version' instead. + ssl_minimum_version = _SSL_VERSION_TO_TLS_VERSION.get( + ssl_version, TLSVersion.MINIMUM_SUPPORTED + ) + ssl_maximum_version = _SSL_VERSION_TO_TLS_VERSION.get( + ssl_version, TLSVersion.MAXIMUM_SUPPORTED + ) - context.set_ciphers(ciphers or DEFAULT_CIPHERS) + # This warning message is pushing users to use 'ssl_minimum_version' + # instead of both min/max. Best practice is to only set the minimum version and + # keep the maximum version to be it's default value: 'TLSVersion.MAXIMUM_SUPPORTED' + warnings.warn( + "'ssl_version' option is deprecated and will be " + "removed in urllib3 v2.6.0. Instead use 'ssl_minimum_version'", + category=DeprecationWarning, + stacklevel=2, + ) + + # PROTOCOL_TLS is deprecated in Python 3.10 so we always use PROTOCOL_TLS_CLIENT + context = SSLContext(PROTOCOL_TLS_CLIENT) + + if ssl_minimum_version is not None: + context.minimum_version = ssl_minimum_version + else: # Python <3.10 defaults to 'MINIMUM_SUPPORTED' so explicitly set TLSv1.2 here + context.minimum_version = TLSVersion.TLSv1_2 + + if ssl_maximum_version is not None: + context.maximum_version = ssl_maximum_version + + # Unless we're given ciphers defer to either system ciphers in + # the case of OpenSSL 1.1.1+ or use our own secure default ciphers. + if ciphers: + context.set_ciphers(ciphers) # Setting the default here, as we may have no ssl module on import cert_reqs = ssl.CERT_REQUIRED if cert_reqs is None else cert_reqs @@ -311,65 +330,106 @@ def create_urllib3_context( context.options |= options + if verify_flags is None: + verify_flags = 0 + # In Python 3.13+ ssl.create_default_context() sets VERIFY_X509_PARTIAL_CHAIN + # and VERIFY_X509_STRICT so we do the same + if sys.version_info >= (3, 13): + verify_flags |= VERIFY_X509_PARTIAL_CHAIN + verify_flags |= VERIFY_X509_STRICT + + context.verify_flags |= verify_flags + # Enable post-handshake authentication for TLS 1.3, see GH #1634. PHA is # necessary for conditional client cert authentication with TLS 1.3. - # The attribute is None for OpenSSL <= 1.1.0 or does not exist in older - # versions of Python. We only enable on Python 3.7.4+ or if certificate - # verification is enabled to work around Python issue #37428 - # See: https://bugs.python.org/issue37428 - if (cert_reqs == ssl.CERT_REQUIRED or sys.version_info >= (3, 7, 4)) and getattr( - context, "post_handshake_auth", None - ) is not None: + # The attribute is None for OpenSSL <= 1.1.0 or does not exist when using + # an SSLContext created by pyOpenSSL. + if getattr(context, "post_handshake_auth", None) is not None: context.post_handshake_auth = True - def disable_check_hostname(): - if ( - getattr(context, "check_hostname", None) is not None - ): # Platform-specific: Python 3.2 - # We do our own verification, including fingerprints and alternative - # hostnames. So disable it here - context.check_hostname = False - # The order of the below lines setting verify_mode and check_hostname # matter due to safe-guards SSLContext has to prevent an SSLContext with - # check_hostname=True, verify_mode=NONE/OPTIONAL. This is made even more - # complex because we don't know whether PROTOCOL_TLS_CLIENT will be used - # or not so we don't know the initial state of the freshly created SSLContext. - if cert_reqs == ssl.CERT_REQUIRED: + # check_hostname=True, verify_mode=NONE/OPTIONAL. + # We always set 'check_hostname=False' for pyOpenSSL so we rely on our own + # 'ssl.match_hostname()' implementation. + if cert_reqs == ssl.CERT_REQUIRED and not IS_PYOPENSSL: context.verify_mode = cert_reqs - disable_check_hostname() + context.check_hostname = True else: - disable_check_hostname() + context.check_hostname = False context.verify_mode = cert_reqs - # Enable logging of TLS session keys via defacto standard environment variable - # 'SSLKEYLOGFILE', if the feature is available (Python 3.8+). Skip empty values. - if hasattr(context, "keylog_filename"): - sslkeylogfile = os.environ.get("SSLKEYLOGFILE") - if sslkeylogfile: - context.keylog_filename = sslkeylogfile + try: + context.hostname_checks_common_name = False + except AttributeError: # Defensive: for CPython < 3.9.3; for PyPy < 7.3.8 + pass + + if "SSLKEYLOGFILE" in os.environ: + sslkeylogfile = os.path.expandvars(os.environ.get("SSLKEYLOGFILE")) + else: + sslkeylogfile = None + if sslkeylogfile: + context.keylog_filename = sslkeylogfile return context +@typing.overload +def ssl_wrap_socket( + sock: socket.socket, + keyfile: str | None = ..., + certfile: str | None = ..., + cert_reqs: int | None = ..., + ca_certs: str | None = ..., + server_hostname: str | None = ..., + ssl_version: int | None = ..., + ciphers: str | None = ..., + ssl_context: ssl.SSLContext | None = ..., + ca_cert_dir: str | None = ..., + key_password: str | None = ..., + ca_cert_data: None | str | bytes = ..., + tls_in_tls: typing.Literal[False] = ..., +) -> ssl.SSLSocket: ... + + +@typing.overload +def ssl_wrap_socket( + sock: socket.socket, + keyfile: str | None = ..., + certfile: str | None = ..., + cert_reqs: int | None = ..., + ca_certs: str | None = ..., + server_hostname: str | None = ..., + ssl_version: int | None = ..., + ciphers: str | None = ..., + ssl_context: ssl.SSLContext | None = ..., + ca_cert_dir: str | None = ..., + key_password: str | None = ..., + ca_cert_data: None | str | bytes = ..., + tls_in_tls: bool = ..., +) -> ssl.SSLSocket | SSLTransportType: ... + + def ssl_wrap_socket( - sock, - keyfile=None, - certfile=None, - cert_reqs=None, - ca_certs=None, - server_hostname=None, - ssl_version=None, - ciphers=None, - ssl_context=None, - ca_cert_dir=None, - key_password=None, - ca_cert_data=None, - tls_in_tls=False, -): + sock: socket.socket, + keyfile: str | None = None, + certfile: str | None = None, + cert_reqs: int | None = None, + ca_certs: str | None = None, + server_hostname: str | None = None, + ssl_version: int | None = None, + ciphers: str | None = None, + ssl_context: ssl.SSLContext | None = None, + ca_cert_dir: str | None = None, + key_password: str | None = None, + ca_cert_data: None | str | bytes = None, + tls_in_tls: bool = False, +) -> ssl.SSLSocket | SSLTransportType: """ - All arguments except for server_hostname, ssl_context, and ca_cert_dir have - the same meaning as they do when using :func:`ssl.wrap_socket`. + All arguments except for server_hostname, ssl_context, tls_in_tls, ca_cert_data and + ca_cert_dir have the same meaning as they do when using + :func:`ssl.create_default_context`, :meth:`ssl.SSLContext.load_cert_chain`, + :meth:`ssl.SSLContext.set_ciphers` and :meth:`ssl.SSLContext.wrap_socket`. :param server_hostname: When SNI is supported, the expected hostname of the certificate @@ -392,19 +452,18 @@ def ssl_wrap_socket( """ context = ssl_context if context is None: - # Note: This branch of code and all the variables in it are no longer - # used by urllib3 itself. We should consider deprecating and removing - # this code. + # Note: This branch of code and all the variables in it are only used in tests. + # We should consider deprecating and removing this code. context = create_urllib3_context(ssl_version, cert_reqs, ciphers=ciphers) if ca_certs or ca_cert_dir or ca_cert_data: try: context.load_verify_locations(ca_certs, ca_cert_dir, ca_cert_data) - except (IOError, OSError) as e: - raise SSLError(e) + except OSError as e: + raise SSLError(e) from e elif ssl_context is None and hasattr(context, "load_default_certs"): - # try to load OS default certs; works well on Windows (require Python3.4+) + # try to load OS default certs; works well on Windows. context.load_default_certs() # Attempt to detect if we get the goofy behavior of the @@ -419,57 +478,28 @@ def ssl_wrap_socket( else: context.load_cert_chain(certfile, keyfile, key_password) - try: - if hasattr(context, "set_alpn_protocols"): - context.set_alpn_protocols(ALPN_PROTOCOLS) - except NotImplementedError: # Defensive: in CI, we always have set_alpn_protocols - pass - - # If we detect server_hostname is an IP address then the SNI - # extension should not be used according to RFC3546 Section 3.1 - use_sni_hostname = server_hostname and not is_ipaddress(server_hostname) - # SecureTransport uses server_hostname in certificate verification. - send_sni = (use_sni_hostname and HAS_SNI) or ( - IS_SECURETRANSPORT and server_hostname - ) - # Do not warn the user if server_hostname is an invalid SNI hostname. - if not HAS_SNI and use_sni_hostname: - warnings.warn( - "An HTTPS request has been made, but the SNI (Server Name " - "Indication) extension to TLS is not available on this platform. " - "This may cause the server to present an incorrect TLS " - "certificate, which can cause validation failures. You can upgrade to " - "a newer version of Python to solve this. For more information, see " - "https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html" - "#ssl-warnings", - SNIMissingWarning, - ) + context.set_alpn_protocols(ALPN_PROTOCOLS) - if send_sni: - ssl_sock = _ssl_wrap_socket_impl( - sock, context, tls_in_tls, server_hostname=server_hostname - ) - else: - ssl_sock = _ssl_wrap_socket_impl(sock, context, tls_in_tls) + ssl_sock = _ssl_wrap_socket_impl(sock, context, tls_in_tls, server_hostname) return ssl_sock -def is_ipaddress(hostname): +def is_ipaddress(hostname: str | bytes) -> bool: """Detects whether the hostname given is an IPv4 or IPv6 address. Also detects IPv6 addresses with Zone IDs. :param str hostname: Hostname to examine. :return: True if the hostname is an IP address, False otherwise. """ - if not six.PY2 and isinstance(hostname, bytes): + if isinstance(hostname, bytes): # IDN A-label bytes are ASCII compatible. hostname = hostname.decode("ascii") - return bool(IPV4_RE.match(hostname) or BRACELESS_IPV6_ADDRZ_RE.match(hostname)) + return bool(_IPV4_RE.match(hostname) or _BRACELESS_IPV6_ADDRZ_RE.match(hostname)) -def _is_key_file_encrypted(key_file): +def _is_key_file_encrypted(key_file: str) -> bool: """Detects if a key file is encrypted or not.""" - with open(key_file, "r") as f: + with open(key_file) as f: for line in f: # Look for Proc-Type: 4,ENCRYPTED if "ENCRYPTED" in line: @@ -478,7 +508,12 @@ def _is_key_file_encrypted(key_file): return False -def _ssl_wrap_socket_impl(sock, ssl_context, tls_in_tls, server_hostname=None): +def _ssl_wrap_socket_impl( + sock: socket.socket, + ssl_context: ssl.SSLContext, + tls_in_tls: bool, + server_hostname: str | None = None, +) -> ssl.SSLSocket | SSLTransportType: if tls_in_tls: if not SSLTransport: # Import error, ssl is not available. @@ -489,7 +524,4 @@ def _ssl_wrap_socket_impl(sock, ssl_context, tls_in_tls, server_hostname=None): SSLTransport._validate_ssl_context_for_tls_in_tls(ssl_context) return SSLTransport(sock, ssl_context, server_hostname) - if server_hostname: - return ssl_context.wrap_socket(sock, server_hostname=server_hostname) - else: - return ssl_context.wrap_socket(sock) + return ssl_context.wrap_socket(sock, server_hostname=server_hostname) diff --git a/newrelic/packages/urllib3/util/ssl_match_hostname.py b/newrelic/packages/urllib3/util/ssl_match_hostname.py index 1dd950c489..25d9100041 100644 --- a/newrelic/packages/urllib3/util/ssl_match_hostname.py +++ b/newrelic/packages/urllib3/util/ssl_match_hostname.py @@ -1,19 +1,18 @@ -"""The match_hostname() function from Python 3.3.3, essential when using SSL.""" +"""The match_hostname() function from Python 3.5, essential when using SSL.""" # Note: This file is under the PSF license as the code comes from the python # stdlib. http://docs.python.org/3/license.html +# It is modified to remove commonName support. +from __future__ import annotations + +import ipaddress import re -import sys +import typing +from ipaddress import IPv4Address, IPv6Address -# ipaddress has been backported to 2.6+ in pypi. If it is installed on the -# system, use it to handle IPAddress ServerAltnames (this was added in -# python-3.5) otherwise only do DNS matching. This allows -# util.ssl_match_hostname to continue to be used in Python 2.7. -try: - import ipaddress -except ImportError: - ipaddress = None +if typing.TYPE_CHECKING: + from .ssl_ import _TYPE_PEER_CERT_RET_DICT __version__ = "3.5.0.1" @@ -22,7 +21,9 @@ class CertificateError(ValueError): pass -def _dnsname_match(dn, hostname, max_wildcards=1): +def _dnsname_match( + dn: typing.Any, hostname: str, max_wildcards: int = 1 +) -> typing.Match[str] | None | bool: """Matching according to RFC 6125, section 6.4.3 http://tools.ietf.org/html/rfc6125#section-6.4.3 @@ -49,7 +50,7 @@ def _dnsname_match(dn, hostname, max_wildcards=1): # speed up common case w/o wildcards if not wildcards: - return dn.lower() == hostname.lower() + return bool(dn.lower() == hostname.lower()) # RFC 6125, section 6.4.3, subitem 1. # The client SHOULD NOT attempt to match a presented identifier in which @@ -76,26 +77,26 @@ def _dnsname_match(dn, hostname, max_wildcards=1): return pat.match(hostname) -def _to_unicode(obj): - if isinstance(obj, str) and sys.version_info < (3,): - # ignored flake8 # F821 to support python 2.7 function - obj = unicode(obj, encoding="ascii", errors="strict") # noqa: F821 - return obj - - -def _ipaddress_match(ipname, host_ip): +def _ipaddress_match(ipname: str, host_ip: IPv4Address | IPv6Address) -> bool: """Exact matching of IP addresses. - RFC 6125 explicitly doesn't define an algorithm for this - (section 1.7.2 - "Out of Scope"). + RFC 9110 section 4.3.5: "A reference identity of IP-ID contains the decoded + bytes of the IP address. An IP version 4 address is 4 octets, and an IP + version 6 address is 16 octets. [...] A reference identity of type IP-ID + matches if the address is identical to an iPAddress value of the + subjectAltName extension of the certificate." """ # OpenSSL may add a trailing newline to a subjectAltName's IP address # Divergence from upstream: ipaddress can't handle byte str - ip = ipaddress.ip_address(_to_unicode(ipname).rstrip()) - return ip == host_ip + ip = ipaddress.ip_address(ipname.rstrip()) + return bool(ip.packed == host_ip.packed) -def match_hostname(cert, hostname): +def match_hostname( + cert: _TYPE_PEER_CERT_RET_DICT | None, + hostname: str, + hostname_checks_common_name: bool = False, +) -> None: """Verify that *cert* (in decoded format as returned by SSLSocket.getpeercert()) matches the *hostname*. RFC 2818 and RFC 6125 rules are followed, but IP addresses are not accepted for *hostname*. @@ -111,21 +112,22 @@ def match_hostname(cert, hostname): ) try: # Divergence from upstream: ipaddress can't handle byte str - host_ip = ipaddress.ip_address(_to_unicode(hostname)) - except (UnicodeError, ValueError): - # ValueError: Not an IP address (common case) - # UnicodeError: Divergence from upstream: Have to deal with ipaddress not taking - # byte strings. addresses should be all ascii, so we consider it not - # an ipaddress in this case + # + # The ipaddress module shipped with Python < 3.9 does not support + # scoped IPv6 addresses so we unconditionally strip the Zone IDs for + # now. Once we drop support for Python 3.9 we can remove this branch. + if "%" in hostname: + host_ip = ipaddress.ip_address(hostname[: hostname.rfind("%")]) + else: + host_ip = ipaddress.ip_address(hostname) + + except ValueError: + # Not an IP address (common case) host_ip = None - except AttributeError: - # Divergence from upstream: Make ipaddress library optional - if ipaddress is None: - host_ip = None - else: # Defensive - raise dnsnames = [] - san = cert.get("subjectAltName", ()) + san: tuple[tuple[str, str], ...] = cert.get("subjectAltName", ()) + key: str + value: str for key, value in san: if key == "DNS": if host_ip is None and _dnsname_match(value, hostname): @@ -135,25 +137,23 @@ def match_hostname(cert, hostname): if host_ip is not None and _ipaddress_match(value, host_ip): return dnsnames.append(value) - if not dnsnames: - # The subject is only checked when there is no dNSName entry - # in subjectAltName + + # We only check 'commonName' if it's enabled and we're not verifying + # an IP address. IP addresses aren't valid within 'commonName'. + if hostname_checks_common_name and host_ip is None and not dnsnames: for sub in cert.get("subject", ()): for key, value in sub: - # XXX according to RFC 2818, the most specific Common Name - # must be used. if key == "commonName": if _dnsname_match(value, hostname): return - dnsnames.append(value) + dnsnames.append(value) # Defensive: for Python < 3.9.3 + if len(dnsnames) > 1: raise CertificateError( "hostname %r " "doesn't match either of %s" % (hostname, ", ".join(map(repr, dnsnames))) ) elif len(dnsnames) == 1: - raise CertificateError("hostname %r doesn't match %r" % (hostname, dnsnames[0])) + raise CertificateError(f"hostname {hostname!r} doesn't match {dnsnames[0]!r}") else: - raise CertificateError( - "no appropriate commonName or subjectAltName fields were found" - ) + raise CertificateError("no appropriate subjectAltName fields were found") diff --git a/newrelic/packages/urllib3/util/ssltransport.py b/newrelic/packages/urllib3/util/ssltransport.py index 4a7105d179..6d59bc3bce 100644 --- a/newrelic/packages/urllib3/util/ssltransport.py +++ b/newrelic/packages/urllib3/util/ssltransport.py @@ -1,9 +1,20 @@ +from __future__ import annotations + import io import socket import ssl +import typing from ..exceptions import ProxySchemeUnsupported -from ..packages import six + +if typing.TYPE_CHECKING: + from typing_extensions import Self + + from .ssl_ import _TYPE_PEER_CERT_RET, _TYPE_PEER_CERT_RET_DICT + + +_WriteBuffer = typing.Union[bytearray, memoryview] +_ReturnValue = typing.TypeVar("_ReturnValue") SSL_BLOCKSIZE = 16384 @@ -20,7 +31,7 @@ class SSLTransport: """ @staticmethod - def _validate_ssl_context_for_tls_in_tls(ssl_context): + def _validate_ssl_context_for_tls_in_tls(ssl_context: ssl.SSLContext) -> None: """ Raises a ProxySchemeUnsupported if the provided ssl_context can't be used for TLS in TLS. @@ -30,20 +41,18 @@ def _validate_ssl_context_for_tls_in_tls(ssl_context): """ if not hasattr(ssl_context, "wrap_bio"): - if six.PY2: - raise ProxySchemeUnsupported( - "TLS in TLS requires SSLContext.wrap_bio() which isn't " - "supported on Python 2" - ) - else: - raise ProxySchemeUnsupported( - "TLS in TLS requires SSLContext.wrap_bio() which isn't " - "available on non-native SSLContext" - ) + raise ProxySchemeUnsupported( + "TLS in TLS requires SSLContext.wrap_bio() which isn't " + "available on non-native SSLContext" + ) def __init__( - self, socket, ssl_context, server_hostname=None, suppress_ragged_eofs=True - ): + self, + socket: socket.socket, + ssl_context: ssl.SSLContext, + server_hostname: str | None = None, + suppress_ragged_eofs: bool = True, + ) -> None: """ Create an SSLTransport around socket using the provided ssl_context. """ @@ -60,33 +69,36 @@ def __init__( # Perform initial handshake. self._ssl_io_loop(self.sslobj.do_handshake) - def __enter__(self): + def __enter__(self) -> Self: return self - def __exit__(self, *_): + def __exit__(self, *_: typing.Any) -> None: self.close() - def fileno(self): + def fileno(self) -> int: return self.socket.fileno() - def read(self, len=1024, buffer=None): + def read(self, len: int = 1024, buffer: typing.Any | None = None) -> int | bytes: return self._wrap_ssl_read(len, buffer) - def recv(self, len=1024, flags=0): + def recv(self, buflen: int = 1024, flags: int = 0) -> int | bytes: if flags != 0: raise ValueError("non-zero flags not allowed in calls to recv") - return self._wrap_ssl_read(len) - - def recv_into(self, buffer, nbytes=None, flags=0): + return self._wrap_ssl_read(buflen) + + def recv_into( + self, + buffer: _WriteBuffer, + nbytes: int | None = None, + flags: int = 0, + ) -> None | int | bytes: if flags != 0: raise ValueError("non-zero flags not allowed in calls to recv_into") - if buffer and (nbytes is None): + if nbytes is None: nbytes = len(buffer) - elif nbytes is None: - nbytes = 1024 return self.read(nbytes, buffer) - def sendall(self, data, flags=0): + def sendall(self, data: bytes, flags: int = 0) -> None: if flags != 0: raise ValueError("non-zero flags not allowed in calls to sendall") count = 0 @@ -96,15 +108,20 @@ def sendall(self, data, flags=0): v = self.send(byte_view[count:]) count += v - def send(self, data, flags=0): + def send(self, data: bytes, flags: int = 0) -> int: if flags != 0: raise ValueError("non-zero flags not allowed in calls to send") - response = self._ssl_io_loop(self.sslobj.write, data) - return response + return self._ssl_io_loop(self.sslobj.write, data) def makefile( - self, mode="r", buffering=None, encoding=None, errors=None, newline=None - ): + self, + mode: str, + buffering: int | None = None, + *, + encoding: str | None = None, + errors: str | None = None, + newline: str | None = None, + ) -> typing.BinaryIO | typing.TextIO | socket.SocketIO: """ Python's httpclient uses makefile and buffered io when reading HTTP messages and we need to support it. @@ -113,7 +130,7 @@ def makefile( changes to point to the socket directly. """ if not set(mode) <= {"r", "w", "b"}: - raise ValueError("invalid mode %r (only r, w, b allowed)" % (mode,)) + raise ValueError(f"invalid mode {mode!r} (only r, w, b allowed)") writing = "w" in mode reading = "r" in mode or not writing @@ -124,8 +141,8 @@ def makefile( rawmode += "r" if writing: rawmode += "w" - raw = socket.SocketIO(self, rawmode) - self.socket._io_refs += 1 + raw = socket.SocketIO(self, rawmode) # type: ignore[arg-type] + self.socket._io_refs += 1 # type: ignore[attr-defined] if buffering is None: buffering = -1 if buffering < 0: @@ -134,8 +151,9 @@ def makefile( if not binary: raise ValueError("unbuffered streams must be binary") return raw + buffer: typing.BinaryIO if reading and writing: - buffer = io.BufferedRWPair(raw, raw, buffering) + buffer = io.BufferedRWPair(raw, raw, buffering) # type: ignore[assignment] elif reading: buffer = io.BufferedReader(raw, buffering) else: @@ -144,46 +162,51 @@ def makefile( if binary: return buffer text = io.TextIOWrapper(buffer, encoding, errors, newline) - text.mode = mode + text.mode = mode # type: ignore[misc] return text - def unwrap(self): + def unwrap(self) -> None: self._ssl_io_loop(self.sslobj.unwrap) - def close(self): + def close(self) -> None: self.socket.close() - def getpeercert(self, binary_form=False): - return self.sslobj.getpeercert(binary_form) + @typing.overload + def getpeercert( + self, binary_form: typing.Literal[False] = ... + ) -> _TYPE_PEER_CERT_RET_DICT | None: ... + + @typing.overload + def getpeercert(self, binary_form: typing.Literal[True]) -> bytes | None: ... + + def getpeercert(self, binary_form: bool = False) -> _TYPE_PEER_CERT_RET: + return self.sslobj.getpeercert(binary_form) # type: ignore[return-value] - def version(self): + def version(self) -> str | None: return self.sslobj.version() - def cipher(self): + def cipher(self) -> tuple[str, str, int] | None: return self.sslobj.cipher() - def selected_alpn_protocol(self): + def selected_alpn_protocol(self) -> str | None: return self.sslobj.selected_alpn_protocol() - def selected_npn_protocol(self): - return self.sslobj.selected_npn_protocol() - - def shared_ciphers(self): + def shared_ciphers(self) -> list[tuple[str, str, int]] | None: return self.sslobj.shared_ciphers() - def compression(self): + def compression(self) -> str | None: return self.sslobj.compression() - def settimeout(self, value): + def settimeout(self, value: float | None) -> None: self.socket.settimeout(value) - def gettimeout(self): + def gettimeout(self) -> float | None: return self.socket.gettimeout() - def _decref_socketios(self): - self.socket._decref_socketios() + def _decref_socketios(self) -> None: + self.socket._decref_socketios() # type: ignore[attr-defined] - def _wrap_ssl_read(self, len, buffer=None): + def _wrap_ssl_read(self, len: int, buffer: bytearray | None = None) -> int | bytes: try: return self._ssl_io_loop(self.sslobj.read, len, buffer) except ssl.SSLError as e: @@ -192,7 +215,29 @@ def _wrap_ssl_read(self, len, buffer=None): else: raise - def _ssl_io_loop(self, func, *args): + # func is sslobj.do_handshake or sslobj.unwrap + @typing.overload + def _ssl_io_loop(self, func: typing.Callable[[], None]) -> None: ... + + # func is sslobj.write, arg1 is data + @typing.overload + def _ssl_io_loop(self, func: typing.Callable[[bytes], int], arg1: bytes) -> int: ... + + # func is sslobj.read, arg1 is len, arg2 is buffer + @typing.overload + def _ssl_io_loop( + self, + func: typing.Callable[[int, bytearray | None], bytes], + arg1: int, + arg2: bytearray | None, + ) -> bytes: ... + + def _ssl_io_loop( + self, + func: typing.Callable[..., _ReturnValue], + arg1: None | bytes | int = None, + arg2: bytearray | None = None, + ) -> _ReturnValue: """Performs an I/O loop between incoming/outgoing and the socket.""" should_loop = True ret = None @@ -200,7 +245,12 @@ def _ssl_io_loop(self, func, *args): while should_loop: errno = None try: - ret = func(*args) + if arg1 is None and arg2 is None: + ret = func() + elif arg2 is None: + ret = func(arg1) + else: + ret = func(arg1, arg2) except ssl.SSLError as e: if e.errno not in (ssl.SSL_ERROR_WANT_READ, ssl.SSL_ERROR_WANT_WRITE): # WANT_READ, and WANT_WRITE are expected, others are not. @@ -218,4 +268,4 @@ def _ssl_io_loop(self, func, *args): self.incoming.write(buf) else: self.incoming.write_eof() - return ret + return typing.cast(_ReturnValue, ret) diff --git a/newrelic/packages/urllib3/util/timeout.py b/newrelic/packages/urllib3/util/timeout.py index 78e18a6272..4bb1be11d9 100644 --- a/newrelic/packages/urllib3/util/timeout.py +++ b/newrelic/packages/urllib3/util/timeout.py @@ -1,44 +1,56 @@ -from __future__ import absolute_import +from __future__ import annotations import time - -# The default socket timeout, used by httplib to indicate that no timeout was; specified by the user -from socket import _GLOBAL_DEFAULT_TIMEOUT, getdefaulttimeout +import typing +from enum import Enum +from socket import getdefaulttimeout from ..exceptions import TimeoutStateError -# A sentinel value to indicate that no timeout was specified by the user in -# urllib3 -_Default = object() +if typing.TYPE_CHECKING: + from typing import Final + + +class _TYPE_DEFAULT(Enum): + # This value should never be passed to socket.settimeout() so for safety we use a -1. + # socket.settimout() raises a ValueError for negative values. + token = -1 + +_DEFAULT_TIMEOUT: Final[_TYPE_DEFAULT] = _TYPE_DEFAULT.token -# Use time.monotonic if available. -current_time = getattr(time, "monotonic", time.time) +_TYPE_TIMEOUT = typing.Optional[typing.Union[float, _TYPE_DEFAULT]] -class Timeout(object): +class Timeout: """Timeout configuration. Timeouts can be defined as a default for a pool: .. code-block:: python - timeout = Timeout(connect=2.0, read=7.0) - http = PoolManager(timeout=timeout) - response = http.request('GET', 'http://example.com/') + import urllib3 + + timeout = urllib3.util.Timeout(connect=2.0, read=7.0) + + http = urllib3.PoolManager(timeout=timeout) + + resp = http.request("GET", "https://example.com/") + + print(resp.status) Or per-request (which overrides the default for the pool): .. code-block:: python - response = http.request('GET', 'http://example.com/', timeout=Timeout(10)) + response = http.request("GET", "https://example.com/", timeout=Timeout(10)) Timeouts can be disabled by setting all the parameters to ``None``: .. code-block:: python no_timeout = Timeout(connect=None, read=None) - response = http.request('GET', 'http://example.com/, timeout=no_timeout) + response = http.request("GET", "https://example.com/", timeout=no_timeout) :param total: @@ -89,38 +101,34 @@ class Timeout(object): the case; if a server streams one byte every fifteen seconds, a timeout of 20 seconds will not trigger, even though the request will take several minutes to complete. - - If your goal is to cut off any request after a set amount of wall clock - time, consider having a second "watcher" thread to cut off a slow - request. """ #: A sentinel object representing the default timeout value - DEFAULT_TIMEOUT = _GLOBAL_DEFAULT_TIMEOUT - - def __init__(self, total=None, connect=_Default, read=_Default): + DEFAULT_TIMEOUT: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT + + def __init__( + self, + total: _TYPE_TIMEOUT = None, + connect: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, + read: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, + ) -> None: self._connect = self._validate_timeout(connect, "connect") self._read = self._validate_timeout(read, "read") self.total = self._validate_timeout(total, "total") - self._start_connect = None + self._start_connect: float | None = None - def __repr__(self): - return "%s(connect=%r, read=%r, total=%r)" % ( - type(self).__name__, - self._connect, - self._read, - self.total, - ) + def __repr__(self) -> str: + return f"{type(self).__name__}(connect={self._connect!r}, read={self._read!r}, total={self.total!r})" # __str__ provided for backwards compatibility __str__ = __repr__ - @classmethod - def resolve_default_timeout(cls, timeout): - return getdefaulttimeout() if timeout is cls.DEFAULT_TIMEOUT else timeout + @staticmethod + def resolve_default_timeout(timeout: _TYPE_TIMEOUT) -> float | None: + return getdefaulttimeout() if timeout is _DEFAULT_TIMEOUT else timeout @classmethod - def _validate_timeout(cls, value, name): + def _validate_timeout(cls, value: _TYPE_TIMEOUT, name: str) -> _TYPE_TIMEOUT: """Check that a timeout attribute is valid. :param value: The timeout value to validate @@ -130,10 +138,7 @@ def _validate_timeout(cls, value, name): :raises ValueError: If it is a numeric value less than or equal to zero, or the type is not an integer, float, or None. """ - if value is _Default: - return cls.DEFAULT_TIMEOUT - - if value is None or value is cls.DEFAULT_TIMEOUT: + if value is None or value is _DEFAULT_TIMEOUT: return value if isinstance(value, bool): @@ -147,7 +152,7 @@ def _validate_timeout(cls, value, name): raise ValueError( "Timeout value %s was %s, but it must be an " "int, float or None." % (name, value) - ) + ) from None try: if value <= 0: @@ -157,16 +162,15 @@ def _validate_timeout(cls, value, name): "than or equal to 0." % (name, value) ) except TypeError: - # Python 3 raise ValueError( "Timeout value %s was %s, but it must be an " "int, float or None." % (name, value) - ) + ) from None return value @classmethod - def from_float(cls, timeout): + def from_float(cls, timeout: _TYPE_TIMEOUT) -> Timeout: """Create a new Timeout from a legacy timeout value. The timeout value used by httplib.py sets the same timeout on the @@ -175,13 +179,13 @@ def from_float(cls, timeout): passed to this function. :param timeout: The legacy timeout value. - :type timeout: integer, float, sentinel default object, or None + :type timeout: integer, float, :attr:`urllib3.util.Timeout.DEFAULT_TIMEOUT`, or None :return: Timeout object :rtype: :class:`Timeout` """ return Timeout(read=timeout, connect=timeout) - def clone(self): + def clone(self) -> Timeout: """Create a copy of the timeout object Timeout properties are stored per-pool but each request needs a fresh @@ -195,7 +199,7 @@ def clone(self): # detect the user default. return Timeout(connect=self._connect, read=self._read, total=self.total) - def start_connect(self): + def start_connect(self) -> float: """Start the timeout clock, used during a connect() attempt :raises urllib3.exceptions.TimeoutStateError: if you attempt @@ -203,10 +207,10 @@ def start_connect(self): """ if self._start_connect is not None: raise TimeoutStateError("Timeout timer has already been started.") - self._start_connect = current_time() + self._start_connect = time.monotonic() return self._start_connect - def get_connect_duration(self): + def get_connect_duration(self) -> float: """Gets the time elapsed since the call to :meth:`start_connect`. :return: Elapsed time in seconds. @@ -218,10 +222,10 @@ def get_connect_duration(self): raise TimeoutStateError( "Can't get connect duration for timer that has not started." ) - return current_time() - self._start_connect + return time.monotonic() - self._start_connect @property - def connect_timeout(self): + def connect_timeout(self) -> _TYPE_TIMEOUT: """Get the value to use when setting a connection timeout. This will be a positive float or integer, the value None @@ -233,13 +237,13 @@ def connect_timeout(self): if self.total is None: return self._connect - if self._connect is None or self._connect is self.DEFAULT_TIMEOUT: + if self._connect is None or self._connect is _DEFAULT_TIMEOUT: return self.total - return min(self._connect, self.total) + return min(self._connect, self.total) # type: ignore[type-var] @property - def read_timeout(self): + def read_timeout(self) -> float | None: """Get the value for the read timeout. This assumes some time has elapsed in the connection timeout and @@ -251,21 +255,21 @@ def read_timeout(self): raised. :return: Value to use for the read timeout. - :rtype: int, float, :attr:`Timeout.DEFAULT_TIMEOUT` or None + :rtype: int, float or None :raises urllib3.exceptions.TimeoutStateError: If :meth:`start_connect` has not yet been called on this object. """ if ( self.total is not None - and self.total is not self.DEFAULT_TIMEOUT + and self.total is not _DEFAULT_TIMEOUT and self._read is not None - and self._read is not self.DEFAULT_TIMEOUT + and self._read is not _DEFAULT_TIMEOUT ): # In case the connect timeout has not yet been established. if self._start_connect is None: return self._read return max(0, min(self.total - self.get_connect_duration(), self._read)) - elif self.total is not None and self.total is not self.DEFAULT_TIMEOUT: + elif self.total is not None and self.total is not _DEFAULT_TIMEOUT: return max(0, self.total - self.get_connect_duration()) else: - return self._read + return self.resolve_default_timeout(self._read) diff --git a/newrelic/packages/urllib3/util/url.py b/newrelic/packages/urllib3/util/url.py index e5682d3be4..db057f17be 100644 --- a/newrelic/packages/urllib3/util/url.py +++ b/newrelic/packages/urllib3/util/url.py @@ -1,22 +1,20 @@ -from __future__ import absolute_import +from __future__ import annotations import re -from collections import namedtuple +import typing from ..exceptions import LocationParseError -from ..packages import six - -url_attrs = ["scheme", "auth", "host", "port", "path", "query", "fragment"] +from .util import to_str # We only want to normalize urls with an HTTP(S) scheme. # urllib3 infers URLs without a scheme (None) to be http. -NORMALIZABLE_SCHEMES = ("http", "https", None) +_NORMALIZABLE_SCHEMES = ("http", "https", None) # Almost all of these patterns were derived from the # 'rfc3986' module: https://github.com/python-hyper/rfc3986 -PERCENT_RE = re.compile(r"%[a-fA-F0-9]{2}") -SCHEME_RE = re.compile(r"^(?:[a-zA-Z][a-zA-Z0-9+-]*:|/)") -URI_RE = re.compile( +_PERCENT_RE = re.compile(r"%[a-fA-F0-9]{2}") +_SCHEME_RE = re.compile(r"^(?:[a-zA-Z][a-zA-Z0-9+-]*:|/)") +_URI_RE = re.compile( r"^(?:([a-zA-Z][a-zA-Z0-9+.-]*):)?" r"(?://([^\\/?#]*))?" r"([^?#]*)" @@ -25,10 +23,10 @@ re.UNICODE | re.DOTALL, ) -IPV4_PAT = r"(?:[0-9]{1,3}\.){3}[0-9]{1,3}" -HEX_PAT = "[0-9A-Fa-f]{1,4}" -LS32_PAT = "(?:{hex}:{hex}|{ipv4})".format(hex=HEX_PAT, ipv4=IPV4_PAT) -_subs = {"hex": HEX_PAT, "ls32": LS32_PAT} +_IPV4_PAT = r"(?:[0-9]{1,3}\.){3}[0-9]{1,3}" +_HEX_PAT = "[0-9A-Fa-f]{1,4}" +_LS32_PAT = "(?:{hex}:{hex}|{ipv4})".format(hex=_HEX_PAT, ipv4=_IPV4_PAT) +_subs = {"hex": _HEX_PAT, "ls32": _LS32_PAT} _variations = [ # 6( h16 ":" ) ls32 "(?:%(hex)s:){6}%(ls32)s", @@ -50,69 +48,78 @@ "(?:(?:%(hex)s:){0,6}%(hex)s)?::", ] -UNRESERVED_PAT = r"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789._\-~" -IPV6_PAT = "(?:" + "|".join([x % _subs for x in _variations]) + ")" -ZONE_ID_PAT = "(?:%25|%)(?:[" + UNRESERVED_PAT + "]|%[a-fA-F0-9]{2})+" -IPV6_ADDRZ_PAT = r"\[" + IPV6_PAT + r"(?:" + ZONE_ID_PAT + r")?\]" -REG_NAME_PAT = r"(?:[^\[\]%:/?#]|%[a-fA-F0-9]{2})*" -TARGET_RE = re.compile(r"^(/[^?#]*)(?:\?([^#]*))?(?:#.*)?$") +_UNRESERVED_PAT = r"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789._\-~" +_IPV6_PAT = "(?:" + "|".join([x % _subs for x in _variations]) + ")" +_ZONE_ID_PAT = "(?:%25|%)(?:[" + _UNRESERVED_PAT + "]|%[a-fA-F0-9]{2})+" +_IPV6_ADDRZ_PAT = r"\[" + _IPV6_PAT + r"(?:" + _ZONE_ID_PAT + r")?\]" +_REG_NAME_PAT = r"(?:[^\[\]%:/?#]|%[a-fA-F0-9]{2})*" +_TARGET_RE = re.compile(r"^(/[^?#]*)(?:\?([^#]*))?(?:#.*)?$") -IPV4_RE = re.compile("^" + IPV4_PAT + "$") -IPV6_RE = re.compile("^" + IPV6_PAT + "$") -IPV6_ADDRZ_RE = re.compile("^" + IPV6_ADDRZ_PAT + "$") -BRACELESS_IPV6_ADDRZ_RE = re.compile("^" + IPV6_ADDRZ_PAT[2:-2] + "$") -ZONE_ID_RE = re.compile("(" + ZONE_ID_PAT + r")\]$") +_IPV4_RE = re.compile("^" + _IPV4_PAT + "$") +_IPV6_RE = re.compile("^" + _IPV6_PAT + "$") +_IPV6_ADDRZ_RE = re.compile("^" + _IPV6_ADDRZ_PAT + "$") +_BRACELESS_IPV6_ADDRZ_RE = re.compile("^" + _IPV6_ADDRZ_PAT[2:-2] + "$") +_ZONE_ID_RE = re.compile("(" + _ZONE_ID_PAT + r")\]$") _HOST_PORT_PAT = ("^(%s|%s|%s)(?::0*?(|0|[1-9][0-9]{0,4}))?$") % ( - REG_NAME_PAT, - IPV4_PAT, - IPV6_ADDRZ_PAT, + _REG_NAME_PAT, + _IPV4_PAT, + _IPV6_ADDRZ_PAT, ) _HOST_PORT_RE = re.compile(_HOST_PORT_PAT, re.UNICODE | re.DOTALL) -UNRESERVED_CHARS = set( +_UNRESERVED_CHARS = set( "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789._-~" ) -SUB_DELIM_CHARS = set("!$&'()*+,;=") -USERINFO_CHARS = UNRESERVED_CHARS | SUB_DELIM_CHARS | {":"} -PATH_CHARS = USERINFO_CHARS | {"@", "/"} -QUERY_CHARS = FRAGMENT_CHARS = PATH_CHARS | {"?"} - - -class Url(namedtuple("Url", url_attrs)): +_SUB_DELIM_CHARS = set("!$&'()*+,;=") +_USERINFO_CHARS = _UNRESERVED_CHARS | _SUB_DELIM_CHARS | {":"} +_PATH_CHARS = _USERINFO_CHARS | {"@", "/"} +_QUERY_CHARS = _FRAGMENT_CHARS = _PATH_CHARS | {"?"} + + +class Url( + typing.NamedTuple( + "Url", + [ + ("scheme", typing.Optional[str]), + ("auth", typing.Optional[str]), + ("host", typing.Optional[str]), + ("port", typing.Optional[int]), + ("path", typing.Optional[str]), + ("query", typing.Optional[str]), + ("fragment", typing.Optional[str]), + ], + ) +): """ Data structure for representing an HTTP URL. Used as a return value for :func:`parse_url`. Both the scheme and host are normalized as they are both case-insensitive according to RFC 3986. """ - __slots__ = () - - def __new__( + def __new__( # type: ignore[no-untyped-def] cls, - scheme=None, - auth=None, - host=None, - port=None, - path=None, - query=None, - fragment=None, + scheme: str | None = None, + auth: str | None = None, + host: str | None = None, + port: int | None = None, + path: str | None = None, + query: str | None = None, + fragment: str | None = None, ): if path and not path.startswith("/"): path = "/" + path if scheme is not None: scheme = scheme.lower() - return super(Url, cls).__new__( - cls, scheme, auth, host, port, path, query, fragment - ) + return super().__new__(cls, scheme, auth, host, port, path, query, fragment) @property - def hostname(self): + def hostname(self) -> str | None: """For backwards-compatibility with urlparse. We're nice like that.""" return self.host @property - def request_uri(self): + def request_uri(self) -> str: """Absolute path including the query string.""" uri = self.path or "/" @@ -122,14 +129,37 @@ def request_uri(self): return uri @property - def netloc(self): - """Network location including host and port""" + def authority(self) -> str | None: + """ + Authority component as defined in RFC 3986 3.2. + This includes userinfo (auth), host and port. + + i.e. + userinfo@host:port + """ + userinfo = self.auth + netloc = self.netloc + if netloc is None or userinfo is None: + return netloc + else: + return f"{userinfo}@{netloc}" + + @property + def netloc(self) -> str | None: + """ + Network location including host and port. + + If you need the equivalent of urllib.parse's ``netloc``, + use the ``authority`` property instead. + """ + if self.host is None: + return None if self.port: - return "%s:%d" % (self.host, self.port) + return f"{self.host}:{self.port}" return self.host @property - def url(self): + def url(self) -> str: """ Convert self into a url @@ -138,88 +168,77 @@ def url(self): :func:`.parse_url`, but it should be equivalent by the RFC (e.g., urls with a blank port will have : removed). - Example: :: + Example: + + .. code-block:: python + + import urllib3 - >>> U = parse_url('http://google.com/mail/') - >>> U.url - 'http://google.com/mail/' - >>> Url('http', 'username:password', 'host.com', 80, - ... '/path', 'query', 'fragment').url - 'http://username:password@host.com:80/path?query#fragment' + U = urllib3.util.parse_url("https://google.com/mail/") + + print(U.url) + # "https://google.com/mail/" + + print( urllib3.util.Url("https", "username:password", + "host.com", 80, "/path", "query", "fragment" + ).url + ) + # "https://username:password@host.com:80/path?query#fragment" """ scheme, auth, host, port, path, query, fragment = self - url = u"" + url = "" # We use "is not None" we want things to happen with empty strings (or 0 port) if scheme is not None: - url += scheme + u"://" + url += scheme + "://" if auth is not None: - url += auth + u"@" + url += auth + "@" if host is not None: url += host if port is not None: - url += u":" + str(port) + url += ":" + str(port) if path is not None: url += path if query is not None: - url += u"?" + query + url += "?" + query if fragment is not None: - url += u"#" + fragment + url += "#" + fragment return url - def __str__(self): + def __str__(self) -> str: return self.url -def split_first(s, delims): - """ - .. deprecated:: 1.25 - - Given a string and an iterable of delimiters, split on the first found - delimiter. Return two split parts and the matched delimiter. - - If not found, then the first part is the full input string. - - Example:: - - >>> split_first('foo/bar?baz', '?/=') - ('foo', 'bar?baz', '/') - >>> split_first('foo/bar?baz', '123') - ('foo/bar?baz', '', None) - - Scales linearly with number of delims. Not ideal for large number of delims. - """ - min_idx = None - min_delim = None - for d in delims: - idx = s.find(d) - if idx < 0: - continue +@typing.overload +def _encode_invalid_chars( + component: str, allowed_chars: typing.Container[str] +) -> str: # Abstract + ... - if min_idx is None or idx < min_idx: - min_idx = idx - min_delim = d - if min_idx is None or min_idx < 0: - return s, "", None +@typing.overload +def _encode_invalid_chars( + component: None, allowed_chars: typing.Container[str] +) -> None: # Abstract + ... - return s[:min_idx], s[min_idx + 1 :], min_delim - -def _encode_invalid_chars(component, allowed_chars, encoding="utf-8"): +def _encode_invalid_chars( + component: str | None, allowed_chars: typing.Container[str] +) -> str | None: """Percent-encodes a URI component without reapplying onto an already percent-encoded component. """ if component is None: return component - component = six.ensure_text(component) + component = to_str(component) # Normalize existing percent-encoded bytes. # Try to see if the component we're encoding is already percent-encoded # so we can skip all '%' characters but still encode all others. - component, percent_encodings = PERCENT_RE.subn( + component, percent_encodings = _PERCENT_RE.subn( lambda match: match.group(0).upper(), component ) @@ -228,7 +247,7 @@ def _encode_invalid_chars(component, allowed_chars, encoding="utf-8"): encoded_component = bytearray() for i in range(0, len(uri_bytes)): - # Will return a single character bytestring on both Python 2 & 3 + # Will return a single character bytestring byte = uri_bytes[i : i + 1] byte_ord = ord(byte) if (is_percent_encoded and byte == b"%") or ( @@ -238,10 +257,10 @@ def _encode_invalid_chars(component, allowed_chars, encoding="utf-8"): continue encoded_component.extend(b"%" + (hex(byte_ord)[2:].encode().zfill(2).upper())) - return encoded_component.decode(encoding) + return encoded_component.decode() -def _remove_path_dot_segments(path): +def _remove_path_dot_segments(path: str) -> str: # See http://tools.ietf.org/html/rfc3986#section-5.2.4 for pseudo-code segments = path.split("/") # Turn the path into a list of segments output = [] # Initialize the variable to use to store output @@ -251,7 +270,7 @@ def _remove_path_dot_segments(path): if segment == ".": continue # Anything other than '..', should be appended to the output - elif segment != "..": + if segment != "..": output.append(segment) # In this case segment == '..', if we can, we should pop the last # element @@ -271,18 +290,23 @@ def _remove_path_dot_segments(path): return "/".join(output) -def _normalize_host(host, scheme): - if host: - if isinstance(host, six.binary_type): - host = six.ensure_str(host) +@typing.overload +def _normalize_host(host: None, scheme: str | None) -> None: ... + + +@typing.overload +def _normalize_host(host: str, scheme: str | None) -> str: ... + - if scheme in NORMALIZABLE_SCHEMES: - is_ipv6 = IPV6_ADDRZ_RE.match(host) +def _normalize_host(host: str | None, scheme: str | None) -> str | None: + if host: + if scheme in _NORMALIZABLE_SCHEMES: + is_ipv6 = _IPV6_ADDRZ_RE.match(host) if is_ipv6: # IPv6 hosts of the form 'a::b%zone' are encoded in a URL as # such per RFC 6874: 'a::b%25zone'. Unquote the ZoneID # separator as necessary to return a valid RFC 4007 scoped IP. - match = ZONE_ID_RE.search(host) + match = _ZONE_ID_RE.search(host) if match: start, end = match.span(1) zone_id = host[start:end] @@ -291,46 +315,56 @@ def _normalize_host(host, scheme): zone_id = zone_id[3:] else: zone_id = zone_id[1:] - zone_id = "%" + _encode_invalid_chars(zone_id, UNRESERVED_CHARS) - return host[:start].lower() + zone_id + host[end:] + zone_id = _encode_invalid_chars(zone_id, _UNRESERVED_CHARS) + return f"{host[:start].lower()}%{zone_id}{host[end:]}" else: return host.lower() - elif not IPV4_RE.match(host): - return six.ensure_str( - b".".join([_idna_encode(label) for label in host.split(".")]) + elif not _IPV4_RE.match(host): + return to_str( + b".".join([_idna_encode(label) for label in host.split(".")]), + "ascii", ) return host -def _idna_encode(name): - if name and any(ord(x) >= 128 for x in name): +def _idna_encode(name: str) -> bytes: + if not name.isascii(): try: import idna except ImportError: - six.raise_from( - LocationParseError("Unable to parse URL without the 'idna' module"), - None, - ) + raise LocationParseError( + "Unable to parse URL without the 'idna' module" + ) from None + try: return idna.encode(name.lower(), strict=True, std3_rules=True) except idna.IDNAError: - six.raise_from( - LocationParseError(u"Name '%s' is not a valid IDNA label" % name), None - ) + raise LocationParseError( + f"Name '{name}' is not a valid IDNA label" + ) from None + return name.lower().encode("ascii") -def _encode_target(target): - """Percent-encodes a request target so that there are no invalid characters""" - path, query = TARGET_RE.match(target).groups() - target = _encode_invalid_chars(path, PATH_CHARS) - query = _encode_invalid_chars(query, QUERY_CHARS) +def _encode_target(target: str) -> str: + """Percent-encodes a request target so that there are no invalid characters + + Pre-condition for this function is that 'target' must start with '/'. + If that is the case then _TARGET_RE will always produce a match. + """ + match = _TARGET_RE.match(target) + if not match: # Defensive: + raise LocationParseError(f"{target!r} is not a valid request URI") + + path, query = match.groups() + encoded_target = _encode_invalid_chars(path, _PATH_CHARS) if query is not None: - target += "?" + query - return target + query = _encode_invalid_chars(query, _QUERY_CHARS) + encoded_target += "?" + query + return encoded_target -def parse_url(url): +def parse_url(url: str) -> Url: """ Given a url, return a parsed :class:`.Url` namedtuple. Best-effort is performed to parse incomplete urls. Fields not provided will be None. @@ -341,28 +375,44 @@ def parse_url(url): :param str url: URL to parse into a :class:`.Url` namedtuple. - Partly backwards-compatible with :mod:`urlparse`. + Partly backwards-compatible with :mod:`urllib.parse`. - Example:: + Example: - >>> parse_url('http://google.com/mail/') - Url(scheme='http', host='google.com', port=None, path='/mail/', ...) - >>> parse_url('google.com:80') - Url(scheme=None, host='google.com', port=80, path=None, ...) - >>> parse_url('/foo?bar') - Url(scheme=None, host=None, port=None, path='/foo', query='bar', ...) + .. code-block:: python + + import urllib3 + + print( urllib3.util.parse_url('http://google.com/mail/')) + # Url(scheme='http', host='google.com', port=None, path='/mail/', ...) + + print( urllib3.util.parse_url('google.com:80')) + # Url(scheme=None, host='google.com', port=80, path=None, ...) + + print( urllib3.util.parse_url('/foo?bar')) + # Url(scheme=None, host=None, port=None, path='/foo', query='bar', ...) """ if not url: # Empty return Url() source_url = url - if not SCHEME_RE.search(url): + if not _SCHEME_RE.search(url): url = "//" + url + scheme: str | None + authority: str | None + auth: str | None + host: str | None + port: str | None + port_int: int | None + path: str | None + query: str | None + fragment: str | None + try: - scheme, authority, path, query, fragment = URI_RE.match(url).groups() - normalize_uri = scheme is None or scheme.lower() in NORMALIZABLE_SCHEMES + scheme, authority, path, query, fragment = _URI_RE.match(url).groups() # type: ignore[union-attr] + normalize_uri = scheme is None or scheme.lower() in _NORMALIZABLE_SCHEMES if scheme: scheme = scheme.lower() @@ -370,31 +420,33 @@ def parse_url(url): if authority: auth, _, host_port = authority.rpartition("@") auth = auth or None - host, port = _HOST_PORT_RE.match(host_port).groups() + host, port = _HOST_PORT_RE.match(host_port).groups() # type: ignore[union-attr] if auth and normalize_uri: - auth = _encode_invalid_chars(auth, USERINFO_CHARS) + auth = _encode_invalid_chars(auth, _USERINFO_CHARS) if port == "": port = None else: auth, host, port = None, None, None if port is not None: - port = int(port) - if not (0 <= port <= 65535): + port_int = int(port) + if not (0 <= port_int <= 65535): raise LocationParseError(url) + else: + port_int = None host = _normalize_host(host, scheme) if normalize_uri and path: path = _remove_path_dot_segments(path) - path = _encode_invalid_chars(path, PATH_CHARS) + path = _encode_invalid_chars(path, _PATH_CHARS) if normalize_uri and query: - query = _encode_invalid_chars(query, QUERY_CHARS) + query = _encode_invalid_chars(query, _QUERY_CHARS) if normalize_uri and fragment: - fragment = _encode_invalid_chars(fragment, FRAGMENT_CHARS) + fragment = _encode_invalid_chars(fragment, _FRAGMENT_CHARS) - except (ValueError, AttributeError): - return six.raise_from(LocationParseError(source_url), None) + except (ValueError, AttributeError) as e: + raise LocationParseError(source_url) from e # For the sake of backwards compatibility we put empty # string values for path if there are any defined values @@ -406,30 +458,12 @@ def parse_url(url): else: path = None - # Ensure that each part of the URL is a `str` for - # backwards compatibility. - if isinstance(url, six.text_type): - ensure_func = six.ensure_text - else: - ensure_func = six.ensure_str - - def ensure_type(x): - return x if x is None else ensure_func(x) - return Url( - scheme=ensure_type(scheme), - auth=ensure_type(auth), - host=ensure_type(host), - port=port, - path=ensure_type(path), - query=ensure_type(query), - fragment=ensure_type(fragment), + scheme=scheme, + auth=auth, + host=host, + port=port_int, + path=path, + query=query, + fragment=fragment, ) - - -def get_host(url): - """ - Deprecated. Use :func:`parse_url` instead. - """ - p = parse_url(url) - return p.scheme or "http", p.hostname, p.port diff --git a/newrelic/packages/urllib3/util/util.py b/newrelic/packages/urllib3/util/util.py new file mode 100644 index 0000000000..35c77e4025 --- /dev/null +++ b/newrelic/packages/urllib3/util/util.py @@ -0,0 +1,42 @@ +from __future__ import annotations + +import typing +from types import TracebackType + + +def to_bytes( + x: str | bytes, encoding: str | None = None, errors: str | None = None +) -> bytes: + if isinstance(x, bytes): + return x + elif not isinstance(x, str): + raise TypeError(f"not expecting type {type(x).__name__}") + if encoding or errors: + return x.encode(encoding or "utf-8", errors=errors or "strict") + return x.encode() + + +def to_str( + x: str | bytes, encoding: str | None = None, errors: str | None = None +) -> str: + if isinstance(x, str): + return x + elif not isinstance(x, bytes): + raise TypeError(f"not expecting type {type(x).__name__}") + if encoding or errors: + return x.decode(encoding or "utf-8", errors=errors or "strict") + return x.decode() + + +def reraise( + tp: type[BaseException] | None, + value: BaseException, + tb: TracebackType | None = None, +) -> typing.NoReturn: + try: + if value.__traceback__ is not tb: + raise value.with_traceback(tb) + raise value + finally: + value = None # type: ignore[assignment] + tb = None diff --git a/newrelic/packages/urllib3/util/wait.py b/newrelic/packages/urllib3/util/wait.py index 21b4590b3d..aeca0c7ad5 100644 --- a/newrelic/packages/urllib3/util/wait.py +++ b/newrelic/packages/urllib3/util/wait.py @@ -1,18 +1,10 @@ -import errno +from __future__ import annotations + import select -import sys +import socket from functools import partial -try: - from time import monotonic -except ImportError: - from time import time as monotonic - -__all__ = ["NoWayToWaitForSocketError", "wait_for_read", "wait_for_write"] - - -class NoWayToWaitForSocketError(Exception): - pass +__all__ = ["wait_for_read", "wait_for_write"] # How should we wait on sockets? @@ -37,37 +29,13 @@ class NoWayToWaitForSocketError(Exception): # So: on Windows we use select(), and everywhere else we use poll(). We also # fall back to select() in case poll() is somehow broken or missing. -if sys.version_info >= (3, 5): - # Modern Python, that retries syscalls by default - def _retry_on_intr(fn, timeout): - return fn(timeout) - -else: - # Old and broken Pythons. - def _retry_on_intr(fn, timeout): - if timeout is None: - deadline = float("inf") - else: - deadline = monotonic() + timeout - - while True: - try: - return fn(timeout) - # OSError for 3 <= pyver < 3.5, select.error for pyver <= 2.7 - except (OSError, select.error) as e: - # 'e.args[0]' incantation works for both OSError and select.error - if e.args[0] != errno.EINTR: - raise - else: - timeout = deadline - monotonic() - if timeout < 0: - timeout = 0 - if timeout == float("inf"): - timeout = None - continue - - -def select_wait_for_socket(sock, read=False, write=False, timeout=None): + +def select_wait_for_socket( + sock: socket.socket, + read: bool = False, + write: bool = False, + timeout: float | None = None, +) -> bool: if not read and not write: raise RuntimeError("must specify at least one of read=True, write=True") rcheck = [] @@ -82,11 +50,16 @@ def select_wait_for_socket(sock, read=False, write=False, timeout=None): # sockets for both conditions. (The stdlib selectors module does the same # thing.) fn = partial(select.select, rcheck, wcheck, wcheck) - rready, wready, xready = _retry_on_intr(fn, timeout) + rready, wready, xready = fn(timeout) return bool(rready or wready or xready) -def poll_wait_for_socket(sock, read=False, write=False, timeout=None): +def poll_wait_for_socket( + sock: socket.socket, + read: bool = False, + write: bool = False, + timeout: float | None = None, +) -> bool: if not read and not write: raise RuntimeError("must specify at least one of read=True, write=True") mask = 0 @@ -98,32 +71,33 @@ def poll_wait_for_socket(sock, read=False, write=False, timeout=None): poll_obj.register(sock, mask) # For some reason, poll() takes timeout in milliseconds - def do_poll(t): + def do_poll(t: float | None) -> list[tuple[int, int]]: if t is not None: t *= 1000 return poll_obj.poll(t) - return bool(_retry_on_intr(do_poll, timeout)) - - -def null_wait_for_socket(*args, **kwargs): - raise NoWayToWaitForSocketError("no select-equivalent available") + return bool(do_poll(timeout)) -def _have_working_poll(): +def _have_working_poll() -> bool: # Apparently some systems have a select.poll that fails as soon as you try # to use it, either due to strange configuration or broken monkeypatching # from libraries like eventlet/greenlet. try: poll_obj = select.poll() - _retry_on_intr(poll_obj.poll, 0) + poll_obj.poll(0) except (AttributeError, OSError): return False else: return True -def wait_for_socket(*args, **kwargs): +def wait_for_socket( + sock: socket.socket, + read: bool = False, + write: bool = False, + timeout: float | None = None, +) -> bool: # We delay choosing which implementation to use until the first time we're # called. We could do it at import time, but then we might make the wrong # decision if someone goes wild with monkeypatching select.poll after @@ -133,19 +107,17 @@ def wait_for_socket(*args, **kwargs): wait_for_socket = poll_wait_for_socket elif hasattr(select, "select"): wait_for_socket = select_wait_for_socket - else: # Platform-specific: Appengine. - wait_for_socket = null_wait_for_socket - return wait_for_socket(*args, **kwargs) + return wait_for_socket(sock, read, write, timeout) -def wait_for_read(sock, timeout=None): +def wait_for_read(sock: socket.socket, timeout: float | None = None) -> bool: """Waits for reading to be available on a given socket. Returns True if the socket is readable, or False if the timeout expired. """ return wait_for_socket(sock, read=True, timeout=timeout) -def wait_for_write(sock, timeout=None): +def wait_for_write(sock: socket.socket, timeout: float | None = None) -> bool: """Waits for writing to be available on a given socket. Returns True if the socket is readable, or False if the timeout expired. """ diff --git a/newrelic/packages/wrapt/LICENSE b/newrelic/packages/wrapt/LICENSE index d49cae8439..643f6fe280 100644 --- a/newrelic/packages/wrapt/LICENSE +++ b/newrelic/packages/wrapt/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2013-2019, Graham Dumpleton +Copyright (c) 2013-2025, Graham Dumpleton All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/newrelic/packages/wrapt/__init__.py b/newrelic/packages/wrapt/__init__.py index 3735818c61..fe7730c0b9 100644 --- a/newrelic/packages/wrapt/__init__.py +++ b/newrelic/packages/wrapt/__init__.py @@ -2,7 +2,7 @@ Wrapt is a library for decorators, wrappers and monkey patching. """ -__version_info__ = ("2", "0", "0") +__version_info__ = ("2", "0", "1") __version__ = ".".join(__version_info__) from .__wrapt__ import ( @@ -53,6 +53,7 @@ "when_imported", "apply_patch", "function_wrapper", + "lazy_import", "patch_function_wrapper", "resolve_path", "transient_function_wrapper", diff --git a/newrelic/packages/wrapt/__init__.pyi b/newrelic/packages/wrapt/__init__.pyi index 31ba64ca10..2e33e00e7f 100644 --- a/newrelic/packages/wrapt/__init__.pyi +++ b/newrelic/packages/wrapt/__init__.pyi @@ -37,12 +37,16 @@ if sys.version_info >= (3, 10): # LazyObjectProxy class LazyObjectProxy(AutoObjectProxy[T]): - def __init__(self, callback: Callable[[], T] | None) -> None: ... + def __init__( + self, callback: Callable[[], T] | None, *, interface: Any = ... + ) -> None: ... @overload def lazy_import(name: str) -> LazyObjectProxy[ModuleType]: ... @overload - def lazy_import(name: str, attribute: str) -> LazyObjectProxy[Any]: ... + def lazy_import( + name: str, attribute: str, *, interface: Any = ... + ) -> LazyObjectProxy[Any]: ... # CallableObjectProxy diff --git a/newrelic/packages/wrapt/proxies.py b/newrelic/packages/wrapt/proxies.py index 60261da21a..fbb6c9e39a 100644 --- a/newrelic/packages/wrapt/proxies.py +++ b/newrelic/packages/wrapt/proxies.py @@ -1,5 +1,8 @@ """Variants of ObjectProxy for different use cases.""" +from collections.abc import Callable +from types import ModuleType + from .__wrapt__ import BaseObjectProxy from .decorators import synchronized @@ -30,7 +33,12 @@ def __iter__(self): # object and add special dunder methods. -def __wrapper_call__(self, *args, **kwargs): +def __wrapper_call__(*args, **kwargs): + def _unpack_self(self, *args): + return self, args + + self, args = _unpack_self(*args) + return self.__wrapped__(*args, **kwargs) @@ -136,7 +144,7 @@ def __new__(cls, wrapped): if cls is AutoObjectProxy: name = BaseObjectProxy.__name__ - return super().__new__(type(name, (cls,), namespace)) + return super(AutoObjectProxy, cls).__new__(type(name, (cls,), namespace)) def __wrapped_setattr_fixups__(self): """Adjusts special dunder methods on the class as needed based on the @@ -218,10 +226,64 @@ class LazyObjectProxy(AutoObjectProxy): when it is first needed. """ - def __new__(cls, callback=None): - return super().__new__(cls, None) + def __new__(cls, callback=None, *, interface=...): + """Injects special dunder methods into a dynamically created subclass + as needed based on the wrapped object. + """ + + if interface is ...: + interface = type(None) + + namespace = {} + + interface_attrs = dir(interface) + class_attrs = set(dir(cls)) + + if "__call__" in interface_attrs and "__call__" not in class_attrs: + namespace["__call__"] = __wrapper_call__ + + if "__iter__" in interface_attrs and "__iter__" not in class_attrs: + namespace["__iter__"] = __wrapper_iter__ + + if "__next__" in interface_attrs and "__next__" not in class_attrs: + namespace["__next__"] = __wrapper_next__ + + if "__aiter__" in interface_attrs and "__aiter__" not in class_attrs: + namespace["__aiter__"] = __wrapper_aiter__ + + if "__anext__" in interface_attrs and "__anext__" not in class_attrs: + namespace["__anext__"] = __wrapper_anext__ - def __init__(self, callback=None): + if ( + "__length_hint__" in interface_attrs + and "__length_hint__" not in class_attrs + ): + namespace["__length_hint__"] = __wrapper_length_hint__ + + # Note that not providing compatibility with generator-based coroutines + # (PEP 342) here as they are removed in Python 3.11+ and were deprecated + # in 3.8. + + if "__await__" in interface_attrs and "__await__" not in class_attrs: + namespace["__await__"] = __wrapper_await__ + + if "__get__" in interface_attrs and "__get__" not in class_attrs: + namespace["__get__"] = __wrapper_get__ + + if "__set__" in interface_attrs and "__set__" not in class_attrs: + namespace["__set__"] = __wrapper_set__ + + if "__delete__" in interface_attrs and "__delete__" not in class_attrs: + namespace["__delete__"] = __wrapper_delete__ + + if "__set_name__" in interface_attrs and "__set_name__" not in class_attrs: + namespace["__set_name__"] = __wrapper_set_name__ + + name = cls.__name__ + + return super(AutoObjectProxy, cls).__new__(type(name, (cls,), namespace)) + + def __init__(self, callback=None, *, interface=...): """Initialize the object proxy with wrapped object as `None` but due to presence of special `__wrapped_factory__` attribute addded first, this will actually trigger the deferred creation of the wrapped object @@ -263,7 +325,7 @@ def __wrapped_get__(self): return self.__wrapped__ -def lazy_import(name, attribute=None): +def lazy_import(name, attribute=None, *, interface=...): """Lazily imports the module `name`, returning a `LazyObjectProxy` which will import the module when it is first needed. When `name is a dotted name, then the full dotted name is imported and the last module is taken as the @@ -271,6 +333,13 @@ def lazy_import(name, attribute=None): from the module. """ + if attribute is not None: + if interface is ...: + interface = Callable + else: + if interface is ...: + interface = ModuleType + def _import(): module = __import__(name, fromlist=[""]) @@ -279,4 +348,4 @@ def _import(): return module - return LazyObjectProxy(_import) + return LazyObjectProxy(_import, interface=interface) diff --git a/pyproject.toml b/pyproject.toml index d7a9076a82..8b64b37772 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -78,14 +78,13 @@ packages = [ "newrelic.packages", "newrelic.packages.isort", "newrelic.packages.isort.stdlibs", + "newrelic.packages.opentelemetry_proto", "newrelic.packages.urllib3", - "newrelic.packages.urllib3.util", "newrelic.packages.urllib3.contrib", - "newrelic.packages.urllib3.contrib._securetransport", - "newrelic.packages.urllib3.packages", - "newrelic.packages.urllib3.packages.backports", + "newrelic.packages.urllib3.contrib.emscripten", + "newrelic.packages.urllib3.http2", + "newrelic.packages.urllib3.util", "newrelic.packages.wrapt", - "newrelic.packages.opentelemetry_proto", "newrelic.samplers", ] diff --git a/setup.py b/setup.py index 486ffd778b..45fff5674b 100644 --- a/setup.py +++ b/setup.py @@ -114,14 +114,13 @@ def build_extension(self, ext): "newrelic.packages", "newrelic.packages.isort", "newrelic.packages.isort.stdlibs", + "newrelic.packages.opentelemetry_proto", "newrelic.packages.urllib3", - "newrelic.packages.urllib3.util", "newrelic.packages.urllib3.contrib", - "newrelic.packages.urllib3.contrib._securetransport", - "newrelic.packages.urllib3.packages", - "newrelic.packages.urllib3.packages.backports", + "newrelic.packages.urllib3.contrib.emscripten", + "newrelic.packages.urllib3.http2", + "newrelic.packages.urllib3.util", "newrelic.packages.wrapt", - "newrelic.packages.opentelemetry_proto", "newrelic.samplers", ] diff --git a/tests/testing_support/certs/cert.pem b/tests/testing_support/certs/cert.pem index 0bbbf3a170..f56002fbb9 100644 --- a/tests/testing_support/certs/cert.pem +++ b/tests/testing_support/certs/cert.pem @@ -1,51 +1,87 @@ This is not a secret key! This private key is used only for testing and is not functionally used in the agent. To generate a new key and certificate, use the following. -openssl req -nodes -newkey rsa:2048 -x509 -keyout key.pem -out cert.pem -subj '/CN=localhost' -days 3650 +openssl req -noenc -newkey rsa:4096 -x509 -keyout cert.pem -out cert.pem -subj '/CN=localhost' -days 3650 -addext "subjectAltName = DNS.1:localhost,IP.1:127.0.0.1" + -----BEGIN PRIVATE KEY----- -MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDYF0U/0zXikonW -Ez532avkDL1QbQ8Yz5ULMwZz8j+cLEhdw/4pQJ7Dox6KEZbsan1nZZqpcZWT0d39 -aY/AQ9udwZT+G4biRCQQHd3IaYdveDuq/MQXEiDmcs1CpCwyWjmfRnjCm2/c8wdW -JCBaRq1hG/hsZ5UKhJxIA9BUl3qPizr7qU/VwNK8+8QQ28EsnUrkLDPL2x1fkIzy -XR89d/NO97a02YV7WwEf8GH9gB0KLhIZzDDh/BM3olHc1BRlaqkATcuxPbWqKH53 -HqL5Wi9O8Pxe9OSBXbAOSlBhmRRUVFx4siRNV+Bkv3VOBCUtk2/5SQwJdxfkICbP -0YlrBPqFAgMBAAECggEBAKzbiJiy0xMIl9w4jqr+4+LMUhBo/T+iph5MVeggK8Q5 -JDZllwXW3GmxLbfStEEwOlqgy2SqKLYTlpmlfMmXPrHmbdILoQ2U5qhBy+0Khb2k -l06DXjT6Wnkd8pZRj81DoX6IuAcsogJEImVFBuBQU1cwMbw969p7FC0DZ/6TIgZ6 -KHvm5Z43uy/wcbHFa2PoMaVvyutKun1po3NG90FlVMJmQYiph2V4/kxcZo8wWXU2 -hE8cbL2g1pv60ZF3wZTWWhnSZTRB2uesW0opNmpwcqqQjQOczJ91y8B4BIjy1QTD -ICxUO9pEtOexNi3/JnzreByHxQt5g7wINbYxFk8MR40CgYEA751xj/B6jut3NMmr -bTLngjE1IAjv/8xEXKhfDAp6fgyU+ATbD8ysIllkch/k2Q0boiIB+XoQ/+KqB/pC -iGw6cGtY3ZF75u/NokHMhQVtHIu3CDbNYSCCtLekG3osXfZaaD4QJVHSrgBYkmez -Ty7my+Sub+uqizz4fK2DUmBpDyMCgYEA5t4HJRgCRQzz340ou+H63QoN5P1x5FlP -M8QpklclpU+dOJsbvmcHzbZJgvuZb6Vt18LuUYLWGeVRrpvUVCapJecklbnNF3wL -YIehBDIiJd2Qq8rbg+yKjNTElbaDWJP+RqPX8IGfvGr23Lsw34vDj/d7N9Ch6xm5 -XChbVCi6/jcCgYB0RhhnWrB+TfDIotwW307MNIitBOlBXaQGuoV02FjcdcqMF/8d -SZp2CJ7fam6ojN3N7Wa74uoA4cLUoDJM9QfeqZiz2/cd91v30qomGp357iphSAad -jSMgAsUVuFFzPypbz1ISagQr/2r7kGrIj9/bLRsgoGFfs7R4+9Hv1WzltQKBgEof -BKo7IBdtRisC1g4kSneHD9jyKgvHRK95DmPGiPafLfoLiofB6nZ4TPe5sZRvx2lb -U0pmODkOMABgVXZDB1F8+Xj8s0UT9U8jnGWNdvszPIx7T6j2W7FFamwqsdbRhPTH -C8BSzacfrGxHyTQsWjgxm6Ta3fFuS92zs0a84PRXAoGANEm47fczWIdWR0SmuEoL -gIGLBi8b2nKZWIeATNwTyWWvD/jEJJXIdjXYxYMK3iG0CCXIColvfoqzEKfNCkz4 -p5wl5yH6EOI+QVISNq7ovrtgLXpUUPPXA/FjYk74e5ITAd5Ute3nB32bX0jPQCGN -cXIVO2dC+mN517lRVQyF/GQ= +MIIJQwIBADANBgkqhkiG9w0BAQEFAASCCS0wggkpAgEAAoICAQDk8E5vrgXW21uo ++cqOQlotxS5w3q7y7YyVTbYgbHF/SlIdu4HpY4ycEnAjKYrAiPD5bWPIZhK0wHL0 +DQ5SqKw+zRBV+xRpubpRZrpYVjTwR/X26PEnhUZfikLk5/1Y88WGV0UcLzPk6Prx +IAd6w/s2I3hrg/ZKR0p6NHXB/0dabY9OPdX2wdR6Xg5Rd/+RHyvgXnxUxK2DfDBv +kp15wYHaLTMmcxrDEMYa0mh27tuXwtf7NyWBieJ9RvHasgxCkzdoYRwYc4qMCBOO +F7W9Q4LL79rMyJ3NdNcvT9moJmz0W8wuLcC5aXFpxOG1aj1ipZkaVQ8aflVl7M1H +Ug/PCBtXiieSR+58BoQNhG/wP0Qm2HZp+PQ33vX1/s5iQCeBSRizdi4Xf4p+glWt +f1vWDo0SjWDIDUif+HTu4oC/2ka2PJW5tLy6c02pbtMPFAgUg0Ep8CL8kx4iUORc +OJtiGvA4eaZTC8rQkVXh2c0uS4645QBEmOoYSNcx3KgggTcxHMMo6aW8+F3dQt8d +7YYp3YMXzZ2QNnGXIP8shUJjdz34XLErI/L19wycHtIqa4Hbtxl48e5XXzTORIJ3 +icDmIyne6Q0P7a/mYzjfFsXFuK8R+ogK+PqHSHnCIUjNmUxdPQ92C9jaEJ1/HFyf +bHGXHLP4hc5MD/kJ+7icbDeQSHZm7wIDAQABAoICAA8IhqYHv+NpeR3h9T6dNc2+ +nnuT69oQ5kPhm/2KEXPh3f2M1A2O12tiPJHahv14oJZIbB57MWxEHOhQuSmNYO4o +yhNTTvZYV1dEDyWA164Vk524kylcs4/PhPACGd1O+KAHOAcPRHGaKOxPhZ42o1bd +QmmQ+0nKX6Yhrr/j8vwJqLjjD5tKBBla9sa7wgD2EowDuFdaqOgy7f1Nm+CkZ9H7 +WNoEAfRgNBoLygdRTQMsrMEW0HQuqTw/vd72BR8UCrXkdpNWdvkWCK6yeOEqPzsE +D5KV8+LLctvs+uZzS4FKS+CWaYrjVSq0Xnvqs4g4RpL3levP8uyj/aDazyXxqtXX +dNJgWPX9Jer90JIUY7lnpxe/W1gW5qU1Q8g9XaYACIGJlUQAYLcRjnFZcIIG9579 +LW4J3DCw3/D93QQTD4j4xKyhBoAPEkaHaKp5RXe7Yw9XfXD5zGMGEvAZcXCxHaV1 +Hq5hJYULmjgukKhYUYGjN8UPezrg/4Jd/wOLee9ItTdlD3ihAp2MyDriMeGH41MO +zb+m63iazoT6bT5aMDm1cFUoaVx+WVVQr8S47jQr8c6pyoj2CYzP6t/J6ac0+grW +agp2RZNyLx5aMfAJt9plPKtLvsq2lC4eFL1ZMw4XJMEwEewlcDYGuLirGlDiSsOM +VtIheTqQftdcvS6i6/K1AoIBAQD1vHZtH3aVzZpH6Cwa9+ZdghAmX8e4boDe8Ra9 +q04+I1DHZAYUsxuP+0d6G/yQA9ihGay8Y/GwQCW+Kpss3RESUma/xbufS1+3PNXM +sSyo/PC90zUkN+dXdsK+aGbxv/22XYp7m0ieftorf/sWRCsmjE2vMdqG6mwWDolE +IIknhE/huc6T+QPPNc1AvOOGpA+dk94YkfW8zDVrqdbJPEBNt0KyXT5XTwyI8kPO +J84nn4iQijfQDEZDxKQifuNyJpjTpytf3mmLs8NpBUzhWe7Fhh5kTV9gvtZdWOq2 +AWZqw8DGjKhDKWNmuANNyoiwErLIaInIybnh8nIl0wgKLLR9AoIBAQDugDyIT4WR +URtNNmy6koSCqHtYoIv5wGjJT+zUBJwdZiNLbcysFcp/GPBz196FuZ8AoICD1HAd +ZdcaZtzXyk8KVv2NXIinbwXzemQc1wJzoo4rg2pSl4pU5A527M8MYHf9AfcArjnO +TK1kqrfVrPJpVVeX4PfRTw1eD0CoGxoiPzp0C9Wd/fbI44rjDUi7h+rSzeoc+VO+ +uueTxJUpG/0F9ieS9KIyRBRq5ALFCJwkA+lTT45CXFK8FUI1pkwt48lnDOiM+7XI +4eejnzSKmfyBeTjoMK7UBEksX8E43q55X2h77ezlUOySDizUvdcnrSZD7xXPLeIJ +kdNUqrQymADbAoIBAQCt4gvSr57T5caz9x+ufZgutqgC32eNo/PgzawPzjXxVkAE +t0xuPUbVnTM4vrD6nx4c8PP/4qDU3K9YXwGqv0sjMdeu/5YB4+341T1cOEqn0UPw +rpE97ajvhQPMhEfD7Nz0vEAPsxOxw4VRnp/nY5k9D66wt5AwQ5T0Dpkm8fbbVY7I +5Re+MUh2yVVR59cAIPtDv6w6qp2+WKm8Y1Ou1cmStIineb9xPGhcR0GfkR8ZfpO9 +43AW8XiO34hdOHhs/87IhdP1ZIY+6pbtq2h5VY/ViU/cHbvN03wQVajP3THBfn7c +gA9YZuMFflQoKZaLMM/9a6uDvuqfbVVEWo2n1XZpAoIBAFqDgHWa+G32Ag6DoTAN +ewy7NFSmWXkndJ0yIAc22KivoqV1vj9w5bDmnhrYyjKmB5oNT7i4XvRJOiFi+F1N +AkJCUWfcvmAM2o1U3bm0P9Hy11HcRfWiXXVqN7ManFluIxt6K2uus3F/2C5kO/Bz ++mvPX7bcQjDFd6VC1J736islI+H2u9OCFq6W7JbO69N/+baXP0pPtWClPk3uRU2c +uaIRkWNMRGIfREBs2EA+zEM+2MYtYyf8Mcn/p2kE+9ROppjdZURcItliIq8ONLqF +Rjc88kPsde0w0zRsAsC6giy98MFXwpgk5iNoDcuPYKBGLkeJ7RT7rNVE6pcvUcQB +vBECggEBAKyRPnOASM6n2WagyvkzNYFOhcPR/XmcBoiJdVE+XIJXmhXk7/sctxNU +BrMlawTZZOyHSqnIQ47bO+M+6YF4q3avdsqJjSPuhgDSHkEr5kuzoMbHCro5xKQ/ +Gi/TkgO+Orf6s5q1SubLA5Oe2DHFX6GVBWMpk3iqFkViJ9Vowndnu8CdewW9UGmI +zoobm3k9yqk/f7WnM4mzEFm4LW1j2Ke21frpsqqL6BTDsJrcT/E+8mW4NLjjGuAT +du74BILJK4MbvZAR+nTj0bMQukaVVNvFgETfXnTyK/rzM7w3f98g141IddAQd48e +IF6rWffrLUSEs02xLX3zXw56FK2qLbo= -----END PRIVATE KEY----- -----BEGIN CERTIFICATE----- -MIIDCTCCAfGgAwIBAgIUbytSUISOZeaoqVCzd/zLDhQgZ1owDQYJKoZIhvcNAQEL -BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTIxMDMwMzAxMzY1MloXDTMxMDMw -MTAxMzY1MlowFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEF -AAOCAQ8AMIIBCgKCAQEA2BdFP9M14pKJ1hM+d9mr5Ay9UG0PGM+VCzMGc/I/nCxI -XcP+KUCew6MeihGW7Gp9Z2WaqXGVk9Hd/WmPwEPbncGU/huG4kQkEB3dyGmHb3g7 -qvzEFxIg5nLNQqQsMlo5n0Z4wptv3PMHViQgWkatYRv4bGeVCoScSAPQVJd6j4s6 -+6lP1cDSvPvEENvBLJ1K5Cwzy9sdX5CM8l0fPXfzTve2tNmFe1sBH/Bh/YAdCi4S -Gcww4fwTN6JR3NQUZWqpAE3LsT21qih+dx6i+VovTvD8XvTkgV2wDkpQYZkUVFRc -eLIkTVfgZL91TgQlLZNv+UkMCXcX5CAmz9GJawT6hQIDAQABo1MwUTAdBgNVHQ4E -FgQUiC/0q2fQCAYC01Opw5iDBfhLNPQwHwYDVR0jBBgwFoAUiC/0q2fQCAYC01Op -w5iDBfhLNPQwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAaxSo -gJh6X/ywmT3BXcS15MlAXufMm3uybVbMZjPszZ+vIPF65oelAbSnw/+JHp77fF7F -Erv19MGY8IlMEeUf9agXRF6JNVJD7N3i3zE/2GXoer9UOHQqz5/WWs4F17FAmZW8 -YkzMA70GVa20RedIMreEUxxIyN2eUL8xLfs3E9DEYovOldKfC0Ie1BHFMBhp1tja -6Ag91xyPqP9Pw9ofgS0DoYq6m2ltDNXLoWep1yi1OTwiTvI+GD6JJhmWbCjK0ofA -IkJENYq5tKA6yvQ2Roi9o6oixDJP/SGQtUKPGGRoFcN9gqn+IVC2XmvxHzTOxUWr -/FMyhRqe1k81s3T2hg== +MIIFJTCCAw2gAwIBAgIUPbDuIqZQBhN2JA/3iL3+FydryBcwDQYJKoZIhvcNAQEL +BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTI1MTIxNzE3MTUxOFoXDTM1MTIx +NTE3MTUxOFowFDESMBAGA1UEAwwJbG9jYWxob3N0MIICIjANBgkqhkiG9w0BAQEF +AAOCAg8AMIICCgKCAgEA5PBOb64F1ttbqPnKjkJaLcUucN6u8u2MlU22IGxxf0pS +HbuB6WOMnBJwIymKwIjw+W1jyGYStMBy9A0OUqisPs0QVfsUabm6UWa6WFY08Ef1 +9ujxJ4VGX4pC5Of9WPPFhldFHC8z5Oj68SAHesP7NiN4a4P2SkdKejR1wf9HWm2P +Tj3V9sHUel4OUXf/kR8r4F58VMStg3wwb5KdecGB2i0zJnMawxDGGtJodu7bl8LX ++zclgYnifUbx2rIMQpM3aGEcGHOKjAgTjhe1vUOCy+/azMidzXTXL0/ZqCZs9FvM +Li3AuWlxacThtWo9YqWZGlUPGn5VZezNR1IPzwgbV4onkkfufAaEDYRv8D9EJth2 +afj0N9719f7OYkAngUkYs3YuF3+KfoJVrX9b1g6NEo1gyA1In/h07uKAv9pGtjyV +ubS8unNNqW7TDxQIFINBKfAi/JMeIlDkXDibYhrwOHmmUwvK0JFV4dnNLkuOuOUA +RJjqGEjXMdyoIIE3MRzDKOmlvPhd3ULfHe2GKd2DF82dkDZxlyD/LIVCY3c9+Fyx +KyPy9fcMnB7SKmuB27cZePHuV180zkSCd4nA5iMp3ukND+2v5mM43xbFxbivEfqI +Cvj6h0h5wiFIzZlMXT0PdgvY2hCdfxxcn2xxlxyz+IXOTA/5Cfu4nGw3kEh2Zu8C +AwEAAaNvMG0wHQYDVR0OBBYEFH/Er2J8BaxQKdKlICmL6Ef3yG/KMB8GA1UdIwQY +MBaAFH/Er2J8BaxQKdKlICmL6Ef3yG/KMA8GA1UdEwEB/wQFMAMBAf8wGgYDVR0R +BBMwEYIJbG9jYWxob3N0hwR/AAABMA0GCSqGSIb3DQEBCwUAA4ICAQCTyP6lF+vI +0Vhdrbdh0X2XPYdfFc7X8lIxC8esZ9hrbjgEeTaRbGML+EKqKmUNTcOsJB4WYoEw +CNOMKGT0y4jVeKhowDfIgE8LvHalw1GF6Y4jTwfztW3Wu5DUiW/fjxyxs6OG3D7b +OYmBHfp/zGDtmpzKLipaZ+c5rsPPPW/3g+hptNzbZh32CYH1vMcGqZChDOa79hGL +K0Q1F67ge6rgkPcIS2Ppii5rNDWwGbii0tXkOI7L6rPhbn5a5jg1cbmxEr10+jtk +TOXWZ21f1KhuFOq+wojufoCBkkHsmMf+PfGvyrdlaj+N4n2TJbUCwMFvXHQ9ftir +mXaiM1N8oKx09jbnQxOEp6xH2qJoLaLHcDBklSals77IuLVgWpppGU5QbYj9j63P +4pzTyGsJtypSeR8U+CRl64CsE19X9ao1Szpflkmda5H22YVLg8sHAZ7y9lPWkHzQ +fgFzUdEvMVJ4OXoRsoeHZvBO2mBSTs6TwHq2Mk+uvAMg6CXRKBIFVkI9TBPC5yf+ +fEoXbJY/FtrILTWxr6FGXV0SZf5LWhhb4uPi9fmNSwuY+WhmVigjjJIZk8AzazjL +S3zu4Ljz4mZQguDTud5NujMBAFjgyJQN2cJ4/rA3e95iQ3WaHJU2APVqNvlq8/sN +yyQWFg0mZ1vsKZbl0vxPyn01KhzS58uPbw== -----END CERTIFICATE----- From ef63449d0a94a3e82b968cf9cd8fe290a999cd06 Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Tue, 13 Jan 2026 15:21:39 -0800 Subject: [PATCH 051/124] LangGraph Instrumentation Co-authored-by: Uma Annamalai --- newrelic/config.py | 4 +++ newrelic/hooks/mlmodel_langgraph.py | 55 +++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 newrelic/hooks/mlmodel_langgraph.py diff --git a/newrelic/config.py b/newrelic/config.py index fd7f74649d..80342011c5 100644 --- a/newrelic/config.py +++ b/newrelic/config.py @@ -2088,6 +2088,10 @@ def _process_module_builtin_defaults(): _process_module_definition("asyncio.runners", "newrelic.hooks.coroutines_asyncio", "instrument_asyncio_runners") + _process_module_definition( + "langgraph.prebuilt.tool_node", "newrelic.hooks.mlmodel_langgraph", "instrument_langgraph_prebuilt_tool_node" + ) + _process_module_definition( "langchain_core.runnables.base", "newrelic.hooks.mlmodel_langchain", diff --git a/newrelic/hooks/mlmodel_langgraph.py b/newrelic/hooks/mlmodel_langgraph.py new file mode 100644 index 0000000000..74aeb4d3c9 --- /dev/null +++ b/newrelic/hooks/mlmodel_langgraph.py @@ -0,0 +1,55 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from newrelic.api.transaction import current_transaction +from newrelic.common.object_wrapper import wrap_function_wrapper +from newrelic.common.signature import bind_args + + +def wrap_ToolNode__execute_tool_sync(wrapped, instance, args, kwargs): + if not current_transaction(): + return wrapped(*args, **kwargs) + + try: + bound_args = bind_args(wrapped, args, kwargs) + agent_name = bound_args["request"].state["messages"][-1].name + metadata = bound_args["config"]["metadata"] + metadata["_nr_agent_name"] = agent_name + except Exception: + pass + + return wrapped(*args, **kwargs) + + +async def wrap_ToolNode__execute_tool_async(wrapped, instance, args, kwargs): + if not current_transaction(): + return await wrapped(*args, **kwargs) + + try: + bound_args = bind_args(wrapped, args, kwargs) + agent_name = bound_args["request"].state["messages"][-1].name + metadata = bound_args["config"]["metadata"] + metadata["_nr_agent_name"] = agent_name + except Exception: + pass + + return await wrapped(*args, **kwargs) + + +def instrument_langgraph_prebuilt_tool_node(module): + if hasattr(module, "ToolNode"): + if hasattr(module.ToolNode, "_execute_tool_sync"): + wrap_function_wrapper(module, "ToolNode._execute_tool_sync", wrap_ToolNode__execute_tool_sync) + if hasattr(module.ToolNode, "_execute_tool_async"): + wrap_function_wrapper(module, "ToolNode._execute_tool_async", wrap_ToolNode__execute_tool_async) From 56f14cc0c0080b2f6be3bbefa179b7d44b128864 Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Tue, 13 Jan 2026 15:26:29 -0800 Subject: [PATCH 052/124] LangChain Agents Instrumentation Co-authored-by: Uma Annamalai --- newrelic/config.py | 16 +- newrelic/hooks/mlmodel_langchain.py | 464 +++++++++++++++++----------- 2 files changed, 289 insertions(+), 191 deletions(-) diff --git a/newrelic/config.py b/newrelic/config.py index 80342011c5..3960e4e1ea 100644 --- a/newrelic/config.py +++ b/newrelic/config.py @@ -2103,13 +2103,19 @@ def _process_module_builtin_defaults(): "instrument_langchain_core_runnables_config", ) _process_module_definition( - "langchain.chains.base", "newrelic.hooks.mlmodel_langchain", "instrument_langchain_chains_base" + "langchain_core.tools.structured", + "newrelic.hooks.mlmodel_langchain", + "instrument_langchain_core_tools_structured", ) + _process_module_definition( - "langchain_classic.chains.base", "newrelic.hooks.mlmodel_langchain", "instrument_langchain_chains_base" + "langchain.agents.factory", "newrelic.hooks.mlmodel_langchain", "instrument_langchain_agents_factory" ) _process_module_definition( - "langchain_core.callbacks.manager", "newrelic.hooks.mlmodel_langchain", "instrument_langchain_callbacks_manager" + "langchain.chains.base", "newrelic.hooks.mlmodel_langchain", "instrument_langchain_chains_base" + ) + _process_module_definition( + "langchain_classic.chains.base", "newrelic.hooks.mlmodel_langchain", "instrument_langchain_chains_base" ) # VectorStores with similarity_search method @@ -2675,10 +2681,6 @@ def _process_module_builtin_defaults(): "langchain_core.tools", "newrelic.hooks.mlmodel_langchain", "instrument_langchain_core_tools" ) - _process_module_definition( - "langchain_core.callbacks.manager", "newrelic.hooks.mlmodel_langchain", "instrument_langchain_callbacks_manager" - ) - _process_module_definition("asgiref.sync", "newrelic.hooks.adapter_asgiref", "instrument_asgiref_sync") _process_module_definition( diff --git a/newrelic/hooks/mlmodel_langchain.py b/newrelic/hooks/mlmodel_langchain.py index 3e1317dd7e..d5a6722a0c 100644 --- a/newrelic/hooks/mlmodel_langchain.py +++ b/newrelic/hooks/mlmodel_langchain.py @@ -21,11 +21,12 @@ from newrelic.api.function_trace import FunctionTrace from newrelic.api.time_trace import current_trace, get_trace_linking_metadata from newrelic.api.transaction import current_transaction -from newrelic.common.object_wrapper import wrap_function_wrapper +from newrelic.common.llm_utils import AsyncGeneratorProxy, GeneratorProxy +from newrelic.common.object_wrapper import ObjectProxy, wrap_function_wrapper from newrelic.common.package_version_utils import get_package_version from newrelic.common.signature import bind_args from newrelic.core.config import global_settings -from newrelic.core.context import context_wrapper +from newrelic.core.context import ContextOf, context_wrapper _logger = logging.getLogger(__name__) LANGCHAIN_VERSION = get_package_version("langchain") @@ -130,6 +131,146 @@ } +def _construct_base_agent_event_dict(agent_name, agent_id, transaction): + try: + linking_metadata = get_trace_linking_metadata() + + agent_event_dict = { + "id": agent_id, + "name": agent_name, + "span_id": linking_metadata.get("span.id"), + "trace_id": linking_metadata.get("trace.id"), + "vendor": "langchain", + "ingest_source": "Python", + } + agent_event_dict.update(_get_llm_metadata(transaction)) + except Exception: + agent_event_dict = {} + _logger.warning(RECORD_EVENTS_FAILURE_LOG_MESSAGE, exc_info=True) + + return agent_event_dict + + +class AgentObjectProxy(ObjectProxy): + def invoke(self, *args, **kwargs): + transaction = current_transaction() + + agent_name = getattr(transaction, "_nr_agent_name", "agent") + agent_id = str(uuid.uuid4()) + agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) + function_trace_name = f"invoke/{agent_name}" + + ft = FunctionTrace(name=function_trace_name, group="Llm/agent/LangChain") + ft.__enter__() + try: + return_val = self.__wrapped__.invoke(*args, **kwargs) + except Exception: + ft.notice_error(attributes={"agent_id": agent_id}) + ft.__exit__(*sys.exc_info()) + # If we hit an exception, append the error attribute and duration from the exited function trace + agent_event_dict.update({"duration": ft.duration * 1000, "error": True}) + transaction.record_custom_event("LlmAgent", agent_event_dict) + raise + + ft.__exit__(None, None, None) + agent_event_dict.update({"duration": ft.duration * 1000}) + + transaction.record_custom_event("LlmAgent", agent_event_dict) + + return return_val + + async def ainvoke(self, *args, **kwargs): + transaction = current_transaction() + + agent_name = getattr(transaction, "_nr_agent_name", "agent") + agent_id = str(uuid.uuid4()) + agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) + function_trace_name = f"ainvoke/{agent_name}" + + ft = FunctionTrace(name=function_trace_name, group="Llm/agent/LangChain") + ft.__enter__() + try: + return_val = await self.__wrapped__.ainvoke(*args, **kwargs) + except Exception: + ft.notice_error(attributes={"agent_id": agent_id}) + ft.__exit__(*sys.exc_info()) + # If we hit an exception, append the error attribute and duration from the exited function trace + agent_event_dict.update({"duration": ft.duration * 1000, "error": True}) + transaction.record_custom_event("LlmAgent", agent_event_dict) + raise + + ft.__exit__(None, None, None) + agent_event_dict.update({"duration": ft.duration * 1000}) + + transaction.record_custom_event("LlmAgent", agent_event_dict) + + return return_val + + def stream(self, *args, **kwargs): + transaction = current_transaction() + + agent_name = getattr(transaction, "_nr_agent_name", "agent") + agent_id = str(uuid.uuid4()) + agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) + function_trace_name = f"stream/{agent_name}" + + ft = FunctionTrace(name=function_trace_name, group="Llm/agent/LangChain") + ft.__enter__() + try: + return_val = self.__wrapped__.stream(*args, **kwargs) + return_val = GeneratorProxy( + return_val, + on_stop_iteration=self.on_stop_iteration(ft, agent_event_dict), + on_error=self.on_error(ft, agent_event_dict, agent_id), + ) + except Exception: + self.on_error(ft, agent_event_dict, agent_id)(transaction) + raise + + return return_val + + def astream(self, *args, **kwargs): + transaction = current_transaction() + + agent_name = getattr(transaction, "_nr_agent_name", "agent") + agent_id = str(uuid.uuid4()) + agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) + function_trace_name = f"astream/{agent_name}" + + ft = FunctionTrace(name=function_trace_name, group="Llm/agent/LangChain") + ft.__enter__() + try: + return_val = self.__wrapped__.astream(*args, **kwargs) + return_val = AsyncGeneratorProxy( + return_val, + on_stop_iteration=self.on_stop_iteration(ft, agent_event_dict), + on_error=self.on_error(ft, agent_event_dict, agent_id), + ) + except Exception: + self.on_error(ft, agent_event_dict, agent_id)(transaction) + raise + + return return_val + + def on_stop_iteration(self, ft, agent_event_dict): + def _on_stop_iteration(proxy, transaction): + ft.__exit__(None, None, None) + agent_event_dict.update({"duration": ft.duration * 1000}) + transaction.record_custom_event("LlmAgent", agent_event_dict) + + return _on_stop_iteration + + def on_error(self, ft, agent_event_dict, agent_id): + def _on_error(proxy, transaction): + ft.notice_error(attributes={"agent_id": agent_id}) + ft.__exit__(*sys.exc_info()) + # If we hit an exception, append the error attribute and duration from the exited function trace + agent_event_dict.update({"duration": ft.duration * 1000, "error": True}) + transaction.record_custom_event("LlmAgent", agent_event_dict) + + return _on_error + + def bind_submit(func, *args, **kwargs): return {"func": func, "args": args, "kwargs": kwargs} @@ -301,27 +442,32 @@ def wrap_tool_sync_run(wrapped, instance, args, kwargs): transaction.add_ml_model_info("LangChain", LANGCHAIN_VERSION) transaction._add_agent_attribute("llm", True) - tool_id, metadata, tags, tool_input, tool_name, tool_description, run_args = _capture_tool_info( + tool_id, agent_name, tool_input, tool_name, tool_run_id, run_args = _capture_tool_info( instance, wrapped, args, kwargs ) - ft = FunctionTrace(name=wrapped.__name__, group="Llm/tool/LangChain") + # Filter out injected State or ToolRuntime arguments that would clog up the input + try: + filtered_tool_input = instance._filter_injected_args(tool_input) + except Exception: + filtered_tool_input = tool_input + + ft = FunctionTrace(name=f"{wrapped.__name__}/{tool_name}", group="Llm/tool/LangChain") ft.__enter__() linking_metadata = get_trace_linking_metadata() try: return_val = wrapped(**run_args) except Exception: _record_tool_error( - instance, - transaction, - linking_metadata, - tags, - metadata, - tool_id, - tool_input, - tool_name, - tool_description, - ft, + instance=instance, + transaction=transaction, + linking_metadata=linking_metadata, + agent_name=agent_name, + tool_id=tool_id, + tool_input=filtered_tool_input, + tool_name=tool_name, + tool_run_id=tool_run_id, + ft=ft, ) raise ft.__exit__(None, None, None) @@ -330,17 +476,16 @@ def wrap_tool_sync_run(wrapped, instance, args, kwargs): return return_val _record_tool_success( - instance, - transaction, - linking_metadata, - tags, - metadata, - tool_id, - tool_input, - tool_name, - tool_description, - ft, - return_val, + instance=instance, + transaction=transaction, + linking_metadata=linking_metadata, + agent_name=agent_name, + tool_id=tool_id, + tool_input=filtered_tool_input, + tool_name=tool_name, + tool_run_id=tool_run_id, + ft=ft, + response=return_val, ) return return_val @@ -358,27 +503,32 @@ async def wrap_tool_async_run(wrapped, instance, args, kwargs): transaction.add_ml_model_info("LangChain", LANGCHAIN_VERSION) transaction._add_agent_attribute("llm", True) - tool_id, metadata, tags, tool_input, tool_name, tool_description, run_args = _capture_tool_info( + tool_id, agent_name, tool_input, tool_name, tool_run_id, run_args = _capture_tool_info( instance, wrapped, args, kwargs ) - ft = FunctionTrace(name=wrapped.__name__, group="Llm/tool/LangChain") + # Filter out injected State or ToolRuntime arguments that would clog up the input + try: + filtered_tool_input = instance._filter_injected_args(tool_input) + except Exception: + filtered_tool_input = tool_input + + ft = FunctionTrace(name=f"{wrapped.__name__}/{tool_name}", group="Llm/tool/LangChain") ft.__enter__() linking_metadata = get_trace_linking_metadata() try: return_val = await wrapped(**run_args) except Exception: _record_tool_error( - instance, - transaction, - linking_metadata, - tags, - metadata, - tool_id, - tool_input, - tool_name, - tool_description, - ft, + instance=instance, + transaction=transaction, + linking_metadata=linking_metadata, + agent_name=agent_name, + tool_id=tool_id, + tool_input=filtered_tool_input, + tool_name=tool_name, + tool_run_id=tool_run_id, + ft=ft, ) raise ft.__exit__(None, None, None) @@ -387,17 +537,16 @@ async def wrap_tool_async_run(wrapped, instance, args, kwargs): return return_val _record_tool_success( - instance, - transaction, - linking_metadata, - tags, - metadata, - tool_id, - tool_input, - tool_name, - tool_description, - ft, - return_val, + instance=instance, + transaction=transaction, + linking_metadata=linking_metadata, + agent_name=agent_name, + tool_id=tool_id, + tool_input=filtered_tool_input, + tool_name=tool_name, + tool_run_id=tool_run_id, + ft=ft, + response=return_val, ) return return_val @@ -407,51 +556,35 @@ def _capture_tool_info(instance, wrapped, args, kwargs): tool_id = str(uuid.uuid4()) metadata = run_args.get("metadata") or {} - metadata["nr_tool_id"] = tool_id - run_args["metadata"] = metadata - tags = run_args.get("tags") or [] + agent_name = metadata.pop("_nr_agent_name", None) tool_input = run_args.get("tool_input") tool_name = getattr(instance, "name", None) - tool_description = getattr(instance, "description", None) - return tool_id, metadata, tags, tool_input, tool_name, tool_description, run_args + # Checking multiple places for an acceptable tool run ID, fallback to creating our own. + tool_run_id = run_args.get("run_id", None) or run_args.get("tool_call_id", None) or str(uuid.uuid4()) + + return tool_id, agent_name, tool_input, tool_name, tool_run_id, run_args def _record_tool_success( - instance, - transaction, - linking_metadata, - tags, - metadata, - tool_id, - tool_input, - tool_name, - tool_description, - ft, - response, + instance, transaction, linking_metadata, agent_name, tool_id, tool_input, tool_name, tool_run_id, ft, response ): settings = transaction.settings if transaction.settings is not None else global_settings() - run_id = getattr(transaction, "_nr_tool_run_ids", {}).pop(tool_id, None) - # Update tags and metadata previously obtained from run_args with instance values - metadata.update(getattr(instance, "metadata", None) or {}) - tags.extend(getattr(instance, "tags", None) or []) - full_tool_event_dict = {f"metadata.{key}": value for key, value in metadata.items() if key != "nr_tool_id"} - full_tool_event_dict.update( - { - "id": tool_id, - "run_id": run_id, - "name": tool_name, - "description": tool_description, - "span_id": linking_metadata.get("span.id"), - "trace_id": linking_metadata.get("trace.id"), - "vendor": "langchain", - "ingest_source": "Python", - "duration": ft.duration * 1000, - "tags": tags or None, - } - ) + + full_tool_event_dict = { + "id": tool_id, + "run_id": tool_run_id, + "name": tool_name, + "agent_name": agent_name, + "span_id": linking_metadata.get("span.id"), + "trace_id": linking_metadata.get("trace.id"), + "vendor": "langchain", + "ingest_source": "Python", + "duration": ft.duration * 1000, + } + result = None try: - result = str(response) + result = str(response.content) if hasattr(response, "content") else str(response) except Exception: _logger.debug("Failed to convert tool response into a string.\n%s", traceback.format_exception(*sys.exc_info())) if settings.ai_monitoring.record_content.enabled: @@ -461,79 +594,31 @@ def _record_tool_success( def _record_tool_error( - instance, transaction, linking_metadata, tags, metadata, tool_id, tool_input, tool_name, tool_description, ft + instance, transaction, linking_metadata, agent_name, tool_id, tool_input, tool_name, tool_run_id, ft ): settings = transaction.settings if transaction.settings is not None else global_settings() ft.notice_error(attributes={"tool_id": tool_id}) ft.__exit__(*sys.exc_info()) - run_id = getattr(transaction, "_nr_tool_run_ids", {}).pop(tool_id, None) - # Update tags and metadata previously obtained from run_args with instance values - metadata.update(getattr(instance, "metadata", None) or {}) - tags.extend(getattr(instance, "tags", None) or []) # Make sure the builtin attributes take precedence over metadata attributes. - error_tool_event_dict = {f"metadata.{key}": value for key, value in metadata.items() if key != "nr_tool_id"} - error_tool_event_dict.update( - { - "id": tool_id, - "run_id": run_id, - "name": tool_name, - "description": tool_description, - "span_id": linking_metadata.get("span.id"), - "trace_id": linking_metadata.get("trace.id"), - "vendor": "langchain", - "ingest_source": "Python", - "duration": ft.duration * 1000, - "tags": tags or None, - "error": True, - } - ) + error_tool_event_dict = { + "id": tool_id, + "run_id": tool_run_id, + "name": tool_name, + "agent_name": agent_name, + "span_id": linking_metadata.get("span.id"), + "trace_id": linking_metadata.get("trace.id"), + "vendor": "langchain", + "ingest_source": "Python", + "duration": ft.duration * 1000, + "error": True, + } + if settings.ai_monitoring.record_content.enabled: error_tool_event_dict["input"] = tool_input error_tool_event_dict.update(_get_llm_metadata(transaction)) - transaction.record_custom_event("LlmTool", error_tool_event_dict) - - -def wrap_on_tool_start_sync(wrapped, instance, args, kwargs): - transaction = current_transaction() - if not transaction: - return wrapped(*args, **kwargs) - - settings = transaction.settings if transaction.settings is not None else global_settings() - if not settings.ai_monitoring.enabled: - return wrapped(*args, **kwargs) - - tool_id = _get_tool_id(instance) - run_manager = wrapped(*args, **kwargs) - _capture_tool_run_id(transaction, run_manager, tool_id) - return run_manager - - -async def wrap_on_tool_start_async(wrapped, instance, args, kwargs): - transaction = current_transaction() - if not transaction: - return await wrapped(*args, **kwargs) - - settings = transaction.settings if transaction.settings is not None else global_settings() - if not settings.ai_monitoring.enabled: - return await wrapped(*args, **kwargs) - tool_id = _get_tool_id(instance) - run_manager = await wrapped(*args, **kwargs) - _capture_tool_run_id(transaction, run_manager, tool_id) - return run_manager - - -def _get_tool_id(instance): - return (getattr(instance, "metadata", None) or {}).pop("nr_tool_id", None) - - -def _capture_tool_run_id(transaction, run_manager, tool_id): - if tool_id: - if not hasattr(transaction, "_nr_tool_run_ids"): - transaction._nr_tool_run_ids = {} - if tool_id not in transaction._nr_tool_run_ids: - transaction._nr_tool_run_ids[tool_id] = getattr(run_manager, "run_id", None) + transaction.record_custom_event("LlmTool", error_tool_event_dict) async def wrap_chain_async_run(wrapped, instance, args, kwargs): @@ -822,47 +907,56 @@ def create_chat_completion_message_event( transaction.record_custom_event("LlmChatCompletionMessage", chat_completion_output_message_dict) -def wrap_on_chain_start(wrapped, instance, args, kwargs): +def wrap_create_agent(wrapped, instance, args, kwargs): transaction = current_transaction() if not transaction: return wrapped(*args, **kwargs) - settings = transaction.settings if transaction.settings is not None else global_settings() + settings = transaction.settings or global_settings() if not settings.ai_monitoring.enabled: return wrapped(*args, **kwargs) - completion_id = _get_completion_id(instance) - run_manager = wrapped(*args, **kwargs) - _capture_chain_run_id(transaction, run_manager, completion_id) - return run_manager + # Framework metric also used for entity tagging in the UI + transaction.add_ml_model_info("LangChain", LANGCHAIN_VERSION) + transaction._add_agent_attribute("llm", True) + agent_name = kwargs.get("name", None) -async def wrap_async_on_chain_start(wrapped, instance, args, kwargs): - transaction = current_transaction() - if not transaction: - return await wrapped(*args, **kwargs) + transaction._nr_agent_name = agent_name - settings = transaction.settings if transaction.settings is not None else global_settings() - if not settings.ai_monitoring.enabled: - return await wrapped(*args, **kwargs) + return_val = wrapped(*args, **kwargs) - completion_id = _get_completion_id(instance) - run_manager = await wrapped(*args, **kwargs) - _capture_chain_run_id(transaction, run_manager, completion_id) - return run_manager + return AgentObjectProxy(return_val) -def _get_completion_id(instance): - return (getattr(instance, "metadata", None) or {}).pop("nr_completion_id", None) +def wrap_StructuredTool_invoke(wrapped, instance, args, kwargs): + """If StructuredTool.invoke is being run inside a ThreadPoolExecutor, propagate context from StructuredTool.ainvoke.""" + trace = current_trace() + if trace: + return wrapped(*args, **kwargs) + metadata = bind_args(wrapped, args, kwargs).get("config", {}).get("metadata", {}) + trace = metadata.get("_nr_trace") + if not trace: + return wrapped(*args, **kwargs) + + with ContextOf(trace=trace): + return wrapped(*args, **kwargs) + + +async def wrap_StructuredTool_ainvoke(wrapped, instance, args, kwargs): + """Save a copy of the current trace if we're about to run StructuredTool.invoke inside a ThreadPoolExecutor.""" + trace = current_trace() + if not trace or instance.coroutine: + return await wrapped(*args, **kwargs) + + metadata = bind_args(wrapped, args, kwargs).get("config", {}).get("metadata", {}) + metadata["_nr_trace"] = trace -def _capture_chain_run_id(transaction, run_manager, completion_id): - if completion_id: - if not hasattr(transaction, "_nr_chain_run_ids"): - transaction._nr_chain_run_ids = {} - # Only capture the first run_id. - if completion_id not in transaction._nr_chain_run_ids: - transaction._nr_chain_run_ids[completion_id] = getattr(run_manager, "run_id", "") + try: + return await wrapped(*args, **kwargs) + finally: + metadata.pop("_nr_trace", None) def instrument_langchain_runnables_chains_base(module): @@ -903,17 +997,19 @@ def instrument_langchain_core_tools(module): wrap_function_wrapper(module, "BaseTool.arun", wrap_tool_async_run) -def instrument_langchain_callbacks_manager(module): - if hasattr(module.CallbackManager, "on_tool_start"): - wrap_function_wrapper(module, "CallbackManager.on_tool_start", wrap_on_tool_start_sync) - if hasattr(module.AsyncCallbackManager, "on_tool_start"): - wrap_function_wrapper(module, "AsyncCallbackManager.on_tool_start", wrap_on_tool_start_async) - if hasattr(module.CallbackManager, "on_chain_start"): - wrap_function_wrapper(module, "CallbackManager.on_chain_start", wrap_on_chain_start) - if hasattr(module.AsyncCallbackManager, "on_chain_start"): - wrap_function_wrapper(module, "AsyncCallbackManager.on_chain_start", wrap_async_on_chain_start) - - def instrument_langchain_core_runnables_config(module): if hasattr(module, "ContextThreadPoolExecutor"): wrap_function_wrapper(module, "ContextThreadPoolExecutor.submit", wrap_ContextThreadPoolExecutor_submit) + + +def instrument_langchain_core_tools_structured(module): + if hasattr(module, "StructuredTool"): + if hasattr(module.StructuredTool, "invoke"): + wrap_function_wrapper(module, "StructuredTool.invoke", wrap_StructuredTool_invoke) + if hasattr(module.StructuredTool, "ainvoke"): + wrap_function_wrapper(module, "StructuredTool.ainvoke", wrap_StructuredTool_ainvoke) + + +def instrument_langchain_agents_factory(module): + if hasattr(module, "create_agent"): + wrap_function_wrapper(module, "create_agent", wrap_create_agent) From 4929f79d7f7fecf5787c3027ae55ccca5d24e29b Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Tue, 13 Jan 2026 15:19:29 -0800 Subject: [PATCH 053/124] Update tox versions for LangChain / LangGraph Co-authored-by: Uma Annamalai --- tox.ini | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/tox.ini b/tox.ini index 4eb11c4049..86be658e70 100644 --- a/tox.ini +++ b/tox.ini @@ -429,19 +429,16 @@ deps = mlmodel_gemini: google-genai mlmodel_openai-openai0: openai[datalib]<1.0 mlmodel_openai-openailatest: openai[datalib] - ; Required for openai testing mlmodel_openai: protobuf - ; Pin to 1.1.0 temporarily - mlmodel_langchain: langchain<1.1.1 - mlmodel_langchain: langchain-core<1.1.1 + mlmodel_langchain: langchain + mlmodel_langchain: langchain-core mlmodel_langchain: langchain-community mlmodel_langchain: langchain-openai - ; Required for langchain testing + mlmodel_langchain: langgraph mlmodel_langchain: pypdf mlmodel_langchain: tiktoken mlmodel_langchain: faiss-cpu mlmodel_langchain: mock - mlmodel_langchain: asyncio mlmodel_strands: strands-agents[openai] mlmodel_strands: strands-agents-tools logger_loguru-logurulatest: loguru From b8b6cca351d0b4db96d906ac3c5375bd1d41e86d Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Tue, 13 Jan 2026 15:20:16 -0800 Subject: [PATCH 054/124] Move GeneratorProxy from Strands to common file Co-authored-by: Uma Annamalai --- newrelic/common/llm_utils.py | 63 +++++++++++++++++++++++++++++++ newrelic/hooks/mlmodel_strands.py | 34 +---------------- 2 files changed, 65 insertions(+), 32 deletions(-) diff --git a/newrelic/common/llm_utils.py b/newrelic/common/llm_utils.py index eebdacfc7f..624accd05c 100644 --- a/newrelic/common/llm_utils.py +++ b/newrelic/common/llm_utils.py @@ -12,6 +12,9 @@ # See the License for the specific language governing permissions and # limitations under the License. +from newrelic.api.transaction import current_transaction +from newrelic.common.object_wrapper import ObjectProxy + def _get_llm_metadata(transaction): # Grab LLM-related custom attributes off of the transaction to store as metadata on LLM events @@ -22,3 +25,63 @@ def _get_llm_metadata(transaction): llm_metadata_dict.update(llm_context_attrs) return llm_metadata_dict + + +class GeneratorProxy(ObjectProxy): + def __init__(self, wrapped, on_stop_iteration, on_error): + super().__init__(wrapped) + self._nr_on_stop_iteration = on_stop_iteration + self._nr_on_error = on_error + + def __iter__(self): + self._nr_wrapped_iter = self.__wrapped__.__iter__() + return self + + def __next__(self): + transaction = current_transaction() + if not transaction: + return self._nr_wrapped_iter.__next__() + + return_val = None + try: + return_val = self._nr_wrapped_iter.__next__() + except StopIteration: + self._nr_on_stop_iteration(self, transaction) + raise + except Exception: + self._nr_on_error(self, transaction) + raise + return return_val + + def close(self): + return super().close() + + +class AsyncGeneratorProxy(ObjectProxy): + def __init__(self, wrapped, on_stop_iteration, on_error): + super().__init__(wrapped) + self._nr_on_stop_iteration = on_stop_iteration + self._nr_on_error = on_error + + def __aiter__(self): + self._nr_wrapped_iter = self.__wrapped__.__aiter__() + return self + + async def __anext__(self): + transaction = current_transaction() + if not transaction: + return await self._nr_wrapped_iter.__anext__() + + return_val = None + try: + return_val = await self._nr_wrapped_iter.__anext__() + except StopAsyncIteration: + self._nr_on_stop_iteration(self, transaction) + raise + except Exception: + self._nr_on_error(self, transaction) + raise + return return_val + + async def aclose(self): + return await super().aclose() diff --git a/newrelic/hooks/mlmodel_strands.py b/newrelic/hooks/mlmodel_strands.py index 06337f7d21..a4ac6e5d72 100644 --- a/newrelic/hooks/mlmodel_strands.py +++ b/newrelic/hooks/mlmodel_strands.py @@ -20,9 +20,9 @@ from newrelic.api.function_trace import FunctionTrace from newrelic.api.time_trace import current_trace, get_trace_linking_metadata from newrelic.api.transaction import current_transaction -from newrelic.common.llm_utils import _get_llm_metadata +from newrelic.common.llm_utils import AsyncGeneratorProxy, _get_llm_metadata from newrelic.common.object_names import callable_name -from newrelic.common.object_wrapper import ObjectProxy, wrap_function_wrapper +from newrelic.common.object_wrapper import wrap_function_wrapper from newrelic.common.package_version_utils import get_package_version from newrelic.common.signature import bind_args from newrelic.core.config import global_settings @@ -385,36 +385,6 @@ def wrap_tool_executor__stream(wrapped, instance, args, kwargs): return return_val -class AsyncGeneratorProxy(ObjectProxy): - def __init__(self, wrapped, on_stop_iteration, on_error): - super().__init__(wrapped) - self._nr_on_stop_iteration = on_stop_iteration - self._nr_on_error = on_error - - def __aiter__(self): - self._nr_wrapped_iter = self.__wrapped__.__aiter__() - return self - - async def __anext__(self): - transaction = current_transaction() - if not transaction: - return await self._nr_wrapped_iter.__anext__() - - return_val = None - try: - return_val = await self._nr_wrapped_iter.__anext__() - except StopAsyncIteration: - self._nr_on_stop_iteration(self, transaction) - raise - except Exception: - self._nr_on_error(self, transaction) - raise - return return_val - - async def aclose(self): - return await super().aclose() - - def wrap_ToolRegister_register_tool(wrapped, instance, args, kwargs): try: from strands.tools.decorator import DecoratedFunctionTool From 71445b9521450ff730b3f7047365874f198747ec Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Tue, 13 Jan 2026 15:22:37 -0800 Subject: [PATCH 055/124] More verbose logging in validate_custom_events Co-authored-by: Uma Annamalai --- .../testing_support/validators/validate_custom_events.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/tests/testing_support/validators/validate_custom_events.py b/tests/testing_support/validators/validate_custom_events.py index e3f1c1a15a..1ccc7b5f72 100644 --- a/tests/testing_support/validators/validate_custom_events.py +++ b/tests/testing_support/validators/validate_custom_events.py @@ -53,7 +53,9 @@ def _validate_custom_events(wrapped, instance, args, kwargs): for captured in found_events: if _check_event_attributes(expected, captured, mismatches): matching_custom_events += 1 - assert matching_custom_events == 1, _event_details(matching_custom_events, found_events, mismatches) + assert matching_custom_events == 1, _event_details( + expected, matching_custom_events, found_events, mismatches + ) return val @@ -98,9 +100,10 @@ def _check_event_attributes(expected, captured, mismatches): return True -def _event_details(matching_custom_events, captured, mismatches): +def _event_details(expected_event, matching_custom_events, captured, mismatches): details = [ - f"matching_custom_events={matching_custom_events}", + f"\nexpected_event={pformat(expected_event)}", + f"{matching_custom_events=}", f"mismatches={pformat(mismatches)}", f"captured_events={pformat(captured)}", ] From b9e22f76c0e06ebd4d44c68f5804f1af0c51ee68 Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Tue, 13 Jan 2026 15:21:05 -0800 Subject: [PATCH 056/124] Improve prompt logging for mock openai server Co-authored-by: Uma Annamalai --- .../external_botocore/_mock_external_bedrock_server_converse.py | 2 +- .../_mock_external_bedrock_server_invoke_model.py | 2 +- tests/mlmodel_langchain/_mock_external_openai_server.py | 2 +- tests/mlmodel_openai/_mock_external_openai_server.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/tests/external_botocore/_mock_external_bedrock_server_converse.py b/tests/external_botocore/_mock_external_bedrock_server_converse.py index bc93c8b773..bb34315fc0 100644 --- a/tests/external_botocore/_mock_external_bedrock_server_converse.py +++ b/tests/external_botocore/_mock_external_bedrock_server_converse.py @@ -195,7 +195,7 @@ def simple_get(self): # If no matches found self.send_response(500) self.end_headers() - self.wfile.write(f"Unknown Prompt:\n{prompt}".encode()) + self.wfile.write(f"Unknown Prompt ({'Streaming' if stream else 'Non-Streaming'}):\n{prompt}".encode()) return # Send response code diff --git a/tests/external_botocore/_mock_external_bedrock_server_invoke_model.py b/tests/external_botocore/_mock_external_bedrock_server_invoke_model.py index 6dd1fbaac0..09b3937ce2 100644 --- a/tests/external_botocore/_mock_external_bedrock_server_invoke_model.py +++ b/tests/external_botocore/_mock_external_bedrock_server_invoke_model.py @@ -6772,7 +6772,7 @@ def simple_get(self): # If no matches found self.send_response(500) self.end_headers() - self.wfile.write(f"Unknown Prompt:\n{prompt}".encode()) + self.wfile.write(f"Unknown Prompt ({'Streaming' if stream else 'Non-Streaming'}):\n{prompt}".encode()) return if stream: diff --git a/tests/mlmodel_langchain/_mock_external_openai_server.py b/tests/mlmodel_langchain/_mock_external_openai_server.py index d6adcdb9fb..9cd644015a 100644 --- a/tests/mlmodel_langchain/_mock_external_openai_server.py +++ b/tests/mlmodel_langchain/_mock_external_openai_server.py @@ -502,7 +502,7 @@ def _simple_get(self): else: # If no matches found self.send_response(500) self.end_headers() - self.wfile.write(f"Unknown Prompt:\n{prompt}".encode()) + self.wfile.write(f"Unknown Prompt ({'Streaming' if stream else 'Non-Streaming'}):\n{prompt}".encode()) return # Send response code diff --git a/tests/mlmodel_openai/_mock_external_openai_server.py b/tests/mlmodel_openai/_mock_external_openai_server.py index 5b22133141..e218b4939a 100644 --- a/tests/mlmodel_openai/_mock_external_openai_server.py +++ b/tests/mlmodel_openai/_mock_external_openai_server.py @@ -704,7 +704,7 @@ def _simple_get(self): else: # If no matches found self.send_response(500) self.end_headers() - self.wfile.write(f"Unknown Prompt:\n{prompt}".encode()) + self.wfile.write(f"Unknown Prompt ({'Streaming' if stream else 'Non-Streaming'}):\n{prompt}".encode()) return # Send response code From 4de38706cc1055b20a4ea7ea73dcaff8501a3be2 Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Tue, 13 Jan 2026 15:24:04 -0800 Subject: [PATCH 057/124] Tweak langchain test folder structure Co-authored-by: Uma Annamalai --- tests/mlmodel_langchain/__init__.py | 13 +++++++++++++ tests/mlmodel_langchain/test_vectorstore.py | 16 ++++++++-------- 2 files changed, 21 insertions(+), 8 deletions(-) create mode 100644 tests/mlmodel_langchain/__init__.py diff --git a/tests/mlmodel_langchain/__init__.py b/tests/mlmodel_langchain/__init__.py new file mode 100644 index 0000000000..8030baccf7 --- /dev/null +++ b/tests/mlmodel_langchain/__init__.py @@ -0,0 +1,13 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. diff --git a/tests/mlmodel_langchain/test_vectorstore.py b/tests/mlmodel_langchain/test_vectorstore.py index bdb152fe5c..6366c9cab1 100644 --- a/tests/mlmodel_langchain/test_vectorstore.py +++ b/tests/mlmodel_langchain/test_vectorstore.py @@ -130,7 +130,7 @@ def test_vectorstore_modules_instrumented(): # Two OpenAI LlmEmbedded, two LangChain LlmVectorSearch @validate_custom_event_count(count=4) @validate_transaction_metrics( - name="test_vectorstore:test_pdf_pagesplitter_vectorstore_in_txn", + name="mlmodel_langchain.test_vectorstore:test_pdf_pagesplitter_vectorstore_in_txn", scoped_metrics=[("Llm/vectorstore/LangChain/similarity_search", 1)], rollup_metrics=[("Llm/vectorstore/LangChain/similarity_search", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -159,7 +159,7 @@ def test_pdf_pagesplitter_vectorstore_in_txn(set_trace_info, embedding_openai_cl # Two OpenAI LlmEmbedded, two LangChain LlmVectorSearch @validate_custom_event_count(count=4) @validate_transaction_metrics( - name="test_vectorstore:test_pdf_pagesplitter_vectorstore_in_txn_no_content", + name="mlmodel_langchain.test_vectorstore:test_pdf_pagesplitter_vectorstore_in_txn_no_content", scoped_metrics=[("Llm/vectorstore/LangChain/similarity_search", 1)], rollup_metrics=[("Llm/vectorstore/LangChain/similarity_search", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -214,7 +214,7 @@ def test_pdf_pagesplitter_vectorstore_ai_monitoring_disabled(set_trace_info, emb # Two OpenAI LlmEmbedded, two LangChain LlmVectorSearch @validate_custom_event_count(count=4) @validate_transaction_metrics( - name="test_vectorstore:test_async_pdf_pagesplitter_vectorstore_in_txn", + name="mlmodel_langchain.test_vectorstore:test_async_pdf_pagesplitter_vectorstore_in_txn", scoped_metrics=[("Llm/vectorstore/LangChain/asimilarity_search", 1)], rollup_metrics=[("Llm/vectorstore/LangChain/asimilarity_search", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -247,7 +247,7 @@ async def _test(): # Two OpenAI LlmEmbedded, two LangChain LlmVectorSearch @validate_custom_event_count(count=4) @validate_transaction_metrics( - name="test_vectorstore:test_async_pdf_pagesplitter_vectorstore_in_txn_no_content", + name="mlmodel_langchain.test_vectorstore:test_async_pdf_pagesplitter_vectorstore_in_txn_no_content", scoped_metrics=[("Llm/vectorstore/LangChain/asimilarity_search", 1)], rollup_metrics=[("Llm/vectorstore/LangChain/asimilarity_search", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -331,7 +331,7 @@ async def _test(): ) @validate_custom_events(events_with_context_attrs(vectorstore_error_events)) @validate_transaction_metrics( - name="test_vectorstore:test_vectorstore_error", + name="mlmodel_langchain.test_vectorstore:test_vectorstore_error", scoped_metrics=[("Llm/vectorstore/LangChain/similarity_search", 1)], rollup_metrics=[("Llm/vectorstore/LangChain/similarity_search", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -357,7 +357,7 @@ def test_vectorstore_error(set_trace_info, embedding_openai_client, loop): ) @validate_custom_events(vectorstore_events_sans_content(vectorstore_error_events)) @validate_transaction_metrics( - name="test_vectorstore:test_vectorstore_error_no_content", + name="mlmodel_langchain.test_vectorstore:test_vectorstore_error_no_content", scoped_metrics=[("Llm/vectorstore/LangChain/similarity_search", 1)], rollup_metrics=[("Llm/vectorstore/LangChain/similarity_search", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -380,7 +380,7 @@ def test_vectorstore_error_no_content(set_trace_info, embedding_openai_client): ) @validate_custom_events(events_with_context_attrs(vectorstore_error_events)) @validate_transaction_metrics( - name="test_vectorstore:test_async_vectorstore_error", + name="mlmodel_langchain.test_vectorstore:test_async_vectorstore_error", scoped_metrics=[("Llm/vectorstore/LangChain/asimilarity_search", 1)], rollup_metrics=[("Llm/vectorstore/LangChain/asimilarity_search", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -410,7 +410,7 @@ async def _test(): ) @validate_custom_events(vectorstore_events_sans_content(vectorstore_error_events)) @validate_transaction_metrics( - name="test_vectorstore:test_async_vectorstore_error_no_content", + name="mlmodel_langchain.test_vectorstore:test_async_vectorstore_error_no_content", scoped_metrics=[("Llm/vectorstore/LangChain/asimilarity_search", 1)], rollup_metrics=[("Llm/vectorstore/LangChain/asimilarity_search", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], From b6d1dda165301ea3cbae24a339217543f1860720 Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Tue, 13 Jan 2026 15:24:23 -0800 Subject: [PATCH 058/124] Update Chain tests Co-authored-by: Uma Annamalai --- tests/mlmodel_langchain/test_chain.py | 74 ++++++++++++--------------- 1 file changed, 33 insertions(+), 41 deletions(-) diff --git a/tests/mlmodel_langchain/test_chain.py b/tests/mlmodel_langchain/test_chain.py index c6fcf080ba..30281843b8 100644 --- a/tests/mlmodel_langchain/test_chain.py +++ b/tests/mlmodel_langchain/test_chain.py @@ -12,9 +12,6 @@ # See the License for the specific language governing permissions and # limitations under the License. -import asyncio -import uuid -from unittest.mock import patch import langchain import langchain_core @@ -54,11 +51,6 @@ from langchain.chains.openai_functions import create_structured_output_chain, create_structured_output_runnable from langchain.schema import BaseOutputParser -_test_openai_chat_completion_messages = ( - {"role": "system", "content": "You are a scientist."}, - {"role": "user", "content": "What is 212 degrees Fahrenheit converted to Celsius?"}, -) - chat_completion_recorded_events_invoke_langchain_error = [ ( @@ -384,15 +376,15 @@ "request.model": "text-embedding-ada-002", "request_id": None, "duration": None, - "response.model": "text-embedding-ada-002", - "response.organization": "new-relic-nkmd8b", + "response.model": "text-embedding-ada-002-v2", + "response.organization": "user-rk8wq9voijy9sejrncvgi0iw", "response.headers.llmVersion": "2020-10-01", - "response.headers.ratelimitLimitRequests": 3000, - "response.headers.ratelimitLimitTokens": 1000000, + "response.headers.ratelimitLimitRequests": 10000, + "response.headers.ratelimitLimitTokens": 10000000, + "response.headers.ratelimitRemainingRequests": 9999, + "response.headers.ratelimitRemainingTokens": 9999992, + "response.headers.ratelimitResetRequests": "6ms", "response.headers.ratelimitResetTokens": "0s", - "response.headers.ratelimitResetRequests": "20ms", - "response.headers.ratelimitRemainingTokens": 999992, - "response.headers.ratelimitRemainingRequests": 2999, "vendor": "openai", "ingest_source": "Python", "input": "[[3923, 374, 220, 17, 489, 220, 19, 30]]", @@ -407,15 +399,15 @@ "request.model": "text-embedding-ada-002", "request_id": None, "duration": None, - "response.model": "text-embedding-ada-002", - "response.organization": "new-relic-nkmd8b", + "response.model": "text-embedding-ada-002-v2", + "response.organization": "user-rk8wq9voijy9sejrncvgi0iw", "response.headers.llmVersion": "2020-10-01", - "response.headers.ratelimitLimitRequests": 3000, - "response.headers.ratelimitLimitTokens": 1000000, + "response.headers.ratelimitLimitRequests": 10000, + "response.headers.ratelimitLimitTokens": 10000000, + "response.headers.ratelimitRemainingRequests": 9999, + "response.headers.ratelimitRemainingTokens": 9999998, + "response.headers.ratelimitResetRequests": "6ms", "response.headers.ratelimitResetTokens": "0s", - "response.headers.ratelimitResetRequests": "20ms", - "response.headers.ratelimitRemainingTokens": 999998, - "response.headers.ratelimitRemainingRequests": 2999, "vendor": "openai", "ingest_source": "Python", "input": "[[10590]]", @@ -479,15 +471,15 @@ "request_id": None, "duration": None, "response.model": "gpt-3.5-turbo-0125", - "response.organization": "new-relic-nkmd8b", + "response.organization": "user-rk8wq9voijy9sejrncvgi0iw", "response.choices.finish_reason": "stop", "response.headers.llmVersion": "2020-10-01", "response.headers.ratelimitLimitRequests": 10000, - "response.headers.ratelimitLimitTokens": 200000, - "response.headers.ratelimitResetTokens": "26ms", - "response.headers.ratelimitResetRequests": "8.64s", - "response.headers.ratelimitRemainingTokens": 199912, + "response.headers.ratelimitLimitTokens": 50000000, "response.headers.ratelimitRemainingRequests": 9999, + "response.headers.ratelimitRemainingTokens": 49999927, + "response.headers.ratelimitResetRequests": "6ms", + "response.headers.ratelimitResetTokens": "0s", "response.number_of_messages": 3, }, ], @@ -796,7 +788,7 @@ @validate_custom_events(events_with_context_attrs(chat_completion_recorded_events_str_response)) @validate_custom_event_count(count=7) @validate_transaction_metrics( - name="test_chain:test_langchain_chain_str_response", + name="mlmodel_langchain.test_chain:test_langchain_chain_str_response", scoped_metrics=[("Llm/chain/LangChain/invoke", 1)], rollup_metrics=[("Llm/chain/LangChain/invoke", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -825,7 +817,7 @@ def test_langchain_chain_str_response(set_trace_info, chat_openai_client): @validate_custom_events(events_with_context_attrs(chat_completion_recorded_events_list_response)) @validate_custom_event_count(count=7) @validate_transaction_metrics( - name="test_chain:test_langchain_chain_list_response", + name="mlmodel_langchain.test_chain:test_langchain_chain_list_response", scoped_metrics=[("Llm/chain/LangChain/invoke", 1)], rollup_metrics=[("Llm/chain/LangChain/invoke", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -924,7 +916,7 @@ def test_langchain_chain( # 3 langchain events and 5 openai events. @validate_custom_event_count(count=8) @validate_transaction_metrics( - name="test_chain:test_langchain_chain.._test", + name="mlmodel_langchain.test_chain:test_langchain_chain.._test", scoped_metrics=[(f"Llm/chain/LangChain/{call_function}", 1)], rollup_metrics=[(f"Llm/chain/LangChain/{call_function}", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -985,7 +977,7 @@ def test_langchain_chain_no_content( # 3 langchain events and 5 openai events. @validate_custom_event_count(count=8) @validate_transaction_metrics( - name="test_chain:test_langchain_chain_no_content.._test", + name="mlmodel_langchain.test_chain:test_langchain_chain_no_content.._test", scoped_metrics=[(f"Llm/chain/LangChain/{call_function}", 1)], rollup_metrics=[(f"Llm/chain/LangChain/{call_function}", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -1060,7 +1052,7 @@ def test_langchain_chain_error_in_openai( @validate_custom_events(events_with_context_attrs(expected_events)) @validate_custom_event_count(count=6) @validate_transaction_metrics( - name="test_chain:test_langchain_chain_error_in_openai.._test", + name="mlmodel_langchain.test_chain:test_langchain_chain_error_in_openai.._test", scoped_metrics=[(f"Llm/chain/LangChain/{call_function}", 1)], rollup_metrics=[(f"Llm/chain/LangChain/{call_function}", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -1123,7 +1115,7 @@ def test_langchain_chain_error_in_langchain( @validate_custom_events(expected_events) @validate_custom_event_count(count=2) @validate_transaction_metrics( - name="test_chain:test_langchain_chain_error_in_langchain.._test", + name="mlmodel_langchain.test_chain:test_langchain_chain_error_in_langchain.._test", scoped_metrics=[(f"Llm/chain/LangChain/{call_function}", 1)], rollup_metrics=[(f"Llm/chain/LangChain/{call_function}", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -1186,7 +1178,7 @@ def test_langchain_chain_error_in_langchain_no_content( @validate_custom_events(expected_events) @validate_custom_event_count(count=2) @validate_transaction_metrics( - name="test_chain:test_langchain_chain_error_in_langchain_no_content.._test", + name="mlmodel_langchain.test_chain:test_langchain_chain_error_in_langchain_no_content.._test", scoped_metrics=[(f"Llm/chain/LangChain/{call_function}", 1)], rollup_metrics=[(f"Llm/chain/LangChain/{call_function}", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -1251,7 +1243,7 @@ def test_langchain_chain_ai_monitoring_disabled( @validate_custom_events(events_with_context_attrs(chat_completion_recorded_events_list_response)) @validate_custom_event_count(count=7) @validate_transaction_metrics( - name="test_chain:test_async_langchain_chain_list_response", + name="mlmodel_langchain.test_chain:test_async_langchain_chain_list_response", scoped_metrics=[("Llm/chain/LangChain/ainvoke", 1)], rollup_metrics=[("Llm/chain/LangChain/ainvoke", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -1284,7 +1276,7 @@ def test_async_langchain_chain_list_response( @validate_custom_events(events_sans_content(chat_completion_recorded_events_list_response)) @validate_custom_event_count(count=7) @validate_transaction_metrics( - name="test_chain:test_async_langchain_chain_list_response_no_content", + name="mlmodel_langchain.test_chain:test_async_langchain_chain_list_response_no_content", scoped_metrics=[("Llm/chain/LangChain/ainvoke", 1)], rollup_metrics=[("Llm/chain/LangChain/ainvoke", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -1386,7 +1378,7 @@ def test_async_langchain_chain( # 3 langchain events and 5 openai events. @validate_custom_event_count(count=8) @validate_transaction_metrics( - name="test_chain:test_async_langchain_chain.._test", + name="mlmodel_langchain.test_chain:test_async_langchain_chain.._test", scoped_metrics=[(f"Llm/chain/LangChain/{call_function}", 1)], rollup_metrics=[(f"Llm/chain/LangChain/{call_function}", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -1461,7 +1453,7 @@ def test_async_langchain_chain_error_in_openai( @validate_custom_events(events_with_context_attrs(expected_events)) @validate_custom_event_count(count=6) @validate_transaction_metrics( - name="test_chain:test_async_langchain_chain_error_in_openai.._test", + name="mlmodel_langchain.test_chain:test_async_langchain_chain_error_in_openai.._test", scoped_metrics=[(f"Llm/chain/LangChain/{call_function}", 1)], rollup_metrics=[(f"Llm/chain/LangChain/{call_function}", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -1525,7 +1517,7 @@ def test_async_langchain_chain_error_in_langchain( @validate_custom_events(expected_events) @validate_custom_event_count(count=2) @validate_transaction_metrics( - name="test_chain:test_async_langchain_chain_error_in_langchain.._test", + name="mlmodel_langchain.test_chain:test_async_langchain_chain_error_in_langchain.._test", scoped_metrics=[(f"Llm/chain/LangChain/{call_function}", 1)], rollup_metrics=[(f"Llm/chain/LangChain/{call_function}", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -1589,7 +1581,7 @@ def test_async_langchain_chain_error_in_langchain_no_content( @validate_custom_events(expected_events) @validate_custom_event_count(count=2) @validate_transaction_metrics( - name="test_chain:test_async_langchain_chain_error_in_langchain_no_content.._test", + name="mlmodel_langchain.test_chain:test_async_langchain_chain_error_in_langchain_no_content.._test", scoped_metrics=[(f"Llm/chain/LangChain/{call_function}", 1)], rollup_metrics=[(f"Llm/chain/LangChain/{call_function}", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], @@ -1636,7 +1628,7 @@ def test_async_langchain_chain_outside_transaction( @validate_custom_events(recorded_events_retrieval_chain_response) @validate_custom_event_count(count=17) @validate_transaction_metrics( - name="test_chain:test_retrieval_chains", + name="mlmodel_langchain.test_chain:test_retrieval_chains", scoped_metrics=[("Llm/chain/LangChain/invoke", 3)], rollup_metrics=[("Llm/chain/LangChain/invoke", 3)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], From 74fdac5130e4d6800ed99f9fe63a376f14d6f4c5 Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Tue, 13 Jan 2026 15:24:31 -0800 Subject: [PATCH 059/124] New Agent testing Co-authored-by: Uma Annamalai --- tests/mlmodel_langchain/test_agent.py | 88 ------------ tests/mlmodel_langchain/test_agents.py | 178 +++++++++++++++++++++++++ 2 files changed, 178 insertions(+), 88 deletions(-) delete mode 100644 tests/mlmodel_langchain/test_agent.py create mode 100644 tests/mlmodel_langchain/test_agents.py diff --git a/tests/mlmodel_langchain/test_agent.py b/tests/mlmodel_langchain/test_agent.py deleted file mode 100644 index d13bdee30d..0000000000 --- a/tests/mlmodel_langchain/test_agent.py +++ /dev/null @@ -1,88 +0,0 @@ -# Copyright 2010 New Relic, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import langchain -import pytest -from langchain.tools import tool -from langchain_core.prompts import MessagesPlaceholder -from testing_support.fixtures import reset_core_stats_engine, validate_attributes -from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics - -from newrelic.api.background_task import background_task - -# Moved in langchain v1.0.1 -try: - from langchain_classic.agents import AgentExecutor, create_openai_functions_agent -except ImportError: - from langchain.agents import AgentExecutor, create_openai_functions_agent - -try: - from langchain_core.prompts import ChatPromptTemplate -except Exception: - from langchain.prompts import ChatPromptTemplate - - -@pytest.fixture -def tools(): - @tool - def multi_arg_tool(first_num, second_num): - """A test tool that adds two integers together""" - return first_num + second_num - - return [multi_arg_tool] - - -@pytest.fixture -def prompt(): - return ChatPromptTemplate.from_messages( - [ - ("system", "You are a world class algorithm for extracting information in structured formats."), - ("human", "Use the given format to extract information from the following input: {input}"), - ("human", "Tip: Make sure to answer in the correct format"), - MessagesPlaceholder(variable_name="agent_scratchpad"), - ] - ) - - -@reset_core_stats_engine() -@validate_transaction_metrics( - name="test_agent:test_sync_agent", - scoped_metrics=[("Llm/agent/LangChain/invoke", 1)], - rollup_metrics=[("Llm/agent/LangChain/invoke", 1)], - custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], - background_task=True, -) -@validate_attributes("agent", ["llm"]) -@background_task() -def test_sync_agent(chat_openai_client, tools, prompt): - agent = create_openai_functions_agent(chat_openai_client, tools, prompt) - agent_executor = AgentExecutor(agent=agent, tools=tools, verbose=True) - response = agent_executor.invoke({"input": "Hello, world"}) - assert response - - -@reset_core_stats_engine() -@validate_transaction_metrics( - name="test_agent:test_async_agent", - scoped_metrics=[("Llm/agent/LangChain/ainvoke", 1)], - rollup_metrics=[("Llm/agent/LangChain/ainvoke", 1)], - custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], - background_task=True, -) -@validate_attributes("agent", ["llm"]) -@background_task() -def test_async_agent(loop, chat_openai_client, tools, prompt): - agent = create_openai_functions_agent(chat_openai_client, tools, prompt) - agent_executor = AgentExecutor(agent=agent, tools=tools, verbose=True) - loop.run_until_complete(agent_executor.ainvoke({"input": "Hello, world"})) diff --git a/tests/mlmodel_langchain/test_agents.py b/tests/mlmodel_langchain/test_agents.py new file mode 100644 index 0000000000..5c836eb496 --- /dev/null +++ b/tests/mlmodel_langchain/test_agents.py @@ -0,0 +1,178 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from langchain.messages import HumanMessage +from langchain.tools import tool +from testing_support.fixtures import reset_core_stats_engine, validate_attributes +from testing_support.ml_testing_utils import ( + disabled_ai_monitoring_record_content_settings, + disabled_ai_monitoring_settings, + events_with_context_attrs, +) +from testing_support.validators.validate_custom_event import validate_custom_event_count +from testing_support.validators.validate_custom_events import validate_custom_events +from testing_support.validators.validate_error_trace_attributes import validate_error_trace_attributes +from testing_support.validators.validate_transaction_error_event_count import validate_transaction_error_event_count +from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics + +from newrelic.api.background_task import background_task +from newrelic.api.llm_custom_attributes import WithLlmCustomAttributes +from newrelic.common.object_names import callable_name +from newrelic.common.object_wrapper import transient_function_wrapper + +PROMPT = {"messages": [HumanMessage('Use a tool to add an exclamation to the word "Hello"')]} +ERROR_PROMPT = {"messages": [HumanMessage('Use a tool to add an exclamation to the word "exc"')]} +SYNC_METHODS = {"invoke", "stream"} + +agent_recorded_event = [ + ( + {"type": "LlmAgent"}, + { + "id": None, + "name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "vendor": "langchain", + "ingest_source": "Python", + "duration": None, + }, + ) +] + +agent_recorded_event_error = [ + ( + {"type": "LlmAgent"}, + { + "id": None, + "name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "vendor": "langchain", + "ingest_source": "Python", + "error": True, + "duration": None, + }, + ) +] + + +@tool +def add_exclamation(message: str) -> str: + """Adds an exclamation mark to the input message.""" + if "exc" in message: + raise RuntimeError("Oops") + return f"{message}!" + + +@reset_core_stats_engine() +def test_agent(exercise_agent, create_agent_runnable, set_trace_info, method_name): + @validate_custom_events(events_with_context_attrs(agent_recorded_event)) + @validate_custom_event_count(count=11) + @validate_transaction_metrics( + "test_agent", + scoped_metrics=[(f"Llm/agent/LangChain/{method_name}/my_agent", 1)], + rollup_metrics=[(f"Llm/agent/LangChain/{method_name}/my_agent", 1)], + background_task=True, + ) + @validate_attributes("agent", ["llm"]) + @background_task(name="test_agent") + def _test(): + set_trace_info() + my_agent = create_agent_runnable( + tools=[add_exclamation], system_prompt="You are a text manipulation algorithm." + ) + + with WithLlmCustomAttributes({"context": "attr"}): + exercise_agent(my_agent, PROMPT) + + _test() + + +@reset_core_stats_engine() +@disabled_ai_monitoring_record_content_settings +def test_agent_no_content(exercise_agent, create_agent_runnable, set_trace_info, method_name): + @validate_custom_events(agent_recorded_event) + @validate_custom_event_count(count=11) + @validate_transaction_metrics( + "test_agent_no_content", + scoped_metrics=[(f"Llm/agent/LangChain/{method_name}/my_agent", 1)], + rollup_metrics=[(f"Llm/agent/LangChain/{method_name}/my_agent", 1)], + background_task=True, + ) + @validate_attributes("agent", ["llm"]) + @background_task(name="test_agent_no_content") + def _test(): + set_trace_info() + my_agent = create_agent_runnable( + tools=[add_exclamation], system_prompt="You are a text manipulation algorithm." + ) + exercise_agent(my_agent, PROMPT) + + _test() + + +@reset_core_stats_engine() +@validate_custom_event_count(count=0) +def test_agent_outside_txn(exercise_agent, create_agent_runnable): + my_agent = create_agent_runnable(tools=[add_exclamation], system_prompt="You are a text manipulation algorithm.") + exercise_agent(my_agent, PROMPT) + + +@disabled_ai_monitoring_settings +@reset_core_stats_engine() +@validate_custom_event_count(count=0) +@background_task() +def test_agent_disabled_ai_monitoring_events(exercise_agent, create_agent_runnable, set_trace_info): + set_trace_info() + my_agent = create_agent_runnable(tools=[add_exclamation], system_prompt="You are a text manipulation algorithm.") + exercise_agent(my_agent, PROMPT) + + +@reset_core_stats_engine() +def test_agent_execution_error(exercise_agent, create_agent_runnable, set_trace_info, method_name): + # Add a wrapper to intentionally force an error in the Agent code + def _inject_exception(wrapped, instance, args, kwargs): + raise ValueError("Oops") + + inject_exception = transient_function_wrapper("langchain_core.callbacks.manager", "CallbackManager.on_chain_start")( + _inject_exception + ) + inject_exception_async = transient_function_wrapper( + "langchain_core.callbacks.manager", "AsyncCallbackManager.on_chain_start" + )(_inject_exception) + + @inject_exception + @inject_exception_async + @validate_transaction_error_event_count(1) + @validate_error_trace_attributes(callable_name(ValueError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) + @validate_custom_events(agent_recorded_event_error) + @validate_custom_event_count(count=1) + @validate_transaction_metrics( + "test_agent_execution_error", + scoped_metrics=[(f"Llm/agent/LangChain/{method_name}/my_agent", 1)], + rollup_metrics=[(f"Llm/agent/LangChain/{method_name}/my_agent", 1)], + background_task=True, + ) + @validate_attributes("agent", ["llm"]) + @background_task(name="test_agent_execution_error") + def _test(): + set_trace_info() + my_agent = create_agent_runnable( + tools=[add_exclamation], system_prompt="You are a text manipulation algorithm." + ) + with pytest.raises(ValueError): + exercise_agent(my_agent, PROMPT) # raises ValueError + + _test() # No output to validate From 6486445c313b2a06c97c4c8109ef69cf407f64b4 Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Tue, 13 Jan 2026 15:24:38 -0800 Subject: [PATCH 060/124] New Tool testing Co-authored-by: Uma Annamalai --- tests/mlmodel_langchain/_test_tools.py | 54 +++++ tests/mlmodel_langchain/test_tools.py | 202 ++++++++++++++++++ .../{test_tool.py => test_tools_legacy.py} | 81 ++++--- 3 files changed, 292 insertions(+), 45 deletions(-) create mode 100644 tests/mlmodel_langchain/_test_tools.py create mode 100644 tests/mlmodel_langchain/test_tools.py rename tests/mlmodel_langchain/{test_tool.py => test_tools_legacy.py} (84%) diff --git a/tests/mlmodel_langchain/_test_tools.py b/tests/mlmodel_langchain/_test_tools.py new file mode 100644 index 0000000000..a187a68767 --- /dev/null +++ b/tests/mlmodel_langchain/_test_tools.py @@ -0,0 +1,54 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from langchain.tools import tool + + +@tool("add_exclamation") +def add_exclamation_sync(message: str) -> str: + """Adds an exclamation mark to the input message.""" + if "exc" in message: + raise RuntimeError("Oops") + return f"{message}!" + + +@tool("add_exclamation") +async def add_exclamation_async(message: str) -> str: + """Adds an exclamation mark to the input message.""" + if "exc" in message: + raise RuntimeError("Oops") + return f"{message}!" + + +@pytest.fixture(scope="session", params=["sync_tool", "async_tool"]) +def tool_type(request): + return request.param + + +@pytest.fixture(scope="session") +def tool_method_name(tool_type): + return "run" if tool_type == "sync_tool" else "arun" + + +@pytest.fixture(scope="session") +def add_exclamation(tool_type, exercise_agent): + if tool_type == "sync_tool": + return add_exclamation_sync + elif tool_type == "async_tool": + if exercise_agent._called_method in {"invoke", "stream"}: + pytest.skip("Async tools cannot be invoked synchronously.") + return add_exclamation_async + else: + raise NotImplementedError diff --git a/tests/mlmodel_langchain/test_tools.py b/tests/mlmodel_langchain/test_tools.py new file mode 100644 index 0000000000..d5e4774d5f --- /dev/null +++ b/tests/mlmodel_langchain/test_tools.py @@ -0,0 +1,202 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from langchain.messages import HumanMessage +from testing_support.fixtures import reset_core_stats_engine, validate_attributes +from testing_support.ml_testing_utils import ( + disabled_ai_monitoring_record_content_settings, + events_with_context_attrs, + tool_events_sans_content, +) +from testing_support.validators.validate_custom_event import validate_custom_event_count +from testing_support.validators.validate_custom_events import validate_custom_events +from testing_support.validators.validate_error_trace_attributes import validate_error_trace_attributes +from testing_support.validators.validate_transaction_error_event_count import validate_transaction_error_event_count +from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics + +from newrelic.api.background_task import background_task +from newrelic.api.llm_custom_attributes import WithLlmCustomAttributes +from newrelic.common.object_names import callable_name +from newrelic.common.object_wrapper import transient_function_wrapper + +from ._test_tools import add_exclamation, tool_method_name, tool_type + +PROMPT = {"messages": [HumanMessage('Use a tool to add an exclamation to the word "Hello"')]} +ERROR_PROMPT = {"messages": [HumanMessage('Use a tool to add an exclamation to the word "exc"')]} +SYNC_METHODS = {"invoke", "stream"} + +tool_recorded_event = [ + ( + {"type": "LlmTool"}, + { + "id": None, + "run_id": None, + "output": "Hello!", + "name": "add_exclamation", + "agent_name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "input": "{'message': 'Hello'}", + "vendor": "langchain", + "ingest_source": "Python", + "duration": None, + }, + ) +] + +tool_recorded_event_execution_error = [ + ( + {"type": "LlmTool"}, + { + "id": None, + "run_id": None, + "name": "add_exclamation", + "agent_name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "input": "{'message': 'exc'}", + "vendor": "langchain", + "ingest_source": "Python", + "error": True, + "duration": None, + }, + ) +] + +tool_recorded_event_forced_internal_error = [ + ( + {"type": "LlmTool"}, + { + "id": None, + "run_id": None, + "name": "add_exclamation", + "agent_name": "my_agent", + "span_id": None, + "trace_id": "trace-id", + "input": "{'message': 'Hello'}", + "vendor": "langchain", + "ingest_source": "Python", + "duration": None, + "error": True, + }, + ) +] + + +@reset_core_stats_engine() +def test_tool(exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name): + @validate_custom_events(events_with_context_attrs(tool_recorded_event)) + @validate_custom_event_count(count=11) + @validate_transaction_metrics( + "test_tool", + scoped_metrics=[(f"Llm/tool/LangChain/{tool_method_name}/add_exclamation", 1)], + rollup_metrics=[(f"Llm/tool/LangChain/{tool_method_name}/add_exclamation", 1)], + background_task=True, + ) + @validate_attributes("agent", ["llm"]) + @background_task(name="test_tool") + def _test(): + set_trace_info() + my_agent = create_agent_runnable( + tools=[add_exclamation], system_prompt="You are a text manipulation algorithm." + ) + + with WithLlmCustomAttributes({"context": "attr"}): + exercise_agent(my_agent, PROMPT) + + _test() + + +@reset_core_stats_engine() +@disabled_ai_monitoring_record_content_settings +def test_tool_no_content(exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name): + @validate_custom_events(tool_events_sans_content(tool_recorded_event)) + @validate_custom_event_count(count=11) + @validate_transaction_metrics( + "test_tool_no_content", + scoped_metrics=[(f"Llm/tool/LangChain/{tool_method_name}/add_exclamation", 1)], + rollup_metrics=[(f"Llm/tool/LangChain/{tool_method_name}/add_exclamation", 1)], + background_task=True, + ) + @validate_attributes("agent", ["llm"]) + @background_task(name="test_tool_no_content") + def _test(): + set_trace_info() + my_agent = create_agent_runnable( + tools=[add_exclamation], system_prompt="You are a text manipulation algorithm." + ) + exercise_agent(my_agent, PROMPT) + + _test() + + +@reset_core_stats_engine() +def test_tool_execution_error(exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name): + @validate_transaction_error_event_count(1) + @validate_error_trace_attributes( + callable_name(RuntimeError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}} + ) + @validate_custom_events(tool_recorded_event_execution_error) + @validate_custom_event_count(count=5) + @validate_transaction_metrics( + "test_tool_execution_error", + scoped_metrics=[(f"Llm/tool/LangChain/{tool_method_name}/add_exclamation", 1)], + rollup_metrics=[(f"Llm/tool/LangChain/{tool_method_name}/add_exclamation", 1)], + background_task=True, + ) + @validate_attributes("agent", ["llm"]) + @background_task(name="test_tool_execution_error") + def _test(): + set_trace_info() + my_agent = create_agent_runnable( + tools=[add_exclamation], system_prompt="You are a text manipulation algorithm." + ) + with pytest.raises(RuntimeError): + exercise_agent(my_agent, ERROR_PROMPT) + + _test() + + +@reset_core_stats_engine() +def test_tool_pre_execution_exception( + exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name +): + # Add a wrapper to intentionally force an error in the setup logic of BaseTool + @transient_function_wrapper("langchain_core.tools.base", "BaseTool._parse_input") + def inject_exception(wrapped, instance, args, kwargs): + raise ValueError("Oops") + + @inject_exception + @validate_transaction_error_event_count(1) + @validate_error_trace_attributes(callable_name(ValueError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) + @validate_custom_events(tool_recorded_event_forced_internal_error) + @validate_custom_event_count(count=5) + @validate_transaction_metrics( + "test_tool_pre_execution_exception", + scoped_metrics=[(f"Llm/tool/LangChain/{tool_method_name}/add_exclamation", 1)], + rollup_metrics=[(f"Llm/tool/LangChain/{tool_method_name}/add_exclamation", 1)], + background_task=True, + ) + @validate_attributes("agent", ["llm"]) + @background_task(name="test_tool_pre_execution_exception") + def _test(): + set_trace_info() + my_agent = create_agent_runnable( + tools=[add_exclamation], system_prompt="You are a text manipulation algorithm." + ) + with pytest.raises(ValueError): + exercise_agent(my_agent, PROMPT) + + _test() diff --git a/tests/mlmodel_langchain/test_tool.py b/tests/mlmodel_langchain/test_tools_legacy.py similarity index 84% rename from tests/mlmodel_langchain/test_tool.py rename to tests/mlmodel_langchain/test_tools_legacy.py index 9ce8d7c2a5..94c942bca0 100644 --- a/tests/mlmodel_langchain/test_tool.py +++ b/tests/mlmodel_langchain/test_tools_legacy.py @@ -42,7 +42,7 @@ @pytest.fixture def single_arg_tool(): - @tool + @tool("single_arg_tool") def _single_arg_tool(query: str): """A test tool that returns query string""" return query @@ -52,7 +52,7 @@ def _single_arg_tool(query: str): @pytest.fixture def multi_arg_tool(): - @tool + @tool("multi_arg_tool") def _multi_arg_tool(first_num: int, second_num: int): """A test tool that adds two integers together""" return first_num + second_num @@ -67,8 +67,7 @@ def _multi_arg_tool(first_num: int, second_num: int): "id": None, # UUID that varies with each run "run_id": None, "output": "Python Agent", - "name": "_single_arg_tool", - "description": "A test tool that returns query string", + "name": "single_arg_tool", "span_id": None, "trace_id": "trace-id", "input": "{'query': 'Python Agent'}", @@ -84,9 +83,9 @@ def _multi_arg_tool(first_num: int, second_num: int): @validate_custom_events(events_with_context_attrs(single_arg_tool_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( - name="test_tool:test_langchain_single_arg_tool", - scoped_metrics=[("Llm/tool/LangChain/run", 1)], - rollup_metrics=[("Llm/tool/LangChain/run", 1)], + name="mlmodel_langchain.test_tools_legacy:test_langchain_single_arg_tool", + scoped_metrics=[("Llm/tool/LangChain/run/single_arg_tool", 1)], + rollup_metrics=[("Llm/tool/LangChain/run/single_arg_tool", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], background_task=True, ) @@ -103,9 +102,9 @@ def test_langchain_single_arg_tool(set_trace_info, single_arg_tool): @validate_custom_events(tool_events_sans_content(single_arg_tool_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( - name="test_tool:test_langchain_single_arg_tool_no_content", - scoped_metrics=[("Llm/tool/LangChain/run", 1)], - rollup_metrics=[("Llm/tool/LangChain/run", 1)], + name="mlmodel_langchain.test_tools_legacy:test_langchain_single_arg_tool_no_content", + scoped_metrics=[("Llm/tool/LangChain/run/single_arg_tool", 1)], + rollup_metrics=[("Llm/tool/LangChain/run/single_arg_tool", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], background_task=True, ) @@ -120,9 +119,9 @@ def test_langchain_single_arg_tool_no_content(set_trace_info, single_arg_tool): @validate_custom_events(events_with_context_attrs(single_arg_tool_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( - name="test_tool:test_langchain_single_arg_tool_async", - scoped_metrics=[("Llm/tool/LangChain/arun", 1)], - rollup_metrics=[("Llm/tool/LangChain/arun", 1)], + name="mlmodel_langchain.test_tools_legacy:test_langchain_single_arg_tool_async", + scoped_metrics=[("Llm/tool/LangChain/arun/single_arg_tool", 1)], + rollup_metrics=[("Llm/tool/LangChain/arun/single_arg_tool", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], background_task=True, ) @@ -139,9 +138,9 @@ def test_langchain_single_arg_tool_async(set_trace_info, single_arg_tool, loop): @validate_custom_events(tool_events_sans_content(single_arg_tool_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( - name="test_tool:test_langchain_single_arg_tool_async_no_content", - scoped_metrics=[("Llm/tool/LangChain/arun", 1)], - rollup_metrics=[("Llm/tool/LangChain/arun", 1)], + name="mlmodel_langchain.test_tools_legacy:test_langchain_single_arg_tool_async_no_content", + scoped_metrics=[("Llm/tool/LangChain/arun/single_arg_tool", 1)], + rollup_metrics=[("Llm/tool/LangChain/arun/single_arg_tool", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], background_task=True, ) @@ -159,17 +158,13 @@ def test_langchain_single_arg_tool_async_no_content(set_trace_info, single_arg_t "id": None, # UUID that varies with each run "run_id": None, "output": "81", - "name": "_multi_arg_tool", - "description": "A test tool that adds two integers together", + "name": "multi_arg_tool", "span_id": None, "trace_id": "trace-id", "input": "{'first_num': 53, 'second_num': 28}", "vendor": "langchain", "ingest_source": "Python", "duration": None, - "tags": "['python', 'test_tags']", - "metadata.test": "langchain", - "metadata.test_run": True, }, ) ] @@ -179,9 +174,9 @@ def test_langchain_single_arg_tool_async_no_content(set_trace_info, single_arg_t @validate_custom_events(multi_arg_tool_recorded_events) @validate_custom_event_count(count=1) @validate_transaction_metrics( - name="test_tool:test_langchain_multi_arg_tool", - scoped_metrics=[("Llm/tool/LangChain/run", 1)], - rollup_metrics=[("Llm/tool/LangChain/run", 1)], + name="mlmodel_langchain.test_tools_legacy:test_langchain_multi_arg_tool", + scoped_metrics=[("Llm/tool/LangChain/run/multi_arg_tool", 1)], + rollup_metrics=[("Llm/tool/LangChain/run/multi_arg_tool", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], background_task=True, ) @@ -197,9 +192,9 @@ def test_langchain_multi_arg_tool(set_trace_info, multi_arg_tool): @validate_custom_events(multi_arg_tool_recorded_events) @validate_custom_event_count(count=1) @validate_transaction_metrics( - name="test_tool:test_langchain_multi_arg_tool_async", - scoped_metrics=[("Llm/tool/LangChain/arun", 1)], - rollup_metrics=[("Llm/tool/LangChain/arun", 1)], + name="mlmodel_langchain.test_tools_legacy:test_langchain_multi_arg_tool_async", + scoped_metrics=[("Llm/tool/LangChain/arun/multi_arg_tool", 1)], + rollup_metrics=[("Llm/tool/LangChain/arun/multi_arg_tool", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], background_task=True, ) @@ -219,17 +214,13 @@ def test_langchain_multi_arg_tool_async(set_trace_info, multi_arg_tool, loop): { "id": None, # UUID that varies with each run "run_id": None, # No run ID created on error - "name": "_multi_arg_tool", - "description": "A test tool that adds two integers together", + "name": "multi_arg_tool", "span_id": None, "trace_id": "trace-id", "input": "{'first_num': 53}", "vendor": "langchain", "ingest_source": "Python", "duration": None, - "tags": "['test_tags', 'python']", - "metadata.test": "langchain", - "metadata.test_run": True, "error": True, }, ) @@ -244,9 +235,9 @@ def test_langchain_multi_arg_tool_async(set_trace_info, multi_arg_tool, loop): @validate_custom_events(events_with_context_attrs(multi_arg_error_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( - name="test_tool:test_langchain_error_in_run", - scoped_metrics=[("Llm/tool/LangChain/run", 1)], - rollup_metrics=[("Llm/tool/LangChain/run", 1)], + name="mlmodel_langchain.test_tools_legacy:test_langchain_error_in_run", + scoped_metrics=[("Llm/tool/LangChain/run/multi_arg_tool", 1)], + rollup_metrics=[("Llm/tool/LangChain/run/multi_arg_tool", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], background_task=True, ) @@ -270,9 +261,9 @@ def test_langchain_error_in_run(set_trace_info, multi_arg_tool): @validate_custom_events(tool_events_sans_content(multi_arg_error_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( - name="test_tool:test_langchain_error_in_run_no_content", - scoped_metrics=[("Llm/tool/LangChain/run", 1)], - rollup_metrics=[("Llm/tool/LangChain/run", 1)], + name="mlmodel_langchain.test_tools_legacy:test_langchain_error_in_run_no_content", + scoped_metrics=[("Llm/tool/LangChain/run/multi_arg_tool", 1)], + rollup_metrics=[("Llm/tool/LangChain/run/multi_arg_tool", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], background_task=True, ) @@ -294,9 +285,9 @@ def test_langchain_error_in_run_no_content(set_trace_info, multi_arg_tool): @validate_custom_events(events_with_context_attrs(multi_arg_error_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( - name="test_tool:test_langchain_error_in_run_async", - scoped_metrics=[("Llm/tool/LangChain/arun", 1)], - rollup_metrics=[("Llm/tool/LangChain/arun", 1)], + name="mlmodel_langchain.test_tools_legacy:test_langchain_error_in_run_async", + scoped_metrics=[("Llm/tool/LangChain/arun/multi_arg_tool", 1)], + rollup_metrics=[("Llm/tool/LangChain/arun/multi_arg_tool", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], background_task=True, ) @@ -322,9 +313,9 @@ def test_langchain_error_in_run_async(set_trace_info, multi_arg_tool, loop): @validate_custom_events(tool_events_sans_content(multi_arg_error_recorded_events)) @validate_custom_event_count(count=1) @validate_transaction_metrics( - name="test_tool:test_langchain_error_in_run_async_no_content", - scoped_metrics=[("Llm/tool/LangChain/arun", 1)], - rollup_metrics=[("Llm/tool/LangChain/arun", 1)], + name="mlmodel_langchain.test_tools_legacy:test_langchain_error_in_run_async_no_content", + scoped_metrics=[("Llm/tool/LangChain/arun/multi_arg_tool", 1)], + rollup_metrics=[("Llm/tool/LangChain/arun/multi_arg_tool", 1)], custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], background_task=True, ) @@ -391,7 +382,7 @@ def test_langchain_multiple_async_calls(set_trace_info, single_arg_tool, multi_a @validate_custom_events(expected_events) @validate_custom_event_count(count=2) @validate_transaction_metrics( - name="test_tool:test_langchain_multiple_async_calls.._test", + name="mlmodel_langchain.test_tools_legacy:test_langchain_multiple_async_calls.._test", custom_metrics=[(f"Supportability/Python/ML/LangChain/{langchain.__version__}", 1)], background_task=True, ) From 55e9af3b3bdadf47141f2b628782931cb8062ca0 Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Tue, 13 Jan 2026 15:26:11 -0800 Subject: [PATCH 061/124] Expand Test Matrixing Co-authored-by: Uma Annamalai --- tests/mlmodel_langchain/conftest.py | 214 ++++++++++++++++++++++++---- 1 file changed, 188 insertions(+), 26 deletions(-) diff --git a/tests/mlmodel_langchain/conftest.py b/tests/mlmodel_langchain/conftest.py index 58b0221d0b..892baf7552 100644 --- a/tests/mlmodel_langchain/conftest.py +++ b/tests/mlmodel_langchain/conftest.py @@ -12,18 +12,12 @@ # See the License for the specific language governing permissions and # limitations under the License. +import itertools import json import os from pathlib import Path import pytest -from _mock_external_openai_server import ( - MockExternalOpenAIServer, - extract_shortened_prompt, - get_openai_version, - openai_version, - simple_get, -) from langchain_openai import ChatOpenAI, OpenAIEmbeddings from testing_support.fixture.event_loop import event_loop as loop from testing_support.fixtures import ( @@ -31,11 +25,14 @@ collector_available_fixture, override_application_settings, ) +from testing_support.ml_testing_utils import set_trace_info from newrelic.api.transaction import current_transaction from newrelic.common.object_wrapper import ObjectProxy, wrap_function_wrapper from newrelic.common.signature import bind_args +from ._mock_external_openai_server import MockExternalOpenAIServer, extract_shortened_prompt, simple_get + _default_settings = { "package_reporting.enabled": False, # Turn off package reporting for testing as it causes slow downs. "transaction_tracer.explain_threshold": 0.0, @@ -57,10 +54,12 @@ OPENAI_AUDIT_LOG_CONTENTS = {} # Intercept outgoing requests and log to file for mocking RECORDED_HEADERS = {"x-request-id", "content-type"} +EXPECTED_AGENT_RESPONSE = 'The word "Hello" with an exclamation mark added is "Hello!"' +EXPECTED_TOOL_OUTPUT = "Hello!" @pytest.fixture(scope="session") -def openai_clients(openai_version, MockExternalOpenAIServer): +def openai_clients(MockExternalOpenAIServer): """ This configures the openai client and returns it for openai v1 and only configures openai for v0 since there is no client. @@ -95,8 +94,181 @@ def chat_openai_client(openai_clients): return chat_client +def state_function_step(state): + return {"messages": [f"The real agent said: {state['messages'][-1].content}"]} + + +def append_function_step(state): + from langchain.messages import ToolMessage + + messages = state["messages"] if "messages" in state else state["model"]["messages"] + messages.append(ToolMessage(f"The real agent said: {messages[-1].content}", tool_call_id=123)) + return state + + +@pytest.fixture(scope="session", params=["create_agent", "StateGraph", "RunnableSeq", "RunnableSequence"]) +def agent_runnable_type(request): + return request.param + + +@pytest.fixture(scope="session") +def create_agent_runnable(agent_runnable_type, chat_openai_client): + """Create different runnable forms of the same agent and model as a fixture.""" + + def _create_agent(model="gpt-5.1", tools=None, system_prompt=None, name="my_agent"): + from langchain.agents import create_agent + + client = chat_openai_client.with_config(model=model, timeout=30) + + return create_agent(model=client, tools=tools, system_prompt=system_prompt, name=name) + + def _create_state_graph(*args, **kwargs): + from langgraph.graph import END, START, MessagesState, StateGraph + + agent = _create_agent(*args, **kwargs) + + graph = StateGraph(MessagesState) + graph.add_node(agent) + graph.add_node(state_function_step) + graph.add_edge(START, "my_agent") + graph.add_edge("my_agent", "state_function_step") + graph.add_edge("state_function_step", END) + + return graph.compile() + + def _create_runnable_seq(*args, **kwargs): + from langgraph._internal._runnable import RunnableSeq + + agent = _create_agent(*args, **kwargs) + + return RunnableSeq(agent, append_function_step) + + def _create_runnable_sequence(*args, **kwargs): + from langchain_core.runnables import RunnableSequence + + agent = _create_agent(*args, **kwargs) + + return RunnableSequence(agent, append_function_step) + + if agent_runnable_type == "create_agent": + return _create_agent + elif agent_runnable_type == "StateGraph": + return _create_state_graph + elif agent_runnable_type == "RunnableSeq": + return _create_runnable_seq + elif agent_runnable_type == "RunnableSequence": + return _create_runnable_sequence + else: + raise NotImplementedError + + +@pytest.fixture(scope="session") +def validate_agent_output(agent_runnable_type): + def _unpack_messages(response): + if isinstance(response, list) and not any(response): + # Only None are returned from RunnableSeq.stream(), avoid the crash + return [] + elif isinstance(response, list): + # stream returns a list of events + # Messages are packaged into nested dicts with a "model" or "tool_call" key, a "message" key, + # which contains a list with one or more messages in order. To unpack everything, + # we need to unpack the dictionaries values and extract the messasges lists, then flatten them. + messages_packed = [next(iter(event.values()))["messages"] for event in response] + return list(itertools.chain.from_iterable(messages_packed)) + + # invoke returns a Response object that contains the messages directly + return response["messages"] + + def _validate_agent_output(response): + is_streaming = isinstance(response, list) + messages = _unpack_messages(response) + if agent_runnable_type == "create_agent": + if is_streaming: + # Events: agent calling tool, tool return value, agent output + assert len(messages) == 3 + assert messages[0].tool_calls + assert messages[1].content == EXPECTED_TOOL_OUTPUT + assert messages[2].content == EXPECTED_AGENT_RESPONSE + else: + # Events: input prompt, agent calling tool, tool return value, agent output + assert len(messages) == 4 + assert messages[1].tool_calls + assert messages[2].content == EXPECTED_TOOL_OUTPUT + assert messages[3].content == EXPECTED_AGENT_RESPONSE + + elif agent_runnable_type == "StateGraph": + # Events: input prompt, agent calling tool, tool return value, agent output, function_step output + assert len(messages) == 5 + assert messages[1].tool_calls + assert messages[2].content == EXPECTED_TOOL_OUTPUT + assert messages[3].content == EXPECTED_AGENT_RESPONSE + + elif agent_runnable_type == "RunnableSeq": + # stream and astream do not directly output anything for RunnableSeq, and can't be validated. + if not is_streaming: + # Events: input prompt, agent calling tool, tool return value, agent output, function_step output + assert len(messages) == 5 + assert messages[1].tool_calls + assert messages[2].content == EXPECTED_TOOL_OUTPUT + assert messages[3].content == EXPECTED_AGENT_RESPONSE + + elif agent_runnable_type == "RunnableSequence": + if is_streaming: + # Events: agent output, function_step output + assert len(messages) == 2 + assert messages[0].content == EXPECTED_AGENT_RESPONSE + else: + # Events: input prompt, agent calling tool, tool return value, agent output, function_step output + assert len(messages) == 5 + assert messages[1].tool_calls + assert messages[2].content == EXPECTED_TOOL_OUTPUT + assert messages[3].content == EXPECTED_AGENT_RESPONSE + + else: + raise NotImplementedError + + return _validate_agent_output + + +@pytest.fixture(scope="session", params=["invoke", "ainvoke", "stream", "astream"]) +def exercise_agent(request, loop, validate_agent_output): + def _exercise_agent(agent, prompt): + if request.param == "invoke": + response = agent.invoke(prompt) + validate_agent_output(response) + return response + elif request.param == "ainvoke": + response = loop.run_until_complete(agent.ainvoke(prompt)) + validate_agent_output(response) + return response + elif request.param == "stream": + response = list(agent.stream(prompt)) + validate_agent_output(response) + return response + elif request.param == "astream": + + async def _exercise_agen(): + return [event async for event in agent.astream(prompt)] + + response = loop.run_until_complete(_exercise_agen()) + validate_agent_output(response) + return response + else: + raise NotImplementedError + + _exercise_agent._called_method = request.param # Used for metric names + return _exercise_agent + + +@pytest.fixture(scope="session") +def method_name(exercise_agent, agent_runnable_type): + if agent_runnable_type == "StateGraph": + return "invoke" if exercise_agent._called_method in {"invoke", "stream"} else "ainvoke" + return exercise_agent._called_method + + @pytest.fixture(autouse=True, scope="session") -def openai_server(openai_version, openai_clients, wrap_httpx_client_send, wrap_stream_iter_events): +def openai_server(wrap_httpx_client_send, wrap_stream_iter_events): """ This fixture will either create a mocked backend for testing purposes, or will set up an audit log file to log responses of the real OpenAI backend to a file. @@ -118,11 +290,12 @@ def openai_server(openai_version, openai_clients, wrap_httpx_client_send, wrap_s @pytest.fixture(scope="session") -def wrap_httpx_client_send(extract_shortened_prompt): +def wrap_httpx_client_send(): def _wrap_httpx_client_send(wrapped, instance, args, kwargs): bound_args = bind_args(wrapped, args, kwargs) stream = bound_args.get("stream", False) request = bound_args["request"] + if not request: return wrapped(*args, **kwargs) @@ -145,6 +318,7 @@ def _wrap_httpx_client_send(wrapped, instance, args, kwargs): rheaders.items(), ) ) + # Append response data to log if stream: OPENAI_AUDIT_LOG_CONTENTS[prompt] = [headers, response.status_code, []] @@ -159,7 +333,7 @@ def _wrap_httpx_client_send(wrapped, instance, args, kwargs): @pytest.fixture(scope="session") -def generator_proxy(openai_version): +def generator_proxy(): class GeneratorProxy(ObjectProxy): def __init__(self, wrapped): super().__init__(wrapped) @@ -184,22 +358,10 @@ def __next__(self): return_val = self.__wrapped__.__next__() if return_val: prompt = list(OPENAI_AUDIT_LOG_CONTENTS.keys())[-1] - if openai_version < (1, 0): - headers = dict( - filter( - lambda k: k[0].lower() in RECORDED_HEADERS - or k[0].lower().startswith("openai") - or k[0].lower().startswith("x-ratelimit"), - return_val._nr_response_headers.items(), - ) - ) - OPENAI_AUDIT_LOG_CONTENTS[prompt][0] = headers - OPENAI_AUDIT_LOG_CONTENTS[prompt][2].append(return_val.to_dict_recursive()) - else: - if not getattr(return_val, "data", "").startswith("[DONE]"): - OPENAI_AUDIT_LOG_CONTENTS[prompt][2].append(return_val.json()) + if not getattr(return_val, "data", "").startswith("[DONE]"): + OPENAI_AUDIT_LOG_CONTENTS[prompt][2].append(return_val.json()) return return_val - except Exception as e: + except Exception: raise def close(self): From 80bff13a41cbe6a4e70411ea2642642bc933b9d8 Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Tue, 13 Jan 2026 15:26:57 -0800 Subject: [PATCH 062/124] Newly recorded responses for LangChain Co-authored-by: Uma Annamalai --- .../_mock_external_openai_server.py | 706 +++++++++++------- 1 file changed, 419 insertions(+), 287 deletions(-) diff --git a/tests/mlmodel_langchain/_mock_external_openai_server.py b/tests/mlmodel_langchain/_mock_external_openai_server.py index 9cd644015a..f59ba056d8 100644 --- a/tests/mlmodel_langchain/_mock_external_openai_server.py +++ b/tests/mlmodel_langchain/_mock_external_openai_server.py @@ -30,293 +30,380 @@ # created by an external call. # 3) This app runs on a separate thread meaning it won't block the test app. STREAMED_RESPONSES_V1 = { - "You are a world class algorithm for extracting information in structured formats.": [ + "system: You are a world class algorithm for extracting information in structured formats. | user: Use the given format to extract information from the following input: Hello, world | user: Tip: Make sure to answer in the correct format": [ { - "content-type": "text/event-stream", - "openai-model": "gpt-3.5-turbo-0125", - "openai-organization": "foobar-jtbczk", - "openai-processing-ms": "511", + "content-type": "text/event-stream; charset=utf-8", + "openai-organization": "user-rk8wq9voijy9sejrncvgi0iw", + "openai-processing-ms": "440", + "openai-project": "proj_0Wv6taeZjWf793P67JMswYY3", "openai-version": "2020-10-01", - "x-ratelimit-limit-requests": "200", - "x-ratelimit-limit-tokens": "40000", - "x-ratelimit-remaining-requests": "196", - "x-ratelimit-remaining-tokens": "39924", - "x-ratelimit-reset-requests": "23m16.298s", - "x-ratelimit-reset-tokens": "114ms", - "x-request-id": "req_69c9ac5f95907fdb4af31572fd99537f", + "x-ratelimit-limit-requests": "10000", + "x-ratelimit-limit-tokens": "50000000", + "x-ratelimit-remaining-requests": "9999", + "x-ratelimit-remaining-tokens": "49999942", + "x-ratelimit-reset-requests": "6ms", + "x-ratelimit-reset-tokens": "0s", + "x-request-id": "req_1addfc2e713648af834cb9992fd417d7", }, 200, [ { - "id": "chatcmpl-8uUiO2kRX1yl9fyniZCjJ6q3GN8wf", + "id": "chatcmpl-CvUIm4qNNuiHpumRpuX0HISeNKViC", "object": "chat.completion.chunk", - "created": 1708475128, + "created": 1767817212, "model": "gpt-3.5-turbo-0125", - "system_fingerprint": "fp_69829325d0", + "service_tier": "default", + "system_fingerprint": None, "choices": [ - {"index": 0, "delta": {"role": "assistant", "content": ""}, "logprobs": None, "finish_reason": None} + { + "index": 0, + "delta": {"role": "assistant", "content": "", "refusal": None}, + "logprobs": None, + "finish_reason": None, + } ], + "usage": None, + "obfuscation": "HeQWMY8H", }, { - "id": "chatcmpl-8uUiO2kRX1yl9fyniZCjJ6q3GN8wf", - "object": "chat.completion.chunk", - "created": 1708475128, - "model": "gpt-3.5-turbo-0125", - "system_fingerprint": "fp_69829325d0", - "choices": [{"index": 0, "delta": {"content": "The"}, "logprobs": None, "finish_reason": None}], - }, - { - "id": "chatcmpl-8uUiO2kRX1yl9fyniZCjJ6q3GN8wf", - "object": "chat.completion.chunk", - "created": 1708475128, - "model": "gpt-3.5-turbo-0125", - "system_fingerprint": "fp_69829325d0", - "choices": [{"index": 0, "delta": {"content": " extracted"}, "logprobs": None, "finish_reason": None}], - }, - { - "id": "chatcmpl-8uUiO2kRX1yl9fyniZCjJ6q3GN8wf", - "object": "chat.completion.chunk", - "created": 1708475128, - "model": "gpt-3.5-turbo-0125", - "system_fingerprint": "fp_69829325d0", - "choices": [ - {"index": 0, "delta": {"content": " information"}, "logprobs": None, "finish_reason": None} - ], - }, - { - "id": "chatcmpl-8uUiO2kRX1yl9fyniZCjJ6q3GN8wf", - "object": "chat.completion.chunk", - "created": 1708475128, - "model": "gpt-3.5-turbo-0125", - "system_fingerprint": "fp_69829325d0", - "choices": [{"index": 0, "delta": {"content": " from"}, "logprobs": None, "finish_reason": None}], - }, - { - "id": "chatcmpl-8uUiO2kRX1yl9fyniZCjJ6q3GN8wf", - "object": "chat.completion.chunk", - "created": 1708475128, - "model": "gpt-3.5-turbo-0125", - "system_fingerprint": "fp_69829325d0", - "choices": [{"index": 0, "delta": {"content": " the"}, "logprobs": None, "finish_reason": None}], - }, - { - "id": "chatcmpl-8uUiO2kRX1yl9fyniZCjJ6q3GN8wf", - "object": "chat.completion.chunk", - "created": 1708475128, - "model": "gpt-3.5-turbo-0125", - "system_fingerprint": "fp_69829325d0", - "choices": [{"index": 0, "delta": {"content": " input"}, "logprobs": None, "finish_reason": None}], - }, - { - "id": "chatcmpl-8uUiO2kRX1yl9fyniZCjJ6q3GN8wf", - "object": "chat.completion.chunk", - "created": 1708475128, - "model": "gpt-3.5-turbo-0125", - "system_fingerprint": "fp_69829325d0", - "choices": [{"index": 0, "delta": {"content": ' "'}, "logprobs": None, "finish_reason": None}], - }, - { - "id": "chatcmpl-8uUiO2kRX1yl9fyniZCjJ6q3GN8wf", - "object": "chat.completion.chunk", - "created": 1708475128, - "model": "gpt-3.5-turbo-0125", - "system_fingerprint": "fp_69829325d0", - "choices": [{"index": 0, "delta": {"content": "Hello"}, "logprobs": None, "finish_reason": None}], - }, - { - "id": "chatcmpl-8uUiO2kRX1yl9fyniZCjJ6q3GN8wf", - "object": "chat.completion.chunk", - "created": 1708475128, - "model": "gpt-3.5-turbo-0125", - "system_fingerprint": "fp_69829325d0", - "choices": [{"index": 0, "delta": {"content": ","}, "logprobs": None, "finish_reason": None}], - }, - { - "id": "chatcmpl-8uUiO2kRX1yl9fyniZCjJ6q3GN8wf", - "object": "chat.completion.chunk", - "created": 1708475128, - "model": "gpt-3.5-turbo-0125", - "system_fingerprint": "fp_69829325d0", - "choices": [{"index": 0, "delta": {"content": " world"}, "logprobs": None, "finish_reason": None}], - }, - { - "id": "chatcmpl-8uUiO2kRX1yl9fyniZCjJ6q3GN8wf", - "object": "chat.completion.chunk", - "created": 1708475128, - "model": "gpt-3.5-turbo-0125", - "system_fingerprint": "fp_69829325d0", - "choices": [{"index": 0, "delta": {"content": '"'}, "logprobs": None, "finish_reason": None}], - }, - { - "id": "chatcmpl-8uUiO2kRX1yl9fyniZCjJ6q3GN8wf", - "object": "chat.completion.chunk", - "created": 1708475128, - "model": "gpt-3.5-turbo-0125", - "system_fingerprint": "fp_69829325d0", - "choices": [{"index": 0, "delta": {"content": " is"}, "logprobs": None, "finish_reason": None}], - }, - { - "id": "chatcmpl-8uUiO2kRX1yl9fyniZCjJ6q3GN8wf", + "id": "chatcmpl-CvUIm4qNNuiHpumRpuX0HISeNKViC", "object": "chat.completion.chunk", - "created": 1708475128, + "created": 1767817212, "model": "gpt-3.5-turbo-0125", - "system_fingerprint": "fp_69829325d0", - "choices": [{"index": 0, "delta": {"content": ' "'}, "logprobs": None, "finish_reason": None}], + "service_tier": "default", + "system_fingerprint": None, + "choices": [{"index": 0, "delta": {"content": "Hello,"}, "logprobs": None, "finish_reason": None}], + "usage": None, + "obfuscation": "DferQO2zD", }, { - "id": "chatcmpl-8uUiO2kRX1yl9fyniZCjJ6q3GN8wf", + "id": "chatcmpl-CvUIm4qNNuiHpumRpuX0HISeNKViC", "object": "chat.completion.chunk", - "created": 1708475128, + "created": 1767817212, "model": "gpt-3.5-turbo-0125", - "system_fingerprint": "fp_69829325d0", - "choices": [{"index": 0, "delta": {"content": "H"}, "logprobs": None, "finish_reason": None}], + "service_tier": "default", + "system_fingerprint": None, + "choices": [{"index": 0, "delta": {"content": " world!"}, "logprobs": None, "finish_reason": None}], + "usage": None, + "obfuscation": "LlLJvKqz", }, { - "id": "chatcmpl-8uUiO2kRX1yl9fyniZCjJ6q3GN8wf", + "id": "chatcmpl-CvUIm4qNNuiHpumRpuX0HISeNKViC", "object": "chat.completion.chunk", - "created": 1708475128, + "created": 1767817212, "model": "gpt-3.5-turbo-0125", - "system_fingerprint": "fp_69829325d0", - "choices": [{"index": 0, "delta": {"content": "elloworld"}, "logprobs": None, "finish_reason": None}], - }, - { - "id": "chatcmpl-8uUiO2kRX1yl9fyniZCjJ6q3GN8wf", - "object": "chat.completion.chunk", - "created": 1708475128, - "model": "gpt-3.5-turbo-0125", - "system_fingerprint": "fp_69829325d0", - "choices": [{"index": 0, "delta": {"content": '"'}, "logprobs": None, "finish_reason": None}], + "service_tier": "default", + "system_fingerprint": None, + "choices": [{"index": 0, "delta": {}, "logprobs": None, "finish_reason": "stop"}], + "usage": None, + "obfuscation": "Qzvy", }, { - "id": "chatcmpl-8uUiO2kRX1yl9fyniZCjJ6q3GN8wf", + "id": "chatcmpl-CvUIm4qNNuiHpumRpuX0HISeNKViC", "object": "chat.completion.chunk", - "created": 1708475128, + "created": 1767817212, "model": "gpt-3.5-turbo-0125", - "system_fingerprint": "fp_69829325d0", - "choices": [{"index": 0, "delta": {}, "logprobs": None, "finish_reason": "stop"}], + "service_tier": "default", + "system_fingerprint": None, + "choices": [], + "usage": { + "prompt_tokens": 96, + "completion_tokens": 24, + "total_tokens": 120, + "prompt_tokens_details": {"cached_tokens": 0, "audio_tokens": 0}, + "completion_tokens_details": { + "reasoning_tokens": 0, + "audio_tokens": 0, + "accepted_prediction_tokens": 0, + "rejected_prediction_tokens": 0, + }, + }, + "obfuscation": "NzeDrNhe", }, ], ] } RESPONSES_V1 = { - "3923": [ + 'system: You are a text manipulation algorithm. | user: Use a tool to add an exclamation to the word "Hello"': [ { "content-type": "application/json", - "openai-model": "text-embedding-ada-002", - "openai-organization": "new-relic-nkmd8b", - "openai-processing-ms": "26", + "openai-organization": "user-rk8wq9voijy9sejrncvgi0iw", + "openai-processing-ms": "324", + "openai-project": "proj_0Wv6taeZjWf793P67JMswYY3", "openai-version": "2020-10-01", - "x-ratelimit-limit-requests": "3000", - "x-ratelimit-limit-tokens": "1000000", - "x-ratelimit-remaining-requests": "2999", - "x-ratelimit-remaining-tokens": "999992", - "x-ratelimit-reset-requests": "20ms", + "x-ratelimit-limit-requests": "10000", + "x-ratelimit-limit-tokens": "50000000", + "x-ratelimit-remaining-requests": "9999", + "x-ratelimit-remaining-tokens": "49999974", + "x-ratelimit-reset-requests": "6ms", "x-ratelimit-reset-tokens": "0s", - "x-request-id": "req_222ee158a955e783854f6e7cf52e6e5a", + "x-request-id": "req_619548c272db4f1ab380b83de9fdedef", }, 200, { - "object": "list", - "data": [ + "id": "chatcmpl-CukvsGfSQihNO9I3FTqaNKERWtUca", + "object": "chat.completion", + "created": 1767642812, + "model": "gpt-3.5-turbo-0125", + "choices": [ { - "object": "embedding", "index": 0, - "embedding": "0ylWOiHvhzsp+JM8/ZzpvC4vFL115AW8j02kvJIXjbvOdue8Trg4vGvz4ruG0Mw74dUKvcnKrLvBwSA8fWmAO3ZRnTzwXN265+7cPLqpvbvjM8u8rfVlPPjoi7puxe67gLBGuwWlBrmF2G87W+ltvIixrzx5Gwa9bGD6PJi7pLxoIde8DwzTOpQAE7yIsS88+OgLvN/shDs9vZo8n1Dlu51uEzxwMRe77oKuO3qQwLsSWs28bswiPF67+TxLYpu8mbMBvMWLiTweHus7KW3Oun5ShrvECGe89KpXO5N9cLwrVlS84sazOweH2LqrG7c8Kl53vMKjcrx3M2+8fktSPN54ubx6DK+6dsZXvD29Gj0Lza+8Q2GyPDF2Wjw3Es88VzUQvC27yLw5Agk9ihakvPrRkbwh6NO82yo/uqbktjzatvM8eZ8Xvefu3LtXqsq7wNgau+wlXbxmONG7X7qKPJ9XGbzIXRW8pPT8OmJ9vzyjh+U7UQazPMhOvrxKeRU9/C/Su1iiJz3tkvS8EeWSvCl0gryiKSU7jPeGvMjZA7x/O4w7LijguzeW4Dv5VSM8e3nGuqZgJbztknS8o44ZPV+rszxkV+68Rqj4uxnnarrP4g88IINfvBUkNrzneSK82FF/PJx2NjuzHKA8RFLbOjmGGj3/CBK8vf9aPKQKiLw1QMO87/fovGEQKD1NS6E8yrOyPKOOmTxABOG6fd66PPM1nbyqI9o8o4dlvF+z1ruG0Ew8eRTSPG1QNLwlLqu73BtoO0TOST30orQ8vnMmPZ3ypLxUXNC8j8kSvOb9M7s7WKY88Gu0PP4QtTzf9Cc8tf0CvM75iTwWkU28xnQPOxUzDb2WZYe84zPLPPWTXbzbrtA7nPrHPALMxjyalVM7NxJPvGt2hbzlFK680csVPOMk9LtB/L08dzPvO9MwijyV6Zi66kMLvNFHhLy0BaY7g/5AO1GKRDxeu3k7xQBEPEGHA71hEKg77RUXPKExyDt6BXu7hd8jPBtMXzy2apo6oiLxucwRczyoSSu/sqjUvD29GjzzuS69vmxyvJmzAT1agwo8LihgPF4+HLwiZMI8hPYdOnAxl7ydbpO6WYstOgYSHju30P28M9tOPHsEDLxhjJa88zUdunILRrwAbgY9mpwHvOBhv7viQqI8iR5Huv2URjwYgQe94zNLvBaYgTw/Io+8vA4yO8E+/jtl2hC8/ZzpPB+Stjz5Xca8WYutPAd/tbs/G9s8YYyWvE64uLsGC2o89ou6OnqQQLxD1my8ZU/LPO96izzTKdY8dzojPPJMl7wUsGq86ksuPEATODy7oZo65v0zvJXi5DwNI807IfB2O7T+cbwdLcK7eZhjO/8IkrxrdoW7ftaXvDkCCTxz9Eu96kuuPPO5rjzkHFG6wcGgO1geFj0B1Gk8vA6yPC8YGjy8kkM7/KtAPaBAn7zFdX48aCiLPEcrm7weHmu7TcDbvBWox7tKcuE8E86YvBHttbzpWoU8sqjUO614CDpXJjk9VFStPEALlbxPsJW8SJAPPD06+Dz3/4U7C0kePJ3ypLvBPQ88CHeSuil8JbwyZpQ8EHHHOvLJ9DvzNZ08e3nGvGIBUTqaIJk8ui3PvGa84rp3vjQ7wTbbuz29GjzObsS6llawvEJwCTw7YEk8JMGTu+fu3LxT4GE8BLwAvMbpSTt93jq8O2BJvIe5Ujwh7we84GG/vLVyvbzDm8+8f0MvO69hjjzRSHO6m4Z8vPYPzDx11a67juCMO8jZA7vatvM8+OiLvKC9fLy9e0m7DhOHPM/jfrtD1mw8/C9SvFiahDt3M285nIWNO5qV0zsbTN+76sccu8hdFby317E7w6KDPHkjKbyk+zC7sTMaO/u6Fzz5XUa7pPR8u2cwLjzNAS28PjmJvIEkkrzWAha8FhVfvPSxizxePhy8ucC3vGbDlryvYQ690cuVu/JMlzyt/Jm84yT0PJCymLvJRpu8zn2bvMWLCbxs45w7PEnPPKwEPTsOEwc8SInbuQ6XGDyDgtI8oxIrvLZjZrwz4gK7YCDuO9QS3DxPqWG8p828PBrXJDz60RE7yUabPMV1/rkeFsg8l9IePb17yTw/l8k8s5l9PGAYy7tV0Js7kDYqu27Fbjml8407sTs9PSnxX7pgJ6K6XcrQvOfuXLw+rsO8cDEXPMV8MjxAE7g71n4EvKDEsLvfcJY87RUXPMBN1bolNk48XdGEPIg1QTsfDiU8AG/1OzNXPT34ZWk8YZS5vBB56ryvWto6V6rKPOQjhTwzVz28rIjOOg4bKjwBX687fs/jPC4vFLm8DrI7Sv2mPFiT0Dzo3pa8cZf6Oy4vFLxYF+I8aoZLu7X9gjxwrYU7rfVlPKm2wrykf0K8VrLtO8Z0jzmJLR68oEAfO9q28zrWApa7bOu/PE64uDzAycM7+V3GushOPryUABM8ipo1POrHnLvY3MS8N50UPF67ebvxVLq8vJJDvCAGgrtVRdY6gLBGPOlT0TpgJ6I8UXvtu954OTtHp4m6xAhnvOb2/7zXb607JwjaPNZ30LsvGJo7lHyBO+6Rhbqe4807nuqBPIOJBrz2D0y5qDrUvKOOmTu317G7SYE4vM7y1TyXTg08ZFduOlGKRLo66447g3qvOzxJTzvcngq82UlcOyl0gjscPJk7iwfNvEPdoLvuitG8R6eJu6IhArxgGEs8QnH4u3P0yztVwUS7tA1JvI9FgbxYF2I8DDKku8b4oDtfugq8Tri4O9frm7xZhHk9EPXYPKuXpTsOFPY7Rq8svLG3qzvO+Qm94yT0O31iTDusgKs7q5DxuvYAdbs2pbc8/Zxpu+lahTwXgvY7+z4pvLWBlLtS/g87Nq1aPLKoVLqWZQc8+dm0PEPWbDzCqqa7hefGO4oWJLzNAa087/fou6QD1LzNEIQ89g/MOxLWOzz9Hww7leLkuqOH5bu2Y+Y6pllxPGa8YryG1wC6pH/Cu3Rh4zsgBgI7YCeiux0tQjzkHNE7EWmkvAtCajzuBsA8kDYqvP2c6bpuxW48/DaGvNwb6Ds687E5egX7O0GHA70pfKW8khcNvdyeirw+OQk86OY5vAFfLzzMnLi8flKGu59Xmbwnkx+8xvigu2RmRbxgJyK8bVA0PLwHfry6Jay8Fw28uy6kzjxr+hY893RAPMovITxpERG9coe0PIx7mLxK/aa8gagjvC4vFLx0YWM8AG6Gu1tskDscRLw6+k0AvIuDuzxvObo8Y+rWu31izDsuq4K86c+/POfu3DyBoIC8Pxvbu+dqSzsQgJ68B381PIe50rwxdlq80ynWvJi0cLxFO2E8PM1gPNo5Frue6gG96N4WvWisHLxFxqa81vM+PEpy4Tp5I6k83oDcPMyUFTy1gZQ712eKvNlJ3Lwsyp88hGvYvOfu3Lor0kK8Q9ZsvLG3q7w+rkM8llYwvdMhs7wLSZ47+GXpu0enCTvzua68IAYCO37HwLxRe+07aCiLO2CjED3MlBU8zJQVPMjSz7uIsS87S2q+vHbNC7yf0we9JwjavABuBr3egNw7y6sPvL5zpjxdRr87oL18PPWaEbyiGs45oTFIOmkZtLyc+ke8k4SkvMQXvjw7WKY8BgvqPIINmDynzbw7eZ8XPJx2tjsuKGA74VLouRHe3ruMdGS8eCvMPCtOsTzatvM7agI6u8OiAz1ESjg8znZnu89moTu7oRq7FhXfu6T7sLx9Wqm7QngsvCplq7xr+pa8W+ltO+pDCzzzuS68yjfEuxnuHjySGPy8SJgyPV+6CrsI7My5NTggPN/0pzxd0QS9m42wvJMItrqpK/07pexZPDJfYDoY9sE8Pb0au7ORWjwZ7h68+tGROkL0Gr1GqHg8cCrjukzeibuHPWQ8BRpBvMjZA71sYHq84VkcujxJzzwnkx+90rSbPLG3K7xhlLm8cgMjOjPigrwR7TU9Uv6PPPwv0jzRy5U8MmaUPBJLdrxYF+K7Rq8sOlRN+bucdrY8AGfSPNdvLbwUv0G81ndQu+/+nDtGqHi8vmzyvERKuLvpzz+8TM+yuytOsTo3nRS7z2YhvSCKkzvP4o+8kaNBvLWBFLwgihO8YCBuvBagpDxiCAW9qL5lPOjeljzOfZu8x9ryu0tim7wZag08y6uPOwHbnbt1zvo8g/7AvNHLFTuFYzU8qbZCvGisHL1T7zg8LMNrPPWT3TyJoti8PxtbvKOH5by1/QI9tAUmO5dODTzivhC8uTymu+d5ory5uJQ8ucA3PE1LoTxmPwW84r//O/vCOruHudK8GIEHvRj2Qby9/9o85gwLvJN98LsIcF68t1tDu859mzw73Lc5lHwBu9o5FrvAycM81gKWvL7vlDy8B/67MXZaPVVMCr3O+Qm7IINfvNfk57y6qb08sTMavIixr7zA2Jo7Zyl6POhb9LrFhFW8UB2tvM7y1Txb8CE8Y/L5OhvPgTn2izq8wT0PPaMSKzuU8Ts8QAThPNwbaLop8V87yjfEPBD8DDyTfXA7Jw+Ou852Z7x6Bfu7oLXZO5EuBzzBNts79ZoRva5i/bsAZ1K8HLn2uqC8jTyteAg5Rr4DvA8MUzsJ3XU7RcYmPE1EbTqX0h69b7Uou1XQm7zZSVy8ZrzivP99TLzoW3Q8EmGBuwrchjsAdqm8CPujuqBAHzyd6/C83RNFPD+fbDufSMI8TccPPFXBxLzJP2c8vnMmvA0jzTyIsa+8uM8OumzjnLuPyRK8rmJ9uycXsTzzPUC81BLcu4z3BrxNRG284r4QvMnKrDteu/m5i4M7vCxGDrv44Vc8YggFPQh3kjyJHsc7U+cVvb17yTu9Bg+7n8xTPGGF4rqN6K+85BzROgYLarzqwGg7p808vIRyDLydbpM8YCDuvBUzjTyDiQY8TcePO13RhDpKcuE8LD/aPHAiQLxWsu06mLTwvAYSnrxs6788ybtVvAB2qbugvXy8ewQMO0H8vbzliei8JS4rPGXLubsbTF+8YggFPYzw0jsOlxi9DpcYvIZbErwI84C8mLsku9bzvrx7BIy7htcAPQBuBrut9WU7aY5uPEa3z7y9/1q7ux2JPEao+Lu317E7AdRpPhiBh7zXYNY8rXgIPVL+D7yTCLY8ElIqPfyrQLtQFvk367CiO+fuXDyteIg8f7+dvKR/QjwxfQ48Da4SvDmGGr0K1dK8r1pavGkRkTqrExQ8BgtqubZj5rtYoie8uFMgPYGggDxdVZa83oeQuz6uw7ocwKq6mbOBvOFS6Dv+jCO88y7pPCTJtrzA0ea70zAKPc0J0LwQeeo7iKr7PIc9ZDxIids6VNg+vK/WSLpwIkA7uTymOwBvdbotu8i8/aMdvDJf4DxQDta86OY5u8Kj8jvhWRw9JS4rvNQZkLp6iB08BaUGvOlaBbxOuLg6lHXNOdwbaDwduAe92FH/PKuQcbtsZ648C0kevRlqDbr0sQu7ig/wvOwlXbs2rVo7y6RbvDAJwzpIDW284VJouxCAHruHRBi8sMaCPB8OpTz5XUa85ZAcO5sRQrzX6xu8OfvUvCLgMLx2zYs8u6Gau9V/czy9e0k7Y3UcPJdHWbxCeKy8DDIkPGzjnDyO4Iw8HakwutFHBD1jdRy6tmoavJsJn7zmBdc8Tri4O7ZqGjt3M++7qEEIu0tiG7wybjc7DDrHPIGhb7wduAe7TUuhvIe5Ujw8xb27khDZvPf4UTw1Mey6cDEXu5i7pDt1WcC8IfeqOxFppLwPBDC8gCy1PCB7vDkkwZO8hedGOwS8gDsohEi8DafevAWlhrsyX2C7OAqsPNhRfzsqXve7zQEtPAtCarv3/wW8gaCAvGAgbjzsHbo5VyY5vDTE1LwvGJq5YBjLPJEuB73n9RA8tA3Ju7k8prxrdgW9PUGsvM/ijzvLqw89S2q+vIXY7ztc4cq8JxexvP8IEr2TjMc89ZoRvJ7qAbyuYv27hdjvO6C9fDx1WUC9G0zfuzPTK76hMcg7cDGXOjkCCbwWkU285Jg/POfuXDzlieg7yqx+vExTxDwUv8E8egyvvJyFDbytcVQ8NqU3vFa5Ibu8kkM8tYEUPHztkTy5NXK7Sv0mPejmObxWPbM6lHVNu1gXYjwj0Vm8LqROPJ9Q5TzMlBU8Q+XDvHGWC7w5Aok79hYAvB4WSDtdVRY8t9exvBaRzbvPZqG7PElPuz+XSTzy0Kg8MIUxPDa0jrteu/m7Omjsu37HwDzlieg7iS2eul1OYrttWNe8TUTtPKIazrq31zE8JTZOuAnd9TzA0eY7tP7xvEgUoTvatvO7n0jCODJuNzlNx4+7/R8MPYRyjLzhWZw82Uncu4x05Dut7UI8sTs9vC+Vdzv1k108GefqvF4+HDyWZQe9FhwTPHXOejx0aJc7pAoIvF8vxTtGr6w7qp9IuT8ijzzA0Wa8kKvkO5CyGLv1mpG7MX2Ou0avrDykCog8T6E+vH7HQDzP4/68lekYvKIpJbywx/E8jHRkPCn4Ez1JgTg8YCeiPJCr5LwxfQ48Trg4vCAGAr2UfAE8cDGXPI9NpDuVbao8BLwAPMMmFTylaEg8OvMxvHGX+rqWVjA8KXSCPDchpjxl2pA7BDG7vAYLartGr6y7KXQCOw8EMD2SFw27lW0qvAHU6TzIXZW7ZFfuu2GF4r0cuXa7yqz+O852Zz3W8z48PyIPPSUnd7xNRG08BaWGPGN1HD3ukQW8Y+rWvHv9VzxRgqE8PM1gvLbuKzy+awO8AlDYvOFKxbzhWZw8bsVuPPaLurx4p7o87ZJ0vEYzPry317G8nevwvIfABjx13dE78tCouSAGAj3RQNC8NqW3umRmRbyLg7s7HqGNPKi+5bvVhqe8gaCAPLjPDr37upe7gaFvu8yUFbtwrQW9aCHXvJmszTrcIpy7JT2COxnnajyPRnC8c/TLvJ3rcLwh74e8qiqOPBj2QbxNwFu7AG/1O8BN1TwvlAi7J4zrubySQ7u31zE6xYTVvL0GDzy0Dck8Vj0zPEYzPrsvlIg8zBinPLE7vTrv/hy8PUEsO/u6l7s+MtU68GMRvSgANzwfkra8jPDSOxw8GT3zua670U8nvM7yVbxYmgQ7LqsCvNhRfzwYgQc8VdAbvIIGZLzsHbo89KrXu1tskLt8cSM9mLTwPDchprwz2068+7oXPMhdFbuMexi9UnPKPMKyybtntD+8YYyWvJZlh73sJV084rfcO9nFyrwbz4E8VdAbPCAGAjy3W8O85+5cO+2SdDzveou8BwPHPDeW4Lz/fUy873qLvEVCFTuQuju5lk98O6sTlDuJLR669hYAva9a2rtV0Js87pEFPCU9Ajzf5dA8fHGjvAWe0juLDgG9eKe6vN2I/zyn3BO8GIEHu638GT1UYwS8GefqvFgelrwxfY48L5V3Ol1OYrvm9v87cvzuvJ9Q5bunUU68Om+gPHIDo7yF2G+7ftaXPKC9/Dy+bPK84N0tPGxg+jvHZTi8bOu/vDzN4Lu317G8pXcfvIOJhrxEUts8uTwmvdK0mzy5wDc5FhXfPOYMizvqwOg8Da6Su/w2BrzGbVu5H5I2vMwR87zqx5y7+VWju0gN7TtD5cM88GORPOu4RbwjTUi7LqROPOQjBb24REm7ZjjRO+d5IrxmvOK7Om+gu3qIHT3v9+g0znZnOxS3njwY9kG8F4J2PEALFbwdLcI71Y7KvJ9Q5bxBh4M81Qq5u9fkZ7zivhC8x+GmPCnx3zwQeeq7Li8UOw6XGL2rExS88OcivJmzgbvMlJW8/ZTGvE3Hjzw81BQ9U+DhPPYHKT0LSZ68KAA3PPWT3buBoW+7flIGvRvITbwNKgG9+kZMPKDEsLxM3gk8j00kPVCZG7ySGPw7/33Mu3ZCRjwAb3W8EHnqOwnddTzA2Bq8rmkxvEJwCbw73De8cvxuus9mITxCadW8AleMPImiWDtPoT49AG91PCFzmbuteIg8dlEdvHsEjDy7mua69/hRO7KviLyoxRm9TyyEPE3A27xy/O48W+ltuHxqbzxVwcS8vJJDO5C6uzzyyIW8rIArPKMSq7qvUjc7+OHXPLX2zjwp8V+8NMuIO2Y40Tx7eca8htDMvIoP8Lztmai8MX0OPEH8Pb25PKa8ycqsPDPiAr0XgnY8ycosvGEQqDzFhNU65Jg/vCTBkzxPsBW9ucC3u7EzGjzTMIo5O1imvCD/zbtONCe9", + "message": { + "role": "assistant", + "content": None, + "tool_calls": [ + { + "id": "call_ymnsNurMgr3atFVr7BnJ2XYK", + "type": "function", + "function": {"name": "add_exclamation", "arguments": '{"message":"Hello"}'}, + } + ], + "refusal": None, + "annotations": [], + }, + "logprobs": None, + "finish_reason": "tool_calls", } ], - "model": "text-embedding-ada-002", - "usage": {"prompt_tokens": 8, "total_tokens": 8}, + "usage": { + "prompt_tokens": 70, + "completion_tokens": 15, + "total_tokens": 85, + "prompt_tokens_details": {"cached_tokens": 0, "audio_tokens": 0}, + "completion_tokens_details": { + "reasoning_tokens": 0, + "audio_tokens": 0, + "accepted_prediction_tokens": 0, + "rejected_prediction_tokens": 0, + }, + }, + "service_tier": "default", + "system_fingerprint": None, }, ], - "10590": [ + 'system: You are a text manipulation algorithm. | user: Use a tool to add an exclamation to the word "Hello" | assistant: None | tool: Hello!': [ { "content-type": "application/json", - "openai-model": "text-embedding-ada-002", - "openai-organization": "new-relic-nkmd8b", - "openai-processing-ms": "19", + "openai-organization": "user-rk8wq9voijy9sejrncvgi0iw", + "openai-processing-ms": "751", + "openai-project": "proj_0Wv6taeZjWf793P67JMswYY3", "openai-version": "2020-10-01", - "x-ratelimit-limit-requests": "3000", - "x-ratelimit-limit-tokens": "1000000", - "x-ratelimit-remaining-requests": "2999", - "x-ratelimit-remaining-tokens": "999998", - "x-ratelimit-reset-requests": "20ms", + "x-ratelimit-limit-requests": "10000", + "x-ratelimit-limit-tokens": "50000000", + "x-ratelimit-remaining-requests": "9999", + "x-ratelimit-remaining-tokens": "49999970", + "x-ratelimit-reset-requests": "6ms", "x-ratelimit-reset-tokens": "0s", - "x-request-id": "req_f6e05c43962fe31877c469d6e15861ee", + "x-request-id": "req_e9add199e2c543f1b0f1dc5318690171", }, 200, { - "object": "list", - "data": [ + "id": "chatcmpl-CukvtgYHPS8HRHqCQiQgQrs7a2Tx1", + "object": "chat.completion", + "created": 1767642813, + "model": "gpt-3.5-turbo-0125", + "choices": [ { - "object": "embedding", "index": 0, - "embedding": "kpYxPGKcETvy0vc77wK5vCbHl7z8bR+8/z3evOW4lbzlAJw7Q/2vvNETfTxppdg8Gew9vCi/wzwBp6e7bXZBPDPCCj03suI6vMe8PMRpDjt9QXM7xGmOPIjcGjzSPJS8R6YrvFbBtzvkR3g7WboNvGa1ALzKCja8FhvVPJfPubxOZ+y8odHWvGw2D732e/M7RPXbvPhUMLzqOSQ8ZYzpu1Og9DwFMIo8n5EkO9UsbLyUHmq7iNyaPAthvruiOfa8246LvNPsOTuHvAE81SzsPEBM4Ls3smK8ZJS9vAppkruMPZA8Ljh+PCd3PTsvYZW7iJSUu2ALW7xyr0m8ch89PH/Sqbvqgaq70YPwO/mctjvUNMC8VVkYPJP+UDsBz5Q8JjcLPJAFeztiVAs9OYsfvB0Frby6pnm7tW1xO0Rlzzylor88NXKwvK6sMLviT8w6HJ2NPPFCa7wftdK8NOIjPKKpabsY9JG75biVPGvuCLv/zeo6jPWJPKFBSrxzP1a8vA/Du5g32TzEsRQ8yMoDvauLbTvpYZE8bea0u1e5Y7wDn1O7KN/cup8BmDtzF+m78JJFPFV5sTuU1uO80xSnPNGDcDyk8hm9IUYJvKSCprxpzUU8DKnEvDuj5DuAgk+8LfjLO794jLumUuU8WiItu7FdAD1LLw48EAo6vCVWerxq7d67ddCMu60cJD15mHc81rx4PAUwijwDV028ZtRvPA96rbwcnY08saUGvatDZ7zxQuu7x8nZPPTzOrwYhJ65QiUdvdCr3TzJWhA9dsi4PEemK7v262a87Sl8u7dGrrwcVYc8vzCGPDVyMLwmx5e6YlSLvDvL0TwvGY+7vMc8PBIif7wKsZi7lmcaPNPMIDvKmsI7ORusPJ0A7jr2e/O69PO6vBarYbwWY1u8CrEYO0Y+DL2JtC0873IsvCAdcjz/PV47zNp0u8AIGbwlVvo7cxfpu1YJvjxHpqs84DcHPXAnkbyvFNA8eXmIPJwIQjwv0Yg8LRhlvJF2GDvcriQ9Kf91uz90zbs1cjC/gGK2vC2IWLuEe6W8RYXoPLunozyBEtw8bXZBPBxVh7wOyoe7nXDhOs/TSruoCwm86RmLvLsXFzxsfhW8Sp8BPI+d27xSONW8vedVOgw50bw5Qxk8DzInvHwhWrsRKlM8LLBFOw96rTydAG68E3MDuoZLZLyxXQA8Gey9OxBSwLy2JpW8T5CDPGKckTvUxMy7CCDiPIBiNjyuZCo9LRjlvI7FyLzcHhg9EXLZu1raprzUDFM8vS/cPD8sx7ukOiA8QNxsvMapQDxLv5q8t7YhPHegyzyri208UWBCvEvnB7skplS8h7wBPGSUPTtgw1S8tk6CvBIif7wddSC6j3VuvJF2mLv7BQC9EAq6PLgeQTxRQKm76akXPIoczTyN7TW8rmSqO4n8szwsaD88pMosPUlW0bzTXC281rz4uwI3tDuiOXa84A8avZoQFrwFMAo9EAo6PGml2Dtdgvg6UGgWPVtCxjxP2Ak9wmjkPMDgKzzY3bu8NpJJPEqfgTwYhB67qks7PCXvBLtcGtm84MeTvCu4mbyayA88SVbRO+nRBDyx7Yw8vH82u5h/3zzXvSI9Sk59vDwUgrxgU+E77lITvIIThjtsDiK6zUsSvVrapjy23o67pKqTPLgeQbwiPrU7L9GIPNET/brVnF+8KW/pO/KziLt07/s7nQDuOsdZZrrD2YG7rUQRPIcECDvZtc67lj+tvE1H0zyF40Q6GPSROyHWFby8x7w83n7jvN7G6byj0oA7z9PKO/SDR7xy98+7AIcOvGcdoLtLdxQ8UxDouyH+Aj3cPrE7gcpVPJswLzxHzpg69GOuPLO9y7y2log56dGEODkbrLz63Og7PVyIOxp8yjxQ+KK8vA/DO1HQtTncZp68LNiyvEEFhDzA4Ku7O6PkvKy0BDxyr8m8Q7UpO0NFNjxY2fy7T5ADPG8m57yM9Ym8P7xTvE1H07suqPG5KnATu0KVEL2oU487kS4SPThrBjt/GrA8EAq6PJCehbwvYRU7KiiNO8rCrzwt0N67RoaSPIPrGDwk7lo7iCQhO5tYHDxmtYA7PMP9PEq+8DwLiSs8+eS8PJSudrx1YJk8OCMAvYQLMjxOZ+y8ofnDPIz1ibrNSxI8QJRmvKTyGb0NEeS86xE3PC44fjxAlOY6IB1yO9mNYbyhGV28MaHHuzlDmbw/LMc87XoAu20uO7zmsEE7SO6xPIA6STykyqy6+wUAvR4lxjsLQaU7xCGIOiMWyDxHzpi5ssWfPMSxlDxw34q6BTAKPUyXrTyz5bi8D6KaPIe8gTxUyYu8pDqgPO5Sk7wuOP48mDdZvGALWzvoYGc8LYhYvNcFqTzcPjG93K6kPPNDlTwYhB678rOIPIr03zycmM48cN8KPVD4Ijzvcqw8lh+UPBg8mDuSJr4777oyu147HDsV+zu97pqZvH/SKbtb0tI701ytu5VHgTuS3je8eXkIPL94DDt7AcG6rvQ2vKrbxzrxQus7CmkSvLgewbx64ac8CmmSPO7CBrxFhei7TW/AvAHPFLxRYEK8qMMCPFzy6zvWnYk75ZAoPI3ttbtPkAO9BAfzuywgOTs0Uhc8mjiDvDIJZ7uPdW68NSqqvPVbWrwsaL+8XWMJPALvrbtWwTc8qmtUvCVW+rwYrIu85QAcvFgqgbzuUpO8lUcBPIOjkjyFK0s7K0gmvKgLCb3sCeM83RZEPHu5urwwga68cbedvAyBVzpcGlk9TmdsPIr0X7wcnQ09fxqwO5XXDbpe85W6TtffvAuJqzwmNws69IPHO5rID7yODc88XPJrPKTKLDxe8xU8PDNxO7A0abzShJo7QpWQvN/vgLsV00684DeHPLTd5Dsq4AY8gRLcuZxQSLyNpS89UGgWuYJ6+7wqKA08YlQLPSuQLLzlAJw8h0wOvIGi6Dyu9LY88rOIO4gkITyaOAO9If6CPIQLsjw2ksm7PBSCvHxpYLz55Dy7FUPCvH5qijwdLRq8BlAjvOuhQzsC7y08hHslvJb3JryaOAO7ygq2PBisCzyEe6U6lq+gvDlDmbwF6IO8ARebu5g3WTz9tSW8kk4rvMza9LxY2fy8xGmOOrZum7x3WMU7bFaouxY77rz55Ly8H7VSvLtfnTwZ7D279aPgPE/3+DzeNl28U8jhPKkrorzzGyi873IsuOtZvbyrs1q8JDbhPGKckTtl/Fy8npB6Ox0FLbtMJ7o7RK1VPNm1zjxsNo+75mg7uoNbDDxJLuQ8oqlpPN6m0DzUDFO8ZYxpO2+287xXKVc7oqlpu/SrtDtKn4G7dO/7OgCHDj2AYjY7kAV7vC1A0jrp0YS7qiNOPBBSwDtjBLE8Big2PINbjDycwDs8To/ZPBarYbzJMqO7OCOAvAnZhTyxXYA8kk6rvKibFTwYrIs8gDrJvCZXJLyJ/LM8lY+HuwyBVzzShBq8W4rMvEQdybylWrm8C9ExvA0RZLxA3Oy7t0auO5P+0Lu7z5A8dvAlPGZk/LxoPTk70+w5vTQKkbzb1hG896SKunxp4DzQY9e6lj+tPHBvF7zS9A28sg0muTZq3LwnLze8DKlEPGbU7zwirqg83B4YPaSqE7lu3uA8au1ePLZOArzx+mQ7RRV1OrE1kzuSJr68Pgyuu1D4ojyboKI6OjvFPGEr9DtUyQs8fdF/PDrzPjr37BC8Ht2/O7E1E7yFK8s8Tf9Mu0P9rzvAUJ886amXvEku5DsHAEm75CgJOpTWY7ykqhO8xdGtPNKsh7rm2K48QNzsu/qUYjzbRgW9D+qgvKTKrLzswdw8q4ttOwtBpbspb+k8qXOovPtNhjxn1Zm71SxsO9KsB716mSG8jPWJO92Gt7zuwga8E7sJvLjWurvLKk+8NAoRuxisizufcQu8mH/fO+Vwj7wDV028bZ6uPE5n7Lv1o+A8zrOxPKTymTyk8pk8dO/7OkKVkLyomxU8mhAWPJWPhzpcGlk8hMMrPM5rKzxLd5S7AF53vOMn37lr7oi8lK72vKficTzvKia7WEnwumJUizkW82c8Y+QXvagLiTw/5MC7ZtTvupeHs7zeNl28dzBYu4CqvDzAmKU6uGZHPMCYJTyVRwE8+SzDuuf4x7uk8hm9fUHzun3RfzvDiP08ZtTvvBvkaTziB0Y8n0kePM27hbxG9oU7WXKHuuzB3DyboKK8X6M7OQ6CAbtIDsu7iNwaPAohjLvhnya7AaenvGnNxbykOiC8GjREPK3UnTuYx+W8cte2O0wHobrEIQi8Sp8BOvMbKLzYTS88i8xyvOHnrLxrDXi77FHpO4QLMjra1Wc8pDoguu2Zb7yIJKE8ZtTvu1QREj1sfpW7BpgpuN7u1rydAO47+7T7O3CXhLwYzKQ8Z42TvEFsebyqSzs5I15OuscRYLtIxsS7lY+Hu6hTj7s1Kqo8/UUyvANXzbzf74C82mV0PGldUrx3MNi6TN8zu7X9/bsLiSu6tAXSOwQHczs68747LfjLvF7LqLyWZxq8NAoROlI41bwxEbu8XYL4vDQKkTolVno7k27EPFoirTvzQxW6Z40TPL5PdbyC6m67DzKnPPZ787yt/Aq9tAVSvERlT7wzwgo73578O9FkgTsaNMQ8MlHtOww50bwUszW8VIGFOhfL+rw+xCe8q4ttvAaYKT1sfpU8jjW8O+kZC7tmtYA8M3qEuybHlzyMhZa8n5Gku+APGrzc9iq7Ac8UO71XSbx+aoq8xCEIvNpl9Dw5i5+7qbuuPFrapjyfSR68ch89vA96rbyIlBQ8i1z/PEcWH7x8aWA8rqywvNadibzOkxg8H/1YO5WPh7x2gLK70RP9u+dATrxGPow8eHhevPUTVLyHvAG82JW1vK+EwzwvYRU8hMOrOxWLyDtsNg88IdaVurqHijg50yW7gKo8va2Ml7ydKNs8D1qUvP39q7tk3EO7m1gcPCFGiTv55Ly7ORssvPekirs7E1i8KwCgO/gMqrrV5OW8t440OyZXpDwhjo+8BwDJvO6aGbz/zeq7rUSRvLaWiLuU1mM7eXmIuWumAr3BcDi8HFWHu6wb+rsd5ZO7VlFEPkg2uLwpJ2M6o9IAPX4ihDpwJ5E73578PC6o8btFhWi7AIeOOlVZmDm2lgi8EMIzvGfVmTtGPoy7j1VVvJ4phbyHTA694Z8mvLO9S7qr+2A8QiUdPHVgmbzZ/VS8qmtUOtWc3zvQq928zbsFOqlzqDyAqry8FJMcvF/rQbvqgao84A8auzN6hLyUjt07lUeBuyrghjxbisw8jc2cPGWMaTzoYGc7LGi/PFgqgbx2yDg7BeiDPM/TSrwwOSi8mjgDvA9alDxf68G8kJ4FvBAKOrsJsO482tVnuiGODzvRE/08nXDhumg9ubsBzxQ9RvaFvERlTzxQsJy7jK2DusEAxbyomxW7DsoHvfAi0rv4xKO7ssWfutAbUbz7TQY7vZ9PvHCXhDwf/di8mKfMvCHWlTtTEGg8vk/1Oyu4GTtjvCq8dWCZu9KEGjzlcI+8cJeEvEku5Lwkfmc8cz/WPClvaTtHzhg8/dU+vL2fT7zvciy7E7uJvLe2ITtnjRM8tN1kvJ1w4TwCNzS83B4YO65kKr03+mg8p+LxPOdATjxN/8w8D1oUPJavILxGhhK8uxeXu+WQKLwe3b85pepFvEjusbincn47rLSEPOK/PzxJ5l08KwCgO9PsuTwHcDw8ImaivGxWqLxphb87t460PHRAALyAgk+8EgLmvAnZBbtsxhs6mzAvvVzyazxPkAO86WGROxSTnDuvXFa7jc0cO50oW7tGPoy8rYwXvK3UHTyow4I71rz4uyJmIjyDoxK8T5ADPHrhp7wMOVE8m3i1O7YmFTxTyOG8M+H5vI2lr7tUEZK8D3qtvDHpzTvFGbS8/mVLvR9tzLxJLmQ8D+qgPKdyfrzY3Tu8IR4cPSefqrwFMAq7BcCWvNjdO77KCra7sDTpOQzxSryqI0677poZPN7GaTxakqA5MPGhvODHE7teqw88A1dNu47FyLxo9bK6wJilPPyVDLwyUe05vedVvAUwijzYlbU8x8lZPdyupLytjJc81VTZugD3gbpUyYu7aaVYPJjH5Ts8M3E87gqNvH6yELxdgni7FLM1PIhsJ7svGY+8DcndOXOHXLzkKAm8To/ZvEku5Dt90X+8r6TcPJo4gzvdFsQ7D+ogvNiVNTvlcA88jsVIvFI41TwM8cq8+pRiPEKVkDsIkNU8BJf/u+Mn3zz/heS7b7bzvOxRaTv+9de6WElwOuRH+LtsVii9i1z/O//NajzXLRa74gfGvOsxULtTyGE8EgLmvJQeajxdgng8Kf/1u+kZCz1/0im8nJjOOyqYAD0yUe27lvemO3IfvborSCa8OLOMuy8ZDz11GBO7+00GvZF2GDwiPjW8g1uMuxMDEDzk4II8w9kBvcjKAzzKeqm8IY4PPEemq7xsVig9nXDhPPMbKDp5wQ69YpwRPaI59ru1bfG7JVb6OoZLZLzD+PA74Xe5PJrIj7yyDaY7f9KpOtGD8DxVMas5m+iovBO7ibzluJU7APcBPCgHyjwBzxS7H7VSOfjEI7xTyGG7HFUHOph/Xz0Tu4k7yVoQvHRfbzwruBk8D3qtvN5+473ShBq9zbuFuyH+Aj0bVF28w4j9PEJto7z1E9S7ZtRvuwZQIz2FK8u8GPSRvNflj7yboCI8neDUvPTzurpasjk8s71LOtI8lLyfcQs9uNY6PIpkU7z9/Ss7r6RcPPdchDs8M/E7GKwLvX/SKT0BX6E8OCOAPOIHRjxIxsS7zbuFPNd1HL29V8m7aRXMu4ITBr2lWjk7qpNBPAdwvLxTyOE7k25EPJcXwLu/eIy8M+H5OzlDGby2bpu5B0jPPJjvUroL0bG86dGEvHWIhjm7F5e6RK3Vuzey4jz6lOK7rRwkPCywxTxb+r86wUjLO9KEmrx7Scc7/G2fu2Zk/DxmtYA76skwPKuLbbwKaZK7Q7WpPMP48LuJRDo8AsdAPFXpJL3vujI9BXgQvUnmXTyJRDq9wFCfOlfh0DweJca8ssUfvH6yELtLLw481lUDOqHR1jzsUek6MIEuvMVBobswOSg80KtdO+bYrroqmAA6/N0SPe4KDbzyswi7sV0AvHOHXLxvtnO8UPgiu4PrmDuUrva7TW9AvIcEiL3x+mQ84A+auXFHKrzdzj07m1icvNtGhbcOyge9vVdJO8OIfTsLGbi84A8aunCXhLyurDC78tL3vGumAr2kOiA8LCC5PEqfATzlkCg8yVqQPEq+cDvvcqw8qmvUO1e54zpdYwk8z0O+O8+LRDwEB/O60vSNu2bUbzwF6AM7XWOJPA3J3TyWP627oUFKvHyRzbtLLw48fGlgvCL2Lj1eqw+75CgJvYTDq7utjJc7G3R2PD7EJzx+shC7XYL4O2j1sjpb0tK74ydfPIr03zuncn68vMe8N1m6jbx5wQ69dxA/Oxo0RDx6URs8PsSnvJ4phTxQsJw8KE9QO7HtDL2XX8a7CbDuO2ALW7wqmIA708wgOpIGJb3xst68H41lvEsvDjsR4sw75tiuPNTETLwNyd27VemkO2bUb7yNzZw8ZCTKPKprVDzZbUi84A8aPYZL5Dw+VLS6Q0W2vI2lL7y6h4o7KW9pOnegSzzXLRa6G3R2vA+iGjzuwoY8gaJoPJTWYzhtLju8rLQEPLZOAj3Z/VS7B3A8vA4SDr2LXP+7Hk2zug8ypzxOZ+y67poZvcY5zTujYg09sg2mPInURjrJ6pw62Y1hPFjZ/LsVQ8I8j1VVvLe2obzi31i8ivTfPKTKrLsfjeU8PlQ0PJQeajvP+zc9keYLvPu0+zuXF0C8lUcBPcWJJzxP2Ak7bMYbvPBKPztl/Nw8I87Bu8P4cLwMqcS4CJBVPAFfIby7pyM9fvqWO4m0LbxrDfg60WQBvODHkzvrWb06DVlqPJJOq7wU26K88muCPEpOfbyWZ5q8je01vPekCrxVoZ474H+NvL1XyTwyCee6jRUjvHrhJzs+fKE850DOPKAhsTssILm8hAuyvC+pmzxn/Qa87poZvEsvDrzEIYg8PewUPAUwiryd4NS8H21MPFOg9Lyri+27ztuevCCt/jV07/s8ZrWAvOJPzDzM2vS8cUcqvF1jCbw3inW7pKoTvf21pbzvciy9", + "message": { + "role": "assistant", + "content": 'The word "Hello" with an exclamation mark added is "Hello!"', + "refusal": None, + "annotations": [], + }, + "logprobs": None, + "finish_reason": "stop", } ], - "model": "text-embedding-ada-002", - "usage": {"prompt_tokens": 1, "total_tokens": 1}, + "usage": { + "prompt_tokens": 96, + "completion_tokens": 16, + "total_tokens": 112, + "prompt_tokens_details": {"cached_tokens": 0, "audio_tokens": 0}, + "completion_tokens_details": { + "reasoning_tokens": 0, + "audio_tokens": 0, + "accepted_prediction_tokens": 0, + "rejected_prediction_tokens": 0, + }, + }, + "service_tier": "default", + "system_fingerprint": None, }, ], - "You are a generator of quiz questions for a seminar. Use the following pieces of retrieved context to generate 5 multiple choice questions (A,B,C,D) on the subject matter. Use a three sentence maximum and keep the answer concise. Render the output as HTML\n\nWhat is 2 + 4?": [ + 'system: You are a text manipulation algorithm. | user: Use a tool to add an exclamation to the word "exc"': [ { "content-type": "application/json", - "openai-organization": "new-relic-nkmd8b", - "openai-processing-ms": "4977", + "openai-organization": "user-rk8wq9voijy9sejrncvgi0iw", + "openai-processing-ms": "767", + "openai-project": "proj_0Wv6taeZjWf793P67JMswYY3", "openai-version": "2020-10-01", "x-ratelimit-limit-requests": "10000", - "x-ratelimit-limit-tokens": "200000", + "x-ratelimit-limit-tokens": "50000000", "x-ratelimit-remaining-requests": "9999", - "x-ratelimit-remaining-tokens": "199912", - "x-ratelimit-reset-requests": "8.64s", - "x-ratelimit-reset-tokens": "26ms", - "x-request-id": "req_942efbd5ead41ff093d2f8bfb7833fcb", + "x-ratelimit-remaining-tokens": "49999975", + "x-ratelimit-reset-requests": "6ms", + "x-ratelimit-reset-tokens": "0s", + "x-request-id": "req_27d106351bab9878a3969f23108cd4c6", }, 200, { - "id": "chatcmpl-A0tPUPHiRvco7ONEyOMrW88Qk95vl", + "id": "chatcmpl-CxGq2dnBYh5JR5o4OANlkHgBhuxfK", "object": "chat.completion", - "created": 1724776360, + "created": 1768242114, "model": "gpt-3.5-turbo-0125", "choices": [ { "index": 0, "message": { "role": "assistant", - "content": "```html\n\n\n\n Math Quiz\n\n\n

Math Quiz Questions

\n
    \n
  1. What is the result of 5 + 3?
    2. \n
      \n
    • A) 7
      • \n
    • B) 8
      • \n
    • C) 9
      • \n
    • D) 10
      • \n
    \n
  2. What is the product of 6 x 7?
    3. \n
      \n
    • A) 36
      • \n
    • B) 42
      • \n
    • C) 48
      • \n
    • D) 56
      • \n
    \n
  3. What is the square root of 64?
    4. \n
      \n
    • A) 6
      • \n
    • B) 7
      • \n
    • C) 8
      • \n
    • D) 9
      • \n
    \n
  4. What is the result of 12 / 4?
    5. \n
      \n
    • A) 2
      • \n
    • B) 3
      • \n
    • C) 4
      • \n
    • D) 5
      • \n
    \n
  5. What is the sum of 15 + 9?
    6. \n
      \n
    • A) 22
      • \n
    • B) 23
      • \n
    • C) 24
      • \n
    • D) 25
      • \n
    \n
\n\n\n```", + "content": None, + "tool_calls": [ + { + "id": "call_blmqxOaZvxUtgB0JVLXYnEu1", + "type": "function", + "function": {"name": "add_exclamation", "arguments": '{"message":"exc"}'}, + } + ], + "refusal": None, + "annotations": [], + }, + "logprobs": None, + "finish_reason": "tool_calls", + } + ], + "usage": { + "prompt_tokens": 70, + "completion_tokens": 15, + "total_tokens": 85, + "prompt_tokens_details": {"cached_tokens": 0, "audio_tokens": 0}, + "completion_tokens_details": { + "reasoning_tokens": 0, + "audio_tokens": 0, + "accepted_prediction_tokens": 0, + "rejected_prediction_tokens": 0, + }, + }, + "service_tier": "default", + "system_fingerprint": None, + }, + ], + "system: You are a helpful assistant who generates a random first name. A user will pass in a first letter, and you should generate a name that starts with that first letter. | user: M": [ + { + "content-type": "application/json", + "openai-organization": "user-rk8wq9voijy9sejrncvgi0iw", + "openai-processing-ms": "236", + "openai-project": "proj_0Wv6taeZjWf793P67JMswYY3", + "openai-version": "2020-10-01", + "x-ratelimit-limit-requests": "10000", + "x-ratelimit-limit-tokens": "50000000", + "x-ratelimit-remaining-requests": "9999", + "x-ratelimit-remaining-tokens": "49999955", + "x-ratelimit-reset-requests": "6ms", + "x-ratelimit-reset-tokens": "0s", + "x-request-id": "req_58e5f91c0c3d4c2c9b6ee9ad8c4e8961", + }, + 200, + { + "id": "chatcmpl-CxGtBIjrsLMSkCUPSLOlAiHFxLz7A", + "object": "chat.completion", + "created": 1768242309, + "model": "gpt-3.5-turbo-0125", + "choices": [ + { + "index": 0, + "message": {"role": "assistant", "content": "Milo", "refusal": None, "annotations": []}, + "logprobs": None, + "finish_reason": "stop", + } + ], + "usage": { + "prompt_tokens": 46, + "completion_tokens": 2, + "total_tokens": 48, + "prompt_tokens_details": {"cached_tokens": 0, "audio_tokens": 0}, + "completion_tokens_details": { + "reasoning_tokens": 0, + "audio_tokens": 0, + "accepted_prediction_tokens": 0, + "rejected_prediction_tokens": 0, + }, + }, + "service_tier": "default", + "system_fingerprint": None, + }, + ], + "system: You are a helpful assistant who generates comma separated lists.\n A user will pass in a category, and you should generate 5 objects in that category in a comma separated list.\n ONLY return a comma separated list, and nothing more. | user: colors": [ + { + "content-type": "application/json", + "openai-organization": "user-rk8wq9voijy9sejrncvgi0iw", + "openai-processing-ms": "289", + "openai-project": "proj_0Wv6taeZjWf793P67JMswYY3", + "openai-version": "2020-10-01", + "x-ratelimit-limit-requests": "10000", + "x-ratelimit-limit-tokens": "50000000", + "x-ratelimit-remaining-requests": "9999", + "x-ratelimit-remaining-tokens": "49999935", + "x-ratelimit-reset-requests": "6ms", + "x-ratelimit-reset-tokens": "0s", + "x-request-id": "req_fbc7bb2ab3e149c1845699cfea9403d4", + }, + 200, + { + "id": "chatcmpl-CxGyV8CzGN80ByzFb4wN1hwGktOKD", + "object": "chat.completion", + "created": 1768242639, + "model": "gpt-3.5-turbo-0125", + "choices": [ + { + "index": 0, + "message": { + "role": "assistant", + "content": "red, blue, green, yellow, orange", "refusal": None, + "annotations": [], }, "logprobs": None, "finish_reason": "stop", } ], - "usage": {"prompt_tokens": 73, "completion_tokens": 375, "total_tokens": 448}, + "usage": { + "prompt_tokens": 60, + "completion_tokens": 9, + "total_tokens": 69, + "prompt_tokens_details": {"cached_tokens": 0, "audio_tokens": 0}, + "completion_tokens_details": { + "reasoning_tokens": 0, + "audio_tokens": 0, + "accepted_prediction_tokens": 0, + "rejected_prediction_tokens": 0, + }, + }, + "service_tier": "default", "system_fingerprint": None, }, ], - "You are a world class algorithm for extracting information in structured formats.": [ + "system: You are a world class algorithm for extracting information in structured formats. | user: Use the given format to extract information from the following input: Sally is 13 | user: Tip: Make sure to answer in the correct format": [ { "content-type": "application/json", - "openai-model": "gpt-3.5-turbo-1106", - "openai-organization": "foobar-jtbczk", - "openai-processing-ms": "749", + "openai-organization": "user-rk8wq9voijy9sejrncvgi0iw", + "openai-processing-ms": "201", + "openai-project": "proj_0Wv6taeZjWf793P67JMswYY3", "openai-version": "2020-10-01", - "x-ratelimit-limit-requests": "200", - "x-ratelimit-limit-tokens": "40000", - "x-ratelimit-limit-tokens_usage_based": "40000", - "x-ratelimit-remaining-requests": "197", - "x-ratelimit-remaining-tokens": "39929", - "x-ratelimit-remaining-tokens_usage_based": "39929", - "x-ratelimit-reset-requests": "16m17.764s", - "x-ratelimit-reset-tokens": "106ms", - "x-ratelimit-reset-tokens_usage_based": "106ms", - "x-request-id": "f47e6e80fb796a56c05ad89c5d98609c", + "x-ratelimit-limit-requests": "10000", + "x-ratelimit-limit-tokens": "50000000", + "x-ratelimit-remaining-requests": "9999", + "x-ratelimit-remaining-tokens": "49999944", + "x-ratelimit-reset-requests": "6ms", + "x-ratelimit-reset-tokens": "0s", + "x-request-id": "req_40a68eb08b684844b1e1f2253c85f00c", }, 200, { - "id": "chatcmpl-8ckHXhZGwmPuqIIaKLbacUEq4SPq1", + "id": "chatcmpl-CxGyZUlLnBXQkOnJyJNSlshVXdOwQ", "object": "chat.completion", - "created": 1704245063, - "model": "gpt-3.5-turbo-1106", + "created": 1768242643, + "model": "gpt-3.5-turbo-0125", "choices": [ { "index": 0, @@ -324,16 +411,30 @@ "role": "assistant", "content": None, "function_call": {"name": "output_formatter", "arguments": '{"name":"Sally","age":13}'}, + "refusal": None, + "annotations": [], }, "logprobs": None, "finish_reason": "stop", } ], - "usage": {"prompt_tokens": 159, "completion_tokens": 10, "total_tokens": 169}, - "system_fingerprint": "fp_772e8125bb", + "usage": { + "prompt_tokens": 159, + "completion_tokens": 10, + "total_tokens": 169, + "prompt_tokens_details": {"cached_tokens": 0, "audio_tokens": 0}, + "completion_tokens_details": { + "reasoning_tokens": 0, + "audio_tokens": 0, + "accepted_prediction_tokens": 0, + "rejected_prediction_tokens": 0, + }, + }, + "service_tier": "default", + "system_fingerprint": None, }, ], - "You are a world class algorithm for extracting information in structured formats with openai failures.": [ + "system: You are a world class algorithm for extracting information in structured formats with openai failures. | user: Use the given format to extract information from the following input: Sally is 13 | user: Tip: Make sure to answer in the correct format": [ {"content-type": "application/json; charset=utf-8", "x-request-id": "e58911d54d574647d36237e4e53c0f1a"}, 401, { @@ -345,91 +446,132 @@ } }, ], - "You are a helpful assistant who generates comma separated lists.\n A user will pass in a category, and you should generate 5 objects in that category in a comma separated list.\n ONLY return a comma separated list, and nothing more.": [ + "system: You are a generator of quiz questions for a seminar. Use the following pieces of retrieved context to generate 5 multiple choice questions (A,B,C,D) on the subject matter. Use a three sentence maximum and keep the answer concise. Render the output as HTML\n\nWhat is 2 + 4? | user: math": [ { - "Content-Type": "application/json", - "openai-model": "gpt-3.5-turbo-0613", - "openai-organization": "foobar-jtbczk", - "openai-processing-ms": "488", + "content-type": "application/json", + "openai-organization": "user-rk8wq9voijy9sejrncvgi0iw", + "openai-processing-ms": "2029", + "openai-project": "proj_0Wv6taeZjWf793P67JMswYY3", "openai-version": "2020-10-01", - "x-ratelimit-limit-requests": "200", - "x-ratelimit-limit-tokens": "40000", - "x-ratelimit-limit-tokens_usage_based": "40000", - "x-ratelimit-remaining-requests": "199", - "x-ratelimit-remaining-tokens": "39921", - "x-ratelimit-remaining-tokens_usage_based": "39921", - "x-ratelimit-reset-requests": "7m12s", - "x-ratelimit-reset-tokens": "118ms", - "x-ratelimit-reset-tokens_usage_based": "118ms", - "x-request-id": "f3de99e17ccc360430cffa243b74dcbd", + "x-ratelimit-limit-requests": "10000", + "x-ratelimit-limit-tokens": "50000000", + "x-ratelimit-remaining-requests": "9999", + "x-ratelimit-remaining-tokens": "49999927", + "x-ratelimit-reset-requests": "6ms", + "x-ratelimit-reset-tokens": "0s", + "x-request-id": "req_008a31c6023e42c9ae640eae2ae3b5ad", }, 200, { - "id": "chatcmpl-8XEjOPNHth7yS2jt1You3fEwB6w9i", + "id": "chatcmpl-CxfJTw2pCnRMvza9LZyE8qitryqFC", "object": "chat.completion", - "created": 1702932142, - "model": "gpt-3.5-turbo-0613", + "created": 1768336195, + "model": "gpt-3.5-turbo-0125", "choices": [ { "index": 0, - "message": {"role": "assistant", "content": "red, blue, green, yellow, orange"}, + "message": { + "role": "assistant", + "content": "```html\n\n\n\n Math Quiz\n\n\n

Math Quiz Questions

\n
    \n
  1. What is the result of 5 + 3?
    2. \n
      \n
    • A) 7
      • \n
    • B) 8
      • \n
    • C) 9
      • \n
    • D) 10
      • \n
    \n
  2. What is the product of 6 x 7?
    3. \n
      \n
    • A) 36
      • \n
    • B) 42
      • \n
    • C) 48
      • \n
    • D) 56
      • \n
    \n
  3. What is the square root of 64?
    4. \n
      \n
    • A) 6
      • \n
    • B) 7
      • \n
    • C) 8
      • \n
    • D) 9
      • \n
    \n
  4. What is the result of 12 / 4?
    5. \n
      \n
    • A) 2
      • \n
    • B) 3
      • \n
    • C) 4
      • \n
    • D) 5
      • \n
    \n
  5. What is the sum of 15 + 9?
    6. \n
      \n
    • A) 22
      • \n
    • B) 23
      • \n
    • C) 24
      • \n
    • D) 25
      • \n
    \n
\n\n\n```", + "refusal": None, + "annotations": [], + }, "logprobs": None, "finish_reason": "stop", } ], - "usage": {"prompt_tokens": 60, "completion_tokens": 9, "total_tokens": 69}, + "usage": { + "prompt_tokens": 73, + "completion_tokens": 337, + "total_tokens": 410, + "prompt_tokens_details": {"cached_tokens": 0, "audio_tokens": 0}, + "completion_tokens_details": { + "reasoning_tokens": 0, + "audio_tokens": 0, + "accepted_prediction_tokens": 0, + "rejected_prediction_tokens": 0, + }, + }, + "service_tier": "default", "system_fingerprint": None, }, ], - "You are a helpful assistant who generates a random first name. A user will pass in a first letter, and you should generate a name that starts with that first letter.": [ + # Embedding Responses + "3923": [ { - "Content-Type": "application/json", - "openai-model": "gpt-3.5-turbo-0613", - "openai-organization": "foobar-jtbczk", - "openai-processing-ms": "488", + "content-type": "application/json", + "openai-model": "text-embedding-ada-002-v2", + "openai-organization": "user-rk8wq9voijy9sejrncvgi0iw", + "openai-processing-ms": "42", + "openai-project": "proj_0Wv6taeZjWf793P67JMswYY3", "openai-version": "2020-10-01", - "x-ratelimit-limit-requests": "200", - "x-ratelimit-limit-tokens": "40000", - "x-ratelimit-limit-tokens_usage_based": "40000", - "x-ratelimit-remaining-requests": "199", - "x-ratelimit-remaining-tokens": "39921", - "x-ratelimit-remaining-tokens_usage_based": "39921", - "x-ratelimit-reset-requests": "7m12s", - "x-ratelimit-reset-tokens": "118ms", - "x-ratelimit-reset-tokens_usage_based": "118ms", - "x-request-id": "f3de99e17ccc360430cffa243b74dcbd", + "x-ratelimit-limit-requests": "10000", + "x-ratelimit-limit-tokens": "10000000", + "x-ratelimit-remaining-requests": "9999", + "x-ratelimit-remaining-tokens": "9999992", + "x-ratelimit-reset-requests": "6ms", + "x-ratelimit-reset-tokens": "0s", + "x-request-id": "req_72a807dee044452d85ae14ec24d2497a", }, 200, { - "id": "chatcmpl-8XEjOPNHth7yS2jt1You3fEwB6w9i", - "object": "chat.completion", - "created": 1702932142, - "model": "gpt-3.5-turbo-0613", - "choices": [ + "object": "list", + "data": [ { + "object": "embedding", "index": 0, - "message": {"role": "assistant", "content": "Milo"}, - "logprobs": None, - "finish_reason": "stop", + "embedding": "anlkOuOnhjtKxJM82Y7ovNMWFL3YOQa8D1GkvDBzibu8e+e8Mk44vB2u4bvdncw7U70KvaaGrru3FyE8vIeAO9BUnTzovt+6qGHdPGsTv7s9b8u8cLBkPH6fh7pbSe27zVlHu2IayLiKAW87Z7dtvL5irzxP5wW9vC76PBu/pLxvnNa8onfKOkSNE7z4iDE8ZWILvE/nhTt9Upo8cLDku8FxEzykXhK7KaKuO+aWw7vpC828Y7QiPLb3+Twp75u85QgCvCo8iTxDbew7AknJumCMhrvI6We8QORUO7/wcLxA5FS8n+6yO7TP3bqRH7c8dZp3vPTfcrybpm+8+U9SPMxFubyqXLO6jK9XvInAGj1Gta+8mbeyPFuWWjwYxM48+MEQvHO/yLyh6Qg9CRqkvJ4nkrwoCNS8NRAvugjNtjwFhfM8utkXvcV03rsfXMq7VNEYu6hhXbxNs9C7R0+KPO/IGbwOPRa8pFL5Ony4vzzrM+k7HNOyPFluvrx/sxU9cP3Ru943Jz0uBvW8OB+TvAIcg7yvfyU77xWHvAhTA7xZ9Io73VDfuy9T4jvsBiM8+DvEuqlIJbwuBnW878gZPbwBtDxyJe68e9H3u9/FaLpvbxA83VBfvGJnNbx6kCO8VMV/PBacMjurqaA8i5vJOonAGj2SuRG85OhaPITWh7xje8O86zPpvPYTKD3ChaE8mbeyPONamTzBntm69ca6PFNwnby7Z9k8ZEJkvIyv17vXZkw8djTSPM6mNLzLMau7SaRsOw63ST3OprQ8zZImPbW2pbythM+8daYQvDJOOLtKd6Y830u1PGJntTwZXik8fwADvMQzijxm8Ey8iKwMOxc2Db0H8oe8qK7KPJzzXLwWY9M7XOPHPMHrxjxHfFA7HvtOvMaUhbwdNK68f7MVPPTf8rvQG748m6bvO7OOiTwuEo66a5kLvJfcg7w40qU7LStGO/g7RDwOMX072ihDPJGlA71z+Kc7ov0WPBolyjslDX67Ji0lPOi+Xzxy5Jk6blsCugu8czxOTSu/KAjUvAalGjw1EC+9xSdxvFy2AT1Z9Ao8y6tePLh4HLxGaMI8icAaOrrZl7yi/Za6ATU7OpUuGzslDf68NddPPNbYCryi/Za893QjurBGRrxgjAY9AbsHvPRlv7tXRqI8UYlVuru0Rjz1TAe9PW9LvOUIgjxAt468+IgxOytE/jv++BC82Y7oPHQMtjwn9MW8lOGtPGJntbtnBNs8FHSWvCwXuLvxamk8/V62OmXcPrxhgG28wIrLPGViizzmSdY8Y7QiPKL9lrwmWmu8I2suPCCpNzzChaE6J0EzvHCw5DzpC807Fyp0O9CVcbwjHsG7Dn5qO4yCkbxVHoa7utmXvIoNCDxDpku9KaKuPKBPrjwFvlK6vE6hOwgGFj0JR2o8dW2xPB6BGzxv6UM7jl1APfOenrxDIH881tiKPBhKm7yHjGW7ik7cvEQHx7sSQOE8QyyYvGJntby074Q8S1LVO3+zFTrA1zg9I2uuPPAplbz8l5W8TCUPPJjk+Dwx1IQ7/wwfPJ3apLtSXA888XaCukRAJrzTFpQ8Lj/UOjQ99TvWi508tn3GvNmOaDpU0Zg8oRbPvO6o8rrx8DU7/MTbu5tlGzxKPse6XpGwvJuyCDyLm0k8YqCUu4QX3LwpHGI8Pen+u1asRzuKhzu862xIvPlPUjwBuwe86Pe+vE0Avrw118+8cDYxO7dkjjwOioO6AsN8vNEvzDx9Ba27dgeMO+UIArsLvPM8dgeMvALDfLzAiku7bPqGPNNjgbtP22w8/4ZSvMzLhTsdbY05juOMO73I1DvFdN67HCAgu2KgFLwE97E7nROEPKKwKbx9BS27TTkdOzGHFzzszUO7Wvx/uy/ZLjwRxi28pyCJvJ4nkrxioBS83VBfvO60izwp7xu8IKm3vBmrlryxLQ69H+KWuytQlzxsrZm8Fyr0PEMsmLskuJu8LyacvE2GCrznMJ47NdfPPK3RPDvvFQc8fpPuuTe+Fzxkj9E8MDoqvJkxZrxa/P+6Q23sO5CF3DwdrmG8MO28PIDHIzwEMBE7oZybPFTF/7nf/sc8droePRTuyTwCSck8Gp99PJcJyrsAbpo7uYwquwlHajk0SY47NiQ9PYoBb7qrqaC63DzRvJCFXLzmlsO8f7MVPJm3MjwDlrY7IC8EvPJRsbuWj5Y8JRkXPIKi0roMVk48LJ2EPC6MQTuMNSQ8Fyr0OzxbPT0Ofmo83uq5vP3Y6bxBRdA6JZPKPD1ChTy5Pz28m9/OOrNVKjzDma87XgvkPEdPirh1bbE7VeWmPMqX0Dwf4pa85a/7O9lNFLwdruE8AklJu/3kgjyLboM7jcNlPEyfwry9FUK8T9vsO5ijpDlTcB28V0YiO9bM8TrZTZS7+Zy/PLqguDxpssM7XUTDuuj3Prw4HxM8Ymc1PO1nnrsK4cS8/JcVPLwuertyq7q85pZDvGgkgruI2dI6PtBGPBTuyTpL2KE8T9vsu0uLNDtJsIW6n2hmvLAZAL19Ba07RLrZPGrG0buDiZo7RdqAO5V7iLqJOs4739GBPE/nBbyq1ma5FmPTvNfsmDtwNrG7T2E5vFfA1TwXNg08bO5tOutsSLo0SY47svSuOxyaUztTvQq8RLpZO+s/gjtOmpg76QvNvEWhobtfWNG8WfSKu/F2ArzAiks8UlD2uz1vyztMn0K75TVIvEXagLwMCWE8epCjuy7FoDvKagq85CG6O5Uum7yqiXk9qcLYPG3BpztAq/U77nssvPSyrDs84Qm9C7zzOwJJSTvue6w7Wvz/uqRSebsgqbc81Fdou0N5hTx1mvc7nHkpvGfXlLt1phA72HpaPKnCWLo2qgk8S4u0PE/bbDwBgqi7XOPHOyYtJbz66aw8vHvnuzR21LwgL4Q8zPjLO4qHOzy9mw47n2jmuo3D5bvjh986v/BwPExmY7wSQOG5QDHCuyPl4Ts5bAA7S9ihu0ZoQjxkj9E7G7+kvOszaTx8uL88orApvJZv77qnFHA8W1WGvA5+6jvfS7U5x5z6Ow6KA721tqW8lBoNvU2GirwYlwg8+/06vJoYLjw9vLi8VR6Gu3gbmryZBCC8S9ihu2/pQ7xXRiK830s1PCUNfrxlKay8R8m9uxKNzjyoNBc8iCZAPEvYITyBFBG9Vvm0PEMsmLzkbqe8biIjvNlNFLxY1GM8wF2Fu4yCkTtje8M6Vn8BvJC+uzxhBro8Yy7Wux9cyjt0koK8iCbAPK6Y3TywGYC8A13XuxTuSTvtZ5685YI1PHxr0rxbllq8V8DVvLm5cLz0LGA8AJtgPFoIGbvf0QG9qDQXvdaLHbzBJKa8fLg/PG072zoflak8lrzcPIXqFTzlu5Q73A+LvHmp27wcIKA8o4vYvAwJ4bo0w0G8bO5tvFq7q7x1IEQ8WFowvRacsrzE5pw7ziDou/PrCzumhq68ZsMGO4gmwLwa7Oo7MHOJO3vdED0ZqxY89mAVPO9Czbt5Lyg70Bu+vOJGC7wH8ge9zQzavFtVBr3k6No7+MEQvMdbpjzuLr87FGh9PCFDErykJbM50eJeOjnms7zf/ke8jDWkvNZSvjy77aU8Dn7qPMAQmDzWUr47utkXPPHwtTvovl87/03zuei+37t252S8zPjLPHVtsTxAq/U75CE6uw6KAz2djTc8Ri9ju24iozsf4ha73VDfu2TIsLz8Sqi77nssvFSEq7yua5e8igFvO2ViCzwjay68e1fEu+cwHjzr5vu8mbcyPckJD7u8TqG5k80fPPxKqDyvuAS95+OwvDA6qro96f47zQxaPBS1ajrJg8I8lS4bu9JDWjztZx681HePOo/3Gr11mnc8dufkusQzirtkQmQ8Ix5BvBTBA73lr3u8O5QcuhKNzjyNlh+9oZybPOINLLxbz7m8854eOm5bgrz3JzY94OWPPO3h0Tx/s5U82U2UPEwZdrwG0uC7XURDOoc/+LsDlrY8+U/SPIM8LbxGaEK8HJpTu6fTmzt1mne84jryvE9hubsujEG8vAG0u52NtzrAEBi7NPwgvWKglDtXk4+8QDFCvFD7E7y7OhO8hMpuvA9RpDw3CwW9k/plPCUZlzyVLpu8+hbzu6fTm7wR/ww87FOQOynvm7u29/k8F7DAvI/3GjvlgjU8UtZCvDuUHL3kITo8Q21sPKhh3Typwti8bTtbvIeM5bz95AI9epAjO5QaDTyGSxG83jenu9phorzq8pQ82LM5PDozoTw9QgW8Wvz/O5b1O7uZftO8fp8HvatwQbzqH9s8WfQKvBcq9Lu0z128lvU7ux6BmzwOt8k5ziwBu0SNE7t7V8Q8iyGWvOW7lDwOMf270kNaPdChCr084Qm73VBfvMjp57xHyb08j/cavM8HsLzpkZk7tvd5PK1L8LrINlW8+umsvF331TxL2CE8qon5Os1ZRznvjzq81HcPPR00Ljv7/To8EkDhPHWad7oj5WE7+DvEPHw+DDwmWms7UlyPu8KyZ7zN0/q7OEzZO+neBjz2jds7D54RvVr8/7uI2VK80wr7uppRjTxMJQ85i24DvP0lVzuwwHk7wSQmPCnPdDrznh69orApuzVdnLxzclu8NYrivFRLTLwR83M8FMGDu+8VhzsrA6q8V0aiuohfHzy5ufC8M2JGPGe3bTvPusI82q4PPA8Yxby8e2c86qUnvOPUzDzbdbC8mPARungbmrvN3xO8vC56u2r/sDyOXUC8oirdu+neBrw4/2u8CWcRvHfOrDuNw+W5E9o7vLEtDrsDXVc8wF0FPSd6kjy2fcY7f7MVvYVkyTt1phC7QORUPJLm17pM7K+8xGDQOglHaryT+mU7B2w7vHw+DLxEjZM8bO7tvBc2jTw3CwU8CWeRO1JcjzoXd+E8SvHZPO4uP7y/8PA6ubnwvOcwnrz5nL88sVpUvKKwqbvr5nu82q4PO8rkvbzl/Oi8orApPK8yuLvjh1+8tO8EPfMY0jvRtRi9QywYvJ4nErzOLIG8yh0du+4uv7xTvYq7P6MAPU/nBbvUV2g7eFxuPCppz7xQKFq7KjyJPMFl+ruHErI796FpPvVMh7zmSdY8GJcIPW9vELzx8LU8uYwqPbMIPbsqtrw4S9ihO5CFXDwYl4g8akyevFLWQjwo2w08qpUSvIOJGr35T9K8Yc1avAWRjDrq8hQ8uYwquarW5rveNye8LsUgPUsRgTwOPZa8IUOSuwSqxLq2yrO639GBvJkx5juAxyO86zPpPJEft7yq1ua7v/wJPS+gz7wmWus75a/7PHCwZDz8xNs6fLg/vPV5TboXsEA7LGSlO0XagLqFZMm85zAevAbS4Dxd99W8XDA1u/oW8zu4eBw9uYwqvNbYirpNOR08bPoGvMzLBbzIb7Q6o4vYObx7Zzz7gwe9QyD/PAu8c7sja648akwevQLD/LmxLQ67od3vvMfVWbvwVls79o1bvD28uDpDbWy8anlku4IoH7tmdhm8AhyDPBu/pDw+0Ea828IdO0ZoQryyQRy8t5HUvPJRMbzutIs8skGcuxHzczyYakU71osdPLtnWbz0sqy8biIjPC8mnDwR/4w87nssuqNKBD1dfSK6+jYavHzxnrzmSdY83uq5OzGHFzv6FvO7ZsMGuzVdHLx6QzY75TXIPLm5cLwx1AS7LsWgvI4QUzx3gb+7u2fZvJNHUzyEyu66XGkUuz4Jpjsd58C86ESsOxu/pLxekTC82RS1PAlH6jnN35O8OvpBO9/RgTtWrEe81xnfvGCMhrvFdF674g2sPNmagTtG4vW7DI8tPDLIa7tJsAW8Wvx/vH6Tbjz+csQ5VZg5vEDk1LzRtZi5tBzLPO8VB73sUxA8GiXKu0p3przGlAW96ESsvNR3jzvarg89X6W+vJZv7zu0HMu85+OwvJjwEb3NWcc8krkRvAIcA7z8i/y7ciXuOxRofTyOXUC96L7fu93WK77TkMc7RwKdOq1XCbz1eU28iCZAPIpOXDzl/Og7MXt+vOzNwzw0w8E8poauvIisDLwWY1M8JuA3vIb+I7tv6UM8Z9cUPJjwkTzocXK7WxwnPXKrOrxu1bU6srtPuxd3YTxK8Vm8DFZOPIeM5TyWjxY85pbDvOh9C7xBGIo7P6MAvOkLTTsOPRY8e6SxvAxWzruAx6O7lahOuwJJSTwHuag8+IgxPEbujru8Lvq7fpPuu6Y5wTzl/Og7Ke+bukxmY7uGeNe8W0ntPEOmy7ryUTE8ndokuEwZ9jy2ROc73APyvDT8oDvuqPK7M2LGOKdNTzmaUY27+SIMPf9ZjLyn05s8W5bau5kx5jvPukI8swg9vFJQdjuumF08ICPrvL6vHDz1TAe9nicSPM3TejwIBpY7hNYHvCf0xTsRxq07QOTUuMkJjzzI6We8qtbmOwgGFruBFJG7aTiQu+hErDyE1oc80Bs+vJrLQDw96f68VNEYvLvtJbzWzPE8XgtkPErEEz1JKjk81CqiPIFV5byxLQ48IKk3vOs/Ar1LEQE8tKKXPOwGozs2cao8ziwBPHl8FTz22kg8hxIyvAj6/Lp7pDE88XaCPLW2pTywzJI7kL67vFUSbbvoRKy7CPr8OtU+MD3D0g67KwMqvAMQ6jzq8pS7T9vsuy9T4r28Lnq7N7L+O7x7Zz3iwD48TCUPPWksd7xJpGw8W1WGPLh4HD1P5wW8gEHXvIBBVzw6M6E8DAlhvMsxKzy07wS8GznYvJIzxbyyQZw8lm9vPHjiurz1xro8LgZ1vGXcPrz4iLG8s4LwvNICBjxfWNE7seCgueUIAj2+KdC82LO5urBGRryhY7w7FzaNPM4g6Ltniqe8MzWAPEC3Dr262Ze7Jlpru4/3GrvMywW9hnjXvNDO0DrQVJ27tlCAOyZaazzFJ3G8WoLMvNbMcbwYl4i8pb+NPLfeQby0z127Fyr0O73I1DxZ9Aq7D8vXufg7RLvYszk6wv/UvFJcDzwOt8k8FpwyPKeaPLuQRIg85G6nPA8YxTrKHR28hxIyO6g0l7uAQdc6hksRvZEfNzyFsba8k0fTO1oIGT0Rxq27zZImvOASVrwan/06Vn8BvLAZgDzvFQc8Ke8bvGRCZLzvj7o8GznYu0C3jrvxPSM9rUvwPNLJprwkMk+80bUYPBXVEbvLfhi9H1zKPBolyrtrEz+8lo+WvHIxh71tO1s8nPPcOz1vy7xctoE8rAocPNmaATxYDcO8tM9dOzQ9dTxlYou8wevGPPQs4LzXZky8+SKMvHNFFTv8lxW5N7J+O+rylDuvfyW6Wvz/vHNy27uhnJs8zMsFPN/RATzcPNE85s+ivLjyzztLEQG9ATW7vEMg/zxKxBO8cjEHu3gbGj0OigO8ICPrvPZglbxMJY88ciVuOkH4YrsI+vw7lm/vvKrW5rt9zE28KI6gPGO0orzFJ3G7wBCYPA4x/TzcA/K8+uksPLDA+TvA1zi8/9O/vNcZ37sKLrK8pXIgvFtVhrxtO9s8x1smvaGcmzwVT0U51xnfPO60izvfxeg8e92Qu0N5Bby293m59yc2vBHz87xBy5y7jDWku3Il7jtpssM8GwySPC0rRrwfXEq7srtPPLomBb2cQEq7TbPQO24iI7w1iuK74fmdu1NwHT1IY5g22Y5oO3zxnjw0w0G8Xr52PH+zFbxpssM7MQHLvIFV5byLboM8tGm4u8KyZ7xjARC8T66mPO713zwOfuq7jIIRO06aGL3q8hS8XX0ivJfcg7t/s5W8PtDGvODljzxn1xQ9KRziPIrUKD1e3p289yc2PNHi3rsLvHO73nAGvRjETrxLEQG9WoJMPGr/sLwkBQk8D1EkPUcCHbzxHfw7xsHLu56hRTxMGXa8Dn7qO0CrdTw7lBy85+MwvDzhCbzA1zi88R18uqVyIDzINtW8fD6MPD6DWTtfpT49RuJ1PGZ2mbsSYIg8vq8cvPkijDyc89y6p01POx7OiLzvyBm9IC+EPHmp27yWb+88+Zy/tpumbzwK4cS8Ix5BOxPauzxDeYW8158rPG3Bp7qXVjc7kubXPKdNzzwAm2C8JAWJO2SP0TzB68a8VEvMvKcU8Lxz+Ke8QLcOPNZSPr1EQKa8+umsPPetAr1pLHc8gzwtvPYTqDxjLtY6C0JAvNlNlDyF6hW9SSq5u0MsGDx/4Fs5x1umvDsO0LthUye9", } ], - "usage": {"prompt_tokens": 60, "completion_tokens": 9, "total_tokens": 69}, - "system_fingerprint": None, + "model": "text-embedding-ada-002-v2", + "usage": {"prompt_tokens": 8, "total_tokens": 8}, + }, + ], + "10590": [ + { + "content-type": "application/json", + "openai-model": "text-embedding-ada-002-v2", + "openai-organization": "user-rk8wq9voijy9sejrncvgi0iw", + "openai-processing-ms": "82", + "openai-project": "proj_0Wv6taeZjWf793P67JMswYY3", + "openai-version": "2020-10-01", + "x-ratelimit-limit-requests": "10000", + "x-ratelimit-limit-tokens": "10000000", + "x-ratelimit-remaining-requests": "9999", + "x-ratelimit-remaining-tokens": "9999998", + "x-ratelimit-reset-requests": "6ms", + "x-ratelimit-reset-tokens": "0s", + "x-request-id": "req_39f823ffb1ba4f0db5866f82f4a16be9", + }, + 200, + { + "object": "list", + "data": [ + { + "object": "embedding", + "index": 0, + "embedding": "3dQxPM4zDzsEjPc75tS5vCDGl7wZ3B68XtzevDualbw0sJw7AB6wvOVCfTw7CNk8doQ+vEhRwzx7WKi7appBPEX5Cj3Izeg6mM28PPjxDTu9bnM7AGeOPFf5GjxtzZS8cG4rvLOhujvtt307Og8OvMwdALyYQjW8ss3UPCjyubzEWOy8GzTXvJSLD72mD/I77QDcvL4AMLxv4yM8yM3ou1GT9Dy6SYo8UA8iO0AebLwZ1Wm7076aPIFuu7to8vW8C1GLvOJfPTtgQgE81ELtPG7G37sZSmK8Zpq9vJAWk7sfO5A89Sx+PKVCQTv5fJW7Vm6Tu6RuW7xrJUm84l89PNxJqrv0qKu7liXxO06wtDvPAMC8NyUZPHsPSjt9t5U8PoQKPJeweDvRqAs97x0gvAsIrbwb63i7j7BwO1VRzzwJqb88SrCwvC5RK7s18sU66QeNPEAebLwXNNO8JVEjPLVua7s3mpG7v9SVPHuhBruWmuk6A9yKPEFnSryQhFa8rLfBuzOT2DwUURM8yagDvfMWbzv1fJE8txa3u/YAZLw2CFW7IL/iuo2hljtMCOm7b5pFPM3qsDvui+O876inPAt2cDxHDxq93JIIvOgzp7yG+UY8JQjFvAbr5DsTNE+8ew/KOxBRj7vLQuU8i0Ipu9SSAD2MFg88Ypo5vEI0e7w/CN27rl+Nu/MdJD2AUXc8p5p5PLpJijwDSk68d1FvPNFfrbyuX408/9sGvcBYaLyt+eq7Qn3ZPP0zO7xgzYi5PCUdvUd93TyjdRA9CB64PJosKrup+Wa8M0p6u10PrryLi4c8/9uGPIRYMLw6D466C1GLvHya0TybAJC7XiU9PBawgLxabpe7iSwaPEiaITv+vsI7eOOrPEAe7DqPO/i6cYS6vNcsYrwvHly8eUIZO9kdDL1NJS082dQtvK6EcjwB62A71c10u/YHGbxhCP076xbnuzRnvjw2xqs8SW4HPavqkLwiHtA83JKIPHqEQjxoQok8RwhlvNszGzs9sCQ9/BZ3u7JCzbuEWDC/K2e2vGHGU7tEJaW8CuvoPKEWozyr49s89klCPM2oh7zNqIe7S33hOh4eTLuqXwm8RfmKvM6+Fjx1QhW8YEIBPGnG27yAmtW8ebBcOjp90bzukhg89x0ovJ9uV7tJZ1I8FqlLO5e3rTxYfW28E8YLukcIZbzUkgA8XiW9O5VYwLwrsJS8A1GDPOWSkDvcAMy71yziPIXjNzyioSo9T33lvPfUybzmHRg9WtzauyLcprzVFlM8Lx7cPExRx7v+ByE81EJtvN/qQDyRoZq8OLAgPNSLyzzct208/r5CvM2oB7thxlO86/EBPPJJPjv06lS882aCvIhRf7whUR+6WH1tvMPUmbuQxv+8ag+6PCEIQTw5O6i7UvkWPHeazTwj8jW8BwipO8IAtDyFbj88CwgtPbZC0bw9Oyy8rw/6uzZRszto8nW8BfIZvc6+Frw+hAo93l85PMK31TsjYPk6x0kWPfpJxjyy1Ak9/nXkPPSoKzzLALy8xaFKPB4lgTzXvh67R8Y7PHuhBru+Qtm8HMaTvD+ambzVqA88q1jUO8moAzyn6ow8v4s3uyQ03zzbviI9cfJ9vOvxgbw7k+A7DNwSvMUzhzucQjm6RoQSvWT5pjzVqI+7Vm6TPO7UQbzS6rQ7ouqIPPwW97okNF+8SJPsOyYlibtKqfs766HuOojGd7o9+YK7q+oQPMEzAzs98s27VZqtvBc00zwOqUM6FFGTO5QWF7yYzbw8OB7kvEwI6byhX4E7ew/KO0xRR7xVUc+7QoQOvLzqoLte4xM8pYTqu8EzAz3d1LE7eCVVPLaLLzyRoZo6pqGuPJrjy7zCSZI5NYQCOX9YrLzAWOg7UeOHO0Fnyjwd3KK8DqnDO2oPujmVoZ68eG6zvBI7hDxNJa27QJPkvJZ1BDy1t8m84L4mO5+3NTzO4/u7EjsEPG9R57wumom8UdxSvCce1LvzX825hSwWuyewEL2Ui487gCwSPSIlBTt0bq88KPK5PDIPhrxX+Ro7I7CMO3zjrzwUSt67DNySPEcPGjxO8l07LDscOx1RGzyIUX87aX39PBLr8DzBdSw8HAi9PGjydbz2B5k8DjsAveVJMjzMzey80wDEPA/Gh7oEZxI8qflmvMtJGr1Ak+S8txY3PP2hfjxvUec6WQh1O1PyYbw/CF28nljIu/YHmbyG+cY8d6ECuwWpO7xIUUM7oyyyPO9fSTyeoaa6DjsAvQK/xjsKfaU7QoSOOhoeyDwsO5y59pKgPCuwlDw7mpW6Ng8KPRvyrTximrm8BfKZPB4lgTxV44u8vOqgPBRRk7x5Z/48hJpZvMu3XTuZD2Y8p+NXvIPNqDxRJTG9f82kPPl8lTy46hy7YM2IPLDj3zwLv848wr4KPbl1JDxFsKw84h2UPI2hljsRHsA7ynU0u6CLGzuRWDy9gbeZvCLcJrtC8tE7G/Ktu+vxgTt9bje8HrAIPLbUDTu3Fre6K2c2vAY0wzqOJek7FFETvGMlwbx7WKg8N5qRPP/bBrwCdui713XAvOmSFLy0LEK8HiUBPL3j6zsumok79x0oPIxYuLtFbgO9GmDxu/G+NjvHSRY8PfmCvLTjY7vkLG68FvKpvAjVWbxTO8C8aEIJPCNnrrs7UTc83YtTvLaE+ryXAIy8V/kavON8gbxWbpO81JIAPIAskjwxfUk7a24nvCYlCb0oNOM8keNDPPW+urx0bq+8hredvKRuWzq+Qlk9UAhtPAHrYLy21A09l7etO075ErrnqJ+68gDgvLoArDy+SQ46KQjJO5sAELwTNM88SJNsPMF1LDyNoRY8TAhpO9BCabyGt507o3WQvMwdgLtN3E68xTOHPBXV5Tu9vgY8SJPsua1CSbw6xi89UA8iucZu+7zhkgw8j4sLPcnqLLwsO5w8fCwOvMBY6Dz5M7c8Ng+KO5mhIjxFbgO9A1GDPGmEsjzn6si7qdSBvEMIYbyJ4zu7OGfCvPxmijzLSRq8JVEjvN/qQDufLC48XIQmvGT5JrwDUQO7I/K1PE1uCzz/kqg6/gehvO6SmLxUWIS8X26bu75CWTxchCa8zV8pvN1C9bxhCP286HyFOuKom7xMUcc7nqGmu2hn7rzTdby8zaFSvESanTzXdUC7O5PgPJew+DzSLF685hbjPFAPory1ACi8w9SZuKBCvbxa3Fq8hSXhPJSLjzs/CF28DjuAO8Z1MLsQk7g7TmdWPE3czjwQUY+7EJM4utkdDDxyxuM8fjtoPLZC0TzlAFS82LdpO7b58ryUhFo72Ldpuytntju5voK7iMb3Osa+Dj38qDM7toR6vKrNzDpczYS7A0pOPDRnvjsPCLE80uo0PJ91jDwFqTs8zizaPMdCYbwGfaG7igCAvGy3hTyhX4E8A5OsvMdJFjwTxos8Y7DIvH/NJLyIWLQ87HyJu1XcVjzD1Bm83ADMvCkIybwQk7i8oywyvIKwZLzct+27CJOwO67N0LtpzZA80NQlPFIe/Lz5Mzc7ag86vbNfkbzCSRK8SW6HugHr4DwnHtS6I2euPFL5Fry21A28nPlauTeT3Ly/ize823VEPIc78DzF6qg8YuMXPXbGZ7l9sOA8FEpePEVuA7ydhGI7vW5zOpiLkzt2hL68E32tu9u+ojxYhKI6b5rFPNXN9DsLUQs8zB2APFBRSzqjdRC8XiW9OxRRE7xQUcs8D79Su5NCsTuli588IMaXvO6L4zulzUi7Y24fOmpRY7zSMxO82dStPDKajbrovq48f8bvuyC/Yjyu1AW9/gehvE0lrbyzWNw8jiVpO56hpruWmuk8e1iovDmEhjwkxpu7UAhtO5MACL3+ByG8eCyKO3X5trz/2wa8aEIJvLsWu7uHhE68YVgQu+kHjTuPiwu8v83gO5SLj7yHhE68KtyuPL3j67u3WOA81V+xPP18mTzLSZo85UL9OiewkLyFLBY8hSwWPOQHiTpCfVk8G/ItPPSoKzxLhJa7BIx3vCC/4rkmJYm8eNz2vK6EcjwKfSW7toT6ujZRsznbLGY85h0YvdySiDzXdcC7j7DwuoDjs7w/CF286QBYu14lvTzbM5s6nlhIPH/NJDxgQgE8kePDupbjx7sF8hm9xm77upDGfzvtt/08d1HvvCFKajzAoUY8EWcePPDxhbzYkoQ73R2Quv3q3DyZoaK8Bn0hOeN8Abu9LMq7X24bPFXji7vNXym7KVGnvPPUxbwhUR+8xBZDPAnynTuRmuW8CB64O6CLm7oXOwi8tUkGOugzJ7zovi48Mr9yvI9CrbwjYHm7RJPoO+rUPTr6AGg8Q8Y3uhLrcLy86qA8pg/yu/zxET0B8pW7yr6SuOGL17zEWOw7cfL9O5Z1hLw9sKQ8FFGTvCNgebzcSSo5hJpZuv3qXLuhzcS7QfmGux87kLtYD6o8J2cyvHeazbweJYG8WQh1PElnUrzLt9268b42uwUX/7uaLCq6fJrRO7b5cjsRHsA73ADMvEklqbxHDxq88HwNOrpC1bw33Lq8l7D4vPV8kTqPO3g7X7DEPC5Rqzt1QhW6ZVgUPM1YdLzUQm2776inPDo087zJMwu9fJpRvMmhTryLiwc79Sz+O28sgjvTAMQ8hzvwOzp90bwj8jW8yTOLOr75+rw5Oyi81EJtvA99KT23X5U803W8OzYPCrtYzYA8fxaDu2LjlzxS+Za82Emmu8PUGbwb8i27v9QVOyGTSLx4LIq8FzsIvM1Y9DwlUaO78DOvPKYWpzwRZx68Tzs8vFWarbwcxhM8DIz/PO8dILzyAGA8hFiwvKpfibw/mhk8u81cOw/Gh7wnZ7K73c38u0VnTrwTxos8kA9evOUAVLzjfAG8ZQ+2vIpuwzwYURc8qharOznyyTuUiw88zjOPuuS+KjiCQiG72uo8vWLjl7xpxts86ZKUvLoArLu4LEa7X24bPPxmijso8rm77DMrvBs7jLszk1i8DvKhOylRp7qZD+a8k0IxO7EApDzOM4+8pc3IvIksGrwxNOu79XyRvBc7iLvTt2U7DWBlufvbAr0Qkzi8QfmGuzq/+ruYi5O723VEPoXjt7yvWFg6WM0APSYliTqr6pA75UL9PCpK8rv2AGS7EFGPOuKomzlR4we8BB40vEcPmjsymo27RvJVvBqwhLx8LA69ItwmvMmhTrpDCGE8An0dPPYHmbwE1VW8HL9eOvIA4DuYhN68ttQNOkGwqDyYzby8X24bvFc7RLuaLKo8P5oZu9AdhLyzWNw71JKAuwdRhzzkdcw8LDucPJ0PajzEzWQ7hW6/PGe3gbw33Do7EjuEPA40S7yDzSi8TOMDvOmSlDyst8G8ZEIFvLOhOrtv3O485Ld1uhBRDzvlQv08z7fhumoPuruv6hQ992aGvBM0Tzxm45u7+9uCumclxbykABi7D8YHvfhf0bt/zaS7Fmeiuq7NULzVHQg72YtPvGRChTy+Qtm87OrMvAHylTtEk2g8YX31Oyg7GDtghCq8w9SZu5GhGjwQUY+8VFiEvDCp47w0qWc80qHWPGDybTswsBg8ATQ/vGywULxVmi27eCyKvOeoHzvaqBM8OB5kvBHV4TxGOzS8Qw8WO1gPKr3IzWg8ItXxPLm3TTyqzcw84h0UPAZ9IbwcxhO89geZuzk7KLyQhNY5b5pFvB87ELnlQn072JKEPM8AQDxO8l08z0meO2KauTx2hD48HdyivIPNqLzf6sA7TrC0PGBCAbzodVC8X2fmvDmEBrs+hAo6MlEvvUAebDwtDwK8cUKRO5kWmzt1sFi7laEeOwjVWbuPi4u8IMYXvBncHjzBM4M7l7D4u6mLIzy71BG8CsYDPClRp7wyCFE82l+1OxRREzxT8uG8rw/6vOVJsru71JG8E32tvANKzjvCALS81ItLveR1zLyZD2Y8vOqgPIhRf7xWsDy8LDscPaKhqrw+hAq7x0mWvMsAPL4z3La7cGf2ORapS7wONEu7MLAYPKWEajy9bnM5Bn2hvPEHFbsI3A481ItLu2slybxhD7K6XISmPF1YDLzO4/s5NghVvHgsijyft7U8Qn1ZPX/NpLzeqJc8TvLduj35grpV44u7p+NXPIKw5DumD3I8XViMvHm3EbxZCHW74dQ1PLl1JLvVqI+81c30OZz5WryqXwm8SvLZvBXV5TtQWIC8N5PcPGe3gTs4Z8I7OLAgvBQINTsI3A48luNHvHgl1TwHv8q8W2diPIAskjuID9Y89Sz+u+qL3zzIzei7QanzvMjNaDvSoda6toR6OoBR97t7WCi9zB0APDE0azyJLBq7uCzGvJduT7uNmmE8HUrmvDmpazyXsHg8E3b4u4cWCz1Rmim8GqnPO1BYAD3UQu272EmmO5jNvLpk+Sa8yTOLuxBRDz2UFhe7OYQGve6SGDxdmjW8I7CMu1njDzz724I8LQ8CvTWEAjySt6m8o3UQPH9YrLz/kig9lQ/iPJ0WHzpChA69u9QRPfwW97uuhPK7iMb3OkCTZLz7i+875tS5PBBRj7wxxqc7LcajOoc78DxPxsM5vXWovLLUibz5fJU7A1EDPDnyyTx9txW7sCw+OW/jI7yRmmW7cywGOuqLXz3ckog7HzsQvOuhbjwV3Bo8l7etvDCp470V3Bq9fxaDu8EzAz3DQl287bf9POuoo7wuk9S7YX11u6mLIz3Ui8u8RoSSvJSLj7yZoSI8NgjVvA99qbpaJTk8719JOm3NlLzRqAs9P1E7PJP5Urx/WCw79XVcPON8gTtJHvQ7E8YLvVgPKj0GfaE8zB2APDxnRjxPxsO7bLeFPLjqHL2iWMy7skLNu/DxBb11+TY7KH1BPEfGu7zXLOI74+pEPO7UwbvZHYy8K9X5O5kWG7weZ6q5C7/OPJP5UroXfbG8nuqEvBBRjzlm45u6BNXVu+YW4zxqUeO74zMjPLgsxjyKbsM6qs3MO0+Emry4LMY7wF+du93N/DySdYA7AB4wPGhnbrxpzZC7miyqPKYP8rvDizs8KH1BPIZCJb0v3DI9q+oQvV7cXjxxhDq9weqkOnQl0Tw18sW8MDsgvIAsErsXxg88TOMDOqfj1zwCdug6G/ItvHrNoLtk+SY8u81cO39YrLpkQgU6TvkSPTKaDbymXwW7muoAvHE7XLxBqXO8nqEmuwXymTto8vW713VAvJMAiL1PfWU8eoRCuVGaKbzyST47sHWcvF2aNThR4we9KQhJOwUXfzuF47e8ukkKup7qhLwnZzK7jzv4vLm+Ar0wOyA8Ypq5PKnUATxJJSk8N5qRPJYlcTvJ6qw8SWfSO9cs4jrckgg8qLe9O4L5QjxwZ/a6vkmOu56acTzNqAc7LpqJPMNC3TyXt627vSxKvAu/zrtChA48fbBgvCrcLj1sQg27YM0IvbKLq7sYUZc77Cx2PGT5JjxChA67K9X5OxCTuDq2QtG7mIRePG7G3zsMjH+8p5p5OPjxjbyEoQ692uo8O9t1RDyZFhs8McanvGRChTw0sJw8D79SO6fqDL3IFse71ELtOxi/WrwWsIA7/PEROkQlJb1e3N68V/JlvPB8DTsONMs7I2euPCaTTLy7zdy7RCWlO3/Gb7w0sJw8OfLJPLLNVDyW40e8Rw8aPf515DyYQrW68b62vHRuL7wTxos7SJNsOljGSzxxQhG6eNx2vMtJGjy9voY8LTRnPEAebDhqDzq8GrAEPLFJAj10JVG7mM08vDoPDr0OOwC8J2eyuugzpzyHO/C6P5oZvWA7zDvwfA090NSlPIb5RjqBt5k6nYRiPM7j+7s4Z8I8wrdVvEAlobx1sFi8+XXgPH9YrLvTt+U8FAg1PEiTbDuF4zc9yTMLvGl9/TsRHkC8HiUBPTHGJzxdWAw7oIsbvBCTODuBJd08gvnCuxpgcbzXvh65kIRWPKWLH7wtxiM9O5qVOyNnLrzNWPQ6HiUBvBRRkzv9M7s6jiVpPHBuq7xnbqO8d6GCPGl9fbwNZ5q8TrA0vHgsCrxb+Z478HyNvDnyyTxmUd+6Z24jvI63JTuKt6E8wSzOPEqwsDuUzbi8aYSyvNszmzy9vga8NyUZvCOwDLwXO4g8r+oUPPTxibz8X9W8LghNPFkI9bxYfe273zOfvGXNjDjO4/s8HiWBvGiwzDxZCPW8oqEqvC6aCbyAUXe7XuMTvdDUpbx/WCy9", + } + ], + "model": "text-embedding-ada-002-v2", + "usage": {"prompt_tokens": 1, "total_tokens": 1}, }, ], "9906": [ { "content-type": "application/json", - "openai-organization": "new-relic-nkmd8b", - "openai-processing-ms": "23", + "openai-model": "text-embedding-ada-002-v2", + "openai-organization": "user-rk8wq9voijy9sejrncvgi0iw", + "openai-processing-ms": "158", + "openai-project": "proj_0Wv6taeZjWf793P67JMswYY3", "openai-version": "2020-10-01", - "x-ratelimit-limit-requests": "3000", - "x-ratelimit-limit-tokens": "1000000", - "x-ratelimit-remaining-requests": "2999", - "x-ratelimit-remaining-tokens": "999996", - "x-ratelimit-reset-requests": "20ms", + "x-ratelimit-limit-requests": "10000", + "x-ratelimit-limit-tokens": "10000000", + "x-ratelimit-remaining-requests": "9999", + "x-ratelimit-remaining-tokens": "9999996", + "x-ratelimit-reset-requests": "6ms", "x-ratelimit-reset-tokens": "0s", - "x-request-id": "058b2dd82590aa4145e97c2e59681f62", + "x-request-id": "req_2f1a3eb66e7b4f55849cac5a35bcb9c9", }, 200, { @@ -438,7 +580,7 @@ { "object": "embedding", "index": 0, - "embedding": "0TB/Ov96cDsiAKC8oBytvE/gdrsckEQ6CG5svFFCLDz4Vr+7jCAqvXdNdzx16EY8T5m2vJtdLLxfhxM7gEDzO8tQkzzAITe8b08bPIYd5DzO07O8593cO8+EDrsRy4I7jI2/vAcnrDvjPMw7ElaIvB/qFD2P5w+9kJvlPMLKrLzMl1O8DAwCvAxTwjuP54+7OsMIuu26TbxXjLI8ByesvHCWWzydczc7dF3BO6CJwjkzeQK9vQssPI42NTqPVKW8REEKO7GVjzx42Hw8xXOiuzhh07wrYLE8JDwAvS0Jp7oezKS8zxr0PEs/5jwNBB28NFMtvMKGZzt1wvG8pFAoPInkSbyZjuE7AmirOx1BHzzDN0K8cSHhPNCl+Ty5k2u8yp84vDjOaLzyDLk8jlyKO1FrfLywd587qi0ZPN0QNryGYak8fFC9vLZ94LuRkIU8x7L9OwHdJTwDhpu7sKDvPLajtbx7Ms28eRzCOp2ZjDoRpa07ZNx5PGMoJLzrL8g7KkJBvJvwFjzEwke7RK4fvWlyKrxWAS281c4UvNX3ZLz0SBm8+k7au3YsDDzoaGI7+ZqEPPatSTuNPpq8vXjBPGHsQ7yLb8+8D48iO5OxcLsb32k80KX5O+ShfLtErp+8L5SsPP07FT3C8IE8eYnXvH/5MjwHupY6EK0SvWVkhLzW7AS826uFvPGfIz2dczc8z8tOPB+Aejufa9K8bsSVPHj+UTlFOaU8kZAFvA5L3bwv22w86YZSPG/ihTxOv4u82QKQPDu7ozwqhoY8hJJevIBA8ztSYBy8EsMdPBpUZDxs9co7TTQGvH0q6Do3hyg8fJ9iO2wboDwot7s7vryGvHrNnLrLUBO8SSnbu4cSBL2e4Ew8JTSbPOmG0jxdJV47arlqvHBti7zZmHW8q0sJPIZhKb3mcMc8glZ+vOqkwjuBoqi7lcSAPKb5nbw2/KK8GMnevE00BjylAQM8y3njPDW43brZ3Do6O06OPERBirtcmlg8D2lNvKUBAzzzcek84mKhPMhjWDy0GDC/PmSZu8VzIjxfYT480nTEu3j+UTyTG4s8y1CTPIPeiLu0PoU8YruOu2z1SjyiFEi7ZY1UvPZeJLzV92S8K83Guq47v7weObq8PUYpPMM3QrwUKM48nA4HvFVQUrw4OIM8jYVaOuisJ7l+H4i8TTQGOoVDuTxbLUO8/1GgPMZrPTx16Ea6MIxHPR2uNDzLKr67QgUqPCLayjuONrU8z/EjvEK2hLxGpjo7P8nJvHvFN7zLeeM7frXtPDN8/Tv4Vr+7rmGUu0amujxnyTS8ApF7PPZeJDyvFWo7AmirO6rAAz14/tE7syAVu20TOzsMD326gsCYOj+CiTqDB1k8rs6pvDM1vTwkFqu8+2xKPG9Pm7x+bi28XHGIurhyALzDEW2802xfvEJyvzzuHAM9JfDVPGClA7v8ZGW8fQGYPJgDXDxITzA7QA2PvA3A17wwspw8WPnHu5Xt0Lz7bMo6pL29uZFMwDutiuQ8I4slPN7BkLyS18W7q0sJPTGqtzvR6b67WKoiPPME1Dwx0Iy7EhLDO5QTJrzT/0m8nFVHO8ccmDwEzVu70uFZvGVkBD3xnyM9ZWf/vHOsZjuwCgq8VeM8veCT1jwUKM46hxIEvfX87ruFQ7k7dMrWPDN8fby9MYE8RcwPPKnp0zy7z0u8vFpRPB+Aeju9NHy8FQL5O+HXG7xljVS8TBaWPPOXvjrrwrI8UUIsvH5I2DsCaKu70TB/PKLFIrxowU889xJ6OZ2ZDLyZIcy7poyIPOrKl7zGkZI8c6zmvAzmrLwp/vs6TiwhOuchIrxJ2jU8vIAmvNqNFb1gEpk7J5lLuxtJBLxy0rs7FLu4vMJdF70xZvK89q3JuinVqzxLP2Y7frXtuqUBAzvVis+8tD6FvKGnMjykl2i7TiwhvZDBujx0Dhy87x9+vOAAbDoWs9O7qi2ZO9kCkLyF1iO8bsSVvAKR+7vNSK66O7ujuyn7gLz+M7A7W+YCPYooDzvmA7I72QKQPBfRQ7wSEkO4DQQdPJvwFjyZIcy8uAhmOsPoHLwP1uK52klQPBLDHbxxIWE8prXYPNCl+Tx764y6powIPV5DzrzfTBa79WYJvag4+TsaBb+8ysUNOyn7gDyBoig8BnZRvIXWI7uJCh88eYnXPJi0tjyNPho7OgpJvO5rqLzaIAC86PtMvBaKgzywM1q8LQmnu59CArq0PgU95J4BPNwYGz1pcqo7eRzCvGEwCb24coA8N4coPFEc17uj45K8OPS9u9XOlDwEzVu8gIQ4PHC8MDz4w1S8OgpJPEbt+jzchbC80S0EPI2FWjx9Kmg8WD0NOgYJvLkeps887HMNO1V2p7qOXAq8LBEMO4OaQ7zviRi9jNT/u8C0IbyRkAU8BS8RPaKBXTxV4zw8O06OOylolrmkl+g7T+B2vOCT1juKvnS8hJLeu29Pm7xVvWe8jNT/u3Xoxjw++n68f/myOzLIJ7vEnHK7H1eqO2z1SjxOVfE7z/GjvAqEd7xUWDe7sDNaPJEma7rLvSi8W+YCvUkACzzXDfA7FChOu5JqsLyY2gs8YKUDPN/fAL3fdWY8ZCA/OyG82jx0XcG8OgpJOee0DLzbq4U8qenTO6Zms7wHupa87HONPB71dLuaGec6KSTRuw9pTbuTsfA56+gHPN2jIDwpaBa7y1ATPKAcrTxx2iC6GyMvOug/EjwdG8o8q7geu9pJ0Ls4zmi7X87TvGq5arzl5UE902xfPI2rr7pS84Y8y1CTvHx2ErzQpfm8yGPYvHckJ7ynF4472iP7uk/g9juhOh07k4ggPKmiEzwXgh66JujwOWHGbrwuJ5e6637tu2h6j7sIAdc7/RVAO3CWWzyvWa88CEWcO3x2Ejxtz/U7zbVDvPc4z7xkRhS6mNqLuw/8NzzMl1M8kHIVuxz92Two3ZA8tYVFPRu2mTsF60u8bPVKPGB/LjzgJsG79WYJvEGYlDto56S5RBs1O16wYzwnLDa8vrwGvVkXuDxQJLw7Juhwu92joLxFYnW83X3LO+LPtrsKhPe7vZ6WvCe/IL1rRPC8mAPcvLGVj7zem7u7nS9yvPGfI70gCAW9CWMMPArQobzgaga8hvSTu5UxFr3JFLO8OlluPAG30DycVUc8EBoovGwbILxGVxU8cSHhO4zUf7uLSfq8aOckPN8I0btNDrE8VpQXuqRQqDwp+4C75nDHu70xAT0iACA7rqhUPEHnuTwOcTK8YVnZO8Ok1zv4Vr86WsgSvBtyVLzJ7t07LBEMvH9mSLy2o7U5OsMIPIMHWTsZ5048kC7QPAPzsDxYPY28V7KHOYyNPz0++n68z/GjPHC8MLlzgxa8mSHMPG/iBT21NqA8BuNmvA2XB725aps5xAaNvC8BQjzOZp48q3RZuiP4Ortwllu8nXO3vAqEdzrtlPi6w+icu8oyozvA+2G8+XSvOFxLs7w6w4i5uh7xOD5kmTyxUUq8wzfCu3Eh4byOXIq85AuXOcMRbbyJ5Em93TYLvV5DTrztus079EgZvMGsPDymtVi8GMleO5dPhryjMji74mKhO/olCr3aIAC7ye5dPN9MljwF60s8eNUBPUhPsDsfgPo7X4eTO/mdfzvem7u7jRhFvG8L1rw7KLm84LmrPKRQqDwx0Aw9P4KJuzVLSDsJ+XE8W+l9OXjVAbxE12+7i29POzkSLrzG/qe88VteuT9cNDrKnzg8B7qWO7dUELxbLcM7ysWNOxyQRDwdrjQ8aFS6PKVIw7sGdtE8U+shPNtnQDsfgHq8nS9yu7ebULuwoG88cxYBPJXHezytQ6Q8vKl2vGz1SrsvlCw702zfPCQWKzx2c0w7URzXu2tEcLpXSO07cbRLvIHL+Lv1QDS8JceFOotJery79aC8HUEfPCLaSrwkPAC9YKWDu23PdbnNSC49q7iePHvrDDwFfrY82W+lO8nu3TsXgp48lymxvO+JmLoeXw89c/CruqQq07us/168dKGGOu8ffjszeYK7ZEYUvdpJ0Lolg8A8YKUDu70LrLwkqZU7x68CvZFMQDx+tW07iQqfvDvkc7wGCTw8OlnuvAxTQjz9O5W8ULemPFEc1zwo3RC8mAPcOggBV7thMAk8mANcurZ9YLyNhdo8H1eqvJG5VTy9NHw8FxWJu4gz77pCcj+7uf2FvE8GzDyXKbG8kxuLO/Gfo7tvT5s84+0mvOe0DDywoO+7ty47u2c2yrplZIS8TPDAPKAcLTyfkSe7TcrruyjdkLyVxIC8DHkXvYMtLjugRf075AuXvF5pIzz0SJm7Hjk6POxzDTzHia08zfmIu5wOhzxG7fo83RC2vM8a9Lv2h3Q8sVFKPG05kLzAtKE8Pvr+uryp9rpP4PY7MB8yvABwkLz4Vr87mhnnOtkCkDvG/qe7gaIoPHOs5jyzIJU8v3DcO50vcrwKPbe8xif4PLU2ILt/jB28mj+8OqySSbxduEg8uEwrvI6jSru8E5G7k7HwvO5rKLwYyd465imHOtSwpDs5pRi8prXYvHo6MjqGHeS8BKSLO9YV1Tu8gCa8zUiuuxsjLzv3Eno8sVHKuk9KETygr5e71w3wu9RDjzkRy4K8EWFovH7bwruybzo9BpwmPNczxTuVxAC8PUYpvDUECL1XH528pJfougVYYToMeZc7kHKVPCnVKzu0PoU8/jOwuvEyDjyI7C686D+SvAwMgrouugG8dXuxPNX35LvxW968M6JSO8yXUzs1cZ08s7Z6Ow/8tztsiDW8kxuLu7HktLwSw528JKmVOmhUOjzrfm084GqGvAwMgrseXw883RC2O2VkBDsYXMm8JYNAOoIPvry2EMs8bRM7vC4nlztFYnU8thDLvH5I2Dw+0S685imHPNcN8DywM1o8mLS2O6Pjkrq5Jta7jCCquSVdazz46Sm6cSFhO2uuCjz+oEW8tqO1vKcXjryONrU6xU3NvD/vHrwrOtw75KH8PKJYjTxPShG9wdKRvGA76byl2y0844ARPFProbzFc6K6AbdQvEMjmjpgpQM8s/q/vMevgrsamKk8Sz9mPNRDD7qmtdg8kSZrPvVmCbywCoo71hXVPDFm8jwFWGE8BetLPDRTrbtBweQ7UCS8O89eObyNhdq7GMlevBeCnjvnjrc768IyPAeUwbxlZ/+84ovxvOxzjbzRLYQ7/1GgvKHNh7wD87C8ukRGPCMekDtQkVG8z4SOu32UAj29npa6IbxavJhHobt+tW07F9HDPFo1qLwzolK85yEiPWq5ajy9MQE905I0uxAaqLwK0KG8Jg5Gu23P9TstxWE7BycsPI2F2rv7sA+94ADsO8ey/TyIWcS7oEV9PImdiTzIOgg9aS5lPMu9qLy4ucA8ZlyfPPtsSrza+iq8c6xmu9MlHz2QLtC7FUa+POo3rbygRX27/jMwvWr9L7sHupa6RNdvvAvukbwmobC7LrqBu2HG7jrwgbO8AUo7vLICJTxUxcw73X3LPGku5TxI4pq8iigPvJOIILxNyuu8S6kAvUSuH700Uy08XJpYvI6jSrwT4Y28OlnuOzowHrwcau+5X85TPP6gRTwyWxI8Nmm4Ow3AVzxVvee7AUo7vFZuwrvdNos8l7wbPKrAg7t3TXe8baYlPDdD47tUMmI87HONOw5xsrt9lAK92iCAvMevArotxeE7h6jpvAG30Du79aC8ApH7uYjsrjvcX1u8l5bGOmz1Srwxqje8I/g6PHe3kbrRMH+8P++eu30qaDx4/lE8MT0iverKlzpunkA79xL6POj7TDzAIbc7fSpoPKPjkjvJFDM7nHucu5JqsLt9vVI7piJuvD7RLjzaI3u84LkrvGTc+bweps88Ru36vBD00rvuayg6NxoTvfmaBLpANl+8PG/5u2yINT3D6Jy7LBEMvMsqvrzoaOI7Im01uzN5grxCBao75eXBPMYn+LtRQiy9k7HwvHivLL789088ehRdPOSegbwi2ko8+9lfO4ZhKTy+vIY8ctI7O3jY/Dux5LS6z/GjvJqDAbxrrgq9MWbyuyQ8gLzviRi8ygzOtjVxHT15YIc8hLgzPbMglbvWWZo7zmYeux9XqjtGE1C87muoO4kKHz0kPAC7Qee5vNNsX7za+qq8UdUWPXMWgTyEkt48HvX0u3yfYjvfTBa9/jMwvNSwpDwhvNo8WjUoPIhZRDzYUTW8e8W3vGJ3ybs6MJ4818Yvu2ASmTz9FUC83PJFPHtYorvO0zO7jRjFumHG7jzHia08tqO1u6/smTyM+lS7JNLlu1iqIrzkoXy8RTmlu0naNbzZmPW7DAwCumyINbxG7fo7fkhYvGOVuTyMICq8HvX0vAo9N7xWJwK9ZCC/O24xqzu9nha9xMLHPK2K5DodrjS8sAqKvIzUfzzpGT08cdogPHPwK7z+MzA8f4wdvIE1Ezzp8+e8U+uhvG7ElTwVRr68pFCou35urbwJY4w7qDh5PCTS5TsV2ag8pCpTvA5LXbxFOSU6uN+VPAljjLwrzca6fQEYPfFbXrz5dK88vTT8O34fCD2kUKi8t1QQvD0g1DtpLuU85463PL0xgTx0ytY8RleVuw3AV7wHuha7aFS6ukIFKj1/Zkg82iP7vOldAjyVMZa7pCpTOjaPjb2aGee8qpouOXrNnDwIRRw8zNsYPUOQr7tHMcA7wPthujowHjxQt6Y7PqtZvC/b7DuyAqW7l08GPdfGr7xQt6Y8NxqTvJ9r0rvTJZ88uf0FuyMeELzPy048hxKEvKu4nrxUWDc8AY6AvGtE8DxTp1w77ti9u6jxuLxKtOC8S9JQu0K2BLyEuDO6UmCcPOBqBr1iUXQ8yGNYPDEXzbzleKw8KfuAPIq+9LuJnQm98KeIuzW4XTzG/ic7uh7xPEA23zuixaK83sGQvJaeK71KR8u8fHaSPG05kDubXSy74vWLPHCW2zwb32m7vKn2O7XJCjxksyk7KWgWvbgI5jwBjgC8U6dcPM/LTryhp7I8AAb2PPwdpTsnUou8jja1PJ+RJ7wOS908P+8evZ4kkjwFLxG8GXq5vNaoPzxG7Xo8TlXxvGhUurw0wMK6M+YXvKZmszzgaoY8cxYBvPl0rztHxCq8Z8k0va/sGbyzIJU857SMPF5DTrw/gok7ipWkPDpZbrrHiS27QnK/PEhPsDxLqQC9j1SlvM7Ts70J+fE8nKTsu7qIi7wp1as8uEyruZmOYTx+tW282o0VvLONKrt2maG8m8pBu/FbXryqw348K83GvG3P9bvmKQc9d5G8PM5Aybsc/Vm7OlnuOp4kkrye4Ey8wLShO0fEKry6HvE7f4wdvZAuULsQh725LrqBvLjflTtmXB+9VicCvEbt+jzrL8g7NUvIux7MpDuONrU8woZnvBLDnTx42Py861WdvNlvpTzguSs8GedOu1zenTqtQyQ76GjiOrZ94DwQ9FI8lDz2O7lqmzzF4Le8jPpUu/VmibzntIy8mY5hvJCbZbphxm67vO07veMW9zzZAhC8/sYaPdQdurv1/G47pFAoOxHLgrwBjgC8sAqKuwjYhryWnqu7AkJWvG05EDyRTMA8mY7hPOxNuLh6OjK8YnfJPEltIL3Rmhk93TYLPXXC8TuRJuu81ffkOXxQvTxhnR48frXtOurKlzrM25i7UdWWOyjdEL3hRDG8DktdO7wTkTxtORA8RTklOy5Q57tDkK86ULemPHsyTTzgJkE8635tPNXOlLtduEg7W+aCuxPhjTp5iVe8/PfPvCqvVjyLSXo78wRUOuJioTwFLxG7E3dzPBtJBL3Hsv04v3DcPGK7jjtrrgq9qaITPcPoHLxIvMU7+ZoEPRJWiLyF1qM7E3fzOEIFqjttz3W8XrDjPOho4rsM5qw8AvuVu/fLubsX0cO8RhPQOaySSTjuHIM77kVTPLpERrxk3Hk9JDwAPGqQmrt8n2I8YcZuPLU2oDzPXrk8oK8XPO26TbzA++G8fJ9iu5o/vDuvf4S8ODgDvTFm8rtDI5q7Nd6yvIeoabzBP6e8iMbZPOtVnTw6WW48GXq5PLxa0TuAqo28vKl2vNbsBDwJY4w7yDqIvAwP/bys/948frVtuxorlLyLs5S8SSlbO1OnXDsk0mW7fSrou68V6rtHxCo8CzXSPFvmAjvVO6q8UGgBvfmahDsI2IY8BVjhvAljjLsiR+C8", + "embedding": "N6UxukuzljuISqW8PMimvFQmeLufoLS6iqeAvDZENTxDzqi7AZY1vZezhDxK2Es80+23vMFEcLycXCs7TZYjPFX9oTySFkG8eVsUPNwvAT36j7O8db7QO1WDU7slcpc7a3TFvK2wWTuPUKc7ZPR0vAcWBj1J0Am9YS7bPNGImrw+MWW8TvcfvG4yHTxGkKG7LmNouQtiUbyZHMM8J1nFvJT9bjwEWK46aRfqO+2L8bpxAPm8UjcIPBNHPzpkZoG8e0JCO94SjjzRBoo8rS7JuwkB1bxcB8U81MgCvV1oQbtq7pO8/lnuPO2H0Dz4rCa8PE5YvNESbTspQPO8aQsHPO9iG7zJKd47sywJPDVAFDzh3Ei8pijHPFLB2jxSP0q8Yg1HvIBtebzg+bs8U5gEOz8Ij7xii7Y7/OwOPCk8Urx4fKg8zkiyvP+yqLuohaI8tY0FPL/fUjxJ0Im7WqrpPKEBsby8Hdq8pqKVukh78Dp9p1878wOAPG6wDLywdvM78q5mvEPKBzwVKky7qeYevQGaVrxXXh680YgavI/aebzAuh28PqszvIhS5zts1UE7bNliPBFgEbqVUoi8Ld22PG46X7yhBdK85RiQOzRdh7sVsH08JBndO2EuW7vwRai8/HLAPIuKDT35Nnk8xITYvN4aUDzjt5M7QesbvbB2c7wE1h284H9tvMC6HT1fS048EeZCPB9wtjtQ3s28ygCIPOcD3zpJ1Ko8oQExvFLF+7y6vF08pixoPPMDgDyzOGy8s66ZPG+TmTxnqoo86sl4vBADtjsYajS8aQ8oPFooWTxmTa87PNDou/z0ULkkl0w8BNo+O88nnjw8zMc7M4p+vC8+Mzd2mRu8diPuu1/R/7yj5D08MgCsPDTn2TxLMYY7Z7JMvJe/Z7zbXHi8Nb4DPLHPLb0yBM08q1N+vM7GoTsHHsi7QXFNPF/FnLzqP6a8L8TkvOugIjxVh/Q7j9bYPK4Vd7t2nbw6l79nPKS/iLu9flY8ZywbvFyFtDsf9uc8piSmPH4EOzxADDC/tZnouzbCJDy1DxY8vXaUu1OgRjzPsXA8fB2NPJkg5LupZI486N4pu4fxajzHPg+7UGBevFDeTbzT8Vi8jfPLugig2LySFsG8ZPT0O1hFTLz5sMc8LVsmvEPSSbzmeYw8KUBzujZMdzpuOl+84VYXusxlpTzi4Gm89WidPJziXDx8HQ279AtCPdYxQTwTwY27BjcaPDitczt7QsI8EAM2vL30g7xz16K59XDfvD4xZbyly+s7m4HgPL/XEDxI8R28B5iWuwl/xDyhfyC8zUSRPD+KHzyZGKI7SPW+O28RCT0Y5AI8QW0sOv5ZbjuhBdK66NqIucQG6TpsUzE8brStvAY7uzzXjpy8ed0kPE2Wo7xzWTO8PMSFu9tc+LuFCj28nGBMvI1xuzyNef08lPnNPCqVDDrjPUW8FCKKPAkFdjwsAmw7GGaTvJ+k1bwC97E8rgkUvI/W2LxzYfU6G6ocus+tTzvCpew8cXpHPGkLh7yc4ty78qIDPaCo9jsEVA280+03POrF1zymKMe72fO5O8+tT7yuDTW8gytRO6lorzzh1Ia7HY0pvJezBD0HGic9q0/dvOD5OzuISiW8mZoyvcBAzzxaJDg7ZGYBvZzm/bsdkco7PNDoPBaDhrxxAHk8gyOPO2Tw0zxzXVS8ySU9PFBk/zufGoO88wchPO1/Drzv7G28JXKXPN4SDrvHQrA83h7xu+b/vTu1F9i6BFxPPNnvGLzqvRU8C9wfuxcR+rvju7S7dcJxPJp5nrz15ow8SHvwvEaQobwnUQM7hYxNOxaLyLvoXBk8stNOvHPXIr3REu07XWziu94a0LvPsXA7wh+7vKJeDL2rU/68JXY4u5r7rjw+pxI7bxUqO9cQLbnyrua8a3hmvLhbYTyKs2O7LVsmvVWD0zzKAAi8iFJnvLWZaDqxz627XWjBO/1Ni7wBEAS8wDiNvB2NqbupaC+7xeVUu/+uh7wIpPk7Nx8APaiFojvZ7xg8E0OePEFxTbxk9HQ6pL8IPJ8eJDyKr8K88qIDOpXYObwEVA27tRdYPMA4Dbwzhl08VYPTPCIuDj1Vg1O7lPELPUFxzbxSN4i7/U0LvaEF0jvYkr28fSEuO2euqzwTwQ08v9eQvAa1CbuXOTY8+hHEPJ4/uDxiCaY798kZvHS2jrySlLC76GRbvOFWlzzREm28qI3ku9250zpnqgo9L8TkO712FD0ZSaA7INGyvBPBDb0tV4U8jXVcPIwQv7sQiWe8QfNdux2NqTzJp0281EoTPDtnKjz/tkm8E0c/PDTn2TzCH7u8RpTCO9TUZTyzOGw84dgnOZxYCrqEL/I8xV8jOyQdfropQPO6ySU9Ome2bbyDpR+9s7K6u1qq6buy1+87X0MMPbrAfjzbXPg7INXTOxWw/brzAwA8EIlnvPz48Tu2cJK88qIDvHwdjbzdvXS8w/oFvGINxzxkZoG8Nkx3O02Wo7thqKm7I4+KO/dPSzzOysI7uxm5vIwUYLwD+1I6xIRYPMkt/7o80Gi80mcGvdltCDyaeR48tY2Fu734pLwJ/TM8l7/nO8P6Bb2BQII8SHOuOzit8zxNnuW8bFdSO4sMHrwtV4U8KpWMO3AZy7y6Nqy8roeDPOUYELrJLX86l7vGuxjoo7vXDAw7+g0jPBs07ztAkmG7AvMQPI9Qpzz9TQu6kK0CO4uKDTxzXdQ8qWxQulDezbvoYDq7S7vYvFQiV7zTb0g9eIRqPF1s4rp/DH08zGWlvNtQFbyRO/a8szjsvNEKK7xJVrs7KDSQukCS4TvsKnU5BN7fO/fV/Dt2nTy7zOc1u0CSYbyeOxe7cXrHu1ogF7vJIRw8BFxPOvQPYzwEWK48OK1zO6EBMTyhCfM7urg8vBuuvbyfHqS4j9p5u0QvJTxBcU081i0gu8QG6TwiLo4866RDPYhOxjt2Fwu8Q9JJPFqeBjw8xIW7+Tb5u3u8kDsay7A5SG8NOjRlSTwayzC8q8UKvcdCsDxQXL07FoMGu8xhhLyjam+8HZHKO/KuZruN76q7j86WvIsMHr0sAuy89XDfvNESbbzeHvG7rbBZvNJrJ73NwgC9ZOgRPLFNnbwbLC28bFfSu8IbGr3OxqG8AnGAPG463zzv7G08kC8TvNGMO7wl9Cc8+TLYO6YsaLspQPO8X8UcPCdZxbvOSLI8L7iBuhuuvTz6EcS7e0bju+ho/DzZ+3s7Uj9KPOsiszy1kSa8b5OZO4opETyFkG670QorvEAMMLyDIw88Y5P4uxQiirzqwTY7mRSBO2zZYjvth1A8CQHVPLhXwDwE1p280/FYOku3Nz0zin6890uqPEhzrjoYZhO8INGyPLHLDD36i5I8roeDvJCtAr2P2vm6FCKKvNn3WjxpD6g8gOfHOv8wGLnjv1W8e8CxvBADNjv0jVK27+jMuyBX5Du6vF28UxqVufXuzryeQ1k6gG15uiOPijwf9me8faffuyBX5LyA34W8khKgOk51j7xfS069huUHvVI/Srxmz787VX8yvDelMTyAbXm8FoOGO+WiYrwCdSG6Dp6YO+FWF71ly566ARCEPI1xuzwE3l88Ii4OPTVAFDyQMzQ8uNWvO/KqxTvgf+27zkgyvNn32ry9fta8ldi5PO/kqzxTmAQ9eHiHu8KZiTsOKGs82W2IuiBLAbyKqyG7ZcueOyDRMrykRbq8szTLOvoRxDrRDkw8fZ+dOwY/3LuP2vk72e+YO0rYSzxDVNo71NDEPDEhwLvMacY872IbPBYN2brOUHS8+TLYu+wqdbtaqmk899HbO2kLhzxIc648x8hhvFyFNLuKr8I7pqrXPAGSFDzrHhI5KDSQu/QPY7uxTR08gGlYvJkUAbzRjDu8TZYjO/dHibzPK7+8cQD5OyBPIrwCcQC9scsMuyg0kLr1aB09WD2KPFogFzzcM6I89A/jO+sm1DvrnIE8TvefvFBYHLtx9BU9J1GDusXdErsxJWG8fgQ7O3s+ITuHazm7j84WvQY3mruzNMs8xV8juyx8ury6Nqw7V+jwvPDHODwOIKk7UrmYvK4Vd7y7GTk8YTL8vNiWXjz6l3W8NGGoPLjZ0DxX4C68pEU6O62wWbtutC084l7ZujtnKrwGP9w8O2eqvKS/iDw2THc8hmcYuzElYbvM7/e6BNadvAzDzTzyJJS8PMzHO4qvwrvwRag8WD0KvIJEIzyDK9G7FKSau7hb4bpNFJO8RhbTPC+4ATxBcU278q7mu4HCkryNeX28GGYTvS9CVDpvEQk87+SrvJKYUTxdZCC7E0c/PKCo9jvUzKM8lHOcu0sxhjy6Os08bNGgvIMjD7yQL5M8X8k9PGmNl7xLNac8j1Anu2xTMbucWAo8UNosvHH0lbw3qVI71MgCOwY/XDvRiBq7JXIXPDkO8DxSuZg8JXIXPJe3JbzKCMq8EInnPKeBAbse7iW8nNoauiV+erxfS048o2rvu3YXi7tzVZK7xmflvEYadLyKr0I6Stxsux5slTstVwW8UN7NvJT97rp9p9+8X81eO5AvEztYwzu8L0JUuy/AwzkyBE08brjOujzQ6DtsTxC7nNoavI/StzpNHFW8J9tVvCfTE7xSOyk9cfQVPDkCDTwvvCK8EP8UvJKQD710OJ+8bja+uWcsGzp7xNI7bxWqPP3PGzsCcYA8LmNoukaQITzHRlG8+KymvDGjUDr88C+8j9K3PMkt/7uCzvW8+S43O7wd2jsTxa4898kZOxhu1Tsaz1G83LERu/fJmbxTnKW8O+k6O6RFOjzeEo48lVKIvI9MhrvwRSg8v9uxO7WNhTvCocu8dDgfO4drubxSP8o8q81MvCI20DtcAyQ8JXa4vIqvwjxhqCm8gN+FPIBt+TyU+U08E8GNOzRdB7ovQtS7284Eu9TUZTyXPde5gyOPOnlbFDyU+U28ZOyyvIuKjbzcL4G6jBTgvG8VqrtDyoc7ll7rPG46XzwYZhO9XIlVvEHz3bxNHNU747cTPAcap7zEfBa7rbBZvCMRmztlSQ48NkS1vAect7oxHZ88X81ePI15/bqjZs48LmNoPvMDALyZGKI7X83ePDEl4Tz6EUQ8ARQlPDtnKruhCfM7ZGYBPNEOTLxYPQq8aQuHvMqCmDtQWJw7wEBPPHF2prw2TPe84H/tvH5+ibyU+c07x8CfvDpjibyQM7S87+hMPPXqrTsNx268+g0ju6Co9jx4fKi6Q1h7vLHLjLvUSpM7gsazPKailbz88C+8P4ofPdESbTzM7/c8SdAJu4blh7wYZpO8NF2Hu9cQrTueR3o7ygQpPOq9lbveEg69M4bdO/qX9TyfIsW7XeKPPIBpWDw2TPc8usB+PLHPrbyuj8U8njuXPOsiM7z8bh+8MgAsuww9HD2V2Lm76OLKPMA4jbwVKky7Z64rvY/Olrv4qIW60RJtvLWRprzXjhy7H3TXu/dPy7k1QJS8YSo6vNYxQTxGFtM7stPOPDOG3TzRiJq8TZICvD8ID7wYcva8y477vAeYFr3MZSU8NsIkvLZwErxsT5C872IbPGryNLzoXBk60RJtPCk8UjwvuAE8piQmPBsojDzOysK77+QrvOhk27uAYZY86TsFPIZnGLt5W5S8Zk0vPBjkArwfdFc88ixWO8C+vrthMvy8nbmGvBPJTzuXv+c7ZlXxvKeBATywbrG8QI5AudTMoztToEa87+jMumv2VbzF5VS8j9I3PMA4jTl52YO8yoa5u3CbWzzlomI8ez4hvXwdjTq27oE7EurjPJR3PTwf8kY7IFdkPFv/gjtangY7stdvu4WEi7sBkpQ7m4FgvENUWjzREm28vXo1vDW+A71s1cE8cQD5vHs6ALwBEAQ7TnUPvXNZMzvWs1G8/zAYvMqGOT0yfhu7KpUMvIMnsLw5DvA7TRzVupezhLwGvcs7h+3JPK6HA7ymJCa9J9/2vP1RLL4iuGA899FbPAY3mrzv7G08scuMOyBTQzwXEXo8L0JUOweYFjzyrua6J1WkvF/R/7vh1Aa92W0IvNESbbwisB68ldi5OmpwJD3ZbYg8pqY2PV9DDLwtVwU8ZGqiu3tG4zrv6Ey8tZXHO8qCGD2uFXc6a3TFvMdGUbywbrG8e7wQPUnQiTwgV+Q8vJvJuzxKNztk6BG9tu4BvPdLqjyXPdc84dQGPEHzXTyojWS8ldi5vHrl5rsOIKk840FmufzsjjxLOUi8bxUqPGXLnruPzha7hQYcOLbuAT36i5I8ujKLux2JiDxBaQu7Fgk4vIhGBLzKilq8gsazu0rYS7zo2gi8EP8UO7UXWLz/tsk7TZ5lvDcnwjyb/0+8GygMvTzIJrx7vBC9cfSVO6XLazsHmBa9CX/EPBjkgjkygjy8szhsvOhofDzPKz88/VEsPLLTzrse7iU8Rg4RvCBLATy3+uS8tnSzvBD/lDzAPK68GtPyuwn9s7wqG747J1GDPBs07zv/NLk8xAJIvHgCWrz1bL64Mn6bPKPgnLxSwVo7Dp4YPXnZg7yN76o8xVsCPCz2CD3FX6O8xVsCvBD/lDvJKd48o+CcPO1/jjyH8eo89Widu7M4bLzXDAy7yoKYu49QJz1s2WI8/64HvZ8aAzwygjy7+pd1OrOumb21mei8VfkAO1/RfzwZSSA8GccPPWcsm7tAkuE7euXmudJrJzxGDpE7eIRqvKPkvTuITsa7U5gEPRhqtLwbKIw87+SrvLLX77vKAIg8/zQ5u9GIGrxhqCk8cXKFvBCBpbzm+xw8cQB5vEs96TzHPo87rg21u6THyryAadi87X8Ou66HA7zWMcE5kC+TPM+lDb1GlEI8CKBYPATavrz9Uaw8Br1LPGIFBbzHPg+9/PAvuzOGXTxmVXE7Nx8APfoJAjwMv6y8cQB5vMC6Hb1Vg9O88MtZPB0PujtQ3k27q8WKPI113DyG5Ye7ol6MO9JnBjxwm1s7urQbva4R1jz6j7O7kC8TPKRFOrzHwJ88bjrfPKPkvTmcWIq8v9uxPFBYHLwJAdU898kZvZkYojwMuwu8hYisvOb7HDzoaHw8sHbzvIWIrLyKLTK7KpktvIwQvzxNlqM8u5OHu7/bsTvU0ES86j8mvQY3Grwe7qU8+pd1PEaMALxsT5A7+o+zPK6Hg7pnssy6wEDPPFqmyDxC9/68gyOPvAL3sb2FkO48O2vLu94Sjrwqma08EeZCO9ESbTzv7G28YocVvEW5d7vJo6y8ARjGuhYNWbxJUpo81NDEvF9LzrvhVhc9Kp3OPJ5Hersn17S6lVYpOgtaj7yoiUO8euVmO5xYCrxDygc8V9wNve7girsotiA7C2ZyvHF2JjvhVhe9ZOyyu+rJ+Dx2I+47xALIu+WaIDrvZrw81quPvD8IjzxV+QC92W2IvFqipzwiMi88jXn9uzVAlLldZCA7C2ZyOpT5zTz31Xw8XAvmO1qipzzwx7i8BkN9u9cMjLwdiYi8CKR5vGe2bbkdiYi7Pi1Evfk2+Txaoie8C1oPPYWMzbtiBQU7ygQpO/z4cbxuOt+7Pi3Eu2EuW7yLig27qI1kvPKiAzzju7Q88U3qPOB/bTp0PEC8lzm2PKRBGb3RiBo9HuoEPSX0Jzx9p9+8rhHWOmGsyjx9IS48LuHXuO2DrztYRUy7+CqWO/MHIb1nriu8vYJ3OydVpDyrxQo821CVO8Kl7LvvYps6tZGmPILKVDznA188oQlzPBaLyLskGV07A33juhHioblGEjK80RLtvKNmTjzelJ47xV8jOwvcnzwY7ES72ft7PFv/Ar0t2RW7mSDkPFBYnDuG5Qe9YKQIPffJGbxXXh48LALsPDkCjbw8xAU8ol6MumxTsTuRN1W8ARznPHFyBbx5X7U8ZGaBuruXqLvMaca8SVKaur/bsbnlomI7cBlLPKvNTLxUJng9ARAEPDGbjrt+CFw8WqppPJzamjyohaI8iEolPJR3Pbx4hOq8hmeYu2RqIjwvuIG8p4EBvRNL4LuNddy76yKzvGeqiry1E7e8j9bYPF1koDyAbXk8bNGgPEW11jvgc4q8MSVhvOB/7TvNRJE7ygCIvJTxC71K3Ow8hYzNu7uXqLxOdY+83C8BO0aMgDsjEZu7UFicu02SArx9IS48cBnLPKTDqTsWCbi88U3qvKNiLTtaIJc8EurjvIWIrLtSwdq8", } ], "model": "text-embedding-ada-002-v2", @@ -448,16 +590,18 @@ "12833": [ { "content-type": "application/json", - "openai-organization": "new-relic-nkmd8b", - "openai-processing-ms": "26", + "openai-model": "text-embedding-ada-002-v2", + "openai-organization": "user-rk8wq9voijy9sejrncvgi0iw", + "openai-processing-ms": "116", + "openai-project": "proj_0Wv6taeZjWf793P67JMswYY3", "openai-version": "2020-10-01", - "x-ratelimit-limit-requests": "3000", - "x-ratelimit-limit-tokens": "1000000", - "x-ratelimit-remaining-requests": "2999", - "x-ratelimit-remaining-tokens": "999994", - "x-ratelimit-reset-requests": "20ms", + "x-ratelimit-limit-requests": "10000", + "x-ratelimit-limit-tokens": "10000000", + "x-ratelimit-remaining-requests": "9999", + "x-ratelimit-remaining-tokens": "9999995", + "x-ratelimit-reset-requests": "6ms", "x-ratelimit-reset-tokens": "0s", - "x-request-id": "d5d71019880e25a94de58b927045a202", + "x-request-id": "req_92ab81c1ce20420591176c5507d7e04e", }, 200, { @@ -466,7 +610,7 @@ { "object": "embedding", "index": 0, - "embedding": "d4ypOv2yiTxi17k673XCuxSAAb2qjsg8jxGuvNoQ1bs0Xby8L/2bvIAk6TxKUjU8L3UfvLozmrxa94a7e8TIvIoBED0Cw6c44Ih9PKFGi7wb6LC76DWUvFUqfjvmzQm8dAwXvOqNpbxEsgs8JhB8vHiksTv9sgk6ZX9Nu+aliLrQiA688+VbvI7Bqzvh2H+8IQBevICEZLyiDpE8jpmqvFw3ED0lIPU7f+RfPNVgMrxoJ+G8kyHMO6hOvzuKAZC8Yb+xvIoBkDwK89w8L3UfPGX30LyxHnm8znAGvHOUEzuyvn28v7u7PLmTFbz8moG8wSNGu2SPxrvnvZC8fIzOPPJFV7mh5o+76f0Zu7K+/bc2Zcu7oB6KPKxGVTyo/jw8/toKvM/oiTvdGGQ8a6fzO8VbZTt4fLC79RXsuwwj7bpPitQ86hUivVvnDb0zbbU8eFQvPfPlWzv2BXO8/8qRPPC1S7zg6Pi8etTBO9TArTyI+QC8Lb0SPSCYU7w6/WU8DmP2O0/a1jsJ29Q7/WKHvAC7mLvFu2C850WNO2aX1TrOqIC7GnAtu6hOv7o77Ww7L02ePM+Yh7tffyg7Mh0zPQRTMzwXyBm9FRCNu6tWTrwsLQc86DWUvL+7u7sGM8G8rp5mOwWTvDwlcPc7xGvevOb1ijsr3QQ81ni6vJsBf7wioGI8Ok3oumX30Dyhlo27eoS/O6UGp7rQ2JC8JDDuPINU+bxQyt08irGNu94Ia7wxjSc7bDf/PEXylDvO+IK8AUukujIdMzwxLaw84dh/vNfwvbvtDTg4LR2OPMW7YDt9fNU8Y3e+Ozld4TwHI8g81ti1u7vTHj30dec7GzgzvARTMzyNqSM8x5tuPJZR3Lw3pVQ6QzoIPXcErTwBSyQ7OM1VPD3Nerx4HLW8XheePNPQJr0l0PI7lDnUOtx437p8ZM08fzRiPNmoyrwt9Qy9c2ySvNqYUTwrBYY7703BPJUB2juPES47faRWPEYKHbzcKN08MMWhvKQ+oTts5/w8A4stPUmKr7p4VC+/VSr+u45xKTyT+cq6lqHePDgd2Duv7mi6ThLRPFkHADscULs8lMFQvJjR7jwu5ZO75d0CvO/FRDp3LK67DCNtO2M/xLtbD4+8mrF8u9TALb339fk6BZO8uzOVNjwYQB08k0nNuuoVojzO0IG8ZN/IvGoHbzwH+8a8g/T9OwLrqDzBw0o8xVtlPedtjjzQiA68MkU0POz1r7xF8hQ9IqBiO5sBf7zszS68FKgCvTDFITygfoW8ixkYPHVMILxqB288rp7mu4yRmzwhAF68PI3xO71jKjy/a7m7sR75OkXKkzyXQeO7JsD5uxtgNDyoTr+3JSB1PDPlOLxod+O7L02evKsuTTz9EoW8JhB8vGq3bDyU6VE6l0FjvDM1uzsKQ9+8dUygu0yCRTxbl4s8HfA/vKXeJbzrLSo8XP+VPGun8zzJe/y6lQFavKNOGr1+9Ng8uKMOvVvnDb13BC27751DO4F0azwc2Lc8XU+YPKFGC7zvdUK86j0jPHFkA7xCcgK9HrjFPIIEdzuKAZC8UbpkPB2gPbxnh1w8qCY+PNF4FbsjkOm7iRGJvNMwIj3XGL88r+5ovCylijuf3oC8Md2pvBQghjwOY3Y8IWDZvJKBxzzQ2JA8HFC7PP56j7yoJr48FrCRPGOfPzxcrxO8r47tO00iSjxHWp+8BMu2vOiFFr2o/ry7ZufXPHV0IbxSWuk7iHEEu0xaRDyUOVQ8qy7NPI5xKbtz9A45ny6DuvF9Ubyj/he87xVHvAuT4Ttej6E8vJukvLw7KbxHqiG8eKQxu2S3x7rsHbG7T4rUOzaNTLzg6Pg69lV1OSGw27xFQpe7ZufXu/KV2buVsde82FjIO3OUEz270x68/8qRPFlXgrpet6K8qj7GOqv2UjyQAbW7iomMvDkNXzzCY8+8Bbs9vHRcGbwyfa47572QPFPqdLxzRJG8/lKOOnt0xrw17cc7TjpSOujVmDtcX5E8cWQDPTSFvbsDsy49i6GUPNZQubz9ioi66u2gPJEZvTz3RXy8CStXO9LgH7ykjqO8fOzJO44hpzu7gxw8RcoTPJWJVjyKsQ08rv5hPNgIRrx2FCY7FtiSu9kgTjxffyi8kjHFPERSkDy3OwS7aHfjvL0Dr7ulfiq7AAubPNLgHzw5Dd85RmoYOwszZry7gxw70uCfPLJuezy3swc76f0ZvOZVBrxsN3887EWyPFw3ED27qx28IqDivAAzHLwHS0k8qIY5PNLgH7yaEXg8M201vMJjzzwy9bG796X3PB2gPbznHYy7XU8YPF8vpjyISQO9dISaPMjbdzwDY6w8vqMzPHS8FDzRGBo9RfKUvL+TOjwe4Ea8HHg8vDr9ZTx2xKO8U0pwvAhj0Ts6/eU8kWk/Peu1pjwkgPC7Wh+IuustKjxc/xW8B5vLu2kX6Dt4fDC6p+a0vCsFhrz1Fey8DXNvvPiVfjylBqe8CBPPPFp/Azz96gO7iZkFPGRnxbuT0cm6uuOXvPVlbrzJK3o8HNi3PHG0hbw9HX2835j2vNUQMLoa+Km8ZafOu70rsLvSkB08VIp5PGGHN7zRyBe8BoNDPBWYiTz0JeW7fQRSu9OoJTxGapi7c/SOu/1ih7wFG7m8iEkDPHzsybuqPsa66A0TvRnQqDt0XBm8u6udPPQlZTwH08W8ps4svAszZrrEy1k8Q8KEvKy+WDq7IyE9lqFeO5ChOTwtvZK8ZLdHvNvYWrwPo389A2OsOwlT2LtZB4A818i8urdjBT1FohK829javJgx6rp6NL28oyaZvKcOtjkFazu7vJukPLwTKDwiUGC8oPaIOgNjrLppZ+q7RaKSO5EZvbxlH9I7kHm4Ow+jfzvQsA88a0d4vLq7lrs5vdw7t7OHPIvJlbyDpPs6jkkoPKOeHDsiUOC7M+U4PApD3zxs53w6XheePDa1zbrmpYi8sR55PKYerzzamFG8XDeQvNTALTyg9oi8sH50vAfTRTwB06C81EiqugdzSjx8FEu87B2xvGpXcbwt9Yy8lOlRPIAk6buVAVq8eFSvvIzhnbwtbZC84Oj4vKiGuTuwfnS7NK2+vAWTPL07Pe+8iPmAvJP5yrxFyhM8v7u7vHG0hbyrfs+8SbKwOw4T9DzdaGY8lWHVu4kRibwEyza7cYyEu0YyHjwCmya8L50gPIk5CjuZIfG77TU5PLybJDy7gxy8PI1xvMTL2TyirpU8a6dzPPGlUjxc15S8uNsIvEXylDz/QpW7CDtQvP2yiby+8zW7XIeSu6AeirxzlBO8UHrbvHucRzzRUJQ7i8mVu8fr8DwdyD68zziMvPOF4DyNMSC8qP48PKFGC7xHWh88z8CIPAC7mDyIIQI9gcRtu5Wx17yW8eC6fSzTvKKGlDw2Fck8XXcZvFkvgTzXGD88ddScu6t+T7pRCme85Y2AvPC1yzsaICu85qWIvBrAr7xyzA283HhfvJLhwjxhXza8RaKSu41ZobwXeBc8oW4MvEdan7xqV/G8ApsmvWtH+LsGC8A87B2xPNjgxDt3jCm8DCPtutIIIbyu/uE7CkPfO5ZR3LwPo387572QPBfImTxrp3M8HFC7PGjHZbrgOHs8vYsrvBWYCTwcADm8yXt8vF0nl7xn11687iXAPO79vjyPOa882fhMPDgdWLj+eg882hBVuerFnzvzNd676hUivC1FD7yu/mG5/MICPHr8QrynDja7zzgMPAVDOryorjo7IBBXOwcjSDynvjO8pd4lPRogK7yqZsc70gghOz3NertLur+8j7EyvNHIlzxdTxg8IEjRPP/KkTwLM2Y8ejQ9vJfh57vxzVO8U5ryPJQR0zqYMeq7pLaku6iGObxZBwC86j0jvM8Qi7ytXl28TyrZO3m8ObxsN/+71TixPPQl5bwKQ9+8iWELvF4/n7wurRk9LR2OO2eH3Dzn5ZE8FTgOPKG+DrsC6yg8C5PhuncsLrzt5bY8wotQPKpmR7o6/WW8l0FjPHFkAzzQiI68GYCmvNJonLuTcc48Xy+mO/BlybugHoo8ufOQvDa1zTzrBak7yNv3u3mUOLzxBc67WqeEvIsZGDyD9H28pm6xOw8D+zymbjE8nwYCvDjN1Tov1Rq7qcZCu/PlW7z1xek88vXUvH804jvtvbU7z+iJPJGRwLy9KzA89WXuO3FkgzyqPka8B9PFvJ/eALzsHbG4L/0bPKxGVTxH0iI8llHcvHMcELtrp/O7q6bQPDTVv7vI23e7pm6xvHskRLuwfvS8GagnvUaSGbzSkB081CCpu8W7YL2A1Ga8I0BnPPiVfruj/pc8IqDiuxwoujtypIw88kXXu/4qjbqISQO8o3abPAM7q7yCZHK7/8qRu8VbZbyTqcg7NP3Auwvj47yNMSA7UQpnPEmysDywLnI7uFOMOzkNXzwu5ZM8lJnPu+stqjszvbe8i8kVPdjgxLuOcSk8GiCru3KkDLu264E7cnyLvAkD1rsBgx48fXzVvEk6rTv/GpQ7/gIMO76jMzufBgK7COvNvNSYLLy2w4C8dAyXPL6jszt8PMy8lWFVPAFLpDsxtag8L3UfPNaguzqUOdS8MS2svJ8ug7rFW+W8o8YdPIsZGDwj8OQ8ujMaO3e0KrtLQry89NViu/56D72fBoK7koFHu7eLhro17Uc8vQMvPF4XHjvrBSk9wUvHugHToDwMg+i8NU3DOzud6jznRY28fvTYO0OKCrwHS8m8DcNxvEOKijwHI0i8WVcCvTBlpjyN+SU8qP48u14/n7zUSCq8lqHeuja1TTzFu2A8X38ovF8HpbzTMCK7eqxAvFr3hjvTMCK7GBgcu4NUebwA45k8HaA9vFlXArzO+II8mNHuvNx4Xzxx3IY7q6ZQvKfmtDzFW2W8HgjIO1Xae7xzRJE884XgvKNOmjy7gxw49HVnvP5SjrwYaB685lWGvBnQqLx11By7XScXvY6ZqrkC66i8grT0POgNkzulfqq8kZFAvJjR7ruhRgu8HWjDPNQgqbxdn5o53CjdvMg7czxpZ+o8ddScvP5SjrzvnUM8xvtpu+iFFjwKQ988r+5oPqBWhLzPOIw6FKgCPfZVdTw7PW+8kAE1PfC1y7svTR67LW2QPGBHrrybAX+8A7OuvIwJHzzQsI88DwN7u4npB72JwQa8iTkKveXdAr1kB0q71RCwuxbYkrugfoW8AsOnPKj+vDrDA9S4YG8vPCylijyYMWo79RXsvATLtrwc2Lc8DCPtPH0EUjpxPAI8S7q/PP0SBTyvjm08O51qPLc7hDtMqkY8ixkYvIyRm7yUOVQ8z+iJPLbrATysvli8SYovPCQw7jytXl28SdqxOxWYCT1blws9S5I+vPyagTxsN3+7k9HJulqnhLsLM+Y6qNa7uy/9Gz2sHlQ85QWEPAg7ULynvjM8alfxvCAQVzqX4Wc88+XbOhXACrvqjSU8pm4xO7w7Kbymziy9CQNWvIpRkjzp/Rk8F1AWPS4NFT1Uivm7ilGSOjIdMzxff6i8qt5KvLoLGb1etyI8pBagPNmAybxgHy27rp7mO1rPBbwGW0I8LyUdPBxQuzx4VC8806glPKGWjTwtHY68XXcZO99I9LzoXRW8RgodvBSogjtIEqy8No1Mu0bim7sbELI8FKiCO30E0ryTqUi8JSB1vE0iSjyL8Ra81/C9O9jgxLsUSAc8cRQBO7ijjrqR8Ts7ZC9LuwBbHTx93FC7CzPmPExaxDunXri8ZR/SuhzYN7z2BXM7OB3YvJoReDyJmQU7xvvpPHh8sLtkB0o7rQ5bPKS2JLtRuuQ8IWDZvMDTwzu4e408l5FlvCx9CbyjTho8tzuEvEaSGb0c2Lc7itmOvCEA3ryVYVW8/YoIvaP+l7xaH4i4W5cLuwCTlzwGq0Q7ztABvTT9wLt8FMs3XU+YPP2KCLxyzI076U0cPFkHgLzrVau80RiavEiaKL5b5w0909Cmu19/qLy6u5Y87b01PLybpDzb2Fo88GXJvOA4e7qMuZw8IlDgvNIIobx7TMW8RNoMvFXae7xjx0C8cgQIPDzdcz1D6gU8icGGPJNxzrwNw3E8gcRtvMTLWTtQyl28N6VUO8/oCT3u/b68mNFuOzNttbxOEtE79gVzOkJyAjyOwau75lWGu9doQTuNWaG8NwVQvLezhzxff6g8HRhBPJWJ1juNWaG8iZkFusW74LvEG1w8txODPKVWKT0USIe72ajKPGjH5bynXjg87M2uPK5O5LqDpHs8GnAtvFrPhTzeWG28Yk89PC29EjxZL4G8BoPDPHrUwbs0hb268h3WOqy+WDuM4R08SdoxvEtCPDxTmvK7FtgSvdx4Xzv0dee8x0tsPEoqNDy8myS9LjWWPDV1xLygfgW8TsLOu+wdsTozlba8vJskvAEjo7xKojc8mDHqOwEjozsw7SK8SYqvvNn4zDxkB0q8Siq0vDa1zbvEG9w7vHMjPAfTxTtsN/85a/f1uzgd2DvgiP07CQNWvDzdczxDEgc8IMBUPMMD1DuPYTA8jumsPB4wybtkL8s6rQ5bvGTfyDwCm6Y8Q+oFPSJQ4LsAkxc8Ok1ovIP0fbygzoc8QxKHO7ezBz3eqO+56A0TvdU4Mbu4e4271qA7u5HJur3WKDi8dsQjO58ugzsypS88ursWPXWsG7upFsU8pS4oPNYouDtiT728ciwJvFvnjbxaHwi8FmCPPP4CjLyyvn08Vdr7vB+ozLxk38g896V3vI7Bq7wDAzE72LjDvGRnxbv3RXw76XWdvI2BIjwIE888AnOlOeCIfby9iyu8AwMxPMEjRrxgz6q7qNa7t4yRG70rPYA8dfwdPIj5AL0f0E08IEjRu9x4Xzv2tfC85qUIPC8lnTsDi628tusBPMnLfrxPKtm6icEGvUQCjryv7ui8ufOQO9WIszzgiP264Oj4O0tCvDu9s6y7dUwgvKiuurmqBsy7Snq2vO1tszzltYG7u6udO6SOo7wmYP47L3WfO68+a7v/8hK8S/I5PbdjBTzwjUo8f+TfvHVMoLs3fdO8C+PjvBs4MzyWoV677KUtvAGrn7yJEYm7gcTtu3lENrsrBYY8N1VSu4tBGTscALm7wuvLvLcTAzyjxp08aCfhupqxfDzWALc7pLaktxNYgLzEy1m70NgQPbzrpjvZqEq8t4sGvJdBY72QUbc8Ms2wvDXtx7yBdGs7l0FjvCTga7v8woK7icGGvDJFtLt3LK47MMUhvAH7oTtx3IY7dmQove9NQTxKKjQ9MS0sPMITTTwIi1I8D6N/vK/uaLxcXxE8M221PN0Y5DtnN9o6O53qvDLNsDzHS2w7UvrtvNZ4ujzFW+W8jOEdPCAQ1zywLnK8cqQMPL/jPDt1rBs9clSKvBs4M7mihpS8uCuLvOdtjjx6rMC5DCNtvEQqjzinXri56F0VO+rtID2lLqg7FXAIvFz/lTxOElG87PWvu0PChDqMaZq8fBRLvGtH+Dum9q060LAPvSBIUT23iwY8vWOqPNAoEzxg96s7LZWRO9fIPLzQiA68krnBu1rPBb0szYu8MzW7ux8gULxc15Q7LfWMPJ/egDxzlBM7YJcwO4kRCb3mzYk8Y+/BPNT4pzwjkGm8ojaSPBgYHD0PA3s8RAIOu87QgbtN0se6TOJAPJkh8bz+Agy72ahKvP/KET3mVQa6Bbu9u8iLdTt7xMg4W5eLPBQghjxfL6Y3ZafOOVJaabyMCZ+8GTAkvEPCBLyJEYm850UNvakWRTx11Bw9ob4OPHcErTvdGOQ8H9BNO3VMoLxUOne7NwVQPJWxV7wBqx+9uAMKPQZbwjrBm8k8Q8IEPeA4+7wZgKY8xvvpOzBlJjm4ow68UbrkOzhtWrw2Zcu7W2+KPIvxlrz0dWe8ulsbvMRr3rrXyDy8JDDuPFlXAjvceF89igGQOgmz07sv1Zo8fkRbPI7BqzyaYfo8kUE+Otx437xrR/i7o/6XPP8aFDy+ozO8arfsvEVCl7wX8Bq7FoiQvBfwmrn/8pK7AnOlPBWYiTweMMk7ASOjPFxfkbssfYm8qCY+uwSjNTxSWmk87M2uu/9CFb2nlrI8DCPtu9oQ1bySgce5gcRtPBhAHbvmVYa8FEiHO/4CDDzUcCu7zvgCu/OF4Lxdx5u8kllGvU0iSjvPmIc80VAUvAvjYzy5a5S7", + "embedding": "F6KrOqe0iTyCOMA60BG9u3g/Ar2Xusg8qf+svE442bvs9ry8me6avMr56DxICTQ8ndIcvNOqm7yCB4a78E3KvO4qDz2dXPk3xft9PMGniLxK+7S7UIaUvLdPeDtJsBG8E9gSvGCXprwDOgw82gp7vO91sjup/yw5HV5Fu9FCd7q3UhC8yJRcvB54rjvn4YC8rqFdvIhnZbyiQ5M8pBurvCjnDz0zK/E7f59hPFsmMLwKJ+C8QBnIO8stuzuXiY68XRixvLVgjzzma908wI0fPDm20Lwn5He8LVgGvDp0/zqITXy8CNy8PK79F7zp04G8Ym8+u1oMx7vYG5K82z7NPHglmbnyDpG7+XEIu2Rhv7jwTcq74nCKPBGKVzzJOzo8dM4LvKyYizu8TWM8foX4O5IvaTtDJbK7c1jou36F+Lp/LNY8c7QivSQDDr0UI7Y8r9UvPaD1Vzts9XC8aIeSPHvVSLzVJvm8uBC/O48MrjzS0gO8TpQTPT6aUrwT72M8DvH4O2FV1TueA9c7nuyFvCpMnLvwM2G8anmTO8pVIzvAF3y7fuEyuyXBvLq5zm072oCePO63g7tPbCs71YIzPUMlMjx6Fxq91raFu6GCTLz8Ywk8NKGUvEOYvbtrN8K8VYFnO2JvvjyITfw7dtfdvGYihju60QU8BPi6vDp0f7z0F2M8STruuuIU0DwASIu7WKe6O2Jvvrr0AJK8n9vuPNUm+bxc5N48waeIuwyMbLx8fCY7H6wAPaU1lDvS0oO8YxacuidAMjyFRKo8y/yAvIkOw7s1X0M4z1OOPI1LZzsRitc8/JTDOw4L4jwkNMg84y65u76bHj3k7Oc7k/AvvCVOMTywYiQ89nxvPMiU3LwrCks6wacIPYoorDxUUC0795ZYPPT9ebykjra8RD+bPJhhJr37YPE7EYrXOhud/rpM08w8+ftkPJyeyrwFLA29EeaRvHhWUzxt+Ig7gjjAPEVw1TtnbSk7zQVTPPRzHbzrT9885jqjvPRznTv44fs85q0uPdMdp7p1GS+/Maz7uy6jKTwbbMS6QvHfPDRF2jtgrne6ri7SPBjT5ToLzr08hJ1MvPZ87zzYG5K7Aqr/u84fPDo8T6+7RFZsO+OhxLuSpYy8JJCCu3InLr0ARfM6qmS5u1uZOzzYjh08GlLbuhwTojzn4YC8uIPKvPZ8bzx548e8cj7/O0uIqTwt/Es8+ftkPdFFjzy1YA+8sscwPF0YsbxSeBU9DIxsOwKqf7y+Diq8lxYDvZGLIzz1jYa84uMVPNiOHbwMjGw8UJ3lu2Akmzx21128Hhz0OzGVKjw33ri7w5kJO74okzyZkuC7YK73u9xYNjye7IW4Hhx0POcSO7y8TeO7EFmdvGqqTTyg3oa8T4N8vNPBbDyIZ2U6NqpmvHKauTtc5N68KFqbu8a8RDxX6Ys83r1CvPH0J7zYASk8qRmWPD3z9Dy/tQe7SVRXvLXTGr2eA9c8ChAPvc1hDb2Y1DG7AexQO1WBZzxUw7g8rAuXPIvPCbyjAUK8j5kiPM/gArxfTAO9kOTFPFICcjtEzI+8olpkPLYePrx21108sTo8PGp5E7vBMeW7agaIvFfPIj2cK78808FsvD32jDsinoG8wACrvIT5hjx+hXg895bYvCJCxzx9lo88BPi6PLVgj7y2Hr48E9iSPKMBQjwT2BK8NqrmO0AZSDy+m568h6m2vKwLF72vSLu795bYPHWmI7xVgec7QHUCu+l3Rzw+mlI811rLPMdjIrvMXvW1z/dTuotzT7ySGBi86XdHvEu54zvKVaM85jqjvHx8JrzMRyS8VrU5u4SD47pdGLG7oPXXO07FTbw98/Q6BCn1OOKH27yPJpe7EYrXu/eW2Lv3lti83MvBO6JDEz2gxB28L72SPKYkfboALqK8unXLOunqUjzCZbe7AzqMvCMaXzwb38+8PrQ7vCZoGrxDJbI7DAKQPHDZcrwR5pG8T4N8OqzJxbzBS847kMpcOipMnDv0AJI8mQgEPXd+u7s8Ty89wwyVPMk7urxB13a6Fy+gPJhHvTwxrHu8EYpXO1LrILxS66C846HEO7c4pztGMRw8Gq4VPJ4DVzwHHg48GlJbPJPWRrxnbSk78g6RuzuoUTwqvye8wtjCPLw2kjzdjAi7olrkvP+grbvmrS67KFqbPOFWITzrq5k5H5IXO7xNY7xn+h07irWgPLszejz0ABI7PWkYvHHcCrwbnX48I1ywPNQ3ED0vMB681kDivNOqG7y2kUk8yTs6PIbRHrwn5Hc82mY1vKdYzzwGd7C7mHj3POoEPLw99oy7bGsUPO8CpzyZCAS9f/ubPKFAezwxlao8h6k2PMX+FTyZ7ho9Gq6VvOoEPDxd/ke8RYo+vBjTZTyRi6O808FsvHtI1DtQneU888w/PXx8pjwO8fi7b+qJulJeLDz+yBW8vWfMu4hn5TsnQDK6u4+0vLbtg7zttOu8huhvvN7ufDwQzKi8yCHRPNLSAzxjMAW7oN4GPKjlw7ssJLS6jyaXvC9Hb7y7M3o83Fi2PIIHhrw1kH28YK73vN8IZrppX6q8AezQu5H+rrtJIx08nVx5PHKaObyW/Bm846FEPKe0iTxC8d+7MHtBu3qKJTySGJi7GLyUuzI8iLzEV7i8JoIDPB1exbvlk8W6Mq8TvSH3ozvtnRq8SxWePKJaZDwDa8a8I1wwvDkpXLrIlFw8KXSEvG+OTzocEyI9kMpcO7gQPzyeX5G8dP9FvDkpXLwCqn89HIatO6D117tUZ348unXLug+BBT2Zew+8i+bavDaq5rpffb28I3aZvDrQuTkbbES7P86kPJ1FKDxgyGC8JvWOOtd0tLq16uu7UIaUOwbqu7z3I807PrS7O8AXfDt4sg08blp9vKK2nru/zNg7v7WHPItClbxJOu467wInPO4qDzsCxOi7VrU5PAon4Dz8Y4k6oMSdPIccwroWV4i82gp7PFRQrTw5tlC8ChCPvPH0JzwYSYm8smt2vKjlQzz7SaC8iiisuueFRjzBS068BIWvvGItbbwhEY28Wn9SPH+f4btOOFm8PE+vvN1yn7zWKZG8Rrv4vHd+uzsO8Xi7mjm+vAjcPL3cifC8rxeBvF/wyLyBehE8Qaa8vPWNhrxxgNC81YKzOzgP8zyrImg8hgLZu43Birx5cDy7ZiKGu1TdITy3OCe8+VcfPHbADDvcifC7N944PNErJjzYjh28AEVzvE442TwAu5Y8UgJyPD6aUjw2k5W8v7UHvKJDkzyiQ5O7jmVQvIndiLx0jDq7bGuUuzYgirxvXRW8/HravFoMRzwYvJQ7rv2Xu9yJ8DyTYzu8Hx+MvLdp4TxNBx+8yy07PFfpC7xJIx083YyIPEJNmjwIqwI9VuZzu9m/17yb9+y669zTvFCGlDy4g8o8yuIXvD6DgTyhD0E8ZQiduwmDGrrBMWW8H6yAvN4wzjsXoiu8FleIvM6ssLysmAu81kBivOCvwzy9gTW8QtqOuzrqorxCTRo8b+oJvPtJoLw4D/O8RLImvcAX/LtKbsA805CyPF/wyDuFRCq8foX4usN/ILxx89s7RXDVO66h3bzZqIY78g6RPCZomjzhbXI8k2O7PNs+Tbre7nw8fO8xvBo7CjyOfzm8blp9vDt3l7w9DV68gjjAPPHavjx1Ga88xD1PPCH3IzhC2g48b12VuQmDmjtTHNu7MxQgvNYpEbyG0R65RVkEPIUqQbw+tDu7eLINPP0hOLzEVzg7qkpQOzw1RjyduDO8XqUlPRK+Kbxbmbs7BBIkO1RnfrucK7+8LCQ0vAmDmjyPJhc84hTQPEe+kDxQnWU8e2I9vFll6buGAlm8VubzPKXZ2To2qua7fm6nuwEGOrzL/AC8AC4ivI3BiryGAlm8OSncO69IO7zL/AC8CWmxPNok5Ly3aeG8MjwIvN9koLxeMho94nCKO3Hz2zwT2JI86zgOPJQKGbuv1S88BUPeuncLMLzeSrc84CJPPLRGJrrBMWW8R9VhPK8XATwkA4687RCmvBcvoLsw7sw86pGwO5yeyrs2IIo8SbCRvErhyzzVD6g7qwj/u/8TObyXLdS71MSEvO2dGjxyPn+8cieuO9oK+zwlTjE85+EAvHNY6DpzQRe7M/o2u3HzW7xzWOg87s7UvAVD3jsz+rY7cdyKPJ8dwLyT8C88L0fvO19MgzwZekO8IkLHvD6DAbyy4Zm4V1wXPNLpVDzHYyI8rqHdvLNuDrvhbfK75AbRPEWKvrtbynW7msayvOOhRLvMXvW8ZXsovYjDH7yG0R4805Cyu/AzYb3BMWW83whmPEJng7sHkZk8ZaziuymlvjuQs4s8G9/PuwwCkLpfTAO8RD+bPKYNrLxEVmy7BZ+Yu7AGarwgUMY77Pa8uxjT5byINis7O45oPHzvsTwn5Hc73f+TO+KHWzyGXpM8U6nPu1k0rzs17Le8qRkWPRSWwbsuoyk8VkKuu7DvGLtFWYQ7ym+MvGwP2rv7SSA8eFbTvHzvsTvi45U7/sgVO/NZNDtSAvK6SuHLvFk0L7xAdYK8V1yXPEYXsztmxsu8v8xYPC8wnjtnbak8irUgPN/XqzpeY9S8/a6svOMuObqIZ+W8auwePEQ/Gzy8TeM8ge0cO1JeLLuxOry8mR9Vu+4qD72UlHW7JDRIuz32jLrQhEg81YIzPIPfHTtIlig9FCO2um7QoDzK+ei8Y9TKOz9y6jx2wIy8rqHdOx0tC7wpGMq8vrJvvKqmijyekEu8lSQCve0QpjxGpCc8aV8qu0sVnrxpXyq82b/XuoSdTDz0F2M8XqUlvNErprzvAie7iQ5DvKqmijvhViG7/Tshu25afbyZ7po8mjk+vEB1ArzP4II83InwvMiUXDwwSoc7dmRSvIW3tTwY02W89THMO4Nperxjo5A8t2nhvLXTmjwchq04GNNlvJl7j7xq7B68MjyIvNgBqbw/Wxm7rAsXvac+Zrkuo6m8lJT1PHglmTsVsKq8Mm1CvB4c9LtX6Qu8UUTDPGV7qLwXLyA5AF/cvI+wczwHqOo8Z/qdvHqkjrxTNkQ8tepru48mFzwjGt88WWVpPrjfhLzVJnk6JJACPUufejyf22689ks1Pbp1y7tEsia7Y6OQPM6ssLzj0n68BIWvvDaTFTx9lo88STpuu6PQB70Rcwa84nAKvUVZBL2xrUe7Ul6su7pEkbvUxIS8uSqoPJo5vjqY1DE5ef0wPIvPiTyrImg7XknrvBcVt7yMjbg8n9vuPN7ufDrL/AA8vfTAPDBKBzwQcG48XklrPD6DgTvLoEY8yPAWvNacnLz3llg8cdyKPK8XATxoK1i8dRkvPGIt7TwFQ168Svu0O4ndCD3Kbww9vfRAvEB1gjze7ny7jn+5uk+DfLueA9c6uBC/u7fFGz3uzlQ87reDPOAiT7wQPzQ8GTjyvKhyODrFFWc8rqHdOvd/B7s/ziQ8New3O9/XK7xwNS29SVRXvCvZkDxgJBs8rAsXPTShFD0S1fq7mQiEOoepNjy5Kqi80IRIvLDvGL0j6SQ8p5qgPApBybxGFzO7nXbiO0k9BrzGvEQ8GiEhPFinujyW4jA8m1MnPLF8jTzPU468DHUbOz3z9LwvvRK8/TshvMxedTut466846FEu1fPorsnQLI83u58O0CM07yxrUe8eqF2vKN0TTzRuBq8TGDBO9CEyLulwgg8R0sFO32Wj7r3I007wthCuxwTIjzDsFq7iGflPFFEwzv/E7m8BUPeulHRN7xTHFs795bYvCMAdjyBehE76NDpPJrGsrt2ZFI7i+ZaPGKJJ7v+3+Y83aPZvEAZyDskA448t2lhvDkSC7w/Wxk8YzCFvAeRGb32S7U7Bx6OvOtP37woi1W8UBMJvXUzmLxepaW5bfgIu48mlzxOOFk7ze4BvRl6w7vrqxk5WU6YPBZXCLz71pQ7JmgaPMnff7z7vKu8sO+YvIFgKL6XiQ49Kr+nu6IpqrzI8JY8qmQ5PCjNpjw0RVo8YeLJvAM6jLoVPZ88s4XfvIq1oLwDa8a8s24OvPT9ebzzzD+84H4JPB4cdD35cQg8TiGIPKdYz7xs9XA82KVuvOtPXzuzhV+8dHJRO/xjCT24EL+8yJRcO0r7tLzp6tI7hINjOv3F/Tt1Ga+7ezGDu/iwQTurfqK8BdBSvEk9hjzTHac8ZGE/PKD11zsCIKO8jUvnuVWB57tx81s87MWCPKIpKj0kA46711rLPKc+5rzhPDg8BIWvPAqdA7udXHk8OGstvH8VhTzTwWy8eXA8PLw2EjxAdYK8/4bEPPyUw7s00s66AF/cOtokZDv9OyE8cDUtvEOYPTydXPm7hGwSvbnObTurIui808FsPA1NMzw/ziS9OIWWPG8bxLx/FQW8wUvOu4T5hjqMjbi8XqUlvMdjoryocjg8hujvO5GLozukqB+8r9WvvL9ZzTwPJUu83Fi2vA0zyrtsD9o7ylUjPH3HyTvGiwo6CQ33u0J+1DvaCvs7fyxWvLdPeDwRcwY8RXBVPKVmzjuaxjI8kf6uPKN0zbtZZek63aNZvO5byTyyVKU8utEFPQLE6LvI8BY8XklrvMnff7z1jYY87MWCO7+1Bz2Lzwm6L70SvXn9MLvbDZO7BPg6u+cSu73aZjW8mGEmO57shTsLWzI8ALsWPeB+CbsdXsU8T2wrPAjcvDsNwL68UBMJvHqkjrxmIga8RMyPPJSXjbzF+308iE38vNlMzLznhcY8ZJJ5vDV5rLwCky47xMrDvEfvyrskkII7LT6dvMdjIjwW+808R76QOYhNfLyKKCy8QyUyPMmuRbzfZKC7h6k2uJ3SHL0frIA8vpsePHRbAL38B088z/fTu2z1cDsVVPC8id0IPAx1mzvon6+8EXMGPJBAgLwKQcm6ST0GvQUsjbzK+ei81DeQO4W3tTxOONm6ZJL5O+MuuTtrUau7bN4fvLbtA7p548e72ma1vGTuszxLn3q7Qk2aO+Y6o7wJDfc7ZQidO5IvabtLohK8kXE6PW/qCTwDa0Y8ervfvCq/p7t2ZNK89BfjvKSONjyg9Ve74cksvEYxnLylwoi7gQTuu5hHPbuE+YY8hgJZuxcvIDuocri7SuHLvM3uATy+m548VYHnuhudfjwwCLY7pcKIN0B1gryXLVS78g4RPbJUpTtmxku8ZiIGvC3iYr3CZbc8QTOxvCYmybzih1s7f59hvERWbLsS1Xq7o9CHvAjcvLuaxrI7CfYlvFLroDvDmYk7uSoovd69QjwQPzQ9HnguPLp1SzysPFE8yd9/vOTsZ7wVyhM8wHO2PIhn5TuYR706z93qvDxPrzyNS2c7n9vuvAT4ujz+3+a8NgYhPC9h2Dxw2XK87ioPPDzCOjvwjxs9/lWKvMiU3LmlNZS8kLOLvF6/jjyfqrS5m/dsvOnq0rgAX1y45NUWOxcvID1UUK07oN4GvI00ljwD3lG8YAqyu4vPiTpCTZq8MO5MvLsz+juARr861DcQvef4UT0wSgc89OaoPHNBFzwO2qc7B5GZO+z2PLxohxK8lVW8uw+BBb3IfYu8Is+7u3ZkUryBepE7dsCMPAPHgDxwwiE7YoknO4vPCb0YSYk8TGDBPIFgqDzK+Wi8iFCUPNacHD0S1Xo8QOgNu3I+f7uUrt66uwJAPMd687xV9wq7i3NPvEuiEj3F+/25iQ7DuypjbTt87zE5AEiLPKDehjytcCM49TFMOSV/a7wvMJ68I+kkvPWNBryJ3Yi8zWENvW8bRDwqTBw90UUPPDOHqzuiWuQ8ObZQO6mMobx6oXa769xTPJkfVbyG0R69i88JPbc4pzqekMs87rcDPd7u/Lxiiac87bTrO+IUUDkKEA+8QvHfO/x6WrylZs67kqWMPOTVlrySL2m8XjIavOFt8roizzu8EHDuPHbADDvNeF49DAKQOtTb1bvwj5s8IxpfPPu8qzxLn/o8WgxHOnq737xPg/y7H5KXPPIOETxk7jO8fCDsvD1pmLzFcSG7m22QvNsNk7kR5pG7tEamPDQuiTzzzL87kYujPA70kLvdjIi8XRgxu/ZLNTwMjGw87IOxu1J4Fb25nbM8AsTou9Lp1Lx5cDy52KVuPB+SF7toFIe84H6JOzYgCjy0Ria7lJT1up124rzwj5u854VGvVM2RDv5cYg8H5IXvNZAYjzf8ZS7", } ], "model": "text-embedding-ada-002-v2", @@ -477,7 +621,7 @@ @pytest.fixture(scope="session") -def simple_get(openai_version, extract_shortened_prompt): +def simple_get(): def _simple_get(self): content_len = int(self.headers.get("content-length")) content = json.loads(self.rfile.read(content_len).decode("utf-8")) @@ -496,7 +640,7 @@ def _simple_get(self): mocked_responses = STREAMED_RESPONSES_V1 for k, v in mocked_responses.items(): - if prompt.startswith(k): + if prompt == k: headers, status_code, response = v break else: # If no matches found @@ -542,27 +686,15 @@ def __init__(self, handler=simple_get, port=None, *args, **kwargs): return _MockExternalOpenAIServer -@pytest.fixture(scope="session") -def extract_shortened_prompt(openai_version): - def _extract_shortened_prompt(content): - _input = content.get("input", None) - prompt = (_input and str(_input[0][0])) or content.get("messages")[0]["content"] - return prompt +def extract_shortened_prompt(content): + _input = content.get("input", None) + if _input: + return str(_input[0][0]) - return _extract_shortened_prompt - - -def get_openai_version(): - # Import OpenAI so that get package version can catpure the version from the - # system module. OpenAI does not have a package version in v0. - import openai - - return get_package_version_tuple("openai") - - -@pytest.fixture(scope="session") -def openai_version(): - return get_openai_version() + # Transform all input messages into a single prompt + messages = content.get("messages") + prompt = [f"{message['role']}: {message['content']}" for message in messages] + return " | ".join(prompt) if __name__ == "__main__": From ac2c776655cc815040613e071cd51b085f3ed0a0 Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Tue, 13 Jan 2026 15:33:57 -0800 Subject: [PATCH 063/124] Patch incorrect super() call in GeneratorProxy Co-authored-by: Uma Annamalai --- newrelic/common/llm_utils.py | 4 ++-- newrelic/hooks/external_botocore.py | 4 ++-- newrelic/hooks/mlmodel_openai.py | 4 ++-- tests/mlmodel_langchain/conftest.py | 2 +- tests/mlmodel_openai/conftest.py | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/newrelic/common/llm_utils.py b/newrelic/common/llm_utils.py index 624accd05c..4b3ec01076 100644 --- a/newrelic/common/llm_utils.py +++ b/newrelic/common/llm_utils.py @@ -54,7 +54,7 @@ def __next__(self): return return_val def close(self): - return super().close() + return self.__wrapped__.close() class AsyncGeneratorProxy(ObjectProxy): @@ -84,4 +84,4 @@ async def __anext__(self): return return_val async def aclose(self): - return await super().aclose() + return await self.__wrapped__.aclose() diff --git a/newrelic/hooks/external_botocore.py b/newrelic/hooks/external_botocore.py index 255fd4f225..78c23f7a0d 100644 --- a/newrelic/hooks/external_botocore.py +++ b/newrelic/hooks/external_botocore.py @@ -1070,7 +1070,7 @@ def __next__(self): return return_val def close(self): - return super().close() + return self.__wrapped__.close() class AsyncEventStreamWrapper(ObjectProxy): @@ -1108,7 +1108,7 @@ async def __anext__(self): return return_val async def aclose(self): - return await super().aclose() + return await self.__wrapped__.aclose() def handle_embedding_event(transaction, bedrock_attrs): diff --git a/newrelic/hooks/mlmodel_openai.py b/newrelic/hooks/mlmodel_openai.py index deb1ede35b..d6c3945bb1 100644 --- a/newrelic/hooks/mlmodel_openai.py +++ b/newrelic/hooks/mlmodel_openai.py @@ -762,7 +762,7 @@ def __next__(self): return return_val def close(self): - return super().close() + return self.__wrapped__.close() def _record_stream_chunk(self, return_val): @@ -872,7 +872,7 @@ async def __anext__(self): return return_val async def aclose(self): - return await super().aclose() + return await self.__wrapped__.aclose() def wrap_stream_iter_events_sync(wrapped, instance, args, kwargs): diff --git a/tests/mlmodel_langchain/conftest.py b/tests/mlmodel_langchain/conftest.py index 892baf7552..e42279422d 100644 --- a/tests/mlmodel_langchain/conftest.py +++ b/tests/mlmodel_langchain/conftest.py @@ -365,7 +365,7 @@ def __next__(self): raise def close(self): - return super().close() + return self.__wrapped__.close() return GeneratorProxy diff --git a/tests/mlmodel_openai/conftest.py b/tests/mlmodel_openai/conftest.py index 625459367b..ae3b2958db 100644 --- a/tests/mlmodel_openai/conftest.py +++ b/tests/mlmodel_openai/conftest.py @@ -318,7 +318,7 @@ def __next__(self): raise def close(self): - return super().close() + return self.__wrapped__.close() return GeneratorProxy From 0f672b25e5ebd495a2bc6b435616e34cc7ded440 Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Tue, 13 Jan 2026 15:59:12 -0800 Subject: [PATCH 064/124] Better entry point for agent exception testing --- tests/mlmodel_langchain/test_agents.py | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/tests/mlmodel_langchain/test_agents.py b/tests/mlmodel_langchain/test_agents.py index 5c836eb496..640a871c43 100644 --- a/tests/mlmodel_langchain/test_agents.py +++ b/tests/mlmodel_langchain/test_agents.py @@ -143,18 +143,11 @@ def test_agent_disabled_ai_monitoring_events(exercise_agent, create_agent_runnab @reset_core_stats_engine() def test_agent_execution_error(exercise_agent, create_agent_runnable, set_trace_info, method_name): # Add a wrapper to intentionally force an error in the Agent code - def _inject_exception(wrapped, instance, args, kwargs): + @transient_function_wrapper("langchain_openai.chat_models.base", "ChatOpenAI._get_request_payload") + def inject_exception(wrapped, instance, args, kwargs): raise ValueError("Oops") - inject_exception = transient_function_wrapper("langchain_core.callbacks.manager", "CallbackManager.on_chain_start")( - _inject_exception - ) - inject_exception_async = transient_function_wrapper( - "langchain_core.callbacks.manager", "AsyncCallbackManager.on_chain_start" - )(_inject_exception) - @inject_exception - @inject_exception_async @validate_transaction_error_event_count(1) @validate_error_trace_attributes(callable_name(ValueError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) @validate_custom_events(agent_recorded_event_error) From bca09c0d7bf4c003ecde27508befc1a874ecf58d Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Wed, 14 Jan 2026 15:00:09 -0800 Subject: [PATCH 065/124] Update AgentObjectProxy to include transform() methods Co-authored-by: Uma Annamalai --- newrelic/hooks/mlmodel_langchain.py | 76 ++++++++++++++++++++++++----- 1 file changed, 63 insertions(+), 13 deletions(-) diff --git a/newrelic/hooks/mlmodel_langchain.py b/newrelic/hooks/mlmodel_langchain.py index d5a6722a0c..2833a20f9f 100644 --- a/newrelic/hooks/mlmodel_langchain.py +++ b/newrelic/hooks/mlmodel_langchain.py @@ -220,11 +220,11 @@ def stream(self, *args, **kwargs): return_val = self.__wrapped__.stream(*args, **kwargs) return_val = GeneratorProxy( return_val, - on_stop_iteration=self.on_stop_iteration(ft, agent_event_dict), - on_error=self.on_error(ft, agent_event_dict, agent_id), + on_stop_iteration=self._nr_on_stop_iteration(ft, agent_event_dict), + on_error=self._nr_on_error(ft, agent_event_dict, agent_id), ) except Exception: - self.on_error(ft, agent_event_dict, agent_id)(transaction) + self._nr_on_error(ft, agent_event_dict, agent_id)(transaction) raise return return_val @@ -243,30 +243,80 @@ def astream(self, *args, **kwargs): return_val = self.__wrapped__.astream(*args, **kwargs) return_val = AsyncGeneratorProxy( return_val, - on_stop_iteration=self.on_stop_iteration(ft, agent_event_dict), - on_error=self.on_error(ft, agent_event_dict, agent_id), + on_stop_iteration=self._nr_on_stop_iteration(ft, agent_event_dict), + on_error=self._nr_on_error(ft, agent_event_dict, agent_id), ) except Exception: - self.on_error(ft, agent_event_dict, agent_id)(transaction) + self._nr_on_error(ft, agent_event_dict, agent_id)(transaction) raise return return_val - def on_stop_iteration(self, ft, agent_event_dict): + def transform(self, *args, **kwargs): + transaction = current_transaction() + + agent_name = getattr(transaction, "_nr_agent_name", "agent") + agent_id = str(uuid.uuid4()) + agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) + function_trace_name = f"stream/{agent_name}" + + ft = FunctionTrace(name=function_trace_name, group="Llm/agent/LangChain") + ft.__enter__() + try: + return_val = self.__wrapped__.transform(*args, **kwargs) + return_val = GeneratorProxy( + return_val, + on_stop_iteration=self._nr_on_stop_iteration(ft, agent_event_dict), + on_error=self._nr_on_error(ft, agent_event_dict, agent_id), + ) + except Exception: + self._nr_on_error(ft, agent_event_dict, agent_id)(transaction) + raise + + return return_val + + def atransform(self, *args, **kwargs): + transaction = current_transaction() + + agent_name = getattr(transaction, "_nr_agent_name", "agent") + agent_id = str(uuid.uuid4()) + agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) + function_trace_name = f"astream/{agent_name}" + + ft = FunctionTrace(name=function_trace_name, group="Llm/agent/LangChain") + ft.__enter__() + try: + return_val = self.__wrapped__.atransform(*args, **kwargs) + return_val = AsyncGeneratorProxy( + return_val, + on_stop_iteration=self._nr_on_stop_iteration(ft, agent_event_dict), + on_error=self._nr_on_error(ft, agent_event_dict, agent_id), + ) + except Exception: + self._nr_on_error(ft, agent_event_dict, agent_id)(transaction) + raise + + return return_val + + def _nr_on_stop_iteration(self, ft, agent_event_dict): def _on_stop_iteration(proxy, transaction): ft.__exit__(None, None, None) - agent_event_dict.update({"duration": ft.duration * 1000}) - transaction.record_custom_event("LlmAgent", agent_event_dict) + if agent_event_dict: + agent_event_dict.update({"duration": ft.duration * 1000}) + transaction.record_custom_event("LlmAgent", agent_event_dict) + agent_event_dict.clear() return _on_stop_iteration - def on_error(self, ft, agent_event_dict, agent_id): + def _nr_on_error(self, ft, agent_event_dict, agent_id): def _on_error(proxy, transaction): ft.notice_error(attributes={"agent_id": agent_id}) ft.__exit__(*sys.exc_info()) - # If we hit an exception, append the error attribute and duration from the exited function trace - agent_event_dict.update({"duration": ft.duration * 1000, "error": True}) - transaction.record_custom_event("LlmAgent", agent_event_dict) + if agent_event_dict: + # If we hit an exception, append the error attribute and duration from the exited function trace + agent_event_dict.update({"duration": ft.duration * 1000, "error": True}) + transaction.record_custom_event("LlmAgent", agent_event_dict) + agent_event_dict.clear() return _on_error From 447516fb341970a081d6308ea9597178bf5133bb Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Wed, 14 Jan 2026 15:08:35 -0800 Subject: [PATCH 066/124] Update event counts in RunnableSequence tests --- tests/mlmodel_langchain/test_agents.py | 12 ++++++------ tests/mlmodel_langchain/test_tools.py | 16 ++++++++-------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/tests/mlmodel_langchain/test_agents.py b/tests/mlmodel_langchain/test_agents.py index 640a871c43..e4641b8c0e 100644 --- a/tests/mlmodel_langchain/test_agents.py +++ b/tests/mlmodel_langchain/test_agents.py @@ -77,9 +77,9 @@ def add_exclamation(message: str) -> str: @reset_core_stats_engine() -def test_agent(exercise_agent, create_agent_runnable, set_trace_info, method_name): +def test_agent(exercise_agent, create_agent_runnable, set_trace_info, method_name, agent_runnable_type): @validate_custom_events(events_with_context_attrs(agent_recorded_event)) - @validate_custom_event_count(count=11) + @validate_custom_event_count(count=11 if agent_runnable_type != "RunnableSequence" else 14) @validate_transaction_metrics( "test_agent", scoped_metrics=[(f"Llm/agent/LangChain/{method_name}/my_agent", 1)], @@ -102,9 +102,9 @@ def _test(): @reset_core_stats_engine() @disabled_ai_monitoring_record_content_settings -def test_agent_no_content(exercise_agent, create_agent_runnable, set_trace_info, method_name): +def test_agent_no_content(exercise_agent, create_agent_runnable, set_trace_info, method_name, agent_runnable_type): @validate_custom_events(agent_recorded_event) - @validate_custom_event_count(count=11) + @validate_custom_event_count(count=11 if agent_runnable_type != "RunnableSequence" else 14) @validate_transaction_metrics( "test_agent_no_content", scoped_metrics=[(f"Llm/agent/LangChain/{method_name}/my_agent", 1)], @@ -141,7 +141,7 @@ def test_agent_disabled_ai_monitoring_events(exercise_agent, create_agent_runnab @reset_core_stats_engine() -def test_agent_execution_error(exercise_agent, create_agent_runnable, set_trace_info, method_name): +def test_agent_execution_error(exercise_agent, create_agent_runnable, set_trace_info, method_name, agent_runnable_type): # Add a wrapper to intentionally force an error in the Agent code @transient_function_wrapper("langchain_openai.chat_models.base", "ChatOpenAI._get_request_payload") def inject_exception(wrapped, instance, args, kwargs): @@ -151,7 +151,7 @@ def inject_exception(wrapped, instance, args, kwargs): @validate_transaction_error_event_count(1) @validate_error_trace_attributes(callable_name(ValueError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) @validate_custom_events(agent_recorded_event_error) - @validate_custom_event_count(count=1) + @validate_custom_event_count(count=1 if agent_runnable_type != "RunnableSequence" else 3) @validate_transaction_metrics( "test_agent_execution_error", scoped_metrics=[(f"Llm/agent/LangChain/{method_name}/my_agent", 1)], diff --git a/tests/mlmodel_langchain/test_tools.py b/tests/mlmodel_langchain/test_tools.py index d5e4774d5f..e5fd466803 100644 --- a/tests/mlmodel_langchain/test_tools.py +++ b/tests/mlmodel_langchain/test_tools.py @@ -96,9 +96,9 @@ @reset_core_stats_engine() -def test_tool(exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name): +def test_tool(exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name, agent_runnable_type): @validate_custom_events(events_with_context_attrs(tool_recorded_event)) - @validate_custom_event_count(count=11) + @validate_custom_event_count(count=11 if agent_runnable_type != "RunnableSequence" else 14) @validate_transaction_metrics( "test_tool", scoped_metrics=[(f"Llm/tool/LangChain/{tool_method_name}/add_exclamation", 1)], @@ -121,9 +121,9 @@ def _test(): @reset_core_stats_engine() @disabled_ai_monitoring_record_content_settings -def test_tool_no_content(exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name): +def test_tool_no_content(exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name, agent_runnable_type): @validate_custom_events(tool_events_sans_content(tool_recorded_event)) - @validate_custom_event_count(count=11) + @validate_custom_event_count(count=11 if agent_runnable_type != "RunnableSequence" else 14) @validate_transaction_metrics( "test_tool_no_content", scoped_metrics=[(f"Llm/tool/LangChain/{tool_method_name}/add_exclamation", 1)], @@ -143,13 +143,13 @@ def _test(): @reset_core_stats_engine() -def test_tool_execution_error(exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name): +def test_tool_execution_error(exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name, agent_runnable_type): @validate_transaction_error_event_count(1) @validate_error_trace_attributes( callable_name(RuntimeError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}} ) @validate_custom_events(tool_recorded_event_execution_error) - @validate_custom_event_count(count=5) + @validate_custom_event_count(count=5 if agent_runnable_type != "RunnableSequence" else 7) @validate_transaction_metrics( "test_tool_execution_error", scoped_metrics=[(f"Llm/tool/LangChain/{tool_method_name}/add_exclamation", 1)], @@ -171,7 +171,7 @@ def _test(): @reset_core_stats_engine() def test_tool_pre_execution_exception( - exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name + exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name, agent_runnable_type ): # Add a wrapper to intentionally force an error in the setup logic of BaseTool @transient_function_wrapper("langchain_core.tools.base", "BaseTool._parse_input") @@ -182,7 +182,7 @@ def inject_exception(wrapped, instance, args, kwargs): @validate_transaction_error_event_count(1) @validate_error_trace_attributes(callable_name(ValueError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) @validate_custom_events(tool_recorded_event_forced_internal_error) - @validate_custom_event_count(count=5) + @validate_custom_event_count(count=5 if agent_runnable_type != "RunnableSequence" else 7) @validate_transaction_metrics( "test_tool_pre_execution_exception", scoped_metrics=[(f"Llm/tool/LangChain/{tool_method_name}/add_exclamation", 1)], From ca2d2536b7a48bc3ff81f14405bd425e3c8c03e2 Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Wed, 21 Jan 2026 10:29:12 -0800 Subject: [PATCH 067/124] Reformatting to kwargs --- newrelic/hooks/mlmodel_langchain.py | 30 +++++++++++++++++++++++++---- 1 file changed, 26 insertions(+), 4 deletions(-) diff --git a/newrelic/hooks/mlmodel_langchain.py b/newrelic/hooks/mlmodel_langchain.py index 2833a20f9f..5335593a75 100644 --- a/newrelic/hooks/mlmodel_langchain.py +++ b/newrelic/hooks/mlmodel_langchain.py @@ -702,7 +702,12 @@ async def wrap_chain_async_run(wrapped, instance, args, kwargs): ft.notice_error(attributes={"completion_id": completion_id}) ft.__exit__(*sys.exc_info()) _create_error_chain_run_events( - transaction, instance, run_args, completion_id, linking_metadata, ft.duration * 1000 + transaction=transaction, + instance=instance, + run_args=run_args, + completion_id=completion_id, + linking_metadata=linking_metadata, + duration=ft.duration * 1000, ) raise ft.__exit__(None, None, None) @@ -711,7 +716,13 @@ async def wrap_chain_async_run(wrapped, instance, args, kwargs): return response _create_successful_chain_run_events( - transaction, instance, run_args, completion_id, response, linking_metadata, ft.duration * 1000 + transaction=transaction, + instance=instance, + run_args=run_args, + completion_id=completion_id, + response=response, + linking_metadata=linking_metadata, + duration=ft.duration * 1000, ) return response @@ -747,7 +758,12 @@ def wrap_chain_sync_run(wrapped, instance, args, kwargs): ft.notice_error(attributes={"completion_id": completion_id}) ft.__exit__(*sys.exc_info()) _create_error_chain_run_events( - transaction, instance, run_args, completion_id, linking_metadata, ft.duration * 1000 + transaction=transaction, + instance=instance, + run_args=run_args, + completion_id=completion_id, + linking_metadata=linking_metadata, + duration=ft.duration * 1000, ) raise ft.__exit__(None, None, None) @@ -756,7 +772,13 @@ def wrap_chain_sync_run(wrapped, instance, args, kwargs): return response _create_successful_chain_run_events( - transaction, instance, run_args, completion_id, response, linking_metadata, ft.duration * 1000 + transaction=transaction, + instance=instance, + run_args=run_args, + completion_id=completion_id, + response=response, + linking_metadata=linking_metadata, + duration=ft.duration * 1000, ) return response From 1116f515b08289d75c5724b1c3736992c3563c4c Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Wed, 21 Jan 2026 12:07:36 -0800 Subject: [PATCH 068/124] Formatting --- tests/mlmodel_langchain/test_tools.py | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/tests/mlmodel_langchain/test_tools.py b/tests/mlmodel_langchain/test_tools.py index e5fd466803..82a264c7a3 100644 --- a/tests/mlmodel_langchain/test_tools.py +++ b/tests/mlmodel_langchain/test_tools.py @@ -96,7 +96,9 @@ @reset_core_stats_engine() -def test_tool(exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name, agent_runnable_type): +def test_tool( + exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name, agent_runnable_type +): @validate_custom_events(events_with_context_attrs(tool_recorded_event)) @validate_custom_event_count(count=11 if agent_runnable_type != "RunnableSequence" else 14) @validate_transaction_metrics( @@ -121,7 +123,9 @@ def _test(): @reset_core_stats_engine() @disabled_ai_monitoring_record_content_settings -def test_tool_no_content(exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name, agent_runnable_type): +def test_tool_no_content( + exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name, agent_runnable_type +): @validate_custom_events(tool_events_sans_content(tool_recorded_event)) @validate_custom_event_count(count=11 if agent_runnable_type != "RunnableSequence" else 14) @validate_transaction_metrics( @@ -143,7 +147,9 @@ def _test(): @reset_core_stats_engine() -def test_tool_execution_error(exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name, agent_runnable_type): +def test_tool_execution_error( + exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name, agent_runnable_type +): @validate_transaction_error_event_count(1) @validate_error_trace_attributes( callable_name(RuntimeError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}} From ffa5332978dd0d1b67ebc821ac3cb65b89a9e1ff Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Wed, 21 Jan 2026 12:08:26 -0800 Subject: [PATCH 069/124] Remove storage of agent name on transaction --- newrelic/hooks/mlmodel_langchain.py | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/newrelic/hooks/mlmodel_langchain.py b/newrelic/hooks/mlmodel_langchain.py index 5335593a75..3076a19ecb 100644 --- a/newrelic/hooks/mlmodel_langchain.py +++ b/newrelic/hooks/mlmodel_langchain.py @@ -155,7 +155,7 @@ class AgentObjectProxy(ObjectProxy): def invoke(self, *args, **kwargs): transaction = current_transaction() - agent_name = getattr(transaction, "_nr_agent_name", "agent") + agent_name = getattr(self.__wrapped__, "name", None) agent_id = str(uuid.uuid4()) agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) function_trace_name = f"invoke/{agent_name}" @@ -182,7 +182,7 @@ def invoke(self, *args, **kwargs): async def ainvoke(self, *args, **kwargs): transaction = current_transaction() - agent_name = getattr(transaction, "_nr_agent_name", "agent") + agent_name = getattr(self.__wrapped__, "name", None) agent_id = str(uuid.uuid4()) agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) function_trace_name = f"ainvoke/{agent_name}" @@ -209,7 +209,7 @@ async def ainvoke(self, *args, **kwargs): def stream(self, *args, **kwargs): transaction = current_transaction() - agent_name = getattr(transaction, "_nr_agent_name", "agent") + agent_name = getattr(self.__wrapped__, "name", None) agent_id = str(uuid.uuid4()) agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) function_trace_name = f"stream/{agent_name}" @@ -232,7 +232,7 @@ def stream(self, *args, **kwargs): def astream(self, *args, **kwargs): transaction = current_transaction() - agent_name = getattr(transaction, "_nr_agent_name", "agent") + agent_name = getattr(self.__wrapped__, "name", None) agent_id = str(uuid.uuid4()) agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) function_trace_name = f"astream/{agent_name}" @@ -255,7 +255,7 @@ def astream(self, *args, **kwargs): def transform(self, *args, **kwargs): transaction = current_transaction() - agent_name = getattr(transaction, "_nr_agent_name", "agent") + agent_name = getattr(self.__wrapped__, "name", None) agent_id = str(uuid.uuid4()) agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) function_trace_name = f"stream/{agent_name}" @@ -278,7 +278,7 @@ def transform(self, *args, **kwargs): def atransform(self, *args, **kwargs): transaction = current_transaction() - agent_name = getattr(transaction, "_nr_agent_name", "agent") + agent_name = getattr(self.__wrapped__, "name", None) agent_id = str(uuid.uuid4()) agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) function_trace_name = f"astream/{agent_name}" @@ -992,10 +992,6 @@ def wrap_create_agent(wrapped, instance, args, kwargs): transaction.add_ml_model_info("LangChain", LANGCHAIN_VERSION) transaction._add_agent_attribute("llm", True) - agent_name = kwargs.get("name", None) - - transaction._nr_agent_name = agent_name - return_val = wrapped(*args, **kwargs) return AgentObjectProxy(return_val) From be2e1e10e88bea90593cbbc15140ba044e4681f5 Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Wed, 21 Jan 2026 13:03:29 -0800 Subject: [PATCH 070/124] Instrument RunnableSequence.stream and astream --- newrelic/hooks/mlmodel_langchain.py | 144 ++++++++++++++++++++++++++++ 1 file changed, 144 insertions(+) diff --git a/newrelic/hooks/mlmodel_langchain.py b/newrelic/hooks/mlmodel_langchain.py index 3076a19ecb..9d7dc19bfe 100644 --- a/newrelic/hooks/mlmodel_langchain.py +++ b/newrelic/hooks/mlmodel_langchain.py @@ -783,6 +783,146 @@ def wrap_chain_sync_run(wrapped, instance, args, kwargs): return response +def wrap_RunnableSequence_stream(wrapped, instance, args, kwargs): + transaction = current_transaction() + if not transaction: + return wrapped(*args, **kwargs) + + settings = transaction.settings if transaction.settings is not None else global_settings() + if not settings.ai_monitoring.enabled: + return wrapped(*args, **kwargs) + + # Framework metric also used for entity tagging in the UI + transaction.add_ml_model_info("LangChain", LANGCHAIN_VERSION) + transaction._add_agent_attribute("llm", True) + + run_args = bind_args(wrapped, args, kwargs) + run_args["timestamp"] = int(1000.0 * time.time()) + completion_id = str(uuid.uuid4()) + add_nr_completion_id(run_args, completion_id) + # Check to see if launched from agent or directly from chain. + # The trace group will reflect from where it has started. + # The AgentExecutor class has an attribute "agent" that does + # not exist within the Chain class + group_name = "Llm/agent/LangChain" if hasattr(instance, "agent") else "Llm/chain/LangChain" + ft = FunctionTrace(name=wrapped.__name__, group=group_name) + ft.__enter__() + linking_metadata = get_trace_linking_metadata() + try: + return_val = wrapped(input=run_args["input"], config=run_args["config"], **run_args.get("kwargs", {})) + return_val = GeneratorProxy( + return_val, + on_stop_iteration=_on_chain_stop_iteration( + ft=ft, + instance=instance, + run_args=run_args, + completion_id=completion_id, + response=[], + linking_metadata=linking_metadata, + ), + on_error=_on_chain_error( + ft=ft, + instance=instance, + run_args=run_args, + completion_id=completion_id, + linking_metadata=linking_metadata, + ), + ) + except Exception: + _on_chain_error( + ft=ft, instance=instance, run_args=run_args, completion_id=completion_id, linking_metadata=linking_metadata + )(transaction) + raise + + return return_val + + +def wrap_RunnableSequence_astream(wrapped, instance, args, kwargs): + transaction = current_transaction() + if not transaction: + return wrapped(*args, **kwargs) + + settings = transaction.settings if transaction.settings is not None else global_settings() + if not settings.ai_monitoring.enabled: + return wrapped(*args, **kwargs) + + # Framework metric also used for entity tagging in the UI + transaction.add_ml_model_info("LangChain", LANGCHAIN_VERSION) + transaction._add_agent_attribute("llm", True) + + run_args = bind_args(wrapped, args, kwargs) + run_args["timestamp"] = int(1000.0 * time.time()) + completion_id = str(uuid.uuid4()) + add_nr_completion_id(run_args, completion_id) + # Check to see if launched from agent or directly from chain. + # The trace group will reflect from where it has started. + # The AgentExecutor class has an attribute "agent" that does + # not exist within the Chain class + group_name = "Llm/agent/LangChain" if hasattr(instance, "agent") else "Llm/chain/LangChain" + ft = FunctionTrace(name=wrapped.__name__, group=group_name) + ft.__enter__() + linking_metadata = get_trace_linking_metadata() + try: + return_val = wrapped(input=run_args["input"], config=run_args["config"], **run_args.get("kwargs", {})) + return_val = AsyncGeneratorProxy( + return_val, + on_stop_iteration=_on_chain_stop_iteration( + ft=ft, + instance=instance, + run_args=run_args, + completion_id=completion_id, + response=[], + linking_metadata=linking_metadata, + ), + on_error=_on_chain_error( + ft=ft, + instance=instance, + run_args=run_args, + completion_id=completion_id, + linking_metadata=linking_metadata, + ), + ) + except Exception: + _on_chain_error( + ft=ft, instance=instance, run_args=run_args, completion_id=completion_id, linking_metadata=linking_metadata + )(transaction) + raise + + return return_val + + +def _on_chain_stop_iteration(ft, instance, run_args, completion_id, response, linking_metadata): + def _on_stop_iteration(proxy, transaction): + ft.__exit__(None, None, None) + _create_successful_chain_run_events( + transaction=transaction, + instance=instance, + run_args=run_args, + completion_id=completion_id, + response=response, + linking_metadata=linking_metadata, + duration=ft.duration * 1000, + ) + + return _on_stop_iteration + + +def _on_chain_error(ft, instance, run_args, completion_id, linking_metadata): + def _on_error(proxy, transaction): + ft.notice_error(attributes={"completion_id": completion_id}) + ft.__exit__(*sys.exc_info()) + _create_error_chain_run_events( + transaction=transaction, + instance=instance, + run_args=run_args, + completion_id=completion_id, + linking_metadata=linking_metadata, + duration=ft.duration * 1000, + ) + + return _on_error + + def add_nr_completion_id(run_args, completion_id): # invoke has an argument named "config" that contains metadata and tags. # Add the nr_completion_id into the metadata to be used as the function call @@ -1032,6 +1172,10 @@ def instrument_langchain_runnables_chains_base(module): wrap_function_wrapper(module, "RunnableSequence.invoke", wrap_chain_sync_run) if hasattr(module.RunnableSequence, "ainvoke"): wrap_function_wrapper(module, "RunnableSequence.ainvoke", wrap_chain_async_run) + if hasattr(module.RunnableSequence, "stream"): + wrap_function_wrapper(module, "RunnableSequence.stream", wrap_RunnableSequence_stream) + if hasattr(module.RunnableSequence, "astream"): + wrap_function_wrapper(module, "RunnableSequence.astream", wrap_RunnableSequence_astream) def instrument_langchain_chains_base(module): From f8c0808297f7001d15533f4c1bbe866347ac939b Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Wed, 21 Jan 2026 13:07:52 -0800 Subject: [PATCH 071/124] Add correct event counts --- tests/mlmodel_langchain/conftest.py | 11 ++++++++++- tests/mlmodel_langchain/test_agents.py | 8 ++++---- tests/mlmodel_langchain/test_tools.py | 12 ++++-------- 3 files changed, 18 insertions(+), 13 deletions(-) diff --git a/tests/mlmodel_langchain/conftest.py b/tests/mlmodel_langchain/conftest.py index e42279422d..19cf5216ec 100644 --- a/tests/mlmodel_langchain/conftest.py +++ b/tests/mlmodel_langchain/conftest.py @@ -231,7 +231,7 @@ def _validate_agent_output(response): @pytest.fixture(scope="session", params=["invoke", "ainvoke", "stream", "astream"]) -def exercise_agent(request, loop, validate_agent_output): +def exercise_agent(request, loop, validate_agent_output, agent_runnable_type): def _exercise_agent(agent, prompt): if request.param == "invoke": response = agent.invoke(prompt) @@ -257,6 +257,15 @@ async def _exercise_agen(): raise NotImplementedError _exercise_agent._called_method = request.param # Used for metric names + + # Expected number of events for a full run of the agent + if agent_runnable_type != "RunnableSequence": + _exercise_agent._expected_event_count = 11 + elif request.param in {"invoke", "ainvoke"}: + _exercise_agent._expected_event_count = 14 + else: + _exercise_agent._expected_event_count = 13 + return _exercise_agent diff --git a/tests/mlmodel_langchain/test_agents.py b/tests/mlmodel_langchain/test_agents.py index e4641b8c0e..9ec7b20dff 100644 --- a/tests/mlmodel_langchain/test_agents.py +++ b/tests/mlmodel_langchain/test_agents.py @@ -77,9 +77,9 @@ def add_exclamation(message: str) -> str: @reset_core_stats_engine() -def test_agent(exercise_agent, create_agent_runnable, set_trace_info, method_name, agent_runnable_type): +def test_agent(exercise_agent, create_agent_runnable, set_trace_info, method_name): @validate_custom_events(events_with_context_attrs(agent_recorded_event)) - @validate_custom_event_count(count=11 if agent_runnable_type != "RunnableSequence" else 14) + @validate_custom_event_count(count=exercise_agent._expected_event_count) @validate_transaction_metrics( "test_agent", scoped_metrics=[(f"Llm/agent/LangChain/{method_name}/my_agent", 1)], @@ -102,9 +102,9 @@ def _test(): @reset_core_stats_engine() @disabled_ai_monitoring_record_content_settings -def test_agent_no_content(exercise_agent, create_agent_runnable, set_trace_info, method_name, agent_runnable_type): +def test_agent_no_content(exercise_agent, create_agent_runnable, set_trace_info, method_name): @validate_custom_events(agent_recorded_event) - @validate_custom_event_count(count=11 if agent_runnable_type != "RunnableSequence" else 14) + @validate_custom_event_count(count=exercise_agent._expected_event_count) @validate_transaction_metrics( "test_agent_no_content", scoped_metrics=[(f"Llm/agent/LangChain/{method_name}/my_agent", 1)], diff --git a/tests/mlmodel_langchain/test_tools.py b/tests/mlmodel_langchain/test_tools.py index 82a264c7a3..1ae8cc6033 100644 --- a/tests/mlmodel_langchain/test_tools.py +++ b/tests/mlmodel_langchain/test_tools.py @@ -96,11 +96,9 @@ @reset_core_stats_engine() -def test_tool( - exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name, agent_runnable_type -): +def test_tool(exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name): @validate_custom_events(events_with_context_attrs(tool_recorded_event)) - @validate_custom_event_count(count=11 if agent_runnable_type != "RunnableSequence" else 14) + @validate_custom_event_count(count=exercise_agent._expected_event_count) @validate_transaction_metrics( "test_tool", scoped_metrics=[(f"Llm/tool/LangChain/{tool_method_name}/add_exclamation", 1)], @@ -123,11 +121,9 @@ def _test(): @reset_core_stats_engine() @disabled_ai_monitoring_record_content_settings -def test_tool_no_content( - exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name, agent_runnable_type -): +def test_tool_no_content(exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name): @validate_custom_events(tool_events_sans_content(tool_recorded_event)) - @validate_custom_event_count(count=11 if agent_runnable_type != "RunnableSequence" else 14) + @validate_custom_event_count(count=exercise_agent._expected_event_count) @validate_transaction_metrics( "test_tool_no_content", scoped_metrics=[(f"Llm/tool/LangChain/{tool_method_name}/add_exclamation", 1)], From 384fe2d5361786ea0524439276ca4693edda3b22 Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Wed, 21 Jan 2026 15:31:14 -0800 Subject: [PATCH 072/124] Guard metadata additions --- newrelic/hooks/mlmodel_langgraph.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/newrelic/hooks/mlmodel_langgraph.py b/newrelic/hooks/mlmodel_langgraph.py index 74aeb4d3c9..6644b80e1b 100644 --- a/newrelic/hooks/mlmodel_langgraph.py +++ b/newrelic/hooks/mlmodel_langgraph.py @@ -24,8 +24,9 @@ def wrap_ToolNode__execute_tool_sync(wrapped, instance, args, kwargs): try: bound_args = bind_args(wrapped, args, kwargs) agent_name = bound_args["request"].state["messages"][-1].name - metadata = bound_args["config"]["metadata"] - metadata["_nr_agent_name"] = agent_name + if agent_name: + metadata = bound_args["config"]["metadata"] + metadata["_nr_agent_name"] = agent_name except Exception: pass @@ -39,8 +40,9 @@ async def wrap_ToolNode__execute_tool_async(wrapped, instance, args, kwargs): try: bound_args = bind_args(wrapped, args, kwargs) agent_name = bound_args["request"].state["messages"][-1].name - metadata = bound_args["config"]["metadata"] - metadata["_nr_agent_name"] = agent_name + if agent_name: + metadata = bound_args["config"]["metadata"] + metadata["_nr_agent_name"] = agent_name except Exception: pass From 1ef97354d3375f4dcd2308749b317e177b467d42 Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Wed, 21 Jan 2026 15:53:37 -0800 Subject: [PATCH 073/124] Add alternate source for agent_name --- newrelic/hooks/mlmodel_langchain.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/newrelic/hooks/mlmodel_langchain.py b/newrelic/hooks/mlmodel_langchain.py index 9d7dc19bfe..f12ccd9c44 100644 --- a/newrelic/hooks/mlmodel_langchain.py +++ b/newrelic/hooks/mlmodel_langchain.py @@ -606,7 +606,8 @@ def _capture_tool_info(instance, wrapped, args, kwargs): tool_id = str(uuid.uuid4()) metadata = run_args.get("metadata") or {} - agent_name = metadata.pop("_nr_agent_name", None) + # lc_agent_name was added to metadata in LangChain 1.2.4 + agent_name = metadata.pop("_nr_agent_name", None) or metadata.get("lc_agent_name", None) tool_input = run_args.get("tool_input") tool_name = getattr(instance, "name", None) # Checking multiple places for an acceptable tool run ID, fallback to creating our own. From c5644dfeaa8a77042874e9680ecef554dc7a4a19 Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Wed, 21 Jan 2026 15:55:55 -0800 Subject: [PATCH 074/124] Pin lower bound of langchain tests --- tox.ini | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tox.ini b/tox.ini index 86be658e70..d33e67d6fd 100644 --- a/tox.ini +++ b/tox.ini @@ -185,7 +185,7 @@ envlist = python-mlmodel_autogen-{py310,py311,py312,py313,py314,pypy311}-autogenlatest, python-mlmodel_strands-{py310,py311,py312,py313}-strandslatest, python-mlmodel_gemini-{py39,py310,py311,py312,py313,py314}, - python-mlmodel_langchain-{py39,py310,py311,py312,py313}, + python-mlmodel_langchain-{py310,py311,py312,py313}, ;; Package not ready for Python 3.14 (type annotations not updated) ; python-mlmodel_langchain-py314, python-mlmodel_openai-openai0-{py38,py39,py310,py311,py312}, @@ -430,7 +430,7 @@ deps = mlmodel_openai-openai0: openai[datalib]<1.0 mlmodel_openai-openailatest: openai[datalib] mlmodel_openai: protobuf - mlmodel_langchain: langchain + mlmodel_langchain: langchain>=1.2.4 mlmodel_langchain: langchain-core mlmodel_langchain: langchain-community mlmodel_langchain: langchain-openai From b86e8f12712b86fec976c1379469b44ccb6e2021 Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Wed, 21 Jan 2026 16:13:12 -0800 Subject: [PATCH 075/124] Implement tee() and __copy__() for GeneratorProxy --- newrelic/common/llm_utils.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/newrelic/common/llm_utils.py b/newrelic/common/llm_utils.py index 4b3ec01076..5a4bb7e218 100644 --- a/newrelic/common/llm_utils.py +++ b/newrelic/common/llm_utils.py @@ -12,6 +12,8 @@ # See the License for the specific language governing permissions and # limitations under the License. +import itertools + from newrelic.api.transaction import current_transaction from newrelic.common.object_wrapper import ObjectProxy @@ -56,6 +58,11 @@ def __next__(self): def close(self): return self.__wrapped__.close() + def __copy__(self): + # Required to properly interface with itertool.tee, which can be called by LangChain on generators + self.__wrapped__, copy = itertools.tee(self.__wrapped__, 2) + return GeneratorProxy(copy, self._nr_on_stop_iteration, self._nr_on_error) + class AsyncGeneratorProxy(ObjectProxy): def __init__(self, wrapped, on_stop_iteration, on_error): @@ -85,3 +92,8 @@ async def __anext__(self): async def aclose(self): return await self.__wrapped__.aclose() + + def __copy__(self): + # Required to properly interface with itertool.tee, which can be called by LangChain on generators + self.__wrapped__, copy = itertools.tee(self.__wrapped__, n=2) + return AsyncGeneratorProxy(copy, self._nr_on_stop_iteration, self._nr_on_error) From 0d47eaee766798f137d98f51d362e42d6a726c7d Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Wed, 21 Jan 2026 16:39:37 -0800 Subject: [PATCH 076/124] Slight tweaks --- newrelic/hooks/mlmodel_langchain.py | 4 +++- tests/mlmodel_langchain/conftest.py | 3 +++ tests/mlmodel_langchain/test_tools.py | 10 ++++------ 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/newrelic/hooks/mlmodel_langchain.py b/newrelic/hooks/mlmodel_langchain.py index f12ccd9c44..07d2e8b64e 100644 --- a/newrelic/hooks/mlmodel_langchain.py +++ b/newrelic/hooks/mlmodel_langchain.py @@ -1145,7 +1145,8 @@ def wrap_StructuredTool_invoke(wrapped, instance, args, kwargs): return wrapped(*args, **kwargs) metadata = bind_args(wrapped, args, kwargs).get("config", {}).get("metadata", {}) - trace = metadata.get("_nr_trace") + # Delete the reference after grabbing it to avoid it ending up in LangChain attributes + trace = metadata.pop("_nr_trace", None) if not trace: return wrapped(*args, **kwargs) @@ -1156,6 +1157,7 @@ def wrap_StructuredTool_invoke(wrapped, instance, args, kwargs): async def wrap_StructuredTool_ainvoke(wrapped, instance, args, kwargs): """Save a copy of the current trace if we're about to run StructuredTool.invoke inside a ThreadPoolExecutor.""" trace = current_trace() + # We only need to propagate for synchronous calls with an active trace if not trace or instance.coroutine: return await wrapped(*args, **kwargs) diff --git a/tests/mlmodel_langchain/conftest.py b/tests/mlmodel_langchain/conftest.py index 19cf5216ec..fdb7dac3cb 100644 --- a/tests/mlmodel_langchain/conftest.py +++ b/tests/mlmodel_langchain/conftest.py @@ -261,10 +261,13 @@ async def _exercise_agen(): # Expected number of events for a full run of the agent if agent_runnable_type != "RunnableSequence": _exercise_agent._expected_event_count = 11 + _exercise_agent._expected_event_count_error = 5 elif request.param in {"invoke", "ainvoke"}: _exercise_agent._expected_event_count = 14 + _exercise_agent._expected_event_count_error = 7 else: _exercise_agent._expected_event_count = 13 + _exercise_agent._expected_event_count_error = 7 return _exercise_agent diff --git a/tests/mlmodel_langchain/test_tools.py b/tests/mlmodel_langchain/test_tools.py index 1ae8cc6033..19778997db 100644 --- a/tests/mlmodel_langchain/test_tools.py +++ b/tests/mlmodel_langchain/test_tools.py @@ -143,15 +143,13 @@ def _test(): @reset_core_stats_engine() -def test_tool_execution_error( - exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name, agent_runnable_type -): +def test_tool_execution_error(exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name): @validate_transaction_error_event_count(1) @validate_error_trace_attributes( callable_name(RuntimeError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}} ) @validate_custom_events(tool_recorded_event_execution_error) - @validate_custom_event_count(count=5 if agent_runnable_type != "RunnableSequence" else 7) + @validate_custom_event_count(exercise_agent._expected_event_count_error) @validate_transaction_metrics( "test_tool_execution_error", scoped_metrics=[(f"Llm/tool/LangChain/{tool_method_name}/add_exclamation", 1)], @@ -173,7 +171,7 @@ def _test(): @reset_core_stats_engine() def test_tool_pre_execution_exception( - exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name, agent_runnable_type + exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name ): # Add a wrapper to intentionally force an error in the setup logic of BaseTool @transient_function_wrapper("langchain_core.tools.base", "BaseTool._parse_input") @@ -184,7 +182,7 @@ def inject_exception(wrapped, instance, args, kwargs): @validate_transaction_error_event_count(1) @validate_error_trace_attributes(callable_name(ValueError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) @validate_custom_events(tool_recorded_event_forced_internal_error) - @validate_custom_event_count(count=5 if agent_runnable_type != "RunnableSequence" else 7) + @validate_custom_event_count(exercise_agent._expected_event_count_error) @validate_transaction_metrics( "test_tool_pre_execution_exception", scoped_metrics=[(f"Llm/tool/LangChain/{tool_method_name}/add_exclamation", 1)], From 5b677312b2dc9d4c765cbd028fbdfe547dab4594 Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Wed, 28 Jan 2026 23:59:46 -0800 Subject: [PATCH 077/124] Fixups. --- newrelic/common/llm_utils.py | 21 +++++++++++----- newrelic/hooks/mlmodel_langchain.py | 39 ++++++++++++++--------------- newrelic/hooks/mlmodel_openai.py | 6 ++--- 3 files changed, 37 insertions(+), 29 deletions(-) diff --git a/newrelic/common/llm_utils.py b/newrelic/common/llm_utils.py index 5a4bb7e218..062ce60f1d 100644 --- a/newrelic/common/llm_utils.py +++ b/newrelic/common/llm_utils.py @@ -13,18 +13,27 @@ # limitations under the License. import itertools +import logging from newrelic.api.transaction import current_transaction from newrelic.common.object_wrapper import ObjectProxy +_logger = logging.getLogger(__name__) + def _get_llm_metadata(transaction): - # Grab LLM-related custom attributes off of the transaction to store as metadata on LLM events - custom_attrs_dict = transaction._custom_params - llm_metadata_dict = {key: value for key, value in custom_attrs_dict.items() if key.startswith("llm.")} - llm_context_attrs = getattr(transaction, "_llm_context_attrs", None) - if llm_context_attrs: - llm_metadata_dict.update(llm_context_attrs) + if not transaction: + return {} + try: + # Grab LLM-related custom attributes off of the transaction to store as metadata on LLM events + custom_attrs_dict = getattr(transaction, "_custom_params", {}) + llm_metadata_dict = {key: value for key, value in custom_attrs_dict.items() if key.startswith("llm.")} + llm_context_attrs = getattr(transaction, "_llm_context_attrs", None) + if llm_context_attrs: + llm_metadata_dict.update(llm_context_attrs) + except Exception: + _logger.warning("Unable to capture custom metadata attributes to record on LLM events.") + return {} return llm_metadata_dict diff --git a/newrelic/hooks/mlmodel_langchain.py b/newrelic/hooks/mlmodel_langchain.py index 07d2e8b64e..e682f1bff3 100644 --- a/newrelic/hooks/mlmodel_langchain.py +++ b/newrelic/hooks/mlmodel_langchain.py @@ -21,7 +21,7 @@ from newrelic.api.function_trace import FunctionTrace from newrelic.api.time_trace import current_trace, get_trace_linking_metadata from newrelic.api.transaction import current_transaction -from newrelic.common.llm_utils import AsyncGeneratorProxy, GeneratorProxy +from newrelic.common.llm_utils import AsyncGeneratorProxy, GeneratorProxy, _get_llm_metadata from newrelic.common.object_wrapper import ObjectProxy, wrap_function_wrapper from newrelic.common.package_version_utils import get_package_version from newrelic.common.signature import bind_args @@ -154,8 +154,10 @@ def _construct_base_agent_event_dict(agent_name, agent_id, transaction): class AgentObjectProxy(ObjectProxy): def invoke(self, *args, **kwargs): transaction = current_transaction() + if not transaction: + return self.__wrapped__.invoke(*args, **kwargs) - agent_name = getattr(self.__wrapped__, "name", None) + agent_name = getattr(self.__wrapped__, "name", "agent") agent_id = str(uuid.uuid4()) agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) function_trace_name = f"invoke/{agent_name}" @@ -174,15 +176,16 @@ def invoke(self, *args, **kwargs): ft.__exit__(None, None, None) agent_event_dict.update({"duration": ft.duration * 1000}) - transaction.record_custom_event("LlmAgent", agent_event_dict) return return_val async def ainvoke(self, *args, **kwargs): transaction = current_transaction() + if not transaction: + return await self.__wrapped__.ainvoke(*args, **kwargs) - agent_name = getattr(self.__wrapped__, "name", None) + agent_name = getattr(self.__wrapped__, "name", "agent") agent_id = str(uuid.uuid4()) agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) function_trace_name = f"ainvoke/{agent_name}" @@ -201,15 +204,16 @@ async def ainvoke(self, *args, **kwargs): ft.__exit__(None, None, None) agent_event_dict.update({"duration": ft.duration * 1000}) - transaction.record_custom_event("LlmAgent", agent_event_dict) return return_val def stream(self, *args, **kwargs): transaction = current_transaction() + if not transaction: + return self.__wrapped__.stream(*args, **kwargs) - agent_name = getattr(self.__wrapped__, "name", None) + agent_name = getattr(self.__wrapped__, "name", "agent") agent_id = str(uuid.uuid4()) agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) function_trace_name = f"stream/{agent_name}" @@ -231,8 +235,10 @@ def stream(self, *args, **kwargs): def astream(self, *args, **kwargs): transaction = current_transaction() + if not transaction: + return self.__wrapped__.astream(*args, **kwargs) - agent_name = getattr(self.__wrapped__, "name", None) + agent_name = getattr(self.__wrapped__, "name", "agent") agent_id = str(uuid.uuid4()) agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) function_trace_name = f"astream/{agent_name}" @@ -254,8 +260,10 @@ def astream(self, *args, **kwargs): def transform(self, *args, **kwargs): transaction = current_transaction() + if not transaction: + return self.__wrapped__.transform(*args, **kwargs) - agent_name = getattr(self.__wrapped__, "name", None) + agent_name = getattr(self.__wrapped__, "name", "agent") agent_id = str(uuid.uuid4()) agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) function_trace_name = f"stream/{agent_name}" @@ -277,8 +285,10 @@ def transform(self, *args, **kwargs): def atransform(self, *args, **kwargs): transaction = current_transaction() + if not transaction: + return self.__wrapped__.atransform(*args, **kwargs) - agent_name = getattr(self.__wrapped__, "name", None) + agent_name = getattr(self.__wrapped__, "name", "agent") agent_id = str(uuid.uuid4()) agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) function_trace_name = f"astream/{agent_name}" @@ -989,17 +999,6 @@ def _get_run_manager_info(transaction, run_args, instance, completion_id): return run_id, metadata, tags or None -def _get_llm_metadata(transaction): - # Grab LLM-related custom attributes off of the transaction to store as metadata on LLM events - custom_attrs_dict = transaction._custom_params - llm_metadata_dict = {key: value for key, value in custom_attrs_dict.items() if key.startswith("llm.")} - llm_context_attrs = getattr(transaction, "_llm_context_attrs", None) - if llm_context_attrs: - llm_metadata_dict.update(llm_context_attrs) - - return llm_metadata_dict - - def _create_successful_chain_run_events( transaction, instance, run_args, completion_id, response, linking_metadata, duration ): diff --git a/newrelic/hooks/mlmodel_openai.py b/newrelic/hooks/mlmodel_openai.py index d6c3945bb1..9190cc30bc 100644 --- a/newrelic/hooks/mlmodel_openai.py +++ b/newrelic/hooks/mlmodel_openai.py @@ -170,8 +170,7 @@ def create_chat_completion_message_event( "vendor": "openai", "ingest_source": "Python", } - - if settings.ai_monitoring.record_content.enabled: + if settings.ai_monitoring.record_content.enabled and message_content: chat_completion_input_message_dict["content"] = message_content if request_timestamp: chat_completion_input_message_dict["timestamp"] = request_timestamp @@ -214,7 +213,7 @@ def create_chat_completion_message_event( "is_response": True, } - if settings.ai_monitoring.record_content.enabled: + if settings.ai_monitoring.record_content.enabled and message_content: chat_completion_output_message_dict["content"] = message_content chat_completion_output_message_dict.update(llm_metadata) @@ -492,6 +491,7 @@ def _record_completion_success( ): span_id = linking_metadata.get("span.id") trace_id = linking_metadata.get("trace.id") + try: if response: response_model = response.get("model") From 6cfc6027f3a19d744f2965bb264766252e2590d9 Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Wed, 11 Feb 2026 13:21:13 -0800 Subject: [PATCH 078/124] Fix pyramid by pinning setuptools (#1647) --- .github/scripts/install_azure_functions_worker.sh | 2 +- .github/workflows/benchmarks.yml | 1 + tox.ini | 3 ++- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/scripts/install_azure_functions_worker.sh b/.github/scripts/install_azure_functions_worker.sh index eea074abfd..6a6c68be95 100755 --- a/.github/scripts/install_azure_functions_worker.sh +++ b/.github/scripts/install_azure_functions_worker.sh @@ -34,7 +34,7 @@ ${PIP} install pip-tools build invoke # Install proto build dependencies $( cd ${BUILD_DIR}/workers/ && ${PIPCOMPILE} -o ${BUILD_DIR}/requirements.txt ) -${PIP} install -r ${BUILD_DIR}/requirements.txt +${PIP} install 'setuptools<82' -r ${BUILD_DIR}/requirements.txt # Build proto files into pb2 files (invoke handles fixing include paths for the protos) cd ${BUILD_DIR}/workers/tests && ${INVOKE} -c test_setup build-protos diff --git a/.github/workflows/benchmarks.yml b/.github/workflows/benchmarks.yml index 4bfbaf5e94..ff1edb33d6 100644 --- a/.github/workflows/benchmarks.yml +++ b/.github/workflows/benchmarks.yml @@ -30,6 +30,7 @@ jobs: runs-on: ubuntu-24.04 timeout-minutes: 30 strategy: + fail-fast: false matrix: python: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"] diff --git a/tox.ini b/tox.ini index d33e67d6fd..f61d90a775 100644 --- a/tox.ini +++ b/tox.ini @@ -69,7 +69,7 @@ envlist = # Integration Tests (only run on Linux) cassandra-datastore_cassandradriver-py38-cassandra032903, - cassandra-datastore_cassandradriver-{py39,py310,py311,py312,pypy311}-cassandralatest, + cassandra-datastore_cassandradriver-{py39,py310,py311,py312}-cassandralatest, elasticsearchserver07-datastore_elasticsearch-{py38,py39,py310,py311,py312,py313,py314,pypy311}-elasticsearch07, elasticsearchserver08-datastore_elasticsearch-{py38,py39,py310,py311,py312,py313,py314,pypy311}-elasticsearch08, firestore-datastore_firestore-{py38,py39,py310,py311,py312,py313,py314}, @@ -392,6 +392,7 @@ deps = framework_grpc-grpc0162: grpcio<1.63 framework_grpc-grpc0162: grpcio-tools<1.63 framework_grpc-grpc0162: protobuf<4.25 + framework_pyramid: setuptools<82 framework_pyramid: routes framework_pyramid-cornicelatest: cornice framework_pyramid-Pyramidlatest: Pyramid From c88814a0e7785a66ee6fe3afa6bfdffb80e6b21b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 11 Feb 2026 14:08:21 -0800 Subject: [PATCH 079/124] Bump the github_actions group across 1 directory with 7 updates (#1657) Bumps the github_actions group with 7 updates in the / directory: | Package | From | To | | --- | --- | --- | | [actions/checkout](https://github.com/actions/checkout) | `6.0.1` | `6.0.2` | | [actions/setup-python](https://github.com/actions/setup-python) | `6.1.0` | `6.2.0` | | [docker/login-action](https://github.com/docker/login-action) | `3.6.0` | `3.7.0` | | [docker/build-push-action](https://github.com/docker/build-push-action) | `6.18.0` | `6.19.1` | | [actions/attest-build-provenance](https://github.com/actions/attest-build-provenance) | `3.1.0` | `3.2.0` | | [astral-sh/setup-uv](https://github.com/astral-sh/setup-uv) | `7.2.0` | `7.3.0` | | [github/codeql-action](https://github.com/github/codeql-action) | `4.31.10` | `4.32.2` | Updates `actions/checkout` from 6.0.1 to 6.0.2 - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/8e8c483db84b4bee98b60c0593521ed34d9990e8...de0fac2e4500dabe0009e67214ff5f5447ce83dd) Updates `actions/setup-python` from 6.1.0 to 6.2.0 - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](https://github.com/actions/setup-python/compare/83679a892e2d95755f2dac6acb0bfd1e9ac5d548...a309ff8b426b58ec0e2a45f0f869d46889d02405) Updates `docker/login-action` from 3.6.0 to 3.7.0 - [Release notes](https://github.com/docker/login-action/releases) - [Commits](https://github.com/docker/login-action/compare/5e57cd118135c172c3672efd75eb46360885c0ef...c94ce9fb468520275223c153574b00df6fe4bcc9) Updates `docker/build-push-action` from 6.18.0 to 6.19.1 - [Release notes](https://github.com/docker/build-push-action/releases) - [Commits](https://github.com/docker/build-push-action/compare/263435318d21b8e681c14492fe198d362a7d2c83...601a80b39c9405e50806ae38af30926f9d957c47) Updates `actions/attest-build-provenance` from 3.1.0 to 3.2.0 - [Release notes](https://github.com/actions/attest-build-provenance/releases) - [Changelog](https://github.com/actions/attest-build-provenance/blob/main/RELEASE.md) - [Commits](https://github.com/actions/attest-build-provenance/compare/00014ed6ed5efc5b1ab7f7f34a39eb55d41aa4f8...96278af6caaf10aea03fd8d33a09a777ca52d62f) Updates `astral-sh/setup-uv` from 7.2.0 to 7.3.0 - [Release notes](https://github.com/astral-sh/setup-uv/releases) - [Commits](https://github.com/astral-sh/setup-uv/compare/61cb8a9741eeb8a550a1b8544337180c0fc8476b...eac588ad8def6316056a12d4907a9d4d84ff7a3b) Updates `github/codeql-action` from 4.31.10 to 4.32.2 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/github/codeql-action/compare/cdefb33c0f6224e58673d9004f47f7cb3e328b89...45cbd0c69e560cd9e7cd7f8c32362050c9b7ded2) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: 6.0.2 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions - dependency-name: actions/setup-python dependency-version: 6.2.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: docker/login-action dependency-version: 3.7.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: docker/build-push-action dependency-version: 6.19.1 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: actions/attest-build-provenance dependency-version: 3.2.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: astral-sh/setup-uv dependency-version: 7.3.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: github/codeql-action dependency-version: 4.32.2 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/addlicense.yml | 2 +- .github/workflows/benchmarks.yml | 4 +- .github/workflows/build-ci-image.yml | 8 ++-- .github/workflows/deploy.yml | 8 ++-- .github/workflows/mega-linter.yml | 2 +- .github/workflows/tests.yml | 62 ++++++++++++++-------------- .github/workflows/trivy.yml | 4 +- 7 files changed, 45 insertions(+), 45 deletions(-) diff --git a/.github/workflows/addlicense.yml b/.github/workflows/addlicense.yml index e57534cc77..f357a8b093 100644 --- a/.github/workflows/addlicense.yml +++ b/.github/workflows/addlicense.yml @@ -39,7 +39,7 @@ jobs: permissions: contents: read steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | diff --git a/.github/workflows/benchmarks.yml b/.github/workflows/benchmarks.yml index ff1edb33d6..2e7094fe09 100644 --- a/.github/workflows/benchmarks.yml +++ b/.github/workflows/benchmarks.yml @@ -39,11 +39,11 @@ jobs: BASE_SHA: ${{ github.event.pull_request.base.sha }} steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 with: fetch-depth: 0 - - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # 6.1.0 + - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # 6.2.0 with: python-version: "${{ matrix.python }}" diff --git a/.github/workflows/build-ci-image.yml b/.github/workflows/build-ci-image.yml index 406922b543..8e94aa3439 100644 --- a/.github/workflows/build-ci-image.yml +++ b/.github/workflows/build-ci-image.yml @@ -43,7 +43,7 @@ jobs: name: Docker Build ${{ matrix.platform }} steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 with: persist-credentials: false fetch-depth: 0 @@ -75,7 +75,7 @@ jobs: - name: Login to GitHub Container Registry if: github.event_name != 'pull_request' - uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # 3.6.0 + uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 # 3.7.0 with: registry: ghcr.io username: ${{ github.repository_owner }} @@ -83,7 +83,7 @@ jobs: - name: Build and Push Image by Digest id: build - uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # 6.18.0 + uses: docker/build-push-action@601a80b39c9405e50806ae38af30926f9d957c47 # 6.19.1 with: context: .github/containers platforms: ${{ matrix.platform }} @@ -122,7 +122,7 @@ jobs: - name: Login to GitHub Container Registry if: github.event_name != 'pull_request' - uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # 3.6.0 + uses: docker/login-action@c94ce9fb468520275223c153574b00df6fe4bcc9 # 3.7.0 with: registry: ghcr.io username: ${{ github.repository_owner }} diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 4d7e32aeeb..9f3e4f0a4f 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -69,7 +69,7 @@ jobs: runs-on: ${{ matrix.os }} steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 with: persist-credentials: false fetch-depth: 0 @@ -109,12 +109,12 @@ jobs: runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 with: persist-credentials: false fetch-depth: 0 - - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # 6.1.0 + - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # 6.2.0 with: python-version: "3.13" @@ -196,7 +196,7 @@ jobs: repository-url: https://test.pypi.org/legacy/ - name: Attest - uses: actions/attest-build-provenance@00014ed6ed5efc5b1ab7f7f34a39eb55d41aa4f8 # 3.1.0 + uses: actions/attest-build-provenance@96278af6caaf10aea03fd8d33a09a777ca52d62f # 3.2.0 id: attest with: subject-path: | diff --git a/.github/workflows/mega-linter.yml b/.github/workflows/mega-linter.yml index 38d972ee85..e8efe75ada 100644 --- a/.github/workflows/mega-linter.yml +++ b/.github/workflows/mega-linter.yml @@ -45,7 +45,7 @@ jobs: steps: # Git Checkout - name: Checkout Code - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 with: token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }} fetch-depth: 0 # Required for pushing commits to PRs diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index aa3569ee21..4d1b7932e2 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -93,8 +93,8 @@ jobs: - tests steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # 6.1.0 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 + - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # 6.2.0 with: python-version: "3.13" architecture: x64 @@ -127,8 +127,8 @@ jobs: - tests steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 - - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # 6.1.0 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 + - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # 6.2.0 with: python-version: "3.13" architecture: x64 @@ -166,7 +166,7 @@ jobs: --add-host=host.docker.internal:host-gateway timeout-minutes: 30 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -231,7 +231,7 @@ jobs: --add-host=host.docker.internal:host-gateway timeout-minutes: 30 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -294,14 +294,14 @@ jobs: runs-on: windows-2025 timeout-minutes: 30 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | git fetch --tags origin - name: Install uv - uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b # 7.2.0 + uses: astral-sh/setup-uv@eac588ad8def6316056a12d4907a9d4d84ff7a3b # 7.3.0 - name: Install Python run: | @@ -363,14 +363,14 @@ jobs: runs-on: windows-11-arm timeout-minutes: 30 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | git fetch --tags origin - name: Install uv - uses: astral-sh/setup-uv@61cb8a9741eeb8a550a1b8544337180c0fc8476b # 7.2.0 + uses: astral-sh/setup-uv@eac588ad8def6316056a12d4907a9d4d84ff7a3b # 7.3.0 - name: Install Python run: | @@ -443,7 +443,7 @@ jobs: --add-host=host.docker.internal:host-gateway timeout-minutes: 30 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -526,7 +526,7 @@ jobs: --health-retries 10 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -606,7 +606,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -687,7 +687,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -772,7 +772,7 @@ jobs: # from every being executed as bash commands. steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -837,7 +837,7 @@ jobs: --add-host=host.docker.internal:host-gateway timeout-minutes: 30 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -927,7 +927,7 @@ jobs: KAFKA_CFG_INTER_BROKER_LISTENER_NAME: L3 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -1005,7 +1005,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -1083,7 +1083,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -1161,7 +1161,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -1244,7 +1244,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -1327,7 +1327,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -1406,7 +1406,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -1487,7 +1487,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -1567,7 +1567,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -1647,7 +1647,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -1726,7 +1726,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -1804,7 +1804,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -1923,7 +1923,7 @@ jobs: --add-host=host.docker.internal:host-gateway steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -2003,7 +2003,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | @@ -2081,7 +2081,7 @@ jobs: --health-retries 5 steps: - - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 - name: Fetch git tags run: | diff --git a/.github/workflows/trivy.yml b/.github/workflows/trivy.yml index 0cb037ebc4..04be27cdcd 100644 --- a/.github/workflows/trivy.yml +++ b/.github/workflows/trivy.yml @@ -32,7 +32,7 @@ jobs: steps: # Git Checkout - name: Checkout Code - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # 6.0.1 + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 with: token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }} fetch-depth: 0 @@ -61,6 +61,6 @@ jobs: - name: Upload Trivy scan results to GitHub Security tab if: ${{ github.event_name == 'schedule' }} - uses: github/codeql-action/upload-sarif@cdefb33c0f6224e58673d9004f47f7cb3e328b89 # 4.31.10 + uses: github/codeql-action/upload-sarif@45cbd0c69e560cd9e7cd7f8c32362050c9b7ded2 # 4.32.2 with: sarif_file: "trivy-results.sarif" From 0c58455861d35719b62216aa427b2f64ce8a1c6c Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Fri, 13 Feb 2026 16:48:48 -0800 Subject: [PATCH 080/124] Revert "Merge main into develop-v12.0.0" --- .github/.trivyignore | 17 +- .github/containers/Dockerfile | 2 +- .github/workflows/benchmarks.yml | 2 +- .github/workflows/deploy.yml | 13 +- THIRD_PARTY_NOTICES.md | 4 +- asv.conf.json | 2 +- newrelic/admin/__init__.py | 14 +- newrelic/common/agent_http.py | 4 +- newrelic/common/object_wrapper.py | 11 +- newrelic/common/package_version_utils.py | 49 +- newrelic/config.py | 28 +- newrelic/core/_thread_utilization.c | 13 +- newrelic/core/config.py | 3 +- newrelic/core/environment.py | 8 +- newrelic/hooks/database_dbapi2.py | 3 - newrelic/hooks/logger_structlog.py | 2 +- newrelic/packages/asgiref_compatibility.py | 14 +- newrelic/packages/requirements.txt | 6 +- newrelic/packages/urllib3/LICENSE.txt | 2 +- newrelic/packages/urllib3/__init__.py | 155 +- newrelic/packages/urllib3/_base_connection.py | 165 - newrelic/packages/urllib3/_collections.py | 422 +- newrelic/packages/urllib3/_version.py | 36 +- newrelic/packages/urllib3/connection.py | 1175 ++-- newrelic/packages/urllib3/connectionpool.py | 779 ++- .../urllib3/contrib/_appengine_environ.py | 36 + .../contrib/_securetransport/__init__.py | 0 .../contrib/_securetransport/bindings.py | 519 ++ .../contrib/_securetransport/low_level.py | 397 ++ .../packages/urllib3/contrib/appengine.py | 314 ++ .../urllib3/contrib/emscripten/__init__.py | 17 - .../urllib3/contrib/emscripten/connection.py | 260 - .../emscripten/emscripten_fetch_worker.js | 110 - .../urllib3/contrib/emscripten/fetch.py | 726 --- .../urllib3/contrib/emscripten/request.py | 22 - .../urllib3/contrib/emscripten/response.py | 277 - newrelic/packages/urllib3/contrib/ntlmpool.py | 130 + .../packages/urllib3/contrib/pyopenssl.py | 410 +- .../urllib3/contrib/securetransport.py | 920 ++++ newrelic/packages/urllib3/contrib/socks.py | 84 +- newrelic/packages/urllib3/exceptions.py | 208 +- newrelic/packages/urllib3/fields.py | 257 +- newrelic/packages/urllib3/filepost.py | 65 +- newrelic/packages/urllib3/http2/__init__.py | 53 - newrelic/packages/urllib3/http2/connection.py | 356 -- newrelic/packages/urllib3/http2/probe.py | 87 - .../packages/urllib3/packages/__init__.py | 0 .../urllib3/packages/backports/__init__.py | 0 .../urllib3/packages/backports/makefile.py | 51 + .../packages/backports/weakref_finalize.py | 155 + newrelic/packages/urllib3/packages/six.py | 1076 ++++ newrelic/packages/urllib3/poolmanager.py | 359 +- newrelic/packages/urllib3/py.typed | 2 - .../{_request_methods.py => request.py} | 187 +- newrelic/packages/urllib3/response.py | 1295 ++--- newrelic/packages/urllib3/util/__init__.py | 19 +- newrelic/packages/urllib3/util/connection.py | 80 +- newrelic/packages/urllib3/util/proxy.py | 38 +- newrelic/packages/urllib3/util/queue.py | 22 + newrelic/packages/urllib3/util/request.py | 177 +- newrelic/packages/urllib3/util/response.py | 82 +- newrelic/packages/urllib3/util/retry.py | 375 +- newrelic/packages/urllib3/util/ssl_.py | 588 +- .../urllib3/util/ssl_match_hostname.py | 96 +- .../packages/urllib3/util/ssltransport.py | 162 +- newrelic/packages/urllib3/util/timeout.py | 118 +- newrelic/packages/urllib3/util/url.py | 394 +- newrelic/packages/urllib3/util/util.py | 42 - newrelic/packages/urllib3/util/wait.py | 90 +- newrelic/packages/wrapt/LICENSE | 2 +- newrelic/packages/wrapt/__init__.py | 86 +- newrelic/packages/wrapt/__init__.pyi | 319 -- newrelic/packages/wrapt/__wrapt__.py | 50 +- newrelic/packages/wrapt/_wrappers.c | 4821 +++++++---------- newrelic/packages/wrapt/arguments.py | 47 +- newrelic/packages/wrapt/decorators.py | 177 +- newrelic/packages/wrapt/importer.py | 151 +- newrelic/packages/wrapt/patches.py | 144 +- newrelic/packages/wrapt/proxies.py | 351 -- newrelic/packages/wrapt/py.typed | 1 - newrelic/packages/wrapt/weakrefs.py | 40 +- newrelic/packages/wrapt/wrappers.py | 560 +- pyproject.toml | 14 +- setup.py | 18 +- .../test_package_version_utils.py | 27 +- tests/datastore_psycopg/test_cursor.py | 4 +- tests/datastore_psycopg/test_register.py | 4 +- tests/datastore_psycopg/test_rollback.py | 2 +- tests/framework_starlette/test_application.py | 1 + .../_target_schema_async.py | 4 +- .../_target_schema_sync.py | 10 +- .../mlmodel_sklearn/test_inference_events.py | 8 +- tests/testing_support/certs/cert.pem | 124 +- tox.ini | 259 +- 94 files changed, 9295 insertions(+), 11514 deletions(-) delete mode 100644 newrelic/packages/urllib3/_base_connection.py create mode 100644 newrelic/packages/urllib3/contrib/_appengine_environ.py create mode 100644 newrelic/packages/urllib3/contrib/_securetransport/__init__.py create mode 100644 newrelic/packages/urllib3/contrib/_securetransport/bindings.py create mode 100644 newrelic/packages/urllib3/contrib/_securetransport/low_level.py create mode 100644 newrelic/packages/urllib3/contrib/appengine.py delete mode 100644 newrelic/packages/urllib3/contrib/emscripten/__init__.py delete mode 100644 newrelic/packages/urllib3/contrib/emscripten/connection.py delete mode 100644 newrelic/packages/urllib3/contrib/emscripten/emscripten_fetch_worker.js delete mode 100644 newrelic/packages/urllib3/contrib/emscripten/fetch.py delete mode 100644 newrelic/packages/urllib3/contrib/emscripten/request.py delete mode 100644 newrelic/packages/urllib3/contrib/emscripten/response.py create mode 100644 newrelic/packages/urllib3/contrib/ntlmpool.py create mode 100644 newrelic/packages/urllib3/contrib/securetransport.py delete mode 100644 newrelic/packages/urllib3/http2/__init__.py delete mode 100644 newrelic/packages/urllib3/http2/connection.py delete mode 100644 newrelic/packages/urllib3/http2/probe.py create mode 100644 newrelic/packages/urllib3/packages/__init__.py create mode 100644 newrelic/packages/urllib3/packages/backports/__init__.py create mode 100644 newrelic/packages/urllib3/packages/backports/makefile.py create mode 100644 newrelic/packages/urllib3/packages/backports/weakref_finalize.py create mode 100644 newrelic/packages/urllib3/packages/six.py delete mode 100644 newrelic/packages/urllib3/py.typed rename newrelic/packages/urllib3/{_request_methods.py => request.py} (50%) create mode 100644 newrelic/packages/urllib3/util/queue.py delete mode 100644 newrelic/packages/urllib3/util/util.py delete mode 100644 newrelic/packages/wrapt/__init__.pyi delete mode 100644 newrelic/packages/wrapt/proxies.py delete mode 100644 newrelic/packages/wrapt/py.typed diff --git a/.github/.trivyignore b/.github/.trivyignore index fd69f0b5d6..e9de2222cc 100644 --- a/.github/.trivyignore +++ b/.github/.trivyignore @@ -1 +1,16 @@ -# Empty for now +# ============================= +# Accepted Risk Vulnerabilities +# ============================= + +# Accepting risk due to Python 3.8 support. +CVE-2025-50181 # Requires misconfiguration of urllib3, which agent does not do without intervention +CVE-2025-66418 # Malicious servers could cause high resource consumption +CVE-2025-66471 # Malicious servers could cause high resource consumption +CVE-2026-21441 # Improper Handling of Highly Compressed Data (Data Amplification) + +# ======================= +# Ignored Vulnerabilities +# ======================= + +# Not relevant, only affects Pyodide +CVE-2025-50182 diff --git a/.github/containers/Dockerfile b/.github/containers/Dockerfile index b3016548d7..3f370a4a45 100644 --- a/.github/containers/Dockerfile +++ b/.github/containers/Dockerfile @@ -115,7 +115,7 @@ RUN mv "${HOME}/.local/bin/python3.11" "${HOME}/.local/bin/pypy3.11" && \ mv "${HOME}/.local/bin/python3.10" "${HOME}/.local/bin/pypy3.10" # Install CPython versions -RUN uv python install -f cp3.14 cp3.14t cp3.13 cp3.12 cp3.11 cp3.10 cp3.9 +RUN uv python install -f cp3.14 cp3.14t cp3.13 cp3.12 cp3.11 cp3.10 cp3.9 cp3.8 # Set default Python version to CPython 3.13 RUN uv python install -f --default cp3.13 diff --git a/.github/workflows/benchmarks.yml b/.github/workflows/benchmarks.yml index 6375db76a2..2e7094fe09 100644 --- a/.github/workflows/benchmarks.yml +++ b/.github/workflows/benchmarks.yml @@ -32,7 +32,7 @@ jobs: strategy: fail-fast: false matrix: - python: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"] + python: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"] env: ASV_FACTOR: "1.1" diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 0570d3dda6..9f3e4f0a4f 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -29,6 +29,8 @@ jobs: matrix: include: # Linux glibc + - wheel: cp38-manylinux + os: ubuntu-24.04 - wheel: cp39-manylinux os: ubuntu-24.04 - wheel: cp310-manylinux @@ -39,13 +41,11 @@ jobs: os: ubuntu-24.04 - wheel: cp313-manylinux os: ubuntu-24.04 - - wheel: cp313t-manylinux - os: ubuntu-24.04 - wheel: cp314-manylinux os: ubuntu-24.04 - - wheel: cp314t-manylinux - os: ubuntu-24.04 # Linux musllibc + - wheel: cp38-musllinux + os: ubuntu-24.04 - wheel: cp39-musllinux os: ubuntu-24.04 - wheel: cp310-musllinux @@ -56,12 +56,8 @@ jobs: os: ubuntu-24.04 - wheel: cp313-musllinux os: ubuntu-24.04 - - wheel: cp313t-musllinux - os: ubuntu-24.04 - wheel: cp314-musllinux os: ubuntu-24.04 - - wheel: cp314t-musllinux - os: ubuntu-24.04 # Windows # Windows wheels won't but published until the full release announcement. # - wheel: cp313-win @@ -93,7 +89,6 @@ jobs: CIBW_ARCHS_MACOS: native CIBW_ARCHS_WINDOWS: AMD64 ARM64 CIBW_ENVIRONMENT_LINUX: "LD_LIBRARY_PATH=/opt/rh/devtoolset-8/root/usr/lib64:/opt/rh/devtoolset-8/root/usr/lib:/opt/rh/devtoolset-8/root/usr/lib64/dyninst:/opt/rh/devtoolset-8/root/usr/lib/dyninst:/usr/local/lib64:/usr/local/lib" - CIBW_ENABLE: cpython-freethreading CIBW_TEST_REQUIRES: pytest CIBW_TEST_COMMAND_LINUX: "export PYTHONPATH={project}/tests; pytest {project}/tests/agent_unittests -vx" CIBW_TEST_COMMAND_MACOS: "export PYTHONPATH={project}/tests; pytest {project}/tests/agent_unittests -vx" diff --git a/THIRD_PARTY_NOTICES.md b/THIRD_PARTY_NOTICES.md index 312328b613..2aceaea9fa 100644 --- a/THIRD_PARTY_NOTICES.md +++ b/THIRD_PARTY_NOTICES.md @@ -37,7 +37,7 @@ Distributed under the following license(s): ## [urllib3](https://pypi.org/project/urllib3) -Copyright (c) 2008-2020 Andrey Petrov and contributors. +Copyright (c) 2008-2019 Andrey Petrov and contributors (see CONTRIBUTORS.txt) Distributed under the following license(s): @@ -46,7 +46,7 @@ Distributed under the following license(s): ## [wrapt](https://pypi.org/project/wrapt) -Copyright (c) 2013-2025, Graham Dumpleton +Copyright (c) 2013-2019, Graham Dumpleton All rights reserved. Distributed under the following license(s): diff --git a/asv.conf.json b/asv.conf.json index ca6902e314..203d52c887 100644 --- a/asv.conf.json +++ b/asv.conf.json @@ -6,7 +6,7 @@ "repo": ".", "environment_type": "virtualenv", "install_timeout": 120, - "pythons": ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"], + "pythons": ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"], "benchmark_dir": "tests/agent_benchmarks", "env_dir": ".asv/env", "results_dir": ".asv/results", diff --git a/newrelic/admin/__init__.py b/newrelic/admin/__init__.py index fe6433a23e..61f3995a3f 100644 --- a/newrelic/admin/__init__.py +++ b/newrelic/admin/__init__.py @@ -120,7 +120,19 @@ def load_internal_plugins(): def load_external_plugins(): - from importlib.metadata import entry_points + try: + # importlib.metadata was introduced into the standard library starting in Python 3.8. + from importlib.metadata import entry_points + except ImportError: + try: + # importlib_metadata is a backport library installable from PyPI. + from importlib_metadata import entry_points + except ImportError: + try: + # Fallback to pkg_resources, which is available in older versions of setuptools. + from pkg_resources import iter_entry_points as entry_points + except ImportError: + return group = "newrelic.admin" diff --git a/newrelic/common/agent_http.py b/newrelic/common/agent_http.py index 4bca7437cd..7f054cb3c7 100644 --- a/newrelic/common/agent_http.py +++ b/newrelic/common/agent_http.py @@ -354,7 +354,9 @@ def _connection(self): return self._connection_attr retries = urllib3.Retry(total=False, connect=None, read=None, redirect=0, status=None) - self._connection_attr = self.CONNECTION_CLS(self._host, self._port, retries=retries, **self._connection_kwargs) + self._connection_attr = self.CONNECTION_CLS( + self._host, self._port, strict=True, retries=retries, **self._connection_kwargs + ) return self._connection_attr def close_connection(self): diff --git a/newrelic/common/object_wrapper.py b/newrelic/common/object_wrapper.py index e535559109..be8c351f4e 100644 --- a/newrelic/common/object_wrapper.py +++ b/newrelic/common/object_wrapper.py @@ -21,16 +21,11 @@ import inspect -from newrelic.packages.wrapt import ( # noqa: F401 - BaseObjectProxy, - apply_patch, - resolve_path, - wrap_object, - wrap_object_attribute, -) from newrelic.packages.wrapt import BoundFunctionWrapper as _BoundFunctionWrapper from newrelic.packages.wrapt import CallableObjectProxy as _CallableObjectProxy from newrelic.packages.wrapt import FunctionWrapper as _FunctionWrapper +from newrelic.packages.wrapt import ObjectProxy as _ObjectProxy +from newrelic.packages.wrapt import apply_patch, resolve_path, wrap_object, wrap_object_attribute # noqa: F401 # We previously had our own pure Python implementation of the generic # object wrapper but we now defer to using the wrapt module as its C @@ -49,7 +44,7 @@ # ObjectProxy or FunctionWrapper should be used going forward. -class ObjectProxy(BaseObjectProxy): +class ObjectProxy(_ObjectProxy): """ This class provides method overrides for all object wrappers used by the agent. These methods allow attributes to be defined with the special prefix diff --git a/newrelic/common/package_version_utils.py b/newrelic/common/package_version_utils.py index 38c85057d0..da40f0dffa 100644 --- a/newrelic/common/package_version_utils.py +++ b/newrelic/common/package_version_utils.py @@ -12,7 +12,6 @@ # See the License for the specific language governing permissions and # limitations under the License. -import importlib.metadata as importlib_metadata import sys import warnings from functools import lru_cache @@ -96,17 +95,37 @@ def _get_package_version(name): except Exception: pass - try: - # In Python 3.10+ packages_distribution can be checked for as well. - if hasattr(importlib_metadata, "packages_distributions"): - distributions = importlib_metadata.packages_distributions() - distribution_name = distributions.get(name, name) - distribution_name = distribution_name[0] if isinstance(distribution_name, list) else distribution_name - else: - distribution_name = name - - version = importlib_metadata.version(distribution_name) - if version not in NULL_VERSIONS: - return version - except Exception: - pass + importlib_metadata = None + # importlib.metadata was introduced into the standard library starting in Python 3.8. + importlib_metadata = getattr(sys.modules.get("importlib", None), "metadata", None) + if importlib_metadata is None: + # importlib_metadata is a backport library installable from PyPI. + try: + import importlib_metadata + except ImportError: + pass + + if importlib_metadata is not None: + try: + # In Python 3.10+ packages_distribution can be checked for as well. + if hasattr(importlib_metadata, "packages_distributions"): + distributions = importlib_metadata.packages_distributions() + distribution_name = distributions.get(name, name) + distribution_name = distribution_name[0] if isinstance(distribution_name, list) else distribution_name + else: + distribution_name = name + + version = importlib_metadata.version(distribution_name) + if version not in NULL_VERSIONS: + return version + except Exception: + pass + + # Fallback to pkg_resources, which is available in older versions of setuptools. + if "pkg_resources" in sys.modules: + try: + version = sys.modules["pkg_resources"].get_distribution(name).version + if version not in NULL_VERSIONS: + return version + except Exception: + pass diff --git a/newrelic/config.py b/newrelic/config.py index 51e477416d..3960e4e1ea 100644 --- a/newrelic/config.py +++ b/newrelic/config.py @@ -4226,7 +4226,19 @@ def _process_module_builtin_defaults(): def _process_module_entry_points(): - from importlib.metadata import entry_points + try: + # importlib.metadata was introduced into the standard library starting in Python 3.8. + from importlib.metadata import entry_points + except ImportError: + try: + # importlib_metadata is a backport library installable from PyPI. + from importlib_metadata import entry_points + except ImportError: + try: + # Fallback to pkg_resources, which is available in older versions of setuptools. + from pkg_resources import iter_entry_points as entry_points + except ImportError: + return group = "newrelic.hooks" @@ -4294,7 +4306,19 @@ def _setup_instrumentation(): def _setup_extensions(): - from importlib.metadata import entry_points + try: + # importlib.metadata was introduced into the standard library starting in Python 3.8. + from importlib.metadata import entry_points + except ImportError: + try: + # importlib_metadata is a backport library installable from PyPI. + from importlib_metadata import entry_points + except ImportError: + try: + # Fallback to pkg_resources, which is available in older versions of setuptools. + from pkg_resources import iter_entry_points as entry_points + except ImportError: + return group = "newrelic.extension" diff --git a/newrelic/core/_thread_utilization.c b/newrelic/core/_thread_utilization.c index 18f081a5be..d1d7bfacc6 100644 --- a/newrelic/core/_thread_utilization.c +++ b/newrelic/core/_thread_utilization.c @@ -202,10 +202,13 @@ static PyObject *NRUtilization_new(PyTypeObject *type, return NULL; /* - * Using a mutex to ensure this is compatible with free threaded Python interpreters. - * In the past, this relied on the GIL for thread safety with weakrefs but that was - * not reliable enough anyway. + * XXX Using a mutex for now just in case the calls to get + * the current thread are causing release of GIL in a + * multithreaded context. May explain why having issues with + * object referred to by weakrefs being corrupted. The GIL + * should technically be enough to protect us here. */ + self->thread_mutex = PyThread_allocate_lock(); self->set_of_all_threads = PyDict_New(); @@ -452,10 +455,6 @@ moduleinit(void) PyModule_AddObject(module, "ThreadUtilization", (PyObject *)&NRUtilization_Type); -#ifdef Py_GIL_DISABLED - PyUnstable_Module_SetGIL(module, Py_MOD_GIL_NOT_USED); -#endif - return module; } diff --git a/newrelic/core/config.py b/newrelic/core/config.py index c6b2d4233e..8cfdeda0ae 100644 --- a/newrelic/core/config.py +++ b/newrelic/core/config.py @@ -1119,7 +1119,8 @@ def _flatten(settings, o, name=None): for key, value in vars(o).items(): # Remove any leading underscores on keys accessed through # properties for reporting. - key = key.removeprefix("_") + if key.startswith("_"): + key = key[1:] if name: key = f"{name}.{key}" diff --git a/newrelic/core/environment.py b/newrelic/core/environment.py index 11203df657..7d3a04f1b6 100644 --- a/newrelic/core/environment.py +++ b/newrelic/core/environment.py @@ -248,7 +248,13 @@ def _get_stdlib_builtin_module_names(): # Since sys.stdlib_module_names is not available in versions of python below 3.10, # use isort's hardcoded stdlibs instead. python_version = sys.version_info[0:2] - if python_version < (3, 10): + if python_version < (3,): + stdlibs = isort_stdlibs.py27.stdlib + elif (3, 7) <= python_version < (3, 8): + stdlibs = isort_stdlibs.py37.stdlib + elif python_version < (3, 9): + stdlibs = isort_stdlibs.py38.stdlib + elif python_version < (3, 10): stdlibs = isort_stdlibs.py39.stdlib elif python_version >= (3, 10): stdlibs = sys.stdlib_module_names diff --git a/newrelic/hooks/database_dbapi2.py b/newrelic/hooks/database_dbapi2.py index 1e38880113..b100fa58de 100644 --- a/newrelic/hooks/database_dbapi2.py +++ b/newrelic/hooks/database_dbapi2.py @@ -89,9 +89,6 @@ def callproc(self, procname, parameters=DEFAULT): else: return self.__wrapped__.callproc(procname) - def __iter__(self): - return iter(self.__wrapped__) - class ConnectionWrapper(ObjectProxy): __cursor_wrapper__ = CursorWrapper diff --git a/newrelic/hooks/logger_structlog.py b/newrelic/hooks/logger_structlog.py index 66d7102505..8d9ba3cc5d 100644 --- a/newrelic/hooks/logger_structlog.py +++ b/newrelic/hooks/logger_structlog.py @@ -22,7 +22,7 @@ from newrelic.hooks.logger_logging import add_nr_linking_metadata -@functools.cache +@functools.lru_cache(maxsize=None) def normalize_level_name(method_name): # Look up level number for method name, using result to look up level name for that level number. # Convert result to upper case, and default to UNKNOWN in case of errors or missing values. diff --git a/newrelic/packages/asgiref_compatibility.py b/newrelic/packages/asgiref_compatibility.py index 444fa52582..f5b029b1da 100644 --- a/newrelic/packages/asgiref_compatibility.py +++ b/newrelic/packages/asgiref_compatibility.py @@ -30,16 +30,6 @@ import inspect -# Python 3.12 deprecates asyncio.iscoroutinefunction() as an alias for -# inspect.iscoroutinefunction(), whilst also removing the _is_coroutine marker. -# The latter is replaced with the inspect.markcoroutinefunction decorator. -# Until 3.12 is the minimum supported Python version, provide a shim. - -if hasattr(inspect, "iscoroutinefunction"): - iscoroutinefunction = inspect.iscoroutinefunction -else: - iscoroutinefunction = asyncio.iscoroutinefunction # type: ignore[assignment] - def is_double_callable(application): """ Tests to see if an application is a legacy-style (double-callable) application. @@ -56,10 +46,10 @@ def is_double_callable(application): if hasattr(application, "__call__"): # We only check to see if its __call__ is a coroutine function - # if it's not, it still might be a coroutine function itself. - if iscoroutinefunction(application.__call__): + if asyncio.iscoroutinefunction(application.__call__): return False # Non-classes we just check directly - return not iscoroutinefunction(application) + return not asyncio.iscoroutinefunction(application) def double_to_single_callable(application): diff --git a/newrelic/packages/requirements.txt b/newrelic/packages/requirements.txt index 9a251fb557..5d8c59db2e 100644 --- a/newrelic/packages/requirements.txt +++ b/newrelic/packages/requirements.txt @@ -3,6 +3,6 @@ # This file is used by dependabot to keep track of and recommend updates # to the New Relic Python Agent's dependencies in newrelic/packages/. opentelemetry_proto==1.32.1 -urllib3==2.6.3 -wrapt==2.0.1 -asgiref==3.11.0 # We only vendor asgiref.compatibility.py +urllib3==1.26.19 +wrapt==1.16.0 +asgiref==3.6.0 # We only vendor asgiref.compatibility.py diff --git a/newrelic/packages/urllib3/LICENSE.txt b/newrelic/packages/urllib3/LICENSE.txt index e6183d0276..429a1767e4 100644 --- a/newrelic/packages/urllib3/LICENSE.txt +++ b/newrelic/packages/urllib3/LICENSE.txt @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2008-2020 Andrey Petrov and contributors. +Copyright (c) 2008-2020 Andrey Petrov and contributors (see CONTRIBUTORS.txt) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/newrelic/packages/urllib3/__init__.py b/newrelic/packages/urllib3/__init__.py index 3fe782c8a4..c6fa38212f 100644 --- a/newrelic/packages/urllib3/__init__.py +++ b/newrelic/packages/urllib3/__init__.py @@ -1,49 +1,40 @@ """ Python HTTP library with thread-safe connection pooling, file post support, user friendly, and more """ - -from __future__ import annotations +from __future__ import absolute_import # Set default logging handler to avoid "No handler found" warnings. import logging -import sys -import typing import warnings from logging import NullHandler from . import exceptions -from ._base_connection import _TYPE_BODY -from ._collections import HTTPHeaderDict from ._version import __version__ from .connectionpool import HTTPConnectionPool, HTTPSConnectionPool, connection_from_url -from .filepost import _TYPE_FIELDS, encode_multipart_formdata +from .filepost import encode_multipart_formdata from .poolmanager import PoolManager, ProxyManager, proxy_from_url -from .response import BaseHTTPResponse, HTTPResponse +from .response import HTTPResponse from .util.request import make_headers from .util.retry import Retry from .util.timeout import Timeout +from .util.url import get_host -# Ensure that Python is compiled with OpenSSL 1.1.1+ -# If the 'ssl' module isn't available at all that's -# fine, we only care if the module is available. +# === NOTE TO REPACKAGERS AND VENDORS === +# Please delete this block, this logic is only +# for urllib3 being distributed via PyPI. +# See: https://github.com/urllib3/urllib3/issues/2680 try: - import ssl + import urllib3_secure_extra # type: ignore # noqa: F401 except ImportError: pass else: - if not ssl.OPENSSL_VERSION.startswith("OpenSSL "): # Defensive: - warnings.warn( - "urllib3 v2 only supports OpenSSL 1.1.1+, currently " - f"the 'ssl' module is compiled with {ssl.OPENSSL_VERSION!r}. " - "See: https://github.com/urllib3/urllib3/issues/3020", - exceptions.NotOpenSSLWarning, - ) - elif ssl.OPENSSL_VERSION_INFO < (1, 1, 1): # Defensive: - raise ImportError( - "urllib3 v2 only supports OpenSSL 1.1.1+, currently " - f"the 'ssl' module is compiled with {ssl.OPENSSL_VERSION!r}. " - "See: https://github.com/urllib3/urllib3/issues/2168" - ) + warnings.warn( + "'urllib3[secure]' extra is deprecated and will be removed " + "in a future release of urllib3 2.x. Read more in this issue: " + "https://github.com/urllib3/urllib3/issues/2680", + category=DeprecationWarning, + stacklevel=2, + ) __author__ = "Andrey Petrov (andrey.petrov@shazow.net)" __license__ = "MIT" @@ -51,7 +42,6 @@ __all__ = ( "HTTPConnectionPool", - "HTTPHeaderDict", "HTTPSConnectionPool", "PoolManager", "ProxyManager", @@ -62,18 +52,15 @@ "connection_from_url", "disable_warnings", "encode_multipart_formdata", + "get_host", "make_headers", "proxy_from_url", - "request", - "BaseHTTPResponse", ) logging.getLogger(__name__).addHandler(NullHandler()) -def add_stderr_logger( - level: int = logging.DEBUG, -) -> logging.StreamHandler[typing.TextIO]: +def add_stderr_logger(level=logging.DEBUG): """ Helper for quickly adding a StreamHandler to the logger. Useful for debugging. @@ -100,112 +87,16 @@ def add_stderr_logger( # mechanisms to silence them. # SecurityWarning's always go off by default. warnings.simplefilter("always", exceptions.SecurityWarning, append=True) +# SubjectAltNameWarning's should go off once per host +warnings.simplefilter("default", exceptions.SubjectAltNameWarning, append=True) # InsecurePlatformWarning's don't vary between requests, so we keep it default. warnings.simplefilter("default", exceptions.InsecurePlatformWarning, append=True) +# SNIMissingWarnings should go off only once. +warnings.simplefilter("default", exceptions.SNIMissingWarning, append=True) -def disable_warnings(category: type[Warning] = exceptions.HTTPWarning) -> None: +def disable_warnings(category=exceptions.HTTPWarning): """ Helper for quickly disabling all urllib3 warnings. """ warnings.simplefilter("ignore", category) - - -_DEFAULT_POOL = PoolManager() - - -def request( - method: str, - url: str, - *, - body: _TYPE_BODY | None = None, - fields: _TYPE_FIELDS | None = None, - headers: typing.Mapping[str, str] | None = None, - preload_content: bool | None = True, - decode_content: bool | None = True, - redirect: bool | None = True, - retries: Retry | bool | int | None = None, - timeout: Timeout | float | int | None = 3, - json: typing.Any | None = None, -) -> BaseHTTPResponse: - """ - A convenience, top-level request method. It uses a module-global ``PoolManager`` instance. - Therefore, its side effects could be shared across dependencies relying on it. - To avoid side effects create a new ``PoolManager`` instance and use it instead. - The method does not accept low-level ``**urlopen_kw`` keyword arguments. - - :param method: - HTTP request method (such as GET, POST, PUT, etc.) - - :param url: - The URL to perform the request on. - - :param body: - Data to send in the request body, either :class:`str`, :class:`bytes`, - an iterable of :class:`str`/:class:`bytes`, or a file-like object. - - :param fields: - Data to encode and send in the request body. - - :param headers: - Dictionary of custom headers to send, such as User-Agent, - If-None-Match, etc. - - :param bool preload_content: - If True, the response's body will be preloaded into memory. - - :param bool decode_content: - If True, will attempt to decode the body based on the - 'content-encoding' header. - - :param redirect: - If True, automatically handle redirects (status codes 301, 302, - 303, 307, 308). Each redirect counts as a retry. Disabling retries - will disable redirect, too. - - :param retries: - Configure the number of retries to allow before raising a - :class:`~urllib3.exceptions.MaxRetryError` exception. - - If ``None`` (default) will retry 3 times, see ``Retry.DEFAULT``. Pass a - :class:`~urllib3.util.retry.Retry` object for fine-grained control - over different types of retries. - Pass an integer number to retry connection errors that many times, - but no other types of errors. Pass zero to never retry. - - If ``False``, then retries are disabled and any exception is raised - immediately. Also, instead of raising a MaxRetryError on redirects, - the redirect response will be returned. - - :type retries: :class:`~urllib3.util.retry.Retry`, False, or an int. - - :param timeout: - If specified, overrides the default timeout for this one - request. It may be a float (in seconds) or an instance of - :class:`urllib3.util.Timeout`. - - :param json: - Data to encode and send as JSON with UTF-encoded in the request body. - The ``"Content-Type"`` header will be set to ``"application/json"`` - unless specified otherwise. - """ - - return _DEFAULT_POOL.request( - method, - url, - body=body, - fields=fields, - headers=headers, - preload_content=preload_content, - decode_content=decode_content, - redirect=redirect, - retries=retries, - timeout=timeout, - json=json, - ) - - -if sys.platform == "emscripten": - from .contrib.emscripten import inject_into_urllib3 # noqa: 401 - - inject_into_urllib3() diff --git a/newrelic/packages/urllib3/_base_connection.py b/newrelic/packages/urllib3/_base_connection.py deleted file mode 100644 index dc0f318c0b..0000000000 --- a/newrelic/packages/urllib3/_base_connection.py +++ /dev/null @@ -1,165 +0,0 @@ -from __future__ import annotations - -import typing - -from .util.connection import _TYPE_SOCKET_OPTIONS -from .util.timeout import _DEFAULT_TIMEOUT, _TYPE_TIMEOUT -from .util.url import Url - -_TYPE_BODY = typing.Union[bytes, typing.IO[typing.Any], typing.Iterable[bytes], str] - - -class ProxyConfig(typing.NamedTuple): - ssl_context: ssl.SSLContext | None - use_forwarding_for_https: bool - assert_hostname: None | str | typing.Literal[False] - assert_fingerprint: str | None - - -class _ResponseOptions(typing.NamedTuple): - # TODO: Remove this in favor of a better - # HTTP request/response lifecycle tracking. - request_method: str - request_url: str - preload_content: bool - decode_content: bool - enforce_content_length: bool - - -if typing.TYPE_CHECKING: - import ssl - from typing import Protocol - - from .response import BaseHTTPResponse - - class BaseHTTPConnection(Protocol): - default_port: typing.ClassVar[int] - default_socket_options: typing.ClassVar[_TYPE_SOCKET_OPTIONS] - - host: str - port: int - timeout: None | ( - float - ) # Instance doesn't store _DEFAULT_TIMEOUT, must be resolved. - blocksize: int - source_address: tuple[str, int] | None - socket_options: _TYPE_SOCKET_OPTIONS | None - - proxy: Url | None - proxy_config: ProxyConfig | None - - is_verified: bool - proxy_is_verified: bool | None - - def __init__( - self, - host: str, - port: int | None = None, - *, - timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, - source_address: tuple[str, int] | None = None, - blocksize: int = 8192, - socket_options: _TYPE_SOCKET_OPTIONS | None = ..., - proxy: Url | None = None, - proxy_config: ProxyConfig | None = None, - ) -> None: ... - - def set_tunnel( - self, - host: str, - port: int | None = None, - headers: typing.Mapping[str, str] | None = None, - scheme: str = "http", - ) -> None: ... - - def connect(self) -> None: ... - - def request( - self, - method: str, - url: str, - body: _TYPE_BODY | None = None, - headers: typing.Mapping[str, str] | None = None, - # We know *at least* botocore is depending on the order of the - # first 3 parameters so to be safe we only mark the later ones - # as keyword-only to ensure we have space to extend. - *, - chunked: bool = False, - preload_content: bool = True, - decode_content: bool = True, - enforce_content_length: bool = True, - ) -> None: ... - - def getresponse(self) -> BaseHTTPResponse: ... - - def close(self) -> None: ... - - @property - def is_closed(self) -> bool: - """Whether the connection either is brand new or has been previously closed. - If this property is True then both ``is_connected`` and ``has_connected_to_proxy`` - properties must be False. - """ - - @property - def is_connected(self) -> bool: - """Whether the connection is actively connected to any origin (proxy or target)""" - - @property - def has_connected_to_proxy(self) -> bool: - """Whether the connection has successfully connected to its proxy. - This returns False if no proxy is in use. Used to determine whether - errors are coming from the proxy layer or from tunnelling to the target origin. - """ - - class BaseHTTPSConnection(BaseHTTPConnection, Protocol): - default_port: typing.ClassVar[int] - default_socket_options: typing.ClassVar[_TYPE_SOCKET_OPTIONS] - - # Certificate verification methods - cert_reqs: int | str | None - assert_hostname: None | str | typing.Literal[False] - assert_fingerprint: str | None - ssl_context: ssl.SSLContext | None - - # Trusted CAs - ca_certs: str | None - ca_cert_dir: str | None - ca_cert_data: None | str | bytes - - # TLS version - ssl_minimum_version: int | None - ssl_maximum_version: int | None - ssl_version: int | str | None # Deprecated - - # Client certificates - cert_file: str | None - key_file: str | None - key_password: str | None - - def __init__( - self, - host: str, - port: int | None = None, - *, - timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, - source_address: tuple[str, int] | None = None, - blocksize: int = 16384, - socket_options: _TYPE_SOCKET_OPTIONS | None = ..., - proxy: Url | None = None, - proxy_config: ProxyConfig | None = None, - cert_reqs: int | str | None = None, - assert_hostname: None | str | typing.Literal[False] = None, - assert_fingerprint: str | None = None, - server_hostname: str | None = None, - ssl_context: ssl.SSLContext | None = None, - ca_certs: str | None = None, - ca_cert_dir: str | None = None, - ca_cert_data: None | str | bytes = None, - ssl_minimum_version: int | None = None, - ssl_maximum_version: int | None = None, - ssl_version: int | str | None = None, # Deprecated - cert_file: str | None = None, - key_file: str | None = None, - key_password: str | None = None, - ) -> None: ... diff --git a/newrelic/packages/urllib3/_collections.py b/newrelic/packages/urllib3/_collections.py index 0378aab1b1..bceb8451f0 100644 --- a/newrelic/packages/urllib3/_collections.py +++ b/newrelic/packages/urllib3/_collections.py @@ -1,66 +1,34 @@ -from __future__ import annotations +from __future__ import absolute_import + +try: + from collections.abc import Mapping, MutableMapping +except ImportError: + from collections import Mapping, MutableMapping +try: + from threading import RLock +except ImportError: # Platform-specific: No threads available + + class RLock: + def __enter__(self): + pass -import typing -from collections import OrderedDict -from enum import Enum, auto -from threading import RLock + def __exit__(self, exc_type, exc_value, traceback): + pass -if typing.TYPE_CHECKING: - # We can only import Protocol if TYPE_CHECKING because it's a development - # dependency, and is not available at runtime. - from typing import Protocol - from typing_extensions import Self +from collections import OrderedDict - class HasGettableStringKeys(Protocol): - def keys(self) -> typing.Iterator[str]: ... +from .exceptions import InvalidHeader +from .packages import six +from .packages.six import iterkeys, itervalues - def __getitem__(self, key: str) -> str: ... +__all__ = ["RecentlyUsedContainer", "HTTPHeaderDict"] -__all__ = ["RecentlyUsedContainer", "HTTPHeaderDict"] +_Null = object() -# Key type -_KT = typing.TypeVar("_KT") -# Value type -_VT = typing.TypeVar("_VT") -# Default type -_DT = typing.TypeVar("_DT") - -ValidHTTPHeaderSource = typing.Union[ - "HTTPHeaderDict", - typing.Mapping[str, str], - typing.Iterable[tuple[str, str]], - "HasGettableStringKeys", -] - - -class _Sentinel(Enum): - not_passed = auto() - - -def ensure_can_construct_http_header_dict( - potential: object, -) -> ValidHTTPHeaderSource | None: - if isinstance(potential, HTTPHeaderDict): - return potential - elif isinstance(potential, typing.Mapping): - # Full runtime checking of the contents of a Mapping is expensive, so for the - # purposes of typechecking, we assume that any Mapping is the right shape. - return typing.cast(typing.Mapping[str, str], potential) - elif isinstance(potential, typing.Iterable): - # Similarly to Mapping, full runtime checking of the contents of an Iterable is - # expensive, so for the purposes of typechecking, we assume that any Iterable - # is the right shape. - return typing.cast(typing.Iterable[tuple[str, str]], potential) - elif hasattr(potential, "keys") and hasattr(potential, "__getitem__"): - return typing.cast("HasGettableStringKeys", potential) - else: - return None - - -class RecentlyUsedContainer(typing.Generic[_KT, _VT], typing.MutableMapping[_KT, _VT]): +class RecentlyUsedContainer(MutableMapping): """ Provides a thread-safe dict-like container which maintains up to ``maxsize`` keys while throwing away the least-recently-used keys beyond @@ -74,134 +42,69 @@ class RecentlyUsedContainer(typing.Generic[_KT, _VT], typing.MutableMapping[_KT, ``dispose_func(value)`` is called. Callback which will get called """ - _container: typing.OrderedDict[_KT, _VT] - _maxsize: int - dispose_func: typing.Callable[[_VT], None] | None - lock: RLock - - def __init__( - self, - maxsize: int = 10, - dispose_func: typing.Callable[[_VT], None] | None = None, - ) -> None: - super().__init__() + ContainerCls = OrderedDict + + def __init__(self, maxsize=10, dispose_func=None): self._maxsize = maxsize self.dispose_func = dispose_func - self._container = OrderedDict() + + self._container = self.ContainerCls() self.lock = RLock() - def __getitem__(self, key: _KT) -> _VT: + def __getitem__(self, key): # Re-insert the item, moving it to the end of the eviction line. with self.lock: item = self._container.pop(key) self._container[key] = item return item - def __setitem__(self, key: _KT, value: _VT) -> None: - evicted_item = None + def __setitem__(self, key, value): + evicted_value = _Null with self.lock: # Possibly evict the existing value of 'key' - try: - # If the key exists, we'll overwrite it, which won't change the - # size of the pool. Because accessing a key should move it to - # the end of the eviction line, we pop it out first. - evicted_item = key, self._container.pop(key) - self._container[key] = value - except KeyError: - # When the key does not exist, we insert the value first so that - # evicting works in all cases, including when self._maxsize is 0 - self._container[key] = value - if len(self._container) > self._maxsize: - # If we didn't evict an existing value, and we've hit our maximum - # size, then we have to evict the least recently used item from - # the beginning of the container. - evicted_item = self._container.popitem(last=False) - - # After releasing the lock on the pool, dispose of any evicted value. - if evicted_item is not None and self.dispose_func: - _, evicted_value = evicted_item + evicted_value = self._container.get(key, _Null) + self._container[key] = value + + # If we didn't evict an existing value, we might have to evict the + # least recently used item from the beginning of the container. + if len(self._container) > self._maxsize: + _key, evicted_value = self._container.popitem(last=False) + + if self.dispose_func and evicted_value is not _Null: self.dispose_func(evicted_value) - def __delitem__(self, key: _KT) -> None: + def __delitem__(self, key): with self.lock: value = self._container.pop(key) if self.dispose_func: self.dispose_func(value) - def __len__(self) -> int: + def __len__(self): with self.lock: return len(self._container) - def __iter__(self) -> typing.NoReturn: + def __iter__(self): raise NotImplementedError( "Iteration over this class is unlikely to be threadsafe." ) - def clear(self) -> None: + def clear(self): with self.lock: # Copy pointers to all values, then wipe the mapping - values = list(self._container.values()) + values = list(itervalues(self._container)) self._container.clear() if self.dispose_func: for value in values: self.dispose_func(value) - def keys(self) -> set[_KT]: # type: ignore[override] + def keys(self): with self.lock: - return set(self._container.keys()) - + return list(iterkeys(self._container)) -class HTTPHeaderDictItemView(set[tuple[str, str]]): - """ - HTTPHeaderDict is unusual for a Mapping[str, str] in that it has two modes of - address. - - If we directly try to get an item with a particular name, we will get a string - back that is the concatenated version of all the values: - - >>> d['X-Header-Name'] - 'Value1, Value2, Value3' - - However, if we iterate over an HTTPHeaderDict's items, we will optionally combine - these values based on whether combine=True was called when building up the dictionary - - >>> d = HTTPHeaderDict({"A": "1", "B": "foo"}) - >>> d.add("A", "2", combine=True) - >>> d.add("B", "bar") - >>> list(d.items()) - [ - ('A', '1, 2'), - ('B', 'foo'), - ('B', 'bar'), - ] - - This class conforms to the interface required by the MutableMapping ABC while - also giving us the nonstandard iteration behavior we want; items with duplicate - keys, ordered by time of first insertion. - """ - - _headers: HTTPHeaderDict - - def __init__(self, headers: HTTPHeaderDict) -> None: - self._headers = headers - - def __len__(self) -> int: - return len(list(self._headers.iteritems())) - - def __iter__(self) -> typing.Iterator[tuple[str, str]]: - return self._headers.iteritems() - def __contains__(self, item: object) -> bool: - if isinstance(item, tuple) and len(item) == 2: - passed_key, passed_val = item - if isinstance(passed_key, str) and isinstance(passed_val, str): - return self._headers._has_value_for_header(passed_key, passed_val) - return False - - -class HTTPHeaderDict(typing.MutableMapping[str, str]): +class HTTPHeaderDict(MutableMapping): """ :param headers: An iterable of field-value pairs. Must not contain multiple field names @@ -235,11 +138,9 @@ class HTTPHeaderDict(typing.MutableMapping[str, str]): '7' """ - _container: typing.MutableMapping[str, list[str]] - - def __init__(self, headers: ValidHTTPHeaderSource | None = None, **kwargs: str): - super().__init__() - self._container = {} # 'dict' is insert-ordered + def __init__(self, headers=None, **kwargs): + super(HTTPHeaderDict, self).__init__() + self._container = OrderedDict() if headers is not None: if isinstance(headers, HTTPHeaderDict): self._copy_from(headers) @@ -248,156 +149,126 @@ def __init__(self, headers: ValidHTTPHeaderSource | None = None, **kwargs: str): if kwargs: self.extend(kwargs) - def __setitem__(self, key: str, val: str) -> None: - # avoid a bytes/str comparison by decoding before httplib - if isinstance(key, bytes): - key = key.decode("latin-1") + def __setitem__(self, key, val): self._container[key.lower()] = [key, val] + return self._container[key.lower()] - def __getitem__(self, key: str) -> str: - if isinstance(key, bytes): - key = key.decode("latin-1") + def __getitem__(self, key): val = self._container[key.lower()] return ", ".join(val[1:]) - def __delitem__(self, key: str) -> None: - if isinstance(key, bytes): - key = key.decode("latin-1") + def __delitem__(self, key): del self._container[key.lower()] - def __contains__(self, key: object) -> bool: - if isinstance(key, bytes): - key = key.decode("latin-1") - if isinstance(key, str): - return key.lower() in self._container - return False - - def setdefault(self, key: str, default: str = "") -> str: - return super().setdefault(key, default) + def __contains__(self, key): + return key.lower() in self._container - def __eq__(self, other: object) -> bool: - maybe_constructable = ensure_can_construct_http_header_dict(other) - if maybe_constructable is None: + def __eq__(self, other): + if not isinstance(other, Mapping) and not hasattr(other, "keys"): return False - else: - other_as_http_header_dict = type(self)(maybe_constructable) - - return {k.lower(): v for k, v in self.itermerged()} == { - k.lower(): v for k, v in other_as_http_header_dict.itermerged() - } + if not isinstance(other, type(self)): + other = type(self)(other) + return dict((k.lower(), v) for k, v in self.itermerged()) == dict( + (k.lower(), v) for k, v in other.itermerged() + ) - def __ne__(self, other: object) -> bool: + def __ne__(self, other): return not self.__eq__(other) - def __len__(self) -> int: + if six.PY2: # Python 2 + iterkeys = MutableMapping.iterkeys + itervalues = MutableMapping.itervalues + + __marker = object() + + def __len__(self): return len(self._container) - def __iter__(self) -> typing.Iterator[str]: + def __iter__(self): # Only provide the originally cased names for vals in self._container.values(): yield vals[0] - def discard(self, key: str) -> None: + def pop(self, key, default=__marker): + """D.pop(k[,d]) -> v, remove specified key and return the corresponding value. + If key is not found, d is returned if given, otherwise KeyError is raised. + """ + # Using the MutableMapping function directly fails due to the private marker. + # Using ordinary dict.pop would expose the internal structures. + # So let's reinvent the wheel. + try: + value = self[key] + except KeyError: + if default is self.__marker: + raise + return default + else: + del self[key] + return value + + def discard(self, key): try: del self[key] except KeyError: pass - def add(self, key: str, val: str, *, combine: bool = False) -> None: + def add(self, key, val): """Adds a (name, value) pair, doesn't overwrite the value if it already exists. - If this is called with combine=True, instead of adding a new header value - as a distinct item during iteration, this will instead append the value to - any existing header value with a comma. If no existing header value exists - for the key, then the value will simply be added, ignoring the combine parameter. - >>> headers = HTTPHeaderDict(foo='bar') >>> headers.add('Foo', 'baz') >>> headers['foo'] 'bar, baz' - >>> list(headers.items()) - [('foo', 'bar'), ('foo', 'baz')] - >>> headers.add('foo', 'quz', combine=True) - >>> list(headers.items()) - [('foo', 'bar, baz, quz')] """ - # avoid a bytes/str comparison by decoding before httplib - if isinstance(key, bytes): - key = key.decode("latin-1") key_lower = key.lower() new_vals = [key, val] # Keep the common case aka no item present as fast as possible vals = self._container.setdefault(key_lower, new_vals) if new_vals is not vals: - # if there are values here, then there is at least the initial - # key/value pair - assert len(vals) >= 2 - if combine: - vals[-1] = vals[-1] + ", " + val - else: - vals.append(val) + vals.append(val) - def extend(self, *args: ValidHTTPHeaderSource, **kwargs: str) -> None: + def extend(self, *args, **kwargs): """Generic import function for any type of header-like object. Adapted version of MutableMapping.update in order to insert items with self.add instead of self.__setitem__ """ if len(args) > 1: raise TypeError( - f"extend() takes at most 1 positional arguments ({len(args)} given)" + "extend() takes at most 1 positional " + "arguments ({0} given)".format(len(args)) ) other = args[0] if len(args) >= 1 else () if isinstance(other, HTTPHeaderDict): for key, val in other.iteritems(): self.add(key, val) - elif isinstance(other, typing.Mapping): - for key, val in other.items(): - self.add(key, val) - elif isinstance(other, typing.Iterable): - other = typing.cast(typing.Iterable[tuple[str, str]], other) - for key, value in other: - self.add(key, value) - elif hasattr(other, "keys") and hasattr(other, "__getitem__"): - # THIS IS NOT A TYPESAFE BRANCH - # In this branch, the object has a `keys` attr but is not a Mapping or any of - # the other types indicated in the method signature. We do some stuff with - # it as though it partially implements the Mapping interface, but we're not - # doing that stuff safely AT ALL. + elif isinstance(other, Mapping): + for key in other: + self.add(key, other[key]) + elif hasattr(other, "keys"): for key in other.keys(): self.add(key, other[key]) + else: + for key, value in other: + self.add(key, value) for key, value in kwargs.items(): self.add(key, value) - @typing.overload - def getlist(self, key: str) -> list[str]: ... - - @typing.overload - def getlist(self, key: str, default: _DT) -> list[str] | _DT: ... - - def getlist( - self, key: str, default: _Sentinel | _DT = _Sentinel.not_passed - ) -> list[str] | _DT: + def getlist(self, key, default=__marker): """Returns a list of all the values for the named field. Returns an empty list if the key doesn't exist.""" - if isinstance(key, bytes): - key = key.decode("latin-1") try: vals = self._container[key.lower()] except KeyError: - if default is _Sentinel.not_passed: - # _DT is unbound; empty list is instance of List[str] + if default is self.__marker: return [] - # _DT is bound; default is instance of _DT return default else: - # _DT may or may not be bound; vals[1:] is instance of List[str], which - # meets our external interface requirement of `Union[List[str], _DT]`. return vals[1:] - def _prepare_for_method_change(self) -> Self: + def _prepare_for_method_change(self): """ Remove content-specific header fields before changing the request method to GET or HEAD according to RFC 9110, Section 15.4. @@ -423,65 +294,62 @@ def _prepare_for_method_change(self) -> Self: # Backwards compatibility for http.cookiejar get_all = getlist - def __repr__(self) -> str: - return f"{type(self).__name__}({dict(self.itermerged())})" + def __repr__(self): + return "%s(%s)" % (type(self).__name__, dict(self.itermerged())) - def _copy_from(self, other: HTTPHeaderDict) -> None: + def _copy_from(self, other): for key in other: val = other.getlist(key) - self._container[key.lower()] = [key, *val] + if isinstance(val, list): + # Don't need to convert tuples + val = list(val) + self._container[key.lower()] = [key] + val - def copy(self) -> Self: + def copy(self): clone = type(self)() clone._copy_from(self) return clone - def iteritems(self) -> typing.Iterator[tuple[str, str]]: + def iteritems(self): """Iterate over all header lines, including duplicate ones.""" for key in self: vals = self._container[key.lower()] for val in vals[1:]: yield vals[0], val - def itermerged(self) -> typing.Iterator[tuple[str, str]]: + def itermerged(self): """Iterate over all headers, merging duplicate ones together.""" for key in self: val = self._container[key.lower()] yield val[0], ", ".join(val[1:]) - def items(self) -> HTTPHeaderDictItemView: # type: ignore[override] - return HTTPHeaderDictItemView(self) - - def _has_value_for_header(self, header_name: str, potential_value: str) -> bool: - if header_name in self: - return potential_value in self._container[header_name.lower()][1:] - return False - - def __ior__(self, other: object) -> HTTPHeaderDict: - # Supports extending a header dict in-place using operator |= - # combining items with add instead of __setitem__ - maybe_constructable = ensure_can_construct_http_header_dict(other) - if maybe_constructable is None: - return NotImplemented - self.extend(maybe_constructable) - return self - - def __or__(self, other: object) -> Self: - # Supports merging header dicts using operator | - # combining items with add instead of __setitem__ - maybe_constructable = ensure_can_construct_http_header_dict(other) - if maybe_constructable is None: - return NotImplemented - result = self.copy() - result.extend(maybe_constructable) - return result - - def __ror__(self, other: object) -> Self: - # Supports merging header dicts using operator | when other is on left side - # combining items with add instead of __setitem__ - maybe_constructable = ensure_can_construct_http_header_dict(other) - if maybe_constructable is None: - return NotImplemented - result = type(self)(maybe_constructable) - result.extend(self) - return result + def items(self): + return list(self.iteritems()) + + @classmethod + def from_httplib(cls, message): # Python 2 + """Read headers from a Python 2 httplib message object.""" + # python2.7 does not expose a proper API for exporting multiheaders + # efficiently. This function re-reads raw lines from the message + # object and extracts the multiheaders properly. + obs_fold_continued_leaders = (" ", "\t") + headers = [] + + for line in message.headers: + if line.startswith(obs_fold_continued_leaders): + if not headers: + # We received a header line that starts with OWS as described + # in RFC-7230 S3.2.4. This indicates a multiline header, but + # there exists no previous header to which we can attach it. + raise InvalidHeader( + "Header continuation with no previous header: %s" % line + ) + else: + key, value = headers[-1] + headers[-1] = (key, value + " " + line.strip()) + continue + + key, value = line.split(":", 1) + headers.append((key, value.strip())) + + return cls(headers) diff --git a/newrelic/packages/urllib3/_version.py b/newrelic/packages/urllib3/_version.py index 268d3b984d..c40db86d0a 100644 --- a/newrelic/packages/urllib3/_version.py +++ b/newrelic/packages/urllib3/_version.py @@ -1,34 +1,2 @@ -# file generated by setuptools-scm -# don't change, don't track in version control - -__all__ = [ - "__version__", - "__version_tuple__", - "version", - "version_tuple", - "__commit_id__", - "commit_id", -] - -TYPE_CHECKING = False -if TYPE_CHECKING: - from typing import Tuple - from typing import Union - - VERSION_TUPLE = Tuple[Union[int, str], ...] - COMMIT_ID = Union[str, None] -else: - VERSION_TUPLE = object - COMMIT_ID = object - -version: str -__version__: str -__version_tuple__: VERSION_TUPLE -version_tuple: VERSION_TUPLE -commit_id: COMMIT_ID -__commit_id__: COMMIT_ID - -__version__ = version = '2.6.3' -__version_tuple__ = version_tuple = (2, 6, 3) - -__commit_id__ = commit_id = None +# This file is protected via CODEOWNERS +__version__ = "1.26.19" diff --git a/newrelic/packages/urllib3/connection.py b/newrelic/packages/urllib3/connection.py index 2ceeb0a548..de35b63d67 100644 --- a/newrelic/packages/urllib3/connection.py +++ b/newrelic/packages/urllib3/connection.py @@ -1,59 +1,59 @@ -from __future__ import annotations +from __future__ import absolute_import import datetime -import http.client import logging import os import re import socket -import sys -import threading -import typing import warnings -from http.client import HTTPConnection as _HTTPConnection -from http.client import HTTPException as HTTPException # noqa: F401 -from http.client import ResponseNotReady +from socket import error as SocketError from socket import timeout as SocketTimeout -if typing.TYPE_CHECKING: - from .response import HTTPResponse - from .util.ssl_ import _TYPE_PEER_CERT_RET_DICT - from .util.ssltransport import SSLTransport - -from ._collections import HTTPHeaderDict -from .http2 import probe as http2_probe -from .util.response import assert_header_parsing -from .util.timeout import _DEFAULT_TIMEOUT, _TYPE_TIMEOUT, Timeout -from .util.util import to_str -from .util.wait import wait_for_read +from .packages import six +from .packages.six.moves.http_client import HTTPConnection as _HTTPConnection +from .packages.six.moves.http_client import HTTPException # noqa: F401 +from .util.proxy import create_proxy_ssl_context try: # Compiled with SSL? import ssl BaseSSLError = ssl.SSLError -except (ImportError, AttributeError): - ssl = None # type: ignore[assignment] +except (ImportError, AttributeError): # Platform-specific: No SSL. + ssl = None + + class BaseSSLError(BaseException): + pass + + +try: + # Python 3: not a no-op, we're adding this to the namespace so it can be imported. + ConnectionError = ConnectionError +except NameError: + # Python 2 + class ConnectionError(Exception): + pass + + +try: # Python 3: + # Not a no-op, we're adding this to the namespace so it can be imported. + BrokenPipeError = BrokenPipeError +except NameError: # Python 2: - class BaseSSLError(BaseException): # type: ignore[no-redef] + class BrokenPipeError(Exception): pass -from ._base_connection import _TYPE_BODY -from ._base_connection import ProxyConfig as ProxyConfig -from ._base_connection import _ResponseOptions as _ResponseOptions +from ._collections import HTTPHeaderDict # noqa (historical, removed in v2) from ._version import __version__ from .exceptions import ( ConnectTimeoutError, - HeaderParsingError, - NameResolutionError, NewConnectionError, - ProxyError, + SubjectAltNameWarning, SystemTimeWarning, ) -from .util import SKIP_HEADER, SKIPPABLE_HEADERS, connection, ssl_ -from .util.request import body_to_chunks -from .util.ssl_ import assert_fingerprint as _assert_fingerprint +from .util import SKIP_HEADER, SKIPPABLE_HEADERS, connection from .util.ssl_ import ( + assert_fingerprint, create_urllib3_context, is_ipaddress, resolve_cert_reqs, @@ -61,12 +61,6 @@ class BaseSSLError(BaseException): # type: ignore[no-redef] ssl_wrap_socket, ) from .util.ssl_match_hostname import CertificateError, match_hostname -from .util.url import Url - -# Not a no-op, we're adding this to the namespace so it can be imported. -ConnectionError = ConnectionError -BrokenPipeError = BrokenPipeError - log = logging.getLogger(__name__) @@ -74,12 +68,12 @@ class BaseSSLError(BaseException): # type: ignore[no-redef] # When it comes time to update this value as a part of regular maintenance # (ie test_recent_date is failing) update it to ~6 months before the current date. -RECENT_DATE = datetime.date(2025, 1, 1) +RECENT_DATE = datetime.date(2024, 1, 1) _CONTAINS_CONTROL_CHAR_RE = re.compile(r"[^-!#$%&'*+.^_`|~0-9a-zA-Z]") -class HTTPConnection(_HTTPConnection): +class HTTPConnection(_HTTPConnection, object): """ Based on :class:`http.client.HTTPConnection` but provides an extra constructor backwards-compatibility layer between older and newer Pythons. @@ -87,6 +81,7 @@ class HTTPConnection(_HTTPConnection): Additional keyword parameters are used to configure attributes of the connection. Accepted parameters include: + - ``strict``: See the documentation on :class:`urllib3.connectionpool.HTTPConnectionPool` - ``source_address``: Set the source address for the current connection. - ``socket_options``: Set specific options on the underlying socket. If not specified, then defaults are loaded from ``HTTPConnection.default_socket_options`` which includes disabling @@ -104,70 +99,38 @@ class HTTPConnection(_HTTPConnection): Or you may want to disable the defaults by passing an empty list (e.g., ``[]``). """ - default_port: typing.ClassVar[int] = port_by_scheme["http"] # type: ignore[misc] + default_port = port_by_scheme["http"] #: Disable Nagle's algorithm by default. #: ``[(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)]`` - default_socket_options: typing.ClassVar[connection._TYPE_SOCKET_OPTIONS] = [ - (socket.IPPROTO_TCP, socket.TCP_NODELAY, 1) - ] + default_socket_options = [(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)] #: Whether this connection verifies the host's certificate. - is_verified: bool = False + is_verified = False - #: Whether this proxy connection verified the proxy host's certificate. - # If no proxy is currently connected to the value will be ``None``. - proxy_is_verified: bool | None = None + #: Whether this proxy connection (if used) verifies the proxy host's + #: certificate. + proxy_is_verified = None - blocksize: int - source_address: tuple[str, int] | None - socket_options: connection._TYPE_SOCKET_OPTIONS | None + def __init__(self, *args, **kw): + if not six.PY2: + kw.pop("strict", None) - _has_connected_to_proxy: bool - _response_options: _ResponseOptions | None - _tunnel_host: str | None - _tunnel_port: int | None - _tunnel_scheme: str | None + # Pre-set source_address. + self.source_address = kw.get("source_address") - def __init__( - self, - host: str, - port: int | None = None, - *, - timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, - source_address: tuple[str, int] | None = None, - blocksize: int = 16384, - socket_options: None | ( - connection._TYPE_SOCKET_OPTIONS - ) = default_socket_options, - proxy: Url | None = None, - proxy_config: ProxyConfig | None = None, - ) -> None: - super().__init__( - host=host, - port=port, - timeout=Timeout.resolve_default_timeout(timeout), - source_address=source_address, - blocksize=blocksize, - ) - self.socket_options = socket_options - self.proxy = proxy - self.proxy_config = proxy_config + #: The socket options provided by the user. If no options are + #: provided, we use the default options. + self.socket_options = kw.pop("socket_options", self.default_socket_options) - self._has_connected_to_proxy = False - self._response_options = None - self._tunnel_host: str | None = None - self._tunnel_port: int | None = None - self._tunnel_scheme: str | None = None + # Proxy options provided by the user. + self.proxy = kw.pop("proxy", None) + self.proxy_config = kw.pop("proxy_config", None) - def __str__(self) -> str: - return f"{type(self).__name__}(host={self.host!r}, port={self.port!r})" - - def __repr__(self) -> str: - return f"<{self} at {id(self):#x}>" + _HTTPConnection.__init__(self, *args, **kw) @property - def host(self) -> str: + def host(self): """ Getter method to remove any trailing dots that indicate the hostname is an FQDN. @@ -186,7 +149,7 @@ def host(self) -> str: return self._dns_host.rstrip(".") @host.setter - def host(self, value: str) -> None: + def host(self, value): """ Setter for the `host` property. @@ -195,409 +158,129 @@ def host(self, value: str) -> None: """ self._dns_host = value - def _new_conn(self) -> socket.socket: + def _new_conn(self): """Establish a socket connection and set nodelay settings on it. :return: New socket connection. """ + extra_kw = {} + if self.source_address: + extra_kw["source_address"] = self.source_address + + if self.socket_options: + extra_kw["socket_options"] = self.socket_options + try: - sock = connection.create_connection( - (self._dns_host, self.port), - self.timeout, - source_address=self.source_address, - socket_options=self.socket_options, + conn = connection.create_connection( + (self._dns_host, self.port), self.timeout, **extra_kw ) - except socket.gaierror as e: - raise NameResolutionError(self.host, self, e) from e - except SocketTimeout as e: + + except SocketTimeout: raise ConnectTimeoutError( self, - f"Connection to {self.host} timed out. (connect timeout={self.timeout})", - ) from e + "Connection to %s timed out. (connect timeout=%s)" + % (self.host, self.timeout), + ) - except OSError as e: + except SocketError as e: raise NewConnectionError( - self, f"Failed to establish a new connection: {e}" - ) from e - - sys.audit("http.client.connect", self, self.host, self.port) + self, "Failed to establish a new connection: %s" % e + ) - return sock + return conn - def set_tunnel( - self, - host: str, - port: int | None = None, - headers: typing.Mapping[str, str] | None = None, - scheme: str = "http", - ) -> None: - if scheme not in ("http", "https"): - raise ValueError( - f"Invalid proxy scheme for tunneling: {scheme!r}, must be either 'http' or 'https'" - ) - super().set_tunnel(host, port=port, headers=headers) - self._tunnel_scheme = scheme - - if sys.version_info < (3, 11, 9) or ((3, 12) <= sys.version_info < (3, 12, 3)): - # Taken from python/cpython#100986 which was backported in 3.11.9 and 3.12.3. - # When using connection_from_host, host will come without brackets. - def _wrap_ipv6(self, ip: bytes) -> bytes: - if b":" in ip and ip[0] != b"["[0]: - return b"[" + ip + b"]" - return ip - - if sys.version_info < (3, 11, 9): - # `_tunnel` copied from 3.11.13 backporting - # https://github.com/python/cpython/commit/0d4026432591d43185568dd31cef6a034c4b9261 - # and https://github.com/python/cpython/commit/6fbc61070fda2ffb8889e77e3b24bca4249ab4d1 - def _tunnel(self) -> None: - _MAXLINE = http.client._MAXLINE # type: ignore[attr-defined] - connect = b"CONNECT %s:%d HTTP/1.0\r\n" % ( # type: ignore[str-format] - self._wrap_ipv6(self._tunnel_host.encode("ascii")), # type: ignore[union-attr] - self._tunnel_port, - ) - headers = [connect] - for header, value in self._tunnel_headers.items(): # type: ignore[attr-defined] - headers.append(f"{header}: {value}\r\n".encode("latin-1")) - headers.append(b"\r\n") - # Making a single send() call instead of one per line encourages - # the host OS to use a more optimal packet size instead of - # potentially emitting a series of small packets. - self.send(b"".join(headers)) - del headers - - response = self.response_class(self.sock, method=self._method) # type: ignore[attr-defined] - try: - (version, code, message) = response._read_status() # type: ignore[attr-defined] - - if code != http.HTTPStatus.OK: - self.close() - raise OSError( - f"Tunnel connection failed: {code} {message.strip()}" - ) - while True: - line = response.fp.readline(_MAXLINE + 1) - if len(line) > _MAXLINE: - raise http.client.LineTooLong("header line") - if not line: - # for sites which EOF without sending a trailer - break - if line in (b"\r\n", b"\n", b""): - break - - if self.debuglevel > 0: - print("header:", line.decode()) - finally: - response.close() - - elif (3, 12) <= sys.version_info < (3, 12, 3): - # `_tunnel` copied from 3.12.11 backporting - # https://github.com/python/cpython/commit/23aef575c7629abcd4aaf028ebd226fb41a4b3c8 - def _tunnel(self) -> None: # noqa: F811 - connect = b"CONNECT %s:%d HTTP/1.1\r\n" % ( # type: ignore[str-format] - self._wrap_ipv6(self._tunnel_host.encode("idna")), # type: ignore[union-attr] - self._tunnel_port, - ) - headers = [connect] - for header, value in self._tunnel_headers.items(): # type: ignore[attr-defined] - headers.append(f"{header}: {value}\r\n".encode("latin-1")) - headers.append(b"\r\n") - # Making a single send() call instead of one per line encourages - # the host OS to use a more optimal packet size instead of - # potentially emitting a series of small packets. - self.send(b"".join(headers)) - del headers - - response = self.response_class(self.sock, method=self._method) # type: ignore[attr-defined] - try: - (version, code, message) = response._read_status() # type: ignore[attr-defined] - - self._raw_proxy_headers = http.client._read_headers(response.fp) # type: ignore[attr-defined] - - if self.debuglevel > 0: - for header in self._raw_proxy_headers: - print("header:", header.decode()) - - if code != http.HTTPStatus.OK: - self.close() - raise OSError( - f"Tunnel connection failed: {code} {message.strip()}" - ) - - finally: - response.close() - - def connect(self) -> None: - self.sock = self._new_conn() - if self._tunnel_host: - # If we're tunneling it means we're connected to our proxy. - self._has_connected_to_proxy = True + def _is_using_tunnel(self): + # Google App Engine's httplib does not define _tunnel_host + return getattr(self, "_tunnel_host", None) + def _prepare_conn(self, conn): + self.sock = conn + if self._is_using_tunnel(): # TODO: Fix tunnel so it doesn't depend on self.sock state. self._tunnel() + # Mark this connection as not reusable + self.auto_open = 0 - # If there's a proxy to be connected to we are fully connected. - # This is set twice (once above and here) due to forwarding proxies - # not using tunnelling. - self._has_connected_to_proxy = bool(self.proxy) - - if self._has_connected_to_proxy: - self.proxy_is_verified = False - - @property - def is_closed(self) -> bool: - return self.sock is None - - @property - def is_connected(self) -> bool: - if self.sock is None: - return False - return not wait_for_read(self.sock, timeout=0.0) - - @property - def has_connected_to_proxy(self) -> bool: - return self._has_connected_to_proxy - - @property - def proxy_is_forwarding(self) -> bool: - """ - Return True if a forwarding proxy is configured, else return False - """ - return bool(self.proxy) and self._tunnel_host is None - - @property - def proxy_is_tunneling(self) -> bool: - """ - Return True if a tunneling proxy is configured, else return False - """ - return self._tunnel_host is not None + def connect(self): + conn = self._new_conn() + self._prepare_conn(conn) - def close(self) -> None: - try: - super().close() - finally: - # Reset all stateful properties so connection - # can be re-used without leaking prior configs. - self.sock = None - self.is_verified = False - self.proxy_is_verified = None - self._has_connected_to_proxy = False - self._response_options = None - self._tunnel_host = None - self._tunnel_port = None - self._tunnel_scheme = None - - def putrequest( - self, - method: str, - url: str, - skip_host: bool = False, - skip_accept_encoding: bool = False, - ) -> None: - """""" + def putrequest(self, method, url, *args, **kwargs): + """ """ # Empty docstring because the indentation of CPython's implementation # is broken but we don't want this method in our documentation. match = _CONTAINS_CONTROL_CHAR_RE.search(method) if match: raise ValueError( - f"Method cannot contain non-token characters {method!r} (found at least {match.group()!r})" + "Method cannot contain non-token characters %r (found at least %r)" + % (method, match.group()) ) - return super().putrequest( - method, url, skip_host=skip_host, skip_accept_encoding=skip_accept_encoding - ) + return _HTTPConnection.putrequest(self, method, url, *args, **kwargs) - def putheader(self, header: str, *values: str) -> None: # type: ignore[override] - """""" + def putheader(self, header, *values): + """ """ if not any(isinstance(v, str) and v == SKIP_HEADER for v in values): - super().putheader(header, *values) - elif to_str(header.lower()) not in SKIPPABLE_HEADERS: - skippable_headers = "', '".join( - [str.title(header) for header in sorted(SKIPPABLE_HEADERS)] - ) + _HTTPConnection.putheader(self, header, *values) + elif six.ensure_str(header.lower()) not in SKIPPABLE_HEADERS: raise ValueError( - f"urllib3.util.SKIP_HEADER only supports '{skippable_headers}'" + "urllib3.util.SKIP_HEADER only supports '%s'" + % ("', '".join(map(str.title, sorted(SKIPPABLE_HEADERS))),) ) - # `request` method's signature intentionally violates LSP. - # urllib3's API is different from `http.client.HTTPConnection` and the subclassing is only incidental. - def request( # type: ignore[override] - self, - method: str, - url: str, - body: _TYPE_BODY | None = None, - headers: typing.Mapping[str, str] | None = None, - *, - chunked: bool = False, - preload_content: bool = True, - decode_content: bool = True, - enforce_content_length: bool = True, - ) -> None: + def request(self, method, url, body=None, headers=None): # Update the inner socket's timeout value to send the request. # This only triggers if the connection is re-used. - if self.sock is not None: + if getattr(self, "sock", None) is not None: self.sock.settimeout(self.timeout) - # Store these values to be fed into the HTTPResponse - # object later. TODO: Remove this in favor of a real - # HTTP lifecycle mechanism. - - # We have to store these before we call .request() - # because sometimes we can still salvage a response - # off the wire even if we aren't able to completely - # send the request body. - self._response_options = _ResponseOptions( - request_method=method, - request_url=url, - preload_content=preload_content, - decode_content=decode_content, - enforce_content_length=enforce_content_length, - ) - if headers is None: headers = {} - header_keys = frozenset(to_str(k.lower()) for k in headers) + else: + # Avoid modifying the headers passed into .request() + headers = headers.copy() + if "user-agent" not in (six.ensure_str(k.lower()) for k in headers): + headers["User-Agent"] = _get_default_user_agent() + super(HTTPConnection, self).request(method, url, body=body, headers=headers) + + def request_chunked(self, method, url, body=None, headers=None): + """ + Alternative to the common request method, which sends the + body with chunked encoding and not as one block + """ + headers = headers or {} + header_keys = set([six.ensure_str(k.lower()) for k in headers]) skip_accept_encoding = "accept-encoding" in header_keys skip_host = "host" in header_keys self.putrequest( method, url, skip_accept_encoding=skip_accept_encoding, skip_host=skip_host ) - - # Transform the body into an iterable of sendall()-able chunks - # and detect if an explicit Content-Length is doable. - chunks_and_cl = body_to_chunks(body, method=method, blocksize=self.blocksize) - chunks = chunks_and_cl.chunks - content_length = chunks_and_cl.content_length - - # When chunked is explicit set to 'True' we respect that. - if chunked: - if "transfer-encoding" not in header_keys: - self.putheader("Transfer-Encoding", "chunked") - else: - # Detect whether a framing mechanism is already in use. If so - # we respect that value, otherwise we pick chunked vs content-length - # depending on the type of 'body'. - if "content-length" in header_keys: - chunked = False - elif "transfer-encoding" in header_keys: - chunked = True - - # Otherwise we go off the recommendation of 'body_to_chunks()'. - else: - chunked = False - if content_length is None: - if chunks is not None: - chunked = True - self.putheader("Transfer-Encoding", "chunked") - else: - self.putheader("Content-Length", str(content_length)) - - # Now that framing headers are out of the way we send all the other headers. if "user-agent" not in header_keys: self.putheader("User-Agent", _get_default_user_agent()) for header, value in headers.items(): self.putheader(header, value) + if "transfer-encoding" not in header_keys: + self.putheader("Transfer-Encoding", "chunked") self.endheaders() - # If we're given a body we start sending that in chunks. - if chunks is not None: - for chunk in chunks: - # Sending empty chunks isn't allowed for TE: chunked - # as it indicates the end of the body. + if body is not None: + stringish_types = six.string_types + (bytes,) + if isinstance(body, stringish_types): + body = (body,) + for chunk in body: if not chunk: continue - if isinstance(chunk, str): - chunk = chunk.encode("utf-8") - if chunked: - self.send(b"%x\r\n%b\r\n" % (len(chunk), chunk)) - else: - self.send(chunk) - - # Regardless of whether we have a body or not, if we're in - # chunked mode we want to send an explicit empty chunk. - if chunked: - self.send(b"0\r\n\r\n") - - def request_chunked( - self, - method: str, - url: str, - body: _TYPE_BODY | None = None, - headers: typing.Mapping[str, str] | None = None, - ) -> None: - """ - Alternative to the common request method, which sends the - body with chunked encoding and not as one block - """ - warnings.warn( - "HTTPConnection.request_chunked() is deprecated and will be removed " - "in urllib3 v2.1.0. Instead use HTTPConnection.request(..., chunked=True).", - category=DeprecationWarning, - stacklevel=2, - ) - self.request(method, url, body=body, headers=headers, chunked=True) - - def getresponse( # type: ignore[override] - self, - ) -> HTTPResponse: - """ - Get the response from the server. - - If the HTTPConnection is in the correct state, returns an instance of HTTPResponse or of whatever object is returned by the response_class variable. - - If a request has not been sent or if a previous response has not be handled, ResponseNotReady is raised. If the HTTP response indicates that the connection should be closed, then it will be closed before the response is returned. When the connection is closed, the underlying socket is closed. - """ - # Raise the same error as http.client.HTTPConnection - if self._response_options is None: - raise ResponseNotReady() - - # Reset this attribute for being used again. - resp_options = self._response_options - self._response_options = None + if not isinstance(chunk, bytes): + chunk = chunk.encode("utf8") + len_str = hex(len(chunk))[2:] + to_send = bytearray(len_str.encode()) + to_send += b"\r\n" + to_send += chunk + to_send += b"\r\n" + self.send(to_send) - # Since the connection's timeout value may have been updated - # we need to set the timeout on the socket. - self.sock.settimeout(self.timeout) - - # This is needed here to avoid circular import errors - from .response import HTTPResponse - - # Save a reference to the shutdown function before ownership is passed - # to httplib_response - # TODO should we implement it everywhere? - _shutdown = getattr(self.sock, "shutdown", None) - - # Get the response from http.client.HTTPConnection - httplib_response = super().getresponse() - - try: - assert_header_parsing(httplib_response.msg) - except (HeaderParsingError, TypeError) as hpe: - log.warning( - "Failed to parse headers (url=%s): %s", - _url_from_connection(self, resp_options.request_url), - hpe, - exc_info=True, - ) - - headers = HTTPHeaderDict(httplib_response.msg.items()) - - response = HTTPResponse( - body=httplib_response, - headers=headers, - status=httplib_response.status, - version=httplib_response.version, - version_string=getattr(self, "_http_vsn_str", "HTTP/?"), - reason=httplib_response.reason, - preload_content=resp_options.preload_content, - decode_content=resp_options.decode_content, - original_response=httplib_response, - enforce_content_length=resp_options.enforce_content_length, - request_method=resp_options.request_method, - request_url=resp_options.request_url, - sock_shutdown=_shutdown, - ) - return response + # After the if clause, to always have a closed body + self.send(b"0\r\n\r\n") class HTTPSConnection(HTTPConnection): @@ -606,103 +289,57 @@ class HTTPSConnection(HTTPConnection): socket by means of :py:func:`urllib3.util.ssl_wrap_socket`. """ - default_port = port_by_scheme["https"] # type: ignore[misc] + default_port = port_by_scheme["https"] - cert_reqs: int | str | None = None - ca_certs: str | None = None - ca_cert_dir: str | None = None - ca_cert_data: None | str | bytes = None - ssl_version: int | str | None = None - ssl_minimum_version: int | None = None - ssl_maximum_version: int | None = None - assert_fingerprint: str | None = None - _connect_callback: typing.Callable[..., None] | None = None + cert_reqs = None + ca_certs = None + ca_cert_dir = None + ca_cert_data = None + ssl_version = None + assert_fingerprint = None + tls_in_tls_required = False def __init__( self, - host: str, - port: int | None = None, - *, - timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, - source_address: tuple[str, int] | None = None, - blocksize: int = 16384, - socket_options: None | ( - connection._TYPE_SOCKET_OPTIONS - ) = HTTPConnection.default_socket_options, - proxy: Url | None = None, - proxy_config: ProxyConfig | None = None, - cert_reqs: int | str | None = None, - assert_hostname: None | str | typing.Literal[False] = None, - assert_fingerprint: str | None = None, - server_hostname: str | None = None, - ssl_context: ssl.SSLContext | None = None, - ca_certs: str | None = None, - ca_cert_dir: str | None = None, - ca_cert_data: None | str | bytes = None, - ssl_minimum_version: int | None = None, - ssl_maximum_version: int | None = None, - ssl_version: int | str | None = None, # Deprecated - cert_file: str | None = None, - key_file: str | None = None, - key_password: str | None = None, - ) -> None: - super().__init__( - host, - port=port, - timeout=timeout, - source_address=source_address, - blocksize=blocksize, - socket_options=socket_options, - proxy=proxy, - proxy_config=proxy_config, - ) + host, + port=None, + key_file=None, + cert_file=None, + key_password=None, + strict=None, + timeout=socket._GLOBAL_DEFAULT_TIMEOUT, + ssl_context=None, + server_hostname=None, + **kw + ): + + HTTPConnection.__init__(self, host, port, strict=strict, timeout=timeout, **kw) self.key_file = key_file self.cert_file = cert_file self.key_password = key_password self.ssl_context = ssl_context self.server_hostname = server_hostname - self.assert_hostname = assert_hostname - self.assert_fingerprint = assert_fingerprint - self.ssl_version = ssl_version - self.ssl_minimum_version = ssl_minimum_version - self.ssl_maximum_version = ssl_maximum_version - self.ca_certs = ca_certs and os.path.expanduser(ca_certs) - self.ca_cert_dir = ca_cert_dir and os.path.expanduser(ca_cert_dir) - self.ca_cert_data = ca_cert_data - # cert_reqs depends on ssl_context so calculate last. - if cert_reqs is None: - if self.ssl_context is not None: - cert_reqs = self.ssl_context.verify_mode - else: - cert_reqs = resolve_cert_reqs(None) - self.cert_reqs = cert_reqs - self._connect_callback = None + # Required property for Google AppEngine 1.9.0 which otherwise causes + # HTTPS requests to go out as HTTP. (See Issue #356) + self._protocol = "https" def set_cert( self, - key_file: str | None = None, - cert_file: str | None = None, - cert_reqs: int | str | None = None, - key_password: str | None = None, - ca_certs: str | None = None, - assert_hostname: None | str | typing.Literal[False] = None, - assert_fingerprint: str | None = None, - ca_cert_dir: str | None = None, - ca_cert_data: None | str | bytes = None, - ) -> None: + key_file=None, + cert_file=None, + cert_reqs=None, + key_password=None, + ca_certs=None, + assert_hostname=None, + assert_fingerprint=None, + ca_cert_dir=None, + ca_cert_data=None, + ): """ This method should only be called once, before the connection is used. """ - warnings.warn( - "HTTPSConnection.set_cert() is deprecated and will be removed " - "in urllib3 v2.1.0. Instead provide the parameters to the " - "HTTPSConnection constructor.", - category=DeprecationWarning, - stacklevel=2, - ) - # If cert_reqs is not provided we'll assume CERT_REQUIRED unless we also # have an SSLContext object in which case we'll use its verify_mode. if cert_reqs is None: @@ -721,322 +358,191 @@ def set_cert( self.ca_cert_dir = ca_cert_dir and os.path.expanduser(ca_cert_dir) self.ca_cert_data = ca_cert_data - def connect(self) -> None: - # Today we don't need to be doing this step before the /actual/ socket - # connection, however in the future we'll need to decide whether to - # create a new socket or re-use an existing "shared" socket as a part - # of the HTTP/2 handshake dance. - if self._tunnel_host is not None and self._tunnel_port is not None: - probe_http2_host = self._tunnel_host - probe_http2_port = self._tunnel_port - else: - probe_http2_host = self.host - probe_http2_port = self.port - - # Check if the target origin supports HTTP/2. - # If the value comes back as 'None' it means that the current thread - # is probing for HTTP/2 support. Otherwise, we're waiting for another - # probe to complete, or we get a value right away. - target_supports_http2: bool | None - if "h2" in ssl_.ALPN_PROTOCOLS: - target_supports_http2 = http2_probe.acquire_and_get( - host=probe_http2_host, port=probe_http2_port - ) - else: - # If HTTP/2 isn't going to be offered it doesn't matter if - # the target supports HTTP/2. Don't want to make a probe. - target_supports_http2 = False - - if self._connect_callback is not None: - self._connect_callback( - "before connect", - thread_id=threading.get_ident(), - target_supports_http2=target_supports_http2, - ) + def connect(self): + # Add certificate verification + self.sock = conn = self._new_conn() + hostname = self.host + tls_in_tls = False - try: - sock: socket.socket | ssl.SSLSocket - self.sock = sock = self._new_conn() - server_hostname: str = self.host - tls_in_tls = False - - # Do we need to establish a tunnel? - if self.proxy_is_tunneling: - # We're tunneling to an HTTPS origin so need to do TLS-in-TLS. - if self._tunnel_scheme == "https": - # _connect_tls_proxy will verify and assign proxy_is_verified - self.sock = sock = self._connect_tls_proxy(self.host, sock) - tls_in_tls = True - elif self._tunnel_scheme == "http": - self.proxy_is_verified = False - - # If we're tunneling it means we're connected to our proxy. - self._has_connected_to_proxy = True - - self._tunnel() - # Override the host with the one we're requesting data from. - server_hostname = typing.cast(str, self._tunnel_host) - - if self.server_hostname is not None: - server_hostname = self.server_hostname - - is_time_off = datetime.date.today() < RECENT_DATE - if is_time_off: - warnings.warn( - ( - f"System time is way off (before {RECENT_DATE}). This will probably " - "lead to SSL verification errors" - ), - SystemTimeWarning, - ) + if self._is_using_tunnel(): + if self.tls_in_tls_required: + self.sock = conn = self._connect_tls_proxy(hostname, conn) + tls_in_tls = True - # Remove trailing '.' from fqdn hostnames to allow certificate validation - server_hostname_rm_dot = server_hostname.rstrip(".") - - sock_and_verified = _ssl_wrap_socket_and_match_hostname( - sock=sock, - cert_reqs=self.cert_reqs, - ssl_version=self.ssl_version, - ssl_minimum_version=self.ssl_minimum_version, - ssl_maximum_version=self.ssl_maximum_version, - ca_certs=self.ca_certs, - ca_cert_dir=self.ca_cert_dir, - ca_cert_data=self.ca_cert_data, - cert_file=self.cert_file, - key_file=self.key_file, - key_password=self.key_password, - server_hostname=server_hostname_rm_dot, - ssl_context=self.ssl_context, - tls_in_tls=tls_in_tls, - assert_hostname=self.assert_hostname, - assert_fingerprint=self.assert_fingerprint, + # Calls self._set_hostport(), so self.host is + # self._tunnel_host below. + self._tunnel() + # Mark this connection as not reusable + self.auto_open = 0 + + # Override the host with the one we're requesting data from. + hostname = self._tunnel_host + + server_hostname = hostname + if self.server_hostname is not None: + server_hostname = self.server_hostname + + is_time_off = datetime.date.today() < RECENT_DATE + if is_time_off: + warnings.warn( + ( + "System time is way off (before {0}). This will probably " + "lead to SSL verification errors" + ).format(RECENT_DATE), + SystemTimeWarning, ) - self.sock = sock_and_verified.socket - - # If an error occurs during connection/handshake we may need to release - # our lock so another connection can probe the origin. - except BaseException: - if self._connect_callback is not None: - self._connect_callback( - "after connect failure", - thread_id=threading.get_ident(), - target_supports_http2=target_supports_http2, - ) - if target_supports_http2 is None: - http2_probe.set_and_release( - host=probe_http2_host, port=probe_http2_port, supports_http2=None - ) - raise - - # If this connection doesn't know if the origin supports HTTP/2 - # we report back to the HTTP/2 probe our result. - if target_supports_http2 is None: - supports_http2 = sock_and_verified.socket.selected_alpn_protocol() == "h2" - http2_probe.set_and_release( - host=probe_http2_host, - port=probe_http2_port, - supports_http2=supports_http2, + # Wrap socket using verification with the root certs in + # trusted_root_certs + default_ssl_context = False + if self.ssl_context is None: + default_ssl_context = True + self.ssl_context = create_urllib3_context( + ssl_version=resolve_ssl_version(self.ssl_version), + cert_reqs=resolve_cert_reqs(self.cert_reqs), ) - # Forwarding proxies can never have a verified target since - # the proxy is the one doing the verification. Should instead - # use a CONNECT tunnel in order to verify the target. - # See: https://github.com/urllib3/urllib3/issues/3267. - if self.proxy_is_forwarding: - self.is_verified = False - else: - self.is_verified = sock_and_verified.is_verified + context = self.ssl_context + context.verify_mode = resolve_cert_reqs(self.cert_reqs) + + # Try to load OS default certs if none are given. + # Works well on Windows (requires Python3.4+) + if ( + not self.ca_certs + and not self.ca_cert_dir + and not self.ca_cert_data + and default_ssl_context + and hasattr(context, "load_default_certs") + ): + context.load_default_certs() - # If there's a proxy to be connected to we are fully connected. - # This is set twice (once above and here) due to forwarding proxies - # not using tunnelling. - self._has_connected_to_proxy = bool(self.proxy) + self.sock = ssl_wrap_socket( + sock=conn, + keyfile=self.key_file, + certfile=self.cert_file, + key_password=self.key_password, + ca_certs=self.ca_certs, + ca_cert_dir=self.ca_cert_dir, + ca_cert_data=self.ca_cert_data, + server_hostname=server_hostname, + ssl_context=context, + tls_in_tls=tls_in_tls, + ) - # Set `self.proxy_is_verified` unless it's already set while - # establishing a tunnel. - if self._has_connected_to_proxy and self.proxy_is_verified is None: - self.proxy_is_verified = sock_and_verified.is_verified + # If we're using all defaults and the connection + # is TLSv1 or TLSv1.1 we throw a DeprecationWarning + # for the host. + if ( + default_ssl_context + and self.ssl_version is None + and hasattr(self.sock, "version") + and self.sock.version() in {"TLSv1", "TLSv1.1"} + ): # Defensive: + warnings.warn( + "Negotiating TLSv1/TLSv1.1 by default is deprecated " + "and will be disabled in urllib3 v2.0.0. Connecting to " + "'%s' with '%s' can be enabled by explicitly opting-in " + "with 'ssl_version'" % (self.host, self.sock.version()), + DeprecationWarning, + ) - def _connect_tls_proxy(self, hostname: str, sock: socket.socket) -> ssl.SSLSocket: + if self.assert_fingerprint: + assert_fingerprint( + self.sock.getpeercert(binary_form=True), self.assert_fingerprint + ) + elif ( + context.verify_mode != ssl.CERT_NONE + and not getattr(context, "check_hostname", False) + and self.assert_hostname is not False + ): + # While urllib3 attempts to always turn off hostname matching from + # the TLS library, this cannot always be done. So we check whether + # the TLS Library still thinks it's matching hostnames. + cert = self.sock.getpeercert() + if not cert.get("subjectAltName", ()): + warnings.warn( + ( + "Certificate for {0} has no `subjectAltName`, falling back to check for a " + "`commonName` for now. This feature is being removed by major browsers and " + "deprecated by RFC 2818. (See https://github.com/urllib3/urllib3/issues/497 " + "for details.)".format(hostname) + ), + SubjectAltNameWarning, + ) + _match_hostname(cert, self.assert_hostname or server_hostname) + + self.is_verified = ( + context.verify_mode == ssl.CERT_REQUIRED + or self.assert_fingerprint is not None + ) + + def _connect_tls_proxy(self, hostname, conn): """ Establish a TLS connection to the proxy using the provided SSL context. """ - # `_connect_tls_proxy` is called when self._tunnel_host is truthy. - proxy_config = typing.cast(ProxyConfig, self.proxy_config) + proxy_config = self.proxy_config ssl_context = proxy_config.ssl_context - sock_and_verified = _ssl_wrap_socket_and_match_hostname( - sock, - cert_reqs=self.cert_reqs, - ssl_version=self.ssl_version, - ssl_minimum_version=self.ssl_minimum_version, - ssl_maximum_version=self.ssl_maximum_version, + if ssl_context: + # If the user provided a proxy context, we assume CA and client + # certificates have already been set + return ssl_wrap_socket( + sock=conn, + server_hostname=hostname, + ssl_context=ssl_context, + ) + + ssl_context = create_proxy_ssl_context( + self.ssl_version, + self.cert_reqs, + self.ca_certs, + self.ca_cert_dir, + self.ca_cert_data, + ) + + # If no cert was provided, use only the default options for server + # certificate validation + socket = ssl_wrap_socket( + sock=conn, ca_certs=self.ca_certs, ca_cert_dir=self.ca_cert_dir, ca_cert_data=self.ca_cert_data, server_hostname=hostname, ssl_context=ssl_context, - assert_hostname=proxy_config.assert_hostname, - assert_fingerprint=proxy_config.assert_fingerprint, - # Features that aren't implemented for proxies yet: - cert_file=None, - key_file=None, - key_password=None, - tls_in_tls=False, ) - self.proxy_is_verified = sock_and_verified.is_verified - return sock_and_verified.socket # type: ignore[return-value] - -class _WrappedAndVerifiedSocket(typing.NamedTuple): - """ - Wrapped socket and whether the connection is - verified after the TLS handshake - """ - - socket: ssl.SSLSocket | SSLTransport - is_verified: bool - - -def _ssl_wrap_socket_and_match_hostname( - sock: socket.socket, - *, - cert_reqs: None | str | int, - ssl_version: None | str | int, - ssl_minimum_version: int | None, - ssl_maximum_version: int | None, - cert_file: str | None, - key_file: str | None, - key_password: str | None, - ca_certs: str | None, - ca_cert_dir: str | None, - ca_cert_data: None | str | bytes, - assert_hostname: None | str | typing.Literal[False], - assert_fingerprint: str | None, - server_hostname: str | None, - ssl_context: ssl.SSLContext | None, - tls_in_tls: bool = False, -) -> _WrappedAndVerifiedSocket: - """Logic for constructing an SSLContext from all TLS parameters, passing - that down into ssl_wrap_socket, and then doing certificate verification - either via hostname or fingerprint. This function exists to guarantee - that both proxies and targets have the same behavior when connecting via TLS. - """ - default_ssl_context = False - if ssl_context is None: - default_ssl_context = True - context = create_urllib3_context( - ssl_version=resolve_ssl_version(ssl_version), - ssl_minimum_version=ssl_minimum_version, - ssl_maximum_version=ssl_maximum_version, - cert_reqs=resolve_cert_reqs(cert_reqs), - ) - else: - context = ssl_context - - context.verify_mode = resolve_cert_reqs(cert_reqs) - - # In some cases, we want to verify hostnames ourselves - if ( - # `ssl` can't verify fingerprints or alternate hostnames - assert_fingerprint - or assert_hostname - # assert_hostname can be set to False to disable hostname checking - or assert_hostname is False - # We still support OpenSSL 1.0.2, which prevents us from verifying - # hostnames easily: https://github.com/pyca/pyopenssl/pull/933 - or ssl_.IS_PYOPENSSL - or not ssl_.HAS_NEVER_CHECK_COMMON_NAME - ): - context.check_hostname = False - - # Try to load OS default certs if none are given. We need to do the hasattr() check - # for custom pyOpenSSL SSLContext objects because they don't support - # load_default_certs(). - if ( - not ca_certs - and not ca_cert_dir - and not ca_cert_data - and default_ssl_context - and hasattr(context, "load_default_certs") - ): - context.load_default_certs() - - # Ensure that IPv6 addresses are in the proper format and don't have a - # scope ID. Python's SSL module fails to recognize scoped IPv6 addresses - # and interprets them as DNS hostnames. - if server_hostname is not None: - normalized = server_hostname.strip("[]") - if "%" in normalized: - normalized = normalized[: normalized.rfind("%")] - if is_ipaddress(normalized): - server_hostname = normalized - - ssl_sock = ssl_wrap_socket( - sock=sock, - keyfile=key_file, - certfile=cert_file, - key_password=key_password, - ca_certs=ca_certs, - ca_cert_dir=ca_cert_dir, - ca_cert_data=ca_cert_data, - server_hostname=server_hostname, - ssl_context=context, - tls_in_tls=tls_in_tls, - ) - - try: - if assert_fingerprint: - _assert_fingerprint( - ssl_sock.getpeercert(binary_form=True), assert_fingerprint - ) - elif ( - context.verify_mode != ssl.CERT_NONE - and not context.check_hostname - and assert_hostname is not False + if ssl_context.verify_mode != ssl.CERT_NONE and not getattr( + ssl_context, "check_hostname", False ): - cert: _TYPE_PEER_CERT_RET_DICT = ssl_sock.getpeercert() # type: ignore[assignment] - - # Need to signal to our match_hostname whether to use 'commonName' or not. - # If we're using our own constructed SSLContext we explicitly set 'False' - # because PyPy hard-codes 'True' from SSLContext.hostname_checks_common_name. - if default_ssl_context: - hostname_checks_common_name = False - else: - hostname_checks_common_name = ( - getattr(context, "hostname_checks_common_name", False) or False + # While urllib3 attempts to always turn off hostname matching from + # the TLS library, this cannot always be done. So we check whether + # the TLS Library still thinks it's matching hostnames. + cert = socket.getpeercert() + if not cert.get("subjectAltName", ()): + warnings.warn( + ( + "Certificate for {0} has no `subjectAltName`, falling back to check for a " + "`commonName` for now. This feature is being removed by major browsers and " + "deprecated by RFC 2818. (See https://github.com/urllib3/urllib3/issues/497 " + "for details.)".format(hostname) + ), + SubjectAltNameWarning, ) + _match_hostname(cert, hostname) - _match_hostname( - cert, - assert_hostname or server_hostname, # type: ignore[arg-type] - hostname_checks_common_name, - ) - - return _WrappedAndVerifiedSocket( - socket=ssl_sock, - is_verified=context.verify_mode == ssl.CERT_REQUIRED - or bool(assert_fingerprint), - ) - except BaseException: - ssl_sock.close() - raise + self.proxy_is_verified = ssl_context.verify_mode == ssl.CERT_REQUIRED + return socket -def _match_hostname( - cert: _TYPE_PEER_CERT_RET_DICT | None, - asserted_hostname: str, - hostname_checks_common_name: bool = False, -) -> None: +def _match_hostname(cert, asserted_hostname): # Our upstream implementation of ssl.match_hostname() # only applies this normalization to IP addresses so it doesn't # match DNS SANs so we do the same thing! - stripped_hostname = asserted_hostname.strip("[]") + stripped_hostname = asserted_hostname.strip("u[]") if is_ipaddress(stripped_hostname): asserted_hostname = stripped_hostname try: - match_hostname(cert, asserted_hostname, hostname_checks_common_name) + match_hostname(cert, asserted_hostname) except CertificateError as e: log.warning( "Certificate did not match expected hostname: %s. Certificate: %s", @@ -1045,55 +551,22 @@ def _match_hostname( ) # Add cert to exception and reraise so client code can inspect # the cert when catching the exception, if they want to - e._peer_cert = cert # type: ignore[attr-defined] + e._peer_cert = cert raise -def _wrap_proxy_error(err: Exception, proxy_scheme: str | None) -> ProxyError: - # Look for the phrase 'wrong version number', if found - # then we should warn the user that we're very sure that - # this proxy is HTTP-only and they have a configuration issue. - error_normalized = " ".join(re.split("[^a-z]", str(err).lower())) - is_likely_http_proxy = ( - "wrong version number" in error_normalized - or "unknown protocol" in error_normalized - or "record layer failure" in error_normalized - ) - http_proxy_warning = ( - ". Your proxy appears to only use HTTP and not HTTPS, " - "try changing your proxy URL to be HTTP. See: " - "https://urllib3.readthedocs.io/en/latest/advanced-usage.html" - "#https-proxy-error-http-proxy" - ) - new_err = ProxyError( - f"Unable to connect to proxy" - f"{http_proxy_warning if is_likely_http_proxy and proxy_scheme == 'https' else ''}", - err, - ) - new_err.__cause__ = err - return new_err - - -def _get_default_user_agent() -> str: - return f"python-urllib3/{__version__}" - - -class DummyConnection: - """Used to detect a failed ConnectionCls import.""" +def _get_default_user_agent(): + return "python-urllib3/%s" % __version__ -if not ssl: - HTTPSConnection = DummyConnection # type: ignore[misc, assignment] # noqa: F811 - +class DummyConnection(object): + """Used to detect a failed ConnectionCls import.""" -VerifiedHTTPSConnection = HTTPSConnection + pass -def _url_from_connection( - conn: HTTPConnection | HTTPSConnection, path: str | None = None -) -> str: - """Returns the URL from a given connection. This is mainly used for testing and logging.""" +if not ssl: + HTTPSConnection = DummyConnection # noqa: F811 - scheme = "https" if isinstance(conn, HTTPSConnection) else "http" - return Url(scheme=scheme, host=conn.host, port=conn.port, path=path).url +VerifiedHTTPSConnection = HTTPSConnection diff --git a/newrelic/packages/urllib3/connectionpool.py b/newrelic/packages/urllib3/connectionpool.py index 3a0685b4cd..402bf670da 100644 --- a/newrelic/packages/urllib3/connectionpool.py +++ b/newrelic/packages/urllib3/connectionpool.py @@ -1,18 +1,15 @@ -from __future__ import annotations +from __future__ import absolute_import import errno import logging -import queue +import re +import socket import sys -import typing import warnings -import weakref +from socket import error as SocketError from socket import timeout as SocketTimeout -from types import TracebackType -from ._base_connection import _TYPE_BODY from ._collections import HTTPHeaderDict -from ._request_methods import RequestMethods from .connection import ( BaseSSLError, BrokenPipeError, @@ -20,14 +17,13 @@ HTTPConnection, HTTPException, HTTPSConnection, - ProxyConfig, - _wrap_proxy_error, + VerifiedHTTPSConnection, + port_by_scheme, ) -from .connection import port_by_scheme as port_by_scheme from .exceptions import ( ClosedPoolError, EmptyPoolError, - FullPoolError, + HeaderParsingError, HostChangedError, InsecureRequestWarning, LocationValueError, @@ -39,32 +35,38 @@ SSLError, TimeoutError, ) -from .response import BaseHTTPResponse +from .packages import six +from .packages.six.moves import queue +from .request import RequestMethods +from .response import HTTPResponse from .util.connection import is_connection_dropped from .util.proxy import connection_requires_http_tunnel -from .util.request import _TYPE_BODY_POSITION, set_file_position +from .util.queue import LifoQueue +from .util.request import set_file_position +from .util.response import assert_header_parsing from .util.retry import Retry from .util.ssl_match_hostname import CertificateError -from .util.timeout import _DEFAULT_TIMEOUT, _TYPE_DEFAULT, Timeout +from .util.timeout import Timeout from .util.url import Url, _encode_target from .util.url import _normalize_host as normalize_host -from .util.url import parse_url -from .util.util import to_str +from .util.url import get_host, parse_url -if typing.TYPE_CHECKING: - import ssl +try: # Platform-specific: Python 3 + import weakref - from typing_extensions import Self + weakref_finalize = weakref.finalize +except AttributeError: # Platform-specific: Python 2 + from .packages.backports.weakref_finalize import weakref_finalize - from ._base_connection import BaseHTTPConnection, BaseHTTPSConnection +xrange = six.moves.xrange log = logging.getLogger(__name__) -_TYPE_TIMEOUT = typing.Union[Timeout, float, _TYPE_DEFAULT, None] +_Default = object() # Pool objects -class ConnectionPool: +class ConnectionPool(object): """ Base class for all connection pools, such as :class:`.HTTPConnectionPool` and :class:`.HTTPSConnectionPool`. @@ -75,42 +77,33 @@ class ConnectionPool: target URIs. """ - scheme: str | None = None - QueueCls = queue.LifoQueue + scheme = None + QueueCls = LifoQueue - def __init__(self, host: str, port: int | None = None) -> None: + def __init__(self, host, port=None): if not host: raise LocationValueError("No host specified.") self.host = _normalize_host(host, scheme=self.scheme) + self._proxy_host = host.lower() self.port = port - # This property uses 'normalize_host()' (not '_normalize_host()') - # to avoid removing square braces around IPv6 addresses. - # This value is sent to `HTTPConnection.set_tunnel()` if called - # because square braces are required for HTTP CONNECT tunneling. - self._tunnel_host = normalize_host(host, scheme=self.scheme).lower() + def __str__(self): + return "%s(host=%r, port=%r)" % (type(self).__name__, self.host, self.port) - def __str__(self) -> str: - return f"{type(self).__name__}(host={self.host!r}, port={self.port!r})" - - def __enter__(self) -> Self: + def __enter__(self): return self - def __exit__( - self, - exc_type: type[BaseException] | None, - exc_val: BaseException | None, - exc_tb: TracebackType | None, - ) -> typing.Literal[False]: + def __exit__(self, exc_type, exc_val, exc_tb): self.close() # Return False to re-raise any potential exceptions return False - def close(self) -> None: + def close(self): """ Close all pooled connections and disable the pool. """ + pass # This is taken from http://hg.python.org/cpython/file/7aaba721ebc0/Lib/socket.py#l252 @@ -129,6 +122,14 @@ class HTTPConnectionPool(ConnectionPool, RequestMethods): Port used for this HTTP Connection (None is equivalent to 80), passed into :class:`http.client.HTTPConnection`. + :param strict: + Causes BadStatusLine to be raised if the status line can't be parsed + as a valid HTTP/1.0 or 1.1 status line, passed into + :class:`http.client.HTTPConnection`. + + .. note:: + Only works in Python 2. This parameter is ignored in Python 3. + :param timeout: Socket timeout in seconds for each individual connection. This can be a float or integer, which sets the timeout for the HTTP request, @@ -170,25 +171,29 @@ class HTTPConnectionPool(ConnectionPool, RequestMethods): """ scheme = "http" - ConnectionCls: type[BaseHTTPConnection] | type[BaseHTTPSConnection] = HTTPConnection + ConnectionCls = HTTPConnection + ResponseCls = HTTPResponse def __init__( self, - host: str, - port: int | None = None, - timeout: _TYPE_TIMEOUT | None = _DEFAULT_TIMEOUT, - maxsize: int = 1, - block: bool = False, - headers: typing.Mapping[str, str] | None = None, - retries: Retry | bool | int | None = None, - _proxy: Url | None = None, - _proxy_headers: typing.Mapping[str, str] | None = None, - _proxy_config: ProxyConfig | None = None, - **conn_kw: typing.Any, + host, + port=None, + strict=False, + timeout=Timeout.DEFAULT_TIMEOUT, + maxsize=1, + block=False, + headers=None, + retries=None, + _proxy=None, + _proxy_headers=None, + _proxy_config=None, + **conn_kw ): ConnectionPool.__init__(self, host, port) RequestMethods.__init__(self, headers) + self.strict = strict + if not isinstance(timeout, Timeout): timeout = Timeout.from_float(timeout) @@ -198,7 +203,7 @@ def __init__( self.timeout = timeout self.retries = retries - self.pool: queue.LifoQueue[typing.Any] | None = self.QueueCls(maxsize) + self.pool = self.QueueCls(maxsize) self.block = block self.proxy = _proxy @@ -206,7 +211,7 @@ def __init__( self.proxy_config = _proxy_config # Fill the queue up so that doing get() on it will block properly - for _ in range(maxsize): + for _ in xrange(maxsize): self.pool.put(None) # These are mostly for testing and debugging purposes. @@ -231,9 +236,9 @@ def __init__( # Close all the HTTPConnections in the pool before the # HTTPConnectionPool object is garbage collected. - weakref.finalize(self, _close_pool_connections, pool) + weakref_finalize(self, _close_pool_connections, pool) - def _new_conn(self) -> BaseHTTPConnection: + def _new_conn(self): """ Return a fresh :class:`HTTPConnection`. """ @@ -249,11 +254,12 @@ def _new_conn(self) -> BaseHTTPConnection: host=self.host, port=self.port, timeout=self.timeout.connect_timeout, - **self.conn_kw, + strict=self.strict, + **self.conn_kw ) return conn - def _get_conn(self, timeout: float | None = None) -> BaseHTTPConnection: + def _get_conn(self, timeout=None): """ Get a connection. Will return a pooled connection if one is available. @@ -266,32 +272,33 @@ def _get_conn(self, timeout: float | None = None) -> BaseHTTPConnection: :prop:`.block` is ``True``. """ conn = None - - if self.pool is None: - raise ClosedPoolError(self, "Pool is closed.") - try: conn = self.pool.get(block=self.block, timeout=timeout) except AttributeError: # self.pool is None - raise ClosedPoolError(self, "Pool is closed.") from None # Defensive: + raise ClosedPoolError(self, "Pool is closed.") except queue.Empty: if self.block: raise EmptyPoolError( self, - "Pool is empty and a new connection can't be opened due to blocking mode.", - ) from None + "Pool reached maximum size and no more connections are allowed.", + ) pass # Oh well, we'll create a new connection then # If this is a persistent connection, check if it got disconnected if conn and is_connection_dropped(conn): log.debug("Resetting dropped connection: %s", self.host) conn.close() + if getattr(conn, "auto_open", 1) == 0: + # This is a proxied connection that has been mutated by + # http.client._tunnel() and cannot be reused (since it would + # attempt to bypass the proxy) + conn = None return conn or self._new_conn() - def _put_conn(self, conn: BaseHTTPConnection | None) -> None: + def _put_conn(self, conn): """ Put a connection back into the pool. @@ -305,47 +312,36 @@ def _put_conn(self, conn: BaseHTTPConnection | None) -> None: If the pool is closed, then the connection will be closed and discarded. """ - if self.pool is not None: - try: - self.pool.put(conn, block=False) - return # Everything is dandy, done. - except AttributeError: - # self.pool is None. - pass - except queue.Full: - # Connection never got put back into the pool, close it. - if conn: - conn.close() - - if self.block: - # This should never happen if you got the conn from self._get_conn - raise FullPoolError( - self, - "Pool reached maximum size and no more connections are allowed.", - ) from None - - log.warning( - "Connection pool is full, discarding connection: %s. Connection pool size: %s", - self.host, - self.pool.qsize(), - ) - + try: + self.pool.put(conn, block=False) + return # Everything is dandy, done. + except AttributeError: + # self.pool is None. + pass + except queue.Full: + # This should never happen if self.block == True + log.warning( + "Connection pool is full, discarding connection: %s. Connection pool size: %s", + self.host, + self.pool.qsize(), + ) # Connection never got put back into the pool, close it. if conn: conn.close() - def _validate_conn(self, conn: BaseHTTPConnection) -> None: + def _validate_conn(self, conn): """ Called right before a request is made, after the socket is created. """ + pass - def _prepare_proxy(self, conn: BaseHTTPConnection) -> None: + def _prepare_proxy(self, conn): # Nothing to do for HTTP connections. pass - def _get_timeout(self, timeout: _TYPE_TIMEOUT) -> Timeout: + def _get_timeout(self, timeout): """Helper that always returns a :class:`urllib3.util.Timeout`""" - if timeout is _DEFAULT_TIMEOUT: + if timeout is _Default: return self.timeout.clone() if isinstance(timeout, Timeout): @@ -355,40 +351,34 @@ def _get_timeout(self, timeout: _TYPE_TIMEOUT) -> Timeout: # can be removed later return Timeout.from_float(timeout) - def _raise_timeout( - self, - err: BaseSSLError | OSError | SocketTimeout, - url: str, - timeout_value: _TYPE_TIMEOUT | None, - ) -> None: + def _raise_timeout(self, err, url, timeout_value): """Is the error actually a timeout? Will raise a ReadTimeout or pass""" if isinstance(err, SocketTimeout): raise ReadTimeoutError( - self, url, f"Read timed out. (read timeout={timeout_value})" - ) from err + self, url, "Read timed out. (read timeout=%s)" % timeout_value + ) - # See the above comment about EAGAIN in Python 3. + # See the above comment about EAGAIN in Python 3. In Python 2 we have + # to specifically catch it and throw the timeout error if hasattr(err, "errno") and err.errno in _blocking_errnos: raise ReadTimeoutError( - self, url, f"Read timed out. (read timeout={timeout_value})" - ) from err + self, url, "Read timed out. (read timeout=%s)" % timeout_value + ) + + # Catch possible read timeouts thrown as SSL errors. If not the + # case, rethrow the original. We need to do this because of: + # http://bugs.python.org/issue10272 + if "timed out" in str(err) or "did not complete (read)" in str( + err + ): # Python < 2.7.4 + raise ReadTimeoutError( + self, url, "Read timed out. (read timeout=%s)" % timeout_value + ) def _make_request( - self, - conn: BaseHTTPConnection, - method: str, - url: str, - body: _TYPE_BODY | None = None, - headers: typing.Mapping[str, str] | None = None, - retries: Retry | None = None, - timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, - chunked: bool = False, - response_conn: BaseHTTPConnection | None = None, - preload_content: bool = True, - decode_content: bool = True, - enforce_content_length: bool = True, - ) -> BaseHTTPResponse: + self, conn, method, url, timeout=_Default, chunked=False, **httplib_request_kw + ): """ Perform a request on a given urllib connection object taken from our pool. @@ -396,61 +386,12 @@ def _make_request( :param conn: a connection from one of our connection pools - :param method: - HTTP request method (such as GET, POST, PUT, etc.) - - :param url: - The URL to perform the request on. - - :param body: - Data to send in the request body, either :class:`str`, :class:`bytes`, - an iterable of :class:`str`/:class:`bytes`, or a file-like object. - - :param headers: - Dictionary of custom headers to send, such as User-Agent, - If-None-Match, etc. If None, pool headers are used. If provided, - these headers completely replace any pool-specific headers. - - :param retries: - Configure the number of retries to allow before raising a - :class:`~urllib3.exceptions.MaxRetryError` exception. - - Pass ``None`` to retry until you receive a response. Pass a - :class:`~urllib3.util.retry.Retry` object for fine-grained control - over different types of retries. - Pass an integer number to retry connection errors that many times, - but no other types of errors. Pass zero to never retry. - - If ``False``, then retries are disabled and any exception is raised - immediately. Also, instead of raising a MaxRetryError on redirects, - the redirect response will be returned. - - :type retries: :class:`~urllib3.util.retry.Retry`, False, or an int. - :param timeout: - If specified, overrides the default timeout for this one - request. It may be a float (in seconds) or an instance of - :class:`urllib3.util.Timeout`. - - :param chunked: - If True, urllib3 will send the body using chunked transfer - encoding. Otherwise, urllib3 will send the body using the standard - content-length form. Defaults to False. - - :param response_conn: - Set this to ``None`` if you will handle releasing the connection or - set the connection to have the response release it. - - :param preload_content: - If True, the response's body will be preloaded during construction. - - :param decode_content: - If True, will attempt to decode the body based on the - 'content-encoding' header. - - :param enforce_content_length: - Enforce content length checking. Body returned by server must match - value of Content-Length header, if present. Otherwise, raise error. + Socket timeout in seconds for the request. This can be a + float or integer, which will set the same timeout value for + the socket connect and the socket read, or an instance of + :class:`urllib3.util.Timeout`, which gives you more fine-grained + control over your timeouts. """ self.num_requests += 1 @@ -458,66 +399,44 @@ def _make_request( timeout_obj.start_connect() conn.timeout = Timeout.resolve_default_timeout(timeout_obj.connect_timeout) + # Trigger any extra validation we need to do. try: - # Trigger any extra validation we need to do. - try: - self._validate_conn(conn) - except (SocketTimeout, BaseSSLError) as e: - self._raise_timeout(err=e, url=url, timeout_value=conn.timeout) - raise - - # _validate_conn() starts the connection to an HTTPS proxy - # so we need to wrap errors with 'ProxyError' here too. - except ( - OSError, - NewConnectionError, - TimeoutError, - BaseSSLError, - CertificateError, - SSLError, - ) as e: - new_e: Exception = e - if isinstance(e, (BaseSSLError, CertificateError)): - new_e = SSLError(e) - # If the connection didn't successfully connect to it's proxy - # then there - if isinstance( - new_e, (OSError, NewConnectionError, TimeoutError, SSLError) - ) and (conn and conn.proxy and not conn.has_connected_to_proxy): - new_e = _wrap_proxy_error(new_e, conn.proxy.scheme) - raise new_e + self._validate_conn(conn) + except (SocketTimeout, BaseSSLError) as e: + # Py2 raises this as a BaseSSLError, Py3 raises it as socket timeout. + self._raise_timeout(err=e, url=url, timeout_value=conn.timeout) + raise # conn.request() calls http.client.*.request, not the method in # urllib3.request. It also calls makefile (recv) on the socket. try: - conn.request( - method, - url, - body=body, - headers=headers, - chunked=chunked, - preload_content=preload_content, - decode_content=decode_content, - enforce_content_length=enforce_content_length, - ) + if chunked: + conn.request_chunked(method, url, **httplib_request_kw) + else: + conn.request(method, url, **httplib_request_kw) # We are swallowing BrokenPipeError (errno.EPIPE) since the server is # legitimately able to close the connection after sending a valid response. # With this behaviour, the received response is still readable. except BrokenPipeError: + # Python 3 pass - except OSError as e: - # MacOS/Linux - # EPROTOTYPE and ECONNRESET are needed on macOS + except IOError as e: + # Python 2 and macOS/Linux + # EPIPE and ESHUTDOWN are BrokenPipeError on Python 2, and EPROTOTYPE is needed on macOS # https://erickt.github.io/blog/2014/11/19/adventures-in-debugging-a-potential-osx-kernel-bug/ - # Condition changed later to emit ECONNRESET instead of only EPROTOTYPE. - if e.errno != errno.EPROTOTYPE and e.errno != errno.ECONNRESET: + if e.errno not in { + errno.EPIPE, + errno.ESHUTDOWN, + errno.EPROTOTYPE, + }: raise # Reset the timeout for the recv() on the socket read_timeout = timeout_obj.read_timeout - if not conn.is_closed: + # App Engine doesn't have a sock attr + if getattr(conn, "sock", None): # In Python 3 socket.py will catch EAGAIN and return None when you # try and read into the file pointer created by http.client, which # instead raises a BadStatusLine exception. Instead of catching @@ -525,22 +444,33 @@ def _make_request( # timeouts, check for a zero timeout before making the request. if read_timeout == 0: raise ReadTimeoutError( - self, url, f"Read timed out. (read timeout={read_timeout})" + self, url, "Read timed out. (read timeout=%s)" % read_timeout ) - conn.timeout = read_timeout + if read_timeout is Timeout.DEFAULT_TIMEOUT: + conn.sock.settimeout(socket.getdefaulttimeout()) + else: # None or a value + conn.sock.settimeout(read_timeout) # Receive the response from the server try: - response = conn.getresponse() - except (BaseSSLError, OSError) as e: + try: + # Python 2.7, use buffering of HTTP responses + httplib_response = conn.getresponse(buffering=True) + except TypeError: + # Python 3 + try: + httplib_response = conn.getresponse() + except BaseException as e: + # Remove the TypeError from the exception chain in + # Python 3 (including for exceptions like SystemExit). + # Otherwise it looks like a bug in the code. + six.raise_from(e, None) + except (SocketTimeout, BaseSSLError, SocketError) as e: self._raise_timeout(err=e, url=url, timeout_value=read_timeout) raise - # Set properties that are used by the pooling layer. - response.retries = retries - response._connection = response_conn # type: ignore[attr-defined] - response._pool = self # type: ignore[attr-defined] - + # AppEngine doesn't have a version attr. + http_version = getattr(conn, "_http_vsn_str", "HTTP/?") log.debug( '%s://%s:%s "%s %s %s" %s %s', self.scheme, @@ -548,14 +478,27 @@ def _make_request( self.port, method, url, - response.version_string, - response.status, - response.length_remaining, + http_version, + httplib_response.status, + httplib_response.length, ) - return response + try: + assert_header_parsing(httplib_response.msg) + except (HeaderParsingError, TypeError) as hpe: # Platform-specific: Python 3 + log.warning( + "Failed to parse headers (url=%s): %s", + self._absolute_url(url), + hpe, + exc_info=True, + ) + + return httplib_response + + def _absolute_url(self, path): + return Url(scheme=self.scheme, host=self.host, port=self.port, path=path).url - def close(self) -> None: + def close(self): """ Close all pooled connections and disable the pool. """ @@ -567,7 +510,7 @@ def close(self) -> None: # Close all the HTTPConnections in the pool. _close_pool_connections(old_pool) - def is_same_host(self, url: str) -> bool: + def is_same_host(self, url): """ Check if the given ``url`` is a member of the same host as this connection pool. @@ -576,8 +519,7 @@ def is_same_host(self, url: str) -> bool: return True # TODO: Add optional support for socket.gethostbyname checking. - scheme, _, host, port, *_ = parse_url(url) - scheme = scheme or "http" + scheme, host, port = get_host(url) if host is not None: host = _normalize_host(host, scheme=scheme) @@ -589,24 +531,22 @@ def is_same_host(self, url: str) -> bool: return (scheme, host, port) == (self.scheme, self.host, self.port) - def urlopen( # type: ignore[override] + def urlopen( self, - method: str, - url: str, - body: _TYPE_BODY | None = None, - headers: typing.Mapping[str, str] | None = None, - retries: Retry | bool | int | None = None, - redirect: bool = True, - assert_same_host: bool = True, - timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, - pool_timeout: int | None = None, - release_conn: bool | None = None, - chunked: bool = False, - body_pos: _TYPE_BODY_POSITION | None = None, - preload_content: bool = True, - decode_content: bool = True, - **response_kw: typing.Any, - ) -> BaseHTTPResponse: + method, + url, + body=None, + headers=None, + retries=None, + redirect=True, + assert_same_host=True, + timeout=_Default, + pool_timeout=None, + release_conn=None, + chunked=False, + body_pos=None, + **response_kw + ): """ Get a connection from the pool and perform an HTTP request. This is the lowest level call for making a request, so you'll need to specify all @@ -614,8 +554,8 @@ def urlopen( # type: ignore[override] .. note:: - More commonly, it's appropriate to use a convenience method - such as :meth:`request`. + More commonly, it's appropriate to use a convenience method provided + by :class:`.RequestMethods`, such as :meth:`request`. .. note:: @@ -643,7 +583,7 @@ def urlopen( # type: ignore[override] Configure the number of retries to allow before raising a :class:`~urllib3.exceptions.MaxRetryError` exception. - If ``None`` (default) will retry 3 times, see ``Retry.DEFAULT``. Pass a + Pass ``None`` to retry until you receive a response. Pass a :class:`~urllib3.util.retry.Retry` object for fine-grained control over different types of retries. Pass an integer number to retry connection errors that many times, @@ -675,13 +615,6 @@ def urlopen( # type: ignore[override] block for ``pool_timeout`` seconds and raise EmptyPoolError if no connection is available within the time period. - :param bool preload_content: - If True, the response's body will be preloaded into memory. - - :param bool decode_content: - If True, will attempt to decode the body based on the - 'content-encoding' header. - :param release_conn: If False, then the urlopen call will not release the connection back into the pool once a response is received (but will release if @@ -689,10 +622,10 @@ def urlopen( # type: ignore[override] `preload_content=True`). This is useful if you're not preloading the response's content immediately. You will need to call ``r.release_conn()`` on the response ``r`` to return the connection - back into the pool. If None, it takes the value of ``preload_content`` - which defaults to ``True``. + back into the pool. If None, it takes the value of + ``response_kw.get('preload_content', True)``. - :param bool chunked: + :param chunked: If True, urllib3 will send the body using chunked transfer encoding. Otherwise, urllib3 will send the body using the standard content-length form. Defaults to False. @@ -701,7 +634,12 @@ def urlopen( # type: ignore[override] Position to seek to in file-like body in the event of a retry or redirect. Typically this won't need to be set because urllib3 will auto-populate the value when needed. + + :param \\**response_kw: + Additional parameters are passed to + :meth:`urllib3.response.HTTPResponse.from_httplib` """ + parsed_url = parse_url(url) destination_scheme = parsed_url.scheme @@ -712,7 +650,7 @@ def urlopen( # type: ignore[override] retries = Retry.from_int(retries, redirect=redirect, default=self.retries) if release_conn is None: - release_conn = preload_content + release_conn = response_kw.get("preload_content", True) # Check host if assert_same_host and not self.is_same_host(url): @@ -720,9 +658,9 @@ def urlopen( # type: ignore[override] # Ensure that the URL we're connecting to is properly encoded if url.startswith("/"): - url = to_str(_encode_target(url)) + url = six.ensure_str(_encode_target(url)) else: - url = to_str(parsed_url.url) + url = six.ensure_str(parsed_url.url) conn = None @@ -745,8 +683,8 @@ def urlopen( # type: ignore[override] # have to copy the headers dict so we can safely change it without those # changes being reflected in anyone else's copy. if not http_tunnel_required: - headers = headers.copy() # type: ignore[attr-defined] - headers.update(self.proxy_headers) # type: ignore[union-attr] + headers = headers.copy() + headers.update(self.proxy_headers) # Must keep the exception bound to a separate variable or else Python 3 # complains about UnboundLocalError. @@ -765,26 +703,16 @@ def urlopen( # type: ignore[override] timeout_obj = self._get_timeout(timeout) conn = self._get_conn(timeout=pool_timeout) - conn.timeout = timeout_obj.connect_timeout # type: ignore[assignment] + conn.timeout = timeout_obj.connect_timeout - # Is this a closed/new connection that requires CONNECT tunnelling? - if self.proxy is not None and http_tunnel_required and conn.is_closed: - try: - self._prepare_proxy(conn) - except (BaseSSLError, OSError, SocketTimeout) as e: - self._raise_timeout( - err=e, url=self.proxy.url, timeout_value=conn.timeout - ) - raise - - # If we're going to release the connection in ``finally:``, then - # the response doesn't need to know about the connection. Otherwise - # it will also try to release it and we'll have a double-release - # mess. - response_conn = conn if not release_conn else None + is_new_proxy_conn = self.proxy is not None and not getattr( + conn, "sock", None + ) + if is_new_proxy_conn and http_tunnel_required: + self._prepare_proxy(conn) - # Make the request on the HTTPConnection object - response = self._make_request( + # Make the request on the httplib connection object. + httplib_response = self._make_request( conn, method, url, @@ -792,11 +720,24 @@ def urlopen( # type: ignore[override] body=body, headers=headers, chunked=chunked, + ) + + # If we're going to release the connection in ``finally:``, then + # the response doesn't need to know about the connection. Otherwise + # it will also try to release it and we'll have a double-release + # mess. + response_conn = conn if not release_conn else None + + # Pass method to Response for length checking + response_kw["request_method"] = method + + # Import httplib's response into our own wrapper object + response = self.ResponseCls.from_httplib( + httplib_response, + pool=self, + connection=response_conn, retries=retries, - response_conn=response_conn, - preload_content=preload_content, - decode_content=decode_content, - **response_kw, + **response_kw ) # Everything went great! @@ -811,35 +752,54 @@ def urlopen( # type: ignore[override] except ( TimeoutError, HTTPException, - OSError, + SocketError, ProtocolError, BaseSSLError, SSLError, CertificateError, - ProxyError, ) as e: # Discard the connection for these exceptions. It will be # replaced during the next _get_conn() call. clean_exit = False - new_e: Exception = e - if isinstance(e, (BaseSSLError, CertificateError)): - new_e = SSLError(e) - if isinstance( - new_e, - ( - OSError, - NewConnectionError, - TimeoutError, - SSLError, - HTTPException, - ), - ) and (conn and conn.proxy and not conn.has_connected_to_proxy): - new_e = _wrap_proxy_error(new_e, conn.proxy.scheme) - elif isinstance(new_e, (OSError, HTTPException)): - new_e = ProtocolError("Connection aborted.", new_e) + + def _is_ssl_error_message_from_http_proxy(ssl_error): + # We're trying to detect the message 'WRONG_VERSION_NUMBER' but + # SSLErrors are kinda all over the place when it comes to the message, + # so we try to cover our bases here! + message = " ".join(re.split("[^a-z]", str(ssl_error).lower())) + return ( + "wrong version number" in message + or "unknown protocol" in message + or "record layer failure" in message + ) + + # Try to detect a common user error with proxies which is to + # set an HTTP proxy to be HTTPS when it should be 'http://' + # (ie {'http': 'http://proxy', 'https': 'https://proxy'}) + # Instead we add a nice error message and point to a URL. + if ( + isinstance(e, BaseSSLError) + and self.proxy + and _is_ssl_error_message_from_http_proxy(e) + and conn.proxy + and conn.proxy.scheme == "https" + ): + e = ProxyError( + "Your proxy appears to only use HTTP and not HTTPS, " + "try changing your proxy URL to be HTTP. See: " + "https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html" + "#https-proxy-error-http-proxy", + SSLError(e), + ) + elif isinstance(e, (BaseSSLError, CertificateError)): + e = SSLError(e) + elif isinstance(e, (SocketError, NewConnectionError)) and self.proxy: + e = ProxyError("Cannot connect to proxy.", e) + elif isinstance(e, (SocketError, HTTPException)): + e = ProtocolError("Connection aborted.", e) retries = retries.increment( - method, url, error=new_e, _pool=self, _stacktrace=sys.exc_info()[2] + method, url, error=e, _pool=self, _stacktrace=sys.exc_info()[2] ) retries.sleep() @@ -852,9 +812,7 @@ def urlopen( # type: ignore[override] # to throw the connection away unless explicitly told not to. # Close the connection, set the variable to None, and make sure # we put the None back in the pool to avoid leaking it. - if conn: - conn.close() - conn = None + conn = conn and conn.close() release_this_conn = True if release_this_conn: @@ -881,9 +839,7 @@ def urlopen( # type: ignore[override] release_conn=release_conn, chunked=chunked, body_pos=body_pos, - preload_content=preload_content, - decode_content=decode_content, - **response_kw, + **response_kw ) # Handle redirect? @@ -920,9 +876,7 @@ def urlopen( # type: ignore[override] release_conn=release_conn, chunked=chunked, body_pos=body_pos, - preload_content=preload_content, - decode_content=decode_content, - **response_kw, + **response_kw ) # Check if we should retry the HTTP response. @@ -952,9 +906,7 @@ def urlopen( # type: ignore[override] release_conn=release_conn, chunked=chunked, body_pos=body_pos, - preload_content=preload_content, - decode_content=decode_content, - **response_kw, + **response_kw ) return response @@ -975,35 +927,37 @@ class HTTPSConnectionPool(HTTPConnectionPool): """ scheme = "https" - ConnectionCls: type[BaseHTTPSConnection] = HTTPSConnection + ConnectionCls = HTTPSConnection def __init__( self, - host: str, - port: int | None = None, - timeout: _TYPE_TIMEOUT | None = _DEFAULT_TIMEOUT, - maxsize: int = 1, - block: bool = False, - headers: typing.Mapping[str, str] | None = None, - retries: Retry | bool | int | None = None, - _proxy: Url | None = None, - _proxy_headers: typing.Mapping[str, str] | None = None, - key_file: str | None = None, - cert_file: str | None = None, - cert_reqs: int | str | None = None, - key_password: str | None = None, - ca_certs: str | None = None, - ssl_version: int | str | None = None, - ssl_minimum_version: ssl.TLSVersion | None = None, - ssl_maximum_version: ssl.TLSVersion | None = None, - assert_hostname: str | typing.Literal[False] | None = None, - assert_fingerprint: str | None = None, - ca_cert_dir: str | None = None, - **conn_kw: typing.Any, - ) -> None: - super().__init__( + host, + port=None, + strict=False, + timeout=Timeout.DEFAULT_TIMEOUT, + maxsize=1, + block=False, + headers=None, + retries=None, + _proxy=None, + _proxy_headers=None, + key_file=None, + cert_file=None, + cert_reqs=None, + key_password=None, + ca_certs=None, + ssl_version=None, + assert_hostname=None, + assert_fingerprint=None, + ca_cert_dir=None, + **conn_kw + ): + + HTTPConnectionPool.__init__( + self, host, port, + strict, timeout, maxsize, block, @@ -1011,7 +965,7 @@ def __init__( retries, _proxy, _proxy_headers, - **conn_kw, + **conn_kw ) self.key_file = key_file @@ -1021,29 +975,47 @@ def __init__( self.ca_certs = ca_certs self.ca_cert_dir = ca_cert_dir self.ssl_version = ssl_version - self.ssl_minimum_version = ssl_minimum_version - self.ssl_maximum_version = ssl_maximum_version self.assert_hostname = assert_hostname self.assert_fingerprint = assert_fingerprint - def _prepare_proxy(self, conn: HTTPSConnection) -> None: # type: ignore[override] - """Establishes a tunnel connection through HTTP CONNECT.""" - if self.proxy and self.proxy.scheme == "https": - tunnel_scheme = "https" - else: - tunnel_scheme = "http" + def _prepare_conn(self, conn): + """ + Prepare the ``connection`` for :meth:`urllib3.util.ssl_wrap_socket` + and establish the tunnel if proxy is used. + """ + + if isinstance(conn, VerifiedHTTPSConnection): + conn.set_cert( + key_file=self.key_file, + key_password=self.key_password, + cert_file=self.cert_file, + cert_reqs=self.cert_reqs, + ca_certs=self.ca_certs, + ca_cert_dir=self.ca_cert_dir, + assert_hostname=self.assert_hostname, + assert_fingerprint=self.assert_fingerprint, + ) + conn.ssl_version = self.ssl_version + return conn + + def _prepare_proxy(self, conn): + """ + Establishes a tunnel connection through HTTP CONNECT. + + Tunnel connection is established early because otherwise httplib would + improperly set Host: header to proxy's IP:port. + """ + + conn.set_tunnel(self._proxy_host, self.port, self.proxy_headers) + + if self.proxy.scheme == "https": + conn.tls_in_tls_required = True - conn.set_tunnel( - scheme=tunnel_scheme, - host=self._tunnel_host, - port=self.port, - headers=self.proxy_headers, - ) conn.connect() - def _new_conn(self) -> BaseHTTPSConnection: + def _new_conn(self): """ - Return a fresh :class:`urllib3.connection.HTTPConnection`. + Return a fresh :class:`http.client.HTTPSConnection`. """ self.num_connections += 1 log.debug( @@ -1053,59 +1025,64 @@ def _new_conn(self) -> BaseHTTPSConnection: self.port or "443", ) - if not self.ConnectionCls or self.ConnectionCls is DummyConnection: # type: ignore[comparison-overlap] - raise ImportError( + if not self.ConnectionCls or self.ConnectionCls is DummyConnection: + raise SSLError( "Can't connect to HTTPS URL because the SSL module is not available." ) - actual_host: str = self.host + actual_host = self.host actual_port = self.port - if self.proxy is not None and self.proxy.host is not None: + if self.proxy is not None: actual_host = self.proxy.host actual_port = self.proxy.port - return self.ConnectionCls( + conn = self.ConnectionCls( host=actual_host, port=actual_port, timeout=self.timeout.connect_timeout, + strict=self.strict, cert_file=self.cert_file, key_file=self.key_file, key_password=self.key_password, - cert_reqs=self.cert_reqs, - ca_certs=self.ca_certs, - ca_cert_dir=self.ca_cert_dir, - assert_hostname=self.assert_hostname, - assert_fingerprint=self.assert_fingerprint, - ssl_version=self.ssl_version, - ssl_minimum_version=self.ssl_minimum_version, - ssl_maximum_version=self.ssl_maximum_version, - **self.conn_kw, + **self.conn_kw ) - def _validate_conn(self, conn: BaseHTTPConnection) -> None: + return self._prepare_conn(conn) + + def _validate_conn(self, conn): """ Called right before a request is made, after the socket is created. """ - super()._validate_conn(conn) + super(HTTPSConnectionPool, self)._validate_conn(conn) # Force connect early to allow us to validate the connection. - if conn.is_closed: + if not getattr(conn, "sock", None): # AppEngine might not have `.sock` conn.connect() - # TODO revise this, see https://github.com/urllib3/urllib3/issues/2791 - if not conn.is_verified and not conn.proxy_is_verified: + if not conn.is_verified: + warnings.warn( + ( + "Unverified HTTPS request is being made to host '%s'. " + "Adding certificate verification is strongly advised. See: " + "https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html" + "#ssl-warnings" % conn.host + ), + InsecureRequestWarning, + ) + + if getattr(conn, "proxy_is_verified", None) is False: warnings.warn( ( - f"Unverified HTTPS request is being made to host '{conn.host}'. " + "Unverified HTTPS connection done to an HTTPS proxy. " "Adding certificate verification is strongly advised. See: " - "https://urllib3.readthedocs.io/en/latest/advanced-usage.html" - "#tls-warnings" + "https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html" + "#ssl-warnings" ), InsecureRequestWarning, ) -def connection_from_url(url: str, **kw: typing.Any) -> HTTPConnectionPool: +def connection_from_url(url, **kw): """ Given a url, return an :class:`.ConnectionPool` instance of its host. @@ -1125,24 +1102,15 @@ def connection_from_url(url: str, **kw: typing.Any) -> HTTPConnectionPool: >>> conn = connection_from_url('http://google.com/') >>> r = conn.request('GET', '/') """ - scheme, _, host, port, *_ = parse_url(url) - scheme = scheme or "http" + scheme, host, port = get_host(url) port = port or port_by_scheme.get(scheme, 80) if scheme == "https": - return HTTPSConnectionPool(host, port=port, **kw) # type: ignore[arg-type] + return HTTPSConnectionPool(host, port=port, **kw) else: - return HTTPConnectionPool(host, port=port, **kw) # type: ignore[arg-type] - + return HTTPConnectionPool(host, port=port, **kw) -@typing.overload -def _normalize_host(host: None, scheme: str | None) -> None: ... - -@typing.overload -def _normalize_host(host: str, scheme: str | None) -> str: ... - - -def _normalize_host(host: str | None, scheme: str | None) -> str | None: +def _normalize_host(host, scheme): """ Normalize hosts for comparisons and use with sockets. """ @@ -1155,19 +1123,12 @@ def _normalize_host(host: str | None, scheme: str | None) -> str | None: # Instead, we need to make sure we never pass ``None`` as the port. # However, for backward compatibility reasons we can't actually # *assert* that. See http://bugs.python.org/issue28539 - if host and host.startswith("[") and host.endswith("]"): + if host.startswith("[") and host.endswith("]"): host = host[1:-1] return host -def _url_from_pool( - pool: HTTPConnectionPool | HTTPSConnectionPool, path: str | None = None -) -> str: - """Returns the URL from a given connection pool. This is mainly used for testing and logging.""" - return Url(scheme=pool.scheme, host=pool.host, port=pool.port, path=path).url - - -def _close_pool_connections(pool: queue.LifoQueue[typing.Any]) -> None: +def _close_pool_connections(pool): """Drains a queue of connections and closes each one.""" try: while True: diff --git a/newrelic/packages/urllib3/contrib/_appengine_environ.py b/newrelic/packages/urllib3/contrib/_appengine_environ.py new file mode 100644 index 0000000000..8765b907d7 --- /dev/null +++ b/newrelic/packages/urllib3/contrib/_appengine_environ.py @@ -0,0 +1,36 @@ +""" +This module provides means to detect the App Engine environment. +""" + +import os + + +def is_appengine(): + return is_local_appengine() or is_prod_appengine() + + +def is_appengine_sandbox(): + """Reports if the app is running in the first generation sandbox. + + The second generation runtimes are technically still in a sandbox, but it + is much less restrictive, so generally you shouldn't need to check for it. + see https://cloud.google.com/appengine/docs/standard/runtimes + """ + return is_appengine() and os.environ["APPENGINE_RUNTIME"] == "python27" + + +def is_local_appengine(): + return "APPENGINE_RUNTIME" in os.environ and os.environ.get( + "SERVER_SOFTWARE", "" + ).startswith("Development/") + + +def is_prod_appengine(): + return "APPENGINE_RUNTIME" in os.environ and os.environ.get( + "SERVER_SOFTWARE", "" + ).startswith("Google App Engine/") + + +def is_prod_appengine_mvms(): + """Deprecated.""" + return False diff --git a/newrelic/packages/urllib3/contrib/_securetransport/__init__.py b/newrelic/packages/urllib3/contrib/_securetransport/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/newrelic/packages/urllib3/contrib/_securetransport/bindings.py b/newrelic/packages/urllib3/contrib/_securetransport/bindings.py new file mode 100644 index 0000000000..264d564dbd --- /dev/null +++ b/newrelic/packages/urllib3/contrib/_securetransport/bindings.py @@ -0,0 +1,519 @@ +""" +This module uses ctypes to bind a whole bunch of functions and constants from +SecureTransport. The goal here is to provide the low-level API to +SecureTransport. These are essentially the C-level functions and constants, and +they're pretty gross to work with. + +This code is a bastardised version of the code found in Will Bond's oscrypto +library. An enormous debt is owed to him for blazing this trail for us. For +that reason, this code should be considered to be covered both by urllib3's +license and by oscrypto's: + + Copyright (c) 2015-2016 Will Bond + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the "Software"), + to deal in the Software without restriction, including without limitation + the rights to use, copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. +""" +from __future__ import absolute_import + +import platform +from ctypes import ( + CDLL, + CFUNCTYPE, + POINTER, + c_bool, + c_byte, + c_char_p, + c_int32, + c_long, + c_size_t, + c_uint32, + c_ulong, + c_void_p, +) +from ctypes.util import find_library + +from ...packages.six import raise_from + +if platform.system() != "Darwin": + raise ImportError("Only macOS is supported") + +version = platform.mac_ver()[0] +version_info = tuple(map(int, version.split("."))) +if version_info < (10, 8): + raise OSError( + "Only OS X 10.8 and newer are supported, not %s.%s" + % (version_info[0], version_info[1]) + ) + + +def load_cdll(name, macos10_16_path): + """Loads a CDLL by name, falling back to known path on 10.16+""" + try: + # Big Sur is technically 11 but we use 10.16 due to the Big Sur + # beta being labeled as 10.16. + if version_info >= (10, 16): + path = macos10_16_path + else: + path = find_library(name) + if not path: + raise OSError # Caught and reraised as 'ImportError' + return CDLL(path, use_errno=True) + except OSError: + raise_from(ImportError("The library %s failed to load" % name), None) + + +Security = load_cdll( + "Security", "/System/Library/Frameworks/Security.framework/Security" +) +CoreFoundation = load_cdll( + "CoreFoundation", + "/System/Library/Frameworks/CoreFoundation.framework/CoreFoundation", +) + + +Boolean = c_bool +CFIndex = c_long +CFStringEncoding = c_uint32 +CFData = c_void_p +CFString = c_void_p +CFArray = c_void_p +CFMutableArray = c_void_p +CFDictionary = c_void_p +CFError = c_void_p +CFType = c_void_p +CFTypeID = c_ulong + +CFTypeRef = POINTER(CFType) +CFAllocatorRef = c_void_p + +OSStatus = c_int32 + +CFDataRef = POINTER(CFData) +CFStringRef = POINTER(CFString) +CFArrayRef = POINTER(CFArray) +CFMutableArrayRef = POINTER(CFMutableArray) +CFDictionaryRef = POINTER(CFDictionary) +CFArrayCallBacks = c_void_p +CFDictionaryKeyCallBacks = c_void_p +CFDictionaryValueCallBacks = c_void_p + +SecCertificateRef = POINTER(c_void_p) +SecExternalFormat = c_uint32 +SecExternalItemType = c_uint32 +SecIdentityRef = POINTER(c_void_p) +SecItemImportExportFlags = c_uint32 +SecItemImportExportKeyParameters = c_void_p +SecKeychainRef = POINTER(c_void_p) +SSLProtocol = c_uint32 +SSLCipherSuite = c_uint32 +SSLContextRef = POINTER(c_void_p) +SecTrustRef = POINTER(c_void_p) +SSLConnectionRef = c_uint32 +SecTrustResultType = c_uint32 +SecTrustOptionFlags = c_uint32 +SSLProtocolSide = c_uint32 +SSLConnectionType = c_uint32 +SSLSessionOption = c_uint32 + + +try: + Security.SecItemImport.argtypes = [ + CFDataRef, + CFStringRef, + POINTER(SecExternalFormat), + POINTER(SecExternalItemType), + SecItemImportExportFlags, + POINTER(SecItemImportExportKeyParameters), + SecKeychainRef, + POINTER(CFArrayRef), + ] + Security.SecItemImport.restype = OSStatus + + Security.SecCertificateGetTypeID.argtypes = [] + Security.SecCertificateGetTypeID.restype = CFTypeID + + Security.SecIdentityGetTypeID.argtypes = [] + Security.SecIdentityGetTypeID.restype = CFTypeID + + Security.SecKeyGetTypeID.argtypes = [] + Security.SecKeyGetTypeID.restype = CFTypeID + + Security.SecCertificateCreateWithData.argtypes = [CFAllocatorRef, CFDataRef] + Security.SecCertificateCreateWithData.restype = SecCertificateRef + + Security.SecCertificateCopyData.argtypes = [SecCertificateRef] + Security.SecCertificateCopyData.restype = CFDataRef + + Security.SecCopyErrorMessageString.argtypes = [OSStatus, c_void_p] + Security.SecCopyErrorMessageString.restype = CFStringRef + + Security.SecIdentityCreateWithCertificate.argtypes = [ + CFTypeRef, + SecCertificateRef, + POINTER(SecIdentityRef), + ] + Security.SecIdentityCreateWithCertificate.restype = OSStatus + + Security.SecKeychainCreate.argtypes = [ + c_char_p, + c_uint32, + c_void_p, + Boolean, + c_void_p, + POINTER(SecKeychainRef), + ] + Security.SecKeychainCreate.restype = OSStatus + + Security.SecKeychainDelete.argtypes = [SecKeychainRef] + Security.SecKeychainDelete.restype = OSStatus + + Security.SecPKCS12Import.argtypes = [ + CFDataRef, + CFDictionaryRef, + POINTER(CFArrayRef), + ] + Security.SecPKCS12Import.restype = OSStatus + + SSLReadFunc = CFUNCTYPE(OSStatus, SSLConnectionRef, c_void_p, POINTER(c_size_t)) + SSLWriteFunc = CFUNCTYPE( + OSStatus, SSLConnectionRef, POINTER(c_byte), POINTER(c_size_t) + ) + + Security.SSLSetIOFuncs.argtypes = [SSLContextRef, SSLReadFunc, SSLWriteFunc] + Security.SSLSetIOFuncs.restype = OSStatus + + Security.SSLSetPeerID.argtypes = [SSLContextRef, c_char_p, c_size_t] + Security.SSLSetPeerID.restype = OSStatus + + Security.SSLSetCertificate.argtypes = [SSLContextRef, CFArrayRef] + Security.SSLSetCertificate.restype = OSStatus + + Security.SSLSetCertificateAuthorities.argtypes = [SSLContextRef, CFTypeRef, Boolean] + Security.SSLSetCertificateAuthorities.restype = OSStatus + + Security.SSLSetConnection.argtypes = [SSLContextRef, SSLConnectionRef] + Security.SSLSetConnection.restype = OSStatus + + Security.SSLSetPeerDomainName.argtypes = [SSLContextRef, c_char_p, c_size_t] + Security.SSLSetPeerDomainName.restype = OSStatus + + Security.SSLHandshake.argtypes = [SSLContextRef] + Security.SSLHandshake.restype = OSStatus + + Security.SSLRead.argtypes = [SSLContextRef, c_char_p, c_size_t, POINTER(c_size_t)] + Security.SSLRead.restype = OSStatus + + Security.SSLWrite.argtypes = [SSLContextRef, c_char_p, c_size_t, POINTER(c_size_t)] + Security.SSLWrite.restype = OSStatus + + Security.SSLClose.argtypes = [SSLContextRef] + Security.SSLClose.restype = OSStatus + + Security.SSLGetNumberSupportedCiphers.argtypes = [SSLContextRef, POINTER(c_size_t)] + Security.SSLGetNumberSupportedCiphers.restype = OSStatus + + Security.SSLGetSupportedCiphers.argtypes = [ + SSLContextRef, + POINTER(SSLCipherSuite), + POINTER(c_size_t), + ] + Security.SSLGetSupportedCiphers.restype = OSStatus + + Security.SSLSetEnabledCiphers.argtypes = [ + SSLContextRef, + POINTER(SSLCipherSuite), + c_size_t, + ] + Security.SSLSetEnabledCiphers.restype = OSStatus + + Security.SSLGetNumberEnabledCiphers.argtype = [SSLContextRef, POINTER(c_size_t)] + Security.SSLGetNumberEnabledCiphers.restype = OSStatus + + Security.SSLGetEnabledCiphers.argtypes = [ + SSLContextRef, + POINTER(SSLCipherSuite), + POINTER(c_size_t), + ] + Security.SSLGetEnabledCiphers.restype = OSStatus + + Security.SSLGetNegotiatedCipher.argtypes = [SSLContextRef, POINTER(SSLCipherSuite)] + Security.SSLGetNegotiatedCipher.restype = OSStatus + + Security.SSLGetNegotiatedProtocolVersion.argtypes = [ + SSLContextRef, + POINTER(SSLProtocol), + ] + Security.SSLGetNegotiatedProtocolVersion.restype = OSStatus + + Security.SSLCopyPeerTrust.argtypes = [SSLContextRef, POINTER(SecTrustRef)] + Security.SSLCopyPeerTrust.restype = OSStatus + + Security.SecTrustSetAnchorCertificates.argtypes = [SecTrustRef, CFArrayRef] + Security.SecTrustSetAnchorCertificates.restype = OSStatus + + Security.SecTrustSetAnchorCertificatesOnly.argstypes = [SecTrustRef, Boolean] + Security.SecTrustSetAnchorCertificatesOnly.restype = OSStatus + + Security.SecTrustEvaluate.argtypes = [SecTrustRef, POINTER(SecTrustResultType)] + Security.SecTrustEvaluate.restype = OSStatus + + Security.SecTrustGetCertificateCount.argtypes = [SecTrustRef] + Security.SecTrustGetCertificateCount.restype = CFIndex + + Security.SecTrustGetCertificateAtIndex.argtypes = [SecTrustRef, CFIndex] + Security.SecTrustGetCertificateAtIndex.restype = SecCertificateRef + + Security.SSLCreateContext.argtypes = [ + CFAllocatorRef, + SSLProtocolSide, + SSLConnectionType, + ] + Security.SSLCreateContext.restype = SSLContextRef + + Security.SSLSetSessionOption.argtypes = [SSLContextRef, SSLSessionOption, Boolean] + Security.SSLSetSessionOption.restype = OSStatus + + Security.SSLSetProtocolVersionMin.argtypes = [SSLContextRef, SSLProtocol] + Security.SSLSetProtocolVersionMin.restype = OSStatus + + Security.SSLSetProtocolVersionMax.argtypes = [SSLContextRef, SSLProtocol] + Security.SSLSetProtocolVersionMax.restype = OSStatus + + try: + Security.SSLSetALPNProtocols.argtypes = [SSLContextRef, CFArrayRef] + Security.SSLSetALPNProtocols.restype = OSStatus + except AttributeError: + # Supported only in 10.12+ + pass + + Security.SecCopyErrorMessageString.argtypes = [OSStatus, c_void_p] + Security.SecCopyErrorMessageString.restype = CFStringRef + + Security.SSLReadFunc = SSLReadFunc + Security.SSLWriteFunc = SSLWriteFunc + Security.SSLContextRef = SSLContextRef + Security.SSLProtocol = SSLProtocol + Security.SSLCipherSuite = SSLCipherSuite + Security.SecIdentityRef = SecIdentityRef + Security.SecKeychainRef = SecKeychainRef + Security.SecTrustRef = SecTrustRef + Security.SecTrustResultType = SecTrustResultType + Security.SecExternalFormat = SecExternalFormat + Security.OSStatus = OSStatus + + Security.kSecImportExportPassphrase = CFStringRef.in_dll( + Security, "kSecImportExportPassphrase" + ) + Security.kSecImportItemIdentity = CFStringRef.in_dll( + Security, "kSecImportItemIdentity" + ) + + # CoreFoundation time! + CoreFoundation.CFRetain.argtypes = [CFTypeRef] + CoreFoundation.CFRetain.restype = CFTypeRef + + CoreFoundation.CFRelease.argtypes = [CFTypeRef] + CoreFoundation.CFRelease.restype = None + + CoreFoundation.CFGetTypeID.argtypes = [CFTypeRef] + CoreFoundation.CFGetTypeID.restype = CFTypeID + + CoreFoundation.CFStringCreateWithCString.argtypes = [ + CFAllocatorRef, + c_char_p, + CFStringEncoding, + ] + CoreFoundation.CFStringCreateWithCString.restype = CFStringRef + + CoreFoundation.CFStringGetCStringPtr.argtypes = [CFStringRef, CFStringEncoding] + CoreFoundation.CFStringGetCStringPtr.restype = c_char_p + + CoreFoundation.CFStringGetCString.argtypes = [ + CFStringRef, + c_char_p, + CFIndex, + CFStringEncoding, + ] + CoreFoundation.CFStringGetCString.restype = c_bool + + CoreFoundation.CFDataCreate.argtypes = [CFAllocatorRef, c_char_p, CFIndex] + CoreFoundation.CFDataCreate.restype = CFDataRef + + CoreFoundation.CFDataGetLength.argtypes = [CFDataRef] + CoreFoundation.CFDataGetLength.restype = CFIndex + + CoreFoundation.CFDataGetBytePtr.argtypes = [CFDataRef] + CoreFoundation.CFDataGetBytePtr.restype = c_void_p + + CoreFoundation.CFDictionaryCreate.argtypes = [ + CFAllocatorRef, + POINTER(CFTypeRef), + POINTER(CFTypeRef), + CFIndex, + CFDictionaryKeyCallBacks, + CFDictionaryValueCallBacks, + ] + CoreFoundation.CFDictionaryCreate.restype = CFDictionaryRef + + CoreFoundation.CFDictionaryGetValue.argtypes = [CFDictionaryRef, CFTypeRef] + CoreFoundation.CFDictionaryGetValue.restype = CFTypeRef + + CoreFoundation.CFArrayCreate.argtypes = [ + CFAllocatorRef, + POINTER(CFTypeRef), + CFIndex, + CFArrayCallBacks, + ] + CoreFoundation.CFArrayCreate.restype = CFArrayRef + + CoreFoundation.CFArrayCreateMutable.argtypes = [ + CFAllocatorRef, + CFIndex, + CFArrayCallBacks, + ] + CoreFoundation.CFArrayCreateMutable.restype = CFMutableArrayRef + + CoreFoundation.CFArrayAppendValue.argtypes = [CFMutableArrayRef, c_void_p] + CoreFoundation.CFArrayAppendValue.restype = None + + CoreFoundation.CFArrayGetCount.argtypes = [CFArrayRef] + CoreFoundation.CFArrayGetCount.restype = CFIndex + + CoreFoundation.CFArrayGetValueAtIndex.argtypes = [CFArrayRef, CFIndex] + CoreFoundation.CFArrayGetValueAtIndex.restype = c_void_p + + CoreFoundation.kCFAllocatorDefault = CFAllocatorRef.in_dll( + CoreFoundation, "kCFAllocatorDefault" + ) + CoreFoundation.kCFTypeArrayCallBacks = c_void_p.in_dll( + CoreFoundation, "kCFTypeArrayCallBacks" + ) + CoreFoundation.kCFTypeDictionaryKeyCallBacks = c_void_p.in_dll( + CoreFoundation, "kCFTypeDictionaryKeyCallBacks" + ) + CoreFoundation.kCFTypeDictionaryValueCallBacks = c_void_p.in_dll( + CoreFoundation, "kCFTypeDictionaryValueCallBacks" + ) + + CoreFoundation.CFTypeRef = CFTypeRef + CoreFoundation.CFArrayRef = CFArrayRef + CoreFoundation.CFStringRef = CFStringRef + CoreFoundation.CFDictionaryRef = CFDictionaryRef + +except (AttributeError): + raise ImportError("Error initializing ctypes") + + +class CFConst(object): + """ + A class object that acts as essentially a namespace for CoreFoundation + constants. + """ + + kCFStringEncodingUTF8 = CFStringEncoding(0x08000100) + + +class SecurityConst(object): + """ + A class object that acts as essentially a namespace for Security constants. + """ + + kSSLSessionOptionBreakOnServerAuth = 0 + + kSSLProtocol2 = 1 + kSSLProtocol3 = 2 + kTLSProtocol1 = 4 + kTLSProtocol11 = 7 + kTLSProtocol12 = 8 + # SecureTransport does not support TLS 1.3 even if there's a constant for it + kTLSProtocol13 = 10 + kTLSProtocolMaxSupported = 999 + + kSSLClientSide = 1 + kSSLStreamType = 0 + + kSecFormatPEMSequence = 10 + + kSecTrustResultInvalid = 0 + kSecTrustResultProceed = 1 + # This gap is present on purpose: this was kSecTrustResultConfirm, which + # is deprecated. + kSecTrustResultDeny = 3 + kSecTrustResultUnspecified = 4 + kSecTrustResultRecoverableTrustFailure = 5 + kSecTrustResultFatalTrustFailure = 6 + kSecTrustResultOtherError = 7 + + errSSLProtocol = -9800 + errSSLWouldBlock = -9803 + errSSLClosedGraceful = -9805 + errSSLClosedNoNotify = -9816 + errSSLClosedAbort = -9806 + + errSSLXCertChainInvalid = -9807 + errSSLCrypto = -9809 + errSSLInternal = -9810 + errSSLCertExpired = -9814 + errSSLCertNotYetValid = -9815 + errSSLUnknownRootCert = -9812 + errSSLNoRootCert = -9813 + errSSLHostNameMismatch = -9843 + errSSLPeerHandshakeFail = -9824 + errSSLPeerUserCancelled = -9839 + errSSLWeakPeerEphemeralDHKey = -9850 + errSSLServerAuthCompleted = -9841 + errSSLRecordOverflow = -9847 + + errSecVerifyFailed = -67808 + errSecNoTrustSettings = -25263 + errSecItemNotFound = -25300 + errSecInvalidTrustSettings = -25262 + + # Cipher suites. We only pick the ones our default cipher string allows. + # Source: https://developer.apple.com/documentation/security/1550981-ssl_cipher_suite_values + TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 = 0xC02C + TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 = 0xC030 + TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 = 0xC02B + TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 = 0xC02F + TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 = 0xCCA9 + TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 = 0xCCA8 + TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 = 0x009F + TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 = 0x009E + TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 = 0xC024 + TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 = 0xC028 + TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA = 0xC00A + TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA = 0xC014 + TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 = 0x006B + TLS_DHE_RSA_WITH_AES_256_CBC_SHA = 0x0039 + TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 = 0xC023 + TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 = 0xC027 + TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 0xC009 + TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA = 0xC013 + TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 = 0x0067 + TLS_DHE_RSA_WITH_AES_128_CBC_SHA = 0x0033 + TLS_RSA_WITH_AES_256_GCM_SHA384 = 0x009D + TLS_RSA_WITH_AES_128_GCM_SHA256 = 0x009C + TLS_RSA_WITH_AES_256_CBC_SHA256 = 0x003D + TLS_RSA_WITH_AES_128_CBC_SHA256 = 0x003C + TLS_RSA_WITH_AES_256_CBC_SHA = 0x0035 + TLS_RSA_WITH_AES_128_CBC_SHA = 0x002F + TLS_AES_128_GCM_SHA256 = 0x1301 + TLS_AES_256_GCM_SHA384 = 0x1302 + TLS_AES_128_CCM_8_SHA256 = 0x1305 + TLS_AES_128_CCM_SHA256 = 0x1304 diff --git a/newrelic/packages/urllib3/contrib/_securetransport/low_level.py b/newrelic/packages/urllib3/contrib/_securetransport/low_level.py new file mode 100644 index 0000000000..fa0b245d27 --- /dev/null +++ b/newrelic/packages/urllib3/contrib/_securetransport/low_level.py @@ -0,0 +1,397 @@ +""" +Low-level helpers for the SecureTransport bindings. + +These are Python functions that are not directly related to the high-level APIs +but are necessary to get them to work. They include a whole bunch of low-level +CoreFoundation messing about and memory management. The concerns in this module +are almost entirely about trying to avoid memory leaks and providing +appropriate and useful assistance to the higher-level code. +""" +import base64 +import ctypes +import itertools +import os +import re +import ssl +import struct +import tempfile + +from .bindings import CFConst, CoreFoundation, Security + +# This regular expression is used to grab PEM data out of a PEM bundle. +_PEM_CERTS_RE = re.compile( + b"-----BEGIN CERTIFICATE-----\n(.*?)\n-----END CERTIFICATE-----", re.DOTALL +) + + +def _cf_data_from_bytes(bytestring): + """ + Given a bytestring, create a CFData object from it. This CFData object must + be CFReleased by the caller. + """ + return CoreFoundation.CFDataCreate( + CoreFoundation.kCFAllocatorDefault, bytestring, len(bytestring) + ) + + +def _cf_dictionary_from_tuples(tuples): + """ + Given a list of Python tuples, create an associated CFDictionary. + """ + dictionary_size = len(tuples) + + # We need to get the dictionary keys and values out in the same order. + keys = (t[0] for t in tuples) + values = (t[1] for t in tuples) + cf_keys = (CoreFoundation.CFTypeRef * dictionary_size)(*keys) + cf_values = (CoreFoundation.CFTypeRef * dictionary_size)(*values) + + return CoreFoundation.CFDictionaryCreate( + CoreFoundation.kCFAllocatorDefault, + cf_keys, + cf_values, + dictionary_size, + CoreFoundation.kCFTypeDictionaryKeyCallBacks, + CoreFoundation.kCFTypeDictionaryValueCallBacks, + ) + + +def _cfstr(py_bstr): + """ + Given a Python binary data, create a CFString. + The string must be CFReleased by the caller. + """ + c_str = ctypes.c_char_p(py_bstr) + cf_str = CoreFoundation.CFStringCreateWithCString( + CoreFoundation.kCFAllocatorDefault, + c_str, + CFConst.kCFStringEncodingUTF8, + ) + return cf_str + + +def _create_cfstring_array(lst): + """ + Given a list of Python binary data, create an associated CFMutableArray. + The array must be CFReleased by the caller. + + Raises an ssl.SSLError on failure. + """ + cf_arr = None + try: + cf_arr = CoreFoundation.CFArrayCreateMutable( + CoreFoundation.kCFAllocatorDefault, + 0, + ctypes.byref(CoreFoundation.kCFTypeArrayCallBacks), + ) + if not cf_arr: + raise MemoryError("Unable to allocate memory!") + for item in lst: + cf_str = _cfstr(item) + if not cf_str: + raise MemoryError("Unable to allocate memory!") + try: + CoreFoundation.CFArrayAppendValue(cf_arr, cf_str) + finally: + CoreFoundation.CFRelease(cf_str) + except BaseException as e: + if cf_arr: + CoreFoundation.CFRelease(cf_arr) + raise ssl.SSLError("Unable to allocate array: %s" % (e,)) + return cf_arr + + +def _cf_string_to_unicode(value): + """ + Creates a Unicode string from a CFString object. Used entirely for error + reporting. + + Yes, it annoys me quite a lot that this function is this complex. + """ + value_as_void_p = ctypes.cast(value, ctypes.POINTER(ctypes.c_void_p)) + + string = CoreFoundation.CFStringGetCStringPtr( + value_as_void_p, CFConst.kCFStringEncodingUTF8 + ) + if string is None: + buffer = ctypes.create_string_buffer(1024) + result = CoreFoundation.CFStringGetCString( + value_as_void_p, buffer, 1024, CFConst.kCFStringEncodingUTF8 + ) + if not result: + raise OSError("Error copying C string from CFStringRef") + string = buffer.value + if string is not None: + string = string.decode("utf-8") + return string + + +def _assert_no_error(error, exception_class=None): + """ + Checks the return code and throws an exception if there is an error to + report + """ + if error == 0: + return + + cf_error_string = Security.SecCopyErrorMessageString(error, None) + output = _cf_string_to_unicode(cf_error_string) + CoreFoundation.CFRelease(cf_error_string) + + if output is None or output == u"": + output = u"OSStatus %s" % error + + if exception_class is None: + exception_class = ssl.SSLError + + raise exception_class(output) + + +def _cert_array_from_pem(pem_bundle): + """ + Given a bundle of certs in PEM format, turns them into a CFArray of certs + that can be used to validate a cert chain. + """ + # Normalize the PEM bundle's line endings. + pem_bundle = pem_bundle.replace(b"\r\n", b"\n") + + der_certs = [ + base64.b64decode(match.group(1)) for match in _PEM_CERTS_RE.finditer(pem_bundle) + ] + if not der_certs: + raise ssl.SSLError("No root certificates specified") + + cert_array = CoreFoundation.CFArrayCreateMutable( + CoreFoundation.kCFAllocatorDefault, + 0, + ctypes.byref(CoreFoundation.kCFTypeArrayCallBacks), + ) + if not cert_array: + raise ssl.SSLError("Unable to allocate memory!") + + try: + for der_bytes in der_certs: + certdata = _cf_data_from_bytes(der_bytes) + if not certdata: + raise ssl.SSLError("Unable to allocate memory!") + cert = Security.SecCertificateCreateWithData( + CoreFoundation.kCFAllocatorDefault, certdata + ) + CoreFoundation.CFRelease(certdata) + if not cert: + raise ssl.SSLError("Unable to build cert object!") + + CoreFoundation.CFArrayAppendValue(cert_array, cert) + CoreFoundation.CFRelease(cert) + except Exception: + # We need to free the array before the exception bubbles further. + # We only want to do that if an error occurs: otherwise, the caller + # should free. + CoreFoundation.CFRelease(cert_array) + raise + + return cert_array + + +def _is_cert(item): + """ + Returns True if a given CFTypeRef is a certificate. + """ + expected = Security.SecCertificateGetTypeID() + return CoreFoundation.CFGetTypeID(item) == expected + + +def _is_identity(item): + """ + Returns True if a given CFTypeRef is an identity. + """ + expected = Security.SecIdentityGetTypeID() + return CoreFoundation.CFGetTypeID(item) == expected + + +def _temporary_keychain(): + """ + This function creates a temporary Mac keychain that we can use to work with + credentials. This keychain uses a one-time password and a temporary file to + store the data. We expect to have one keychain per socket. The returned + SecKeychainRef must be freed by the caller, including calling + SecKeychainDelete. + + Returns a tuple of the SecKeychainRef and the path to the temporary + directory that contains it. + """ + # Unfortunately, SecKeychainCreate requires a path to a keychain. This + # means we cannot use mkstemp to use a generic temporary file. Instead, + # we're going to create a temporary directory and a filename to use there. + # This filename will be 8 random bytes expanded into base64. We also need + # some random bytes to password-protect the keychain we're creating, so we + # ask for 40 random bytes. + random_bytes = os.urandom(40) + filename = base64.b16encode(random_bytes[:8]).decode("utf-8") + password = base64.b16encode(random_bytes[8:]) # Must be valid UTF-8 + tempdirectory = tempfile.mkdtemp() + + keychain_path = os.path.join(tempdirectory, filename).encode("utf-8") + + # We now want to create the keychain itself. + keychain = Security.SecKeychainRef() + status = Security.SecKeychainCreate( + keychain_path, len(password), password, False, None, ctypes.byref(keychain) + ) + _assert_no_error(status) + + # Having created the keychain, we want to pass it off to the caller. + return keychain, tempdirectory + + +def _load_items_from_file(keychain, path): + """ + Given a single file, loads all the trust objects from it into arrays and + the keychain. + Returns a tuple of lists: the first list is a list of identities, the + second a list of certs. + """ + certificates = [] + identities = [] + result_array = None + + with open(path, "rb") as f: + raw_filedata = f.read() + + try: + filedata = CoreFoundation.CFDataCreate( + CoreFoundation.kCFAllocatorDefault, raw_filedata, len(raw_filedata) + ) + result_array = CoreFoundation.CFArrayRef() + result = Security.SecItemImport( + filedata, # cert data + None, # Filename, leaving it out for now + None, # What the type of the file is, we don't care + None, # what's in the file, we don't care + 0, # import flags + None, # key params, can include passphrase in the future + keychain, # The keychain to insert into + ctypes.byref(result_array), # Results + ) + _assert_no_error(result) + + # A CFArray is not very useful to us as an intermediary + # representation, so we are going to extract the objects we want + # and then free the array. We don't need to keep hold of keys: the + # keychain already has them! + result_count = CoreFoundation.CFArrayGetCount(result_array) + for index in range(result_count): + item = CoreFoundation.CFArrayGetValueAtIndex(result_array, index) + item = ctypes.cast(item, CoreFoundation.CFTypeRef) + + if _is_cert(item): + CoreFoundation.CFRetain(item) + certificates.append(item) + elif _is_identity(item): + CoreFoundation.CFRetain(item) + identities.append(item) + finally: + if result_array: + CoreFoundation.CFRelease(result_array) + + CoreFoundation.CFRelease(filedata) + + return (identities, certificates) + + +def _load_client_cert_chain(keychain, *paths): + """ + Load certificates and maybe keys from a number of files. Has the end goal + of returning a CFArray containing one SecIdentityRef, and then zero or more + SecCertificateRef objects, suitable for use as a client certificate trust + chain. + """ + # Ok, the strategy. + # + # This relies on knowing that macOS will not give you a SecIdentityRef + # unless you have imported a key into a keychain. This is a somewhat + # artificial limitation of macOS (for example, it doesn't necessarily + # affect iOS), but there is nothing inside Security.framework that lets you + # get a SecIdentityRef without having a key in a keychain. + # + # So the policy here is we take all the files and iterate them in order. + # Each one will use SecItemImport to have one or more objects loaded from + # it. We will also point at a keychain that macOS can use to work with the + # private key. + # + # Once we have all the objects, we'll check what we actually have. If we + # already have a SecIdentityRef in hand, fab: we'll use that. Otherwise, + # we'll take the first certificate (which we assume to be our leaf) and + # ask the keychain to give us a SecIdentityRef with that cert's associated + # key. + # + # We'll then return a CFArray containing the trust chain: one + # SecIdentityRef and then zero-or-more SecCertificateRef objects. The + # responsibility for freeing this CFArray will be with the caller. This + # CFArray must remain alive for the entire connection, so in practice it + # will be stored with a single SSLSocket, along with the reference to the + # keychain. + certificates = [] + identities = [] + + # Filter out bad paths. + paths = (path for path in paths if path) + + try: + for file_path in paths: + new_identities, new_certs = _load_items_from_file(keychain, file_path) + identities.extend(new_identities) + certificates.extend(new_certs) + + # Ok, we have everything. The question is: do we have an identity? If + # not, we want to grab one from the first cert we have. + if not identities: + new_identity = Security.SecIdentityRef() + status = Security.SecIdentityCreateWithCertificate( + keychain, certificates[0], ctypes.byref(new_identity) + ) + _assert_no_error(status) + identities.append(new_identity) + + # We now want to release the original certificate, as we no longer + # need it. + CoreFoundation.CFRelease(certificates.pop(0)) + + # We now need to build a new CFArray that holds the trust chain. + trust_chain = CoreFoundation.CFArrayCreateMutable( + CoreFoundation.kCFAllocatorDefault, + 0, + ctypes.byref(CoreFoundation.kCFTypeArrayCallBacks), + ) + for item in itertools.chain(identities, certificates): + # ArrayAppendValue does a CFRetain on the item. That's fine, + # because the finally block will release our other refs to them. + CoreFoundation.CFArrayAppendValue(trust_chain, item) + + return trust_chain + finally: + for obj in itertools.chain(identities, certificates): + CoreFoundation.CFRelease(obj) + + +TLS_PROTOCOL_VERSIONS = { + "SSLv2": (0, 2), + "SSLv3": (3, 0), + "TLSv1": (3, 1), + "TLSv1.1": (3, 2), + "TLSv1.2": (3, 3), +} + + +def _build_tls_unknown_ca_alert(version): + """ + Builds a TLS alert record for an unknown CA. + """ + ver_maj, ver_min = TLS_PROTOCOL_VERSIONS[version] + severity_fatal = 0x02 + description_unknown_ca = 0x30 + msg = struct.pack(">BB", severity_fatal, description_unknown_ca) + msg_len = len(msg) + record_type_alert = 0x15 + record = struct.pack(">BBBH", record_type_alert, ver_maj, ver_min, msg_len) + msg + return record diff --git a/newrelic/packages/urllib3/contrib/appengine.py b/newrelic/packages/urllib3/contrib/appengine.py new file mode 100644 index 0000000000..a5a6d91035 --- /dev/null +++ b/newrelic/packages/urllib3/contrib/appengine.py @@ -0,0 +1,314 @@ +""" +This module provides a pool manager that uses Google App Engine's +`URLFetch Service `_. + +Example usage:: + + from urllib3 import PoolManager + from urllib3.contrib.appengine import AppEngineManager, is_appengine_sandbox + + if is_appengine_sandbox(): + # AppEngineManager uses AppEngine's URLFetch API behind the scenes + http = AppEngineManager() + else: + # PoolManager uses a socket-level API behind the scenes + http = PoolManager() + + r = http.request('GET', 'https://google.com/') + +There are `limitations `_ to the URLFetch service and it may not be +the best choice for your application. There are three options for using +urllib3 on Google App Engine: + +1. You can use :class:`AppEngineManager` with URLFetch. URLFetch is + cost-effective in many circumstances as long as your usage is within the + limitations. +2. You can use a normal :class:`~urllib3.PoolManager` by enabling sockets. + Sockets also have `limitations and restrictions + `_ and have a lower free quota than URLFetch. + To use sockets, be sure to specify the following in your ``app.yaml``:: + + env_variables: + GAE_USE_SOCKETS_HTTPLIB : 'true' + +3. If you are using `App Engine Flexible +`_, you can use the standard +:class:`PoolManager` without any configuration or special environment variables. +""" + +from __future__ import absolute_import + +import io +import logging +import warnings + +from ..exceptions import ( + HTTPError, + HTTPWarning, + MaxRetryError, + ProtocolError, + SSLError, + TimeoutError, +) +from ..packages.six.moves.urllib.parse import urljoin +from ..request import RequestMethods +from ..response import HTTPResponse +from ..util.retry import Retry +from ..util.timeout import Timeout +from . import _appengine_environ + +try: + from google.appengine.api import urlfetch +except ImportError: + urlfetch = None + + +log = logging.getLogger(__name__) + + +class AppEnginePlatformWarning(HTTPWarning): + pass + + +class AppEnginePlatformError(HTTPError): + pass + + +class AppEngineManager(RequestMethods): + """ + Connection manager for Google App Engine sandbox applications. + + This manager uses the URLFetch service directly instead of using the + emulated httplib, and is subject to URLFetch limitations as described in + the App Engine documentation `here + `_. + + Notably it will raise an :class:`AppEnginePlatformError` if: + * URLFetch is not available. + * If you attempt to use this on App Engine Flexible, as full socket + support is available. + * If a request size is more than 10 megabytes. + * If a response size is more than 32 megabytes. + * If you use an unsupported request method such as OPTIONS. + + Beyond those cases, it will raise normal urllib3 errors. + """ + + def __init__( + self, + headers=None, + retries=None, + validate_certificate=True, + urlfetch_retries=True, + ): + if not urlfetch: + raise AppEnginePlatformError( + "URLFetch is not available in this environment." + ) + + warnings.warn( + "urllib3 is using URLFetch on Google App Engine sandbox instead " + "of sockets. To use sockets directly instead of URLFetch see " + "https://urllib3.readthedocs.io/en/1.26.x/reference/urllib3.contrib.html.", + AppEnginePlatformWarning, + ) + + RequestMethods.__init__(self, headers) + self.validate_certificate = validate_certificate + self.urlfetch_retries = urlfetch_retries + + self.retries = retries or Retry.DEFAULT + + def __enter__(self): + return self + + def __exit__(self, exc_type, exc_val, exc_tb): + # Return False to re-raise any potential exceptions + return False + + def urlopen( + self, + method, + url, + body=None, + headers=None, + retries=None, + redirect=True, + timeout=Timeout.DEFAULT_TIMEOUT, + **response_kw + ): + + retries = self._get_retries(retries, redirect) + + try: + follow_redirects = redirect and retries.redirect != 0 and retries.total + response = urlfetch.fetch( + url, + payload=body, + method=method, + headers=headers or {}, + allow_truncated=False, + follow_redirects=self.urlfetch_retries and follow_redirects, + deadline=self._get_absolute_timeout(timeout), + validate_certificate=self.validate_certificate, + ) + except urlfetch.DeadlineExceededError as e: + raise TimeoutError(self, e) + + except urlfetch.InvalidURLError as e: + if "too large" in str(e): + raise AppEnginePlatformError( + "URLFetch request too large, URLFetch only " + "supports requests up to 10mb in size.", + e, + ) + raise ProtocolError(e) + + except urlfetch.DownloadError as e: + if "Too many redirects" in str(e): + raise MaxRetryError(self, url, reason=e) + raise ProtocolError(e) + + except urlfetch.ResponseTooLargeError as e: + raise AppEnginePlatformError( + "URLFetch response too large, URLFetch only supports" + "responses up to 32mb in size.", + e, + ) + + except urlfetch.SSLCertificateError as e: + raise SSLError(e) + + except urlfetch.InvalidMethodError as e: + raise AppEnginePlatformError( + "URLFetch does not support method: %s" % method, e + ) + + http_response = self._urlfetch_response_to_http_response( + response, retries=retries, **response_kw + ) + + # Handle redirect? + redirect_location = redirect and http_response.get_redirect_location() + if redirect_location: + # Check for redirect response + if self.urlfetch_retries and retries.raise_on_redirect: + raise MaxRetryError(self, url, "too many redirects") + else: + if http_response.status == 303: + method = "GET" + + try: + retries = retries.increment( + method, url, response=http_response, _pool=self + ) + except MaxRetryError: + if retries.raise_on_redirect: + raise MaxRetryError(self, url, "too many redirects") + return http_response + + retries.sleep_for_retry(http_response) + log.debug("Redirecting %s -> %s", url, redirect_location) + redirect_url = urljoin(url, redirect_location) + return self.urlopen( + method, + redirect_url, + body, + headers, + retries=retries, + redirect=redirect, + timeout=timeout, + **response_kw + ) + + # Check if we should retry the HTTP response. + has_retry_after = bool(http_response.headers.get("Retry-After")) + if retries.is_retry(method, http_response.status, has_retry_after): + retries = retries.increment(method, url, response=http_response, _pool=self) + log.debug("Retry: %s", url) + retries.sleep(http_response) + return self.urlopen( + method, + url, + body=body, + headers=headers, + retries=retries, + redirect=redirect, + timeout=timeout, + **response_kw + ) + + return http_response + + def _urlfetch_response_to_http_response(self, urlfetch_resp, **response_kw): + + if is_prod_appengine(): + # Production GAE handles deflate encoding automatically, but does + # not remove the encoding header. + content_encoding = urlfetch_resp.headers.get("content-encoding") + + if content_encoding == "deflate": + del urlfetch_resp.headers["content-encoding"] + + transfer_encoding = urlfetch_resp.headers.get("transfer-encoding") + # We have a full response's content, + # so let's make sure we don't report ourselves as chunked data. + if transfer_encoding == "chunked": + encodings = transfer_encoding.split(",") + encodings.remove("chunked") + urlfetch_resp.headers["transfer-encoding"] = ",".join(encodings) + + original_response = HTTPResponse( + # In order for decoding to work, we must present the content as + # a file-like object. + body=io.BytesIO(urlfetch_resp.content), + msg=urlfetch_resp.header_msg, + headers=urlfetch_resp.headers, + status=urlfetch_resp.status_code, + **response_kw + ) + + return HTTPResponse( + body=io.BytesIO(urlfetch_resp.content), + headers=urlfetch_resp.headers, + status=urlfetch_resp.status_code, + original_response=original_response, + **response_kw + ) + + def _get_absolute_timeout(self, timeout): + if timeout is Timeout.DEFAULT_TIMEOUT: + return None # Defer to URLFetch's default. + if isinstance(timeout, Timeout): + if timeout._read is not None or timeout._connect is not None: + warnings.warn( + "URLFetch does not support granular timeout settings, " + "reverting to total or default URLFetch timeout.", + AppEnginePlatformWarning, + ) + return timeout.total + return timeout + + def _get_retries(self, retries, redirect): + if not isinstance(retries, Retry): + retries = Retry.from_int(retries, redirect=redirect, default=self.retries) + + if retries.connect or retries.read or retries.redirect: + warnings.warn( + "URLFetch only supports total retries and does not " + "recognize connect, read, or redirect retry parameters.", + AppEnginePlatformWarning, + ) + + return retries + + +# Alias methods from _appengine_environ to maintain public API interface. + +is_appengine = _appengine_environ.is_appengine +is_appengine_sandbox = _appengine_environ.is_appengine_sandbox +is_local_appengine = _appengine_environ.is_local_appengine +is_prod_appengine = _appengine_environ.is_prod_appengine +is_prod_appengine_mvms = _appengine_environ.is_prod_appengine_mvms diff --git a/newrelic/packages/urllib3/contrib/emscripten/__init__.py b/newrelic/packages/urllib3/contrib/emscripten/__init__.py deleted file mode 100644 index e5b62b25e9..0000000000 --- a/newrelic/packages/urllib3/contrib/emscripten/__init__.py +++ /dev/null @@ -1,17 +0,0 @@ -from __future__ import annotations - -import urllib3.connection - -from ...connectionpool import HTTPConnectionPool, HTTPSConnectionPool -from .connection import EmscriptenHTTPConnection, EmscriptenHTTPSConnection - - -def inject_into_urllib3() -> None: - # override connection classes to use emscripten specific classes - # n.b. mypy complains about the overriding of classes below - # if it isn't ignored - HTTPConnectionPool.ConnectionCls = EmscriptenHTTPConnection - HTTPSConnectionPool.ConnectionCls = EmscriptenHTTPSConnection - urllib3.connection.HTTPConnection = EmscriptenHTTPConnection # type: ignore[misc,assignment] - urllib3.connection.HTTPSConnection = EmscriptenHTTPSConnection # type: ignore[misc,assignment] - urllib3.connection.VerifiedHTTPSConnection = EmscriptenHTTPSConnection # type: ignore[assignment] diff --git a/newrelic/packages/urllib3/contrib/emscripten/connection.py b/newrelic/packages/urllib3/contrib/emscripten/connection.py deleted file mode 100644 index 63f79dd3be..0000000000 --- a/newrelic/packages/urllib3/contrib/emscripten/connection.py +++ /dev/null @@ -1,260 +0,0 @@ -from __future__ import annotations - -import os -import typing - -# use http.client.HTTPException for consistency with non-emscripten -from http.client import HTTPException as HTTPException # noqa: F401 -from http.client import ResponseNotReady - -from ..._base_connection import _TYPE_BODY -from ...connection import HTTPConnection, ProxyConfig, port_by_scheme -from ...exceptions import TimeoutError -from ...response import BaseHTTPResponse -from ...util.connection import _TYPE_SOCKET_OPTIONS -from ...util.timeout import _DEFAULT_TIMEOUT, _TYPE_TIMEOUT -from ...util.url import Url -from .fetch import _RequestError, _TimeoutError, send_request, send_streaming_request -from .request import EmscriptenRequest -from .response import EmscriptenHttpResponseWrapper, EmscriptenResponse - -if typing.TYPE_CHECKING: - from ..._base_connection import BaseHTTPConnection, BaseHTTPSConnection - - -class EmscriptenHTTPConnection: - default_port: typing.ClassVar[int] = port_by_scheme["http"] - default_socket_options: typing.ClassVar[_TYPE_SOCKET_OPTIONS] - - timeout: None | (float) - - host: str - port: int - blocksize: int - source_address: tuple[str, int] | None - socket_options: _TYPE_SOCKET_OPTIONS | None - - proxy: Url | None - proxy_config: ProxyConfig | None - - is_verified: bool = False - proxy_is_verified: bool | None = None - - response_class: type[BaseHTTPResponse] = EmscriptenHttpResponseWrapper - _response: EmscriptenResponse | None - - def __init__( - self, - host: str, - port: int = 0, - *, - timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, - source_address: tuple[str, int] | None = None, - blocksize: int = 8192, - socket_options: _TYPE_SOCKET_OPTIONS | None = None, - proxy: Url | None = None, - proxy_config: ProxyConfig | None = None, - ) -> None: - self.host = host - self.port = port - self.timeout = timeout if isinstance(timeout, float) else 0.0 - self.scheme = "http" - self._closed = True - self._response = None - # ignore these things because we don't - # have control over that stuff - self.proxy = None - self.proxy_config = None - self.blocksize = blocksize - self.source_address = None - self.socket_options = None - self.is_verified = False - - def set_tunnel( - self, - host: str, - port: int | None = 0, - headers: typing.Mapping[str, str] | None = None, - scheme: str = "http", - ) -> None: - pass - - def connect(self) -> None: - pass - - def request( - self, - method: str, - url: str, - body: _TYPE_BODY | None = None, - headers: typing.Mapping[str, str] | None = None, - # We know *at least* botocore is depending on the order of the - # first 3 parameters so to be safe we only mark the later ones - # as keyword-only to ensure we have space to extend. - *, - chunked: bool = False, - preload_content: bool = True, - decode_content: bool = True, - enforce_content_length: bool = True, - ) -> None: - self._closed = False - if url.startswith("/"): - if self.port is not None: - port = f":{self.port}" - else: - port = "" - # no scheme / host / port included, make a full url - url = f"{self.scheme}://{self.host}{port}{url}" - request = EmscriptenRequest( - url=url, - method=method, - timeout=self.timeout if self.timeout else 0, - decode_content=decode_content, - ) - request.set_body(body) - if headers: - for k, v in headers.items(): - request.set_header(k, v) - self._response = None - try: - if not preload_content: - self._response = send_streaming_request(request) - if self._response is None: - self._response = send_request(request) - except _TimeoutError as e: - raise TimeoutError(e.message) from e - except _RequestError as e: - raise HTTPException(e.message) from e - - def getresponse(self) -> BaseHTTPResponse: - if self._response is not None: - return EmscriptenHttpResponseWrapper( - internal_response=self._response, - url=self._response.request.url, - connection=self, - ) - else: - raise ResponseNotReady() - - def close(self) -> None: - self._closed = True - self._response = None - - @property - def is_closed(self) -> bool: - """Whether the connection either is brand new or has been previously closed. - If this property is True then both ``is_connected`` and ``has_connected_to_proxy`` - properties must be False. - """ - return self._closed - - @property - def is_connected(self) -> bool: - """Whether the connection is actively connected to any origin (proxy or target)""" - return True - - @property - def has_connected_to_proxy(self) -> bool: - """Whether the connection has successfully connected to its proxy. - This returns False if no proxy is in use. Used to determine whether - errors are coming from the proxy layer or from tunnelling to the target origin. - """ - return False - - -class EmscriptenHTTPSConnection(EmscriptenHTTPConnection): - default_port = port_by_scheme["https"] - # all this is basically ignored, as browser handles https - cert_reqs: int | str | None = None - ca_certs: str | None = None - ca_cert_dir: str | None = None - ca_cert_data: None | str | bytes = None - cert_file: str | None - key_file: str | None - key_password: str | None - ssl_context: typing.Any | None - ssl_version: int | str | None = None - ssl_minimum_version: int | None = None - ssl_maximum_version: int | None = None - assert_hostname: None | str | typing.Literal[False] - assert_fingerprint: str | None = None - - def __init__( - self, - host: str, - port: int = 0, - *, - timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, - source_address: tuple[str, int] | None = None, - blocksize: int = 16384, - socket_options: ( - None | _TYPE_SOCKET_OPTIONS - ) = HTTPConnection.default_socket_options, - proxy: Url | None = None, - proxy_config: ProxyConfig | None = None, - cert_reqs: int | str | None = None, - assert_hostname: None | str | typing.Literal[False] = None, - assert_fingerprint: str | None = None, - server_hostname: str | None = None, - ssl_context: typing.Any | None = None, - ca_certs: str | None = None, - ca_cert_dir: str | None = None, - ca_cert_data: None | str | bytes = None, - ssl_minimum_version: int | None = None, - ssl_maximum_version: int | None = None, - ssl_version: int | str | None = None, # Deprecated - cert_file: str | None = None, - key_file: str | None = None, - key_password: str | None = None, - ) -> None: - super().__init__( - host, - port=port, - timeout=timeout, - source_address=source_address, - blocksize=blocksize, - socket_options=socket_options, - proxy=proxy, - proxy_config=proxy_config, - ) - self.scheme = "https" - - self.key_file = key_file - self.cert_file = cert_file - self.key_password = key_password - self.ssl_context = ssl_context - self.server_hostname = server_hostname - self.assert_hostname = assert_hostname - self.assert_fingerprint = assert_fingerprint - self.ssl_version = ssl_version - self.ssl_minimum_version = ssl_minimum_version - self.ssl_maximum_version = ssl_maximum_version - self.ca_certs = ca_certs and os.path.expanduser(ca_certs) - self.ca_cert_dir = ca_cert_dir and os.path.expanduser(ca_cert_dir) - self.ca_cert_data = ca_cert_data - - self.cert_reqs = None - - # The browser will automatically verify all requests. - # We have no control over that setting. - self.is_verified = True - - def set_cert( - self, - key_file: str | None = None, - cert_file: str | None = None, - cert_reqs: int | str | None = None, - key_password: str | None = None, - ca_certs: str | None = None, - assert_hostname: None | str | typing.Literal[False] = None, - assert_fingerprint: str | None = None, - ca_cert_dir: str | None = None, - ca_cert_data: None | str | bytes = None, - ) -> None: - pass - - -# verify that this class implements BaseHTTP(s) connection correctly -if typing.TYPE_CHECKING: - _supports_http_protocol: BaseHTTPConnection = EmscriptenHTTPConnection("", 0) - _supports_https_protocol: BaseHTTPSConnection = EmscriptenHTTPSConnection("", 0) diff --git a/newrelic/packages/urllib3/contrib/emscripten/emscripten_fetch_worker.js b/newrelic/packages/urllib3/contrib/emscripten/emscripten_fetch_worker.js deleted file mode 100644 index faf141e1fa..0000000000 --- a/newrelic/packages/urllib3/contrib/emscripten/emscripten_fetch_worker.js +++ /dev/null @@ -1,110 +0,0 @@ -let Status = { - SUCCESS_HEADER: -1, - SUCCESS_EOF: -2, - ERROR_TIMEOUT: -3, - ERROR_EXCEPTION: -4, -}; - -let connections = new Map(); -let nextConnectionID = 1; -const encoder = new TextEncoder(); - -self.addEventListener("message", async function (event) { - if (event.data.close) { - let connectionID = event.data.close; - connections.delete(connectionID); - return; - } else if (event.data.getMore) { - let connectionID = event.data.getMore; - let { curOffset, value, reader, intBuffer, byteBuffer } = - connections.get(connectionID); - // if we still have some in buffer, then just send it back straight away - if (!value || curOffset >= value.length) { - // read another buffer if required - try { - let readResponse = await reader.read(); - - if (readResponse.done) { - // read everything - clear connection and return - connections.delete(connectionID); - Atomics.store(intBuffer, 0, Status.SUCCESS_EOF); - Atomics.notify(intBuffer, 0); - // finished reading successfully - // return from event handler - return; - } - curOffset = 0; - connections.get(connectionID).value = readResponse.value; - value = readResponse.value; - } catch (error) { - console.log("Request exception:", error); - let errorBytes = encoder.encode(error.message); - let written = errorBytes.length; - byteBuffer.set(errorBytes); - intBuffer[1] = written; - Atomics.store(intBuffer, 0, Status.ERROR_EXCEPTION); - Atomics.notify(intBuffer, 0); - } - } - - // send as much buffer as we can - let curLen = value.length - curOffset; - if (curLen > byteBuffer.length) { - curLen = byteBuffer.length; - } - byteBuffer.set(value.subarray(curOffset, curOffset + curLen), 0); - - Atomics.store(intBuffer, 0, curLen); // store current length in bytes - Atomics.notify(intBuffer, 0); - curOffset += curLen; - connections.get(connectionID).curOffset = curOffset; - - return; - } else { - // start fetch - let connectionID = nextConnectionID; - nextConnectionID += 1; - const intBuffer = new Int32Array(event.data.buffer); - const byteBuffer = new Uint8Array(event.data.buffer, 8); - try { - const response = await fetch(event.data.url, event.data.fetchParams); - // return the headers first via textencoder - var headers = []; - for (const pair of response.headers.entries()) { - headers.push([pair[0], pair[1]]); - } - let headerObj = { - headers: headers, - status: response.status, - connectionID, - }; - const headerText = JSON.stringify(headerObj); - let headerBytes = encoder.encode(headerText); - let written = headerBytes.length; - byteBuffer.set(headerBytes); - intBuffer[1] = written; - // make a connection - connections.set(connectionID, { - reader: response.body.getReader(), - intBuffer: intBuffer, - byteBuffer: byteBuffer, - value: undefined, - curOffset: 0, - }); - // set header ready - Atomics.store(intBuffer, 0, Status.SUCCESS_HEADER); - Atomics.notify(intBuffer, 0); - // all fetching after this goes through a new postmessage call with getMore - // this allows for parallel requests - } catch (error) { - console.log("Request exception:", error); - let errorBytes = encoder.encode(error.message); - let written = errorBytes.length; - byteBuffer.set(errorBytes); - intBuffer[1] = written; - Atomics.store(intBuffer, 0, Status.ERROR_EXCEPTION); - Atomics.notify(intBuffer, 0); - } - } -}); -self.postMessage({ inited: true }); diff --git a/newrelic/packages/urllib3/contrib/emscripten/fetch.py b/newrelic/packages/urllib3/contrib/emscripten/fetch.py deleted file mode 100644 index 612cfddc4c..0000000000 --- a/newrelic/packages/urllib3/contrib/emscripten/fetch.py +++ /dev/null @@ -1,726 +0,0 @@ -""" -Support for streaming http requests in emscripten. - -A few caveats - - -If your browser (or Node.js) has WebAssembly JavaScript Promise Integration enabled -https://github.com/WebAssembly/js-promise-integration/blob/main/proposals/js-promise-integration/Overview.md -*and* you launch pyodide using `pyodide.runPythonAsync`, this will fetch data using the -JavaScript asynchronous fetch api (wrapped via `pyodide.ffi.call_sync`). In this case -timeouts and streaming should just work. - -Otherwise, it uses a combination of XMLHttpRequest and a web-worker for streaming. - -This approach has several caveats: - -Firstly, you can't do streaming http in the main UI thread, because atomics.wait isn't allowed. -Streaming only works if you're running pyodide in a web worker. - -Secondly, this uses an extra web worker and SharedArrayBuffer to do the asynchronous fetch -operation, so it requires that you have crossOriginIsolation enabled, by serving over https -(or from localhost) with the two headers below set: - - Cross-Origin-Opener-Policy: same-origin - Cross-Origin-Embedder-Policy: require-corp - -You can tell if cross origin isolation is successfully enabled by looking at the global crossOriginIsolated variable in -JavaScript console. If it isn't, streaming requests will fallback to XMLHttpRequest, i.e. getting the whole -request into a buffer and then returning it. it shows a warning in the JavaScript console in this case. - -Finally, the webworker which does the streaming fetch is created on initial import, but will only be started once -control is returned to javascript. Call `await wait_for_streaming_ready()` to wait for streaming fetch. - -NB: in this code, there are a lot of JavaScript objects. They are named js_* -to make it clear what type of object they are. -""" - -from __future__ import annotations - -import io -import json -from email.parser import Parser -from importlib.resources import files -from typing import TYPE_CHECKING, Any - -import js # type: ignore[import-not-found] -from pyodide.ffi import ( # type: ignore[import-not-found] - JsArray, - JsException, - JsProxy, - to_js, -) - -if TYPE_CHECKING: - from typing_extensions import Buffer - -from .request import EmscriptenRequest -from .response import EmscriptenResponse - -""" -There are some headers that trigger unintended CORS preflight requests. -See also https://github.com/koenvo/pyodide-http/issues/22 -""" -HEADERS_TO_IGNORE = ("user-agent",) - -SUCCESS_HEADER = -1 -SUCCESS_EOF = -2 -ERROR_TIMEOUT = -3 -ERROR_EXCEPTION = -4 - - -class _RequestError(Exception): - def __init__( - self, - message: str | None = None, - *, - request: EmscriptenRequest | None = None, - response: EmscriptenResponse | None = None, - ): - self.request = request - self.response = response - self.message = message - super().__init__(self.message) - - -class _StreamingError(_RequestError): - pass - - -class _TimeoutError(_RequestError): - pass - - -def _obj_from_dict(dict_val: dict[str, Any]) -> JsProxy: - return to_js(dict_val, dict_converter=js.Object.fromEntries) - - -class _ReadStream(io.RawIOBase): - def __init__( - self, - int_buffer: JsArray, - byte_buffer: JsArray, - timeout: float, - worker: JsProxy, - connection_id: int, - request: EmscriptenRequest, - ): - self.int_buffer = int_buffer - self.byte_buffer = byte_buffer - self.read_pos = 0 - self.read_len = 0 - self.connection_id = connection_id - self.worker = worker - self.timeout = int(1000 * timeout) if timeout > 0 else None - self.is_live = True - self._is_closed = False - self.request: EmscriptenRequest | None = request - - def __del__(self) -> None: - self.close() - - # this is compatible with _base_connection - def is_closed(self) -> bool: - return self._is_closed - - # for compatibility with RawIOBase - @property - def closed(self) -> bool: - return self.is_closed() - - def close(self) -> None: - if self.is_closed(): - return - self.read_len = 0 - self.read_pos = 0 - self.int_buffer = None - self.byte_buffer = None - self._is_closed = True - self.request = None - if self.is_live: - self.worker.postMessage(_obj_from_dict({"close": self.connection_id})) - self.is_live = False - super().close() - - def readable(self) -> bool: - return True - - def writable(self) -> bool: - return False - - def seekable(self) -> bool: - return False - - def readinto(self, byte_obj: Buffer) -> int: - if not self.int_buffer: - raise _StreamingError( - "No buffer for stream in _ReadStream.readinto", - request=self.request, - response=None, - ) - if self.read_len == 0: - # wait for the worker to send something - js.Atomics.store(self.int_buffer, 0, ERROR_TIMEOUT) - self.worker.postMessage(_obj_from_dict({"getMore": self.connection_id})) - if ( - js.Atomics.wait(self.int_buffer, 0, ERROR_TIMEOUT, self.timeout) - == "timed-out" - ): - raise _TimeoutError - data_len = self.int_buffer[0] - if data_len > 0: - self.read_len = data_len - self.read_pos = 0 - elif data_len == ERROR_EXCEPTION: - string_len = self.int_buffer[1] - # decode the error string - js_decoder = js.TextDecoder.new() - json_str = js_decoder.decode(self.byte_buffer.slice(0, string_len)) - raise _StreamingError( - f"Exception thrown in fetch: {json_str}", - request=self.request, - response=None, - ) - else: - # EOF, free the buffers and return zero - # and free the request - self.is_live = False - self.close() - return 0 - # copy from int32array to python bytes - ret_length = min(self.read_len, len(memoryview(byte_obj))) - subarray = self.byte_buffer.subarray( - self.read_pos, self.read_pos + ret_length - ).to_py() - memoryview(byte_obj)[0:ret_length] = subarray - self.read_len -= ret_length - self.read_pos += ret_length - return ret_length - - -class _StreamingFetcher: - def __init__(self) -> None: - # make web-worker and data buffer on startup - self.streaming_ready = False - streaming_worker_code = ( - files(__package__) - .joinpath("emscripten_fetch_worker.js") - .read_text(encoding="utf-8") - ) - js_data_blob = js.Blob.new( - to_js([streaming_worker_code], create_pyproxies=False), - _obj_from_dict({"type": "application/javascript"}), - ) - - def promise_resolver(js_resolve_fn: JsProxy, js_reject_fn: JsProxy) -> None: - def onMsg(e: JsProxy) -> None: - self.streaming_ready = True - js_resolve_fn(e) - - def onErr(e: JsProxy) -> None: - js_reject_fn(e) # Defensive: never happens in ci - - self.js_worker.onmessage = onMsg - self.js_worker.onerror = onErr - - js_data_url = js.URL.createObjectURL(js_data_blob) - self.js_worker = js.globalThis.Worker.new(js_data_url) - self.js_worker_ready_promise = js.globalThis.Promise.new(promise_resolver) - - def send(self, request: EmscriptenRequest) -> EmscriptenResponse: - headers = { - k: v for k, v in request.headers.items() if k not in HEADERS_TO_IGNORE - } - - body = request.body - fetch_data = {"headers": headers, "body": to_js(body), "method": request.method} - # start the request off in the worker - timeout = int(1000 * request.timeout) if request.timeout > 0 else None - js_shared_buffer = js.SharedArrayBuffer.new(1048576) - js_int_buffer = js.Int32Array.new(js_shared_buffer) - js_byte_buffer = js.Uint8Array.new(js_shared_buffer, 8) - - js.Atomics.store(js_int_buffer, 0, ERROR_TIMEOUT) - js.Atomics.notify(js_int_buffer, 0) - js_absolute_url = js.URL.new(request.url, js.location).href - self.js_worker.postMessage( - _obj_from_dict( - { - "buffer": js_shared_buffer, - "url": js_absolute_url, - "fetchParams": fetch_data, - } - ) - ) - # wait for the worker to send something - js.Atomics.wait(js_int_buffer, 0, ERROR_TIMEOUT, timeout) - if js_int_buffer[0] == ERROR_TIMEOUT: - raise _TimeoutError( - "Timeout connecting to streaming request", - request=request, - response=None, - ) - elif js_int_buffer[0] == SUCCESS_HEADER: - # got response - # header length is in second int of intBuffer - string_len = js_int_buffer[1] - # decode the rest to a JSON string - js_decoder = js.TextDecoder.new() - # this does a copy (the slice) because decode can't work on shared array - # for some silly reason - json_str = js_decoder.decode(js_byte_buffer.slice(0, string_len)) - # get it as an object - response_obj = json.loads(json_str) - return EmscriptenResponse( - request=request, - status_code=response_obj["status"], - headers=response_obj["headers"], - body=_ReadStream( - js_int_buffer, - js_byte_buffer, - request.timeout, - self.js_worker, - response_obj["connectionID"], - request, - ), - ) - elif js_int_buffer[0] == ERROR_EXCEPTION: - string_len = js_int_buffer[1] - # decode the error string - js_decoder = js.TextDecoder.new() - json_str = js_decoder.decode(js_byte_buffer.slice(0, string_len)) - raise _StreamingError( - f"Exception thrown in fetch: {json_str}", request=request, response=None - ) - else: - raise _StreamingError( - f"Unknown status from worker in fetch: {js_int_buffer[0]}", - request=request, - response=None, - ) - - -class _JSPIReadStream(io.RawIOBase): - """ - A read stream that uses pyodide.ffi.run_sync to read from a JavaScript fetch - response. This requires support for WebAssembly JavaScript Promise Integration - in the containing browser, and for pyodide to be launched via runPythonAsync. - - :param js_read_stream: - The JavaScript stream reader - - :param timeout: - Timeout in seconds - - :param request: - The request we're handling - - :param response: - The response this stream relates to - - :param js_abort_controller: - A JavaScript AbortController object, used for timeouts - """ - - def __init__( - self, - js_read_stream: Any, - timeout: float, - request: EmscriptenRequest, - response: EmscriptenResponse, - js_abort_controller: Any, # JavaScript AbortController for timeouts - ): - self.js_read_stream = js_read_stream - self.timeout = timeout - self._is_closed = False - self._is_done = False - self.request: EmscriptenRequest | None = request - self.response: EmscriptenResponse | None = response - self.current_buffer = None - self.current_buffer_pos = 0 - self.js_abort_controller = js_abort_controller - - def __del__(self) -> None: - self.close() - - # this is compatible with _base_connection - def is_closed(self) -> bool: - return self._is_closed - - # for compatibility with RawIOBase - @property - def closed(self) -> bool: - return self.is_closed() - - def close(self) -> None: - if self.is_closed(): - return - self.read_len = 0 - self.read_pos = 0 - self.js_read_stream.cancel() - self.js_read_stream = None - self._is_closed = True - self._is_done = True - self.request = None - self.response = None - super().close() - - def readable(self) -> bool: - return True - - def writable(self) -> bool: - return False - - def seekable(self) -> bool: - return False - - def _get_next_buffer(self) -> bool: - result_js = _run_sync_with_timeout( - self.js_read_stream.read(), - self.timeout, - self.js_abort_controller, - request=self.request, - response=self.response, - ) - if result_js.done: - self._is_done = True - return False - else: - self.current_buffer = result_js.value.to_py() - self.current_buffer_pos = 0 - return True - - def readinto(self, byte_obj: Buffer) -> int: - if self.current_buffer is None: - if not self._get_next_buffer() or self.current_buffer is None: - self.close() - return 0 - ret_length = min( - len(byte_obj), len(self.current_buffer) - self.current_buffer_pos - ) - byte_obj[0:ret_length] = self.current_buffer[ - self.current_buffer_pos : self.current_buffer_pos + ret_length - ] - self.current_buffer_pos += ret_length - if self.current_buffer_pos == len(self.current_buffer): - self.current_buffer = None - return ret_length - - -# check if we are in a worker or not -def is_in_browser_main_thread() -> bool: - return hasattr(js, "window") and hasattr(js, "self") and js.self == js.window - - -def is_cross_origin_isolated() -> bool: - return hasattr(js, "crossOriginIsolated") and js.crossOriginIsolated - - -def is_in_node() -> bool: - return ( - hasattr(js, "process") - and hasattr(js.process, "release") - and hasattr(js.process.release, "name") - and js.process.release.name == "node" - ) - - -def is_worker_available() -> bool: - return hasattr(js, "Worker") and hasattr(js, "Blob") - - -_fetcher: _StreamingFetcher | None = None - -if is_worker_available() and ( - (is_cross_origin_isolated() and not is_in_browser_main_thread()) - and (not is_in_node()) -): - _fetcher = _StreamingFetcher() -else: - _fetcher = None - - -NODE_JSPI_ERROR = ( - "urllib3 only works in Node.js with pyodide.runPythonAsync" - " and requires the flag --experimental-wasm-stack-switching in " - " versions of node <24." -) - - -def send_streaming_request(request: EmscriptenRequest) -> EmscriptenResponse | None: - if has_jspi(): - return send_jspi_request(request, True) - elif is_in_node(): - raise _RequestError( - message=NODE_JSPI_ERROR, - request=request, - response=None, - ) - - if _fetcher and streaming_ready(): - return _fetcher.send(request) - else: - _show_streaming_warning() - return None - - -_SHOWN_TIMEOUT_WARNING = False - - -def _show_timeout_warning() -> None: - global _SHOWN_TIMEOUT_WARNING - if not _SHOWN_TIMEOUT_WARNING: - _SHOWN_TIMEOUT_WARNING = True - message = "Warning: Timeout is not available on main browser thread" - js.console.warn(message) - - -_SHOWN_STREAMING_WARNING = False - - -def _show_streaming_warning() -> None: - global _SHOWN_STREAMING_WARNING - if not _SHOWN_STREAMING_WARNING: - _SHOWN_STREAMING_WARNING = True - message = "Can't stream HTTP requests because: \n" - if not is_cross_origin_isolated(): - message += " Page is not cross-origin isolated\n" - if is_in_browser_main_thread(): - message += " Python is running in main browser thread\n" - if not is_worker_available(): - message += " Worker or Blob classes are not available in this environment." # Defensive: this is always False in browsers that we test in - if streaming_ready() is False: - message += """ Streaming fetch worker isn't ready. If you want to be sure that streaming fetch -is working, you need to call: 'await urllib3.contrib.emscripten.fetch.wait_for_streaming_ready()`""" - from js import console - - console.warn(message) - - -def send_request(request: EmscriptenRequest) -> EmscriptenResponse: - if has_jspi(): - return send_jspi_request(request, False) - elif is_in_node(): - raise _RequestError( - message=NODE_JSPI_ERROR, - request=request, - response=None, - ) - try: - js_xhr = js.XMLHttpRequest.new() - - if not is_in_browser_main_thread(): - js_xhr.responseType = "arraybuffer" - if request.timeout: - js_xhr.timeout = int(request.timeout * 1000) - else: - js_xhr.overrideMimeType("text/plain; charset=ISO-8859-15") - if request.timeout: - # timeout isn't available on the main thread - show a warning in console - # if it is set - _show_timeout_warning() - - js_xhr.open(request.method, request.url, False) - for name, value in request.headers.items(): - if name.lower() not in HEADERS_TO_IGNORE: - js_xhr.setRequestHeader(name, value) - - js_xhr.send(to_js(request.body)) - - headers = dict(Parser().parsestr(js_xhr.getAllResponseHeaders())) - - if not is_in_browser_main_thread(): - body = js_xhr.response.to_py().tobytes() - else: - body = js_xhr.response.encode("ISO-8859-15") - return EmscriptenResponse( - status_code=js_xhr.status, headers=headers, body=body, request=request - ) - except JsException as err: - if err.name == "TimeoutError": - raise _TimeoutError(err.message, request=request) - elif err.name == "NetworkError": - raise _RequestError(err.message, request=request) - else: - # general http error - raise _RequestError(err.message, request=request) - - -def send_jspi_request( - request: EmscriptenRequest, streaming: bool -) -> EmscriptenResponse: - """ - Send a request using WebAssembly JavaScript Promise Integration - to wrap the asynchronous JavaScript fetch api (experimental). - - :param request: - Request to send - - :param streaming: - Whether to stream the response - - :return: The response object - :rtype: EmscriptenResponse - """ - timeout = request.timeout - js_abort_controller = js.AbortController.new() - headers = {k: v for k, v in request.headers.items() if k not in HEADERS_TO_IGNORE} - req_body = request.body - fetch_data = { - "headers": headers, - "body": to_js(req_body), - "method": request.method, - "signal": js_abort_controller.signal, - } - # Node.js returns the whole response (unlike opaqueredirect in browsers), - # so urllib3 can set `redirect: manual` to control redirects itself. - # https://stackoverflow.com/a/78524615 - if _is_node_js(): - fetch_data["redirect"] = "manual" - # Call JavaScript fetch (async api, returns a promise) - fetcher_promise_js = js.fetch(request.url, _obj_from_dict(fetch_data)) - # Now suspend WebAssembly until we resolve that promise - # or time out. - response_js = _run_sync_with_timeout( - fetcher_promise_js, - timeout, - js_abort_controller, - request=request, - response=None, - ) - headers = {} - header_iter = response_js.headers.entries() - while True: - iter_value_js = header_iter.next() - if getattr(iter_value_js, "done", False): - break - else: - headers[str(iter_value_js.value[0])] = str(iter_value_js.value[1]) - status_code = response_js.status - body: bytes | io.RawIOBase = b"" - - response = EmscriptenResponse( - status_code=status_code, headers=headers, body=b"", request=request - ) - if streaming: - # get via inputstream - if response_js.body is not None: - # get a reader from the fetch response - body_stream_js = response_js.body.getReader() - body = _JSPIReadStream( - body_stream_js, timeout, request, response, js_abort_controller - ) - else: - # get directly via arraybuffer - # n.b. this is another async JavaScript call. - body = _run_sync_with_timeout( - response_js.arrayBuffer(), - timeout, - js_abort_controller, - request=request, - response=response, - ).to_py() - response.body = body - return response - - -def _run_sync_with_timeout( - promise: Any, - timeout: float, - js_abort_controller: Any, - request: EmscriptenRequest | None, - response: EmscriptenResponse | None, -) -> Any: - """ - Await a JavaScript promise synchronously with a timeout which is implemented - via the AbortController - - :param promise: - Javascript promise to await - - :param timeout: - Timeout in seconds - - :param js_abort_controller: - A JavaScript AbortController object, used on timeout - - :param request: - The request being handled - - :param response: - The response being handled (if it exists yet) - - :raises _TimeoutError: If the request times out - :raises _RequestError: If the request raises a JavaScript exception - - :return: The result of awaiting the promise. - """ - timer_id = None - if timeout > 0: - timer_id = js.setTimeout( - js_abort_controller.abort.bind(js_abort_controller), int(timeout * 1000) - ) - try: - from pyodide.ffi import run_sync - - # run_sync here uses WebAssembly JavaScript Promise Integration to - # suspend python until the JavaScript promise resolves. - return run_sync(promise) - except JsException as err: - if err.name == "AbortError": - raise _TimeoutError( - message="Request timed out", request=request, response=response - ) - else: - raise _RequestError(message=err.message, request=request, response=response) - finally: - if timer_id is not None: - js.clearTimeout(timer_id) - - -def has_jspi() -> bool: - """ - Return true if jspi can be used. - - This requires both browser support and also WebAssembly - to be in the correct state - i.e. that the javascript - call into python was async not sync. - - :return: True if jspi can be used. - :rtype: bool - """ - try: - from pyodide.ffi import can_run_sync, run_sync # noqa: F401 - - return bool(can_run_sync()) - except ImportError: - return False - - -def _is_node_js() -> bool: - """ - Check if we are in Node.js. - - :return: True if we are in Node.js. - :rtype: bool - """ - return ( - hasattr(js, "process") - and hasattr(js.process, "release") - # According to the Node.js documentation, the release name is always "node". - and js.process.release.name == "node" - ) - - -def streaming_ready() -> bool | None: - if _fetcher: - return _fetcher.streaming_ready - else: - return None # no fetcher, return None to signify that - - -async def wait_for_streaming_ready() -> bool: - if _fetcher: - await _fetcher.js_worker_ready_promise - return True - else: - return False diff --git a/newrelic/packages/urllib3/contrib/emscripten/request.py b/newrelic/packages/urllib3/contrib/emscripten/request.py deleted file mode 100644 index e692e692bd..0000000000 --- a/newrelic/packages/urllib3/contrib/emscripten/request.py +++ /dev/null @@ -1,22 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass, field - -from ..._base_connection import _TYPE_BODY - - -@dataclass -class EmscriptenRequest: - method: str - url: str - params: dict[str, str] | None = None - body: _TYPE_BODY | None = None - headers: dict[str, str] = field(default_factory=dict) - timeout: float = 0 - decode_content: bool = True - - def set_header(self, name: str, value: str) -> None: - self.headers[name.capitalize()] = value - - def set_body(self, body: _TYPE_BODY | None) -> None: - self.body = body diff --git a/newrelic/packages/urllib3/contrib/emscripten/response.py b/newrelic/packages/urllib3/contrib/emscripten/response.py deleted file mode 100644 index cb1088a182..0000000000 --- a/newrelic/packages/urllib3/contrib/emscripten/response.py +++ /dev/null @@ -1,277 +0,0 @@ -from __future__ import annotations - -import json as _json -import logging -import typing -from contextlib import contextmanager -from dataclasses import dataclass -from http.client import HTTPException as HTTPException -from io import BytesIO, IOBase - -from ...exceptions import InvalidHeader, TimeoutError -from ...response import BaseHTTPResponse -from ...util.retry import Retry -from .request import EmscriptenRequest - -if typing.TYPE_CHECKING: - from ..._base_connection import BaseHTTPConnection, BaseHTTPSConnection - -log = logging.getLogger(__name__) - - -@dataclass -class EmscriptenResponse: - status_code: int - headers: dict[str, str] - body: IOBase | bytes - request: EmscriptenRequest - - -class EmscriptenHttpResponseWrapper(BaseHTTPResponse): - def __init__( - self, - internal_response: EmscriptenResponse, - url: str | None = None, - connection: BaseHTTPConnection | BaseHTTPSConnection | None = None, - ): - self._pool = None # set by pool class - self._body = None - self._response = internal_response - self._url = url - self._connection = connection - self._closed = False - super().__init__( - headers=internal_response.headers, - status=internal_response.status_code, - request_url=url, - version=0, - version_string="HTTP/?", - reason="", - decode_content=True, - ) - self.length_remaining = self._init_length(self._response.request.method) - self.length_is_certain = False - - @property - def url(self) -> str | None: - return self._url - - @url.setter - def url(self, url: str | None) -> None: - self._url = url - - @property - def connection(self) -> BaseHTTPConnection | BaseHTTPSConnection | None: - return self._connection - - @property - def retries(self) -> Retry | None: - return self._retries - - @retries.setter - def retries(self, retries: Retry | None) -> None: - # Override the request_url if retries has a redirect location. - self._retries = retries - - def stream( - self, amt: int | None = 2**16, decode_content: bool | None = None - ) -> typing.Generator[bytes]: - """ - A generator wrapper for the read() method. A call will block until - ``amt`` bytes have been read from the connection or until the - connection is closed. - - :param amt: - How much of the content to read. The generator will return up to - much data per iteration, but may return less. This is particularly - likely when using compressed data. However, the empty string will - never be returned. - - :param decode_content: - If True, will attempt to decode the body based on the - 'content-encoding' header. - """ - while True: - data = self.read(amt=amt, decode_content=decode_content) - - if data: - yield data - else: - break - - def _init_length(self, request_method: str | None) -> int | None: - length: int | None - content_length: str | None = self.headers.get("content-length") - - if content_length is not None: - try: - # RFC 7230 section 3.3.2 specifies multiple content lengths can - # be sent in a single Content-Length header - # (e.g. Content-Length: 42, 42). This line ensures the values - # are all valid ints and that as long as the `set` length is 1, - # all values are the same. Otherwise, the header is invalid. - lengths = {int(val) for val in content_length.split(",")} - if len(lengths) > 1: - raise InvalidHeader( - "Content-Length contained multiple " - "unmatching values (%s)" % content_length - ) - length = lengths.pop() - except ValueError: - length = None - else: - if length < 0: - length = None - - else: # if content_length is None - length = None - - # Check for responses that shouldn't include a body - if ( - self.status in (204, 304) - or 100 <= self.status < 200 - or request_method == "HEAD" - ): - length = 0 - - return length - - def read( - self, - amt: int | None = None, - decode_content: bool | None = None, # ignored because browser decodes always - cache_content: bool = False, - ) -> bytes: - if ( - self._closed - or self._response is None - or (isinstance(self._response.body, IOBase) and self._response.body.closed) - ): - return b"" - - with self._error_catcher(): - # body has been preloaded as a string by XmlHttpRequest - if not isinstance(self._response.body, IOBase): - self.length_remaining = len(self._response.body) - self.length_is_certain = True - # wrap body in IOStream - self._response.body = BytesIO(self._response.body) - if amt is not None and amt >= 0: - # don't cache partial content - cache_content = False - data = self._response.body.read(amt) - else: # read all we can (and cache it) - data = self._response.body.read() - if cache_content: - self._body = data - if self.length_remaining is not None: - self.length_remaining = max(self.length_remaining - len(data), 0) - if len(data) == 0 or ( - self.length_is_certain and self.length_remaining == 0 - ): - # definitely finished reading, close response stream - self._response.body.close() - return typing.cast(bytes, data) - - def read_chunked( - self, - amt: int | None = None, - decode_content: bool | None = None, - ) -> typing.Generator[bytes]: - # chunked is handled by browser - while True: - bytes = self.read(amt, decode_content) - if not bytes: - break - yield bytes - - def release_conn(self) -> None: - if not self._pool or not self._connection: - return None - - self._pool._put_conn(self._connection) - self._connection = None - - def drain_conn(self) -> None: - self.close() - - @property - def data(self) -> bytes: - if self._body: - return self._body - else: - return self.read(cache_content=True) - - def json(self) -> typing.Any: - """ - Deserializes the body of the HTTP response as a Python object. - - The body of the HTTP response must be encoded using UTF-8, as per - `RFC 8529 Section 8.1 `_. - - To use a custom JSON decoder pass the result of :attr:`HTTPResponse.data` to - your custom decoder instead. - - If the body of the HTTP response is not decodable to UTF-8, a - `UnicodeDecodeError` will be raised. If the body of the HTTP response is not a - valid JSON document, a `json.JSONDecodeError` will be raised. - - Read more :ref:`here `. - - :returns: The body of the HTTP response as a Python object. - """ - data = self.data.decode("utf-8") - return _json.loads(data) - - def close(self) -> None: - if not self._closed: - if isinstance(self._response.body, IOBase): - self._response.body.close() - if self._connection: - self._connection.close() - self._connection = None - self._closed = True - - @contextmanager - def _error_catcher(self) -> typing.Generator[None]: - """ - Catch Emscripten specific exceptions thrown by fetch.py, - instead re-raising urllib3 variants, so that low-level exceptions - are not leaked in the high-level api. - - On exit, release the connection back to the pool. - """ - from .fetch import _RequestError, _TimeoutError # avoid circular import - - clean_exit = False - - try: - yield - # If no exception is thrown, we should avoid cleaning up - # unnecessarily. - clean_exit = True - except _TimeoutError as e: - raise TimeoutError(str(e)) - except _RequestError as e: - raise HTTPException(str(e)) - finally: - # If we didn't terminate cleanly, we need to throw away our - # connection. - if not clean_exit: - # The response may not be closed but we're not going to use it - # anymore so close it now - if ( - isinstance(self._response.body, IOBase) - and not self._response.body.closed - ): - self._response.body.close() - # release the connection back to the pool - self.release_conn() - else: - # If we have read everything from the response stream, - # return the connection back to the pool. - if ( - isinstance(self._response.body, IOBase) - and self._response.body.closed - ): - self.release_conn() diff --git a/newrelic/packages/urllib3/contrib/ntlmpool.py b/newrelic/packages/urllib3/contrib/ntlmpool.py new file mode 100644 index 0000000000..471665754e --- /dev/null +++ b/newrelic/packages/urllib3/contrib/ntlmpool.py @@ -0,0 +1,130 @@ +""" +NTLM authenticating pool, contributed by erikcederstran + +Issue #10, see: http://code.google.com/p/urllib3/issues/detail?id=10 +""" +from __future__ import absolute_import + +import warnings +from logging import getLogger + +from ntlm import ntlm + +from .. import HTTPSConnectionPool +from ..packages.six.moves.http_client import HTTPSConnection + +warnings.warn( + "The 'urllib3.contrib.ntlmpool' module is deprecated and will be removed " + "in urllib3 v2.0 release, urllib3 is not able to support it properly due " + "to reasons listed in issue: https://github.com/urllib3/urllib3/issues/2282. " + "If you are a user of this module please comment in the mentioned issue.", + DeprecationWarning, +) + +log = getLogger(__name__) + + +class NTLMConnectionPool(HTTPSConnectionPool): + """ + Implements an NTLM authentication version of an urllib3 connection pool + """ + + scheme = "https" + + def __init__(self, user, pw, authurl, *args, **kwargs): + """ + authurl is a random URL on the server that is protected by NTLM. + user is the Windows user, probably in the DOMAIN\\username format. + pw is the password for the user. + """ + super(NTLMConnectionPool, self).__init__(*args, **kwargs) + self.authurl = authurl + self.rawuser = user + user_parts = user.split("\\", 1) + self.domain = user_parts[0].upper() + self.user = user_parts[1] + self.pw = pw + + def _new_conn(self): + # Performs the NTLM handshake that secures the connection. The socket + # must be kept open while requests are performed. + self.num_connections += 1 + log.debug( + "Starting NTLM HTTPS connection no. %d: https://%s%s", + self.num_connections, + self.host, + self.authurl, + ) + + headers = {"Connection": "Keep-Alive"} + req_header = "Authorization" + resp_header = "www-authenticate" + + conn = HTTPSConnection(host=self.host, port=self.port) + + # Send negotiation message + headers[req_header] = "NTLM %s" % ntlm.create_NTLM_NEGOTIATE_MESSAGE( + self.rawuser + ) + log.debug("Request headers: %s", headers) + conn.request("GET", self.authurl, None, headers) + res = conn.getresponse() + reshdr = dict(res.headers) + log.debug("Response status: %s %s", res.status, res.reason) + log.debug("Response headers: %s", reshdr) + log.debug("Response data: %s [...]", res.read(100)) + + # Remove the reference to the socket, so that it can not be closed by + # the response object (we want to keep the socket open) + res.fp = None + + # Server should respond with a challenge message + auth_header_values = reshdr[resp_header].split(", ") + auth_header_value = None + for s in auth_header_values: + if s[:5] == "NTLM ": + auth_header_value = s[5:] + if auth_header_value is None: + raise Exception( + "Unexpected %s response header: %s" % (resp_header, reshdr[resp_header]) + ) + + # Send authentication message + ServerChallenge, NegotiateFlags = ntlm.parse_NTLM_CHALLENGE_MESSAGE( + auth_header_value + ) + auth_msg = ntlm.create_NTLM_AUTHENTICATE_MESSAGE( + ServerChallenge, self.user, self.domain, self.pw, NegotiateFlags + ) + headers[req_header] = "NTLM %s" % auth_msg + log.debug("Request headers: %s", headers) + conn.request("GET", self.authurl, None, headers) + res = conn.getresponse() + log.debug("Response status: %s %s", res.status, res.reason) + log.debug("Response headers: %s", dict(res.headers)) + log.debug("Response data: %s [...]", res.read()[:100]) + if res.status != 200: + if res.status == 401: + raise Exception("Server rejected request: wrong username or password") + raise Exception("Wrong server response: %s %s" % (res.status, res.reason)) + + res.fp = None + log.debug("Connection established") + return conn + + def urlopen( + self, + method, + url, + body=None, + headers=None, + retries=3, + redirect=True, + assert_same_host=True, + ): + if headers is None: + headers = {} + headers["Connection"] = "Keep-Alive" + return super(NTLMConnectionPool, self).urlopen( + method, url, body, headers, retries, redirect, assert_same_host + ) diff --git a/newrelic/packages/urllib3/contrib/pyopenssl.py b/newrelic/packages/urllib3/contrib/pyopenssl.py index 8e05d3d785..1ed214b1d7 100644 --- a/newrelic/packages/urllib3/contrib/pyopenssl.py +++ b/newrelic/packages/urllib3/contrib/pyopenssl.py @@ -1,17 +1,17 @@ """ -Module for using pyOpenSSL as a TLS backend. This module was relevant before -the standard library ``ssl`` module supported SNI, but now that we've dropped -support for Python 2.7 all relevant Python versions support SNI so -**this module is no longer recommended**. +TLS with SNI_-support for Python 2. Follow these instructions if you would +like to verify TLS certificates in Python 2. Note, the default libraries do +*not* do certificate checking; you need to do additional work to validate +certificates yourself. This needs the following packages installed: * `pyOpenSSL`_ (tested with 16.0.0) * `cryptography`_ (minimum 1.3.4, from pyopenssl) -* `idna`_ (minimum 2.0) +* `idna`_ (minimum 2.0, from cryptography) -However, pyOpenSSL depends on cryptography, so while we use all three directly here we -end up having relatively few packages required. +However, pyopenssl depends on cryptography, which depends on idna, so while we +use all three directly here we end up having relatively few packages required. You can install them with the following command: @@ -33,46 +33,75 @@ except ImportError: pass +Now you can use :mod:`urllib3` as you normally would, and it will support SNI +when the required modules are installed. + +Activating this module also has the positive side effect of disabling SSL/TLS +compression in Python 2 (see `CRIME attack`_). + +.. _sni: https://en.wikipedia.org/wiki/Server_Name_Indication +.. _crime attack: https://en.wikipedia.org/wiki/CRIME_(security_exploit) .. _pyopenssl: https://www.pyopenssl.org .. _cryptography: https://cryptography.io .. _idna: https://github.com/kjd/idna """ +from __future__ import absolute_import -from __future__ import annotations - -import OpenSSL.SSL # type: ignore[import-not-found] +import OpenSSL.crypto +import OpenSSL.SSL from cryptography import x509 +from cryptography.hazmat.backends.openssl import backend as openssl_backend try: - from cryptography.x509 import UnsupportedExtension # type: ignore[attr-defined] + from cryptography.x509 import UnsupportedExtension except ImportError: # UnsupportedExtension is gone in cryptography >= 2.1.0 - class UnsupportedExtension(Exception): # type: ignore[no-redef] + class UnsupportedExtension(Exception): pass -import logging -import ssl -import typing from io import BytesIO -from socket import socket as socket_cls +from socket import error as SocketError from socket import timeout -from .. import util +try: # Platform-specific: Python 2 + from socket import _fileobject +except ImportError: # Platform-specific: Python 3 + _fileobject = None + from ..packages.backports.makefile import backport_makefile -if typing.TYPE_CHECKING: - from OpenSSL.crypto import X509 # type: ignore[import-not-found] +import logging +import ssl +import sys +import warnings +from .. import util +from ..packages import six +from ..util.ssl_ import PROTOCOL_TLS_CLIENT + +warnings.warn( + "'urllib3.contrib.pyopenssl' module is deprecated and will be removed " + "in a future release of urllib3 2.x. Read more in this issue: " + "https://github.com/urllib3/urllib3/issues/2680", + category=DeprecationWarning, + stacklevel=2, +) __all__ = ["inject_into_urllib3", "extract_from_urllib3"] +# SNI always works. +HAS_SNI = True + # Map from urllib3 to PyOpenSSL compatible parameter-values. -_openssl_versions: dict[int, int] = { - util.ssl_.PROTOCOL_TLS: OpenSSL.SSL.SSLv23_METHOD, # type: ignore[attr-defined] - util.ssl_.PROTOCOL_TLS_CLIENT: OpenSSL.SSL.SSLv23_METHOD, # type: ignore[attr-defined] +_openssl_versions = { + util.PROTOCOL_TLS: OpenSSL.SSL.SSLv23_METHOD, + PROTOCOL_TLS_CLIENT: OpenSSL.SSL.SSLv23_METHOD, ssl.PROTOCOL_TLSv1: OpenSSL.SSL.TLSv1_METHOD, } +if hasattr(ssl, "PROTOCOL_SSLv3") and hasattr(OpenSSL.SSL, "SSLv3_METHOD"): + _openssl_versions[ssl.PROTOCOL_SSLv3] = OpenSSL.SSL.SSLv3_METHOD + if hasattr(ssl, "PROTOCOL_TLSv1_1") and hasattr(OpenSSL.SSL, "TLSv1_1_METHOD"): _openssl_versions[ssl.PROTOCOL_TLSv1_1] = OpenSSL.SSL.TLSv1_1_METHOD @@ -86,77 +115,43 @@ class UnsupportedExtension(Exception): # type: ignore[no-redef] ssl.CERT_REQUIRED: OpenSSL.SSL.VERIFY_PEER + OpenSSL.SSL.VERIFY_FAIL_IF_NO_PEER_CERT, } -_openssl_to_stdlib_verify = {v: k for k, v in _stdlib_to_openssl_verify.items()} - -# The SSLvX values are the most likely to be missing in the future -# but we check them all just to be sure. -_OP_NO_SSLv2_OR_SSLv3: int = getattr(OpenSSL.SSL, "OP_NO_SSLv2", 0) | getattr( - OpenSSL.SSL, "OP_NO_SSLv3", 0 -) -_OP_NO_TLSv1: int = getattr(OpenSSL.SSL, "OP_NO_TLSv1", 0) -_OP_NO_TLSv1_1: int = getattr(OpenSSL.SSL, "OP_NO_TLSv1_1", 0) -_OP_NO_TLSv1_2: int = getattr(OpenSSL.SSL, "OP_NO_TLSv1_2", 0) -_OP_NO_TLSv1_3: int = getattr(OpenSSL.SSL, "OP_NO_TLSv1_3", 0) - -_openssl_to_ssl_minimum_version: dict[int, int] = { - ssl.TLSVersion.MINIMUM_SUPPORTED: _OP_NO_SSLv2_OR_SSLv3, - ssl.TLSVersion.TLSv1: _OP_NO_SSLv2_OR_SSLv3, - ssl.TLSVersion.TLSv1_1: _OP_NO_SSLv2_OR_SSLv3 | _OP_NO_TLSv1, - ssl.TLSVersion.TLSv1_2: _OP_NO_SSLv2_OR_SSLv3 | _OP_NO_TLSv1 | _OP_NO_TLSv1_1, - ssl.TLSVersion.TLSv1_3: ( - _OP_NO_SSLv2_OR_SSLv3 | _OP_NO_TLSv1 | _OP_NO_TLSv1_1 | _OP_NO_TLSv1_2 - ), - ssl.TLSVersion.MAXIMUM_SUPPORTED: ( - _OP_NO_SSLv2_OR_SSLv3 | _OP_NO_TLSv1 | _OP_NO_TLSv1_1 | _OP_NO_TLSv1_2 - ), -} -_openssl_to_ssl_maximum_version: dict[int, int] = { - ssl.TLSVersion.MINIMUM_SUPPORTED: ( - _OP_NO_SSLv2_OR_SSLv3 - | _OP_NO_TLSv1 - | _OP_NO_TLSv1_1 - | _OP_NO_TLSv1_2 - | _OP_NO_TLSv1_3 - ), - ssl.TLSVersion.TLSv1: ( - _OP_NO_SSLv2_OR_SSLv3 | _OP_NO_TLSv1_1 | _OP_NO_TLSv1_2 | _OP_NO_TLSv1_3 - ), - ssl.TLSVersion.TLSv1_1: _OP_NO_SSLv2_OR_SSLv3 | _OP_NO_TLSv1_2 | _OP_NO_TLSv1_3, - ssl.TLSVersion.TLSv1_2: _OP_NO_SSLv2_OR_SSLv3 | _OP_NO_TLSv1_3, - ssl.TLSVersion.TLSv1_3: _OP_NO_SSLv2_OR_SSLv3, - ssl.TLSVersion.MAXIMUM_SUPPORTED: _OP_NO_SSLv2_OR_SSLv3, -} +_openssl_to_stdlib_verify = dict((v, k) for k, v in _stdlib_to_openssl_verify.items()) # OpenSSL will only write 16K at a time SSL_WRITE_BLOCKSIZE = 16384 +orig_util_HAS_SNI = util.HAS_SNI orig_util_SSLContext = util.ssl_.SSLContext log = logging.getLogger(__name__) -def inject_into_urllib3() -> None: +def inject_into_urllib3(): "Monkey-patch urllib3 with PyOpenSSL-backed SSL-support." _validate_dependencies_met() - util.SSLContext = PyOpenSSLContext # type: ignore[assignment] - util.ssl_.SSLContext = PyOpenSSLContext # type: ignore[assignment] + util.SSLContext = PyOpenSSLContext + util.ssl_.SSLContext = PyOpenSSLContext + util.HAS_SNI = HAS_SNI + util.ssl_.HAS_SNI = HAS_SNI util.IS_PYOPENSSL = True util.ssl_.IS_PYOPENSSL = True -def extract_from_urllib3() -> None: +def extract_from_urllib3(): "Undo monkey-patching by :func:`inject_into_urllib3`." util.SSLContext = orig_util_SSLContext util.ssl_.SSLContext = orig_util_SSLContext + util.HAS_SNI = orig_util_HAS_SNI + util.ssl_.HAS_SNI = orig_util_HAS_SNI util.IS_PYOPENSSL = False util.ssl_.IS_PYOPENSSL = False -def _validate_dependencies_met() -> None: +def _validate_dependencies_met(): """ Verifies that PyOpenSSL's package-level dependencies have been met. Throws `ImportError` if they are not met. @@ -182,7 +177,7 @@ def _validate_dependencies_met() -> None: ) -def _dnsname_to_stdlib(name: str) -> str | None: +def _dnsname_to_stdlib(name): """ Converts a dNSName SubjectAlternativeName field to the form used by the standard library on the given Python version. @@ -196,7 +191,7 @@ def _dnsname_to_stdlib(name: str) -> str | None: the name given should be skipped. """ - def idna_encode(name: str) -> bytes | None: + def idna_encode(name): """ Borrowed wholesale from the Python Cryptography Project. It turns out that we can't just safely call `idna.encode`: it can explode for @@ -205,7 +200,7 @@ def idna_encode(name: str) -> bytes | None: import idna try: - for prefix in ["*.", "."]: + for prefix in [u"*.", u"."]: if name.startswith(prefix): name = name[len(prefix) :] return prefix.encode("ascii") + idna.encode(name) @@ -217,17 +212,24 @@ def idna_encode(name: str) -> bytes | None: if ":" in name: return name - encoded_name = idna_encode(name) - if encoded_name is None: + name = idna_encode(name) + if name is None: return None - return encoded_name.decode("utf-8") + elif sys.version_info >= (3, 0): + name = name.decode("utf-8") + return name -def get_subj_alt_name(peer_cert: X509) -> list[tuple[str, str]]: +def get_subj_alt_name(peer_cert): """ Given an PyOpenSSL certificate, provides all the subject alternative names. """ - cert = peer_cert.to_cryptography() + # Pass the cert to cryptography, which has much better APIs for this. + if hasattr(peer_cert, "to_cryptography"): + cert = peer_cert.to_cryptography() + else: + der = OpenSSL.crypto.dump_certificate(OpenSSL.crypto.FILETYPE_ASN1, peer_cert) + cert = x509.load_der_x509_certificate(der, openssl_backend) # We want to find the SAN extension. Ask Cryptography to locate it (it's # faster than looping in Python) @@ -271,94 +273,93 @@ def get_subj_alt_name(peer_cert: X509) -> list[tuple[str, str]]: return names -class WrappedSocket: - """API-compatibility wrapper for Python OpenSSL's Connection-class.""" +class WrappedSocket(object): + """API-compatibility wrapper for Python OpenSSL's Connection-class. - def __init__( - self, - connection: OpenSSL.SSL.Connection, - socket: socket_cls, - suppress_ragged_eofs: bool = True, - ) -> None: + Note: _makefile_refs, _drop() and _reuse() are needed for the garbage + collector of pypy. + """ + + def __init__(self, connection, socket, suppress_ragged_eofs=True): self.connection = connection self.socket = socket self.suppress_ragged_eofs = suppress_ragged_eofs - self._io_refs = 0 + self._makefile_refs = 0 self._closed = False - def fileno(self) -> int: + def fileno(self): return self.socket.fileno() # Copy-pasted from Python 3.5 source code - def _decref_socketios(self) -> None: - if self._io_refs > 0: - self._io_refs -= 1 + def _decref_socketios(self): + if self._makefile_refs > 0: + self._makefile_refs -= 1 if self._closed: self.close() - def recv(self, *args: typing.Any, **kwargs: typing.Any) -> bytes: + def recv(self, *args, **kwargs): try: data = self.connection.recv(*args, **kwargs) except OpenSSL.SSL.SysCallError as e: if self.suppress_ragged_eofs and e.args == (-1, "Unexpected EOF"): return b"" else: - raise OSError(e.args[0], str(e)) from e + raise SocketError(str(e)) except OpenSSL.SSL.ZeroReturnError: if self.connection.get_shutdown() == OpenSSL.SSL.RECEIVED_SHUTDOWN: return b"" else: raise - except OpenSSL.SSL.WantReadError as e: + except OpenSSL.SSL.WantReadError: if not util.wait_for_read(self.socket, self.socket.gettimeout()): - raise timeout("The read operation timed out") from e + raise timeout("The read operation timed out") else: return self.recv(*args, **kwargs) # TLS 1.3 post-handshake authentication except OpenSSL.SSL.Error as e: - raise ssl.SSLError(f"read error: {e!r}") from e + raise ssl.SSLError("read error: %r" % e) else: - return data # type: ignore[no-any-return] + return data - def recv_into(self, *args: typing.Any, **kwargs: typing.Any) -> int: + def recv_into(self, *args, **kwargs): try: - return self.connection.recv_into(*args, **kwargs) # type: ignore[no-any-return] + return self.connection.recv_into(*args, **kwargs) except OpenSSL.SSL.SysCallError as e: if self.suppress_ragged_eofs and e.args == (-1, "Unexpected EOF"): return 0 else: - raise OSError(e.args[0], str(e)) from e + raise SocketError(str(e)) except OpenSSL.SSL.ZeroReturnError: if self.connection.get_shutdown() == OpenSSL.SSL.RECEIVED_SHUTDOWN: return 0 else: raise - except OpenSSL.SSL.WantReadError as e: + except OpenSSL.SSL.WantReadError: if not util.wait_for_read(self.socket, self.socket.gettimeout()): - raise timeout("The read operation timed out") from e + raise timeout("The read operation timed out") else: return self.recv_into(*args, **kwargs) # TLS 1.3 post-handshake authentication except OpenSSL.SSL.Error as e: - raise ssl.SSLError(f"read error: {e!r}") from e + raise ssl.SSLError("read error: %r" % e) - def settimeout(self, timeout: float) -> None: + def settimeout(self, timeout): return self.socket.settimeout(timeout) - def _send_until_done(self, data: bytes) -> int: + def _send_until_done(self, data): while True: try: - return self.connection.send(data) # type: ignore[no-any-return] - except OpenSSL.SSL.WantWriteError as e: + return self.connection.send(data) + except OpenSSL.SSL.WantWriteError: if not util.wait_for_write(self.socket, self.socket.gettimeout()): - raise timeout() from e + raise timeout() continue except OpenSSL.SSL.SysCallError as e: - raise OSError(e.args[0], str(e)) from e + raise SocketError(str(e)) - def sendall(self, data: bytes) -> None: + def sendall(self, data): total_sent = 0 while total_sent < len(data): sent = self._send_until_done( @@ -366,151 +367,135 @@ def sendall(self, data: bytes) -> None: ) total_sent += sent - def shutdown(self, how: int) -> None: - try: - self.connection.shutdown() - except OpenSSL.SSL.Error as e: - raise ssl.SSLError(f"shutdown error: {e!r}") from e - - def close(self) -> None: - self._closed = True - if self._io_refs <= 0: - self._real_close() + def shutdown(self): + # FIXME rethrow compatible exceptions should we ever use this + self.connection.shutdown() - def _real_close(self) -> None: - try: - return self.connection.close() # type: ignore[no-any-return] - except OpenSSL.SSL.Error: - return + def close(self): + if self._makefile_refs < 1: + try: + self._closed = True + return self.connection.close() + except OpenSSL.SSL.Error: + return + else: + self._makefile_refs -= 1 - def getpeercert( - self, binary_form: bool = False - ) -> dict[str, list[typing.Any]] | None: + def getpeercert(self, binary_form=False): x509 = self.connection.get_peer_certificate() if not x509: - return x509 # type: ignore[no-any-return] + return x509 if binary_form: - return OpenSSL.crypto.dump_certificate(OpenSSL.crypto.FILETYPE_ASN1, x509) # type: ignore[no-any-return] + return OpenSSL.crypto.dump_certificate(OpenSSL.crypto.FILETYPE_ASN1, x509) return { - "subject": ((("commonName", x509.get_subject().CN),),), # type: ignore[dict-item] + "subject": ((("commonName", x509.get_subject().CN),),), "subjectAltName": get_subj_alt_name(x509), } - def version(self) -> str: - return self.connection.get_protocol_version_name() # type: ignore[no-any-return] + def version(self): + return self.connection.get_protocol_version_name() - def selected_alpn_protocol(self) -> str | None: - alpn_proto = self.connection.get_alpn_proto_negotiated() - return alpn_proto.decode() if alpn_proto else None + def _reuse(self): + self._makefile_refs += 1 + + def _drop(self): + if self._makefile_refs < 1: + self.close() + else: + self._makefile_refs -= 1 -WrappedSocket.makefile = socket_cls.makefile # type: ignore[attr-defined] +if _fileobject: # Platform-specific: Python 2 + def makefile(self, mode, bufsize=-1): + self._makefile_refs += 1 + return _fileobject(self, mode, bufsize, close=True) -class PyOpenSSLContext: +else: # Platform-specific: Python 3 + makefile = backport_makefile + +WrappedSocket.makefile = makefile + + +class PyOpenSSLContext(object): """ I am a wrapper class for the PyOpenSSL ``Context`` object. I am responsible for translating the interface of the standard library ``SSLContext`` object to calls into PyOpenSSL. """ - def __init__(self, protocol: int) -> None: + def __init__(self, protocol): self.protocol = _openssl_versions[protocol] self._ctx = OpenSSL.SSL.Context(self.protocol) self._options = 0 self.check_hostname = False - self._minimum_version: int = ssl.TLSVersion.MINIMUM_SUPPORTED - self._maximum_version: int = ssl.TLSVersion.MAXIMUM_SUPPORTED - self._verify_flags: int = ssl.VERIFY_X509_TRUSTED_FIRST @property - def options(self) -> int: + def options(self): return self._options @options.setter - def options(self, value: int) -> None: + def options(self, value): self._options = value - self._set_ctx_options() - - @property - def verify_flags(self) -> int: - return self._verify_flags - - @verify_flags.setter - def verify_flags(self, value: int) -> None: - self._verify_flags = value - self._ctx.get_cert_store().set_flags(self._verify_flags) + self._ctx.set_options(value) @property - def verify_mode(self) -> int: + def verify_mode(self): return _openssl_to_stdlib_verify[self._ctx.get_verify_mode()] @verify_mode.setter - def verify_mode(self, value: ssl.VerifyMode) -> None: + def verify_mode(self, value): self._ctx.set_verify(_stdlib_to_openssl_verify[value], _verify_callback) - def set_default_verify_paths(self) -> None: + def set_default_verify_paths(self): self._ctx.set_default_verify_paths() - def set_ciphers(self, ciphers: bytes | str) -> None: - if isinstance(ciphers, str): + def set_ciphers(self, ciphers): + if isinstance(ciphers, six.text_type): ciphers = ciphers.encode("utf-8") self._ctx.set_cipher_list(ciphers) - def load_verify_locations( - self, - cafile: str | None = None, - capath: str | None = None, - cadata: bytes | None = None, - ) -> None: + def load_verify_locations(self, cafile=None, capath=None, cadata=None): if cafile is not None: - cafile = cafile.encode("utf-8") # type: ignore[assignment] + cafile = cafile.encode("utf-8") if capath is not None: - capath = capath.encode("utf-8") # type: ignore[assignment] + capath = capath.encode("utf-8") try: self._ctx.load_verify_locations(cafile, capath) if cadata is not None: self._ctx.load_verify_locations(BytesIO(cadata)) except OpenSSL.SSL.Error as e: - raise ssl.SSLError(f"unable to load trusted certificates: {e!r}") from e + raise ssl.SSLError("unable to load trusted certificates: %r" % e) - def load_cert_chain( - self, - certfile: str, - keyfile: str | None = None, - password: str | None = None, - ) -> None: - try: - self._ctx.use_certificate_chain_file(certfile) - if password is not None: - if not isinstance(password, bytes): - password = password.encode("utf-8") # type: ignore[assignment] - self._ctx.set_passwd_cb(lambda *_: password) - self._ctx.use_privatekey_file(keyfile or certfile) - except OpenSSL.SSL.Error as e: - raise ssl.SSLError(f"Unable to load certificate chain: {e!r}") from e + def load_cert_chain(self, certfile, keyfile=None, password=None): + self._ctx.use_certificate_chain_file(certfile) + if password is not None: + if not isinstance(password, six.binary_type): + password = password.encode("utf-8") + self._ctx.set_passwd_cb(lambda *_: password) + self._ctx.use_privatekey_file(keyfile or certfile) - def set_alpn_protocols(self, protocols: list[bytes | str]) -> None: - protocols = [util.util.to_bytes(p, "ascii") for p in protocols] - return self._ctx.set_alpn_protos(protocols) # type: ignore[no-any-return] + def set_alpn_protocols(self, protocols): + protocols = [six.ensure_binary(p) for p in protocols] + return self._ctx.set_alpn_protos(protocols) def wrap_socket( self, - sock: socket_cls, - server_side: bool = False, - do_handshake_on_connect: bool = True, - suppress_ragged_eofs: bool = True, - server_hostname: bytes | str | None = None, - ) -> WrappedSocket: + sock, + server_side=False, + do_handshake_on_connect=True, + suppress_ragged_eofs=True, + server_hostname=None, + ): cnx = OpenSSL.SSL.Connection(self._ctx, sock) - # If server_hostname is an IP, don't use it for SNI, per RFC6066 Section 3 - if server_hostname and not util.ssl_.is_ipaddress(server_hostname): - if isinstance(server_hostname, str): - server_hostname = server_hostname.encode("utf-8") + if isinstance(server_hostname, six.text_type): # Platform-specific: Python 3 + server_hostname = server_hostname.encode("utf-8") + + if server_hostname is not None: cnx.set_tlsext_host_name(server_hostname) cnx.set_connect_state() @@ -518,47 +503,16 @@ def wrap_socket( while True: try: cnx.do_handshake() - except OpenSSL.SSL.WantReadError as e: + except OpenSSL.SSL.WantReadError: if not util.wait_for_read(sock, sock.gettimeout()): - raise timeout("select timed out") from e + raise timeout("select timed out") continue except OpenSSL.SSL.Error as e: - raise ssl.SSLError(f"bad handshake: {e!r}") from e + raise ssl.SSLError("bad handshake: %r" % e) break return WrappedSocket(cnx, sock) - def _set_ctx_options(self) -> None: - self._ctx.set_options( - self._options - | _openssl_to_ssl_minimum_version[self._minimum_version] - | _openssl_to_ssl_maximum_version[self._maximum_version] - ) - - @property - def minimum_version(self) -> int: - return self._minimum_version - @minimum_version.setter - def minimum_version(self, minimum_version: int) -> None: - self._minimum_version = minimum_version - self._set_ctx_options() - - @property - def maximum_version(self) -> int: - return self._maximum_version - - @maximum_version.setter - def maximum_version(self, maximum_version: int) -> None: - self._maximum_version = maximum_version - self._set_ctx_options() - - -def _verify_callback( - cnx: OpenSSL.SSL.Connection, - x509: X509, - err_no: int, - err_depth: int, - return_code: int, -) -> bool: +def _verify_callback(cnx, x509, err_no, err_depth, return_code): return err_no == 0 diff --git a/newrelic/packages/urllib3/contrib/securetransport.py b/newrelic/packages/urllib3/contrib/securetransport.py new file mode 100644 index 0000000000..e311c0c899 --- /dev/null +++ b/newrelic/packages/urllib3/contrib/securetransport.py @@ -0,0 +1,920 @@ +""" +SecureTranport support for urllib3 via ctypes. + +This makes platform-native TLS available to urllib3 users on macOS without the +use of a compiler. This is an important feature because the Python Package +Index is moving to become a TLSv1.2-or-higher server, and the default OpenSSL +that ships with macOS is not capable of doing TLSv1.2. The only way to resolve +this is to give macOS users an alternative solution to the problem, and that +solution is to use SecureTransport. + +We use ctypes here because this solution must not require a compiler. That's +because pip is not allowed to require a compiler either. + +This is not intended to be a seriously long-term solution to this problem. +The hope is that PEP 543 will eventually solve this issue for us, at which +point we can retire this contrib module. But in the short term, we need to +solve the impending tire fire that is Python on Mac without this kind of +contrib module. So...here we are. + +To use this module, simply import and inject it:: + + import urllib3.contrib.securetransport + urllib3.contrib.securetransport.inject_into_urllib3() + +Happy TLSing! + +This code is a bastardised version of the code found in Will Bond's oscrypto +library. An enormous debt is owed to him for blazing this trail for us. For +that reason, this code should be considered to be covered both by urllib3's +license and by oscrypto's: + +.. code-block:: + + Copyright (c) 2015-2016 Will Bond + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the "Software"), + to deal in the Software without restriction, including without limitation + the rights to use, copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. +""" +from __future__ import absolute_import + +import contextlib +import ctypes +import errno +import os.path +import shutil +import socket +import ssl +import struct +import threading +import weakref + +from .. import util +from ..packages import six +from ..util.ssl_ import PROTOCOL_TLS_CLIENT +from ._securetransport.bindings import CoreFoundation, Security, SecurityConst +from ._securetransport.low_level import ( + _assert_no_error, + _build_tls_unknown_ca_alert, + _cert_array_from_pem, + _create_cfstring_array, + _load_client_cert_chain, + _temporary_keychain, +) + +try: # Platform-specific: Python 2 + from socket import _fileobject +except ImportError: # Platform-specific: Python 3 + _fileobject = None + from ..packages.backports.makefile import backport_makefile + +__all__ = ["inject_into_urllib3", "extract_from_urllib3"] + +# SNI always works +HAS_SNI = True + +orig_util_HAS_SNI = util.HAS_SNI +orig_util_SSLContext = util.ssl_.SSLContext + +# This dictionary is used by the read callback to obtain a handle to the +# calling wrapped socket. This is a pretty silly approach, but for now it'll +# do. I feel like I should be able to smuggle a handle to the wrapped socket +# directly in the SSLConnectionRef, but for now this approach will work I +# guess. +# +# We need to lock around this structure for inserts, but we don't do it for +# reads/writes in the callbacks. The reasoning here goes as follows: +# +# 1. It is not possible to call into the callbacks before the dictionary is +# populated, so once in the callback the id must be in the dictionary. +# 2. The callbacks don't mutate the dictionary, they only read from it, and +# so cannot conflict with any of the insertions. +# +# This is good: if we had to lock in the callbacks we'd drastically slow down +# the performance of this code. +_connection_refs = weakref.WeakValueDictionary() +_connection_ref_lock = threading.Lock() + +# Limit writes to 16kB. This is OpenSSL's limit, but we'll cargo-cult it over +# for no better reason than we need *a* limit, and this one is right there. +SSL_WRITE_BLOCKSIZE = 16384 + +# This is our equivalent of util.ssl_.DEFAULT_CIPHERS, but expanded out to +# individual cipher suites. We need to do this because this is how +# SecureTransport wants them. +CIPHER_SUITES = [ + SecurityConst.TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, + SecurityConst.TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, + SecurityConst.TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, + SecurityConst.TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, + SecurityConst.TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256, + SecurityConst.TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256, + SecurityConst.TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, + SecurityConst.TLS_DHE_RSA_WITH_AES_128_GCM_SHA256, + SecurityConst.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, + SecurityConst.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, + SecurityConst.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, + SecurityConst.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, + SecurityConst.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, + SecurityConst.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, + SecurityConst.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, + SecurityConst.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, + SecurityConst.TLS_DHE_RSA_WITH_AES_256_CBC_SHA256, + SecurityConst.TLS_DHE_RSA_WITH_AES_256_CBC_SHA, + SecurityConst.TLS_DHE_RSA_WITH_AES_128_CBC_SHA256, + SecurityConst.TLS_DHE_RSA_WITH_AES_128_CBC_SHA, + SecurityConst.TLS_AES_256_GCM_SHA384, + SecurityConst.TLS_AES_128_GCM_SHA256, + SecurityConst.TLS_RSA_WITH_AES_256_GCM_SHA384, + SecurityConst.TLS_RSA_WITH_AES_128_GCM_SHA256, + SecurityConst.TLS_AES_128_CCM_8_SHA256, + SecurityConst.TLS_AES_128_CCM_SHA256, + SecurityConst.TLS_RSA_WITH_AES_256_CBC_SHA256, + SecurityConst.TLS_RSA_WITH_AES_128_CBC_SHA256, + SecurityConst.TLS_RSA_WITH_AES_256_CBC_SHA, + SecurityConst.TLS_RSA_WITH_AES_128_CBC_SHA, +] + +# Basically this is simple: for PROTOCOL_SSLv23 we turn it into a low of +# TLSv1 and a high of TLSv1.2. For everything else, we pin to that version. +# TLSv1 to 1.2 are supported on macOS 10.8+ +_protocol_to_min_max = { + util.PROTOCOL_TLS: (SecurityConst.kTLSProtocol1, SecurityConst.kTLSProtocol12), + PROTOCOL_TLS_CLIENT: (SecurityConst.kTLSProtocol1, SecurityConst.kTLSProtocol12), +} + +if hasattr(ssl, "PROTOCOL_SSLv2"): + _protocol_to_min_max[ssl.PROTOCOL_SSLv2] = ( + SecurityConst.kSSLProtocol2, + SecurityConst.kSSLProtocol2, + ) +if hasattr(ssl, "PROTOCOL_SSLv3"): + _protocol_to_min_max[ssl.PROTOCOL_SSLv3] = ( + SecurityConst.kSSLProtocol3, + SecurityConst.kSSLProtocol3, + ) +if hasattr(ssl, "PROTOCOL_TLSv1"): + _protocol_to_min_max[ssl.PROTOCOL_TLSv1] = ( + SecurityConst.kTLSProtocol1, + SecurityConst.kTLSProtocol1, + ) +if hasattr(ssl, "PROTOCOL_TLSv1_1"): + _protocol_to_min_max[ssl.PROTOCOL_TLSv1_1] = ( + SecurityConst.kTLSProtocol11, + SecurityConst.kTLSProtocol11, + ) +if hasattr(ssl, "PROTOCOL_TLSv1_2"): + _protocol_to_min_max[ssl.PROTOCOL_TLSv1_2] = ( + SecurityConst.kTLSProtocol12, + SecurityConst.kTLSProtocol12, + ) + + +def inject_into_urllib3(): + """ + Monkey-patch urllib3 with SecureTransport-backed SSL-support. + """ + util.SSLContext = SecureTransportContext + util.ssl_.SSLContext = SecureTransportContext + util.HAS_SNI = HAS_SNI + util.ssl_.HAS_SNI = HAS_SNI + util.IS_SECURETRANSPORT = True + util.ssl_.IS_SECURETRANSPORT = True + + +def extract_from_urllib3(): + """ + Undo monkey-patching by :func:`inject_into_urllib3`. + """ + util.SSLContext = orig_util_SSLContext + util.ssl_.SSLContext = orig_util_SSLContext + util.HAS_SNI = orig_util_HAS_SNI + util.ssl_.HAS_SNI = orig_util_HAS_SNI + util.IS_SECURETRANSPORT = False + util.ssl_.IS_SECURETRANSPORT = False + + +def _read_callback(connection_id, data_buffer, data_length_pointer): + """ + SecureTransport read callback. This is called by ST to request that data + be returned from the socket. + """ + wrapped_socket = None + try: + wrapped_socket = _connection_refs.get(connection_id) + if wrapped_socket is None: + return SecurityConst.errSSLInternal + base_socket = wrapped_socket.socket + + requested_length = data_length_pointer[0] + + timeout = wrapped_socket.gettimeout() + error = None + read_count = 0 + + try: + while read_count < requested_length: + if timeout is None or timeout >= 0: + if not util.wait_for_read(base_socket, timeout): + raise socket.error(errno.EAGAIN, "timed out") + + remaining = requested_length - read_count + buffer = (ctypes.c_char * remaining).from_address( + data_buffer + read_count + ) + chunk_size = base_socket.recv_into(buffer, remaining) + read_count += chunk_size + if not chunk_size: + if not read_count: + return SecurityConst.errSSLClosedGraceful + break + except (socket.error) as e: + error = e.errno + + if error is not None and error != errno.EAGAIN: + data_length_pointer[0] = read_count + if error == errno.ECONNRESET or error == errno.EPIPE: + return SecurityConst.errSSLClosedAbort + raise + + data_length_pointer[0] = read_count + + if read_count != requested_length: + return SecurityConst.errSSLWouldBlock + + return 0 + except Exception as e: + if wrapped_socket is not None: + wrapped_socket._exception = e + return SecurityConst.errSSLInternal + + +def _write_callback(connection_id, data_buffer, data_length_pointer): + """ + SecureTransport write callback. This is called by ST to request that data + actually be sent on the network. + """ + wrapped_socket = None + try: + wrapped_socket = _connection_refs.get(connection_id) + if wrapped_socket is None: + return SecurityConst.errSSLInternal + base_socket = wrapped_socket.socket + + bytes_to_write = data_length_pointer[0] + data = ctypes.string_at(data_buffer, bytes_to_write) + + timeout = wrapped_socket.gettimeout() + error = None + sent = 0 + + try: + while sent < bytes_to_write: + if timeout is None or timeout >= 0: + if not util.wait_for_write(base_socket, timeout): + raise socket.error(errno.EAGAIN, "timed out") + chunk_sent = base_socket.send(data) + sent += chunk_sent + + # This has some needless copying here, but I'm not sure there's + # much value in optimising this data path. + data = data[chunk_sent:] + except (socket.error) as e: + error = e.errno + + if error is not None and error != errno.EAGAIN: + data_length_pointer[0] = sent + if error == errno.ECONNRESET or error == errno.EPIPE: + return SecurityConst.errSSLClosedAbort + raise + + data_length_pointer[0] = sent + + if sent != bytes_to_write: + return SecurityConst.errSSLWouldBlock + + return 0 + except Exception as e: + if wrapped_socket is not None: + wrapped_socket._exception = e + return SecurityConst.errSSLInternal + + +# We need to keep these two objects references alive: if they get GC'd while +# in use then SecureTransport could attempt to call a function that is in freed +# memory. That would be...uh...bad. Yeah, that's the word. Bad. +_read_callback_pointer = Security.SSLReadFunc(_read_callback) +_write_callback_pointer = Security.SSLWriteFunc(_write_callback) + + +class WrappedSocket(object): + """ + API-compatibility wrapper for Python's OpenSSL wrapped socket object. + + Note: _makefile_refs, _drop(), and _reuse() are needed for the garbage + collector of PyPy. + """ + + def __init__(self, socket): + self.socket = socket + self.context = None + self._makefile_refs = 0 + self._closed = False + self._exception = None + self._keychain = None + self._keychain_dir = None + self._client_cert_chain = None + + # We save off the previously-configured timeout and then set it to + # zero. This is done because we use select and friends to handle the + # timeouts, but if we leave the timeout set on the lower socket then + # Python will "kindly" call select on that socket again for us. Avoid + # that by forcing the timeout to zero. + self._timeout = self.socket.gettimeout() + self.socket.settimeout(0) + + @contextlib.contextmanager + def _raise_on_error(self): + """ + A context manager that can be used to wrap calls that do I/O from + SecureTransport. If any of the I/O callbacks hit an exception, this + context manager will correctly propagate the exception after the fact. + This avoids silently swallowing those exceptions. + + It also correctly forces the socket closed. + """ + self._exception = None + + # We explicitly don't catch around this yield because in the unlikely + # event that an exception was hit in the block we don't want to swallow + # it. + yield + if self._exception is not None: + exception, self._exception = self._exception, None + self.close() + raise exception + + def _set_ciphers(self): + """ + Sets up the allowed ciphers. By default this matches the set in + util.ssl_.DEFAULT_CIPHERS, at least as supported by macOS. This is done + custom and doesn't allow changing at this time, mostly because parsing + OpenSSL cipher strings is going to be a freaking nightmare. + """ + ciphers = (Security.SSLCipherSuite * len(CIPHER_SUITES))(*CIPHER_SUITES) + result = Security.SSLSetEnabledCiphers( + self.context, ciphers, len(CIPHER_SUITES) + ) + _assert_no_error(result) + + def _set_alpn_protocols(self, protocols): + """ + Sets up the ALPN protocols on the context. + """ + if not protocols: + return + protocols_arr = _create_cfstring_array(protocols) + try: + result = Security.SSLSetALPNProtocols(self.context, protocols_arr) + _assert_no_error(result) + finally: + CoreFoundation.CFRelease(protocols_arr) + + def _custom_validate(self, verify, trust_bundle): + """ + Called when we have set custom validation. We do this in two cases: + first, when cert validation is entirely disabled; and second, when + using a custom trust DB. + Raises an SSLError if the connection is not trusted. + """ + # If we disabled cert validation, just say: cool. + if not verify: + return + + successes = ( + SecurityConst.kSecTrustResultUnspecified, + SecurityConst.kSecTrustResultProceed, + ) + try: + trust_result = self._evaluate_trust(trust_bundle) + if trust_result in successes: + return + reason = "error code: %d" % (trust_result,) + except Exception as e: + # Do not trust on error + reason = "exception: %r" % (e,) + + # SecureTransport does not send an alert nor shuts down the connection. + rec = _build_tls_unknown_ca_alert(self.version()) + self.socket.sendall(rec) + # close the connection immediately + # l_onoff = 1, activate linger + # l_linger = 0, linger for 0 seoncds + opts = struct.pack("ii", 1, 0) + self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_LINGER, opts) + self.close() + raise ssl.SSLError("certificate verify failed, %s" % reason) + + def _evaluate_trust(self, trust_bundle): + # We want data in memory, so load it up. + if os.path.isfile(trust_bundle): + with open(trust_bundle, "rb") as f: + trust_bundle = f.read() + + cert_array = None + trust = Security.SecTrustRef() + + try: + # Get a CFArray that contains the certs we want. + cert_array = _cert_array_from_pem(trust_bundle) + + # Ok, now the hard part. We want to get the SecTrustRef that ST has + # created for this connection, shove our CAs into it, tell ST to + # ignore everything else it knows, and then ask if it can build a + # chain. This is a buuuunch of code. + result = Security.SSLCopyPeerTrust(self.context, ctypes.byref(trust)) + _assert_no_error(result) + if not trust: + raise ssl.SSLError("Failed to copy trust reference") + + result = Security.SecTrustSetAnchorCertificates(trust, cert_array) + _assert_no_error(result) + + result = Security.SecTrustSetAnchorCertificatesOnly(trust, True) + _assert_no_error(result) + + trust_result = Security.SecTrustResultType() + result = Security.SecTrustEvaluate(trust, ctypes.byref(trust_result)) + _assert_no_error(result) + finally: + if trust: + CoreFoundation.CFRelease(trust) + + if cert_array is not None: + CoreFoundation.CFRelease(cert_array) + + return trust_result.value + + def handshake( + self, + server_hostname, + verify, + trust_bundle, + min_version, + max_version, + client_cert, + client_key, + client_key_passphrase, + alpn_protocols, + ): + """ + Actually performs the TLS handshake. This is run automatically by + wrapped socket, and shouldn't be needed in user code. + """ + # First, we do the initial bits of connection setup. We need to create + # a context, set its I/O funcs, and set the connection reference. + self.context = Security.SSLCreateContext( + None, SecurityConst.kSSLClientSide, SecurityConst.kSSLStreamType + ) + result = Security.SSLSetIOFuncs( + self.context, _read_callback_pointer, _write_callback_pointer + ) + _assert_no_error(result) + + # Here we need to compute the handle to use. We do this by taking the + # id of self modulo 2**31 - 1. If this is already in the dictionary, we + # just keep incrementing by one until we find a free space. + with _connection_ref_lock: + handle = id(self) % 2147483647 + while handle in _connection_refs: + handle = (handle + 1) % 2147483647 + _connection_refs[handle] = self + + result = Security.SSLSetConnection(self.context, handle) + _assert_no_error(result) + + # If we have a server hostname, we should set that too. + if server_hostname: + if not isinstance(server_hostname, bytes): + server_hostname = server_hostname.encode("utf-8") + + result = Security.SSLSetPeerDomainName( + self.context, server_hostname, len(server_hostname) + ) + _assert_no_error(result) + + # Setup the ciphers. + self._set_ciphers() + + # Setup the ALPN protocols. + self._set_alpn_protocols(alpn_protocols) + + # Set the minimum and maximum TLS versions. + result = Security.SSLSetProtocolVersionMin(self.context, min_version) + _assert_no_error(result) + + result = Security.SSLSetProtocolVersionMax(self.context, max_version) + _assert_no_error(result) + + # If there's a trust DB, we need to use it. We do that by telling + # SecureTransport to break on server auth. We also do that if we don't + # want to validate the certs at all: we just won't actually do any + # authing in that case. + if not verify or trust_bundle is not None: + result = Security.SSLSetSessionOption( + self.context, SecurityConst.kSSLSessionOptionBreakOnServerAuth, True + ) + _assert_no_error(result) + + # If there's a client cert, we need to use it. + if client_cert: + self._keychain, self._keychain_dir = _temporary_keychain() + self._client_cert_chain = _load_client_cert_chain( + self._keychain, client_cert, client_key + ) + result = Security.SSLSetCertificate(self.context, self._client_cert_chain) + _assert_no_error(result) + + while True: + with self._raise_on_error(): + result = Security.SSLHandshake(self.context) + + if result == SecurityConst.errSSLWouldBlock: + raise socket.timeout("handshake timed out") + elif result == SecurityConst.errSSLServerAuthCompleted: + self._custom_validate(verify, trust_bundle) + continue + else: + _assert_no_error(result) + break + + def fileno(self): + return self.socket.fileno() + + # Copy-pasted from Python 3.5 source code + def _decref_socketios(self): + if self._makefile_refs > 0: + self._makefile_refs -= 1 + if self._closed: + self.close() + + def recv(self, bufsiz): + buffer = ctypes.create_string_buffer(bufsiz) + bytes_read = self.recv_into(buffer, bufsiz) + data = buffer[:bytes_read] + return data + + def recv_into(self, buffer, nbytes=None): + # Read short on EOF. + if self._closed: + return 0 + + if nbytes is None: + nbytes = len(buffer) + + buffer = (ctypes.c_char * nbytes).from_buffer(buffer) + processed_bytes = ctypes.c_size_t(0) + + with self._raise_on_error(): + result = Security.SSLRead( + self.context, buffer, nbytes, ctypes.byref(processed_bytes) + ) + + # There are some result codes that we want to treat as "not always + # errors". Specifically, those are errSSLWouldBlock, + # errSSLClosedGraceful, and errSSLClosedNoNotify. + if result == SecurityConst.errSSLWouldBlock: + # If we didn't process any bytes, then this was just a time out. + # However, we can get errSSLWouldBlock in situations when we *did* + # read some data, and in those cases we should just read "short" + # and return. + if processed_bytes.value == 0: + # Timed out, no data read. + raise socket.timeout("recv timed out") + elif result in ( + SecurityConst.errSSLClosedGraceful, + SecurityConst.errSSLClosedNoNotify, + ): + # The remote peer has closed this connection. We should do so as + # well. Note that we don't actually return here because in + # principle this could actually be fired along with return data. + # It's unlikely though. + self.close() + else: + _assert_no_error(result) + + # Ok, we read and probably succeeded. We should return whatever data + # was actually read. + return processed_bytes.value + + def settimeout(self, timeout): + self._timeout = timeout + + def gettimeout(self): + return self._timeout + + def send(self, data): + processed_bytes = ctypes.c_size_t(0) + + with self._raise_on_error(): + result = Security.SSLWrite( + self.context, data, len(data), ctypes.byref(processed_bytes) + ) + + if result == SecurityConst.errSSLWouldBlock and processed_bytes.value == 0: + # Timed out + raise socket.timeout("send timed out") + else: + _assert_no_error(result) + + # We sent, and probably succeeded. Tell them how much we sent. + return processed_bytes.value + + def sendall(self, data): + total_sent = 0 + while total_sent < len(data): + sent = self.send(data[total_sent : total_sent + SSL_WRITE_BLOCKSIZE]) + total_sent += sent + + def shutdown(self): + with self._raise_on_error(): + Security.SSLClose(self.context) + + def close(self): + # TODO: should I do clean shutdown here? Do I have to? + if self._makefile_refs < 1: + self._closed = True + if self.context: + CoreFoundation.CFRelease(self.context) + self.context = None + if self._client_cert_chain: + CoreFoundation.CFRelease(self._client_cert_chain) + self._client_cert_chain = None + if self._keychain: + Security.SecKeychainDelete(self._keychain) + CoreFoundation.CFRelease(self._keychain) + shutil.rmtree(self._keychain_dir) + self._keychain = self._keychain_dir = None + return self.socket.close() + else: + self._makefile_refs -= 1 + + def getpeercert(self, binary_form=False): + # Urgh, annoying. + # + # Here's how we do this: + # + # 1. Call SSLCopyPeerTrust to get hold of the trust object for this + # connection. + # 2. Call SecTrustGetCertificateAtIndex for index 0 to get the leaf. + # 3. To get the CN, call SecCertificateCopyCommonName and process that + # string so that it's of the appropriate type. + # 4. To get the SAN, we need to do something a bit more complex: + # a. Call SecCertificateCopyValues to get the data, requesting + # kSecOIDSubjectAltName. + # b. Mess about with this dictionary to try to get the SANs out. + # + # This is gross. Really gross. It's going to be a few hundred LoC extra + # just to repeat something that SecureTransport can *already do*. So my + # operating assumption at this time is that what we want to do is + # instead to just flag to urllib3 that it shouldn't do its own hostname + # validation when using SecureTransport. + if not binary_form: + raise ValueError("SecureTransport only supports dumping binary certs") + trust = Security.SecTrustRef() + certdata = None + der_bytes = None + + try: + # Grab the trust store. + result = Security.SSLCopyPeerTrust(self.context, ctypes.byref(trust)) + _assert_no_error(result) + if not trust: + # Probably we haven't done the handshake yet. No biggie. + return None + + cert_count = Security.SecTrustGetCertificateCount(trust) + if not cert_count: + # Also a case that might happen if we haven't handshaked. + # Handshook? Handshaken? + return None + + leaf = Security.SecTrustGetCertificateAtIndex(trust, 0) + assert leaf + + # Ok, now we want the DER bytes. + certdata = Security.SecCertificateCopyData(leaf) + assert certdata + + data_length = CoreFoundation.CFDataGetLength(certdata) + data_buffer = CoreFoundation.CFDataGetBytePtr(certdata) + der_bytes = ctypes.string_at(data_buffer, data_length) + finally: + if certdata: + CoreFoundation.CFRelease(certdata) + if trust: + CoreFoundation.CFRelease(trust) + + return der_bytes + + def version(self): + protocol = Security.SSLProtocol() + result = Security.SSLGetNegotiatedProtocolVersion( + self.context, ctypes.byref(protocol) + ) + _assert_no_error(result) + if protocol.value == SecurityConst.kTLSProtocol13: + raise ssl.SSLError("SecureTransport does not support TLS 1.3") + elif protocol.value == SecurityConst.kTLSProtocol12: + return "TLSv1.2" + elif protocol.value == SecurityConst.kTLSProtocol11: + return "TLSv1.1" + elif protocol.value == SecurityConst.kTLSProtocol1: + return "TLSv1" + elif protocol.value == SecurityConst.kSSLProtocol3: + return "SSLv3" + elif protocol.value == SecurityConst.kSSLProtocol2: + return "SSLv2" + else: + raise ssl.SSLError("Unknown TLS version: %r" % protocol) + + def _reuse(self): + self._makefile_refs += 1 + + def _drop(self): + if self._makefile_refs < 1: + self.close() + else: + self._makefile_refs -= 1 + + +if _fileobject: # Platform-specific: Python 2 + + def makefile(self, mode, bufsize=-1): + self._makefile_refs += 1 + return _fileobject(self, mode, bufsize, close=True) + +else: # Platform-specific: Python 3 + + def makefile(self, mode="r", buffering=None, *args, **kwargs): + # We disable buffering with SecureTransport because it conflicts with + # the buffering that ST does internally (see issue #1153 for more). + buffering = 0 + return backport_makefile(self, mode, buffering, *args, **kwargs) + + +WrappedSocket.makefile = makefile + + +class SecureTransportContext(object): + """ + I am a wrapper class for the SecureTransport library, to translate the + interface of the standard library ``SSLContext`` object to calls into + SecureTransport. + """ + + def __init__(self, protocol): + self._min_version, self._max_version = _protocol_to_min_max[protocol] + self._options = 0 + self._verify = False + self._trust_bundle = None + self._client_cert = None + self._client_key = None + self._client_key_passphrase = None + self._alpn_protocols = None + + @property + def check_hostname(self): + """ + SecureTransport cannot have its hostname checking disabled. For more, + see the comment on getpeercert() in this file. + """ + return True + + @check_hostname.setter + def check_hostname(self, value): + """ + SecureTransport cannot have its hostname checking disabled. For more, + see the comment on getpeercert() in this file. + """ + pass + + @property + def options(self): + # TODO: Well, crap. + # + # So this is the bit of the code that is the most likely to cause us + # trouble. Essentially we need to enumerate all of the SSL options that + # users might want to use and try to see if we can sensibly translate + # them, or whether we should just ignore them. + return self._options + + @options.setter + def options(self, value): + # TODO: Update in line with above. + self._options = value + + @property + def verify_mode(self): + return ssl.CERT_REQUIRED if self._verify else ssl.CERT_NONE + + @verify_mode.setter + def verify_mode(self, value): + self._verify = True if value == ssl.CERT_REQUIRED else False + + def set_default_verify_paths(self): + # So, this has to do something a bit weird. Specifically, what it does + # is nothing. + # + # This means that, if we had previously had load_verify_locations + # called, this does not undo that. We need to do that because it turns + # out that the rest of the urllib3 code will attempt to load the + # default verify paths if it hasn't been told about any paths, even if + # the context itself was sometime earlier. We resolve that by just + # ignoring it. + pass + + def load_default_certs(self): + return self.set_default_verify_paths() + + def set_ciphers(self, ciphers): + # For now, we just require the default cipher string. + if ciphers != util.ssl_.DEFAULT_CIPHERS: + raise ValueError("SecureTransport doesn't support custom cipher strings") + + def load_verify_locations(self, cafile=None, capath=None, cadata=None): + # OK, we only really support cadata and cafile. + if capath is not None: + raise ValueError("SecureTransport does not support cert directories") + + # Raise if cafile does not exist. + if cafile is not None: + with open(cafile): + pass + + self._trust_bundle = cafile or cadata + + def load_cert_chain(self, certfile, keyfile=None, password=None): + self._client_cert = certfile + self._client_key = keyfile + self._client_cert_passphrase = password + + def set_alpn_protocols(self, protocols): + """ + Sets the ALPN protocols that will later be set on the context. + + Raises a NotImplementedError if ALPN is not supported. + """ + if not hasattr(Security, "SSLSetALPNProtocols"): + raise NotImplementedError( + "SecureTransport supports ALPN only in macOS 10.12+" + ) + self._alpn_protocols = [six.ensure_binary(p) for p in protocols] + + def wrap_socket( + self, + sock, + server_side=False, + do_handshake_on_connect=True, + suppress_ragged_eofs=True, + server_hostname=None, + ): + # So, what do we do here? Firstly, we assert some properties. This is a + # stripped down shim, so there is some functionality we don't support. + # See PEP 543 for the real deal. + assert not server_side + assert do_handshake_on_connect + assert suppress_ragged_eofs + + # Ok, we're good to go. Now we want to create the wrapped socket object + # and store it in the appropriate place. + wrapped_socket = WrappedSocket(sock) + + # Now we can handshake + wrapped_socket.handshake( + server_hostname, + self._verify, + self._trust_bundle, + self._min_version, + self._max_version, + self._client_cert, + self._client_key, + self._client_key_passphrase, + self._alpn_protocols, + ) + return wrapped_socket diff --git a/newrelic/packages/urllib3/contrib/socks.py b/newrelic/packages/urllib3/contrib/socks.py index e3239b569d..c326e80dd1 100644 --- a/newrelic/packages/urllib3/contrib/socks.py +++ b/newrelic/packages/urllib3/contrib/socks.py @@ -1,3 +1,4 @@ +# -*- coding: utf-8 -*- """ This module contains provisional support for SOCKS proxies from within urllib3. This module supports SOCKS4, SOCKS4A (an extension of SOCKS4), and @@ -37,11 +38,10 @@ proxy_url="socks5h://:@proxy-host" """ - -from __future__ import annotations +from __future__ import absolute_import try: - import socks # type: ignore[import-untyped] + import socks except ImportError: import warnings @@ -51,13 +51,13 @@ ( "SOCKS support in urllib3 requires the installation of optional " "dependencies: specifically, PySocks. For more information, see " - "https://urllib3.readthedocs.io/en/latest/advanced-usage.html#socks-proxies" + "https://urllib3.readthedocs.io/en/1.26.x/contrib.html#socks-proxies" ), DependencyWarning, ) raise -import typing +from socket import error as SocketError from socket import timeout as SocketTimeout from ..connection import HTTPConnection, HTTPSConnection @@ -69,16 +69,7 @@ try: import ssl except ImportError: - ssl = None # type: ignore[assignment] - - -class _TYPE_SOCKS_OPTIONS(typing.TypedDict): - socks_version: int - proxy_host: str | None - proxy_port: str | None - username: str | None - password: str | None - rdns: bool + ssl = None class SOCKSConnection(HTTPConnection): @@ -86,20 +77,15 @@ class SOCKSConnection(HTTPConnection): A plain-text HTTP connection that connects via a SOCKS proxy. """ - def __init__( - self, - _socks_options: _TYPE_SOCKS_OPTIONS, - *args: typing.Any, - **kwargs: typing.Any, - ) -> None: - self._socks_options = _socks_options - super().__init__(*args, **kwargs) - - def _new_conn(self) -> socks.socksocket: + def __init__(self, *args, **kwargs): + self._socks_options = kwargs.pop("_socks_options") + super(SOCKSConnection, self).__init__(*args, **kwargs) + + def _new_conn(self): """ Establish a new connection via the SOCKS proxy. """ - extra_kw: dict[str, typing.Any] = {} + extra_kw = {} if self.source_address: extra_kw["source_address"] = self.source_address @@ -116,14 +102,15 @@ def _new_conn(self) -> socks.socksocket: proxy_password=self._socks_options["password"], proxy_rdns=self._socks_options["rdns"], timeout=self.timeout, - **extra_kw, + **extra_kw ) - except SocketTimeout as e: + except SocketTimeout: raise ConnectTimeoutError( self, - f"Connection to {self.host} timed out. (connect timeout={self.timeout})", - ) from e + "Connection to %s timed out. (connect timeout=%s)" + % (self.host, self.timeout), + ) except socks.ProxyError as e: # This is fragile as hell, but it seems to be the only way to raise @@ -133,23 +120,22 @@ def _new_conn(self) -> socks.socksocket: if isinstance(error, SocketTimeout): raise ConnectTimeoutError( self, - f"Connection to {self.host} timed out. (connect timeout={self.timeout})", - ) from e + "Connection to %s timed out. (connect timeout=%s)" + % (self.host, self.timeout), + ) else: - # Adding `from e` messes with coverage somehow, so it's omitted. - # See #2386. raise NewConnectionError( - self, f"Failed to establish a new connection: {error}" + self, "Failed to establish a new connection: %s" % error ) else: raise NewConnectionError( - self, f"Failed to establish a new connection: {e}" - ) from e + self, "Failed to establish a new connection: %s" % e + ) - except OSError as e: # Defensive: PySocks should catch all these. + except SocketError as e: # Defensive: PySocks should catch all these. raise NewConnectionError( - self, f"Failed to establish a new connection: {e}" - ) from e + self, "Failed to establish a new connection: %s" % e + ) return conn @@ -183,12 +169,12 @@ class SOCKSProxyManager(PoolManager): def __init__( self, - proxy_url: str, - username: str | None = None, - password: str | None = None, - num_pools: int = 10, - headers: typing.Mapping[str, str] | None = None, - **connection_pool_kw: typing.Any, + proxy_url, + username=None, + password=None, + num_pools=10, + headers=None, + **connection_pool_kw ): parsed = parse_url(proxy_url) @@ -209,7 +195,7 @@ def __init__( socks_version = socks.PROXY_TYPE_SOCKS4 rdns = True else: - raise ValueError(f"Unable to determine SOCKS version from {proxy_url}") + raise ValueError("Unable to determine SOCKS version from %s" % proxy_url) self.proxy_url = proxy_url @@ -223,6 +209,8 @@ def __init__( } connection_pool_kw["_socks_options"] = socks_options - super().__init__(num_pools, headers, **connection_pool_kw) + super(SOCKSProxyManager, self).__init__( + num_pools, headers, **connection_pool_kw + ) self.pool_classes_by_scheme = SOCKSProxyManager.pool_classes_by_scheme diff --git a/newrelic/packages/urllib3/exceptions.py b/newrelic/packages/urllib3/exceptions.py index 58723faeb0..cba6f3f560 100644 --- a/newrelic/packages/urllib3/exceptions.py +++ b/newrelic/packages/urllib3/exceptions.py @@ -1,16 +1,6 @@ -from __future__ import annotations +from __future__ import absolute_import -import socket -import typing -import warnings -from email.errors import MessageDefect -from http.client import IncompleteRead as httplib_IncompleteRead - -if typing.TYPE_CHECKING: - from .connection import HTTPConnection - from .connectionpool import ConnectionPool - from .response import HTTPResponse - from .util.retry import Retry +from .packages.six.moves.http_client import IncompleteRead as httplib_IncompleteRead # Base Exceptions @@ -18,61 +8,64 @@ class HTTPError(Exception): """Base exception used by this module.""" + pass + class HTTPWarning(Warning): """Base warning used by this module.""" - -_TYPE_REDUCE_RESULT = tuple[typing.Callable[..., object], tuple[object, ...]] + pass class PoolError(HTTPError): """Base exception for errors caused within a pool.""" - def __init__(self, pool: ConnectionPool, message: str) -> None: + def __init__(self, pool, message): self.pool = pool - self._message = message - super().__init__(f"{pool}: {message}") + HTTPError.__init__(self, "%s: %s" % (pool, message)) - def __reduce__(self) -> _TYPE_REDUCE_RESULT: + def __reduce__(self): # For pickling purposes. - return self.__class__, (None, self._message) + return self.__class__, (None, None) class RequestError(PoolError): """Base exception for PoolErrors that have associated URLs.""" - def __init__(self, pool: ConnectionPool, url: str | None, message: str) -> None: + def __init__(self, pool, url, message): self.url = url - super().__init__(pool, message) + PoolError.__init__(self, pool, message) - def __reduce__(self) -> _TYPE_REDUCE_RESULT: + def __reduce__(self): # For pickling purposes. - return self.__class__, (None, self.url, self._message) + return self.__class__, (None, self.url, None) class SSLError(HTTPError): """Raised when SSL certificate fails in an HTTPS connection.""" + pass + class ProxyError(HTTPError): """Raised when the connection to a proxy fails.""" - # The original error is also available as __cause__. - original_error: Exception - - def __init__(self, message: str, error: Exception) -> None: - super().__init__(message, error) + def __init__(self, message, error, *args): + super(ProxyError, self).__init__(message, error, *args) self.original_error = error class DecodeError(HTTPError): """Raised when automatic decoding based on Content-Type fails.""" + pass + class ProtocolError(HTTPError): """Raised when something unexpected happens mid-request/response.""" + pass + #: Renamed to ProtocolError but aliased for backwards compatibility. ConnectionError = ProtocolError @@ -86,40 +79,33 @@ class MaxRetryError(RequestError): :param pool: The connection pool :type pool: :class:`~urllib3.connectionpool.HTTPConnectionPool` - :param str url: The requested Url - :param reason: The underlying error - :type reason: :class:`Exception` + :param string url: The requested Url + :param exceptions.Exception reason: The underlying error """ - def __init__( - self, pool: ConnectionPool, url: str | None, reason: Exception | None = None - ) -> None: + def __init__(self, pool, url, reason=None): self.reason = reason - message = f"Max retries exceeded with url: {url} (Caused by {reason!r})" - - super().__init__(pool, url, message) + message = "Max retries exceeded with url: %s (Caused by %r)" % (url, reason) - def __reduce__(self) -> _TYPE_REDUCE_RESULT: - # For pickling purposes. - return self.__class__, (None, self.url, self.reason) + RequestError.__init__(self, pool, url, message) class HostChangedError(RequestError): """Raised when an existing pool gets a request for a foreign host.""" - def __init__( - self, pool: ConnectionPool, url: str, retries: Retry | int = 3 - ) -> None: - message = f"Tried to open a foreign host with url: {url}" - super().__init__(pool, url, message) + def __init__(self, pool, url, retries=3): + message = "Tried to open a foreign host with url: %s" % url + RequestError.__init__(self, pool, url, message) self.retries = retries class TimeoutStateError(HTTPError): """Raised when passing an invalid state to a timeout""" + pass + class TimeoutError(HTTPError): """Raised when a socket timeout error occurs. @@ -128,77 +114,53 @@ class TimeoutError(HTTPError): ` and :exc:`ConnectTimeoutErrors `. """ + pass + class ReadTimeoutError(TimeoutError, RequestError): """Raised when a socket timeout occurs while receiving data from a server""" + pass + # This timeout error does not have a URL attached and needs to inherit from the # base HTTPError class ConnectTimeoutError(TimeoutError): """Raised when a socket timeout occurs while connecting to a server""" + pass -class NewConnectionError(ConnectTimeoutError, HTTPError): - """Raised when we fail to establish a new connection. Usually ECONNREFUSED.""" - - def __init__(self, conn: HTTPConnection, message: str) -> None: - self.conn = conn - self._message = message - super().__init__(f"{conn}: {message}") - - def __reduce__(self) -> _TYPE_REDUCE_RESULT: - # For pickling purposes. - return self.__class__, (None, self._message) - - @property - def pool(self) -> HTTPConnection: - warnings.warn( - "The 'pool' property is deprecated and will be removed " - "in urllib3 v2.1.0. Use 'conn' instead.", - DeprecationWarning, - stacklevel=2, - ) - return self.conn - - -class NameResolutionError(NewConnectionError): - """Raised when host name resolution fails.""" - - def __init__(self, host: str, conn: HTTPConnection, reason: socket.gaierror): - message = f"Failed to resolve '{host}' ({reason})" - self._host = host - self._reason = reason - super().__init__(conn, message) +class NewConnectionError(ConnectTimeoutError, PoolError): + """Raised when we fail to establish a new connection. Usually ECONNREFUSED.""" - def __reduce__(self) -> _TYPE_REDUCE_RESULT: - # For pickling purposes. - return self.__class__, (self._host, None, self._reason) + pass class EmptyPoolError(PoolError): """Raised when a pool runs out of connections and no more are allowed.""" - -class FullPoolError(PoolError): - """Raised when we try to add a connection to a full pool in blocking mode.""" + pass class ClosedPoolError(PoolError): """Raised when a request enters a pool after the pool has been closed.""" + pass + class LocationValueError(ValueError, HTTPError): """Raised when there is something wrong with a given URL input.""" + pass + class LocationParseError(LocationValueError): """Raised when get_host or similar fails to parse the URL input.""" - def __init__(self, location: str) -> None: - message = f"Failed to parse: {location}" - super().__init__(message) + def __init__(self, location): + message = "Failed to parse: %s" % location + HTTPError.__init__(self, message) self.location = location @@ -206,9 +168,9 @@ def __init__(self, location: str) -> None: class URLSchemeUnknown(LocationValueError): """Raised when a URL input has an unsupported scheme.""" - def __init__(self, scheme: str): - message = f"Not supported URL scheme {scheme}" - super().__init__(message) + def __init__(self, scheme): + message = "Not supported URL scheme %s" % scheme + super(URLSchemeUnknown, self).__init__(message) self.scheme = scheme @@ -223,22 +185,38 @@ class ResponseError(HTTPError): class SecurityWarning(HTTPWarning): """Warned when performing security reducing actions""" + pass + + +class SubjectAltNameWarning(SecurityWarning): + """Warned when connecting to a host with a certificate missing a SAN.""" + + pass + class InsecureRequestWarning(SecurityWarning): """Warned when making an unverified HTTPS request.""" - -class NotOpenSSLWarning(SecurityWarning): - """Warned when using unsupported SSL library""" + pass class SystemTimeWarning(SecurityWarning): """Warned when system time is suspected to be wrong""" + pass + class InsecurePlatformWarning(SecurityWarning): """Warned when certain TLS/SSL configuration is not available on a platform.""" + pass + + +class SNIMissingWarning(HTTPWarning): + """Warned when making a HTTPS request without SNI available.""" + + pass + class DependencyWarning(HTTPWarning): """ @@ -246,10 +224,14 @@ class DependencyWarning(HTTPWarning): dependencies. """ + pass + class ResponseNotChunked(ProtocolError, ValueError): """Response needs to be chunked in order to read it as chunks.""" + pass + class BodyNotHttplibCompatible(HTTPError): """ @@ -257,6 +239,8 @@ class BodyNotHttplibCompatible(HTTPError): (have an fp attribute which returns raw chunks) for read_chunked(). """ + pass + class IncompleteRead(HTTPError, httplib_IncompleteRead): """ @@ -266,14 +250,10 @@ class IncompleteRead(HTTPError, httplib_IncompleteRead): for ``partial`` to avoid creating large objects on streamed reads. """ - partial: int # type: ignore[assignment] - expected: int + def __init__(self, partial, expected): + super(IncompleteRead, self).__init__(partial, expected) - def __init__(self, partial: int, expected: int) -> None: - self.partial = partial - self.expected = expected - - def __repr__(self) -> str: + def __repr__(self): return "IncompleteRead(%i bytes read, %i more expected)" % ( self.partial, self.expected, @@ -283,13 +263,14 @@ def __repr__(self) -> str: class InvalidChunkLength(HTTPError, httplib_IncompleteRead): """Invalid chunk length in a chunked response.""" - def __init__(self, response: HTTPResponse, length: bytes) -> None: - self.partial: int = response.tell() # type: ignore[assignment] - self.expected: int | None = response.length_remaining + def __init__(self, response, length): + super(InvalidChunkLength, self).__init__( + response.tell(), response.length_remaining + ) self.response = response self.length = length - def __repr__(self) -> str: + def __repr__(self): return "InvalidChunkLength(got length %r, %i bytes read)" % ( self.length, self.partial, @@ -299,13 +280,15 @@ def __repr__(self) -> str: class InvalidHeader(HTTPError): """The header provided was somehow invalid.""" + pass + class ProxySchemeUnknown(AssertionError, URLSchemeUnknown): """ProxyManager does not support the supplied scheme""" # TODO(t-8ch): Stop inheriting from AssertionError in v2.0. - def __init__(self, scheme: str | None) -> None: + def __init__(self, scheme): # 'localhost' is here because our URL parser parses # localhost:8080 -> scheme=localhost, remove if we fix this. if scheme == "localhost": @@ -313,23 +296,28 @@ def __init__(self, scheme: str | None) -> None: if scheme is None: message = "Proxy URL had no scheme, should start with http:// or https://" else: - message = f"Proxy URL had unsupported scheme {scheme}, should use http:// or https://" - super().__init__(message) + message = ( + "Proxy URL had unsupported scheme %s, should use http:// or https://" + % scheme + ) + super(ProxySchemeUnknown, self).__init__(message) class ProxySchemeUnsupported(ValueError): """Fetching HTTPS resources through HTTPS proxies is unsupported""" + pass + class HeaderParsingError(HTTPError): """Raised by assert_header_parsing, but we convert it to a log.warning statement.""" - def __init__( - self, defects: list[MessageDefect], unparsed_data: bytes | str | None - ) -> None: - message = f"{defects or 'Unknown'}, unparsed data: {unparsed_data!r}" - super().__init__(message) + def __init__(self, defects, unparsed_data): + message = "%s, unparsed data: %r" % (defects or "Unknown", unparsed_data) + super(HeaderParsingError, self).__init__(message) class UnrewindableBodyError(HTTPError): """urllib3 encountered an error when trying to rewind a body""" + + pass diff --git a/newrelic/packages/urllib3/fields.py b/newrelic/packages/urllib3/fields.py index 97c4730cff..9d630f491d 100644 --- a/newrelic/packages/urllib3/fields.py +++ b/newrelic/packages/urllib3/fields.py @@ -1,20 +1,13 @@ -from __future__ import annotations +from __future__ import absolute_import import email.utils import mimetypes -import typing +import re -_TYPE_FIELD_VALUE = typing.Union[str, bytes] -_TYPE_FIELD_VALUE_TUPLE = typing.Union[ - _TYPE_FIELD_VALUE, - tuple[str, _TYPE_FIELD_VALUE], - tuple[str, _TYPE_FIELD_VALUE, str], -] +from .packages import six -def guess_content_type( - filename: str | None, default: str = "application/octet-stream" -) -> str: +def guess_content_type(filename, default="application/octet-stream"): """ Guess the "Content-Type" of a file. @@ -28,7 +21,7 @@ def guess_content_type( return default -def format_header_param_rfc2231(name: str, value: _TYPE_FIELD_VALUE) -> str: +def format_header_param_rfc2231(name, value): """ Helper function to format and quote a single header parameter using the strategy defined in RFC 2231. @@ -41,28 +34,14 @@ def format_header_param_rfc2231(name: str, value: _TYPE_FIELD_VALUE) -> str: The name of the parameter, a string expected to be ASCII only. :param value: The value of the parameter, provided as ``bytes`` or `str``. - :returns: + :ret: An RFC-2231-formatted unicode string. - - .. deprecated:: 2.0.0 - Will be removed in urllib3 v2.1.0. This is not valid for - ``multipart/form-data`` header parameters. """ - import warnings - - warnings.warn( - "'format_header_param_rfc2231' is deprecated and will be " - "removed in urllib3 v2.1.0. This is not valid for " - "multipart/form-data header parameters.", - DeprecationWarning, - stacklevel=2, - ) - - if isinstance(value, bytes): + if isinstance(value, six.binary_type): value = value.decode("utf-8") if not any(ch in value for ch in '"\\\r\n'): - result = f'{name}="{value}"' + result = u'%s="%s"' % (name, value) try: result.encode("ascii") except (UnicodeEncodeError, UnicodeDecodeError): @@ -70,87 +49,81 @@ def format_header_param_rfc2231(name: str, value: _TYPE_FIELD_VALUE) -> str: else: return result + if six.PY2: # Python 2: + value = value.encode("utf-8") + + # encode_rfc2231 accepts an encoded string and returns an ascii-encoded + # string in Python 2 but accepts and returns unicode strings in Python 3 value = email.utils.encode_rfc2231(value, "utf-8") - value = f"{name}*={value}" + value = "%s*=%s" % (name, value) + + if six.PY2: # Python 2: + value = value.decode("utf-8") return value -def format_multipart_header_param(name: str, value: _TYPE_FIELD_VALUE) -> str: +_HTML5_REPLACEMENTS = { + u"\u0022": u"%22", + # Replace "\" with "\\". + u"\u005C": u"\u005C\u005C", +} + +# All control characters from 0x00 to 0x1F *except* 0x1B. +_HTML5_REPLACEMENTS.update( + { + six.unichr(cc): u"%{:02X}".format(cc) + for cc in range(0x00, 0x1F + 1) + if cc not in (0x1B,) + } +) + + +def _replace_multiple(value, needles_and_replacements): + def replacer(match): + return needles_and_replacements[match.group(0)] + + pattern = re.compile( + r"|".join([re.escape(needle) for needle in needles_and_replacements.keys()]) + ) + + result = pattern.sub(replacer, value) + + return result + + +def format_header_param_html5(name, value): """ - Format and quote a single multipart header parameter. + Helper function to format and quote a single header parameter using the + HTML5 strategy. - This follows the `WHATWG HTML Standard`_ as of 2021/06/10, matching - the behavior of current browser and curl versions. Values are - assumed to be UTF-8. The ``\\n``, ``\\r``, and ``"`` characters are - percent encoded. + Particularly useful for header parameters which might contain + non-ASCII values, like file names. This follows the `HTML5 Working Draft + Section 4.10.22.7`_ and matches the behavior of curl and modern browsers. - .. _WHATWG HTML Standard: - https://html.spec.whatwg.org/multipage/ - form-control-infrastructure.html#multipart-form-data + .. _HTML5 Working Draft Section 4.10.22.7: + https://w3c.github.io/html/sec-forms.html#multipart-form-data :param name: - The name of the parameter, an ASCII-only ``str``. + The name of the parameter, a string expected to be ASCII only. :param value: - The value of the parameter, a ``str`` or UTF-8 encoded - ``bytes``. - :returns: - A string ``name="value"`` with the escaped value. - - .. versionchanged:: 2.0.0 - Matches the WHATWG HTML Standard as of 2021/06/10. Control - characters are no longer percent encoded. - - .. versionchanged:: 2.0.0 - Renamed from ``format_header_param_html5`` and - ``format_header_param``. The old names will be removed in - urllib3 v2.1.0. + The value of the parameter, provided as ``bytes`` or `str``. + :ret: + A unicode string, stripped of troublesome characters. """ - if isinstance(value, bytes): + if isinstance(value, six.binary_type): value = value.decode("utf-8") - # percent encode \n \r " - value = value.translate({10: "%0A", 13: "%0D", 34: "%22"}) - return f'{name}="{value}"' + value = _replace_multiple(value, _HTML5_REPLACEMENTS) - -def format_header_param_html5(name: str, value: _TYPE_FIELD_VALUE) -> str: - """ - .. deprecated:: 2.0.0 - Renamed to :func:`format_multipart_header_param`. Will be - removed in urllib3 v2.1.0. - """ - import warnings - - warnings.warn( - "'format_header_param_html5' has been renamed to " - "'format_multipart_header_param'. The old name will be " - "removed in urllib3 v2.1.0.", - DeprecationWarning, - stacklevel=2, - ) - return format_multipart_header_param(name, value) + return u'%s="%s"' % (name, value) -def format_header_param(name: str, value: _TYPE_FIELD_VALUE) -> str: - """ - .. deprecated:: 2.0.0 - Renamed to :func:`format_multipart_header_param`. Will be - removed in urllib3 v2.1.0. - """ - import warnings - - warnings.warn( - "'format_header_param' has been renamed to " - "'format_multipart_header_param'. The old name will be " - "removed in urllib3 v2.1.0.", - DeprecationWarning, - stacklevel=2, - ) - return format_multipart_header_param(name, value) +# For backwards-compatibility. +format_header_param = format_header_param_html5 -class RequestField: +class RequestField(object): """ A data container for request body parameters. @@ -162,47 +135,29 @@ class RequestField: An optional filename of the request field. Must be unicode. :param headers: An optional dict-like object of headers to initially use for the field. - - .. versionchanged:: 2.0.0 - The ``header_formatter`` parameter is deprecated and will - be removed in urllib3 v2.1.0. + :param header_formatter: + An optional callable that is used to encode and format the headers. By + default, this is :func:`format_header_param_html5`. """ def __init__( self, - name: str, - data: _TYPE_FIELD_VALUE, - filename: str | None = None, - headers: typing.Mapping[str, str] | None = None, - header_formatter: typing.Callable[[str, _TYPE_FIELD_VALUE], str] | None = None, + name, + data, + filename=None, + headers=None, + header_formatter=format_header_param_html5, ): self._name = name self._filename = filename self.data = data - self.headers: dict[str, str | None] = {} + self.headers = {} if headers: self.headers = dict(headers) - - if header_formatter is not None: - import warnings - - warnings.warn( - "The 'header_formatter' parameter is deprecated and " - "will be removed in urllib3 v2.1.0.", - DeprecationWarning, - stacklevel=2, - ) - self.header_formatter = header_formatter - else: - self.header_formatter = format_multipart_header_param + self.header_formatter = header_formatter @classmethod - def from_tuples( - cls, - fieldname: str, - value: _TYPE_FIELD_VALUE_TUPLE, - header_formatter: typing.Callable[[str, _TYPE_FIELD_VALUE], str] | None = None, - ) -> RequestField: + def from_tuples(cls, fieldname, value, header_formatter=format_header_param_html5): """ A :class:`~urllib3.fields.RequestField` factory from old-style tuple parameters. @@ -219,10 +174,6 @@ def from_tuples( Field names and filenames must be unicode. """ - filename: str | None - content_type: str | None - data: _TYPE_FIELD_VALUE - if isinstance(value, tuple): if len(value) == 3: filename, data, content_type = value @@ -241,29 +192,20 @@ def from_tuples( return request_param - def _render_part(self, name: str, value: _TYPE_FIELD_VALUE) -> str: + def _render_part(self, name, value): """ - Override this method to change how each multipart header - parameter is formatted. By default, this calls - :func:`format_multipart_header_param`. + Overridable helper function to format a single header parameter. By + default, this calls ``self.header_formatter``. :param name: - The name of the parameter, an ASCII-only ``str``. + The name of the parameter, a string expected to be ASCII only. :param value: - The value of the parameter, a ``str`` or UTF-8 encoded - ``bytes``. - - :meta public: + The value of the parameter, provided as a unicode string. """ + return self.header_formatter(name, value) - def _render_parts( - self, - header_parts: ( - dict[str, _TYPE_FIELD_VALUE | None] - | typing.Sequence[tuple[str, _TYPE_FIELD_VALUE | None]] - ), - ) -> str: + def _render_parts(self, header_parts): """ Helper function to format and quote a single header. @@ -274,21 +216,18 @@ def _render_parts( A sequence of (k, v) tuples or a :class:`dict` of (k, v) to format as `k1="v1"; k2="v2"; ...`. """ - iterable: typing.Iterable[tuple[str, _TYPE_FIELD_VALUE | None]] - parts = [] + iterable = header_parts if isinstance(header_parts, dict): iterable = header_parts.items() - else: - iterable = header_parts for name, value in iterable: if value is not None: parts.append(self._render_part(name, value)) - return "; ".join(parts) + return u"; ".join(parts) - def render_headers(self) -> str: + def render_headers(self): """ Renders the headers for this request field. """ @@ -297,45 +236,39 @@ def render_headers(self) -> str: sort_keys = ["Content-Disposition", "Content-Type", "Content-Location"] for sort_key in sort_keys: if self.headers.get(sort_key, False): - lines.append(f"{sort_key}: {self.headers[sort_key]}") + lines.append(u"%s: %s" % (sort_key, self.headers[sort_key])) for header_name, header_value in self.headers.items(): if header_name not in sort_keys: if header_value: - lines.append(f"{header_name}: {header_value}") + lines.append(u"%s: %s" % (header_name, header_value)) - lines.append("\r\n") - return "\r\n".join(lines) + lines.append(u"\r\n") + return u"\r\n".join(lines) def make_multipart( - self, - content_disposition: str | None = None, - content_type: str | None = None, - content_location: str | None = None, - ) -> None: + self, content_disposition=None, content_type=None, content_location=None + ): """ Makes this request field into a multipart request field. This method overrides "Content-Disposition", "Content-Type" and "Content-Location" headers to the request parameter. - :param content_disposition: - The 'Content-Disposition' of the request body. Defaults to 'form-data' :param content_type: The 'Content-Type' of the request body. :param content_location: The 'Content-Location' of the request body. """ - content_disposition = (content_disposition or "form-data") + "; ".join( + self.headers["Content-Disposition"] = content_disposition or u"form-data" + self.headers["Content-Disposition"] += u"; ".join( [ - "", + u"", self._render_parts( - (("name", self._name), ("filename", self._filename)) + ((u"name", self._name), (u"filename", self._filename)) ), ] ) - - self.headers["Content-Disposition"] = content_disposition self.headers["Content-Type"] = content_type self.headers["Content-Location"] = content_location diff --git a/newrelic/packages/urllib3/filepost.py b/newrelic/packages/urllib3/filepost.py index 14f70b05b4..36c9252c64 100644 --- a/newrelic/packages/urllib3/filepost.py +++ b/newrelic/packages/urllib3/filepost.py @@ -1,32 +1,28 @@ -from __future__ import annotations +from __future__ import absolute_import import binascii import codecs import os -import typing from io import BytesIO -from .fields import _TYPE_FIELD_VALUE_TUPLE, RequestField +from .fields import RequestField +from .packages import six +from .packages.six import b writer = codecs.lookup("utf-8")[3] -_TYPE_FIELDS_SEQUENCE = typing.Sequence[ - typing.Union[tuple[str, _TYPE_FIELD_VALUE_TUPLE], RequestField] -] -_TYPE_FIELDS = typing.Union[ - _TYPE_FIELDS_SEQUENCE, - typing.Mapping[str, _TYPE_FIELD_VALUE_TUPLE], -] - -def choose_boundary() -> str: +def choose_boundary(): """ Our embarrassingly-simple replacement for mimetools.choose_boundary. """ - return binascii.hexlify(os.urandom(16)).decode() + boundary = binascii.hexlify(os.urandom(16)) + if not six.PY2: + boundary = boundary.decode("ascii") + return boundary -def iter_field_objects(fields: _TYPE_FIELDS) -> typing.Iterable[RequestField]: +def iter_field_objects(fields): """ Iterate over fields. @@ -34,29 +30,42 @@ def iter_field_objects(fields: _TYPE_FIELDS) -> typing.Iterable[RequestField]: :class:`~urllib3.fields.RequestField`. """ - iterable: typing.Iterable[RequestField | tuple[str, _TYPE_FIELD_VALUE_TUPLE]] - - if isinstance(fields, typing.Mapping): - iterable = fields.items() + if isinstance(fields, dict): + i = six.iteritems(fields) else: - iterable = fields + i = iter(fields) - for field in iterable: + for field in i: if isinstance(field, RequestField): yield field else: yield RequestField.from_tuples(*field) -def encode_multipart_formdata( - fields: _TYPE_FIELDS, boundary: str | None = None -) -> tuple[bytes, str]: +def iter_fields(fields): + """ + .. deprecated:: 1.6 + + Iterate over fields. + + The addition of :class:`~urllib3.fields.RequestField` makes this function + obsolete. Instead, use :func:`iter_field_objects`, which returns + :class:`~urllib3.fields.RequestField` objects. + + Supports list of (k, v) tuples and dicts. + """ + if isinstance(fields, dict): + return ((k, v) for k, v in six.iteritems(fields)) + + return ((k, v) for k, v in fields) + + +def encode_multipart_formdata(fields, boundary=None): """ Encode a dictionary of ``fields`` using the multipart/form-data MIME format. :param fields: Dictionary of fields or list of (key, :class:`~urllib3.fields.RequestField`). - Values are processed by :func:`urllib3.fields.RequestField.from_tuples`. :param boundary: If not specified, then a random boundary will be generated using @@ -67,7 +76,7 @@ def encode_multipart_formdata( boundary = choose_boundary() for field in iter_field_objects(fields): - body.write(f"--{boundary}\r\n".encode("latin-1")) + body.write(b("--%s\r\n" % (boundary))) writer(body).write(field.render_headers()) data = field.data @@ -75,15 +84,15 @@ def encode_multipart_formdata( if isinstance(data, int): data = str(data) # Backwards compatibility - if isinstance(data, str): + if isinstance(data, six.text_type): writer(body).write(data) else: body.write(data) body.write(b"\r\n") - body.write(f"--{boundary}--\r\n".encode("latin-1")) + body.write(b("--%s--\r\n" % (boundary))) - content_type = f"multipart/form-data; boundary={boundary}" + content_type = str("multipart/form-data; boundary=%s" % boundary) return body.getvalue(), content_type diff --git a/newrelic/packages/urllib3/http2/__init__.py b/newrelic/packages/urllib3/http2/__init__.py deleted file mode 100644 index 133e1d8f23..0000000000 --- a/newrelic/packages/urllib3/http2/__init__.py +++ /dev/null @@ -1,53 +0,0 @@ -from __future__ import annotations - -from importlib.metadata import version - -__all__ = [ - "inject_into_urllib3", - "extract_from_urllib3", -] - -import typing - -orig_HTTPSConnection: typing.Any = None - - -def inject_into_urllib3() -> None: - # First check if h2 version is valid - h2_version = version("h2") - if not h2_version.startswith("4."): - raise ImportError( - "urllib3 v2 supports h2 version 4.x.x, currently " - f"the 'h2' module is compiled with {h2_version!r}. " - "See: https://github.com/urllib3/urllib3/issues/3290" - ) - - # Import here to avoid circular dependencies. - from .. import connection as urllib3_connection - from .. import util as urllib3_util - from ..connectionpool import HTTPSConnectionPool - from ..util import ssl_ as urllib3_util_ssl - from .connection import HTTP2Connection - - global orig_HTTPSConnection - orig_HTTPSConnection = urllib3_connection.HTTPSConnection - - HTTPSConnectionPool.ConnectionCls = HTTP2Connection - urllib3_connection.HTTPSConnection = HTTP2Connection # type: ignore[misc] - - # TODO: Offer 'http/1.1' as well, but for testing purposes this is handy. - urllib3_util.ALPN_PROTOCOLS = ["h2"] - urllib3_util_ssl.ALPN_PROTOCOLS = ["h2"] - - -def extract_from_urllib3() -> None: - from .. import connection as urllib3_connection - from .. import util as urllib3_util - from ..connectionpool import HTTPSConnectionPool - from ..util import ssl_ as urllib3_util_ssl - - HTTPSConnectionPool.ConnectionCls = orig_HTTPSConnection - urllib3_connection.HTTPSConnection = orig_HTTPSConnection # type: ignore[misc] - - urllib3_util.ALPN_PROTOCOLS = ["http/1.1"] - urllib3_util_ssl.ALPN_PROTOCOLS = ["http/1.1"] diff --git a/newrelic/packages/urllib3/http2/connection.py b/newrelic/packages/urllib3/http2/connection.py deleted file mode 100644 index 0a026da0a8..0000000000 --- a/newrelic/packages/urllib3/http2/connection.py +++ /dev/null @@ -1,356 +0,0 @@ -from __future__ import annotations - -import logging -import re -import threading -import types -import typing - -import h2.config -import h2.connection -import h2.events - -from .._base_connection import _TYPE_BODY -from .._collections import HTTPHeaderDict -from ..connection import HTTPSConnection, _get_default_user_agent -from ..exceptions import ConnectionError -from ..response import BaseHTTPResponse - -orig_HTTPSConnection = HTTPSConnection - -T = typing.TypeVar("T") - -log = logging.getLogger(__name__) - -RE_IS_LEGAL_HEADER_NAME = re.compile(rb"^[!#$%&'*+\-.^_`|~0-9a-z]+$") -RE_IS_ILLEGAL_HEADER_VALUE = re.compile(rb"[\0\x00\x0a\x0d\r\n]|^[ \r\n\t]|[ \r\n\t]$") - - -def _is_legal_header_name(name: bytes) -> bool: - """ - "An implementation that validates fields according to the definitions in Sections - 5.1 and 5.5 of [HTTP] only needs an additional check that field names do not - include uppercase characters." (https://httpwg.org/specs/rfc9113.html#n-field-validity) - - `http.client._is_legal_header_name` does not validate the field name according to the - HTTP 1.1 spec, so we do that here, in addition to checking for uppercase characters. - - This does not allow for the `:` character in the header name, so should not - be used to validate pseudo-headers. - """ - return bool(RE_IS_LEGAL_HEADER_NAME.match(name)) - - -def _is_illegal_header_value(value: bytes) -> bool: - """ - "A field value MUST NOT contain the zero value (ASCII NUL, 0x00), line feed - (ASCII LF, 0x0a), or carriage return (ASCII CR, 0x0d) at any position. A field - value MUST NOT start or end with an ASCII whitespace character (ASCII SP or HTAB, - 0x20 or 0x09)." (https://httpwg.org/specs/rfc9113.html#n-field-validity) - """ - return bool(RE_IS_ILLEGAL_HEADER_VALUE.search(value)) - - -class _LockedObject(typing.Generic[T]): - """ - A wrapper class that hides a specific object behind a lock. - The goal here is to provide a simple way to protect access to an object - that cannot safely be simultaneously accessed from multiple threads. The - intended use of this class is simple: take hold of it with a context - manager, which returns the protected object. - """ - - __slots__ = ( - "lock", - "_obj", - ) - - def __init__(self, obj: T): - self.lock = threading.RLock() - self._obj = obj - - def __enter__(self) -> T: - self.lock.acquire() - return self._obj - - def __exit__( - self, - exc_type: type[BaseException] | None, - exc_val: BaseException | None, - exc_tb: types.TracebackType | None, - ) -> None: - self.lock.release() - - -class HTTP2Connection(HTTPSConnection): - def __init__( - self, host: str, port: int | None = None, **kwargs: typing.Any - ) -> None: - self._h2_conn = self._new_h2_conn() - self._h2_stream: int | None = None - self._headers: list[tuple[bytes, bytes]] = [] - - if "proxy" in kwargs or "proxy_config" in kwargs: # Defensive: - raise NotImplementedError("Proxies aren't supported with HTTP/2") - - super().__init__(host, port, **kwargs) - - if self._tunnel_host is not None: - raise NotImplementedError("Tunneling isn't supported with HTTP/2") - - def _new_h2_conn(self) -> _LockedObject[h2.connection.H2Connection]: - config = h2.config.H2Configuration(client_side=True) - return _LockedObject(h2.connection.H2Connection(config=config)) - - def connect(self) -> None: - super().connect() - with self._h2_conn as conn: - conn.initiate_connection() - if data_to_send := conn.data_to_send(): - self.sock.sendall(data_to_send) - - def putrequest( # type: ignore[override] - self, - method: str, - url: str, - **kwargs: typing.Any, - ) -> None: - """putrequest - This deviates from the HTTPConnection method signature since we never need to override - sending accept-encoding headers or the host header. - """ - if "skip_host" in kwargs: - raise NotImplementedError("`skip_host` isn't supported") - if "skip_accept_encoding" in kwargs: - raise NotImplementedError("`skip_accept_encoding` isn't supported") - - self._request_url = url or "/" - self._validate_path(url) # type: ignore[attr-defined] - - if ":" in self.host: - authority = f"[{self.host}]:{self.port or 443}" - else: - authority = f"{self.host}:{self.port or 443}" - - self._headers.append((b":scheme", b"https")) - self._headers.append((b":method", method.encode())) - self._headers.append((b":authority", authority.encode())) - self._headers.append((b":path", url.encode())) - - with self._h2_conn as conn: - self._h2_stream = conn.get_next_available_stream_id() - - def putheader(self, header: str | bytes, *values: str | bytes) -> None: # type: ignore[override] - # TODO SKIPPABLE_HEADERS from urllib3 are ignored. - header = header.encode() if isinstance(header, str) else header - header = header.lower() # A lot of upstream code uses capitalized headers. - if not _is_legal_header_name(header): - raise ValueError(f"Illegal header name {str(header)}") - - for value in values: - value = value.encode() if isinstance(value, str) else value - if _is_illegal_header_value(value): - raise ValueError(f"Illegal header value {str(value)}") - self._headers.append((header, value)) - - def endheaders(self, message_body: typing.Any = None) -> None: # type: ignore[override] - if self._h2_stream is None: - raise ConnectionError("Must call `putrequest` first.") - - with self._h2_conn as conn: - conn.send_headers( - stream_id=self._h2_stream, - headers=self._headers, - end_stream=(message_body is None), - ) - if data_to_send := conn.data_to_send(): - self.sock.sendall(data_to_send) - self._headers = [] # Reset headers for the next request. - - def send(self, data: typing.Any) -> None: - """Send data to the server. - `data` can be: `str`, `bytes`, an iterable, or file-like objects - that support a .read() method. - """ - if self._h2_stream is None: - raise ConnectionError("Must call `putrequest` first.") - - with self._h2_conn as conn: - if data_to_send := conn.data_to_send(): - self.sock.sendall(data_to_send) - - if hasattr(data, "read"): # file-like objects - while True: - chunk = data.read(self.blocksize) - if not chunk: - break - if isinstance(chunk, str): - chunk = chunk.encode() - conn.send_data(self._h2_stream, chunk, end_stream=False) - if data_to_send := conn.data_to_send(): - self.sock.sendall(data_to_send) - conn.end_stream(self._h2_stream) - return - - if isinstance(data, str): # str -> bytes - data = data.encode() - - try: - if isinstance(data, bytes): - conn.send_data(self._h2_stream, data, end_stream=True) - if data_to_send := conn.data_to_send(): - self.sock.sendall(data_to_send) - else: - for chunk in data: - conn.send_data(self._h2_stream, chunk, end_stream=False) - if data_to_send := conn.data_to_send(): - self.sock.sendall(data_to_send) - conn.end_stream(self._h2_stream) - except TypeError: - raise TypeError( - "`data` should be str, bytes, iterable, or file. got %r" - % type(data) - ) - - def set_tunnel( - self, - host: str, - port: int | None = None, - headers: typing.Mapping[str, str] | None = None, - scheme: str = "http", - ) -> None: - raise NotImplementedError( - "HTTP/2 does not support setting up a tunnel through a proxy" - ) - - def getresponse( # type: ignore[override] - self, - ) -> HTTP2Response: - status = None - data = bytearray() - with self._h2_conn as conn: - end_stream = False - while not end_stream: - # TODO: Arbitrary read value. - if received_data := self.sock.recv(65535): - events = conn.receive_data(received_data) - for event in events: - if isinstance(event, h2.events.ResponseReceived): - headers = HTTPHeaderDict() - for header, value in event.headers: - if header == b":status": - status = int(value.decode()) - else: - headers.add( - header.decode("ascii"), value.decode("ascii") - ) - - elif isinstance(event, h2.events.DataReceived): - data += event.data - conn.acknowledge_received_data( - event.flow_controlled_length, event.stream_id - ) - - elif isinstance(event, h2.events.StreamEnded): - end_stream = True - - if data_to_send := conn.data_to_send(): - self.sock.sendall(data_to_send) - - assert status is not None - return HTTP2Response( - status=status, - headers=headers, - request_url=self._request_url, - data=bytes(data), - ) - - def request( # type: ignore[override] - self, - method: str, - url: str, - body: _TYPE_BODY | None = None, - headers: typing.Mapping[str, str] | None = None, - *, - preload_content: bool = True, - decode_content: bool = True, - enforce_content_length: bool = True, - **kwargs: typing.Any, - ) -> None: - """Send an HTTP/2 request""" - if "chunked" in kwargs: - # TODO this is often present from upstream. - # raise NotImplementedError("`chunked` isn't supported with HTTP/2") - pass - - if self.sock is not None: - self.sock.settimeout(self.timeout) - - self.putrequest(method, url) - - headers = headers or {} - for k, v in headers.items(): - if k.lower() == "transfer-encoding" and v == "chunked": - continue - else: - self.putheader(k, v) - - if b"user-agent" not in dict(self._headers): - self.putheader(b"user-agent", _get_default_user_agent()) - - if body: - self.endheaders(message_body=body) - self.send(body) - else: - self.endheaders() - - def close(self) -> None: - with self._h2_conn as conn: - try: - conn.close_connection() - if data := conn.data_to_send(): - self.sock.sendall(data) - except Exception: - pass - - # Reset all our HTTP/2 connection state. - self._h2_conn = self._new_h2_conn() - self._h2_stream = None - self._headers = [] - - super().close() - - -class HTTP2Response(BaseHTTPResponse): - # TODO: This is a woefully incomplete response object, but works for non-streaming. - def __init__( - self, - status: int, - headers: HTTPHeaderDict, - request_url: str, - data: bytes, - decode_content: bool = False, # TODO: support decoding - ) -> None: - super().__init__( - status=status, - headers=headers, - # Following CPython, we map HTTP versions to major * 10 + minor integers - version=20, - version_string="HTTP/2", - # No reason phrase in HTTP/2 - reason=None, - decode_content=decode_content, - request_url=request_url, - ) - self._data = data - self.length_remaining = 0 - - @property - def data(self) -> bytes: - return self._data - - def get_redirect_location(self) -> None: - return None - - def close(self) -> None: - pass diff --git a/newrelic/packages/urllib3/http2/probe.py b/newrelic/packages/urllib3/http2/probe.py deleted file mode 100644 index 9ea900764f..0000000000 --- a/newrelic/packages/urllib3/http2/probe.py +++ /dev/null @@ -1,87 +0,0 @@ -from __future__ import annotations - -import threading - - -class _HTTP2ProbeCache: - __slots__ = ( - "_lock", - "_cache_locks", - "_cache_values", - ) - - def __init__(self) -> None: - self._lock = threading.Lock() - self._cache_locks: dict[tuple[str, int], threading.RLock] = {} - self._cache_values: dict[tuple[str, int], bool | None] = {} - - def acquire_and_get(self, host: str, port: int) -> bool | None: - # By the end of this block we know that - # _cache_[values,locks] is available. - value = None - with self._lock: - key = (host, port) - try: - value = self._cache_values[key] - # If it's a known value we return right away. - if value is not None: - return value - except KeyError: - self._cache_locks[key] = threading.RLock() - self._cache_values[key] = None - - # If the value is unknown, we acquire the lock to signal - # to the requesting thread that the probe is in progress - # or that the current thread needs to return their findings. - key_lock = self._cache_locks[key] - key_lock.acquire() - try: - # If the by the time we get the lock the value has been - # updated we want to return the updated value. - value = self._cache_values[key] - - # In case an exception like KeyboardInterrupt is raised here. - except BaseException as e: # Defensive: - assert not isinstance(e, KeyError) # KeyError shouldn't be possible. - key_lock.release() - raise - - return value - - def set_and_release( - self, host: str, port: int, supports_http2: bool | None - ) -> None: - key = (host, port) - key_lock = self._cache_locks[key] - with key_lock: # Uses an RLock, so can be locked again from same thread. - if supports_http2 is None and self._cache_values[key] is not None: - raise ValueError( - "Cannot reset HTTP/2 support for origin after value has been set." - ) # Defensive: not expected in normal usage - - self._cache_values[key] = supports_http2 - key_lock.release() - - def _values(self) -> dict[tuple[str, int], bool | None]: - """This function is for testing purposes only. Gets the current state of the probe cache""" - with self._lock: - return {k: v for k, v in self._cache_values.items()} - - def _reset(self) -> None: - """This function is for testing purposes only. Reset the cache values""" - with self._lock: - self._cache_locks = {} - self._cache_values = {} - - -_HTTP2_PROBE_CACHE = _HTTP2ProbeCache() - -set_and_release = _HTTP2_PROBE_CACHE.set_and_release -acquire_and_get = _HTTP2_PROBE_CACHE.acquire_and_get -_values = _HTTP2_PROBE_CACHE._values -_reset = _HTTP2_PROBE_CACHE._reset - -__all__ = [ - "set_and_release", - "acquire_and_get", -] diff --git a/newrelic/packages/urllib3/packages/__init__.py b/newrelic/packages/urllib3/packages/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/newrelic/packages/urllib3/packages/backports/__init__.py b/newrelic/packages/urllib3/packages/backports/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/newrelic/packages/urllib3/packages/backports/makefile.py b/newrelic/packages/urllib3/packages/backports/makefile.py new file mode 100644 index 0000000000..b8fb2154b6 --- /dev/null +++ b/newrelic/packages/urllib3/packages/backports/makefile.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +""" +backports.makefile +~~~~~~~~~~~~~~~~~~ + +Backports the Python 3 ``socket.makefile`` method for use with anything that +wants to create a "fake" socket object. +""" +import io +from socket import SocketIO + + +def backport_makefile( + self, mode="r", buffering=None, encoding=None, errors=None, newline=None +): + """ + Backport of ``socket.makefile`` from Python 3.5. + """ + if not set(mode) <= {"r", "w", "b"}: + raise ValueError("invalid mode %r (only r, w, b allowed)" % (mode,)) + writing = "w" in mode + reading = "r" in mode or not writing + assert reading or writing + binary = "b" in mode + rawmode = "" + if reading: + rawmode += "r" + if writing: + rawmode += "w" + raw = SocketIO(self, rawmode) + self._makefile_refs += 1 + if buffering is None: + buffering = -1 + if buffering < 0: + buffering = io.DEFAULT_BUFFER_SIZE + if buffering == 0: + if not binary: + raise ValueError("unbuffered streams must be binary") + return raw + if reading and writing: + buffer = io.BufferedRWPair(raw, raw, buffering) + elif reading: + buffer = io.BufferedReader(raw, buffering) + else: + assert writing + buffer = io.BufferedWriter(raw, buffering) + if binary: + return buffer + text = io.TextIOWrapper(buffer, encoding, errors, newline) + text.mode = mode + return text diff --git a/newrelic/packages/urllib3/packages/backports/weakref_finalize.py b/newrelic/packages/urllib3/packages/backports/weakref_finalize.py new file mode 100644 index 0000000000..a2f2966e54 --- /dev/null +++ b/newrelic/packages/urllib3/packages/backports/weakref_finalize.py @@ -0,0 +1,155 @@ +# -*- coding: utf-8 -*- +""" +backports.weakref_finalize +~~~~~~~~~~~~~~~~~~ + +Backports the Python 3 ``weakref.finalize`` method. +""" +from __future__ import absolute_import + +import itertools +import sys +from weakref import ref + +__all__ = ["weakref_finalize"] + + +class weakref_finalize(object): + """Class for finalization of weakrefable objects + finalize(obj, func, *args, **kwargs) returns a callable finalizer + object which will be called when obj is garbage collected. The + first time the finalizer is called it evaluates func(*arg, **kwargs) + and returns the result. After this the finalizer is dead, and + calling it just returns None. + When the program exits any remaining finalizers for which the + atexit attribute is true will be run in reverse order of creation. + By default atexit is true. + """ + + # Finalizer objects don't have any state of their own. They are + # just used as keys to lookup _Info objects in the registry. This + # ensures that they cannot be part of a ref-cycle. + + __slots__ = () + _registry = {} + _shutdown = False + _index_iter = itertools.count() + _dirty = False + _registered_with_atexit = False + + class _Info(object): + __slots__ = ("weakref", "func", "args", "kwargs", "atexit", "index") + + def __init__(self, obj, func, *args, **kwargs): + if not self._registered_with_atexit: + # We may register the exit function more than once because + # of a thread race, but that is harmless + import atexit + + atexit.register(self._exitfunc) + weakref_finalize._registered_with_atexit = True + info = self._Info() + info.weakref = ref(obj, self) + info.func = func + info.args = args + info.kwargs = kwargs or None + info.atexit = True + info.index = next(self._index_iter) + self._registry[self] = info + weakref_finalize._dirty = True + + def __call__(self, _=None): + """If alive then mark as dead and return func(*args, **kwargs); + otherwise return None""" + info = self._registry.pop(self, None) + if info and not self._shutdown: + return info.func(*info.args, **(info.kwargs or {})) + + def detach(self): + """If alive then mark as dead and return (obj, func, args, kwargs); + otherwise return None""" + info = self._registry.get(self) + obj = info and info.weakref() + if obj is not None and self._registry.pop(self, None): + return (obj, info.func, info.args, info.kwargs or {}) + + def peek(self): + """If alive then return (obj, func, args, kwargs); + otherwise return None""" + info = self._registry.get(self) + obj = info and info.weakref() + if obj is not None: + return (obj, info.func, info.args, info.kwargs or {}) + + @property + def alive(self): + """Whether finalizer is alive""" + return self in self._registry + + @property + def atexit(self): + """Whether finalizer should be called at exit""" + info = self._registry.get(self) + return bool(info) and info.atexit + + @atexit.setter + def atexit(self, value): + info = self._registry.get(self) + if info: + info.atexit = bool(value) + + def __repr__(self): + info = self._registry.get(self) + obj = info and info.weakref() + if obj is None: + return "<%s object at %#x; dead>" % (type(self).__name__, id(self)) + else: + return "<%s object at %#x; for %r at %#x>" % ( + type(self).__name__, + id(self), + type(obj).__name__, + id(obj), + ) + + @classmethod + def _select_for_exit(cls): + # Return live finalizers marked for exit, oldest first + L = [(f, i) for (f, i) in cls._registry.items() if i.atexit] + L.sort(key=lambda item: item[1].index) + return [f for (f, i) in L] + + @classmethod + def _exitfunc(cls): + # At shutdown invoke finalizers for which atexit is true. + # This is called once all other non-daemonic threads have been + # joined. + reenable_gc = False + try: + if cls._registry: + import gc + + if gc.isenabled(): + reenable_gc = True + gc.disable() + pending = None + while True: + if pending is None or weakref_finalize._dirty: + pending = cls._select_for_exit() + weakref_finalize._dirty = False + if not pending: + break + f = pending.pop() + try: + # gc is disabled, so (assuming no daemonic + # threads) the following is the only line in + # this function which might trigger creation + # of a new finalizer + f() + except Exception: + sys.excepthook(*sys.exc_info()) + assert f not in cls._registry + finally: + # prevent any more finalizers from executing during shutdown + weakref_finalize._shutdown = True + if reenable_gc: + gc.enable() diff --git a/newrelic/packages/urllib3/packages/six.py b/newrelic/packages/urllib3/packages/six.py new file mode 100644 index 0000000000..f099a3dcd2 --- /dev/null +++ b/newrelic/packages/urllib3/packages/six.py @@ -0,0 +1,1076 @@ +# Copyright (c) 2010-2020 Benjamin Peterson +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in all +# copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE. + +"""Utilities for writing code that runs on Python 2 and 3""" + +from __future__ import absolute_import + +import functools +import itertools +import operator +import sys +import types + +__author__ = "Benjamin Peterson " +__version__ = "1.16.0" + + +# Useful for very coarse version differentiation. +PY2 = sys.version_info[0] == 2 +PY3 = sys.version_info[0] == 3 +PY34 = sys.version_info[0:2] >= (3, 4) + +if PY3: + string_types = (str,) + integer_types = (int,) + class_types = (type,) + text_type = str + binary_type = bytes + + MAXSIZE = sys.maxsize +else: + string_types = (basestring,) + integer_types = (int, long) + class_types = (type, types.ClassType) + text_type = unicode + binary_type = str + + if sys.platform.startswith("java"): + # Jython always uses 32 bits. + MAXSIZE = int((1 << 31) - 1) + else: + # It's possible to have sizeof(long) != sizeof(Py_ssize_t). + class X(object): + def __len__(self): + return 1 << 31 + + try: + len(X()) + except OverflowError: + # 32-bit + MAXSIZE = int((1 << 31) - 1) + else: + # 64-bit + MAXSIZE = int((1 << 63) - 1) + del X + +if PY34: + from importlib.util import spec_from_loader +else: + spec_from_loader = None + + +def _add_doc(func, doc): + """Add documentation to a function.""" + func.__doc__ = doc + + +def _import_module(name): + """Import module, returning the module after the last dot.""" + __import__(name) + return sys.modules[name] + + +class _LazyDescr(object): + def __init__(self, name): + self.name = name + + def __get__(self, obj, tp): + result = self._resolve() + setattr(obj, self.name, result) # Invokes __set__. + try: + # This is a bit ugly, but it avoids running this again by + # removing this descriptor. + delattr(obj.__class__, self.name) + except AttributeError: + pass + return result + + +class MovedModule(_LazyDescr): + def __init__(self, name, old, new=None): + super(MovedModule, self).__init__(name) + if PY3: + if new is None: + new = name + self.mod = new + else: + self.mod = old + + def _resolve(self): + return _import_module(self.mod) + + def __getattr__(self, attr): + _module = self._resolve() + value = getattr(_module, attr) + setattr(self, attr, value) + return value + + +class _LazyModule(types.ModuleType): + def __init__(self, name): + super(_LazyModule, self).__init__(name) + self.__doc__ = self.__class__.__doc__ + + def __dir__(self): + attrs = ["__doc__", "__name__"] + attrs += [attr.name for attr in self._moved_attributes] + return attrs + + # Subclasses should override this + _moved_attributes = [] + + +class MovedAttribute(_LazyDescr): + def __init__(self, name, old_mod, new_mod, old_attr=None, new_attr=None): + super(MovedAttribute, self).__init__(name) + if PY3: + if new_mod is None: + new_mod = name + self.mod = new_mod + if new_attr is None: + if old_attr is None: + new_attr = name + else: + new_attr = old_attr + self.attr = new_attr + else: + self.mod = old_mod + if old_attr is None: + old_attr = name + self.attr = old_attr + + def _resolve(self): + module = _import_module(self.mod) + return getattr(module, self.attr) + + +class _SixMetaPathImporter(object): + + """ + A meta path importer to import six.moves and its submodules. + + This class implements a PEP302 finder and loader. It should be compatible + with Python 2.5 and all existing versions of Python3 + """ + + def __init__(self, six_module_name): + self.name = six_module_name + self.known_modules = {} + + def _add_module(self, mod, *fullnames): + for fullname in fullnames: + self.known_modules[self.name + "." + fullname] = mod + + def _get_module(self, fullname): + return self.known_modules[self.name + "." + fullname] + + def find_module(self, fullname, path=None): + if fullname in self.known_modules: + return self + return None + + def find_spec(self, fullname, path, target=None): + if fullname in self.known_modules: + return spec_from_loader(fullname, self) + return None + + def __get_module(self, fullname): + try: + return self.known_modules[fullname] + except KeyError: + raise ImportError("This loader does not know module " + fullname) + + def load_module(self, fullname): + try: + # in case of a reload + return sys.modules[fullname] + except KeyError: + pass + mod = self.__get_module(fullname) + if isinstance(mod, MovedModule): + mod = mod._resolve() + else: + mod.__loader__ = self + sys.modules[fullname] = mod + return mod + + def is_package(self, fullname): + """ + Return true, if the named module is a package. + + We need this method to get correct spec objects with + Python 3.4 (see PEP451) + """ + return hasattr(self.__get_module(fullname), "__path__") + + def get_code(self, fullname): + """Return None + + Required, if is_package is implemented""" + self.__get_module(fullname) # eventually raises ImportError + return None + + get_source = get_code # same as get_code + + def create_module(self, spec): + return self.load_module(spec.name) + + def exec_module(self, module): + pass + + +_importer = _SixMetaPathImporter(__name__) + + +class _MovedItems(_LazyModule): + + """Lazy loading of moved objects""" + + __path__ = [] # mark as package + + +_moved_attributes = [ + MovedAttribute("cStringIO", "cStringIO", "io", "StringIO"), + MovedAttribute("filter", "itertools", "builtins", "ifilter", "filter"), + MovedAttribute( + "filterfalse", "itertools", "itertools", "ifilterfalse", "filterfalse" + ), + MovedAttribute("input", "__builtin__", "builtins", "raw_input", "input"), + MovedAttribute("intern", "__builtin__", "sys"), + MovedAttribute("map", "itertools", "builtins", "imap", "map"), + MovedAttribute("getcwd", "os", "os", "getcwdu", "getcwd"), + MovedAttribute("getcwdb", "os", "os", "getcwd", "getcwdb"), + MovedAttribute("getoutput", "commands", "subprocess"), + MovedAttribute("range", "__builtin__", "builtins", "xrange", "range"), + MovedAttribute( + "reload_module", "__builtin__", "importlib" if PY34 else "imp", "reload" + ), + MovedAttribute("reduce", "__builtin__", "functools"), + MovedAttribute("shlex_quote", "pipes", "shlex", "quote"), + MovedAttribute("StringIO", "StringIO", "io"), + MovedAttribute("UserDict", "UserDict", "collections"), + MovedAttribute("UserList", "UserList", "collections"), + MovedAttribute("UserString", "UserString", "collections"), + MovedAttribute("xrange", "__builtin__", "builtins", "xrange", "range"), + MovedAttribute("zip", "itertools", "builtins", "izip", "zip"), + MovedAttribute( + "zip_longest", "itertools", "itertools", "izip_longest", "zip_longest" + ), + MovedModule("builtins", "__builtin__"), + MovedModule("configparser", "ConfigParser"), + MovedModule( + "collections_abc", + "collections", + "collections.abc" if sys.version_info >= (3, 3) else "collections", + ), + MovedModule("copyreg", "copy_reg"), + MovedModule("dbm_gnu", "gdbm", "dbm.gnu"), + MovedModule("dbm_ndbm", "dbm", "dbm.ndbm"), + MovedModule( + "_dummy_thread", + "dummy_thread", + "_dummy_thread" if sys.version_info < (3, 9) else "_thread", + ), + MovedModule("http_cookiejar", "cookielib", "http.cookiejar"), + MovedModule("http_cookies", "Cookie", "http.cookies"), + MovedModule("html_entities", "htmlentitydefs", "html.entities"), + MovedModule("html_parser", "HTMLParser", "html.parser"), + MovedModule("http_client", "httplib", "http.client"), + MovedModule("email_mime_base", "email.MIMEBase", "email.mime.base"), + MovedModule("email_mime_image", "email.MIMEImage", "email.mime.image"), + MovedModule("email_mime_multipart", "email.MIMEMultipart", "email.mime.multipart"), + MovedModule( + "email_mime_nonmultipart", "email.MIMENonMultipart", "email.mime.nonmultipart" + ), + MovedModule("email_mime_text", "email.MIMEText", "email.mime.text"), + MovedModule("BaseHTTPServer", "BaseHTTPServer", "http.server"), + MovedModule("CGIHTTPServer", "CGIHTTPServer", "http.server"), + MovedModule("SimpleHTTPServer", "SimpleHTTPServer", "http.server"), + MovedModule("cPickle", "cPickle", "pickle"), + MovedModule("queue", "Queue"), + MovedModule("reprlib", "repr"), + MovedModule("socketserver", "SocketServer"), + MovedModule("_thread", "thread", "_thread"), + MovedModule("tkinter", "Tkinter"), + MovedModule("tkinter_dialog", "Dialog", "tkinter.dialog"), + MovedModule("tkinter_filedialog", "FileDialog", "tkinter.filedialog"), + MovedModule("tkinter_scrolledtext", "ScrolledText", "tkinter.scrolledtext"), + MovedModule("tkinter_simpledialog", "SimpleDialog", "tkinter.simpledialog"), + MovedModule("tkinter_tix", "Tix", "tkinter.tix"), + MovedModule("tkinter_ttk", "ttk", "tkinter.ttk"), + MovedModule("tkinter_constants", "Tkconstants", "tkinter.constants"), + MovedModule("tkinter_dnd", "Tkdnd", "tkinter.dnd"), + MovedModule("tkinter_colorchooser", "tkColorChooser", "tkinter.colorchooser"), + MovedModule("tkinter_commondialog", "tkCommonDialog", "tkinter.commondialog"), + MovedModule("tkinter_tkfiledialog", "tkFileDialog", "tkinter.filedialog"), + MovedModule("tkinter_font", "tkFont", "tkinter.font"), + MovedModule("tkinter_messagebox", "tkMessageBox", "tkinter.messagebox"), + MovedModule("tkinter_tksimpledialog", "tkSimpleDialog", "tkinter.simpledialog"), + MovedModule("urllib_parse", __name__ + ".moves.urllib_parse", "urllib.parse"), + MovedModule("urllib_error", __name__ + ".moves.urllib_error", "urllib.error"), + MovedModule("urllib", __name__ + ".moves.urllib", __name__ + ".moves.urllib"), + MovedModule("urllib_robotparser", "robotparser", "urllib.robotparser"), + MovedModule("xmlrpc_client", "xmlrpclib", "xmlrpc.client"), + MovedModule("xmlrpc_server", "SimpleXMLRPCServer", "xmlrpc.server"), +] +# Add windows specific modules. +if sys.platform == "win32": + _moved_attributes += [ + MovedModule("winreg", "_winreg"), + ] + +for attr in _moved_attributes: + setattr(_MovedItems, attr.name, attr) + if isinstance(attr, MovedModule): + _importer._add_module(attr, "moves." + attr.name) +del attr + +_MovedItems._moved_attributes = _moved_attributes + +moves = _MovedItems(__name__ + ".moves") +_importer._add_module(moves, "moves") + + +class Module_six_moves_urllib_parse(_LazyModule): + + """Lazy loading of moved objects in six.moves.urllib_parse""" + + +_urllib_parse_moved_attributes = [ + MovedAttribute("ParseResult", "urlparse", "urllib.parse"), + MovedAttribute("SplitResult", "urlparse", "urllib.parse"), + MovedAttribute("parse_qs", "urlparse", "urllib.parse"), + MovedAttribute("parse_qsl", "urlparse", "urllib.parse"), + MovedAttribute("urldefrag", "urlparse", "urllib.parse"), + MovedAttribute("urljoin", "urlparse", "urllib.parse"), + MovedAttribute("urlparse", "urlparse", "urllib.parse"), + MovedAttribute("urlsplit", "urlparse", "urllib.parse"), + MovedAttribute("urlunparse", "urlparse", "urllib.parse"), + MovedAttribute("urlunsplit", "urlparse", "urllib.parse"), + MovedAttribute("quote", "urllib", "urllib.parse"), + MovedAttribute("quote_plus", "urllib", "urllib.parse"), + MovedAttribute("unquote", "urllib", "urllib.parse"), + MovedAttribute("unquote_plus", "urllib", "urllib.parse"), + MovedAttribute( + "unquote_to_bytes", "urllib", "urllib.parse", "unquote", "unquote_to_bytes" + ), + MovedAttribute("urlencode", "urllib", "urllib.parse"), + MovedAttribute("splitquery", "urllib", "urllib.parse"), + MovedAttribute("splittag", "urllib", "urllib.parse"), + MovedAttribute("splituser", "urllib", "urllib.parse"), + MovedAttribute("splitvalue", "urllib", "urllib.parse"), + MovedAttribute("uses_fragment", "urlparse", "urllib.parse"), + MovedAttribute("uses_netloc", "urlparse", "urllib.parse"), + MovedAttribute("uses_params", "urlparse", "urllib.parse"), + MovedAttribute("uses_query", "urlparse", "urllib.parse"), + MovedAttribute("uses_relative", "urlparse", "urllib.parse"), +] +for attr in _urllib_parse_moved_attributes: + setattr(Module_six_moves_urllib_parse, attr.name, attr) +del attr + +Module_six_moves_urllib_parse._moved_attributes = _urllib_parse_moved_attributes + +_importer._add_module( + Module_six_moves_urllib_parse(__name__ + ".moves.urllib_parse"), + "moves.urllib_parse", + "moves.urllib.parse", +) + + +class Module_six_moves_urllib_error(_LazyModule): + + """Lazy loading of moved objects in six.moves.urllib_error""" + + +_urllib_error_moved_attributes = [ + MovedAttribute("URLError", "urllib2", "urllib.error"), + MovedAttribute("HTTPError", "urllib2", "urllib.error"), + MovedAttribute("ContentTooShortError", "urllib", "urllib.error"), +] +for attr in _urllib_error_moved_attributes: + setattr(Module_six_moves_urllib_error, attr.name, attr) +del attr + +Module_six_moves_urllib_error._moved_attributes = _urllib_error_moved_attributes + +_importer._add_module( + Module_six_moves_urllib_error(__name__ + ".moves.urllib.error"), + "moves.urllib_error", + "moves.urllib.error", +) + + +class Module_six_moves_urllib_request(_LazyModule): + + """Lazy loading of moved objects in six.moves.urllib_request""" + + +_urllib_request_moved_attributes = [ + MovedAttribute("urlopen", "urllib2", "urllib.request"), + MovedAttribute("install_opener", "urllib2", "urllib.request"), + MovedAttribute("build_opener", "urllib2", "urllib.request"), + MovedAttribute("pathname2url", "urllib", "urllib.request"), + MovedAttribute("url2pathname", "urllib", "urllib.request"), + MovedAttribute("getproxies", "urllib", "urllib.request"), + MovedAttribute("Request", "urllib2", "urllib.request"), + MovedAttribute("OpenerDirector", "urllib2", "urllib.request"), + MovedAttribute("HTTPDefaultErrorHandler", "urllib2", "urllib.request"), + MovedAttribute("HTTPRedirectHandler", "urllib2", "urllib.request"), + MovedAttribute("HTTPCookieProcessor", "urllib2", "urllib.request"), + MovedAttribute("ProxyHandler", "urllib2", "urllib.request"), + MovedAttribute("BaseHandler", "urllib2", "urllib.request"), + MovedAttribute("HTTPPasswordMgr", "urllib2", "urllib.request"), + MovedAttribute("HTTPPasswordMgrWithDefaultRealm", "urllib2", "urllib.request"), + MovedAttribute("AbstractBasicAuthHandler", "urllib2", "urllib.request"), + MovedAttribute("HTTPBasicAuthHandler", "urllib2", "urllib.request"), + MovedAttribute("ProxyBasicAuthHandler", "urllib2", "urllib.request"), + MovedAttribute("AbstractDigestAuthHandler", "urllib2", "urllib.request"), + MovedAttribute("HTTPDigestAuthHandler", "urllib2", "urllib.request"), + MovedAttribute("ProxyDigestAuthHandler", "urllib2", "urllib.request"), + MovedAttribute("HTTPHandler", "urllib2", "urllib.request"), + MovedAttribute("HTTPSHandler", "urllib2", "urllib.request"), + MovedAttribute("FileHandler", "urllib2", "urllib.request"), + MovedAttribute("FTPHandler", "urllib2", "urllib.request"), + MovedAttribute("CacheFTPHandler", "urllib2", "urllib.request"), + MovedAttribute("UnknownHandler", "urllib2", "urllib.request"), + MovedAttribute("HTTPErrorProcessor", "urllib2", "urllib.request"), + MovedAttribute("urlretrieve", "urllib", "urllib.request"), + MovedAttribute("urlcleanup", "urllib", "urllib.request"), + MovedAttribute("URLopener", "urllib", "urllib.request"), + MovedAttribute("FancyURLopener", "urllib", "urllib.request"), + MovedAttribute("proxy_bypass", "urllib", "urllib.request"), + MovedAttribute("parse_http_list", "urllib2", "urllib.request"), + MovedAttribute("parse_keqv_list", "urllib2", "urllib.request"), +] +for attr in _urllib_request_moved_attributes: + setattr(Module_six_moves_urllib_request, attr.name, attr) +del attr + +Module_six_moves_urllib_request._moved_attributes = _urllib_request_moved_attributes + +_importer._add_module( + Module_six_moves_urllib_request(__name__ + ".moves.urllib.request"), + "moves.urllib_request", + "moves.urllib.request", +) + + +class Module_six_moves_urllib_response(_LazyModule): + + """Lazy loading of moved objects in six.moves.urllib_response""" + + +_urllib_response_moved_attributes = [ + MovedAttribute("addbase", "urllib", "urllib.response"), + MovedAttribute("addclosehook", "urllib", "urllib.response"), + MovedAttribute("addinfo", "urllib", "urllib.response"), + MovedAttribute("addinfourl", "urllib", "urllib.response"), +] +for attr in _urllib_response_moved_attributes: + setattr(Module_six_moves_urllib_response, attr.name, attr) +del attr + +Module_six_moves_urllib_response._moved_attributes = _urllib_response_moved_attributes + +_importer._add_module( + Module_six_moves_urllib_response(__name__ + ".moves.urllib.response"), + "moves.urllib_response", + "moves.urllib.response", +) + + +class Module_six_moves_urllib_robotparser(_LazyModule): + + """Lazy loading of moved objects in six.moves.urllib_robotparser""" + + +_urllib_robotparser_moved_attributes = [ + MovedAttribute("RobotFileParser", "robotparser", "urllib.robotparser"), +] +for attr in _urllib_robotparser_moved_attributes: + setattr(Module_six_moves_urllib_robotparser, attr.name, attr) +del attr + +Module_six_moves_urllib_robotparser._moved_attributes = ( + _urllib_robotparser_moved_attributes +) + +_importer._add_module( + Module_six_moves_urllib_robotparser(__name__ + ".moves.urllib.robotparser"), + "moves.urllib_robotparser", + "moves.urllib.robotparser", +) + + +class Module_six_moves_urllib(types.ModuleType): + + """Create a six.moves.urllib namespace that resembles the Python 3 namespace""" + + __path__ = [] # mark as package + parse = _importer._get_module("moves.urllib_parse") + error = _importer._get_module("moves.urllib_error") + request = _importer._get_module("moves.urllib_request") + response = _importer._get_module("moves.urllib_response") + robotparser = _importer._get_module("moves.urllib_robotparser") + + def __dir__(self): + return ["parse", "error", "request", "response", "robotparser"] + + +_importer._add_module( + Module_six_moves_urllib(__name__ + ".moves.urllib"), "moves.urllib" +) + + +def add_move(move): + """Add an item to six.moves.""" + setattr(_MovedItems, move.name, move) + + +def remove_move(name): + """Remove item from six.moves.""" + try: + delattr(_MovedItems, name) + except AttributeError: + try: + del moves.__dict__[name] + except KeyError: + raise AttributeError("no such move, %r" % (name,)) + + +if PY3: + _meth_func = "__func__" + _meth_self = "__self__" + + _func_closure = "__closure__" + _func_code = "__code__" + _func_defaults = "__defaults__" + _func_globals = "__globals__" +else: + _meth_func = "im_func" + _meth_self = "im_self" + + _func_closure = "func_closure" + _func_code = "func_code" + _func_defaults = "func_defaults" + _func_globals = "func_globals" + + +try: + advance_iterator = next +except NameError: + + def advance_iterator(it): + return it.next() + + +next = advance_iterator + + +try: + callable = callable +except NameError: + + def callable(obj): + return any("__call__" in klass.__dict__ for klass in type(obj).__mro__) + + +if PY3: + + def get_unbound_function(unbound): + return unbound + + create_bound_method = types.MethodType + + def create_unbound_method(func, cls): + return func + + Iterator = object +else: + + def get_unbound_function(unbound): + return unbound.im_func + + def create_bound_method(func, obj): + return types.MethodType(func, obj, obj.__class__) + + def create_unbound_method(func, cls): + return types.MethodType(func, None, cls) + + class Iterator(object): + def next(self): + return type(self).__next__(self) + + callable = callable +_add_doc( + get_unbound_function, """Get the function out of a possibly unbound function""" +) + + +get_method_function = operator.attrgetter(_meth_func) +get_method_self = operator.attrgetter(_meth_self) +get_function_closure = operator.attrgetter(_func_closure) +get_function_code = operator.attrgetter(_func_code) +get_function_defaults = operator.attrgetter(_func_defaults) +get_function_globals = operator.attrgetter(_func_globals) + + +if PY3: + + def iterkeys(d, **kw): + return iter(d.keys(**kw)) + + def itervalues(d, **kw): + return iter(d.values(**kw)) + + def iteritems(d, **kw): + return iter(d.items(**kw)) + + def iterlists(d, **kw): + return iter(d.lists(**kw)) + + viewkeys = operator.methodcaller("keys") + + viewvalues = operator.methodcaller("values") + + viewitems = operator.methodcaller("items") +else: + + def iterkeys(d, **kw): + return d.iterkeys(**kw) + + def itervalues(d, **kw): + return d.itervalues(**kw) + + def iteritems(d, **kw): + return d.iteritems(**kw) + + def iterlists(d, **kw): + return d.iterlists(**kw) + + viewkeys = operator.methodcaller("viewkeys") + + viewvalues = operator.methodcaller("viewvalues") + + viewitems = operator.methodcaller("viewitems") + +_add_doc(iterkeys, "Return an iterator over the keys of a dictionary.") +_add_doc(itervalues, "Return an iterator over the values of a dictionary.") +_add_doc(iteritems, "Return an iterator over the (key, value) pairs of a dictionary.") +_add_doc( + iterlists, "Return an iterator over the (key, [values]) pairs of a dictionary." +) + + +if PY3: + + def b(s): + return s.encode("latin-1") + + def u(s): + return s + + unichr = chr + import struct + + int2byte = struct.Struct(">B").pack + del struct + byte2int = operator.itemgetter(0) + indexbytes = operator.getitem + iterbytes = iter + import io + + StringIO = io.StringIO + BytesIO = io.BytesIO + del io + _assertCountEqual = "assertCountEqual" + if sys.version_info[1] <= 1: + _assertRaisesRegex = "assertRaisesRegexp" + _assertRegex = "assertRegexpMatches" + _assertNotRegex = "assertNotRegexpMatches" + else: + _assertRaisesRegex = "assertRaisesRegex" + _assertRegex = "assertRegex" + _assertNotRegex = "assertNotRegex" +else: + + def b(s): + return s + + # Workaround for standalone backslash + + def u(s): + return unicode(s.replace(r"\\", r"\\\\"), "unicode_escape") + + unichr = unichr + int2byte = chr + + def byte2int(bs): + return ord(bs[0]) + + def indexbytes(buf, i): + return ord(buf[i]) + + iterbytes = functools.partial(itertools.imap, ord) + import StringIO + + StringIO = BytesIO = StringIO.StringIO + _assertCountEqual = "assertItemsEqual" + _assertRaisesRegex = "assertRaisesRegexp" + _assertRegex = "assertRegexpMatches" + _assertNotRegex = "assertNotRegexpMatches" +_add_doc(b, """Byte literal""") +_add_doc(u, """Text literal""") + + +def assertCountEqual(self, *args, **kwargs): + return getattr(self, _assertCountEqual)(*args, **kwargs) + + +def assertRaisesRegex(self, *args, **kwargs): + return getattr(self, _assertRaisesRegex)(*args, **kwargs) + + +def assertRegex(self, *args, **kwargs): + return getattr(self, _assertRegex)(*args, **kwargs) + + +def assertNotRegex(self, *args, **kwargs): + return getattr(self, _assertNotRegex)(*args, **kwargs) + + +if PY3: + exec_ = getattr(moves.builtins, "exec") + + def reraise(tp, value, tb=None): + try: + if value is None: + value = tp() + if value.__traceback__ is not tb: + raise value.with_traceback(tb) + raise value + finally: + value = None + tb = None + +else: + + def exec_(_code_, _globs_=None, _locs_=None): + """Execute code in a namespace.""" + if _globs_ is None: + frame = sys._getframe(1) + _globs_ = frame.f_globals + if _locs_ is None: + _locs_ = frame.f_locals + del frame + elif _locs_ is None: + _locs_ = _globs_ + exec ("""exec _code_ in _globs_, _locs_""") + + exec_( + """def reraise(tp, value, tb=None): + try: + raise tp, value, tb + finally: + tb = None +""" + ) + + +if sys.version_info[:2] > (3,): + exec_( + """def raise_from(value, from_value): + try: + raise value from from_value + finally: + value = None +""" + ) +else: + + def raise_from(value, from_value): + raise value + + +print_ = getattr(moves.builtins, "print", None) +if print_ is None: + + def print_(*args, **kwargs): + """The new-style print function for Python 2.4 and 2.5.""" + fp = kwargs.pop("file", sys.stdout) + if fp is None: + return + + def write(data): + if not isinstance(data, basestring): + data = str(data) + # If the file has an encoding, encode unicode with it. + if ( + isinstance(fp, file) + and isinstance(data, unicode) + and fp.encoding is not None + ): + errors = getattr(fp, "errors", None) + if errors is None: + errors = "strict" + data = data.encode(fp.encoding, errors) + fp.write(data) + + want_unicode = False + sep = kwargs.pop("sep", None) + if sep is not None: + if isinstance(sep, unicode): + want_unicode = True + elif not isinstance(sep, str): + raise TypeError("sep must be None or a string") + end = kwargs.pop("end", None) + if end is not None: + if isinstance(end, unicode): + want_unicode = True + elif not isinstance(end, str): + raise TypeError("end must be None or a string") + if kwargs: + raise TypeError("invalid keyword arguments to print()") + if not want_unicode: + for arg in args: + if isinstance(arg, unicode): + want_unicode = True + break + if want_unicode: + newline = unicode("\n") + space = unicode(" ") + else: + newline = "\n" + space = " " + if sep is None: + sep = space + if end is None: + end = newline + for i, arg in enumerate(args): + if i: + write(sep) + write(arg) + write(end) + + +if sys.version_info[:2] < (3, 3): + _print = print_ + + def print_(*args, **kwargs): + fp = kwargs.get("file", sys.stdout) + flush = kwargs.pop("flush", False) + _print(*args, **kwargs) + if flush and fp is not None: + fp.flush() + + +_add_doc(reraise, """Reraise an exception.""") + +if sys.version_info[0:2] < (3, 4): + # This does exactly the same what the :func:`py3:functools.update_wrapper` + # function does on Python versions after 3.2. It sets the ``__wrapped__`` + # attribute on ``wrapper`` object and it doesn't raise an error if any of + # the attributes mentioned in ``assigned`` and ``updated`` are missing on + # ``wrapped`` object. + def _update_wrapper( + wrapper, + wrapped, + assigned=functools.WRAPPER_ASSIGNMENTS, + updated=functools.WRAPPER_UPDATES, + ): + for attr in assigned: + try: + value = getattr(wrapped, attr) + except AttributeError: + continue + else: + setattr(wrapper, attr, value) + for attr in updated: + getattr(wrapper, attr).update(getattr(wrapped, attr, {})) + wrapper.__wrapped__ = wrapped + return wrapper + + _update_wrapper.__doc__ = functools.update_wrapper.__doc__ + + def wraps( + wrapped, + assigned=functools.WRAPPER_ASSIGNMENTS, + updated=functools.WRAPPER_UPDATES, + ): + return functools.partial( + _update_wrapper, wrapped=wrapped, assigned=assigned, updated=updated + ) + + wraps.__doc__ = functools.wraps.__doc__ + +else: + wraps = functools.wraps + + +def with_metaclass(meta, *bases): + """Create a base class with a metaclass.""" + # This requires a bit of explanation: the basic idea is to make a dummy + # metaclass for one level of class instantiation that replaces itself with + # the actual metaclass. + class metaclass(type): + def __new__(cls, name, this_bases, d): + if sys.version_info[:2] >= (3, 7): + # This version introduced PEP 560 that requires a bit + # of extra care (we mimic what is done by __build_class__). + resolved_bases = types.resolve_bases(bases) + if resolved_bases is not bases: + d["__orig_bases__"] = bases + else: + resolved_bases = bases + return meta(name, resolved_bases, d) + + @classmethod + def __prepare__(cls, name, this_bases): + return meta.__prepare__(name, bases) + + return type.__new__(metaclass, "temporary_class", (), {}) + + +def add_metaclass(metaclass): + """Class decorator for creating a class with a metaclass.""" + + def wrapper(cls): + orig_vars = cls.__dict__.copy() + slots = orig_vars.get("__slots__") + if slots is not None: + if isinstance(slots, str): + slots = [slots] + for slots_var in slots: + orig_vars.pop(slots_var) + orig_vars.pop("__dict__", None) + orig_vars.pop("__weakref__", None) + if hasattr(cls, "__qualname__"): + orig_vars["__qualname__"] = cls.__qualname__ + return metaclass(cls.__name__, cls.__bases__, orig_vars) + + return wrapper + + +def ensure_binary(s, encoding="utf-8", errors="strict"): + """Coerce **s** to six.binary_type. + + For Python 2: + - `unicode` -> encoded to `str` + - `str` -> `str` + + For Python 3: + - `str` -> encoded to `bytes` + - `bytes` -> `bytes` + """ + if isinstance(s, binary_type): + return s + if isinstance(s, text_type): + return s.encode(encoding, errors) + raise TypeError("not expecting type '%s'" % type(s)) + + +def ensure_str(s, encoding="utf-8", errors="strict"): + """Coerce *s* to `str`. + + For Python 2: + - `unicode` -> encoded to `str` + - `str` -> `str` + + For Python 3: + - `str` -> `str` + - `bytes` -> decoded to `str` + """ + # Optimization: Fast return for the common case. + if type(s) is str: + return s + if PY2 and isinstance(s, text_type): + return s.encode(encoding, errors) + elif PY3 and isinstance(s, binary_type): + return s.decode(encoding, errors) + elif not isinstance(s, (text_type, binary_type)): + raise TypeError("not expecting type '%s'" % type(s)) + return s + + +def ensure_text(s, encoding="utf-8", errors="strict"): + """Coerce *s* to six.text_type. + + For Python 2: + - `unicode` -> `unicode` + - `str` -> `unicode` + + For Python 3: + - `str` -> `str` + - `bytes` -> decoded to `str` + """ + if isinstance(s, binary_type): + return s.decode(encoding, errors) + elif isinstance(s, text_type): + return s + else: + raise TypeError("not expecting type '%s'" % type(s)) + + +def python_2_unicode_compatible(klass): + """ + A class decorator that defines __unicode__ and __str__ methods under Python 2. + Under Python 3 it does nothing. + + To support Python 2 and 3 with a single code base, define a __str__ method + returning text and apply this decorator to the class. + """ + if PY2: + if "__str__" not in klass.__dict__: + raise ValueError( + "@python_2_unicode_compatible cannot be applied " + "to %s because it doesn't define __str__()." % klass.__name__ + ) + klass.__unicode__ = klass.__str__ + klass.__str__ = lambda self: self.__unicode__().encode("utf-8") + return klass + + +# Complete the moves implementation. +# This code is at the end of this module to speed up module loading. +# Turn this module into a package. +__path__ = [] # required for PEP 302 and PEP 451 +__package__ = __name__ # see PEP 366 @ReservedAssignment +if globals().get("__spec__") is not None: + __spec__.submodule_search_locations = [] # PEP 451 @UndefinedVariable +# Remove other six meta path importers, since they cause problems. This can +# happen if six is removed from sys.modules and then reloaded. (Setuptools does +# this for some reason.) +if sys.meta_path: + for i, importer in enumerate(sys.meta_path): + # Here's some real nastiness: Another "instance" of the six module might + # be floating around. Therefore, we can't use isinstance() to check for + # the six meta path importer, since the other six instance will have + # inserted an importer with different class. + if ( + type(importer).__name__ == "_SixMetaPathImporter" + and importer.name == __name__ + ): + del sys.meta_path[i] + break + del i, importer +# Finally, add the importer to the meta path import hook. +sys.meta_path.append(_importer) diff --git a/newrelic/packages/urllib3/poolmanager.py b/newrelic/packages/urllib3/poolmanager.py index 28ec82f016..fb51bf7d96 100644 --- a/newrelic/packages/urllib3/poolmanager.py +++ b/newrelic/packages/urllib3/poolmanager.py @@ -1,33 +1,24 @@ -from __future__ import annotations +from __future__ import absolute_import +import collections import functools import logging -import typing -import warnings -from types import TracebackType -from urllib.parse import urljoin from ._collections import HTTPHeaderDict, RecentlyUsedContainer -from ._request_methods import RequestMethods -from .connection import ProxyConfig from .connectionpool import HTTPConnectionPool, HTTPSConnectionPool, port_by_scheme from .exceptions import ( LocationValueError, MaxRetryError, ProxySchemeUnknown, + ProxySchemeUnsupported, URLSchemeUnknown, ) -from .response import BaseHTTPResponse -from .util.connection import _TYPE_SOCKET_OPTIONS +from .packages import six +from .packages.six.moves.urllib.parse import urljoin +from .request import RequestMethods from .util.proxy import connection_requires_http_tunnel from .util.retry import Retry -from .util.timeout import Timeout -from .util.url import Url, parse_url - -if typing.TYPE_CHECKING: - import ssl - - from typing_extensions import Self +from .util.url import parse_url __all__ = ["PoolManager", "ProxyManager", "proxy_from_url"] @@ -39,62 +30,53 @@ "cert_file", "cert_reqs", "ca_certs", - "ca_cert_data", "ssl_version", - "ssl_minimum_version", - "ssl_maximum_version", "ca_cert_dir", "ssl_context", "key_password", "server_hostname", ) -# Default value for `blocksize` - a new parameter introduced to -# http.client.HTTPConnection & http.client.HTTPSConnection in Python 3.7 -_DEFAULT_BLOCKSIZE = 16384 +# All known keyword arguments that could be provided to the pool manager, its +# pools, or the underlying connections. This is used to construct a pool key. +_key_fields = ( + "key_scheme", # str + "key_host", # str + "key_port", # int + "key_timeout", # int or float or Timeout + "key_retries", # int or Retry + "key_strict", # bool + "key_block", # bool + "key_source_address", # str + "key_key_file", # str + "key_key_password", # str + "key_cert_file", # str + "key_cert_reqs", # str + "key_ca_certs", # str + "key_ssl_version", # str + "key_ca_cert_dir", # str + "key_ssl_context", # instance of ssl.SSLContext or urllib3.util.ssl_.SSLContext + "key_maxsize", # int + "key_headers", # dict + "key__proxy", # parsed proxy url + "key__proxy_headers", # dict + "key__proxy_config", # class + "key_socket_options", # list of (level (int), optname (int), value (int or str)) tuples + "key__socks_options", # dict + "key_assert_hostname", # bool or string + "key_assert_fingerprint", # str + "key_server_hostname", # str +) + +#: The namedtuple class used to construct keys for the connection pool. +#: All custom key schemes should include the fields in this key at a minimum. +PoolKey = collections.namedtuple("PoolKey", _key_fields) -class PoolKey(typing.NamedTuple): - """ - All known keyword arguments that could be provided to the pool manager, its - pools, or the underlying connections. +_proxy_config_fields = ("ssl_context", "use_forwarding_for_https") +ProxyConfig = collections.namedtuple("ProxyConfig", _proxy_config_fields) - All custom key schemes should include the fields in this key at a minimum. - """ - key_scheme: str - key_host: str - key_port: int | None - key_timeout: Timeout | float | int | None - key_retries: Retry | bool | int | None - key_block: bool | None - key_source_address: tuple[str, int] | None - key_key_file: str | None - key_key_password: str | None - key_cert_file: str | None - key_cert_reqs: str | None - key_ca_certs: str | None - key_ca_cert_data: str | bytes | None - key_ssl_version: int | str | None - key_ssl_minimum_version: ssl.TLSVersion | None - key_ssl_maximum_version: ssl.TLSVersion | None - key_ca_cert_dir: str | None - key_ssl_context: ssl.SSLContext | None - key_maxsize: int | None - key_headers: frozenset[tuple[str, str]] | None - key__proxy: Url | None - key__proxy_headers: frozenset[tuple[str, str]] | None - key__proxy_config: ProxyConfig | None - key_socket_options: _TYPE_SOCKET_OPTIONS | None - key__socks_options: frozenset[tuple[str, str]] | None - key_assert_hostname: bool | str | None - key_assert_fingerprint: str | None - key_server_hostname: str | None - key_blocksize: int | None - - -def _default_key_normalizer( - key_class: type[PoolKey], request_context: dict[str, typing.Any] -) -> PoolKey: +def _default_key_normalizer(key_class, request_context): """ Create a pool key out of a request context dictionary. @@ -140,10 +122,6 @@ def _default_key_normalizer( if field not in context: context[field] = None - # Default key_blocksize to _DEFAULT_BLOCKSIZE if missing from the context - if context.get("key_blocksize") is None: - context["key_blocksize"] = _DEFAULT_BLOCKSIZE - return key_class(**context) @@ -176,50 +154,23 @@ class PoolManager(RequestMethods): Additional parameters are used to create fresh :class:`urllib3.connectionpool.ConnectionPool` instances. - Example: - - .. code-block:: python - - import urllib3 - - http = urllib3.PoolManager(num_pools=2) + Example:: - resp1 = http.request("GET", "https://google.com/") - resp2 = http.request("GET", "https://google.com/mail") - resp3 = http.request("GET", "https://yahoo.com/") - - print(len(http.pools)) - # 2 + >>> manager = PoolManager(num_pools=2) + >>> r = manager.request('GET', 'http://google.com/') + >>> r = manager.request('GET', 'http://google.com/mail') + >>> r = manager.request('GET', 'http://yahoo.com/') + >>> len(manager.pools) + 2 """ - proxy: Url | None = None - proxy_config: ProxyConfig | None = None + proxy = None + proxy_config = None - def __init__( - self, - num_pools: int = 10, - headers: typing.Mapping[str, str] | None = None, - **connection_pool_kw: typing.Any, - ) -> None: - super().__init__(headers) - # PoolManager handles redirects itself in PoolManager.urlopen(). - # It always passes redirect=False to the underlying connection pool to - # suppress per-pool redirect handling. If the user supplied a non-Retry - # value (int/bool/etc) for retries and we let the pool normalize it - # while redirect=False, the resulting Retry object would have redirect - # handling disabled, which can interfere with PoolManager's own - # redirect logic. Normalize here so redirects remain governed solely by - # PoolManager logic. - if "retries" in connection_pool_kw: - retries = connection_pool_kw["retries"] - if not isinstance(retries, Retry): - retries = Retry.from_int(retries) - connection_pool_kw = connection_pool_kw.copy() - connection_pool_kw["retries"] = retries + def __init__(self, num_pools=10, headers=None, **connection_pool_kw): + RequestMethods.__init__(self, headers) self.connection_pool_kw = connection_pool_kw - - self.pools: RecentlyUsedContainer[PoolKey, HTTPConnectionPool] self.pools = RecentlyUsedContainer(num_pools) # Locally set the pool classes and keys so other PoolManagers can @@ -227,26 +178,15 @@ def __init__( self.pool_classes_by_scheme = pool_classes_by_scheme self.key_fn_by_scheme = key_fn_by_scheme.copy() - def __enter__(self) -> Self: + def __enter__(self): return self - def __exit__( - self, - exc_type: type[BaseException] | None, - exc_val: BaseException | None, - exc_tb: TracebackType | None, - ) -> typing.Literal[False]: + def __exit__(self, exc_type, exc_val, exc_tb): self.clear() # Return False to re-raise any potential exceptions return False - def _new_pool( - self, - scheme: str, - host: str, - port: int, - request_context: dict[str, typing.Any] | None = None, - ) -> HTTPConnectionPool: + def _new_pool(self, scheme, host, port, request_context=None): """ Create a new :class:`urllib3.connectionpool.ConnectionPool` based on host, port, scheme, and any additional pool keyword arguments. @@ -256,15 +196,10 @@ def _new_pool( connection pools handed out by :meth:`connection_from_url` and companion methods. It is intended to be overridden for customization. """ - pool_cls: type[HTTPConnectionPool] = self.pool_classes_by_scheme[scheme] + pool_cls = self.pool_classes_by_scheme[scheme] if request_context is None: request_context = self.connection_pool_kw.copy() - # Default blocksize to _DEFAULT_BLOCKSIZE if missing or explicitly - # set to 'None' in the request_context. - if request_context.get("blocksize") is None: - request_context["blocksize"] = _DEFAULT_BLOCKSIZE - # Although the context has everything necessary to create the pool, # this function has historically only used the scheme, host, and port # in the positional args. When an API change is acceptable these can @@ -278,7 +213,7 @@ def _new_pool( return pool_cls(host, port, **request_context) - def clear(self) -> None: + def clear(self): """ Empty our store of pools and direct them all to close. @@ -287,13 +222,7 @@ def clear(self) -> None: """ self.pools.clear() - def connection_from_host( - self, - host: str | None, - port: int | None = None, - scheme: str | None = "http", - pool_kwargs: dict[str, typing.Any] | None = None, - ) -> HTTPConnectionPool: + def connection_from_host(self, host, port=None, scheme="http", pool_kwargs=None): """ Get a :class:`urllib3.connectionpool.ConnectionPool` based on the host, port, and scheme. @@ -316,23 +245,13 @@ def connection_from_host( return self.connection_from_context(request_context) - def connection_from_context( - self, request_context: dict[str, typing.Any] - ) -> HTTPConnectionPool: + def connection_from_context(self, request_context): """ Get a :class:`urllib3.connectionpool.ConnectionPool` based on the request context. ``request_context`` must at least contain the ``scheme`` key and its value must be a key in ``key_fn_by_scheme`` instance variable. """ - if "strict" in request_context: - warnings.warn( - "The 'strict' parameter is no longer needed on Python 3+. " - "This will raise an error in urllib3 v2.1.0.", - DeprecationWarning, - ) - request_context.pop("strict") - scheme = request_context["scheme"].lower() pool_key_constructor = self.key_fn_by_scheme.get(scheme) if not pool_key_constructor: @@ -341,9 +260,7 @@ def connection_from_context( return self.connection_from_pool_key(pool_key, request_context=request_context) - def connection_from_pool_key( - self, pool_key: PoolKey, request_context: dict[str, typing.Any] - ) -> HTTPConnectionPool: + def connection_from_pool_key(self, pool_key, request_context=None): """ Get a :class:`urllib3.connectionpool.ConnectionPool` based on the provided pool key. @@ -367,9 +284,7 @@ def connection_from_pool_key( return pool - def connection_from_url( - self, url: str, pool_kwargs: dict[str, typing.Any] | None = None - ) -> HTTPConnectionPool: + def connection_from_url(self, url, pool_kwargs=None): """ Similar to :func:`urllib3.connectionpool.connection_from_url`. @@ -385,9 +300,7 @@ def connection_from_url( u.host, port=u.port, scheme=u.scheme, pool_kwargs=pool_kwargs ) - def _merge_pool_kwargs( - self, override: dict[str, typing.Any] | None - ) -> dict[str, typing.Any]: + def _merge_pool_kwargs(self, override): """ Merge a dictionary of override values for self.connection_pool_kw. @@ -407,7 +320,7 @@ def _merge_pool_kwargs( base_pool_kwargs[key] = value return base_pool_kwargs - def _proxy_requires_url_absolute_form(self, parsed_url: Url) -> bool: + def _proxy_requires_url_absolute_form(self, parsed_url): """ Indicates if the proxy requires the complete destination URL in the request. Normally this is only needed when not using an HTTP CONNECT @@ -420,9 +333,24 @@ def _proxy_requires_url_absolute_form(self, parsed_url: Url) -> bool: self.proxy, self.proxy_config, parsed_url.scheme ) - def urlopen( # type: ignore[override] - self, method: str, url: str, redirect: bool = True, **kw: typing.Any - ) -> BaseHTTPResponse: + def _validate_proxy_scheme_url_selection(self, url_scheme): + """ + Validates that were not attempting to do TLS in TLS connections on + Python2 or with unsupported SSL implementations. + """ + if self.proxy is None or url_scheme != "https": + return + + if self.proxy.scheme != "https": + return + + if six.PY2 and not self.proxy_config.use_forwarding_for_https: + raise ProxySchemeUnsupported( + "Contacting HTTPS destinations through HTTPS proxies " + "'via CONNECT tunnels' is not supported in Python 2" + ) + + def urlopen(self, method, url, redirect=True, **kw): """ Same as :meth:`urllib3.HTTPConnectionPool.urlopen` with custom cross-host redirect logic and only sends the request-uri @@ -432,16 +360,7 @@ def urlopen( # type: ignore[override] :class:`urllib3.connectionpool.ConnectionPool` can be chosen for it. """ u = parse_url(url) - - if u.scheme is None: - warnings.warn( - "URLs without a scheme (ie 'https://') are deprecated and will raise an error " - "in a future version of urllib3. To avoid this DeprecationWarning ensure all URLs " - "start with 'https://' or 'http://'. Read more in this issue: " - "https://github.com/urllib3/urllib3/issues/2920", - category=DeprecationWarning, - stacklevel=2, - ) + self._validate_proxy_scheme_url_selection(u.scheme) conn = self.connection_from_host(u.host, port=u.port, scheme=u.scheme) @@ -449,7 +368,7 @@ def urlopen( # type: ignore[override] kw["redirect"] = False if "headers" not in kw: - kw["headers"] = self.headers + kw["headers"] = self.headers.copy() if self._proxy_requires_url_absolute_form(u): response = conn.urlopen(method, url, **kw) @@ -470,7 +389,7 @@ def urlopen( # type: ignore[override] kw["body"] = None kw["headers"] = HTTPHeaderDict(kw["headers"])._prepare_for_method_change() - retries = kw.get("retries", response.retries) + retries = kw.get("retries") if not isinstance(retries, Retry): retries = Retry.from_int(retries, redirect=redirect) @@ -480,11 +399,10 @@ def urlopen( # type: ignore[override] if retries.remove_headers_on_redirect and not conn.is_same_host( redirect_location ): - new_headers = kw["headers"].copy() - for header in kw["headers"]: + headers = list(six.iterkeys(kw["headers"])) + for header in headers: if header.lower() in retries.remove_headers_on_redirect: - new_headers.pop(header, None) - kw["headers"] = new_headers + kw["headers"].pop(header, None) try: retries = retries.increment(method, url, response=response, _pool=conn) @@ -530,51 +448,37 @@ class ProxyManager(PoolManager): private. IP address, target hostname, SNI, and port are always visible to an HTTPS proxy even when this flag is disabled. - :param proxy_assert_hostname: - The hostname of the certificate to verify against. - - :param proxy_assert_fingerprint: - The fingerprint of the certificate to verify against. - Example: - - .. code-block:: python - - import urllib3 - - proxy = urllib3.ProxyManager("https://localhost:3128/") - - resp1 = proxy.request("GET", "https://google.com/") - resp2 = proxy.request("GET", "https://httpbin.org/") - - print(len(proxy.pools)) - # 1 - - resp3 = proxy.request("GET", "https://httpbin.org/") - resp4 = proxy.request("GET", "https://twitter.com/") - - print(len(proxy.pools)) - # 3 + >>> proxy = urllib3.ProxyManager('http://localhost:3128/') + >>> r1 = proxy.request('GET', 'http://google.com/') + >>> r2 = proxy.request('GET', 'http://httpbin.org/') + >>> len(proxy.pools) + 1 + >>> r3 = proxy.request('GET', 'https://httpbin.org/') + >>> r4 = proxy.request('GET', 'https://twitter.com/') + >>> len(proxy.pools) + 3 """ def __init__( self, - proxy_url: str, - num_pools: int = 10, - headers: typing.Mapping[str, str] | None = None, - proxy_headers: typing.Mapping[str, str] | None = None, - proxy_ssl_context: ssl.SSLContext | None = None, - use_forwarding_for_https: bool = False, - proxy_assert_hostname: None | str | typing.Literal[False] = None, - proxy_assert_fingerprint: str | None = None, - **connection_pool_kw: typing.Any, - ) -> None: + proxy_url, + num_pools=10, + headers=None, + proxy_headers=None, + proxy_ssl_context=None, + use_forwarding_for_https=False, + **connection_pool_kw + ): + if isinstance(proxy_url, HTTPConnectionPool): - str_proxy_url = f"{proxy_url.scheme}://{proxy_url.host}:{proxy_url.port}" - else: - str_proxy_url = proxy_url - proxy = parse_url(str_proxy_url) + proxy_url = "%s://%s:%i" % ( + proxy_url.scheme, + proxy_url.host, + proxy_url.port, + ) + proxy = parse_url(proxy_url) if proxy.scheme not in ("http", "https"): raise ProxySchemeUnknown(proxy.scheme) @@ -586,38 +490,25 @@ def __init__( self.proxy = proxy self.proxy_headers = proxy_headers or {} self.proxy_ssl_context = proxy_ssl_context - self.proxy_config = ProxyConfig( - proxy_ssl_context, - use_forwarding_for_https, - proxy_assert_hostname, - proxy_assert_fingerprint, - ) + self.proxy_config = ProxyConfig(proxy_ssl_context, use_forwarding_for_https) connection_pool_kw["_proxy"] = self.proxy connection_pool_kw["_proxy_headers"] = self.proxy_headers connection_pool_kw["_proxy_config"] = self.proxy_config - super().__init__(num_pools, headers, **connection_pool_kw) + super(ProxyManager, self).__init__(num_pools, headers, **connection_pool_kw) - def connection_from_host( - self, - host: str | None, - port: int | None = None, - scheme: str | None = "http", - pool_kwargs: dict[str, typing.Any] | None = None, - ) -> HTTPConnectionPool: + def connection_from_host(self, host, port=None, scheme="http", pool_kwargs=None): if scheme == "https": - return super().connection_from_host( + return super(ProxyManager, self).connection_from_host( host, port, scheme, pool_kwargs=pool_kwargs ) - return super().connection_from_host( - self.proxy.host, self.proxy.port, self.proxy.scheme, pool_kwargs=pool_kwargs # type: ignore[union-attr] + return super(ProxyManager, self).connection_from_host( + self.proxy.host, self.proxy.port, self.proxy.scheme, pool_kwargs=pool_kwargs ) - def _set_proxy_headers( - self, url: str, headers: typing.Mapping[str, str] | None = None - ) -> typing.Mapping[str, str]: + def _set_proxy_headers(self, url, headers=None): """ Sets headers needed by proxies: specifically, the Accept and Host headers. Only sets headers not provided by the user. @@ -632,9 +523,7 @@ def _set_proxy_headers( headers_.update(headers) return headers_ - def urlopen( # type: ignore[override] - self, method: str, url: str, redirect: bool = True, **kw: typing.Any - ) -> BaseHTTPResponse: + def urlopen(self, method, url, redirect=True, **kw): "Same as HTTP(S)ConnectionPool.urlopen, ``url`` must be absolute." u = parse_url(url) if not connection_requires_http_tunnel(self.proxy, self.proxy_config, u.scheme): @@ -644,8 +533,8 @@ def urlopen( # type: ignore[override] headers = kw.get("headers", self.headers) kw["headers"] = self._set_proxy_headers(url, headers) - return super().urlopen(method, url, redirect=redirect, **kw) + return super(ProxyManager, self).urlopen(method, url, redirect=redirect, **kw) -def proxy_from_url(url: str, **kw: typing.Any) -> ProxyManager: +def proxy_from_url(url, **kw): return ProxyManager(proxy_url=url, **kw) diff --git a/newrelic/packages/urllib3/py.typed b/newrelic/packages/urllib3/py.typed deleted file mode 100644 index 5f3ea3d919..0000000000 --- a/newrelic/packages/urllib3/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Instruct type checkers to look for inline type annotations in this package. -# See PEP 561. diff --git a/newrelic/packages/urllib3/_request_methods.py b/newrelic/packages/urllib3/request.py similarity index 50% rename from newrelic/packages/urllib3/_request_methods.py rename to newrelic/packages/urllib3/request.py index 297c271bf4..3b4cf99922 100644 --- a/newrelic/packages/urllib3/_request_methods.py +++ b/newrelic/packages/urllib3/request.py @@ -1,23 +1,15 @@ -from __future__ import annotations +from __future__ import absolute_import -import json as _json -import typing -from urllib.parse import urlencode +import sys -from ._base_connection import _TYPE_BODY -from ._collections import HTTPHeaderDict -from .filepost import _TYPE_FIELDS, encode_multipart_formdata -from .response import BaseHTTPResponse +from .filepost import encode_multipart_formdata +from .packages import six +from .packages.six.moves.urllib.parse import urlencode __all__ = ["RequestMethods"] -_TYPE_ENCODE_URL_FIELDS = typing.Union[ - typing.Sequence[tuple[str, typing.Union[str, bytes]]], - typing.Mapping[str, typing.Union[str, bytes]], -] - -class RequestMethods: +class RequestMethods(object): """ Convenience mixin for classes who implement a :meth:`urlopen` method, such as :class:`urllib3.HTTPConnectionPool` and @@ -48,34 +40,25 @@ class RequestMethods: _encode_url_methods = {"DELETE", "GET", "HEAD", "OPTIONS"} - def __init__(self, headers: typing.Mapping[str, str] | None = None) -> None: + def __init__(self, headers=None): self.headers = headers or {} def urlopen( self, - method: str, - url: str, - body: _TYPE_BODY | None = None, - headers: typing.Mapping[str, str] | None = None, - encode_multipart: bool = True, - multipart_boundary: str | None = None, - **kw: typing.Any, - ) -> BaseHTTPResponse: # Abstract + method, + url, + body=None, + headers=None, + encode_multipart=True, + multipart_boundary=None, + **kw + ): # Abstract raise NotImplementedError( "Classes extending RequestMethods must implement " "their own ``urlopen`` method." ) - def request( - self, - method: str, - url: str, - body: _TYPE_BODY | None = None, - fields: _TYPE_FIELDS | None = None, - headers: typing.Mapping[str, str] | None = None, - json: typing.Any | None = None, - **urlopen_kw: typing.Any, - ) -> BaseHTTPResponse: + def request(self, method, url, fields=None, headers=None, **urlopen_kw): """ Make a request using :meth:`urlopen` with the appropriate encoding of ``fields`` based on the ``method`` used. @@ -85,95 +68,29 @@ def request( option to drop down to more specific methods when necessary, such as :meth:`request_encode_url`, :meth:`request_encode_body`, or even the lowest level :meth:`urlopen`. - - :param method: - HTTP request method (such as GET, POST, PUT, etc.) - - :param url: - The URL to perform the request on. - - :param body: - Data to send in the request body, either :class:`str`, :class:`bytes`, - an iterable of :class:`str`/:class:`bytes`, or a file-like object. - - :param fields: - Data to encode and send in the URL or request body, depending on ``method``. - - :param headers: - Dictionary of custom headers to send, such as User-Agent, - If-None-Match, etc. If None, pool headers are used. If provided, - these headers completely replace any pool-specific headers. - - :param json: - Data to encode and send as JSON with UTF-encoded in the request body. - The ``"Content-Type"`` header will be set to ``"application/json"`` - unless specified otherwise. """ method = method.upper() - if json is not None and body is not None: - raise TypeError( - "request got values for both 'body' and 'json' parameters which are mutually exclusive" - ) - - if json is not None: - if headers is None: - headers = self.headers - - if not ("content-type" in map(str.lower, headers.keys())): - headers = HTTPHeaderDict(headers) - headers["Content-Type"] = "application/json" - - body = _json.dumps(json, separators=(",", ":"), ensure_ascii=False).encode( - "utf-8" - ) - - if body is not None: - urlopen_kw["body"] = body + urlopen_kw["request_url"] = url if method in self._encode_url_methods: return self.request_encode_url( - method, - url, - fields=fields, # type: ignore[arg-type] - headers=headers, - **urlopen_kw, + method, url, fields=fields, headers=headers, **urlopen_kw ) else: return self.request_encode_body( method, url, fields=fields, headers=headers, **urlopen_kw ) - def request_encode_url( - self, - method: str, - url: str, - fields: _TYPE_ENCODE_URL_FIELDS | None = None, - headers: typing.Mapping[str, str] | None = None, - **urlopen_kw: str, - ) -> BaseHTTPResponse: + def request_encode_url(self, method, url, fields=None, headers=None, **urlopen_kw): """ Make a request using :meth:`urlopen` with the ``fields`` encoded in the url. This is useful for request methods like GET, HEAD, DELETE, etc. - - :param method: - HTTP request method (such as GET, POST, PUT, etc.) - - :param url: - The URL to perform the request on. - - :param fields: - Data to encode and send in the URL. - - :param headers: - Dictionary of custom headers to send, such as User-Agent, - If-None-Match, etc. If None, pool headers are used. If provided, - these headers completely replace any pool-specific headers. """ if headers is None: headers = self.headers - extra_kw: dict[str, typing.Any] = {"headers": headers} + extra_kw = {"headers": headers} extra_kw.update(urlopen_kw) if fields: @@ -183,14 +100,14 @@ def request_encode_url( def request_encode_body( self, - method: str, - url: str, - fields: _TYPE_FIELDS | None = None, - headers: typing.Mapping[str, str] | None = None, - encode_multipart: bool = True, - multipart_boundary: str | None = None, - **urlopen_kw: str, - ) -> BaseHTTPResponse: + method, + url, + fields=None, + headers=None, + encode_multipart=True, + multipart_boundary=None, + **urlopen_kw + ): """ Make a request using :meth:`urlopen` with the ``fields`` encoded in the body. This is useful for request methods like POST, PUT, PATCH, etc. @@ -225,34 +142,11 @@ def request_encode_body( be overwritten because it depends on the dynamic random boundary string which is used to compose the body of the request. The random boundary string can be explicitly set with the ``multipart_boundary`` parameter. - - :param method: - HTTP request method (such as GET, POST, PUT, etc.) - - :param url: - The URL to perform the request on. - - :param fields: - Data to encode and send in the request body. - - :param headers: - Dictionary of custom headers to send, such as User-Agent, - If-None-Match, etc. If None, pool headers are used. If provided, - these headers completely replace any pool-specific headers. - - :param encode_multipart: - If True, encode the ``fields`` using the multipart/form-data MIME - format. - - :param multipart_boundary: - If not specified, then a random boundary will be generated using - :func:`urllib3.filepost.choose_boundary`. """ if headers is None: headers = self.headers - extra_kw: dict[str, typing.Any] = {"headers": HTTPHeaderDict(headers)} - body: bytes | str + extra_kw = {"headers": {}} if fields: if "body" in urlopen_kw: @@ -266,13 +160,32 @@ def request_encode_body( ) else: body, content_type = ( - urlencode(fields), # type: ignore[arg-type] + urlencode(fields), "application/x-www-form-urlencoded", ) extra_kw["body"] = body - extra_kw["headers"].setdefault("Content-Type", content_type) + extra_kw["headers"] = {"Content-Type": content_type} + extra_kw["headers"].update(headers) extra_kw.update(urlopen_kw) return self.urlopen(method, url, **extra_kw) + + +if not six.PY2: + + class RequestModule(sys.modules[__name__].__class__): + def __call__(self, *args, **kwargs): + """ + If user tries to call this module directly urllib3 v2.x style raise an error to the user + suggesting they may need urllib3 v2 + """ + raise TypeError( + "'module' object is not callable\n" + "urllib3.request() method is not supported in this release, " + "upgrade to urllib3 v2 to use it\n" + "see https://urllib3.readthedocs.io/en/stable/v2-migration-guide.html" + ) + + sys.modules[__name__].__class__ = RequestModule diff --git a/newrelic/packages/urllib3/response.py b/newrelic/packages/urllib3/response.py index ff6d1f4911..0bd13d40b8 100644 --- a/newrelic/packages/urllib3/response.py +++ b/newrelic/packages/urllib3/response.py @@ -1,38 +1,28 @@ -from __future__ import annotations +from __future__ import absolute_import -import collections import io -import json as _json import logging -import socket import sys -import typing import warnings import zlib from contextlib import contextmanager -from http.client import HTTPMessage as _HttplibHTTPMessage -from http.client import HTTPResponse as _HttplibHTTPResponse +from socket import error as SocketError from socket import timeout as SocketTimeout -if typing.TYPE_CHECKING: - from ._base_connection import BaseHTTPConnection - try: try: - import brotlicffi as brotli # type: ignore[import-not-found] + import brotlicffi as brotli except ImportError: - import brotli # type: ignore[import-not-found] + import brotli except ImportError: brotli = None from . import util -from ._base_connection import _TYPE_BODY from ._collections import HTTPHeaderDict -from .connection import BaseSSLError, HTTPConnection, HTTPException +from .connection import BaseSSLError, HTTPException from .exceptions import ( BodyNotHttplibCompatible, DecodeError, - DependencyWarning, HTTPError, IncompleteRead, InvalidChunkLength, @@ -42,262 +32,101 @@ ResponseNotChunked, SSLError, ) +from .packages import six from .util.response import is_fp_closed, is_response_to_head -from .util.retry import Retry - -if typing.TYPE_CHECKING: - from .connectionpool import HTTPConnectionPool log = logging.getLogger(__name__) -class ContentDecoder: - def decompress(self, data: bytes, max_length: int = -1) -> bytes: - raise NotImplementedError() - - @property - def has_unconsumed_tail(self) -> bool: - raise NotImplementedError() - - def flush(self) -> bytes: - raise NotImplementedError() - - -class DeflateDecoder(ContentDecoder): - def __init__(self) -> None: +class DeflateDecoder(object): + def __init__(self): self._first_try = True - self._first_try_data = b"" - self._unfed_data = b"" + self._data = b"" self._obj = zlib.decompressobj() - def decompress(self, data: bytes, max_length: int = -1) -> bytes: - data = self._unfed_data + data - self._unfed_data = b"" - if not data and not self._obj.unconsumed_tail: + def __getattr__(self, name): + return getattr(self._obj, name) + + def decompress(self, data): + if not data: return data - original_max_length = max_length - if original_max_length < 0: - max_length = 0 - elif original_max_length == 0: - # We should not pass 0 to the zlib decompressor because 0 is - # the default value that will make zlib decompress without a - # length limit. - # Data should be stored for subsequent calls. - self._unfed_data = data - return b"" - # Subsequent calls always reuse `self._obj`. zlib requires - # passing the unconsumed tail if decompression is to continue. if not self._first_try: - return self._obj.decompress( - self._obj.unconsumed_tail + data, max_length=max_length - ) + return self._obj.decompress(data) - # First call tries with RFC 1950 ZLIB format. - self._first_try_data += data + self._data += data try: - decompressed = self._obj.decompress(data, max_length=max_length) + decompressed = self._obj.decompress(data) if decompressed: self._first_try = False - self._first_try_data = b"" + self._data = None return decompressed - # On failure, it falls back to RFC 1951 DEFLATE format. except zlib.error: self._first_try = False self._obj = zlib.decompressobj(-zlib.MAX_WBITS) try: - return self.decompress( - self._first_try_data, max_length=original_max_length - ) + return self.decompress(self._data) finally: - self._first_try_data = b"" + self._data = None - @property - def has_unconsumed_tail(self) -> bool: - return bool(self._unfed_data) or ( - bool(self._obj.unconsumed_tail) and not self._first_try - ) - def flush(self) -> bytes: - return self._obj.flush() +class GzipDecoderState(object): - -class GzipDecoderState: FIRST_MEMBER = 0 OTHER_MEMBERS = 1 SWALLOW_DATA = 2 -class GzipDecoder(ContentDecoder): - def __init__(self) -> None: +class GzipDecoder(object): + def __init__(self): self._obj = zlib.decompressobj(16 + zlib.MAX_WBITS) self._state = GzipDecoderState.FIRST_MEMBER - self._unconsumed_tail = b"" - - def decompress(self, data: bytes, max_length: int = -1) -> bytes: - ret = bytearray() - if self._state == GzipDecoderState.SWALLOW_DATA: - return bytes(ret) - if max_length == 0: - # We should not pass 0 to the zlib decompressor because 0 is - # the default value that will make zlib decompress without a - # length limit. - # Data should be stored for subsequent calls. - self._unconsumed_tail += data - return b"" + def __getattr__(self, name): + return getattr(self._obj, name) - # zlib requires passing the unconsumed tail to the subsequent - # call if decompression is to continue. - data = self._unconsumed_tail + data - if not data and self._obj.eof: + def decompress(self, data): + ret = bytearray() + if self._state == GzipDecoderState.SWALLOW_DATA or not data: return bytes(ret) - while True: try: - ret += self._obj.decompress( - data, max_length=max(max_length - len(ret), 0) - ) + ret += self._obj.decompress(data) except zlib.error: previous_state = self._state # Ignore data after the first error self._state = GzipDecoderState.SWALLOW_DATA - self._unconsumed_tail = b"" if previous_state == GzipDecoderState.OTHER_MEMBERS: # Allow trailing garbage acceptable in other gzip clients return bytes(ret) raise - - self._unconsumed_tail = data = ( - self._obj.unconsumed_tail or self._obj.unused_data - ) - if max_length > 0 and len(ret) >= max_length: - break - + data = self._obj.unused_data if not data: return bytes(ret) - # When the end of a gzip member is reached, a new decompressor - # must be created for unused (possibly future) data. - if self._obj.eof: - self._state = GzipDecoderState.OTHER_MEMBERS - self._obj = zlib.decompressobj(16 + zlib.MAX_WBITS) - - return bytes(ret) - - @property - def has_unconsumed_tail(self) -> bool: - return bool(self._unconsumed_tail) - - def flush(self) -> bytes: - return self._obj.flush() + self._state = GzipDecoderState.OTHER_MEMBERS + self._obj = zlib.decompressobj(16 + zlib.MAX_WBITS) if brotli is not None: - class BrotliDecoder(ContentDecoder): + class BrotliDecoder(object): # Supports both 'brotlipy' and 'Brotli' packages # since they share an import name. The top branches # are for 'brotlipy' and bottom branches for 'Brotli' - def __init__(self) -> None: + def __init__(self): self._obj = brotli.Decompressor() if hasattr(self._obj, "decompress"): - setattr(self, "_decompress", self._obj.decompress) + self.decompress = self._obj.decompress else: - setattr(self, "_decompress", self._obj.process) - - # Requires Brotli >= 1.2.0 for `output_buffer_limit`. - def _decompress(self, data: bytes, output_buffer_limit: int = -1) -> bytes: - raise NotImplementedError() - - def decompress(self, data: bytes, max_length: int = -1) -> bytes: - try: - if max_length > 0: - return self._decompress(data, output_buffer_limit=max_length) - else: - return self._decompress(data) - except TypeError: - # Fallback for Brotli/brotlicffi/brotlipy versions without - # the `output_buffer_limit` parameter. - warnings.warn( - "Brotli >= 1.2.0 is required to prevent decompression bombs.", - DependencyWarning, - ) - return self._decompress(data) - - @property - def has_unconsumed_tail(self) -> bool: - try: - return not self._obj.can_accept_more_data() - except AttributeError: - return False + self.decompress = self._obj.process - def flush(self) -> bytes: + def flush(self): if hasattr(self._obj, "flush"): - return self._obj.flush() # type: ignore[no-any-return] - return b"" - - -try: - if sys.version_info >= (3, 14): - from compression import zstd - else: - from backports import zstd -except ImportError: - HAS_ZSTD = False -else: - HAS_ZSTD = True - - class ZstdDecoder(ContentDecoder): - def __init__(self) -> None: - self._obj = zstd.ZstdDecompressor() - - def decompress(self, data: bytes, max_length: int = -1) -> bytes: - if not data and not self.has_unconsumed_tail: - return b"" - if self._obj.eof: - data = self._obj.unused_data + data - self._obj = zstd.ZstdDecompressor() - part = self._obj.decompress(data, max_length=max_length) - length = len(part) - data_parts = [part] - # Every loop iteration is supposed to read data from a separate frame. - # The loop breaks when: - # - enough data is read; - # - no more unused data is available; - # - end of the last read frame has not been reached (i.e., - # more data has to be fed). - while ( - self._obj.eof - and self._obj.unused_data - and (max_length < 0 or length < max_length) - ): - unused_data = self._obj.unused_data - if not self._obj.needs_input: - self._obj = zstd.ZstdDecompressor() - part = self._obj.decompress( - unused_data, - max_length=(max_length - length) if max_length > 0 else -1, - ) - if part_length := len(part): - data_parts.append(part) - length += part_length - elif self._obj.needs_input: - break - return b"".join(data_parts) - - @property - def has_unconsumed_tail(self) -> bool: - return not (self._obj.needs_input or self._obj.eof) or bool( - self._obj.unused_data - ) - - def flush(self) -> bytes: - if not self._obj.eof: - raise DecodeError("Zstandard data is incomplete") + return self._obj.flush() return b"" -class MultiDecoder(ContentDecoder): +class MultiDecoder(object): """ From RFC7231: If one or more encodings have been applied to a representation, the @@ -306,387 +135,32 @@ class MultiDecoder(ContentDecoder): they were applied. """ - # Maximum allowed number of chained HTTP encodings in the - # Content-Encoding header. - max_decode_links = 5 - - def __init__(self, modes: str) -> None: - encodings = [m.strip() for m in modes.split(",")] - if len(encodings) > self.max_decode_links: - raise DecodeError( - "Too many content encodings in the chain: " - f"{len(encodings)} > {self.max_decode_links}" - ) - self._decoders = [_get_decoder(e) for e in encodings] + def __init__(self, modes): + self._decoders = [_get_decoder(m.strip()) for m in modes.split(",")] - def flush(self) -> bytes: + def flush(self): return self._decoders[0].flush() - def decompress(self, data: bytes, max_length: int = -1) -> bytes: - if max_length <= 0: - for d in reversed(self._decoders): - data = d.decompress(data) - return data - - ret = bytearray() - # Every while loop iteration goes through all decoders once. - # It exits when enough data is read or no more data can be read. - # It is possible that the while loop iteration does not produce - # any data because we retrieve up to `max_length` from every - # decoder, and the amount of bytes may be insufficient for the - # next decoder to produce enough/any output. - while True: - any_data = False - for d in reversed(self._decoders): - data = d.decompress(data, max_length=max_length - len(ret)) - if data: - any_data = True - # We should not break when no data is returned because - # next decoders may produce data even with empty input. - ret += data - if not any_data or len(ret) >= max_length: - return bytes(ret) - data = b"" - - @property - def has_unconsumed_tail(self) -> bool: - return any(d.has_unconsumed_tail for d in self._decoders) + def decompress(self, data): + for d in reversed(self._decoders): + data = d.decompress(data) + return data -def _get_decoder(mode: str) -> ContentDecoder: +def _get_decoder(mode): if "," in mode: return MultiDecoder(mode) - # According to RFC 9110 section 8.4.1.3, recipients should - # consider x-gzip equivalent to gzip - if mode in ("gzip", "x-gzip"): + if mode == "gzip": return GzipDecoder() if brotli is not None and mode == "br": return BrotliDecoder() - if HAS_ZSTD and mode == "zstd": - return ZstdDecoder() - return DeflateDecoder() -class BytesQueueBuffer: - """Memory-efficient bytes buffer - - To return decoded data in read() and still follow the BufferedIOBase API, we need a - buffer to always return the correct amount of bytes. - - This buffer should be filled using calls to put() - - Our maximum memory usage is determined by the sum of the size of: - - * self.buffer, which contains the full data - * the largest chunk that we will copy in get() - """ - - def __init__(self) -> None: - self.buffer: typing.Deque[bytes | memoryview[bytes]] = collections.deque() - self._size: int = 0 - - def __len__(self) -> int: - return self._size - - def put(self, data: bytes) -> None: - self.buffer.append(data) - self._size += len(data) - - def get(self, n: int) -> bytes: - if n == 0: - return b"" - elif not self.buffer: - raise RuntimeError("buffer is empty") - elif n < 0: - raise ValueError("n should be > 0") - - if len(self.buffer[0]) == n and isinstance(self.buffer[0], bytes): - self._size -= n - return self.buffer.popleft() - - fetched = 0 - ret = io.BytesIO() - while fetched < n: - remaining = n - fetched - chunk = self.buffer.popleft() - chunk_length = len(chunk) - if remaining < chunk_length: - chunk = memoryview(chunk) - left_chunk, right_chunk = chunk[:remaining], chunk[remaining:] - ret.write(left_chunk) - self.buffer.appendleft(right_chunk) - self._size -= remaining - break - else: - ret.write(chunk) - self._size -= chunk_length - fetched += chunk_length - - if not self.buffer: - break - - return ret.getvalue() - - def get_all(self) -> bytes: - buffer = self.buffer - if not buffer: - assert self._size == 0 - return b"" - if len(buffer) == 1: - result = buffer.pop() - if isinstance(result, memoryview): - result = result.tobytes() - else: - ret = io.BytesIO() - ret.writelines(buffer.popleft() for _ in range(len(buffer))) - result = ret.getvalue() - self._size = 0 - return result - - -class BaseHTTPResponse(io.IOBase): - CONTENT_DECODERS = ["gzip", "x-gzip", "deflate"] - if brotli is not None: - CONTENT_DECODERS += ["br"] - if HAS_ZSTD: - CONTENT_DECODERS += ["zstd"] - REDIRECT_STATUSES = [301, 302, 303, 307, 308] - - DECODER_ERROR_CLASSES: tuple[type[Exception], ...] = (IOError, zlib.error) - if brotli is not None: - DECODER_ERROR_CLASSES += (brotli.error,) - - if HAS_ZSTD: - DECODER_ERROR_CLASSES += (zstd.ZstdError,) - - def __init__( - self, - *, - headers: typing.Mapping[str, str] | typing.Mapping[bytes, bytes] | None = None, - status: int, - version: int, - version_string: str, - reason: str | None, - decode_content: bool, - request_url: str | None, - retries: Retry | None = None, - ) -> None: - if isinstance(headers, HTTPHeaderDict): - self.headers = headers - else: - self.headers = HTTPHeaderDict(headers) # type: ignore[arg-type] - self.status = status - self.version = version - self.version_string = version_string - self.reason = reason - self.decode_content = decode_content - self._has_decoded_content = False - self._request_url: str | None = request_url - self.retries = retries - - self.chunked = False - tr_enc = self.headers.get("transfer-encoding", "").lower() - # Don't incur the penalty of creating a list and then discarding it - encodings = (enc.strip() for enc in tr_enc.split(",")) - if "chunked" in encodings: - self.chunked = True - - self._decoder: ContentDecoder | None = None - self.length_remaining: int | None - - def get_redirect_location(self) -> str | None | typing.Literal[False]: - """ - Should we redirect and where to? - - :returns: Truthy redirect location string if we got a redirect status - code and valid location. ``None`` if redirect status and no - location. ``False`` if not a redirect status code. - """ - if self.status in self.REDIRECT_STATUSES: - return self.headers.get("location") - return False - - @property - def data(self) -> bytes: - raise NotImplementedError() - - def json(self) -> typing.Any: - """ - Deserializes the body of the HTTP response as a Python object. - - The body of the HTTP response must be encoded using UTF-8, as per - `RFC 8529 Section 8.1 `_. - - To use a custom JSON decoder pass the result of :attr:`HTTPResponse.data` to - your custom decoder instead. - - If the body of the HTTP response is not decodable to UTF-8, a - `UnicodeDecodeError` will be raised. If the body of the HTTP response is not a - valid JSON document, a `json.JSONDecodeError` will be raised. - - Read more :ref:`here `. - - :returns: The body of the HTTP response as a Python object. - """ - data = self.data.decode("utf-8") - return _json.loads(data) - - @property - def url(self) -> str | None: - raise NotImplementedError() - - @url.setter - def url(self, url: str | None) -> None: - raise NotImplementedError() - - @property - def connection(self) -> BaseHTTPConnection | None: - raise NotImplementedError() - - @property - def retries(self) -> Retry | None: - return self._retries - - @retries.setter - def retries(self, retries: Retry | None) -> None: - # Override the request_url if retries has a redirect location. - if retries is not None and retries.history: - self.url = retries.history[-1].redirect_location - self._retries = retries - - def stream( - self, amt: int | None = 2**16, decode_content: bool | None = None - ) -> typing.Iterator[bytes]: - raise NotImplementedError() - - def read( - self, - amt: int | None = None, - decode_content: bool | None = None, - cache_content: bool = False, - ) -> bytes: - raise NotImplementedError() - - def read1( - self, - amt: int | None = None, - decode_content: bool | None = None, - ) -> bytes: - raise NotImplementedError() - - def read_chunked( - self, - amt: int | None = None, - decode_content: bool | None = None, - ) -> typing.Iterator[bytes]: - raise NotImplementedError() - - def release_conn(self) -> None: - raise NotImplementedError() - - def drain_conn(self) -> None: - raise NotImplementedError() - - def shutdown(self) -> None: - raise NotImplementedError() - - def close(self) -> None: - raise NotImplementedError() - - def _init_decoder(self) -> None: - """ - Set-up the _decoder attribute if necessary. - """ - # Note: content-encoding value should be case-insensitive, per RFC 7230 - # Section 3.2 - content_encoding = self.headers.get("content-encoding", "").lower() - if self._decoder is None: - if content_encoding in self.CONTENT_DECODERS: - self._decoder = _get_decoder(content_encoding) - elif "," in content_encoding: - encodings = [ - e.strip() - for e in content_encoding.split(",") - if e.strip() in self.CONTENT_DECODERS - ] - if encodings: - self._decoder = _get_decoder(content_encoding) - - def _decode( - self, - data: bytes, - decode_content: bool | None, - flush_decoder: bool, - max_length: int | None = None, - ) -> bytes: - """ - Decode the data passed in and potentially flush the decoder. - """ - if not decode_content: - if self._has_decoded_content: - raise RuntimeError( - "Calling read(decode_content=False) is not supported after " - "read(decode_content=True) was called." - ) - return data - - if max_length is None or flush_decoder: - max_length = -1 - - try: - if self._decoder: - data = self._decoder.decompress(data, max_length=max_length) - self._has_decoded_content = True - except self.DECODER_ERROR_CLASSES as e: - content_encoding = self.headers.get("content-encoding", "").lower() - raise DecodeError( - "Received response with content-encoding: %s, but " - "failed to decode it." % content_encoding, - e, - ) from e - if flush_decoder: - data += self._flush_decoder() - - return data - - def _flush_decoder(self) -> bytes: - """ - Flushes the decoder. Should only be called if the decoder is actually - being used. - """ - if self._decoder: - return self._decoder.decompress(b"") + self._decoder.flush() - return b"" - - # Compatibility methods for `io` module - def readinto(self, b: bytearray) -> int: - temp = self.read(len(b)) - if len(temp) == 0: - return 0 - else: - b[: len(temp)] = temp - return len(temp) - - # Methods used by dependent libraries - def getheaders(self) -> HTTPHeaderDict: - return self.headers - - def getheader(self, name: str, default: str | None = None) -> str | None: - return self.headers.get(name, default) - - # Compatibility method for http.cookiejar - def info(self) -> HTTPHeaderDict: - return self.headers - - def geturl(self) -> str | None: - return self.url - - -class HTTPResponse(BaseHTTPResponse): +class HTTPResponse(io.IOBase): """ HTTP Response container. @@ -719,111 +193,126 @@ class is also compatible with the Python standard library's :mod:`io` value of Content-Length header, if present. Otherwise, raise error. """ + CONTENT_DECODERS = ["gzip", "deflate"] + if brotli is not None: + CONTENT_DECODERS += ["br"] + REDIRECT_STATUSES = [301, 302, 303, 307, 308] + def __init__( self, - body: _TYPE_BODY = "", - headers: typing.Mapping[str, str] | typing.Mapping[bytes, bytes] | None = None, - status: int = 0, - version: int = 0, - version_string: str = "HTTP/?", - reason: str | None = None, - preload_content: bool = True, - decode_content: bool = True, - original_response: _HttplibHTTPResponse | None = None, - pool: HTTPConnectionPool | None = None, - connection: HTTPConnection | None = None, - msg: _HttplibHTTPMessage | None = None, - retries: Retry | None = None, - enforce_content_length: bool = True, - request_method: str | None = None, - request_url: str | None = None, - auto_close: bool = True, - sock_shutdown: typing.Callable[[int], None] | None = None, - ) -> None: - super().__init__( - headers=headers, - status=status, - version=version, - version_string=version_string, - reason=reason, - decode_content=decode_content, - request_url=request_url, - retries=retries, - ) + body="", + headers=None, + status=0, + version=0, + reason=None, + strict=0, + preload_content=True, + decode_content=True, + original_response=None, + pool=None, + connection=None, + msg=None, + retries=None, + enforce_content_length=False, + request_method=None, + request_url=None, + auto_close=True, + ): + if isinstance(headers, HTTPHeaderDict): + self.headers = headers + else: + self.headers = HTTPHeaderDict(headers) + self.status = status + self.version = version + self.reason = reason + self.strict = strict + self.decode_content = decode_content + self.retries = retries self.enforce_content_length = enforce_content_length self.auto_close = auto_close + self._decoder = None self._body = None - self._fp: _HttplibHTTPResponse | None = None + self._fp = None self._original_response = original_response self._fp_bytes_read = 0 self.msg = msg + self._request_url = request_url - if body and isinstance(body, (str, bytes)): + if body and isinstance(body, (six.string_types, bytes)): self._body = body self._pool = pool self._connection = connection if hasattr(body, "read"): - self._fp = body # type: ignore[assignment] - self._sock_shutdown = sock_shutdown + self._fp = body # Are we using the chunked-style of transfer encoding? - self.chunk_left: int | None = None + self.chunked = False + self.chunk_left = None + tr_enc = self.headers.get("transfer-encoding", "").lower() + # Don't incur the penalty of creating a list and then discarding it + encodings = (enc.strip() for enc in tr_enc.split(",")) + if "chunked" in encodings: + self.chunked = True # Determine length of response self.length_remaining = self._init_length(request_method) - # Used to return the correct amount of bytes for partial read()s - self._decoded_buffer = BytesQueueBuffer() - # If requested, preload the body. if preload_content and not self._body: self._body = self.read(decode_content=decode_content) - def release_conn(self) -> None: + def get_redirect_location(self): + """ + Should we redirect and where to? + + :returns: Truthy redirect location string if we got a redirect status + code and valid location. ``None`` if redirect status and no + location. ``False`` if not a redirect status code. + """ + if self.status in self.REDIRECT_STATUSES: + return self.headers.get("location") + + return False + + def release_conn(self): if not self._pool or not self._connection: - return None + return self._pool._put_conn(self._connection) self._connection = None - def drain_conn(self) -> None: + def drain_conn(self): """ Read and discard any remaining HTTP response data in the response connection. Unread data in the HTTPResponse connection blocks the connection from being released back to the pool. """ try: - self.read( - # Do not spend resources decoding the content unless - # decoding has already been initiated. - decode_content=self._has_decoded_content, - ) - except (HTTPError, OSError, BaseSSLError, HTTPException): + self.read() + except (HTTPError, SocketError, BaseSSLError, HTTPException): pass @property - def data(self) -> bytes: + def data(self): # For backwards-compat with earlier urllib3 0.4 and earlier. if self._body: - return self._body # type: ignore[return-value] + return self._body if self._fp: return self.read(cache_content=True) - return None # type: ignore[return-value] - @property - def connection(self) -> HTTPConnection | None: + def connection(self): return self._connection - def isclosed(self) -> bool: + def isclosed(self): return is_fp_closed(self._fp) - def tell(self) -> int: + def tell(self): """ Obtain the number of bytes pulled over the wire so far. May differ from the amount of content returned by :meth:``urllib3.response.HTTPResponse.read`` @@ -831,14 +320,13 @@ def tell(self) -> int: """ return self._fp_bytes_read - def _init_length(self, request_method: str | None) -> int | None: + def _init_length(self, request_method): """ Set initial length value for Response content if available. """ - length: int | None - content_length: str | None = self.headers.get("content-length") + length = self.headers.get("content-length") - if content_length is not None: + if length is not None: if self.chunked: # This Response will fail with an IncompleteRead if it can't be # received as chunked. This method falls back to attempt reading @@ -858,11 +346,11 @@ def _init_length(self, request_method: str | None) -> int | None: # (e.g. Content-Length: 42, 42). This line ensures the values # are all valid ints and that as long as the `set` length is 1, # all values are the same. Otherwise, the header is invalid. - lengths = {int(val) for val in content_length.split(",")} + lengths = set([int(val) for val in length.split(",")]) if len(lengths) > 1: raise InvalidHeader( "Content-Length contained multiple " - "unmatching values (%s)" % content_length + "unmatching values (%s)" % length ) length = lengths.pop() except ValueError: @@ -871,9 +359,6 @@ def _init_length(self, request_method: str | None) -> int | None: if length < 0: length = None - else: # if content_length is None - length = None - # Convert status to int for comparison # In some cases, httplib returns a status of "_UNKNOWN" try: @@ -887,8 +372,64 @@ def _init_length(self, request_method: str | None) -> int | None: return length + def _init_decoder(self): + """ + Set-up the _decoder attribute if necessary. + """ + # Note: content-encoding value should be case-insensitive, per RFC 7230 + # Section 3.2 + content_encoding = self.headers.get("content-encoding", "").lower() + if self._decoder is None: + if content_encoding in self.CONTENT_DECODERS: + self._decoder = _get_decoder(content_encoding) + elif "," in content_encoding: + encodings = [ + e.strip() + for e in content_encoding.split(",") + if e.strip() in self.CONTENT_DECODERS + ] + if len(encodings): + self._decoder = _get_decoder(content_encoding) + + DECODER_ERROR_CLASSES = (IOError, zlib.error) + if brotli is not None: + DECODER_ERROR_CLASSES += (brotli.error,) + + def _decode(self, data, decode_content, flush_decoder): + """ + Decode the data passed in and potentially flush the decoder. + """ + if not decode_content: + return data + + try: + if self._decoder: + data = self._decoder.decompress(data) + except self.DECODER_ERROR_CLASSES as e: + content_encoding = self.headers.get("content-encoding", "").lower() + raise DecodeError( + "Received response with content-encoding: %s, but " + "failed to decode it." % content_encoding, + e, + ) + if flush_decoder: + data += self._flush_decoder() + + return data + + def _flush_decoder(self): + """ + Flushes the decoder. Should only be called if the decoder is actually + being used. + """ + if self._decoder: + buf = self._decoder.decompress(b"") + return buf + self._decoder.flush() + + return b"" + @contextmanager - def _error_catcher(self) -> typing.Generator[None]: + def _error_catcher(self): """ Catch low-level python exceptions, instead re-raising urllib3 variants, so that low-level exceptions are not leaked in the @@ -902,32 +443,22 @@ def _error_catcher(self) -> typing.Generator[None]: try: yield - except SocketTimeout as e: + except SocketTimeout: # FIXME: Ideally we'd like to include the url in the ReadTimeoutError but # there is yet no clean way to get at it from this context. - raise ReadTimeoutError(self._pool, None, "Read timed out.") from e # type: ignore[arg-type] + raise ReadTimeoutError(self._pool, None, "Read timed out.") except BaseSSLError as e: # FIXME: Is there a better way to differentiate between SSLErrors? if "read operation timed out" not in str(e): # SSL errors related to framing/MAC get wrapped and reraised here - raise SSLError(e) from e - - raise ReadTimeoutError(self._pool, None, "Read timed out.") from e # type: ignore[arg-type] + raise SSLError(e) - except IncompleteRead as e: - if ( - e.expected is not None - and e.partial is not None - and e.expected == -e.partial - ): - arg = "Response may not contain content." - else: - arg = f"Connection broken: {e!r}" - raise ProtocolError(arg, e) from e + raise ReadTimeoutError(self._pool, None, "Read timed out.") - except (HTTPException, OSError) as e: - raise ProtocolError(f"Connection broken: {e!r}", e) from e + except (HTTPException, SocketError) as e: + # This includes IncompleteRead. + raise ProtocolError("Connection broken: %r" % e, e) # If no exception is thrown, we should avoid cleaning up # unnecessarily. @@ -953,12 +484,7 @@ def _error_catcher(self) -> typing.Generator[None]: if self._original_response and self._original_response.isclosed(): self.release_conn() - def _fp_read( - self, - amt: int | None = None, - *, - read1: bool = False, - ) -> bytes: + def _fp_read(self, amt): """ Read a response with the thought that reading the number of bytes larger than can fit in a 32-bit int at a time via SSL in some @@ -967,23 +493,21 @@ def _fp_read( happen. The known cases: - * CPython < 3.9.7 because of a bug + * 3.8 <= CPython < 3.9.7 because of a bug https://github.com/urllib3/urllib3/issues/2513#issuecomment-1152559900. * urllib3 injected with pyOpenSSL-backed SSL-support. * CPython < 3.10 only when `amt` does not fit 32-bit int. """ assert self._fp - c_int_max = 2**31 - 1 + c_int_max = 2 ** 31 - 1 if ( - (amt and amt > c_int_max) - or ( - amt is None - and self.length_remaining - and self.length_remaining > c_int_max + ( + (amt and amt > c_int_max) + or (self.length_remaining and self.length_remaining > c_int_max) ) - ) and (util.IS_PYOPENSSL or sys.version_info < (3, 10)): - if read1: - return self._fp.read1(c_int_max) + and not util.IS_SECURETRANSPORT + and (util.IS_PYOPENSSL or sys.version_info < (3, 10)) + ): buffer = io.BytesIO() # Besides `max_chunk_amt` being a maximum chunk size, it # affects memory overhead of reading a response by this @@ -991,7 +515,7 @@ def _fp_read( # `c_int_max` equal to 2 GiB - 1 byte is the actual maximum # chunk size that does not lead to an overflow error, but # 256 MiB is a compromise. - max_chunk_amt = 2**28 + max_chunk_amt = 2 ** 28 while amt is None or amt != 0: if amt is not None: chunk_amt = min(amt, max_chunk_amt) @@ -1004,70 +528,11 @@ def _fp_read( buffer.write(data) del data # to reduce peak memory usage by `max_chunk_amt`. return buffer.getvalue() - elif read1: - return self._fp.read1(amt) if amt is not None else self._fp.read1() else: # StringIO doesn't like amt=None return self._fp.read(amt) if amt is not None else self._fp.read() - def _raw_read( - self, - amt: int | None = None, - *, - read1: bool = False, - ) -> bytes: - """ - Reads `amt` of bytes from the socket. - """ - if self._fp is None: - return None # type: ignore[return-value] - - fp_closed = getattr(self._fp, "closed", False) - - with self._error_catcher(): - data = self._fp_read(amt, read1=read1) if not fp_closed else b"" - if amt is not None and amt != 0 and not data: - # Platform-specific: Buggy versions of Python. - # Close the connection when no data is returned - # - # This is redundant to what httplib/http.client _should_ - # already do. However, versions of python released before - # December 15, 2012 (http://bugs.python.org/issue16298) do - # not properly close the connection in all cases. There is - # no harm in redundantly calling close. - self._fp.close() - if ( - self.enforce_content_length - and self.length_remaining is not None - and self.length_remaining != 0 - ): - # This is an edge case that httplib failed to cover due - # to concerns of backward compatibility. We're - # addressing it here to make sure IncompleteRead is - # raised during streaming, so all calls with incorrect - # Content-Length are caught. - raise IncompleteRead(self._fp_bytes_read, self.length_remaining) - elif read1 and ( - (amt != 0 and not data) or self.length_remaining == len(data) - ): - # All data has been read, but `self._fp.read1` in - # CPython 3.12 and older doesn't always close - # `http.client.HTTPResponse`, so we close it here. - # See https://github.com/python/cpython/issues/113199 - self._fp.close() - - if data: - self._fp_bytes_read += len(data) - if self.length_remaining is not None: - self.length_remaining -= len(data) - return data - - def read( - self, - amt: int | None = None, - decode_content: bool | None = None, - cache_content: bool = False, - ) -> bytes: + def read(self, amt=None, decode_content=None, cache_content=False): """ Similar to :meth:`http.client.HTTPResponse.read`, but with two additional parameters: ``decode_content`` and ``cache_content``. @@ -1092,145 +557,54 @@ def read( if decode_content is None: decode_content = self.decode_content - if amt and amt < 0: - # Negative numbers and `None` should be treated the same. - amt = None - elif amt is not None: - cache_content = False - - if self._decoder and self._decoder.has_unconsumed_tail: - decoded_data = self._decode( - b"", - decode_content, - flush_decoder=False, - max_length=amt - len(self._decoded_buffer), - ) - self._decoded_buffer.put(decoded_data) - if len(self._decoded_buffer) >= amt: - return self._decoded_buffer.get(amt) + if self._fp is None: + return - data = self._raw_read(amt) + flush_decoder = False + fp_closed = getattr(self._fp, "closed", False) - flush_decoder = amt is None or (amt != 0 and not data) + with self._error_catcher(): + data = self._fp_read(amt) if not fp_closed else b"" + if amt is None: + flush_decoder = True + else: + cache_content = False + if ( + amt != 0 and not data + ): # Platform-specific: Buggy versions of Python. + # Close the connection when no data is returned + # + # This is redundant to what httplib/http.client _should_ + # already do. However, versions of python released before + # December 15, 2012 (http://bugs.python.org/issue16298) do + # not properly close the connection in all cases. There is + # no harm in redundantly calling close. + self._fp.close() + flush_decoder = True + if self.enforce_content_length and self.length_remaining not in ( + 0, + None, + ): + # This is an edge case that httplib failed to cover due + # to concerns of backward compatibility. We're + # addressing it here to make sure IncompleteRead is + # raised during streaming, so all calls with incorrect + # Content-Length are caught. + raise IncompleteRead(self._fp_bytes_read, self.length_remaining) - if ( - not data - and len(self._decoded_buffer) == 0 - and not (self._decoder and self._decoder.has_unconsumed_tail) - ): - return data + if data: + self._fp_bytes_read += len(data) + if self.length_remaining is not None: + self.length_remaining -= len(data) - if amt is None: data = self._decode(data, decode_content, flush_decoder) + if cache_content: self._body = data - else: - # do not waste memory on buffer when not decoding - if not decode_content: - if self._has_decoded_content: - raise RuntimeError( - "Calling read(decode_content=False) is not supported after " - "read(decode_content=True) was called." - ) - return data - - decoded_data = self._decode( - data, - decode_content, - flush_decoder, - max_length=amt - len(self._decoded_buffer), - ) - self._decoded_buffer.put(decoded_data) - - while len(self._decoded_buffer) < amt and data: - # TODO make sure to initially read enough data to get past the headers - # For example, the GZ file header takes 10 bytes, we don't want to read - # it one byte at a time - data = self._raw_read(amt) - decoded_data = self._decode( - data, - decode_content, - flush_decoder, - max_length=amt - len(self._decoded_buffer), - ) - self._decoded_buffer.put(decoded_data) - data = self._decoded_buffer.get(amt) return data - def read1( - self, - amt: int | None = None, - decode_content: bool | None = None, - ) -> bytes: - """ - Similar to ``http.client.HTTPResponse.read1`` and documented - in :meth:`io.BufferedReader.read1`, but with an additional parameter: - ``decode_content``. - - :param amt: - How much of the content to read. - - :param decode_content: - If True, will attempt to decode the body based on the - 'content-encoding' header. - """ - if decode_content is None: - decode_content = self.decode_content - if amt and amt < 0: - # Negative numbers and `None` should be treated the same. - amt = None - # try and respond without going to the network - if self._has_decoded_content: - if not decode_content: - raise RuntimeError( - "Calling read1(decode_content=False) is not supported after " - "read1(decode_content=True) was called." - ) - if ( - self._decoder - and self._decoder.has_unconsumed_tail - and (amt is None or len(self._decoded_buffer) < amt) - ): - decoded_data = self._decode( - b"", - decode_content, - flush_decoder=False, - max_length=( - amt - len(self._decoded_buffer) if amt is not None else None - ), - ) - self._decoded_buffer.put(decoded_data) - if len(self._decoded_buffer) > 0: - if amt is None: - return self._decoded_buffer.get_all() - return self._decoded_buffer.get(amt) - if amt == 0: - return b"" - - # FIXME, this method's type doesn't say returning None is possible - data = self._raw_read(amt, read1=True) - if not decode_content or data is None: - return data - - self._init_decoder() - while True: - flush_decoder = not data - decoded_data = self._decode( - data, decode_content, flush_decoder, max_length=amt - ) - self._decoded_buffer.put(decoded_data) - if decoded_data or flush_decoder: - break - data = self._raw_read(8192, read1=True) - - if amt is None: - return self._decoded_buffer.get_all() - return self._decoded_buffer.get(amt) - - def stream( - self, amt: int | None = 2**16, decode_content: bool | None = None - ) -> typing.Generator[bytes]: + def stream(self, amt=2 ** 16, decode_content=None): """ A generator wrapper for the read() method. A call will block until ``amt`` bytes have been read from the connection or until the @@ -1247,35 +621,73 @@ def stream( 'content-encoding' header. """ if self.chunked and self.supports_chunked_reads(): - yield from self.read_chunked(amt, decode_content=decode_content) + for line in self.read_chunked(amt, decode_content=decode_content): + yield line else: - while ( - not is_fp_closed(self._fp) - or len(self._decoded_buffer) > 0 - or (self._decoder and self._decoder.has_unconsumed_tail) - ): + while not is_fp_closed(self._fp): data = self.read(amt=amt, decode_content=decode_content) if data: yield data - # Overrides from io.IOBase - def readable(self) -> bool: - return True + @classmethod + def from_httplib(ResponseCls, r, **response_kw): + """ + Given an :class:`http.client.HTTPResponse` instance ``r``, return a + corresponding :class:`urllib3.response.HTTPResponse` object. - def shutdown(self) -> None: - if not self._sock_shutdown: - raise ValueError("Cannot shutdown socket as self._sock_shutdown is not set") - if self._connection is None: - raise RuntimeError( - "Cannot shutdown as connection has already been released to the pool" - ) - self._sock_shutdown(socket.SHUT_RD) + Remaining parameters are passed to the HTTPResponse constructor, along + with ``original_response=r``. + """ + headers = r.msg + + if not isinstance(headers, HTTPHeaderDict): + if six.PY2: + # Python 2.7 + headers = HTTPHeaderDict.from_httplib(headers) + else: + headers = HTTPHeaderDict(headers.items()) + + # HTTPResponse objects in Python 3 don't have a .strict attribute + strict = getattr(r, "strict", 0) + resp = ResponseCls( + body=r, + headers=headers, + status=r.status, + version=r.version, + reason=r.reason, + strict=strict, + original_response=r, + **response_kw + ) + return resp + + # Backwards-compatibility methods for http.client.HTTPResponse + def getheaders(self): + warnings.warn( + "HTTPResponse.getheaders() is deprecated and will be removed " + "in urllib3 v2.1.0. Instead access HTTPResponse.headers directly.", + category=DeprecationWarning, + stacklevel=2, + ) + return self.headers - def close(self) -> None: - self._sock_shutdown = None + def getheader(self, name, default=None): + warnings.warn( + "HTTPResponse.getheader() is deprecated and will be removed " + "in urllib3 v2.1.0. Instead use HTTPResponse.headers.get(name, default).", + category=DeprecationWarning, + stacklevel=2, + ) + return self.headers.get(name, default) + + # Backwards compatibility for http.cookiejar + def info(self): + return self.headers - if not self.closed and self._fp: + # Overrides from io.IOBase + def close(self): + if not self.closed: self._fp.close() if self._connection: @@ -1285,9 +697,9 @@ def close(self) -> None: io.IOBase.close(self) @property - def closed(self) -> bool: + def closed(self): if not self.auto_close: - return io.IOBase.closed.__get__(self) # type: ignore[no-any-return] + return io.IOBase.closed.__get__(self) elif self._fp is None: return True elif hasattr(self._fp, "isclosed"): @@ -1297,18 +709,18 @@ def closed(self) -> bool: else: return True - def fileno(self) -> int: + def fileno(self): if self._fp is None: - raise OSError("HTTPResponse has no file to get a fileno from") + raise IOError("HTTPResponse has no file to get a fileno from") elif hasattr(self._fp, "fileno"): return self._fp.fileno() else: - raise OSError( + raise IOError( "The file-like object this HTTPResponse is wrapped " "around has no file descriptor" ) - def flush(self) -> None: + def flush(self): if ( self._fp is not None and hasattr(self._fp, "flush") @@ -1316,7 +728,20 @@ def flush(self) -> None: ): return self._fp.flush() - def supports_chunked_reads(self) -> bool: + def readable(self): + # This method is required for `io` module compatibility. + return True + + def readinto(self, b): + # This method is required for `io` module compatibility. + temp = self.read(len(b)) + if len(temp) == 0: + return 0 + else: + b[: len(temp)] = temp + return len(temp) + + def supports_chunked_reads(self): """ Checks if the underlying file-like object looks like a :class:`http.client.HTTPResponse` object. We do this by testing for @@ -1325,49 +750,43 @@ def supports_chunked_reads(self) -> bool: """ return hasattr(self._fp, "fp") - def _update_chunk_length(self) -> None: + def _update_chunk_length(self): # First, we'll figure out length of a chunk and then # we'll try to read it from socket. if self.chunk_left is not None: - return None - line = self._fp.fp.readline() # type: ignore[union-attr] + return + line = self._fp.fp.readline() line = line.split(b";", 1)[0] try: self.chunk_left = int(line, 16) except ValueError: + # Invalid chunked protocol response, abort. self.close() - if line: - # Invalid chunked protocol response, abort. - raise InvalidChunkLength(self, line) from None - else: - # Truncated at start of next chunk - raise ProtocolError("Response ended prematurely") from None + raise InvalidChunkLength(self, line) - def _handle_chunk(self, amt: int | None) -> bytes: + def _handle_chunk(self, amt): returned_chunk = None if amt is None: - chunk = self._fp._safe_read(self.chunk_left) # type: ignore[union-attr] + chunk = self._fp._safe_read(self.chunk_left) returned_chunk = chunk - self._fp._safe_read(2) # type: ignore[union-attr] # Toss the CRLF at the end of the chunk. + self._fp._safe_read(2) # Toss the CRLF at the end of the chunk. self.chunk_left = None - elif self.chunk_left is not None and amt < self.chunk_left: - value = self._fp._safe_read(amt) # type: ignore[union-attr] + elif amt < self.chunk_left: + value = self._fp._safe_read(amt) self.chunk_left = self.chunk_left - amt returned_chunk = value elif amt == self.chunk_left: - value = self._fp._safe_read(amt) # type: ignore[union-attr] - self._fp._safe_read(2) # type: ignore[union-attr] # Toss the CRLF at the end of the chunk. + value = self._fp._safe_read(amt) + self._fp._safe_read(2) # Toss the CRLF at the end of the chunk. self.chunk_left = None returned_chunk = value else: # amt > self.chunk_left - returned_chunk = self._fp._safe_read(self.chunk_left) # type: ignore[union-attr] - self._fp._safe_read(2) # type: ignore[union-attr] # Toss the CRLF at the end of the chunk. + returned_chunk = self._fp._safe_read(self.chunk_left) + self._fp._safe_read(2) # Toss the CRLF at the end of the chunk. self.chunk_left = None - return returned_chunk # type: ignore[no-any-return] + return returned_chunk - def read_chunked( - self, amt: int | None = None, decode_content: bool | None = None - ) -> typing.Generator[bytes]: + def read_chunked(self, amt=None, decode_content=None): """ Similar to :meth:`HTTPResponse.read`, but with an additional parameter: ``decode_content``. @@ -1398,32 +817,20 @@ def read_chunked( # Don't bother reading the body of a HEAD request. if self._original_response and is_response_to_head(self._original_response): self._original_response.close() - return None + return # If a response is already read and closed # then return immediately. - if self._fp.fp is None: # type: ignore[union-attr] - return None - - if amt and amt < 0: - # Negative numbers and `None` should be treated the same, - # but httplib handles only `None` correctly. - amt = None + if self._fp.fp is None: + return while True: - # First, check if any data is left in the decoder's buffer. - if self._decoder and self._decoder.has_unconsumed_tail: - chunk = b"" - else: - self._update_chunk_length() - if self.chunk_left == 0: - break - chunk = self._handle_chunk(amt) + self._update_chunk_length() + if self.chunk_left == 0: + break + chunk = self._handle_chunk(amt) decoded = self._decode( - chunk, - decode_content=decode_content, - flush_decoder=False, - max_length=amt, + chunk, decode_content=decode_content, flush_decoder=False ) if decoded: yield decoded @@ -1437,7 +844,7 @@ def read_chunked( yield decoded # Chunk content ends with \r\n: discard it. - while self._fp is not None: + while True: line = self._fp.fp.readline() if not line: # Some sites may not end with '\r\n'. @@ -1449,29 +856,27 @@ def read_chunked( if self._original_response: self._original_response.close() - @property - def url(self) -> str | None: + def geturl(self): """ Returns the URL that was the source of this response. If the request that generated this response redirected, this method will return the final redirect location. """ - return self._request_url - - @url.setter - def url(self, url: str | None) -> None: - self._request_url = url + if self.retries is not None and len(self.retries.history): + return self.retries.history[-1].redirect_location + else: + return self._request_url - def __iter__(self) -> typing.Iterator[bytes]: - buffer: list[bytes] = [] + def __iter__(self): + buffer = [] for chunk in self.stream(decode_content=True): if b"\n" in chunk: - chunks = chunk.split(b"\n") - yield b"".join(buffer) + chunks[0] + b"\n" - for x in chunks[1:-1]: + chunk = chunk.split(b"\n") + yield b"".join(buffer) + chunk[0] + b"\n" + for x in chunk[1:-1]: yield x + b"\n" - if chunks[-1]: - buffer = [chunks[-1]] + if chunk[-1]: + buffer = [chunk[-1]] else: buffer = [] else: diff --git a/newrelic/packages/urllib3/util/__init__.py b/newrelic/packages/urllib3/util/__init__.py index 534126033c..4547fc522b 100644 --- a/newrelic/packages/urllib3/util/__init__.py +++ b/newrelic/packages/urllib3/util/__init__.py @@ -1,39 +1,46 @@ -# For backwards compatibility, provide imports that used to be here. -from __future__ import annotations +from __future__ import absolute_import +# For backwards compatibility, provide imports that used to be here. from .connection import is_connection_dropped from .request import SKIP_HEADER, SKIPPABLE_HEADERS, make_headers from .response import is_fp_closed from .retry import Retry from .ssl_ import ( ALPN_PROTOCOLS, + HAS_SNI, IS_PYOPENSSL, + IS_SECURETRANSPORT, + PROTOCOL_TLS, SSLContext, assert_fingerprint, - create_urllib3_context, resolve_cert_reqs, resolve_ssl_version, ssl_wrap_socket, ) -from .timeout import Timeout -from .url import Url, parse_url +from .timeout import Timeout, current_time +from .url import Url, get_host, parse_url, split_first from .wait import wait_for_read, wait_for_write __all__ = ( + "HAS_SNI", "IS_PYOPENSSL", + "IS_SECURETRANSPORT", "SSLContext", + "PROTOCOL_TLS", "ALPN_PROTOCOLS", "Retry", "Timeout", "Url", "assert_fingerprint", - "create_urllib3_context", + "current_time", "is_connection_dropped", "is_fp_closed", + "get_host", "parse_url", "make_headers", "resolve_cert_reqs", "resolve_ssl_version", + "split_first", "ssl_wrap_socket", "wait_for_read", "wait_for_write", diff --git a/newrelic/packages/urllib3/util/connection.py b/newrelic/packages/urllib3/util/connection.py index f92519ee91..6af1138f26 100644 --- a/newrelic/packages/urllib3/util/connection.py +++ b/newrelic/packages/urllib3/util/connection.py @@ -1,23 +1,33 @@ -from __future__ import annotations +from __future__ import absolute_import import socket -import typing +from ..contrib import _appengine_environ from ..exceptions import LocationParseError -from .timeout import _DEFAULT_TIMEOUT, _TYPE_TIMEOUT +from ..packages import six +from .wait import NoWayToWaitForSocketError, wait_for_read -_TYPE_SOCKET_OPTIONS = list[tuple[int, int, typing.Union[int, bytes]]] -if typing.TYPE_CHECKING: - from .._base_connection import BaseHTTPConnection - - -def is_connection_dropped(conn: BaseHTTPConnection) -> bool: # Platform-specific +def is_connection_dropped(conn): # Platform-specific """ Returns True if the connection is dropped and should be closed. - :param conn: :class:`urllib3.connection.HTTPConnection` object. + + :param conn: + :class:`http.client.HTTPConnection` object. + + Note: For platforms like AppEngine, this will always return ``False`` to + let the platform handle connection recycling transparently for us. """ - return not conn.is_connected + sock = getattr(conn, "sock", False) + if sock is False: # Platform-specific: AppEngine + return False + if sock is None: # Connection already closed (such as by httplib). + return True + try: + # Returns True if readable, which here means it's been dropped + return wait_for_read(sock, timeout=0.0) + except NoWayToWaitForSocketError: # Platform-specific: AppEngine + return False # This function is copied from socket.py in the Python 2.7 standard @@ -25,11 +35,11 @@ def is_connection_dropped(conn: BaseHTTPConnection) -> bool: # Platform-specifi # One additional modification is that we avoid binding to IPv6 servers # discovered in DNS if the system doesn't have IPv6 functionality. def create_connection( - address: tuple[str, int], - timeout: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, - source_address: tuple[str, int] | None = None, - socket_options: _TYPE_SOCKET_OPTIONS | None = None, -) -> socket.socket: + address, + timeout=socket._GLOBAL_DEFAULT_TIMEOUT, + source_address=None, + socket_options=None, +): """Connect to *address* and return the socket object. Convenience function. Connect to *address* (a 2-tuple ``(host, @@ -55,7 +65,9 @@ def create_connection( try: host.encode("idna") except UnicodeError: - raise LocationParseError(f"'{host}', label empty or too long") from None + return six.raise_from( + LocationParseError(u"'%s', label empty or too long" % host), None + ) for res in socket.getaddrinfo(host, port, family, socket.SOCK_STREAM): af, socktype, proto, canonname, sa = res @@ -66,33 +78,26 @@ def create_connection( # If provided, set socket level options before connecting. _set_socket_options(sock, socket_options) - if timeout is not _DEFAULT_TIMEOUT: + if timeout is not socket._GLOBAL_DEFAULT_TIMEOUT: sock.settimeout(timeout) if source_address: sock.bind(source_address) sock.connect(sa) - # Break explicitly a reference cycle - err = None return sock - except OSError as _: - err = _ + except socket.error as e: + err = e if sock is not None: sock.close() + sock = None if err is not None: - try: - raise err - finally: - # Break explicitly a reference cycle - err = None - else: - raise OSError("getaddrinfo returns an empty list") + raise err + raise socket.error("getaddrinfo returns an empty list") -def _set_socket_options( - sock: socket.socket, options: _TYPE_SOCKET_OPTIONS | None -) -> None: + +def _set_socket_options(sock, options): if options is None: return @@ -100,7 +105,7 @@ def _set_socket_options( sock.setsockopt(*opt) -def allowed_gai_family() -> socket.AddressFamily: +def allowed_gai_family(): """This function is designed to work in the context of getaddrinfo, where family=socket.AF_UNSPEC is the default and will perform a DNS search for both IPv6 and IPv4 records.""" @@ -111,11 +116,18 @@ def allowed_gai_family() -> socket.AddressFamily: return family -def _has_ipv6(host: str) -> bool: +def _has_ipv6(host): """Returns True if the system can bind an IPv6 address.""" sock = None has_ipv6 = False + # App Engine doesn't support IPV6 sockets and actually has a quota on the + # number of sockets that can be used, so just early out here instead of + # creating a socket needlessly. + # See https://github.com/urllib3/urllib3/issues/1446 + if _appengine_environ.is_appengine_sandbox(): + return False + if socket.has_ipv6: # has_ipv6 returns true if cPython was compiled with IPv6 support. # It does not tell us if the system has IPv6 support enabled. To diff --git a/newrelic/packages/urllib3/util/proxy.py b/newrelic/packages/urllib3/util/proxy.py index 908fc6621d..2199cc7b7f 100644 --- a/newrelic/packages/urllib3/util/proxy.py +++ b/newrelic/packages/urllib3/util/proxy.py @@ -1,18 +1,9 @@ -from __future__ import annotations - -import typing - -from .url import Url - -if typing.TYPE_CHECKING: - from ..connection import ProxyConfig +from .ssl_ import create_urllib3_context, resolve_cert_reqs, resolve_ssl_version def connection_requires_http_tunnel( - proxy_url: Url | None = None, - proxy_config: ProxyConfig | None = None, - destination_scheme: str | None = None, -) -> bool: + proxy_url=None, proxy_config=None, destination_scheme=None +): """ Returns True if the connection requires an HTTP CONNECT through the proxy. @@ -41,3 +32,26 @@ def connection_requires_http_tunnel( # Otherwise always use a tunnel. return True + + +def create_proxy_ssl_context( + ssl_version, cert_reqs, ca_certs=None, ca_cert_dir=None, ca_cert_data=None +): + """ + Generates a default proxy ssl context if one hasn't been provided by the + user. + """ + ssl_context = create_urllib3_context( + ssl_version=resolve_ssl_version(ssl_version), + cert_reqs=resolve_cert_reqs(cert_reqs), + ) + + if ( + not ca_certs + and not ca_cert_dir + and not ca_cert_data + and hasattr(ssl_context, "load_default_certs") + ): + ssl_context.load_default_certs() + + return ssl_context diff --git a/newrelic/packages/urllib3/util/queue.py b/newrelic/packages/urllib3/util/queue.py new file mode 100644 index 0000000000..41784104ee --- /dev/null +++ b/newrelic/packages/urllib3/util/queue.py @@ -0,0 +1,22 @@ +import collections + +from ..packages import six +from ..packages.six.moves import queue + +if six.PY2: + # Queue is imported for side effects on MS Windows. See issue #229. + import Queue as _unused_module_Queue # noqa: F401 + + +class LifoQueue(queue.Queue): + def _init(self, _): + self.queue = collections.deque() + + def _qsize(self, len=len): + return len(self.queue) + + def _put(self, item): + self.queue.append(item) + + def _get(self): + return self.queue.pop() diff --git a/newrelic/packages/urllib3/util/request.py b/newrelic/packages/urllib3/util/request.py index 6c2372ba7e..b574b081e9 100644 --- a/newrelic/packages/urllib3/util/request.py +++ b/newrelic/packages/urllib3/util/request.py @@ -1,16 +1,9 @@ -from __future__ import annotations +from __future__ import absolute_import -import io -import sys -import typing from base64 import b64encode -from enum import Enum from ..exceptions import UnrewindableBodyError -from .util import to_bytes - -if typing.TYPE_CHECKING: - from typing import Final +from ..packages.six import b, integer_types # Pass as a value within ``headers`` to skip # emitting some HTTP headers that are added automatically. @@ -22,49 +15,25 @@ ACCEPT_ENCODING = "gzip,deflate" try: try: - import brotlicffi as _unused_module_brotli # type: ignore[import-not-found] # noqa: F401 + import brotlicffi as _unused_module_brotli # noqa: F401 except ImportError: - import brotli as _unused_module_brotli # type: ignore[import-not-found] # noqa: F401 + import brotli as _unused_module_brotli # noqa: F401 except ImportError: pass else: ACCEPT_ENCODING += ",br" -try: - if sys.version_info >= (3, 14): - from compression import zstd as _unused_module_zstd # noqa: F401 - else: - from backports import zstd as _unused_module_zstd # noqa: F401 -except ImportError: - pass -else: - ACCEPT_ENCODING += ",zstd" - - -class _TYPE_FAILEDTELL(Enum): - token = 0 - - -_FAILEDTELL: Final[_TYPE_FAILEDTELL] = _TYPE_FAILEDTELL.token - -_TYPE_BODY_POSITION = typing.Union[int, _TYPE_FAILEDTELL] - -# When sending a request with these methods we aren't expecting -# a body so don't need to set an explicit 'Content-Length: 0' -# The reason we do this in the negative instead of tracking methods -# which 'should' have a body is because unknown methods should be -# treated as if they were 'POST' which *does* expect a body. -_METHODS_NOT_EXPECTING_BODY = {"GET", "HEAD", "DELETE", "TRACE", "OPTIONS", "CONNECT"} +_FAILEDTELL = object() def make_headers( - keep_alive: bool | None = None, - accept_encoding: bool | list[str] | str | None = None, - user_agent: str | None = None, - basic_auth: str | None = None, - proxy_basic_auth: str | None = None, - disable_cache: bool | None = None, -) -> dict[str, str]: + keep_alive=None, + accept_encoding=None, + user_agent=None, + basic_auth=None, + proxy_basic_auth=None, + disable_cache=None, +): """ Shortcuts for generating request headers. @@ -73,11 +42,7 @@ def make_headers( :param accept_encoding: Can be a boolean, list, or string. - ``True`` translates to 'gzip,deflate'. If the dependencies for - Brotli (either the ``brotli`` or ``brotlicffi`` package) and/or - Zstandard (the ``backports.zstd`` package for Python before 3.14) - algorithms are installed, then their encodings are - included in the string ('br' and 'zstd', respectively). + ``True`` translates to 'gzip,deflate'. List will get joined by comma. String will be used as provided. @@ -96,18 +61,14 @@ def make_headers( :param disable_cache: If ``True``, adds 'cache-control: no-cache' header. - Example: - - .. code-block:: python + Example:: - import urllib3 - - print(urllib3.util.make_headers(keep_alive=True, user_agent="Batman/1.0")) - # {'connection': 'keep-alive', 'user-agent': 'Batman/1.0'} - print(urllib3.util.make_headers(accept_encoding=True)) - # {'accept-encoding': 'gzip,deflate'} + >>> make_headers(keep_alive=True, user_agent="Batman/1.0") + {'connection': 'keep-alive', 'user-agent': 'Batman/1.0'} + >>> make_headers(accept_encoding=True) + {'accept-encoding': 'gzip,deflate'} """ - headers: dict[str, str] = {} + headers = {} if accept_encoding: if isinstance(accept_encoding, str): pass @@ -124,14 +85,12 @@ def make_headers( headers["connection"] = "keep-alive" if basic_auth: - headers["authorization"] = ( - f"Basic {b64encode(basic_auth.encode('latin-1')).decode()}" - ) + headers["authorization"] = "Basic " + b64encode(b(basic_auth)).decode("utf-8") if proxy_basic_auth: - headers["proxy-authorization"] = ( - f"Basic {b64encode(proxy_basic_auth.encode('latin-1')).decode()}" - ) + headers["proxy-authorization"] = "Basic " + b64encode( + b(proxy_basic_auth) + ).decode("utf-8") if disable_cache: headers["cache-control"] = "no-cache" @@ -139,9 +98,7 @@ def make_headers( return headers -def set_file_position( - body: typing.Any, pos: _TYPE_BODY_POSITION | None -) -> _TYPE_BODY_POSITION | None: +def set_file_position(body, pos): """ If a position is provided, move file to that point. Otherwise, we'll attempt to record a position for future use. @@ -151,7 +108,7 @@ def set_file_position( elif getattr(body, "tell", None) is not None: try: pos = body.tell() - except OSError: + except (IOError, OSError): # This differentiates from None, allowing us to catch # a failed `tell()` later when trying to rewind the body. pos = _FAILEDTELL @@ -159,7 +116,7 @@ def set_file_position( return pos -def rewind_body(body: typing.IO[typing.AnyStr], body_pos: _TYPE_BODY_POSITION) -> None: +def rewind_body(body, body_pos): """ Attempt to rewind body to a certain position. Primarily used for request redirects and retries. @@ -171,13 +128,13 @@ def rewind_body(body: typing.IO[typing.AnyStr], body_pos: _TYPE_BODY_POSITION) - Position to seek to in file. """ body_seek = getattr(body, "seek", None) - if body_seek is not None and isinstance(body_pos, int): + if body_seek is not None and isinstance(body_pos, integer_types): try: body_seek(body_pos) - except OSError as e: + except (IOError, OSError): raise UnrewindableBodyError( "An error occurred when rewinding request body for redirect/retry." - ) from e + ) elif body_pos is _FAILEDTELL: raise UnrewindableBodyError( "Unable to record file position for rewinding " @@ -185,79 +142,5 @@ def rewind_body(body: typing.IO[typing.AnyStr], body_pos: _TYPE_BODY_POSITION) - ) else: raise ValueError( - f"body_pos must be of type integer, instead it was {type(body_pos)}." + "body_pos must be of type integer, instead it was %s." % type(body_pos) ) - - -class ChunksAndContentLength(typing.NamedTuple): - chunks: typing.Iterable[bytes] | None - content_length: int | None - - -def body_to_chunks( - body: typing.Any | None, method: str, blocksize: int -) -> ChunksAndContentLength: - """Takes the HTTP request method, body, and blocksize and - transforms them into an iterable of chunks to pass to - socket.sendall() and an optional 'Content-Length' header. - - A 'Content-Length' of 'None' indicates the length of the body - can't be determined so should use 'Transfer-Encoding: chunked' - for framing instead. - """ - - chunks: typing.Iterable[bytes] | None - content_length: int | None - - # No body, we need to make a recommendation on 'Content-Length' - # based on whether that request method is expected to have - # a body or not. - if body is None: - chunks = None - if method.upper() not in _METHODS_NOT_EXPECTING_BODY: - content_length = 0 - else: - content_length = None - - # Bytes or strings become bytes - elif isinstance(body, (str, bytes)): - chunks = (to_bytes(body),) - content_length = len(chunks[0]) - - # File-like object, TODO: use seek() and tell() for length? - elif hasattr(body, "read"): - - def chunk_readable() -> typing.Iterable[bytes]: - encode = isinstance(body, io.TextIOBase) - while True: - datablock = body.read(blocksize) - if not datablock: - break - if encode: - datablock = datablock.encode("utf-8") - yield datablock - - chunks = chunk_readable() - content_length = None - - # Otherwise we need to start checking via duck-typing. - else: - try: - # Check if the body implements the buffer API. - mv = memoryview(body) - except TypeError: - try: - # Check if the body is an iterable - chunks = iter(body) - content_length = None - except TypeError: - raise TypeError( - f"'body' must be a bytes-like object, file-like " - f"object, or iterable. Instead was {body!r}" - ) from None - else: - # Since it implements the buffer API can be passed directly to socket.sendall() - chunks = (body,) - content_length = mv.nbytes - - return ChunksAndContentLength(chunks=chunks, content_length=content_length) diff --git a/newrelic/packages/urllib3/util/response.py b/newrelic/packages/urllib3/util/response.py index 0f4578696f..5ea609cced 100644 --- a/newrelic/packages/urllib3/util/response.py +++ b/newrelic/packages/urllib3/util/response.py @@ -1,12 +1,12 @@ -from __future__ import annotations +from __future__ import absolute_import -import http.client as httplib from email.errors import MultipartInvariantViolationDefect, StartBoundaryNotFoundDefect from ..exceptions import HeaderParsingError +from ..packages.six.moves import http_client as httplib -def is_fp_closed(obj: object) -> bool: +def is_fp_closed(obj): """ Checks whether a given file-like object is closed. @@ -17,27 +17,27 @@ def is_fp_closed(obj: object) -> bool: try: # Check `isclosed()` first, in case Python3 doesn't set `closed`. # GH Issue #928 - return obj.isclosed() # type: ignore[no-any-return, attr-defined] + return obj.isclosed() except AttributeError: pass try: # Check via the official file-like-object way. - return obj.closed # type: ignore[no-any-return, attr-defined] + return obj.closed except AttributeError: pass try: # Check if the object is a container for another file-like object that # gets released on exhaustion (e.g. HTTPResponse). - return obj.fp is None # type: ignore[attr-defined] + return obj.fp is None except AttributeError: pass raise ValueError("Unable to determine whether fp is closed.") -def assert_header_parsing(headers: httplib.HTTPMessage) -> None: +def assert_header_parsing(headers): """ Asserts whether all headers have been successfully parsed. Extracts encountered errors from the result of parsing headers. @@ -53,49 +53,55 @@ def assert_header_parsing(headers: httplib.HTTPMessage) -> None: # This will fail silently if we pass in the wrong kind of parameter. # To make debugging easier add an explicit check. if not isinstance(headers, httplib.HTTPMessage): - raise TypeError(f"expected httplib.Message, got {type(headers)}.") + raise TypeError("expected httplib.Message, got {0}.".format(type(headers))) - unparsed_data = None + defects = getattr(headers, "defects", None) + get_payload = getattr(headers, "get_payload", None) - # get_payload is actually email.message.Message.get_payload; - # we're only interested in the result if it's not a multipart message - if not headers.is_multipart(): - payload = headers.get_payload() - - if isinstance(payload, (bytes, str)): - unparsed_data = payload - - # httplib is assuming a response body is available - # when parsing headers even when httplib only sends - # header data to parse_headers() This results in - # defects on multipart responses in particular. - # See: https://github.com/urllib3/urllib3/issues/800 - - # So we ignore the following defects: - # - StartBoundaryNotFoundDefect: - # The claimed start boundary was never found. - # - MultipartInvariantViolationDefect: - # A message claimed to be a multipart but no subparts were found. - defects = [ - defect - for defect in headers.defects - if not isinstance( - defect, (StartBoundaryNotFoundDefect, MultipartInvariantViolationDefect) - ) - ] + unparsed_data = None + if get_payload: + # get_payload is actually email.message.Message.get_payload; + # we're only interested in the result if it's not a multipart message + if not headers.is_multipart(): + payload = get_payload() + + if isinstance(payload, (bytes, str)): + unparsed_data = payload + if defects: + # httplib is assuming a response body is available + # when parsing headers even when httplib only sends + # header data to parse_headers() This results in + # defects on multipart responses in particular. + # See: https://github.com/urllib3/urllib3/issues/800 + + # So we ignore the following defects: + # - StartBoundaryNotFoundDefect: + # The claimed start boundary was never found. + # - MultipartInvariantViolationDefect: + # A message claimed to be a multipart but no subparts were found. + defects = [ + defect + for defect in defects + if not isinstance( + defect, (StartBoundaryNotFoundDefect, MultipartInvariantViolationDefect) + ) + ] if defects or unparsed_data: raise HeaderParsingError(defects=defects, unparsed_data=unparsed_data) -def is_response_to_head(response: httplib.HTTPResponse) -> bool: +def is_response_to_head(response): """ Checks whether the request of a response has been a HEAD-request. + Handles the quirks of AppEngine. :param http.client.HTTPResponse response: Response to check if the originating request used 'HEAD' as a method. """ # FIXME: Can we do this somehow without accessing private httplib _method? - method_str = response._method # type: str # type: ignore[attr-defined] - return method_str.upper() == "HEAD" + method = response._method + if isinstance(method, int): # Platform-specific: Appengine + return method == 3 + return method.upper() == "HEAD" diff --git a/newrelic/packages/urllib3/util/retry.py b/newrelic/packages/urllib3/util/retry.py index b21b4b64eb..9a1e90d0b2 100644 --- a/newrelic/packages/urllib3/util/retry.py +++ b/newrelic/packages/urllib3/util/retry.py @@ -1,13 +1,12 @@ -from __future__ import annotations +from __future__ import absolute_import import email import logging -import random import re import time -import typing +import warnings +from collections import namedtuple from itertools import takewhile -from types import TracebackType from ..exceptions import ( ConnectTimeoutError, @@ -18,51 +17,97 @@ ReadTimeoutError, ResponseError, ) -from .util import reraise - -if typing.TYPE_CHECKING: - from typing_extensions import Self - - from ..connectionpool import ConnectionPool - from ..response import BaseHTTPResponse +from ..packages import six log = logging.getLogger(__name__) # Data structure for representing the metadata of requests that result in a retry. -class RequestHistory(typing.NamedTuple): - method: str | None - url: str | None - error: Exception | None - status: int | None - redirect_location: str | None +RequestHistory = namedtuple( + "RequestHistory", ["method", "url", "error", "status", "redirect_location"] +) + + +# TODO: In v2 we can remove this sentinel and metaclass with deprecated options. +_Default = object() + + +class _RetryMeta(type): + @property + def DEFAULT_METHOD_WHITELIST(cls): + warnings.warn( + "Using 'Retry.DEFAULT_METHOD_WHITELIST' is deprecated and " + "will be removed in v2.0. Use 'Retry.DEFAULT_ALLOWED_METHODS' instead", + DeprecationWarning, + ) + return cls.DEFAULT_ALLOWED_METHODS + + @DEFAULT_METHOD_WHITELIST.setter + def DEFAULT_METHOD_WHITELIST(cls, value): + warnings.warn( + "Using 'Retry.DEFAULT_METHOD_WHITELIST' is deprecated and " + "will be removed in v2.0. Use 'Retry.DEFAULT_ALLOWED_METHODS' instead", + DeprecationWarning, + ) + cls.DEFAULT_ALLOWED_METHODS = value + + @property + def DEFAULT_REDIRECT_HEADERS_BLACKLIST(cls): + warnings.warn( + "Using 'Retry.DEFAULT_REDIRECT_HEADERS_BLACKLIST' is deprecated and " + "will be removed in v2.0. Use 'Retry.DEFAULT_REMOVE_HEADERS_ON_REDIRECT' instead", + DeprecationWarning, + ) + return cls.DEFAULT_REMOVE_HEADERS_ON_REDIRECT + + @DEFAULT_REDIRECT_HEADERS_BLACKLIST.setter + def DEFAULT_REDIRECT_HEADERS_BLACKLIST(cls, value): + warnings.warn( + "Using 'Retry.DEFAULT_REDIRECT_HEADERS_BLACKLIST' is deprecated and " + "will be removed in v2.0. Use 'Retry.DEFAULT_REMOVE_HEADERS_ON_REDIRECT' instead", + DeprecationWarning, + ) + cls.DEFAULT_REMOVE_HEADERS_ON_REDIRECT = value + + @property + def BACKOFF_MAX(cls): + warnings.warn( + "Using 'Retry.BACKOFF_MAX' is deprecated and " + "will be removed in v2.0. Use 'Retry.DEFAULT_BACKOFF_MAX' instead", + DeprecationWarning, + ) + return cls.DEFAULT_BACKOFF_MAX + + @BACKOFF_MAX.setter + def BACKOFF_MAX(cls, value): + warnings.warn( + "Using 'Retry.BACKOFF_MAX' is deprecated and " + "will be removed in v2.0. Use 'Retry.DEFAULT_BACKOFF_MAX' instead", + DeprecationWarning, + ) + cls.DEFAULT_BACKOFF_MAX = value -class Retry: +@six.add_metaclass(_RetryMeta) +class Retry(object): """Retry configuration. Each retry attempt will create a new Retry object with updated values, so they can be safely reused. - Retries can be defined as a default for a pool: - - .. code-block:: python + Retries can be defined as a default for a pool:: retries = Retry(connect=5, read=2, redirect=5) http = PoolManager(retries=retries) - response = http.request("GET", "https://example.com/") + response = http.request('GET', 'http://example.com/') - Or per-request (which overrides the default for the pool): + Or per-request (which overrides the default for the pool):: - .. code-block:: python + response = http.request('GET', 'http://example.com/', retries=Retry(10)) - response = http.request("GET", "https://example.com/", retries=Retry(10)) + Retries can be disabled by passing ``False``:: - Retries can be disabled by passing ``False``: - - .. code-block:: python - - response = http.request("GET", "https://example.com/", retries=False) + response = http.request('GET', 'http://example.com/', retries=False) Errors will be wrapped in :class:`~urllib3.exceptions.MaxRetryError` unless retries are disabled, in which case the causing exception will be raised. @@ -124,16 +169,21 @@ class Retry: If ``total`` is not set, it's a good idea to set this to 0 to account for unexpected edge cases and avoid infinite retry loops. - :param Collection allowed_methods: + :param iterable allowed_methods: Set of uppercased HTTP method verbs that we should retry on. By default, we only retry on methods which are considered to be idempotent (multiple requests with the same parameters end with the same state). See :attr:`Retry.DEFAULT_ALLOWED_METHODS`. - Set to a ``None`` value to retry on any verb. + Set to a ``False`` value to retry on any verb. + + .. warning:: + + Previously this parameter was named ``method_whitelist``, that + usage is deprecated in v1.26.0 and will be removed in v2.0. - :param Collection status_forcelist: + :param iterable status_forcelist: A set of integer HTTP status codes that we should force a retry on. A retry is initiated if the request method is in ``allowed_methods`` and the response status code is in ``status_forcelist``. @@ -145,17 +195,13 @@ class Retry: (most errors are resolved immediately by a second try without a delay). urllib3 will sleep for:: - {backoff factor} * (2 ** ({number of previous retries})) + {backoff factor} * (2 ** ({number of total retries} - 1)) - seconds. If `backoff_jitter` is non-zero, this sleep is extended by:: + seconds. If the backoff_factor is 0.1, then :func:`.sleep` will sleep + for [0.0s, 0.2s, 0.4s, ...] between retries. It will never be longer + than :attr:`Retry.DEFAULT_BACKOFF_MAX`. - random.uniform(0, {backoff jitter}) - - seconds. For example, if the backoff_factor is 0.1, then :func:`Retry.sleep` will - sleep for [0.0s, 0.2s, 0.4s, 0.8s, ...] between retries. No backoff will ever - be longer than `backoff_max`. - - By default, backoff is disabled (factor set to 0). + By default, backoff is disabled (set to 0). :param bool raise_on_redirect: Whether, if the number of redirects is exhausted, to raise a MaxRetryError, or to return a response with a @@ -174,15 +220,10 @@ class Retry: Whether to respect Retry-After header on status codes defined as :attr:`Retry.RETRY_AFTER_STATUS_CODES` or not. - :param Collection remove_headers_on_redirect: + :param iterable remove_headers_on_redirect: Sequence of headers to remove from the request when a response indicating a redirect is returned before firing off the redirected request. - - :param int retry_after_max: Number of seconds to allow as the maximum for - Retry-After headers. Defaults to :attr:`Retry.DEFAULT_RETRY_AFTER_MAX`. - Any Retry-After headers larger than this value will be limited to this - value. """ #: Default methods to be used for ``allowed_methods`` @@ -198,38 +239,48 @@ class Retry: ["Cookie", "Authorization", "Proxy-Authorization"] ) - #: Default maximum backoff time. + #: Maximum backoff time. DEFAULT_BACKOFF_MAX = 120 - # This is undocumented in the RFC. Setting to 6 hours matches other popular libraries. - #: Default maximum allowed value for Retry-After headers in seconds - DEFAULT_RETRY_AFTER_MAX: typing.Final[int] = 21600 - - # Backward compatibility; assigned outside of the class. - DEFAULT: typing.ClassVar[Retry] - def __init__( self, - total: bool | int | None = 10, - connect: int | None = None, - read: int | None = None, - redirect: bool | int | None = None, - status: int | None = None, - other: int | None = None, - allowed_methods: typing.Collection[str] | None = DEFAULT_ALLOWED_METHODS, - status_forcelist: typing.Collection[int] | None = None, - backoff_factor: float = 0, - backoff_max: float = DEFAULT_BACKOFF_MAX, - raise_on_redirect: bool = True, - raise_on_status: bool = True, - history: tuple[RequestHistory, ...] | None = None, - respect_retry_after_header: bool = True, - remove_headers_on_redirect: typing.Collection[ - str - ] = DEFAULT_REMOVE_HEADERS_ON_REDIRECT, - backoff_jitter: float = 0.0, - retry_after_max: int = DEFAULT_RETRY_AFTER_MAX, - ) -> None: + total=10, + connect=None, + read=None, + redirect=None, + status=None, + other=None, + allowed_methods=_Default, + status_forcelist=None, + backoff_factor=0, + raise_on_redirect=True, + raise_on_status=True, + history=None, + respect_retry_after_header=True, + remove_headers_on_redirect=_Default, + # TODO: Deprecated, remove in v2.0 + method_whitelist=_Default, + ): + + if method_whitelist is not _Default: + if allowed_methods is not _Default: + raise ValueError( + "Using both 'allowed_methods' and " + "'method_whitelist' together is not allowed. " + "Instead only use 'allowed_methods'" + ) + warnings.warn( + "Using 'method_whitelist' with Retry is deprecated and " + "will be removed in v2.0. Use 'allowed_methods' instead", + DeprecationWarning, + stacklevel=2, + ) + allowed_methods = method_whitelist + if allowed_methods is _Default: + allowed_methods = self.DEFAULT_ALLOWED_METHODS + if remove_headers_on_redirect is _Default: + remove_headers_on_redirect = self.DEFAULT_REMOVE_HEADERS_ON_REDIRECT + self.total = total self.connect = connect self.read = read @@ -244,18 +295,15 @@ def __init__( self.status_forcelist = status_forcelist or set() self.allowed_methods = allowed_methods self.backoff_factor = backoff_factor - self.backoff_max = backoff_max - self.retry_after_max = retry_after_max self.raise_on_redirect = raise_on_redirect self.raise_on_status = raise_on_status - self.history = history or () + self.history = history or tuple() self.respect_retry_after_header = respect_retry_after_header self.remove_headers_on_redirect = frozenset( - h.lower() for h in remove_headers_on_redirect + [h.lower() for h in remove_headers_on_redirect] ) - self.backoff_jitter = backoff_jitter - def new(self, **kw: typing.Any) -> Self: + def new(self, **kw): params = dict( total=self.total, connect=self.connect, @@ -263,29 +311,36 @@ def new(self, **kw: typing.Any) -> Self: redirect=self.redirect, status=self.status, other=self.other, - allowed_methods=self.allowed_methods, status_forcelist=self.status_forcelist, backoff_factor=self.backoff_factor, - backoff_max=self.backoff_max, - retry_after_max=self.retry_after_max, raise_on_redirect=self.raise_on_redirect, raise_on_status=self.raise_on_status, history=self.history, remove_headers_on_redirect=self.remove_headers_on_redirect, respect_retry_after_header=self.respect_retry_after_header, - backoff_jitter=self.backoff_jitter, ) + # TODO: If already given in **kw we use what's given to us + # If not given we need to figure out what to pass. We decide + # based on whether our class has the 'method_whitelist' property + # and if so we pass the deprecated 'method_whitelist' otherwise + # we use 'allowed_methods'. Remove in v2.0 + if "method_whitelist" not in kw and "allowed_methods" not in kw: + if "method_whitelist" in self.__dict__: + warnings.warn( + "Using 'method_whitelist' with Retry is deprecated and " + "will be removed in v2.0. Use 'allowed_methods' instead", + DeprecationWarning, + ) + params["method_whitelist"] = self.allowed_methods + else: + params["allowed_methods"] = self.allowed_methods + params.update(kw) - return type(self)(**params) # type: ignore[arg-type] + return type(self)(**params) @classmethod - def from_int( - cls, - retries: Retry | bool | int | None, - redirect: bool | int | None = True, - default: Retry | bool | int | None = None, - ) -> Retry: + def from_int(cls, retries, redirect=True, default=None): """Backwards-compatibility for the old retries format.""" if retries is None: retries = default if default is not None else cls.DEFAULT @@ -298,7 +353,7 @@ def from_int( log.debug("Converted retries value: %r -> %r", retries, new_retries) return new_retries - def get_backoff_time(self) -> float: + def get_backoff_time(self): """Formula for computing the current backoff :rtype: float @@ -313,32 +368,32 @@ def get_backoff_time(self) -> float: return 0 backoff_value = self.backoff_factor * (2 ** (consecutive_errors_len - 1)) - if self.backoff_jitter != 0.0: - backoff_value += random.random() * self.backoff_jitter - return float(max(0, min(self.backoff_max, backoff_value))) + return min(self.DEFAULT_BACKOFF_MAX, backoff_value) - def parse_retry_after(self, retry_after: str) -> float: - seconds: float + def parse_retry_after(self, retry_after): # Whitespace: https://tools.ietf.org/html/rfc7230#section-3.2.4 if re.match(r"^\s*[0-9]+\s*$", retry_after): seconds = int(retry_after) else: retry_date_tuple = email.utils.parsedate_tz(retry_after) if retry_date_tuple is None: - raise InvalidHeader(f"Invalid Retry-After header: {retry_after}") + raise InvalidHeader("Invalid Retry-After header: %s" % retry_after) + if retry_date_tuple[9] is None: # Python 2 + # Assume UTC if no timezone was specified + # On Python2.7, parsedate_tz returns None for a timezone offset + # instead of 0 if no timezone is given, where mktime_tz treats + # a None timezone offset as local time. + retry_date_tuple = retry_date_tuple[:9] + (0,) + retry_date_tuple[10:] retry_date = email.utils.mktime_tz(retry_date_tuple) seconds = retry_date - time.time() - seconds = max(seconds, 0) - - # Check the seconds do not exceed the specified maximum - if seconds > self.retry_after_max: - seconds = self.retry_after_max + if seconds < 0: + seconds = 0 return seconds - def get_retry_after(self, response: BaseHTTPResponse) -> float | None: + def get_retry_after(self, response): """Get the value of Retry-After in seconds.""" retry_after = response.headers.get("Retry-After") @@ -348,7 +403,7 @@ def get_retry_after(self, response: BaseHTTPResponse) -> float | None: return self.parse_retry_after(retry_after) - def sleep_for_retry(self, response: BaseHTTPResponse) -> bool: + def sleep_for_retry(self, response=None): retry_after = self.get_retry_after(response) if retry_after: time.sleep(retry_after) @@ -356,13 +411,13 @@ def sleep_for_retry(self, response: BaseHTTPResponse) -> bool: return False - def _sleep_backoff(self) -> None: + def _sleep_backoff(self): backoff = self.get_backoff_time() if backoff <= 0: return time.sleep(backoff) - def sleep(self, response: BaseHTTPResponse | None = None) -> None: + def sleep(self, response=None): """Sleep between retry attempts. This method will respect a server's ``Retry-After`` response header @@ -378,7 +433,7 @@ def sleep(self, response: BaseHTTPResponse | None = None) -> None: self._sleep_backoff() - def _is_connection_error(self, err: Exception) -> bool: + def _is_connection_error(self, err): """Errors when we're fairly sure that the server did not receive the request, so it should be safe to retry. """ @@ -386,23 +441,33 @@ def _is_connection_error(self, err: Exception) -> bool: err = err.original_error return isinstance(err, ConnectTimeoutError) - def _is_read_error(self, err: Exception) -> bool: + def _is_read_error(self, err): """Errors that occur after the request has been started, so we should assume that the server began processing it. """ return isinstance(err, (ReadTimeoutError, ProtocolError)) - def _is_method_retryable(self, method: str) -> bool: + def _is_method_retryable(self, method): """Checks if a given HTTP method should be retried upon, depending if it is included in the allowed_methods """ - if self.allowed_methods and method.upper() not in self.allowed_methods: + # TODO: For now favor if the Retry implementation sets its own method_whitelist + # property outside of our constructor to avoid breaking custom implementations. + if "method_whitelist" in self.__dict__: + warnings.warn( + "Using 'method_whitelist' with Retry is deprecated and " + "will be removed in v2.0. Use 'allowed_methods' instead", + DeprecationWarning, + ) + allowed_methods = self.method_whitelist + else: + allowed_methods = self.allowed_methods + + if allowed_methods and method.upper() not in allowed_methods: return False return True - def is_retry( - self, method: str, status_code: int, has_retry_after: bool = False - ) -> bool: + def is_retry(self, method, status_code, has_retry_after=False): """Is this method/status code retryable? (Based on allowlists and control variables such as the number of total retries to allow, whether to respect the Retry-After header, whether this header is present, and @@ -415,27 +480,24 @@ def is_retry( if self.status_forcelist and status_code in self.status_forcelist: return True - return bool( + return ( self.total and self.respect_retry_after_header and has_retry_after and (status_code in self.RETRY_AFTER_STATUS_CODES) ) - def is_exhausted(self) -> bool: + def is_exhausted(self): """Are we out of retries?""" - retry_counts = [ - x - for x in ( - self.total, - self.connect, - self.read, - self.redirect, - self.status, - self.other, - ) - if x - ] + retry_counts = ( + self.total, + self.connect, + self.read, + self.redirect, + self.status, + self.other, + ) + retry_counts = list(filter(None, retry_counts)) if not retry_counts: return False @@ -443,18 +505,18 @@ def is_exhausted(self) -> bool: def increment( self, - method: str | None = None, - url: str | None = None, - response: BaseHTTPResponse | None = None, - error: Exception | None = None, - _pool: ConnectionPool | None = None, - _stacktrace: TracebackType | None = None, - ) -> Self: + method=None, + url=None, + response=None, + error=None, + _pool=None, + _stacktrace=None, + ): """Return a new Retry object with incremented retry counters. :param response: A response object, or None, if the server did not return a response. - :type response: :class:`~urllib3.response.BaseHTTPResponse` + :type response: :class:`~urllib3.response.HTTPResponse` :param Exception error: An error encountered during the request, or None if the response was received successfully. @@ -462,7 +524,7 @@ def increment( """ if self.total is False and error: # Disabled, indicate to re-raise the error. - raise reraise(type(error), error, _stacktrace) + raise six.reraise(type(error), error, _stacktrace) total = self.total if total is not None: @@ -480,14 +542,14 @@ def increment( if error and self._is_connection_error(error): # Connect retry? if connect is False: - raise reraise(type(error), error, _stacktrace) + raise six.reraise(type(error), error, _stacktrace) elif connect is not None: connect -= 1 elif error and self._is_read_error(error): # Read retry? - if read is False or method is None or not self._is_method_retryable(method): - raise reraise(type(error), error, _stacktrace) + if read is False or not self._is_method_retryable(method): + raise six.reraise(type(error), error, _stacktrace) elif read is not None: read -= 1 @@ -501,9 +563,7 @@ def increment( if redirect is not None: redirect -= 1 cause = "too many redirects" - response_redirect_location = response.get_redirect_location() - if response_redirect_location: - redirect_location = response_redirect_location + redirect_location = response.get_redirect_location() status = response.status else: @@ -531,18 +591,31 @@ def increment( ) if new_retry.is_exhausted(): - reason = error or ResponseError(cause) - raise MaxRetryError(_pool, url, reason) from reason # type: ignore[arg-type] + raise MaxRetryError(_pool, url, error or ResponseError(cause)) log.debug("Incremented Retry for (url='%s'): %r", url, new_retry) return new_retry - def __repr__(self) -> str: + def __repr__(self): return ( - f"{type(self).__name__}(total={self.total}, connect={self.connect}, " - f"read={self.read}, redirect={self.redirect}, status={self.status})" - ) + "{cls.__name__}(total={self.total}, connect={self.connect}, " + "read={self.read}, redirect={self.redirect}, status={self.status})" + ).format(cls=type(self), self=self) + + def __getattr__(self, item): + if item == "method_whitelist": + # TODO: Remove this deprecated alias in v2.0 + warnings.warn( + "Using 'method_whitelist' with Retry is deprecated and " + "will be removed in v2.0. Use 'allowed_methods' instead", + DeprecationWarning, + ) + return self.allowed_methods + try: + return getattr(super(Retry, self), item) + except AttributeError: + return getattr(Retry, item) # For backwards compatibility (equivalent to pre-v1.9): diff --git a/newrelic/packages/urllib3/util/ssl_.py b/newrelic/packages/urllib3/util/ssl_.py index 56fe9093ad..8f867812a5 100644 --- a/newrelic/packages/urllib3/util/ssl_.py +++ b/newrelic/packages/urllib3/util/ssl_.py @@ -1,155 +1,185 @@ -from __future__ import annotations +from __future__ import absolute_import -import hashlib import hmac import os -import socket import sys -import typing import warnings -from binascii import unhexlify - -from ..exceptions import ProxySchemeUnsupported, SSLError -from .url import _BRACELESS_IPV6_ADDRZ_RE, _IPV4_RE +from binascii import hexlify, unhexlify +from hashlib import md5, sha1, sha256 + +from ..exceptions import ( + InsecurePlatformWarning, + ProxySchemeUnsupported, + SNIMissingWarning, + SSLError, +) +from ..packages import six +from .url import BRACELESS_IPV6_ADDRZ_RE, IPV4_RE SSLContext = None SSLTransport = None -HAS_NEVER_CHECK_COMMON_NAME = False +HAS_SNI = False IS_PYOPENSSL = False +IS_SECURETRANSPORT = False ALPN_PROTOCOLS = ["http/1.1"] -_TYPE_VERSION_INFO = tuple[int, int, int, str, int] - # Maps the length of a digest to a possible hash function producing this digest -HASHFUNC_MAP = { - length: getattr(hashlib, algorithm, None) - for length, algorithm in ((32, "md5"), (40, "sha1"), (64, "sha256")) -} - - -def _is_bpo_43522_fixed( - implementation_name: str, - version_info: _TYPE_VERSION_INFO, - pypy_version_info: _TYPE_VERSION_INFO | None, -) -> bool: - """Return True for CPython 3.9.3+ or 3.10+ and PyPy 7.3.8+ where - setting SSLContext.hostname_checks_common_name to False works. - - Outside of CPython and PyPy we don't know which implementations work - or not so we conservatively use our hostname matching as we know that works - on all implementations. - - https://github.com/urllib3/urllib3/issues/2192#issuecomment-821832963 - https://foss.heptapod.net/pypy/pypy/-/issues/3539 +HASHFUNC_MAP = {32: md5, 40: sha1, 64: sha256} + + +def _const_compare_digest_backport(a, b): """ - if implementation_name == "pypy": - # https://foss.heptapod.net/pypy/pypy/-/issues/3129 - return pypy_version_info >= (7, 3, 8) # type: ignore[operator] - elif implementation_name == "cpython": - major_minor = version_info[:2] - micro = version_info[2] - return (major_minor == (3, 9) and micro >= 3) or major_minor >= (3, 10) - else: # Defensive: - return False - - -def _is_has_never_check_common_name_reliable( - openssl_version: str, - openssl_version_number: int, - implementation_name: str, - version_info: _TYPE_VERSION_INFO, - pypy_version_info: _TYPE_VERSION_INFO | None, -) -> bool: - # As of May 2023, all released versions of LibreSSL fail to reject certificates with - # only common names, see https://github.com/urllib3/urllib3/pull/3024 - is_openssl = openssl_version.startswith("OpenSSL ") - # Before fixing OpenSSL issue #14579, the SSL_new() API was not copying hostflags - # like X509_CHECK_FLAG_NEVER_CHECK_SUBJECT, which tripped up CPython. - # https://github.com/openssl/openssl/issues/14579 - # This was released in OpenSSL 1.1.1l+ (>=0x101010cf) - is_openssl_issue_14579_fixed = openssl_version_number >= 0x101010CF - - return is_openssl and ( - is_openssl_issue_14579_fixed - or _is_bpo_43522_fixed(implementation_name, version_info, pypy_version_info) - ) + Compare two digests of equal length in constant time. + + The digests must be of type str/bytes. + Returns True if the digests match, and False otherwise. + """ + result = abs(len(a) - len(b)) + for left, right in zip(bytearray(a), bytearray(b)): + result |= left ^ right + return result == 0 -if typing.TYPE_CHECKING: - from ssl import VerifyMode - from typing import TypedDict +_const_compare_digest = getattr(hmac, "compare_digest", _const_compare_digest_backport) - from .ssltransport import SSLTransport as SSLTransportType +try: # Test for SSL features + import ssl + from ssl import CERT_REQUIRED, wrap_socket +except ImportError: + pass - class _TYPE_PEER_CERT_RET_DICT(TypedDict, total=False): - subjectAltName: tuple[tuple[str, str], ...] - subject: tuple[tuple[tuple[str, str], ...], ...] - serialNumber: str +try: + from ssl import HAS_SNI # Has SNI? +except ImportError: + pass +try: + from .ssltransport import SSLTransport +except ImportError: + pass -# Mapping from 'ssl.PROTOCOL_TLSX' to 'TLSVersion.X' -_SSL_VERSION_TO_TLS_VERSION: dict[int, int] = {} -try: # Do we have ssl at all? - import ssl - from ssl import ( # type: ignore[assignment] - CERT_REQUIRED, - HAS_NEVER_CHECK_COMMON_NAME, - OP_NO_COMPRESSION, - OP_NO_TICKET, - OPENSSL_VERSION, - OPENSSL_VERSION_NUMBER, - PROTOCOL_TLS, - PROTOCOL_TLS_CLIENT, - VERIFY_X509_STRICT, - OP_NO_SSLv2, - OP_NO_SSLv3, - SSLContext, - TLSVersion, - ) +try: # Platform-specific: Python 3.6 + from ssl import PROTOCOL_TLS PROTOCOL_SSLv23 = PROTOCOL_TLS +except ImportError: + try: + from ssl import PROTOCOL_SSLv23 as PROTOCOL_TLS - # Needed for Python 3.9 which does not define this - VERIFY_X509_PARTIAL_CHAIN = getattr(ssl, "VERIFY_X509_PARTIAL_CHAIN", 0x80000) - - # Setting SSLContext.hostname_checks_common_name = False didn't work before CPython - # 3.9.3, and 3.10 (but OK on PyPy) or OpenSSL 1.1.1l+ - if HAS_NEVER_CHECK_COMMON_NAME and not _is_has_never_check_common_name_reliable( - OPENSSL_VERSION, - OPENSSL_VERSION_NUMBER, - sys.implementation.name, - sys.version_info, - sys.pypy_version_info if sys.implementation.name == "pypy" else None, # type: ignore[attr-defined] - ): # Defensive: for Python < 3.9.3 - HAS_NEVER_CHECK_COMMON_NAME = False - - # Need to be careful here in case old TLS versions get - # removed in future 'ssl' module implementations. - for attr in ("TLSv1", "TLSv1_1", "TLSv1_2"): - try: - _SSL_VERSION_TO_TLS_VERSION[getattr(ssl, f"PROTOCOL_{attr}")] = getattr( - TLSVersion, attr - ) - except AttributeError: # Defensive: - continue + PROTOCOL_SSLv23 = PROTOCOL_TLS + except ImportError: + PROTOCOL_SSLv23 = PROTOCOL_TLS = 2 - from .ssltransport import SSLTransport # type: ignore[assignment] +try: + from ssl import PROTOCOL_TLS_CLIENT except ImportError: - OP_NO_COMPRESSION = 0x20000 # type: ignore[assignment, misc] - OP_NO_TICKET = 0x4000 # type: ignore[assignment, misc] - OP_NO_SSLv2 = 0x1000000 # type: ignore[assignment, misc] - OP_NO_SSLv3 = 0x2000000 # type: ignore[assignment, misc] - PROTOCOL_SSLv23 = PROTOCOL_TLS = 2 # type: ignore[assignment, misc] - PROTOCOL_TLS_CLIENT = 16 # type: ignore[assignment, misc] - VERIFY_X509_PARTIAL_CHAIN = 0x80000 - VERIFY_X509_STRICT = 0x20 # type: ignore[assignment, misc] + PROTOCOL_TLS_CLIENT = PROTOCOL_TLS -_TYPE_PEER_CERT_RET = typing.Union["_TYPE_PEER_CERT_RET_DICT", bytes, None] +try: + from ssl import OP_NO_COMPRESSION, OP_NO_SSLv2, OP_NO_SSLv3 +except ImportError: + OP_NO_SSLv2, OP_NO_SSLv3 = 0x1000000, 0x2000000 + OP_NO_COMPRESSION = 0x20000 -def assert_fingerprint(cert: bytes | None, fingerprint: str) -> None: +try: # OP_NO_TICKET was added in Python 3.6 + from ssl import OP_NO_TICKET +except ImportError: + OP_NO_TICKET = 0x4000 + + +# A secure default. +# Sources for more information on TLS ciphers: +# +# - https://wiki.mozilla.org/Security/Server_Side_TLS +# - https://www.ssllabs.com/projects/best-practices/index.html +# - https://hynek.me/articles/hardening-your-web-servers-ssl-ciphers/ +# +# The general intent is: +# - prefer cipher suites that offer perfect forward secrecy (DHE/ECDHE), +# - prefer ECDHE over DHE for better performance, +# - prefer any AES-GCM and ChaCha20 over any AES-CBC for better performance and +# security, +# - prefer AES-GCM over ChaCha20 because hardware-accelerated AES is common, +# - disable NULL authentication, MD5 MACs, DSS, and other +# insecure ciphers for security reasons. +# - NOTE: TLS 1.3 cipher suites are managed through a different interface +# not exposed by CPython (yet!) and are enabled by default if they're available. +DEFAULT_CIPHERS = ":".join( + [ + "ECDHE+AESGCM", + "ECDHE+CHACHA20", + "DHE+AESGCM", + "DHE+CHACHA20", + "ECDH+AESGCM", + "DH+AESGCM", + "ECDH+AES", + "DH+AES", + "RSA+AESGCM", + "RSA+AES", + "!aNULL", + "!eNULL", + "!MD5", + "!DSS", + ] +) + +try: + from ssl import SSLContext # Modern SSL? +except ImportError: + + class SSLContext(object): # Platform-specific: Python 2 + def __init__(self, protocol_version): + self.protocol = protocol_version + # Use default values from a real SSLContext + self.check_hostname = False + self.verify_mode = ssl.CERT_NONE + self.ca_certs = None + self.options = 0 + self.certfile = None + self.keyfile = None + self.ciphers = None + + def load_cert_chain(self, certfile, keyfile): + self.certfile = certfile + self.keyfile = keyfile + + def load_verify_locations(self, cafile=None, capath=None, cadata=None): + self.ca_certs = cafile + + if capath is not None: + raise SSLError("CA directories not supported in older Pythons") + + if cadata is not None: + raise SSLError("CA data not supported in older Pythons") + + def set_ciphers(self, cipher_suite): + self.ciphers = cipher_suite + + def wrap_socket(self, socket, server_hostname=None, server_side=False): + warnings.warn( + "A true SSLContext object is not available. This prevents " + "urllib3 from configuring SSL appropriately and may cause " + "certain SSL connections to fail. You can upgrade to a newer " + "version of Python to solve this. For more information, see " + "https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html" + "#ssl-warnings", + InsecurePlatformWarning, + ) + kwargs = { + "keyfile": self.keyfile, + "certfile": self.certfile, + "ca_certs": self.ca_certs, + "cert_reqs": self.verify_mode, + "ssl_version": self.protocol, + "server_side": server_side, + } + return wrap_socket(socket, ciphers=self.ciphers, **kwargs) + + +def assert_fingerprint(cert, fingerprint): """ Checks if given fingerprint matches the supplied certificate. @@ -159,31 +189,26 @@ def assert_fingerprint(cert: bytes | None, fingerprint: str) -> None: Fingerprint as string of hexdigits, can be interspersed by colons. """ - if cert is None: - raise SSLError("No certificate for the peer.") - fingerprint = fingerprint.replace(":", "").lower() digest_length = len(fingerprint) - if digest_length not in HASHFUNC_MAP: - raise SSLError(f"Fingerprint of invalid length: {fingerprint}") hashfunc = HASHFUNC_MAP.get(digest_length) - if hashfunc is None: - raise SSLError( - f"Hash function implementation unavailable for fingerprint length: {digest_length}" - ) + if not hashfunc: + raise SSLError("Fingerprint of invalid length: {0}".format(fingerprint)) # We need encode() here for py32; works on py2 and p33. fingerprint_bytes = unhexlify(fingerprint.encode()) cert_digest = hashfunc(cert).digest() - if not hmac.compare_digest(cert_digest, fingerprint_bytes): + if not _const_compare_digest(cert_digest, fingerprint_bytes): raise SSLError( - f'Fingerprints did not match. Expected "{fingerprint}", got "{cert_digest.hex()}"' + 'Fingerprints did not match. Expected "{0}", got "{1}".'.format( + fingerprint, hexlify(cert_digest) + ) ) -def resolve_cert_reqs(candidate: None | int | str) -> VerifyMode: +def resolve_cert_reqs(candidate): """ Resolves the argument to a numeric constant, which can be passed to the wrap_socket function/method from the ssl module. @@ -201,12 +226,12 @@ def resolve_cert_reqs(candidate: None | int | str) -> VerifyMode: res = getattr(ssl, candidate, None) if res is None: res = getattr(ssl, "CERT_" + candidate) - return res # type: ignore[no-any-return] + return res - return candidate # type: ignore[return-value] + return candidate -def resolve_ssl_version(candidate: None | int | str) -> int: +def resolve_ssl_version(candidate): """ like resolve_cert_reqs """ @@ -217,34 +242,35 @@ def resolve_ssl_version(candidate: None | int | str) -> int: res = getattr(ssl, candidate, None) if res is None: res = getattr(ssl, "PROTOCOL_" + candidate) - return typing.cast(int, res) + return res return candidate def create_urllib3_context( - ssl_version: int | None = None, - cert_reqs: int | None = None, - options: int | None = None, - ciphers: str | None = None, - ssl_minimum_version: int | None = None, - ssl_maximum_version: int | None = None, - verify_flags: int | None = None, -) -> ssl.SSLContext: - """Creates and configures an :class:`ssl.SSLContext` instance for use with urllib3. + ssl_version=None, cert_reqs=None, options=None, ciphers=None +): + """All arguments have the same meaning as ``ssl_wrap_socket``. + + By default, this function does a lot of the same work that + ``ssl.create_default_context`` does on Python 3.4+. It: + + - Disables SSLv2, SSLv3, and compression + - Sets a restricted set of server ciphers + + If you wish to enable SSLv3, you can do:: + + from urllib3.util import ssl_ + context = ssl_.create_urllib3_context() + context.options &= ~ssl_.OP_NO_SSLv3 + + You can do the same to enable compression (substituting ``COMPRESSION`` + for ``SSLv3`` in the last line above). :param ssl_version: The desired protocol version to use. This will default to PROTOCOL_SSLv23 which will negotiate the highest protocol that both the server and your installation of OpenSSL support. - - This parameter is deprecated instead use 'ssl_minimum_version'. - :param ssl_minimum_version: - The minimum version of TLS to be used. Use the 'ssl.TLSVersion' enum for specifying the value. - :param ssl_maximum_version: - The maximum version of TLS to be used. Use the 'ssl.TLSVersion' enum for specifying the value. - Not recommended to set to anything other than 'ssl.TLSVersion.MAXIMUM_SUPPORTED' which is the - default value. :param cert_reqs: Whether to require the certificate verification. This defaults to ``ssl.CERT_REQUIRED``. @@ -252,63 +278,18 @@ def create_urllib3_context( Specific OpenSSL options. These default to ``ssl.OP_NO_SSLv2``, ``ssl.OP_NO_SSLv3``, ``ssl.OP_NO_COMPRESSION``, and ``ssl.OP_NO_TICKET``. :param ciphers: - Which cipher suites to allow the server to select. Defaults to either system configured - ciphers if OpenSSL 1.1.1+, otherwise uses a secure default set of ciphers. - :param verify_flags: - The flags for certificate verification operations. These default to - ``ssl.VERIFY_X509_PARTIAL_CHAIN`` and ``ssl.VERIFY_X509_STRICT`` for Python 3.13+. + Which cipher suites to allow the server to select. :returns: Constructed SSLContext object with specified options :rtype: SSLContext """ - if SSLContext is None: - raise TypeError("Can't create an SSLContext object without an ssl module") - - # This means 'ssl_version' was specified as an exact value. - if ssl_version not in (None, PROTOCOL_TLS, PROTOCOL_TLS_CLIENT): - # Disallow setting 'ssl_version' and 'ssl_minimum|maximum_version' - # to avoid conflicts. - if ssl_minimum_version is not None or ssl_maximum_version is not None: - raise ValueError( - "Can't specify both 'ssl_version' and either " - "'ssl_minimum_version' or 'ssl_maximum_version'" - ) + # PROTOCOL_TLS is deprecated in Python 3.10 + if not ssl_version or ssl_version == PROTOCOL_TLS: + ssl_version = PROTOCOL_TLS_CLIENT - # 'ssl_version' is deprecated and will be removed in the future. - else: - # Use 'ssl_minimum_version' and 'ssl_maximum_version' instead. - ssl_minimum_version = _SSL_VERSION_TO_TLS_VERSION.get( - ssl_version, TLSVersion.MINIMUM_SUPPORTED - ) - ssl_maximum_version = _SSL_VERSION_TO_TLS_VERSION.get( - ssl_version, TLSVersion.MAXIMUM_SUPPORTED - ) + context = SSLContext(ssl_version) - # This warning message is pushing users to use 'ssl_minimum_version' - # instead of both min/max. Best practice is to only set the minimum version and - # keep the maximum version to be it's default value: 'TLSVersion.MAXIMUM_SUPPORTED' - warnings.warn( - "'ssl_version' option is deprecated and will be " - "removed in urllib3 v2.6.0. Instead use 'ssl_minimum_version'", - category=DeprecationWarning, - stacklevel=2, - ) - - # PROTOCOL_TLS is deprecated in Python 3.10 so we always use PROTOCOL_TLS_CLIENT - context = SSLContext(PROTOCOL_TLS_CLIENT) - - if ssl_minimum_version is not None: - context.minimum_version = ssl_minimum_version - else: # Python <3.10 defaults to 'MINIMUM_SUPPORTED' so explicitly set TLSv1.2 here - context.minimum_version = TLSVersion.TLSv1_2 - - if ssl_maximum_version is not None: - context.maximum_version = ssl_maximum_version - - # Unless we're given ciphers defer to either system ciphers in - # the case of OpenSSL 1.1.1+ or use our own secure default ciphers. - if ciphers: - context.set_ciphers(ciphers) + context.set_ciphers(ciphers or DEFAULT_CIPHERS) # Setting the default here, as we may have no ssl module on import cert_reqs = ssl.CERT_REQUIRED if cert_reqs is None else cert_reqs @@ -330,106 +311,65 @@ def create_urllib3_context( context.options |= options - if verify_flags is None: - verify_flags = 0 - # In Python 3.13+ ssl.create_default_context() sets VERIFY_X509_PARTIAL_CHAIN - # and VERIFY_X509_STRICT so we do the same - if sys.version_info >= (3, 13): - verify_flags |= VERIFY_X509_PARTIAL_CHAIN - verify_flags |= VERIFY_X509_STRICT - - context.verify_flags |= verify_flags - # Enable post-handshake authentication for TLS 1.3, see GH #1634. PHA is # necessary for conditional client cert authentication with TLS 1.3. - # The attribute is None for OpenSSL <= 1.1.0 or does not exist when using - # an SSLContext created by pyOpenSSL. - if getattr(context, "post_handshake_auth", None) is not None: + # The attribute is None for OpenSSL <= 1.1.0 or does not exist in older + # versions of Python. We only enable on Python 3.7.4+ or if certificate + # verification is enabled to work around Python issue #37428 + # See: https://bugs.python.org/issue37428 + if (cert_reqs == ssl.CERT_REQUIRED or sys.version_info >= (3, 7, 4)) and getattr( + context, "post_handshake_auth", None + ) is not None: context.post_handshake_auth = True + def disable_check_hostname(): + if ( + getattr(context, "check_hostname", None) is not None + ): # Platform-specific: Python 3.2 + # We do our own verification, including fingerprints and alternative + # hostnames. So disable it here + context.check_hostname = False + # The order of the below lines setting verify_mode and check_hostname # matter due to safe-guards SSLContext has to prevent an SSLContext with - # check_hostname=True, verify_mode=NONE/OPTIONAL. - # We always set 'check_hostname=False' for pyOpenSSL so we rely on our own - # 'ssl.match_hostname()' implementation. - if cert_reqs == ssl.CERT_REQUIRED and not IS_PYOPENSSL: + # check_hostname=True, verify_mode=NONE/OPTIONAL. This is made even more + # complex because we don't know whether PROTOCOL_TLS_CLIENT will be used + # or not so we don't know the initial state of the freshly created SSLContext. + if cert_reqs == ssl.CERT_REQUIRED: context.verify_mode = cert_reqs - context.check_hostname = True + disable_check_hostname() else: - context.check_hostname = False + disable_check_hostname() context.verify_mode = cert_reqs - try: - context.hostname_checks_common_name = False - except AttributeError: # Defensive: for CPython < 3.9.3; for PyPy < 7.3.8 - pass - - if "SSLKEYLOGFILE" in os.environ: - sslkeylogfile = os.path.expandvars(os.environ.get("SSLKEYLOGFILE")) - else: - sslkeylogfile = None - if sslkeylogfile: - context.keylog_filename = sslkeylogfile + # Enable logging of TLS session keys via defacto standard environment variable + # 'SSLKEYLOGFILE', if the feature is available (Python 3.8+). Skip empty values. + if hasattr(context, "keylog_filename"): + sslkeylogfile = os.environ.get("SSLKEYLOGFILE") + if sslkeylogfile: + context.keylog_filename = sslkeylogfile return context -@typing.overload -def ssl_wrap_socket( - sock: socket.socket, - keyfile: str | None = ..., - certfile: str | None = ..., - cert_reqs: int | None = ..., - ca_certs: str | None = ..., - server_hostname: str | None = ..., - ssl_version: int | None = ..., - ciphers: str | None = ..., - ssl_context: ssl.SSLContext | None = ..., - ca_cert_dir: str | None = ..., - key_password: str | None = ..., - ca_cert_data: None | str | bytes = ..., - tls_in_tls: typing.Literal[False] = ..., -) -> ssl.SSLSocket: ... - - -@typing.overload -def ssl_wrap_socket( - sock: socket.socket, - keyfile: str | None = ..., - certfile: str | None = ..., - cert_reqs: int | None = ..., - ca_certs: str | None = ..., - server_hostname: str | None = ..., - ssl_version: int | None = ..., - ciphers: str | None = ..., - ssl_context: ssl.SSLContext | None = ..., - ca_cert_dir: str | None = ..., - key_password: str | None = ..., - ca_cert_data: None | str | bytes = ..., - tls_in_tls: bool = ..., -) -> ssl.SSLSocket | SSLTransportType: ... - - def ssl_wrap_socket( - sock: socket.socket, - keyfile: str | None = None, - certfile: str | None = None, - cert_reqs: int | None = None, - ca_certs: str | None = None, - server_hostname: str | None = None, - ssl_version: int | None = None, - ciphers: str | None = None, - ssl_context: ssl.SSLContext | None = None, - ca_cert_dir: str | None = None, - key_password: str | None = None, - ca_cert_data: None | str | bytes = None, - tls_in_tls: bool = False, -) -> ssl.SSLSocket | SSLTransportType: + sock, + keyfile=None, + certfile=None, + cert_reqs=None, + ca_certs=None, + server_hostname=None, + ssl_version=None, + ciphers=None, + ssl_context=None, + ca_cert_dir=None, + key_password=None, + ca_cert_data=None, + tls_in_tls=False, +): """ - All arguments except for server_hostname, ssl_context, tls_in_tls, ca_cert_data and - ca_cert_dir have the same meaning as they do when using - :func:`ssl.create_default_context`, :meth:`ssl.SSLContext.load_cert_chain`, - :meth:`ssl.SSLContext.set_ciphers` and :meth:`ssl.SSLContext.wrap_socket`. + All arguments except for server_hostname, ssl_context, and ca_cert_dir have + the same meaning as they do when using :func:`ssl.wrap_socket`. :param server_hostname: When SNI is supported, the expected hostname of the certificate @@ -452,18 +392,19 @@ def ssl_wrap_socket( """ context = ssl_context if context is None: - # Note: This branch of code and all the variables in it are only used in tests. - # We should consider deprecating and removing this code. + # Note: This branch of code and all the variables in it are no longer + # used by urllib3 itself. We should consider deprecating and removing + # this code. context = create_urllib3_context(ssl_version, cert_reqs, ciphers=ciphers) if ca_certs or ca_cert_dir or ca_cert_data: try: context.load_verify_locations(ca_certs, ca_cert_dir, ca_cert_data) - except OSError as e: - raise SSLError(e) from e + except (IOError, OSError) as e: + raise SSLError(e) elif ssl_context is None and hasattr(context, "load_default_certs"): - # try to load OS default certs; works well on Windows. + # try to load OS default certs; works well on Windows (require Python3.4+) context.load_default_certs() # Attempt to detect if we get the goofy behavior of the @@ -478,28 +419,57 @@ def ssl_wrap_socket( else: context.load_cert_chain(certfile, keyfile, key_password) - context.set_alpn_protocols(ALPN_PROTOCOLS) + try: + if hasattr(context, "set_alpn_protocols"): + context.set_alpn_protocols(ALPN_PROTOCOLS) + except NotImplementedError: # Defensive: in CI, we always have set_alpn_protocols + pass + + # If we detect server_hostname is an IP address then the SNI + # extension should not be used according to RFC3546 Section 3.1 + use_sni_hostname = server_hostname and not is_ipaddress(server_hostname) + # SecureTransport uses server_hostname in certificate verification. + send_sni = (use_sni_hostname and HAS_SNI) or ( + IS_SECURETRANSPORT and server_hostname + ) + # Do not warn the user if server_hostname is an invalid SNI hostname. + if not HAS_SNI and use_sni_hostname: + warnings.warn( + "An HTTPS request has been made, but the SNI (Server Name " + "Indication) extension to TLS is not available on this platform. " + "This may cause the server to present an incorrect TLS " + "certificate, which can cause validation failures. You can upgrade to " + "a newer version of Python to solve this. For more information, see " + "https://urllib3.readthedocs.io/en/1.26.x/advanced-usage.html" + "#ssl-warnings", + SNIMissingWarning, + ) - ssl_sock = _ssl_wrap_socket_impl(sock, context, tls_in_tls, server_hostname) + if send_sni: + ssl_sock = _ssl_wrap_socket_impl( + sock, context, tls_in_tls, server_hostname=server_hostname + ) + else: + ssl_sock = _ssl_wrap_socket_impl(sock, context, tls_in_tls) return ssl_sock -def is_ipaddress(hostname: str | bytes) -> bool: +def is_ipaddress(hostname): """Detects whether the hostname given is an IPv4 or IPv6 address. Also detects IPv6 addresses with Zone IDs. :param str hostname: Hostname to examine. :return: True if the hostname is an IP address, False otherwise. """ - if isinstance(hostname, bytes): + if not six.PY2 and isinstance(hostname, bytes): # IDN A-label bytes are ASCII compatible. hostname = hostname.decode("ascii") - return bool(_IPV4_RE.match(hostname) or _BRACELESS_IPV6_ADDRZ_RE.match(hostname)) + return bool(IPV4_RE.match(hostname) or BRACELESS_IPV6_ADDRZ_RE.match(hostname)) -def _is_key_file_encrypted(key_file: str) -> bool: +def _is_key_file_encrypted(key_file): """Detects if a key file is encrypted or not.""" - with open(key_file) as f: + with open(key_file, "r") as f: for line in f: # Look for Proc-Type: 4,ENCRYPTED if "ENCRYPTED" in line: @@ -508,12 +478,7 @@ def _is_key_file_encrypted(key_file: str) -> bool: return False -def _ssl_wrap_socket_impl( - sock: socket.socket, - ssl_context: ssl.SSLContext, - tls_in_tls: bool, - server_hostname: str | None = None, -) -> ssl.SSLSocket | SSLTransportType: +def _ssl_wrap_socket_impl(sock, ssl_context, tls_in_tls, server_hostname=None): if tls_in_tls: if not SSLTransport: # Import error, ssl is not available. @@ -524,4 +489,7 @@ def _ssl_wrap_socket_impl( SSLTransport._validate_ssl_context_for_tls_in_tls(ssl_context) return SSLTransport(sock, ssl_context, server_hostname) - return ssl_context.wrap_socket(sock, server_hostname=server_hostname) + if server_hostname: + return ssl_context.wrap_socket(sock, server_hostname=server_hostname) + else: + return ssl_context.wrap_socket(sock) diff --git a/newrelic/packages/urllib3/util/ssl_match_hostname.py b/newrelic/packages/urllib3/util/ssl_match_hostname.py index 25d9100041..1dd950c489 100644 --- a/newrelic/packages/urllib3/util/ssl_match_hostname.py +++ b/newrelic/packages/urllib3/util/ssl_match_hostname.py @@ -1,18 +1,19 @@ -"""The match_hostname() function from Python 3.5, essential when using SSL.""" +"""The match_hostname() function from Python 3.3.3, essential when using SSL.""" # Note: This file is under the PSF license as the code comes from the python # stdlib. http://docs.python.org/3/license.html -# It is modified to remove commonName support. -from __future__ import annotations - -import ipaddress import re -import typing -from ipaddress import IPv4Address, IPv6Address +import sys -if typing.TYPE_CHECKING: - from .ssl_ import _TYPE_PEER_CERT_RET_DICT +# ipaddress has been backported to 2.6+ in pypi. If it is installed on the +# system, use it to handle IPAddress ServerAltnames (this was added in +# python-3.5) otherwise only do DNS matching. This allows +# util.ssl_match_hostname to continue to be used in Python 2.7. +try: + import ipaddress +except ImportError: + ipaddress = None __version__ = "3.5.0.1" @@ -21,9 +22,7 @@ class CertificateError(ValueError): pass -def _dnsname_match( - dn: typing.Any, hostname: str, max_wildcards: int = 1 -) -> typing.Match[str] | None | bool: +def _dnsname_match(dn, hostname, max_wildcards=1): """Matching according to RFC 6125, section 6.4.3 http://tools.ietf.org/html/rfc6125#section-6.4.3 @@ -50,7 +49,7 @@ def _dnsname_match( # speed up common case w/o wildcards if not wildcards: - return bool(dn.lower() == hostname.lower()) + return dn.lower() == hostname.lower() # RFC 6125, section 6.4.3, subitem 1. # The client SHOULD NOT attempt to match a presented identifier in which @@ -77,26 +76,26 @@ def _dnsname_match( return pat.match(hostname) -def _ipaddress_match(ipname: str, host_ip: IPv4Address | IPv6Address) -> bool: +def _to_unicode(obj): + if isinstance(obj, str) and sys.version_info < (3,): + # ignored flake8 # F821 to support python 2.7 function + obj = unicode(obj, encoding="ascii", errors="strict") # noqa: F821 + return obj + + +def _ipaddress_match(ipname, host_ip): """Exact matching of IP addresses. - RFC 9110 section 4.3.5: "A reference identity of IP-ID contains the decoded - bytes of the IP address. An IP version 4 address is 4 octets, and an IP - version 6 address is 16 octets. [...] A reference identity of type IP-ID - matches if the address is identical to an iPAddress value of the - subjectAltName extension of the certificate." + RFC 6125 explicitly doesn't define an algorithm for this + (section 1.7.2 - "Out of Scope"). """ # OpenSSL may add a trailing newline to a subjectAltName's IP address # Divergence from upstream: ipaddress can't handle byte str - ip = ipaddress.ip_address(ipname.rstrip()) - return bool(ip.packed == host_ip.packed) + ip = ipaddress.ip_address(_to_unicode(ipname).rstrip()) + return ip == host_ip -def match_hostname( - cert: _TYPE_PEER_CERT_RET_DICT | None, - hostname: str, - hostname_checks_common_name: bool = False, -) -> None: +def match_hostname(cert, hostname): """Verify that *cert* (in decoded format as returned by SSLSocket.getpeercert()) matches the *hostname*. RFC 2818 and RFC 6125 rules are followed, but IP addresses are not accepted for *hostname*. @@ -112,22 +111,21 @@ def match_hostname( ) try: # Divergence from upstream: ipaddress can't handle byte str - # - # The ipaddress module shipped with Python < 3.9 does not support - # scoped IPv6 addresses so we unconditionally strip the Zone IDs for - # now. Once we drop support for Python 3.9 we can remove this branch. - if "%" in hostname: - host_ip = ipaddress.ip_address(hostname[: hostname.rfind("%")]) - else: - host_ip = ipaddress.ip_address(hostname) - - except ValueError: - # Not an IP address (common case) + host_ip = ipaddress.ip_address(_to_unicode(hostname)) + except (UnicodeError, ValueError): + # ValueError: Not an IP address (common case) + # UnicodeError: Divergence from upstream: Have to deal with ipaddress not taking + # byte strings. addresses should be all ascii, so we consider it not + # an ipaddress in this case host_ip = None + except AttributeError: + # Divergence from upstream: Make ipaddress library optional + if ipaddress is None: + host_ip = None + else: # Defensive + raise dnsnames = [] - san: tuple[tuple[str, str], ...] = cert.get("subjectAltName", ()) - key: str - value: str + san = cert.get("subjectAltName", ()) for key, value in san: if key == "DNS": if host_ip is None and _dnsname_match(value, hostname): @@ -137,23 +135,25 @@ def match_hostname( if host_ip is not None and _ipaddress_match(value, host_ip): return dnsnames.append(value) - - # We only check 'commonName' if it's enabled and we're not verifying - # an IP address. IP addresses aren't valid within 'commonName'. - if hostname_checks_common_name and host_ip is None and not dnsnames: + if not dnsnames: + # The subject is only checked when there is no dNSName entry + # in subjectAltName for sub in cert.get("subject", ()): for key, value in sub: + # XXX according to RFC 2818, the most specific Common Name + # must be used. if key == "commonName": if _dnsname_match(value, hostname): return - dnsnames.append(value) # Defensive: for Python < 3.9.3 - + dnsnames.append(value) if len(dnsnames) > 1: raise CertificateError( "hostname %r " "doesn't match either of %s" % (hostname, ", ".join(map(repr, dnsnames))) ) elif len(dnsnames) == 1: - raise CertificateError(f"hostname {hostname!r} doesn't match {dnsnames[0]!r}") + raise CertificateError("hostname %r doesn't match %r" % (hostname, dnsnames[0])) else: - raise CertificateError("no appropriate subjectAltName fields were found") + raise CertificateError( + "no appropriate commonName or subjectAltName fields were found" + ) diff --git a/newrelic/packages/urllib3/util/ssltransport.py b/newrelic/packages/urllib3/util/ssltransport.py index 6d59bc3bce..4a7105d179 100644 --- a/newrelic/packages/urllib3/util/ssltransport.py +++ b/newrelic/packages/urllib3/util/ssltransport.py @@ -1,20 +1,9 @@ -from __future__ import annotations - import io import socket import ssl -import typing from ..exceptions import ProxySchemeUnsupported - -if typing.TYPE_CHECKING: - from typing_extensions import Self - - from .ssl_ import _TYPE_PEER_CERT_RET, _TYPE_PEER_CERT_RET_DICT - - -_WriteBuffer = typing.Union[bytearray, memoryview] -_ReturnValue = typing.TypeVar("_ReturnValue") +from ..packages import six SSL_BLOCKSIZE = 16384 @@ -31,7 +20,7 @@ class SSLTransport: """ @staticmethod - def _validate_ssl_context_for_tls_in_tls(ssl_context: ssl.SSLContext) -> None: + def _validate_ssl_context_for_tls_in_tls(ssl_context): """ Raises a ProxySchemeUnsupported if the provided ssl_context can't be used for TLS in TLS. @@ -41,18 +30,20 @@ def _validate_ssl_context_for_tls_in_tls(ssl_context: ssl.SSLContext) -> None: """ if not hasattr(ssl_context, "wrap_bio"): - raise ProxySchemeUnsupported( - "TLS in TLS requires SSLContext.wrap_bio() which isn't " - "available on non-native SSLContext" - ) + if six.PY2: + raise ProxySchemeUnsupported( + "TLS in TLS requires SSLContext.wrap_bio() which isn't " + "supported on Python 2" + ) + else: + raise ProxySchemeUnsupported( + "TLS in TLS requires SSLContext.wrap_bio() which isn't " + "available on non-native SSLContext" + ) def __init__( - self, - socket: socket.socket, - ssl_context: ssl.SSLContext, - server_hostname: str | None = None, - suppress_ragged_eofs: bool = True, - ) -> None: + self, socket, ssl_context, server_hostname=None, suppress_ragged_eofs=True + ): """ Create an SSLTransport around socket using the provided ssl_context. """ @@ -69,36 +60,33 @@ def __init__( # Perform initial handshake. self._ssl_io_loop(self.sslobj.do_handshake) - def __enter__(self) -> Self: + def __enter__(self): return self - def __exit__(self, *_: typing.Any) -> None: + def __exit__(self, *_): self.close() - def fileno(self) -> int: + def fileno(self): return self.socket.fileno() - def read(self, len: int = 1024, buffer: typing.Any | None = None) -> int | bytes: + def read(self, len=1024, buffer=None): return self._wrap_ssl_read(len, buffer) - def recv(self, buflen: int = 1024, flags: int = 0) -> int | bytes: + def recv(self, len=1024, flags=0): if flags != 0: raise ValueError("non-zero flags not allowed in calls to recv") - return self._wrap_ssl_read(buflen) - - def recv_into( - self, - buffer: _WriteBuffer, - nbytes: int | None = None, - flags: int = 0, - ) -> None | int | bytes: + return self._wrap_ssl_read(len) + + def recv_into(self, buffer, nbytes=None, flags=0): if flags != 0: raise ValueError("non-zero flags not allowed in calls to recv_into") - if nbytes is None: + if buffer and (nbytes is None): nbytes = len(buffer) + elif nbytes is None: + nbytes = 1024 return self.read(nbytes, buffer) - def sendall(self, data: bytes, flags: int = 0) -> None: + def sendall(self, data, flags=0): if flags != 0: raise ValueError("non-zero flags not allowed in calls to sendall") count = 0 @@ -108,20 +96,15 @@ def sendall(self, data: bytes, flags: int = 0) -> None: v = self.send(byte_view[count:]) count += v - def send(self, data: bytes, flags: int = 0) -> int: + def send(self, data, flags=0): if flags != 0: raise ValueError("non-zero flags not allowed in calls to send") - return self._ssl_io_loop(self.sslobj.write, data) + response = self._ssl_io_loop(self.sslobj.write, data) + return response def makefile( - self, - mode: str, - buffering: int | None = None, - *, - encoding: str | None = None, - errors: str | None = None, - newline: str | None = None, - ) -> typing.BinaryIO | typing.TextIO | socket.SocketIO: + self, mode="r", buffering=None, encoding=None, errors=None, newline=None + ): """ Python's httpclient uses makefile and buffered io when reading HTTP messages and we need to support it. @@ -130,7 +113,7 @@ def makefile( changes to point to the socket directly. """ if not set(mode) <= {"r", "w", "b"}: - raise ValueError(f"invalid mode {mode!r} (only r, w, b allowed)") + raise ValueError("invalid mode %r (only r, w, b allowed)" % (mode,)) writing = "w" in mode reading = "r" in mode or not writing @@ -141,8 +124,8 @@ def makefile( rawmode += "r" if writing: rawmode += "w" - raw = socket.SocketIO(self, rawmode) # type: ignore[arg-type] - self.socket._io_refs += 1 # type: ignore[attr-defined] + raw = socket.SocketIO(self, rawmode) + self.socket._io_refs += 1 if buffering is None: buffering = -1 if buffering < 0: @@ -151,9 +134,8 @@ def makefile( if not binary: raise ValueError("unbuffered streams must be binary") return raw - buffer: typing.BinaryIO if reading and writing: - buffer = io.BufferedRWPair(raw, raw, buffering) # type: ignore[assignment] + buffer = io.BufferedRWPair(raw, raw, buffering) elif reading: buffer = io.BufferedReader(raw, buffering) else: @@ -162,51 +144,46 @@ def makefile( if binary: return buffer text = io.TextIOWrapper(buffer, encoding, errors, newline) - text.mode = mode # type: ignore[misc] + text.mode = mode return text - def unwrap(self) -> None: + def unwrap(self): self._ssl_io_loop(self.sslobj.unwrap) - def close(self) -> None: + def close(self): self.socket.close() - @typing.overload - def getpeercert( - self, binary_form: typing.Literal[False] = ... - ) -> _TYPE_PEER_CERT_RET_DICT | None: ... - - @typing.overload - def getpeercert(self, binary_form: typing.Literal[True]) -> bytes | None: ... - - def getpeercert(self, binary_form: bool = False) -> _TYPE_PEER_CERT_RET: - return self.sslobj.getpeercert(binary_form) # type: ignore[return-value] + def getpeercert(self, binary_form=False): + return self.sslobj.getpeercert(binary_form) - def version(self) -> str | None: + def version(self): return self.sslobj.version() - def cipher(self) -> tuple[str, str, int] | None: + def cipher(self): return self.sslobj.cipher() - def selected_alpn_protocol(self) -> str | None: + def selected_alpn_protocol(self): return self.sslobj.selected_alpn_protocol() - def shared_ciphers(self) -> list[tuple[str, str, int]] | None: + def selected_npn_protocol(self): + return self.sslobj.selected_npn_protocol() + + def shared_ciphers(self): return self.sslobj.shared_ciphers() - def compression(self) -> str | None: + def compression(self): return self.sslobj.compression() - def settimeout(self, value: float | None) -> None: + def settimeout(self, value): self.socket.settimeout(value) - def gettimeout(self) -> float | None: + def gettimeout(self): return self.socket.gettimeout() - def _decref_socketios(self) -> None: - self.socket._decref_socketios() # type: ignore[attr-defined] + def _decref_socketios(self): + self.socket._decref_socketios() - def _wrap_ssl_read(self, len: int, buffer: bytearray | None = None) -> int | bytes: + def _wrap_ssl_read(self, len, buffer=None): try: return self._ssl_io_loop(self.sslobj.read, len, buffer) except ssl.SSLError as e: @@ -215,29 +192,7 @@ def _wrap_ssl_read(self, len: int, buffer: bytearray | None = None) -> int | byt else: raise - # func is sslobj.do_handshake or sslobj.unwrap - @typing.overload - def _ssl_io_loop(self, func: typing.Callable[[], None]) -> None: ... - - # func is sslobj.write, arg1 is data - @typing.overload - def _ssl_io_loop(self, func: typing.Callable[[bytes], int], arg1: bytes) -> int: ... - - # func is sslobj.read, arg1 is len, arg2 is buffer - @typing.overload - def _ssl_io_loop( - self, - func: typing.Callable[[int, bytearray | None], bytes], - arg1: int, - arg2: bytearray | None, - ) -> bytes: ... - - def _ssl_io_loop( - self, - func: typing.Callable[..., _ReturnValue], - arg1: None | bytes | int = None, - arg2: bytearray | None = None, - ) -> _ReturnValue: + def _ssl_io_loop(self, func, *args): """Performs an I/O loop between incoming/outgoing and the socket.""" should_loop = True ret = None @@ -245,12 +200,7 @@ def _ssl_io_loop( while should_loop: errno = None try: - if arg1 is None and arg2 is None: - ret = func() - elif arg2 is None: - ret = func(arg1) - else: - ret = func(arg1, arg2) + ret = func(*args) except ssl.SSLError as e: if e.errno not in (ssl.SSL_ERROR_WANT_READ, ssl.SSL_ERROR_WANT_WRITE): # WANT_READ, and WANT_WRITE are expected, others are not. @@ -268,4 +218,4 @@ def _ssl_io_loop( self.incoming.write(buf) else: self.incoming.write_eof() - return typing.cast(_ReturnValue, ret) + return ret diff --git a/newrelic/packages/urllib3/util/timeout.py b/newrelic/packages/urllib3/util/timeout.py index 4bb1be11d9..78e18a6272 100644 --- a/newrelic/packages/urllib3/util/timeout.py +++ b/newrelic/packages/urllib3/util/timeout.py @@ -1,56 +1,44 @@ -from __future__ import annotations +from __future__ import absolute_import import time -import typing -from enum import Enum -from socket import getdefaulttimeout -from ..exceptions import TimeoutStateError - -if typing.TYPE_CHECKING: - from typing import Final +# The default socket timeout, used by httplib to indicate that no timeout was; specified by the user +from socket import _GLOBAL_DEFAULT_TIMEOUT, getdefaulttimeout +from ..exceptions import TimeoutStateError -class _TYPE_DEFAULT(Enum): - # This value should never be passed to socket.settimeout() so for safety we use a -1. - # socket.settimout() raises a ValueError for negative values. - token = -1 - +# A sentinel value to indicate that no timeout was specified by the user in +# urllib3 +_Default = object() -_DEFAULT_TIMEOUT: Final[_TYPE_DEFAULT] = _TYPE_DEFAULT.token -_TYPE_TIMEOUT = typing.Optional[typing.Union[float, _TYPE_DEFAULT]] +# Use time.monotonic if available. +current_time = getattr(time, "monotonic", time.time) -class Timeout: +class Timeout(object): """Timeout configuration. Timeouts can be defined as a default for a pool: .. code-block:: python - import urllib3 - - timeout = urllib3.util.Timeout(connect=2.0, read=7.0) - - http = urllib3.PoolManager(timeout=timeout) - - resp = http.request("GET", "https://example.com/") - - print(resp.status) + timeout = Timeout(connect=2.0, read=7.0) + http = PoolManager(timeout=timeout) + response = http.request('GET', 'http://example.com/') Or per-request (which overrides the default for the pool): .. code-block:: python - response = http.request("GET", "https://example.com/", timeout=Timeout(10)) + response = http.request('GET', 'http://example.com/', timeout=Timeout(10)) Timeouts can be disabled by setting all the parameters to ``None``: .. code-block:: python no_timeout = Timeout(connect=None, read=None) - response = http.request("GET", "https://example.com/", timeout=no_timeout) + response = http.request('GET', 'http://example.com/, timeout=no_timeout) :param total: @@ -101,34 +89,38 @@ class Timeout: the case; if a server streams one byte every fifteen seconds, a timeout of 20 seconds will not trigger, even though the request will take several minutes to complete. + + If your goal is to cut off any request after a set amount of wall clock + time, consider having a second "watcher" thread to cut off a slow + request. """ #: A sentinel object representing the default timeout value - DEFAULT_TIMEOUT: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT - - def __init__( - self, - total: _TYPE_TIMEOUT = None, - connect: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, - read: _TYPE_TIMEOUT = _DEFAULT_TIMEOUT, - ) -> None: + DEFAULT_TIMEOUT = _GLOBAL_DEFAULT_TIMEOUT + + def __init__(self, total=None, connect=_Default, read=_Default): self._connect = self._validate_timeout(connect, "connect") self._read = self._validate_timeout(read, "read") self.total = self._validate_timeout(total, "total") - self._start_connect: float | None = None + self._start_connect = None - def __repr__(self) -> str: - return f"{type(self).__name__}(connect={self._connect!r}, read={self._read!r}, total={self.total!r})" + def __repr__(self): + return "%s(connect=%r, read=%r, total=%r)" % ( + type(self).__name__, + self._connect, + self._read, + self.total, + ) # __str__ provided for backwards compatibility __str__ = __repr__ - @staticmethod - def resolve_default_timeout(timeout: _TYPE_TIMEOUT) -> float | None: - return getdefaulttimeout() if timeout is _DEFAULT_TIMEOUT else timeout + @classmethod + def resolve_default_timeout(cls, timeout): + return getdefaulttimeout() if timeout is cls.DEFAULT_TIMEOUT else timeout @classmethod - def _validate_timeout(cls, value: _TYPE_TIMEOUT, name: str) -> _TYPE_TIMEOUT: + def _validate_timeout(cls, value, name): """Check that a timeout attribute is valid. :param value: The timeout value to validate @@ -138,7 +130,10 @@ def _validate_timeout(cls, value: _TYPE_TIMEOUT, name: str) -> _TYPE_TIMEOUT: :raises ValueError: If it is a numeric value less than or equal to zero, or the type is not an integer, float, or None. """ - if value is None or value is _DEFAULT_TIMEOUT: + if value is _Default: + return cls.DEFAULT_TIMEOUT + + if value is None or value is cls.DEFAULT_TIMEOUT: return value if isinstance(value, bool): @@ -152,7 +147,7 @@ def _validate_timeout(cls, value: _TYPE_TIMEOUT, name: str) -> _TYPE_TIMEOUT: raise ValueError( "Timeout value %s was %s, but it must be an " "int, float or None." % (name, value) - ) from None + ) try: if value <= 0: @@ -162,15 +157,16 @@ def _validate_timeout(cls, value: _TYPE_TIMEOUT, name: str) -> _TYPE_TIMEOUT: "than or equal to 0." % (name, value) ) except TypeError: + # Python 3 raise ValueError( "Timeout value %s was %s, but it must be an " "int, float or None." % (name, value) - ) from None + ) return value @classmethod - def from_float(cls, timeout: _TYPE_TIMEOUT) -> Timeout: + def from_float(cls, timeout): """Create a new Timeout from a legacy timeout value. The timeout value used by httplib.py sets the same timeout on the @@ -179,13 +175,13 @@ def from_float(cls, timeout: _TYPE_TIMEOUT) -> Timeout: passed to this function. :param timeout: The legacy timeout value. - :type timeout: integer, float, :attr:`urllib3.util.Timeout.DEFAULT_TIMEOUT`, or None + :type timeout: integer, float, sentinel default object, or None :return: Timeout object :rtype: :class:`Timeout` """ return Timeout(read=timeout, connect=timeout) - def clone(self) -> Timeout: + def clone(self): """Create a copy of the timeout object Timeout properties are stored per-pool but each request needs a fresh @@ -199,7 +195,7 @@ def clone(self) -> Timeout: # detect the user default. return Timeout(connect=self._connect, read=self._read, total=self.total) - def start_connect(self) -> float: + def start_connect(self): """Start the timeout clock, used during a connect() attempt :raises urllib3.exceptions.TimeoutStateError: if you attempt @@ -207,10 +203,10 @@ def start_connect(self) -> float: """ if self._start_connect is not None: raise TimeoutStateError("Timeout timer has already been started.") - self._start_connect = time.monotonic() + self._start_connect = current_time() return self._start_connect - def get_connect_duration(self) -> float: + def get_connect_duration(self): """Gets the time elapsed since the call to :meth:`start_connect`. :return: Elapsed time in seconds. @@ -222,10 +218,10 @@ def get_connect_duration(self) -> float: raise TimeoutStateError( "Can't get connect duration for timer that has not started." ) - return time.monotonic() - self._start_connect + return current_time() - self._start_connect @property - def connect_timeout(self) -> _TYPE_TIMEOUT: + def connect_timeout(self): """Get the value to use when setting a connection timeout. This will be a positive float or integer, the value None @@ -237,13 +233,13 @@ def connect_timeout(self) -> _TYPE_TIMEOUT: if self.total is None: return self._connect - if self._connect is None or self._connect is _DEFAULT_TIMEOUT: + if self._connect is None or self._connect is self.DEFAULT_TIMEOUT: return self.total - return min(self._connect, self.total) # type: ignore[type-var] + return min(self._connect, self.total) @property - def read_timeout(self) -> float | None: + def read_timeout(self): """Get the value for the read timeout. This assumes some time has elapsed in the connection timeout and @@ -255,21 +251,21 @@ def read_timeout(self) -> float | None: raised. :return: Value to use for the read timeout. - :rtype: int, float or None + :rtype: int, float, :attr:`Timeout.DEFAULT_TIMEOUT` or None :raises urllib3.exceptions.TimeoutStateError: If :meth:`start_connect` has not yet been called on this object. """ if ( self.total is not None - and self.total is not _DEFAULT_TIMEOUT + and self.total is not self.DEFAULT_TIMEOUT and self._read is not None - and self._read is not _DEFAULT_TIMEOUT + and self._read is not self.DEFAULT_TIMEOUT ): # In case the connect timeout has not yet been established. if self._start_connect is None: return self._read return max(0, min(self.total - self.get_connect_duration(), self._read)) - elif self.total is not None and self.total is not _DEFAULT_TIMEOUT: + elif self.total is not None and self.total is not self.DEFAULT_TIMEOUT: return max(0, self.total - self.get_connect_duration()) else: - return self.resolve_default_timeout(self._read) + return self._read diff --git a/newrelic/packages/urllib3/util/url.py b/newrelic/packages/urllib3/util/url.py index db057f17be..e5682d3be4 100644 --- a/newrelic/packages/urllib3/util/url.py +++ b/newrelic/packages/urllib3/util/url.py @@ -1,20 +1,22 @@ -from __future__ import annotations +from __future__ import absolute_import import re -import typing +from collections import namedtuple from ..exceptions import LocationParseError -from .util import to_str +from ..packages import six + +url_attrs = ["scheme", "auth", "host", "port", "path", "query", "fragment"] # We only want to normalize urls with an HTTP(S) scheme. # urllib3 infers URLs without a scheme (None) to be http. -_NORMALIZABLE_SCHEMES = ("http", "https", None) +NORMALIZABLE_SCHEMES = ("http", "https", None) # Almost all of these patterns were derived from the # 'rfc3986' module: https://github.com/python-hyper/rfc3986 -_PERCENT_RE = re.compile(r"%[a-fA-F0-9]{2}") -_SCHEME_RE = re.compile(r"^(?:[a-zA-Z][a-zA-Z0-9+-]*:|/)") -_URI_RE = re.compile( +PERCENT_RE = re.compile(r"%[a-fA-F0-9]{2}") +SCHEME_RE = re.compile(r"^(?:[a-zA-Z][a-zA-Z0-9+-]*:|/)") +URI_RE = re.compile( r"^(?:([a-zA-Z][a-zA-Z0-9+.-]*):)?" r"(?://([^\\/?#]*))?" r"([^?#]*)" @@ -23,10 +25,10 @@ re.UNICODE | re.DOTALL, ) -_IPV4_PAT = r"(?:[0-9]{1,3}\.){3}[0-9]{1,3}" -_HEX_PAT = "[0-9A-Fa-f]{1,4}" -_LS32_PAT = "(?:{hex}:{hex}|{ipv4})".format(hex=_HEX_PAT, ipv4=_IPV4_PAT) -_subs = {"hex": _HEX_PAT, "ls32": _LS32_PAT} +IPV4_PAT = r"(?:[0-9]{1,3}\.){3}[0-9]{1,3}" +HEX_PAT = "[0-9A-Fa-f]{1,4}" +LS32_PAT = "(?:{hex}:{hex}|{ipv4})".format(hex=HEX_PAT, ipv4=IPV4_PAT) +_subs = {"hex": HEX_PAT, "ls32": LS32_PAT} _variations = [ # 6( h16 ":" ) ls32 "(?:%(hex)s:){6}%(ls32)s", @@ -48,78 +50,69 @@ "(?:(?:%(hex)s:){0,6}%(hex)s)?::", ] -_UNRESERVED_PAT = r"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789._\-~" -_IPV6_PAT = "(?:" + "|".join([x % _subs for x in _variations]) + ")" -_ZONE_ID_PAT = "(?:%25|%)(?:[" + _UNRESERVED_PAT + "]|%[a-fA-F0-9]{2})+" -_IPV6_ADDRZ_PAT = r"\[" + _IPV6_PAT + r"(?:" + _ZONE_ID_PAT + r")?\]" -_REG_NAME_PAT = r"(?:[^\[\]%:/?#]|%[a-fA-F0-9]{2})*" -_TARGET_RE = re.compile(r"^(/[^?#]*)(?:\?([^#]*))?(?:#.*)?$") +UNRESERVED_PAT = r"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789._\-~" +IPV6_PAT = "(?:" + "|".join([x % _subs for x in _variations]) + ")" +ZONE_ID_PAT = "(?:%25|%)(?:[" + UNRESERVED_PAT + "]|%[a-fA-F0-9]{2})+" +IPV6_ADDRZ_PAT = r"\[" + IPV6_PAT + r"(?:" + ZONE_ID_PAT + r")?\]" +REG_NAME_PAT = r"(?:[^\[\]%:/?#]|%[a-fA-F0-9]{2})*" +TARGET_RE = re.compile(r"^(/[^?#]*)(?:\?([^#]*))?(?:#.*)?$") -_IPV4_RE = re.compile("^" + _IPV4_PAT + "$") -_IPV6_RE = re.compile("^" + _IPV6_PAT + "$") -_IPV6_ADDRZ_RE = re.compile("^" + _IPV6_ADDRZ_PAT + "$") -_BRACELESS_IPV6_ADDRZ_RE = re.compile("^" + _IPV6_ADDRZ_PAT[2:-2] + "$") -_ZONE_ID_RE = re.compile("(" + _ZONE_ID_PAT + r")\]$") +IPV4_RE = re.compile("^" + IPV4_PAT + "$") +IPV6_RE = re.compile("^" + IPV6_PAT + "$") +IPV6_ADDRZ_RE = re.compile("^" + IPV6_ADDRZ_PAT + "$") +BRACELESS_IPV6_ADDRZ_RE = re.compile("^" + IPV6_ADDRZ_PAT[2:-2] + "$") +ZONE_ID_RE = re.compile("(" + ZONE_ID_PAT + r")\]$") _HOST_PORT_PAT = ("^(%s|%s|%s)(?::0*?(|0|[1-9][0-9]{0,4}))?$") % ( - _REG_NAME_PAT, - _IPV4_PAT, - _IPV6_ADDRZ_PAT, + REG_NAME_PAT, + IPV4_PAT, + IPV6_ADDRZ_PAT, ) _HOST_PORT_RE = re.compile(_HOST_PORT_PAT, re.UNICODE | re.DOTALL) -_UNRESERVED_CHARS = set( +UNRESERVED_CHARS = set( "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789._-~" ) -_SUB_DELIM_CHARS = set("!$&'()*+,;=") -_USERINFO_CHARS = _UNRESERVED_CHARS | _SUB_DELIM_CHARS | {":"} -_PATH_CHARS = _USERINFO_CHARS | {"@", "/"} -_QUERY_CHARS = _FRAGMENT_CHARS = _PATH_CHARS | {"?"} - - -class Url( - typing.NamedTuple( - "Url", - [ - ("scheme", typing.Optional[str]), - ("auth", typing.Optional[str]), - ("host", typing.Optional[str]), - ("port", typing.Optional[int]), - ("path", typing.Optional[str]), - ("query", typing.Optional[str]), - ("fragment", typing.Optional[str]), - ], - ) -): +SUB_DELIM_CHARS = set("!$&'()*+,;=") +USERINFO_CHARS = UNRESERVED_CHARS | SUB_DELIM_CHARS | {":"} +PATH_CHARS = USERINFO_CHARS | {"@", "/"} +QUERY_CHARS = FRAGMENT_CHARS = PATH_CHARS | {"?"} + + +class Url(namedtuple("Url", url_attrs)): """ Data structure for representing an HTTP URL. Used as a return value for :func:`parse_url`. Both the scheme and host are normalized as they are both case-insensitive according to RFC 3986. """ - def __new__( # type: ignore[no-untyped-def] + __slots__ = () + + def __new__( cls, - scheme: str | None = None, - auth: str | None = None, - host: str | None = None, - port: int | None = None, - path: str | None = None, - query: str | None = None, - fragment: str | None = None, + scheme=None, + auth=None, + host=None, + port=None, + path=None, + query=None, + fragment=None, ): if path and not path.startswith("/"): path = "/" + path if scheme is not None: scheme = scheme.lower() - return super().__new__(cls, scheme, auth, host, port, path, query, fragment) + return super(Url, cls).__new__( + cls, scheme, auth, host, port, path, query, fragment + ) @property - def hostname(self) -> str | None: + def hostname(self): """For backwards-compatibility with urlparse. We're nice like that.""" return self.host @property - def request_uri(self) -> str: + def request_uri(self): """Absolute path including the query string.""" uri = self.path or "/" @@ -129,37 +122,14 @@ def request_uri(self) -> str: return uri @property - def authority(self) -> str | None: - """ - Authority component as defined in RFC 3986 3.2. - This includes userinfo (auth), host and port. - - i.e. - userinfo@host:port - """ - userinfo = self.auth - netloc = self.netloc - if netloc is None or userinfo is None: - return netloc - else: - return f"{userinfo}@{netloc}" - - @property - def netloc(self) -> str | None: - """ - Network location including host and port. - - If you need the equivalent of urllib.parse's ``netloc``, - use the ``authority`` property instead. - """ - if self.host is None: - return None + def netloc(self): + """Network location including host and port""" if self.port: - return f"{self.host}:{self.port}" + return "%s:%d" % (self.host, self.port) return self.host @property - def url(self) -> str: + def url(self): """ Convert self into a url @@ -168,77 +138,88 @@ def url(self) -> str: :func:`.parse_url`, but it should be equivalent by the RFC (e.g., urls with a blank port will have : removed). - Example: - - .. code-block:: python - - import urllib3 + Example: :: - U = urllib3.util.parse_url("https://google.com/mail/") - - print(U.url) - # "https://google.com/mail/" - - print( urllib3.util.Url("https", "username:password", - "host.com", 80, "/path", "query", "fragment" - ).url - ) - # "https://username:password@host.com:80/path?query#fragment" + >>> U = parse_url('http://google.com/mail/') + >>> U.url + 'http://google.com/mail/' + >>> Url('http', 'username:password', 'host.com', 80, + ... '/path', 'query', 'fragment').url + 'http://username:password@host.com:80/path?query#fragment' """ scheme, auth, host, port, path, query, fragment = self - url = "" + url = u"" # We use "is not None" we want things to happen with empty strings (or 0 port) if scheme is not None: - url += scheme + "://" + url += scheme + u"://" if auth is not None: - url += auth + "@" + url += auth + u"@" if host is not None: url += host if port is not None: - url += ":" + str(port) + url += u":" + str(port) if path is not None: url += path if query is not None: - url += "?" + query + url += u"?" + query if fragment is not None: - url += "#" + fragment + url += u"#" + fragment return url - def __str__(self) -> str: + def __str__(self): return self.url -@typing.overload -def _encode_invalid_chars( - component: str, allowed_chars: typing.Container[str] -) -> str: # Abstract - ... +def split_first(s, delims): + """ + .. deprecated:: 1.25 + + Given a string and an iterable of delimiters, split on the first found + delimiter. Return two split parts and the matched delimiter. + + If not found, then the first part is the full input string. + + Example:: + + >>> split_first('foo/bar?baz', '?/=') + ('foo', 'bar?baz', '/') + >>> split_first('foo/bar?baz', '123') + ('foo/bar?baz', '', None) + + Scales linearly with number of delims. Not ideal for large number of delims. + """ + min_idx = None + min_delim = None + for d in delims: + idx = s.find(d) + if idx < 0: + continue + if min_idx is None or idx < min_idx: + min_idx = idx + min_delim = d -@typing.overload -def _encode_invalid_chars( - component: None, allowed_chars: typing.Container[str] -) -> None: # Abstract - ... + if min_idx is None or min_idx < 0: + return s, "", None + return s[:min_idx], s[min_idx + 1 :], min_delim -def _encode_invalid_chars( - component: str | None, allowed_chars: typing.Container[str] -) -> str | None: + +def _encode_invalid_chars(component, allowed_chars, encoding="utf-8"): """Percent-encodes a URI component without reapplying onto an already percent-encoded component. """ if component is None: return component - component = to_str(component) + component = six.ensure_text(component) # Normalize existing percent-encoded bytes. # Try to see if the component we're encoding is already percent-encoded # so we can skip all '%' characters but still encode all others. - component, percent_encodings = _PERCENT_RE.subn( + component, percent_encodings = PERCENT_RE.subn( lambda match: match.group(0).upper(), component ) @@ -247,7 +228,7 @@ def _encode_invalid_chars( encoded_component = bytearray() for i in range(0, len(uri_bytes)): - # Will return a single character bytestring + # Will return a single character bytestring on both Python 2 & 3 byte = uri_bytes[i : i + 1] byte_ord = ord(byte) if (is_percent_encoded and byte == b"%") or ( @@ -257,10 +238,10 @@ def _encode_invalid_chars( continue encoded_component.extend(b"%" + (hex(byte_ord)[2:].encode().zfill(2).upper())) - return encoded_component.decode() + return encoded_component.decode(encoding) -def _remove_path_dot_segments(path: str) -> str: +def _remove_path_dot_segments(path): # See http://tools.ietf.org/html/rfc3986#section-5.2.4 for pseudo-code segments = path.split("/") # Turn the path into a list of segments output = [] # Initialize the variable to use to store output @@ -270,7 +251,7 @@ def _remove_path_dot_segments(path: str) -> str: if segment == ".": continue # Anything other than '..', should be appended to the output - if segment != "..": + elif segment != "..": output.append(segment) # In this case segment == '..', if we can, we should pop the last # element @@ -290,23 +271,18 @@ def _remove_path_dot_segments(path: str) -> str: return "/".join(output) -@typing.overload -def _normalize_host(host: None, scheme: str | None) -> None: ... - - -@typing.overload -def _normalize_host(host: str, scheme: str | None) -> str: ... - - -def _normalize_host(host: str | None, scheme: str | None) -> str | None: +def _normalize_host(host, scheme): if host: - if scheme in _NORMALIZABLE_SCHEMES: - is_ipv6 = _IPV6_ADDRZ_RE.match(host) + if isinstance(host, six.binary_type): + host = six.ensure_str(host) + + if scheme in NORMALIZABLE_SCHEMES: + is_ipv6 = IPV6_ADDRZ_RE.match(host) if is_ipv6: # IPv6 hosts of the form 'a::b%zone' are encoded in a URL as # such per RFC 6874: 'a::b%25zone'. Unquote the ZoneID # separator as necessary to return a valid RFC 4007 scoped IP. - match = _ZONE_ID_RE.search(host) + match = ZONE_ID_RE.search(host) if match: start, end = match.span(1) zone_id = host[start:end] @@ -315,56 +291,46 @@ def _normalize_host(host: str | None, scheme: str | None) -> str | None: zone_id = zone_id[3:] else: zone_id = zone_id[1:] - zone_id = _encode_invalid_chars(zone_id, _UNRESERVED_CHARS) - return f"{host[:start].lower()}%{zone_id}{host[end:]}" + zone_id = "%" + _encode_invalid_chars(zone_id, UNRESERVED_CHARS) + return host[:start].lower() + zone_id + host[end:] else: return host.lower() - elif not _IPV4_RE.match(host): - return to_str( - b".".join([_idna_encode(label) for label in host.split(".")]), - "ascii", + elif not IPV4_RE.match(host): + return six.ensure_str( + b".".join([_idna_encode(label) for label in host.split(".")]) ) return host -def _idna_encode(name: str) -> bytes: - if not name.isascii(): +def _idna_encode(name): + if name and any(ord(x) >= 128 for x in name): try: import idna except ImportError: - raise LocationParseError( - "Unable to parse URL without the 'idna' module" - ) from None - + six.raise_from( + LocationParseError("Unable to parse URL without the 'idna' module"), + None, + ) try: return idna.encode(name.lower(), strict=True, std3_rules=True) except idna.IDNAError: - raise LocationParseError( - f"Name '{name}' is not a valid IDNA label" - ) from None - + six.raise_from( + LocationParseError(u"Name '%s' is not a valid IDNA label" % name), None + ) return name.lower().encode("ascii") -def _encode_target(target: str) -> str: - """Percent-encodes a request target so that there are no invalid characters - - Pre-condition for this function is that 'target' must start with '/'. - If that is the case then _TARGET_RE will always produce a match. - """ - match = _TARGET_RE.match(target) - if not match: # Defensive: - raise LocationParseError(f"{target!r} is not a valid request URI") - - path, query = match.groups() - encoded_target = _encode_invalid_chars(path, _PATH_CHARS) +def _encode_target(target): + """Percent-encodes a request target so that there are no invalid characters""" + path, query = TARGET_RE.match(target).groups() + target = _encode_invalid_chars(path, PATH_CHARS) + query = _encode_invalid_chars(query, QUERY_CHARS) if query is not None: - query = _encode_invalid_chars(query, _QUERY_CHARS) - encoded_target += "?" + query - return encoded_target + target += "?" + query + return target -def parse_url(url: str) -> Url: +def parse_url(url): """ Given a url, return a parsed :class:`.Url` namedtuple. Best-effort is performed to parse incomplete urls. Fields not provided will be None. @@ -375,44 +341,28 @@ def parse_url(url: str) -> Url: :param str url: URL to parse into a :class:`.Url` namedtuple. - Partly backwards-compatible with :mod:`urllib.parse`. + Partly backwards-compatible with :mod:`urlparse`. - Example: + Example:: - .. code-block:: python - - import urllib3 - - print( urllib3.util.parse_url('http://google.com/mail/')) - # Url(scheme='http', host='google.com', port=None, path='/mail/', ...) - - print( urllib3.util.parse_url('google.com:80')) - # Url(scheme=None, host='google.com', port=80, path=None, ...) - - print( urllib3.util.parse_url('/foo?bar')) - # Url(scheme=None, host=None, port=None, path='/foo', query='bar', ...) + >>> parse_url('http://google.com/mail/') + Url(scheme='http', host='google.com', port=None, path='/mail/', ...) + >>> parse_url('google.com:80') + Url(scheme=None, host='google.com', port=80, path=None, ...) + >>> parse_url('/foo?bar') + Url(scheme=None, host=None, port=None, path='/foo', query='bar', ...) """ if not url: # Empty return Url() source_url = url - if not _SCHEME_RE.search(url): + if not SCHEME_RE.search(url): url = "//" + url - scheme: str | None - authority: str | None - auth: str | None - host: str | None - port: str | None - port_int: int | None - path: str | None - query: str | None - fragment: str | None - try: - scheme, authority, path, query, fragment = _URI_RE.match(url).groups() # type: ignore[union-attr] - normalize_uri = scheme is None or scheme.lower() in _NORMALIZABLE_SCHEMES + scheme, authority, path, query, fragment = URI_RE.match(url).groups() + normalize_uri = scheme is None or scheme.lower() in NORMALIZABLE_SCHEMES if scheme: scheme = scheme.lower() @@ -420,33 +370,31 @@ def parse_url(url: str) -> Url: if authority: auth, _, host_port = authority.rpartition("@") auth = auth or None - host, port = _HOST_PORT_RE.match(host_port).groups() # type: ignore[union-attr] + host, port = _HOST_PORT_RE.match(host_port).groups() if auth and normalize_uri: - auth = _encode_invalid_chars(auth, _USERINFO_CHARS) + auth = _encode_invalid_chars(auth, USERINFO_CHARS) if port == "": port = None else: auth, host, port = None, None, None if port is not None: - port_int = int(port) - if not (0 <= port_int <= 65535): + port = int(port) + if not (0 <= port <= 65535): raise LocationParseError(url) - else: - port_int = None host = _normalize_host(host, scheme) if normalize_uri and path: path = _remove_path_dot_segments(path) - path = _encode_invalid_chars(path, _PATH_CHARS) + path = _encode_invalid_chars(path, PATH_CHARS) if normalize_uri and query: - query = _encode_invalid_chars(query, _QUERY_CHARS) + query = _encode_invalid_chars(query, QUERY_CHARS) if normalize_uri and fragment: - fragment = _encode_invalid_chars(fragment, _FRAGMENT_CHARS) + fragment = _encode_invalid_chars(fragment, FRAGMENT_CHARS) - except (ValueError, AttributeError) as e: - raise LocationParseError(source_url) from e + except (ValueError, AttributeError): + return six.raise_from(LocationParseError(source_url), None) # For the sake of backwards compatibility we put empty # string values for path if there are any defined values @@ -458,12 +406,30 @@ def parse_url(url: str) -> Url: else: path = None + # Ensure that each part of the URL is a `str` for + # backwards compatibility. + if isinstance(url, six.text_type): + ensure_func = six.ensure_text + else: + ensure_func = six.ensure_str + + def ensure_type(x): + return x if x is None else ensure_func(x) + return Url( - scheme=scheme, - auth=auth, - host=host, - port=port_int, - path=path, - query=query, - fragment=fragment, + scheme=ensure_type(scheme), + auth=ensure_type(auth), + host=ensure_type(host), + port=port, + path=ensure_type(path), + query=ensure_type(query), + fragment=ensure_type(fragment), ) + + +def get_host(url): + """ + Deprecated. Use :func:`parse_url` instead. + """ + p = parse_url(url) + return p.scheme or "http", p.hostname, p.port diff --git a/newrelic/packages/urllib3/util/util.py b/newrelic/packages/urllib3/util/util.py deleted file mode 100644 index 35c77e4025..0000000000 --- a/newrelic/packages/urllib3/util/util.py +++ /dev/null @@ -1,42 +0,0 @@ -from __future__ import annotations - -import typing -from types import TracebackType - - -def to_bytes( - x: str | bytes, encoding: str | None = None, errors: str | None = None -) -> bytes: - if isinstance(x, bytes): - return x - elif not isinstance(x, str): - raise TypeError(f"not expecting type {type(x).__name__}") - if encoding or errors: - return x.encode(encoding or "utf-8", errors=errors or "strict") - return x.encode() - - -def to_str( - x: str | bytes, encoding: str | None = None, errors: str | None = None -) -> str: - if isinstance(x, str): - return x - elif not isinstance(x, bytes): - raise TypeError(f"not expecting type {type(x).__name__}") - if encoding or errors: - return x.decode(encoding or "utf-8", errors=errors or "strict") - return x.decode() - - -def reraise( - tp: type[BaseException] | None, - value: BaseException, - tb: TracebackType | None = None, -) -> typing.NoReturn: - try: - if value.__traceback__ is not tb: - raise value.with_traceback(tb) - raise value - finally: - value = None # type: ignore[assignment] - tb = None diff --git a/newrelic/packages/urllib3/util/wait.py b/newrelic/packages/urllib3/util/wait.py index aeca0c7ad5..21b4590b3d 100644 --- a/newrelic/packages/urllib3/util/wait.py +++ b/newrelic/packages/urllib3/util/wait.py @@ -1,10 +1,18 @@ -from __future__ import annotations - +import errno import select -import socket +import sys from functools import partial -__all__ = ["wait_for_read", "wait_for_write"] +try: + from time import monotonic +except ImportError: + from time import time as monotonic + +__all__ = ["NoWayToWaitForSocketError", "wait_for_read", "wait_for_write"] + + +class NoWayToWaitForSocketError(Exception): + pass # How should we wait on sockets? @@ -29,13 +37,37 @@ # So: on Windows we use select(), and everywhere else we use poll(). We also # fall back to select() in case poll() is somehow broken or missing. - -def select_wait_for_socket( - sock: socket.socket, - read: bool = False, - write: bool = False, - timeout: float | None = None, -) -> bool: +if sys.version_info >= (3, 5): + # Modern Python, that retries syscalls by default + def _retry_on_intr(fn, timeout): + return fn(timeout) + +else: + # Old and broken Pythons. + def _retry_on_intr(fn, timeout): + if timeout is None: + deadline = float("inf") + else: + deadline = monotonic() + timeout + + while True: + try: + return fn(timeout) + # OSError for 3 <= pyver < 3.5, select.error for pyver <= 2.7 + except (OSError, select.error) as e: + # 'e.args[0]' incantation works for both OSError and select.error + if e.args[0] != errno.EINTR: + raise + else: + timeout = deadline - monotonic() + if timeout < 0: + timeout = 0 + if timeout == float("inf"): + timeout = None + continue + + +def select_wait_for_socket(sock, read=False, write=False, timeout=None): if not read and not write: raise RuntimeError("must specify at least one of read=True, write=True") rcheck = [] @@ -50,16 +82,11 @@ def select_wait_for_socket( # sockets for both conditions. (The stdlib selectors module does the same # thing.) fn = partial(select.select, rcheck, wcheck, wcheck) - rready, wready, xready = fn(timeout) + rready, wready, xready = _retry_on_intr(fn, timeout) return bool(rready or wready or xready) -def poll_wait_for_socket( - sock: socket.socket, - read: bool = False, - write: bool = False, - timeout: float | None = None, -) -> bool: +def poll_wait_for_socket(sock, read=False, write=False, timeout=None): if not read and not write: raise RuntimeError("must specify at least one of read=True, write=True") mask = 0 @@ -71,33 +98,32 @@ def poll_wait_for_socket( poll_obj.register(sock, mask) # For some reason, poll() takes timeout in milliseconds - def do_poll(t: float | None) -> list[tuple[int, int]]: + def do_poll(t): if t is not None: t *= 1000 return poll_obj.poll(t) - return bool(do_poll(timeout)) + return bool(_retry_on_intr(do_poll, timeout)) + + +def null_wait_for_socket(*args, **kwargs): + raise NoWayToWaitForSocketError("no select-equivalent available") -def _have_working_poll() -> bool: +def _have_working_poll(): # Apparently some systems have a select.poll that fails as soon as you try # to use it, either due to strange configuration or broken monkeypatching # from libraries like eventlet/greenlet. try: poll_obj = select.poll() - poll_obj.poll(0) + _retry_on_intr(poll_obj.poll, 0) except (AttributeError, OSError): return False else: return True -def wait_for_socket( - sock: socket.socket, - read: bool = False, - write: bool = False, - timeout: float | None = None, -) -> bool: +def wait_for_socket(*args, **kwargs): # We delay choosing which implementation to use until the first time we're # called. We could do it at import time, but then we might make the wrong # decision if someone goes wild with monkeypatching select.poll after @@ -107,17 +133,19 @@ def wait_for_socket( wait_for_socket = poll_wait_for_socket elif hasattr(select, "select"): wait_for_socket = select_wait_for_socket - return wait_for_socket(sock, read, write, timeout) + else: # Platform-specific: Appengine. + wait_for_socket = null_wait_for_socket + return wait_for_socket(*args, **kwargs) -def wait_for_read(sock: socket.socket, timeout: float | None = None) -> bool: +def wait_for_read(sock, timeout=None): """Waits for reading to be available on a given socket. Returns True if the socket is readable, or False if the timeout expired. """ return wait_for_socket(sock, read=True, timeout=timeout) -def wait_for_write(sock: socket.socket, timeout: float | None = None) -> bool: +def wait_for_write(sock, timeout=None): """Waits for writing to be available on a given socket. Returns True if the socket is readable, or False if the timeout expired. """ diff --git a/newrelic/packages/wrapt/LICENSE b/newrelic/packages/wrapt/LICENSE index 643f6fe280..d49cae8439 100644 --- a/newrelic/packages/wrapt/LICENSE +++ b/newrelic/packages/wrapt/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2013-2025, Graham Dumpleton +Copyright (c) 2013-2019, Graham Dumpleton All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/newrelic/packages/wrapt/__init__.py b/newrelic/packages/wrapt/__init__.py index fe7730c0b9..ed31a94313 100644 --- a/newrelic/packages/wrapt/__init__.py +++ b/newrelic/packages/wrapt/__init__.py @@ -1,64 +1,30 @@ -""" -Wrapt is a library for decorators, wrappers and monkey patching. -""" +__version_info__ = ('1', '16', '0') +__version__ = '.'.join(__version_info__) -__version_info__ = ("2", "0", "1") -__version__ = ".".join(__version_info__) +from .__wrapt__ import (ObjectProxy, CallableObjectProxy, FunctionWrapper, + BoundFunctionWrapper, PartialCallableObjectProxy) + +from .patches import (resolve_path, apply_patch, wrap_object, wrap_object_attribute, + function_wrapper, wrap_function_wrapper, patch_function_wrapper, + transient_function_wrapper) -from .__wrapt__ import ( - BaseObjectProxy, - BoundFunctionWrapper, - CallableObjectProxy, - FunctionWrapper, - PartialCallableObjectProxy, - partial, -) -from .decorators import AdapterFactory, adapter_factory, decorator, synchronized -from .importer import ( - discover_post_import_hooks, - notify_module_loaded, - register_post_import_hook, - when_imported, -) -from .patches import ( - apply_patch, - function_wrapper, - patch_function_wrapper, - resolve_path, - transient_function_wrapper, - wrap_function_wrapper, - wrap_object, - wrap_object_attribute, -) -from .proxies import AutoObjectProxy, LazyObjectProxy, ObjectProxy, lazy_import from .weakrefs import WeakFunctionProxy -__all__ = ( - "AutoObjectProxy", - "BaseObjectProxy", - "BoundFunctionWrapper", - "CallableObjectProxy", - "FunctionWrapper", - "LazyObjectProxy", - "ObjectProxy", - "PartialCallableObjectProxy", - "partial", - "AdapterFactory", - "adapter_factory", - "decorator", - "synchronized", - "discover_post_import_hooks", - "notify_module_loaded", - "register_post_import_hook", - "when_imported", - "apply_patch", - "function_wrapper", - "lazy_import", - "patch_function_wrapper", - "resolve_path", - "transient_function_wrapper", - "wrap_function_wrapper", - "wrap_object", - "wrap_object_attribute", - "WeakFunctionProxy", -) +from .decorators import (adapter_factory, AdapterFactory, decorator, + synchronized) + +from .importer import (register_post_import_hook, when_imported, + notify_module_loaded, discover_post_import_hooks) + +# Import of inspect.getcallargs() included for backward compatibility. An +# implementation of this was previously bundled and made available here for +# Python <2.7. Avoid using this in future. + +from inspect import getcallargs + +# Variant of inspect.formatargspec() included here for forward compatibility. +# This is being done because Python 3.11 dropped inspect.formatargspec() but +# code for handling signature changing decorators relied on it. Exposing the +# bundled implementation here in case any user of wrapt was also needing it. + +from .arguments import formatargspec diff --git a/newrelic/packages/wrapt/__init__.pyi b/newrelic/packages/wrapt/__init__.pyi deleted file mode 100644 index 2e33e00e7f..0000000000 --- a/newrelic/packages/wrapt/__init__.pyi +++ /dev/null @@ -1,319 +0,0 @@ -import sys - -if sys.version_info >= (3, 10): - from inspect import FullArgSpec - from types import ModuleType, TracebackType - from typing import ( - Any, - Callable, - Concatenate, - Generic, - ParamSpec, - Protocol, - TypeVar, - overload, - ) - - P = ParamSpec("P") - R = TypeVar("R", covariant=True) - - T = TypeVar("T", bound=Any) - - class Boolean(Protocol): - def __bool__(self) -> bool: ... - - # ObjectProxy - - class BaseObjectProxy(Generic[T]): - __wrapped__: T - def __init__(self, wrapped: T) -> None: ... - - class ObjectProxy(BaseObjectProxy[T]): - def __init__(self, wrapped: T) -> None: ... - - class AutoObjectProxy(BaseObjectProxy[T]): - def __init__(self, wrapped: T) -> None: ... - - # LazyObjectProxy - - class LazyObjectProxy(AutoObjectProxy[T]): - def __init__( - self, callback: Callable[[], T] | None, *, interface: Any = ... - ) -> None: ... - - @overload - def lazy_import(name: str) -> LazyObjectProxy[ModuleType]: ... - @overload - def lazy_import( - name: str, attribute: str, *, interface: Any = ... - ) -> LazyObjectProxy[Any]: ... - - # CallableObjectProxy - - class CallableObjectProxy(BaseObjectProxy[T]): - def __call__(self, *args: Any, **kwargs: Any) -> Any: ... - - # PartialCallableObjectProxy - - class PartialCallableObjectProxy: - def __init__( - self, func: Callable[..., Any], *args: Any, **kwargs: Any - ) -> None: ... - def __call__(self, *args: Any, **kwargs: Any) -> Any: ... - - def partial( - func: Callable[..., Any], /, *args: Any, **kwargs: Any - ) -> Callable[..., Any]: ... - - # WeakFunctionProxy - - class WeakFunctionProxy: - def __init__( - self, - wrapped: Callable[..., Any], - callback: Callable[..., Any] | None = None, - ) -> None: ... - def __call__(self, *args: Any, **kwargs: Any) -> Any: ... - - # FunctionWrapper - - WrappedFunction = Callable[P, R] - - GenericCallableWrapperFunction = Callable[ - [WrappedFunction[P, R], Any, tuple[Any, ...], dict[str, Any]], R - ] - - ClassMethodWrapperFunction = Callable[ - [type[Any], WrappedFunction[P, R], Any, tuple[Any, ...], dict[str, Any]], R - ] - - InstanceMethodWrapperFunction = Callable[ - [Any, WrappedFunction[P, R], Any, tuple[Any, ...], dict[str, Any]], R - ] - - WrapperFunction = ( - GenericCallableWrapperFunction[P, R] - | ClassMethodWrapperFunction[P, R] - | InstanceMethodWrapperFunction[P, R] - ) - - class _FunctionWrapperBase(ObjectProxy[WrappedFunction[P, R]]): - _self_instance: Any - _self_wrapper: WrapperFunction[P, R] - _self_enabled: bool | Boolean | Callable[[], bool] | None - _self_binding: str - _self_parent: Any - _self_owner: Any - - class BoundFunctionWrapper(_FunctionWrapperBase[P, R]): - def __call__(self, *args: P.args, **kwargs: P.kwargs) -> R: ... - def __get__( - self, instance: Any, owner: type[Any] | None = None - ) -> "BoundFunctionWrapper[P, R]": ... - - class FunctionWrapper(_FunctionWrapperBase[P, R]): - def __init__( - self, - wrapped: WrappedFunction[P, R], - wrapper: WrapperFunction[P, R], - enabled: bool | Boolean | Callable[[], bool] | None = None, - ) -> None: ... - def __call__(self, *args: P.args, **kwargs: P.kwargs) -> R: ... - def __get__( - self, instance: Any, owner: type[Any] | None = None - ) -> BoundFunctionWrapper[P, R]: ... - - # AdapterFactory/adapter_factory() - - class AdapterFactory(Protocol): - def __call__( - self, wrapped: Callable[..., Any] - ) -> str | FullArgSpec | Callable[..., Any]: ... - - def adapter_factory(wrapped: Callable[..., Any]) -> AdapterFactory: ... - - # decorator() - - class Descriptor(Protocol): - def __get__(self, instance: Any, owner: type[Any] | None = None) -> Any: ... - - class FunctionDecorator(Generic[P, R]): - def __call__( - self, - callable: ( - Callable[P, R] - | Callable[Concatenate[type[T], P], R] - | Callable[Concatenate[Any, P], R] - | Callable[[type[T]], R] - | Descriptor - ), - ) -> FunctionWrapper[P, R]: ... - - class PartialFunctionDecorator: - @overload - def __call__( - self, wrapper: GenericCallableWrapperFunction[P, R], / - ) -> FunctionDecorator[P, R]: ... - @overload - def __call__( - self, wrapper: ClassMethodWrapperFunction[P, R], / - ) -> FunctionDecorator[P, R]: ... - @overload - def __call__( - self, wrapper: InstanceMethodWrapperFunction[P, R], / - ) -> FunctionDecorator[P, R]: ... - - # ... Decorator applied to class type. - - @overload - def decorator(wrapper: type[T], /) -> FunctionDecorator[Any, Any]: ... - - # ... Decorator applied to function or method. - - @overload - def decorator( - wrapper: GenericCallableWrapperFunction[P, R], / - ) -> FunctionDecorator[P, R]: ... - @overload - def decorator( - wrapper: ClassMethodWrapperFunction[P, R], / - ) -> FunctionDecorator[P, R]: ... - @overload - def decorator( - wrapper: InstanceMethodWrapperFunction[P, R], / - ) -> FunctionDecorator[P, R]: ... - - # ... Positional arguments. - - @overload - def decorator( - *, - enabled: bool | Boolean | Callable[[], bool] | None = None, - adapter: str | FullArgSpec | AdapterFactory | Callable[..., Any] | None = None, - proxy: type[FunctionWrapper[Any, Any]] | None = None, - ) -> PartialFunctionDecorator: ... - - # function_wrapper() - - @overload - def function_wrapper(wrapper: type[Any]) -> FunctionDecorator[Any, Any]: ... - @overload - def function_wrapper( - wrapper: GenericCallableWrapperFunction[P, R], - ) -> FunctionDecorator[P, R]: ... - @overload - def function_wrapper( - wrapper: ClassMethodWrapperFunction[P, R], - ) -> FunctionDecorator[P, R]: ... - @overload - def function_wrapper( - wrapper: InstanceMethodWrapperFunction[P, R], - ) -> FunctionDecorator[P, R]: ... - # @overload - # def function_wrapper(wrapper: Any) -> FunctionDecorator[Any, Any]: ... # Don't use, breaks stuff. - - # wrap_function_wrapper() - - def wrap_function_wrapper( - target: ModuleType | type[Any] | Any | str, - name: str, - wrapper: WrapperFunction[P, R], - ) -> FunctionWrapper[P, R]: ... - - # patch_function_wrapper() - - class WrapperDecorator: - def __call__(self, wrapper: WrapperFunction[P, R]) -> FunctionWrapper[P, R]: ... - - def patch_function_wrapper( - target: ModuleType | type[Any] | Any | str, - name: str, - enabled: bool | Boolean | Callable[[], bool] | None = None, - ) -> WrapperDecorator: ... - - # transient_function_wrapper() - - class TransientDecorator: - def __call__( - self, wrapper: WrapperFunction[P, R] - ) -> FunctionDecorator[P, R]: ... - - def transient_function_wrapper( - target: ModuleType | type[Any] | Any | str, name: str - ) -> TransientDecorator: ... - - # resolve_path() - - def resolve_path( - target: ModuleType | type[Any] | Any | str, name: str - ) -> tuple[ModuleType | type[Any] | Any, str, Callable[..., Any]]: ... - - # apply_patch() - - def apply_patch( - parent: ModuleType | type[Any] | Any, - attribute: str, - replacement: Any, - ) -> None: ... - - # wrap_object() - - WrapperFactory = Callable[ - [Callable[..., Any], tuple[Any, ...], dict[str, Any]], type[ObjectProxy[Any]] - ] - - def wrap_object( - target: ModuleType | type[Any] | Any | str, - name: str, - factory: WrapperFactory | type[ObjectProxy[Any]], - args: tuple[Any, ...], - kwargs: dict[str, Any], - ) -> Any: ... - - # wrap_object_attribute() - - def wrap_object_attribute( - target: ModuleType | type[Any] | Any | str, - name: str, - factory: WrapperFactory | type[ObjectProxy[Any]], - args: tuple[Any, ...] = (), - kwargs: dict[str, Any] = {}, - ) -> Any: ... - - # register_post_import_hook() - - def register_post_import_hook( - hook: Callable[[ModuleType], Any] | str, name: str - ) -> None: ... - - # discover_post_import_hooks() - - def discover_post_import_hooks(group: str) -> None: ... - - # notify_module_loaded() - - def notify_module_loaded(module: ModuleType) -> None: ... - - # when_imported() - - class ImportHookDecorator: - def __call__(self, hook: Callable[[ModuleType], Any]) -> Callable[..., Any]: ... - - def when_imported(name: str) -> ImportHookDecorator: ... - - # synchronized() - - class SynchronizedObject: - def __call__(self, wrapped: Callable[P, R]) -> Callable[P, R]: ... - def __enter__(self) -> Any: ... - def __exit__( - self, - exc_type: type[BaseException] | None, - exc_value: BaseException | None, - traceback: TracebackType | None, - ) -> bool | None: ... - - @overload - def synchronized(wrapped: Callable[P, R]) -> Callable[P, R]: ... - @overload - def synchronized(wrapped: Any) -> SynchronizedObject: ... diff --git a/newrelic/packages/wrapt/__wrapt__.py b/newrelic/packages/wrapt/__wrapt__.py index ac8f32bb92..9933b2c972 100644 --- a/newrelic/packages/wrapt/__wrapt__.py +++ b/newrelic/packages/wrapt/__wrapt__.py @@ -1,44 +1,14 @@ -"""This module is used to switch between C and Python implementations of the -wrappers. -""" - import os -from .wrappers import BoundFunctionWrapper, CallableObjectProxy, FunctionWrapper -from .wrappers import ObjectProxy as BaseObjectProxy -from .wrappers import PartialCallableObjectProxy, _FunctionWrapperBase - -# Try to use C extensions if not disabled. - -_using_c_extension = False - -_use_extensions = not os.environ.get("WRAPT_DISABLE_EXTENSIONS") - -if _use_extensions: - try: - from ._wrappers import ( # type: ignore[no-redef,import-not-found] - BoundFunctionWrapper, - CallableObjectProxy, - FunctionWrapper, - ) - from ._wrappers import ( - ObjectProxy as BaseObjectProxy, # type: ignore[no-redef,import-not-found] - ) - from ._wrappers import ( # type: ignore[no-redef,import-not-found] - PartialCallableObjectProxy, - _FunctionWrapperBase, - ) - - _using_c_extension = True - except ImportError: - # C extensions not available, using Python implementations - pass +from .wrappers import (ObjectProxy, CallableObjectProxy, + PartialCallableObjectProxy, FunctionWrapper, + BoundFunctionWrapper, _FunctionWrapperBase) +try: + if not os.environ.get('WRAPT_DISABLE_EXTENSIONS'): + from ._wrappers import (ObjectProxy, CallableObjectProxy, + PartialCallableObjectProxy, FunctionWrapper, + BoundFunctionWrapper, _FunctionWrapperBase) -def partial(*args, **kwargs): - """Create a callable object proxy with partial application of the given - arguments and keywords. This behaves the same as `functools.partial`, but - implemented using the `ObjectProxy` class to provide better support for - introspection. - """ - return PartialCallableObjectProxy(*args, **kwargs) +except ImportError: + pass diff --git a/newrelic/packages/wrapt/_wrappers.c b/newrelic/packages/wrapt/_wrappers.c index 8cd2f6c28f..e0e1b5bc65 100644 --- a/newrelic/packages/wrapt/_wrappers.c +++ b/newrelic/packages/wrapt/_wrappers.c @@ -10,38 +10,34 @@ /* ------------------------------------------------------------------------- */ -typedef struct -{ - PyObject_HEAD +typedef struct { + PyObject_HEAD - PyObject *dict; - PyObject *wrapped; - PyObject *weakreflist; + PyObject *dict; + PyObject *wrapped; + PyObject *weakreflist; } WraptObjectProxyObject; PyTypeObject WraptObjectProxy_Type; PyTypeObject WraptCallableObjectProxy_Type; -typedef struct -{ - WraptObjectProxyObject object_proxy; +typedef struct { + WraptObjectProxyObject object_proxy; - PyObject *args; - PyObject *kwargs; + PyObject *args; + PyObject *kwargs; } WraptPartialCallableObjectProxyObject; PyTypeObject WraptPartialCallableObjectProxy_Type; -typedef struct -{ - WraptObjectProxyObject object_proxy; - - PyObject *instance; - PyObject *wrapper; - PyObject *enabled; - PyObject *binding; - PyObject *parent; - PyObject *owner; +typedef struct { + WraptObjectProxyObject object_proxy; + + PyObject *instance; + PyObject *wrapper; + PyObject *enabled; + PyObject *binding; + PyObject *parent; } WraptFunctionWrapperObject; PyTypeObject WraptFunctionWrapperBase_Type; @@ -50,4048 +46,3195 @@ PyTypeObject WraptFunctionWrapper_Type; /* ------------------------------------------------------------------------- */ -static int raise_uninitialized_wrapper_error(WraptObjectProxyObject *object) +static PyObject *WraptObjectProxy_new(PyTypeObject *type, + PyObject *args, PyObject *kwds) { - // Before raising an exception we need to first check whether this is a lazy - // proxy object and attempt to intialize the wrapped object using the supplied - // callback if so. If the callback is not present then we can proceed to raise - // the exception, but if the callback is present and returns a value, we set - // that as the wrapped object and continue and return without raising an error. - - static PyObject *wrapped_str = NULL; - static PyObject *wrapped_factory_str = NULL; - static PyObject *wrapped_get_str = NULL; - - PyObject *callback = NULL; - PyObject *value = NULL; - - if (!wrapped_str) - { - wrapped_str = PyUnicode_InternFromString("__wrapped__"); - wrapped_factory_str = PyUnicode_InternFromString("__wrapped_factory__"); - wrapped_get_str = PyUnicode_InternFromString("__wrapped_get__"); - } - - // Note that we use existance of __wrapped_factory__ to gate whether we can - // attempt to initialize the wrapped object lazily, but it is __wrapped_get__ - // that we actually call to do the initialization. This is so that we can - // handle multithreading correctly by having __wrapped_get__ use a lock to - // protect against multiple threads trying to initialize the wrapped object - // at the same time. - - callback = PyObject_GenericGetAttr((PyObject *)object, wrapped_factory_str); - - if (callback) - { - if (callback != Py_None) - { - Py_DECREF(callback); - - callback = PyObject_GenericGetAttr((PyObject *)object, wrapped_get_str); - - if (!callback) - return -1; - - value = PyObject_CallObject(callback, NULL); - - Py_DECREF(callback); - - if (value) - { - // We use setattr so that special dunder methods will be properly set. - - if (PyObject_SetAttr((PyObject *)object, wrapped_str, value) == -1) - { - Py_DECREF(value); - return -1; - } - - Py_DECREF(value); - - return 0; - } - else - { - return -1; - } - } - else - { - Py_DECREF(callback); - } - } - else - PyErr_Clear(); - - // We need to reach into the wrapt.wrappers module to get the exception - // class because the exception we need to raise needs to inherit from both - // ValueError and AttributeError and we can't do that in C code using the - // built in exception classes, or at least not easily or safely. - - PyObject *wrapt_wrappers_module = NULL; - PyObject *wrapper_not_initialized_error = NULL; - - // Import the wrapt.wrappers module and get the exception class. - // We do this fresh each time to be safe with multiple sub-interpreters. - - wrapt_wrappers_module = PyImport_ImportModule("wrapt.wrappers"); - - if (!wrapt_wrappers_module) - { - // Fallback to ValueError if import fails. - - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - - return -1; - } + WraptObjectProxyObject *self; - wrapper_not_initialized_error = PyObject_GetAttrString( - wrapt_wrappers_module, "WrapperNotInitializedError"); + self = (WraptObjectProxyObject *)type->tp_alloc(type, 0); - if (!wrapper_not_initialized_error) - { - // Fallback to ValueError if attribute lookup fails. - - Py_DECREF(wrapt_wrappers_module); - - PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); - - return -1; - } - - // Raise the custom exception. - - PyErr_SetString(wrapper_not_initialized_error, - "wrapper has not been initialized"); - - // Clean up references. + if (!self) + return NULL; - Py_DECREF(wrapper_not_initialized_error); - Py_DECREF(wrapt_wrappers_module); + self->dict = PyDict_New(); + self->wrapped = NULL; + self->weakreflist = NULL; - return -1; + return (PyObject *)self; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_new(PyTypeObject *type, PyObject *args, - PyObject *kwds) +static int WraptObjectProxy_raw_init(WraptObjectProxyObject *self, + PyObject *wrapped) { - WraptObjectProxyObject *self; + static PyObject *module_str = NULL; + static PyObject *doc_str = NULL; - self = (WraptObjectProxyObject *)type->tp_alloc(type, 0); + PyObject *object = NULL; - if (!self) - return NULL; + Py_INCREF(wrapped); + Py_XDECREF(self->wrapped); + self->wrapped = wrapped; - self->dict = PyDict_New(); - self->wrapped = NULL; - self->weakreflist = NULL; + if (!module_str) { +#if PY_MAJOR_VERSION >= 3 + module_str = PyUnicode_InternFromString("__module__"); +#else + module_str = PyString_InternFromString("__module__"); +#endif + } - return (PyObject *)self; -} + if (!doc_str) { +#if PY_MAJOR_VERSION >= 3 + doc_str = PyUnicode_InternFromString("__doc__"); +#else + doc_str = PyString_InternFromString("__doc__"); +#endif + } -/* ------------------------------------------------------------------------- */ + object = PyObject_GetAttr(wrapped, module_str); -static int WraptObjectProxy_raw_init(WraptObjectProxyObject *self, - PyObject *wrapped) -{ - static PyObject *module_str = NULL; - static PyObject *doc_str = NULL; - static PyObject *wrapped_factory_str = NULL; - - PyObject *object = NULL; - - // If wrapped is Py_None and we have a __wrapped_factory__ attribute - // then we defer initialization of the wrapped object until it is first needed. - - if (!wrapped_factory_str) - { - wrapped_factory_str = PyUnicode_InternFromString("__wrapped_factory__"); - } - - if (wrapped == Py_None) - { - PyObject *callback = NULL; - - callback = PyObject_GenericGetAttr((PyObject *)self, wrapped_factory_str); - - if (callback) - { - if (callback != Py_None) - { - Py_DECREF(callback); - return 0; - } - else - { - Py_DECREF(callback); - } + if (object) { + if (PyDict_SetItem(self->dict, module_str, object) == -1) { + Py_DECREF(object); + return -1; + } + Py_DECREF(object); } else - PyErr_Clear(); - } - - Py_INCREF(wrapped); - Py_XDECREF(self->wrapped); - self->wrapped = wrapped; - - if (!module_str) - { - module_str = PyUnicode_InternFromString("__module__"); - } - - if (!doc_str) - { - doc_str = PyUnicode_InternFromString("__doc__"); - } - - object = PyObject_GetAttr(wrapped, module_str); - - if (object) - { - if (PyDict_SetItem(self->dict, module_str, object) == -1) - { - Py_DECREF(object); - return -1; - } - Py_DECREF(object); - } - else - PyErr_Clear(); + PyErr_Clear(); - object = PyObject_GetAttr(wrapped, doc_str); + object = PyObject_GetAttr(wrapped, doc_str); - if (object) - { - if (PyDict_SetItem(self->dict, doc_str, object) == -1) - { - Py_DECREF(object); - return -1; + if (object) { + if (PyDict_SetItem(self->dict, doc_str, object) == -1) { + Py_DECREF(object); + return -1; + } + Py_DECREF(object); } - Py_DECREF(object); - } - else - PyErr_Clear(); + else + PyErr_Clear(); - return 0; + return 0; } /* ------------------------------------------------------------------------- */ -static int WraptObjectProxy_init(WraptObjectProxyObject *self, PyObject *args, - PyObject *kwds) +static int WraptObjectProxy_init(WraptObjectProxyObject *self, + PyObject *args, PyObject *kwds) { - PyObject *wrapped = NULL; + PyObject *wrapped = NULL; - char *const kwlist[] = {"wrapped", NULL}; + static char *kwlist[] = { "wrapped", NULL }; - if (!PyArg_ParseTupleAndKeywords(args, kwds, "O:ObjectProxy", kwlist, - &wrapped)) - { - return -1; - } + if (!PyArg_ParseTupleAndKeywords(args, kwds, "O:ObjectProxy", + kwlist, &wrapped)) { + return -1; + } - return WraptObjectProxy_raw_init(self, wrapped); + return WraptObjectProxy_raw_init(self, wrapped); } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_traverse(WraptObjectProxyObject *self, - visitproc visit, void *arg) + visitproc visit, void *arg) { - Py_VISIT(self->dict); - Py_VISIT(self->wrapped); + Py_VISIT(self->dict); + Py_VISIT(self->wrapped); - return 0; + return 0; } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_clear(WraptObjectProxyObject *self) { - Py_CLEAR(self->dict); - Py_CLEAR(self->wrapped); + Py_CLEAR(self->dict); + Py_CLEAR(self->wrapped); - return 0; + return 0; } /* ------------------------------------------------------------------------- */ static void WraptObjectProxy_dealloc(WraptObjectProxyObject *self) { - PyObject_GC_UnTrack(self); + PyObject_GC_UnTrack(self); - if (self->weakreflist != NULL) - PyObject_ClearWeakRefs((PyObject *)self); + if (self->weakreflist != NULL) + PyObject_ClearWeakRefs((PyObject *)self); - WraptObjectProxy_clear(self); + WraptObjectProxy_clear(self); - Py_TYPE(self)->tp_free(self); + Py_TYPE(self)->tp_free(self); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_repr(WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyUnicode_FromFormat("<%s at %p for %s at %p>", Py_TYPE(self)->tp_name, - self, Py_TYPE(self->wrapped)->tp_name, - self->wrapped); +#if PY_MAJOR_VERSION >= 3 + return PyUnicode_FromFormat("<%s at %p for %s at %p>", + Py_TYPE(self)->tp_name, self, + Py_TYPE(self->wrapped)->tp_name, self->wrapped); +#else + return PyString_FromFormat("<%s at %p for %s at %p>", + Py_TYPE(self)->tp_name, self, + Py_TYPE(self->wrapped)->tp_name, self->wrapped); +#endif } /* ------------------------------------------------------------------------- */ +#if PY_MAJOR_VERSION < 3 || (PY_MAJOR_VERSION == 3 && PY_MINOR_VERSION < 3) +typedef long Py_hash_t; +#endif + static Py_hash_t WraptObjectProxy_hash(WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return -1; - } + } - return PyObject_Hash(self->wrapped); + return PyObject_Hash(self->wrapped); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_str(WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyObject_Str(self->wrapped); + return PyObject_Str(self->wrapped); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_add(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o1)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) - return NULL; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o1)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } + + o1 = ((WraptObjectProxyObject *)o1)->wrapped; } - o1 = ((WraptObjectProxyObject *)o1)->wrapped; - } + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o2)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o2)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) - return NULL; + o2 = ((WraptObjectProxyObject *)o2)->wrapped; } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; - } - - return PyNumber_Add(o1, o2); + return PyNumber_Add(o1, o2); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_subtract(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o1)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) - return NULL; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o1)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } + + o1 = ((WraptObjectProxyObject *)o1)->wrapped; } - o1 = ((WraptObjectProxyObject *)o1)->wrapped; - } + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o2)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o2)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) - return NULL; + o2 = ((WraptObjectProxyObject *)o2)->wrapped; } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; - } - return PyNumber_Subtract(o1, o2); + return PyNumber_Subtract(o1, o2); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_multiply(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o1)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) - return NULL; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o1)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } + + o1 = ((WraptObjectProxyObject *)o1)->wrapped; } - o1 = ((WraptObjectProxyObject *)o1)->wrapped; - } + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o2)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o2)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) - return NULL; + o2 = ((WraptObjectProxyObject *)o2)->wrapped; + } + + return PyNumber_Multiply(o1, o2); +} + +/* ------------------------------------------------------------------------- */ + +#if PY_MAJOR_VERSION < 3 +static PyObject *WraptObjectProxy_divide(PyObject *o1, PyObject *o2) +{ + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o1)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } + + o1 = ((WraptObjectProxyObject *)o1)->wrapped; } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; - } + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o2)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } + + o2 = ((WraptObjectProxyObject *)o2)->wrapped; + } - return PyNumber_Multiply(o1, o2); + return PyNumber_Divide(o1, o2); } +#endif /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_remainder(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o1)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) - return NULL; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o1)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } + + o1 = ((WraptObjectProxyObject *)o1)->wrapped; } - o1 = ((WraptObjectProxyObject *)o1)->wrapped; - } + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o2)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o2)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) - return NULL; + o2 = ((WraptObjectProxyObject *)o2)->wrapped; } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; - } - - return PyNumber_Remainder(o1, o2); + return PyNumber_Remainder(o1, o2); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_divmod(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o1)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) - return NULL; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o1)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } + + o1 = ((WraptObjectProxyObject *)o1)->wrapped; } - o1 = ((WraptObjectProxyObject *)o1)->wrapped; - } + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o2)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o2)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) - return NULL; + o2 = ((WraptObjectProxyObject *)o2)->wrapped; } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; - } - - return PyNumber_Divmod(o1, o2); + return PyNumber_Divmod(o1, o2); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_power(PyObject *o1, PyObject *o2, - PyObject *modulo) + PyObject *modulo) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o1)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) - return NULL; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o1)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } + + o1 = ((WraptObjectProxyObject *)o1)->wrapped; } - o1 = ((WraptObjectProxyObject *)o1)->wrapped; - } + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o2)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o2)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) - return NULL; + o2 = ((WraptObjectProxyObject *)o2)->wrapped; } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; - } - - return PyNumber_Power(o1, o2, modulo); + return PyNumber_Power(o1, o2, modulo); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_negative(WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyNumber_Negative(self->wrapped); + return PyNumber_Negative(self->wrapped); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_positive(WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyNumber_Positive(self->wrapped); + return PyNumber_Positive(self->wrapped); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_absolute(WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyNumber_Absolute(self->wrapped); + return PyNumber_Absolute(self->wrapped); } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_bool(WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return -1; - } + } - return PyObject_IsTrue(self->wrapped); + return PyObject_IsTrue(self->wrapped); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_invert(WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyNumber_Invert(self->wrapped); + return PyNumber_Invert(self->wrapped); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_lshift(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o1)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) - return NULL; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o1)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } + + o1 = ((WraptObjectProxyObject *)o1)->wrapped; } - o1 = ((WraptObjectProxyObject *)o1)->wrapped; - } + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o2)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o2)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) - return NULL; + o2 = ((WraptObjectProxyObject *)o2)->wrapped; } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; - } - - return PyNumber_Lshift(o1, o2); + return PyNumber_Lshift(o1, o2); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_rshift(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o1)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) - return NULL; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o1)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } + + o1 = ((WraptObjectProxyObject *)o1)->wrapped; } - o1 = ((WraptObjectProxyObject *)o1)->wrapped; - } + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o2)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o2)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) - return NULL; + o2 = ((WraptObjectProxyObject *)o2)->wrapped; } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; - } - - return PyNumber_Rshift(o1, o2); + return PyNumber_Rshift(o1, o2); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_and(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o1)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) - return NULL; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o1)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } + + o1 = ((WraptObjectProxyObject *)o1)->wrapped; } - o1 = ((WraptObjectProxyObject *)o1)->wrapped; - } + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o2)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o2)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) - return NULL; + o2 = ((WraptObjectProxyObject *)o2)->wrapped; } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; - } - - return PyNumber_And(o1, o2); + return PyNumber_And(o1, o2); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_xor(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o1)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) - return NULL; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o1)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } + + o1 = ((WraptObjectProxyObject *)o1)->wrapped; } - o1 = ((WraptObjectProxyObject *)o1)->wrapped; - } + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o2)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o2)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) - return NULL; + o2 = ((WraptObjectProxyObject *)o2)->wrapped; } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; - } - - return PyNumber_Xor(o1, o2); + return PyNumber_Xor(o1, o2); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_or(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o1)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) - return NULL; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o1)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } + + o1 = ((WraptObjectProxyObject *)o1)->wrapped; } - o1 = ((WraptObjectProxyObject *)o1)->wrapped; - } + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o2)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o2)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) - return NULL; + o2 = ((WraptObjectProxyObject *)o2)->wrapped; } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; - } - - return PyNumber_Or(o1, o2); + return PyNumber_Or(o1, o2); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_long(WraptObjectProxyObject *self) +#if PY_MAJOR_VERSION < 3 +static PyObject *WraptObjectProxy_int(WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyNumber_Long(self->wrapped); + return PyNumber_Int(self->wrapped); } +#endif /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_float(WraptObjectProxyObject *self) +static PyObject *WraptObjectProxy_long(WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyNumber_Float(self->wrapped); + return PyNumber_Long(self->wrapped); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_inplace_add(WraptObjectProxyObject *self, - PyObject *other) +static PyObject *WraptObjectProxy_float(WraptObjectProxyObject *self) { - PyObject *object = NULL; - - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } - - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; - - if (PyObject_HasAttrString(self->wrapped, "__iadd__")) - { - object = PyNumber_InPlaceAdd(self->wrapped, other); + } - if (!object) - return NULL; + return PyNumber_Float(self->wrapped); +} - Py_DECREF(self->wrapped); - self->wrapped = object; +/* ------------------------------------------------------------------------- */ - Py_INCREF(self); - return (PyObject *)self; - } - else - { - PyObject *result = PyNumber_Add(self->wrapped, other); +#if PY_MAJOR_VERSION < 3 +static PyObject *WraptObjectProxy_oct(WraptObjectProxyObject *self) +{ + PyNumberMethods *nb; - if (!result) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; + } - PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); - - if (!proxy_type) - { - Py_DECREF(proxy_type); - return NULL; + if ((nb = self->wrapped->ob_type->tp_as_number) == NULL || + nb->nb_oct == NULL) { + PyErr_SetString(PyExc_TypeError, + "oct() argument can't be converted to oct"); + return NULL; } - PyObject *proxy_args = PyTuple_Pack(1, result); + return (*nb->nb_oct)(self->wrapped); +} +#endif + +/* ------------------------------------------------------------------------- */ - Py_DECREF(result); +#if PY_MAJOR_VERSION < 3 +static PyObject *WraptObjectProxy_hex(WraptObjectProxyObject *self) +{ + PyNumberMethods *nb; - if (!proxy_args) - { - Py_DECREF(proxy_type); + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; } - PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); - - Py_DECREF(proxy_type); - Py_DECREF(proxy_args); + if ((nb = self->wrapped->ob_type->tp_as_number) == NULL || + nb->nb_hex == NULL) { + PyErr_SetString(PyExc_TypeError, + "hex() argument can't be converted to hex"); + return NULL; + } - return proxy_instance; - } + return (*nb->nb_hex)(self->wrapped); } +#endif /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_inplace_subtract(WraptObjectProxyObject *self, - PyObject *other) +static PyObject *WraptObjectProxy_inplace_add(WraptObjectProxyObject *self, + PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; - if (PyObject_HasAttrString(self->wrapped, "__isub__")) - { - object = PyNumber_InPlaceSubtract(self->wrapped, other); + object = PyNumber_InPlaceAdd(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; - } - else - { - PyObject *result = PyNumber_Subtract(self->wrapped, other); +} - if (!result) - return NULL; +/* ------------------------------------------------------------------------- */ - PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); +static PyObject *WraptObjectProxy_inplace_subtract( + WraptObjectProxyObject *self, PyObject *other) +{ + PyObject *object = NULL; - if (!proxy_type) - { - Py_DECREF(proxy_type); + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; } - PyObject *proxy_args = PyTuple_Pack(1, result); + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; - Py_DECREF(result); - - if (!proxy_args) - { - Py_DECREF(proxy_type); - return NULL; - } + object = PyNumber_InPlaceSubtract(self->wrapped, other); - PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); + if (!object) + return NULL; - Py_DECREF(proxy_type); - Py_DECREF(proxy_args); + Py_DECREF(self->wrapped); + self->wrapped = object; - return proxy_instance; - } + Py_INCREF(self); + return (PyObject *)self; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_inplace_multiply(WraptObjectProxyObject *self, - PyObject *other) +static PyObject *WraptObjectProxy_inplace_multiply( + WraptObjectProxyObject *self, PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; - if (PyObject_HasAttrString(self->wrapped, "__imul__")) - { object = PyNumber_InPlaceMultiply(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; - } - else - { - PyObject *result = PyNumber_Multiply(self->wrapped, other); +} - if (!result) - return NULL; +/* ------------------------------------------------------------------------- */ - PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); +#if PY_MAJOR_VERSION < 3 +static PyObject *WraptObjectProxy_inplace_divide( + WraptObjectProxyObject *self, PyObject *other) +{ + PyObject *object = NULL; - if (!proxy_type) - { - Py_DECREF(proxy_type); + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; } - PyObject *proxy_args = PyTuple_Pack(1, result); - - Py_DECREF(result); + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; - if (!proxy_args) - { - Py_DECREF(proxy_type); - return NULL; - } + object = PyNumber_InPlaceDivide(self->wrapped, other); - PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); + if (!object) + return NULL; - Py_DECREF(proxy_type); - Py_DECREF(proxy_args); + Py_DECREF(self->wrapped); + self->wrapped = object; - return proxy_instance; - } + Py_INCREF(self); + return (PyObject *)self; } +#endif /* ------------------------------------------------------------------------- */ -static PyObject * -WraptObjectProxy_inplace_remainder(WraptObjectProxyObject *self, - PyObject *other) +static PyObject *WraptObjectProxy_inplace_remainder( + WraptObjectProxyObject *self, PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; - if (PyObject_HasAttrString(self->wrapped, "__imod__")) - { object = PyNumber_InPlaceRemainder(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; - } - else - { - PyObject *result = PyNumber_Remainder(self->wrapped, other); +} - if (!result) - return NULL; +/* ------------------------------------------------------------------------- */ - PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); +static PyObject *WraptObjectProxy_inplace_power(WraptObjectProxyObject *self, + PyObject *other, PyObject *modulo) +{ + PyObject *object = NULL; - if (!proxy_type) - { - Py_DECREF(proxy_type); + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; } - PyObject *proxy_args = PyTuple_Pack(1, result); + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; - Py_DECREF(result); - - if (!proxy_args) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); - - Py_DECREF(proxy_type); - Py_DECREF(proxy_args); - - return proxy_instance; - } -} - -/* ------------------------------------------------------------------------- */ - -static PyObject *WraptObjectProxy_inplace_power(WraptObjectProxyObject *self, - PyObject *other, - PyObject *modulo) -{ - PyObject *object = NULL; - - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) - return NULL; - } - - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; - - if (PyObject_HasAttrString(self->wrapped, "__ipow__")) - { - object = PyNumber_InPlacePower(self->wrapped, other, modulo); + object = PyNumber_InPlacePower(self->wrapped, other, modulo); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; - } - else - { - PyObject *result = PyNumber_Power(self->wrapped, other, modulo); - - if (!result) - return NULL; - - PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); - - if (!proxy_type) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_args = PyTuple_Pack(1, result); - - Py_DECREF(result); - - if (!proxy_args) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); - - Py_DECREF(proxy_type); - Py_DECREF(proxy_args); - - return proxy_instance; - } } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_inplace_lshift(WraptObjectProxyObject *self, - PyObject *other) + PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; - if (PyObject_HasAttrString(self->wrapped, "__ilshift__")) - { object = PyNumber_InPlaceLshift(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; - } - else - { - PyObject *result = PyNumber_Lshift(self->wrapped, other); - - if (!result) - return NULL; - - PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); - - if (!proxy_type) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_args = PyTuple_Pack(1, result); - - Py_DECREF(result); - - if (!proxy_args) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); - - Py_DECREF(proxy_type); - Py_DECREF(proxy_args); - - return proxy_instance; - } } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_inplace_rshift(WraptObjectProxyObject *self, - PyObject *other) + PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; - if (PyObject_HasAttrString(self->wrapped, "__irshift__")) - { object = PyNumber_InPlaceRshift(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; - } - else - { - PyObject *result = PyNumber_Rshift(self->wrapped, other); - - if (!result) - return NULL; - - PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); - - if (!proxy_type) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_args = PyTuple_Pack(1, result); - - Py_DECREF(result); - - if (!proxy_args) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); - - Py_DECREF(proxy_type); - Py_DECREF(proxy_args); - - return proxy_instance; - } } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_inplace_and(WraptObjectProxyObject *self, - PyObject *other) + PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; - if (PyObject_HasAttrString(self->wrapped, "__iand__")) - { object = PyNumber_InPlaceAnd(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; - } - else - { - PyObject *result = PyNumber_And(self->wrapped, other); - - if (!result) - return NULL; - - PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); - - if (!proxy_type) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_args = PyTuple_Pack(1, result); - - Py_DECREF(result); - - if (!proxy_args) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); - - Py_DECREF(proxy_type); - Py_DECREF(proxy_args); - - return proxy_instance; - } } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_inplace_xor(WraptObjectProxyObject *self, - PyObject *other) + PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; - if (PyObject_HasAttrString(self->wrapped, "__ixor__")) - { object = PyNumber_InPlaceXor(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; - } - else - { - PyObject *result = PyNumber_Xor(self->wrapped, other); - - if (!result) - return NULL; - - PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); - - if (!proxy_type) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_args = PyTuple_Pack(1, result); - - Py_DECREF(result); - - if (!proxy_args) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); - - Py_DECREF(proxy_type); - Py_DECREF(proxy_args); - - return proxy_instance; - } } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_inplace_or(WraptObjectProxyObject *self, - PyObject *other) + PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; - if (PyObject_HasAttrString(self->wrapped, "__ior__")) - { object = PyNumber_InPlaceOr(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; - } - else - { - PyObject *result = PyNumber_Or(self->wrapped, other); - - if (!result) - return NULL; - - PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); - - if (!proxy_type) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_args = PyTuple_Pack(1, result); - - Py_DECREF(result); - - if (!proxy_args) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); - - Py_DECREF(proxy_type); - Py_DECREF(proxy_args); - - return proxy_instance; - } } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_floor_divide(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o1)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) - return NULL; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o1)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } + + o1 = ((WraptObjectProxyObject *)o1)->wrapped; } - o1 = ((WraptObjectProxyObject *)o1)->wrapped; - } + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o2)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o2)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) - return NULL; + o2 = ((WraptObjectProxyObject *)o2)->wrapped; } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; - } - - return PyNumber_FloorDivide(o1, o2); + return PyNumber_FloorDivide(o1, o2); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_true_divide(PyObject *o1, PyObject *o2) { - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o1)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) - return NULL; + if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o1)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } + + o1 = ((WraptObjectProxyObject *)o1)->wrapped; } - o1 = ((WraptObjectProxyObject *)o1)->wrapped; - } + if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) { + if (!((WraptObjectProxyObject *)o2)->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o2)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) - return NULL; + o2 = ((WraptObjectProxyObject *)o2)->wrapped; } - o2 = ((WraptObjectProxyObject *)o2)->wrapped; - } - - return PyNumber_TrueDivide(o1, o2); + return PyNumber_TrueDivide(o1, o2); } /* ------------------------------------------------------------------------- */ -static PyObject * -WraptObjectProxy_inplace_floor_divide(WraptObjectProxyObject *self, - PyObject *other) +static PyObject *WraptObjectProxy_inplace_floor_divide( + WraptObjectProxyObject *self, PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; - if (PyObject_HasAttrString(self->wrapped, "__ifloordiv__")) - { object = PyNumber_InPlaceFloorDivide(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; - } - else - { - PyObject *result = PyNumber_FloorDivide(self->wrapped, other); - - if (!result) - return NULL; - - PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); - - if (!proxy_type) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_args = PyTuple_Pack(1, result); - - Py_DECREF(result); - - if (!proxy_args) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); - - Py_DECREF(proxy_type); - Py_DECREF(proxy_args); - - return proxy_instance; - } } /* ------------------------------------------------------------------------- */ -static PyObject * -WraptObjectProxy_inplace_true_divide(WraptObjectProxyObject *self, - PyObject *other) +static PyObject *WraptObjectProxy_inplace_true_divide( + WraptObjectProxyObject *self, PyObject *other) { - PyObject *object = NULL; + PyObject *object = NULL; - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; + if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) + other = ((WraptObjectProxyObject *)other)->wrapped; - if (PyObject_HasAttrString(self->wrapped, "__itruediv__")) - { object = PyNumber_InPlaceTrueDivide(self->wrapped, other); if (!object) - return NULL; + return NULL; Py_DECREF(self->wrapped); self->wrapped = object; Py_INCREF(self); return (PyObject *)self; - } - else - { - PyObject *result = PyNumber_TrueDivide(self->wrapped, other); - - if (!result) - return NULL; - - PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); - - if (!proxy_type) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_args = PyTuple_Pack(1, result); - - Py_DECREF(result); - - if (!proxy_args) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); - - Py_DECREF(proxy_type); - Py_DECREF(proxy_args); - - return proxy_instance; - } } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_index(WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } - - return PyNumber_Index(self->wrapped); -} - -/* ------------------------------------------------------------------------- */ - -static PyObject *WraptObjectProxy_matrix_multiply(PyObject *o1, PyObject *o2) -{ - if (PyObject_IsInstance(o1, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o1)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o1) == -1) - return NULL; } - o1 = ((WraptObjectProxyObject *)o1)->wrapped; - } - - if (PyObject_IsInstance(o2, (PyObject *)&WraptObjectProxy_Type)) - { - if (!((WraptObjectProxyObject *)o2)->wrapped) - { - if (raise_uninitialized_wrapper_error((WraptObjectProxyObject *)o2) == -1) - return NULL; - } - - o2 = ((WraptObjectProxyObject *)o2)->wrapped; - } - - return PyNumber_MatrixMultiply(o1, o2); -} - -/* ------------------------------------------------------------------------- */ - -static PyObject *WraptObjectProxy_inplace_matrix_multiply( - WraptObjectProxyObject *self, PyObject *other) -{ - PyObject *object = NULL; - - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) - return NULL; - } - - if (PyObject_IsInstance(other, (PyObject *)&WraptObjectProxy_Type)) - other = ((WraptObjectProxyObject *)other)->wrapped; - - if (PyObject_HasAttrString(self->wrapped, "__imatmul__")) - { - object = PyNumber_InPlaceMatrixMultiply(self->wrapped, other); - - if (!object) - return NULL; - - Py_DECREF(self->wrapped); - self->wrapped = object; - - Py_INCREF(self); - return (PyObject *)self; - } - else - { - PyObject *result = PyNumber_MatrixMultiply(self->wrapped, other); - - if (!result) - return NULL; - - PyObject *proxy_type = PyObject_GetAttrString((PyObject *)self, "__object_proxy__"); - - if (!proxy_type) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_args = PyTuple_Pack(1, result); - - Py_DECREF(result); - - if (!proxy_args) - { - Py_DECREF(proxy_type); - return NULL; - } - - PyObject *proxy_instance = PyObject_Call(proxy_type, proxy_args, NULL); - - Py_DECREF(proxy_type); - Py_DECREF(proxy_args); - - return proxy_instance; - } + return PyNumber_Index(self->wrapped); } /* ------------------------------------------------------------------------- */ static Py_ssize_t WraptObjectProxy_length(WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return -1; - } + } - return PyObject_Length(self->wrapped); + return PyObject_Length(self->wrapped); } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_contains(WraptObjectProxyObject *self, - PyObject *value) + PyObject *value) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return -1; - } + } - return PySequence_Contains(self->wrapped, value); + return PySequence_Contains(self->wrapped, value); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_getitem(WraptObjectProxyObject *self, - PyObject *key) + PyObject *key) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyObject_GetItem(self->wrapped, key); + return PyObject_GetItem(self->wrapped, key); } /* ------------------------------------------------------------------------- */ -static int WraptObjectProxy_setitem(WraptObjectProxyObject *self, PyObject *key, - PyObject *value) +static int WraptObjectProxy_setitem(WraptObjectProxyObject *self, + PyObject *key, PyObject* value) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return -1; - } + } - if (value == NULL) - return PyObject_DelItem(self->wrapped, key); - else - return PyObject_SetItem(self->wrapped, key, value); + if (value == NULL) + return PyObject_DelItem(self->wrapped, key); + else + return PyObject_SetItem(self->wrapped, key, value); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_self_setattr(WraptObjectProxyObject *self, - PyObject *args) +static PyObject *WraptObjectProxy_self_setattr( + WraptObjectProxyObject *self, PyObject *args) { - PyObject *name = NULL; - PyObject *value = NULL; + PyObject *name = NULL; + PyObject *value = NULL; - if (!PyArg_ParseTuple(args, "UO:__self_setattr__", &name, &value)) - return NULL; +#if PY_MAJOR_VERSION >= 3 + if (!PyArg_ParseTuple(args, "UO:__self_setattr__", &name, &value)) + return NULL; +#else + if (!PyArg_ParseTuple(args, "SO:__self_setattr__", &name, &value)) + return NULL; +#endif - if (PyObject_GenericSetAttr((PyObject *)self, name, value) != 0) - { - return NULL; - } + if (PyObject_GenericSetAttr((PyObject *)self, name, value) != 0) { + return NULL; + } - Py_INCREF(Py_None); - return Py_None; + Py_INCREF(Py_None); + return Py_None; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_dir(WraptObjectProxyObject *self, - PyObject *args) +static PyObject *WraptObjectProxy_dir( + WraptObjectProxyObject *self, PyObject *args) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyObject_Dir(self->wrapped); + return PyObject_Dir(self->wrapped); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_enter(WraptObjectProxyObject *self, - PyObject *args, PyObject *kwds) +static PyObject *WraptObjectProxy_enter( + WraptObjectProxyObject *self, PyObject *args, PyObject *kwds) { - PyObject *method = NULL; - PyObject *result = NULL; + PyObject *method = NULL; + PyObject *result = NULL; - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - method = PyObject_GetAttrString(self->wrapped, "__enter__"); + method = PyObject_GetAttrString(self->wrapped, "__enter__"); - if (!method) - return NULL; + if (!method) + return NULL; - result = PyObject_Call(method, args, kwds); + result = PyObject_Call(method, args, kwds); - Py_DECREF(method); + Py_DECREF(method); - return result; + return result; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_exit(WraptObjectProxyObject *self, - PyObject *args, PyObject *kwds) +static PyObject *WraptObjectProxy_exit( + WraptObjectProxyObject *self, PyObject *args, PyObject *kwds) { - PyObject *method = NULL; - PyObject *result = NULL; + PyObject *method = NULL; + PyObject *result = NULL; - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - method = PyObject_GetAttrString(self->wrapped, "__exit__"); + method = PyObject_GetAttrString(self->wrapped, "__exit__"); - if (!method) - return NULL; + if (!method) + return NULL; - result = PyObject_Call(method, args, kwds); + result = PyObject_Call(method, args, kwds); - Py_DECREF(method); + Py_DECREF(method); - return result; + return result; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_aenter(WraptObjectProxyObject *self, - PyObject *args, PyObject *kwds) +static PyObject *WraptObjectProxy_copy( + WraptObjectProxyObject *self, PyObject *args, PyObject *kwds) { - PyObject *method = NULL; - PyObject *result = NULL; - - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) - return NULL; - } + PyErr_SetString(PyExc_NotImplementedError, + "object proxy must define __copy__()"); - method = PyObject_GetAttrString(self->wrapped, "__aenter__"); - - if (!method) return NULL; - - result = PyObject_Call(method, args, kwds); - - Py_DECREF(method); - - return result; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_aexit(WraptObjectProxyObject *self, - PyObject *args, PyObject *kwds) +static PyObject *WraptObjectProxy_deepcopy( + WraptObjectProxyObject *self, PyObject *args, PyObject *kwds) { - PyObject *method = NULL; - PyObject *result = NULL; - - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) - return NULL; - } + PyErr_SetString(PyExc_NotImplementedError, + "object proxy must define __deepcopy__()"); - method = PyObject_GetAttrString(self->wrapped, "__aexit__"); - - if (!method) return NULL; - - result = PyObject_Call(method, args, kwds); - - Py_DECREF(method); - - return result; -} - -/* ------------------------------------------------------------------------- */ - -static PyObject *WraptObjectProxy_copy(WraptObjectProxyObject *self, - PyObject *args, PyObject *kwds) -{ - PyErr_SetString(PyExc_NotImplementedError, - "object proxy must define __copy__()"); - - return NULL; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_deepcopy(WraptObjectProxyObject *self, - PyObject *args, PyObject *kwds) +static PyObject *WraptObjectProxy_reduce( + WraptObjectProxyObject *self, PyObject *args, PyObject *kwds) { - PyErr_SetString(PyExc_NotImplementedError, - "object proxy must define __deepcopy__()"); - - return NULL; -} + PyErr_SetString(PyExc_NotImplementedError, + "object proxy must define __reduce_ex__()"); -/* ------------------------------------------------------------------------- */ - -static PyObject *WraptObjectProxy_reduce(WraptObjectProxyObject *self, - PyObject *args, PyObject *kwds) -{ - PyErr_SetString(PyExc_NotImplementedError, - "object proxy must define __reduce__()"); - - return NULL; -} - -/* ------------------------------------------------------------------------- */ - -static PyObject *WraptObjectProxy_reduce_ex(WraptObjectProxyObject *self, - PyObject *args, PyObject *kwds) -{ - PyErr_SetString(PyExc_NotImplementedError, - "object proxy must define __reduce_ex__()"); - - return NULL; + return NULL; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_bytes(WraptObjectProxyObject *self, - PyObject *args) +static PyObject *WraptObjectProxy_reduce_ex( + WraptObjectProxyObject *self, PyObject *args, PyObject *kwds) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) - return NULL; - } + PyErr_SetString(PyExc_NotImplementedError, + "object proxy must define __reduce_ex__()"); - return PyObject_Bytes(self->wrapped); + return NULL; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_format(WraptObjectProxyObject *self, - PyObject *args) +static PyObject *WraptObjectProxy_bytes( + WraptObjectProxyObject *self, PyObject *args) { - PyObject *format_spec = NULL; - - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } - - if (!PyArg_ParseTuple(args, "|O:format", &format_spec)) - return NULL; + } - return PyObject_Format(self->wrapped, format_spec); + return PyObject_Bytes(self->wrapped); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_reversed(WraptObjectProxyObject *self, - PyObject *args) +static PyObject *WraptObjectProxy_reversed( + WraptObjectProxyObject *self, PyObject *args) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyObject_CallFunctionObjArgs((PyObject *)&PyReversed_Type, - self->wrapped, NULL); + return PyObject_CallFunctionObjArgs((PyObject *)&PyReversed_Type, + self->wrapped, NULL); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_round(WraptObjectProxyObject *self, - PyObject *args, PyObject *kwds) +#if PY_MAJOR_VERSION >= 3 +static PyObject *WraptObjectProxy_round( + WraptObjectProxyObject *self, PyObject *args) { - PyObject *ndigits = NULL; + PyObject *module = NULL; + PyObject *dict = NULL; + PyObject *round = NULL; - PyObject *module = NULL; - PyObject *round = NULL; - - PyObject *result = NULL; - - char *const kwlist[] = {"ndigits", NULL}; + PyObject *result = NULL; - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - if (!PyArg_ParseTupleAndKeywords(args, kwds, "|O:ObjectProxy", kwlist, - &ndigits)) - { - return NULL; - } + module = PyImport_ImportModule("builtins"); - module = PyImport_ImportModule("builtins"); + if (!module) + return NULL; - if (!module) - return NULL; + dict = PyModule_GetDict(module); + round = PyDict_GetItemString(dict, "round"); - round = PyObject_GetAttrString(module, "round"); + if (!round) { + Py_DECREF(module); + return NULL; + } - if (!round) - { + Py_INCREF(round); Py_DECREF(module); - return NULL; - } - - Py_INCREF(round); - Py_DECREF(module); - result = PyObject_CallFunctionObjArgs(round, self->wrapped, ndigits, NULL); + result = PyObject_CallFunctionObjArgs(round, self->wrapped, NULL); - Py_DECREF(round); + Py_DECREF(round); - return result; + return result; } +#endif /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_complex(WraptObjectProxyObject *self, - PyObject *args) +static PyObject *WraptObjectProxy_complex( + WraptObjectProxyObject *self, PyObject *args) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyObject_CallFunctionObjArgs((PyObject *)&PyComplex_Type, - self->wrapped, NULL); + return PyObject_CallFunctionObjArgs((PyObject *)&PyComplex_Type, + self->wrapped, NULL); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_mro_entries(WraptObjectProxyObject *self, - PyObject *args, PyObject *kwds) +static PyObject *WraptObjectProxy_mro_entries( + WraptObjectProxyObject *self, PyObject *args, PyObject *kwds) { - PyObject *wrapped = NULL; - PyObject *mro_entries_method = NULL; - PyObject *result = NULL; - int is_type = 0; - - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } - - wrapped = self->wrapped; - - // Check if wrapped is a type (class). - - is_type = PyType_Check(wrapped); - - // If wrapped is not a type and has __mro_entries__, forward to it. - - if (!is_type) - { - mro_entries_method = PyObject_GetAttrString(wrapped, "__mro_entries__"); - - if (mro_entries_method) - { - // Call wrapped.__mro_entries__(bases). - - result = PyObject_Call(mro_entries_method, args, kwds); - - Py_DECREF(mro_entries_method); - - return result; } - else - { - PyErr_Clear(); - } - } - return Py_BuildValue("(O)", wrapped); + return Py_BuildValue("(O)", self->wrapped); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_get_name(WraptObjectProxyObject *self) +static PyObject *WraptObjectProxy_get_name( + WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyObject_GetAttrString(self->wrapped, "__name__"); + return PyObject_GetAttrString(self->wrapped, "__name__"); } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_set_name(WraptObjectProxyObject *self, - PyObject *value) + PyObject *value) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return -1; - } + } - return PyObject_SetAttrString(self->wrapped, "__name__", value); + return PyObject_SetAttrString(self->wrapped, "__name__", value); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_get_qualname(WraptObjectProxyObject *self) +static PyObject *WraptObjectProxy_get_qualname( + WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyObject_GetAttrString(self->wrapped, "__qualname__"); + return PyObject_GetAttrString(self->wrapped, "__qualname__"); } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_set_qualname(WraptObjectProxyObject *self, - PyObject *value) + PyObject *value) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return -1; - } + } - return PyObject_SetAttrString(self->wrapped, "__qualname__", value); + return PyObject_SetAttrString(self->wrapped, "__qualname__", value); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_get_module(WraptObjectProxyObject *self) +static PyObject *WraptObjectProxy_get_module( + WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyObject_GetAttrString(self->wrapped, "__module__"); + return PyObject_GetAttrString(self->wrapped, "__module__"); } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_set_module(WraptObjectProxyObject *self, - PyObject *value) + PyObject *value) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return -1; - } + } - if (PyObject_SetAttrString(self->wrapped, "__module__", value) == -1) - return -1; + if (PyObject_SetAttrString(self->wrapped, "__module__", value) == -1) + return -1; - return PyDict_SetItemString(self->dict, "__module__", value); + return PyDict_SetItemString(self->dict, "__module__", value); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_get_doc(WraptObjectProxyObject *self) +static PyObject *WraptObjectProxy_get_doc( + WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyObject_GetAttrString(self->wrapped, "__doc__"); + return PyObject_GetAttrString(self->wrapped, "__doc__"); } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_set_doc(WraptObjectProxyObject *self, - PyObject *value) + PyObject *value) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return -1; - } + } - if (PyObject_SetAttrString(self->wrapped, "__doc__", value) == -1) - return -1; + if (PyObject_SetAttrString(self->wrapped, "__doc__", value) == -1) + return -1; - return PyDict_SetItemString(self->dict, "__doc__", value); + return PyDict_SetItemString(self->dict, "__doc__", value); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_get_class(WraptObjectProxyObject *self) +static PyObject *WraptObjectProxy_get_class( + WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyObject_GetAttrString(self->wrapped, "__class__"); + return PyObject_GetAttrString(self->wrapped, "__class__"); } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_set_class(WraptObjectProxyObject *self, - PyObject *value) + PyObject *value) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return -1; - } + } - return PyObject_SetAttrString(self->wrapped, "__class__", value); + return PyObject_SetAttrString(self->wrapped, "__class__", value); } /* ------------------------------------------------------------------------- */ -static PyObject * -WraptObjectProxy_get_annotations(WraptObjectProxyObject *self) +static PyObject *WraptObjectProxy_get_annotations( + WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyObject_GetAttrString(self->wrapped, "__annotations__"); + return PyObject_GetAttrString(self->wrapped, "__annotations__"); } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_set_annotations(WraptObjectProxyObject *self, - PyObject *value) + PyObject *value) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return -1; - } + } - return PyObject_SetAttrString(self->wrapped, "__annotations__", value); + return PyObject_SetAttrString(self->wrapped, "__annotations__", value); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_get_wrapped(WraptObjectProxyObject *self) +static PyObject *WraptObjectProxy_get_wrapped( + WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } - - Py_INCREF(self->wrapped); - return self->wrapped; -} - -/* ------------------------------------------------------------------------- */ + } -static PyObject *WraptObjectProxy_get_object_proxy(WraptObjectProxyObject *self) -{ - Py_INCREF(&WraptObjectProxy_Type); - return (PyObject *)&WraptObjectProxy_Type; + Py_INCREF(self->wrapped); + return self->wrapped; } /* ------------------------------------------------------------------------- */ static int WraptObjectProxy_set_wrapped(WraptObjectProxyObject *self, - PyObject *value) + PyObject *value) { - static PyObject *fixups_str = NULL; - - PyObject *fixups = NULL; - - if (!value) - { - PyErr_SetString(PyExc_TypeError, "__wrapped__ must be an object"); - return -1; - } - - Py_INCREF(value); - Py_XDECREF(self->wrapped); - - self->wrapped = value; - - if (!fixups_str) - { - fixups_str = PyUnicode_InternFromString("__wrapped_setattr_fixups__"); - } - - fixups = PyObject_GetAttr((PyObject *)self, fixups_str); - - if (fixups) - { - PyObject *result = NULL; - - result = PyObject_CallObject(fixups, NULL); - Py_DECREF(fixups); + if (!value) { + PyErr_SetString(PyExc_TypeError, "__wrapped__ must be an object"); + return -1; + } - if (!result) - return -1; + Py_INCREF(value); + Py_XDECREF(self->wrapped); - Py_DECREF(result); - } - else - PyErr_Clear(); + self->wrapped = value; - return 0; + return 0; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_getattro(WraptObjectProxyObject *self, - PyObject *name) +static PyObject *WraptObjectProxy_getattro( + WraptObjectProxyObject *self, PyObject *name) { - PyObject *object = NULL; - PyObject *result = NULL; + PyObject *object = NULL; + PyObject *result = NULL; - static PyObject *getattr_str = NULL; + static PyObject *getattr_str = NULL; - object = PyObject_GenericGetAttr((PyObject *)self, name); + object = PyObject_GenericGetAttr((PyObject *)self, name); - if (object) - return object; + if (object) + return object; - if (!PyErr_ExceptionMatches(PyExc_AttributeError)) - return NULL; + if (!PyErr_ExceptionMatches(PyExc_AttributeError)) + return NULL; - PyErr_Clear(); + PyErr_Clear(); - if (!getattr_str) - { - getattr_str = PyUnicode_InternFromString("__getattr__"); - } + if (!getattr_str) { +#if PY_MAJOR_VERSION >= 3 + getattr_str = PyUnicode_InternFromString("__getattr__"); +#else + getattr_str = PyString_InternFromString("__getattr__"); +#endif + } - object = PyObject_GenericGetAttr((PyObject *)self, getattr_str); + object = PyObject_GenericGetAttr((PyObject *)self, getattr_str); - if (!object) - return NULL; + if (!object) + return NULL; - result = PyObject_CallFunctionObjArgs(object, name, NULL); + result = PyObject_CallFunctionObjArgs(object, name, NULL); - Py_DECREF(object); + Py_DECREF(object); - return result; + return result; } /* ------------------------------------------------------------------------- */ -static PyObject *WraptObjectProxy_getattr(WraptObjectProxyObject *self, - PyObject *args) +static PyObject *WraptObjectProxy_getattr( + WraptObjectProxyObject *self, PyObject *args) { - PyObject *name = NULL; + PyObject *name = NULL; - if (!PyArg_ParseTuple(args, "U:__getattr__", &name)) - return NULL; +#if PY_MAJOR_VERSION >= 3 + if (!PyArg_ParseTuple(args, "U:__getattr__", &name)) + return NULL; +#else + if (!PyArg_ParseTuple(args, "S:__getattr__", &name)) + return NULL; +#endif - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyObject_GetAttr(self->wrapped, name); + return PyObject_GetAttr(self->wrapped, name); } /* ------------------------------------------------------------------------- */ -static int WraptObjectProxy_setattro(WraptObjectProxyObject *self, - PyObject *name, PyObject *value) +static int WraptObjectProxy_setattro( + WraptObjectProxyObject *self, PyObject *name, PyObject *value) { - static PyObject *self_str = NULL; - static PyObject *startswith_str = NULL; + static PyObject *self_str = NULL; + static PyObject *wrapped_str = NULL; + static PyObject *startswith_str = NULL; - PyObject *match = NULL; + PyObject *match = NULL; + + if (!startswith_str) { +#if PY_MAJOR_VERSION >= 3 + startswith_str = PyUnicode_InternFromString("startswith"); +#else + startswith_str = PyString_InternFromString("startswith"); +#endif + } - if (!startswith_str) - { - startswith_str = PyUnicode_InternFromString("startswith"); - } + if (!self_str) { +#if PY_MAJOR_VERSION >= 3 + self_str = PyUnicode_InternFromString("_self_"); +#else + self_str = PyString_InternFromString("_self_"); +#endif + } - if (!self_str) - { - self_str = PyUnicode_InternFromString("_self_"); - } + match = PyObject_CallMethodObjArgs(name, startswith_str, self_str, NULL); - match = PyObject_CallMethodObjArgs(name, startswith_str, self_str, NULL); + if (match == Py_True) { + Py_DECREF(match); - if (match == Py_True) - { - Py_DECREF(match); + return PyObject_GenericSetAttr((PyObject *)self, name, value); + } + else if (!match) + PyErr_Clear(); - return PyObject_GenericSetAttr((PyObject *)self, name, value); - } - else if (!match) - PyErr_Clear(); + Py_XDECREF(match); - Py_XDECREF(match); + if (!wrapped_str) { +#if PY_MAJOR_VERSION >= 3 + wrapped_str = PyUnicode_InternFromString("__wrapped__"); +#else + wrapped_str = PyString_InternFromString("__wrapped__"); +#endif + } - if (PyObject_HasAttr((PyObject *)Py_TYPE(self), name)) - return PyObject_GenericSetAttr((PyObject *)self, name, value); + if (PyObject_HasAttr((PyObject *)Py_TYPE(self), name)) + return PyObject_GenericSetAttr((PyObject *)self, name, value); - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return -1; - } + } - return PyObject_SetAttr(self->wrapped, name, value); + return PyObject_SetAttr(self->wrapped, name, value); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_richcompare(WraptObjectProxyObject *self, - PyObject *other, int opcode) + PyObject *other, int opcode) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyObject_RichCompare(self->wrapped, other, opcode); + return PyObject_RichCompare(self->wrapped, other, opcode); } /* ------------------------------------------------------------------------- */ static PyObject *WraptObjectProxy_iter(WraptObjectProxyObject *self) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyObject_GetIter(self->wrapped); + return PyObject_GetIter(self->wrapped); } /* ------------------------------------------------------------------------- */ static PyNumberMethods WraptObjectProxy_as_number = { - (binaryfunc)WraptObjectProxy_add, /*nb_add*/ - (binaryfunc)WraptObjectProxy_subtract, /*nb_subtract*/ - (binaryfunc)WraptObjectProxy_multiply, /*nb_multiply*/ - (binaryfunc)WraptObjectProxy_remainder, /*nb_remainder*/ - (binaryfunc)WraptObjectProxy_divmod, /*nb_divmod*/ - (ternaryfunc)WraptObjectProxy_power, /*nb_power*/ - (unaryfunc)WraptObjectProxy_negative, /*nb_negative*/ - (unaryfunc)WraptObjectProxy_positive, /*nb_positive*/ - (unaryfunc)WraptObjectProxy_absolute, /*nb_absolute*/ - (inquiry)WraptObjectProxy_bool, /*nb_nonzero/nb_bool*/ - (unaryfunc)WraptObjectProxy_invert, /*nb_invert*/ - (binaryfunc)WraptObjectProxy_lshift, /*nb_lshift*/ - (binaryfunc)WraptObjectProxy_rshift, /*nb_rshift*/ - (binaryfunc)WraptObjectProxy_and, /*nb_and*/ - (binaryfunc)WraptObjectProxy_xor, /*nb_xor*/ - (binaryfunc)WraptObjectProxy_or, /*nb_or*/ - (unaryfunc)WraptObjectProxy_long, /*nb_int*/ - 0, /*nb_long/nb_reserved*/ - (unaryfunc)WraptObjectProxy_float, /*nb_float*/ - (binaryfunc)WraptObjectProxy_inplace_add, /*nb_inplace_add*/ - (binaryfunc)WraptObjectProxy_inplace_subtract, /*nb_inplace_subtract*/ - (binaryfunc)WraptObjectProxy_inplace_multiply, /*nb_inplace_multiply*/ + (binaryfunc)WraptObjectProxy_add, /*nb_add*/ + (binaryfunc)WraptObjectProxy_subtract, /*nb_subtract*/ + (binaryfunc)WraptObjectProxy_multiply, /*nb_multiply*/ +#if PY_MAJOR_VERSION < 3 + (binaryfunc)WraptObjectProxy_divide, /*nb_divide*/ +#endif + (binaryfunc)WraptObjectProxy_remainder, /*nb_remainder*/ + (binaryfunc)WraptObjectProxy_divmod, /*nb_divmod*/ + (ternaryfunc)WraptObjectProxy_power, /*nb_power*/ + (unaryfunc)WraptObjectProxy_negative, /*nb_negative*/ + (unaryfunc)WraptObjectProxy_positive, /*nb_positive*/ + (unaryfunc)WraptObjectProxy_absolute, /*nb_absolute*/ + (inquiry)WraptObjectProxy_bool, /*nb_nonzero/nb_bool*/ + (unaryfunc)WraptObjectProxy_invert, /*nb_invert*/ + (binaryfunc)WraptObjectProxy_lshift, /*nb_lshift*/ + (binaryfunc)WraptObjectProxy_rshift, /*nb_rshift*/ + (binaryfunc)WraptObjectProxy_and, /*nb_and*/ + (binaryfunc)WraptObjectProxy_xor, /*nb_xor*/ + (binaryfunc)WraptObjectProxy_or, /*nb_or*/ +#if PY_MAJOR_VERSION < 3 + 0, /*nb_coerce*/ +#endif +#if PY_MAJOR_VERSION < 3 + (unaryfunc)WraptObjectProxy_int, /*nb_int*/ + (unaryfunc)WraptObjectProxy_long, /*nb_long*/ +#else + (unaryfunc)WraptObjectProxy_long, /*nb_int*/ + 0, /*nb_long/nb_reserved*/ +#endif + (unaryfunc)WraptObjectProxy_float, /*nb_float*/ +#if PY_MAJOR_VERSION < 3 + (unaryfunc)WraptObjectProxy_oct, /*nb_oct*/ + (unaryfunc)WraptObjectProxy_hex, /*nb_hex*/ +#endif + (binaryfunc)WraptObjectProxy_inplace_add, /*nb_inplace_add*/ + (binaryfunc)WraptObjectProxy_inplace_subtract, /*nb_inplace_subtract*/ + (binaryfunc)WraptObjectProxy_inplace_multiply, /*nb_inplace_multiply*/ +#if PY_MAJOR_VERSION < 3 + (binaryfunc)WraptObjectProxy_inplace_divide, /*nb_inplace_divide*/ +#endif (binaryfunc)WraptObjectProxy_inplace_remainder, /*nb_inplace_remainder*/ - (ternaryfunc)WraptObjectProxy_inplace_power, /*nb_inplace_power*/ - (binaryfunc)WraptObjectProxy_inplace_lshift, /*nb_inplace_lshift*/ - (binaryfunc)WraptObjectProxy_inplace_rshift, /*nb_inplace_rshift*/ - (binaryfunc)WraptObjectProxy_inplace_and, /*nb_inplace_and*/ - (binaryfunc)WraptObjectProxy_inplace_xor, /*nb_inplace_xor*/ - (binaryfunc)WraptObjectProxy_inplace_or, /*nb_inplace_or*/ - (binaryfunc)WraptObjectProxy_floor_divide, /*nb_floor_divide*/ - (binaryfunc)WraptObjectProxy_true_divide, /*nb_true_divide*/ - (binaryfunc) - WraptObjectProxy_inplace_floor_divide, /*nb_inplace_floor_divide*/ - (binaryfunc)WraptObjectProxy_inplace_true_divide, /*nb_inplace_true_divide*/ - (unaryfunc)WraptObjectProxy_index, /*nb_index*/ - (binaryfunc)WraptObjectProxy_matrix_multiply, /*nb_matrix_multiply*/ - (binaryfunc)WraptObjectProxy_inplace_matrix_multiply, /*nb_inplace_matrix_multiply*/ + (ternaryfunc)WraptObjectProxy_inplace_power, /*nb_inplace_power*/ + (binaryfunc)WraptObjectProxy_inplace_lshift, /*nb_inplace_lshift*/ + (binaryfunc)WraptObjectProxy_inplace_rshift, /*nb_inplace_rshift*/ + (binaryfunc)WraptObjectProxy_inplace_and, /*nb_inplace_and*/ + (binaryfunc)WraptObjectProxy_inplace_xor, /*nb_inplace_xor*/ + (binaryfunc)WraptObjectProxy_inplace_or, /*nb_inplace_or*/ + (binaryfunc)WraptObjectProxy_floor_divide, /*nb_floor_divide*/ + (binaryfunc)WraptObjectProxy_true_divide, /*nb_true_divide*/ + (binaryfunc)WraptObjectProxy_inplace_floor_divide, /*nb_inplace_floor_divide*/ + (binaryfunc)WraptObjectProxy_inplace_true_divide, /*nb_inplace_true_divide*/ + (unaryfunc)WraptObjectProxy_index, /*nb_index*/ }; static PySequenceMethods WraptObjectProxy_as_sequence = { - (lenfunc)WraptObjectProxy_length, /*sq_length*/ - 0, /*sq_concat*/ - 0, /*sq_repeat*/ - 0, /*sq_item*/ - 0, /*sq_slice*/ - 0, /*sq_ass_item*/ - 0, /*sq_ass_slice*/ + (lenfunc)WraptObjectProxy_length, /*sq_length*/ + 0, /*sq_concat*/ + 0, /*sq_repeat*/ + 0, /*sq_item*/ + 0, /*sq_slice*/ + 0, /*sq_ass_item*/ + 0, /*sq_ass_slice*/ (objobjproc)WraptObjectProxy_contains, /* sq_contains */ }; static PyMappingMethods WraptObjectProxy_as_mapping = { - (lenfunc)WraptObjectProxy_length, /*mp_length*/ - (binaryfunc)WraptObjectProxy_getitem, /*mp_subscript*/ + (lenfunc)WraptObjectProxy_length, /*mp_length*/ + (binaryfunc)WraptObjectProxy_getitem, /*mp_subscript*/ (objobjargproc)WraptObjectProxy_setitem, /*mp_ass_subscript*/ }; static PyMethodDef WraptObjectProxy_methods[] = { - {"__self_setattr__", (PyCFunction)WraptObjectProxy_self_setattr, - METH_VARARGS, 0}, - {"__dir__", (PyCFunction)WraptObjectProxy_dir, METH_NOARGS, 0}, - {"__enter__", (PyCFunction)WraptObjectProxy_enter, - METH_VARARGS | METH_KEYWORDS, 0}, - {"__exit__", (PyCFunction)WraptObjectProxy_exit, - METH_VARARGS | METH_KEYWORDS, 0}, - {"__aenter__", (PyCFunction)WraptObjectProxy_aenter, - METH_VARARGS | METH_KEYWORDS, 0}, - {"__aexit__", (PyCFunction)WraptObjectProxy_aexit, - METH_VARARGS | METH_KEYWORDS, 0}, - {"__copy__", (PyCFunction)WraptObjectProxy_copy, METH_NOARGS, 0}, - {"__deepcopy__", (PyCFunction)WraptObjectProxy_deepcopy, - METH_VARARGS | METH_KEYWORDS, 0}, - {"__reduce__", (PyCFunction)WraptObjectProxy_reduce, METH_NOARGS, 0}, - {"__reduce_ex__", (PyCFunction)WraptObjectProxy_reduce_ex, - METH_VARARGS | METH_KEYWORDS, 0}, - {"__getattr__", (PyCFunction)WraptObjectProxy_getattr, METH_VARARGS, 0}, - {"__bytes__", (PyCFunction)WraptObjectProxy_bytes, METH_NOARGS, 0}, - {"__format__", (PyCFunction)WraptObjectProxy_format, METH_VARARGS, 0}, - {"__reversed__", (PyCFunction)WraptObjectProxy_reversed, METH_NOARGS, 0}, - {"__round__", (PyCFunction)WraptObjectProxy_round, - METH_VARARGS | METH_KEYWORDS, 0}, - {"__complex__", (PyCFunction)WraptObjectProxy_complex, METH_NOARGS, 0}, - {"__mro_entries__", (PyCFunction)WraptObjectProxy_mro_entries, - METH_VARARGS | METH_KEYWORDS, 0}, - {NULL, NULL}, + { "__self_setattr__", (PyCFunction)WraptObjectProxy_self_setattr, + METH_VARARGS , 0 }, + { "__dir__", (PyCFunction)WraptObjectProxy_dir, METH_NOARGS, 0 }, + { "__enter__", (PyCFunction)WraptObjectProxy_enter, + METH_VARARGS | METH_KEYWORDS, 0 }, + { "__exit__", (PyCFunction)WraptObjectProxy_exit, + METH_VARARGS | METH_KEYWORDS, 0 }, + { "__copy__", (PyCFunction)WraptObjectProxy_copy, + METH_NOARGS, 0 }, + { "__deepcopy__", (PyCFunction)WraptObjectProxy_deepcopy, + METH_VARARGS | METH_KEYWORDS, 0 }, + { "__reduce__", (PyCFunction)WraptObjectProxy_reduce, + METH_NOARGS, 0 }, + { "__reduce_ex__", (PyCFunction)WraptObjectProxy_reduce_ex, + METH_VARARGS | METH_KEYWORDS, 0 }, + { "__getattr__", (PyCFunction)WraptObjectProxy_getattr, + METH_VARARGS , 0 }, + { "__bytes__", (PyCFunction)WraptObjectProxy_bytes, METH_NOARGS, 0 }, + { "__reversed__", (PyCFunction)WraptObjectProxy_reversed, METH_NOARGS, 0 }, +#if PY_MAJOR_VERSION >= 3 + { "__round__", (PyCFunction)WraptObjectProxy_round, METH_NOARGS, 0 }, +#endif + { "__complex__", (PyCFunction)WraptObjectProxy_complex, METH_NOARGS, 0 }, +#if PY_MAJOR_VERSION > 3 || (PY_MAJOR_VERSION == 3 && PY_MINOR_VERSION >= 7) + { "__mro_entries__", (PyCFunction)WraptObjectProxy_mro_entries, + METH_VARARGS | METH_KEYWORDS, 0 }, +#endif + { NULL, NULL }, }; static PyGetSetDef WraptObjectProxy_getset[] = { - {"__name__", (getter)WraptObjectProxy_get_name, - (setter)WraptObjectProxy_set_name, 0}, - {"__qualname__", (getter)WraptObjectProxy_get_qualname, - (setter)WraptObjectProxy_set_qualname, 0}, - {"__module__", (getter)WraptObjectProxy_get_module, - (setter)WraptObjectProxy_set_module, 0}, - {"__doc__", (getter)WraptObjectProxy_get_doc, - (setter)WraptObjectProxy_set_doc, 0}, - {"__class__", (getter)WraptObjectProxy_get_class, - (setter)WraptObjectProxy_set_class, 0}, - {"__annotations__", (getter)WraptObjectProxy_get_annotations, - (setter)WraptObjectProxy_set_annotations, 0}, - {"__wrapped__", (getter)WraptObjectProxy_get_wrapped, - (setter)WraptObjectProxy_set_wrapped, 0}, - {"__object_proxy__", (getter)WraptObjectProxy_get_object_proxy, 0, 0}, - {NULL}, + { "__name__", (getter)WraptObjectProxy_get_name, + (setter)WraptObjectProxy_set_name, 0 }, + { "__qualname__", (getter)WraptObjectProxy_get_qualname, + (setter)WraptObjectProxy_set_qualname, 0 }, + { "__module__", (getter)WraptObjectProxy_get_module, + (setter)WraptObjectProxy_set_module, 0 }, + { "__doc__", (getter)WraptObjectProxy_get_doc, + (setter)WraptObjectProxy_set_doc, 0 }, + { "__class__", (getter)WraptObjectProxy_get_class, + (setter)WraptObjectProxy_set_class, 0 }, + { "__annotations__", (getter)WraptObjectProxy_get_annotations, + (setter)WraptObjectProxy_set_annotations, 0 }, + { "__wrapped__", (getter)WraptObjectProxy_get_wrapped, + (setter)WraptObjectProxy_set_wrapped, 0 }, + { NULL }, }; PyTypeObject WraptObjectProxy_Type = { - PyVarObject_HEAD_INIT(NULL, 0) "ObjectProxy", /*tp_name*/ - sizeof(WraptObjectProxyObject), /*tp_basicsize*/ - 0, /*tp_itemsize*/ + PyVarObject_HEAD_INIT(NULL, 0) + "ObjectProxy", /*tp_name*/ + sizeof(WraptObjectProxyObject), /*tp_basicsize*/ + 0, /*tp_itemsize*/ /* methods */ - (destructor)WraptObjectProxy_dealloc, /*tp_dealloc*/ - 0, /*tp_print*/ - 0, /*tp_getattr*/ - 0, /*tp_setattr*/ - 0, /*tp_as_async*/ - (unaryfunc)WraptObjectProxy_repr, /*tp_repr*/ - &WraptObjectProxy_as_number, /*tp_as_number*/ - &WraptObjectProxy_as_sequence, /*tp_as_sequence*/ - &WraptObjectProxy_as_mapping, /*tp_as_mapping*/ - (hashfunc)WraptObjectProxy_hash, /*tp_hash*/ - 0, /*tp_call*/ - (unaryfunc)WraptObjectProxy_str, /*tp_str*/ - (getattrofunc)WraptObjectProxy_getattro, /*tp_getattro*/ - (setattrofunc)WraptObjectProxy_setattro, /*tp_setattro*/ - 0, /*tp_as_buffer*/ - Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, /*tp_flags*/ - 0, /*tp_doc*/ - (traverseproc)WraptObjectProxy_traverse, /*tp_traverse*/ - (inquiry)WraptObjectProxy_clear, /*tp_clear*/ - (richcmpfunc)WraptObjectProxy_richcompare, /*tp_richcompare*/ - offsetof(WraptObjectProxyObject, weakreflist), /*tp_weaklistoffset*/ - 0, /* (getiterfunc)WraptObjectProxy_iter, */ /*tp_iter*/ - 0, /*tp_iternext*/ - WraptObjectProxy_methods, /*tp_methods*/ - 0, /*tp_members*/ - WraptObjectProxy_getset, /*tp_getset*/ - 0, /*tp_base*/ - 0, /*tp_dict*/ - 0, /*tp_descr_get*/ - 0, /*tp_descr_set*/ - offsetof(WraptObjectProxyObject, dict), /*tp_dictoffset*/ - (initproc)WraptObjectProxy_init, /*tp_init*/ - PyType_GenericAlloc, /*tp_alloc*/ - WraptObjectProxy_new, /*tp_new*/ - PyObject_GC_Del, /*tp_free*/ - 0, /*tp_is_gc*/ + (destructor)WraptObjectProxy_dealloc, /*tp_dealloc*/ + 0, /*tp_print*/ + 0, /*tp_getattr*/ + 0, /*tp_setattr*/ + 0, /*tp_compare*/ + (unaryfunc)WraptObjectProxy_repr, /*tp_repr*/ + &WraptObjectProxy_as_number, /*tp_as_number*/ + &WraptObjectProxy_as_sequence, /*tp_as_sequence*/ + &WraptObjectProxy_as_mapping, /*tp_as_mapping*/ + (hashfunc)WraptObjectProxy_hash, /*tp_hash*/ + 0, /*tp_call*/ + (unaryfunc)WraptObjectProxy_str, /*tp_str*/ + (getattrofunc)WraptObjectProxy_getattro, /*tp_getattro*/ + (setattrofunc)WraptObjectProxy_setattro, /*tp_setattro*/ + 0, /*tp_as_buffer*/ +#if PY_MAJOR_VERSION < 3 + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | + Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_CHECKTYPES, /*tp_flags*/ +#else + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | + Py_TPFLAGS_HAVE_GC, /*tp_flags*/ +#endif + 0, /*tp_doc*/ + (traverseproc)WraptObjectProxy_traverse, /*tp_traverse*/ + (inquiry)WraptObjectProxy_clear, /*tp_clear*/ + (richcmpfunc)WraptObjectProxy_richcompare, /*tp_richcompare*/ + offsetof(WraptObjectProxyObject, weakreflist), /*tp_weaklistoffset*/ + (getiterfunc)WraptObjectProxy_iter, /*tp_iter*/ + 0, /*tp_iternext*/ + WraptObjectProxy_methods, /*tp_methods*/ + 0, /*tp_members*/ + WraptObjectProxy_getset, /*tp_getset*/ + 0, /*tp_base*/ + 0, /*tp_dict*/ + 0, /*tp_descr_get*/ + 0, /*tp_descr_set*/ + offsetof(WraptObjectProxyObject, dict), /*tp_dictoffset*/ + (initproc)WraptObjectProxy_init, /*tp_init*/ + PyType_GenericAlloc, /*tp_alloc*/ + WraptObjectProxy_new, /*tp_new*/ + PyObject_GC_Del, /*tp_free*/ + 0, /*tp_is_gc*/ }; /* ------------------------------------------------------------------------- */ -static PyObject *WraptCallableObjectProxy_call(WraptObjectProxyObject *self, - PyObject *args, PyObject *kwds) +static PyObject *WraptCallableObjectProxy_call( + WraptObjectProxyObject *self, PyObject *args, PyObject *kwds) { - if (!self->wrapped) - { - if (raise_uninitialized_wrapper_error(self) == -1) + if (!self->wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - return PyObject_Call(self->wrapped, args, kwds); + return PyObject_Call(self->wrapped, args, kwds); } /* ------------------------------------------------------------------------- */; static PyGetSetDef WraptCallableObjectProxy_getset[] = { - {"__module__", (getter)WraptObjectProxy_get_module, - (setter)WraptObjectProxy_set_module, 0}, - {"__doc__", (getter)WraptObjectProxy_get_doc, - (setter)WraptObjectProxy_set_doc, 0}, - {NULL}, + { "__module__", (getter)WraptObjectProxy_get_module, + (setter)WraptObjectProxy_set_module, 0 }, + { "__doc__", (getter)WraptObjectProxy_get_doc, + (setter)WraptObjectProxy_set_doc, 0 }, + { NULL }, }; PyTypeObject WraptCallableObjectProxy_Type = { - PyVarObject_HEAD_INIT(NULL, 0) "CallableObjectProxy", /*tp_name*/ - sizeof(WraptObjectProxyObject), /*tp_basicsize*/ - 0, /*tp_itemsize*/ + PyVarObject_HEAD_INIT(NULL, 0) + "CallableObjectProxy", /*tp_name*/ + sizeof(WraptObjectProxyObject), /*tp_basicsize*/ + 0, /*tp_itemsize*/ /* methods */ - 0, /*tp_dealloc*/ - 0, /*tp_print*/ - 0, /*tp_getattr*/ - 0, /*tp_setattr*/ - 0, /*tp_compare*/ - 0, /*tp_repr*/ - 0, /*tp_as_number*/ - 0, /*tp_as_sequence*/ - 0, /*tp_as_mapping*/ - 0, /*tp_hash*/ - (ternaryfunc)WraptCallableObjectProxy_call, /*tp_call*/ - 0, /*tp_str*/ - 0, /*tp_getattro*/ - 0, /*tp_setattro*/ - 0, /*tp_as_buffer*/ - Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ - 0, /*tp_doc*/ - 0, /*tp_traverse*/ - 0, /*tp_clear*/ - 0, /*tp_richcompare*/ + 0, /*tp_dealloc*/ + 0, /*tp_print*/ + 0, /*tp_getattr*/ + 0, /*tp_setattr*/ + 0, /*tp_compare*/ + 0, /*tp_repr*/ + 0, /*tp_as_number*/ + 0, /*tp_as_sequence*/ + 0, /*tp_as_mapping*/ + 0, /*tp_hash*/ + (ternaryfunc)WraptCallableObjectProxy_call, /*tp_call*/ + 0, /*tp_str*/ + 0, /*tp_getattro*/ + 0, /*tp_setattro*/ + 0, /*tp_as_buffer*/ +#if PY_MAJOR_VERSION < 3 + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_CHECKTYPES, /*tp_flags*/ +#else + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ +#endif + 0, /*tp_doc*/ + 0, /*tp_traverse*/ + 0, /*tp_clear*/ + 0, /*tp_richcompare*/ offsetof(WraptObjectProxyObject, weakreflist), /*tp_weaklistoffset*/ - 0, /*tp_iter*/ - 0, /*tp_iternext*/ - 0, /*tp_methods*/ - 0, /*tp_members*/ - WraptCallableObjectProxy_getset, /*tp_getset*/ - 0, /*tp_base*/ - 0, /*tp_dict*/ - 0, /*tp_descr_get*/ - 0, /*tp_descr_set*/ - 0, /*tp_dictoffset*/ - (initproc)WraptObjectProxy_init, /*tp_init*/ - 0, /*tp_alloc*/ - 0, /*tp_new*/ - 0, /*tp_free*/ - 0, /*tp_is_gc*/ + 0, /*tp_iter*/ + 0, /*tp_iternext*/ + 0, /*tp_methods*/ + 0, /*tp_members*/ + WraptCallableObjectProxy_getset, /*tp_getset*/ + 0, /*tp_base*/ + 0, /*tp_dict*/ + 0, /*tp_descr_get*/ + 0, /*tp_descr_set*/ + 0, /*tp_dictoffset*/ + (initproc)WraptObjectProxy_init, /*tp_init*/ + 0, /*tp_alloc*/ + 0, /*tp_new*/ + 0, /*tp_free*/ + 0, /*tp_is_gc*/ }; /* ------------------------------------------------------------------------- */ static PyObject *WraptPartialCallableObjectProxy_new(PyTypeObject *type, - PyObject *args, - PyObject *kwds) + PyObject *args, PyObject *kwds) { - WraptPartialCallableObjectProxyObject *self; + WraptPartialCallableObjectProxyObject *self; - self = (WraptPartialCallableObjectProxyObject *)WraptObjectProxy_new( - type, args, kwds); + self = (WraptPartialCallableObjectProxyObject *)WraptObjectProxy_new(type, + args, kwds); - if (!self) - return NULL; + if (!self) + return NULL; - self->args = NULL; - self->kwargs = NULL; + self->args = NULL; + self->kwargs = NULL; - return (PyObject *)self; + return (PyObject *)self; } /* ------------------------------------------------------------------------- */ static int WraptPartialCallableObjectProxy_raw_init( - WraptPartialCallableObjectProxyObject *self, PyObject *wrapped, - PyObject *args, PyObject *kwargs) + WraptPartialCallableObjectProxyObject *self, + PyObject *wrapped, PyObject *args, PyObject *kwargs) { - int result = 0; + int result = 0; - result = WraptObjectProxy_raw_init((WraptObjectProxyObject *)self, wrapped); + result = WraptObjectProxy_raw_init((WraptObjectProxyObject *)self, + wrapped); - if (result == 0) - { - Py_INCREF(args); - Py_XDECREF(self->args); - self->args = args; + if (result == 0) { + Py_INCREF(args); + Py_XDECREF(self->args); + self->args = args; - Py_XINCREF(kwargs); - Py_XDECREF(self->kwargs); - self->kwargs = kwargs; - } + Py_XINCREF(kwargs); + Py_XDECREF(self->kwargs); + self->kwargs = kwargs; + } - return result; + return result; } /* ------------------------------------------------------------------------- */ static int WraptPartialCallableObjectProxy_init( - WraptPartialCallableObjectProxyObject *self, PyObject *args, - PyObject *kwds) + WraptPartialCallableObjectProxyObject *self, PyObject *args, + PyObject *kwds) { - PyObject *wrapped = NULL; - PyObject *fnargs = NULL; + PyObject *wrapped = NULL; + PyObject *fnargs = NULL; - int result = 0; + int result = 0; - if (!PyObject_Length(args)) - { - PyErr_SetString(PyExc_TypeError, "__init__ of partial needs an argument"); - return -1; - } + if (!PyObject_Length(args)) { + PyErr_SetString(PyExc_TypeError, + "__init__ of partial needs an argument"); + return -1; + } - if (PyObject_Length(args) < 1) - { - PyErr_SetString(PyExc_TypeError, - "partial type takes at least one argument"); - return -1; - } + if (PyObject_Length(args) < 1) { + PyErr_SetString(PyExc_TypeError, + "partial type takes at least one argument"); + return -1; + } - wrapped = PyTuple_GetItem(args, 0); + wrapped = PyTuple_GetItem(args, 0); - if (!PyCallable_Check(wrapped)) - { - PyErr_SetString(PyExc_TypeError, "the first argument must be callable"); - return -1; - } + if (!PyCallable_Check(wrapped)) { + PyErr_SetString(PyExc_TypeError, + "the first argument must be callable"); + return -1; + } - fnargs = PyTuple_GetSlice(args, 1, PyTuple_Size(args)); + fnargs = PyTuple_GetSlice(args, 1, PyTuple_Size(args)); - if (!fnargs) - return -1; + if (!fnargs) + return -1; - result = - WraptPartialCallableObjectProxy_raw_init(self, wrapped, fnargs, kwds); + result = WraptPartialCallableObjectProxy_raw_init(self, wrapped, + fnargs, kwds); - Py_DECREF(fnargs); + Py_DECREF(fnargs); - return result; + return result; } /* ------------------------------------------------------------------------- */ static int WraptPartialCallableObjectProxy_traverse( - WraptPartialCallableObjectProxyObject *self, visitproc visit, void *arg) + WraptPartialCallableObjectProxyObject *self, + visitproc visit, void *arg) { - WraptObjectProxy_traverse((WraptObjectProxyObject *)self, visit, arg); + WraptObjectProxy_traverse((WraptObjectProxyObject *)self, visit, arg); - Py_VISIT(self->args); - Py_VISIT(self->kwargs); + Py_VISIT(self->args); + Py_VISIT(self->kwargs); - return 0; + return 0; } /* ------------------------------------------------------------------------- */ static int WraptPartialCallableObjectProxy_clear( - WraptPartialCallableObjectProxyObject *self) + WraptPartialCallableObjectProxyObject *self) { - WraptObjectProxy_clear((WraptObjectProxyObject *)self); + WraptObjectProxy_clear((WraptObjectProxyObject *)self); - Py_CLEAR(self->args); - Py_CLEAR(self->kwargs); + Py_CLEAR(self->args); + Py_CLEAR(self->kwargs); - return 0; + return 0; } /* ------------------------------------------------------------------------- */ static void WraptPartialCallableObjectProxy_dealloc( - WraptPartialCallableObjectProxyObject *self) + WraptPartialCallableObjectProxyObject *self) { - PyObject_GC_UnTrack(self); + PyObject_GC_UnTrack(self); - WraptPartialCallableObjectProxy_clear(self); + WraptPartialCallableObjectProxy_clear(self); - WraptObjectProxy_dealloc((WraptObjectProxyObject *)self); + WraptObjectProxy_dealloc((WraptObjectProxyObject *)self); } /* ------------------------------------------------------------------------- */ static PyObject *WraptPartialCallableObjectProxy_call( - WraptPartialCallableObjectProxyObject *self, PyObject *args, - PyObject *kwds) + WraptPartialCallableObjectProxyObject *self, PyObject *args, + PyObject *kwds) { - PyObject *fnargs = NULL; - PyObject *fnkwargs = NULL; + PyObject *fnargs = NULL; + PyObject *fnkwargs = NULL; - PyObject *result = NULL; + PyObject *result = NULL; - long i; - long offset; + long i; + long offset; - if (!self->object_proxy.wrapped) - { - if (raise_uninitialized_wrapper_error(&self->object_proxy) == -1) + if (!self->object_proxy.wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - fnargs = PyTuple_New(PyTuple_Size(self->args) + PyTuple_Size(args)); + fnargs = PyTuple_New(PyTuple_Size(self->args)+PyTuple_Size(args)); - for (i = 0; i < PyTuple_Size(self->args); i++) - { - PyObject *item; - item = PyTuple_GetItem(self->args, i); - Py_INCREF(item); - PyTuple_SetItem(fnargs, i, item); - } + for (i=0; iargs); i++) { + PyObject *item; + item = PyTuple_GetItem(self->args, i); + Py_INCREF(item); + PyTuple_SetItem(fnargs, i, item); + } - offset = PyTuple_Size(self->args); + offset = PyTuple_Size(self->args); - for (i = 0; i < PyTuple_Size(args); i++) - { - PyObject *item; - item = PyTuple_GetItem(args, i); - Py_INCREF(item); - PyTuple_SetItem(fnargs, offset + i, item); - } + for (i=0; ikwargs && PyDict_Update(fnkwargs, self->kwargs) == -1) - { - Py_DECREF(fnargs); - Py_DECREF(fnkwargs); - return NULL; - } + if (self->kwargs && PyDict_Update(fnkwargs, self->kwargs) == -1) { + Py_DECREF(fnargs); + Py_DECREF(fnkwargs); + return NULL; + } - if (kwds && PyDict_Update(fnkwargs, kwds) == -1) - { - Py_DECREF(fnargs); - Py_DECREF(fnkwargs); - return NULL; - } + if (kwds && PyDict_Update(fnkwargs, kwds) == -1) { + Py_DECREF(fnargs); + Py_DECREF(fnkwargs); + return NULL; + } - result = PyObject_Call(self->object_proxy.wrapped, fnargs, fnkwargs); + result = PyObject_Call(self->object_proxy.wrapped, + fnargs, fnkwargs); - Py_DECREF(fnargs); - Py_DECREF(fnkwargs); + Py_DECREF(fnargs); + Py_DECREF(fnkwargs); - return result; + return result; } /* ------------------------------------------------------------------------- */; static PyGetSetDef WraptPartialCallableObjectProxy_getset[] = { - {"__module__", (getter)WraptObjectProxy_get_module, - (setter)WraptObjectProxy_set_module, 0}, - {"__doc__", (getter)WraptObjectProxy_get_doc, - (setter)WraptObjectProxy_set_doc, 0}, - {NULL}, + { "__module__", (getter)WraptObjectProxy_get_module, + (setter)WraptObjectProxy_set_module, 0 }, + { "__doc__", (getter)WraptObjectProxy_get_doc, + (setter)WraptObjectProxy_set_doc, 0 }, + { NULL }, }; PyTypeObject WraptPartialCallableObjectProxy_Type = { - PyVarObject_HEAD_INIT(NULL, 0) "PartialCallableObjectProxy", /*tp_name*/ - sizeof(WraptPartialCallableObjectProxyObject), /*tp_basicsize*/ - 0, /*tp_itemsize*/ + PyVarObject_HEAD_INIT(NULL, 0) + "PartialCallableObjectProxy", /*tp_name*/ + sizeof(WraptPartialCallableObjectProxyObject), /*tp_basicsize*/ + 0, /*tp_itemsize*/ /* methods */ - (destructor)WraptPartialCallableObjectProxy_dealloc, /*tp_dealloc*/ - 0, /*tp_print*/ - 0, /*tp_getattr*/ - 0, /*tp_setattr*/ - 0, /*tp_compare*/ - 0, /*tp_repr*/ - 0, /*tp_as_number*/ - 0, /*tp_as_sequence*/ - 0, /*tp_as_mapping*/ - 0, /*tp_hash*/ - (ternaryfunc)WraptPartialCallableObjectProxy_call, /*tp_call*/ - 0, /*tp_str*/ - 0, /*tp_getattro*/ - 0, /*tp_setattro*/ - 0, /*tp_as_buffer*/ - Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, /*tp_flags*/ - 0, /*tp_doc*/ - (traverseproc)WraptPartialCallableObjectProxy_traverse, /*tp_traverse*/ - (inquiry)WraptPartialCallableObjectProxy_clear, /*tp_clear*/ - 0, /*tp_richcompare*/ - offsetof(WraptObjectProxyObject, weakreflist), /*tp_weaklistoffset*/ - 0, /*tp_iter*/ - 0, /*tp_iternext*/ - 0, /*tp_methods*/ - 0, /*tp_members*/ - WraptPartialCallableObjectProxy_getset, /*tp_getset*/ - 0, /*tp_base*/ - 0, /*tp_dict*/ - 0, /*tp_descr_get*/ - 0, /*tp_descr_set*/ - 0, /*tp_dictoffset*/ - (initproc)WraptPartialCallableObjectProxy_init, /*tp_init*/ - 0, /*tp_alloc*/ - WraptPartialCallableObjectProxy_new, /*tp_new*/ - 0, /*tp_free*/ - 0, /*tp_is_gc*/ + (destructor)WraptPartialCallableObjectProxy_dealloc, /*tp_dealloc*/ + 0, /*tp_print*/ + 0, /*tp_getattr*/ + 0, /*tp_setattr*/ + 0, /*tp_compare*/ + 0, /*tp_repr*/ + 0, /*tp_as_number*/ + 0, /*tp_as_sequence*/ + 0, /*tp_as_mapping*/ + 0, /*tp_hash*/ + (ternaryfunc)WraptPartialCallableObjectProxy_call, /*tp_call*/ + 0, /*tp_str*/ + 0, /*tp_getattro*/ + 0, /*tp_setattro*/ + 0, /*tp_as_buffer*/ +#if PY_MAJOR_VERSION < 3 + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | + Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_CHECKTYPES, /*tp_flags*/ +#else + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | + Py_TPFLAGS_HAVE_GC, /*tp_flags*/ +#endif + 0, /*tp_doc*/ + (traverseproc)WraptPartialCallableObjectProxy_traverse, /*tp_traverse*/ + (inquiry)WraptPartialCallableObjectProxy_clear, /*tp_clear*/ + 0, /*tp_richcompare*/ + offsetof(WraptObjectProxyObject, weakreflist), /*tp_weaklistoffset*/ + 0, /*tp_iter*/ + 0, /*tp_iternext*/ + 0, /*tp_methods*/ + 0, /*tp_members*/ + WraptPartialCallableObjectProxy_getset, /*tp_getset*/ + 0, /*tp_base*/ + 0, /*tp_dict*/ + 0, /*tp_descr_get*/ + 0, /*tp_descr_set*/ + 0, /*tp_dictoffset*/ + (initproc)WraptPartialCallableObjectProxy_init, /*tp_init*/ + 0, /*tp_alloc*/ + WraptPartialCallableObjectProxy_new, /*tp_new*/ + 0, /*tp_free*/ + 0, /*tp_is_gc*/ }; /* ------------------------------------------------------------------------- */ static PyObject *WraptFunctionWrapperBase_new(PyTypeObject *type, - PyObject *args, PyObject *kwds) + PyObject *args, PyObject *kwds) { - WraptFunctionWrapperObject *self; + WraptFunctionWrapperObject *self; - self = (WraptFunctionWrapperObject *)WraptObjectProxy_new(type, args, kwds); + self = (WraptFunctionWrapperObject *)WraptObjectProxy_new(type, + args, kwds); - if (!self) - return NULL; + if (!self) + return NULL; - self->instance = NULL; - self->wrapper = NULL; - self->enabled = NULL; - self->binding = NULL; - self->parent = NULL; - self->owner = NULL; + self->instance = NULL; + self->wrapper = NULL; + self->enabled = NULL; + self->binding = NULL; + self->parent = NULL; - return (PyObject *)self; + return (PyObject *)self; } /* ------------------------------------------------------------------------- */ -static int WraptFunctionWrapperBase_raw_init( - WraptFunctionWrapperObject *self, PyObject *wrapped, PyObject *instance, - PyObject *wrapper, PyObject *enabled, PyObject *binding, PyObject *parent, - PyObject *owner) +static int WraptFunctionWrapperBase_raw_init(WraptFunctionWrapperObject *self, + PyObject *wrapped, PyObject *instance, PyObject *wrapper, + PyObject *enabled, PyObject *binding, PyObject *parent) { - int result = 0; + int result = 0; - result = WraptObjectProxy_raw_init((WraptObjectProxyObject *)self, wrapped); + result = WraptObjectProxy_raw_init((WraptObjectProxyObject *)self, + wrapped); - if (result == 0) - { - Py_INCREF(instance); - Py_XDECREF(self->instance); - self->instance = instance; + if (result == 0) { + Py_INCREF(instance); + Py_XDECREF(self->instance); + self->instance = instance; - Py_INCREF(wrapper); - Py_XDECREF(self->wrapper); - self->wrapper = wrapper; + Py_INCREF(wrapper); + Py_XDECREF(self->wrapper); + self->wrapper = wrapper; - Py_INCREF(enabled); - Py_XDECREF(self->enabled); - self->enabled = enabled; + Py_INCREF(enabled); + Py_XDECREF(self->enabled); + self->enabled = enabled; - Py_INCREF(binding); - Py_XDECREF(self->binding); - self->binding = binding; + Py_INCREF(binding); + Py_XDECREF(self->binding); + self->binding = binding; - Py_INCREF(parent); - Py_XDECREF(self->parent); - self->parent = parent; - - Py_INCREF(owner); - Py_XDECREF(self->owner); - self->owner = owner; - } + Py_INCREF(parent); + Py_XDECREF(self->parent); + self->parent = parent; + } - return result; + return result; } /* ------------------------------------------------------------------------- */ static int WraptFunctionWrapperBase_init(WraptFunctionWrapperObject *self, - PyObject *args, PyObject *kwds) + PyObject *args, PyObject *kwds) { - PyObject *wrapped = NULL; - PyObject *instance = NULL; - PyObject *wrapper = NULL; - PyObject *enabled = Py_None; - PyObject *binding = NULL; - PyObject *parent = Py_None; - PyObject *owner = Py_None; - - static PyObject *callable_str = NULL; - - char *const kwlist[] = {"wrapped", "instance", "wrapper", "enabled", - "binding", "parent", "owner", NULL}; - - if (!callable_str) - { - callable_str = PyUnicode_InternFromString("callable"); - } - - if (!PyArg_ParseTupleAndKeywords(args, kwds, "OOO|OOOO:FunctionWrapperBase", - kwlist, &wrapped, &instance, &wrapper, - &enabled, &binding, &parent, &owner)) - { - return -1; - } - - if (!binding) - binding = callable_str; - - return WraptFunctionWrapperBase_raw_init(self, wrapped, instance, wrapper, - enabled, binding, parent, owner); + PyObject *wrapped = NULL; + PyObject *instance = NULL; + PyObject *wrapper = NULL; + PyObject *enabled = Py_None; + PyObject *binding = NULL; + PyObject *parent = Py_None; + + static PyObject *function_str = NULL; + + static char *kwlist[] = { "wrapped", "instance", "wrapper", + "enabled", "binding", "parent", NULL }; + + if (!function_str) { +#if PY_MAJOR_VERSION >= 3 + function_str = PyUnicode_InternFromString("function"); +#else + function_str = PyString_InternFromString("function"); +#endif + } + + if (!PyArg_ParseTupleAndKeywords(args, kwds, + "OOO|OOO:FunctionWrapperBase", kwlist, &wrapped, &instance, + &wrapper, &enabled, &binding, &parent)) { + return -1; + } + + if (!binding) + binding = function_str; + + return WraptFunctionWrapperBase_raw_init(self, wrapped, instance, wrapper, + enabled, binding, parent); } /* ------------------------------------------------------------------------- */ static int WraptFunctionWrapperBase_traverse(WraptFunctionWrapperObject *self, - visitproc visit, void *arg) + visitproc visit, void *arg) { - WraptObjectProxy_traverse((WraptObjectProxyObject *)self, visit, arg); + WraptObjectProxy_traverse((WraptObjectProxyObject *)self, visit, arg); - Py_VISIT(self->instance); - Py_VISIT(self->wrapper); - Py_VISIT(self->enabled); - Py_VISIT(self->binding); - Py_VISIT(self->parent); - Py_VISIT(self->owner); + Py_VISIT(self->instance); + Py_VISIT(self->wrapper); + Py_VISIT(self->enabled); + Py_VISIT(self->binding); + Py_VISIT(self->parent); - return 0; + return 0; } /* ------------------------------------------------------------------------- */ static int WraptFunctionWrapperBase_clear(WraptFunctionWrapperObject *self) { - WraptObjectProxy_clear((WraptObjectProxyObject *)self); + WraptObjectProxy_clear((WraptObjectProxyObject *)self); - Py_CLEAR(self->instance); - Py_CLEAR(self->wrapper); - Py_CLEAR(self->enabled); - Py_CLEAR(self->binding); - Py_CLEAR(self->parent); - Py_CLEAR(self->owner); + Py_CLEAR(self->instance); + Py_CLEAR(self->wrapper); + Py_CLEAR(self->enabled); + Py_CLEAR(self->binding); + Py_CLEAR(self->parent); - return 0; + return 0; } /* ------------------------------------------------------------------------- */ static void WraptFunctionWrapperBase_dealloc(WraptFunctionWrapperObject *self) { - PyObject_GC_UnTrack(self); + PyObject_GC_UnTrack(self); - WraptFunctionWrapperBase_clear(self); + WraptFunctionWrapperBase_clear(self); - WraptObjectProxy_dealloc((WraptObjectProxyObject *)self); + WraptObjectProxy_dealloc((WraptObjectProxyObject *)self); } /* ------------------------------------------------------------------------- */ -static PyObject *WraptFunctionWrapperBase_call(WraptFunctionWrapperObject *self, - PyObject *args, PyObject *kwds) +static PyObject *WraptFunctionWrapperBase_call( + WraptFunctionWrapperObject *self, PyObject *args, PyObject *kwds) { - PyObject *param_kwds = NULL; + PyObject *param_kwds = NULL; - PyObject *result = NULL; + PyObject *result = NULL; - static PyObject *function_str = NULL; - static PyObject *callable_str = NULL; - static PyObject *classmethod_str = NULL; - static PyObject *instancemethod_str = NULL; + static PyObject *function_str = NULL; + static PyObject *classmethod_str = NULL; - if (!function_str) - { - function_str = PyUnicode_InternFromString("function"); - callable_str = PyUnicode_InternFromString("callable"); - classmethod_str = PyUnicode_InternFromString("classmethod"); - instancemethod_str = PyUnicode_InternFromString("instancemethod"); - } + if (!function_str) { +#if PY_MAJOR_VERSION >= 3 + function_str = PyUnicode_InternFromString("function"); + classmethod_str = PyUnicode_InternFromString("classmethod"); +#else + function_str = PyString_InternFromString("function"); + classmethod_str = PyString_InternFromString("classmethod"); +#endif + } - if (self->enabled != Py_None) - { - if (PyCallable_Check(self->enabled)) - { - PyObject *object = NULL; + if (self->enabled != Py_None) { + if (PyCallable_Check(self->enabled)) { + PyObject *object = NULL; - object = PyObject_CallFunctionObjArgs(self->enabled, NULL); + object = PyObject_CallFunctionObjArgs(self->enabled, NULL); - if (!object) - return NULL; + if (!object) + return NULL; - if (PyObject_Not(object)) - { - Py_DECREF(object); - return PyObject_Call(self->object_proxy.wrapped, args, kwds); - } - - Py_DECREF(object); - } - else if (PyObject_Not(self->enabled)) - { - return PyObject_Call(self->object_proxy.wrapped, args, kwds); - } - } - - if (!kwds) - { - param_kwds = PyDict_New(); - kwds = param_kwds; - } - - if ((self->instance == Py_None) && - (self->binding == function_str || - PyObject_RichCompareBool(self->binding, function_str, Py_EQ) == 1 || - self->binding == instancemethod_str || - PyObject_RichCompareBool(self->binding, instancemethod_str, Py_EQ) == - 1 || - self->binding == callable_str || - PyObject_RichCompareBool(self->binding, callable_str, Py_EQ) == 1 || - self->binding == classmethod_str || - PyObject_RichCompareBool(self->binding, classmethod_str, Py_EQ) == 1)) - { + if (PyObject_Not(object)) { + Py_DECREF(object); + return PyObject_Call(self->object_proxy.wrapped, args, kwds); + } - PyObject *instance = NULL; + Py_DECREF(object); + } + else if (PyObject_Not(self->enabled)) { + return PyObject_Call(self->object_proxy.wrapped, args, kwds); + } + } + + if (!kwds) { + param_kwds = PyDict_New(); + kwds = param_kwds; + } + + if ((self->instance == Py_None) && (self->binding == function_str || + PyObject_RichCompareBool(self->binding, function_str, + Py_EQ) == 1 || self->binding == classmethod_str || + PyObject_RichCompareBool(self->binding, classmethod_str, + Py_EQ) == 1)) { + + PyObject *instance = NULL; - instance = PyObject_GetAttrString(self->object_proxy.wrapped, "__self__"); + instance = PyObject_GetAttrString(self->object_proxy.wrapped, + "__self__"); - if (instance) - { - result = PyObject_CallFunctionObjArgs(self->wrapper, - self->object_proxy.wrapped, - instance, args, kwds, NULL); + if (instance) { + result = PyObject_CallFunctionObjArgs(self->wrapper, + self->object_proxy.wrapped, instance, args, kwds, NULL); - Py_XDECREF(param_kwds); + Py_XDECREF(param_kwds); - Py_DECREF(instance); + Py_DECREF(instance); - return result; + return result; + } + else + PyErr_Clear(); } - else - PyErr_Clear(); - } - result = - PyObject_CallFunctionObjArgs(self->wrapper, self->object_proxy.wrapped, - self->instance, args, kwds, NULL); + result = PyObject_CallFunctionObjArgs(self->wrapper, + self->object_proxy.wrapped, self->instance, args, kwds, NULL); - Py_XDECREF(param_kwds); + Py_XDECREF(param_kwds); - return result; + return result; } /* ------------------------------------------------------------------------- */ -static PyObject * -WraptFunctionWrapperBase_descr_get(WraptFunctionWrapperObject *self, - PyObject *obj, PyObject *type) +static PyObject *WraptFunctionWrapperBase_descr_get( + WraptFunctionWrapperObject *self, PyObject *obj, PyObject *type) { - PyObject *bound_type = NULL; - PyObject *descriptor = NULL; - PyObject *result = NULL; - - static PyObject *bound_type_str = NULL; - static PyObject *function_str = NULL; - static PyObject *callable_str = NULL; - static PyObject *builtin_str = NULL; - static PyObject *class_str = NULL; - static PyObject *instancemethod_str = NULL; - - if (!bound_type_str) - { - bound_type_str = PyUnicode_InternFromString("__bound_function_wrapper__"); - } - - if (!function_str) - { - function_str = PyUnicode_InternFromString("function"); - callable_str = PyUnicode_InternFromString("callable"); - builtin_str = PyUnicode_InternFromString("builtin"); - class_str = PyUnicode_InternFromString("class"); - instancemethod_str = PyUnicode_InternFromString("instancemethod"); - } - - if (self->parent == Py_None) - { - if (self->binding == builtin_str || - PyObject_RichCompareBool(self->binding, builtin_str, Py_EQ) == 1) - { - Py_INCREF(self); - return (PyObject *)self; - } - - if (self->binding == class_str || - PyObject_RichCompareBool(self->binding, class_str, Py_EQ) == 1) - { - Py_INCREF(self); - return (PyObject *)self; - } - - if (Py_TYPE(self->object_proxy.wrapped)->tp_descr_get == NULL) - { - Py_INCREF(self); - return (PyObject *)self; - } - - descriptor = (Py_TYPE(self->object_proxy.wrapped)->tp_descr_get)( - self->object_proxy.wrapped, obj, type); - - if (!descriptor) - return NULL; + PyObject *bound_type = NULL; + PyObject *descriptor = NULL; + PyObject *result = NULL; - if (Py_TYPE(self) != &WraptFunctionWrapper_Type) - { - bound_type = PyObject_GenericGetAttr((PyObject *)self, bound_type_str); + static PyObject *bound_type_str = NULL; + static PyObject *function_str = NULL; - if (!bound_type) - PyErr_Clear(); + if (!bound_type_str) { +#if PY_MAJOR_VERSION >= 3 + bound_type_str = PyUnicode_InternFromString( + "__bound_function_wrapper__"); +#else + bound_type_str = PyString_InternFromString( + "__bound_function_wrapper__"); +#endif } - if (obj == NULL) - obj = Py_None; + if (!function_str) { +#if PY_MAJOR_VERSION >= 3 + function_str = PyUnicode_InternFromString("function"); +#else + function_str = PyString_InternFromString("function"); +#endif + } - result = PyObject_CallFunctionObjArgs( - bound_type ? bound_type : (PyObject *)&WraptBoundFunctionWrapper_Type, - descriptor, obj, self->wrapper, self->enabled, self->binding, self, - type, NULL); + if (self->parent == Py_None) { +#if PY_MAJOR_VERSION < 3 + if (PyObject_IsInstance(self->object_proxy.wrapped, + (PyObject *)&PyClass_Type) || PyObject_IsInstance( + self->object_proxy.wrapped, (PyObject *)&PyType_Type)) { + Py_INCREF(self); + return (PyObject *)self; + } +#else + if (PyObject_IsInstance(self->object_proxy.wrapped, + (PyObject *)&PyType_Type)) { + Py_INCREF(self); + return (PyObject *)self; + } +#endif - Py_XDECREF(bound_type); - Py_DECREF(descriptor); + if (Py_TYPE(self->object_proxy.wrapped)->tp_descr_get == NULL) { + PyErr_Format(PyExc_AttributeError, + "'%s' object has no attribute '__get__'", + Py_TYPE(self->object_proxy.wrapped)->tp_name); + return NULL; + } - return result; - } - - if (self->instance == Py_None && - (self->binding == function_str || - PyObject_RichCompareBool(self->binding, function_str, Py_EQ) == 1 || - self->binding == instancemethod_str || - PyObject_RichCompareBool(self->binding, instancemethod_str, Py_EQ) == - 1 || - self->binding == callable_str || - PyObject_RichCompareBool(self->binding, callable_str, Py_EQ) == 1)) - { + descriptor = (Py_TYPE(self->object_proxy.wrapped)->tp_descr_get)( + self->object_proxy.wrapped, obj, type); - PyObject *wrapped = NULL; + if (!descriptor) + return NULL; - static PyObject *wrapped_str = NULL; + if (Py_TYPE(self) != &WraptFunctionWrapper_Type) { + bound_type = PyObject_GenericGetAttr((PyObject *)self, + bound_type_str); - if (!wrapped_str) - { - wrapped_str = PyUnicode_InternFromString("__wrapped__"); - } + if (!bound_type) + PyErr_Clear(); + } - wrapped = PyObject_GetAttr(self->parent, wrapped_str); + if (obj == NULL) + obj = Py_None; - if (!wrapped) - return NULL; + result = PyObject_CallFunctionObjArgs(bound_type ? bound_type : + (PyObject *)&WraptBoundFunctionWrapper_Type, descriptor, + obj, self->wrapper, self->enabled, self->binding, + self, NULL); - if (Py_TYPE(wrapped)->tp_descr_get == NULL) - { - PyErr_Format(PyExc_AttributeError, - "'%s' object has no attribute '__get__'", - Py_TYPE(wrapped)->tp_name); - Py_DECREF(wrapped); - return NULL; + Py_XDECREF(bound_type); + Py_DECREF(descriptor); + + return result; } - descriptor = (Py_TYPE(wrapped)->tp_descr_get)(wrapped, obj, type); + if (self->instance == Py_None && (self->binding == function_str || + PyObject_RichCompareBool(self->binding, function_str, + Py_EQ) == 1)) { - Py_DECREF(wrapped); + PyObject *wrapped = NULL; - if (!descriptor) - return NULL; + static PyObject *wrapped_str = NULL; - if (Py_TYPE(self->parent) != &WraptFunctionWrapper_Type) - { - bound_type = - PyObject_GenericGetAttr((PyObject *)self->parent, bound_type_str); + if (!wrapped_str) { +#if PY_MAJOR_VERSION >= 3 + wrapped_str = PyUnicode_InternFromString("__wrapped__"); +#else + wrapped_str = PyString_InternFromString("__wrapped__"); +#endif + } - if (!bound_type) - PyErr_Clear(); - } + wrapped = PyObject_GetAttr(self->parent, wrapped_str); - if (obj == NULL) - obj = Py_None; + if (!wrapped) + return NULL; + + if (Py_TYPE(wrapped)->tp_descr_get == NULL) { + PyErr_Format(PyExc_AttributeError, + "'%s' object has no attribute '__get__'", + Py_TYPE(wrapped)->tp_name); + Py_DECREF(wrapped); + return NULL; + } - result = PyObject_CallFunctionObjArgs( - bound_type ? bound_type : (PyObject *)&WraptBoundFunctionWrapper_Type, - descriptor, obj, self->wrapper, self->enabled, self->binding, - self->parent, type, NULL); + descriptor = (Py_TYPE(wrapped)->tp_descr_get)(wrapped, obj, type); - Py_XDECREF(bound_type); - Py_DECREF(descriptor); + Py_DECREF(wrapped); - return result; - } + if (!descriptor) + return NULL; + + if (Py_TYPE(self->parent) != &WraptFunctionWrapper_Type) { + bound_type = PyObject_GenericGetAttr((PyObject *)self->parent, + bound_type_str); - Py_INCREF(self); - return (PyObject *)self; + if (!bound_type) + PyErr_Clear(); + } + + if (obj == NULL) + obj = Py_None; + + result = PyObject_CallFunctionObjArgs(bound_type ? bound_type : + (PyObject *)&WraptBoundFunctionWrapper_Type, descriptor, + obj, self->wrapper, self->enabled, self->binding, + self->parent, NULL); + + Py_XDECREF(bound_type); + Py_DECREF(descriptor); + + return result; + } + + Py_INCREF(self); + return (PyObject *)self; } /* ------------------------------------------------------------------------- */ -static PyObject * -WraptFunctionWrapperBase_set_name(WraptFunctionWrapperObject *self, - PyObject *args, PyObject *kwds) +static PyObject *WraptFunctionWrapperBase_set_name( + WraptFunctionWrapperObject *self, PyObject *args, PyObject *kwds) { - PyObject *method = NULL; - PyObject *result = NULL; + PyObject *method = NULL; + PyObject *result = NULL; - if (!self->object_proxy.wrapped) - { - if (raise_uninitialized_wrapper_error(&self->object_proxy) == -1) + if (!self->object_proxy.wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } + } - method = PyObject_GetAttrString(self->object_proxy.wrapped, "__set_name__"); + method = PyObject_GetAttrString(self->object_proxy.wrapped, + "__set_name__"); - if (!method) - { - PyErr_Clear(); - Py_INCREF(Py_None); - return Py_None; - } + if (!method) { + PyErr_Clear(); + Py_INCREF(Py_None); + return Py_None; + } - result = PyObject_Call(method, args, kwds); + result = PyObject_Call(method, args, kwds); - Py_DECREF(method); + Py_DECREF(method); - return result; + return result; } /* ------------------------------------------------------------------------- */ -static PyObject * -WraptFunctionWrapperBase_instancecheck(WraptFunctionWrapperObject *self, - PyObject *instance) +static PyObject *WraptFunctionWrapperBase_instancecheck( + WraptFunctionWrapperObject *self, PyObject *instance) { - PyObject *result = NULL; + PyObject *result = NULL; - int check = 0; + int check = 0; - if (!self->object_proxy.wrapped) - { - if (raise_uninitialized_wrapper_error(&self->object_proxy) == -1) - return NULL; - } + if (!self->object_proxy.wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); + return NULL; + } - check = PyObject_IsInstance(instance, self->object_proxy.wrapped); + check = PyObject_IsInstance(instance, self->object_proxy.wrapped); - if (check < 0) - { - return NULL; - } + if (check < 0) { + return NULL; + } - result = check ? Py_True : Py_False; + result = check ? Py_True : Py_False; - Py_INCREF(result); - return result; + Py_INCREF(result); + return result; } /* ------------------------------------------------------------------------- */ -static PyObject * -WraptFunctionWrapperBase_subclasscheck(WraptFunctionWrapperObject *self, - PyObject *args) +static PyObject *WraptFunctionWrapperBase_subclasscheck( + WraptFunctionWrapperObject *self, PyObject *args) { - PyObject *subclass = NULL; - PyObject *object = NULL; - PyObject *result = NULL; + PyObject *subclass = NULL; + PyObject *object = NULL; + PyObject *result = NULL; - int check = 0; + int check = 0; - if (!self->object_proxy.wrapped) - { - if (raise_uninitialized_wrapper_error(&self->object_proxy) == -1) + if (!self->object_proxy.wrapped) { + PyErr_SetString(PyExc_ValueError, "wrapper has not been initialized"); return NULL; - } - - if (!PyArg_ParseTuple(args, "O", &subclass)) - return NULL; - - object = PyObject_GetAttrString(subclass, "__wrapped__"); - - if (!object) - PyErr_Clear(); + } - check = PyObject_IsSubclass(object ? object : subclass, - self->object_proxy.wrapped); + if (!PyArg_ParseTuple(args, "O", &subclass)) + return NULL; - Py_XDECREF(object); + object = PyObject_GetAttrString(subclass, "__wrapped__"); - if (check == -1) - return NULL; + if (!object) + PyErr_Clear(); - result = check ? Py_True : Py_False; + check = PyObject_IsSubclass(object ? object: subclass, + self->object_proxy.wrapped); - Py_INCREF(result); + Py_XDECREF(object); - return result; -} + if (check == -1) + return NULL; -/* ------------------------------------------------------------------------- */ + result = check ? Py_True : Py_False; -static PyObject * -WraptFunctionWrapperBase_get_self_instance(WraptFunctionWrapperObject *self, - void *closure) -{ - if (!self->instance) - { - Py_INCREF(Py_None); - return Py_None; - } + Py_INCREF(result); - Py_INCREF(self->instance); - return self->instance; + return result; } /* ------------------------------------------------------------------------- */ -static PyObject * -WraptFunctionWrapperBase_get_self_wrapper(WraptFunctionWrapperObject *self, - void *closure) +static PyObject *WraptFunctionWrapperBase_get_self_instance( + WraptFunctionWrapperObject *self, void *closure) { - if (!self->wrapper) - { - Py_INCREF(Py_None); - return Py_None; - } + if (!self->instance) { + Py_INCREF(Py_None); + return Py_None; + } - Py_INCREF(self->wrapper); - return self->wrapper; + Py_INCREF(self->instance); + return self->instance; } /* ------------------------------------------------------------------------- */ -static PyObject * -WraptFunctionWrapperBase_get_self_enabled(WraptFunctionWrapperObject *self, - void *closure) +static PyObject *WraptFunctionWrapperBase_get_self_wrapper( + WraptFunctionWrapperObject *self, void *closure) { - if (!self->enabled) - { - Py_INCREF(Py_None); - return Py_None; - } + if (!self->wrapper) { + Py_INCREF(Py_None); + return Py_None; + } - Py_INCREF(self->enabled); - return self->enabled; + Py_INCREF(self->wrapper); + return self->wrapper; } /* ------------------------------------------------------------------------- */ -static PyObject * -WraptFunctionWrapperBase_get_self_binding(WraptFunctionWrapperObject *self, - void *closure) +static PyObject *WraptFunctionWrapperBase_get_self_enabled( + WraptFunctionWrapperObject *self, void *closure) { - if (!self->binding) - { - Py_INCREF(Py_None); - return Py_None; - } + if (!self->enabled) { + Py_INCREF(Py_None); + return Py_None; + } - Py_INCREF(self->binding); - return self->binding; + Py_INCREF(self->enabled); + return self->enabled; } /* ------------------------------------------------------------------------- */ -static PyObject * -WraptFunctionWrapperBase_get_self_parent(WraptFunctionWrapperObject *self, - void *closure) +static PyObject *WraptFunctionWrapperBase_get_self_binding( + WraptFunctionWrapperObject *self, void *closure) { - if (!self->parent) - { - Py_INCREF(Py_None); - return Py_None; - } + if (!self->binding) { + Py_INCREF(Py_None); + return Py_None; + } - Py_INCREF(self->parent); - return self->parent; + Py_INCREF(self->binding); + return self->binding; } /* ------------------------------------------------------------------------- */ -static PyObject * -WraptFunctionWrapperBase_get_self_owner(WraptFunctionWrapperObject *self, - void *closure) +static PyObject *WraptFunctionWrapperBase_get_self_parent( + WraptFunctionWrapperObject *self, void *closure) { - if (!self->owner) - { - Py_INCREF(Py_None); - return Py_None; - } + if (!self->parent) { + Py_INCREF(Py_None); + return Py_None; + } - Py_INCREF(self->owner); - return self->owner; + Py_INCREF(self->parent); + return self->parent; } /* ------------------------------------------------------------------------- */; static PyMethodDef WraptFunctionWrapperBase_methods[] = { - {"__set_name__", (PyCFunction)WraptFunctionWrapperBase_set_name, - METH_VARARGS | METH_KEYWORDS, 0}, - {"__instancecheck__", (PyCFunction)WraptFunctionWrapperBase_instancecheck, - METH_O, 0}, - {"__subclasscheck__", (PyCFunction)WraptFunctionWrapperBase_subclasscheck, - METH_VARARGS, 0}, - {NULL, NULL}, + { "__set_name__", (PyCFunction)WraptFunctionWrapperBase_set_name, + METH_VARARGS | METH_KEYWORDS, 0 }, + { "__instancecheck__", (PyCFunction)WraptFunctionWrapperBase_instancecheck, + METH_O, 0}, + { "__subclasscheck__", (PyCFunction)WraptFunctionWrapperBase_subclasscheck, + METH_VARARGS, 0 }, + { NULL, NULL }, }; /* ------------------------------------------------------------------------- */; static PyGetSetDef WraptFunctionWrapperBase_getset[] = { - {"__module__", (getter)WraptObjectProxy_get_module, - (setter)WraptObjectProxy_set_module, 0}, - {"__doc__", (getter)WraptObjectProxy_get_doc, - (setter)WraptObjectProxy_set_doc, 0}, - {"_self_instance", (getter)WraptFunctionWrapperBase_get_self_instance, NULL, - 0}, - {"_self_wrapper", (getter)WraptFunctionWrapperBase_get_self_wrapper, NULL, - 0}, - {"_self_enabled", (getter)WraptFunctionWrapperBase_get_self_enabled, NULL, - 0}, - {"_self_binding", (getter)WraptFunctionWrapperBase_get_self_binding, NULL, - 0}, - {"_self_parent", (getter)WraptFunctionWrapperBase_get_self_parent, NULL, 0}, - {"_self_owner", (getter)WraptFunctionWrapperBase_get_self_owner, NULL, 0}, - {NULL}, + { "__module__", (getter)WraptObjectProxy_get_module, + (setter)WraptObjectProxy_set_module, 0 }, + { "__doc__", (getter)WraptObjectProxy_get_doc, + (setter)WraptObjectProxy_set_doc, 0 }, + { "_self_instance", (getter)WraptFunctionWrapperBase_get_self_instance, + NULL, 0 }, + { "_self_wrapper", (getter)WraptFunctionWrapperBase_get_self_wrapper, + NULL, 0 }, + { "_self_enabled", (getter)WraptFunctionWrapperBase_get_self_enabled, + NULL, 0 }, + { "_self_binding", (getter)WraptFunctionWrapperBase_get_self_binding, + NULL, 0 }, + { "_self_parent", (getter)WraptFunctionWrapperBase_get_self_parent, + NULL, 0 }, + { NULL }, }; PyTypeObject WraptFunctionWrapperBase_Type = { - PyVarObject_HEAD_INIT(NULL, 0) "_FunctionWrapperBase", /*tp_name*/ - sizeof(WraptFunctionWrapperObject), /*tp_basicsize*/ - 0, /*tp_itemsize*/ + PyVarObject_HEAD_INIT(NULL, 0) + "_FunctionWrapperBase", /*tp_name*/ + sizeof(WraptFunctionWrapperObject), /*tp_basicsize*/ + 0, /*tp_itemsize*/ /* methods */ - (destructor)WraptFunctionWrapperBase_dealloc, /*tp_dealloc*/ - 0, /*tp_print*/ - 0, /*tp_getattr*/ - 0, /*tp_setattr*/ - 0, /*tp_compare*/ - 0, /*tp_repr*/ - 0, /*tp_as_number*/ - 0, /*tp_as_sequence*/ - 0, /*tp_as_mapping*/ - 0, /*tp_hash*/ - (ternaryfunc)WraptFunctionWrapperBase_call, /*tp_call*/ - 0, /*tp_str*/ - 0, /*tp_getattro*/ - 0, /*tp_setattro*/ - 0, /*tp_as_buffer*/ - Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, /*tp_flags*/ - 0, /*tp_doc*/ - (traverseproc)WraptFunctionWrapperBase_traverse, /*tp_traverse*/ - (inquiry)WraptFunctionWrapperBase_clear, /*tp_clear*/ - 0, /*tp_richcompare*/ - offsetof(WraptObjectProxyObject, weakreflist), /*tp_weaklistoffset*/ - 0, /*tp_iter*/ - 0, /*tp_iternext*/ - WraptFunctionWrapperBase_methods, /*tp_methods*/ - 0, /*tp_members*/ - WraptFunctionWrapperBase_getset, /*tp_getset*/ - 0, /*tp_base*/ - 0, /*tp_dict*/ - (descrgetfunc)WraptFunctionWrapperBase_descr_get, /*tp_descr_get*/ - 0, /*tp_descr_set*/ - 0, /*tp_dictoffset*/ - (initproc)WraptFunctionWrapperBase_init, /*tp_init*/ - 0, /*tp_alloc*/ - WraptFunctionWrapperBase_new, /*tp_new*/ - 0, /*tp_free*/ - 0, /*tp_is_gc*/ + (destructor)WraptFunctionWrapperBase_dealloc, /*tp_dealloc*/ + 0, /*tp_print*/ + 0, /*tp_getattr*/ + 0, /*tp_setattr*/ + 0, /*tp_compare*/ + 0, /*tp_repr*/ + 0, /*tp_as_number*/ + 0, /*tp_as_sequence*/ + 0, /*tp_as_mapping*/ + 0, /*tp_hash*/ + (ternaryfunc)WraptFunctionWrapperBase_call, /*tp_call*/ + 0, /*tp_str*/ + 0, /*tp_getattro*/ + 0, /*tp_setattro*/ + 0, /*tp_as_buffer*/ +#if PY_MAJOR_VERSION < 3 + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | + Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_CHECKTYPES, /*tp_flags*/ +#else + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | + Py_TPFLAGS_HAVE_GC, /*tp_flags*/ +#endif + 0, /*tp_doc*/ + (traverseproc)WraptFunctionWrapperBase_traverse, /*tp_traverse*/ + (inquiry)WraptFunctionWrapperBase_clear, /*tp_clear*/ + 0, /*tp_richcompare*/ + offsetof(WraptObjectProxyObject, weakreflist), /*tp_weaklistoffset*/ + 0, /*tp_iter*/ + 0, /*tp_iternext*/ + WraptFunctionWrapperBase_methods, /*tp_methods*/ + 0, /*tp_members*/ + WraptFunctionWrapperBase_getset, /*tp_getset*/ + 0, /*tp_base*/ + 0, /*tp_dict*/ + (descrgetfunc)WraptFunctionWrapperBase_descr_get, /*tp_descr_get*/ + 0, /*tp_descr_set*/ + 0, /*tp_dictoffset*/ + (initproc)WraptFunctionWrapperBase_init, /*tp_init*/ + 0, /*tp_alloc*/ + WraptFunctionWrapperBase_new, /*tp_new*/ + 0, /*tp_free*/ + 0, /*tp_is_gc*/ }; /* ------------------------------------------------------------------------- */ -static PyObject * -WraptBoundFunctionWrapper_call(WraptFunctionWrapperObject *self, PyObject *args, - PyObject *kwds) +static PyObject *WraptBoundFunctionWrapper_call( + WraptFunctionWrapperObject *self, PyObject *args, PyObject *kwds) { - PyObject *param_args = NULL; - PyObject *param_kwds = NULL; + PyObject *param_args = NULL; + PyObject *param_kwds = NULL; - PyObject *wrapped = NULL; - PyObject *instance = NULL; + PyObject *wrapped = NULL; + PyObject *instance = NULL; - PyObject *result = NULL; + PyObject *result = NULL; - static PyObject *function_str = NULL; - static PyObject *callable_str = NULL; + static PyObject *function_str = NULL; - if (self->enabled != Py_None) - { - if (PyCallable_Check(self->enabled)) - { - PyObject *object = NULL; + if (self->enabled != Py_None) { + if (PyCallable_Check(self->enabled)) { + PyObject *object = NULL; - object = PyObject_CallFunctionObjArgs(self->enabled, NULL); + object = PyObject_CallFunctionObjArgs(self->enabled, NULL); - if (!object) - return NULL; + if (!object) + return NULL; - if (PyObject_Not(object)) - { - Py_DECREF(object); - return PyObject_Call(self->object_proxy.wrapped, args, kwds); - } - - Py_DECREF(object); - } - else if (PyObject_Not(self->enabled)) - { - return PyObject_Call(self->object_proxy.wrapped, args, kwds); - } - } - - if (!function_str) - { - function_str = PyUnicode_InternFromString("function"); - callable_str = PyUnicode_InternFromString("callable"); - } - - /* - * We need to do things different depending on whether we are likely - * wrapping an instance method vs a static method or class method. - */ - - if (self->binding == function_str || - PyObject_RichCompareBool(self->binding, function_str, Py_EQ) == 1 || - self->binding == callable_str || - PyObject_RichCompareBool(self->binding, callable_str, Py_EQ) == 1) - { - - // if (self->instance == Py_None) { - // /* - // * This situation can occur where someone is calling the - // * instancemethod via the class type and passing the - // * instance as the first argument. We need to shift the args - // * before making the call to the wrapper and effectively - // * bind the instance to the wrapped function using a partial - // * so the wrapper doesn't see anything as being different. - // */ - - // if (PyTuple_Size(args) == 0) { - // PyErr_SetString(PyExc_TypeError, - // "missing 1 required positional argument"); - // return NULL; - // } - - // instance = PyTuple_GetItem(args, 0); - - // if (!instance) - // return NULL; - - // wrapped = PyObject_CallFunctionObjArgs( - // (PyObject *)&WraptPartialCallableObjectProxy_Type, - // self->object_proxy.wrapped, instance, NULL); - - // if (!wrapped) - // return NULL; - - // param_args = PyTuple_GetSlice(args, 1, PyTuple_Size(args)); - - // if (!param_args) { - // Py_DECREF(wrapped); - // return NULL; - // } - - // args = param_args; - // } - - if (self->instance == Py_None && PyTuple_Size(args) != 0) - { - /* - * This situation can occur where someone is calling the - * instancemethod via the class type and passing the - * instance as the first argument. We need to shift the args - * before making the call to the wrapper and effectively - * bind the instance to the wrapped function using a partial - * so the wrapper doesn't see anything as being different. - */ - - instance = PyTuple_GetItem(args, 0); - - if (!instance) - return NULL; + if (PyObject_Not(object)) { + Py_DECREF(object); + return PyObject_Call(self->object_proxy.wrapped, args, kwds); + } - if (PyObject_IsInstance(instance, self->owner) == 1) - { - wrapped = PyObject_CallFunctionObjArgs( - (PyObject *)&WraptPartialCallableObjectProxy_Type, - self->object_proxy.wrapped, instance, NULL); + Py_DECREF(object); + } + else if (PyObject_Not(self->enabled)) { + return PyObject_Call(self->object_proxy.wrapped, args, kwds); + } + } - if (!wrapped) - return NULL; + if (!function_str) { +#if PY_MAJOR_VERSION >= 3 + function_str = PyUnicode_InternFromString("function"); +#else + function_str = PyString_InternFromString("function"); +#endif + } - param_args = PyTuple_GetSlice(args, 1, PyTuple_Size(args)); + /* + * We need to do things different depending on whether we are likely + * wrapping an instance method vs a static method or class method. + */ - if (!param_args) - { - Py_DECREF(wrapped); - return NULL; - } + if (self->binding == function_str || PyObject_RichCompareBool( + self->binding, function_str, Py_EQ) == 1) { - args = param_args; - } - else - { - instance = self->instance; - } - } - else - { - instance = self->instance; - } + if (self->instance == Py_None) { + /* + * This situation can occur where someone is calling the + * instancemethod via the class type and passing the + * instance as the first argument. We need to shift the args + * before making the call to the wrapper and effectively + * bind the instance to the wrapped function using a partial + * so the wrapper doesn't see anything as being different. + */ - if (!wrapped) - { - Py_INCREF(self->object_proxy.wrapped); - wrapped = self->object_proxy.wrapped; - } + if (PyTuple_Size(args) == 0) { + PyErr_SetString(PyExc_TypeError, + "missing 1 required positional argument"); + return NULL; + } - if (!kwds) - { - param_kwds = PyDict_New(); - kwds = param_kwds; - } + instance = PyTuple_GetItem(args, 0); - result = PyObject_CallFunctionObjArgs(self->wrapper, wrapped, instance, - args, kwds, NULL); + if (!instance) + return NULL; - Py_XDECREF(param_args); - Py_XDECREF(param_kwds); - Py_DECREF(wrapped); + wrapped = PyObject_CallFunctionObjArgs( + (PyObject *)&WraptPartialCallableObjectProxy_Type, + self->object_proxy.wrapped, instance, NULL); - return result; - } - else - { - /* - * As in this case we would be dealing with a classmethod or - * staticmethod, then _self_instance will only tell us whether - * when calling the classmethod or staticmethod they did it via - * an instance of the class it is bound to and not the case - * where done by the class type itself. We thus ignore - * _self_instance and use the __self__ attribute of the bound - * function instead. For a classmethod, this means instance will - * be the class type and for a staticmethod it will be None. - * This is probably the more useful thing we can pass through - * even though we loose knowledge of whether they were called on - * the instance vs the class type, as it reflects what they have - * available in the decoratored function. - */ - - instance = PyObject_GetAttrString(self->object_proxy.wrapped, "__self__"); - - if (!instance) - { - PyErr_Clear(); - Py_INCREF(Py_None); - instance = Py_None; - } - - if (!kwds) - { - param_kwds = PyDict_New(); - kwds = param_kwds; - } - - result = PyObject_CallFunctionObjArgs( - self->wrapper, self->object_proxy.wrapped, instance, args, kwds, NULL); + if (!wrapped) + return NULL; - Py_XDECREF(param_kwds); + param_args = PyTuple_GetSlice(args, 1, PyTuple_Size(args)); - Py_DECREF(instance); + if (!param_args) { + Py_DECREF(wrapped); + return NULL; + } - return result; - } + args = param_args; + } + else + instance = self->instance; + + if (!wrapped) { + Py_INCREF(self->object_proxy.wrapped); + wrapped = self->object_proxy.wrapped; + } + + if (!kwds) { + param_kwds = PyDict_New(); + kwds = param_kwds; + } + + result = PyObject_CallFunctionObjArgs(self->wrapper, wrapped, + instance, args, kwds, NULL); + + Py_XDECREF(param_args); + Py_XDECREF(param_kwds); + Py_DECREF(wrapped); + + return result; + } + else { + /* + * As in this case we would be dealing with a classmethod or + * staticmethod, then _self_instance will only tell us whether + * when calling the classmethod or staticmethod they did it via + * an instance of the class it is bound to and not the case + * where done by the class type itself. We thus ignore + * _self_instance and use the __self__ attribute of the bound + * function instead. For a classmethod, this means instance will + * be the class type and for a staticmethod it will be None. + * This is probably the more useful thing we can pass through + * even though we loose knowledge of whether they were called on + * the instance vs the class type, as it reflects what they have + * available in the decoratored function. + */ + + instance = PyObject_GetAttrString(self->object_proxy.wrapped, + "__self__"); + + if (!instance) { + PyErr_Clear(); + Py_INCREF(Py_None); + instance = Py_None; + } + + if (!kwds) { + param_kwds = PyDict_New(); + kwds = param_kwds; + } + + result = PyObject_CallFunctionObjArgs(self->wrapper, + self->object_proxy.wrapped, instance, args, kwds, NULL); + + Py_XDECREF(param_kwds); + + Py_DECREF(instance); + + return result; + } } /* ------------------------------------------------------------------------- */ static PyGetSetDef WraptBoundFunctionWrapper_getset[] = { - {"__module__", (getter)WraptObjectProxy_get_module, - (setter)WraptObjectProxy_set_module, 0}, - {"__doc__", (getter)WraptObjectProxy_get_doc, - (setter)WraptObjectProxy_set_doc, 0}, - {NULL}, + { "__module__", (getter)WraptObjectProxy_get_module, + (setter)WraptObjectProxy_set_module, 0 }, + { "__doc__", (getter)WraptObjectProxy_get_doc, + (setter)WraptObjectProxy_set_doc, 0 }, + { NULL }, }; PyTypeObject WraptBoundFunctionWrapper_Type = { - PyVarObject_HEAD_INIT(NULL, 0) "BoundFunctionWrapper", /*tp_name*/ - sizeof(WraptFunctionWrapperObject), /*tp_basicsize*/ - 0, /*tp_itemsize*/ + PyVarObject_HEAD_INIT(NULL, 0) + "BoundFunctionWrapper", /*tp_name*/ + sizeof(WraptFunctionWrapperObject), /*tp_basicsize*/ + 0, /*tp_itemsize*/ /* methods */ - 0, /*tp_dealloc*/ - 0, /*tp_print*/ - 0, /*tp_getattr*/ - 0, /*tp_setattr*/ - 0, /*tp_compare*/ - 0, /*tp_repr*/ - 0, /*tp_as_number*/ - 0, /*tp_as_sequence*/ - 0, /*tp_as_mapping*/ - 0, /*tp_hash*/ - (ternaryfunc)WraptBoundFunctionWrapper_call, /*tp_call*/ - 0, /*tp_str*/ - 0, /*tp_getattro*/ - 0, /*tp_setattro*/ - 0, /*tp_as_buffer*/ - Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ - 0, /*tp_doc*/ - 0, /*tp_traverse*/ - 0, /*tp_clear*/ - 0, /*tp_richcompare*/ + 0, /*tp_dealloc*/ + 0, /*tp_print*/ + 0, /*tp_getattr*/ + 0, /*tp_setattr*/ + 0, /*tp_compare*/ + 0, /*tp_repr*/ + 0, /*tp_as_number*/ + 0, /*tp_as_sequence*/ + 0, /*tp_as_mapping*/ + 0, /*tp_hash*/ + (ternaryfunc)WraptBoundFunctionWrapper_call, /*tp_call*/ + 0, /*tp_str*/ + 0, /*tp_getattro*/ + 0, /*tp_setattro*/ + 0, /*tp_as_buffer*/ +#if PY_MAJOR_VERSION < 3 + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_CHECKTYPES, /*tp_flags*/ +#else + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ +#endif + 0, /*tp_doc*/ + 0, /*tp_traverse*/ + 0, /*tp_clear*/ + 0, /*tp_richcompare*/ offsetof(WraptObjectProxyObject, weakreflist), /*tp_weaklistoffset*/ - 0, /*tp_iter*/ - 0, /*tp_iternext*/ - 0, /*tp_methods*/ - 0, /*tp_members*/ - WraptBoundFunctionWrapper_getset, /*tp_getset*/ - 0, /*tp_base*/ - 0, /*tp_dict*/ - 0, /*tp_descr_get*/ - 0, /*tp_descr_set*/ - 0, /*tp_dictoffset*/ - 0, /*tp_init*/ - 0, /*tp_alloc*/ - 0, /*tp_new*/ - 0, /*tp_free*/ - 0, /*tp_is_gc*/ + 0, /*tp_iter*/ + 0, /*tp_iternext*/ + 0, /*tp_methods*/ + 0, /*tp_members*/ + WraptBoundFunctionWrapper_getset, /*tp_getset*/ + 0, /*tp_base*/ + 0, /*tp_dict*/ + 0, /*tp_descr_get*/ + 0, /*tp_descr_set*/ + 0, /*tp_dictoffset*/ + 0, /*tp_init*/ + 0, /*tp_alloc*/ + 0, /*tp_new*/ + 0, /*tp_free*/ + 0, /*tp_is_gc*/ }; /* ------------------------------------------------------------------------- */ static int WraptFunctionWrapper_init(WraptFunctionWrapperObject *self, - PyObject *args, PyObject *kwds) + PyObject *args, PyObject *kwds) { - PyObject *wrapped = NULL; - PyObject *wrapper = NULL; - PyObject *enabled = Py_None; - PyObject *binding = NULL; - PyObject *instance = NULL; - - static PyObject *function_str = NULL; - static PyObject *classmethod_str = NULL; - static PyObject *staticmethod_str = NULL; - static PyObject *callable_str = NULL; - static PyObject *builtin_str = NULL; - static PyObject *class_str = NULL; - static PyObject *instancemethod_str = NULL; - - int result = 0; - - char *const kwlist[] = {"wrapped", "wrapper", "enabled", NULL}; - - if (!PyArg_ParseTupleAndKeywords(args, kwds, "OO|O:FunctionWrapper", kwlist, - &wrapped, &wrapper, &enabled)) - { - return -1; - } - - if (!function_str) - { - function_str = PyUnicode_InternFromString("function"); - } - - if (!classmethod_str) - { - classmethod_str = PyUnicode_InternFromString("classmethod"); - } - - if (!staticmethod_str) - { - staticmethod_str = PyUnicode_InternFromString("staticmethod"); - } - - if (!callable_str) - { - callable_str = PyUnicode_InternFromString("callable"); - } - - if (!builtin_str) - { - builtin_str = PyUnicode_InternFromString("builtin"); - } - - if (!class_str) - { - class_str = PyUnicode_InternFromString("class"); - } - - if (!instancemethod_str) - { - instancemethod_str = PyUnicode_InternFromString("instancemethod"); - } - - if (PyObject_IsInstance(wrapped, - (PyObject *)&WraptFunctionWrapperBase_Type)) - { - binding = PyObject_GetAttrString(wrapped, "_self_binding"); - } - - if (!binding) - { - if (PyCFunction_Check(wrapped)) - { - binding = builtin_str; - } - else if (PyObject_IsInstance(wrapped, (PyObject *)&PyFunction_Type)) - { - binding = function_str; - } - else if (PyObject_IsInstance(wrapped, (PyObject *)&PyClassMethod_Type)) - { - binding = classmethod_str; - } - else if (PyObject_IsInstance(wrapped, (PyObject *)&PyType_Type)) - { - binding = class_str; - } - else if (PyObject_IsInstance(wrapped, (PyObject *)&PyStaticMethod_Type)) - { - binding = staticmethod_str; - } - else if ((instance = PyObject_GetAttrString(wrapped, "__self__")) != 0) - { - if (PyObject_IsInstance(instance, (PyObject *)&PyType_Type)) - { + PyObject *wrapped = NULL; + PyObject *wrapper = NULL; + PyObject *enabled = Py_None; + PyObject *binding = NULL; + PyObject *instance = NULL; + + static PyObject *classmethod_str = NULL; + static PyObject *staticmethod_str = NULL; + static PyObject *function_str = NULL; + + int result = 0; + + static char *kwlist[] = { "wrapped", "wrapper", "enabled", NULL }; + + if (!PyArg_ParseTupleAndKeywords(args, kwds, "OO|O:FunctionWrapper", + kwlist, &wrapped, &wrapper, &enabled)) { + return -1; + } + + if (!classmethod_str) { +#if PY_MAJOR_VERSION >= 3 + classmethod_str = PyUnicode_InternFromString("classmethod"); +#else + classmethod_str = PyString_InternFromString("classmethod"); +#endif + } + + if (!staticmethod_str) { +#if PY_MAJOR_VERSION >= 3 + staticmethod_str = PyUnicode_InternFromString("staticmethod"); +#else + staticmethod_str = PyString_InternFromString("staticmethod"); +#endif + } + + if (!function_str) { +#if PY_MAJOR_VERSION >= 3 + function_str = PyUnicode_InternFromString("function"); +#else + function_str = PyString_InternFromString("function"); +#endif + } + + if (PyObject_IsInstance(wrapped, (PyObject *)&PyClassMethod_Type)) { binding = classmethod_str; - } - else if (PyObject_IsInstance(wrapped, (PyObject *)&PyMethod_Type)) - { - binding = instancemethod_str; - } - else - binding = callable_str; + } + else if (PyObject_IsInstance(wrapped, (PyObject *)&PyStaticMethod_Type)) { + binding = staticmethod_str; + } + else if ((instance = PyObject_GetAttrString(wrapped, "__self__")) != 0) { +#if PY_MAJOR_VERSION < 3 + if (PyObject_IsInstance(instance, (PyObject *)&PyClass_Type) || + PyObject_IsInstance(instance, (PyObject *)&PyType_Type)) { + binding = classmethod_str; + } +#else + if (PyObject_IsInstance(instance, (PyObject *)&PyType_Type)) { + binding = classmethod_str; + } +#endif + else + binding = function_str; - Py_DECREF(instance); + Py_DECREF(instance); } - else - { - PyErr_Clear(); + else { + PyErr_Clear(); - binding = callable_str; + binding = function_str; } - } - result = WraptFunctionWrapperBase_raw_init( - self, wrapped, Py_None, wrapper, enabled, binding, Py_None, Py_None); + result = WraptFunctionWrapperBase_raw_init(self, wrapped, Py_None, + wrapper, enabled, binding, Py_None); - return result; + return result; } /* ------------------------------------------------------------------------- */ static PyGetSetDef WraptFunctionWrapper_getset[] = { - {"__module__", (getter)WraptObjectProxy_get_module, - (setter)WraptObjectProxy_set_module, 0}, - {"__doc__", (getter)WraptObjectProxy_get_doc, - (setter)WraptObjectProxy_set_doc, 0}, - {NULL}, + { "__module__", (getter)WraptObjectProxy_get_module, + (setter)WraptObjectProxy_set_module, 0 }, + { "__doc__", (getter)WraptObjectProxy_get_doc, + (setter)WraptObjectProxy_set_doc, 0 }, + { NULL }, }; PyTypeObject WraptFunctionWrapper_Type = { - PyVarObject_HEAD_INIT(NULL, 0) "FunctionWrapper", /*tp_name*/ - sizeof(WraptFunctionWrapperObject), /*tp_basicsize*/ - 0, /*tp_itemsize*/ + PyVarObject_HEAD_INIT(NULL, 0) + "FunctionWrapper", /*tp_name*/ + sizeof(WraptFunctionWrapperObject), /*tp_basicsize*/ + 0, /*tp_itemsize*/ /* methods */ - 0, /*tp_dealloc*/ - 0, /*tp_print*/ - 0, /*tp_getattr*/ - 0, /*tp_setattr*/ - 0, /*tp_compare*/ - 0, /*tp_repr*/ - 0, /*tp_as_number*/ - 0, /*tp_as_sequence*/ - 0, /*tp_as_mapping*/ - 0, /*tp_hash*/ - 0, /*tp_call*/ - 0, /*tp_str*/ - 0, /*tp_getattro*/ - 0, /*tp_setattro*/ - 0, /*tp_as_buffer*/ - Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ - 0, /*tp_doc*/ - 0, /*tp_traverse*/ - 0, /*tp_clear*/ - 0, /*tp_richcompare*/ + 0, /*tp_dealloc*/ + 0, /*tp_print*/ + 0, /*tp_getattr*/ + 0, /*tp_setattr*/ + 0, /*tp_compare*/ + 0, /*tp_repr*/ + 0, /*tp_as_number*/ + 0, /*tp_as_sequence*/ + 0, /*tp_as_mapping*/ + 0, /*tp_hash*/ + 0, /*tp_call*/ + 0, /*tp_str*/ + 0, /*tp_getattro*/ + 0, /*tp_setattro*/ + 0, /*tp_as_buffer*/ +#if PY_MAJOR_VERSION < 3 + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_CHECKTYPES, /*tp_flags*/ +#else + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /*tp_flags*/ +#endif + 0, /*tp_doc*/ + 0, /*tp_traverse*/ + 0, /*tp_clear*/ + 0, /*tp_richcompare*/ offsetof(WraptObjectProxyObject, weakreflist), /*tp_weaklistoffset*/ - 0, /*tp_iter*/ - 0, /*tp_iternext*/ - 0, /*tp_methods*/ - 0, /*tp_members*/ - WraptFunctionWrapper_getset, /*tp_getset*/ - 0, /*tp_base*/ - 0, /*tp_dict*/ - 0, /*tp_descr_get*/ - 0, /*tp_descr_set*/ - 0, /*tp_dictoffset*/ - (initproc)WraptFunctionWrapper_init, /*tp_init*/ - 0, /*tp_alloc*/ - 0, /*tp_new*/ - 0, /*tp_free*/ - 0, /*tp_is_gc*/ + 0, /*tp_iter*/ + 0, /*tp_iternext*/ + 0, /*tp_methods*/ + 0, /*tp_members*/ + WraptFunctionWrapper_getset, /*tp_getset*/ + 0, /*tp_base*/ + 0, /*tp_dict*/ + 0, /*tp_descr_get*/ + 0, /*tp_descr_set*/ + 0, /*tp_dictoffset*/ + (initproc)WraptFunctionWrapper_init, /*tp_init*/ + 0, /*tp_alloc*/ + 0, /*tp_new*/ + 0, /*tp_free*/ + 0, /*tp_is_gc*/ }; /* ------------------------------------------------------------------------- */ +#if PY_MAJOR_VERSION >= 3 static struct PyModuleDef moduledef = { PyModuleDef_HEAD_INIT, - "_wrappers", /* m_name */ - NULL, /* m_doc */ - -1, /* m_size */ - NULL, /* m_methods */ - NULL, /* m_reload */ - NULL, /* m_traverse */ - NULL, /* m_clear */ - NULL, /* m_free */ + "_wrappers", /* m_name */ + NULL, /* m_doc */ + -1, /* m_size */ + NULL, /* m_methods */ + NULL, /* m_reload */ + NULL, /* m_traverse */ + NULL, /* m_clear */ + NULL, /* m_free */ }; +#endif -static PyObject *moduleinit(void) +static PyObject * +moduleinit(void) { - PyObject *module; + PyObject *module; - module = PyModule_Create(&moduledef); +#if PY_MAJOR_VERSION >= 3 + module = PyModule_Create(&moduledef); +#else + module = Py_InitModule3("_wrappers", NULL, NULL); +#endif - if (module == NULL) - return NULL; + if (module == NULL) + return NULL; - if (PyType_Ready(&WraptObjectProxy_Type) < 0) - return NULL; + if (PyType_Ready(&WraptObjectProxy_Type) < 0) + return NULL; - /* Ensure that inheritance relationships specified. */ + /* Ensure that inheritance relationships specified. */ - WraptCallableObjectProxy_Type.tp_base = &WraptObjectProxy_Type; - WraptPartialCallableObjectProxy_Type.tp_base = &WraptObjectProxy_Type; - WraptFunctionWrapperBase_Type.tp_base = &WraptObjectProxy_Type; - WraptBoundFunctionWrapper_Type.tp_base = &WraptFunctionWrapperBase_Type; - WraptFunctionWrapper_Type.tp_base = &WraptFunctionWrapperBase_Type; + WraptCallableObjectProxy_Type.tp_base = &WraptObjectProxy_Type; + WraptPartialCallableObjectProxy_Type.tp_base = &WraptObjectProxy_Type; + WraptFunctionWrapperBase_Type.tp_base = &WraptObjectProxy_Type; + WraptBoundFunctionWrapper_Type.tp_base = &WraptFunctionWrapperBase_Type; + WraptFunctionWrapper_Type.tp_base = &WraptFunctionWrapperBase_Type; - if (PyType_Ready(&WraptCallableObjectProxy_Type) < 0) - return NULL; - if (PyType_Ready(&WraptPartialCallableObjectProxy_Type) < 0) - return NULL; - if (PyType_Ready(&WraptFunctionWrapperBase_Type) < 0) - return NULL; - if (PyType_Ready(&WraptBoundFunctionWrapper_Type) < 0) - return NULL; - if (PyType_Ready(&WraptFunctionWrapper_Type) < 0) - return NULL; + if (PyType_Ready(&WraptCallableObjectProxy_Type) < 0) + return NULL; + if (PyType_Ready(&WraptPartialCallableObjectProxy_Type) < 0) + return NULL; + if (PyType_Ready(&WraptFunctionWrapperBase_Type) < 0) + return NULL; + if (PyType_Ready(&WraptBoundFunctionWrapper_Type) < 0) + return NULL; + if (PyType_Ready(&WraptFunctionWrapper_Type) < 0) + return NULL; - Py_INCREF(&WraptObjectProxy_Type); - PyModule_AddObject(module, "ObjectProxy", (PyObject *)&WraptObjectProxy_Type); - Py_INCREF(&WraptCallableObjectProxy_Type); - PyModule_AddObject(module, "CallableObjectProxy", - (PyObject *)&WraptCallableObjectProxy_Type); - Py_INCREF(&WraptPartialCallableObjectProxy_Type); - PyModule_AddObject(module, "PartialCallableObjectProxy", - (PyObject *)&WraptPartialCallableObjectProxy_Type); - Py_INCREF(&WraptFunctionWrapper_Type); - PyModule_AddObject(module, "FunctionWrapper", - (PyObject *)&WraptFunctionWrapper_Type); - - Py_INCREF(&WraptFunctionWrapperBase_Type); - PyModule_AddObject(module, "_FunctionWrapperBase", - (PyObject *)&WraptFunctionWrapperBase_Type); - Py_INCREF(&WraptBoundFunctionWrapper_Type); - PyModule_AddObject(module, "BoundFunctionWrapper", - (PyObject *)&WraptBoundFunctionWrapper_Type); - -#ifdef Py_GIL_DISABLED - PyUnstable_Module_SetGIL(module, Py_MOD_GIL_NOT_USED); -#endif + Py_INCREF(&WraptObjectProxy_Type); + PyModule_AddObject(module, "ObjectProxy", + (PyObject *)&WraptObjectProxy_Type); + Py_INCREF(&WraptCallableObjectProxy_Type); + PyModule_AddObject(module, "CallableObjectProxy", + (PyObject *)&WraptCallableObjectProxy_Type); + PyModule_AddObject(module, "PartialCallableObjectProxy", + (PyObject *)&WraptPartialCallableObjectProxy_Type); + Py_INCREF(&WraptFunctionWrapper_Type); + PyModule_AddObject(module, "FunctionWrapper", + (PyObject *)&WraptFunctionWrapper_Type); - return module; + Py_INCREF(&WraptFunctionWrapperBase_Type); + PyModule_AddObject(module, "_FunctionWrapperBase", + (PyObject *)&WraptFunctionWrapperBase_Type); + Py_INCREF(&WraptBoundFunctionWrapper_Type); + PyModule_AddObject(module, "BoundFunctionWrapper", + (PyObject *)&WraptBoundFunctionWrapper_Type); + + return module; } -PyMODINIT_FUNC PyInit__wrappers(void) { return moduleinit(); } +#if PY_MAJOR_VERSION < 3 +PyMODINIT_FUNC init_wrappers(void) +{ + moduleinit(); +} +#else +PyMODINIT_FUNC PyInit__wrappers(void) +{ + return moduleinit(); +} +#endif /* ------------------------------------------------------------------------- */ diff --git a/newrelic/packages/wrapt/arguments.py b/newrelic/packages/wrapt/arguments.py index 554f62cd28..032bc059e0 100644 --- a/newrelic/packages/wrapt/arguments.py +++ b/newrelic/packages/wrapt/arguments.py @@ -1,35 +1,16 @@ -"""The inspect.formatargspec() function was dropped in Python 3.11 but we need -it for when constructing signature changing decorators based on result of -inspect.getfullargspec(). The code here implements inspect.formatargspec() based -on Parameter and Signature from inspect module, which were added in Python 3.6. -Thanks to Cyril Jouve for the implementation. -""" - -from typing import Any, Callable, List, Mapping, Optional, Sequence, Tuple +# The inspect.formatargspec() function was dropped in Python 3.11 but we need +# need it for when constructing signature changing decorators based on result of +# inspect.getargspec() or inspect.getfullargspec(). The code here implements +# inspect.formatargspec() base on Parameter and Signature from inspect module, +# which were added in Python 3.6. Thanks to Cyril Jouve for the implementation. try: from inspect import Parameter, Signature except ImportError: - from inspect import formatargspec # type: ignore[attr-defined] + from inspect import formatargspec else: - - def formatargspec( - args: List[str], - varargs: Optional[str] = None, - varkw: Optional[str] = None, - defaults: Optional[Tuple[Any, ...]] = None, - kwonlyargs: Optional[Sequence[str]] = None, - kwonlydefaults: Optional[Mapping[str, Any]] = None, - annotations: Mapping[str, Any] = {}, - formatarg: Callable[[str], str] = str, - formatvarargs: Callable[[str], str] = lambda name: "*" + name, - formatvarkw: Callable[[str], str] = lambda name: "**" + name, - formatvalue: Callable[[Any], str] = lambda value: "=" + repr(value), - formatreturns: Callable[[Any], str] = lambda text: " -> " + text, - formatannotation: Callable[[Any], str] = lambda annot: " -> " + repr(annot), - ) -> str: - if kwonlyargs is None: - kwonlyargs = () + def formatargspec(args, varargs=None, varkw=None, defaults=None, + kwonlyargs=(), kwonlydefaults={}, annotations={}): if kwonlydefaults is None: kwonlydefaults = {} ndefaults = len(defaults) if defaults else 0 @@ -37,10 +18,9 @@ def formatargspec( Parameter( arg, Parameter.POSITIONAL_OR_KEYWORD, - default=defaults[i] if defaults and i >= 0 else Parameter.empty, + default=defaults[i] if i >= 0 else Parameter.empty, annotation=annotations.get(arg, Parameter.empty), - ) - for i, arg in enumerate(args, ndefaults - len(args)) + ) for i, arg in enumerate(args, ndefaults - len(args)) ] if varargs: parameters.append(Parameter(varargs, Parameter.VAR_POSITIONAL)) @@ -50,10 +30,9 @@ def formatargspec( Parameter.KEYWORD_ONLY, default=kwonlydefaults.get(kwonlyarg, Parameter.empty), annotation=annotations.get(kwonlyarg, Parameter.empty), - ) - for kwonlyarg in kwonlyargs + ) for kwonlyarg in kwonlyargs ) if varkw: parameters.append(Parameter(varkw, Parameter.VAR_KEYWORD)) - return_annotation = annotations.get("return", Signature.empty) - return str(Signature(parameters, return_annotation=return_annotation)) + return_annotation = annotations.get('return', Signature.empty) + return str(Signature(parameters, return_annotation=return_annotation)) \ No newline at end of file diff --git a/newrelic/packages/wrapt/decorators.py b/newrelic/packages/wrapt/decorators.py index 6f5cedd2a4..c80a4bb72e 100644 --- a/newrelic/packages/wrapt/decorators.py +++ b/newrelic/packages/wrapt/decorators.py @@ -4,18 +4,51 @@ """ import sys + +PY2 = sys.version_info[0] == 2 + +if PY2: + string_types = basestring, + + def exec_(_code_, _globs_=None, _locs_=None): + """Execute code in a namespace.""" + if _globs_ is None: + frame = sys._getframe(1) + _globs_ = frame.f_globals + if _locs_ is None: + _locs_ = frame.f_locals + del frame + elif _locs_ is None: + _locs_ = _globs_ + exec("""exec _code_ in _globs_, _locs_""") + +else: + string_types = str, + + import builtins + + exec_ = getattr(builtins, "exec") + del builtins + from functools import partial -from inspect import isclass, signature +from inspect import isclass from threading import Lock, RLock -from .__wrapt__ import BoundFunctionWrapper, CallableObjectProxy, FunctionWrapper from .arguments import formatargspec +try: + from inspect import signature +except ImportError: + pass + +from .__wrapt__ import (FunctionWrapper, BoundFunctionWrapper, ObjectProxy, + CallableObjectProxy) + # Adapter wrapper for the wrapped function which will overlay certain # properties from the adapter function onto the wrapped function so that -# functions such as inspect.getfullargspec(), inspect.signature() and -# inspect.getsource() return the correct results one would expect. - +# functions such as inspect.getargspec(), inspect.getfullargspec(), +# inspect.signature() and inspect.getsource() return the correct results +# one would expect. class _AdapterFunctionCode(CallableObjectProxy): @@ -43,7 +76,6 @@ def co_kwonlyargcount(self): def co_varnames(self): return self._self_adapter_code.co_varnames - class _AdapterFunctionSurrogate(CallableObjectProxy): def __init__(self, wrapped, adapter): @@ -52,9 +84,8 @@ def __init__(self, wrapped, adapter): @property def __code__(self): - return _AdapterFunctionCode( - self.__wrapped__.__code__, self._self_adapter.__code__ - ) + return _AdapterFunctionCode(self.__wrapped__.__code__, + self._self_adapter.__code__) @property def __defaults__(self): @@ -66,36 +97,41 @@ def __kwdefaults__(self): @property def __signature__(self): - if "signature" not in globals(): + if 'signature' not in globals(): return self._self_adapter.__signature__ else: return signature(self._self_adapter) + if PY2: + func_code = __code__ + func_defaults = __defaults__ class _BoundAdapterWrapper(BoundFunctionWrapper): @property def __func__(self): - return _AdapterFunctionSurrogate( - self.__wrapped__.__func__, self._self_parent._self_adapter - ) + return _AdapterFunctionSurrogate(self.__wrapped__.__func__, + self._self_parent._self_adapter) @property def __signature__(self): - if "signature" not in globals(): + if 'signature' not in globals(): return self.__wrapped__.__signature__ else: return signature(self._self_parent._self_adapter) + if PY2: + im_func = __func__ class AdapterWrapper(FunctionWrapper): __bound_function_wrapper__ = _BoundAdapterWrapper def __init__(self, *args, **kwargs): - adapter = kwargs.pop("adapter") + adapter = kwargs.pop('adapter') super(AdapterWrapper, self).__init__(*args, **kwargs) - self._self_surrogate = _AdapterFunctionSurrogate(self.__wrapped__, adapter) + self._self_surrogate = _AdapterFunctionSurrogate( + self.__wrapped__, adapter) self._self_adapter = adapter @property @@ -110,25 +146,25 @@ def __defaults__(self): def __kwdefaults__(self): return self._self_surrogate.__kwdefaults__ + if PY2: + func_code = __code__ + func_defaults = __defaults__ + @property def __signature__(self): return self._self_surrogate.__signature__ - -class AdapterFactory: +class AdapterFactory(object): def __call__(self, wrapped): raise NotImplementedError() - class DelegatedAdapterFactory(AdapterFactory): def __init__(self, factory): super(DelegatedAdapterFactory, self).__init__() self.factory = factory - def __call__(self, wrapped): return self.factory(wrapped) - adapter_factory = DelegatedAdapterFactory # Decorator for creating other decorators. This decorator and the @@ -138,32 +174,29 @@ def __call__(self, wrapped): # function so the wrapper is effectively indistinguishable from the # original wrapped function. - -def decorator(wrapper=None, /, *, enabled=None, adapter=None, proxy=FunctionWrapper): - """ - The decorator should be supplied with a single positional argument - which is the `wrapper` function to be used to implement the - decorator. This may be preceded by a step whereby the keyword - arguments are supplied to customise the behaviour of the - decorator. The `adapter` argument is used to optionally denote a - separate function which is notionally used by an adapter - decorator. In that case parts of the function `__code__` and - `__defaults__` attributes are used from the adapter function - rather than those of the wrapped function. This allows for the - argument specification from `inspect.getfullargspec()` and similar - functions to be overridden with a prototype for a different - function than what was wrapped. The `enabled` argument provides a - way to enable/disable the use of the decorator. If the type of - `enabled` is a boolean, then it is evaluated immediately and the - wrapper not even applied if it is `False`. If not a boolean, it will - be evaluated when the wrapper is called for an unbound wrapper, - and when binding occurs for a bound wrapper. When being evaluated, - if `enabled` is callable it will be called to obtain the value to - be checked. If `False`, the wrapper will not be called and instead - the original wrapped function will be called directly instead. - The `proxy` argument provides a way of passing a custom version of - the `FunctionWrapper` class used in decorating the function. - """ +def decorator(wrapper=None, enabled=None, adapter=None, proxy=FunctionWrapper): + # The decorator should be supplied with a single positional argument + # which is the wrapper function to be used to implement the + # decorator. This may be preceded by a step whereby the keyword + # arguments are supplied to customise the behaviour of the + # decorator. The 'adapter' argument is used to optionally denote a + # separate function which is notionally used by an adapter + # decorator. In that case parts of the function '__code__' and + # '__defaults__' attributes are used from the adapter function + # rather than those of the wrapped function. This allows for the + # argument specification from inspect.getfullargspec() and similar + # functions to be overridden with a prototype for a different + # function than what was wrapped. The 'enabled' argument provides a + # way to enable/disable the use of the decorator. If the type of + # 'enabled' is a boolean, then it is evaluated immediately and the + # wrapper not even applied if it is False. If not a boolean, it will + # be evaluated when the wrapper is called for an unbound wrapper, + # and when binding occurs for a bound wrapper. When being evaluated, + # if 'enabled' is callable it will be called to obtain the value to + # be checked. If False, the wrapper will not be called and instead + # the original wrapped function will be called directly instead. + # The 'proxy' argument provides a way of passing a custom version of + # the FunctionWrapper class used in decorating the function. if wrapper is not None: # Helper function for creating wrapper of the appropriate @@ -187,14 +220,14 @@ def _build(wrapped, wrapper, enabled=None, adapter=None): annotations = {} - if not isinstance(adapter, str): + if not isinstance(adapter, string_types): if len(adapter) == 7: annotations = adapter[-1] adapter = adapter[:-1] adapter = formatargspec(*adapter) - exec(f"def adapter{adapter}: pass", ns, ns) - adapter = ns["adapter"] + exec_('def adapter{}: pass'.format(adapter), ns, ns) + adapter = ns['adapter'] # Override the annotations for the manufactured # adapter function so they match the original @@ -203,9 +236,8 @@ def _build(wrapped, wrapper, enabled=None, adapter=None): if annotations: adapter.__annotations__ = annotations - return AdapterWrapper( - wrapped=wrapped, wrapper=wrapper, enabled=enabled, adapter=adapter - ) + return AdapterWrapper(wrapped=wrapped, wrapper=wrapper, + enabled=enabled, adapter=adapter) return proxy(wrapped=wrapped, wrapper=wrapper, enabled=enabled) @@ -221,7 +253,7 @@ def _wrapper(wrapped, instance, args, kwargs): # to a class type. # # @decorator - # class mydecoratorclass: + # class mydecoratorclass(object): # def __init__(self, arg=None): # self.arg = arg # def __call__(self, wrapped, instance, args, kwargs): @@ -265,7 +297,8 @@ def _capture(target_wrapped): # Finally build the wrapper itself and return it. - return _build(target_wrapped, target_wrapper, _enabled, adapter) + return _build(target_wrapped, target_wrapper, + _enabled, adapter) return _capture @@ -295,7 +328,7 @@ def _capture(target_wrapped): # as the decorator wrapper function. # # @decorator - # class mydecoratorclass: + # class mydecoratorclass(object): # def __init__(self, arg=None): # self.arg = arg # def __call__(self, wrapped, instance, @@ -335,7 +368,7 @@ def _capture(target_wrapped): # In this case the decorator was applied to a class # method. # - # class myclass: + # class myclass(object): # @decorator # @classmethod # def decoratorclassmethod(cls, wrapped, @@ -360,7 +393,7 @@ def _capture(target_wrapped): # In this case the decorator was applied to an instance # method. # - # class myclass: + # class myclass(object): # @decorator # def decoratorclassmethod(self, wrapped, # instance, args, kwargs): @@ -399,8 +432,8 @@ def _capture(target_wrapped): # decorator again wrapped in a partial using the collected # arguments. - return partial(decorator, enabled=enabled, adapter=adapter, proxy=proxy) - + return partial(decorator, enabled=enabled, adapter=adapter, + proxy=proxy) # Decorator for implementing thread synchronization. It can be used as a # decorator, in which case the synchronization context is determined by @@ -412,27 +445,14 @@ def _capture(target_wrapped): # synchronization primitive without creating a separate lock against the # derived or supplied context. - def synchronized(wrapped): - """Depending on the nature of the `wrapped` object, will either return a - decorator which can be used to wrap a function or method, or a context - manager, both of which will act accordingly depending on how used, to - synchronize access to calling of the wrapped function, or the block of - code within the context manager. If it is an object which is a - synchronization primitive, such as a threading Lock, RLock, Semaphore, - Condition, or Event, then it is assumed that the object is to be used - directly as the synchronization primitive, otherwise a lock is created - automatically and attached to the wrapped object and used as the - synchronization primitive. - """ - # Determine if being passed an object which is a synchronization # primitive. We can't check by type for Lock, RLock, Semaphore etc, # as the means of creating them isn't the type. Therefore use the # existence of acquire() and release() methods. This is more # extensible anyway as it allows custom synchronization mechanisms. - if hasattr(wrapped, "acquire") and hasattr(wrapped, "release"): + if hasattr(wrapped, 'acquire') and hasattr(wrapped, 'release'): # We remember what the original lock is and then return a new # decorator which accesses and locks it. When returning the new # decorator we wrap it with an object proxy so we can override @@ -469,7 +489,7 @@ def __exit__(self, *args): def _synchronized_lock(context): # Attempt to retrieve the lock for the specific context. - lock = vars(context).get("_synchronized_lock", None) + lock = vars(context).get('_synchronized_lock', None) if lock is None: # There is no existing lock defined for the context we @@ -490,11 +510,11 @@ def _synchronized_lock(context): # at the same time and were competing to create the # meta lock. - lock = vars(context).get("_synchronized_lock", None) + lock = vars(context).get('_synchronized_lock', None) if lock is None: lock = RLock() - setattr(context, "_synchronized_lock", lock) + setattr(context, '_synchronized_lock', lock) return lock @@ -518,5 +538,4 @@ def __exit__(self, *args): return _FinalDecorator(wrapped=wrapped, wrapper=_synchronized_wrapper) - -synchronized._synchronized_meta_lock = Lock() # type: ignore[attr-defined] +synchronized._synchronized_meta_lock = Lock() diff --git a/newrelic/packages/wrapt/importer.py b/newrelic/packages/wrapt/importer.py index a1e0cb7c59..23fcbd2f63 100644 --- a/newrelic/packages/wrapt/importer.py +++ b/newrelic/packages/wrapt/importer.py @@ -3,13 +3,19 @@ """ -import importlib.metadata import sys import threading -from importlib.util import find_spec -from typing import Callable, Dict, List -from .__wrapt__ import BaseObjectProxy +PY2 = sys.version_info[0] == 2 + +if PY2: + string_types = basestring, + find_spec = None +else: + string_types = str, + from importlib.util import find_spec + +from .__wrapt__ import ObjectProxy # The dictionary registering any post import hooks to be triggered once # the target module has been imported. Once a module has been imported @@ -17,7 +23,7 @@ # module will be truncated but the list left in the dictionary. This # acts as a flag to indicate that the module had already been imported. -_post_import_hooks: Dict[str, List[Callable]] = {} +_post_import_hooks = {} _post_import_hooks_init = False _post_import_hooks_lock = threading.RLock() @@ -28,36 +34,22 @@ # proxy callback being registered which will defer loading of the # specified module containing the callback function until required. - def _create_import_hook_from_string(name): def import_hook(module): - module_name, function = name.split(":") - attrs = function.split(".") + module_name, function = name.split(':') + attrs = function.split('.') __import__(module_name) callback = sys.modules[module_name] for attr in attrs: callback = getattr(callback, attr) return callback(module) - return import_hook - def register_post_import_hook(hook, name): - """ - Register a post import hook for the target module `name`. The `hook` - function will be called once the module is imported and will be passed the - module as argument. If the module is already imported, the `hook` will be - called immediately. If you also want to defer loading of the module containing - the `hook` function until required, you can specify the `hook` as a string in - the form 'module:function'. This will result in a proxy hook function being - registered which will defer loading of the specified module containing the - callback function until required. - """ - # Create a deferred import hook if hook is a string name rather than # a callable function. - if isinstance(hook, str): + if isinstance(hook, string_types): hook = _create_import_hook_from_string(hook) with _post_import_hooks_lock: @@ -86,59 +78,34 @@ def register_post_import_hook(hook, name): if module is not None: hook(module) - # Register post import hooks defined as package entry points. - def _create_import_hook_from_entrypoint(entrypoint): def import_hook(module): - entrypoint_value = entrypoint.value.split(":") - module_name = entrypoint_value[0] - __import__(module_name) - callback = sys.modules[module_name] - - if len(entrypoint_value) > 1: - attrs = entrypoint_value[1].split(".") - for attr in attrs: - callback = getattr(callback, attr) + __import__(entrypoint.module_name) + callback = sys.modules[entrypoint.module_name] + for attr in entrypoint.attrs: + callback = getattr(callback, attr) return callback(module) - return import_hook - def discover_post_import_hooks(group): - """ - Discover and register post import hooks defined as package entry points - in the specified `group`. The group should be a string that matches the - entry point group name used in the package metadata. - """ - try: - # Python 3.10+ style with select parameter - entrypoints = importlib.metadata.entry_points(group=group) - except TypeError: - # Python 3.8-3.9 style that returns a dict - entrypoints = importlib.metadata.entry_points().get(group, ()) - - for entrypoint in entrypoints: - callback = entrypoint.load() # Use the loaded callback directly - register_post_import_hook(callback, entrypoint.name) + import pkg_resources + except ImportError: + return + for entrypoint in pkg_resources.iter_entry_points(group=group): + callback = _create_import_hook_from_entrypoint(entrypoint) + register_post_import_hook(callback, entrypoint.name) # Indicate that a module has been loaded. Any post import hooks which # were registered against the target module will be invoked. If an # exception is raised in any of the post import hooks, that will cause # the import of the target module to fail. - def notify_module_loaded(module): - """ - Notify that a `module` has been loaded and invoke any post import hooks - registered against the module. If the module is not registered, this - function does nothing. - """ - - name = getattr(module, "__name__", None) + name = getattr(module, '__name__', None) with _post_import_hooks_lock: hooks = _post_import_hooks.pop(name, ()) @@ -150,13 +117,11 @@ def notify_module_loaded(module): for hook in hooks: hook(module) - # A custom module import finder. This intercepts attempts to import # modules and watches out for attempts to import target modules of # interest. When a module of interest is imported, then any post import # hooks which are registered will be invoked. - class _ImportHookLoader: def load_module(self, fullname): @@ -165,18 +130,17 @@ def load_module(self, fullname): return module - -class _ImportHookChainedLoader(BaseObjectProxy): +class _ImportHookChainedLoader(ObjectProxy): def __init__(self, loader): super(_ImportHookChainedLoader, self).__init__(loader) if hasattr(loader, "load_module"): - self.__self_setattr__("load_module", self._self_load_module) + self.__self_setattr__('load_module', self._self_load_module) if hasattr(loader, "create_module"): - self.__self_setattr__("create_module", self._self_create_module) + self.__self_setattr__('create_module', self._self_create_module) if hasattr(loader, "exec_module"): - self.__self_setattr__("exec_module", self._self_exec_module) + self.__self_setattr__('exec_module', self._self_exec_module) def _self_set_loader(self, module): # Set module's loader to self.__wrapped__ unless it's already set to @@ -184,14 +148,13 @@ def _self_set_loader(self, module): # None, so handle None as well. The module may not support attribute # assignment, in which case we simply skip it. Note that we also deal # with __loader__ not existing at all. This is to future proof things - # due to proposal to remove the attribute as described in the GitHub + # due to proposal to remove the attribue as described in the GitHub # issue at https://github.com/python/cpython/issues/77458. Also prior # to Python 3.3, the __loader__ attribute was only set if a custom # module loader was used. It isn't clear whether the attribute still # existed in that case or was set to None. - class UNDEFINED: - pass + class UNDEFINED: pass if getattr(module, "__loader__", UNDEFINED) in (None, self): try: @@ -199,10 +162,8 @@ class UNDEFINED: except AttributeError: pass - if ( - getattr(module, "__spec__", None) is not None - and getattr(module.__spec__, "loader", None) is self - ): + if (getattr(module, "__spec__", None) is not None + and getattr(module.__spec__, "loader", None) is self): module.__spec__.loader = self.__wrapped__ def _self_load_module(self, fullname): @@ -223,7 +184,6 @@ def _self_exec_module(self, module): self.__wrapped__.exec_module(module) notify_module_loaded(module) - class ImportHookFinder: def __init__(self): @@ -253,18 +213,32 @@ def find_module(self, fullname, path=None): # Now call back into the import system again. try: - # For Python 3 we need to use find_spec().loader - # from the importlib.util module. It doesn't actually - # import the target module and only finds the - # loader. If a loader is found, we need to return - # our own loader which will then in turn call the - # real loader to import the module and invoke the - # post import hooks. + if not find_spec: + # For Python 2 we don't have much choice but to + # call back in to __import__(). This will + # actually cause the module to be imported. If no + # module could be found then ImportError will be + # raised. Otherwise we return a loader which + # returns the already loaded module and invokes + # the post import hooks. - loader = getattr(find_spec(fullname), "loader", None) + __import__(fullname) - if loader and not isinstance(loader, _ImportHookChainedLoader): - return _ImportHookChainedLoader(loader) + return _ImportHookLoader() + + else: + # For Python 3 we need to use find_spec().loader + # from the importlib.util module. It doesn't actually + # import the target module and only finds the + # loader. If a loader is found, we need to return + # our own loader which will then in turn call the + # real loader to import the module and invoke the + # post import hooks. + + loader = getattr(find_spec(fullname), "loader", None) + + if loader and not isinstance(loader, _ImportHookChainedLoader): + return _ImportHookChainedLoader(loader) finally: del self.in_progress[fullname] @@ -311,22 +285,11 @@ def find_spec(self, fullname, path=None, target=None): finally: del self.in_progress[fullname] - # Decorator for marking that a function should be called as a post # import hook when the target module is imported. - def when_imported(name): - """ - Returns a decorator that registers the decorated function as a post import - hook for the module specified by `name`. The function will be called once - the module with the specified name is imported, and will be passed the - module as argument. If the module is already imported, the function will - be called immediately. - """ - def register(hook): register_post_import_hook(hook, name) return hook - return register diff --git a/newrelic/packages/wrapt/patches.py b/newrelic/packages/wrapt/patches.py index f5f1fc3ca9..e22adf7ca8 100644 --- a/newrelic/packages/wrapt/patches.py +++ b/newrelic/packages/wrapt/patches.py @@ -1,29 +1,25 @@ import inspect import sys -from .__wrapt__ import FunctionWrapper +PY2 = sys.version_info[0] == 2 -# Helper functions for applying wrappers to existing functions. +if PY2: + string_types = basestring, +else: + string_types = str, +from .__wrapt__ import FunctionWrapper -def resolve_path(target, name): - """ - Resolves the dotted path supplied as `name` to an attribute on a target - object. The `target` can be a module, class, or instance of a class. If the - `target` argument is a string, it is assumed to be the name of a module, - which will be imported if necessary and then used as the target object. - Returns a tuple containing the parent object holding the attribute lookup - resolved to, the attribute name (path prefix removed if present), and the - original attribute value. - """ +# Helper functions for applying wrappers to existing functions. - if isinstance(target, str): - __import__(target) - target = sys.modules[target] +def resolve_path(module, name): + if isinstance(module, string_types): + __import__(module) + module = sys.modules[module] - parent = target + parent = module - path = name.split(".") + path = name.split('.') attribute = path[0] # We can't just always use getattr() because in doing @@ -57,46 +53,22 @@ def lookup_attribute(parent, attribute): return (parent, attribute, original) - def apply_patch(parent, attribute, replacement): - """ - Convenience function for applying a patch to an attribute. Currently this - maps to the standard setattr() function, but in the future may be extended - to support more complex patching strategies. - """ - setattr(parent, attribute, replacement) - -def wrap_object(target, name, factory, args=(), kwargs={}): - """ - Wraps an object which is the attribute of a target object with a wrapper - object created by the `factory` function. The `target` can be a module, - class, or instance of a class. In the special case of `target` being a - string, it is assumed to be the name of a module, with the module being - imported if necessary and then used as the target object. The `name` is a - string representing the dotted path to the attribute. The `factory` function - should accept the original object and may accept additional positional and - keyword arguments which will be set by unpacking input arguments using - `*args` and `**kwargs` calling conventions. The factory function should - return a new object that will replace the original object. - """ - - (parent, attribute, original) = resolve_path(target, name) +def wrap_object(module, name, factory, args=(), kwargs={}): + (parent, attribute, original) = resolve_path(module, name) wrapper = factory(original, *args, **kwargs) apply_patch(parent, attribute, wrapper) - return wrapper - # Function for applying a proxy object to an attribute of a class # instance. The wrapper works by defining an attribute of the same name # on the class which is a descriptor and which intercepts access to the # instance attribute. Note that this cannot be used on attributes which # are themselves defined by a property object. - -class AttributeWrapper: +class AttributeWrapper(object): def __init__(self, attribute, factory, args, kwargs): self.attribute = attribute @@ -114,47 +86,19 @@ def __set__(self, instance, value): def __delete__(self, instance): del instance.__dict__[self.attribute] - def wrap_object_attribute(module, name, factory, args=(), kwargs={}): - """ - Wraps an object which is the attribute of a class instance with a wrapper - object created by the `factory` function. It does this by patching the - class, not the instance, with a descriptor that intercepts access to the - instance attribute. The `module` can be a module, class, or instance of a - class. In the special case of `module` being a string, it is assumed to be - the name of a module, with the module being imported if necessary and then - used as the target object. The `name` is a string representing the dotted - path to the attribute. The `factory` function should accept the original - object and may accept additional positional and keyword arguments which will - be set by unpacking input arguments using `*args` and `**kwargs` calling - conventions. The factory function should return a new object that will - replace the original object. - """ - - path, attribute = name.rsplit(".", 1) + path, attribute = name.rsplit('.', 1) parent = resolve_path(module, path)[2] wrapper = AttributeWrapper(attribute, factory, args, kwargs) apply_patch(parent, attribute, wrapper) return wrapper - # Functions for creating a simple decorator using a FunctionWrapper, # plus short cut functions for applying wrappers to functions. These are # for use when doing monkey patching. For a more featured way of # creating decorators see the decorator decorator instead. - def function_wrapper(wrapper): - """ - Creates a decorator for wrapping a function with a `wrapper` function. - The decorator which is returned may also be applied to any other callable - objects such as lambda functions, methods, classmethods, and staticmethods, - or objects which implement the `__call__()` method. The `wrapper` function - should accept the `wrapped` function, `instance`, `args`, and `kwargs`, - arguments and return the result of calling the wrapped function or some - other appropriate value. - """ - def _wrapper(wrapped, instance, args, kwargs): target_wrapped = args[0] if instance is None: @@ -164,55 +108,17 @@ def _wrapper(wrapped, instance, args, kwargs): else: target_wrapper = wrapper.__get__(instance, type(instance)) return FunctionWrapper(target_wrapped, target_wrapper) - return FunctionWrapper(wrapper, _wrapper) +def wrap_function_wrapper(module, name, wrapper): + return wrap_object(module, name, FunctionWrapper, (wrapper,)) -def wrap_function_wrapper(target, name, wrapper): - """ - Wraps a function which is the attribute of a target object with a `wrapper` - function. The `target` can be a module, class, or instance of a class. In - the special case of `target` being a string, it is assumed to be the name - of a module, with the module being imported if necessary. The `name` is a - string representing the dotted path to the attribute. The `wrapper` function - should accept the `wrapped` function, `instance`, `args`, and `kwargs` - arguments, and would return the result of calling the wrapped attribute or - some other appropriate value. - """ - - return wrap_object(target, name, FunctionWrapper, (wrapper,)) - - -def patch_function_wrapper(target, name, enabled=None): - """ - Creates a decorator which can be applied to a wrapper function, where the - wrapper function will be used to wrap a function which is the attribute of - a target object. The `target` can be a module, class, or instance of a class. - In the special case of `target` being a string, it is assumed to be the name - of a module, with the module being imported if necessary. The `name` is a - string representing the dotted path to the attribute. The `enabled` - argument can be a boolean or a callable that returns a boolean. When a - callable is provided, it will be called each time the wrapper is invoked to - determine if the wrapper function should be executed or whether the wrapped - function should be called directly. If `enabled` is not provided, the - wrapper is enabled by default. - """ - +def patch_function_wrapper(module, name, enabled=None): def _wrapper(wrapper): - return wrap_object(target, name, FunctionWrapper, (wrapper, enabled)) - + return wrap_object(module, name, FunctionWrapper, (wrapper, enabled)) return _wrapper - -def transient_function_wrapper(target, name): - """Creates a decorator that patches a target function with a wrapper - function, but only for the duration of the call that the decorator was - applied to. The `target` can be a module, class, or instance of a class. - In the special case of `target` being a string, it is assumed to be the name - of a module, with the module being imported if necessary. The `name` is a - string representing the dotted path to the attribute. - """ - +def transient_function_wrapper(module, name): def _decorator(wrapper): def _wrapper(wrapped, instance, args, kwargs): target_wrapped = args[0] @@ -222,18 +128,14 @@ def _wrapper(wrapped, instance, args, kwargs): target_wrapper = wrapper.__get__(None, instance) else: target_wrapper = wrapper.__get__(instance, type(instance)) - def _execute(wrapped, instance, args, kwargs): - (parent, attribute, original) = resolve_path(target, name) + (parent, attribute, original) = resolve_path(module, name) replacement = FunctionWrapper(original, target_wrapper) setattr(parent, attribute, replacement) try: return wrapped(*args, **kwargs) finally: setattr(parent, attribute, original) - return FunctionWrapper(target_wrapped, _execute) - return FunctionWrapper(wrapper, _wrapper) - return _decorator diff --git a/newrelic/packages/wrapt/proxies.py b/newrelic/packages/wrapt/proxies.py deleted file mode 100644 index fbb6c9e39a..0000000000 --- a/newrelic/packages/wrapt/proxies.py +++ /dev/null @@ -1,351 +0,0 @@ -"""Variants of ObjectProxy for different use cases.""" - -from collections.abc import Callable -from types import ModuleType - -from .__wrapt__ import BaseObjectProxy -from .decorators import synchronized - -# Define ObjectProxy which for compatibility adds `__iter__()` support which -# has been removed from `BaseObjectProxy`. - - -class ObjectProxy(BaseObjectProxy): - """A generic object proxy which forwards special methods as needed. - For backwards compatibility this class adds support for `__iter__()`. If - you don't need backward compatibility for `__iter__()` support then it is - preferable to use `BaseObjectProxy` directly. If you want automatic - support for special dunder methods for callables, iterators, and async, - then use `AutoObjectProxy`.""" - - @property - def __object_proxy__(self): - return ObjectProxy - - def __new__(cls, *args, **kwargs): - return super().__new__(cls) - - def __iter__(self): - return iter(self.__wrapped__) - - -# Define variant of ObjectProxy which can automatically adjust to the wrapped -# object and add special dunder methods. - - -def __wrapper_call__(*args, **kwargs): - def _unpack_self(self, *args): - return self, args - - self, args = _unpack_self(*args) - - return self.__wrapped__(*args, **kwargs) - - -def __wrapper_iter__(self): - return iter(self.__wrapped__) - - -def __wrapper_next__(self): - return self.__wrapped__.__next__() - - -def __wrapper_aiter__(self): - return self.__wrapped__.__aiter__() - - -async def __wrapper_anext__(self): - return await self.__wrapped__.__anext__() - - -def __wrapper_length_hint__(self): - return self.__wrapped__.__length_hint__() - - -def __wrapper_await__(self): - return (yield from self.__wrapped__.__await__()) - - -def __wrapper_get__(self, instance, owner): - return self.__wrapped__.__get__(instance, owner) - - -def __wrapper_set__(self, instance, value): - return self.__wrapped__.__set__(instance, value) - - -def __wrapper_delete__(self, instance): - return self.__wrapped__.__delete__(instance) - - -def __wrapper_set_name__(self, owner, name): - return self.__wrapped__.__set_name__(owner, name) - - -class AutoObjectProxy(BaseObjectProxy): - """An object proxy which can automatically adjust to the wrapped object - and add special dunder methods as needed. Note that this creates a new - class for each instance, so it has much higher memory overhead than using - `BaseObjectProxy` directly. If you know what special dunder methods you need - then it is preferable to use `BaseObjectProxy` directly and add them to a - subclass as needed. If you only need `__iter__()` support for backwards - compatibility then use `ObjectProxy` instead. - """ - - def __new__(cls, wrapped): - """Injects special dunder methods into a dynamically created subclass - as needed based on the wrapped object. - """ - - namespace = {} - - wrapped_attrs = dir(wrapped) - class_attrs = set(dir(cls)) - - if callable(wrapped) and "__call__" not in class_attrs: - namespace["__call__"] = __wrapper_call__ - - if "__iter__" in wrapped_attrs and "__iter__" not in class_attrs: - namespace["__iter__"] = __wrapper_iter__ - - if "__next__" in wrapped_attrs and "__next__" not in class_attrs: - namespace["__next__"] = __wrapper_next__ - - if "__aiter__" in wrapped_attrs and "__aiter__" not in class_attrs: - namespace["__aiter__"] = __wrapper_aiter__ - - if "__anext__" in wrapped_attrs and "__anext__" not in class_attrs: - namespace["__anext__"] = __wrapper_anext__ - - if "__length_hint__" in wrapped_attrs and "__length_hint__" not in class_attrs: - namespace["__length_hint__"] = __wrapper_length_hint__ - - # Note that not providing compatibility with generator-based coroutines - # (PEP 342) here as they are removed in Python 3.11+ and were deprecated - # in 3.8. - - if "__await__" in wrapped_attrs and "__await__" not in class_attrs: - namespace["__await__"] = __wrapper_await__ - - if "__get__" in wrapped_attrs and "__get__" not in class_attrs: - namespace["__get__"] = __wrapper_get__ - - if "__set__" in wrapped_attrs and "__set__" not in class_attrs: - namespace["__set__"] = __wrapper_set__ - - if "__delete__" in wrapped_attrs and "__delete__" not in class_attrs: - namespace["__delete__"] = __wrapper_delete__ - - if "__set_name__" in wrapped_attrs and "__set_name__" not in class_attrs: - namespace["__set_name__"] = __wrapper_set_name__ - - name = cls.__name__ - - if cls is AutoObjectProxy: - name = BaseObjectProxy.__name__ - - return super(AutoObjectProxy, cls).__new__(type(name, (cls,), namespace)) - - def __wrapped_setattr_fixups__(self): - """Adjusts special dunder methods on the class as needed based on the - wrapped object, when `__wrapped__` is changed. - """ - - cls = type(self) - class_attrs = set(dir(cls)) - - if callable(self.__wrapped__): - if "__call__" not in class_attrs: - cls.__call__ = __wrapper_call__ - elif getattr(cls, "__call__", None) is __wrapper_call__: - delattr(cls, "__call__") - - if hasattr(self.__wrapped__, "__iter__"): - if "__iter__" not in class_attrs: - cls.__iter__ = __wrapper_iter__ - elif getattr(cls, "__iter__", None) is __wrapper_iter__: - delattr(cls, "__iter__") - - if hasattr(self.__wrapped__, "__next__"): - if "__next__" not in class_attrs: - cls.__next__ = __wrapper_next__ - elif getattr(cls, "__next__", None) is __wrapper_next__: - delattr(cls, "__next__") - - if hasattr(self.__wrapped__, "__aiter__"): - if "__aiter__" not in class_attrs: - cls.__aiter__ = __wrapper_aiter__ - elif getattr(cls, "__aiter__", None) is __wrapper_aiter__: - delattr(cls, "__aiter__") - - if hasattr(self.__wrapped__, "__anext__"): - if "__anext__" not in class_attrs: - cls.__anext__ = __wrapper_anext__ - elif getattr(cls, "__anext__", None) is __wrapper_anext__: - delattr(cls, "__anext__") - - if hasattr(self.__wrapped__, "__length_hint__"): - if "__length_hint__" not in class_attrs: - cls.__length_hint__ = __wrapper_length_hint__ - elif getattr(cls, "__length_hint__", None) is __wrapper_length_hint__: - delattr(cls, "__length_hint__") - - if hasattr(self.__wrapped__, "__await__"): - if "__await__" not in class_attrs: - cls.__await__ = __wrapper_await__ - elif getattr(cls, "__await__", None) is __wrapper_await__: - delattr(cls, "__await__") - - if hasattr(self.__wrapped__, "__get__"): - if "__get__" not in class_attrs: - cls.__get__ = __wrapper_get__ - elif getattr(cls, "__get__", None) is __wrapper_get__: - delattr(cls, "__get__") - - if hasattr(self.__wrapped__, "__set__"): - if "__set__" not in class_attrs: - cls.__set__ = __wrapper_set__ - elif getattr(cls, "__set__", None) is __wrapper_set__: - delattr(cls, "__set__") - - if hasattr(self.__wrapped__, "__delete__"): - if "__delete__" not in class_attrs: - cls.__delete__ = __wrapper_delete__ - elif getattr(cls, "__delete__", None) is __wrapper_delete__: - delattr(cls, "__delete__") - - if hasattr(self.__wrapped__, "__set_name__"): - if "__set_name__" not in class_attrs: - cls.__set_name__ = __wrapper_set_name__ - elif getattr(cls, "__set_name__", None) is __wrapper_set_name__: - delattr(cls, "__set_name__") - - -class LazyObjectProxy(AutoObjectProxy): - """An object proxy which can generate/create the wrapped object on demand - when it is first needed. - """ - - def __new__(cls, callback=None, *, interface=...): - """Injects special dunder methods into a dynamically created subclass - as needed based on the wrapped object. - """ - - if interface is ...: - interface = type(None) - - namespace = {} - - interface_attrs = dir(interface) - class_attrs = set(dir(cls)) - - if "__call__" in interface_attrs and "__call__" not in class_attrs: - namespace["__call__"] = __wrapper_call__ - - if "__iter__" in interface_attrs and "__iter__" not in class_attrs: - namespace["__iter__"] = __wrapper_iter__ - - if "__next__" in interface_attrs and "__next__" not in class_attrs: - namespace["__next__"] = __wrapper_next__ - - if "__aiter__" in interface_attrs and "__aiter__" not in class_attrs: - namespace["__aiter__"] = __wrapper_aiter__ - - if "__anext__" in interface_attrs and "__anext__" not in class_attrs: - namespace["__anext__"] = __wrapper_anext__ - - if ( - "__length_hint__" in interface_attrs - and "__length_hint__" not in class_attrs - ): - namespace["__length_hint__"] = __wrapper_length_hint__ - - # Note that not providing compatibility with generator-based coroutines - # (PEP 342) here as they are removed in Python 3.11+ and were deprecated - # in 3.8. - - if "__await__" in interface_attrs and "__await__" not in class_attrs: - namespace["__await__"] = __wrapper_await__ - - if "__get__" in interface_attrs and "__get__" not in class_attrs: - namespace["__get__"] = __wrapper_get__ - - if "__set__" in interface_attrs and "__set__" not in class_attrs: - namespace["__set__"] = __wrapper_set__ - - if "__delete__" in interface_attrs and "__delete__" not in class_attrs: - namespace["__delete__"] = __wrapper_delete__ - - if "__set_name__" in interface_attrs and "__set_name__" not in class_attrs: - namespace["__set_name__"] = __wrapper_set_name__ - - name = cls.__name__ - - return super(AutoObjectProxy, cls).__new__(type(name, (cls,), namespace)) - - def __init__(self, callback=None, *, interface=...): - """Initialize the object proxy with wrapped object as `None` but due - to presence of special `__wrapped_factory__` attribute addded first, - this will actually trigger the deferred creation of the wrapped object - when first needed. - """ - - if callback is not None: - self.__wrapped_factory__ = callback - - super().__init__(None) - - __wrapped_initialized__ = False - - def __wrapped_factory__(self): - return None - - def __wrapped_get__(self): - """Gets the wrapped object, creating it if necessary.""" - - # We synchronize on the class type, which will be unique to this instance - # since we inherit from `AutoObjectProxy` which creates a new class - # for each instance. If we synchronize on `self` or the method then - # we can end up in infinite recursion via `__getattr__()`. - - with synchronized(type(self)): - # We were called because `__wrapped__` was not set, but because of - # multiple threads we may find that it has been set by the time - # we get the lock. So check again now whether `__wrapped__` is set. - # If it is then just return it, otherwise call the factory to - # create it. - - if self.__wrapped_initialized__: - return self.__wrapped__ - - self.__wrapped__ = self.__wrapped_factory__() - - self.__wrapped_initialized__ = True - - return self.__wrapped__ - - -def lazy_import(name, attribute=None, *, interface=...): - """Lazily imports the module `name`, returning a `LazyObjectProxy` which - will import the module when it is first needed. When `name is a dotted name, - then the full dotted name is imported and the last module is taken as the - target. If `attribute` is provided then it is used to retrieve an attribute - from the module. - """ - - if attribute is not None: - if interface is ...: - interface = Callable - else: - if interface is ...: - interface = ModuleType - - def _import(): - module = __import__(name, fromlist=[""]) - - if attribute is not None: - return getattr(module, attribute) - - return module - - return LazyObjectProxy(_import, interface=interface) diff --git a/newrelic/packages/wrapt/py.typed b/newrelic/packages/wrapt/py.typed deleted file mode 100644 index b648ac9233..0000000000 --- a/newrelic/packages/wrapt/py.typed +++ /dev/null @@ -1 +0,0 @@ -partial diff --git a/newrelic/packages/wrapt/weakrefs.py b/newrelic/packages/wrapt/weakrefs.py index dc8e7eb2d3..f931b60d5f 100644 --- a/newrelic/packages/wrapt/weakrefs.py +++ b/newrelic/packages/wrapt/weakrefs.py @@ -1,7 +1,7 @@ import functools import weakref -from .__wrapt__ import BaseObjectProxy, _FunctionWrapperBase +from .__wrapt__ import ObjectProxy, _FunctionWrapperBase # A weak function proxy. This will work on instance methods, class # methods, static methods and regular functions. Special treatment is @@ -12,7 +12,6 @@ # and the original function. The function is then rebound at the point # of a call via the weak function proxy. - def _weak_function_proxy_callback(ref, proxy, callback): if proxy._self_expired: return @@ -26,25 +25,11 @@ def _weak_function_proxy_callback(ref, proxy, callback): if callback is not None: callback(proxy) +class WeakFunctionProxy(ObjectProxy): -class WeakFunctionProxy(BaseObjectProxy): - """A weak function proxy.""" - - __slots__ = ("_self_expired", "_self_instance") + __slots__ = ('_self_expired', '_self_instance') def __init__(self, wrapped, callback=None): - """Create a proxy to object which uses a weak reference. This is - similar to the `weakref.proxy` but is designed to work with functions - and methods. It will automatically rebind the function to the instance - when called if the function was originally a bound method. This is - necessary because bound methods are transient objects and applying a - weak reference to one will immediately result in it being destroyed - and the weakref callback called. The weak reference is therefore - applied to the instance the method is bound to and the original - function. The function is then rebound at the point of a call via the - weak function proxy. - """ - # We need to determine if the wrapped function is actually a # bound method. In the case of a bound method, we need to keep a # reference to the original unbound function and the instance. @@ -58,23 +43,22 @@ def __init__(self, wrapped, callback=None): # the callback here so as not to cause any odd reference cycles. _callback = callback and functools.partial( - _weak_function_proxy_callback, proxy=self, callback=callback - ) + _weak_function_proxy_callback, proxy=self, + callback=callback) self._self_expired = False if isinstance(wrapped, _FunctionWrapperBase): - self._self_instance = weakref.ref(wrapped._self_instance, _callback) + self._self_instance = weakref.ref(wrapped._self_instance, + _callback) if wrapped._self_parent is not None: super(WeakFunctionProxy, self).__init__( - weakref.proxy(wrapped._self_parent, _callback) - ) + weakref.proxy(wrapped._self_parent, _callback)) else: super(WeakFunctionProxy, self).__init__( - weakref.proxy(wrapped, _callback) - ) + weakref.proxy(wrapped, _callback)) return @@ -82,13 +66,13 @@ def __init__(self, wrapped, callback=None): self._self_instance = weakref.ref(wrapped.__self__, _callback) super(WeakFunctionProxy, self).__init__( - weakref.proxy(wrapped.__func__, _callback) - ) + weakref.proxy(wrapped.__func__, _callback)) except AttributeError: self._self_instance = None - super(WeakFunctionProxy, self).__init__(weakref.proxy(wrapped, _callback)) + super(WeakFunctionProxy, self).__init__( + weakref.proxy(wrapped, _callback)) def __call__(*args, **kwargs): def _unpack_self(self, *args): diff --git a/newrelic/packages/wrapt/wrappers.py b/newrelic/packages/wrapt/wrappers.py index 445d0b2c6e..dfc3440db4 100644 --- a/newrelic/packages/wrapt/wrappers.py +++ b/newrelic/packages/wrapt/wrappers.py @@ -1,24 +1,19 @@ -import inspect -import operator import sys +import operator +import inspect +PY2 = sys.version_info[0] == 2 + +if PY2: + string_types = basestring, +else: + string_types = str, def with_metaclass(meta, *bases): """Create a base class with a metaclass.""" return meta("NewBase", bases, {}) - -class WrapperNotInitializedError(ValueError, AttributeError): - """ - Exception raised when a wrapper is accessed before it has been initialized. - To satisfy different situations where this could arise, we inherit from both - ValueError and AttributeError. - """ - - pass - - -class _ObjectProxyMethods: +class _ObjectProxyMethods(object): # We use properties to override the values of __module__ and # __doc__. If we add these in ObjectProxy, the derived class @@ -61,7 +56,6 @@ def __dict__(self): def __weakref__(self): return self.__wrapped__.__weakref__ - class _ObjectProxyMetaType(type): def __new__(cls, name, bases, dictionary): # Copy our special properties into the class so that they @@ -73,47 +67,19 @@ def __new__(cls, name, bases, dictionary): return type.__new__(cls, name, bases, dictionary) +class ObjectProxy(with_metaclass(_ObjectProxyMetaType)): -# NOTE: Although Python 3+ supports the newer metaclass=MetaClass syntax, -# we must continue using with_metaclass() for ObjectProxy. The newer syntax -# changes how __slots__ is handled during class creation, which would break -# the ability to set _self_* attributes on ObjectProxy instances. The -# with_metaclass() approach creates an intermediate base class that allows -# the necessary attribute flexibility while still applying the metaclass. - - -class ObjectProxy(with_metaclass(_ObjectProxyMetaType)): # type: ignore[misc] - - __slots__ = "__wrapped__" + __slots__ = '__wrapped__' def __init__(self, wrapped): - """Create an object proxy around the given object.""" - - if wrapped is None: - try: - callback = object.__getattribute__(self, "__wrapped_factory__") - except AttributeError: - callback = None - - if callback is not None: - # If wrapped is none and class has a __wrapped_factory__ - # method, then we don't set __wrapped__ yet and instead will - # defer creation of the wrapped object until it is first - # needed. - - pass - - else: - object.__setattr__(self, "__wrapped__", wrapped) - else: - object.__setattr__(self, "__wrapped__", wrapped) + object.__setattr__(self, '__wrapped__', wrapped) # Python 3.2+ has the __qualname__ attribute, but it does not # allow it to be overridden using a property and it must instead # be an actual string object instead. try: - object.__setattr__(self, "__qualname__", wrapped.__qualname__) + object.__setattr__(self, '__qualname__', wrapped.__qualname__) except AttributeError: pass @@ -121,14 +87,10 @@ def __init__(self, wrapped): # using a property and it must instead be set explicitly. try: - object.__setattr__(self, "__annotations__", wrapped.__annotations__) + object.__setattr__(self, '__annotations__', wrapped.__annotations__) except AttributeError: pass - @property - def __object_proxy__(self): - return ObjectProxy - def __self_setattr__(self, name, value): object.__setattr__(self, name, value) @@ -154,27 +116,26 @@ def __dir__(self): def __str__(self): return str(self.__wrapped__) - def __bytes__(self): - return bytes(self.__wrapped__) + if not PY2: + def __bytes__(self): + return bytes(self.__wrapped__) def __repr__(self): - return f"<{type(self).__name__} at 0x{id(self):x} for {type(self.__wrapped__).__name__} at 0x{id(self.__wrapped__):x}>" - - def __format__(self, format_spec): - return format(self.__wrapped__, format_spec) + return '<{} at 0x{:x} for {} at 0x{:x}>'.format( + type(self).__name__, id(self), + type(self.__wrapped__).__name__, + id(self.__wrapped__)) def __reversed__(self): return reversed(self.__wrapped__) - def __round__(self, ndigits=None): - return round(self.__wrapped__, ndigits) + if not PY2: + def __round__(self): + return round(self.__wrapped__) - def __mro_entries__(self, bases): - if not isinstance(self.__wrapped__, type) and hasattr( - self.__wrapped__, "__mro_entries__" - ): - return self.__wrapped__.__mro_entries__(bases) - return (self.__wrapped__,) + if sys.hexversion >= 0x03070000: + def __mro_entries__(self, bases): + return (self.__wrapped__,) def __lt__(self, other): return self.__wrapped__ < other @@ -204,41 +165,33 @@ def __bool__(self): return bool(self.__wrapped__) def __setattr__(self, name, value): - if name.startswith("_self_"): + if name.startswith('_self_'): object.__setattr__(self, name, value) - elif name == "__wrapped__": + elif name == '__wrapped__': object.__setattr__(self, name, value) - try: - object.__delattr__(self, "__qualname__") + object.__delattr__(self, '__qualname__') except AttributeError: pass try: - object.__setattr__(self, "__qualname__", value.__qualname__) + object.__setattr__(self, '__qualname__', value.__qualname__) except AttributeError: pass try: - object.__delattr__(self, "__annotations__") + object.__delattr__(self, '__annotations__') except AttributeError: pass try: - object.__setattr__(self, "__annotations__", value.__annotations__) + object.__setattr__(self, '__annotations__', value.__annotations__) except AttributeError: pass - __wrapped_setattr_fixups__ = getattr( - self, "__wrapped_setattr_fixups__", None - ) - - if __wrapped_setattr_fixups__ is not None: - __wrapped_setattr_fixups__() - - elif name == "__qualname__": + elif name == '__qualname__': setattr(self.__wrapped__, name, value) object.__setattr__(self, name, value) - elif name == "__annotations__": + elif name == '__annotations__': setattr(self.__wrapped__, name, value) object.__setattr__(self, name, value) @@ -249,37 +202,22 @@ def __setattr__(self, name, value): setattr(self.__wrapped__, name, value) def __getattr__(self, name): - # If we need to lookup `__wrapped__` then the `__init__()` method - # cannot have been called, or this is a lazy object proxy which is - # deferring creation of the wrapped object until it is first needed. - - if name == "__wrapped__": - # Note that we use existance of `__wrapped_factory__` to gate whether - # we can attempt to initialize the wrapped object lazily, but it is - # `__wrapped_get__` that we actually call to do the initialization. - # This is so that we can handle multithreading correctly by having - # `__wrapped_get__` use a lock to protect against multiple threads - # trying to initialize the wrapped object at the same time. + # If we are being to lookup '__wrapped__' then the + # '__init__()' method cannot have been called. - try: - object.__getattribute__(self, "__wrapped_factory__") - except AttributeError: - pass - else: - return object.__getattribute__(self, "__wrapped_get__")() - - raise WrapperNotInitializedError("wrapper has not been initialized") + if name == '__wrapped__': + raise ValueError('wrapper has not been initialised') return getattr(self.__wrapped__, name) def __delattr__(self, name): - if name.startswith("_self_"): + if name.startswith('_self_'): object.__delattr__(self, name) - elif name == "__wrapped__": - raise TypeError("__wrapped__ attribute cannot be deleted") + elif name == '__wrapped__': + raise TypeError('__wrapped__ must be an object') - elif name == "__qualname__": + elif name == '__qualname__': object.__delattr__(self, name) delattr(self.__wrapped__, name) @@ -298,6 +236,9 @@ def __sub__(self, other): def __mul__(self, other): return self.__wrapped__ * other + def __div__(self, other): + return operator.div(self.__wrapped__, other) + def __truediv__(self, other): return operator.truediv(self.__wrapped__, other) @@ -337,6 +278,9 @@ def __rsub__(self, other): def __rmul__(self, other): return other * self.__wrapped__ + def __rdiv__(self, other): + return operator.div(other, self.__wrapped__) + def __rtruediv__(self, other): return operator.truediv(other, self.__wrapped__) @@ -368,90 +312,56 @@ def __ror__(self, other): return other | self.__wrapped__ def __iadd__(self, other): - if hasattr(self.__wrapped__, "__iadd__"): - self.__wrapped__ += other - return self - else: - return self.__object_proxy__(self.__wrapped__ + other) + self.__wrapped__ += other + return self def __isub__(self, other): - if hasattr(self.__wrapped__, "__isub__"): - self.__wrapped__ -= other - return self - else: - return self.__object_proxy__(self.__wrapped__ - other) + self.__wrapped__ -= other + return self def __imul__(self, other): - if hasattr(self.__wrapped__, "__imul__"): - self.__wrapped__ *= other - return self - else: - return self.__object_proxy__(self.__wrapped__ * other) + self.__wrapped__ *= other + return self + + def __idiv__(self, other): + self.__wrapped__ = operator.idiv(self.__wrapped__, other) + return self def __itruediv__(self, other): - if hasattr(self.__wrapped__, "__itruediv__"): - self.__wrapped__ /= other - return self - else: - return self.__object_proxy__(self.__wrapped__ / other) + self.__wrapped__ = operator.itruediv(self.__wrapped__, other) + return self def __ifloordiv__(self, other): - if hasattr(self.__wrapped__, "__ifloordiv__"): - self.__wrapped__ //= other - return self - else: - return self.__object_proxy__(self.__wrapped__ // other) + self.__wrapped__ //= other + return self def __imod__(self, other): - if hasattr(self.__wrapped__, "__imod__"): - self.__wrapped__ %= other - return self - else: - return self.__object_proxy__(self.__wrapped__ % other) - + self.__wrapped__ %= other return self - def __ipow__(self, other): # type: ignore[misc] - if hasattr(self.__wrapped__, "__ipow__"): - self.__wrapped__ **= other - return self - else: - return self.__object_proxy__(self.__wrapped__**other) + def __ipow__(self, other): + self.__wrapped__ **= other + return self def __ilshift__(self, other): - if hasattr(self.__wrapped__, "__ilshift__"): - self.__wrapped__ <<= other - return self - else: - return self.__object_proxy__(self.__wrapped__ << other) + self.__wrapped__ <<= other + return self def __irshift__(self, other): - if hasattr(self.__wrapped__, "__irshift__"): - self.__wrapped__ >>= other - return self - else: - return self.__object_proxy__(self.__wrapped__ >> other) + self.__wrapped__ >>= other + return self def __iand__(self, other): - if hasattr(self.__wrapped__, "__iand__"): - self.__wrapped__ &= other - return self - else: - return self.__object_proxy__(self.__wrapped__ & other) + self.__wrapped__ &= other + return self def __ixor__(self, other): - if hasattr(self.__wrapped__, "__ixor__"): - self.__wrapped__ ^= other - return self - else: - return self.__object_proxy__(self.__wrapped__ ^ other) + self.__wrapped__ ^= other + return self def __ior__(self, other): - if hasattr(self.__wrapped__, "__ior__"): - self.__wrapped__ |= other - return self - else: - return self.__object_proxy__(self.__wrapped__ | other) + self.__wrapped__ |= other + return self def __neg__(self): return -self.__wrapped__ @@ -468,6 +378,9 @@ def __invert__(self): def __int__(self): return int(self.__wrapped__) + def __long__(self): + return long(self.__wrapped__) + def __float__(self): return float(self.__wrapped__) @@ -483,19 +396,6 @@ def __hex__(self): def __index__(self): return operator.index(self.__wrapped__) - def __matmul__(self, other): - return self.__wrapped__ @ other - - def __rmatmul__(self, other): - return other @ self.__wrapped__ - - def __imatmul__(self, other): - if hasattr(self.__wrapped__, "__imatmul__"): - self.__wrapped__ @= other - return self - else: - return self.__object_proxy__(self.__wrapped__ @ other) - def __len__(self): return len(self.__wrapped__) @@ -526,24 +426,22 @@ def __enter__(self): def __exit__(self, *args, **kwargs): return self.__wrapped__.__exit__(*args, **kwargs) - def __aenter__(self): - return self.__wrapped__.__aenter__() - - def __aexit__(self, *args, **kwargs): - return self.__wrapped__.__aexit__(*args, **kwargs) + def __iter__(self): + return iter(self.__wrapped__) def __copy__(self): - raise NotImplementedError("object proxy must define __copy__()") + raise NotImplementedError('object proxy must define __copy__()') def __deepcopy__(self, memo): - raise NotImplementedError("object proxy must define __deepcopy__()") + raise NotImplementedError('object proxy must define __deepcopy__()') def __reduce__(self): - raise NotImplementedError("object proxy must define __reduce__()") + raise NotImplementedError( + 'object proxy must define __reduce_ex__()') def __reduce_ex__(self, protocol): - raise NotImplementedError("object proxy must define __reduce_ex__()") - + raise NotImplementedError( + 'object proxy must define __reduce_ex__()') class CallableObjectProxy(ObjectProxy): @@ -555,31 +453,21 @@ def _unpack_self(self, *args): return self.__wrapped__(*args, **kwargs) - class PartialCallableObjectProxy(ObjectProxy): - """A callable object proxy that supports partial application of arguments - and keywords. - """ def __init__(*args, **kwargs): - """Create a callable object proxy with partial application of the given - arguments and keywords. This behaves the same as `functools.partial`, but - implemented using the `ObjectProxy` class to provide better support for - introspection. - """ - def _unpack_self(self, *args): return self, args self, args = _unpack_self(*args) if len(args) < 1: - raise TypeError("partial type takes at least one argument") + raise TypeError('partial type takes at least one argument') wrapped, args = args[0], args[1:] if not callable(wrapped): - raise TypeError("the first argument must be callable") + raise TypeError('the first argument must be callable') super(PartialCallableObjectProxy, self).__init__(wrapped) @@ -591,7 +479,7 @@ def _unpack_self(self, *args): return self, args self, args = _unpack_self(*args) - + _args = self._self_args + args _kwargs = dict(self._self_kwargs) @@ -599,112 +487,75 @@ def _unpack_self(self, *args): return self.__wrapped__(*_args, **_kwargs) - class _FunctionWrapperBase(ObjectProxy): - __slots__ = ( - "_self_instance", - "_self_wrapper", - "_self_enabled", - "_self_binding", - "_self_parent", - "_self_owner", - ) - - def __init__( - self, - wrapped, - instance, - wrapper, - enabled=None, - binding="callable", - parent=None, - owner=None, - ): + __slots__ = ('_self_instance', '_self_wrapper', '_self_enabled', + '_self_binding', '_self_parent') + + def __init__(self, wrapped, instance, wrapper, enabled=None, + binding='function', parent=None): super(_FunctionWrapperBase, self).__init__(wrapped) - object.__setattr__(self, "_self_instance", instance) - object.__setattr__(self, "_self_wrapper", wrapper) - object.__setattr__(self, "_self_enabled", enabled) - object.__setattr__(self, "_self_binding", binding) - object.__setattr__(self, "_self_parent", parent) - object.__setattr__(self, "_self_owner", owner) + object.__setattr__(self, '_self_instance', instance) + object.__setattr__(self, '_self_wrapper', wrapper) + object.__setattr__(self, '_self_enabled', enabled) + object.__setattr__(self, '_self_binding', binding) + object.__setattr__(self, '_self_parent', parent) def __get__(self, instance, owner): - # This method is actually doing double duty for both unbound and bound - # derived wrapper classes. It should possibly be broken up and the - # distinct functionality moved into the derived classes. Can't do that - # straight away due to some legacy code which is relying on it being - # here in this base class. + # This method is actually doing double duty for both unbound and + # bound derived wrapper classes. It should possibly be broken up + # and the distinct functionality moved into the derived classes. + # Can't do that straight away due to some legacy code which is + # relying on it being here in this base class. # - # The distinguishing attribute which determines whether we are being - # called in an unbound or bound wrapper is the parent attribute. If - # binding has never occurred, then the parent will be None. + # The distinguishing attribute which determines whether we are + # being called in an unbound or bound wrapper is the parent + # attribute. If binding has never occurred, then the parent will + # be None. # - # First therefore, is if we are called in an unbound wrapper. In this - # case we perform the binding. + # First therefore, is if we are called in an unbound wrapper. In + # this case we perform the binding. # - # We have two special cases to worry about here. These are where we are - # decorating a class or builtin function as neither provide a __get__() - # method to call. In this case we simply return self. + # We have one special case to worry about here. This is where we + # are decorating a nested class. In this case the wrapped class + # would not have a __get__() method to call. In that case we + # simply return self. # - # Note that we otherwise still do binding even if instance is None and - # accessing an unbound instance method from a class. This is because we - # need to be able to later detect that specific case as we will need to - # extract the instance from the first argument of those passed in. + # Note that we otherwise still do binding even if instance is + # None and accessing an unbound instance method from a class. + # This is because we need to be able to later detect that + # specific case as we will need to extract the instance from the + # first argument of those passed in. if self._self_parent is None: - # Technically can probably just check for existence of __get__ on - # the wrapped object, but this is more explicit. - - if self._self_binding == "builtin": - return self - - if self._self_binding == "class": - return self - - binder = getattr(self.__wrapped__, "__get__", None) + if not inspect.isclass(self.__wrapped__): + descriptor = self.__wrapped__.__get__(instance, owner) - if binder is None: - return self + return self.__bound_function_wrapper__(descriptor, instance, + self._self_wrapper, self._self_enabled, + self._self_binding, self) - descriptor = binder(instance, owner) - - return self.__bound_function_wrapper__( - descriptor, - instance, - self._self_wrapper, - self._self_enabled, - self._self_binding, - self, - owner, - ) + return self - # Now we have the case of binding occurring a second time on what was - # already a bound function. In this case we would usually return - # ourselves again. This mirrors what Python does. + # Now we have the case of binding occurring a second time on what + # was already a bound function. In this case we would usually + # return ourselves again. This mirrors what Python does. # - # The special case this time is where we were originally bound with an - # instance of None and we were likely an instance method. In that case - # we rebind against the original wrapped function from the parent again. + # The special case this time is where we were originally bound + # with an instance of None and we were likely an instance + # method. In that case we rebind against the original wrapped + # function from the parent again. - if self._self_instance is None and self._self_binding in ( - "function", - "instancemethod", - "callable", - ): - descriptor = self._self_parent.__wrapped__.__get__(instance, owner) + if self._self_instance is None and self._self_binding == 'function': + descriptor = self._self_parent.__wrapped__.__get__( + instance, owner) return self._self_parent.__bound_function_wrapper__( - descriptor, - instance, - self._self_wrapper, - self._self_enabled, - self._self_binding, - self._self_parent, - owner, - ) + descriptor, instance, self._self_wrapper, + self._self_enabled, self._self_binding, + self._self_parent) return self @@ -731,16 +582,12 @@ def _unpack_self(self, *args): # a function that was already bound to an instance. In that case # we want to extract the instance from the function and use it. - if self._self_binding in ( - "function", - "instancemethod", - "classmethod", - "callable", - ): + if self._self_binding in ('function', 'classmethod'): if self._self_instance is None: - instance = getattr(self.__wrapped__, "__self__", None) + instance = getattr(self.__wrapped__, '__self__', None) if instance is not None: - return self._self_wrapper(self.__wrapped__, instance, args, kwargs) + return self._self_wrapper(self.__wrapped__, instance, + args, kwargs) # This is generally invoked when the wrapped function is being # called as a normal function and is not bound to a class as an @@ -748,7 +595,8 @@ def _unpack_self(self, *args): # wrapped function was a method, but this wrapper was in turn # wrapped using the staticmethod decorator. - return self._self_wrapper(self.__wrapped__, self._self_instance, args, kwargs) + return self._self_wrapper(self.__wrapped__, self._self_instance, + args, kwargs) def __set_name__(self, owner, name): # This is a special method use to supply information to @@ -777,7 +625,6 @@ def __subclasscheck__(self, subclass): else: return issubclass(subclass, self.__wrapped__) - class BoundFunctionWrapper(_FunctionWrapperBase): def __call__(*args, **kwargs): @@ -786,11 +633,11 @@ def _unpack_self(self, *args): self, args = _unpack_self(*args) - # If enabled has been specified, then evaluate it at this point and if - # the wrapper is not to be executed, then simply return the bound - # function rather than a bound wrapper for the bound function. When - # evaluating enabled, if it is callable we call it, otherwise we - # evaluate it as a boolean. + # If enabled has been specified, then evaluate it at this point + # and if the wrapper is not to be executed, then simply return + # the bound function rather than a bound wrapper for the bound + # function. When evaluating enabled, if it is callable we call + # it, otherwise we evaluate it as a boolean. if self._self_enabled is not None: if callable(self._self_enabled): @@ -799,39 +646,28 @@ def _unpack_self(self, *args): elif not self._self_enabled: return self.__wrapped__(*args, **kwargs) - # We need to do things different depending on whether we are likely - # wrapping an instance method vs a static method or class method. - - if self._self_binding == "function": - if self._self_instance is None and args: - instance, newargs = args[0], args[1:] - if isinstance(instance, self._self_owner): - wrapped = PartialCallableObjectProxy(self.__wrapped__, instance) - return self._self_wrapper(wrapped, instance, newargs, kwargs) + # We need to do things different depending on whether we are + # likely wrapping an instance method vs a static method or class + # method. - return self._self_wrapper( - self.__wrapped__, self._self_instance, args, kwargs - ) - - elif self._self_binding == "callable": + if self._self_binding == 'function': if self._self_instance is None: # This situation can occur where someone is calling the - # instancemethod via the class type and passing the instance as - # the first argument. We need to shift the args before making - # the call to the wrapper and effectively bind the instance to - # the wrapped function using a partial so the wrapper doesn't - # see anything as being different. + # instancemethod via the class type and passing the instance + # as the first argument. We need to shift the args before + # making the call to the wrapper and effectively bind the + # instance to the wrapped function using a partial so the + # wrapper doesn't see anything as being different. if not args: - raise TypeError("missing 1 required positional argument") + raise TypeError('missing 1 required positional argument') instance, args = args[0], args[1:] wrapped = PartialCallableObjectProxy(self.__wrapped__, instance) return self._self_wrapper(wrapped, instance, args, kwargs) - return self._self_wrapper( - self.__wrapped__, self._self_instance, args, kwargs - ) + return self._self_wrapper(self.__wrapped__, self._self_instance, + args, kwargs) else: # As in this case we would be dealing with a classmethod or @@ -847,32 +683,16 @@ def _unpack_self(self, *args): # class type, as it reflects what they have available in the # decoratored function. - instance = getattr(self.__wrapped__, "__self__", None) - - return self._self_wrapper(self.__wrapped__, instance, args, kwargs) + instance = getattr(self.__wrapped__, '__self__', None) + return self._self_wrapper(self.__wrapped__, instance, args, + kwargs) class FunctionWrapper(_FunctionWrapperBase): - """ - A wrapper for callable objects that can be used to apply decorators to - functions, methods, classmethods, and staticmethods, or any other callable. - It handles binding and unbinding of methods, and allows for the wrapper to - be enabled or disabled. - """ __bound_function_wrapper__ = BoundFunctionWrapper def __init__(self, wrapped, wrapper, enabled=None): - """ - Initialize the `FunctionWrapper` with the `wrapped` callable, the - `wrapper` function, and an optional `enabled` argument. The `enabled` - argument can be a boolean or a callable that returns a boolean. When a - callable is provided, it will be called each time the wrapper is - invoked to determine if the wrapper function should be executed or - whether the wrapped function should be called directly. If `enabled` - is not provided, the wrapper is enabled by default. - """ - # What it is we are wrapping here could be anything. We need to # try and detect specific cases though. In particular, we need # to detect when we are given something that is a method of a @@ -913,7 +733,7 @@ def __init__(self, wrapped, wrapper, enabled=None): # # 4. The wrapper is being applied when performing monkey # patching of an instance of a class. In this case binding will - # have been performed where the instance was not None. + # have been perfomed where the instance was not None. # # This case is a problem because we can no longer tell if the # method was a static method. @@ -939,42 +759,26 @@ def __init__(self, wrapped, wrapper, enabled=None): # or patch it in the __dict__ of the class type. # # So to get the best outcome we can, whenever we aren't sure what - # it is, we label it as a 'callable'. If it was already bound and + # it is, we label it as a 'function'. If it was already bound and # that is rebound later, we assume that it will be an instance - # method and try and cope with the possibility that the 'self' + # method and try an cope with the possibility that the 'self' # argument it being passed as an explicit argument and shuffle # the arguments around to extract 'self' for use as the instance. - binding = None - - if isinstance(wrapped, _FunctionWrapperBase): - binding = wrapped._self_binding - - if not binding: - if inspect.isbuiltin(wrapped): - binding = "builtin" + if isinstance(wrapped, classmethod): + binding = 'classmethod' - elif inspect.isfunction(wrapped): - binding = "function" - - elif inspect.isclass(wrapped): - binding = "class" - - elif isinstance(wrapped, classmethod): - binding = "classmethod" - - elif isinstance(wrapped, staticmethod): - binding = "staticmethod" - - elif hasattr(wrapped, "__self__"): - if inspect.isclass(wrapped.__self__): - binding = "classmethod" - elif inspect.ismethod(wrapped): - binding = "instancemethod" - else: - binding = "callable" + elif isinstance(wrapped, staticmethod): + binding = 'staticmethod' + elif hasattr(wrapped, '__self__'): + if inspect.isclass(wrapped.__self__): + binding = 'classmethod' else: - binding = "callable" + binding = 'function' + + else: + binding = 'function' - super(FunctionWrapper, self).__init__(wrapped, None, wrapper, enabled, binding) + super(FunctionWrapper, self).__init__(wrapped, None, wrapper, + enabled, binding) diff --git a/pyproject.toml b/pyproject.toml index 8b64b37772..2dbdb34837 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -28,9 +28,10 @@ readme = "README.md" # "LICENSE", # "THIRD_PARTY_NOTICES.md", # ] -requires-python = ">=3.9" # python_requires is also located in setup.py +requires-python = ">=3.8" # python_requires is also located in setup.py classifiers = [ "Development Status :: 5 - Production/Stable", + "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", @@ -78,13 +79,14 @@ packages = [ "newrelic.packages", "newrelic.packages.isort", "newrelic.packages.isort.stdlibs", - "newrelic.packages.opentelemetry_proto", "newrelic.packages.urllib3", - "newrelic.packages.urllib3.contrib", - "newrelic.packages.urllib3.contrib.emscripten", - "newrelic.packages.urllib3.http2", "newrelic.packages.urllib3.util", + "newrelic.packages.urllib3.contrib", + "newrelic.packages.urllib3.contrib._securetransport", + "newrelic.packages.urllib3.packages", + "newrelic.packages.urllib3.packages.backports", "newrelic.packages.wrapt", + "newrelic.packages.opentelemetry_proto", "newrelic.samplers", ] @@ -103,6 +105,7 @@ git_describe_command = 'git describe --dirty --tags --long --match "*.*.*"' [tool.ruff] output-format = "grouped" line-length = 120 +target-version = "py38" force-exclude = true # Fixes issue with megalinter config preventing exclusion of files extend-exclude = [ "newrelic/packages/", @@ -197,6 +200,7 @@ ignore = [ "PT012", # pytest-raises-with-multiple-statements (too many to fix all at once) # Permanently disabled rules "PLC0415", # import-outside-top-level (intentionally used frequently) + "UP006", # non-pep585-annotation (not compatible with Python 3.8) "D203", # incorrect-blank-line-before-class "D213", # multi-line-summary-second-line "ARG001", # unused-argument diff --git a/setup.py b/setup.py index 45fff5674b..4cccb1e437 100644 --- a/setup.py +++ b/setup.py @@ -17,9 +17,11 @@ python_version = sys.version_info[:2] -if python_version < (3, 9): +if python_version >= (3, 8): + pass +else: error_msg = ( - "The New Relic Python agent only supports Python 3.9+. We recommend upgrading to a newer version of Python." + "The New Relic Python agent only supports Python 3.8+. We recommend upgrading to a newer version of Python." ) try: @@ -32,7 +34,6 @@ (3, 5): "5.24.0.153", (3, 6): "7.16.0.178", (3, 7): "10.17.0", - (3, 8): "11.2.0", } last_supported_version = last_supported_version_lookup.get(python_version, None) @@ -114,19 +115,20 @@ def build_extension(self, ext): "newrelic.packages", "newrelic.packages.isort", "newrelic.packages.isort.stdlibs", - "newrelic.packages.opentelemetry_proto", "newrelic.packages.urllib3", - "newrelic.packages.urllib3.contrib", - "newrelic.packages.urllib3.contrib.emscripten", - "newrelic.packages.urllib3.http2", "newrelic.packages.urllib3.util", + "newrelic.packages.urllib3.contrib", + "newrelic.packages.urllib3.contrib._securetransport", + "newrelic.packages.urllib3.packages", + "newrelic.packages.urllib3.packages.backports", "newrelic.packages.wrapt", + "newrelic.packages.opentelemetry_proto", "newrelic.samplers", ] kwargs.update( { - "python_requires": ">=3.9", # python_requires is also located in pyproject.toml + "python_requires": ">=3.8", # python_requires is also located in pyproject.toml "zip_safe": False, "packages": packages, "package_data": { diff --git a/tests/agent_unittests/test_package_version_utils.py b/tests/agent_unittests/test_package_version_utils.py index 4de504b052..8add829195 100644 --- a/tests/agent_unittests/test_package_version_utils.py +++ b/tests/agent_unittests/test_package_version_utils.py @@ -27,12 +27,17 @@ ) # Notes: -# importlib.metadata was a provisional addition to the std library in Python 3.8 and 3.9 +# importlib.metadata was a provisional addition to the std library in PY38 and PY39 # while pkg_resources was deprecated. -# importlib.metadata is no longer provisional in Python 3.10+. It added some attributes +# importlib.metadata is no longer provisional in PY310+. It added some attributes # such as distribution_packages and removed pkg_resources. +IS_PY38_PLUS = sys.version_info[:2] >= (3, 8) IS_PY310_PLUS = sys.version_info[:2] >= (3, 10) +SKIP_IF_NOT_IMPORTLIB_METADATA = pytest.mark.skipif(not IS_PY38_PLUS, reason="importlib.metadata is not supported.") +SKIP_IF_IMPORTLIB_METADATA = pytest.mark.skipif( + IS_PY38_PLUS, reason="importlib.metadata is preferred over pkg_resources." +) SKIP_IF_NOT_PY310_PLUS = pytest.mark.skipif(not IS_PY310_PLUS, reason="These features were added in 3.10+") @@ -96,6 +101,7 @@ def test_get_package_version_tuple(monkeypatch, attr, value, expected_value): assert version == expected_value +@SKIP_IF_NOT_IMPORTLIB_METADATA @validate_function_called("importlib.metadata", "version") def test_importlib_dot_metadata(): # Test for importlib.metadata from the standard library. @@ -103,6 +109,14 @@ def test_importlib_dot_metadata(): assert version not in NULL_VERSIONS, version +@SKIP_IF_IMPORTLIB_METADATA +@validate_function_called("importlib_metadata", "version") +def test_importlib_underscore_metadata(): + # Test for importlib_metadata, a backport library available on PyPI. + version = get_package_version("pytest") + assert version not in NULL_VERSIONS, version + + @SKIP_IF_NOT_PY310_PLUS @validate_function_called("importlib.metadata", "packages_distributions") def test_mapping_import_to_distribution_packages(): @@ -110,6 +124,15 @@ def test_mapping_import_to_distribution_packages(): assert version not in NULL_VERSIONS, version +@SKIP_IF_IMPORTLIB_METADATA +@validate_function_called("pkg_resources", "get_distribution") +def test_pkg_resources_metadata(monkeypatch): + # Prevent importlib_metadata from being used by these tests + monkeypatch.setitem(sys.modules, "importlib_metadata", None) + version = get_package_version("pytest") + assert version not in NULL_VERSIONS, version + + def _getattr_deprecation_warning(attr): if attr == "__version__": warnings.warn("Testing deprecation warnings.", DeprecationWarning, stacklevel=2) diff --git a/tests/datastore_psycopg/test_cursor.py b/tests/datastore_psycopg/test_cursor.py index f37f00710e..ef5eb939f9 100644 --- a/tests/datastore_psycopg/test_cursor.py +++ b/tests/datastore_psycopg/test_cursor.py @@ -98,7 +98,7 @@ async def _execute(connection, cursor, row_type, wrapper): # Consume inserted records to check that returning param functions records = [] while True: - records.append(await maybe_await(cursor.fetchone())) + records.append(cursor.fetchone()) if not cursor.nextset(): break assert len(records) == len(params) @@ -140,7 +140,7 @@ async def _exercise_db(connection, row_factory=None, use_cur_context=False, row_ try: cursor = connection.cursor(**kwargs) if use_cur_context: - if hasattr(cursor.__wrapped__, "__aenter__"): + if hasattr(cursor, "__aenter__"): async with cursor: await _execute(connection, cursor, row_type, wrapper) else: diff --git a/tests/datastore_psycopg/test_register.py b/tests/datastore_psycopg/test_register.py index dd605774f8..46ea9dfcb4 100644 --- a/tests/datastore_psycopg/test_register.py +++ b/tests/datastore_psycopg/test_register.py @@ -32,7 +32,7 @@ def test(): psycopg.types.json.set_json_loads(loads=lambda x: x, context=connection) psycopg.types.json.set_json_loads(loads=lambda x: x, context=cursor) - if hasattr(connection.__wrapped__, "__aenter__"): + if hasattr(connection, "__aenter__"): async def coro(): async with connection: @@ -69,7 +69,7 @@ async def test(): await maybe_await(cursor.execute(f"DROP TYPE if exists {type_name}")) - if hasattr(connection.__wrapped__, "__aenter__"): + if hasattr(connection, "__aenter__"): async def coro(): async with connection: diff --git a/tests/datastore_psycopg/test_rollback.py b/tests/datastore_psycopg/test_rollback.py index 41849fa8e3..2d652ee1ee 100644 --- a/tests/datastore_psycopg/test_rollback.py +++ b/tests/datastore_psycopg/test_rollback.py @@ -57,7 +57,7 @@ async def _exercise_db(connection): try: - if hasattr(connection.__wrapped__, "__aenter__"): + if hasattr(connection, "__aenter__"): async with connection: raise RuntimeError("error") else: diff --git a/tests/framework_starlette/test_application.py b/tests/framework_starlette/test_application.py index 2005e53c2c..cd5668fcb8 100644 --- a/tests/framework_starlette/test_application.py +++ b/tests/framework_starlette/test_application.py @@ -119,6 +119,7 @@ def test_exception_in_middleware(target_application, app_name): app = target_application[app_name] # Starlette >=0.15 and <0.17 raises an exception group instead of reraising the ValueError + # This only occurs on Python versions >=3.8 if (0, 15, 0) <= starlette_version < (0, 17, 0): from anyio._backends._asyncio import ExceptionGroup diff --git a/tests/framework_strawberry/_target_schema_async.py b/tests/framework_strawberry/_target_schema_async.py index e85ef8ae30..72234e79a6 100644 --- a/tests/framework_strawberry/_target_schema_async.py +++ b/tests/framework_strawberry/_target_schema_async.py @@ -14,6 +14,8 @@ from __future__ import annotations +from typing import List + import strawberry try: @@ -66,7 +68,7 @@ async def resolve_search(contains: str): class Query: library: Library = field(resolver=resolve_library) hello: str = field(resolver=resolve_hello) - search: list[Item] = field(resolver=resolve_search) + search: List[Item] = field(resolver=resolve_search) echo: str = field(resolver=resolve_echo) storage: Storage = field(resolver=resolve_storage) error: str | None = field(resolver=resolve_error) diff --git a/tests/framework_strawberry/_target_schema_sync.py b/tests/framework_strawberry/_target_schema_sync.py index 1504022af5..b4559763e1 100644 --- a/tests/framework_strawberry/_target_schema_sync.py +++ b/tests/framework_strawberry/_target_schema_sync.py @@ -14,7 +14,7 @@ from __future__ import annotations -from typing import Union +from typing import List, Union import strawberry @@ -56,12 +56,12 @@ class Magazine: class Library: id: int branch: str - magazine: list[Magazine] - book: list[Book] + magazine: List[Magazine] + book: List[Book] Item = Union[Book, Magazine] -Storage = list[str] +Storage = List[str] authors = [ @@ -138,7 +138,7 @@ def resolve_search(contains: str): class Query: library: Library = field(resolver=resolve_library) hello: str = field(resolver=resolve_hello) - search: list[Item] = field(resolver=resolve_search) + search: List[Item] = field(resolver=resolve_search) echo: str = field(resolver=resolve_echo) storage: Storage = field(resolver=resolve_storage) error: str | None = field(resolver=resolve_error) diff --git a/tests/mlmodel_sklearn/test_inference_events.py b/tests/mlmodel_sklearn/test_inference_events.py index 92b01727b9..d1fc0762b0 100644 --- a/tests/mlmodel_sklearn/test_inference_events.py +++ b/tests/mlmodel_sklearn/test_inference_events.py @@ -59,9 +59,9 @@ def _test(): _test() -label_type = "numeric" -true_label_value = "1.0" -false_label_value = "0.0" +label_type = "bool" if sys.version_info < (3, 8) else "numeric" +true_label_value = "True" if sys.version_info < (3, 8) else "1.0" +false_label_value = "False" if sys.version_info < (3, 8) else "0.0" pandas_df_bool_recorded_custom_events = [ ( {"type": "InferenceData"}, @@ -87,7 +87,7 @@ def test_pandas_df_bool_feature_event(): def _test(): import sklearn.tree - dtype_name = "boolean" + dtype_name = "bool" if sys.version_info < (3, 8) else "boolean" x_train = pd.DataFrame({"col1": [True, False], "col2": [True, False]}, dtype=dtype_name) y_train = pd.DataFrame({"label": [True, False]}, dtype=dtype_name) x_test = pd.DataFrame({"col1": [True], "col2": [True]}, dtype=dtype_name) diff --git a/tests/testing_support/certs/cert.pem b/tests/testing_support/certs/cert.pem index f56002fbb9..0bbbf3a170 100644 --- a/tests/testing_support/certs/cert.pem +++ b/tests/testing_support/certs/cert.pem @@ -1,87 +1,51 @@ This is not a secret key! This private key is used only for testing and is not functionally used in the agent. To generate a new key and certificate, use the following. -openssl req -noenc -newkey rsa:4096 -x509 -keyout cert.pem -out cert.pem -subj '/CN=localhost' -days 3650 -addext "subjectAltName = DNS.1:localhost,IP.1:127.0.0.1" - +openssl req -nodes -newkey rsa:2048 -x509 -keyout key.pem -out cert.pem -subj '/CN=localhost' -days 3650 -----BEGIN PRIVATE KEY----- -MIIJQwIBADANBgkqhkiG9w0BAQEFAASCCS0wggkpAgEAAoICAQDk8E5vrgXW21uo -+cqOQlotxS5w3q7y7YyVTbYgbHF/SlIdu4HpY4ycEnAjKYrAiPD5bWPIZhK0wHL0 -DQ5SqKw+zRBV+xRpubpRZrpYVjTwR/X26PEnhUZfikLk5/1Y88WGV0UcLzPk6Prx -IAd6w/s2I3hrg/ZKR0p6NHXB/0dabY9OPdX2wdR6Xg5Rd/+RHyvgXnxUxK2DfDBv -kp15wYHaLTMmcxrDEMYa0mh27tuXwtf7NyWBieJ9RvHasgxCkzdoYRwYc4qMCBOO -F7W9Q4LL79rMyJ3NdNcvT9moJmz0W8wuLcC5aXFpxOG1aj1ipZkaVQ8aflVl7M1H -Ug/PCBtXiieSR+58BoQNhG/wP0Qm2HZp+PQ33vX1/s5iQCeBSRizdi4Xf4p+glWt -f1vWDo0SjWDIDUif+HTu4oC/2ka2PJW5tLy6c02pbtMPFAgUg0Ep8CL8kx4iUORc -OJtiGvA4eaZTC8rQkVXh2c0uS4645QBEmOoYSNcx3KgggTcxHMMo6aW8+F3dQt8d -7YYp3YMXzZ2QNnGXIP8shUJjdz34XLErI/L19wycHtIqa4Hbtxl48e5XXzTORIJ3 -icDmIyne6Q0P7a/mYzjfFsXFuK8R+ogK+PqHSHnCIUjNmUxdPQ92C9jaEJ1/HFyf -bHGXHLP4hc5MD/kJ+7icbDeQSHZm7wIDAQABAoICAA8IhqYHv+NpeR3h9T6dNc2+ -nnuT69oQ5kPhm/2KEXPh3f2M1A2O12tiPJHahv14oJZIbB57MWxEHOhQuSmNYO4o -yhNTTvZYV1dEDyWA164Vk524kylcs4/PhPACGd1O+KAHOAcPRHGaKOxPhZ42o1bd -QmmQ+0nKX6Yhrr/j8vwJqLjjD5tKBBla9sa7wgD2EowDuFdaqOgy7f1Nm+CkZ9H7 -WNoEAfRgNBoLygdRTQMsrMEW0HQuqTw/vd72BR8UCrXkdpNWdvkWCK6yeOEqPzsE -D5KV8+LLctvs+uZzS4FKS+CWaYrjVSq0Xnvqs4g4RpL3levP8uyj/aDazyXxqtXX -dNJgWPX9Jer90JIUY7lnpxe/W1gW5qU1Q8g9XaYACIGJlUQAYLcRjnFZcIIG9579 -LW4J3DCw3/D93QQTD4j4xKyhBoAPEkaHaKp5RXe7Yw9XfXD5zGMGEvAZcXCxHaV1 -Hq5hJYULmjgukKhYUYGjN8UPezrg/4Jd/wOLee9ItTdlD3ihAp2MyDriMeGH41MO -zb+m63iazoT6bT5aMDm1cFUoaVx+WVVQr8S47jQr8c6pyoj2CYzP6t/J6ac0+grW -agp2RZNyLx5aMfAJt9plPKtLvsq2lC4eFL1ZMw4XJMEwEewlcDYGuLirGlDiSsOM -VtIheTqQftdcvS6i6/K1AoIBAQD1vHZtH3aVzZpH6Cwa9+ZdghAmX8e4boDe8Ra9 -q04+I1DHZAYUsxuP+0d6G/yQA9ihGay8Y/GwQCW+Kpss3RESUma/xbufS1+3PNXM -sSyo/PC90zUkN+dXdsK+aGbxv/22XYp7m0ieftorf/sWRCsmjE2vMdqG6mwWDolE -IIknhE/huc6T+QPPNc1AvOOGpA+dk94YkfW8zDVrqdbJPEBNt0KyXT5XTwyI8kPO -J84nn4iQijfQDEZDxKQifuNyJpjTpytf3mmLs8NpBUzhWe7Fhh5kTV9gvtZdWOq2 -AWZqw8DGjKhDKWNmuANNyoiwErLIaInIybnh8nIl0wgKLLR9AoIBAQDugDyIT4WR -URtNNmy6koSCqHtYoIv5wGjJT+zUBJwdZiNLbcysFcp/GPBz196FuZ8AoICD1HAd -ZdcaZtzXyk8KVv2NXIinbwXzemQc1wJzoo4rg2pSl4pU5A527M8MYHf9AfcArjnO -TK1kqrfVrPJpVVeX4PfRTw1eD0CoGxoiPzp0C9Wd/fbI44rjDUi7h+rSzeoc+VO+ -uueTxJUpG/0F9ieS9KIyRBRq5ALFCJwkA+lTT45CXFK8FUI1pkwt48lnDOiM+7XI -4eejnzSKmfyBeTjoMK7UBEksX8E43q55X2h77ezlUOySDizUvdcnrSZD7xXPLeIJ -kdNUqrQymADbAoIBAQCt4gvSr57T5caz9x+ufZgutqgC32eNo/PgzawPzjXxVkAE -t0xuPUbVnTM4vrD6nx4c8PP/4qDU3K9YXwGqv0sjMdeu/5YB4+341T1cOEqn0UPw -rpE97ajvhQPMhEfD7Nz0vEAPsxOxw4VRnp/nY5k9D66wt5AwQ5T0Dpkm8fbbVY7I -5Re+MUh2yVVR59cAIPtDv6w6qp2+WKm8Y1Ou1cmStIineb9xPGhcR0GfkR8ZfpO9 -43AW8XiO34hdOHhs/87IhdP1ZIY+6pbtq2h5VY/ViU/cHbvN03wQVajP3THBfn7c -gA9YZuMFflQoKZaLMM/9a6uDvuqfbVVEWo2n1XZpAoIBAFqDgHWa+G32Ag6DoTAN -ewy7NFSmWXkndJ0yIAc22KivoqV1vj9w5bDmnhrYyjKmB5oNT7i4XvRJOiFi+F1N -AkJCUWfcvmAM2o1U3bm0P9Hy11HcRfWiXXVqN7ManFluIxt6K2uus3F/2C5kO/Bz -+mvPX7bcQjDFd6VC1J736islI+H2u9OCFq6W7JbO69N/+baXP0pPtWClPk3uRU2c -uaIRkWNMRGIfREBs2EA+zEM+2MYtYyf8Mcn/p2kE+9ROppjdZURcItliIq8ONLqF -Rjc88kPsde0w0zRsAsC6giy98MFXwpgk5iNoDcuPYKBGLkeJ7RT7rNVE6pcvUcQB -vBECggEBAKyRPnOASM6n2WagyvkzNYFOhcPR/XmcBoiJdVE+XIJXmhXk7/sctxNU -BrMlawTZZOyHSqnIQ47bO+M+6YF4q3avdsqJjSPuhgDSHkEr5kuzoMbHCro5xKQ/ -Gi/TkgO+Orf6s5q1SubLA5Oe2DHFX6GVBWMpk3iqFkViJ9Vowndnu8CdewW9UGmI -zoobm3k9yqk/f7WnM4mzEFm4LW1j2Ke21frpsqqL6BTDsJrcT/E+8mW4NLjjGuAT -du74BILJK4MbvZAR+nTj0bMQukaVVNvFgETfXnTyK/rzM7w3f98g141IddAQd48e -IF6rWffrLUSEs02xLX3zXw56FK2qLbo= +MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDYF0U/0zXikonW +Ez532avkDL1QbQ8Yz5ULMwZz8j+cLEhdw/4pQJ7Dox6KEZbsan1nZZqpcZWT0d39 +aY/AQ9udwZT+G4biRCQQHd3IaYdveDuq/MQXEiDmcs1CpCwyWjmfRnjCm2/c8wdW +JCBaRq1hG/hsZ5UKhJxIA9BUl3qPizr7qU/VwNK8+8QQ28EsnUrkLDPL2x1fkIzy +XR89d/NO97a02YV7WwEf8GH9gB0KLhIZzDDh/BM3olHc1BRlaqkATcuxPbWqKH53 +HqL5Wi9O8Pxe9OSBXbAOSlBhmRRUVFx4siRNV+Bkv3VOBCUtk2/5SQwJdxfkICbP +0YlrBPqFAgMBAAECggEBAKzbiJiy0xMIl9w4jqr+4+LMUhBo/T+iph5MVeggK8Q5 +JDZllwXW3GmxLbfStEEwOlqgy2SqKLYTlpmlfMmXPrHmbdILoQ2U5qhBy+0Khb2k +l06DXjT6Wnkd8pZRj81DoX6IuAcsogJEImVFBuBQU1cwMbw969p7FC0DZ/6TIgZ6 +KHvm5Z43uy/wcbHFa2PoMaVvyutKun1po3NG90FlVMJmQYiph2V4/kxcZo8wWXU2 +hE8cbL2g1pv60ZF3wZTWWhnSZTRB2uesW0opNmpwcqqQjQOczJ91y8B4BIjy1QTD +ICxUO9pEtOexNi3/JnzreByHxQt5g7wINbYxFk8MR40CgYEA751xj/B6jut3NMmr +bTLngjE1IAjv/8xEXKhfDAp6fgyU+ATbD8ysIllkch/k2Q0boiIB+XoQ/+KqB/pC +iGw6cGtY3ZF75u/NokHMhQVtHIu3CDbNYSCCtLekG3osXfZaaD4QJVHSrgBYkmez +Ty7my+Sub+uqizz4fK2DUmBpDyMCgYEA5t4HJRgCRQzz340ou+H63QoN5P1x5FlP +M8QpklclpU+dOJsbvmcHzbZJgvuZb6Vt18LuUYLWGeVRrpvUVCapJecklbnNF3wL +YIehBDIiJd2Qq8rbg+yKjNTElbaDWJP+RqPX8IGfvGr23Lsw34vDj/d7N9Ch6xm5 +XChbVCi6/jcCgYB0RhhnWrB+TfDIotwW307MNIitBOlBXaQGuoV02FjcdcqMF/8d +SZp2CJ7fam6ojN3N7Wa74uoA4cLUoDJM9QfeqZiz2/cd91v30qomGp357iphSAad +jSMgAsUVuFFzPypbz1ISagQr/2r7kGrIj9/bLRsgoGFfs7R4+9Hv1WzltQKBgEof +BKo7IBdtRisC1g4kSneHD9jyKgvHRK95DmPGiPafLfoLiofB6nZ4TPe5sZRvx2lb +U0pmODkOMABgVXZDB1F8+Xj8s0UT9U8jnGWNdvszPIx7T6j2W7FFamwqsdbRhPTH +C8BSzacfrGxHyTQsWjgxm6Ta3fFuS92zs0a84PRXAoGANEm47fczWIdWR0SmuEoL +gIGLBi8b2nKZWIeATNwTyWWvD/jEJJXIdjXYxYMK3iG0CCXIColvfoqzEKfNCkz4 +p5wl5yH6EOI+QVISNq7ovrtgLXpUUPPXA/FjYk74e5ITAd5Ute3nB32bX0jPQCGN +cXIVO2dC+mN517lRVQyF/GQ= -----END PRIVATE KEY----- -----BEGIN CERTIFICATE----- -MIIFJTCCAw2gAwIBAgIUPbDuIqZQBhN2JA/3iL3+FydryBcwDQYJKoZIhvcNAQEL -BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTI1MTIxNzE3MTUxOFoXDTM1MTIx -NTE3MTUxOFowFDESMBAGA1UEAwwJbG9jYWxob3N0MIICIjANBgkqhkiG9w0BAQEF -AAOCAg8AMIICCgKCAgEA5PBOb64F1ttbqPnKjkJaLcUucN6u8u2MlU22IGxxf0pS -HbuB6WOMnBJwIymKwIjw+W1jyGYStMBy9A0OUqisPs0QVfsUabm6UWa6WFY08Ef1 -9ujxJ4VGX4pC5Of9WPPFhldFHC8z5Oj68SAHesP7NiN4a4P2SkdKejR1wf9HWm2P -Tj3V9sHUel4OUXf/kR8r4F58VMStg3wwb5KdecGB2i0zJnMawxDGGtJodu7bl8LX -+zclgYnifUbx2rIMQpM3aGEcGHOKjAgTjhe1vUOCy+/azMidzXTXL0/ZqCZs9FvM -Li3AuWlxacThtWo9YqWZGlUPGn5VZezNR1IPzwgbV4onkkfufAaEDYRv8D9EJth2 -afj0N9719f7OYkAngUkYs3YuF3+KfoJVrX9b1g6NEo1gyA1In/h07uKAv9pGtjyV -ubS8unNNqW7TDxQIFINBKfAi/JMeIlDkXDibYhrwOHmmUwvK0JFV4dnNLkuOuOUA -RJjqGEjXMdyoIIE3MRzDKOmlvPhd3ULfHe2GKd2DF82dkDZxlyD/LIVCY3c9+Fyx -KyPy9fcMnB7SKmuB27cZePHuV180zkSCd4nA5iMp3ukND+2v5mM43xbFxbivEfqI -Cvj6h0h5wiFIzZlMXT0PdgvY2hCdfxxcn2xxlxyz+IXOTA/5Cfu4nGw3kEh2Zu8C -AwEAAaNvMG0wHQYDVR0OBBYEFH/Er2J8BaxQKdKlICmL6Ef3yG/KMB8GA1UdIwQY -MBaAFH/Er2J8BaxQKdKlICmL6Ef3yG/KMA8GA1UdEwEB/wQFMAMBAf8wGgYDVR0R -BBMwEYIJbG9jYWxob3N0hwR/AAABMA0GCSqGSIb3DQEBCwUAA4ICAQCTyP6lF+vI -0Vhdrbdh0X2XPYdfFc7X8lIxC8esZ9hrbjgEeTaRbGML+EKqKmUNTcOsJB4WYoEw -CNOMKGT0y4jVeKhowDfIgE8LvHalw1GF6Y4jTwfztW3Wu5DUiW/fjxyxs6OG3D7b -OYmBHfp/zGDtmpzKLipaZ+c5rsPPPW/3g+hptNzbZh32CYH1vMcGqZChDOa79hGL -K0Q1F67ge6rgkPcIS2Ppii5rNDWwGbii0tXkOI7L6rPhbn5a5jg1cbmxEr10+jtk -TOXWZ21f1KhuFOq+wojufoCBkkHsmMf+PfGvyrdlaj+N4n2TJbUCwMFvXHQ9ftir -mXaiM1N8oKx09jbnQxOEp6xH2qJoLaLHcDBklSals77IuLVgWpppGU5QbYj9j63P -4pzTyGsJtypSeR8U+CRl64CsE19X9ao1Szpflkmda5H22YVLg8sHAZ7y9lPWkHzQ -fgFzUdEvMVJ4OXoRsoeHZvBO2mBSTs6TwHq2Mk+uvAMg6CXRKBIFVkI9TBPC5yf+ -fEoXbJY/FtrILTWxr6FGXV0SZf5LWhhb4uPi9fmNSwuY+WhmVigjjJIZk8AzazjL -S3zu4Ljz4mZQguDTud5NujMBAFjgyJQN2cJ4/rA3e95iQ3WaHJU2APVqNvlq8/sN -yyQWFg0mZ1vsKZbl0vxPyn01KhzS58uPbw== +MIIDCTCCAfGgAwIBAgIUbytSUISOZeaoqVCzd/zLDhQgZ1owDQYJKoZIhvcNAQEL +BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTIxMDMwMzAxMzY1MloXDTMxMDMw +MTAxMzY1MlowFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBIjANBgkqhkiG9w0BAQEF +AAOCAQ8AMIIBCgKCAQEA2BdFP9M14pKJ1hM+d9mr5Ay9UG0PGM+VCzMGc/I/nCxI +XcP+KUCew6MeihGW7Gp9Z2WaqXGVk9Hd/WmPwEPbncGU/huG4kQkEB3dyGmHb3g7 +qvzEFxIg5nLNQqQsMlo5n0Z4wptv3PMHViQgWkatYRv4bGeVCoScSAPQVJd6j4s6 ++6lP1cDSvPvEENvBLJ1K5Cwzy9sdX5CM8l0fPXfzTve2tNmFe1sBH/Bh/YAdCi4S +Gcww4fwTN6JR3NQUZWqpAE3LsT21qih+dx6i+VovTvD8XvTkgV2wDkpQYZkUVFRc +eLIkTVfgZL91TgQlLZNv+UkMCXcX5CAmz9GJawT6hQIDAQABo1MwUTAdBgNVHQ4E +FgQUiC/0q2fQCAYC01Opw5iDBfhLNPQwHwYDVR0jBBgwFoAUiC/0q2fQCAYC01Op +w5iDBfhLNPQwDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAaxSo +gJh6X/ywmT3BXcS15MlAXufMm3uybVbMZjPszZ+vIPF65oelAbSnw/+JHp77fF7F +Erv19MGY8IlMEeUf9agXRF6JNVJD7N3i3zE/2GXoer9UOHQqz5/WWs4F17FAmZW8 +YkzMA70GVa20RedIMreEUxxIyN2eUL8xLfs3E9DEYovOldKfC0Ie1BHFMBhp1tja +6Ag91xyPqP9Pw9ofgS0DoYq6m2ltDNXLoWep1yi1OTwiTvI+GD6JJhmWbCjK0ofA +IkJENYq5tKA6yvQ2Roi9o6oixDJP/SGQtUKPGGRoFcN9gqn+IVC2XmvxHzTOxUWr +/FMyhRqe1k81s3T2hg== -----END CERTIFICATE----- diff --git a/tox.ini b/tox.ini index 597dafb4af..f61d90a775 100644 --- a/tox.ini +++ b/tox.ini @@ -20,7 +20,7 @@ ; framework_aiohttp-aiohttp01: aiohttp<2 ; framework_aiohttp-aiohttp0202: aiohttp<2.3 ; 3. Python version required. Uses the standard tox definitions. (https://tox.readthedocs.io/en/latest/config.html#tox-environments) -; Examples: py39,py310,py311,py312,py313,py314,py314t,pypy311 +; Examples: py38,py39,py310,py311,py312,py313,py314,pypy311 ; 4. Library and version (Optional). Used when testing multiple versions of the library, and may be omitted when only testing a single version. ; Versions should be specified with 2 digits per version number, so <3 becomes 02 and <3.5 becomes 0304. latest and master are also acceptable versions. ; Examples: uvicorn03, CherryPy0302, uvicornlatest @@ -40,7 +40,7 @@ ; ; Full Examples: ; - memcached-datastore_bmemcached-py313-memcached030 -; - linux-agent_unittests-py314-with_extensions +; - linux-agent_unittests-py38-with_extensions ; - python-adapter_gevent-py39 [tox] @@ -51,156 +51,167 @@ uv_seed = true skip_missing_interpreters = false envlist = # Linux Core Agent Test Suite - {linux,linux_arm64}-agent_features-{py39,py310,py311,py312,py313,py314}-{with,without}_extensions, + {linux,linux_arm64}-agent_features-{py38,py39,py310,py311,py312,py313,py314}-{with,without}_extensions, {linux,linux_arm64}-agent_features-pypy311-without_extensions, - {linux,linux_arm64}-agent_streaming-{py39,py310,py311,py312,py313,py314}-protobuf06-{with,without}_extensions, + {linux,linux_arm64}-agent_streaming-{py38,py39,py310,py311,py312,py313,py314}-protobuf06-{with,without}_extensions, {linux,linux_arm64}-agent_streaming-py39-protobuf{03,0319,04,05}-{with,without}_extensions, - {linux,linux_arm64}-agent_unittests-{py39,py310,py311,py312,py313,py314}-{with,without}_extensions, + {linux,linux_arm64}-agent_unittests-{py38,py39,py310,py311,py312,py313,py314}-{with,without}_extensions, {linux,linux_arm64}-agent_unittests-pypy311-without_extensions, - {linux,linux_arm64}-cross_agent-{py39,py310,py311,py312,py313,py314}-{with,without}_extensions, + {linux,linux_arm64}-cross_agent-{py38,py39,py310,py311,py312,py313,py314}-{with,without}_extensions, {linux,linux_arm64}-cross_agent-pypy311-without_extensions, # Windows Core Agent Test Suite - {windows,windows_arm64}-agent_features-{py313,py314,py314t}-{with,without}_extensions, + {windows,windows_arm64}-agent_features-{py313,py314}-{with,without}_extensions, # Windows grpcio wheels don't appear to be installable for Arm64 despite being available windows-agent_streaming-{py313,py314}-protobuf06-{with,without}_extensions, - {windows,windows_arm64}-agent_unittests-{py313,py314,py314t}-{with,without}_extensions, - {windows,windows_arm64}-cross_agent-{py313,py314,py314t}-{with,without}_extensions, + {windows,windows_arm64}-agent_unittests-{py313,py314}-{with,without}_extensions, + {windows,windows_arm64}-cross_agent-{py313,py314}-{with,without}_extensions, # Integration Tests (only run on Linux) + cassandra-datastore_cassandradriver-py38-cassandra032903, cassandra-datastore_cassandradriver-{py39,py310,py311,py312}-cassandralatest, - elasticsearchserver07-datastore_elasticsearch-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-elasticsearch07, - elasticsearchserver08-datastore_elasticsearch-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-elasticsearch08, - firestore-datastore_firestore-{py39,py310,py311,py312,py313,py314,py314t}, - grpc-framework_grpc-{py39,py310,py311,py312,py313,py314,py314t}-grpclatest, + elasticsearchserver07-datastore_elasticsearch-{py38,py39,py310,py311,py312,py313,py314,pypy311}-elasticsearch07, + elasticsearchserver08-datastore_elasticsearch-{py38,py39,py310,py311,py312,py313,py314,pypy311}-elasticsearch08, + firestore-datastore_firestore-{py38,py39,py310,py311,py312,py313,py314}, + grpc-framework_grpc-{py39,py310,py311,py312,py313,py314}-grpclatest, kafka-messagebroker_confluentkafka-py39-confluentkafka{0108,0107,0106}, - kafka-messagebroker_confluentkafka-{py39,py310,py311,py312,py313}-confluentkafkalatest, + kafka-messagebroker_confluentkafka-{py38,py39,py310,py311,py312,py313}-confluentkafkalatest, ;; Package not ready for Python 3.14 (confluent-kafka wheels not released) - ; kafka-messagebroker_confluentkafka-{py314,py314t}-confluentkafkalatest, - kafka-messagebroker_kafkapython-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-kafkapythonlatest, - kafka-messagebroker_kafkapython-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-kafkapythonnglatest, - memcached-datastore_aiomcache-{py39,py310,py311,py312,py313,py314,py314t}, - memcached-datastore_bmemcached-{py39,py310,py311,py312,py313,py314,py314t}, - memcached-datastore_memcache-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-memcached01, - memcached-datastore_pylibmc-{py39,py310,py311}, - memcached-datastore_pymemcache-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, - mongodb8-datastore_motor-{py39,py310,py311,py312,py313,py314,py314t}-motorlatest, - mongodb3-datastore_pymongo-{py39,py310,py311,py312}-pymongo03, - mongodb8-datastore_pymongo-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-pymongo04, - mysql-datastore_aiomysql-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, - mssql-datastore_pymssql-pymssqllatest-{py39,py310,py311,py312,py313,py314,py314t}, - mysql-datastore_mysql-mysqllatest-{py39,py310,py311,py312,py313,py314,py314t}, - mysql-datastore_mysqldb-{py39,py310,py311,py312,py313,py314,py314t}, - mysql-datastore_pymysql-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, - oracledb-datastore_oracledb-{py39,py310,py311,py312,py313,py314,py314t}-oracledblatest, - oracledb-datastore_oracledb-{py39,py313,py314,py314t}-oracledb02, + ; kafka-messagebroker_confluentkafka-py314-confluentkafkalatest, + kafka-messagebroker_kafkapython-{py38,py39,py310,py311,py312,py313,py314,pypy311}-kafkapythonlatest, + kafka-messagebroker_kafkapython-{py38,py39,py310,py311,py312,py313,py314,pypy311}-kafkapythonnglatest, + memcached-datastore_aiomcache-{py38,py39,py310,py311,py312,py313,py314}, + memcached-datastore_bmemcached-{py38,py39,py310,py311,py312,py313,py314}, + memcached-datastore_memcache-{py38,py39,py310,py311,py312,py313,py314,pypy311}-memcached01, + memcached-datastore_pylibmc-{py38,py39,py310,py311}, + memcached-datastore_pymemcache-{py38,py39,py310,py311,py312,py313,py314,pypy311}, + mongodb8-datastore_motor-{py38,py39,py310,py311,py312,py313,py314}-motorlatest, + mongodb3-datastore_pymongo-{py38,py39,py310,py311,py312}-pymongo03, + mongodb8-datastore_pymongo-{py38,py39,py310,py311,py312,py313,py314,pypy311}-pymongo04, + mysql-datastore_aiomysql-{py38,py39,py310,py311,py312,py313,py314,pypy311}, + mssql-datastore_pymssql-pymssqllatest-{py39,py310,py311,py312,py313,py314}, + mssql-datastore_pymssql-pymssql020301-py38, + mysql-datastore_mysql-mysqllatest-{py38,py39,py310,py311,py312,py313,py314}, + mysql-datastore_mysqldb-{py38,py39,py310,py311,py312,py313,py314}, + mysql-datastore_pymysql-{py38,py39,py310,py311,py312,py313,py314,pypy311}, + oracledb-datastore_oracledb-{py39,py310,py311,py312,py313,py314}-oracledblatest, + oracledb-datastore_oracledb-{py39,py313,py314}-oracledb02, oracledb-datastore_oracledb-{py39,py312}-oracledb01, - nginx-external_httpx-{py39,py310,py311,py312,py313,py314,py314t}, - postgres16-datastore_asyncpg-{py39,py310,py311,py312,py313,py314,py314t}, - postgres16-datastore_psycopg-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-psycopglatest, + nginx-external_httpx-{py38,py39,py310,py311,py312,py313,py314}, + postgres16-datastore_asyncpg-{py38,py39,py310,py311,py312,py313,py314}, + postgres16-datastore_psycopg-{py38,py39,py310,py311,py312,py313,py314,pypy311}-psycopglatest, postgres16-datastore_psycopg-py312-psycopg_{purepython,binary,compiled}0301, - postgres16-datastore_psycopg2-{py39,py310,py311,py312}-psycopg2latest, - postgres16-datastore_psycopg2cffi-{py39,py310,py311,py312}-psycopg2cffilatest, - postgres16-datastore_pyodbc-{py39,py310,py311,py312,py313,py314,py314t}-pyodbclatest, - postgres9-datastore_postgresql-{py39,py310,py311,py312,py313,py314,py314t}, - python-adapter_asgiref-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-asgireflatest, + postgres16-datastore_psycopg2-{py38,py39,py310,py311,py312}-psycopg2latest, + postgres16-datastore_psycopg2cffi-{py38,py39,py310,py311,py312}-psycopg2cffilatest, + postgres16-datastore_pyodbc-{py38,py39,py310,py311,py312,py313,py314}-pyodbclatest, + postgres9-datastore_postgresql-{py38,py39,py310,py311,py312,py313,py314}, + python-adapter_asgiref-{py38,py39,py310,py311,py312,py313,py314,pypy311}-asgireflatest, python-adapter_asgiref-py310-asgiref{0303,0304,0305,0306,0307}, - python-adapter_cheroot-{py39,py310,py311,py312,py313,py314,py314t}, - python-adapter_daphne-{py39,py310,py311,py312,py313,py314,py314t}-daphnelatest, - python-adapter_gevent-{py310,py311,py312,py313,py314,py314t}, - python-adapter_gunicorn-{py39,py310,py311,py312,py313}-aiohttp03-gunicornlatest, + python-adapter_cheroot-{py38,py39,py310,py311,py312,py313,py314}, + python-adapter_daphne-{py38,py39,py310,py311,py312,py313,py314}-daphnelatest, + python-adapter_gevent-{py38,py310,py311,py312,py313,py314}, + python-adapter_gunicorn-{py38,py39,py310,py311,py312,py313}-aiohttp03-gunicornlatest, ;; Package not ready for Python 3.14 (aiohttp's worker not updated) - ; python-adapter_gunicorn-{py314,py314t}-aiohttp03-gunicornlatest, - python-adapter_hypercorn-{py39,py310,py311,py312,py313,py314,py314t}-hypercornlatest, - python-adapter_mcp-{py310,py311,py312,py313,py314,py314t}, - python-adapter_uvicorn-{py39,py310,py311,py312,py313,py314,py314t}-uvicornlatest, - python-adapter_waitress-{py39,py310,py311,py312,py313,py314,py314t}-waitresslatest, - python-application_celery-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-celerylatest, + ; python-adapter_gunicorn-py314-aiohttp03-gunicornlatest, + python-adapter_hypercorn-{py310,py311,py312,py313,py314}-hypercornlatest, + python-adapter_hypercorn-{py38,py39}-hypercorn{0010,0011,0012,0013}, + python-adapter_mcp-{py310,py311,py312,py313,py314}, + python-adapter_uvicorn-{py39,py310,py311,py312,py313,py314}-uvicornlatest, + python-adapter_uvicorn-py38-uvicorn020, + python-adapter_waitress-{py38,py39,py310,py311,py312,py313,py314}-waitresslatest, + python-application_celery-{py38,py39,py310,py311,py312,py313,py314,pypy311}-celerylatest, python-application_celery-py311-celery{0504,0503,0502}, - python-component_djangorestframework-{py39,py310,py311,py312,py313,py314,py314t}-djangorestframeworklatest, - python-component_flask_rest-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-flaskrestxlatest, - python-component_graphqlserver-{py39,py310,py311,py312}, + python-component_djangorestframework-{py38,py39,py310,py311,py312,py313,py314}-djangorestframeworklatest, + python-component_flask_rest-{py38,py39,py310,py311,py312,py313,py314,pypy311}-flaskrestxlatest, + python-component_graphqlserver-{py38,py39,py310,py311,py312}, ;; Tests need to be updated to support newer graphql-server/sanic versions - ; python-component_graphqlserver-{py313,py314,py314t}, - python-component_tastypie-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-tastypielatest, - python-coroutines_asyncio-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, - python-datastore_sqlite-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, - python-external_aiobotocore-{py39,py310,py311,py312,py313}-aiobotocorelatest, + ; python-component_graphqlserver-{py313,py314}, + python-component_tastypie-{py38,py39,py310,py311,py312,py313,py314,pypy311}-tastypielatest, + python-coroutines_asyncio-{py38,py39,py310,py311,py312,py313,py314,pypy311}, + python-datastore_sqlite-{py38,py39,py310,py311,py312,py313,py314,pypy311}, + python-external_aiobotocore-{py38,py39,py310,py311,py312,py313}-aiobotocorelatest, ;; Package not ready for Python 3.14 (hangs when running) - ; python-external_aiobotocore-{py314,py314t}-aiobotocorelatest, - python-external_botocore-{py39,py310,py311,py312,py313,py314,py314t}-botocorelatest, + ; python-external_aiobotocore-py314-aiobotocorelatest, + python-external_botocore-{py38,py39,py310,py311,py312,py313,py314}-botocorelatest, python-external_botocore-{py311}-botocorelatest-langchain, python-external_botocore-py310-botocore0125, python-external_botocore-py311-botocore0128, - python-external_feedparser-{py39,py310,py311,py312,py313,py314,py314t}-feedparser06, - python-external_http-{py39,py310,py311,py312,py313,py314,py314t}, - python-external_httplib-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, - python-external_httplib2-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, + python-external_feedparser-{py38,py39,py310,py311,py312,py313,py314}-feedparser06, + python-external_http-{py38,py39,py310,py311,py312,py313,py314}, + python-external_httplib-{py38,py39,py310,py311,py312,py313,py314,pypy311}, + python-external_httplib2-{py38,py39,py310,py311,py312,py313,py314,pypy311}, # pyzeebe requires grpcio which does not support pypy - python-external_pyzeebe-{py39,py310,py311,py312,py313,py314,py314t}, - python-external_requests-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, - python-external_urllib3-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-urllib3latest, - python-external_urllib3-{py312,py313,py314,py314t,pypy311}-urllib30126, - python-framework_aiohttp-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-aiohttp03, - python-framework_ariadne-{py39,py310,py311,py312,py313,py314,py314t}-ariadnelatest, + python-external_pyzeebe-{py39,py310,py311,py312,py313,py314}, + python-external_requests-{py38,py39,py310,py311,py312,py313,py314,pypy311}, + python-external_urllib3-{py38,py39,py310,py311,py312,py313,py314,pypy311}-urllib3latest, + python-external_urllib3-{py312,py313,py314,pypy311}-urllib30126, + python-framework_aiohttp-{py38,py39,py310,py311,py312,py313,py314,pypy311}-aiohttp03, + python-framework_ariadne-{py38,py39,py310,py311,py312,py313,py314}-ariadnelatest, python-framework_azurefunctions-{py39,py310,py311,py312}, - python-framework_bottle-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-bottle0012, - python-framework_cherrypy-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-CherryPylatest, - python-framework_django-{py39,py310,py311,py312,py313,py314,py314t}-Djangolatest, + python-framework_bottle-{py38,py39,py310,py311,py312,py313,py314,pypy311}-bottle0012, + python-framework_cherrypy-{py38,py39,py310,py311,py312,py313,py314,pypy311}-CherryPylatest, + python-framework_django-{py38,py39,py310,py311,py312,py313,py314}-Djangolatest, python-framework_django-py39-Django{0202,0300,0301,0302,0401}, - python-framework_falcon-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-falconlatest, - python-framework_falcon-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-falconmaster, - python-framework_fastapi-{py39,py310,py311,py312,py313,py314,py314t}, - python-framework_flask-{py39,py310,py311,py312,pypy311}-flask02, + python-framework_falcon-{py39,py310,py311,py312,py313,py314,pypy311}-falconlatest, + python-framework_falcon-py38-falcon0410, + python-framework_falcon-{py39,py310,py311,py312,py313,py314,pypy311}-falconmaster, + python-framework_fastapi-{py38,py39,py310,py311,py312,py313,py314}, + python-framework_flask-{py38,py39,py310,py311,py312,pypy311}-flask02, + ; python-framework_flask-py38-flaskmaster fails, even with Flask-Compress<1.16 and coverage==7.61 for py38 + python-framework_flask-py38-flasklatest, ; flaskmaster tests disabled until they can be fixed - python-framework_flask-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-flask{latest}, - python-framework_graphene-{py39,py310,py311,py312,py313,py314,py314t}-graphenelatest, - python-component_graphenedjango-{py39,py310,py311,py312,py313,py314,py314t}-graphenedjangolatest, - python-framework_graphql-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-graphql03, - python-framework_graphql-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-graphqllatest, - python-framework_pyramid-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-Pyramidlatest, - python-framework_pyramid-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-cornicelatest, - python-framework_sanic-py311-sanic2406, - python-framework_sanic-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-saniclatest, + python-framework_flask-{py39,py310,py311,py312,py313,py314,pypy311}-flask{latest}, + python-framework_graphene-{py38,py39,py310,py311,py312,py313,py314}-graphenelatest, + python-component_graphenedjango-{py38,py39,py310,py311,py312,py313,py314}-graphenedjangolatest, + python-framework_graphql-{py38,py39,py310,py311,py312,py313,py314,pypy311}-graphql03, + python-framework_graphql-{py38,py39,py310,py311,py312,py313,py314,pypy311}-graphqllatest, + python-framework_pyramid-{py38,py39,py310,py311,py312,py313,py314,pypy311}-Pyramidlatest, + python-framework_pyramid-{py38,py39,py310,py311,py312,py313,py314,pypy311}-cornicelatest, + python-framework_sanic-py38-sanic2406, + python-framework_sanic-{py39,py310,py311,py312,py313,py314,pypy311}-saniclatest, + python-framework_sanic-py38-sanic2290, python-framework_starlette-{py310,pypy311}-starlette{0014,0015,0019,0028}, - python-framework_starlette-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-starlettelatest, - python-framework_strawberry-{py39,py310,py311,py312}-strawberry02352, - python-framework_strawberry-{py39,py310,py311,py312,py313,py314,py314t}-strawberrylatest, - python-framework_tornado-{py39,py310,py311,py312,py313,py314,py314t}-tornadolatest, - ; Remove `python-framework_tornado-{py314,py314t}-tornadomaster` temporarily + python-framework_starlette-{py38,py39,py310,py311,py312,py313,py314,pypy311}-starlettelatest, + python-framework_starlette-{py38}-starlette002001, + python-framework_strawberry-{py38,py39,py310,py311,py312}-strawberry02352, + python-framework_strawberry-{py38,py39,py310,py311,py312,py313,py314}-strawberrylatest, + python-framework_tornado-{py38,py39,py310,py311,py312,py313,py314}-tornadolatest, + ; Remove `python-framework_tornado-py314-tornadomaster` temporarily python-framework_tornado-{py310,py311,py312,py313}-tornadomaster, - python-logger_logging-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, - python-logger_loguru-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-logurulatest, - python-logger_structlog-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-structloglatest, - python-mlmodel_autogen-{py310,py311,py312,py313,py314,py314t,pypy311}-autogen061, - python-mlmodel_autogen-{py310,py311,py312,py313,py314,py314t,pypy311}-autogenlatest, + python-logger_logging-{py38,py39,py310,py311,py312,py313,py314,pypy311}, + python-logger_loguru-{py38,py39,py310,py311,py312,py313,py314,pypy311}-logurulatest, + python-logger_structlog-{py38,py39,py310,py311,py312,py313,py314,pypy311}-structloglatest, + python-mlmodel_autogen-{py310,py311,py312,py313,py314,pypy311}-autogen061, + python-mlmodel_autogen-{py310,py311,py312,py313,py314,pypy311}-autogenlatest, python-mlmodel_strands-{py310,py311,py312,py313}-strandslatest, - python-mlmodel_gemini-{py39,py310,py311,py312,py313,py314,py314t}, + python-mlmodel_gemini-{py39,py310,py311,py312,py313,py314}, python-mlmodel_langchain-{py310,py311,py312,py313}, ;; Package not ready for Python 3.14 (type annotations not updated) - ; python-mlmodel_langchain-{py314,py314t}, - python-mlmodel_openai-openai0-{py39,py310,py311,py312}, - python-mlmodel_openai-openailatest-{py39,py310,py311,py312,py313,py314,py314t}, - python-mlmodel_sklearn-{py39,py310,py311,py312,py313,py314,py314t}-scikitlearnlatest, - python-template_genshi-{py39,py310,py311,py312,py313,py314,py314t}-genshilatest, - python-template_jinja2-{py39,py310,py311,py312,py313,py314,py314t}-jinja2latest, - python-template_mako-{py39,py310,py311,py312,py313,py314,py314t}, - rabbitmq-messagebroker_pika-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-pikalatest, - rabbitmq-messagebroker_kombu-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-kombulatest, - rabbitmq-messagebroker_kombu-{py39,py310,pypy311}-kombu050204, - redis-datastore_redis-{py39,py310,py311,pypy311}-redis04, - redis-datastore_redis-{py39,py310,py311,py312,pypy311}-redis05, - redis-datastore_redis-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-redislatest, - rediscluster-datastore_rediscluster-{py312,py313,py314,py314t,pypy311}-redislatest, - valkey-datastore_valkey-{py39,py310,py311,py312,py313,py314,py314t,pypy311}-valkeylatest, - solr-datastore_pysolr-{py39,py310,py311,py312,py313,py314,py314t,pypy311}, + ; python-mlmodel_langchain-py314, + python-mlmodel_openai-openai0-{py38,py39,py310,py311,py312}, + python-mlmodel_openai-openailatest-{py38,py39,py310,py311,py312,py313,py314}, + python-mlmodel_sklearn-{py38,py39,py310,py311,py312,py313,py314}-scikitlearnlatest, + python-template_genshi-{py38,py39,py310,py311,py312,py313,py314}-genshilatest, + python-template_jinja2-{py38,py39,py310,py311,py312,py313,py314}-jinja2latest, + python-template_mako-{py38,py39,py310,py311,py312,py313,py314}, + rabbitmq-messagebroker_pika-{py38,py39,py310,py311,py312,py313,py314,pypy311}-pikalatest, + rabbitmq-messagebroker_kombu-{py38,py39,py310,py311,py312,py313,py314,pypy311}-kombulatest, + rabbitmq-messagebroker_kombu-{py38,py39,py310,pypy311}-kombu050204, + redis-datastore_redis-{py38,py39,py310,py311,pypy311}-redis04, + redis-datastore_redis-{py38,py39,py310,py311,py312,pypy311}-redis05, + redis-datastore_redis-{py38,py39,py310,py311,py312,py313,py314,pypy311}-redislatest, + rediscluster-datastore_rediscluster-{py312,py313,py314,pypy311}-redislatest, + valkey-datastore_valkey-{py38,py39,py310,py311,py312,py313,py314,pypy311}-valkeylatest, + solr-datastore_pysolr-{py38,py39,py310,py311,py312,py313,py314,pypy311}, [testenv] deps = # Base Dependencies - {py310,py311,py312,py313,py314,py314t,pypy311}: pytest==9.0.2 - py39: pytest==8.4.2 - WebTest==3.0.7 + {py39,py310,py311,py312,py313,py314,pypy311}: pytest==8.4.1 + py38: pytest==8.3.5 + {py39,py310,py311,py312,py313,py314,pypy311}: WebTest==3.0.6 + py38: WebTest==3.0.1 + py313,py314: legacy-cgi==2.6.1 # cgi was removed from the stdlib in 3.13, and is required for WebTest iniconfig coverage @@ -222,8 +233,14 @@ deps = adapter_gunicorn-gunicorn19: gunicorn<20 adapter_gunicorn-gunicornlatest: gunicorn adapter_hypercorn-hypercornlatest: hypercorn[h3]!=0.18 + adapter_hypercorn-hypercorn0013: hypercorn[h3]<0.14 + adapter_hypercorn-hypercorn0012: hypercorn[h3]<0.13 + adapter_hypercorn-hypercorn0011: hypercorn[h3]<0.12 + adapter_hypercorn-hypercorn0010: hypercorn[h3]<0.11 adapter_hypercorn: niquests adapter_mcp: fastmcp + adapter_uvicorn-uvicorn020: uvicorn<0.21 + adapter_uvicorn-uvicorn020: uvloop<0.20 adapter_uvicorn-uvicornlatest: uvicorn adapter_uvicorn: typing-extensions adapter_uvicorn: uvloop @@ -262,7 +279,7 @@ deps = component_tastypie-tastypielatest: django-tastypie component_tastypie-tastypielatest: django<4.1 component_tastypie-tastypielatest: asgiref<3.7.1 # asgiref==3.7.1 only suppport Python 3.10+ - coroutines_asyncio-{py39,py310,py311,py312,py313,py314,py314t}: uvloop + coroutines_asyncio-{py38,py39,py310,py311,py312,py313,py314}: uvloop cross_agent: requests datastore_asyncpg: asyncpg datastore_aiomcache: aiomcache @@ -271,6 +288,7 @@ deps = datastore_aiomysql: sqlalchemy<2 datastore_bmemcached: python-binary-memcached datastore_cassandradriver-cassandralatest: cassandra-driver + datastore_cassandradriver-cassandra032903: cassandra-driver<3.29.3 datastore_cassandradriver: twisted datastore_elasticsearch: requests datastore_elasticsearch: httpx @@ -301,6 +319,7 @@ deps = datastore_pymongo-pymongo03: pymongo<4.0 datastore_pymongo-pymongo04: pymongo<5.0 datastore_pymssql-pymssqllatest: pymssql + datastore_pymssql-pymssql020301: pymssql==2.3.1 datastore_pymysql: PyMySQL datastore_pymysql: cryptography datastore_pysolr: pysolr<4.0 @@ -349,6 +368,7 @@ deps = framework_django-Django0401: Django<4.2 framework_django-Djangolatest: Django framework_django-Djangomaster: https://github.com/django/django/archive/main.zip + framework_falcon-falcon0410: falcon<4.2 framework_falcon-falconlatest: falcon framework_falcon-falconmaster: https://github.com/falconry/falcon/archive/master.zip framework_fastapi: fastapi @@ -376,8 +396,12 @@ deps = framework_pyramid: routes framework_pyramid-cornicelatest: cornice framework_pyramid-Pyramidlatest: Pyramid + framework_sanic-sanic2290: sanic<22.9.1 framework_sanic-sanic2406: sanic<24.07 framework_sanic-saniclatest: sanic + ; This is the last version of tracerite that supports Python 3.8 + framework_sanic-sanic{2290,2406}: tracerite<1.1.2 + framework_sanic-sanic2290: websockets<11 ; For test_exception_in_middleware test, anyio is used: ; https://github.com/encode/starlette/pull/1157 ; but anyiolatest creates breaking changes to our tests @@ -387,6 +411,7 @@ deps = framework_starlette-starlette0014: starlette<0.15 framework_starlette-starlette0015: starlette<0.16 framework_starlette-starlette0019: starlette<0.20 + framework_starlette-starlette002001: starlette==0.20.1 framework_starlette-starlette0028: starlette<0.29 framework_starlette-starlettelatest: starlette<0.35 framework_strawberry: starlette From 93257cba51c9efd6d00b9e2aebd6329fdce9dcea Mon Sep 17 00:00:00 2001 From: Tim Pansino Date: Tue, 17 Feb 2026 09:31:26 -0800 Subject: [PATCH 081/124] Fix redis uninstrumented commands --- newrelic/hooks/datastore_redis.py | 10 ++++++++-- tests/datastore_redis/test_uninstrumented_methods.py | 3 ++- .../test_uninstrumented_rediscluster_methods.py | 1 + 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/newrelic/hooks/datastore_redis.py b/newrelic/hooks/datastore_redis.py index af14746692..3b1a63910d 100644 --- a/newrelic/hooks/datastore_redis.py +++ b/newrelic/hooks/datastore_redis.py @@ -28,10 +28,10 @@ "blmpop", "bzmpop", "client", - "command", "command_docs", "command_getkeysandflags", "command_info", + "command", "debug_segfault", "expiretime", "failover", @@ -41,6 +41,10 @@ "hexpiretime", "hgetdel", "hgetex", + "hotkeys_get", + "hotkeys_reset", + "hotkeys_start", + "hotkeys_stop", "hpersist", "hpexpire", "hpexpireat", @@ -77,8 +81,8 @@ "sentinel_set", "sentinel_slaves", "shutdown", - "sort", "sort_ro", + "sort", "spop", "srandmember", "unwatch", @@ -90,10 +94,12 @@ "vinfo", "vlinks", "vrandmember", + "vrange", "vrem", "vsetattr", "vsim", "watch", + "xcfgset", "zlexcount", "zrevrangebyscore", } diff --git a/tests/datastore_redis/test_uninstrumented_methods.py b/tests/datastore_redis/test_uninstrumented_methods.py index 87a6a4ac0d..34f20b3301 100644 --- a/tests/datastore_redis/test_uninstrumented_methods.py +++ b/tests/datastore_redis/test_uninstrumented_methods.py @@ -26,6 +26,7 @@ "MODULE_CALLBACKS", "MODULE_VERSION", "NAME", + "RESPONSE_CALLBACKS", "add_edge", "add_node", "append_bucket_size", @@ -72,6 +73,7 @@ "load_document", "load_external_module", "lock", + "maint_notifications_config", "name", "nodes", "parse_response", @@ -80,7 +82,6 @@ "register_script", "relationship_types", "response_callbacks", - "RESPONSE_CALLBACKS", "sentinel", "set_file", "set_path", diff --git a/tests/datastore_rediscluster/test_uninstrumented_rediscluster_methods.py b/tests/datastore_rediscluster/test_uninstrumented_rediscluster_methods.py index c926a2ae21..658c5d6519 100644 --- a/tests/datastore_rediscluster/test_uninstrumented_rediscluster_methods.py +++ b/tests/datastore_rediscluster/test_uninstrumented_rediscluster_methods.py @@ -67,6 +67,7 @@ "load_document", "load_external_module", "lock", + "maint_notifications_config", "name", "nodes", "parse_response", From 14789b24d70ef783d1cd4cf99ebc940d7e72a979 Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Tue, 17 Feb 2026 12:10:26 -0800 Subject: [PATCH 082/124] Add entity guid to Agent Control health file (#1640) * Update with guid. * Add entity guid testing. --- newrelic/core/agent_control_health.py | 5 +- .../test_agent_control_health_check.py | 71 ++++++++++++------- 2 files changed, 51 insertions(+), 25 deletions(-) diff --git a/newrelic/core/agent_control_health.py b/newrelic/core/agent_control_health.py index f78d26a152..4cfe4488c3 100644 --- a/newrelic/core/agent_control_health.py +++ b/newrelic/core/agent_control_health.py @@ -24,6 +24,7 @@ from urllib.parse import urlparse from urllib.request import url2pathname +from newrelic.api.time_trace import get_linking_metadata from newrelic.core.config import _environ_as_bool, _environ_as_int _logger = logging.getLogger(__name__) @@ -217,7 +218,8 @@ def update_to_healthy_status(self, protocol_error=False, collector_error=False): def write_to_health_file(self): status_time_unix_nano = time.time_ns() - + service_metadata = get_linking_metadata() + entity_guid = service_metadata.get("entity.guid", "") if service_metadata else "" try: health_dir_path = self.health_delivery_location if health_dir_path is None: @@ -229,6 +231,7 @@ def write_to_health_file(self): is_healthy = self.is_healthy # Cache property value to avoid multiple calls with health_file_path.open("w") as f: + f.write(f"entity_guid: {entity_guid}\n") f.write(f"healthy: {is_healthy}\n") f.write(f"status: {self.status_message}\n") f.write(f"start_time_unix_nano: {self.start_time_unix_nano}\n") diff --git a/tests/agent_features/test_agent_control_health_check.py b/tests/agent_features/test_agent_control_health_check.py index 84058a1b28..6adfa6f366 100644 --- a/tests/agent_features/test_agent_control_health_check.py +++ b/tests/agent_features/test_agent_control_health_check.py @@ -22,6 +22,7 @@ from testing_support.fixtures import initialize_agent from testing_support.http_client_recorder import HttpClientRecorder +from newrelic.common.object_wrapper import transient_function_wrapper from newrelic.config import _reset_configuration_done, initialize from newrelic.core.agent_control_health import HealthStatus, agent_control_health_instance from newrelic.core.agent_protocol import AgentProtocol @@ -30,6 +31,18 @@ from newrelic.network.exceptions import DiscardDataForRequest +@transient_function_wrapper("newrelic.api.time_trace", "get_service_linking_metadata") +def _wrap_get_service_linking_metadata(wrapped, instance, args, kwargs): + metadata = {"entity.type": "SERVICE"} + + # Set hardcoded values for testing so we can verify the correct entity guid was written to the health file + metadata["entity.name"] = "test-app" + metadata["entity.guid"] = "mock-entity-guid-12345" + metadata["hostname"] = "test-hostname" + + return metadata + + def get_health_file_contents(tmp_path): # Grab the file we just wrote to and read its contents health_file = list(Path(tmp_path).iterdir())[0] @@ -90,6 +103,7 @@ def test_agent_control_not_enabled(monkeypatch, tmp_path): assert not agent_control_health_instance().health_check_enabled +@_wrap_get_service_linking_metadata def test_write_to_file_healthy_status(monkeypatch, tmp_path): # Setup expected env vars to run agent control health check monkeypatch.setenv("NEW_RELIC_AGENT_CONTROL_ENABLED", "True") @@ -104,12 +118,14 @@ def test_write_to_file_healthy_status(monkeypatch, tmp_path): contents = get_health_file_contents(tmp_path) # Assert on contents of health file - assert len(contents) == 4 - assert contents[0] == "healthy: True\n" - assert contents[1] == "status: Healthy\n" - assert int(re.search(r"status_time_unix_nano: (\d+)", contents[3]).group(1)) > 0 + assert len(contents) == 5 + assert contents[0] == "entity_guid: mock-entity-guid-12345\n" + assert contents[1] == "healthy: True\n" + assert contents[2] == "status: Healthy\n" + assert int(re.search(r"status_time_unix_nano: (\d+)", contents[4]).group(1)) > 0 +@_wrap_get_service_linking_metadata def test_write_to_file_unhealthy_status(monkeypatch, tmp_path): # Setup expected env vars to run agent control health check monkeypatch.setenv("NEW_RELIC_AGENT_CONTROL_ENABLED", "True") @@ -126,14 +142,16 @@ def test_write_to_file_unhealthy_status(monkeypatch, tmp_path): contents = get_health_file_contents(tmp_path) # Assert on contents of health file - assert len(contents) == 5 - assert contents[0] == "healthy: False\n" - assert contents[1] == "status: Invalid license key (HTTP status code 401)\n" - assert contents[2] == "start_time_unix_nano: 1234567890\n" - assert int(re.search(r"status_time_unix_nano: (\d+)", contents[3]).group(1)) > 0 - assert contents[4] == "last_error: NR-APM-001\n" + assert len(contents) == 6 + assert contents[0] == "entity_guid: mock-entity-guid-12345\n" + assert contents[1] == "healthy: False\n" + assert contents[2] == "status: Invalid license key (HTTP status code 401)\n" + assert contents[3] == "start_time_unix_nano: 1234567890\n" + assert int(re.search(r"status_time_unix_nano: (\d+)", contents[4]).group(1)) > 0 + assert contents[5] == "last_error: NR-APM-001\n" +@_wrap_get_service_linking_metadata def test_no_override_on_unhealthy_shutdown(monkeypatch, tmp_path): # Setup expected env vars to run agent control health check monkeypatch.setenv("NEW_RELIC_AGENT_CONTROL_ENABLED", "True") @@ -152,10 +170,11 @@ def test_no_override_on_unhealthy_shutdown(monkeypatch, tmp_path): contents = get_health_file_contents(tmp_path) # Assert on contents of health file - assert len(contents) == 5 - assert contents[0] == "healthy: False\n" - assert contents[1] == "status: Invalid license key (HTTP status code 401)\n" - assert contents[4] == "last_error: NR-APM-001\n" + assert len(contents) == 6 + assert contents[0] == "entity_guid: mock-entity-guid-12345\n" + assert contents[1] == "healthy: False\n" + assert contents[2] == "status: Invalid license key (HTTP status code 401)\n" + assert contents[5] == "last_error: NR-APM-001\n" def test_health_check_running_threads(monkeypatch, tmp_path): @@ -186,6 +205,7 @@ def test_health_check_running_threads(monkeypatch, tmp_path): assert running_threads[1].name == "Agent-Control-Health-Main-Thread" +@_wrap_get_service_linking_metadata def test_proxy_error_status(monkeypatch, tmp_path): # Setup expected env vars to run agent control health check monkeypatch.setenv("NEW_RELIC_AGENT_CONTROL_ENABLED", "True") @@ -210,10 +230,11 @@ def test_proxy_error_status(monkeypatch, tmp_path): contents = get_health_file_contents(tmp_path) # Assert on contents of health file - assert len(contents) == 5 - assert contents[0] == "healthy: False\n" - assert contents[1] == "status: HTTP Proxy configuration error; response code 407\n" - assert contents[4] == "last_error: NR-APM-007\n" + assert len(contents) == 6 + assert contents[0] == "entity_guid: mock-entity-guid-12345\n" + assert contents[1] == "healthy: False\n" + assert contents[2] == "status: HTTP Proxy configuration error; response code 407\n" + assert contents[5] == "last_error: NR-APM-007\n" def test_multiple_activations_running_threads(monkeypatch, tmp_path): @@ -266,10 +287,11 @@ def test_update_to_healthy(monkeypatch, tmp_path): contents = get_health_file_contents(tmp_path) # Assert on contents of health file - assert contents[0] == "healthy: True\n" - assert contents[1] == "status: Healthy\n" + assert contents[1] == "healthy: True\n" + assert contents[2] == "status: Healthy\n" +@_wrap_get_service_linking_metadata def test_max_app_name_status(monkeypatch, tmp_path): # Setup expected env vars to run agent control health check monkeypatch.setenv("NEW_RELIC_AGENT_CONTROL_ENABLED", "True") @@ -285,7 +307,8 @@ def test_max_app_name_status(monkeypatch, tmp_path): contents = get_health_file_contents(tmp_path) # Assert on contents of health file - assert len(contents) == 5 - assert contents[0] == "healthy: False\n" - assert contents[1] == "status: The maximum number of configured app names (3) exceeded\n" - assert contents[4] == "last_error: NR-APM-006\n" + assert len(contents) == 6 + assert contents[0] == "entity_guid: mock-entity-guid-12345\n" + assert contents[1] == "healthy: False\n" + assert contents[2] == "status: The maximum number of configured app names (3) exceeded\n" + assert contents[5] == "last_error: NR-APM-006\n" From fa1ccf86b6aec0e72db91b4da2c3ef2716bd8102 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 17 Feb 2026 21:12:02 +0000 Subject: [PATCH 083/124] Bump the github_actions group with 3 updates (#1662) Bumps the github_actions group with 3 updates: [docker/build-push-action](https://github.com/docker/build-push-action), [aquasecurity/trivy-action](https://github.com/aquasecurity/trivy-action) and [github/codeql-action](https://github.com/github/codeql-action). Updates `docker/build-push-action` from 6.19.1 to 6.19.2 - [Release notes](https://github.com/docker/build-push-action/releases) - [Commits](https://github.com/docker/build-push-action/compare/601a80b39c9405e50806ae38af30926f9d957c47...10e90e3645eae34f1e60eeb005ba3a3d33f178e8) Updates `aquasecurity/trivy-action` from 0.33.1 to 0.34.0 - [Release notes](https://github.com/aquasecurity/trivy-action/releases) - [Commits](https://github.com/aquasecurity/trivy-action/compare/b6643a29fecd7f34b3597bc6acb0a98b03d33ff8...c1824fd6edce30d7ab345a9989de00bbd46ef284) Updates `github/codeql-action` from 4.32.2 to 4.32.3 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/github/codeql-action/compare/45cbd0c69e560cd9e7cd7f8c32362050c9b7ded2...9e907b5e64f6b83e7804b09294d44122997950d6) --- updated-dependencies: - dependency-name: docker/build-push-action dependency-version: 6.19.2 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions - dependency-name: aquasecurity/trivy-action dependency-version: 0.34.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: github/codeql-action dependency-version: 4.32.3 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> --- .github/workflows/build-ci-image.yml | 2 +- .github/workflows/trivy.yml | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/build-ci-image.yml b/.github/workflows/build-ci-image.yml index 8e94aa3439..d85b0d89fc 100644 --- a/.github/workflows/build-ci-image.yml +++ b/.github/workflows/build-ci-image.yml @@ -83,7 +83,7 @@ jobs: - name: Build and Push Image by Digest id: build - uses: docker/build-push-action@601a80b39c9405e50806ae38af30926f9d957c47 # 6.19.1 + uses: docker/build-push-action@10e90e3645eae34f1e60eeb005ba3a3d33f178e8 # 6.19.2 with: context: .github/containers platforms: ${{ matrix.platform }} diff --git a/.github/workflows/trivy.yml b/.github/workflows/trivy.yml index 04be27cdcd..75d65aa821 100644 --- a/.github/workflows/trivy.yml +++ b/.github/workflows/trivy.yml @@ -39,7 +39,7 @@ jobs: - name: Run Trivy vulnerability scanner in repo mode if: ${{ github.event_name == 'pull_request' }} - uses: aquasecurity/trivy-action@b6643a29fecd7f34b3597bc6acb0a98b03d33ff8 # v0.33.1 + uses: aquasecurity/trivy-action@c1824fd6edce30d7ab345a9989de00bbd46ef284 # v0.34.0 with: scan-type: "fs" ignore-unfixed: true @@ -50,7 +50,7 @@ jobs: - name: Run Trivy vulnerability scanner in repo mode if: ${{ github.event_name == 'schedule' }} - uses: aquasecurity/trivy-action@b6643a29fecd7f34b3597bc6acb0a98b03d33ff8 # v0.33.1 + uses: aquasecurity/trivy-action@c1824fd6edce30d7ab345a9989de00bbd46ef284 # v0.34.0 with: scan-type: "fs" ignore-unfixed: true @@ -61,6 +61,6 @@ jobs: - name: Upload Trivy scan results to GitHub Security tab if: ${{ github.event_name == 'schedule' }} - uses: github/codeql-action/upload-sarif@45cbd0c69e560cd9e7cd7f8c32362050c9b7ded2 # 4.32.2 + uses: github/codeql-action/upload-sarif@9e907b5e64f6b83e7804b09294d44122997950d6 # 4.32.3 with: sarif_file: "trivy-results.sarif" From 0d90dc8b426c231d21a16b02a424eac1b1cdc07b Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Tue, 17 Feb 2026 13:28:29 -0800 Subject: [PATCH 084/124] Update CI Image (#1649) * Update python installation method * Unpin tox * Update supported confluent-kafka versions --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- .github/containers/Dockerfile | 26 ++++++-------------------- tox.ini | 8 +------- 2 files changed, 7 insertions(+), 27 deletions(-) diff --git a/.github/containers/Dockerfile b/.github/containers/Dockerfile index 3f370a4a45..7538ea11f2 100644 --- a/.github/containers/Dockerfile +++ b/.github/containers/Dockerfile @@ -74,18 +74,6 @@ RUN if [ "${TARGETPLATFORM}" = "linux/amd64" ]; then export ARCH="x86_64"; else rm -rf /tmp/addlicense && \ chmod +x /usr/local/bin/addlicense -# Build librdkafka from source -ARG LIBRDKAFKA_VERSION=2.1.1 -RUN cd /tmp && \ - wget https://github.com/confluentinc/librdkafka/archive/refs/tags/v${LIBRDKAFKA_VERSION}.zip -O ./librdkafka.zip && \ - unzip ./librdkafka.zip && \ - rm ./librdkafka.zip && \ - cd ./librdkafka-${LIBRDKAFKA_VERSION} && \ - ./configure && \ - make all install && \ - cd /tmp && \ - rm -rf ./librdkafka-${LIBRDKAFKA_VERSION} - # Setup ODBC config RUN if [ "${TARGETPLATFORM}" = "linux/amd64" ]; then export ARCH="x86_64"; else export ARCH="aarch64"; fi && \ sed -i "s|Driver=psqlodbca.so|Driver=/usr/lib/${ARCH}-linux-gnu/odbc/psqlodbca.so|g" /etc/odbcinst.ini && \ @@ -109,13 +97,11 @@ ENV PATH="${HOME}/.local/bin:${PATH}" ENV UV_PYTHON_PREFERENCE="only-managed" ENV UV_LINK_MODE="copy" -# Install PyPy versions and rename shims -RUN uv python install -f pp3.11 pp3.10 -RUN mv "${HOME}/.local/bin/python3.11" "${HOME}/.local/bin/pypy3.11" && \ - mv "${HOME}/.local/bin/python3.10" "${HOME}/.local/bin/pypy3.10" - -# Install CPython versions -RUN uv python install -f cp3.14 cp3.14t cp3.13 cp3.12 cp3.11 cp3.10 cp3.9 cp3.8 +# Install CPython and PyPy versions +RUN uv python install -f \ + cp3.14 cp3.13 cp3.12 cp3.11 cp3.10 cp3.9 cp3.8 \ + pp3.11 pp3.10 \ + cp3.14t # Set default Python version to CPython 3.13 RUN uv python install -f --default cp3.13 @@ -130,7 +116,7 @@ EOF ENV UV_PYTHON_DOWNLOADS=never # Install tools with uv in isolated environments -RUN uv tool install tox==4.23.2 --with tox-uv && \ +RUN uv tool install tox --with tox-uv && \ uv tool install ruff && \ uv tool install pre-commit --with pre-commit-uv && \ uv tool install asv --with virtualenv diff --git a/tox.ini b/tox.ini index f61d90a775..f78cdf65fa 100644 --- a/tox.ini +++ b/tox.ini @@ -74,10 +74,7 @@ envlist = elasticsearchserver08-datastore_elasticsearch-{py38,py39,py310,py311,py312,py313,py314,pypy311}-elasticsearch08, firestore-datastore_firestore-{py38,py39,py310,py311,py312,py313,py314}, grpc-framework_grpc-{py39,py310,py311,py312,py313,py314}-grpclatest, - kafka-messagebroker_confluentkafka-py39-confluentkafka{0108,0107,0106}, - kafka-messagebroker_confluentkafka-{py38,py39,py310,py311,py312,py313}-confluentkafkalatest, - ;; Package not ready for Python 3.14 (confluent-kafka wheels not released) - ; kafka-messagebroker_confluentkafka-py314-confluentkafkalatest, + kafka-messagebroker_confluentkafka-{py38,py39,py310,py311,py312,py313,py314}-confluentkafkalatest, kafka-messagebroker_kafkapython-{py38,py39,py310,py311,py312,py313,py314,pypy311}-kafkapythonlatest, kafka-messagebroker_kafkapython-{py38,py39,py310,py311,py312,py313,py314,pypy311}-kafkapythonnglatest, memcached-datastore_aiomcache-{py38,py39,py310,py311,py312,py313,py314}, @@ -447,9 +444,6 @@ deps = messagebroker_pika-pikalatest: pika messagebroker_pika: tornado<5 messagebroker_confluentkafka-confluentkafkalatest: confluent-kafka - messagebroker_confluentkafka-confluentkafka0108: confluent-kafka<1.9 - messagebroker_confluentkafka-confluentkafka0107: confluent-kafka<1.8 - messagebroker_confluentkafka-confluentkafka0106: confluent-kafka<1.7 messagebroker_kafkapython-kafkapythonnglatest: kafka-python-ng messagebroker_kombu-kombulatest: kombu messagebroker_kombu-kombu050204: kombu<5.3.0 From 3f0d83b4ec2ac275e7386bf1b8bd25fce3acfabc Mon Sep 17 00:00:00 2001 From: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Date: Tue, 17 Feb 2026 13:48:54 -0800 Subject: [PATCH 085/124] Fix OracleDB Mismatched Signature (#1648) * Update signature of oracledb callproc * Update tests for callproc --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- newrelic/hooks/database_oracledb.py | 24 ++++++++++++++++++- .../test_async_connection.py | 3 ++- tests/datastore_oracledb/test_connection.py | 3 ++- 3 files changed, 27 insertions(+), 3 deletions(-) diff --git a/newrelic/hooks/database_oracledb.py b/newrelic/hooks/database_oracledb.py index b2888de464..20f6730e58 100644 --- a/newrelic/hooks/database_oracledb.py +++ b/newrelic/hooks/database_oracledb.py @@ -12,7 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -from newrelic.api.database_trace import register_database_client +from newrelic.api.database_trace import DatabaseTrace, register_database_client from newrelic.common.object_wrapper import wrap_object from newrelic.hooks.database_dbapi2 import ConnectionFactory as DBAPI2ConnectionFactory from newrelic.hooks.database_dbapi2 import ConnectionWrapper as DBAPI2ConnectionWrapper @@ -27,6 +27,16 @@ def __enter__(self): self.__wrapped__.__enter__() return self + # Signature differs from DBAPI 2.0 spec + def callproc(self, name, parameters=None, keyword_parameters=None): + with DatabaseTrace( + sql=f"CALL {name}", + dbapi2_module=self._nr_dbapi2_module, + connect_params=self._nr_connect_params, + source=self.__wrapped__.callproc, + ): + return self.__wrapped__.callproc(name=name, parameters=parameters, keyword_parameters=keyword_parameters) + class ConnectionWrapper(DBAPI2ConnectionWrapper): __cursor_wrapper__ = CursorWrapper @@ -45,6 +55,18 @@ async def __aenter__(self): await self.__wrapped__.__aenter__() return self + # Signature differs from DBAPI 2.0 spec + async def callproc(self, name, parameters=None, keyword_parameters=None): + with DatabaseTrace( + sql=f"CALL {name}", + dbapi2_module=self._nr_dbapi2_module, + connect_params=self._nr_connect_params, + source=self.__wrapped__.callproc, + ): + return await self.__wrapped__.callproc( + name=name, parameters=parameters, keyword_parameters=keyword_parameters + ) + class AsyncConnectionWrapper(DBAPI2AsyncConnectionWrapper): __cursor_wrapper__ = AsyncCursorWrapper diff --git a/tests/datastore_oracledb/test_async_connection.py b/tests/datastore_oracledb/test_async_connection.py index 60b2d088a4..4ee81a2397 100644 --- a/tests/datastore_oracledb/test_async_connection.py +++ b/tests/datastore_oracledb/test_async_connection.py @@ -60,7 +60,8 @@ async def execute_db_calls_with_cursor(cursor): END; """ ) - await cursor.callproc(PROCEDURE_NAME, [cursor.var(str)]) # Must specify a container for the OUT parameter + # Must specify a container for the OUT parameter + await cursor.callproc(name=PROCEDURE_NAME, parameters=[cursor.var(str)]) _test_execute_scoped_metrics = [ diff --git a/tests/datastore_oracledb/test_connection.py b/tests/datastore_oracledb/test_connection.py index f8789e78ff..b99b0ef366 100644 --- a/tests/datastore_oracledb/test_connection.py +++ b/tests/datastore_oracledb/test_connection.py @@ -54,7 +54,8 @@ def execute_db_calls_with_cursor(cursor): END; """ ) - cursor.callproc(PROCEDURE_NAME, [cursor.var(str)]) # Must specify a container for the OUT parameter + # Must specify a container for the OUT parameter + cursor.callproc(name=PROCEDURE_NAME, parameters=[cursor.var(str)]) _test_execute_scoped_metrics = [ From 1efa4a5ba2a2cf185738fa4b3b7ba9e9c0ea8497 Mon Sep 17 00:00:00 2001 From: Uma Annamalai Date: Wed, 18 Feb 2026 13:03:59 -0800 Subject: [PATCH 086/124] Add subcomponent attributes to agentic AI framework instrumentations (#1666) * Add Strands subcomponent attrs. * Update tests. * Cleanup. * Add subcomponent attrs. * Add validator to tool tests. * Cleanup tests. * Add subcomponent attribute to MCP instrumentation. * [MegaLinter] Apply linters fixes * Initial commit. * Add attrs to spans. * Update validators in tests. * Swap out subcomponent attribute names. * Update tests. * [MegaLinter] Apply linters fixes * Revert "Add subcomponent attribute to Autogen instrumentation. " --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --- newrelic/core/attribute.py | 1 + newrelic/hooks/adapter_mcp.py | 5 ++++- newrelic/hooks/mlmodel_langchain.py | 19 ++++++++++++++++++ newrelic/hooks/mlmodel_strands.py | 8 ++++++-- tests/adapter_mcp/test_mcp.py | 3 +++ tests/mlmodel_langchain/test_agents.py | 14 ++++++++++++- tests/mlmodel_langchain/test_tools.py | 15 +++++++++++++- tests/mlmodel_strands/test_agents.py | 14 ++++++++++++- .../mlmodel_strands/test_multiagent_graph.py | 20 ++++++++++++++++++- .../mlmodel_strands/test_multiagent_swarm.py | 20 ++++++++++++++++++- tests/mlmodel_strands/test_tools.py | 15 +++++++++++++- 11 files changed, 125 insertions(+), 9 deletions(-) diff --git a/newrelic/core/attribute.py b/newrelic/core/attribute.py index 79b9a56cb2..ed3e5bffa6 100644 --- a/newrelic/core/attribute.py +++ b/newrelic/core/attribute.py @@ -100,6 +100,7 @@ "response.headers.contentType", "response.status", "server.address", + "subcomponent", "zeebe.client.bpmnProcessId", "zeebe.client.messageName", "zeebe.client.correlationKey", diff --git a/newrelic/hooks/adapter_mcp.py b/newrelic/hooks/adapter_mcp.py index bcc8ae0a39..e891df0325 100644 --- a/newrelic/hooks/adapter_mcp.py +++ b/newrelic/hooks/adapter_mcp.py @@ -12,6 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. +import json import logging from newrelic.api.function_trace import FunctionTrace @@ -37,8 +38,10 @@ async def wrap_call_tool(wrapped, instance, args, kwargs): bound_args = bind_args(wrapped, args, kwargs) tool_name = bound_args.get("name") or "tool" function_trace_name = f"{func_name}/{tool_name}" + agentic_subcomponent_data = {"type": "APM-AI_TOOL", "name": tool_name} - with FunctionTrace(name=function_trace_name, group="Llm/tool/MCP", source=wrapped): + with FunctionTrace(name=function_trace_name, group="Llm/tool/MCP", source=wrapped) as ft: + ft._add_agent_attribute("subcomponent", json.dumps(agentic_subcomponent_data)) return await wrapped(*args, **kwargs) diff --git a/newrelic/hooks/mlmodel_langchain.py b/newrelic/hooks/mlmodel_langchain.py index e682f1bff3..a1c22e331f 100644 --- a/newrelic/hooks/mlmodel_langchain.py +++ b/newrelic/hooks/mlmodel_langchain.py @@ -12,6 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. +import json import logging import sys import time @@ -161,9 +162,11 @@ def invoke(self, *args, **kwargs): agent_id = str(uuid.uuid4()) agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) function_trace_name = f"invoke/{agent_name}" + agentic_subcomponent_data = {"type": "APM-AI_AGENT", "name": agent_name} ft = FunctionTrace(name=function_trace_name, group="Llm/agent/LangChain") ft.__enter__() + ft._add_agent_attribute("subcomponent", json.dumps(agentic_subcomponent_data)) try: return_val = self.__wrapped__.invoke(*args, **kwargs) except Exception: @@ -189,9 +192,11 @@ async def ainvoke(self, *args, **kwargs): agent_id = str(uuid.uuid4()) agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) function_trace_name = f"ainvoke/{agent_name}" + agentic_subcomponent_data = {"type": "APM-AI_AGENT", "name": agent_name} ft = FunctionTrace(name=function_trace_name, group="Llm/agent/LangChain") ft.__enter__() + ft._add_agent_attribute("subcomponent", json.dumps(agentic_subcomponent_data)) try: return_val = await self.__wrapped__.ainvoke(*args, **kwargs) except Exception: @@ -217,9 +222,11 @@ def stream(self, *args, **kwargs): agent_id = str(uuid.uuid4()) agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) function_trace_name = f"stream/{agent_name}" + agentic_subcomponent_data = {"type": "APM-AI_AGENT", "name": agent_name} ft = FunctionTrace(name=function_trace_name, group="Llm/agent/LangChain") ft.__enter__() + ft._add_agent_attribute("subcomponent", json.dumps(agentic_subcomponent_data)) try: return_val = self.__wrapped__.stream(*args, **kwargs) return_val = GeneratorProxy( @@ -242,9 +249,11 @@ def astream(self, *args, **kwargs): agent_id = str(uuid.uuid4()) agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) function_trace_name = f"astream/{agent_name}" + agentic_subcomponent_data = {"type": "APM-AI_AGENT", "name": agent_name} ft = FunctionTrace(name=function_trace_name, group="Llm/agent/LangChain") ft.__enter__() + ft._add_agent_attribute("subcomponent", json.dumps(agentic_subcomponent_data)) try: return_val = self.__wrapped__.astream(*args, **kwargs) return_val = AsyncGeneratorProxy( @@ -267,9 +276,11 @@ def transform(self, *args, **kwargs): agent_id = str(uuid.uuid4()) agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) function_trace_name = f"stream/{agent_name}" + agentic_subcomponent_data = {"type": "APM-AI_AGENT", "name": agent_name} ft = FunctionTrace(name=function_trace_name, group="Llm/agent/LangChain") ft.__enter__() + ft._add_agent_attribute("subcomponent", json.dumps(agentic_subcomponent_data)) try: return_val = self.__wrapped__.transform(*args, **kwargs) return_val = GeneratorProxy( @@ -292,9 +303,11 @@ def atransform(self, *args, **kwargs): agent_id = str(uuid.uuid4()) agent_event_dict = _construct_base_agent_event_dict(agent_name, agent_id, transaction) function_trace_name = f"astream/{agent_name}" + agentic_subcomponent_data = {"type": "APM-AI_AGENT", "name": agent_name} ft = FunctionTrace(name=function_trace_name, group="Llm/agent/LangChain") ft.__enter__() + ft._add_agent_attribute("subcomponent", json.dumps(agentic_subcomponent_data)) try: return_val = self.__wrapped__.atransform(*args, **kwargs) return_val = AsyncGeneratorProxy( @@ -512,8 +525,11 @@ def wrap_tool_sync_run(wrapped, instance, args, kwargs): except Exception: filtered_tool_input = tool_input + agentic_subcomponent_data = {"type": "APM-AI_TOOL", "name": tool_name} + ft = FunctionTrace(name=f"{wrapped.__name__}/{tool_name}", group="Llm/tool/LangChain") ft.__enter__() + ft._add_agent_attribute("subcomponent", json.dumps(agentic_subcomponent_data)) linking_metadata = get_trace_linking_metadata() try: return_val = wrapped(**run_args) @@ -573,8 +589,11 @@ async def wrap_tool_async_run(wrapped, instance, args, kwargs): except Exception: filtered_tool_input = tool_input + agentic_subcomponent_data = {"type": "APM-AI_TOOL", "name": tool_name} + ft = FunctionTrace(name=f"{wrapped.__name__}/{tool_name}", group="Llm/tool/LangChain") ft.__enter__() + ft._add_agent_attribute("subcomponent", json.dumps(agentic_subcomponent_data)) linking_metadata = get_trace_linking_metadata() try: return_val = await wrapped(**run_args) diff --git a/newrelic/hooks/mlmodel_strands.py b/newrelic/hooks/mlmodel_strands.py index a4ac6e5d72..bc045df190 100644 --- a/newrelic/hooks/mlmodel_strands.py +++ b/newrelic/hooks/mlmodel_strands.py @@ -12,6 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. +import json import logging import sys import uuid @@ -94,9 +95,12 @@ def wrap_stream_async(wrapped, instance, args, kwargs): func_name = callable_name(wrapped) agent_name = getattr(instance, "name", "agent") function_trace_name = f"{func_name}/{agent_name}" + agentic_subcomponent_data = {"type": "APM-AI_AGENT", "name": agent_name} ft = FunctionTrace(name=function_trace_name, group="Llm/agent/Strands") ft.__enter__() + ft._add_agent_attribute("subcomponent", json.dumps(agentic_subcomponent_data)) + linking_metadata = get_trace_linking_metadata() agent_id = str(uuid.uuid4()) @@ -105,7 +109,6 @@ def wrap_stream_async(wrapped, instance, args, kwargs): except Exception: raise - # For streaming responses, wrap with proxy and attach metadata try: # For streaming responses, wrap with proxy and attach metadata proxied_return_val = AsyncGeneratorProxy( @@ -126,7 +129,6 @@ def _record_agent_event_on_stop_iteration(self, transaction): # Use saved linking metadata to maintain correct span association linking_metadata = self._nr_metadata or get_trace_linking_metadata() self._nr_ft.__exit__(None, None, None) - try: strands_attrs = getattr(self, "_nr_strands_attrs", {}) @@ -352,9 +354,11 @@ def wrap_tool_executor__stream(wrapped, instance, args, kwargs): func_name = callable_name(wrapped) function_trace_name = f"{func_name}/{tool_name}" + agentic_subcomponent_data = {"type": "APM-AI_TOOL", "name": tool_name} ft = FunctionTrace(name=function_trace_name, group="Llm/tool/Strands") ft.__enter__() + ft._add_agent_attribute("subcomponent", json.dumps(agentic_subcomponent_data)) linking_metadata = get_trace_linking_metadata() tool_id = str(uuid.uuid4()) diff --git a/tests/adapter_mcp/test_mcp.py b/tests/adapter_mcp/test_mcp.py index 5ba6a81074..5424b57ca7 100644 --- a/tests/adapter_mcp/test_mcp.py +++ b/tests/adapter_mcp/test_mcp.py @@ -19,6 +19,7 @@ from mcp.server.fastmcp.tools import ToolManager from testing_support.ml_testing_utils import disabled_ai_monitoring_settings from testing_support.validators.validate_function_not_called import validate_function_not_called +from testing_support.validators.validate_span_events import validate_span_events from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics from newrelic.api.background_task import background_task @@ -57,6 +58,7 @@ def echo_prompt(message: str): rollup_metrics=[("Llm/tool/MCP/mcp.client.session:ClientSession.call_tool/add_exclamation", 1)], background_task=True, ) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "add_exclamation"}'}) @background_task() def test_tool_tracing_via_client_session(loop, fastmcp_server): async def _test(): @@ -75,6 +77,7 @@ async def _test(): rollup_metrics=[("Llm/tool/MCP/mcp.server.fastmcp.tools.tool_manager:ToolManager.call_tool/add_exclamation", 1)], background_task=True, ) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "add_exclamation"}'}) @background_task() def test_tool_tracing_via_tool_manager(loop): async def _test(): diff --git a/tests/mlmodel_langchain/test_agents.py b/tests/mlmodel_langchain/test_agents.py index 9ec7b20dff..6a1c471ecd 100644 --- a/tests/mlmodel_langchain/test_agents.py +++ b/tests/mlmodel_langchain/test_agents.py @@ -15,7 +15,7 @@ import pytest from langchain.messages import HumanMessage from langchain.tools import tool -from testing_support.fixtures import reset_core_stats_engine, validate_attributes +from testing_support.fixtures import dt_enabled, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, @@ -24,6 +24,7 @@ from testing_support.validators.validate_custom_event import validate_custom_event_count from testing_support.validators.validate_custom_events import validate_custom_events from testing_support.validators.validate_error_trace_attributes import validate_error_trace_attributes +from testing_support.validators.validate_span_events import validate_span_events from testing_support.validators.validate_transaction_error_event_count import validate_transaction_error_event_count from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics @@ -76,6 +77,7 @@ def add_exclamation(message: str) -> str: return f"{message}!" +@dt_enabled @reset_core_stats_engine() def test_agent(exercise_agent, create_agent_runnable, set_trace_info, method_name): @validate_custom_events(events_with_context_attrs(agent_recorded_event)) @@ -87,6 +89,8 @@ def test_agent(exercise_agent, create_agent_runnable, set_trace_info, method_nam background_task=True, ) @validate_attributes("agent", ["llm"]) + @validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "my_agent"}'}) + @validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "add_exclamation"}'}) @background_task(name="test_agent") def _test(): set_trace_info() @@ -100,6 +104,7 @@ def _test(): _test() +@dt_enabled @reset_core_stats_engine() @disabled_ai_monitoring_record_content_settings def test_agent_no_content(exercise_agent, create_agent_runnable, set_trace_info, method_name): @@ -112,6 +117,8 @@ def test_agent_no_content(exercise_agent, create_agent_runnable, set_trace_info, background_task=True, ) @validate_attributes("agent", ["llm"]) + @validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "my_agent"}'}) + @validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "add_exclamation"}'}) @background_task(name="test_agent_no_content") def _test(): set_trace_info() @@ -123,6 +130,7 @@ def _test(): _test() +@dt_enabled @reset_core_stats_engine() @validate_custom_event_count(count=0) def test_agent_outside_txn(exercise_agent, create_agent_runnable): @@ -130,6 +138,7 @@ def test_agent_outside_txn(exercise_agent, create_agent_runnable): exercise_agent(my_agent, PROMPT) +@dt_enabled @disabled_ai_monitoring_settings @reset_core_stats_engine() @validate_custom_event_count(count=0) @@ -140,6 +149,7 @@ def test_agent_disabled_ai_monitoring_events(exercise_agent, create_agent_runnab exercise_agent(my_agent, PROMPT) +@dt_enabled @reset_core_stats_engine() def test_agent_execution_error(exercise_agent, create_agent_runnable, set_trace_info, method_name, agent_runnable_type): # Add a wrapper to intentionally force an error in the Agent code @@ -159,6 +169,8 @@ def inject_exception(wrapped, instance, args, kwargs): background_task=True, ) @validate_attributes("agent", ["llm"]) + # Only an agent span is expected here and not a tool because the error is injected before the tool is called + @validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "my_agent"}'}) @background_task(name="test_agent_execution_error") def _test(): set_trace_info() diff --git a/tests/mlmodel_langchain/test_tools.py b/tests/mlmodel_langchain/test_tools.py index 19778997db..3ad250fb45 100644 --- a/tests/mlmodel_langchain/test_tools.py +++ b/tests/mlmodel_langchain/test_tools.py @@ -14,7 +14,7 @@ import pytest from langchain.messages import HumanMessage -from testing_support.fixtures import reset_core_stats_engine, validate_attributes +from testing_support.fixtures import dt_enabled, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( disabled_ai_monitoring_record_content_settings, events_with_context_attrs, @@ -23,6 +23,7 @@ from testing_support.validators.validate_custom_event import validate_custom_event_count from testing_support.validators.validate_custom_events import validate_custom_events from testing_support.validators.validate_error_trace_attributes import validate_error_trace_attributes +from testing_support.validators.validate_span_events import validate_span_events from testing_support.validators.validate_transaction_error_event_count import validate_transaction_error_event_count from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics @@ -95,6 +96,7 @@ ] +@dt_enabled @reset_core_stats_engine() def test_tool(exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name): @validate_custom_events(events_with_context_attrs(tool_recorded_event)) @@ -106,6 +108,8 @@ def test_tool(exercise_agent, set_trace_info, create_agent_runnable, add_exclama background_task=True, ) @validate_attributes("agent", ["llm"]) + @validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "my_agent"}'}) + @validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "add_exclamation"}'}) @background_task(name="test_tool") def _test(): set_trace_info() @@ -119,6 +123,7 @@ def _test(): _test() +@dt_enabled @reset_core_stats_engine() @disabled_ai_monitoring_record_content_settings def test_tool_no_content(exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name): @@ -131,6 +136,8 @@ def test_tool_no_content(exercise_agent, set_trace_info, create_agent_runnable, background_task=True, ) @validate_attributes("agent", ["llm"]) + @validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "my_agent"}'}) + @validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "add_exclamation"}'}) @background_task(name="test_tool_no_content") def _test(): set_trace_info() @@ -142,6 +149,7 @@ def _test(): _test() +@dt_enabled @reset_core_stats_engine() def test_tool_execution_error(exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name): @validate_transaction_error_event_count(1) @@ -157,6 +165,8 @@ def test_tool_execution_error(exercise_agent, set_trace_info, create_agent_runna background_task=True, ) @validate_attributes("agent", ["llm"]) + @validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "my_agent"}'}) + @validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "add_exclamation"}'}) @background_task(name="test_tool_execution_error") def _test(): set_trace_info() @@ -169,6 +179,7 @@ def _test(): _test() +@dt_enabled @reset_core_stats_engine() def test_tool_pre_execution_exception( exercise_agent, set_trace_info, create_agent_runnable, add_exclamation, tool_method_name @@ -190,6 +201,8 @@ def inject_exception(wrapped, instance, args, kwargs): background_task=True, ) @validate_attributes("agent", ["llm"]) + @validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "my_agent"}'}) + @validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "add_exclamation"}'}) @background_task(name="test_tool_pre_execution_exception") def _test(): set_trace_info() diff --git a/tests/mlmodel_strands/test_agents.py b/tests/mlmodel_strands/test_agents.py index b0a1965eea..93d635a716 100644 --- a/tests/mlmodel_strands/test_agents.py +++ b/tests/mlmodel_strands/test_agents.py @@ -14,7 +14,7 @@ import pytest from strands import Agent -from testing_support.fixtures import reset_core_stats_engine, validate_attributes +from testing_support.fixtures import dt_enabled, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( disabled_ai_monitoring_record_content_settings, disabled_ai_monitoring_settings, @@ -23,6 +23,7 @@ from testing_support.validators.validate_custom_event import validate_custom_event_count from testing_support.validators.validate_custom_events import validate_custom_events from testing_support.validators.validate_error_trace_attributes import validate_error_trace_attributes +from testing_support.validators.validate_span_events import validate_span_events from testing_support.validators.validate_transaction_error_event_count import validate_transaction_error_event_count from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics @@ -65,6 +66,7 @@ ] +@dt_enabled @reset_core_stats_engine() @validate_custom_events(events_with_context_attrs(agent_recorded_event)) @validate_custom_event_count(count=2) @@ -75,6 +77,8 @@ background_task=True, ) @validate_attributes("agent", ["llm"]) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "my_agent"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "add_exclamation"}'}) @background_task() def test_agent(exercise_agent, set_trace_info, single_tool_model): set_trace_info() @@ -97,6 +101,7 @@ def test_agent(exercise_agent, set_trace_info, single_tool_model): assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 +@dt_enabled @reset_core_stats_engine() @disabled_ai_monitoring_record_content_settings @validate_custom_events(agent_recorded_event) @@ -108,6 +113,8 @@ def test_agent(exercise_agent, set_trace_info, single_tool_model): background_task=True, ) @validate_attributes("agent", ["llm"]) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "my_agent"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "add_exclamation"}'}) @background_task() def test_agent_no_content(exercise_agent, set_trace_info, single_tool_model): set_trace_info() @@ -129,6 +136,7 @@ def test_agent_no_content(exercise_agent, set_trace_info, single_tool_model): assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 +@dt_enabled @reset_core_stats_engine() @validate_custom_event_count(count=0) def test_agent_outside_txn(exercise_agent, single_tool_model): @@ -150,6 +158,7 @@ def test_agent_outside_txn(exercise_agent, single_tool_model): assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 +@dt_enabled @disabled_ai_monitoring_settings @reset_core_stats_engine() @validate_custom_event_count(count=0) @@ -174,6 +183,7 @@ def test_agent_disabled_ai_monitoring_events(exercise_agent, set_trace_info, sin assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 +@dt_enabled @reset_core_stats_engine() @validate_transaction_error_event_count(1) @validate_error_trace_attributes(callable_name(ValueError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) @@ -186,6 +196,8 @@ def test_agent_disabled_ai_monitoring_events(exercise_agent, set_trace_info, sin background_task=True, ) @validate_attributes("agent", ["llm"]) +# Only an agent span is expected here and not a tool because the error is injected before the tool is called +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "my_agent"}'}) @background_task() def test_agent_execution_error(exercise_agent, set_trace_info, single_tool_model): # Add a wrapper to intentionally force an error in the Agent code diff --git a/tests/mlmodel_strands/test_multiagent_graph.py b/tests/mlmodel_strands/test_multiagent_graph.py index 7bd84fc901..216a6bd3a5 100644 --- a/tests/mlmodel_strands/test_multiagent_graph.py +++ b/tests/mlmodel_strands/test_multiagent_graph.py @@ -12,10 +12,11 @@ # See the License for the specific language governing permissions and # limitations under the License. -from testing_support.fixtures import reset_core_stats_engine, validate_attributes +from testing_support.fixtures import dt_enabled, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import disabled_ai_monitoring_settings, events_with_context_attrs from testing_support.validators.validate_custom_event import validate_custom_event_count from testing_support.validators.validate_custom_events import validate_custom_events +from testing_support.validators.validate_span_events import validate_span_events from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics from newrelic.api.background_task import background_task @@ -86,6 +87,7 @@ ] +@dt_enabled @reset_core_stats_engine() @validate_custom_events(events_with_context_attrs(tool_recorded_events)) @validate_custom_events(events_with_context_attrs(agent_recorded_events)) @@ -107,6 +109,10 @@ background_task=True, ) @validate_attributes("agent", ["llm"]) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "math_agent"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "calculate_sum"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "analysis_agent"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "analyze_result"}'}) @background_task() def test_multiagent_graph_invoke(set_trace_info, agent_graph): set_trace_info() @@ -123,6 +129,7 @@ def test_multiagent_graph_invoke(set_trace_info, agent_graph): ) +@dt_enabled @reset_core_stats_engine() @validate_custom_events(tool_recorded_events) @validate_custom_events(agent_recorded_events) @@ -144,6 +151,10 @@ def test_multiagent_graph_invoke(set_trace_info, agent_graph): background_task=True, ) @validate_attributes("agent", ["llm"]) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "math_agent"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "calculate_sum"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "analysis_agent"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "analyze_result"}'}) @background_task() def test_multiagent_graph_invoke_async(loop, set_trace_info, agent_graph): set_trace_info() @@ -162,6 +173,7 @@ async def _test(): loop.run_until_complete(_test()) +@dt_enabled @reset_core_stats_engine() @validate_custom_events(tool_recorded_events) @validate_custom_events(agent_recorded_events) @@ -183,6 +195,10 @@ async def _test(): background_task=True, ) @validate_attributes("agent", ["llm"]) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "math_agent"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "calculate_sum"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "analysis_agent"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "analyze_result"}'}) @background_task() def test_multiagent_graph_stream_async(loop, set_trace_info, agent_graph): set_trace_info() @@ -201,6 +217,7 @@ async def _test(): loop.run_until_complete(_test()) +@dt_enabled @disabled_ai_monitoring_settings @reset_core_stats_engine() @validate_custom_event_count(count=0) @@ -219,6 +236,7 @@ def test_multiagent_graph_invoke_disabled_ai_monitoring_events(set_trace_info, a ) +@dt_enabled @reset_core_stats_engine() @validate_custom_event_count(count=0) def test_multiagent_graph_invoke_outside_txn(agent_graph): diff --git a/tests/mlmodel_strands/test_multiagent_swarm.py b/tests/mlmodel_strands/test_multiagent_swarm.py index bbcbb3e27c..dc4ee95628 100644 --- a/tests/mlmodel_strands/test_multiagent_swarm.py +++ b/tests/mlmodel_strands/test_multiagent_swarm.py @@ -12,10 +12,11 @@ # See the License for the specific language governing permissions and # limitations under the License. -from testing_support.fixtures import reset_core_stats_engine, validate_attributes +from testing_support.fixtures import dt_enabled, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import disabled_ai_monitoring_settings, events_with_context_attrs from testing_support.validators.validate_custom_event import validate_custom_event_count from testing_support.validators.validate_custom_events import validate_custom_events +from testing_support.validators.validate_span_events import validate_span_events from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics from newrelic.api.background_task import background_task @@ -106,6 +107,7 @@ ] +@dt_enabled @reset_core_stats_engine() @validate_custom_events(events_with_context_attrs(tool_recorded_events)) @validate_custom_events(events_with_context_attrs(agent_recorded_events)) @@ -128,6 +130,10 @@ background_task=True, ) @validate_attributes("agent", ["llm"]) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "math_agent"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "calculate_sum"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "analysis_agent"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "analyze_result"}'}) @background_task() def test_multiagent_swarm_invoke(set_trace_info, agent_swarm): set_trace_info() @@ -145,6 +151,7 @@ def test_multiagent_swarm_invoke(set_trace_info, agent_swarm): ) +@dt_enabled @reset_core_stats_engine() @validate_custom_events(tool_recorded_events) @validate_custom_events(agent_recorded_events) @@ -167,6 +174,10 @@ def test_multiagent_swarm_invoke(set_trace_info, agent_swarm): background_task=True, ) @validate_attributes("agent", ["llm"]) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "math_agent"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "calculate_sum"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "analysis_agent"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "analyze_result"}'}) @background_task() def test_multiagent_swarm_invoke_async(loop, set_trace_info, agent_swarm): set_trace_info() @@ -186,6 +197,7 @@ async def _test(): loop.run_until_complete(_test()) +@dt_enabled @reset_core_stats_engine() @validate_custom_events(tool_recorded_events) @validate_custom_events(agent_recorded_events) @@ -208,6 +220,10 @@ async def _test(): background_task=True, ) @validate_attributes("agent", ["llm"]) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "math_agent"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "calculate_sum"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "analysis_agent"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "analyze_result"}'}) @background_task() def test_multiagent_swarm_stream_async(loop, set_trace_info, agent_swarm): set_trace_info() @@ -226,6 +242,7 @@ async def _test(): loop.run_until_complete(_test()) +@dt_enabled @disabled_ai_monitoring_settings @reset_core_stats_engine() @validate_custom_event_count(count=0) @@ -245,6 +262,7 @@ def test_multiagent_swarm_invoke_disabled_ai_monitoring_events(set_trace_info, a ) +@dt_enabled @reset_core_stats_engine() @validate_custom_event_count(count=0) def test_multiagent_swarm_invoke_outside_txn(agent_swarm): diff --git a/tests/mlmodel_strands/test_tools.py b/tests/mlmodel_strands/test_tools.py index a5e62ff3a3..bc9eb233c7 100644 --- a/tests/mlmodel_strands/test_tools.py +++ b/tests/mlmodel_strands/test_tools.py @@ -14,7 +14,7 @@ import pytest from strands import Agent -from testing_support.fixtures import reset_core_stats_engine, validate_attributes +from testing_support.fixtures import dt_enabled, reset_core_stats_engine, validate_attributes from testing_support.ml_testing_utils import ( disabled_ai_monitoring_record_content_settings, events_with_context_attrs, @@ -23,6 +23,7 @@ from testing_support.validators.validate_custom_event import validate_custom_event_count from testing_support.validators.validate_custom_events import validate_custom_events from testing_support.validators.validate_error_trace_attributes import validate_error_trace_attributes +from testing_support.validators.validate_span_events import validate_span_events from testing_support.validators.validate_transaction_error_event_count import validate_transaction_error_event_count from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics @@ -94,6 +95,7 @@ EXPECTED_ERROR_MESSAGES = ["Error: RuntimeError - Oops", "Error: Oops"] +@dt_enabled @reset_core_stats_engine() @validate_custom_events(events_with_context_attrs(tool_recorded_event)) @validate_custom_event_count(count=2) @@ -104,6 +106,8 @@ background_task=True, ) @validate_attributes("agent", ["llm"]) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "my_agent"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "add_exclamation"}'}) @background_task() def test_tool(exercise_agent, set_trace_info, single_tool_model, add_exclamation): set_trace_info() @@ -126,6 +130,7 @@ def test_tool(exercise_agent, set_trace_info, single_tool_model, add_exclamation assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 +@dt_enabled @reset_core_stats_engine() @disabled_ai_monitoring_record_content_settings @validate_custom_events(tool_events_sans_content(tool_recorded_event)) @@ -137,6 +142,8 @@ def test_tool(exercise_agent, set_trace_info, single_tool_model, add_exclamation background_task=True, ) @validate_attributes("agent", ["llm"]) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "my_agent"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "add_exclamation"}'}) @background_task() def test_tool_no_content(exercise_agent, set_trace_info, single_tool_model, add_exclamation): set_trace_info() @@ -158,6 +165,7 @@ def test_tool_no_content(exercise_agent, set_trace_info, single_tool_model, add_ assert response.metrics.tool_metrics["add_exclamation"].success_count == 1 +@dt_enabled @reset_core_stats_engine() def test_tool_execution_error(exercise_agent, set_trace_info, single_tool_model_error, add_exclamation): from strands.tools import PythonAgentTool @@ -178,6 +186,8 @@ def test_tool_execution_error(exercise_agent, set_trace_info, single_tool_model_ background_task=True, ) @validate_attributes("agent", ["llm"]) + @validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "my_agent"}'}) + @validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "add_exclamation"}'}) @background_task(name="test_tool_execution_error") def _test(): set_trace_info() @@ -201,6 +211,7 @@ def _test(): _test() +@dt_enabled @reset_core_stats_engine() @validate_transaction_error_event_count(1) @validate_error_trace_attributes(callable_name(ValueError), exact_attrs={"agent": {}, "intrinsic": {}, "user": {}}) @@ -213,6 +224,8 @@ def _test(): background_task=True, ) @validate_attributes("agent", ["llm"]) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_AGENT", "name": "my_agent"}'}) +@validate_span_events(count=1, exact_agents={"subcomponent": '{"type": "APM-AI_TOOL", "name": "add_exclamation"}'}) @background_task() def test_tool_pre_execution_exception(exercise_agent, set_trace_info, single_tool_model, add_exclamation): # Add a wrapper to intentionally force an error in the ToolExecutor._stream code to hit the exception path in From 7cb9b893a58c13ed56363eefac035b347b5cd9ec Mon Sep 17 00:00:00 2001 From: Hannah Stepanek Date: Thu, 19 Feb 2026 19:07:41 -0500 Subject: [PATCH 087/124] Hybrid core tracing rebased (#1646) * Reorder inheritance on span nodes (#1539) * Reorder inheritance on span nodes Core tracing will be adding a bunch of logic to the span_event method which is called via super on inheriting classes before those inheriting classes add additional attributes. In order for the core tracing logic to work correctly, this inheritance call order has to be reversed; the inheriting classes must first add the attributes and THEN call super. * Remove *args, **kwargs * [MegaLinter] Apply linters fixes --------- Co-authored-by: hmstepanek <30059933+hmstepanek@users.noreply.github.com> * Fix removal of process attr call (#1550) * Add `adaptive_sampling_target` setting & fix logic (#1549) * Fix removal of process attr call * Add adaptive_sampling_target setting & fix logic * Add a new setting: `distributed_tracing.sampler.adaptive_sampling_target` that can be used to configure the sampling target. * Previously the logic for remote parent sampled was slightly incorrect. The sampling value from the tracestate header was used to determine remote parent sampled, instead of from the parent header-this has been fixed. Additionally, the sampling value was only grabbed from the trace state and newrelic headers if there was a priority-this has been fixed too. * Log statements have been added to assist with sampling debug. --------- Co-authored-by: Lalleh Rafeei <84813886+lrafeei@users.noreply.github.com> * Add support for partial granularity type (#1532) * Fix error when shutdown_agent called from harvest thread (#1552) * fix(aiomysql): avoid wrapping pooled connections multiple times (#1553) * fix(aiomysql): avoid wrapping pooled connections multiple times * Move and rewrite regression test * Tweak implementation of fix --------- Co-authored-by: Tim Pansino * Fix structlog tests (#1556) * Bump the github_actions group with 4 updates (#1555) Bumps the github_actions group with 4 updates: [actions/upload-artifact](https://github.com/actions/upload-artifact), [actions/download-artifact](https://github.com/actions/download-artifact), [astral-sh/setup-uv](https://github.com/astral-sh/setup-uv) and [github/codeql-action](https://github.com/github/codeql-action). Updates `actions/upload-artifact` from 4.6.2 to 5.0.0 - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](https://github.com/actions/upload-artifact/compare/ea165f8d65b6e75b540449e92b4886f43607fa02...330a01c490aca151604b8cf639adc76d48f6c5d4) Updates `actions/download-artifact` from 5.0.0 to 6.0.0 - [Release notes](https://github.com/actions/download-artifact/releases) - [Commits](https://github.com/actions/download-artifact/compare/634f93cb2916e3fdff6788551b99b062d0335ce0...018cc2cf5baa6db3ef3c5f8a56943fffe632ef53) Updates `astral-sh/setup-uv` from 7.1.1 to 7.1.2 - [Release notes](https://github.com/astral-sh/setup-uv/releases) - [Commits](https://github.com/astral-sh/setup-uv/compare/2ddd2b9cb38ad8efd50337e8ab201519a34c9f24...85856786d1ce8acfbcc2f13a5f3fbd6b938f9f41) Updates `github/codeql-action` from 4.30.9 to 4.31.0 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/github/codeql-action/compare/16140ae1a102900babc80a33c44059580f687047...4e94bd11f71e507f7f87df81788dff88d1dacbfb) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-version: 5.0.0 dependency-type: direct:production update-type: version-update:semver-major dependency-group: github_actions - dependency-name: actions/download-artifact dependency-version: 6.0.0 dependency-type: direct:production update-type: version-update:semver-major dependency-group: github_actions - dependency-name: astral-sh/setup-uv dependency-version: 7.1.2 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions - dependency-name: github/codeql-action dependency-version: 4.31.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> * Add instrumentation for new kinesis method (#1557) * Add free-threaded Python to CI (#1562) * Bump github/codeql-action in the github_actions group (#1566) Bumps the github_actions group with 1 update: [github/codeql-action](https://github.com/github/codeql-action). Updates `github/codeql-action` from 4.31.0 to 4.31.2 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/github/codeql-action/compare/4e94bd11f71e507f7f87df81788dff88d1dacbfb...0499de31b99561a6d14a36a5f662c2a54f91beee) --- updated-dependencies: - dependency-name: github/codeql-action dependency-version: 4.31.2 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Region aware/ Claude 3+ bedrock support (#1561) * Modify extractor logic. * Add support for Claude Sonnet 3+ and region aware models. * Update claude content extraction logic. * Add support for Claude Sonnet 3+ and region aware models. * Update claude content extraction logic. * Add testing for aiobotocore. * Restore newline. --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Fix notice_error logic for non-iterable exceptions. (#1564) * Revert "Fix notice_error logic for non-iterable exceptions. (#1564)" (#1568) This reverts commit b9d9d3bf97890645f30089e66dfffa3080acaf64. * Add additional trace points for AWS Kinesis (#1569) * Enable environment variables for attribute filters (#1558) * Enable env vars for attribute filters * [MegaLinter] Apply linters fixes * Trigger tests * Change attribute filters to space delimited * Fix test assertion --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Tim Pansino * Update version of cibuildwheel to latest (#1570) * Force uv to use non-emulated Python on windows arm64 (#1567) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Add support 4 partial granularity tracing * Move config consolidation into global settings * [MegaLinter] Apply linters fixes * Move inifinte tracing override to server side config * [MegaLinter] Apply linters fixes * Fix failing event loop tests * Fixup: linter * [MegaLinter] Apply linters fixes --------- Signed-off-by: dependabot[bot] Co-authored-by: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Co-authored-by: canonrock16 <35710450+canonrock16@users.noreply.github.com> Co-authored-by: Tim Pansino Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Uma Annamalai Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Lalleh Rafeei <84813886+lrafeei@users.noreply.github.com> Co-authored-by: hmstepanek <30059933+hmstepanek@users.noreply.github.com> * Add metrics for tracking partial granularity (#1560) * Add SamplerProxy (#1559) * Add adaptive sampling target config options & instances (#1577) * Fix error when shutdown_agent called from harvest thread (#1552) * fix(aiomysql): avoid wrapping pooled connections multiple times (#1553) * fix(aiomysql): avoid wrapping pooled connections multiple times * Move and rewrite regression test * Tweak implementation of fix --------- Co-authored-by: Tim Pansino * Fix structlog tests (#1556) * Bump the github_actions group with 4 updates (#1555) Bumps the github_actions group with 4 updates: [actions/upload-artifact](https://github.com/actions/upload-artifact), [actions/download-artifact](https://github.com/actions/download-artifact), [astral-sh/setup-uv](https://github.com/astral-sh/setup-uv) and [github/codeql-action](https://github.com/github/codeql-action). Updates `actions/upload-artifact` from 4.6.2 to 5.0.0 - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](https://github.com/actions/upload-artifact/compare/ea165f8d65b6e75b540449e92b4886f43607fa02...330a01c490aca151604b8cf639adc76d48f6c5d4) Updates `actions/download-artifact` from 5.0.0 to 6.0.0 - [Release notes](https://github.com/actions/download-artifact/releases) - [Commits](https://github.com/actions/download-artifact/compare/634f93cb2916e3fdff6788551b99b062d0335ce0...018cc2cf5baa6db3ef3c5f8a56943fffe632ef53) Updates `astral-sh/setup-uv` from 7.1.1 to 7.1.2 - [Release notes](https://github.com/astral-sh/setup-uv/releases) - [Commits](https://github.com/astral-sh/setup-uv/compare/2ddd2b9cb38ad8efd50337e8ab201519a34c9f24...85856786d1ce8acfbcc2f13a5f3fbd6b938f9f41) Updates `github/codeql-action` from 4.30.9 to 4.31.0 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/github/codeql-action/compare/16140ae1a102900babc80a33c44059580f687047...4e94bd11f71e507f7f87df81788dff88d1dacbfb) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-version: 5.0.0 dependency-type: direct:production update-type: version-update:semver-major dependency-group: github_actions - dependency-name: actions/download-artifact dependency-version: 6.0.0 dependency-type: direct:production update-type: version-update:semver-major dependency-group: github_actions - dependency-name: astral-sh/setup-uv dependency-version: 7.1.2 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions - dependency-name: github/codeql-action dependency-version: 4.31.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> * Add instrumentation for new kinesis method (#1557) * Add free-threaded Python to CI (#1562) * Bump github/codeql-action in the github_actions group (#1566) Bumps the github_actions group with 1 update: [github/codeql-action](https://github.com/github/codeql-action). Updates `github/codeql-action` from 4.31.0 to 4.31.2 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/github/codeql-action/compare/4e94bd11f71e507f7f87df81788dff88d1dacbfb...0499de31b99561a6d14a36a5f662c2a54f91beee) --- updated-dependencies: - dependency-name: github/codeql-action dependency-version: 4.31.2 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Region aware/ Claude 3+ bedrock support (#1561) * Modify extractor logic. * Add support for Claude Sonnet 3+ and region aware models. * Update claude content extraction logic. * Add support for Claude Sonnet 3+ and region aware models. * Update claude content extraction logic. * Add testing for aiobotocore. * Restore newline. --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Fix notice_error logic for non-iterable exceptions. (#1564) * Revert "Fix notice_error logic for non-iterable exceptions. (#1564)" (#1568) This reverts commit b9d9d3bf97890645f30089e66dfffa3080acaf64. * Add additional trace points for AWS Kinesis (#1569) * Enable environment variables for attribute filters (#1558) * Enable env vars for attribute filters * [MegaLinter] Apply linters fixes * Trigger tests * Change attribute filters to space delimited * Fix test assertion --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Tim Pansino * Update version of cibuildwheel to latest (#1570) * Force uv to use non-emulated Python on windows arm64 (#1567) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Skip hypercorn tests for v0.18 (#1579) * Skip hypercorn tests for v0.18 * Remove tornadomaster for 3.14 * Add support for *.adaptive.sampling_target * Add adaptive sampler instances to SamplerProxy * Fix instability in CI caused by health check tests (#1584) * Bump the github_actions group across 1 directory with 5 updates (#1582) Bumps the github_actions group with 5 updates in the / directory: | Package | From | To | | --- | --- | --- | | [actions/checkout](https://github.com/actions/checkout) | `5.0.0` | `5.0.1` | | [docker/metadata-action](https://github.com/docker/metadata-action) | `5.8.0` | `5.9.0` | | [docker/setup-qemu-action](https://github.com/docker/setup-qemu-action) | `3.6.0` | `3.7.0` | | [astral-sh/setup-uv](https://github.com/astral-sh/setup-uv) | `7.1.2` | `7.1.3` | | [github/codeql-action](https://github.com/github/codeql-action) | `4.31.2` | `4.31.3` | Updates `actions/checkout` from 5.0.0 to 5.0.1 - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/08c6903cd8c0fde910a37f88322edcfb5dd907a8...93cb6efe18208431cddfb8368fd83d5badbf9bfd) Updates `docker/metadata-action` from 5.8.0 to 5.9.0 - [Release notes](https://github.com/docker/metadata-action/releases) - [Commits](https://github.com/docker/metadata-action/compare/c1e51972afc2121e065aed6d45c65596fe445f3f...318604b99e75e41977312d83839a89be02ca4893) Updates `docker/setup-qemu-action` from 3.6.0 to 3.7.0 - [Release notes](https://github.com/docker/setup-qemu-action/releases) - [Commits](https://github.com/docker/setup-qemu-action/compare/29109295f81e9208d7d86ff1c6c12d2833863392...c7c53464625b32c7a7e944ae62b3e17d2b600130) Updates `astral-sh/setup-uv` from 7.1.2 to 7.1.3 - [Release notes](https://github.com/astral-sh/setup-uv/releases) - [Commits](https://github.com/astral-sh/setup-uv/compare/85856786d1ce8acfbcc2f13a5f3fbd6b938f9f41...5a7eac68fb9809dea845d802897dc5c723910fa3) Updates `github/codeql-action` from 4.31.2 to 4.31.3 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/github/codeql-action/compare/0499de31b99561a6d14a36a5f662c2a54f91beee...014f16e7ab1402f30e7c3329d33797e7948572db) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: 5.0.1 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions - dependency-name: docker/metadata-action dependency-version: 5.9.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: docker/setup-qemu-action dependency-version: 3.7.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: astral-sh/setup-uv dependency-version: 7.1.3 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions - dependency-name: github/codeql-action dependency-version: 4.31.3 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Asyncio loop_factory fix (#1576) * Runner instrumentation in asyncio * Clean up asyncio instrumentation * Add asyncio tests for loop_factory * Modify uvicorn test for loop_factory * Fix linter errors * [MegaLinter] Apply linters fixes * Apply suggestions from code review --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Tim Pansino * Fix issue in ASGI header consumption (#1578) * Correct code for Sanic instrumentation * Correct handling of headers in ASGIWebTransaction * Correct handling of headers in ASGIBrowserMiddleware * Add regression test for ASGI headers issues --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> --------- Signed-off-by: dependabot[bot] Co-authored-by: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Co-authored-by: canonrock16 <35710450+canonrock16@users.noreply.github.com> Co-authored-by: Tim Pansino Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Uma Annamalai Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Lalleh Rafeei <84813886+lrafeei@users.noreply.github.com> * Add distributed_tracing.sampler.*root.* config support (#1586) * Add root config * [MegaLinter] Apply linters fixes --------- Co-authored-by: hmstepanek <30059933+hmstepanek@users.noreply.github.com> * Initial Hybrid Agent Trace implementation (#1587) * Initial otel trace/span implementation * Add some hybrid cross agent tests * Tweak some formatting and merge issues * [MegaLinter] Apply linters fixes * Fix application initialization bug * [MegaLinter] Apply linters fixes * Reviewer suggestions, part 1 * [MegaLinter] Apply linters fixes * Fix hasattr syntax * More reviewer suggestions/syntax fixes * [MegaLinter] Apply linters fixes * Apply suggestions from code review Co-authored-by: Hannah Stepanek * Reviewer suggestions, part 2 * Add fixture & enable/disable testing * Log potential error instead of raising error * Apply suggestions from code review Co-authored-by: Hannah Stepanek * Update newrelic/api/opentelemetry.py Co-authored-by: Hannah Stepanek --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Hannah Stepanek * Add TraceIdRatioBasedSampler, config, & tests * Fixup: put args before kwargs * LangChain: Fix message timestamps, add default role assignment, and Bedrock support (#1580) * Record the request message as the time the request started for LangChain. * Tracking the original timestamp of the request for input messages that are recorded as LlmChatCompletionMessage event types. * First pass at preserving LlmChatCompletionMessage timestamp for the request with Bedrock methods. * the `kwargs` was being mapped directly to the OpenAI client and having timestamp in there caused a problem. As a quick test, only add the request timestamp after the wrapped function has been invoked. * Moved the request timestamp to its own variable instead of part of kwargs. * OpenAI async request messages were not being assigned the correct timestamp. * Trying to improve the passing of the request timestamp through for Bedrock. * Passing too many parameters. * Set a default role on input/output messages within LangChain. * [MegaLinter] Apply linters fixes * Fix request_timestamp for LlmChatCompletionSummary table * Fix request_timestamp for LlmChatCompletionSummary table * [MegaLinter] Apply linters fixes * Bedrock Converse Streaming Support (#1565) * Add more formatting to custom event validatators * Add streamed responses to converse mock server * Add streaming fixtures for testing for converse * Rename other bedrock test files * Add tests for converse streaming * Instrument converse streaming * Move GeneratorProxy adjacent functions to mixin * Fix checking of supported models * Reorganize converse error tests * Port new converse botocore tests to aiobotocore * Instrument response streaming in aiobotocore converse * Fix suggestions from code review * Port in converse changes from strands PR * Delete commented code --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Bedrock Converse Streaming Support (#1565) * Add more formatting to custom event validatators * Add streamed responses to converse mock server * Add streaming fixtures for testing for converse * Rename other bedrock test files * Add tests for converse streaming * Instrument converse streaming * Move GeneratorProxy adjacent functions to mixin * Fix checking of supported models * Reorganize converse error tests * Port new converse botocore tests to aiobotocore * Instrument response streaming in aiobotocore converse * Fix suggestions from code review * Port in converse changes from strands PR * Delete commented code --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * [MegaLinter] Apply linters fixes * request_timestamp is now passed across different method * Fixed gemini model kwargs issue * [MegaLinter] Apply linters fixes * Update tests to validate presence of timestamp/ role and fix bugs in instrumentation. * Update aiobotocore instrumentation to receive request timestamp. --------- Co-authored-by: Josh Bonczkowski Co-authored-by: sgoel-nr <236423107+sgoel-nr@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Co-authored-by: Uma Annamalai * Update newrelic/core/config.py Co-authored-by: Lalleh Rafeei <84813886+lrafeei@users.noreply.github.com> * Fixup: unpacking args after kwargs * [MegaLinter] Apply linters fixes * Fixup: duplicated test names * Prioritize full over partial granularity * priority +=2 when full granularity and sampled=true * priority +=1 when partial granularity and sampled=true * always_on sampler for full granularity sets priority=3 instead of 2 * Increment priority when only sampled is sent in headers * [MegaLinter] Apply linters fixes * Fixup: test name * Merge main into develop-hybrid-core-tracing branch (#1605) * Strands Mock Model (#1551) * Add strands to tox.ini * Add mock models for strands testing * Add simple test file to validate strands mocking * Strands Mock Model (#1551) * Add strands to tox.ini * Add mock models for strands testing * Add simple test file to validate strands mocking * Add Strands tools and agents instrumentation. (#1563) * Add baseline instrumentation. * Add tool and agent instrumentation. * Add tests file. * Cleanup instrumentation. * Cleanup. Co-authored-by: Tim Pansino * [MegaLinter] Apply linters fixes * Strands Mock Model (#1551) * Add strands to tox.ini * Add mock models for strands testing * Add simple test file to validate strands mocking * Add baseline instrumentation. * Add tool and agent instrumentation. * Add tests file. * Cleanup instrumentation. * Cleanup. Co-authored-by: Tim Pansino * Handle additional args in mock model. * Add test to force exception and exercise _handle_tool_streaming_completion_error. * Strands Mock Model (#1551) * Add strands to tox.ini * Add mock models for strands testing * Add simple test file to validate strands mocking * Add baseline instrumentation. * Add tool and agent instrumentation. * Add tests file. * Cleanup instrumentation. * Cleanup. Co-authored-by: Tim Pansino * Handle additional args in mock model. * Strands Mock Model (#1551) * Add strands to tox.ini * Add mock models for strands testing * Add simple test file to validate strands mocking * Add baseline instrumentation. * Add tool and agent instrumentation. * Cleanup. Co-authored-by: Tim Pansino * [MegaLinter] Apply linters fixes * Add test to force exception and exercise _handle_tool_streaming_completion_error. * Implement strands context passing instrumentation. * Address review feedback. * [MegaLinter] Apply linters fixes * Remove test_simple.py file. --------- Co-authored-by: Tim Pansino Co-authored-by: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Co-authored-by: Tim Pansino * Strands MultiAgent Instrumentation (#1590) * Rename strands instrument functions * Add instrumentation for strands multiagent * Reorganize strands tests * Strands multiagent tests * Remove timestamp from test expected events. --------- Co-authored-by: Uma Annamalai * Strands Mock Model (#1551) * Add strands to tox.ini * Add mock models for strands testing * Add simple test file to validate strands mocking * Add Strands tools and agents instrumentation. (#1563) * Add baseline instrumentation. * Add tool and agent instrumentation. * Add tests file. * Cleanup instrumentation. * Cleanup. Co-authored-by: Tim Pansino * [MegaLinter] Apply linters fixes * Strands Mock Model (#1551) * Add strands to tox.ini * Add mock models for strands testing * Add simple test file to validate strands mocking * Add baseline instrumentation. * Add tool and agent instrumentation. * Add tests file. * Cleanup instrumentation. * Cleanup. Co-authored-by: Tim Pansino * Handle additional args in mock model. * Add test to force exception and exercise _handle_tool_streaming_completion_error. * Strands Mock Model (#1551) * Add strands to tox.ini * Add mock models for strands testing * Add simple test file to validate strands mocking * Add baseline instrumentation. * Add tool and agent instrumentation. * Add tests file. * Cleanup instrumentation. * Cleanup. Co-authored-by: Tim Pansino * Handle additional args in mock model. * Strands Mock Model (#1551) * Add strands to tox.ini * Add mock models for strands testing * Add simple test file to validate strands mocking * Add baseline instrumentation. * Add tool and agent instrumentation. * Cleanup. Co-authored-by: Tim Pansino * [MegaLinter] Apply linters fixes * Add test to force exception and exercise _handle_tool_streaming_completion_error. * Implement strands context passing instrumentation. * Address review feedback. * [MegaLinter] Apply linters fixes * Remove test_simple.py file. --------- Co-authored-by: Tim Pansino Co-authored-by: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Co-authored-by: Tim Pansino * Strands MultiAgent Instrumentation (#1590) * Rename strands instrument functions * Add instrumentation for strands multiagent * Reorganize strands tests * Strands multiagent tests * Remove timestamp from test expected events. --------- Co-authored-by: Uma Annamalai * Fixed tool type bug for strands * Pin langchain & langchain_core (#1604) * Add safeguarding to converse attr extraction. (#1603) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Pin scikit-learn --------- Signed-off-by: dependabot[bot] Co-authored-by: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Co-authored-by: Uma Annamalai Co-authored-by: Tim Pansino Co-authored-by: Tim Pansino Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Shubham Goel Co-authored-by: Hannah Stepanek * Hybrid agent context management (#1589) * Context propagation/DT enabling * Add accept/extract DT tests * Propagation extract/accept tests & remote tracestate parsing * Remove extra spaces * Explanation for update flags * Modify carrier and sampling logic * Change test name * Apply suggestions from code review Co-authored-by: Hannah Stepanek * Apply reviewer suggestions * Default parent_span_trace_id to None * Apply suggestions from code review Co-authored-by: Hannah Stepanek * Reviewer suggestions & cleanup * [MegaLinter] Apply linters fixes * Apply review suggestions (for real this time) --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Hannah Stepanek * Pretty-ify logic for improved readability * Add tracking metric, nr.pg & error attrs * Only record metric if pg transaction are sent * Check for nr.pg attr in partial gran tests * Keep error attributes & test * Add test for metrics & fix bugs * [MegaLinter] Apply linters fixes * [MegaLinter] Apply linters fixes * Add set_status() API * Megalinter fixes * [MegaLinter] Apply linters fixes * Apply suggestions from code review Co-authored-by: Hannah Stepanek * Add tests for description behavior * [MegaLinter] Apply linters fixes * Refactor span_event into separate functions * Cache spans before harvesting in compact mode * Ignore RUF012 & Apply linters fixes * Fix failing test * Fixup: pr header value test * Hybrid agent WSGI traces (#1607) * WSGI support with Flask tests * Supportability metric & setting name change * Megalinter and merge fixes * [MegaLinter] Apply linters fixes * Tweaks * [MegaLinter] Apply linters fixes * Reviewer suggestions and cleanup * [MegaLinter] Apply linters fixes * Add timer wait for application start up * [MegaLinter] Apply linters fixes * Change function name --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * ASGI (server) support * DynamoDB (Client) support * More DB framework tests * Requests (Client) support * Tweak cross agent tests * Refactor database attr logic * Reviewer suggestions and syntax * Oops, all syntax * Remove full_granularity.
config options * Apply suggestions from code review Co-authored-by: Hannah Stepanek * Reviewer suggestions and linter fixes * Fix supportability metric merge resolution * Change span logic to use sentinels * Kafka-python support (PRODUCER/CONSUMER) * Add sampler supportability metrics * Remove conversion to CSV * [MegaLinter] Apply linters fixes * Apply suggestions from code review Co-authored-by: Hannah Stepanek * Reviewer suggestions * Use json.loads instead of eval * [MegaLinter] Apply linters fixes * Add support and tests for RabbitMQ (#1622) * Add support and tests for RabbitMQ * Remove py3.8 from pika tests * Apply suggestions from code review Co-authored-by: Hannah Stepanek * Revert library names to lowercase --------- Co-authored-by: Hannah Stepanek * Add cross agent tests for core tracing * Fix lint issues Error: tests/cross_agent/test_distributed_tracing_trace_context.py:123:38: C418 Unnecessary dict comprehension passed to `dict()` (remove the outer call to `dict()`) Error: tests/cross_agent/test_distributed_tracing_trace_context.py:124:37: C418 Unnecessary dict comprehension passed to `dict()` (remove the outer call to `dict()`) Error: tests/cross_agent/test_harvest_sampling_rates.py:64:27: FLY002 Consider `f"{setting}.{key}"` instead of string join Error: tests/cross_agent/test_harvest_sampling_rates.py:160:13: B007 Loop control variable `n` not used within loop body Error: tests/cross_agent/test_harvest_sampling_rates.py:163:13: B007 Loop control variable `n` not used within loop body Error: tests/cross_agent/test_harvest_sampling_rates.py:172:13: B007 Loop control variable `n` not used within loop body Error: tests/cross_agent/test_harvest_sampling_rates.py:181:13: B007 Loop control variable `n` not used within loop body Error: tests/cross_agent/test_harvest_sampling_rates.py:190:13: B007 Loop control variable `n` not used within loop body Error: tests/cross_agent/test_sampler_configuration.py:85:27: FLY002 Consider `f"{setting}.{key}"` instead of string join Error: tests/hybridagent_pika/test_pika_blocking_connection_consume_generator.py:69:13: B007 Loop control variable `method_frame` not used within loop body Error: tests/hybridagent_pika/test_pika_blocking_connection_consume_generator.py:88:13: B007 Loop control variable `method_frame` not used within loop body Error: tests/hybridagent_pika/test_pika_blocking_connection_consume_generator.py:222:9: RUF059 Unpacked variable `method` is never used Error: tests/hybridagent_pika/test_pika_blocking_connection_consume_generator.py:260:17: B007 Loop control variable `method_frame` not used within loop body Error: tests/hybridagent_pika/test_pika_blocking_connection_consume_generator.py:286:13: RUF059 Unpacked variable `method_frame` is never used Error: tests/hybridagent_pika/test_pika_blocking_connection_consume_generator.py:323:9: RUF059 Unpacked variable `method` is never used * Update partial tracing attributes to be intrinsics (#1635) * move attrs from agent to intrinsics * Fix linter errors * [MegaLinter] Apply linters fixes * Trigger tests * Hybrid Agent SpanLink and SpanEvent Events Implementation (#1628) * SpanLink & SpanEvent implementation * Supportability metrics for dropped events * Reviewer suggestions * [MegaLinter] Apply linters fixes * Fix LazySpan logic/Add spanlink/spanevent tests for different trace types * [MegaLinter] Apply linters fixes * Remove duplicated files & fix invalid ratio * Remove special handling for ratio=0 * Load instrumentors in configuration * traces.enabled setting, removing instrumentors in tests, & linter fixes * Set TracerProvider to be singleton * Tracer/library attributes and test * Test response attributes for web transactions * Test framework that only OTel supports * Test native (graphql) instrumentation * Add attribute parsing for native elasticsearch * Add tests for disabled (for OTel) framework * Obfuscate DBs and miscellaneous * Application activation retry logic & reviewer suggestions * Apply suggestions from code review Co-authored-by: Hannah Stepanek * [MegaLinter] Apply linters fixes * Add safety guard * Fixup bug in ct (#1634) * Handle attrs set to None * [MegaLinter] Apply linters fixes --------- Co-authored-by: hmstepanek <30059933+hmstepanek@users.noreply.github.com> Co-authored-by: Lalleh Rafeei <84813886+lrafeei@users.noreply.github.com> * Fixup: megalinter * [MegaLinter] Apply linters fixes * Trigger tests * Bump the github_actions group across 1 directory with 7 updates (#1657) Bumps the github_actions group with 7 updates in the / directory: | Package | From | To | | --- | --- | --- | | [actions/checkout](https://github.com/actions/checkout) | `6.0.1` | `6.0.2` | | [actions/setup-python](https://github.com/actions/setup-python) | `6.1.0` | `6.2.0` | | [docker/login-action](https://github.com/docker/login-action) | `3.6.0` | `3.7.0` | | [docker/build-push-action](https://github.com/docker/build-push-action) | `6.18.0` | `6.19.1` | | [actions/attest-build-provenance](https://github.com/actions/attest-build-provenance) | `3.1.0` | `3.2.0` | | [astral-sh/setup-uv](https://github.com/astral-sh/setup-uv) | `7.2.0` | `7.3.0` | | [github/codeql-action](https://github.com/github/codeql-action) | `4.31.10` | `4.32.2` | Updates `actions/checkout` from 6.0.1 to 6.0.2 - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/8e8c483db84b4bee98b60c0593521ed34d9990e8...de0fac2e4500dabe0009e67214ff5f5447ce83dd) Updates `actions/setup-python` from 6.1.0 to 6.2.0 - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](https://github.com/actions/setup-python/compare/83679a892e2d95755f2dac6acb0bfd1e9ac5d548...a309ff8b426b58ec0e2a45f0f869d46889d02405) Updates `docker/login-action` from 3.6.0 to 3.7.0 - [Release notes](https://github.com/docker/login-action/releases) - [Commits](https://github.com/docker/login-action/compare/5e57cd118135c172c3672efd75eb46360885c0ef...c94ce9fb468520275223c153574b00df6fe4bcc9) Updates `docker/build-push-action` from 6.18.0 to 6.19.1 - [Release notes](https://github.com/docker/build-push-action/releases) - [Commits](https://github.com/docker/build-push-action/compare/263435318d21b8e681c14492fe198d362a7d2c83...601a80b39c9405e50806ae38af30926f9d957c47) Updates `actions/attest-build-provenance` from 3.1.0 to 3.2.0 - [Release notes](https://github.com/actions/attest-build-provenance/releases) - [Changelog](https://github.com/actions/attest-build-provenance/blob/main/RELEASE.md) - [Commits](https://github.com/actions/attest-build-provenance/compare/00014ed6ed5efc5b1ab7f7f34a39eb55d41aa4f8...96278af6caaf10aea03fd8d33a09a777ca52d62f) Updates `astral-sh/setup-uv` from 7.2.0 to 7.3.0 - [Release notes](https://github.com/astral-sh/setup-uv/releases) - [Commits](https://github.com/astral-sh/setup-uv/compare/61cb8a9741eeb8a550a1b8544337180c0fc8476b...eac588ad8def6316056a12d4907a9d4d84ff7a3b) Updates `github/codeql-action` from 4.31.10 to 4.32.2 - [Release notes](https://github.com/github/codeql-action/releases) - [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/github/codeql-action/compare/cdefb33c0f6224e58673d9004f47f7cb3e328b89...45cbd0c69e560cd9e7cd7f8c32362050c9b7ded2) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: 6.0.2 dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_actions - dependency-name: actions/setup-python dependency-version: 6.2.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: docker/login-action dependency-version: 3.7.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: docker/build-push-action dependency-version: 6.19.1 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: actions/attest-build-provenance dependency-version: 3.2.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: astral-sh/setup-uv dependency-version: 7.3.0 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions - dependency-name: github/codeql-action dependency-version: 4.32.2 dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_actions ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Fix timestamp merge conflicts in AI * Reviewer suggestions, part 1 * Revert setting transport type when empty payload * Add span links and span events as params * Call tracer provider once for instrumentors * Add try/except logic for opentelemetry imports * Change application activation logic & otel naming * [MegaLinter] Apply linters fixes * Remove duplicate older version of trace_context tests * Fix sampling rates cross agent test fails * Refactor pytest parametrize with Claude * Apply suggestions from code review Co-authored-by: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> * Reviewer suggestions, part 3 * Apply suggestions from code review Co-authored-by: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> * Reviewer suggestions, part 3 * Add test case for unknown partial gran type * [MegaLinter] Apply linters fixes * Trigger tests * Add newrelic.core.samplers to packages * Explicitly check description * More reviewer suggestions * [MegaLinter] Apply linters fixes * Trigger tests * [MegaLinter] Apply linters fixes * Update newrelic/hooks/hybridagent_opentelemetry.py Co-authored-by: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> * [MegaLinter] Apply linters fixes * Trigger tests * Revert "Refactor pytest parametrize with Claude" This reverts commit 9b5095d0f565de5cbd068a66b3e110a575110d3e. * Revert "Update newrelic/hooks/hybridagent_opentelemetry.py" This reverts commit 3f8d15ccbcba626227bafcddd799c8df12798258. * Fix comment formatting * Import current_transaction * Update newrelic/api/transaction.py * Fix comment * Add TRACE level logging & use to log sampling * Rename (kept, instr..) stats to be more explicit * [MegaLinter] Apply linters fixes * Add comment * Test benchmark * Revert "Test benchmark" This reverts commit ba23cfa2a6e5598e5d0a266a91ea4c1546e32572. * Call .log instead of ._log * Comment out trace level logging * Revert raise inside fixture if 0 events * Add logging for commit shas * Change sha on benchmark runner * [MegaLinter] Apply linters fixes * Add comment * Revert raise inside fixture if 0 events * Comment out trace level logging * Tweak benchmark job * Make non-opentelemetry spans more performant * Uplevel partial gran checks outside of nodes This is done to improve performance when there are many spans. * Fix merge conflict * Simplify sampling logic code to improve performance * Simplify sampling logic code to improve performance * [MegaLinter] Apply linters fixes * Add env var check to tracer provider logic * [MegaLinter] Apply linters fixes * Fixup: delete commented out lines * Remove added version in header val before compare * [MegaLinter] Apply linters fixes * Use _environ_as_bool * [MegaLinter] Apply linters fixes * Fix infinite tracing span generation * Fixup: remove span link from function node * Revert "Fixup: remove span link from function node" This reverts commit 8341b660aaa09b6e8ef88274d93c02db6bf9ca46. * Fix harvest loop tests * Ensure ImportHookFinder is singleton * Add extra overhead to max compressed span tests * Increase number of linux runners * Do not run harvest tests in CI * [MegaLinter] Apply linters fixes * Bump tests --------- Signed-off-by: dependabot[bot] Co-authored-by: hmstepanek <30059933+hmstepanek@users.noreply.github.com> Co-authored-by: Lalleh Rafeei <84813886+lrafeei@users.noreply.github.com> Co-authored-by: Timothy Pansino <11214426+TimPansino@users.noreply.github.com> Co-authored-by: canonrock16 <35710450+canonrock16@users.noreply.github.com> Co-authored-by: Tim Pansino Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Uma Annamalai Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: sgoel-nr Co-authored-by: Josh Bonczkowski Co-authored-by: sgoel-nr <236423107+sgoel-nr@users.noreply.github.com> Co-authored-by: Tim Pansino Co-authored-by: Lalleh Rafeei --- .github/workflows/benchmarks.yml | 4 +- .github/workflows/tests.yml | 8 +- newrelic/api/application.py | 4 +- newrelic/api/database_trace.py | 2 + newrelic/api/datastore_trace.py | 2 + newrelic/api/external_trace.py | 2 + newrelic/api/function_trace.py | 2 + newrelic/api/import_hook.py | 12 + newrelic/api/memcache_trace.py | 2 + newrelic/api/message_trace.py | 2 + newrelic/api/opentelemetry.py | 977 ++++++++ newrelic/api/time_trace.py | 62 + newrelic/api/transaction.py | 192 +- newrelic/common/encoding_utils.py | 27 +- newrelic/common/opentelemetry_tracers.py | 243 ++ newrelic/config.py | 291 ++- newrelic/core/agent.py | 49 +- newrelic/core/agent_protocol.py | 3 + newrelic/core/application.py | 65 +- newrelic/core/attribute.py | 27 + newrelic/core/config.py | 346 ++- newrelic/core/data_collector.py | 1 - newrelic/core/database_node.py | 12 +- newrelic/core/database_utils.py | 26 +- newrelic/core/datastore_node.py | 2 + newrelic/core/external_node.py | 9 +- newrelic/core/function_node.py | 10 +- newrelic/core/loop_node.py | 8 +- newrelic/core/memcache_node.py | 5 + newrelic/core/message_node.py | 5 + newrelic/core/node_mixin.py | 300 ++- newrelic/core/otlp_utils.py | 5 +- newrelic/core/root_node.py | 10 +- newrelic/core/samplers/__init__.py | 14 + .../core/{ => samplers}/adaptive_sampler.py | 0 newrelic/core/samplers/sampler_proxy.py | 170 ++ .../samplers/trace_id_ratio_based_sampler.py | 33 + newrelic/core/stats_engine.py | 43 +- newrelic/core/transaction_node.py | 47 +- newrelic/hooks/external_botocore.py | 20 +- newrelic/hooks/hybridagent_opentelemetry.py | 280 +++ pyproject.toml | 1 + .../test_distributed_tracing.py | 1253 +++++++++- .../test_event_loop_wait_time.py | 14 +- tests/agent_unittests/test_agent_connect.py | 20 + tests/agent_unittests/test_agent_protocol.py | 3 +- .../test_distributed_tracing_settings.py | 341 +++ tests/agent_unittests/test_harvest_loop.py | 395 +-- .../test_infinite_trace_settings.py | 17 + .../fixtures/distributed_tracing/README.md | 124 +- .../distributed_tracing.json | 156 +- .../distributed_tracing/trace_context.json | 2120 ++++++++++++++--- tests/cross_agent/fixtures/samplers/README.md | 92 + .../samplers/harvest_sampling_rates.json | 216 ++ .../samplers/sampler_configuration.json | 207 ++ tests/cross_agent/test_datastore_instance.py | 2 + tests/cross_agent/test_distributed_tracing.py | 2 +- .../test_distributed_tracing_trace_context.py | 355 +++ .../test_harvest_sampling_rates.py | 261 ++ .../cross_agent/test_sampler_configuration.py | 145 ++ tests/cross_agent/test_w3c_trace_context.py | 257 -- .../test_distributed_tracing.py | 5 + tests/hybridagent_aiopg/conftest.py | 41 + tests/hybridagent_aiopg/test_database.py | 197 ++ tests/hybridagent_ariadne/__init__.py | 13 + .../_target_application.py | 126 + .../_target_schema_async.py | 91 + .../_target_schema_sync.py | 103 + tests/hybridagent_ariadne/conftest.py | 30 + tests/hybridagent_ariadne/schema.graphql | 48 + tests/hybridagent_ariadne/test_application.py | 36 + .../_test_botocore_dynamodb_opentelemetry.py | 157 ++ tests/hybridagent_dynamodb/conftest.py | 37 + .../test_botocore_dynamodb.py | 172 ++ .../_target_opentelemetry_application.py | 35 + tests/hybridagent_fastapi/conftest.py | 40 + .../test_otel_application.py | 93 + tests/hybridagent_flask/_test_application.py | 70 + .../_test_application_async.py | 27 + tests/hybridagent_flask/conftest.py | 45 + tests/hybridagent_flask/test_application.py | 266 +++ tests/hybridagent_graphql/__init__.py | 13 + .../_target_application.py | 67 + .../_target_schema_async.py | 137 ++ .../_target_schema_sync.py | 171 ++ tests/hybridagent_graphql/conftest.py | 43 + tests/hybridagent_graphql/test_application.py | 400 ++++ .../test_application_async.py | 27 + tests/hybridagent_kafkapython/conftest.py | 277 +++ .../hybridagent_kafkapython/test_consumer.py | 172 ++ .../hybridagent_kafkapython/test_producer.py | 92 + tests/hybridagent_mysql/conftest.py | 41 + tests/hybridagent_mysql/test_database.py | 207 ++ tests/hybridagent_opentelemetry/conftest.py | 42 + .../cross_agent/TestCaseDefinitions.json | 641 +++++ .../test_attributes.py | 133 ++ .../test_context_propagation.py | 124 + .../test_hybrid_cross_agent.py | 274 +++ .../test_settings.py | 57 + .../test_spanevent_spanlinks.py | 268 +++ .../hybridagent_opentelemetry/test_status.py | 230 ++ tests/hybridagent_pika/compat.py | 29 + tests/hybridagent_pika/conftest.py | 120 + .../test_distributed_tracing.py | 209 ++ ...a_blocking_connection_consume_generator.py | 346 +++ tests/hybridagent_pika/test_pika_produce.py | 350 +++ tests/hybridagent_psycopg2/conftest.py | 33 + tests/hybridagent_psycopg2/test_async.py | 142 ++ tests/hybridagent_psycopg2/test_cursor.py | 239 ++ tests/hybridagent_pymongo/conftest.py | 35 + tests/hybridagent_pymongo/test_collection.py | 200 ++ tests/hybridagent_redis/conftest.py | 33 + tests/hybridagent_redis/test_asyncio.py | 233 ++ .../hybridagent_redis/test_execute_command.py | 366 +++ tests/hybridagent_requests/conftest.py | 38 + tests/hybridagent_requests/test_requests.py | 162 ++ tests/hybridagent_requests/test_span_event.py | 67 + tests/hybridagent_strawberry/__init__.py | 13 + .../_target_application.py | 102 + .../_target_schema_async.py | 87 + .../_target_schema_sync.py | 160 ++ tests/hybridagent_strawberry/conftest.py | 30 + .../test_application.py | 37 + tests/testing_support/fixtures.py | 8 +- .../validate_spanlink_spanevent_events.py | 155 ++ .../validate_transaction_object_attributes.py | 38 + tox.ini | 77 + 127 files changed, 16653 insertions(+), 1007 deletions(-) create mode 100644 newrelic/api/opentelemetry.py create mode 100644 newrelic/common/opentelemetry_tracers.py create mode 100644 newrelic/core/samplers/__init__.py rename newrelic/core/{ => samplers}/adaptive_sampler.py (100%) create mode 100644 newrelic/core/samplers/sampler_proxy.py create mode 100644 newrelic/core/samplers/trace_id_ratio_based_sampler.py create mode 100644 newrelic/hooks/hybridagent_opentelemetry.py create mode 100644 tests/cross_agent/fixtures/samplers/README.md create mode 100644 tests/cross_agent/fixtures/samplers/harvest_sampling_rates.json create mode 100644 tests/cross_agent/fixtures/samplers/sampler_configuration.json create mode 100644 tests/cross_agent/test_distributed_tracing_trace_context.py create mode 100644 tests/cross_agent/test_harvest_sampling_rates.py create mode 100644 tests/cross_agent/test_sampler_configuration.py delete mode 100644 tests/cross_agent/test_w3c_trace_context.py create mode 100644 tests/hybridagent_aiopg/conftest.py create mode 100644 tests/hybridagent_aiopg/test_database.py create mode 100644 tests/hybridagent_ariadne/__init__.py create mode 100644 tests/hybridagent_ariadne/_target_application.py create mode 100644 tests/hybridagent_ariadne/_target_schema_async.py create mode 100644 tests/hybridagent_ariadne/_target_schema_sync.py create mode 100644 tests/hybridagent_ariadne/conftest.py create mode 100644 tests/hybridagent_ariadne/schema.graphql create mode 100644 tests/hybridagent_ariadne/test_application.py create mode 100644 tests/hybridagent_dynamodb/_test_botocore_dynamodb_opentelemetry.py create mode 100644 tests/hybridagent_dynamodb/conftest.py create mode 100644 tests/hybridagent_dynamodb/test_botocore_dynamodb.py create mode 100644 tests/hybridagent_fastapi/_target_opentelemetry_application.py create mode 100644 tests/hybridagent_fastapi/conftest.py create mode 100644 tests/hybridagent_fastapi/test_otel_application.py create mode 100644 tests/hybridagent_flask/_test_application.py create mode 100644 tests/hybridagent_flask/_test_application_async.py create mode 100644 tests/hybridagent_flask/conftest.py create mode 100644 tests/hybridagent_flask/test_application.py create mode 100644 tests/hybridagent_graphql/__init__.py create mode 100644 tests/hybridagent_graphql/_target_application.py create mode 100644 tests/hybridagent_graphql/_target_schema_async.py create mode 100644 tests/hybridagent_graphql/_target_schema_sync.py create mode 100644 tests/hybridagent_graphql/conftest.py create mode 100644 tests/hybridagent_graphql/test_application.py create mode 100644 tests/hybridagent_graphql/test_application_async.py create mode 100644 tests/hybridagent_kafkapython/conftest.py create mode 100644 tests/hybridagent_kafkapython/test_consumer.py create mode 100644 tests/hybridagent_kafkapython/test_producer.py create mode 100644 tests/hybridagent_mysql/conftest.py create mode 100644 tests/hybridagent_mysql/test_database.py create mode 100644 tests/hybridagent_opentelemetry/conftest.py create mode 100644 tests/hybridagent_opentelemetry/cross_agent/TestCaseDefinitions.json create mode 100644 tests/hybridagent_opentelemetry/test_attributes.py create mode 100644 tests/hybridagent_opentelemetry/test_context_propagation.py create mode 100644 tests/hybridagent_opentelemetry/test_hybrid_cross_agent.py create mode 100644 tests/hybridagent_opentelemetry/test_settings.py create mode 100644 tests/hybridagent_opentelemetry/test_spanevent_spanlinks.py create mode 100644 tests/hybridagent_opentelemetry/test_status.py create mode 100644 tests/hybridagent_pika/compat.py create mode 100644 tests/hybridagent_pika/conftest.py create mode 100644 tests/hybridagent_pika/test_distributed_tracing.py create mode 100644 tests/hybridagent_pika/test_pika_blocking_connection_consume_generator.py create mode 100644 tests/hybridagent_pika/test_pika_produce.py create mode 100644 tests/hybridagent_psycopg2/conftest.py create mode 100644 tests/hybridagent_psycopg2/test_async.py create mode 100644 tests/hybridagent_psycopg2/test_cursor.py create mode 100644 tests/hybridagent_pymongo/conftest.py create mode 100644 tests/hybridagent_pymongo/test_collection.py create mode 100644 tests/hybridagent_redis/conftest.py create mode 100644 tests/hybridagent_redis/test_asyncio.py create mode 100644 tests/hybridagent_redis/test_execute_command.py create mode 100644 tests/hybridagent_requests/conftest.py create mode 100644 tests/hybridagent_requests/test_requests.py create mode 100644 tests/hybridagent_requests/test_span_event.py create mode 100644 tests/hybridagent_strawberry/__init__.py create mode 100644 tests/hybridagent_strawberry/_target_application.py create mode 100644 tests/hybridagent_strawberry/_target_schema_async.py create mode 100644 tests/hybridagent_strawberry/_target_schema_sync.py create mode 100644 tests/hybridagent_strawberry/conftest.py create mode 100644 tests/hybridagent_strawberry/test_application.py create mode 100644 tests/testing_support/validators/validate_spanlink_spanevent_events.py create mode 100644 tests/testing_support/validators/validate_transaction_object_attributes.py diff --git a/.github/workflows/benchmarks.yml b/.github/workflows/benchmarks.yml index 2e7094fe09..38ff6406ff 100644 --- a/.github/workflows/benchmarks.yml +++ b/.github/workflows/benchmarks.yml @@ -37,6 +37,7 @@ jobs: env: ASV_FACTOR: "1.1" BASE_SHA: ${{ github.event.pull_request.base.sha }} + HEAD_SHA: ${{ github.event.pull_request.head.sha }} steps: - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # 6.0.2 @@ -63,9 +64,10 @@ jobs: - name: Run Benchmark run: | + echo "Running continuous benchmarking between base commit ${BASE_SHA} and head commit ${HEAD_SHA}" asv continuous \ --show-stderr \ --split \ --factor "${ASV_FACTOR}" \ --python=${{ matrix.python }} \ - "${BASE_SHA}" "${GITHUB_SHA}" + "${BASE_SHA}" "${HEAD_SHA}" diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 4d1b7932e2..aa0dedb709 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -152,12 +152,12 @@ jobs: linux: env: - TOTAL_GROUPS: 2 + TOTAL_GROUPS: 3 strategy: fail-fast: false matrix: - group-number: [1, 2] + group-number: [1, 2, 3] runs-on: ubuntu-24.04 container: @@ -217,12 +217,12 @@ jobs: linux_arm64: env: - TOTAL_GROUPS: 2 + TOTAL_GROUPS: 3 strategy: fail-fast: false matrix: - group-number: [1, 2] + group-number: [1, 2, 3] runs-on: ubuntu-24.04-arm container: diff --git a/newrelic/api/application.py b/newrelic/api/application.py index 9aa6d7b6b8..f3a68413fe 100644 --- a/newrelic/api/application.py +++ b/newrelic/api/application.py @@ -156,11 +156,11 @@ def normalize_name(self, name, rule_type="url"): return self._agent.normalize_name(self._name, name, rule_type) return name, False - def compute_sampled(self): + def compute_sampled(self, full_granularity, section, *args, **kwargs): if not self.active or not self.settings.distributed_tracing.enabled: return False - return self._agent.compute_sampled(self._name) + return self._agent.compute_sampled(self._name, full_granularity, section, *args, **kwargs) def application_instance(name=None, activate=True): diff --git a/newrelic/api/database_trace.py b/newrelic/api/database_trace.py index a2f31ca504..cb449da068 100644 --- a/newrelic/api/database_trace.py +++ b/newrelic/api/database_trace.py @@ -226,6 +226,8 @@ def create_node(self): guid=self.guid, agent_attributes=self.agent_attributes, user_attributes=self.user_attributes, + span_link_events=self.span_link_events, + span_event_events=self.span_event_events, ) diff --git a/newrelic/api/datastore_trace.py b/newrelic/api/datastore_trace.py index 4d3a0db0ad..d9a71acf1c 100644 --- a/newrelic/api/datastore_trace.py +++ b/newrelic/api/datastore_trace.py @@ -123,6 +123,8 @@ def create_node(self): guid=self.guid, agent_attributes=self.agent_attributes, user_attributes=self.user_attributes, + span_link_events=self.span_link_events, + span_event_events=self.span_event_events, ) diff --git a/newrelic/api/external_trace.py b/newrelic/api/external_trace.py index 372eb2ca09..9d3dff69e4 100644 --- a/newrelic/api/external_trace.py +++ b/newrelic/api/external_trace.py @@ -59,6 +59,8 @@ def create_node(self): guid=self.guid, agent_attributes=self.agent_attributes, user_attributes=self.user_attributes, + span_link_events=self.span_link_events, + span_event_events=self.span_event_events, ) diff --git a/newrelic/api/function_trace.py b/newrelic/api/function_trace.py index a782c1cfac..5f56104d7a 100644 --- a/newrelic/api/function_trace.py +++ b/newrelic/api/function_trace.py @@ -75,6 +75,8 @@ def create_node(self): guid=self.guid, agent_attributes=self.agent_attributes, user_attributes=self.user_attributes, + span_link_events=self.span_link_events, + span_event_events=self.span_event_events, ) diff --git a/newrelic/api/import_hook.py b/newrelic/api/import_hook.py index 15bd3ba992..07e8477aa3 100644 --- a/newrelic/api/import_hook.py +++ b/newrelic/api/import_hook.py @@ -211,3 +211,15 @@ def decorator(wrapped): def import_module(name): __import__(name) return sys.modules[name] + + +def enable_import_hook_finder(): + if sys.meta_path and not isinstance(sys.meta_path[0], ImportHookFinder): + # If we don't hold the first position in sys.meta_path then we need to insert ourselves + # there and remove all other instances of ImportHookFinder. + sys.meta_path.insert(0, ImportHookFinder()) + + # Remove any duplicate instances of ImportHookFinder. + for finder in list(sys.meta_path[1:]): + if isinstance(finder, ImportHookFinder): + sys.meta_path.remove(finder) diff --git a/newrelic/api/memcache_trace.py b/newrelic/api/memcache_trace.py index 810ed621b6..8963c303e0 100644 --- a/newrelic/api/memcache_trace.py +++ b/newrelic/api/memcache_trace.py @@ -48,6 +48,8 @@ def create_node(self): guid=self.guid, agent_attributes=self.agent_attributes, user_attributes=self.user_attributes, + span_link_events=self.span_link_events, + span_event_events=self.span_event_events, ) diff --git a/newrelic/api/message_trace.py b/newrelic/api/message_trace.py index 5f6f9a76d0..f7fd3a601a 100644 --- a/newrelic/api/message_trace.py +++ b/newrelic/api/message_trace.py @@ -84,6 +84,8 @@ def create_node(self): guid=self.guid, agent_attributes=self.agent_attributes, user_attributes=self.user_attributes, + span_link_events=self.span_link_events, + span_event_events=self.span_event_events, ) diff --git a/newrelic/api/opentelemetry.py b/newrelic/api/opentelemetry.py new file mode 100644 index 0000000000..6a2be370d3 --- /dev/null +++ b/newrelic/api/opentelemetry.py @@ -0,0 +1,977 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import json +import logging +import os +import sys +import time +from contextlib import contextmanager + +try: + from opentelemetry import trace as otel_api_trace + from opentelemetry.baggage.propagation import W3CBaggagePropagator + from opentelemetry.propagate import set_global_textmap + from opentelemetry.propagators.composite import CompositePropagator + from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator + from opentelemetry.trace.status import Status, StatusCode +except ImportError: + otel_api_trace = None + W3CBaggagePropagator = None + set_global_textmap = None + CompositePropagator = None + TraceContextTextMapPropagator = None + Status = None + StatusCode = None + +from newrelic.api.application import application_instance +from newrelic.api.background_task import BackgroundTask +from newrelic.api.datastore_trace import DatastoreTrace +from newrelic.api.external_trace import ExternalTrace +from newrelic.api.function_trace import FunctionTrace +from newrelic.api.message_trace import MessageTrace +from newrelic.api.message_transaction import MessageTransaction +from newrelic.api.time_trace import add_custom_span_attribute, current_trace, notice_error +from newrelic.api.transaction import Sentinel, current_transaction +from newrelic.api.web_transaction import WebTransaction, WSGIWebTransaction +from newrelic.core.attribute import sanitize +from newrelic.core.database_utils import ( + _all_literals_re, + _quotes_table, + generate_dynamodb_arn, + get_database_operation_target_from_statement, +) +from newrelic.core.otlp_utils import create_resource + +_logger = logging.getLogger(__name__) + + +class NRTraceContextPropagator(TraceContextTextMapPropagator): + HEADER_KEYS = ("traceparent", "tracestate", "newrelic") + + def extract(self, carrier, context=None, getter=None): + transaction = current_transaction() + # If we are passing into New Relic, traceparent + # and/or tracestate's keys also need to be NR compatible. + + if transaction: + nr_headers = { + header_key: getter.get(carrier, header_key)[0] + for header_key in self.HEADER_KEYS + if getter.get(carrier, header_key) + } + transaction.accept_distributed_trace_headers(nr_headers) + + extracted_context = super().extract(carrier=carrier, context=context, getter=getter) + + return extracted_context + + def inject(self, carrier, context=None, setter=None): + transaction = current_transaction() + if not transaction: + return super().inject(carrier=carrier, context=context, setter=setter) + + nr_headers = [] + transaction.insert_distributed_trace_headers(nr_headers) + for key, value in nr_headers: + setter.set(carrier, key, value) + # Do NOT call super().inject() since we have already + # inserted the headers here. It will not cause harm, + # but it is redundant logic. + + +# Context and Context Propagator Setup +try: + opentelemetry_context_propagator = CompositePropagator( + propagators=[NRTraceContextPropagator(), W3CBaggagePropagator()] + ) + set_global_textmap(opentelemetry_context_propagator) +except: + pass + +# ---------------------------------------------- +# Custom OpenTelemetry Spans and Traces +# ---------------------------------------------- + + +class Span(otel_api_trace.Span): + def __init__( + self, + name=None, + parent=None, # SpanContext + resource=None, + attributes=None, + kind=otel_api_trace.SpanKind.INTERNAL, + record_exception=True, + set_status_on_exception=True, + nr_transaction=None, + nr_trace_type=FunctionTrace, + instrumenting_module=None, + create_nr_trace=True, + links=None, + *args, + **kwargs, + ): + self.name = name + self.opentelemetry_parent = parent + self.attributes = attributes or {} + self.kind = kind + self.nr_transaction = ( + nr_transaction or current_transaction() + ) # This attribute is purely to prevent garbage collection + self.nr_trace = None + self.instrumenting_module = instrumenting_module + self.status = Status(StatusCode.UNSET) + self._record_exception = record_exception + self.set_status_on_exception = set_status_on_exception + self.links = links or [] + self.create_nr_trace = create_nr_trace + + self.nr_parent = None + current_nr_trace = current_trace() + if ( + not self.opentelemetry_parent + or (self.opentelemetry_parent and self.opentelemetry_parent.span_id == int(current_nr_trace.guid, 16)) + or (self.opentelemetry_parent and isinstance(current_nr_trace, Sentinel)) + ): + # Expected to come here if one of three scenarios have occured: + # 1. `start_as_current_span` was used. + # 2. `start_span` was used and the current span was explicitly set + # to the newly created one. + # 3. Only a Sentinel Trace exists so far while still having a + # remote parent. From OpenTelemetry's end, this will be represented + # as a `NonRecordingSpan` (and be seen as `None` at this + # point). This covers cases where span is remote. + self.nr_parent = current_nr_trace + else: + # This should not occur, but if it does, we need to + # log an error and not create a New Relic trace. + _logger.error( + "OpenTelemetry span (%s) and NR trace (%s) do not match nor correspond to a remote span. Open Telemetry span will not be reported to New Relic. Please report this problem to New Relic.", + self.opentelemetry_parent, + current_nr_trace, # NR parent trace + ) + return + + if not self.create_nr_trace: + # Do not create a New Relic trace for this OpenTelemetry span. + # While this OpenTelemetry span exists it will not be explicitly + # translated to a NR trace. This may occur during the + # creation of a Transaction, which will create the root + # span. This may also occur during special cases, such + # as back to back calls to Kafka's queue's consumer. + # If a transaction already exists, we do not want to + # create another transaction or trace, but rather just + # append existing attributes to the existing transaction. + self.nr_trace = current_nr_trace + # Add Instrumentation Scope Attributes + self.nr_trace._add_agent_attribute("otel.scope.name", self.attributes.get("library_name")) + self.nr_trace._add_agent_attribute("otel.scope.version", self.attributes.get("library_version")) + self.nr_trace._add_agent_attribute("otel.library.name", self.attributes.get("library_name")) + self.nr_trace._add_agent_attribute("otel.library.version", self.attributes.get("library_version")) + return + elif nr_trace_type == FunctionTrace: + trace_kwargs = {"name": self.name, "params": self.attributes, "parent": self.nr_parent} + self.nr_trace = nr_trace_type(**trace_kwargs) + elif nr_trace_type == DatastoreTrace: + trace_kwargs = { + "product": self.instrumenting_module, + "target": None, + "operation": self.name, + "parent": self.nr_parent, + } + self.nr_trace = nr_trace_type(**trace_kwargs) + elif nr_trace_type == ExternalTrace: + trace_kwargs = { + "library": self.instrumenting_module, + "url": self.attributes.get("http.url"), + "method": self.attributes.get("http.method") or self.name, + "parent": self.nr_parent, + } + self.nr_trace = nr_trace_type(**trace_kwargs) + elif nr_trace_type == MessageTrace: + trace_kwargs = { + "library": self.instrumenting_module, + "operation": "Produce" if self.kind == otel_api_trace.SpanKind.PRODUCER else "Consume", + "destination_type": "Exchange", + "destination_name": self.name, + "params": self.attributes, + "parent": self.nr_parent, + "terminal": False, + } + self.nr_trace = nr_trace_type(**trace_kwargs) + else: + trace_kwargs = {"name": self.name, "params": self.attributes, "parent": self.nr_parent} + self.nr_trace = nr_trace_type(**trace_kwargs) + + self.nr_trace.__enter__() + + # Add Instrumentation Scope Attributes + self.nr_trace._add_agent_attribute("otel.scope.name", self.attributes.get("library_name")) + self.nr_trace._add_agent_attribute("otel.scope.version", self.attributes.get("library_version")) + self.nr_trace._add_agent_attribute("otel.library.name", self.attributes.get("library_name")) + self.nr_trace._add_agent_attribute("otel.library.version", self.attributes.get("library_version")) + + # Process Links that were passed in upon span creation + for link in self.links: + self.add_link(context=link.context, attributes=link.attributes, timestamp=self.nr_trace.start_time) + + def _remote(self): + """ + Remote span denotes if propagated from a remote parent + """ + return bool(self.opentelemetry_parent and self.opentelemetry_parent.is_remote) + + def get_span_context(self): + if not getattr(self, "nr_trace", False): + return otel_api_trace.INVALID_SPAN_CONTEXT + + return otel_api_trace.SpanContext( + trace_id=int(self.nr_transaction.trace_id, 16), + span_id=int(self.nr_trace.guid, 16), + is_remote=self._remote(), + trace_flags=otel_api_trace.TraceFlags(0x01), + trace_state=otel_api_trace.TraceState(), + ) + + def set_attribute(self, key, value): + self.attributes[key] = value + + def set_attributes(self, attributes): + for key, value in attributes.items(): + self.set_attribute(key, value) + + def _set_attributes_in_nr(self, opentelemetry_attributes=None): + if not opentelemetry_attributes or not getattr(self, "nr_trace", None): + return + + # If these attributes already exist in NR's agent attributes, + # keep the attributes in the OpenTelemetry span, but do not add them + # to NR's user attributes to avoid sending the same data + # multiple times. + for key, value in opentelemetry_attributes.items(): + if key not in self.nr_trace.agent_attributes: + self.nr_trace.add_custom_attribute(key, value) + + def add_event(self, name, attributes=None, timestamp=None): + """Add an event to the current span. + + If timestamp is None, this will get set to the current time. + """ + current_span_context = self.get_span_context() + current_trace_id = f"{current_span_context.trace_id:032x}" + current_span_id = f"{current_span_context.span_id:016x}" + + # Sanitize name, if not already a string. + try: + name = sanitize(name) + except Exception as e: + _logger.error("Invalid event name %s passed to add_event; event will not be created. Error: %s", name, e) + return + + self.nr_trace._add_span_event_event( + span_id=current_span_id, trace_id=current_trace_id, name=name, timestamp=timestamp, attributes=attributes + ) + + def add_link(self, context=None, attributes=None, timestamp=None): + """Add a link to another span. + + NOTE: `timestamp` is not an OpenTelemetry specific value. This is + a Hybrid Agent specific argument that allows us to set the + time of the link based on when the NR trace was created + (if the link was passed in during the span's creation), or + if added later on (the time when the link was added). + """ + if not context or not context.is_valid: + _logger.error("Invalid span context passed to add_link; link will not be created.") + return + + # If timestamp is None, use the current time + if timestamp: + timestamp = int(timestamp * 1e3) + else: + timestamp = int(time.time() * 1e3) + + link_trace_id = f"{context.trace_id:032x}" + link_span_id = f"{context.span_id:016x}" + current_span_context = self.get_span_context() + current_trace_id = f"{current_span_context.trace_id:032x}" + current_span_id = f"{current_span_context.span_id:016x}" + + self.nr_trace._add_span_link_event( + span_id=current_span_id, + trace_id=current_trace_id, + linked_span_id=link_span_id, + linked_trace_id=link_trace_id, + timestamp=timestamp, + attributes=attributes, + ) + + def update_name(self, name): + # NOTE: Sentinel, MessageTrace, DatastoreTrace, and + # ExternalTrace types do not have a name attribute. + self.name = name + if hasattr(self, "nr_trace") and hasattr(self.nr_trace, "name"): + self.nr_trace.name = self.name + + def is_recording(self): + # If the trace has an end time set then it is done recording. Otherwise, + # if it does not have an end time set and the transaction's priority + # has not been set yet or it is set to something other than 0 then it + # is also still recording. + if getattr(self.nr_trace, "end_time", None): + return False + + # If priority is either not set at this point + # or greater than 0, we are recording. + priority = self.nr_transaction.priority + return (priority is None) or (priority > 0) + + def set_status(self, status, description=None): + """ + This code is modeled after the OpenTelemetry SDK's + status implementation: + https://github.com/open-telemetry/opentelemetry-python/blob/main/opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py#L979 + + Additional Notes: + 1. Ignore future calls if status is already set to OK + since span should be completed if status is OK. + 2. Similarly, ignore calls to set to StatusCode.UNSET + since this will be either invalid or unnecessary. + """ + if isinstance(status, Status): + if (self.status.status_code is StatusCode.OK) or status.is_unset: + return + if description is not None: + # `description` should only exist if status is StatusCode.ERROR + _logger.warning( + "Description %s ignored. Use either `Status` or `(StatusCode, Description)`", description + ) + self.status = status + elif isinstance(status, StatusCode): + if (self.status.status_code is StatusCode.OK) or (status is StatusCode.UNSET): + return + self.status = Status(status, description) + else: + _logger.warning("Invalid status type %s. Expected Status or StatusCode.", type(status)) + return + + # Add status as attribute + self.set_attribute("status_code", self.status.status_code.name) + self.set_attribute("status_description", self.status.description) + + def record_exception(self, exception, attributes=None, timestamp=None, escaped=False): + error_args = sys.exc_info() if not exception else (type(exception), exception, exception.__traceback__) + + # `escaped` indicates whether the exception has not + # been unhandled by the time the span has ended. + if attributes: + attributes["exception.escaped"] = escaped + else: + attributes = {"exception.escaped": escaped} + + self.set_attributes(attributes) + + notice_error(error_args, attributes=attributes) + + def _obfuscate_query(self, sql, database): + database_to_quote_style_mapping = { + "postgresql": "single+dollar", + "psycopg2": "single+dollar", + "graphql": "single+double", + "mysql": "single+double", + } + + quotes_re, quotes_cleanup_re = _quotes_table.get( + database_to_quote_style_mapping.get(database), _quotes_table.get("single") + ) + sql = quotes_re.sub("?", sql) + sql = _all_literals_re.sub("?", sql) + if quotes_cleanup_re.search(sql): + sql = "?" + + return sql + + def _messagequeue_attribute_mapping(self): + host = self.attributes.get("net.peer.name") or self.attributes.get("server.address") + port = self.attributes.get("net.peer.port") or self.attributes.get("server.port") + name = self.name.split(maxsplit=1)[0] # OpenTelemetry's format for this is "name operation" + + # Logic for Pika/RabbitMQ + span_obj_attrs = { + "library": self.attributes.get("messaging.system"), + "destination_name": name, # OpenTelemetry's format for this is "name operation" + } + + if span_obj_attrs["library"] == "rabbitmq": + # In RabbitMQ, destination_type is always Exchange and + # destination_name is actually stored in the span name. + # messaging.destination stores the task_name (such as + # consumer tag) + span_obj_attrs["destination_type"] = "Exchange" + + agent_attrs = {"host": host, "port": port, "server.address": host, "server.port": port} + + # Kafka Specific Logic + if span_obj_attrs["library"] == "kafka": + span_obj_attrs.update( + { + "transport_type": "Kafka", + "destination_type": "Topic", + "destination_name": name + if (name != "unknown") + else "Default", # OpenTelemetry's format for this is "name operation" + } + ) + if isinstance(self.nr_transaction, MessageTransaction): + self.nr_transaction.transport_type = "Kafka" + self.nr_transaction.destination_type = "Topic" + + if ( + self.nr_transaction.destination_name.startswith("unknown") + and span_obj_attrs["destination_name"] != "unknown" + ): + self.nr_transaction.destination_name = span_obj_attrs["destination_name"] + else: + self.nr_transaction.destination_name = "Default" + + bootstrap_servers = json.loads(self.attributes.get("messaging.url", "[]")) + for server_name in bootstrap_servers: + produce_or_consume = "Produce" if self.kind == otel_api_trace.SpanKind.PRODUCER else "Consume" + self.nr_transaction.record_custom_metric( + f"MessageBroker/kafka/Nodes/{server_name}/{produce_or_consume}/{span_obj_attrs['destination_name']}", + 1, + ) + + # Even if the attribute is set to None, it should rename + # the transaction destination_name attribute as well: + if isinstance(self.nr_transaction, MessageTransaction): + name, group = self.nr_transaction.get_transaction_name( + span_obj_attrs["library"], span_obj_attrs["destination_type"], span_obj_attrs["destination_name"] + ) + self.nr_transaction.set_transaction_name(name, group) + + # We do not want to override any agent attributes + # with `None` if `value` does not exist. + for key, value in span_obj_attrs.items(): + if value: + setattr(self.nr_trace, key, value) + for key, value in agent_attrs.items(): + if value: + self.nr_trace._add_agent_attribute(key, value) + + def _database_attribute_mapping(self): + span_obj_attrs = { + "host": self.attributes.get("net.peer.name") or self.attributes.get("server.address"), + "database_name": self.attributes.get("db.name"), + "port_path_or_id": self.attributes.get("net.peer.port") or self.attributes.get("server.port"), + "product": self.attributes.get("db.system", self.attributes.get("db.system.name")), + } + agent_attrs = {} + + db_statement = self.attributes.pop("db.statement", None) + if db_statement: + if hasattr(db_statement, "string"): + db_statement = db_statement.string + operation, target = get_database_operation_target_from_statement(db_statement) + target = target or self.attributes.get("db.mongodb.collection") + span_obj_attrs.update({"operation": operation, "target": target}) + if self.nr_transaction.application.settings.transaction_tracer.record_sql != "off": + if self.nr_transaction.application.settings.transaction_tracer.record_sql == "obfuscated": + db_statement = self._obfuscate_query(db_statement, span_obj_attrs["product"]) + agent_attrs["db.statement"] = db_statement + elif span_obj_attrs["product"] == "dynamodb": + region = self.attributes.get("cloud.region") + operation = self.attributes.get("db.operation", self.attributes.get("db.operation.name")) + target = self.attributes.get("aws.dynamodb.table_names", [None])[-1] + account_id = self.nr_transaction.settings.cloud.aws.account_id + resource_id = generate_dynamodb_arn(span_obj_attrs["host"], region, account_id, target) + agent_attrs.update( + { + "aws.operation": operation, + "cloud.resource_id": resource_id, + "cloud.region": region, + "aws.requestId": self.attributes.get("aws.request_id"), + "http.statusCode": self.attributes.get("http.status_code"), + "cloud.account.id": account_id, + } + ) + span_obj_attrs.update({"target": target, "operation": operation}) + + # We do not want to override any agent attributes + # with `None` if `value` does not exist. + for key, value in span_obj_attrs.items(): + if value: + setattr(self.nr_trace, key, value) + for key, value in agent_attrs.items(): + if value: + self.nr_trace._add_agent_attribute(key, value) + + def _strawberry_operation_name_parser(self, span_name): + if ": " in span_name: + return span_name.split(": ")[1] + return self.nr_trace.agent_attributes.get("graphql.operation.name") + + def _graphql_attribute_mapping(self): + if self.nr_transaction.application.settings.transaction_tracer.record_sql == "obfuscated": + sql = self.attributes.get("query", "") + if sql: + self.attributes["query"] = self._obfuscate_query(sql, "graphql") + + for key in self.attributes.keys(): + if ("graphql.arg" in key) or ("graphql.param." in key): + self.attributes[key] = "?" + elif self.nr_transaction.application.settings.transaction_tracer.record_sql == "off": + self.attributes.pop("query", None) + for key in self.attributes.keys(): + if ("graphql.arg" in key) or ("graphql.param." in key): + self.attributes[key] = "" + + self.nr_trace._add_agent_attribute( + "graphql.field.path", + self.attributes.get("graphql.path", self.nr_trace.agent_attributes.get("graphql.field.path")), + ) + self.nr_trace._add_agent_attribute( + "graphql.field.parentType", + self.attributes.get("graphql.parentType", self.nr_trace.agent_attributes.get("graphql.field.parentType")), + ) + self.nr_trace._add_agent_attribute( + "graphql.operation.name", + self.attributes.get("graphql.operation.name", self._strawberry_operation_name_parser(self.name)), + ) + self.nr_trace._add_agent_attribute( + "graphql.operation.query", + self.attributes.get("query", self.nr_trace.agent_attributes.get("graphql.operation.query")), + ) + + def end(self, end_time=None, *args, **kwargs): + # We will ignore the end_time parameter and use NR's end_time + + # Check to see if New Relic trace ever existed + # or, if it does, that trace has already ended + if not self.nr_trace or getattr(self.nr_trace, "end_time", None): + return + + # We will need to add specific attributes to the + # NR trace before the node creation because the + # attributes were likely not available at the time + # of the trace's creation but eventually populated + # throughout the span's lifetime. + + # Database/Datastore specific attributes + if self.attributes.get("db.system", self.attributes.get("db.system.name")): + self._database_attribute_mapping() + + # Message specific attributes + if self.attributes.get("messaging.system"): + self._messagequeue_attribute_mapping() + + # External/Web specific attributes + if ("http.status_code" in self.attributes) and (isinstance(self.nr_transaction, WebTransaction)): + response_headers = { + key.split("http.response.header.")[1].replace("_", "-"): value[0] + for key, value in self.attributes.items() + if key.startswith("http.response.header.") + } + self.nr_transaction.process_response(str(self.attributes.get("http.status_code")), response_headers) + + self.nr_trace._add_agent_attribute("http.statusCode", self.attributes.get("http.status_code")) + + # GraphQL specific attributes + if self.attributes.get("component") and self.attributes.get("component").lower() == "graphql": + self._graphql_attribute_mapping() + + # Add OpenTelemetry attributes as custom NR trace attributes + self._set_attributes_in_nr(self.attributes) + + error = sys.exc_info() + self.set_status(StatusCode.OK if not error[0] else StatusCode.ERROR) + + # Only if unhandled exception do we want to abruptly end. + # Otherwise, ensure that the span is the last one to end. + if getattr(self.attributes, "exception.escaped", False) or ( + self.kind in (otel_api_trace.SpanKind.SERVER, otel_api_trace.SpanKind.CONSUMER) + and isinstance(current_trace(), Sentinel) + ): + # We need to end the transaction, which will + # end the sentinel trace as well. + self.nr_transaction.__exit__(*error) + else: + # Just end the existing trace + self.nr_trace.__exit__(*error) + + def __exit__(self, exc_type, exc_val, exc_tb): + """ + Ends context manager and calls `end` on the `Span`. + This is used when span is called as a context manager + i.e. `with tracer.start_span() as span:` + """ + if exc_val and self.is_recording(): + if self._record_exception: + self.record_exception(exception=exc_val, escaped=True) + if self.set_status_on_exception: + self.set_status(Status(status_code=StatusCode.ERROR, description=f"{exc_type.__name__}: {exc_val}")) + + super().__exit__(exc_type, exc_val, exc_tb) + + +class LazySpan(otel_api_trace.NonRecordingSpan, Span): + def __init__(self, context, trace): + super().__init__(context) + self.nr_trace = trace + + def set_attribute(self, key, value): + add_custom_span_attribute(key, value) + + def set_attributes(self, attributes): + for key, value in attributes.items(): + add_custom_span_attribute(key, value) + + add_event = Span.add_event + add_link = Span.add_link + + +class Tracer(otel_api_trace.Tracer): + def __init__( + self, + instrumentation_library=None, + instrumenting_library_version=None, + schema_url=None, + attributes=None, + resource=None, + *args, + **kwargs, + ): + self.instrumentation_library = instrumentation_library.split(".")[-1] + self.instrumenting_library_version = instrumenting_library_version + self.schema_url = schema_url + self.tracer_attributes = attributes or {} + self.resource = resource + + def _create_web_transaction(self, nr_headers=None): + if "nr.wsgi.environ" in self.attributes: + # This is a WSGI request + transaction = WSGIWebTransaction(self.nr_application, environ=self.attributes.pop("nr.wsgi.environ")) + elif "nr.asgi.scope" in self.attributes: + # This is an ASGI request + scope = self.attributes.pop("nr.asgi.scope") + scheme = scope.get("scheme", "http") + server = scope.get("server") or (None, None) + host, port = scope["server"] = tuple(server) + request_method = scope.get("method") + request_path = scope.get("path") + query_string = scope.get("query_string") + headers = scope["headers"] + transaction = WebTransaction( + application=self.nr_application, + name=self.name, + group="Uri", + scheme=scheme, + host=host, + port=port, + request_method=request_method, + request_path=request_path, + query_string=query_string, + headers=headers, + ) + else: + # This is a web request + nr_headers = nr_headers or {} + headers = self.attributes.pop("nr.http.headers", nr_headers) + scheme = self.attributes.get("http.scheme") + host = self.attributes.get("http.server_name") + port = self.attributes.get("net.host.port") + request_method = self.attributes.get("http.method") + request_path = self.attributes.get("http.route") + + transaction = WebTransaction( + self.nr_application, + name=self.name, + scheme=scheme, + host=host, + port=port, + request_method=request_method, + request_path=request_path, + headers=headers, + ) + return transaction + + def start_span( + self, + name, + context=None, # Optional[Context] + kind=otel_api_trace.SpanKind.INTERNAL, + attributes=None, + links=None, + start_time=None, + record_exception=True, + set_status_on_exception=True, + *args, + **kwargs, + ): + nr_trace_type = FunctionTrace + transaction = current_transaction() + self.nr_application = application_instance() + self.attributes = { + **(attributes or {}), + **self.tracer_attributes, + "schema_url": self.schema_url, + "library_name": self.instrumentation_library, + "library_version": self.instrumenting_library_version, + } + self.name = name + self.links = links or [] + + if not self.nr_application.active: + # Force application registration if not already active + self.nr_application.activate() + + self._record_exception = record_exception + self.set_status_on_exception = set_status_on_exception + + if not ( + self.nr_application.settings and self.nr_application.settings.opentelemetry.enabled + ) and not os.environ.get("NEW_RELIC_OPENTELEMETRY_ENABLED"): + return otel_api_trace.INVALID_SPAN + + # Retrieve parent span + parent_span_context = otel_api_trace.get_current_span(context).get_span_context() + + # Set default value for whether the span + # should create an analogous NR trace. + create_nr_trace = True + + if parent_span_context is None or not parent_span_context.is_valid: + parent_span_context = None + + parent_span_trace_id = None + nr_headers = {} + if parent_span_context and self.nr_application.settings.distributed_tracing.enabled: + parent_span_trace_id = parent_span_context.trace_id + if len(parent_span_context.trace_state) > 0: + # If headers did not propagate from an existing transaction due + # to no transaction existing at the time of extraction, the + # traceparent and tracestate will still be available in the context. + nr_headers["tracestate"] = parent_span_context.trace_state.to_header() + parent_span_span_id = parent_span_context.span_id + parent_span_trace_flag = parent_span_context.trace_flags + nr_headers["traceparent"] = ( + f"00-{parent_span_trace_id:032x}-{parent_span_span_id:016x}-{'01' if parent_span_trace_flag else '00'}" + ) + + if not self.nr_application.settings.opentelemetry.traces.enabled: + create_nr_trace = False + + # If remote_parent, transaction must be created, regardless of kind type + # Make sure we transfer DT headers when we are here, if DT is enabled + if parent_span_context and parent_span_context.is_remote: + if kind in (otel_api_trace.SpanKind.SERVER, otel_api_trace.SpanKind.CLIENT): + transaction = self._create_web_transaction(nr_headers) + if not self.nr_application.settings.opentelemetry.traces.enabled: + transaction.ignore_transaction = True + transaction.__enter__() + # If a transaction was already active, we want to create + # an NR trace under the existing transaction. Otherwise, + # do not create a new NR trace, aside from the transaction's + # root span. + if transaction.enabled: + create_nr_trace = False + elif kind in (otel_api_trace.SpanKind.PRODUCER, otel_api_trace.SpanKind.INTERNAL): + transaction = BackgroundTask(self.nr_application, name=self.name) + if not self.nr_application.settings.opentelemetry.traces.enabled: + transaction.ignore_transaction = True + transaction.__enter__() + # If a transaction was already active, we want to create + # an NR trace under the existing transaction. Otherwise, + # do not create a new NR trace, aside from the transaction's + # root span. + if transaction.enabled: + create_nr_trace = False + elif kind == otel_api_trace.SpanKind.CONSUMER: + transaction = MessageTransaction( + library=self.instrumentation_library, + destination_type="Exchange", + destination_name=self.name, + application=self.nr_application, + headers=nr_headers, + ) + if not self.nr_application.settings.opentelemetry.traces.enabled: + transaction.ignore_transaction = True + transaction.__enter__() + # In the case of a Kafka consumer span, we do not want to create + # a trace regardless of whether a transaction already existed. + # This scenario should either create a transaction or use + # the existing transaction and add additional attributes to it. + create_nr_trace = False + + if not transaction.enabled: + # We will reach this if there already was a transaction + # active. The attempt at creating a transaction will + # create one where transaction.enabled == False, so + # we do not want to pass an inactive transaction along. + transaction = current_transaction() + + # If not parent_span_context or not parent_span_context.is_remote + # To simplify calculation logic, we will use DeMorgan's Theorem: + # (!parent_span_context or !parent_span_context.is_remote) + # !!(!parent_span_context or !parent_span_context.is_remote) + # !(parent_span_context and parent_span_context.is_remote) + elif not (parent_span_context and parent_span_context.is_remote): + if kind == otel_api_trace.SpanKind.SERVER: + if transaction: + nr_trace_type = FunctionTrace + elif not transaction: + transaction = self._create_web_transaction(nr_headers) + + transaction._trace_id = ( + f"{parent_span_trace_id:x}" if parent_span_trace_id else transaction.trace_id + ) + if not self.nr_application.settings.opentelemetry.traces.enabled: + transaction.ignore_transaction = True + transaction.__enter__() + create_nr_trace = False + elif kind == otel_api_trace.SpanKind.INTERNAL: + if transaction: + nr_trace_type = FunctionTrace + else: + return otel_api_trace.INVALID_SPAN + elif kind == otel_api_trace.SpanKind.CLIENT: + if transaction: + if self.attributes.get("http.url") or self.attributes.get("http.method"): + nr_trace_type = ExternalTrace + else: + nr_trace_type = DatastoreTrace + else: + return otel_api_trace.INVALID_SPAN + elif kind == otel_api_trace.SpanKind.CONSUMER: + # NOTE for instrumenting a Kafka consumer span: + # If a transaction already exists, do not create a new one + # nor should we create a MessageTrace under it. We do, + # however, want to add additional attributes from this span + # into the existing transaction. + if transaction and ( + getattr(self, "_create_consumer_trace", False) or (self.instrumentation_library != "kafka") + ): + # If transaction already exists and the + # _create_consumer_trace flag is set to True, + # then create a MessageTrace under it. + # Note that for Kafka, this flag will not be + # set, so we will not create a MessageTrace + nr_trace_type = MessageTrace + else: + transaction = MessageTransaction( + library=self.instrumentation_library, + destination_type="Exchange", + destination_name=self.name, + application=self.nr_application, + headers=nr_headers, + ) + if not self.nr_application.settings.opentelemetry.traces.enabled: + transaction.ignore_transaction = True + transaction.__enter__() + # In the case of a Kafka consumer span, we do not want to create + # a trace regardless of whether a transaction already existed. + # This scenario should either create a transaction or use + # the existing transaction and add additional attributes to it. + if (self.instrumentation_library == "kafka") or not getattr(self, "_create_consumer_trace", False): + create_nr_trace = False + + if self.instrumentation_library == "kafka": + # Whether a transaction exists or not, do not create a NR + # trace for the case of a consumer span. + create_nr_trace = False + elif kind == otel_api_trace.SpanKind.PRODUCER: + if transaction: + nr_trace_type = MessageTrace + else: + return otel_api_trace.INVALID_SPAN + + # Start transactions in this method, but start traces + # in Span. Span function will take in some Span args + # as well as info for NR applications/transactions + span = Span( + name=self.name, + parent=parent_span_context, + resource=self.resource, + attributes=self.attributes, + kind=kind, + nr_transaction=transaction, + nr_trace_type=nr_trace_type, + instrumenting_module=self.instrumentation_library, + record_exception=self._record_exception, + set_status_on_exception=self.set_status_on_exception, + create_nr_trace=create_nr_trace, + links=links, + ) + + # Remove the tracer._create_consumer_trace flag since + # the span is created now. + if hasattr(self, "_create_consumer_trace"): + delattr(self, "_create_consumer_trace") + + return span + + @contextmanager + def start_as_current_span( + self, + name=None, + context=None, + kind=otel_api_trace.SpanKind.INTERNAL, + attributes=None, + links=None, + end_on_exit=True, + record_exception=True, + set_status_on_exception=True, + ): + span = self.start_span( + name, + context=context, + kind=kind, + attributes=attributes, + record_exception=record_exception, + set_status_on_exception=set_status_on_exception, + links=links, + ) + + with otel_api_trace.use_span( + span, + end_on_exit=end_on_exit, + record_exception=record_exception, + set_status_on_exception=set_status_on_exception, + ) as current_span: + yield current_span + + +class TracerProvider(otel_api_trace.TracerProvider): + def __init__(self, *args, **kwargs): + self._resource = create_resource(hybrid_bridge=True) + + def get_tracer( + self, + instrumenting_module_name="Default", + instrumenting_library_version=None, + schema_url=None, + attributes=None, + *args, + **kwargs, + ): + return Tracer( + *args, + instrumentation_library=instrumenting_module_name, + instrumenting_library_version=instrumenting_library_version, + schema_url=schema_url, + attributes=attributes, + resource=self._resource, + **kwargs, + ) diff --git a/newrelic/api/time_trace.py b/newrelic/api/time_trace.py index 800c6f01b7..d5ebc07fef 100644 --- a/newrelic/api/time_trace.py +++ b/newrelic/api/time_trace.py @@ -51,6 +51,8 @@ def __init__(self, parent=None, source=None): self.guid = f"{random.getrandbits(64):016x}" self.agent_attributes = {} self.user_attributes = {} + self.span_link_events = [] + self.span_event_events = [] self._source = source @@ -215,6 +217,66 @@ def add_code_level_metrics(self, source): exc, ) + def _add_span_link_event(self, span_id, trace_id, linked_span_id, linked_trace_id, timestamp=None, attributes=None): + settings = self.settings + if not settings: + return + + if not settings.opentelemetry.enabled: + return + + if len(self.span_link_events) >= 100: + self.transaction._record_supportability("Supportability/SpanEvent/Links/Dropped") + return + + if attributes: + attributes = dict(attributes) + else: + attributes = {} + + event = [ + { + "type": "SpanLink", + "timestamp": timestamp or int(time.time() * 1e3), + "id": span_id, + "trace.id": trace_id, + "linkedSpanId": linked_span_id, + "linkedTraceId": linked_trace_id, + }, + attributes, + {}, + ] + + self.span_link_events.append(event) + + def _add_span_event_event(self, name, span_id, trace_id, timestamp=None, attributes=None): + settings = self.settings + if not settings: + return + + if not settings.opentelemetry.enabled: + return + + if len(self.span_event_events) >= 100: + self.transaction._record_supportability("Supportability/SpanEvent/Events/Dropped") + return + + attributes = dict(attributes) or {} + + event = [ + { + "type": "SpanEvent", + "timestamp": timestamp or int(time.time() * 1e3), + "span.id": span_id, + "trace.id": trace_id, + "name": name, + }, + attributes, + {}, + ] + + self.span_event_events.append(event) + def _observe_exception(self, exc_info=None, ignore=None, expected=None, status_code=None): # Bail out if the transaction is not active or # collection of errors not enabled. diff --git a/newrelic/api/transaction.py b/newrelic/api/transaction.py index b163ff54fd..5d80ca2b83 100644 --- a/newrelic/api/transaction.py +++ b/newrelic/api/transaction.py @@ -285,7 +285,8 @@ def __init__(self, application, enabled=None, source=None): self.tracestate = "" self._priority = None self._sampled = None - self._traceparent_sampled = None + # Remote parent sampled is set from the W3C parent header or the Newrelic header if no W3C parent header is present. + self._remote_parent_sampled = None self._distributed_trace_state = 0 @@ -535,6 +536,8 @@ def __exit__(self, exc, value, tb): path=self.path, trusted_parent_span=self.trusted_parent_span, tracing_vendors=self.tracing_vendors, + span_link_events=root.span_link_events, + span_event_events=root.span_event_events, ) # Add transaction exclusive time to total exclusive time @@ -569,7 +572,13 @@ def __exit__(self, exc, value, tb): if self._settings.distributed_tracing.enabled: # Sampled and priority need to be computed at the end of the # transaction when distributed tracing or span events are enabled. - self._compute_sampled_and_priority() + self._make_sampling_decision() + else: + # If dt is disabled, set sampled=False and priority random number between 0 and 1. + # The priority of the transaction is used for other data like transaction + # events even when span events are not sent. + self._priority = float(f"{random.random():.6f}") # noqa: S311 + self._sampled = False self._cached_path._name = self.path agent_attributes = self.agent_attributes @@ -636,6 +645,7 @@ def __exit__(self, exc, value, tb): trace_id=self.trace_id, loop_time=self._loop_time, root=root_node, + partial_granularity_sampled=getattr(self, "partial_granularity_sampled", False), ) # Clear settings as we are all done and don't need it @@ -1004,35 +1014,149 @@ def _update_agent_attributes(self): def user_attributes(self): return create_attributes(self._custom_params, DST_ALL, self.attribute_filter) - def sampling_algo_compute_sampled_and_priority(self): - if self._priority is None: + def sampling_algo_compute_sampled_and_priority(self, priority, sampled, sampler_kwargs): + # self._priority and self._sampled are set when parsing the W3C tracestate + # or newrelic DT headers and may be overridden in _make_sampling_decision + # based on the configuration. The only time they are set in here is when the + # sampling decision must be made by the adaptive sampling algorithm. + adjust_priority = priority is None or sampled is None + if priority is None: # Truncate priority field to 6 digits past the decimal. - self._priority = float(f"{random.random():.6f}") # noqa: S311 - if self._sampled is None: - self._sampled = self._application.compute_sampled() - if self._sampled: - self._priority += 1 - - def _compute_sampled_and_priority(self): - if self._traceparent_sampled is None: - config = "default" # Use sampling algo. - elif self._traceparent_sampled: - setting_path = "distributed_tracing.sampler.remote_parent_sampled" - config = self.settings.distributed_tracing.sampler.remote_parent_sampled - else: # self._traceparent_sampled is False. - setting_path = "distributed_tracing.sampler.remote_parent_not_sampled" - config = self.settings.distributed_tracing.sampler.remote_parent_not_sampled - + priority = float(f"{random.random():.6f}") # noqa: S311 + if sampled is None: + # _logger.trace("No trusted account id found. Sampling decision will be made by adaptive sampling algorithm.") + sampled = self._application.compute_sampled(**sampler_kwargs) + if adjust_priority and sampled: + # Make sure priority is <1 so we don't end up with priorities >3. + priority = priority - int(priority) + # Increment the priority + 2 for full and + 1 for partial granularity. + priority += 1 + int(sampler_kwargs.get("full_granularity")) + return priority, sampled + + def _compute_sampled_and_priority( + self, + priority, + sampled, + full_granularity, + root_setting, + remote_parent_sampled_setting, + remote_parent_not_sampled_setting, + ): + if self._remote_parent_sampled is None: + section = 0 + # setting_path = f"distributed_tracing.sampler{'' if full_granularity else '.partial_granularity'}.root" + config = root_setting + # _logger.trace( + # "Sampling decision made based on no remote parent sampling decision present and %s=%s.", + # setting_path, + # config, + # ) + elif self._remote_parent_sampled: + section = 1 + # setting_path = ( + # f"distributed_tracing.sampler{'' if full_granularity else '.partial_granularity'}.remote_parent_sampled" + # ) + config = remote_parent_sampled_setting + # _logger.trace( + # "Sampling decision made based on remote_parent_sampled=%s and %s=%s.", + # self._remote_parent_sampled, + # setting_path, + # config, + # ) + else: # self._remote_parent_sampled is False. + section = 2 + # setting_path = f"distributed_tracing.sampler{'' if full_granularity else '.partial_granularity'}.remote_parent_not_sampled" + config = remote_parent_not_sampled_setting + # _logger.trace( + # "Sampling decision made based on remote_parent_sampled=%s and %s=%s.", + # self._remote_parent_sampled, + # setting_path, + # config, + # ) if config == "always_on": - self._sampled = True - self._priority = 2.0 + sampled = True + # priority=3 for full granularity and priority=2 for partial granularity. + priority = 2.0 + int(full_granularity) + return priority, sampled elif config == "always_off": - self._sampled = False - self._priority = 0 - else: - if config != "default": - _logger.warning("%s=%s is not a recognized value. Using 'default' instead.", setting_path, config) - self.sampling_algo_compute_sampled_and_priority() + sampled = False + priority = 0 + return priority, sampled + elif config == "trace_id_ratio_based": + # _logger.trace("Let trace id ratio based sampler algorithm decide based on trace_id = %s.", self._trace_id) + # If the ratio is not set the sampler proxy will fall back on the global adaptive sampler. + priority, sampled = self.sampling_algo_compute_sampled_and_priority( + priority, + None, # The sampled value from the parent is not used in this case and should always be overridden. + { + "full_granularity": full_granularity, + "section": section, + "trace_id": int(self._trace_id.lower().zfill(32), 16), + }, + ) + return priority, sampled + if config not in ("default", "adaptive"): + _logger.warning("%s is not a recognized value for a sampler type. Using 'adaptive' instead.", config) + + # _logger.trace("Let adaptive sampler algorithm decide based on sampled=%s and priority=%s.", sampled, priority) + priority, sampled = self.sampling_algo_compute_sampled_and_priority( + priority, sampled, {"full_granularity": full_granularity, "section": section} + ) + return priority, sampled + + def _make_sampling_decision(self): + # The sampling decision is computed each time a DT header is generated for exit spans as it is needed + # to send the DT headers. Don't recompute the sampling decision multiple times as it is expensive. + if hasattr(self, "_sampling_decision_made"): + return + priority = self._priority + sampled = self._sampled + # Compute sampling decision for full granularity. + if self.settings.distributed_tracing.sampler.full_granularity.enabled: + # _logger.trace( + # "Full granularity tracing is enabled. Asking if full granularity wants to sample. priority=%s, sampled=%s", + # priority, + # sampled, + # ) + computed_priority, computed_sampled = self._compute_sampled_and_priority( + priority, + sampled, + full_granularity=True, + root_setting=self.settings.distributed_tracing.sampler._root, + remote_parent_sampled_setting=self.settings.distributed_tracing.sampler._remote_parent_sampled, + remote_parent_not_sampled_setting=self.settings.distributed_tracing.sampler._remote_parent_not_sampled, + ) + # _logger.trace("Full granularity sampling decision was %s with priority=%s.", sampled, priority) + if computed_sampled or not self.settings.distributed_tracing.sampler.partial_granularity.enabled: + self._priority = computed_priority + self._sampled = computed_sampled + self._sampling_decision_made = True + return + + # If full granularity is not going to sample, let partial granularity decide. + if self.settings.distributed_tracing.sampler.partial_granularity.enabled: + # _logger.trace("Partial granularity tracing is enabled. Asking if partial granularity wants to sample.") + self._priority, self._sampled = self._compute_sampled_and_priority( + priority, + sampled, + full_granularity=False, + root_setting=self.settings.distributed_tracing.sampler.partial_granularity._root, + remote_parent_sampled_setting=self.settings.distributed_tracing.sampler.partial_granularity._remote_parent_sampled, + remote_parent_not_sampled_setting=self.settings.distributed_tracing.sampler.partial_granularity._remote_parent_not_sampled, + ) + # _logger.trace( + # "Partial granularity sampling decision was %s with priority=%s.", self._sampled, self._priority + # ) + self._sampling_decision_made = True + if self._sampled: + self.partial_granularity_sampled = True + return + + # This is only reachable if both full and partial granularity tracing are off. + # Set priority to random number between 0 and 1 and do not sample. This enables + # DT headers to still be sent even if the trace is never sampled. + self._priority = float(f"{random.random():.6f}") # noqa: S311 + self._sampled = False def _freeze_path(self): if self._frozen_path is None: @@ -1101,7 +1225,7 @@ def _create_distributed_trace_data(self): if not (account_id and application_id and trusted_account_key and settings.distributed_tracing.enabled): return - self._compute_sampled_and_priority() + self._make_sampling_decision() data = { "ty": "App", "ac": account_id, @@ -1204,7 +1328,7 @@ def _accept_distributed_trace_payload(self, payload, transport_type="HTTP"): if not any(k in data for k in ("id", "tx")): self._record_supportability("Supportability/DistributedTrace/AcceptPayload/ParseException") return False - + self._remote_parent_sampled = data.get("sa") settings = self._settings account_id = data.get("ac") trusted_account_key = settings.trusted_account_key or ( @@ -1254,10 +1378,8 @@ def _accept_distributed_trace_data(self, data, transport_type): self._trace_id = data.get("tr") - priority = data.get("pr") - if priority is not None: - self._priority = priority - self._sampled = data.get("sa") + self._priority = data.get("pr") + self._sampled = data.get("sa") if "ti" in data: transport_start = data["ti"] / 1000.0 @@ -1297,6 +1419,7 @@ def accept_distributed_trace_headers(self, headers, transport_type="HTTP"): try: traceparent = ensure_str(traceparent).strip() data = W3CTraceParent.decode(traceparent) + self._remote_parent_sampled = data.pop("sa", None) except: data = None @@ -1332,7 +1455,6 @@ def accept_distributed_trace_headers(self, headers, transport_type="HTTP"): else: self._record_supportability("Supportability/TraceContext/TraceState/NoNrEntry") - self._traceparent_sampled = data.get("sa") self._accept_distributed_trace_data(data, transport_type) self._record_supportability("Supportability/TraceContext/Accept/Success") return True diff --git a/newrelic/common/encoding_utils.py b/newrelic/common/encoding_utils.py index 6f7e9d199f..b59992782a 100644 --- a/newrelic/common/encoding_utils.py +++ b/newrelic/common/encoding_utils.py @@ -418,7 +418,9 @@ def text(self): else: guid = f"{random.getrandbits(64):016x}" - return f"00-{self['tr'].lower().zfill(32)}-{guid}-{int(self.get('sa', 0)):02x}" + v = self.get("v", "00") + + return f"{v}-{self['tr'].lower().zfill(32)}-{guid}-{int(self.get('sa', 0)):02x}" @classmethod def decode(cls, payload): @@ -459,7 +461,7 @@ def decode(cls, payload): # Sampled flag sa = bool(int(fields[3], 2) & FLAG_SAMPLED) - return cls(tr=trace_id, id=parent_id, sa=sa) + return cls(tr=trace_id, id=parent_id, sa=sa, v=version) class W3CTraceState(OrderedDict): @@ -483,14 +485,27 @@ def decode(cls, tracestate): class NrTraceState(dict): - FIELDS = ("ty", "ac", "ap", "id", "tx", "sa", "pr") + FIELDS = ("v", "ty", "ac", "ap", "id", "tx", "sa", "pr") + # Fields Key: + # v: version + # ty: type; {"0": "App", "1": "Browser", "2": "Mobile"} + # ac: account ID + # ap: application ID + # id: span ID + # tx: transaction guid + # sa: sampled + # pr: priority + # tr: trace ID + # tk: trusted account key + # ti: time def text(self): pr = self.get("pr", "") if pr: pr = f"{pr:.6f}".rstrip("0").rstrip(".") - - payload = f"0-0-{self['ac']}-{self['ap']}-{self.get('id', '')}-{self.get('tx', '')}-{'1' if self.get('sa') else '0'}-{pr}-{self['ti']!s}" + version = self.get("v", "0") + ty = "0" # Hardcode this as it will always be App. + payload = f"{version}-{ty}-{self['ac']}-{self['ap']}-{self.get('id', '')}-{self.get('tx', '')}-{'1' if self.get('sa') else '0'}-{pr}-{self['ti']!s}" return f"{self.get('tk', self['ac'])}@nr={payload}" @classmethod @@ -504,7 +519,7 @@ def decode(cls, payload, tk): except: return - for name, value in zip(cls.FIELDS, fields[1:]): + for name, value in zip(cls.FIELDS, fields): if value: data[name] = value diff --git a/newrelic/common/opentelemetry_tracers.py b/newrelic/common/opentelemetry_tracers.py new file mode 100644 index 0000000000..4085fef634 --- /dev/null +++ b/newrelic/common/opentelemetry_tracers.py @@ -0,0 +1,243 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +# This is a mapping of the entry_point name of the +# OpenTelemetry instrumentor and the list of targets in the +# NR hooks that need to be disabled if the OpenTelemetry +# instrumentor is to be used instead. +HYBRID_AGENT_DEFAULT_INCLUDED_TRACERS_TO_NR_HOOKS = { + "aio-pika": [], + "aiohttp_client": ["aiohttp.client", "aiohttp.client_reqrep"], + "aiohttp_server": [ + "aiohttp.web", + "aiohttp.wsgi", + "aiohttp.web_reqrep", + "aiohttp.web_response", + "aiohttp.web_urldispatcher", + "aiohttp.protocol", + ], + "aiokafka": [], + "aiopg": [ + "psycopg2", + "psycopg2._psycopg2", + "psycopg2.extensions", + "psycopg2._json", + "psycopg2._range", + "psycopg2.sql", + ], + "ariadne": [ + "ariadne.graphql", + "graphql.graphql", + "graphql.execution.execute", + "graphql.execution.executor", + "graphql.execution.middleware", + "graphql.execution.utils", + "graphql.error.located_error", + "graphql.language.parser", + "graphql.validation.validate", + "graphql.validation.validation", + "graphql.type.schema", + ], + "asyncclick": [], + "asyncpg": ["asyncpg.connect_utils", "asyncpg.protocol"], + # "boto": [], # this is boto3 + # "boto3": [], # this is boto3sqs + # "botocore": [], + "cassandra": ["cassandra", "cassandra.cluster"], + "celery": ["celery.local", "celery.app.trace", "celery.worker", "celery.concurrency.prefork", "billiard.pool"], + "click": [], + "confluent_kafka": [ + "confluent_kafka.cimpl", + "confluent_kafka.serializing_producer", + "confluent_kafka.deserializing_consumer", + ], + "django": [ + "django.core.handlers.base", + "django.core.handlers.asgi", + "django.core.handlers.wsgi", + "django.core.urlresolvers", + "django.template", + "django.template.loader_tags", + "django.core.servers.basehttp", + "django.contrib.staticfiles.views", + "django.contrib.staticfiles.handlers", + "django.views.debug", + "django.http.multipartparser", + "django.core.mail", + "django.core.mail.message", + "django.views.generic.base", + "django.core.management.base", + "django.template.base", + "django.middleware.gzip", + "django.urls.resolvers", + "django.urls.base", + "django.core.handlers.exception", + ], + "elasticsearch": [ + "elasticsearch.client", + "elasticsearch._async.client", + "elasticsearch._sync.client", + "elasticsearch._async.client", + "elasticsearch.client.cat", + "elasticsearch._async.client.cat", + "elasticsearch._sync.client.cat", + "elasticsearch.client.cluster", + "elasticsearch._async.client.cluster", + "elasticsearch._sync.client.cluster", + "elasticsearch.client.indices", + "elasticsearch._async.client.indices", + "elasticsearch._sync.client.indices", + "elasticsearch.client.nodes", + "elasticsearch._async.client.nodes", + "elasticsearch._sync.client.nodes", + "elasticsearch.client.snapshot", + "elasticsearch._async.client.snapshot", + "elasticsearch._sync.client.snapshot", + "elasticsearch.client.tasks", + "elasticsearch._async.client.tasks", + "elasticsearch._sync.client.tasks", + "elasticsearch.client.ingest", + "elasticsearch._async.client.ingest", + "elasticsearch._sync.client.ingest", + "elasticsearch.connection.base", + "elasticsearch._async.http_aiohttp", + "elastic_transport._node._base", + "elastic_transport._node._base_async", + "elasticsearch.transport", + "elasticsearch._async.transport", + "elastic_transport._transport", + "elastic_transport._async_transport", + ], + "falcon": ["falcon.api", "falcon.app", "falcon.routing.util"], + "fastapi": [ + "fastapi.routing", + "starlette.requests", + "starlette.routing", + "starlette.applications", + "starlette.middleware.errors", + "starlette.middleware.exceptions", + "starlette.exceptions", + "starlette.background", + ], + "flask": ["flask.app", "flask.templating", "flask.blueprints", "flask.views"], + "httpx": ["httpx._client", "urllib.request"], + "jinja2": ["jinja2.environment"], + "kafka": ["kafka.consumer.group", "kafka.producer.kafka", "kafka.coordinator.heartbeat"], + "logging": ["logging"], + "mysql": ["mysql.connector"], + "mysqlclient": ["MySQLdb"], + "pika": ["pika.adapters", "pika.channel", "pika.spec"], + "psycopg": ["psycopg", "psycopg.sql"], + "psycopg2": [ + "psycopg2", + "psycopg2._psycopg2", + "psycopg2.extensions", + "psycopg2._json", + "psycopg2._range", + "psycopg2.sql", + ], + "pymemcache": ["pymemcache.client"], + "pymongo": [ + "pymongo.synchronous.pool", + "pymongo.asynchronous.pool", + "pymongo.synchronous.collection", + "pymongo.asynchronous.collection", + "pymongo.synchronous.mongo_client", + "pymongo.asynchronous.mongo_client", + "pymongo.connection", + "pymongo.collection", + "pymongo.mongo_client", + ], + "pymssql": ["pymssql"], + "pymysql": ["pymysql"], + "pyramid": ["pyramid.router", "pyramid.config", "pyramid.config.views", "pyramid.config.tweens"], + "redis": [ + "redis.asyncio.client", + "redis.asyncio.commands", + "redis.asyncio.connection", + "redis.connection", + "redis.client", + "redis.commands.cluster", + "redis.commands.core", + "redis.commands.sentinel", + "redis.commands.json.commands", + "redis.commands.search.commands", + "redis.commands.timeseries.commands", + "redis.commands.bf.commands", + "redis.commands.graph.commands", + "redis.commands.vectorset.commands", + ], + "remoulade": [], + "requests": [ + "requests.sessions", + "requests.api", + "urllib3.connectionpool", + "urllib3.connection", + "requests.packages.urllib3.connection", + "http.client", + "httplib2", + ], + "sqlalchemy": [], + "sqlite3": ["sqlite3", "sqlite3.dbapi2", "pysqlite2", "pysqlite2.dbapi2"], + "starlette": [ + "starlette.requests", + "starlette.routing", + "starlette.applications", + "starlette.middleware.errors", + "starlette.middleware.exceptions", + "starlette.exceptions", + "starlette.background", + # "starlette.concurrency", # This is deliberately excluded + ], + "strawberry-graphql": [ + "strawberry.schema.schema", + "strawberry.schema.schema_converter", + "graphql.graphql", + "graphql.execution.execute", + "graphql.execution.executor", + "graphql.execution.middleware", + "graphql.execution.utils", + "graphql.error.located_error", + "graphql.language.parser", + "graphql.validation.validate", + "graphql.validation.validation", + "graphql.type.schema", + ], + "system_metrics": [], + "threading": [], + "tornado": [ + "tornado.httpserver", + "tornado.httputil", + "tornado.httpclient", + "tornado.routing", + "tornado.web", + "http.client", + ], + "tortoiseorm": [], + "urllib": ["urllib.request", "http.client"], + "urllib3": ["urllib3.connectionpool", "urllib3.connection", "requests.packages.urllib3.connection", "http.client"], +} + + +TEMPORARILY_DISABLED_OPENTELEMETRY_FRAMEWORKS = { + "boto", + "boto3", + "botocore", + "aws-lambda", + "grpc_aio_client", + "grpc_aio_server", + "grpc_client", + "grpc_server", +} diff --git a/newrelic/config.py b/newrelic/config.py index 3960e4e1ea..37bbb7b4a6 100644 --- a/newrelic/config.py +++ b/newrelic/config.py @@ -43,6 +43,11 @@ import newrelic.core.config from newrelic.common.log_file import initialize_logging from newrelic.common.object_names import callable_name, expand_builtin_exception_name +from newrelic.common.opentelemetry_tracers import ( + HYBRID_AGENT_DEFAULT_INCLUDED_TRACERS_TO_NR_HOOKS, + TEMPORARILY_DISABLED_OPENTELEMETRY_FRAMEWORKS, +) +from newrelic.common.package_version_utils import get_package_version from newrelic.core import trace_cache from newrelic.core.agent_control_health import ( HealthStatus, @@ -53,6 +58,15 @@ __all__ = ["filter_app_factory", "initialize"] + +# Add trace log level to logging module +def trace(self, message, *args, **kws): + self.log(logging.TRACE, message, args, **kws) + + +logging.TRACE = 5 +logging.addLevelName(logging.TRACE, "TRACE") +logging.Logger.trace = trace _logger = logging.getLogger(__name__) DEPRECATED_MODULES = {"aioredis": datetime(2022, 2, 22, 0, 0, tzinfo=timezone.utc)} @@ -66,7 +80,7 @@ def _map_aws_account_id(s): # triggering of callbacks to monkey patch modules before import # returns them to caller. -sys.meta_path.insert(0, newrelic.api.import_hook.ImportHookFinder()) +newrelic.api.import_hook.enable_import_hook_finder() # The set of valid feature flags that the agent currently uses. # This will be used to validate what is provided and issue warnings @@ -95,7 +109,17 @@ def _map_aws_account_id(s): # modules to look up customised settings defined in the loaded # configuration file. -_config_object = configparser.RawConfigParser() + +def ratio(value): + try: + val = float(value) + if 0 < val <= 1: + return val + except ValueError: + pass + + +_config_object = configparser.RawConfigParser(converters={"ratio": ratio}) # Cache of the parsed global settings found in the configuration # file. We cache these so can dump them out to the log file once @@ -108,7 +132,7 @@ def _map_aws_account_id(s): def _reset_config_parser(): global _config_object global _cache_object - _config_object = configparser.RawConfigParser() + _config_object = configparser.RawConfigParser(converters={"ratio": ratio}) _cache_object = [] @@ -150,6 +174,7 @@ def extra_settings(section, types=None, defaults=None): "WARNING": logging.WARNING, "INFO": logging.INFO, "DEBUG": logging.DEBUG, + "TRACE": logging.TRACE, } _RECORD_SQL = { @@ -319,6 +344,92 @@ def _process_setting(section, option, getter, mapper): _raise_configuration_error(section, option) +def _process_dt_hidden_setting(section, option, getter): + try: + # The type of a value is dictated by the getter + # function supplied. + + value = getattr(_config_object, getter)(section, option) + + # Now need to apply the option from the + # configuration file to the internal settings + # object. Walk the object path and assign it. + + target = _settings + fields = option.split(".", 1) + + if value == "trace_id_ratio_based": + raise configparser.NoOptionError("trace_id_ratio_sampler option can only be set by configuring the ratio") + while True: + if len(fields) == 1: + value = value or "default" + # Store the value at the underscored location so if option is + # distributed_tracing.sampler.full_granularity.remote_parent_sampled + # store it at location + # distributed_tracing.sampler.full_granularity._remote_parent_sampled + setattr(target, f"_{fields[0]}", value) + break + target = getattr(target, fields[0]) + fields = fields[1].split(".", 1) + + # Cache the configuration so can be dumped out to + # log file when whole main configuration has been + # processed. This ensures that the log file and log + # level entries have been set. + + _cache_object.append((option, value)) + + except configparser.NoSectionError: + pass + + except configparser.NoOptionError: + pass + + except Exception: + _raise_configuration_error(section, option) + + +def _process_dt_sampler_setting(section, option, getter): + try: + # The type of a value is dictated by the getter + # function supplied. + + value = getattr(_config_object, getter)(section, option) + + # Now need to apply the option from the + # configuration file to the internal settings + # object. Walk the object path and assign it. + + target = _settings + fields = option.split(".", 1) + + while True: + if len(fields) == 1: + setattr(target, f"{fields[0]}", value) + break + elif fields[0] in ("root", "remote_parent_sampled", "remote_parent_not_sampled"): + sampler = fields[1].split(".", 1)[0] + setattr(target, f"_{fields[0]}", sampler) + target = getattr(target, fields[0]) + fields = fields[1].split(".", 1) + + # Cache the configuration so can be dumped out to + # log file when whole main configuration has been + # processed. This ensures that the log file and log + # level entries have been set. + + _cache_object.append((option, value)) + + except configparser.NoSectionError: + pass + + except configparser.NoOptionError: + pass + + except Exception: + _raise_configuration_error(section, option) + + # Processing of all the settings for specified section except # for log file and log level which are applied separately to # ensure they are set as soon as possible. @@ -404,8 +515,58 @@ def _process_configuration(section): _process_setting(section, "ml_insights_events.enabled", "getboolean", None) _process_setting(section, "distributed_tracing.enabled", "getboolean", None) _process_setting(section, "distributed_tracing.exclude_newrelic_header", "getboolean", None) - _process_setting(section, "distributed_tracing.sampler.remote_parent_sampled", "get", None) - _process_setting(section, "distributed_tracing.sampler.remote_parent_not_sampled", "get", None) + _process_setting(section, "distributed_tracing.sampler.adaptive_sampling_target", "getint", None) + _process_dt_hidden_setting(section, "distributed_tracing.sampler.root", "get") + _process_dt_sampler_setting(section, "distributed_tracing.sampler.root.adaptive.sampling_target", "getint") + _process_dt_sampler_setting(section, "distributed_tracing.sampler.root.trace_id_ratio_based.ratio", "getratio") + _process_dt_hidden_setting(section, "distributed_tracing.sampler.remote_parent_sampled", "get") + _process_dt_sampler_setting( + section, "distributed_tracing.sampler.remote_parent_sampled.adaptive.sampling_target", "getint" + ) + _process_dt_sampler_setting( + section, "distributed_tracing.sampler.remote_parent_sampled.trace_id_ratio_based.ratio", "getratio" + ) + _process_dt_hidden_setting(section, "distributed_tracing.sampler.remote_parent_not_sampled", "get") + _process_dt_sampler_setting( + section, "distributed_tracing.sampler.remote_parent_not_sampled.adaptive.sampling_target", "getint" + ) + _process_dt_sampler_setting( + section, "distributed_tracing.sampler.remote_parent_not_sampled.trace_id_ratio_based.ratio", "getratio" + ) + _process_setting(section, "distributed_tracing.sampler.full_granularity.enabled", "getboolean", None) + _process_setting(section, "distributed_tracing.sampler.partial_granularity.enabled", "getboolean", None) + _process_setting(section, "distributed_tracing.sampler.partial_granularity.type", "get", None) + _process_dt_hidden_setting(section, "distributed_tracing.sampler.partial_granularity.root", "get") + _process_dt_sampler_setting( + section, "distributed_tracing.sampler.partial_granularity.root.adaptive.sampling_target", "getint" + ) + _process_dt_sampler_setting( + section, "distributed_tracing.sampler.partial_granularity.root.trace_id_ratio_based.ratio", "getratio" + ) + _process_dt_hidden_setting(section, "distributed_tracing.sampler.partial_granularity.remote_parent_sampled", "get") + _process_dt_sampler_setting( + section, + "distributed_tracing.sampler.partial_granularity.remote_parent_sampled.adaptive.sampling_target", + "getint", + ) + _process_dt_sampler_setting( + section, + "distributed_tracing.sampler.partial_granularity.remote_parent_sampled.trace_id_ratio_based.ratio", + "getratio", + ) + _process_dt_hidden_setting( + section, "distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled", "get" + ) + _process_dt_sampler_setting( + section, + "distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled.adaptive.sampling_target", + "getint", + ) + _process_dt_sampler_setting( + section, + "distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled.trace_id_ratio_based.ratio", + "getratio", + ) _process_setting(section, "span_events.enabled", "getboolean", None) _process_setting(section, "span_events.max_samples_stored", "getint", None) _process_setting(section, "span_events.attributes.enabled", "getboolean", None) @@ -518,6 +679,8 @@ def _process_configuration(section): _process_setting(section, "instrumentation.middleware.django.enabled", "getboolean", None) _process_setting(section, "instrumentation.middleware.django.exclude", "get", _map_inc_excl_middleware) _process_setting(section, "instrumentation.middleware.django.include", "get", _map_inc_excl_middleware) + _process_setting(section, "opentelemetry.enabled", "getboolean", None) + _process_setting(section, "opentelemetry.traces.enabled", "getboolean", None) # Loading of configuration from specified file and for specified @@ -1986,6 +2149,10 @@ def _process_function_profile_configuration(): _raise_configuration_error(section) +opentelemetry_instrumentation = [] +opentelemetry_entrypoints = [] + + def _process_module_definition(target, module, function="instrument"): enabled = True execute = None @@ -2006,6 +2173,9 @@ def _process_module_definition(target, module, function="instrument"): except Exception: _raise_configuration_error(section) + if target in opentelemetry_instrumentation: + enabled = False + try: if _config_object.has_option(section, "execute"): execute = _config_object.get(section, "execute") @@ -4224,6 +4394,33 @@ def _process_module_builtin_defaults(): "pyzeebe.worker.job_executor", "newrelic.hooks.external_pyzeebe", "instrument_pyzeebe_worker_job_executor" ) + # Hybrid Agent Hooks + _process_module_definition( + "opentelemetry.context", "newrelic.hooks.hybridagent_opentelemetry", "instrument_context_api" + ) + + _process_module_definition( + "opentelemetry.instrumentation.propagators", + "newrelic.hooks.hybridagent_opentelemetry", + "instrument_global_propagators_api", + ) + + _process_module_definition( + "opentelemetry.trace", "newrelic.hooks.hybridagent_opentelemetry", "instrument_trace_api" + ) + + _process_module_definition( + "opentelemetry.util.http", "newrelic.hooks.hybridagent_opentelemetry", "instrument_util_http" + ) + + _process_module_definition( + "opentelemetry.instrumentation.utils", "newrelic.hooks.hybridagent_opentelemetry", "instrument_utils" + ) + + _process_module_definition( + "opentelemetry.instrumentation.pika.utils", "newrelic.hooks.hybridagent_opentelemetry", "instrument_pika_utils" + ) + def _process_module_entry_points(): try: @@ -4273,6 +4470,84 @@ def _reset_instrumentation_done(): _instrumentation_done = False +def _is_installed(req): + version = get_package_version(req) + + if version: + return True + return False + + +def _process_opentelemetry_instrumentation_entry_points( + final_include_dict=HYBRID_AGENT_DEFAULT_INCLUDED_TRACERS_TO_NR_HOOKS, +): + if not _settings.opentelemetry.enabled or not _is_installed("opentelemetry-api"): + return + + try: + # importlib.metadata was introduced into the standard library starting in Python 3.8. + from importlib.metadata import entry_points + except ImportError: + try: + # importlib_metadata is a backport library installable from PyPI. + from importlib_metadata import entry_points + except ImportError: + try: + # Fallback to pkg_resources, which is available in older versions of setuptools. + from pkg_resources import iter_entry_points as entry_points + except ImportError: + return + + group = "opentelemetry_instrumentor" + + try: + # group kwarg was only added to importlib.metadata.entry_points in Python 3.10. + _entry_points = entry_points(group=group) + except TypeError: + # Grab entire entry_points dictionary and select group from it. + _entry_points = entry_points().get(group, ()) + + entry_points_generator = ( + entrypoint + for entrypoint in _entry_points + if entrypoint.name in final_include_dict + and entrypoint.name not in TEMPORARILY_DISABLED_OPENTELEMETRY_FRAMEWORKS + ) + + for entrypoint in entry_points_generator: + opentelemetry_entrypoints.append(entrypoint) + opentelemetry_instrumentation.extend(final_include_dict[entrypoint.name]) + + # Check for native installations + # NOTE: This logic will change once enabled and disabled + # functionality is implemented for opentelemetry.traces setting. + # NOTE: elasticsearch is instrumented both with libs and natively. + # To handle this case: If lib is installed, the library itself + # will check for native instrumentation and switch to that on its + # own, but if not, native instrumentation could still be used and + # we would not know. We handle this as we are with strawberry-graphql + # and ariadne where we check to see if opentelemetry-api and the + # specific library are installed on the system. + for lib in ["strawberry-graphql", "ariadne", "elasticsearch"]: + if _is_installed(lib): + opentelemetry_instrumentation.extend(final_include_dict[lib]) + + +def _process_opentelemetry_instrumentors(): + if not _settings.opentelemetry.enabled or not _is_installed("opentelemetry-api"): + return + + tracer_provider = newrelic.core.agent.opentelemetry_tracer_provider() + for entrypoint in opentelemetry_entrypoints: + try: + instrumentor_class = entrypoint.load() + instrumentor = instrumentor_class() + instrumentor.instrument(tracer_provider=tracer_provider) + _logger.debug("Successfully instrumented OpenTelemetry tracer '%s' via entry point.", entrypoint.name) + except Exception as exc: + _logger.warning("Failed to instrument OpenTelemetry tracer '%s' via entry point: %s", entrypoint.name, exc) + + def _setup_instrumentation(): global _instrumentation_done @@ -4283,6 +4558,10 @@ def _setup_instrumentation(): _process_module_configuration() _process_module_entry_points() + # Collection of NR disabled hooks must happen before _process_module_builtin_defaults() + # but the loading of the entrypoints must not happen until after the NR hooks are registered. + _process_opentelemetry_instrumentation_entry_points() + _process_trace_cache_import_hooks() _process_module_builtin_defaults() @@ -4304,6 +4583,8 @@ def _setup_instrumentation(): _process_function_profile_configuration() + _process_opentelemetry_instrumentors() + def _setup_extensions(): try: diff --git a/newrelic/core/agent.py b/newrelic/core/agent.py index 90690a573d..2693b4ee1f 100644 --- a/newrelic/core/agent.py +++ b/newrelic/core/agent.py @@ -120,6 +120,7 @@ class Agent: _instance_lock = threading.Lock() _instance = None + _tracer_provider = None _startup_callables = [] # noqa: RUF012 _registration_callables = {} # noqa: RUF012 @@ -188,6 +189,46 @@ def agent_singleton(): return Agent._instance + @staticmethod + def opentelemetry_tracer_provider(): + """Used by the tracer_provider() function to access/create the + single tracer provider object instance. + + """ + settings = newrelic.core.config.global_settings() + + if not settings.opentelemetry.enabled and not newrelic.core.config._environ_as_bool( + "NEW_RELIC_OPENTELEMETRY_ENABLED" + ): + _logger.debug("OpenTelemetry mode is disabled.") + return + + if Agent._tracer_provider: + return Agent._tracer_provider + + with Agent._instance_lock: + if not Agent._tracer_provider: + try: + from opentelemetry.trace import NoOpTracerProvider + + from newrelic.api.opentelemetry import TracerProvider + + if not settings.opentelemetry.traces.enabled and not newrelic.core.config._environ_as_bool( + "NEW_RELIC_OPENTELEMETRY_TRACES_ENABLED" + ): + # Set this to prevent any potential crashes + _logger.debug("OpenTelemetry traces are disabled.") + Agent._tracer_provider = NoOpTracerProvider() + else: + Agent._tracer_provider = TracerProvider() + except ImportError: + # `opentelemetry-api` is not installed, so tracer provider cannot be created + _logger.warning( + "OpenTelemetry mode has been enabled but `opentelemetry-api` is not installed, so no TracerProvider can be created. Defaulting to New Relic specific monitoring." + ) + + return Agent._tracer_provider + def __init__(self, config): """Initialises the agent and attempt to establish a connection to the core application. Will start the harvest loop running but @@ -581,9 +622,9 @@ def normalize_name(self, app_name, name, rule_type="url"): return application.normalize_name(name, rule_type) - def compute_sampled(self, app_name): + def compute_sampled(self, app_name, full_granularity, section, *args, **kwargs): application = self._applications.get(app_name, None) - return application.compute_sampled() + return application.compute_sampled(full_granularity, section, *args, **kwargs) def _harvest_shutdown_is_set(self): try: @@ -768,6 +809,10 @@ def agent_instance(): return Agent.agent_singleton() +def opentelemetry_tracer_provider(): + return agent_instance().opentelemetry_tracer_provider() + + def shutdown_agent(timeout=None): agent = agent_instance() agent.shutdown_agent(timeout) diff --git a/newrelic/core/agent_protocol.py b/newrelic/core/agent_protocol.py index 0657adc547..ad8c677fe0 100644 --- a/newrelic/core/agent_protocol.py +++ b/newrelic/core/agent_protocol.py @@ -297,6 +297,9 @@ def _connect_payload(app_name, linked_applications, environment, settings): connect_settings["browser_monitoring.loader"] = settings["browser_monitoring.loader"] connect_settings["browser_monitoring.debug"] = settings["browser_monitoring.debug"] connect_settings["ai_monitoring.enabled"] = settings["ai_monitoring.enabled"] + connect_settings["distributed_tracing.sampler.adaptive_sampling_target"] = settings[ + "distributed_tracing.sampler.adaptive_sampling_target" + ] security_settings = {} security_settings["capture_params"] = settings["capture_params"] diff --git a/newrelic/core/application.py b/newrelic/core/application.py index 3ba8168d60..81839715ec 100644 --- a/newrelic/core/application.py +++ b/newrelic/core/application.py @@ -23,7 +23,6 @@ from functools import partial from newrelic.common.object_names import callable_name -from newrelic.core.adaptive_sampler import AdaptiveSampler from newrelic.core.agent_control_health import ( HealthStatus, agent_control_health_instance, @@ -37,6 +36,7 @@ from newrelic.core.internal_metrics import InternalTrace, InternalTraceContext, internal_count_metric, internal_metric from newrelic.core.profile_sessions import profile_session_manager from newrelic.core.rules_engine import RulesEngine, SegmentCollapseEngine +from newrelic.core.samplers.sampler_proxy import SamplerProxy from newrelic.core.stats_engine import CustomMetrics, StatsEngine from newrelic.network.exceptions import ( DiscardDataForRequest, @@ -78,7 +78,7 @@ def __init__(self, app_name, linked_applications=None): self._transaction_count = 0 self._last_transaction = 0.0 - self.adaptive_sampler = None + self.sampler = None self._global_events_account = 0 @@ -156,11 +156,23 @@ def configuration(self): def active(self): return self.configuration is not None - def compute_sampled(self): - if self.adaptive_sampler is None: + def compute_sampled(self, full_granularity, section, *args, **kwargs): + if self.sampler is None: return False - return self.adaptive_sampler.compute_sampled() + return self.sampler.compute_sampled(full_granularity, section, *args, **kwargs) + + def _flattened_span_samples(self, spans, flattened_list=None): + if flattened_list is None: + flattened_list = [] + + if isinstance(spans[-1], dict): + flattened_list.append(spans) + elif isinstance(spans[-1], list): + for span in spans: + self._flattened_span_samples(span, flattened_list) + + return flattened_list def dump(self, file): """Dumps details about the application to the file object.""" @@ -501,12 +513,7 @@ def connect_to_data_collector(self, activate_agent): with self._stats_lock: self._stats_engine.reset_stats(configuration, reset_stream=True) - - if configuration.serverless_mode.enabled: - sampling_target_period = 60.0 - else: - sampling_target_period = configuration.sampling_target_period_in_seconds - self.adaptive_sampler = AdaptiveSampler(configuration.sampling_target, sampling_target_period) + self.sampler = SamplerProxy(configuration) active_session.connect_span_stream(self._stats_engine.span_stream, self.record_custom_metric) @@ -591,6 +598,33 @@ def connect_to_data_collector(self, activate_agent): f"Supportability/InfiniteTracing/gRPC/Compression/{'enabled' if infinite_tracing_compression else 'disabled'}", 1, ) + if configuration.distributed_tracing.enabled: + if configuration.distributed_tracing.sampler.full_granularity.enabled: + internal_metric( + f"Supportability/Python/FullGranularity/Root/{configuration.distributed_tracing.sampler._root}", + 1, + ) + internal_metric( + f"Supportability/Python/FullGranularity/RemoteParentSampled/{configuration.distributed_tracing.sampler._remote_parent_sampled}", + 1, + ) + internal_metric( + f"Supportability/Python/FullGranularity/RemoteParentNotSampled/{configuration.distributed_tracing.sampler._remote_parent_not_sampled}", + 1, + ) + if configuration.distributed_tracing.sampler.partial_granularity.enabled: + internal_metric( + f"Supportability/Python/PartialGranularity/Root/{configuration.distributed_tracing.sampler.partial_granularity._root}", + 1, + ) + internal_metric( + f"Supportability/Python/PartialGranularity/RemoteParentSampled/{configuration.distributed_tracing.sampler.partial_granularity._remote_parent_sampled}", + 1, + ) + internal_metric( + f"Supportability/Python/PartialGranularity/RemoteParentNotSampled/{configuration.distributed_tracing.sampler.partial_granularity._remote_parent_not_sampled}", + 1, + ) # Agent Control health check metric if self._agent_control.health_check_enabled: @@ -601,6 +635,10 @@ def connect_to_data_collector(self, activate_agent): if os.environ.get("FUNCTIONS_WORKER_RUNTIME", None): internal_metric("Supportability/Python/AzureFunctionMode/enabled", 1) + # OpenTelemetry Bridge toggle metric + opentelemetry_bridge = "enabled" if configuration.opentelemetry.enabled else "disabled" + internal_metric(f"Supportability/Tracing/Python/OpenTelemetryBridge/{opentelemetry_bridge}", 1) + self._stats_engine.merge_custom_metrics(internal_metrics.metrics()) # Update the active session in this object. This will the @@ -1361,9 +1399,9 @@ def harvest(self, shutdown=False, flexible=False): spans = stats.span_events if spans: if spans.num_samples > 0: - span_samples = list(spans) + span_samples = self._flattened_span_samples(list(spans)) - _logger.debug("Sending span event data for harvest of %r.", self._app_name) + _logger.debug("Sending Span event data for harvest of %r.", self._app_name) self._active_session.send_span_events(spans.sampling_info, span_samples) span_samples = None @@ -1373,7 +1411,6 @@ def harvest(self, shutdown=False, flexible=False): spans_sampled = spans.num_samples internal_count_metric("Supportability/SpanEvent/TotalEventsSeen", spans_seen) internal_count_metric("Supportability/SpanEvent/TotalEventsSent", spans_sampled) - stats.reset_span_events() # Send error events diff --git a/newrelic/core/attribute.py b/newrelic/core/attribute.py index ed3e5bffa6..c516a94e75 100644 --- a/newrelic/core/attribute.py +++ b/newrelic/core/attribute.py @@ -87,6 +87,13 @@ "message.routingKey", "messaging.destination.name", "messaging.system", + "nr.durations", + "nr.ids", + "nr.pg", + "otel.library.name", + "otel.library.version", + "otel.scope.name", + "otel.scope.version", "peer.address", "peer.hostname", "request.headers.accept", @@ -100,6 +107,7 @@ "response.headers.contentType", "response.status", "server.address", + "server.port", "subcomponent", "zeebe.client.bpmnProcessId", "zeebe.client.messageName", @@ -109,6 +117,25 @@ "zeebe.client.resourceFile", } +SPAN_ENTITY_RELATIONSHIP_ATTRIBUTES = { + "cloud.account.id", + "cloud.platform", + "cloud.region", + "cloud.resource_id", + "db.instance", + "db.system", + "http.url", + "messaging.destination.name", + "messaging.system", + "peer.hostname", + "server.address", + "server.port", + "span.kind", +} + +SPAN_ERROR_ATTRIBUTES = {"error.class", "error.message", "error.expected"} + + MAX_NUM_USER_ATTRIBUTES = 128 MAX_ATTRIBUTE_LENGTH = 255 MAX_NUM_ML_USER_ATTRIBUTES = 64 diff --git a/newrelic/core/config.py b/newrelic/core/config.py index 8cfdeda0ae..20181aefb3 100644 --- a/newrelic/core/config.py +++ b/newrelic/core/config.py @@ -334,6 +334,90 @@ class DistributedTracingSettings(Settings): class DistributedTracingSamplerSettings(Settings): + _root = "default" + _remote_parent_sampled = "default" + _remote_parent_not_sampled = "default" + + +class DistributedTracingSamplerFullGranularitySettings(Settings): + pass + + +class DistributedTracingSamplerRootSettings: + pass + + +class DistributedTracingSamplerRootAdaptiveSettings: + pass + + +class DistributedTracingSamplerRootTraceIdRatioBasedSettings: + pass + + +class DistributedTracingSamplerRemoteParentSampledSettings: + pass + + +class DistributedTracingSamplerRemoteParentSampledAdaptiveSettings: + pass + + +class DistributedTracingSamplerRemoteParentSampledTraceIdRatioBasedSettings: + pass + + +class DistributedTracingSamplerRemoteParentNotSampledSettings: + pass + + +class DistributedTracingSamplerRemoteParentNotSampledAdaptiveSettings: + pass + + +class DistributedTracingSamplerRemoteParentNotSampledTraceIdRatioBasedSettings: + pass + + +class DistributedTracingSamplerPartialGranularitySettings(Settings): + _root = "default" + _remote_parent_sampled = "default" + _remote_parent_not_sampled = "default" + + +class DistributedTracingSamplerPartialGranularityRootSettings: + pass + + +class DistributedTracingSamplerPartialGranularityRootAdaptiveSettings: + pass + + +class DistributedTracingSamplerPartialGranularityRootTraceIdRatioBasedSettings: + pass + + +class DistributedTracingSamplerPartialGranularityRemoteParentSampledSettings: + pass + + +class DistributedTracingSamplerPartialGranularityRemoteParentSampledAdaptiveSettings: + pass + + +class DistributedTracingSamplerPartialGranularityRemoteParentSampledTraceIdRatioBasedSettings: + pass + + +class DistributedTracingSamplerPartialGranularityRemoteParentNotSampledSettings: + pass + + +class DistributedTracingSamplerPartialGranularityRemoteParentNotSampledAdaptiveSettings: + pass + + +class DistributedTracingSamplerPartialGranularityRemoteParentNotSampledTraceIdRatioBasedSettings: pass @@ -474,6 +558,14 @@ class EventHarvestConfigHarvestLimitSettings(Settings): nested = True +class OpentelemetrySettings(Settings): + pass + + +class OpentelemetryTracesSettings(Settings): + pass + + _settings = TopLevelSettings() _settings.agent_limits = AgentLimitsSettings() _settings.application_logging = ApplicationLoggingSettings() @@ -507,6 +599,59 @@ class EventHarvestConfigHarvestLimitSettings(Settings): _settings.debug = DebugSettings() _settings.distributed_tracing = DistributedTracingSettings() _settings.distributed_tracing.sampler = DistributedTracingSamplerSettings() +_settings.distributed_tracing.sampler.full_granularity = DistributedTracingSamplerFullGranularitySettings() +_settings.distributed_tracing.sampler.root = DistributedTracingSamplerRootSettings() +_settings.distributed_tracing.sampler.root.adaptive = DistributedTracingSamplerRootAdaptiveSettings() +_settings.distributed_tracing.sampler.root.trace_id_ratio_based = ( + DistributedTracingSamplerRootTraceIdRatioBasedSettings() +) +_settings.distributed_tracing.sampler.remote_parent_sampled = DistributedTracingSamplerRemoteParentSampledSettings() +_settings.distributed_tracing.sampler.remote_parent_sampled.adaptive = ( + DistributedTracingSamplerRemoteParentSampledAdaptiveSettings() +) +_settings.distributed_tracing.sampler.remote_parent_sampled.trace_id_ratio_based = ( + DistributedTracingSamplerRemoteParentSampledTraceIdRatioBasedSettings() +) +_settings.distributed_tracing.sampler.remote_parent_not_sampled = ( + DistributedTracingSamplerRemoteParentNotSampledSettings() +) +_settings.distributed_tracing.sampler.remote_parent_not_sampled.adaptive = ( + DistributedTracingSamplerRemoteParentNotSampledAdaptiveSettings() +) +_settings.distributed_tracing.sampler.remote_parent_not_sampled.trace_id_ratio_based = ( + DistributedTracingSamplerRemoteParentNotSampledTraceIdRatioBasedSettings() +) +_settings.distributed_tracing.sampler.partial_granularity = DistributedTracingSamplerPartialGranularitySettings() +_settings.distributed_tracing.sampler.partial_granularity.root = ( + DistributedTracingSamplerPartialGranularityRootSettings() +) +_settings.distributed_tracing.sampler.partial_granularity.root.adaptive = ( + DistributedTracingSamplerPartialGranularityRootAdaptiveSettings() +) +_settings.distributed_tracing.sampler.partial_granularity.root.trace_id_ratio_based = ( + DistributedTracingSamplerPartialGranularityRootTraceIdRatioBasedSettings() +) +_settings.distributed_tracing.sampler.partial_granularity.remote_parent_sampled = ( + DistributedTracingSamplerPartialGranularityRemoteParentSampledSettings() +) +_settings.distributed_tracing.sampler.partial_granularity.remote_parent_sampled.adaptive = ( + DistributedTracingSamplerPartialGranularityRemoteParentSampledAdaptiveSettings() +) +_settings.distributed_tracing.sampler.partial_granularity.remote_parent_sampled.trace_id_ratio_based = ( + DistributedTracingSamplerPartialGranularityRemoteParentSampledTraceIdRatioBasedSettings() +) +_settings.distributed_tracing.sampler.partial_granularity.remote_parent_sampled.trace_id_ratio_based = ( + DistributedTracingSamplerPartialGranularityRemoteParentSampledAdaptiveSettings() +) +_settings.distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled = ( + DistributedTracingSamplerPartialGranularityRemoteParentNotSampledSettings() +) +_settings.distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled.adaptive = ( + DistributedTracingSamplerPartialGranularityRemoteParentNotSampledAdaptiveSettings() +) +_settings.distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled.trace_id_ratio_based = ( + DistributedTracingSamplerPartialGranularityRemoteParentNotSampledTraceIdRatioBasedSettings() +) _settings.error_collector = ErrorCollectorSettings() _settings.error_collector.attributes = ErrorCollectorAttributesSettings() _settings.event_harvest_config = EventHarvestConfigSettings() @@ -524,6 +669,8 @@ class EventHarvestConfigHarvestLimitSettings(Settings): _settings.instrumentation.middleware = InstrumentationMiddlewareSettings() _settings.instrumentation.middleware.django = InstrumentationDjangoMiddlewareSettings() _settings.message_tracer = MessageTracerSettings() +_settings.opentelemetry = OpentelemetrySettings() +_settings.opentelemetry.traces = OpentelemetryTracesSettings() _settings.process_host = ProcessHostSettings() _settings.rum = RumSettings() _settings.serverless_mode = ServerlessModeSettings() @@ -548,9 +695,19 @@ class EventHarvestConfigHarvestLimitSettings(Settings): _settings.audit_log_file = os.environ.get("NEW_RELIC_AUDIT_LOG", None) +def _environ_as_sampler(name, default): + val = os.environ.get(name, default) + # The trace_id_ratio_based value can only be set by setting the ratio + if val == "trace_id_ratio_based": + return default + return val + + def _environ_as_int(name, default=0): val = os.environ.get(name, default) try: + if default is None and val is None: + return None return int(val) except ValueError: return default @@ -560,11 +717,27 @@ def _environ_as_float(name, default=0.0): val = os.environ.get(name, default) try: + if default is None and val is None: + return None return float(val) except ValueError: return default +def _environ_as_ratio(name, default=0.0): + val = os.environ.get(name, default) + + try: + if default is None and val is None: + return None + f_val = float(val) + if 0 < f_val <= 1: + return f_val + except ValueError: + return default + return default + + def _environ_as_bool(name, default=False): flag = os.environ.get(name, default) if default is None or default: @@ -842,11 +1015,164 @@ def default_otlp_host(host): _settings.ml_insights_events.enabled = False _settings.distributed_tracing.enabled = _environ_as_bool("NEW_RELIC_DISTRIBUTED_TRACING_ENABLED", default=True) -_settings.distributed_tracing.sampler.remote_parent_sampled = os.environ.get( - "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_SAMPLED", "default" +_settings.distributed_tracing.sampler.adaptive_sampling_target = _environ_as_int( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_ADAPTIVE_SAMPLING_TARGET", default=10 +) +_settings.distributed_tracing.sampler.full_granularity.enabled = _environ_as_bool( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_FULL_GRANULARITY_ENABLED", default=True +) +_settings.distributed_tracing.sampler._root = ( + ( + "trace_id_ratio_based" + if _environ_as_ratio("NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_ROOT_TRACE_ID_RATIO_BASED_RATIO", None) + else None + ) + or ( + "adaptive" + if os.environ.get("NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_ROOT_ADAPTIVE_SAMPLING_TARGET", None) + else None + ) + or _environ_as_sampler("NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_ROOT", "default") +) +_settings.distributed_tracing.sampler.root.adaptive.sampling_target = _environ_as_int( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_ROOT_ADAPTIVE_SAMPLING_TARGET", None +) +_settings.distributed_tracing.sampler.root.trace_id_ratio_based.ratio = _environ_as_ratio( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_ROOT_TRACE_ID_RATIO_BASED_RATIO", None +) +_settings.distributed_tracing.sampler._remote_parent_sampled = ( + ( + "trace_id_ratio_based" + if _environ_as_ratio( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_SAMPLED_TRACE_ID_RATIO_BASED_RATIO", None + ) + else None + ) + or ( + "adaptive" + if os.environ.get("NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_SAMPLED_ADAPTIVE_SAMPLING_TARGET", None) + else None + ) + or _environ_as_sampler("NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_SAMPLED", "default") +) +_settings.distributed_tracing.sampler.remote_parent_sampled.adaptive.sampling_target = _environ_as_int( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_SAMPLED_ADAPTIVE_SAMPLING_TARGET", None +) +_settings.distributed_tracing.sampler.remote_parent_sampled.trace_id_ratio_based.ratio = _environ_as_ratio( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_SAMPLED_TRACE_ID_RATIO_BASED_RATIO", None ) -_settings.distributed_tracing.sampler.remote_parent_not_sampled = os.environ.get( - "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_NOT_SAMPLED", "default" +_settings.distributed_tracing.sampler._remote_parent_not_sampled = ( + ( + "trace_id_ratio_based" + if _environ_as_ratio( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_NOT_SAMPLED_TRACE_ID_RATIO_BASED_RATIO", None + ) + else None + ) + or ( + "adaptive" + if os.environ.get( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_NOT_SAMPLED_ADAPTIVE_SAMPLING_TARGET", None + ) + else None + ) + or _environ_as_sampler("NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_NOT_SAMPLED", "default") +) +_settings.distributed_tracing.sampler.remote_parent_not_sampled.adaptive.sampling_target = _environ_as_int( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_NOT_SAMPLED_ADAPTIVE_SAMPLING_TARGET", None +) +_settings.distributed_tracing.sampler.remote_parent_not_sampled.trace_id_ratio_based.ratio = _environ_as_ratio( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_NOT_SAMPLED_TRACE_ID_RATIO_BASED_RATIO", None +) +_settings.distributed_tracing.sampler.partial_granularity.enabled = _environ_as_bool( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_ENABLED", default=False +) +_settings.distributed_tracing.sampler.partial_granularity.type = os.environ.get( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_TYPE", "essential" +) +_settings.distributed_tracing.sampler.partial_granularity._root = ( + ( + "trace_id_ratio_based" + if _environ_as_ratio( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_ROOT_TRACE_ID_RATIO_BASED_RATIO", None + ) + else None + ) + or ( + "adaptive" + if os.environ.get( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_ROOT_ADAPTIVE_SAMPLING_TARGET", None + ) + else None + ) + or _environ_as_sampler("NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_ROOT", "default") +) +_settings.distributed_tracing.sampler.partial_granularity.root.adaptive.sampling_target = _environ_as_int( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_ROOT_ADAPTIVE_SAMPLING_TARGET", None +) +_settings.distributed_tracing.sampler.partial_granularity.root.trace_id_ratio_based.ratio = _environ_as_ratio( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_ROOT_TRACE_ID_RATIO_BASED_RATIO", None +) +_settings.distributed_tracing.sampler.partial_granularity._remote_parent_sampled = ( + ( + "trace_id_ratio_based" + if _environ_as_ratio( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_SAMPLED_TRACE_ID_RATIO_BASED_RATIO", + None, + ) + else None + ) + or ( + "adaptive" + if os.environ.get( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_SAMPLED_ADAPTIVE_SAMPLING_TARGET", + None, + ) + else None + ) + or _environ_as_sampler("NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_SAMPLED", "default") +) +_settings.distributed_tracing.sampler.partial_granularity.remote_parent_sampled.adaptive.sampling_target = ( + _environ_as_int( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_SAMPLED_ADAPTIVE_SAMPLING_TARGET", None + ) +) +_settings.distributed_tracing.sampler.partial_granularity.remote_parent_sampled.trace_id_ratio_based.ratio = ( + _environ_as_ratio( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_SAMPLED_TRACE_ID_RATIO_BASED_RATIO", + None, + ) +) +_settings.distributed_tracing.sampler.partial_granularity._remote_parent_not_sampled = ( + ( + "trace_id_ratio_based" + if _environ_as_ratio( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_NOT_SAMPLED_TRACE_ID_RATIO_BASED_RATIO", + None, + ) + else None + ) + or ( + "adaptive" + if os.environ.get( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_NOT_SAMPLED_ADAPTIVE_SAMPLING_TARGET", + None, + ) + else None + ) + or _environ_as_sampler( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_NOT_SAMPLED", "default" + ) +) +_settings.distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled.adaptive.sampling_target = ( + _environ_as_int( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_NOT_SAMPLED_ADAPTIVE_SAMPLING_TARGET", + None, + ) +) +_settings.distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled.trace_id_ratio_based.ratio = _environ_as_ratio( + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_NOT_SAMPLED_TRACE_ID_RATIO_BASED_RATIO", + None, ) _settings.distributed_tracing.exclude_newrelic_header = False _settings.span_events.enabled = _environ_as_bool("NEW_RELIC_SPAN_EVENTS_ENABLED", default=True) @@ -1088,6 +1414,8 @@ def default_otlp_host(host): _settings.azure_operator.enabled = _environ_as_bool("NEW_RELIC_AZURE_OPERATOR_ENABLED", default=False) _settings.package_reporting.enabled = _environ_as_bool("NEW_RELIC_PACKAGE_REPORTING_ENABLED", default=True) _settings.ml_insights_events.enabled = _environ_as_bool("NEW_RELIC_ML_INSIGHTS_EVENTS_ENABLED", default=False) +_settings.opentelemetry.enabled = _environ_as_bool("NEW_RELIC_OPENTELEMETRY_ENABLED", default=False) +_settings.opentelemetry.traces.enabled = _environ_as_bool("NEW_RELIC_OPENTELEMETRY_TRACES_ENABLED", default=True) def global_settings(): @@ -1363,6 +1691,16 @@ def apply_server_side_settings(server_side_config=None, settings=_settings): min(settings_snapshot.custom_insights_events.max_attribute_value, 4095), ) + # Partial granularity tracing is not available in infinite tracing mode. + if ( + settings_snapshot.infinite_tracing.enabled + and settings_snapshot.distributed_tracing.sampler.partial_granularity.enabled + ): + _logger.warning( + "Improper configuration. Infinite tracing cannot be enabled at the same time as partial granularity tracing. Setting distributed_tracing.sampler.partial_granularity.enabled=False." + ) + apply_config_setting(settings_snapshot, "distributed_tracing.sampler.partial_granularity.enabled", False) + # This will be removed at some future point # Special case for account_id which will be sent instead of # cross_process_id in the future diff --git a/newrelic/core/data_collector.py b/newrelic/core/data_collector.py index e481f1d6e7..244fa4f9f8 100644 --- a/newrelic/core/data_collector.py +++ b/newrelic/core/data_collector.py @@ -117,7 +117,6 @@ def send_ml_events(self, sampling_info, custom_event_data): def send_span_events(self, sampling_info, span_event_data): """Called to submit sample set for span events.""" - payload = (self.agent_run_id, sampling_info, span_event_data) return self._protocol.send("span_event_data", payload) diff --git a/newrelic/core/database_node.py b/newrelic/core/database_node.py index 7c4032c5b9..7629e894d4 100644 --- a/newrelic/core/database_node.py +++ b/newrelic/core/database_node.py @@ -40,6 +40,8 @@ "port_path_or_id", "database_name", "params", + "span_link_events", + "span_event_events", ], ) @@ -81,6 +83,8 @@ def identifier(self): "guid", "agent_attributes", "user_attributes", + "span_link_events", + "span_event_events", ], ) @@ -224,6 +228,8 @@ def slow_sql_node(self, stats, root): port_path_or_id=self.port_path_or_id, database_name=self.database_name, params=params, + span_link_events=self.span_link_events, + span_event_events=self.span_event_events, ) def trace_node(self, stats, root, connections): @@ -279,7 +285,7 @@ def trace_node(self, stats, root, connections): start_time=start_time, end_time=end_time, name=name, params=params, children=children, label=None ) - def span_event(self, *args, **kwargs): + def span_event(self, settings, base_attrs=None, parent_guid=None, attr_class=dict): sql = self.formatted if sql: @@ -288,4 +294,6 @@ def span_event(self, *args, **kwargs): self.agent_attributes["db.statement"] = sql - return super().span_event(*args, **kwargs) + return DatastoreNodeMixin.span_event( + self, settings, base_attrs=base_attrs, parent_guid=parent_guid, attr_class=attr_class + ) diff --git a/newrelic/core/database_utils.py b/newrelic/core/database_utils.py index c37b419a39..ec593c86b3 100644 --- a/newrelic/core/database_utils.py +++ b/newrelic/core/database_utils.py @@ -419,6 +419,12 @@ def _parse_operation(sql): return operation if operation in _operation_table else "" +def _parse_operation_opentelemetry(sql): + match = _parse_operation_re.search(sql) + operation = match and match.group(1).lower() + return operation or "" + + def _parse_target(sql, operation): sql = sql.rstrip(";") parse = _operation_table.get(operation, None) @@ -898,5 +904,23 @@ def sql_statement(sql, dbapi2_module): result = SQLStatement(sql, database) _sql_statements[key] = result - return result + + +def generate_dynamodb_arn(host, region=None, account_id=None, target=None): + # There are 3 different partition options. + # See https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html for details. + partition = "aws" + if "amazonaws.cn" in host: + partition = "aws-cn" + elif "amazonaws-us-gov.com" in host: + partition = "aws-us-gov" + + if partition and region and account_id and target: + return f"arn:{partition}:dynamodb:{region}:{account_id:012d}:table/{target}" + + +def get_database_operation_target_from_statement(db_statement): + operation = _parse_operation_opentelemetry(db_statement) + target = _parse_target(db_statement, operation) + return operation, target diff --git a/newrelic/core/datastore_node.py b/newrelic/core/datastore_node.py index 68c5254f4d..488ff27cd3 100644 --- a/newrelic/core/datastore_node.py +++ b/newrelic/core/datastore_node.py @@ -36,6 +36,8 @@ "guid", "agent_attributes", "user_attributes", + "span_link_events", + "span_event_events", ], ) diff --git a/newrelic/core/external_node.py b/newrelic/core/external_node.py index 9165d2081f..d066c40f2e 100644 --- a/newrelic/core/external_node.py +++ b/newrelic/core/external_node.py @@ -35,6 +35,8 @@ "guid", "agent_attributes", "user_attributes", + "span_link_events", + "span_event_events", ], ) @@ -169,11 +171,10 @@ def trace_node(self, stats, root, connections): start_time=start_time, end_time=end_time, name=name, params=params, children=children, label=None ) - def span_event(self, *args, **kwargs): + def span_event(self, settings, base_attrs=None, parent_guid=None, attr_class=dict): self.agent_attributes["http.url"] = self.http_url - attrs = super().span_event(*args, **kwargs) - i_attrs = attrs[0] + i_attrs = (base_attrs and base_attrs.copy()) or attr_class() i_attrs["category"] = "http" i_attrs["span.kind"] = "client" _, i_attrs["component"] = attribute.process_user_attribute("component", self.library) @@ -181,4 +182,4 @@ def span_event(self, *args, **kwargs): if self.method: _, i_attrs["http.method"] = attribute.process_user_attribute("http.method", self.method) - return attrs + return i_attrs, attr_class, self.span_link_events, self.span_event_events diff --git a/newrelic/core/function_node.py b/newrelic/core/function_node.py index 809f26742c..5d2726ea84 100644 --- a/newrelic/core/function_node.py +++ b/newrelic/core/function_node.py @@ -34,6 +34,8 @@ "guid", "agent_attributes", "user_attributes", + "span_link_events", + "span_event_events", ], ) @@ -114,10 +116,8 @@ def trace_node(self, stats, root, connections): start_time=start_time, end_time=end_time, name=name, params=params, children=children, label=self.label ) - def span_event(self, *args, **kwargs): - attrs = super().span_event(*args, **kwargs) - i_attrs = attrs[0] - + def span_event(self, settings, base_attrs=None, parent_guid=None, attr_class=dict): + i_attrs = (base_attrs and base_attrs.copy()) or attr_class() i_attrs["name"] = f"{self.group}/{self.name}" - return attrs + return i_attrs, attr_class, self.span_link_events, self.span_event_events diff --git a/newrelic/core/loop_node.py b/newrelic/core/loop_node.py index b9328e7013..3488c47ec2 100644 --- a/newrelic/core/loop_node.py +++ b/newrelic/core/loop_node.py @@ -79,10 +79,8 @@ def trace_node(self, stats, root, connections): start_time=start_time, end_time=end_time, name=name, params=params, children=children, label=None ) - def span_event(self, *args, **kwargs): - attrs = super().span_event(*args, **kwargs) - i_attrs = attrs[0] - + def span_event(self, settings, base_attrs=None, parent_guid=None, attr_class=dict): + i_attrs = (base_attrs and base_attrs.copy()) or attr_class() i_attrs["name"] = f"EventLoop/Wait/{self.name}" - return attrs + return i_attrs, attr_class, None, None diff --git a/newrelic/core/memcache_node.py b/newrelic/core/memcache_node.py index 85641fcff4..b82147fb57 100644 --- a/newrelic/core/memcache_node.py +++ b/newrelic/core/memcache_node.py @@ -30,6 +30,8 @@ "guid", "agent_attributes", "user_attributes", + "span_link_events", + "span_event_events", ], ) @@ -74,3 +76,6 @@ def trace_node(self, stats, root, connections): return newrelic.core.trace_node.TraceNode( start_time=start_time, end_time=end_time, name=name, params=params, children=children, label=None ) + + def span_event(self, settings, base_attrs=None, parent_guid=None, attr_class=dict): + return base_attrs, attr_class, self.span_link_events, self.span_event_events diff --git a/newrelic/core/message_node.py b/newrelic/core/message_node.py index 202e4dca75..ae7f5e107b 100644 --- a/newrelic/core/message_node.py +++ b/newrelic/core/message_node.py @@ -34,6 +34,8 @@ "guid", "agent_attributes", "user_attributes", + "span_link_events", + "span_event_events", ], ) @@ -80,3 +82,6 @@ def trace_node(self, stats, root, connections): return newrelic.core.trace_node.TraceNode( start_time=start_time, end_time=end_time, name=name, params=params, children=children, label=None ) + + def span_event(self, settings, base_attrs=None, parent_guid=None, attr_class=dict): + return base_attrs, attr_class, self.span_link_events, self.span_event_events diff --git a/newrelic/core/node_mixin.py b/newrelic/core/node_mixin.py index 8eedd191d4..f6490ffe1b 100644 --- a/newrelic/core/node_mixin.py +++ b/newrelic/core/node_mixin.py @@ -49,14 +49,17 @@ def get_trace_segment_params(self, settings, params=None): _params["exclusive_duration_millis"] = 1000.0 * self.exclusive return _params - def span_event(self, settings, base_attrs=None, parent_guid=None, attr_class=dict): + def _span_event_full_granularity(self, settings, base_attrs=None, parent_guid=None, attr_class=dict): + base_attrs, attr_class, span_link_events, span_event_events = self.span_event( + settings, base_attrs=base_attrs, parent_guid=parent_guid, attr_class=attr_class + ) i_attrs = (base_attrs and base_attrs.copy()) or attr_class() i_attrs["type"] = "Span" - i_attrs["name"] = self.name + i_attrs["name"] = i_attrs.get("name") or self.name i_attrs["guid"] = self.guid i_attrs["timestamp"] = int(self.start_time * 1000) i_attrs["duration"] = self.duration - i_attrs["category"] = "generic" + i_attrs["category"] = i_attrs.get("category") or "generic" if parent_guid: i_attrs["parentId"] = parent_guid @@ -68,18 +71,286 @@ def span_event(self, settings, base_attrs=None, parent_guid=None, attr_class=dic u_attrs = attribute.resolve_user_attributes( self.processed_user_attributes, settings.attribute_filter, DST_SPAN_EVENTS, attr_class=attr_class ) - # intrinsics, user attrs, agent attrs - return [i_attrs, u_attrs, a_attrs] + base_span_event = [i_attrs, u_attrs, a_attrs] + if span_link_events or span_event_events: + return [base_span_event, span_link_events, span_event_events] + return base_span_event + + def _span_event_partial_granularity_reduced( + self, settings, base_attrs=None, parent_guid=None, attr_class=dict, ct_exit_spans=None + ): + base_attrs, attr_class, span_link_events, span_event_events = self.span_event( + settings, base_attrs=base_attrs, parent_guid=parent_guid, attr_class=attr_class + ) + if ct_exit_spans is None: + ct_exit_spans = {"instrumented": 0, "kept": 0, "dropped_ids": 0} - def span_events(self, settings, base_attrs=None, parent_guid=None, attr_class=dict): - yield self.span_event(settings, base_attrs=base_attrs, parent_guid=parent_guid, attr_class=attr_class) + ct_exit_spans["instrumented"] += 1 + + i_attrs = (base_attrs and base_attrs.copy()) or attr_class() + i_attrs["type"] = "Span" + i_attrs["name"] = i_attrs.get("name") or self.name + i_attrs["guid"] = self.guid + i_attrs["timestamp"] = int(self.start_time * 1000) + i_attrs["duration"] = self.duration + i_attrs["category"] = i_attrs.get("category") or "generic" + + if parent_guid: + i_attrs["parentId"] = parent_guid + + a_attrs = attribute.resolve_agent_attributes( + self.agent_attributes, settings.attribute_filter, DST_SPAN_EVENTS, attr_class=attr_class + ) + u_attrs = attribute.resolve_user_attributes( + self.processed_user_attributes, settings.attribute_filter, DST_SPAN_EVENTS, attr_class=attr_class + ) + + # If this is an entry span, add `nr.pg` to indicate transaction is partial + # granularity sampled. + if i_attrs.get("nr.entryPoint"): + i_attrs["nr.pg"] = True + # If this is the entry node or an LLM span always return it. + if i_attrs.get("nr.entryPoint") or i_attrs["name"].startswith("Llm/"): + ct_exit_spans["kept"] += 1 + base_span_event = [i_attrs, u_attrs, a_attrs] + if span_link_events or span_event_events: + return [base_span_event, span_link_events, span_event_events] + return base_span_event + exit_span_attrs_present = attribute.SPAN_ENTITY_RELATIONSHIP_ATTRIBUTES & set(a_attrs) + # If the span is not an exit span, skip it by returning None. + if not exit_span_attrs_present: + return None + # If the span is an exit span and we are in reduced mode (meaning no attribute dropping), + # just return the exit span as is. + ct_exit_spans["kept"] += 1 + base_span_event = [i_attrs, u_attrs, a_attrs] + if span_link_events or span_event_events: + return [base_span_event, span_link_events, span_event_events] + return base_span_event + + def _span_event_partial_granularity_essential( + self, settings, base_attrs=None, parent_guid=None, attr_class=dict, ct_exit_spans=None + ): + base_attrs, attr_class, span_link_events, span_event_events = self.span_event( + settings, base_attrs=base_attrs, parent_guid=parent_guid, attr_class=attr_class + ) + if ct_exit_spans is None: + ct_exit_spans = {"instrumented": 0, "kept": 0, "dropped_ids": 0} + + ct_exit_spans["instrumented"] += 1 + + i_attrs = (base_attrs and base_attrs.copy()) or attr_class() + i_attrs["type"] = "Span" + i_attrs["name"] = i_attrs.get("name") or self.name + i_attrs["guid"] = self.guid + i_attrs["timestamp"] = int(self.start_time * 1000) + i_attrs["duration"] = self.duration + i_attrs["category"] = i_attrs.get("category") or "generic" + + if parent_guid: + i_attrs["parentId"] = parent_guid + + a_attrs = self.agent_attributes + + a_attrs_set = set(a_attrs) + exit_span_attrs_present = attribute.SPAN_ENTITY_RELATIONSHIP_ATTRIBUTES & a_attrs_set + exit_span_error_attrs_present = attribute.SPAN_ERROR_ATTRIBUTES & a_attrs_set + # If this is an entry span, add `nr.pg` to indicate transaction is partial + # granularity sampled. + if i_attrs.get("nr.entryPoint"): + i_attrs["nr.pg"] = True + # If this is the entry node or an LLM span always return it. + if i_attrs.get("nr.entryPoint") or i_attrs["name"].startswith("Llm/"): + ct_exit_spans["kept"] += 1 + # Only keep entity-synthesis and error agent attributes, and intrinsics. + a_minimized_attrs = attribute.resolve_agent_attributes( + {key: a_attrs[key] for key in exit_span_attrs_present | exit_span_error_attrs_present}, + settings.attribute_filter, + DST_SPAN_EVENTS, + attr_class=attr_class, + ) + base_span_event = [i_attrs, {}, a_minimized_attrs] + if span_link_events or span_event_events: + return [base_span_event, span_link_events, span_event_events] + return base_span_event + # If the span is not an exit span, skip it by returning None. + if not exit_span_attrs_present: + return None + ct_exit_spans["kept"] += 1 + # Only keep entity-synthesis, and error agent attributes, and intrinsics. + a_minimized_attrs = attribute.resolve_agent_attributes( + {key: a_attrs[key] for key in exit_span_attrs_present | exit_span_error_attrs_present}, + settings.attribute_filter, + DST_SPAN_EVENTS, + attr_class=attr_class, + ) + base_span_event = [i_attrs, {}, a_minimized_attrs] + if span_link_events or span_event_events: + return [base_span_event, span_link_events, span_event_events] + return base_span_event + + def _span_event_partial_granularity_compact( + self, settings, base_attrs=None, parent_guid=None, attr_class=dict, ct_exit_spans=None + ): + base_attrs, attr_class, span_link_events, span_event_events = self.span_event( + settings, base_attrs=base_attrs, parent_guid=parent_guid, attr_class=attr_class + ) + if ct_exit_spans is None: + ct_exit_spans = {"instrumented": 0, "kept": 0, "dropped_ids": 0} + + ct_exit_spans["instrumented"] += 1 + + i_attrs = (base_attrs and base_attrs.copy()) or attr_class() + i_attrs["type"] = "Span" + i_attrs["name"] = i_attrs.get("name") or self.name + i_attrs["guid"] = self.guid + i_attrs["timestamp"] = int(self.start_time * 1000) + i_attrs["duration"] = self.duration + i_attrs["category"] = i_attrs.get("category") or "generic" + + if parent_guid: + i_attrs["parentId"] = parent_guid + + a_attrs = self.agent_attributes + + a_attrs_set = set(a_attrs) + exit_span_attrs_present = attribute.SPAN_ENTITY_RELATIONSHIP_ATTRIBUTES & a_attrs_set + exit_span_error_attrs_present = attribute.SPAN_ERROR_ATTRIBUTES & a_attrs_set + # If this is an entry span, add `nr.pg` to indicate transaction is partial + # granularity sampled. + if i_attrs.get("nr.entryPoint"): + i_attrs["nr.pg"] = True + # If this is the entry node or an LLM span always return it. + if i_attrs.get("nr.entryPoint") or i_attrs["name"].startswith("Llm/"): + ct_exit_spans["kept"] += 1 + # Only keep entity-synthesis and error agent attributes, and intrinsics. + a_minimized_attrs = attribute.resolve_agent_attributes( + {key: a_attrs[key] for key in exit_span_attrs_present | exit_span_error_attrs_present}, + settings.attribute_filter, + DST_SPAN_EVENTS, + attr_class=attr_class, + ) + base_span_event = [i_attrs, {}, a_minimized_attrs] + if span_link_events or span_event_events: + return [base_span_event, span_link_events, span_event_events] + return base_span_event + # If the span is not an exit span, skip it by returning None. + if not exit_span_attrs_present: + return None + a_minimized_attrs = attribute.resolve_agent_attributes( + {key: a_attrs[key] for key in exit_span_attrs_present | exit_span_error_attrs_present}, + settings.attribute_filter, + DST_SPAN_EVENTS, + attr_class=attr_class, + ) + + # If the span is an exit span but span compression (compact) is enabled, + # we need to check for uniqueness before returning it. + # Combine all the entity relationship attr values into a frozenset of tuples to be + # used as the hash to check for uniqueness. + span_attrs_hash = hash( + frozenset((key, a_minimized_attrs[key]) for key in exit_span_attrs_present if key in a_minimized_attrs) + ) + # If this is a new exit span, add it to the known ct_exit_spans and + # return it. + if span_attrs_hash not in ct_exit_spans: + # nr.ids is the list of span guids that share this unqiue exit span. + i_attrs["nr.ids"] = [] + i_attrs["nr.durations"] = self.duration + ct_exit_spans[span_attrs_hash] = [i_attrs, a_minimized_attrs] + ct_exit_spans["kept"] += 1 + # Only keep entity-synthesis, and error agent attributes, and intrinsics. + base_span_event = [i_attrs, {}, a_minimized_attrs] + if span_link_events or span_event_events: + return [base_span_event, span_link_events, span_event_events] + return base_span_event + # If this is an exit span we've already seen, add the error attributes + # (last occurring error takes precedence), add it's guid to the list + # of ids on the seen span, compute the new duration & start time, and + # return None. + exit_span = ct_exit_spans[span_attrs_hash] + exit_span[1].update( + attr_class( + {key: a_minimized_attrs[key] for key in exit_span_error_attrs_present if key in a_minimized_attrs} + ) + ) + # Max size for `nr.ids` = 1024. Max length = 63 (each span id is 16 bytes + 8 bytes for list type). + if len(exit_span[0]["nr.ids"]) < 63: + exit_span[0]["nr.ids"].append(self.guid) + else: + ct_exit_spans["dropped_ids"] += 1 + + # Compute the new start and end time for all compressed spans and use + # that to set the duration for all compressed spans. + current_start_time = exit_span[0]["timestamp"] + current_end_time = exit_span[0]["timestamp"] / 1000 + exit_span[0]["nr.durations"] + new_start_time = i_attrs["timestamp"] + new_end_time = i_attrs["timestamp"] / 1000 + i_attrs["duration"] + set_start_time = min(new_start_time, current_start_time) + # If the new span starts after the old span's end time or the new span + # ends before the current span starts; add the durations. + if current_end_time < new_start_time / 1000 or new_end_time < current_start_time / 1000: + set_duration = exit_span[0]["nr.durations"] + i_attrs["duration"] + # Otherwise, if the new and old span's overlap in time, use the newest + # end time and subtract the start time from it to calculate the new + # duration. + else: + set_duration = max(current_end_time, new_end_time) - set_start_time / 1000 + exit_span[0]["timestamp"] = set_start_time + exit_span[0]["nr.durations"] = set_duration + + PARTIAL_GRANULARITY_SPAN_EVENT_METHODS = { # noqa: RUF012 + "reduced": _span_event_partial_granularity_reduced, + "essential": _span_event_partial_granularity_essential, + "compact": _span_event_partial_granularity_compact, + } + + def span_event(self, settings, base_attrs=None, parent_guid=None, attr_class=dict): + return base_attrs, attr_class, None, None + + def span_events_full_granularity(self, settings, base_attrs=None, parent_guid=None, attr_class=dict): + yield self._span_event_full_granularity( + settings, base_attrs=base_attrs, parent_guid=parent_guid, attr_class=attr_class + ) for child in self.children: - for event in child.span_events( # noqa: UP028 + yield from child.span_events_full_granularity( settings, base_attrs=base_attrs, parent_guid=self.guid, attr_class=attr_class + ) + + def span_events_partial_granularity( + self, settings, span_event_method, base_attrs=None, parent_guid=None, attr_class=dict, ct_exit_spans=None + ): + span = span_event_method( + self=self, + settings=settings, + base_attrs=base_attrs, + parent_guid=parent_guid, + attr_class=attr_class, + ct_exit_spans=ct_exit_spans, + ) + parent_id = parent_guid + # In partial granularity tracing, span will be None if the span is an inprocess span or repeated exit span. + if span: + yield span + # Compressed spans are always reparented onto the entry span. + if settings.distributed_tracing.sampler.partial_granularity.type != "compact" or span[0].get( + "nr.entryPoint" ): - yield event + parent_id = self.guid + for child in self.children: + for event in child.span_events_partial_granularity( + settings, + span_event_method, + base_attrs=base_attrs, + parent_guid=parent_id, + attr_class=attr_class, + ct_exit_spans=ct_exit_spans, + ): + # In partial granularity tracing, event will be None if the span is an inprocess span or repeated exit span. + if event: + yield event class DatastoreNodeMixin(GenericNodeMixin): @@ -108,11 +379,10 @@ def db_instance(self): self._db_instance = db_instance_attr return db_instance_attr - def span_event(self, *args, **kwargs): - self.agent_attributes["db.instance"] = self.db_instance - attrs = super().span_event(*args, **kwargs) - i_attrs = attrs[0] - a_attrs = attrs[2] + def span_event(self, settings, base_attrs=None, parent_guid=None, attr_class=dict): + a_attrs = self.agent_attributes + a_attrs["db.instance"] = self.db_instance + i_attrs = (base_attrs and base_attrs.copy()) or attr_class() i_attrs["category"] = "datastore" i_attrs["span.kind"] = "client" @@ -141,4 +411,4 @@ def span_event(self, *args, **kwargs): except Exception: pass - return attrs + return i_attrs, attr_class, self.span_link_events, self.span_event_events diff --git a/newrelic/core/otlp_utils.py b/newrelic/core/otlp_utils.py index e34ba3e6c2..e9753eb247 100644 --- a/newrelic/core/otlp_utils.py +++ b/newrelic/core/otlp_utils.py @@ -116,8 +116,9 @@ def create_key_values_from_iterable(iterable): return list(filter(lambda i: i is not None, (create_key_value(key, value) for key, value in iterable))) -def create_resource(attributes=None, attach_apm_entity=True): - attributes = attributes or {"instrumentation.provider": "newrelic-opentelemetry-python-ml"} +def create_resource(attributes=None, attach_apm_entity=True, hybrid_bridge=False): + instrumentation_provider = "newrelic-opentelemetry-bridge" if hybrid_bridge else "newrelic-opentelemetry-python-ml" + attributes = attributes or {"instrumentation.provider": instrumentation_provider} if attach_apm_entity: metadata = get_service_linking_metadata() attributes.update(metadata) diff --git a/newrelic/core/root_node.py b/newrelic/core/root_node.py index 1591afa3ad..fabe2c35e8 100644 --- a/newrelic/core/root_node.py +++ b/newrelic/core/root_node.py @@ -32,21 +32,23 @@ "path", "trusted_parent_span", "tracing_vendors", + "span_link_events", + "span_event_events", ], ) class RootNode(_RootNode, GenericNodeMixin): - def span_event(self, *args, **kwargs): - span = super().span_event(*args, **kwargs) - i_attrs = span[0] + def span_event(self, settings, base_attrs=None, parent_guid=None, attr_class=dict): + i_attrs = (base_attrs and base_attrs.copy()) or attr_class() i_attrs["transaction.name"] = self.path i_attrs["nr.entryPoint"] = True if self.trusted_parent_span: i_attrs["trustedParentId"] = self.trusted_parent_span if self.tracing_vendors: i_attrs["tracingVendors"] = self.tracing_vendors - return span + + return i_attrs, attr_class, self.span_link_events, self.span_event_events def trace_node(self, stats, root, connections): name = self.path diff --git a/newrelic/core/samplers/__init__.py b/newrelic/core/samplers/__init__.py new file mode 100644 index 0000000000..bfe7af1430 --- /dev/null +++ b/newrelic/core/samplers/__init__.py @@ -0,0 +1,14 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + diff --git a/newrelic/core/adaptive_sampler.py b/newrelic/core/samplers/adaptive_sampler.py similarity index 100% rename from newrelic/core/adaptive_sampler.py rename to newrelic/core/samplers/adaptive_sampler.py diff --git a/newrelic/core/samplers/sampler_proxy.py b/newrelic/core/samplers/sampler_proxy.py new file mode 100644 index 0000000000..c4c8ed667f --- /dev/null +++ b/newrelic/core/samplers/sampler_proxy.py @@ -0,0 +1,170 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +import logging + +from newrelic.core.samplers.adaptive_sampler import AdaptiveSampler +from newrelic.core.samplers.trace_id_ratio_based_sampler import TraceIdRatioBasedSampler + +_logger = logging.getLogger(__name__) + + +class SamplerProxy: + def __init__(self, settings): + if settings.serverless_mode.enabled: + sampling_target_period = 60.0 + else: + sampling_target_period = settings.sampling_target_period_in_seconds + adaptive_sampler = AdaptiveSampler(settings.sampling_target, sampling_target_period) + self._samplers = {"global": adaptive_sampler} + + full_gran_root_ratio = None + full_gran_parent_sampled_ratio = None + full_gran_parent_not_sampled_ratio = None + # Add sampler instances for each config section if configured. + if settings.distributed_tracing.sampler.full_granularity.enabled: + # If the ratio is not defined fallback to adaptive sampler. + if ( + settings.distributed_tracing.sampler._root == "trace_id_ratio_based" + and settings.distributed_tracing.sampler.root.trace_id_ratio_based.ratio + ): + full_gran_root_ratio = settings.distributed_tracing.sampler.root.trace_id_ratio_based.ratio + self.add_trace_id_ratio_based_sampler((True, 0), full_gran_root_ratio) + else: + self.add_adaptive_sampler( + (True, 0), + settings.distributed_tracing.sampler.root.adaptive.sampling_target, + sampling_target_period, + ) + # If the ratio is not defined fallback to adaptive sampler. + if ( + settings.distributed_tracing.sampler._remote_parent_sampled == "trace_id_ratio_based" + and settings.distributed_tracing.sampler.remote_parent_sampled.trace_id_ratio_based.ratio + ): + full_gran_parent_sampled_ratio = ( + settings.distributed_tracing.sampler.remote_parent_sampled.trace_id_ratio_based.ratio + ) + self.add_trace_id_ratio_based_sampler((True, 1), full_gran_parent_sampled_ratio) + else: + self.add_adaptive_sampler( + (True, 1), + settings.distributed_tracing.sampler.remote_parent_sampled.adaptive.sampling_target, + sampling_target_period, + ) + # If the ratio is not defined fallback to adaptive sampler. + if ( + settings.distributed_tracing.sampler._remote_parent_not_sampled == "trace_id_ratio_based" + and settings.distributed_tracing.sampler.remote_parent_not_sampled.trace_id_ratio_based.ratio + ): + full_gran_parent_not_sampled_ratio = ( + settings.distributed_tracing.sampler.remote_parent_not_sampled.trace_id_ratio_based.ratio + ) + self.add_trace_id_ratio_based_sampler((True, 2), full_gran_parent_not_sampled_ratio) + else: + self.add_adaptive_sampler( + (True, 2), + settings.distributed_tracing.sampler.remote_parent_not_sampled.adaptive.sampling_target, + sampling_target_period, + ) + if settings.distributed_tracing.sampler.partial_granularity.enabled: + # If the ratio is not defined fallback to adaptive sampler. + if ( + settings.distributed_tracing.sampler.partial_granularity._root == "trace_id_ratio_based" + and settings.distributed_tracing.sampler.partial_granularity.root.trace_id_ratio_based.ratio + ): + # If both full and partial are set to use the trace id ratio based sampler, + # set partial granularity ratio = full ratio + partial ratio. + ratio = settings.distributed_tracing.sampler.partial_granularity.root.trace_id_ratio_based.ratio + if full_gran_root_ratio: + ratio = min(ratio + full_gran_root_ratio, 1) + self.add_trace_id_ratio_based_sampler((False, 0), ratio) + else: + self.add_adaptive_sampler( + (False, 0), + settings.distributed_tracing.sampler.partial_granularity.root.adaptive.sampling_target, + sampling_target_period, + ) + # If the ratio is not defined fallback to adaptive sampler. + if ( + settings.distributed_tracing.sampler.partial_granularity._remote_parent_sampled + == "trace_id_ratio_based" + and settings.distributed_tracing.sampler.partial_granularity.remote_parent_sampled.trace_id_ratio_based.ratio + ): + # If both full and partial are set to use the trace id ratio based sampler, + # set partial granularity ratio = full ratio + partial ratio. + ratio = settings.distributed_tracing.sampler.partial_granularity.remote_parent_sampled.trace_id_ratio_based.ratio + if full_gran_parent_sampled_ratio: + ratio = min(ratio + full_gran_parent_sampled_ratio, 1) + self.add_trace_id_ratio_based_sampler((False, 1), ratio) + else: + self.add_adaptive_sampler( + (False, 1), + settings.distributed_tracing.sampler.partial_granularity.remote_parent_sampled.adaptive.sampling_target, + sampling_target_period, + ) + # If the ratio is not defined fallback to adaptive sampler. + if ( + settings.distributed_tracing.sampler.partial_granularity._remote_parent_not_sampled + == "trace_id_ratio_based" + and settings.distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled.trace_id_ratio_based.ratio + ): + # If both full and partial are set to use the trace id ratio based sampler, + # set partial granularity ratio = full ratio + partial ratio. + ratio = settings.distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled.trace_id_ratio_based.ratio + if full_gran_parent_not_sampled_ratio: + ratio = min(ratio + full_gran_parent_not_sampled_ratio, 1) + self.add_trace_id_ratio_based_sampler((False, 2), ratio) + else: + self.add_adaptive_sampler( + (False, 2), + settings.distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled.adaptive.sampling_target, + sampling_target_period, + ) + + def add_trace_id_ratio_based_sampler(self, key, ratio): + """ + Add a trace id ratio based sampler instance to self._samplers. + """ + ratio_sampler = TraceIdRatioBasedSampler(ratio) + self._samplers[key] = ratio_sampler + + def add_adaptive_sampler(self, key, sampling_target, sampling_target_period): + """ + Add an adaptive sampler instance to self._samplers if the sampling_target is specified. + """ + if sampling_target: + adaptive_sampler = AdaptiveSampler(sampling_target, sampling_target_period) + self._samplers[key] = adaptive_sampler + + def get_sampler(self, full_granularity, section): + # Return the sampler instance for the given config section. + # If no instance is present, return the global adaptive sampler instance instead. + return self._samplers.get((full_granularity, section)) or self._samplers["global"] + + def compute_sampled(self, full_granularity, section, *args, **kwargs): + """ + full_granularity: True is full granularity, False is partial granularity + section: 0-root, 1-remote_parent_sampled, 2-remote_parent_not_sampled + """ + try: + return self.get_sampler(full_granularity, section).compute_sampled(*args, **kwargs) + except Exception: + # This happens when there is a mismatch in the settings used to create the + # samplers vs request a sampler inside a transaction. While this shouldn't + # ever happen this is a safety guard. + _logger.warning( + "Attempted to access sampler (%s, %s) but encountered an error. Falling back on global adaptive sampler.", + full_granularity, + section, + ) + return self._samplers["global"].compute_sampled() diff --git a/newrelic/core/samplers/trace_id_ratio_based_sampler.py b/newrelic/core/samplers/trace_id_ratio_based_sampler.py new file mode 100644 index 0000000000..457347cb10 --- /dev/null +++ b/newrelic/core/samplers/trace_id_ratio_based_sampler.py @@ -0,0 +1,33 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# For compatibility with 64 bit trace IDs, the sampler checks the 64 +# low-order bits of the trace ID to decide whether to sample a given trace. +TRACE_ID_LIMIT = (1 << 64) - 1 + + +class TraceIdRatioBasedSampler: + """ + This replicates behavior of TraceIdRatioBased sampler in + https://github.com/open-telemetry/opentelemetry-python/blob/main/opentelemetry-sdk/src/opentelemetry/sdk/trace/sampling.py. + """ + + def __init__(self, ratio): + self.ratio = ratio + self.bound = round(ratio * (TRACE_ID_LIMIT + 1)) + + def compute_sampled(self, trace_id): + if trace_id & TRACE_ID_LIMIT < self.bound: + return True + return False diff --git a/newrelic/core/stats_engine.py b/newrelic/core/stats_engine.py index f4a0e98ff6..7c998076cc 100644 --- a/newrelic/core/stats_engine.py +++ b/newrelic/core/stats_engine.py @@ -1193,8 +1193,47 @@ def record_transaction(self, transaction): for event in transaction.span_protos(settings): self._span_stream.put(event) elif transaction.sampled: - for event in transaction.span_events(self.__settings): - self._span_events.add(event, priority=transaction.priority) + opentelemetry_enabled = settings.opentelemetry.enabled + if not opentelemetry_enabled: + # When opentelemetry is not enabled, the event will not contain SpanLinks or SpanEvents, + # so we can add the spans directly without filtering. + for event in transaction.span_events(self.__settings): + self._span_events.add(event, priority=transaction.priority) + else: + for event in transaction.span_events(self.__settings): + # When opentelemetry is enabled, the event may contain + # SpanLinks and/or SpanEvents. + if isinstance(event[-1], dict): + # No SpanLinks or SpanEvents to consider, add spans directly + self._span_events.add(event, priority=transaction.priority) + else: + # SpanLinks or SpanEvents are possible, one or both may also be empty lists. + # A filter is used to remove any empty lists. + new_event = list(filter(bool, event)) + self._span_events.add(new_event, priority=transaction.priority) + + if transaction.partial_granularity_sampled: + partial_gran_type = settings.distributed_tracing.sampler.partial_granularity.type + self.record_custom_metric( + f"Supportability/Python/PartialGranularity/{partial_gran_type}", {"count": 1} + ) + instrumented = getattr(transaction, "spans_instrumented", 0) + if instrumented: + self.record_custom_metric( + f"Supportability/DistributedTrace/PartialGranularity/{partial_gran_type}/Span/Instrumented", + {"count": instrumented}, + ) + kept = getattr(transaction, "spans_kept", 0) + if instrumented: + self.record_custom_metric( + f"Supportability/DistributedTrace/PartialGranularity/{partial_gran_type}/Span/Kept", + {"count": kept}, + ) + dropped_ids = getattr(transaction, "partial_granularity_dropped_ids", 0) + if dropped_ids: + self.record_custom_metric( + "Supportability/Python/PartialGranularity/NrIds/Dropped", {"count": dropped_ids} + ) # Merge in log events diff --git a/newrelic/core/transaction_node.py b/newrelic/core/transaction_node.py index 34871d8b21..6bad1cc077 100644 --- a/newrelic/core/transaction_node.py +++ b/newrelic/core/transaction_node.py @@ -98,6 +98,7 @@ "root_span_guid", "trace_id", "loop_time", + "partial_granularity_sampled", ], ) @@ -633,5 +634,47 @@ def span_events(self, settings, attr_class=dict): ("priority", self.priority), ) ) - - yield from self.root.span_events(settings, base_attrs, parent_guid=self.parent_span, attr_class=attr_class) + if not self.partial_granularity_sampled: + yield from self.root.span_events_full_granularity( + settings, base_attrs, parent_guid=self.parent_span, attr_class=attr_class + ) + else: + ct_exit_spans = {"instrumented": 0, "kept": 0, "dropped_ids": 0} + partial_type = settings.distributed_tracing.sampler.partial_granularity.type + # Get the appropriate span_event method for the partial granularity type. + # If the type does not exist fallback on the default "essential". + span_event_method = self.root.PARTIAL_GRANULARITY_SPAN_EVENT_METHODS.get( + partial_type, self.root.PARTIAL_GRANULARITY_SPAN_EVENT_METHODS["essential"] + ) + # In corner case scenarios where there is a harvest while spans are being added + # to the reservoir, a compact span may be sent before its agent attributes have + # been updated. This is solved by cacheing all spans in compact mode and not + # adding them to the reservoir until all spans are touched. + if partial_type == "compact": + events = list( + self.root.span_events_partial_granularity( + settings, + span_event_method, + base_attrs, + parent_guid=self.parent_span, + attr_class=attr_class, + ct_exit_spans=ct_exit_spans, + ) + ) + yield from events + else: + yield from self.root.span_events_partial_granularity( + settings, + span_event_method, + base_attrs, + parent_guid=self.parent_span, + attr_class=attr_class, + ct_exit_spans=ct_exit_spans, + ) + # If this transaction is partial granularity sampled, record the number of spans + # instrumented and the number of spans kept to monitor cost savings of partial + # granularity tracing. + # Also record the number of span ids dropped (fragmentation) in compact mode. + self.spans_instrumented = ct_exit_spans["instrumented"] + self.spans_kept = ct_exit_spans["kept"] + self.partial_granularity_dropped_ids = ct_exit_spans["dropped_ids"] diff --git a/newrelic/hooks/external_botocore.py b/newrelic/hooks/external_botocore.py index 78c23f7a0d..dfbe1a6e5e 100644 --- a/newrelic/hooks/external_botocore.py +++ b/newrelic/hooks/external_botocore.py @@ -34,6 +34,7 @@ from newrelic.common.package_version_utils import get_package_version from newrelic.common.signature import bind_args from newrelic.core.config import global_settings +from newrelic.core.database_utils import generate_dynamodb_arn QUEUE_URL_PATTERN = re.compile(r"https://sqs.([\w\d-]+).amazonaws.com/(\d+)/([^/]+)") BOTOCORE_VERSION = get_package_version("botocore") @@ -1293,21 +1294,10 @@ def _nr_dynamodb_datastore_trace_wrapper_(wrapped, instance, args, kwargs): settings = transaction.settings if transaction.settings else global_settings() account_id = settings.cloud.aws.account_id if settings and settings.cloud.aws.account_id else None - # There are 3 different partition options. - # See https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html for details. - partition = None - if hasattr(instance, "_endpoint") and hasattr(instance._endpoint, "host"): - _db_host = instance._endpoint.host - partition = "aws" - if "amazonaws.cn" in _db_host: - partition = "aws-cn" - elif "amazonaws-us-gov.com" in _db_host: - partition = "aws-us-gov" - - if partition and region and account_id and _target: - agent_attrs["cloud.resource_id"] = ( - f"arn:{partition}:dynamodb:{region}:{account_id:012d}:table/{_target}" - ) + _db_host = getattr(getattr(instance, "_endpoint", None), "host", None) + resource_id = generate_dynamodb_arn(_db_host, region, account_id, _target) + if resource_id: + agent_attrs["cloud.resource_id"] = resource_id except Exception: _logger.debug("Failed to capture AWS DynamoDB info.", exc_info=True) diff --git a/newrelic/hooks/hybridagent_opentelemetry.py b/newrelic/hooks/hybridagent_opentelemetry.py new file mode 100644 index 0000000000..aee8a35a41 --- /dev/null +++ b/newrelic/hooks/hybridagent_opentelemetry.py @@ -0,0 +1,280 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import os + +from newrelic.api.application import application_instance +from newrelic.api.time_trace import current_trace +from newrelic.api.transaction import current_transaction +from newrelic.common.object_wrapper import wrap_function_wrapper +from newrelic.common.signature import bind_args +from newrelic.core.config import global_settings + +########################################### +# Context Instrumentation +########################################### + + +def wrap__load_runtime_context(wrapped, instance, args, kwargs): + application = application_instance(activate=False) + settings = global_settings() if not application else application.settings + if not settings.opentelemetry.enabled: + return wrapped(*args, **kwargs) + + from opentelemetry.context.contextvars_context import ContextVarsRuntimeContext + + context = ContextVarsRuntimeContext() + return context + + +def wrap_get_global_response_propagator(wrapped, instance, args, kwargs): + from newrelic.api.opentelemetry import opentelemetry_context_propagator + + application = application_instance() + if not application.active: + # Force application registration if not already active + application.activate() + + settings = global_settings() + + if not (settings and settings.opentelemetry.enabled) and not os.environ.get("NEW_RELIC_OPENTELEMETRY_ENABLED"): + return wrapped(*args, **kwargs) + + from opentelemetry.instrumentation.propagators import set_global_response_propagator + + set_global_response_propagator(opentelemetry_context_propagator) + + return opentelemetry_context_propagator + + +def instrument_context_api(module): + if hasattr(module, "_load_runtime_context"): + wrap_function_wrapper(module, "_load_runtime_context", wrap__load_runtime_context) + + +def instrument_global_propagators_api(module): + if hasattr(module, "get_global_response_propagator"): + wrap_function_wrapper(module, "get_global_response_propagator", wrap_get_global_response_propagator) + + +########################################### +# Trace Instrumentation +########################################### + + +def wrap_set_tracer_provider(wrapped, instance, args, kwargs): + # This needs to act as a singleton, like the agent instance. + # We should initialize the agent here as well, if there is + # not an instance already. + + application = application_instance() + if not application.active: + # Force application registration if not already active + application.activate() + + settings = global_settings() + + if not (settings and settings.opentelemetry.enabled) and not os.environ.get("NEW_RELIC_OPENTELEMETRY_ENABLED"): + return wrapped(*args, **kwargs) + + nr_tracer_provider = application._agent.opentelemetry_tracer_provider() + return wrapped(nr_tracer_provider) + + +def wrap_get_tracer_provider(wrapped, instance, args, kwargs): + # This needs to act as a singleton, like the agent instance. + # We should initialize the agent here as well, if there is + # not an instance already. + + application = application_instance() + if not application.active: + # Force application registration if not already active + application.activate() + + settings = global_settings() + + if not (settings and settings.opentelemetry.enabled) and not os.environ.get("NEW_RELIC_OPENTELEMETRY_ENABLED"): + return wrapped(*args, **kwargs) + + return application._agent.opentelemetry_tracer_provider() + + +def wrap_get_custom_headers(wrapped, instance, args, kwargs): + # Capture all headers now and let New Relic handle + # filtering, either through attribute filtering or + # settings like HSM. + + capture_header_env_vars = [ + "OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_SERVER_RESPONSE", + "OTEL_INSTRUMENTATION_HTTP_CAPTURE_HEADERS_CLIENT_RESPONSE", + ] + + bound_args = bind_args(wrapped, args, kwargs) + env_var = bound_args.get("env_var") + if env_var and (env_var in capture_header_env_vars): + return [".*"] + + return wrapped(*args, **kwargs) + + +def wrap_get_current_span(wrapped, instance, args, kwargs): + transaction = current_transaction() + trace = current_trace() + span = wrapped(*args, **kwargs) + + if not transaction: + return span + + # Do not allow the wrapper to continue if + # the Hybrid Agent setting is not enabled + application = application_instance(activate=False) + settings = global_settings() if not application else application.settings + + if not settings.opentelemetry.enabled: + return span + + # If a NR trace does exist, check to see if the current + # OpenTelemetry span corresponds to the current NR trace. If so, + # return the original function's result. + if span.get_span_context().span_id == int(trace.guid, 16): + return span + + # If the current OpenTelemetry span does not match the current NR + # trace, this means that a NR trace was created either + # manually or through the NR agent. Either way, the OpenTelemetry + # API was not used to create a span object. The Hybrid + # Agent's Span object creates a NR trace but since the NR + # trace has already been created, we just need a symbolic + # OpenTelemetry span to represent it the span object. A LazySpan + # will be created. It will effectively be a NonRecordingSpan + # with the ability to add custom attributes. + + from opentelemetry import trace as otel_api_trace + + from newrelic.api.opentelemetry import LazySpan + + span_context = otel_api_trace.SpanContext( + trace_id=int(transaction.trace_id, 16), + span_id=int(trace.guid, 16), + is_remote=span.get_span_context().is_remote, + trace_flags=otel_api_trace.TraceFlags(0x01), + trace_state=otel_api_trace.TraceState(), + ) + + return LazySpan(span_context, trace) + + +def wrap_start_internal_or_server_span(wrapped, instance, args, kwargs): + # We want to take the NR version of the context_carrier + # and put that into the attributes. Keep the original + # context_carrier intact. + + # Do not allow the wrapper to continue if + # the Hybrid Agent setting is not enabled + application = application_instance(activate=False) + settings = global_settings() if not application else application.settings + + if not settings.opentelemetry.enabled: + return wrapped(*args, **kwargs) + + bound_args = bind_args(wrapped, args, kwargs) + context_carrier = bound_args.get("context_carrier") + attributes = bound_args.get("attributes", {}) + + if context_carrier: + if ("HTTP_HOST" in context_carrier) or ("http_version" in context_carrier): + # This is an HTTP request (WSGI, ASGI, or otherwise) + if "wsgi.version" in context_carrier: + attributes["nr.wsgi.environ"] = context_carrier + elif "asgi" in context_carrier: + attributes["nr.asgi.scope"] = context_carrier + else: + attributes["nr.http.headers"] = context_carrier + else: + attributes["nr.nonhttp.headers"] = context_carrier + + bound_args["attributes"] = attributes + + return wrapped(**bound_args) + + +def wrap__get_span(wrapped, instance, args, kwargs): + # Do not allow the wrapper to continue if + # the Hybrid Agent setting is not enabled + application = application_instance(activate=False) + settings = global_settings() if not application else application.settings + + if not settings.opentelemetry.enabled: + return wrapped(*args, **kwargs) + + bound_args = bind_args(wrapped, args, kwargs) + channel = bound_args.get("channel") + properties = bound_args.get("properties") + span_kind = bound_args.get("span_kind") + task_name = bound_args.get("task_name") + tracer = bound_args.get("tracer") + + properties_to_extract = ("correlation_id", "reply_to", "headers") + + if span_kind == span_kind.PRODUCER: + # Do nothing special for producer spans + pass + elif channel: + # This is a callback related consumer call + # if transaction already exists, create trace + # for callback; else, do not do anything + tracer._create_consumer_trace = True + elif not channel: + # This is a consumer generator call + # Create a new transaction only. + # if transaction already exists, a new one + # will not be created and nothing will occur. + # This is the current behavior that Kafka has + tracer._create_consumer_trace = False + + params = {"task_name": task_name} + for _property in properties_to_extract: + value = getattr(properties, _property, None) + if properties and value: + params[_property] = value + + span = wrapped(*args, **kwargs) + span.set_attributes(params) + + return span + + +def instrument_trace_api(module): + if hasattr(module, "set_tracer_provider"): + wrap_function_wrapper(module, "set_tracer_provider", wrap_set_tracer_provider) + + if hasattr(module, "get_tracer_provider"): + wrap_function_wrapper(module, "get_tracer_provider", wrap_get_tracer_provider) + + if hasattr(module, "get_current_span"): + wrap_function_wrapper(module, "get_current_span", wrap_get_current_span) + + +def instrument_utils(module): + if hasattr(module, "_start_internal_or_server_span"): + wrap_function_wrapper(module, "_start_internal_or_server_span", wrap_start_internal_or_server_span) + + +def instrument_pika_utils(module): + if hasattr(module, "_get_span"): + wrap_function_wrapper(module, "_get_span", wrap__get_span) + + +def instrument_util_http(module): + wrap_function_wrapper(module, "get_custom_headers", wrap_get_custom_headers) diff --git a/pyproject.toml b/pyproject.toml index 2dbdb34837..4498ff620b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -71,6 +71,7 @@ packages = [ "newrelic.bootstrap", "newrelic.common", "newrelic.core", + "newrelic.core.samplers", "newrelic.extras", "newrelic.extras.framework_django", "newrelic.extras.framework_django.templatetags", diff --git a/tests/agent_features/test_distributed_tracing.py b/tests/agent_features/test_distributed_tracing.py index 36261d97e2..b7ee3896c3 100644 --- a/tests/agent_features/test_distributed_tracing.py +++ b/tests/agent_features/test_distributed_tracing.py @@ -12,8 +12,11 @@ # See the License for the specific language governing permissions and # limitations under the License. +import asyncio import copy import json +import random +import time import pytest import webtest @@ -23,6 +26,21 @@ from testing_support.validators.validate_function_not_called import validate_function_not_called from testing_support.validators.validate_transaction_event_attributes import validate_transaction_event_attributes from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics +from testing_support.validators.validate_transaction_object_attributes import validate_transaction_object_attributes + +from newrelic.api.application import application_instance +from newrelic.api.function_trace import function_trace +from newrelic.common.object_names import callable_name +from newrelic.common.object_wrapper import function_wrapper, transient_function_wrapper + +try: + from newrelic.core.infinite_tracing_pb2 import AttributeValue, Span +except: + AttributeValue = None + Span = None + +from testing_support.mock_external_http_server import MockExternalHTTPHResponseHeadersServer +from testing_support.validators.validate_span_events import check_value_equals, validate_span_events from newrelic.api.application import application_instance from newrelic.api.background_task import BackgroundTask, background_task @@ -39,6 +57,7 @@ from newrelic.api.wsgi_application import wsgi_application from newrelic.core.attribute import Attribute +# ruff: noqa: UP031 distributed_trace_intrinsics = ["guid", "traceId", "priority", "sampled"] inbound_payload_intrinsics = [ "parent.type", @@ -71,6 +90,110 @@ } +def validate_compact_span_event( + name, compressed_span_count, expected_nr_durations_low_bound, expected_nr_durations_high_bound +): + @function_wrapper + def _validate_wrapper(wrapped, instance, args, kwargs): + record_transaction_called = [] + recorded_span_events = [] + + @transient_function_wrapper("newrelic.core.stats_engine", "StatsEngine.record_transaction") + def capture_span_events(wrapped, instance, args, kwargs): + events = [] + + @transient_function_wrapper("newrelic.common.streaming_utils", "StreamBuffer.put") + def stream_capture(wrapped, instance, args, kwargs): + event = args[0] + events.append(event) + return wrapped(*args, **kwargs) + + record_transaction_called.append(True) + try: + result = stream_capture(wrapped)(*args, **kwargs) + except: + raise + else: + if not instance.settings.infinite_tracing.enabled: + events = [event for priority, seen_at, event in instance.span_events.pq] + + recorded_span_events.append(events) + + return result + + _new_wrapper = capture_span_events(wrapped) + val = _new_wrapper(*args, **kwargs) + assert record_transaction_called + captured_events = recorded_span_events.pop(-1) + + mismatches = [] + matching_span_events = 0 + + def _span_details(): + details = [ + f"matching_span_events={matching_span_events}", + f"mismatches={mismatches}", + f"captured_events={captured_events}", + ] + return "\n".join(details) + + for captured_event in captured_events: + if Span and isinstance(captured_event, Span): + intrinsics = captured_event.intrinsics + user_attrs = captured_event.user_attributes + agent_attrs = captured_event.agent_attributes + else: + intrinsics, _, _ = captured_event + + # Find the span by name. + if not check_value_equals(intrinsics, "name", name): + continue + assert check_value_length(intrinsics, "nr.ids", compressed_span_count - 1, mismatches), _span_details() + assert check_value_between( + intrinsics, + "nr.durations", + expected_nr_durations_low_bound, + expected_nr_durations_high_bound, + mismatches, + ), _span_details() + matching_span_events += 1 + + assert matching_span_events == 1, _span_details() + return val + + return _validate_wrapper + + +def check_value_between(dictionary, key, expected_min, expected_max, mismatches): + value = dictionary.get(key) + if AttributeValue and isinstance(value, AttributeValue): + for _, val in value.ListFields(): + if not (expected_min < val < expected_max): + mismatches.append(f"key: {key}, not {expected_min} < {val} < {expected_max}") + return False + return True + else: + if not (expected_min < value < expected_max): + mismatches.append(f"key: {key}, not {expected_min} < {value} < {expected_max}") + return False + return True + + +def check_value_length(dictionary, key, expected_length, mismatches): + value = dictionary.get(key) + if AttributeValue and isinstance(value, AttributeValue): + for _, val in value.ListFields(): + if len(val) != expected_length: + mismatches.append(f"key: {key}, not len({val}) == {expected_length}") + return False + return True + else: + if len(value) != expected_length: + mismatches.append(f"key: {key}, not len({value}) == {expected_length}") + return False + return True + + @wsgi_application() def target_wsgi_application(environ, start_response): status = "200 OK" @@ -419,24 +542,283 @@ def _test_inbound_dt_payload_acceptance(): @pytest.mark.parametrize( - "sampled,remote_parent_sampled,remote_parent_not_sampled,expected_sampled,expected_priority,expected_adaptive_sampling_algo_called", + "newrelic_header,traceparent_sampled,newrelic_sampled,root_setting,remote_parent_sampled_setting,remote_parent_not_sampled_setting,expected_sampled,expected_priority,expected_adaptive_sampling_algo_called", + ( + (False, None, None, "default", "default", "default", None, None, True), # Uses adaptive sampling algo. + (False, None, None, "always_on", "default", "default", True, 3, False), # Always sampled. + (False, None, None, "always_off", "default", "default", False, 0, False), # Never sampled. + (True, True, None, "default", "default", "default", None, None, True), # Uses adaptive sampling algo. + (True, True, None, "default", "always_on", "default", True, 3, False), # Always sampled. + (True, True, None, "default", "always_off", "default", False, 0, False), # Never sampled. + (True, False, None, "default", "default", "default", None, None, True), # Uses adaptive sampling algo. + (True, False, None, "default", "always_on", "default", None, None, True), # Uses adaptive sampling alog. + (True, False, None, "default", "always_off", "default", None, None, True), # Uses adaptive sampling algo. + (True, True, None, "default", "default", "always_on", None, None, True), # Uses adaptive sampling algo. + (True, True, None, "default", "default", "always_off", None, None, True), # Uses adaptive sampling algo. + (True, False, None, "default", "default", "always_on", True, 3, False), # Always sampled. + (True, False, None, "default", "default", "always_off", False, 0, False), # Never sampled. + ( + True, + True, + True, + "default", + "default", + "default", + True, + 1.23456, + False, + ), # Uses sampling decision in W3C TraceState header. + ( + True, + True, + False, + "default", + "default", + "default", + False, + 1.23456, + False, + ), # Uses sampling decision in W3C TraceState header. + ( + True, + False, + False, + "default", + "default", + "default", + False, + 1.23456, + False, + ), # Uses sampling decision in W3C TraceState header. + (True, True, False, "default", "always_on", "default", True, 3, False), # Always sampled. + (True, True, True, "default", "always_off", "default", False, 0, False), # Never sampled. + (True, False, False, "default", "default", "always_on", True, 3, False), # Always sampled. + (True, False, True, "default", "default", "always_off", False, 0, False), # Never sampled. + ( + True, + None, + True, + "default", + "default", + "default", + True, + 0.1234, + False, + ), # Uses sampling and priority from newrelic header. + (True, None, True, "default", "always_on", "default", True, 3, False), # Always sampled. + (True, None, True, "default", "always_off", "default", False, 0, False), # Never sampled. + ( + True, + None, + False, + "default", + "default", + "default", + False, + 0.1234, + False, + ), # Uses sampling and priority from newrelic header. + ( + True, + None, + False, + "default", + "always_on", + "default", + False, + 0.1234, + False, + ), # Uses sampling and priority from newrelic header. + ( + True, + None, + True, + "default", + "default", + "always_on", + True, + 0.1234, + False, + ), # Uses sampling and priority from newrelic header. + (True, None, False, "default", "default", "always_on", True, 3, False), # Always sampled. + (True, None, False, "default", "default", "always_off", False, 0, False), # Never sampled. + (True, None, None, "default", "default", "default", None, None, True), # Uses adaptive sampling algo. + ), +) +def test_distributed_trace_remote_parent_sampling_decision_full_granularity( + newrelic_header, + traceparent_sampled, + newrelic_sampled, + root_setting, + remote_parent_sampled_setting, + remote_parent_not_sampled_setting, + expected_sampled, + expected_priority, + expected_adaptive_sampling_algo_called, +): + required_intrinsics = [] + if expected_sampled is not None: + required_intrinsics.append(Attribute(name="sampled", value=expected_sampled, destinations=0b110)) + if expected_priority is not None: + required_intrinsics.append(Attribute(name="priority", value=expected_priority, destinations=0b110)) + + test_settings = _override_settings.copy() + test_settings.update( + { + "distributed_tracing.sampler._root": root_setting, + "distributed_tracing.sampler._remote_parent_sampled": remote_parent_sampled_setting, + "distributed_tracing.sampler._remote_parent_not_sampled": remote_parent_not_sampled_setting, + "span_events.enabled": True, + } + ) + if expected_adaptive_sampling_algo_called: + function_called_decorator = validate_function_called( + "newrelic.core.samplers.adaptive_sampler", "AdaptiveSampler.compute_sampled" + ) + else: + function_called_decorator = validate_function_not_called( + "newrelic.core.samplers.adaptive_sampler", "AdaptiveSampler.compute_sampled" + ) + + @function_called_decorator + @override_application_settings(test_settings) + @validate_attributes_complete("intrinsic", required_intrinsics) + @background_task(name="test_distributed_trace_attributes") + def _test(): + txn = current_transaction() + + headers = {} + if traceparent_sampled is not None: + headers = { + "traceparent": f"00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-{int(traceparent_sampled):02x}", + "newrelic": '{"v":[0,1],"d":{"ty":"Mobile","ac":"123","ap":"51424","id":"5f474d64b9cc9b2a","tr":"6e2fea0b173fdad0","pr":0.1234,"sa":true,"ti":1482959525577,"tx":"27856f70d3d314b7"}}', # This header should be ignored. + } + if newrelic_sampled is not None: + headers["tracestate"] = ( + f"1@nr=0-0-1-2827902-0af7651916cd43dd-00f067aa0ba902b7-{int(newrelic_sampled)}-1.23456-1518469636035" + ) + elif newrelic_header: + headers = { + "newrelic": '{"v":[0,1],"d":{"ty":"Mobile","ac":"1","ap":"51424","id":"00f067aa0ba902b7","tr":"0af7651916cd43dd8448eb211c80319c","pr":0.1234,"sa":%s,"ti":1482959525577,"tx":"0af7651916cd43dd"}}' + % (str(newrelic_sampled).lower()) + } + if headers: + accept_distributed_trace_headers(headers) + + _test() + + +@pytest.mark.parametrize( + "newrelic_header,traceparent_sampled,newrelic_sampled,root_setting,remote_parent_sampled_setting,remote_parent_not_sampled_setting,expected_sampled,expected_priority,expected_adaptive_sampling_algo_called", ( - (True, "default", "default", None, None, True), # Uses sampling algo. - (True, "always_on", "default", True, 2, False), # Always sampled. - (True, "always_off", "default", False, 0, False), # Never sampled. - (False, "default", "default", None, None, True), # Uses sampling algo. - (False, "always_on", "default", None, None, True), # Uses sampling alog. - (False, "always_off", "default", None, None, True), # Uses sampling algo. - (True, "default", "always_on", None, None, True), # Uses sampling algo. - (True, "default", "always_off", None, None, True), # Uses sampling algo. - (False, "default", "always_on", True, 2, False), # Always sampled. - (False, "default", "always_off", False, 0, False), # Never sampled. + (False, None, None, "default", "default", "default", None, None, True), # Uses adaptive sampling algo. + (False, None, None, "always_on", "default", "default", True, 2, False), # Always sampled. + (False, None, None, "always_off", "default", "default", False, 0, False), # Never sampled. + (True, True, None, "default", "default", "default", None, None, True), # Uses adaptive sampling algo. + (True, True, None, "default", "always_on", "default", True, 2, False), # Always sampled. + (True, True, None, "default", "always_off", "default", False, 0, False), # Never sampled. + (True, False, None, "default", "default", "default", None, None, True), # Uses adaptive sampling algo. + (True, False, None, "default", "always_on", "default", None, None, True), # Uses adaptive sampling alog. + (True, False, None, "default", "always_off", "default", None, None, True), # Uses adaptive sampling algo. + (True, True, None, "default", "default", "always_on", None, None, True), # Uses adaptive sampling algo. + (True, True, None, "default", "default", "always_off", None, None, True), # Uses adaptive sampling algo. + (True, False, None, "default", "default", "always_on", True, 2, False), # Always sampled. + (True, False, None, "default", "default", "always_off", False, 0, False), # Never sampled. + ( + True, + True, + True, + "default", + "default", + "default", + True, + 1.23456, + False, + ), # Uses sampling decision in W3C TraceState header. + ( + True, + True, + False, + "default", + "default", + "default", + False, + 1.23456, + False, + ), # Uses sampling decision in W3C TraceState header. + ( + True, + False, + False, + "default", + "default", + "default", + False, + 1.23456, + False, + ), # Uses sampling decision in W3C TraceState header. + (True, True, False, "default", "always_on", "default", True, 2, False), # Always sampled. + (True, True, True, "default", "always_off", "default", False, 0, False), # Never sampled. + (True, False, False, "default", "default", "always_on", True, 2, False), # Always sampled. + (True, False, True, "default", "default", "always_off", False, 0, False), # Never sampled. + ( + True, + None, + True, + "default", + "default", + "default", + True, + 0.1234, + False, + ), # Uses sampling and priority from newrelic header. + (True, None, True, "default", "always_on", "default", True, 2, False), # Always sampled. + (True, None, True, "default", "always_off", "default", False, 0, False), # Never sampled. + ( + True, + None, + False, + "default", + "default", + "default", + False, + 0.1234, + False, + ), # Uses sampling and priority from newrelic header. + ( + True, + None, + False, + "default", + "always_on", + "default", + False, + 0.1234, + False, + ), # Uses sampling and priority from newrelic header. + ( + True, + None, + True, + "default", + "default", + "always_on", + True, + 0.1234, + False, + ), # Uses sampling and priority from newrelic header. + (True, None, False, "default", "default", "always_on", True, 2, False), # Always sampled. + (True, None, False, "default", "default", "always_off", False, 0, False), # Never sampled. + (True, None, None, "default", "default", "default", None, None, True), # Uses adaptive sampling algo. ), ) -def test_distributed_trace_w3cparent_sampling_decision( - sampled, - remote_parent_sampled, - remote_parent_not_sampled, +def test_distributed_trace_remote_parent_sampling_decision_partial_granularity( + newrelic_header, + traceparent_sampled, + newrelic_sampled, + root_setting, + remote_parent_sampled_setting, + remote_parent_not_sampled_setting, expected_sampled, expected_priority, expected_adaptive_sampling_algo_called, @@ -450,18 +832,21 @@ def test_distributed_trace_w3cparent_sampling_decision( test_settings = _override_settings.copy() test_settings.update( { - "distributed_tracing.sampler.remote_parent_sampled": remote_parent_sampled, - "distributed_tracing.sampler.remote_parent_not_sampled": remote_parent_not_sampled, + "distributed_tracing.sampler.full_granularity.enabled": False, + "distributed_tracing.sampler.partial_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity._root": root_setting, + "distributed_tracing.sampler.partial_granularity._remote_parent_sampled": remote_parent_sampled_setting, + "distributed_tracing.sampler.partial_granularity._remote_parent_not_sampled": remote_parent_not_sampled_setting, "span_events.enabled": True, } ) if expected_adaptive_sampling_algo_called: function_called_decorator = validate_function_called( - "newrelic.api.transaction", "Transaction.sampling_algo_compute_sampled_and_priority" + "newrelic.core.samplers.adaptive_sampler", "AdaptiveSampler.compute_sampled" ) else: function_called_decorator = validate_function_not_called( - "newrelic.api.transaction", "Transaction.sampling_algo_compute_sampled_and_priority" + "newrelic.core.samplers.adaptive_sampler", "AdaptiveSampler.compute_sampled" ) @function_called_decorator @@ -471,10 +856,836 @@ def test_distributed_trace_w3cparent_sampling_decision( def _test(): txn = current_transaction() + headers = {} + if traceparent_sampled is not None: + headers = { + "traceparent": f"00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-{int(traceparent_sampled):02x}", + "newrelic": '{"v":[0,1],"d":{"ty":"Mobile","ac":"123","ap":"51424","id":"5f474d64b9cc9b2a","tr":"6e2fea0b173fdad0","pr":0.1234,"sa":true,"ti":1482959525577,"tx":"27856f70d3d314b7"}}', # This header should be ignored. + } + if newrelic_sampled is not None: + headers["tracestate"] = ( + f"1@nr=0-0-1-2827902-0af7651916cd43dd-00f067aa0ba902b7-{int(newrelic_sampled)}-1.23456-1518469636035" + ) + elif newrelic_header: + headers = { + "newrelic": '{"v":[0,1],"d":{"ty":"Mobile","ac":"1","ap":"51424","id":"00f067aa0ba902b7","tr":"0af7651916cd43dd8448eb211c80319c","pr":0.1234,"sa":%s,"ti":1482959525577,"tx":"0af7651916cd43dd"}}' + % (str(newrelic_sampled).lower()) + } + if headers: + accept_distributed_trace_headers(headers) + + _test() + + +@pytest.mark.parametrize( + "full_granularity_enabled,full_granularity_remote_parent_sampled_setting,partial_granularity_enabled,partial_granularity_remote_parent_sampled_setting,expected_sampled,expected_priority,expected_adaptive_sampling_algo_called", + ( + (True, "always_off", True, "adaptive", None, None, True), # Uses adaptive sampling algo. + (True, "always_on", True, "adaptive", True, 3, False), # Always samples. + ), +) +def test_distributed_trace_remote_parent_sampling_decision_between_full_and_partial_granularity( + full_granularity_enabled, + full_granularity_remote_parent_sampled_setting, + partial_granularity_enabled, + partial_granularity_remote_parent_sampled_setting, + expected_sampled, + expected_priority, + expected_adaptive_sampling_algo_called, +): + required_intrinsics = [] + if expected_sampled is not None: + required_intrinsics.append(Attribute(name="sampled", value=expected_sampled, destinations=0b110)) + if expected_priority is not None: + required_intrinsics.append(Attribute(name="priority", value=expected_priority, destinations=0b110)) + + test_settings = _override_settings.copy() + test_settings.update( + { + "distributed_tracing.sampler.full_granularity.enabled": full_granularity_enabled, + "distributed_tracing.sampler.partial_granularity.enabled": partial_granularity_enabled, + "distributed_tracing.sampler._remote_parent_sampled": full_granularity_remote_parent_sampled_setting, + "distributed_tracing.sampler.partial_granularity._remote_parent_sampled": partial_granularity_remote_parent_sampled_setting, + "span_events.enabled": True, + } + ) + if expected_adaptive_sampling_algo_called: + function_called_decorator = validate_function_called( + "newrelic.core.samplers.adaptive_sampler", "AdaptiveSampler.compute_sampled" + ) + else: + function_called_decorator = validate_function_not_called( + "newrelic.core.samplers.adaptive_sampler", "AdaptiveSampler.compute_sampled" + ) + + @function_called_decorator + @override_application_settings(test_settings) + @validate_attributes_complete("intrinsic", required_intrinsics) + @background_task(name="test_distributed_trace_attributes") + def _test(): + headers = {"traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"} + accept_distributed_trace_headers(headers) + + _test() + + +def test_partial_granularity_entity_synthesis_attr_none_in_compact(): + """ + Tests no crash happens when an entity synthesis attribute is set to None. + """ + + @validate_span_events( + count=1, # Entry span. + exact_intrinsics={ + "name": "Function/test_distributed_tracing:test_partial_granularity_entity_synthesis_attr_none_in_compact.._test", + "nr.pg": True, + }, + expected_intrinsics=["duration", "timestamp"], + ) + @validate_span_events( + count=1, # 1 external compressed span. + exact_intrinsics={"name": "External/localhost:3000/requests/GET"}, + expected_intrinsics=["nr.durations", "nr.ids"], + exact_agents={"http.url": "http://localhost:3000/"}, + unexpected_agents=["db.instance"], + ) + @background_task() + def _test(): + headers = {"traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"} + accept_distributed_trace_headers(headers) + with ExternalTrace("requests", "http://localhost:3000/", method="GET") as trace: + trace._add_agent_attribute("db.instance", None) + time.sleep(0.1) + + _test = override_application_settings( + { + "distributed_tracing.sampler.full_granularity.enabled": False, + "distributed_tracing.sampler.partial_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity.type": "compact", + "distributed_tracing.sampler.partial_granularity._remote_parent_sampled": "always_on", + "span_events.enabled": True, + } + )(_test) + + _test() + + +def test_partial_granularity_max_compressed_spans(): + """ + Tests `nr.ids` does not exceed 1024 byte limit. + """ + + async def test(index): + with ExternalTrace("requests", "http://localhost:3000/", method="GET") as trace: + time.sleep(0.1) + + @function_trace() + async def call_tests(): + tasks = [test(i) for i in range(65)] + await asyncio.gather(*tasks) + + @validate_span_events( + count=1, # Entry span. + exact_intrinsics={ + "name": "Function/test_distributed_tracing:test_partial_granularity_max_compressed_spans.._test", + "nr.pg": True, + }, + expected_intrinsics=["duration", "timestamp"], + ) + @validate_span_events( + count=1, # 1 external compressed span. + exact_intrinsics={"name": "External/localhost:3000/requests/GET"}, + expected_intrinsics=["nr.durations", "nr.ids"], + exact_agents={"http.url": "http://localhost:3000/"}, + ) + @validate_compact_span_event( + name="External/localhost:3000/requests/GET", + # `nr.ids` can only hold 63 ids but duration reflects all compressed spans. + compressed_span_count=64, + expected_nr_durations_low_bound=6.5, + expected_nr_durations_high_bound=8, # 64 of these + add extra overhead. + ) + @background_task() + def _test(): + headers = {"traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"} + accept_distributed_trace_headers(headers) + asyncio.run(call_tests()) + + _test = override_application_settings( + { + "distributed_tracing.sampler.full_granularity.enabled": False, + "distributed_tracing.sampler.partial_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity.type": "compact", + "distributed_tracing.sampler.partial_granularity._remote_parent_sampled": "always_on", + "span_events.enabled": True, + } + )(_test) + + _test() + + +def test_partial_granularity_compressed_span_attributes_in_series(): + """ + Tests compressed span attributes when compressed span times are serial. + Aka: each span ends before the next compressed span begins. + """ + + async def test(index): + with ExternalTrace("requests", "http://localhost:3000/", method="GET") as trace: + time.sleep(0.1) + + @function_trace() + async def call_tests(): + tasks = [test(i) for i in range(3)] + await asyncio.gather(*tasks) + + @validate_span_events( + count=1, # Entry span. + exact_intrinsics={ + "name": "Function/test_distributed_tracing:test_partial_granularity_compressed_span_attributes_in_series.._test", + "nr.pg": True, + }, + expected_intrinsics=["duration", "timestamp"], + ) + @validate_span_events( + count=1, # 1 external compressed span. + exact_intrinsics={"name": "External/localhost:3000/requests/GET"}, + expected_intrinsics=["nr.durations", "nr.ids"], + exact_agents={"http.url": "http://localhost:3000/"}, + ) + @validate_compact_span_event( + name="External/localhost:3000/requests/GET", + compressed_span_count=3, + expected_nr_durations_low_bound=0.3, + expected_nr_durations_high_bound=0.4, + ) + @background_task() + def _test(): + headers = {"traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"} + accept_distributed_trace_headers(headers) + asyncio.run(call_tests()) + + _test = override_application_settings( + { + "distributed_tracing.sampler.full_granularity.enabled": False, + "distributed_tracing.sampler.partial_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity.type": "compact", + "distributed_tracing.sampler.partial_granularity._remote_parent_sampled": "always_on", + "span_events.enabled": True, + } + )(_test) + + _test() + + +def test_partial_granularity_compressed_span_attributes_overlapping(): + """ + Tests compressed span attributes when compressed span times overlap. + Aka: the next span begins in the middle of the first span. + """ + + @validate_span_events( + count=1, # Entry span. + exact_intrinsics={ + "name": "Function/test_distributed_tracing:test_partial_granularity_compressed_span_attributes_overlapping.._test", + "nr.pg": True, + }, + expected_intrinsics=["duration", "timestamp"], + ) + @validate_span_events( + count=1, # 1 external compressed span. + exact_intrinsics={"name": "External/localhost:3000/requests/GET"}, + expected_intrinsics=["nr.durations", "nr.ids"], + exact_agents={"http.url": "http://localhost:3000/"}, + ) + @validate_compact_span_event( + name="External/localhost:3000/requests/GET", + compressed_span_count=2, + expected_nr_durations_low_bound=0.1, + expected_nr_durations_high_bound=0.2, + ) + @background_task() + def _test(): + headers = {"traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"} + accept_distributed_trace_headers(headers) + with ExternalTrace("requests", "http://localhost:3000/", method="GET") as trace1: + # Override terminal_node so we can create a nested exit span. + trace1.terminal_node = lambda: False + trace2 = ExternalTrace("requests", "http://localhost:3000/", method="GET") + trace2.__enter__() + time.sleep(0.1) + trace2.__exit__(None, None, None) + + _test = override_application_settings( + { + "distributed_tracing.sampler.full_granularity.enabled": False, + "distributed_tracing.sampler.partial_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity.type": "compact", + "distributed_tracing.sampler.partial_granularity._remote_parent_sampled": "always_on", + "span_events.enabled": True, + } + )(_test) + + _test() + + +def test_partial_granularity_reduced_span_attributes(): + """ + In reduced mode, only inprocess spans are dropped. + """ + + @function_trace() + def foo(): + with ExternalTrace("requests", "http://localhost:3000/", method="GET") as trace: + trace.add_custom_attribute("custom", "bar") + + @validate_span_events( + count=1, # Entry span. + exact_intrinsics={ + "name": "Function/test_distributed_tracing:test_partial_granularity_reduced_span_attributes.._test", + "nr.pg": True, + }, + expected_intrinsics=["duration", "timestamp"], + expected_agents=["code.function", "code.lineno", "code.namespace"], + ) + @validate_span_events( + count=0, # Function foo span should not be present. + exact_intrinsics={ + "name": "Function/test_distributed_tracing:test_partial_granularity_reduced_span_attributes..foo" + }, + expected_intrinsics=["duration", "timestamp"], + ) + @validate_span_events( + count=2, # 2 external spans. + exact_intrinsics={"name": "External/localhost:3000/requests/GET"}, + exact_agents={"http.url": "http://localhost:3000/"}, + exact_users={"custom": "bar"}, + ) + @background_task() + def _test(): + headers = {"traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"} + accept_distributed_trace_headers(headers) + with ExternalTrace("requests", "http://localhost:3000/", method="GET") as trace: + # Override terminal_node so we can create a nested exit span. + trace.terminal_node = lambda: False + trace.add_custom_attribute("custom", "bar") + foo() + + _test = override_application_settings( + { + "distributed_tracing.sampler.full_granularity.enabled": False, + "distributed_tracing.sampler.partial_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity.type": "reduced", + "distributed_tracing.sampler.partial_granularity._remote_parent_sampled": "always_on", + "span_events.enabled": True, + } + )(_test) + + _test() + + +def test_partial_granularity_essential_span_attributes(): + """ + In essential mode, inprocess spans are dropped and non-entity synthesis attributes. + """ + + @function_trace() + def foo(): + with ExternalTrace("requests", "http://localhost:3000/", method="GET") as trace: + trace.add_custom_attribute("custom", "bar") + + @validate_span_events( + count=1, # Entry span. + exact_intrinsics={ + "name": "Function/test_distributed_tracing:test_partial_granularity_essential_span_attributes.._test", + "nr.pg": True, + }, + expected_intrinsics=["duration", "timestamp"], + unexpected_agents=["code.function", "code.lineno", "code.namespace"], + ) + @validate_span_events( + count=0, # Function foo span should not be present. + exact_intrinsics={ + "name": "Function/test_distributed_tracing:test_partial_granularity_essential_span_attributes..foo" + }, + expected_intrinsics=["duration", "timestamp"], + ) + @validate_span_events( + count=2, # 2 external spans. + exact_intrinsics={"name": "External/localhost:3000/requests/GET"}, + exact_agents={"http.url": "http://localhost:3000/"}, + unexpected_users=["custom"], + ) + @background_task() + def _test(): + headers = {"traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"} + accept_distributed_trace_headers(headers) + with ExternalTrace("requests", "http://localhost:3000/", method="GET") as trace: + # Override terminal_node so we can create a nested exit span. + trace.terminal_node = lambda: False + trace.add_custom_attribute("custom", "bar") + foo() + + _test = override_application_settings( + { + "distributed_tracing.sampler.full_granularity.enabled": False, + "distributed_tracing.sampler.partial_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity.type": "essential", + "distributed_tracing.sampler.partial_granularity._remote_parent_sampled": "always_on", + "span_events.enabled": True, + } + )(_test) + + _test() + + +def test_partial_granularity_unknown_type_falls_back_on_essential(): + """ + In essential mode, inprocess spans are dropped and non-entity synthesis attributes. + """ + + @function_trace() + def foo(): + with ExternalTrace("requests", "http://localhost:3000/", method="GET") as trace: + trace.add_custom_attribute("custom", "bar") + + @validate_span_events( + count=1, # Entry span. + exact_intrinsics={ + "name": "Function/test_distributed_tracing:test_partial_granularity_unknown_type_falls_back_on_essential.._test", + "nr.pg": True, + }, + expected_intrinsics=["duration", "timestamp"], + unexpected_agents=["code.function", "code.lineno", "code.namespace"], + ) + @validate_span_events( + count=0, # Function foo span should not be present. + exact_intrinsics={ + "name": "Function/test_distributed_tracing:test_partial_granularity_unknown_type_falls_back_on_essential..foo" + }, + expected_intrinsics=["duration", "timestamp"], + ) + @validate_span_events( + count=2, # 2 external spans. + exact_intrinsics={"name": "External/localhost:3000/requests/GET"}, + exact_agents={"http.url": "http://localhost:3000/"}, + unexpected_users=["custom"], + ) + @background_task() + def _test(): + headers = {"traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"} + accept_distributed_trace_headers(headers) + with ExternalTrace("requests", "http://localhost:3000/", method="GET") as trace: + # Override terminal_node so we can create a nested exit span. + trace.terminal_node = lambda: False + trace.add_custom_attribute("custom", "bar") + foo() + + _test = override_application_settings( + { + "distributed_tracing.sampler.full_granularity.enabled": False, + "distributed_tracing.sampler.partial_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity.type": "unknown", + "distributed_tracing.sampler.partial_granularity._remote_parent_sampled": "always_on", + "span_events.enabled": True, + } + )(_test) + + _test() + + +@pytest.mark.parametrize( + "dt_settings,dt_headers,expected_sampling_instance_called,expected_adaptive_computed_count,expected_adaptive_sampled_count,expected_adaptive_sampling_target", + ( + ( + { + "distributed_tracing.sampler.full_granularity.enabled": False, + "distributed_tracing.sampler.partial_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity._root": "default", + "distributed_tracing.sampler.partial_granularity.root.adaptive.sampling_target": 5, + }, + {}, + (False, 0), + 1, + 1, + 5, + ), + ( + { + "distributed_tracing.sampler.full_granularity.enabled": False, + "distributed_tracing.sampler.partial_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity._remote_parent_sampled": "default", + "distributed_tracing.sampler.partial_granularity.remote_parent_sampled.adaptive.sampling_target": 5, + "distributed_tracing.sampler.partial_granularity._remote_parent_not_sampled": "default", + "distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled.adaptive.sampling_target": 6, + }, + {"traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"}, + (False, 1), + 1, + 1, + 5, + ), + ( + { + "distributed_tracing.sampler.full_granularity.enabled": False, + "distributed_tracing.sampler.partial_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity._remote_parent_sampled": "default", + "distributed_tracing.sampler.partial_granularity.remote_parent_sampled.adaptive.sampling_target": 5, + "distributed_tracing.sampler.partial_granularity._remote_parent_not_sampled": "default", + "distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled.adaptive.sampling_target": 6, + }, + {"traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-00"}, + (False, 2), + 1, + 1, + 6, + ), + ( + { + "distributed_tracing.sampler.full_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity.enabled": False, + "distributed_tracing.sampler._root": "default", + "distributed_tracing.sampler.root.adaptive.sampling_target": 5, + }, + {}, + (True, 0), + 1, + 1, + 5, + ), + ( + { + "distributed_tracing.sampler.full_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity.enabled": False, + "distributed_tracing.sampler._remote_parent_sampled": "default", + "distributed_tracing.sampler.remote_parent_sampled.adaptive.sampling_target": 5, + "distributed_tracing.sampler._remote_parent_not_sampled": "default", + "distributed_tracing.sampler.remote_parent_not_sampled.adaptive.sampling_target": 6, + }, + {"traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"}, + (True, 1), + 1, + 1, + 5, + ), + ( + { + "distributed_tracing.sampler.full_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity.enabled": False, + "distributed_tracing.sampler._remote_parent_sampled": "default", + "distributed_tracing.sampler.remote_parent_sampled.adaptive.sampling_target": 5, + "distributed_tracing.sampler._remote_parent_not_sampled": "default", + "distributed_tracing.sampler.remote_parent_not_sampled.adaptive.sampling_target": 6, + }, + {"traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-00"}, + (True, 2), + 1, + 1, + 6, + ), + ), +) +def test_distributed_trace_uses_adaptive_sampling_instance( + dt_settings, + dt_headers, + expected_sampling_instance_called, + expected_adaptive_computed_count, + expected_adaptive_sampled_count, + expected_adaptive_sampling_target, +): + test_settings = _override_settings.copy() + test_settings.update(dt_settings) + function_called_decorator = validate_function_called( + "newrelic.core.samplers.adaptive_sampler", "AdaptiveSampler.compute_sampled" + ) + + @function_called_decorator + @override_application_settings(test_settings) + @background_task(name="test_distributed_trace_attributes") + def _test(): + txn = current_transaction() + application = txn._application._agent._applications.get(txn.settings.app_name) + # Re-initialize sampler proxy after overriding settings. + application.sampler.__init__(txn.settings) + + accept_distributed_trace_headers(dt_headers) + # Explicitly call this so we can assert sampling decision during the transaction + # as opposed to after it ends and we lose the application context. + txn._make_sampling_decision() + + assert ( + application.sampler._samplers[expected_sampling_instance_called].computed_count + == expected_adaptive_computed_count + ) + assert ( + application.sampler._samplers[expected_sampling_instance_called].sampled_count + == expected_adaptive_sampled_count + ) + assert ( + application.sampler._samplers[expected_sampling_instance_called].sampling_target + == expected_adaptive_sampling_target + ) + + _test() + + +@pytest.mark.parametrize( + "dt_settings,dt_headers,expected_sampling_instance_called,expected_ratio", + ( + ( # Ratio for partial granularity does not exceed 1. + { + "distributed_tracing.sampler.full_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity.enabled": True, + "distributed_tracing.sampler.remote_parent_sampled.trace_id_ratio_based.ratio": 0.5, + "distributed_tracing.sampler._remote_parent_sampled": "trace_id_ratio_based", + "distributed_tracing.sampler.partial_granularity.remote_parent_sampled.trace_id_ratio_based.ratio": 0.7, + "distributed_tracing.sampler.partial_granularity._remote_parent_sampled": "trace_id_ratio_based", + }, + {"traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"}, + (False, 1), + 1, + ), + ( # Partial granularity ratio = full ratio + partial ratio. + { + "distributed_tracing.sampler.full_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity.enabled": True, + "distributed_tracing.sampler.remote_parent_sampled.trace_id_ratio_based.ratio": 0.5, + "distributed_tracing.sampler._remote_parent_sampled": "trace_id_ratio_based", + "distributed_tracing.sampler.partial_granularity.remote_parent_sampled.trace_id_ratio_based.ratio": 0.5, + "distributed_tracing.sampler.partial_granularity._remote_parent_sampled": "trace_id_ratio_based", + }, + {"traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"}, + (False, 1), + 1, + ), + ( # Trace ID ratio sampler is called for full granularity. + { + "distributed_tracing.sampler.full_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity.enabled": False, + "distributed_tracing.sampler.remote_parent_sampled.trace_id_ratio_based.ratio": 1, + "distributed_tracing.sampler._remote_parent_sampled": "trace_id_ratio_based", + }, + {"traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"}, + (True, 1), + 1, + ), + ), +) +def test_distributed_trace_uses_ratio_sampling_instance( + dt_settings, dt_headers, expected_sampling_instance_called, expected_ratio +): + test_settings = _override_settings.copy() + test_settings.update(dt_settings) + function_called_decorator = validate_function_called( + "newrelic.core.samplers.trace_id_ratio_based_sampler", "TraceIdRatioBasedSampler.compute_sampled" + ) + + @function_called_decorator + @override_application_settings(test_settings) + @background_task(name="test_distributed_trace_attributes") + def _test(): + txn = current_transaction() + application = txn._application._agent._applications.get(txn.settings.app_name) + # Re-initialize sampler proxy after overriding settings. + application.sampler.__init__(txn.settings) + + accept_distributed_trace_headers(dt_headers) + # Explicitly call this so we can assert sampling decision during the transaction + # as opposed to after it ends and we lose the application context. + txn._make_sampling_decision() + + assert application.sampler._samplers[expected_sampling_instance_called].ratio == expected_ratio + + _test() + + +@pytest.mark.parametrize( + "dt_settings,expected_priority,expected_sampled", + ( + ( # When dt is enabled but full and partial are disabled. + { + "distributed_tracing.sampler.full_granularity.enabled": False, + "distributed_tracing.sampler.partial_granularity.enabled": False, + }, + 0.123, # random + False, + ), + ( # When dt is disabled. + {"distributed_tracing.enabled": False}, + 0.123, # random + False, + ), + ( # Verify when full granularity sampled +2 is added to the priority. + {"distributed_tracing.sampler.root.trace_id_ratio_based.ratio": 1}, + 2.123, # random + 2 + True, + ), + ( # Verify when partial granularity sampled +1 is added to the priority. + { + "distributed_tracing.sampler.full_granularity.enabled": False, + "distributed_tracing.sampler.partial_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity.root.trace_id_ratio_based.ratio": 1, + }, + 1.123, # random + 1 + True, + ), + ), +) +def test_distributed_trace_enabled_settings_set_correct_sampled_priority( + dt_settings, expected_priority, expected_sampled, monkeypatch +): + monkeypatch.setattr(random, "random", lambda *args, **kwargs: 0.123) + + test_settings = _override_settings.copy() + test_settings.update(dt_settings) + + @override_application_settings(test_settings) + @validate_transaction_object_attributes({"sampled": expected_sampled, "priority": expected_priority}) + @background_task(name="test_distributed_trace_attributes") + def _test(): + pass + + _test() + + +def test_distributed_trace_priority_set_when_only_sampled_set_in_tracestate_header(monkeypatch): + monkeypatch.setattr(random, "random", lambda *args, **kwargs: 0.123) + + @override_application_settings(_override_settings) + @validate_transaction_object_attributes({"sampled": True, "priority": 2.123}) + @background_task() + def _test(): headers = { - "traceparent": f"00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-{int(sampled):02x}", - "tracestate": "rojo=f06a0ba902b7,congo=t61rcWkgMzE", + "traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01", + "tracestate": "1@nr=0-0-1-2827902-0af7651916cd43dd-00f067aa0ba902b7-1--1518469636035", + } + accept_distributed_trace_headers(headers) + + _test() + + +def test_partial_granularity_errors_on_compressed_spans(): + @function_trace() + def call_tests(): + with ExternalTrace("requests", "http://localhost:3000/", method="GET") as trace: + time.sleep(0.1) + transaction = current_transaction() + try: + raise Exception("Exception 1") + except: + transaction.notice_error() + with ExternalTrace("requests", "http://localhost:3000/", method="GET") as trace: + time.sleep(0.1) + with ExternalTrace("requests", "http://localhost:3000/", method="GET") as trace: + time.sleep(0.1) + transaction = current_transaction() + try: + raise Exception("Exception 2") + except: + transaction.notice_error(expected=True) + + @validate_span_events( + count=1, # Entry span. + exact_intrinsics={ + "name": "Function/test_distributed_tracing:test_partial_granularity_errors_on_compressed_spans.._test", + "nr.pg": True, + }, + expected_intrinsics=["duration", "timestamp"], + ) + @validate_span_events( + count=1, # 1 external compressed span. + exact_intrinsics={"name": "External/localhost:3000/requests/GET"}, + expected_intrinsics=["nr.durations", "nr.ids"], + exact_agents={ + "http.url": "http://localhost:3000/", + "error.class": callable_name(Exception), + "error.message": "Exception 2", + "error.expected": True, + }, + ) + @validate_compact_span_event( + name="External/localhost:3000/requests/GET", + compressed_span_count=3, + expected_nr_durations_low_bound=0.3, + expected_nr_durations_high_bound=0.4, + ) + @background_task() + def _test(): + headers = {"traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"} + accept_distributed_trace_headers(headers) + call_tests() + + _test = override_application_settings( + { + "distributed_tracing.sampler.full_granularity.enabled": False, + "distributed_tracing.sampler.partial_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity.type": "compact", + "distributed_tracing.sampler.partial_granularity._remote_parent_sampled": "always_on", + "span_events.enabled": True, } + )(_test) + + _test() + + +def test_partial_granularity_errors_on_compressed_spans_status_overriden(): + @function_trace() + def call_tests(): + transaction = current_transaction() + with ExternalTrace("requests", "http://localhost:3000/", method="GET") as trace: + time.sleep(0.1) + try: + raise Exception("Exception 1") + except: + transaction.notice_error(expected=True) + with ExternalTrace("requests", "http://localhost:3000/", method="GET") as trace: + time.sleep(0.1) + with ExternalTrace("requests", "http://localhost:3000/", method="GET") as trace: + time.sleep(0.1) + try: + raise Exception("Exception 2") + except: + transaction.notice_error() + + @validate_span_events( + count=1, # Entry span. + exact_intrinsics={ + "name": "Function/test_distributed_tracing:test_partial_granularity_errors_on_compressed_spans_status_overriden.._test", + "nr.pg": True, + }, + expected_intrinsics=["duration", "timestamp"], + ) + @validate_span_events( + count=1, # 1 external compressed span. + exact_intrinsics={"name": "External/localhost:3000/requests/GET"}, + expected_intrinsics=["nr.durations", "nr.ids"], + exact_agents={ + "http.url": "http://localhost:3000/", + "error.class": callable_name(Exception), + "error.message": "Exception 2", + "error.expected": False, + }, + ) + @validate_compact_span_event( + name="External/localhost:3000/requests/GET", + compressed_span_count=3, + expected_nr_durations_low_bound=0.3, + expected_nr_durations_high_bound=0.4, + ) + @background_task() + def _test(): + headers = {"traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01"} accept_distributed_trace_headers(headers) + call_tests() + + _test = override_application_settings( + { + "distributed_tracing.sampler.full_granularity.enabled": False, + "distributed_tracing.sampler.partial_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity.type": "compact", + "distributed_tracing.sampler.partial_granularity._remote_parent_sampled": "always_on", + "span_events.enabled": True, + } + )(_test) _test() diff --git a/tests/agent_features/test_event_loop_wait_time.py b/tests/agent_features/test_event_loop_wait_time.py index cad4679600..37e2bf9f33 100644 --- a/tests/agent_features/test_event_loop_wait_time.py +++ b/tests/agent_features/test_event_loop_wait_time.py @@ -27,6 +27,16 @@ from newrelic.core.trace_cache import trace_cache +@pytest.fixture +def event_loop(): + # Redefined fixture with function scope instead of session. + from asyncio import new_event_loop, set_event_loop + + loop = new_event_loop() + set_event_loop(loop) + return loop + + @background_task(name="block") async def block_loop(ready, done, blocking_transaction_active, times=1): for _ in range(times): @@ -64,8 +74,6 @@ async def wait_for_loop(ready, done, times=1): "blocking_transaction_active,event_loop_visibility_enabled", ((True, True), (False, True), (False, False)) ) def test_record_event_loop_wait(event_loop, blocking_transaction_active, event_loop_visibility_enabled): - # import asyncio - metric_count = 2 if event_loop_visibility_enabled else None execute_attributes = {"intrinsic": ("eventLoopTime",), "agent": (), "user": ()} wait_attributes = {"intrinsic": ("eventLoopWait",), "agent": (), "user": ()} @@ -143,8 +151,6 @@ def test_blocking_task_on_different_loop(): def test_record_event_loop_wait_on_different_task(event_loop): - # import asyncio - async def recorder(ready, wait): ready.set() await wait.wait() diff --git a/tests/agent_unittests/test_agent_connect.py b/tests/agent_unittests/test_agent_connect.py index a783faddcf..9a37f4ffc5 100644 --- a/tests/agent_unittests/test_agent_connect.py +++ b/tests/agent_unittests/test_agent_connect.py @@ -76,6 +76,26 @@ def test_ml_streaming_disabled_supportability_metrics(): assert app._active_session +@override_generic_settings( + SETTINGS, {"developer_mode": True, "distributed_tracing.sampler.partial_granularity.enabled": True} +) +@validate_internal_metrics( + [ + ("Supportability/Python/FullGranularity/Root/default", 1), + ("Supportability/Python/FullGranularity/RemoteParentSampled/default", 1), + ("Supportability/Python/FullGranularity/RemoteParentNotSampled/default", 1), + ("Supportability/Python/PartialGranularity/Root/default", 1), + ("Supportability/Python/PartialGranularity/RemoteParentSampled/default", 1), + ("Supportability/Python/PartialGranularity/RemoteParentNotSampled/default", 1), + ] +) +def test_sampler_supportability_metrics(): + app = Application("Python Agent Test (agent_unittests-connect)") + app.connect_to_data_collector(None) + + assert app._active_session + + @override_generic_settings(SETTINGS, {"developer_mode": True}) @validate_internal_metrics([("Supportability/AgentControl/Health/enabled", 1)]) def test_agent_control_health_supportability_metric(monkeypatch, tmp_path): diff --git a/tests/agent_unittests/test_agent_protocol.py b/tests/agent_unittests/test_agent_protocol.py index e6f0a04af3..8d9e353978 100644 --- a/tests/agent_unittests/test_agent_protocol.py +++ b/tests/agent_unittests/test_agent_protocol.py @@ -278,10 +278,11 @@ def connect_payload_asserts( assert len(payload_data["security_settings"]) == 2 assert payload_data["security_settings"]["capture_params"] == CAPTURE_PARAMS assert payload_data["security_settings"]["transaction_tracer"] == {"record_sql": RECORD_SQL} - assert len(payload_data["settings"]) == 3 + assert len(payload_data["settings"]) == 4 assert payload_data["settings"]["browser_monitoring.loader"] == (BROWSER_MONITORING_LOADER) assert payload_data["settings"]["browser_monitoring.debug"] == (BROWSER_MONITORING_DEBUG) assert payload_data["settings"]["ai_monitoring.enabled"] is False + assert payload_data["settings"]["distributed_tracing.sampler.adaptive_sampling_target"] == 10 utilization_len = 5 diff --git a/tests/agent_unittests/test_distributed_tracing_settings.py b/tests/agent_unittests/test_distributed_tracing_settings.py index a1c99da58d..0a65d566d5 100644 --- a/tests/agent_unittests/test_distributed_tracing_settings.py +++ b/tests/agent_unittests/test_distributed_tracing_settings.py @@ -14,6 +14,8 @@ import pytest +from newrelic.core.config import finalize_application_settings + INI_FILE_EMPTY = b""" [newrelic] """ @@ -24,9 +26,348 @@ distributed_tracing.exclude_newrelic_header = true """ +INI_FILE_FULL_GRAN_CONFLICTS_ADAPTIVE = b""" +[newrelic] +distributed_tracing.sampler.remote_parent_sampled = always_on +distributed_tracing.sampler.remote_parent_not_sampled = always_off +distributed_tracing.sampler.root.adaptive.sampling_target = 5 +distributed_tracing.sampler.remote_parent_sampled.adaptive.sampling_target = 10 +distributed_tracing.sampler.remote_parent_not_sampled.adaptive.sampling_target = 20 +""" + +INI_FILE_FULL_GRAN_CONFLICTS_RATIO = b""" +[newrelic] +distributed_tracing.sampler.root = always_on +distributed_tracing.sampler.remote_parent_sampled = always_on +distributed_tracing.sampler.remote_parent_not_sampled = always_off +distributed_tracing.sampler.root.trace_id_ratio_based.ratio = .5 +distributed_tracing.sampler.remote_parent_sampled.trace_id_ratio_based.ratio = .1 +distributed_tracing.sampler.remote_parent_not_sampled.trace_id_ratio_based.ratio = .2 +""" + +INI_FILE_FULL_GRAN_MULTIPLE_SAMPLERS_INVALID_RATIO = b""" +[newrelic] +distributed_tracing.sampler.root.adaptive.sampling_target = 5 +distributed_tracing.sampler.remote_parent_sampled.adaptive.sampling_target = 10 +distributed_tracing.sampler.remote_parent_not_sampled.adaptive.sampling_target = 20 +distributed_tracing.sampler.root.trace_id_ratio_based.sampling_target = 5 +distributed_tracing.sampler.remote_parent_sampled.trace_id_ratio_based.sampling_target = 10 +distributed_tracing.sampler.remote_parent_not_sampled.trace_id_ratio_based.sampling_target = 20 +""" + +INI_FILE_FULL_GRAN_NO_RATIO = b""" +[newrelic] +distributed_tracing.sampler.root = trace_id_ratio_based +distributed_tracing.sampler.remote_parent_sampled = trace_id_ratio_based +distributed_tracing.sampler.remote_parent_not_sampled = trace_id_ratio_based +""" + +INI_FILE_FULL_GRAN_MULTIPLE_VALID_SAMPLERS = b""" +[newrelic] +distributed_tracing.sampler.root.adaptive.sampling_target = 5 +distributed_tracing.sampler.remote_parent_sampled.adaptive.sampling_target = 10 +distributed_tracing.sampler.remote_parent_not_sampled.adaptive.sampling_target = 20 +distributed_tracing.sampler.root.trace_id_ratio_based.ratio = .5 +distributed_tracing.sampler.remote_parent_sampled.trace_id_ratio_based.ratio = .1 +distributed_tracing.sampler.remote_parent_not_sampled.trace_id_ratio_based.ratio = .2 +""" + +INI_FILE_PARTIAL_GRAN_NO_RATIO = b""" +[newrelic] +distributed_tracing.sampler.partial_granularity.root = trace_id_ratio_based +distributed_tracing.sampler.partial_granularity.remote_parent_sampled = trace_id_ratio_based +distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled = trace_id_ratio_based +""" + +INI_FILE_PARTIAL_GRAN_CONFLICTS_ADAPTIVE = b""" +[newrelic] +distributed_tracing.sampler.partial_granularity.remote_parent_sampled = always_on +distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled = always_off +distributed_tracing.sampler.partial_granularity.root.adaptive.sampling_target = 5 +distributed_tracing.sampler.partial_granularity.remote_parent_sampled.adaptive.sampling_target = 10 +distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled.adaptive.sampling_target = 20 +""" + +INI_FILE_PARTIAL_GRAN_CONFLICTS_RATIO = b""" +[newrelic] +distributed_tracing.sampler.partial_granularity.remote_parent_sampled = always_on +distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled = always_off +distributed_tracing.sampler.partial_granularity.root.trace_id_ratio_based.ratio = .5 +distributed_tracing.sampler.partial_granularity.remote_parent_sampled.trace_id_ratio_based.ratio = .1 +distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled.trace_id_ratio_based.ratio = .2 +""" + +INI_FILE_PARTIAL_GRAN_MULTIPLE_SAMPLERS = b""" +[newrelic] +distributed_tracing.sampler.partial_granularity.root.adaptive.sampling_target = 5 +distributed_tracing.sampler.partial_granularity.remote_parent_sampled.adaptive.sampling_target = 10 +distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled.adaptive.sampling_target = 20 +distributed_tracing.sampler.partial_granularity.root.trace_id_ratio_based.sampling_target = 5 +distributed_tracing.sampler.partial_granularity.remote_parent_sampled.trace_id_ratio_based.sampling_target = 10 +distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled.trace_id_ratio_based.sampling_target = 20 +""" + # Tests for loading settings and testing for values precedence @pytest.mark.parametrize("ini,env,expected_format", ((INI_FILE_EMPTY, {}, False), (INI_FILE_W3C, {}, True))) def test_distributed_trace_setings(ini, env, expected_format, global_settings): settings = global_settings() assert settings.distributed_tracing.exclude_newrelic_header == expected_format + + +@pytest.mark.parametrize( + "ini,env,expected", + ( + ( # Defaults to adaptive (default) sampler. + INI_FILE_EMPTY, + {}, + ("default", "default", "default", None, None, None), + ), + ( # More specific sampler path overrides less specific path in ini file. + INI_FILE_FULL_GRAN_CONFLICTS_ADAPTIVE, + {}, + ("adaptive", "adaptive", "adaptive", 5, 10, 20), + ), + ( # More specific sampler path overrides less specific path in ini file. + INI_FILE_FULL_GRAN_CONFLICTS_RATIO, + {}, + ("trace_id_ratio_based", "trace_id_ratio_based", "trace_id_ratio_based", 0.5, 0.1, 0.2), + ), + ( # ini file configuration takes precedence over env vars. + INI_FILE_FULL_GRAN_CONFLICTS_ADAPTIVE, + { + "NEW_RELIC_ENABLED": "true", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_ROOT_ADAPTIVE_SAMPLING_TARGET": "50", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_SAMPLED_ADAPTIVE_SAMPLING_TARGET": "50", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_NOT_SAMPLED_ADAPTIVE_SAMPLING_TARGET": "30", + }, + ("adaptive", "adaptive", "adaptive", 5, 10, 20), + ), + ( # Simple configuration works. + INI_FILE_EMPTY, + { + "NEW_RELIC_ENABLED": "true", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_ROOT": "always_on", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_SAMPLED": "always_on", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_NOT_SAMPLED": "always_off", + }, + ("always_on", "always_on", "always_off", None, None, None), + ), + ( # More specific sampler path overrides less specific path in env vars. + INI_FILE_EMPTY, + { + "NEW_RELIC_ENABLED": "true", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_ROOT": "always_on", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_SAMPLED": "always_on", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_NOT_SAMPLED": "always_off", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_ROOT_ADAPTIVE_SAMPLING_TARGET": "20", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_SAMPLED_ADAPTIVE_SAMPLING_TARGET": "20", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_NOT_SAMPLED_ADAPTIVE_SAMPLING_TARGET": "20", + }, + ("adaptive", "adaptive", "adaptive", 20, 20, 20), + ), + ( # Ratio takes precendence over adaptive in env vars. + INI_FILE_EMPTY, + { + "NEW_RELIC_ENABLED": "true", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_ROOT": "always_on", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_SAMPLED": "always_on", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_NOT_SAMPLED": "always_off", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_ROOT_ADAPTIVE_SAMPLING_TARGET": "20", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_SAMPLED_ADAPTIVE_SAMPLING_TARGET": "20", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_NOT_SAMPLED_ADAPTIVE_SAMPLING_TARGET": "20", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_ROOT_TRACE_ID_RATIO_BASED_RATIO": ".5", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_SAMPLED_TRACE_ID_RATIO_BASED_RATIO": ".1", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_NOT_SAMPLED_TRACE_ID_RATIO_BASED_RATIO": ".2", + }, + ("trace_id_ratio_based", "trace_id_ratio_based", "trace_id_ratio_based", 0.5, 0.1, 0.2), + ), + ( # Falls back on adaptive when invalid ratio. + INI_FILE_EMPTY, + { + "NEW_RELIC_ENABLED": "true", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_ROOT_TRACE_ID_RATIO_BASED_RATIO": "5", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_SAMPLED_TRACE_ID_RATIO_BASED_RATIO": "10", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_REMOTE_PARENT_NOT_SAMPLED_TRACE_ID_RATIO_BASED_RATIO": "0", + }, + ("default", "default", "default", None, None, None), + ), + ( # Ignores ratio sampler when invalid ratio path is provided. + INI_FILE_FULL_GRAN_MULTIPLE_SAMPLERS_INVALID_RATIO, + {}, + ("adaptive", "adaptive", "adaptive", 5, 10, 20), + ), + ( # Ignores ratio sampler when ratio is not defined. + INI_FILE_FULL_GRAN_NO_RATIO, + {}, + ("default", "default", "default", None, None, None), + ), + ( # Ratio takes precedence over adaptive. + INI_FILE_FULL_GRAN_MULTIPLE_VALID_SAMPLERS, + {}, + ("trace_id_ratio_based", "trace_id_ratio_based", "trace_id_ratio_based", 0.5, 0.1, 0.2), + ), + ), +) +def test_full_granularity_precedence(ini, env, global_settings, expected): + settings = global_settings() + + app_settings = finalize_application_settings(settings=settings) + + assert app_settings.distributed_tracing.sampler._root == expected[0] + assert app_settings.distributed_tracing.sampler._remote_parent_sampled == expected[1] + assert app_settings.distributed_tracing.sampler._remote_parent_not_sampled == expected[2] + if expected[0] == "trace_id_ratio_based": + assert app_settings.distributed_tracing.sampler.root.trace_id_ratio_based.ratio == expected[3] + else: + assert app_settings.distributed_tracing.sampler.root.adaptive.sampling_target == expected[3] + if expected[1] == "trace_id_ratio_based": + assert app_settings.distributed_tracing.sampler.remote_parent_sampled.trace_id_ratio_based.ratio == expected[4] + else: + assert app_settings.distributed_tracing.sampler.remote_parent_sampled.adaptive.sampling_target == expected[4] + if expected[2] == "trace_id_ratio_based": + assert ( + app_settings.distributed_tracing.sampler.remote_parent_not_sampled.trace_id_ratio_based.ratio == expected[5] + ) + else: + assert ( + app_settings.distributed_tracing.sampler.remote_parent_not_sampled.adaptive.sampling_target == expected[5] + ) + + +@pytest.mark.parametrize( + "ini,env,expected", + ( + ( # Defaults to adaptive (default) sampler. + INI_FILE_EMPTY, + {}, + ("default", "default", "default", None, None, None), + ), + ( # More specific sampler path overrides less specific path in ini file. + INI_FILE_PARTIAL_GRAN_CONFLICTS_ADAPTIVE, + {}, + ("adaptive", "adaptive", "adaptive", 5, 10, 20), + ), + ( # More specific sampler path overrides less specific path in ini file. + INI_FILE_PARTIAL_GRAN_CONFLICTS_RATIO, + {}, + ("trace_id_ratio_based", "trace_id_ratio_based", "trace_id_ratio_based", 0.5, 0.1, 0.2), + ), + ( # ini config takes precedence over env vars. + INI_FILE_PARTIAL_GRAN_CONFLICTS_ADAPTIVE, + { + "NEW_RELIC_ENABLED": "true", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_SAMPLED": "always_on", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_NOT_SAMPLED": "always_off", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_SAMPLED_ADAPTIVE_SAMPLING_TARGET": "20", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_NOT_SAMPLED_ADAPTIVE_SAMPLING_TARGET": "30", + }, + ("adaptive", "adaptive", "adaptive", 5, 10, 20), + ), + ( # Simple configuration works. + INI_FILE_EMPTY, + { + "NEW_RELIC_ENABLED": "true", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_ROOT": "always_on", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_SAMPLED": "always_on", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_NOT_SAMPLED": "always_off", + }, + ("always_on", "always_on", "always_off", None, None, None), + ), + ( # Ignores ratio if ratio is not defined. + INI_FILE_EMPTY, + { + "NEW_RELIC_ENABLED": "true", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_ROOT": "trace_id_ratio_based", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_SAMPLED": "trace_id_ratio_based", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_NOT_SAMPLED": "trace_id_ratio_based", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_NOT_SAMPLED_TRACE_ID_RATIO_BASED_RATIO": ".1", + }, + ("default", "default", "trace_id_ratio_based", None, None, 0.1), + ), + ( # More specific sampler path overrides less specific path in env vars. + INI_FILE_EMPTY, + { + "NEW_RELIC_ENABLED": "true", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_ROOT": "always_on", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_SAMPLED": "always_on", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_NOT_SAMPLED": "always_off", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_ROOT_ADAPTIVE_SAMPLING_TARGET": "5", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_SAMPLED_ADAPTIVE_SAMPLING_TARGET": "10", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_NOT_SAMPLED_ADAPTIVE_SAMPLING_TARGET": "20", + }, + ("adaptive", "adaptive", "adaptive", 5, 10, 20), + ), + ( # Ratio takes precedence over adaptive in env vars. + INI_FILE_EMPTY, + { + "NEW_RELIC_ENABLED": "true", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_ROOT": "always_on", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_SAMPLED": "always_on", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_NOT_SAMPLED": "always_off", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_ROOT_ADAPTIVE_SAMPLING_TARGET": "5", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_SAMPLED_ADAPTIVE_SAMPLING_TARGET": "10", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_NOT_SAMPLED_ADAPTIVE_SAMPLING_TARGET": "20", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_ROOT_TRACE_ID_RATIO_BASED_RATIO": ".5", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_SAMPLED_TRACE_ID_RATIO_BASED_RATIO": ".1", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_NOT_SAMPLED_TRACE_ID_RATIO_BASED_RATIO": ".2", + }, + ("trace_id_ratio_based", "trace_id_ratio_based", "trace_id_ratio_based", 0.5, 0.1, 0.2), + ), + ( # Ignores other unknown samplers. + INI_FILE_PARTIAL_GRAN_MULTIPLE_SAMPLERS, + {}, + ("adaptive", "adaptive", "adaptive", 5, 10, 20), + ), + ( # Ignores ratio sampler when ratio is not defined. + INI_FILE_PARTIAL_GRAN_NO_RATIO, + {}, + ("default", "default", "default", None, None, None), + ), + ( # Falls back on adaptive when invalid ratio. + INI_FILE_EMPTY, + { + "NEW_RELIC_ENABLED": "true", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_ROOT_TRACE_ID_RATIO_BASED_RATIO": "5", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_SAMPLED_TRACE_ID_RATIO_BASED_RATIO": "10", + "NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_REMOTE_PARENT_NOT_SAMPLED_TRACE_ID_RATIO_BASED_RATIO": "0", + }, + ("default", "default", "default", None, None, None), + ), + ), +) +def test_partial_granularity_precedence(ini, env, global_settings, expected): + settings = global_settings() + + app_settings = finalize_application_settings(settings=settings) + + assert app_settings.distributed_tracing.sampler.partial_granularity._root == expected[0] + assert app_settings.distributed_tracing.sampler.partial_granularity._remote_parent_sampled == expected[1] + assert app_settings.distributed_tracing.sampler.partial_granularity._remote_parent_not_sampled == expected[2] + if expected[0] == "trace_id_ratio_based": + assert ( + app_settings.distributed_tracing.sampler.partial_granularity.root.trace_id_ratio_based.ratio == expected[3] + ) + else: + assert app_settings.distributed_tracing.sampler.partial_granularity.root.adaptive.sampling_target == expected[3] + + if expected[1] == "trace_id_ratio_based": + assert ( + app_settings.distributed_tracing.sampler.partial_granularity.remote_parent_sampled.trace_id_ratio_based.ratio + == expected[4] + ) + else: + assert ( + app_settings.distributed_tracing.sampler.partial_granularity.remote_parent_sampled.adaptive.sampling_target + == expected[4] + ) + if expected[2] == "trace_id_ratio_based": + assert ( + app_settings.distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled.trace_id_ratio_based.ratio + == expected[5] + ) + else: + assert ( + app_settings.distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled.adaptive.sampling_target + == expected[5] + ) diff --git a/tests/agent_unittests/test_harvest_loop.py b/tests/agent_unittests/test_harvest_loop.py index 9717e956ba..e90cacf9d2 100644 --- a/tests/agent_unittests/test_harvest_loop.py +++ b/tests/agent_unittests/test_harvest_loop.py @@ -27,6 +27,7 @@ from newrelic.core.config import finalize_application_settings, global_settings from newrelic.core.custom_event import create_custom_event from newrelic.core.error_node import ErrorNode +from newrelic.core.external_node import ExternalNode from newrelic.core.function_node import FunctionNode from newrelic.core.log_event_node import LogEventNode from newrelic.core.root_node import RootNode @@ -39,135 +40,162 @@ @pytest.fixture(scope="module") def transaction_node(request): - default_capacity = SampledDataSet().capacity - num_events = default_capacity + 1 - - custom_events = SampledDataSet(capacity=num_events) - for _ in range(num_events): - event = create_custom_event("Custom", {}) - custom_events.add(event) - - ml_events = SampledDataSet(capacity=num_events) - for _ in range(num_events): - event = create_custom_event("Custom", {}) - ml_events.add(event) - - log_events = SampledDataSet(capacity=num_events) - for _ in range(num_events): - event = LogEventNode(1653609717, "WARNING", "A", {}) - log_events.add(event) - - error = ErrorNode( - timestamp=0, - type="foo:bar", - message="oh no! your foo had a bar", - expected=False, - span_id=None, - stack_trace="", - error_group_name=None, - custom_params={}, - source=None, - ) - - errors = tuple(error for _ in range(num_events)) - - function = FunctionNode( - group="Function", - name="foo", - children=(), - start_time=0, - end_time=1, - duration=1, - exclusive=1, - label=None, - params=None, - rollup=None, - guid="GUID", - agent_attributes={}, - user_attributes={}, - ) - - children = tuple(function for _ in range(num_events)) - - root = RootNode( - name="Function/main", - children=children, - start_time=1524764430.0, - end_time=1524764430.1, - duration=0.1, - exclusive=0.1, - guid=None, - agent_attributes={}, - user_attributes={}, - path="OtherTransaction/Function/main", - trusted_parent_span=None, - tracing_vendors=None, - ) - - node = TransactionNode( - settings=finalize_application_settings({"agent_run_id": "1234567"}), - path="OtherTransaction/Function/main", - type="OtherTransaction", - group="Function", - base_name="main", - name_for_metric="Function/main", - port=None, - request_uri=None, - queue_start=0.0, - start_time=1524764430.0, - end_time=1524764430.1, - last_byte_time=0.0, - total_time=0.1, - response_time=0.1, - duration=0.1, - exclusive=0.1, - root=root, - errors=errors, - slow_sql=(), - custom_events=custom_events, - ml_events=ml_events, - log_events=log_events, - apdex_t=0.5, - suppress_apdex=False, - custom_metrics=CustomMetrics(), - dimensional_metrics=DimensionalMetrics(), - guid="4485b89db608aece", - cpu_time=0.0, - suppress_transaction_trace=False, - client_cross_process_id=None, - referring_transaction_guid=None, - record_tt=False, - synthetics_resource_id=None, - synthetics_job_id=None, - synthetics_monitor_id=None, - synthetics_header=None, - synthetics_type=None, - synthetics_initiator=None, - synthetics_attributes=None, - synthetics_info_header=None, - is_part_of_cat=False, - trip_id="4485b89db608aece", - path_hash=None, - referring_path_hash=None, - alternate_path_hashes=[], - trace_intrinsics={}, - distributed_trace_intrinsics={}, - agent_attributes=[], - user_attributes=[], - priority=1.0, - parent_transport_duration=None, - parent_span=None, - parent_type=None, - parent_account=None, - parent_app=None, - parent_tx=None, - parent_transport_type=None, - sampled=True, - root_span_guid=None, - trace_id="4485b89db608aece", - loop_time=0.0, - ) - return node + def _transaction_node(partial_granularity=False): + default_capacity = SampledDataSet().capacity + num_events = default_capacity + 1 + + custom_events = SampledDataSet(capacity=num_events) + for _ in range(num_events): + event = create_custom_event("Custom", {}) + custom_events.add(event) + + ml_events = SampledDataSet(capacity=num_events) + for _ in range(num_events): + event = create_custom_event("Custom", {}) + ml_events.add(event) + + log_events = SampledDataSet(capacity=num_events) + for _ in range(num_events): + event = LogEventNode(1653609717, "WARNING", "A", {}) + log_events.add(event) + + error = ErrorNode( + timestamp=0, + type="foo:bar", + message="oh no! your foo had a bar", + expected=False, + span_id=None, + stack_trace="", + error_group_name=None, + custom_params={}, + source=None, + ) + + errors = tuple(error for _ in range(num_events)) + + function = FunctionNode( + group="Function", + name="foo", + children=(), + start_time=0, + end_time=1, + duration=1, + exclusive=1, + label=None, + params=None, + rollup=None, + guid="GUID", + agent_attributes={}, + user_attributes={}, + span_link_events=None, + span_event_events=None, + ) + + children = [function for _ in range(num_events)] + + function = ExternalNode( + library="requests", + url="http:localhost:3000", + method="GET", + children=(), + start_time=0, + end_time=1, + duration=1, + exclusive=1, + params={}, + guid="GUID", + agent_attributes={}, + user_attributes={}, + span_link_events=None, + span_event_events=None, + ) + + children.extend([function for _ in range(num_events)]) + + root = RootNode( + name="Function/main", + children=children, + start_time=1524764430.0, + end_time=1524764430.1, + duration=0.1, + exclusive=0.1, + guid=None, + agent_attributes={}, + user_attributes={}, + path="OtherTransaction/Function/main", + trusted_parent_span=None, + tracing_vendors=None, + span_link_events=None, + span_event_events=None, + ) + + node = TransactionNode( + settings=finalize_application_settings({"agent_run_id": "1234567"}), + path="OtherTransaction/Function/main", + type="OtherTransaction", + group="Function", + base_name="main", + name_for_metric="Function/main", + port=None, + request_uri=None, + queue_start=0.0, + start_time=1524764430.0, + end_time=1524764430.1, + last_byte_time=0.0, + total_time=0.1, + response_time=0.1, + duration=0.1, + exclusive=0.1, + root=root, + errors=errors, + slow_sql=(), + custom_events=custom_events, + ml_events=ml_events, + log_events=log_events, + apdex_t=0.5, + suppress_apdex=False, + custom_metrics=CustomMetrics(), + dimensional_metrics=DimensionalMetrics(), + guid="4485b89db608aece", + cpu_time=0.0, + suppress_transaction_trace=False, + client_cross_process_id=None, + referring_transaction_guid=None, + record_tt=False, + synthetics_resource_id=None, + synthetics_job_id=None, + synthetics_monitor_id=None, + synthetics_header=None, + synthetics_type=None, + synthetics_initiator=None, + synthetics_attributes=None, + synthetics_info_header=None, + is_part_of_cat=False, + trip_id="4485b89db608aece", + path_hash=None, + referring_path_hash=None, + alternate_path_hashes=[], + trace_intrinsics={}, + distributed_trace_intrinsics={}, + agent_attributes=[], + user_attributes=[], + priority=1.0, + parent_transport_duration=None, + parent_span=None, + parent_type=None, + parent_account=None, + parent_app=None, + parent_tx=None, + parent_transport_type=None, + sampled=True, + root_span_guid=None, + trace_id="4485b89db608aece", + loop_time=0.0, + partial_granularity_sampled=partial_granularity, + ) + return node + + return _transaction_node def validate_metric_payload(metrics=None, endpoints_called=None): @@ -321,14 +349,32 @@ def test_serverless_application_harvest(): @pytest.mark.parametrize( - "distributed_tracing_enabled,span_events_enabled,spans_created", - [(True, True, 1), (True, True, 15), (True, False, 1), (True, True, 0), (True, False, 0), (False, True, 0)], + "distributed_tracing_enabled,full_granularity_enabled,partial_granularity_enabled,span_events_enabled,spans_created", + [ + (True, True, False, True, 1), + (True, True, True, True, 1), + (True, True, False, True, 15), + (True, True, False, False, 1), + (True, True, False, True, 0), + (True, True, False, False, 0), + (False, True, False, True, 0), + ], ) -def test_application_harvest_with_spans(distributed_tracing_enabled, span_events_enabled, spans_created): +def test_application_harvest_with_spans( + distributed_tracing_enabled, + full_granularity_enabled, + partial_granularity_enabled, + span_events_enabled, + spans_created, +): span_endpoints_called = [] max_samples_stored = 10 - if distributed_tracing_enabled and span_events_enabled: + if ( + distributed_tracing_enabled + and span_events_enabled + and (full_granularity_enabled or partial_granularity_enabled) + ): seen = spans_created sent = min(spans_created, max_samples_stored) else: @@ -348,6 +394,8 @@ def test_application_harvest_with_spans(distributed_tracing_enabled, span_events "developer_mode": True, "license_key": "**NOT A LICENSE KEY**", "distributed_tracing.enabled": distributed_tracing_enabled, + "distributed_tracing.sampler.full_granularity.enabled": full_granularity_enabled, + "distributed_tracing.sampler.partial_granularity.enabled": partial_granularity_enabled, "span_events.enabled": span_events_enabled, # Uses the name from post-translation as this is modifying the settings object, not a config file "event_harvest_config.harvest_limits.span_event_data": max_samples_stored, @@ -366,12 +414,12 @@ def _test(): # Verify that the metric_data endpoint is the 2nd to last and # span_event_data is the 3rd to last endpoint called - assert span_endpoints_called[-2] == "metric_data" + assert span_endpoints_called[-2] == "metric_data", span_endpoints_called if span_events_enabled and spans_created > 0: - assert span_endpoints_called[-3] == "span_event_data" + assert span_endpoints_called[-3] == "span_event_data", span_endpoints_called else: - assert span_endpoints_called[-3] != "span_event_data" + assert span_endpoints_called[-3] != "span_event_data", span_endpoints_called _test() @@ -451,10 +499,11 @@ def _test(): }, ) def test_transaction_count(transaction_node): + txn_node = transaction_node() app = Application("Python Agent Test (Harvest Loop)") app.connect_to_data_collector(None) - app.record_transaction(transaction_node) + app.record_transaction(txn_node) # Harvest has not run yet assert app._transaction_count == 1 @@ -465,9 +514,47 @@ def test_transaction_count(transaction_node): assert app._transaction_count == 0 # Record a transaction - app.record_transaction(transaction_node) + app.record_transaction(txn_node) + assert app._transaction_count == 1 + + app.harvest() + + # Harvest resets the transaction count + assert app._transaction_count == 0 + + +@override_generic_settings( + settings, + { + "developer_mode": True, + "license_key": "**NOT A LICENSE KEY**", + "feature_flag": set(), + "collect_custom_events": False, + "application_logging.forwarding.enabled": False, + "distributed_tracing.sampler.full_granularity.enabled": False, + "distributed_tracing.sampler.partial_granularity.enabled": True, + "distributed_tracing.sampler.partial_granularity.type": "compact", + }, +) +def test_partial_granularity_metrics(transaction_node): + txn_node = transaction_node(True) + app = Application("Python Agent Test (Harvest Loop)") + app.connect_to_data_collector(None) + + app.record_transaction(txn_node) + + # Harvest has not run yet assert app._transaction_count == 1 + instrumented = "Supportability/DistributedTrace/PartialGranularity/compact/Span/Instrumented" + kept = "Supportability/DistributedTrace/PartialGranularity/compact/Span/Kept" + pg = "Supportability/Python/PartialGranularity/compact" + dropped_ids = "Supportability/Python/PartialGranularity/NrIds/Dropped" + assert app._stats_engine.stats_table[(instrumented, "")][0] == 203 + assert app._stats_engine.stats_table[(kept, "")][0] == 2 + assert app._stats_engine.stats_table[(pg, "")][0] == 1 + assert app._stats_engine.stats_table[(dropped_ids, "")][0] == 37 + app.harvest() # Harvest resets the transaction count @@ -478,18 +565,19 @@ def test_transaction_count(transaction_node): settings, {"developer_mode": True, "license_key": "**NOT A LICENSE KEY**", "feature_flag": set()} ) def test_adaptive_sampling(transaction_node, monkeypatch): + txn_node = transaction_node() app = Application("Python Agent Test (Harvest Loop)") # Should always return false for sampling prior to connect - assert app.compute_sampled() is False + assert app.compute_sampled(True, 0) is False app.connect_to_data_collector(None) # First harvest, first N should be sampled for _ in range(settings.sampling_target): - assert app.compute_sampled() is True + assert app.compute_sampled(True, 0) is True - assert app.compute_sampled() is False + assert app.compute_sampled(True, 0) is False # fix random.randrange to return 0 monkeypatch.setattr(random, "randrange", lambda *args, **kwargs: 0) @@ -497,14 +585,14 @@ def test_adaptive_sampling(transaction_node, monkeypatch): # Multiple resets should behave the same for _ in range(2): # Set the last_reset to longer than the period so a reset will occur. - app.adaptive_sampler.last_reset = time.time() - app.adaptive_sampler.period + app.sampler.get_sampler(True, 0).last_reset = time.time() - app.sampler.get_sampler(True, 0).period # Subsequent harvests should allow sampling of 2X the target for _ in range(2 * settings.sampling_target): - assert app.compute_sampled() is True + assert app.compute_sampled(True, 0) is True # No further samples should be saved - assert app.compute_sampled() is False + assert app.compute_sampled(True, 0) is False @override_generic_settings( @@ -522,11 +610,12 @@ def test_adaptive_sampling(transaction_node, monkeypatch): }, ) def test_reservoir_sizes(transaction_node): + txn_node = transaction_node() app = Application("Python Agent Test (Harvest Loop)") app.connect_to_data_collector(None) # Record a transaction with events - app.record_transaction(transaction_node) + app.record_transaction(txn_node) # Test that the samples have been recorded assert app._stats_engine.custom_events.num_samples == 101 @@ -534,7 +623,7 @@ def test_reservoir_sizes(transaction_node): assert app._stats_engine.log_events.num_samples == 101 # Add 1 for the root span - assert app._stats_engine.span_events.num_samples == 102 + assert app._stats_engine.span_events.num_samples == 203 @pytest.mark.parametrize( @@ -647,20 +736,20 @@ def test_serverless_mode_adaptive_sampling(time_to_next_reset, computed_count, c app = Application("Python Agent Test (Harvest Loop)") app.connect_to_data_collector(None) - app.adaptive_sampler.computed_count = 123 - app.adaptive_sampler.last_reset = time.time() - 60 + time_to_next_reset + app.sampler.get_sampler(True, 0).computed_count = 123 + app.sampler.get_sampler(True, 0).last_reset = time.time() - 60 + time_to_next_reset - assert app.compute_sampled() is True - assert app.adaptive_sampler.computed_count == computed_count - assert app.adaptive_sampler.computed_count_last == computed_count_last + assert app.compute_sampled(True, 0) is True + assert app.sampler.get_sampler(True, 0).computed_count == computed_count + assert app.sampler.get_sampler(True, 0).computed_count_last == computed_count_last -@validate_function_not_called("newrelic.core.adaptive_sampler", "AdaptiveSampler._reset") +@validate_function_not_called("newrelic.core.samplers.adaptive_sampler", "AdaptiveSampler._reset") @override_generic_settings(settings, {"developer_mode": True}) def test_compute_sampled_no_reset(): app = Application("Python Agent Test (Harvest Loop)") app.connect_to_data_collector(None) - assert app.compute_sampled() is True + assert app.compute_sampled(True, 0) is True def test_analytic_event_sampling_info(): diff --git a/tests/agent_unittests/test_infinite_trace_settings.py b/tests/agent_unittests/test_infinite_trace_settings.py index 4b47a72398..31c8e6819e 100644 --- a/tests/agent_unittests/test_infinite_trace_settings.py +++ b/tests/agent_unittests/test_infinite_trace_settings.py @@ -14,6 +14,8 @@ import pytest +from newrelic.core.config import finalize_application_settings + INI_FILE_EMPTY = b""" [newrelic] """ @@ -77,3 +79,18 @@ def test_infinite_tracing_port(ini, env, expected_port, global_settings): def test_infinite_tracing_span_queue_size(ini, env, expected_size, global_settings): settings = global_settings() assert settings.infinite_tracing.span_queue_size == expected_size + + +@pytest.mark.parametrize( + "ini,env", + ((INI_FILE_INFINITE_TRACING, {"NEW_RELIC_DISTRIBUTED_TRACING_SAMPLER_PARTIAL_GRANULARITY_ENABLED": "true"}),), +) +def test_partial_granularity_dissabled_when_infinite_tracing_enabled(ini, env, global_settings): + settings = global_settings() + assert settings.distributed_tracing.sampler.partial_granularity.enabled + assert settings.infinite_tracing.enabled + + app_settings = finalize_application_settings(settings=settings) + + assert not app_settings.distributed_tracing.sampler.partial_granularity.enabled + assert app_settings.infinite_tracing.enabled diff --git a/tests/cross_agent/fixtures/distributed_tracing/README.md b/tests/cross_agent/fixtures/distributed_tracing/README.md index 0090d527a0..c49f614852 100644 --- a/tests/cross_agent/fixtures/distributed_tracing/README.md +++ b/tests/cross_agent/fixtures/distributed_tracing/README.md @@ -1,59 +1,3 @@ -# Distributed Tracing Cross Agent Tests - -The `distributed_tracing.json` file included here is our local copy of the -Better Better CAT CAT [tests](https://source.datanerd.us/agents/cross_agent_tests/pull/96/files). - -The tests in json format and is a list of dictionaries, each dictionary -representing one test. - -## Required fields - -Each test will include these fields: - -+ `test_name`: A string representing the test name. -+ `comment`: String; optional field. Describes the test. -+ `inbound_payloads`: List representing distributed trace payloads as described - in the spec. AcceptDistributedTracePayload should be called with each payload - in turn. -+ `account_id` String. The account_id to use for this test. -+ `transport_type` String. If the transport_type is 'HTTP', payloads will be - generated via a request to a dummy WSGI server. Otherwise, they'll be - generated manually. -+ `major_version`: Integer. The expected major version of the payload. -+ `minor_version`: Integer. The expected minor version of the payload. -+ `trusted_account_key`: String. The earliest ancestor trusted account id. -+ `force_sampled_true`: Boolean. Currently does nothing. -+ `expected_metrics`: List. Each list item itself is also a list of length two. - The first item in the list is a metric name (unscoped). The second item is - the expected number of occurrences of that metric. When a `null` is - encountered, then the metric is expected to be absent. -+ `web_transaction`: Boolean. Whether the test should be run - as a web transaction (as opposed to a background task). -+ `raises_exception`: Boolean, defaults to false. Whether the test should raise - and record an exception (thus creating error traces, error events, etc). -+ `span_events_enabled`: Boolean. Whether span events are expected to be - enabled for this test. (that is to say, whether span events are generated and - validated or not) -+ `outbound_payloads`: List. For each item in the list, an outgoing request - should be made during the distributed trace transaction. The list item itself - is a dict, with the key, value pairs that should be asserted. Note that - keys prepended with "d." are in the `data` portion of the outgoing payload. -+ `intrinsics`: Dictionary. Has a specific format, as described below. - -## "Intrinsics" field attributes - -+ `target_events`: List of strings. Each string represents an event type that - will be generated by this test. Each string will also appear as a field in - this `intrinsics` dict, with the same format as `common`. - -+ `common`: A dict representing common attributes for all generated event - types. The key/value pairs in `common` should be unioned with the values for - each specific event type. Both `common` and the specific events will each - have three subfields: `expected`, `unexpected`, and `exact`. The first two - list of fields that should and should not, respectably, be present in the - are event's attributes. `exact`, on the other hand, is a dict with key/value - pairs describing what each attribute's exact value should be. - ### Trace Context test details The Trace Context test cases in `trace_context.json` are meant to be used to verify the @@ -65,17 +9,39 @@ the agent under test. Here's what the various fields in each test case mean: | Name | Meaning | | ---- | ------- | -| `name` | A human-meaningful name for the test case. | +| `test_name` | A human-meaningful name for the test case. | | `trusted_account_key` | The account ids the agent can trust. | | `account_id` | The account id the agent would receive on connect. | | `web_transaction` | Whether the transaction that's tested is a web transaction or not. | | `raises_exception` | Whether to simulate an exception happening within the transaction or not, resulting in a transaction error event. | -| `force_sampled_true` | Whether to force a transaction to be sampled or not. | +| `distributed_tracing_enabled` | If `false`, then distributed tracing is disabled. If `true` or absent, then distributed tracing is enabled (default behavior). | +| `full_granularity_enabled` | If `false`, then full granularity tracing is disabled. If `true` or absent, then full granularity is enabled (default behavior). | +| `root` | The full granularity sampler to use for transactions at the root of a trace. | +| `remote_parent_sampled` | The full granularity sampler to use for transactions with a remote parent that was sampled. | +| `remote_parent_not_sampled` | The full granularity sampler to use for transactions with a remote parent that is not sampled. | +| `force_adaptive_sampled` | The sampling decision to force on a transaction whenever the adaptive sampler is used. This applies to all adaptive samplers used in the test, whether they are the global sampler or an individual sampler instance. | +| `full_granularity_ratio` | The ratio to use for all of the full granularity trace ID ratio samplers defined in the test. For testing purposes we are not defining different ratios for each trace ID ratio sampler instance. If that is necessary, we will need a different way to configure the ratios. | +| `partial_granularity_enabled` | If `true`, then partial granularity is enabled. If `false` or absent, then partial granularity is disabled (default behavior). | +| `partial_granularity_root` | The partial granularity sampler to use for root transactions. | +| `partial_granularity_remote_parent_sampled` | The partial granularity sampler to use for transactions with a remote parent that was sampled. | +| `partial_granularity_remote_parent_not_sampled` | The partial granularity sampler to use for transaction with a remote parent that was not sampled. | +| `partial_granularity_ratio` | The partial granularity ratio to use for all the partial granularity ratio samplers defined in the test. As with `full_granularity_ratio` we're limiting these tests to have one ratio configured for all partial granularity samplers.| +| `expected_priority_between` | The inclusive range of the expected priority value on the generated transaction event. | | `transport_type` | The transport type for the inbound request. | | `inbound_headers` | The headers you should mock coming into the agent. | -| `outbound_payloads` | The exact/expected/unexpected values for outbound headers. | +| `outbound_payloads` | The exact/expected/unexpected values for outbound `w3c` headers. | | `intrinsics` | The exact/expected/unexpected attributes for events. | | `expected_metrics` | The expected metrics and associated counts as a result of the test. | +| `span_events_enabled` | Whether span events are enabled in the agent or not. | +| `transaction_events_enabled` | Whether transaction events are enabled in the agent or not. | + +The samplers that can referenced in the `root`, `remote_parent_sampled`, and `remote_parent_not_sampled` fields are: + +- `default`: Use the adaptive sampler. +- `adaptive`: Use the adaptive sampler. +- `trace_id_ratio_based`: Use the trace ID ratio sampler. +- `always_on`: Use the always on sampler. +- `always_off`: Use the always off sampler. The `outbound_payloads` and `intrinsics` field can have nested values, for example: ```javascript @@ -119,3 +85,43 @@ have a `guid`, both have `da8bc8cc6d062849b0efcf3c169afb5a` as the `traceId`, an The `Transaction` block means anything in there should only apply to the transaction object. Same for the `Span` block. The same idea goes for the `outbound_payloads` block but will apply specifically for the outbound `traceparent` header and `tracestate` header. + +`outbound_payloads` may also target `newrelic` headers and follow same basic structure inline with trace context headers, for example: +```javascript + ... + "outbound_payloads": [ + { + "exact": { + "traceparent.version": "00", + "traceparent.trace_id": "00000000000000006e2fea0b173fdad0", + "traceparent.trace_flags": "01", + "tracestate.tenant_id": "33", + "tracestate.version": 0, + "tracestate.parent_type": 0, + "tracestate.parent_account_id": "33", + "tracestate.sampled": true, + "tracestate.priority": 1.123432, + "newrelic.v": [0, 1], + "newrelic.d.ty": "App", + "newrelic.d.ac": "33", + "newrelic.d.ap": "2827902", + "newrelic.d.tr": "6E2fEA0B173FDAD0", + "newrelic.d.sa": true, + "newrelic.d.pr": 1.1234321 + }, + "expected": [ + "traceparent.parent_id", + "tracestate.timestamp", + "tracestate.parent_application_id", + "tracestate.span_id", + "tracestate.transaction_id", + "newrelic.d.ap", + "newrelic.d.tx", + "newrelic.d.ti", + "newrelic.d.id" + ], + "unexpected": ["newrelic.d.tk"] + } + ], + ... +``` \ No newline at end of file diff --git a/tests/cross_agent/fixtures/distributed_tracing/distributed_tracing.json b/tests/cross_agent/fixtures/distributed_tracing/distributed_tracing.json index ab82f11d8b..aab8a670b7 100644 --- a/tests/cross_agent/fixtures/distributed_tracing/distributed_tracing.json +++ b/tests/cross_agent/fixtures/distributed_tracing/distributed_tracing.json @@ -64,6 +64,66 @@ ["Supportability/DistributedTrace/AcceptPayload/Success", 1] ] }, + { + "test_name": "high_priority_but_sampled_false", + "comment": "this should never happen, but is here to verify your agent only creates a span event if sampled=true, not just based off of priority", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "force_sampled_true": false, + "span_events_enabled": true, + "major_version": 0, + "minor_version": 1, + "transport_type": "HTTP", + "inbound_payloads": [ + { + "v": [0, 1], + "d": { + "ac": "33", + "ap": "2827902", + "id": "7d3efb1b173fecfa", + "tx": "e8b91a159289ff74", + "pr": 1.234567, + "sa": false, + "ti": 1518469636035, + "tr": "d6b4ba0c3a712ca", + "ty": "App" + } + } + ], + "intrinsics": { + "target_events": ["Transaction"], + "common":{ + "exact": { + "traceId": "d6b4ba0c3a712ca", + "priority": 1.234567, + "sampled": false + }, + "expected": ["guid"], + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes"] + }, + "Transaction": { + "exact": { + "parent.type": "App", + "parent.app": "2827902", + "parent.account": "33", + "parent.transportType": "HTTP", + "parentId": "e8b91a159289ff74", + "parentSpanId": "7d3efb1b173fecfa" + }, + "expected": ["parent.transportDuration"] + }, + "unexpected_events": ["Span"] + }, + "expected_metrics": [ + ["DurationByCaller/App/33/2827902/HTTP/all", 1], + ["DurationByCaller/App/33/2827902/HTTP/allWeb", 1], + ["TransportDuration/App/33/2827902/HTTP/all", 1], + ["TransportDuration/App/33/2827902/HTTP/allWeb", 1], + ["Supportability/DistributedTrace/AcceptPayload/Success", 1] + ] + }, { "test_name": "multiple_accept_calls", "trusted_account_key": "33", @@ -736,78 +796,6 @@ ["Supportability/DistributedTrace/CreatePayload/Success", 2] ] }, - { - "test_name": "payload_from_trusted_partnership_account", - "trusted_account_key": "44", - "account_id": "11", - "web_transaction": true, - "raises_exception": false, - "force_sampled_true": false, - "span_events_enabled": true, - "major_version": 0, - "minor_version": 1, - "transport_type": "HTTP", - "inbound_payloads": [ - { - "v": [0, 1], - "d": { - "ac": "33", - "ap": "2827902", - "tx": "e8b91a159289ff74", - "pr": 0.123456, - "sa": false, - "ti": 1518469636035, - "tr": "d6b4ba0c3a712ca", - "tk": "44", - "ty": "App" - } - } - ], - "outbound_payloads": [ - { - "exact": { - "v": [0, 1], - "d.ac": "11", - "d.pr": 0.123456, - "d.sa": false, - "d.tr": "d6b4ba0c3a712ca", - "d.tk": "44", - "d.ty": "App" - }, - "expected": ["d.ap", "d.tx", "d.ti", "d.id"], - "unexpected": [] - } - ], - "intrinsics": { - "target_events": ["Transaction"], - "common":{ - "exact": { - "parent.type": "App", - "parent.app": "2827902", - "parent.account": "33", - "parent.transportType": "HTTP", - "traceId": "d6b4ba0c3a712ca", - "priority": 0.123456, - "sampled": false - }, - "expected": ["parent.transportDuration", "guid"], - "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes"] - }, - "Transaction": { - "exact": { - "parentId": "e8b91a159289ff74" - } - } - }, - "expected_metrics": [ - ["DurationByCaller/App/33/2827902/HTTP/all", 1], - ["DurationByCaller/App/33/2827902/HTTP/allWeb", 1], - ["TransportDuration/App/33/2827902/HTTP/all", 1], - ["TransportDuration/App/33/2827902/HTTP/allWeb", 1], - ["Supportability/DistributedTrace/AcceptPayload/Success", 1], - ["Supportability/DistributedTrace/CreatePayload/Success", 1] - ] - }, { "test_name": "payload_has_larger_minor_version", "trusted_account_key": "33", @@ -895,7 +883,7 @@ "target_events": ["Transaction"], "common":{ "expected": ["guid", "traceId", "priority", "sampled"], - "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parent.transportType", "parentId"] + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parentId"] } }, "expected_metrics": [ @@ -932,7 +920,7 @@ "target_events": ["Transaction"], "common":{ "expected": ["guid", "traceId", "priority", "sampled"], - "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parent.transportType", "parentId"] + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parentId"] } }, "expected_metrics": [ @@ -969,7 +957,7 @@ "target_events": ["Transaction"], "common":{ "expected": ["guid", "traceId", "priority", "sampled"], - "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parent.transportType", "parentId"] + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parentId"] } }, "expected_metrics": [ @@ -992,7 +980,7 @@ "target_events": ["Transaction"], "common":{ "expected": ["guid", "traceId", "priority", "sampled"], - "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parent.transportType", "parentId"] + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parentId"] } }, "expected_metrics": [ @@ -1028,7 +1016,7 @@ "target_events": ["Transaction"], "common":{ "expected": ["guid", "traceId", "priority", "sampled"], - "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parent.transportType", "parentId"] + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parentId"] } }, "expected_metrics": [ @@ -1055,7 +1043,7 @@ "target_events": ["Transaction"], "common":{ "expected": ["guid", "traceId", "priority", "sampled"], - "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parent.transportType", "parentId"] + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parentId"] } }, "expected_metrics": [ @@ -1091,7 +1079,7 @@ "target_events": ["Transaction"], "common":{ "expected": ["guid", "traceId", "priority", "sampled"], - "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parent.transportType", "parentId"] + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parentId"] } }, "expected_metrics": [ @@ -1127,7 +1115,7 @@ "target_events": ["Transaction"], "common":{ "expected": ["guid", "traceId", "priority", "sampled"], - "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parent.transportType", "parentId"] + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parentId"] } }, "expected_metrics": [ @@ -1163,7 +1151,7 @@ "target_events": ["Transaction"], "common":{ "expected": ["guid", "traceId", "priority", "sampled"], - "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parent.transportType", "parentId"] + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parentId"] } }, "expected_metrics": [ @@ -1199,7 +1187,7 @@ "target_events": ["Transaction"], "common":{ "expected": ["guid", "traceId", "priority", "sampled"], - "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parent.transportType", "parentId"] + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parentId"] } }, "expected_metrics": [ @@ -1235,7 +1223,7 @@ "target_events": ["Transaction"], "common":{ "expected": ["guid", "traceId", "priority", "sampled"], - "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parent.transportType", "parentId"] + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parentId"] } }, "expected_metrics": [ @@ -1271,7 +1259,7 @@ "target_events": ["Transaction"], "common":{ "expected": ["guid", "traceId", "priority", "sampled"], - "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parent.transportType", "parentId"] + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parentId"] } }, "expected_metrics": [ diff --git a/tests/cross_agent/fixtures/distributed_tracing/trace_context.json b/tests/cross_agent/fixtures/distributed_tracing/trace_context.json index 61f6be3d84..fb4cd686eb 100644 --- a/tests/cross_agent/fixtures/distributed_tracing/trace_context.json +++ b/tests/cross_agent/fixtures/distributed_tracing/trace_context.json @@ -1,12 +1,926 @@ [ + { + "test_name": "w3c_sampled_remote_parent_sampled_default_uses_adaptive_sampling_algo", + "comment": "W3C parent header is used to determine remote parent is sampled but W3C trace state is not present so decision goes to random adaptive sampler algo", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "remote_parent_sampled": "adaptive", + "remote_parent_not_sampled": "adaptive", + "force_adaptive_sampled": false, + "expected_priority_between": [ 0, 1 ], + "inbound_headers": [ + { + "traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01", + "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"App\",\"ac\":\"33\",\"ap\":\"2827902\",\"id\":\"7d3efb1b173fecfa\",\"tr\":\"0af7651916cd43dd8448eb211c80319c\",\"pr\":1.234567,\"sa\":true,\"ti\":1518469636035,\"tx\":\"0af7651916cd43dd\"}}" + } + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "traceId": "0af7651916cd43dd8448eb211c80319c", + "sampled": false + }, + "expected": [ "guid" ] + } + } + }, + { + "test_name": "w3c_sampled_remote_parent_sampled_default_uses_w3c_trace_state_remote_sampled", + "comment": "W3C parent header is used to determine remote parent is sampled and W3C trace state is used to set sampling decision", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "remote_parent_sampled": "adaptive", + "remote_parent_not_sampled": "adaptive", + "force_adaptive_sampled": false, + "inbound_headers": [ + { + "traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01", + "tracestate": "33@nr=0-0-33-2827902-0af7651916cd43dd--1-1.2-1518469636035", + "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"App\",\"ac\":\"33\",\"ap\":\"2827902\",\"id\":\"7d3efb1b173fecfa\",\"tr\":\"0af7651916cd43dd8448eb211c80319c\",\"pr\":0,\"sa\":false,\"ti\":1518469636035,\"tx\":\"0af7651916cd43dd\"}}" + } + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "traceId": "0af7651916cd43dd8448eb211c80319c", + "priority": 1.2, + "sampled": true + }, + "expected": [ "guid" ] + } + } + }, + { + "test_name": "newrelic_sampled_remote_parent_sampled_default_uses_newrelic_remote_sampled", + "comment": "New Relic header is used to determine remote parent is sampled and to set sampling decision", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "remote_parent_sampled": "adaptive", + "remote_parent_not_sampled": "adaptive", + "force_adaptive_sampled": false, + "inbound_headers": [ + { + "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"App\",\"ac\":\"33\",\"ap\":\"2827902\",\"id\":\"7d3efb1b173fecfa\",\"tr\":\"0af7651916cd43dd8448eb211c80319c\",\"pr\":1.2,\"sa\":true,\"ti\":1518469636035,\"tx\":\"0af7651916cd43dd\"}}" + } + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "traceId": "0af7651916cd43dd8448eb211c80319c", + "priority": 1.2, + "sampled": true + }, + "expected": [ "guid" ] + } + } + }, + { + "test_name": "no_remote_parent_sampled_decision_so_default_uses_adaptive_sampling_algo", + "comment": "No headers so root default is used and sampling decision goes to random adaptive sampling algorithm", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "remote_parent_sampled": "adaptive", + "remote_parent_not_sampled": "adaptive", + "expected_priority_between": [ 2, 3 ], + "force_adaptive_sampled": true, + "inbound_headers": [ + {} + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "sampled": true + }, + "expected": [ "guid", "traceId" ] + } + } + }, + { + "test_name": "w3c_remote_parent_not_sampled_so_adaptive_uses_adaptive_sampling_algo", + "comment": "W3C parent header indicates remote parent not sampled, adaptive is used, and no W3C trace state header present so sampling decision goes to random adaptive sampling algorithm", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "remote_parent_sampled": "adaptive", + "remote_parent_not_sampled": "adaptive", + "expected_priority_between": [ 2, 3 ], + "force_adaptive_sampled": true, + "inbound_headers": [ + { + "traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-00" + } + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "traceId": "0af7651916cd43dd8448eb211c80319c", + "sampled": true + }, + "expected": [ "guid" ] + } + } + }, + { + "test_name": "w3c_remote_parent_not_sampled_so_always_off", + "comment": "W3C parent header indicates remote parent not sampled and is set to always off", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "remote_parent_sampled": "adaptive", + "remote_parent_not_sampled": "always_off", + "force_adaptive_sampled": true, + "inbound_headers": [ + { + "traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-00", + "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"App\",\"ac\":\"33\",\"ap\":\"2827902\",\"id\":\"7d3efb1b173fecfa\",\"tr\":\"0af7651916cd43dd8448eb211c80319c\",\"pr\":1.2,\"sa\":true,\"ti\":1518469636035,\"tx\":\"0af7651916cd43dd\"}}" + } + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "traceId": "0af7651916cd43dd8448eb211c80319c", + "priority": 0.0, + "sampled": false + }, + "expected": [ "guid" ] + } + } + }, + { + "test_name": "newrelic_remote_parent_not_sampled_so_always_off", + "comment": "New Relic parent header indicates remote parent not sampled and is set to always off", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "remote_parent_sampled": "adaptive", + "remote_parent_not_sampled": "always_off", + "force_adaptive_sampled": true, + "inbound_headers": [ + { + "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"App\",\"ac\":\"33\",\"ap\":\"2827902\",\"id\":\"7d3efb1b173fecfa\",\"tr\":\"0af7651916cd43dd8448eb211c80319c\",\"pr\":1.2,\"sa\":false,\"ti\":1518469636035,\"tx\":\"0af7651916cd43dd\"}}" + } + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "traceId": "0af7651916cd43dd8448eb211c80319c", + "priority": 0.0, + "sampled": false + }, + "expected": [ "guid" ] + } + } + }, + { + "test_name": "newrelic_remote_parent_not_sampled_so_always_on", + "comment": "New Relic parent header indicates remote parent not sampled and is set to always on", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "remote_parent_sampled": "adaptive", + "remote_parent_not_sampled": "always_on", + "force_adaptive_sampled": true, + "inbound_headers": [ + { + "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"App\",\"ac\":\"33\",\"ap\":\"2827902\",\"id\":\"7d3efb1b173fecfa\",\"tr\":\"0af7651916cd43dd8448eb211c80319c\",\"pr\":1.2,\"sa\":false,\"ti\":1518469636035,\"tx\":\"0af7651916cd43dd\"}}" + } + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "traceId": "0af7651916cd43dd8448eb211c80319c", + "priority": 3.0, + "sampled": true + }, + "expected": [ "guid" ] + } + } + }, + { + "test_name": "newrelic_remote_parent_sampled_so_always_on", + "comment": "New Relic parent header indicates remote parent sampled and is set to always on", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "remote_parent_sampled": "always_on", + "remote_parent_not_sampled": "always_off", + "force_adaptive_sampled": true, + "inbound_headers": [ + { + "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"App\",\"ac\":\"33\",\"ap\":\"2827902\",\"id\":\"7d3efb1b173fecfa\",\"tr\":\"0af7651916cd43dd8448eb211c80319c\",\"pr\":1.2,\"sa\":true,\"ti\":1518469636035,\"tx\":\"0af7651916cd43dd\"}}" + } + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "traceId": "0af7651916cd43dd8448eb211c80319c", + "priority": 3.0, + "sampled": true + }, + "expected": [ "guid" ] + } + } + }, + { + "test_name": "no_headers_root_always_off", + "comment": "Traces originating from current service are never sampled", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "root": "always_off", + "remote_parent_sampled": "adaptive", + "remote_parent_not_sampled": "adaptive", + "force_adaptive_sampled": true, + "inbound_headers": [ + {} + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "priority": 0.0, + "sampled": false + }, + "expected": [ "guid", "traceId" ] + } + } + }, + { + "test_name": "no_headers_root_always_on", + "comment": "Traces originating from current service are always sampled", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "root": "always_on", + "remote_parent_sampled": "adaptive", + "remote_parent_not_sampled": "adaptive", + "force_adaptive_sampled": true, + "inbound_headers": [ + {} + ], + "intrinsics": { + "target_events": [ + "Transaction" + ], + "common": { + "exact": { + "priority": 3.0, + "sampled": true + }, + "expected": [ + "guid", + "traceId" + ] + } + } + }, + { + "test_name": "no_headers_root_uses_ratio_sampler", + "comment": "Traces originating from current service are always sampled (because ratio=1.0)", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "root": "trace_id_ratio_based", + "full_granularity_ratio": 1.0, + "remote_parent_sampled": "adaptive", + "remote_parent_not_sampled": "adaptive", + + "expected_priority_between": [ 2, 3 ], + "force_adaptive_sampled": false, + "inbound_headers": [ + {} + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "sampled": true + }, + "expected": [ "guid", "traceId" ] + } + } + }, + { + "test_name": "no_headers_root_uses_adaptive_sampler_when_no_ratio", + "comment": "Traces originating from current service use adaptive sampler when no ratio is configured", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "root": "trace_id_ratio_based", + "remote_parent_sampled": "adaptive", + "remote_parent_not_sampled": "adaptive", + "expected_priority_between": [ 2, 3 ], + "force_adaptive_sampled": true, + "inbound_headers": [ + { + "traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-00" + } + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "traceId": "0af7651916cd43dd8448eb211c80319c", + "sampled": true + }, + "expected": [ "guid" ] + } + } + }, + { + "test_name": "w3c_remote_parent_sampled_uses_ratio_sampler_w3c_trace_id", + "comment": "W3C parent header determines parent is sampled and W3C trace id is passed to ratio sampler", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "root": "always_off", + "full_granularity_ratio": 1.0, + "remote_parent_sampled": "trace_id_ratio_based", + "remote_parent_not_sampled": "always_off", + + "expected_priority_between": [ 2, 3 ], + "force_adaptive_sampled": false, + "inbound_headers": [ + { + "traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01" + } + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "traceId": "0af7651916cd43dd8448eb211c80319c", + "sampled": true + }, + "expected": [ "guid" ] + } + } + }, + { + "test_name": "w3c_remote_parent_sampled_uses_ratio_sampler_w3c_trace_id_not_sampled", + "comment": "W3C parent header determines parent is sampled and W3C trace id is passed to ratio sampler but makes a sampling decision of false because ratio is 0", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "root": "trace_id_ratio_based", + "full_granularity_ratio": 0.00000001, + "remote_parent_sampled": "trace_id_ratio_based", + "remote_parent_not_sampled": "trace_id_ratio_based", + + "expected_priority_between": [ 0, 1 ], + "force_adaptive_sampled": false, + "inbound_headers": [ + { + "traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01" + } + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "traceId": "0af7651916cd43dd8448eb211c80319c", + "sampled": false + }, + "expected": [ "guid" ] + } + } + }, + { + "test_name": "newrelic_remote_parent_sampled_uses_ratio_sampler_newrelic_trace_id", + "comment": "New Relic parent header determines parent is sampled and New Relic trace id is passed to ratio sampler", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "root": "always_off", + "full_granularity_ratio": 1.0, + "remote_parent_sampled": "trace_id_ratio_based", + "remote_parent_not_sampled": "always_off", + "expected_priority_between": [ 2, 3 ], + "force_adaptive_sampled": false, + "inbound_headers": [ + { + "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"App\",\"ac\":\"33\",\"ap\":\"2827902\",\"id\":\"7d3efb1b173fecfa\",\"tr\":\"0af7651916cd43dd8448eb211c80319c\",\"pr\":0.2,\"sa\":true,\"ti\":1518469636035,\"tx\":\"0af7651916cd43dd\"}}" + } + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "traceId": "0af7651916cd43dd8448eb211c80319c", + "sampled": true + }, + "expected": [ "guid" ] + } + } + }, + { + "test_name": "newrelic_remote_parent_sampled_uses_ratio_sampler_newrelic_trace_id_not_sampled", + "comment": "New Relic parent header determines parent is sampled and New Relic trace id is passed to ratio sampler but makes a sampling decision of false because ratio is 0", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "root": "trace_id_ratio_based", + "full_granularity_ratio": 0.00000001, + "remote_parent_sampled": "trace_id_ratio_based", + "remote_parent_not_sampled": "trace_id_ratio_based", + "expected_priority_between": [ 0, 1 ], + "force_adaptive_sampled": false, + "inbound_headers": [ + { + "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"App\",\"ac\":\"33\",\"ap\":\"2827902\",\"id\":\"7d3efb1b173fecfa\",\"tr\":\"0af7651916cd43dd8448eb211c80319c\",\"pr\":0.2,\"sa\":true,\"ti\":1518469636035,\"tx\":\"0af7651916cd43dd\"}}" + } + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "traceId": "0af7651916cd43dd8448eb211c80319c", + "sampled": false + }, + "expected": [ "guid" ] + } + } + }, + { + "test_name": "no_headers_root_uses_partial_ratio_sampler", + "comment": "Traces originating from current service are always sampled at partial granularity (ratio=1.0)", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "root": "trace_id_ratio_based", + "full_granularity_ratio": 0.00000001, + "remote_parent_sampled": "adaptive", + "remote_parent_not_sampled": "adaptive", + "partial_granularity_enabled": true, + "partial_granularity_root": "trace_id_ratio_based", + "partial_granularity_ratio": 1.0, + "partial_granularity_remote_parent_sampled": "adaptive", + "partial_granularity_remote_parent_not_sampled": "adaptive", + "force_adaptive_sampled": false, + "inbound_headers": [ + {} + ], + + "expected_priority_between": [ 1, 2 ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "sampled": true + }, + "expected": [ "guid", "traceId" ] + } + } + }, + { + "test_name": "newrelic_remote_parent_sampled_uses_partial_ratio_sampler", + "comment": "New Relic parent header determines parent is sampled and New Relic trace id is passed to partial ratio sampler", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "root": "always_off", + "remote_parent_sampled": "always_off", + "remote_parent_not_sampled": "always_off", + "partial_granularity_enabled": true, + "partial_granularity_root": "adaptive", + "partial_granularity_remote_parent_sampled": "trace_id_ratio_based", + "partial_granularity_ratio": 1.0, + "partial_granularity_remote_parent_not_sampled": "adaptive", + "force_adaptive_sampled": false, + + "expected_priority_between": [ 1, 2 ], + "inbound_headers": [ + { + "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"App\",\"ac\":\"33\",\"ap\":\"2827902\",\"id\":\"7d3efb1b173fecfa\",\"tr\":\"0af7651916cd43dd8448eb211c80319c\",\"pr\":0.2,\"sa\":true,\"ti\":1518469636035,\"tx\":\"0af7651916cd43dd\"}}" + } + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "traceId": "0af7651916cd43dd8448eb211c80319c", + "sampled": true + }, + "expected": [ "guid" ] + } + } + }, + { + "test_name": "newrelic_remote_parent_sampled_uses_partial_ratio_sampler_full_ratio_not_sampled", + "comment": "New Relic parent header determines parent is sampled and New Relic trace id is passed first to full ratio and then partial ratio sampler", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "root": "trace_id_ratio_based", + "remote_parent_sampled": "trace_id_ratio_based", + "remote_parent_not_sampled": "trace_id_ratio_based", + "full_granularity_ratio": 0.00000001, + "partial_granularity_enabled": true, + "partial_granularity_root": "trace_id_ratio_based", + "partial_granularity_remote_parent_sampled": "trace_id_ratio_based", + "partial_granularity_ratio": 1, + "partial_granularity_remote_parent_not_sampled": "trace_id_ratio_based", + "force_adaptive_sampled": false, + + "expected_priority_between": [ 1, 2 ], + "inbound_headers": [ + { + "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"App\",\"ac\":\"33\",\"ap\":\"2827902\",\"id\":\"7d3efb1b173fecfa\",\"tr\":\"0af7651916cd43dd8448eb211c80319c\",\"pr\":0.2,\"sa\":true,\"ti\":1518469636035,\"tx\":\"0af7651916cd43dd\"}}" + } + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "traceId": "0af7651916cd43dd8448eb211c80319c", + "sampled": true + }, + "expected": [ "guid" ] + } + } + }, + { + "test_name": "newrelic_remote_parent_sampled_uses_partial_ratio_sampler_not_sampled", + "comment": "New Relic parent header determines parent is sampled and New Relic trace id is passed to partial ratio sampler and returns false because ratio is 0", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "root": "trace_id_ratio_based", + "remote_parent_sampled": "trace_id_ratio_based", + "remote_parent_not_sampled": "trace_id_ratio_based", + "full_granularity_ratio": 0.00000001, + "partial_granularity_enabled": true, + "partial_granularity_root": "trace_id_ratio_based", + "partial_granularity_remote_parent_sampled": "trace_id_ratio_based", + "partial_granularity_ratio": 0.00000001, + "partial_granularity_remote_parent_not_sampled": "trace_id_ratio_based", + "force_adaptive_sampled": false, + + "expected_priority_between": [ 0, 1 ], + "inbound_headers": [ + { + "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"App\",\"ac\":\"33\",\"ap\":\"2827902\",\"id\":\"7d3efb1b173fecfa\",\"tr\":\"0af7651916cd43dd8448eb211c80319c\",\"pr\":0.2,\"sa\":true,\"ti\":1518469636035,\"tx\":\"0af7651916cd43dd\"}}" + } + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "traceId": "0af7651916cd43dd8448eb211c80319c", + "sampled": false + }, + "expected": [ "guid" ] + } + } + }, + { + "test_name": "no_headers_full_traces_disabled_uses_partial_adaptive_sampler", + "comment": "Root traces are always sampled at partial granularity with the global adaptive sampler", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "full_granularity_enabled": false, + "partial_granularity_enabled": true, + "partial_granularity_root": "adaptive", + "force_adaptive_sampled": true, + "partial_granularity_remote_parent_sampled": "always_off", + "partial_granularity_remote_parent_not_sampled": "always_off", + "inbound_headers": [ + {} + ], + + "expected_priority_between": [ 1, 2 ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "sampled": true + }, + "expected": [ "guid", "traceId" ] + } + } + }, + { + "test_name": "w3c_remote_parent_not_sampled_uses_partial_ratio_sampler", + "comment": "Traceparent header determines parent is not sampled. Full granularity tries to run the adaptive sampler, chooses sampled=false, and W3C trace id is passed to partial ratio sampler", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "root": "always_off", + "remote_parent_sampled": "always_off", + "remote_parent_not_sampled": "adaptive", + "force_adaptive_sampled": false, + "partial_granularity_enabled": true, + "partial_granularity_root": "always_off", + "partial_granularity_remote_parent_sampled": "always_off", + "partial_granularity_remote_parent_not_sampled": "trace_id_ratio_based", + "partial_granularity_ratio": 1.0, + "inbound_headers": [ + { + "traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-00" + } + ], + + "expected_priority_between": [ 1, 2 ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "traceId": "0af7651916cd43dd8448eb211c80319c", + "sampled": true + }, + "expected": [ "guid" ] + } + } + }, + { + "test_name": "w3c_remote_parent_sampled_uses_partial_always_on", + "comment": "W3C parent header determines parent is sampled and passes to partial granularity always on sampler", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "full_granularity_enabled": false, + "partial_granularity_enabled": true, + "partial_granularity_remote_parent_sampled": "always_on", + + "force_adaptive_sampled": false, + "inbound_headers": [ + { + "traceparent": "00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01" + } + ], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "traceId": "0af7651916cd43dd8448eb211c80319c", + "sampled": true, + "priority": 2.0 + }, + "expected": [ "guid" ] + } + } + }, + { + "test_name": "no_headers_root_uses_partial_always_on", + "comment": "Traces originating from current service are always sampled at partial granularity (with priority 2.0)", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "root": "always_off", + "partial_granularity_enabled": true, + "partial_granularity_root": "always_on", + "inbound_headers": [ + {} + ], + "intrinsics": { + "target_events": [ + "Transaction" + ], + "common": { + "exact": { + "priority": 2.0, + "sampled": true + }, + "expected": [ + "guid", + "traceId" + ] + } + } + }, + { + "test_name": "payload_missing_priority_incremented_to_full_granularity_priority", + "comment": "Remote parent was sampled and tracestate has a sampled=true flag but no priority, so a random priority between 2 and 3 should be generated without use of the sampler", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "remote_parent_sampled": "adaptive", + "force_adaptive_sampled": false, + "inbound_headers": [ + { + "traceparent": "00-f6e9c09812b22fba2f1999b318ddfc8b-7d3efb1b173fecfa-01", + "tracestate": "33@nr=0-2-33-2827902-7d3efb1b173fecfa--1--1518469636035" + } + ], + "expected_priority_between": [2,3], + "intrinsics": { + "target_events": ["Transaction"], + "common":{ + "exact": { + "traceId": "f6e9c09812b22fba2f1999b318ddfc8b", + "sampled": true + }, + "expected": ["guid", "priority"] + } + } + }, + { + "test_name": "payload_missing_priority_incremented_to_partial_granularity_priority", + "comment": "Remote parent was sampled and tracestate has a sampled=true flag but no priority, so a random priority between 1 and 2 should be generated without use of the sampler", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "full_granularity_enabled": false, + "partial_granularity_enabled": true, + "partial_granularity_remote_parent_sampled": "adaptive", + "force_adaptive_sampled": false, + "inbound_headers": [ + { + "traceparent": "00-f6e9c09812b22fba2f1999b318ddfc8b-7d3efb1b173fecfa-01", + "tracestate": "33@nr=0-2-33-2827902-7d3efb1b173fecfa--1--1518469636035" + } + ], + "expected_priority_between": [1, 2], + "intrinsics": { + "target_events": ["Transaction"], + "common":{ + "exact": { + "traceId": "f6e9c09812b22fba2f1999b318ddfc8b", + "sampled": true + }, + "expected": ["guid", "priority"] + } + } + }, + + { + "test_name": "no_headers_root_full_and_partial_disabled", + "comment": "Traces are assigned a random priority <1 when full and partial tracing are both disabled. The expected_priority_between min is arbitrarily small (so that it does not include 0)", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "full_granularity_enabled": false, + "root": "always_on", + "partial_granularity_enabled": false, + "partial_granularity_root": "always_on", + "force_adaptive_sampled": true, + "inbound_headers": [ + {} + ], + "expected_priority_between": [0.000000001, 1], + "intrinsics": { + "target_events": [ "Transaction" ], + "common": { + "exact": { + "sampled": false + }, + "expected": [ "guid", "traceId" ] + } + } + }, + { + "test_name": "no_headers_distributed_tracing_disabled", + "comment": "Traces are assigned a random priority <1 when distributed tracing is disabled. The expected_priority_between min is arbitrarily small (so that it does not include 0)", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "distributed_tracing_enabled": false, + "transport_type": "HTTP", + "root": "always_on", + "force_adaptive_sampled": true, + "inbound_headers": [ + {} + ], + "expected_priority_between": [0.000000001, 1] + }, { "test_name": "accept_payload", "trusted_account_key": "33", "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": false, + "force_adaptive_sampled": false, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { @@ -59,8 +973,9 @@ "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": false, + "force_adaptive_sampled": false, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { @@ -75,11 +990,11 @@ "traceparent.trace_id": "37375fc353f345b5801b166e31b76136", "traceparent.trace_flags": "00", "tracestate.tenant_id": "33", - "tracestate.version": 0, - "tracestate.parent_type": 0, + "tracestate.version": "0", + "tracestate.parent_type": "0", "tracestate.parent_account_id": "33", - "tracestate.sampled": false, - "tracestate.priority": 0.123456 + "tracestate.sampled": "0", + "tracestate.priority": "0.123456" }, "expected": [ "traceparent.parent_id", @@ -120,24 +1035,108 @@ ["Supportability/TraceContext/Accept/Success", 1] ] }, + { + "test_name": "non_new_relic_parent", + "comment": [ "If a New Relic agent started a trace, and then a non-New", + "Relic tracer propagated the trace, then the traceparent span ID would", + "updated by the non-New Relic tracer, but not the span ID in the New", + "Relic tracestate entry" ], + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "force_adaptive_sampled": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "inbound_headers": [ + { + "traceparent": "00-7a933b0e517e8c1f6bc6a7466be6f2a0-e8b91a159289ff74-01", + "tracestate": "33@nr=0-0-33-2827902-5093db371f0ba945-3ac44d37ece29bd2-1-1.23456-1518469636035" + } + ], + "intrinsics": { + "target_events": ["Transaction", "Span"], + "common":{ + "exact": { + "traceId": "7a933b0e517e8c1f6bc6a7466be6f2a0", + "priority": 1.23456, + "sampled": true + }, + "expected": ["guid"], + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes"] + }, + "Transaction": { + "exact": { + "parent.type": "App", + "parent.app": "2827902", + "parent.account": "33", + "parent.transportType": "HTTP", + "parentId": "3ac44d37ece29bd2", + "parentSpanId": "e8b91a159289ff74" + }, + "expected": ["parent.transportDuration"] + }, + "Span": { + "exact": { + "parentId": "e8b91a159289ff74", + "trustedParentId": "5093db371f0ba945" + }, + "expected": ["transactionId"], + "unexpected": ["parent.transportDuration", "parent.type", "parent.app", "parent.account", "parent.transportType", "tracingVendors"] + + } + }, + "expected_metrics": [ + ["DurationByCaller/App/33/2827902/HTTP/all", 1], + ["DurationByCaller/App/33/2827902/HTTP/allWeb", 1], + ["TransportDuration/App/33/2827902/HTTP/all", 1], + ["TransportDuration/App/33/2827902/HTTP/allWeb", 1], + ["Supportability/TraceContext/Accept/Success", 1] + ] + }, { "test_name": "spans_disabled_in_parent", - "comment": [ - "If the spans are disabled in a New Relic agent, it will forward its ", - "tracestate, and generate a new traceparent. ", - "The traceparent.parent_id and tracestate.parent_id will mismatch." - ], + "comment": [ "If the parent is a New Relic agent with span events disabled it SHOULD omit span", + "id from the tracestate. This verifies agents propagate Trace Context payloads when the", + "parent is a New Relic agent with span events disabled" ], "trusted_account_key": "33", "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": false, + "force_adaptive_sampled": false, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { "traceparent": "00-7a933b0e517e8c1f6bc6a7466be6f2a0-e8b91a159289ff74-01", - "tracestate": "33@nr=0-0-33-2827902-5093db371f0ba945-3ac44d37ece29bd2-1-1.23456-1518469636035" + "tracestate": "33@nr=0-0-33-2827902--3ac44d37ece29bd2-1-1.23456-1518469636035" + } + ], + "outbound_payloads": [ + { + "exact": { + "traceparent.version": "00", + "traceparent.trace_id": "7a933b0e517e8c1f6bc6a7466be6f2a0", + "traceparent.trace_flags": "01", + "tracestate.tenant_id": "33", + "tracestate.version": "0", + "tracestate.parent_type": "0", + "tracestate.parent_account_id": "33", + "tracestate.sampled": "1", + "tracestate.priority": "1.23456" + }, + "expected": [ + "traceparent.parent_id", + "tracestate.timestamp", + "tracestate.parent_application_id", + "tracestate.span_id", + "tracestate.transaction_id" + ], + "notequal": { + "traceparent.parent_id": "7d3efb1b173fecfa" + } } ], "intrinsics": { @@ -149,7 +1148,9 @@ "sampled": true }, "expected": ["guid"], - "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes"] + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", + "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", + "nr.alternatePathHashes"] }, "Transaction": { "exact": { @@ -164,11 +1165,11 @@ }, "Span": { "exact": { - "parentId": "e8b91a159289ff74", - "trustedParentId": "5093db371f0ba945" + "parentId": "e8b91a159289ff74" }, "expected": ["transactionId"], - "unexpected": ["parent.transportDuration", "parent.type", "parent.app", "parent.account", "parent.transportType", "tracingVendors"] + "unexpected": ["parent.transportDuration", "parent.type", "parent.app", "parent.account", + "parent.transportType", "tracingVendors", "trustedParentId"] } }, @@ -186,8 +1187,9 @@ "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": true, + "force_adaptive_sampled": true, "span_events_enabled": false, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { @@ -202,11 +1204,11 @@ "traceparent.trace_id": "2c7a33d956d44531b48ec6f2e535e5c4", "traceparent.trace_flags": "01", "tracestate.tenant_id": "33", - "tracestate.version": 0, - "tracestate.parent_type": 0, + "tracestate.version": "0", + "tracestate.parent_type": "0", "tracestate.parent_account_id": "33", - "tracestate.sampled": true, - "tracestate.priority": 1.23456 + "tracestate.sampled": "1", + "tracestate.priority": "1.23456" }, "expected": [ "traceparent.parent_id", @@ -255,8 +1257,9 @@ "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": true, + "force_adaptive_sampled": true, "span_events_enabled": false, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ ], @@ -301,8 +1304,7 @@ } }, "expected_metrics": [ - ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/all", 1], - ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/allWeb", 1] + ["Supportability/TraceContext/Create/Success", 1] ] }, { @@ -311,8 +1313,9 @@ "account_id": "33", "web_transaction": true, "raises_exception": true, - "force_sampled_true": false, + "force_adaptive_sampled": false, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { @@ -368,8 +1371,9 @@ "account_id": "33", "web_transaction": false, "raises_exception": false, - "force_sampled_true": true, + "force_adaptive_sampled": true, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { @@ -422,8 +1426,9 @@ "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": true, + "force_adaptive_sampled": true, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { @@ -476,8 +1481,9 @@ "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": false, + "force_adaptive_sampled": false, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "kafka", "inbound_headers": [ { @@ -529,8 +1535,9 @@ "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": true, + "force_adaptive_sampled": true, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { @@ -545,11 +1552,11 @@ "traceparent.trace_id": "e22175eb1d68b6de32bf70e38458ccc3", "traceparent.trace_flags": "01", "tracestate.tenant_id": "33", - "tracestate.version": 0, - "tracestate.parent_type": 0, + "tracestate.version": "0", + "tracestate.parent_type": "0", "tracestate.parent_account_id": "33", - "tracestate.sampled": true, - "tracestate.priority": 1.23456 + "tracestate.sampled": "1", + "tracestate.priority": "1.23456" }, "expected": [ "traceparent.parent_id", @@ -606,8 +1613,9 @@ "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": false, + "force_adaptive_sampled": false, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { @@ -622,11 +1630,11 @@ "traceparent.trace_id": "099ae207600a34ecdd5902aba9c8c6c3", "traceparent.trace_flags": "01", "tracestate.tenant_id": "33", - "tracestate.version": 0, - "tracestate.parent_type": 0, + "tracestate.version": "0", + "tracestate.parent_type": "0", "tracestate.parent_account_id": "33", - "tracestate.sampled": true, - "tracestate.priority": 1.23456 + "tracestate.sampled": "1", + "tracestate.priority": "1.23456" }, "expected": [ "traceparent.parent_id", @@ -642,11 +1650,11 @@ "traceparent.trace_id": "099ae207600a34ecdd5902aba9c8c6c3", "traceparent.trace_flags": "01", "tracestate.tenant_id": "33", - "tracestate.version": 0, - "tracestate.parent_type": 0, + "tracestate.version": "0", + "tracestate.parent_type": "0", "tracestate.parent_account_id": "33", - "tracestate.sampled": true, - "tracestate.priority": 1.23456 + "tracestate.sampled": "1", + "tracestate.priority": "1.23456" }, "expected": [ "traceparent.parent_id", @@ -704,7 +1712,8 @@ "web_transaction": true, "raises_exception": false, "span_events_enabled": true, - "force_sampled_true": false, + "transaction_events_enabled": true, + "force_adaptive_sampled": false, "transport_type": "HTTP", "inbound_headers": [ { @@ -719,11 +1728,11 @@ "traceparent.trace_id": "44673569f54fad422c3795b6cd4aef69", "traceparent.trace_flags": "01", "tracestate.tenant_id": "65", - "tracestate.version": 0, - "tracestate.parent_type": 0, + "tracestate.version": "0", + "tracestate.parent_type": "0", "tracestate.parent_account_id": "11", - "tracestate.sampled": true, - "tracestate.priority": 1.23456 + "tracestate.sampled": "1", + "tracestate.priority": "1.23456" }, "expected": [ "traceparent.parent_id", @@ -779,8 +1788,9 @@ "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": true, + "force_adaptive_sampled": true, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { @@ -818,8 +1828,9 @@ "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": true, + "force_adaptive_sampled": true, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { @@ -858,15 +1869,16 @@ "test_name": "tracestate_has_larger_version", "comment": [ "If the new relic payload's version is higher than 0, with extra new fields, all ", - "the existing fields should be read and used, and the extra future feilds should ", + "the existing fields should be read and used, and the extra future fields should ", "be ignored." ], "trusted_account_key": "33", "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": false, + "force_adaptive_sampled": false, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { @@ -881,11 +1893,11 @@ "traceparent.trace_id": "ccaa36c833b26ce54bafa6c4102fd740", "traceparent.trace_flags": "01", "tracestate.tenant_id": "33", - "tracestate.version": 0, - "tracestate.parent_type": 0, + "tracestate.version": "0", + "tracestate.parent_type": "0", "tracestate.parent_account_id": "33", - "tracestate.sampled": true, - "tracestate.priority": 1.23456 + "tracestate.sampled": "1", + "tracestate.priority": "1.23456" }, "expected": [ "traceparent.parent_id", @@ -941,8 +1953,9 @@ "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": true, + "force_adaptive_sampled": true, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { @@ -980,8 +1993,9 @@ "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": false, + "force_adaptive_sampled": false, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { @@ -1009,8 +2023,9 @@ "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": false, + "force_adaptive_sampled": false, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { @@ -1038,8 +2053,9 @@ "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": false, + "force_adaptive_sampled": false, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { @@ -1067,8 +2083,9 @@ "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": false, + "force_adaptive_sampled": false, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { @@ -1121,8 +2138,9 @@ "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": false, + "force_adaptive_sampled": false, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { @@ -1147,8 +2165,9 @@ "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": false, + "force_adaptive_sampled": false, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { @@ -1165,34 +2184,285 @@ "expected": ["guid", "traceId", "priority", "sampled", "parent.transportType"], "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.transportDuration", "parent.type", "parent.app", "parent.account", "parentId"] } - }, + }, + "expected_metrics": [ + ["Supportability/TraceContext/TraceState/InvalidNrEntry", 1] + ] + }, + { + "test_name": "multiple_vendors_in_tracestate", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "force_adaptive_sampled": true, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "inbound_headers": [ + { + "traceparent": "00-5f2796876f44a3c898994ce2668e2222-b4a146e3237b4df1-01", + "tracestate": "foo=1,bar=2" + } + ], + "outbound_payloads": [ + { + "exact": { + "traceparent.version": "00", + "traceparent.trace_id": "5f2796876f44a3c898994ce2668e2222", + "tracestate.tenant_id": "33", + "tracestate.version": "0", + "tracestate.parent_type": "0" + }, + "expected": [ + "traceparent.trace_flags", + "traceparent.parent_id", + "tracestate.span_id", + "tracestate.transaction_id", + "tracestate.parent_application_id", + "tracestate.timestamp", + "tracestate.sampled", + "tracestate.priority" + ], + "vendors": [ + "foo", + "bar" + ] + } + ], + "intrinsics": { + "target_events": ["Transaction", "Span"], + "common":{ + "exact": { + "sampled": true, + "traceId": "5f2796876f44a3c898994ce2668e2222" + }, + "expected": ["guid", "priority"], + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes"] + }, + "Transaction": { + "exact": { + "parentSpanId": "b4a146e3237b4df1" + }, + "expected": ["parent.transportType"], + "unexpected": [ + "parent.transportDuration", + "parent.type", + "parent.app", + "parent.account", + "parentId" + ] + }, + "Span": { + "exact": { + "parentId": "b4a146e3237b4df1", + "tracingVendors": "foo,bar" + }, + "expected": ["transactionId"], + "unexpected": [ + "parent.transportDuration", + "parent.type", + "parent.app", + "parent.account", + "parent.transportType" + ] + } + }, + "expected_metrics": [ + ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/all", 1], + ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/allWeb", 1] + ] + }, + { + "test_name": "missing_tracestate", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "force_adaptive_sampled": true, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "inbound_headers": [ + { + "traceparent": "00-5f2796876f44a3c898994ce2668e2222-b4a146e3237b4df1-01" + } + ], + "outbound_payloads": [ + { + "exact": { + "traceparent.version": "00", + "traceparent.trace_id": "5f2796876f44a3c898994ce2668e2222", + "tracestate.tenant_id": "33", + "tracestate.version": "0", + "tracestate.parent_type": "0", + "tracestate.parent_account_id": "33" + }, + "expected": [ + "traceparent.trace_flags", + "traceparent.parent_id", + "tracestate.span_id", + "tracestate.transaction_id", + "tracestate.parent_application_id", + "tracestate.timestamp", + "tracestate.sampled", + "tracestate.priority" + ] + } + ], + "intrinsics": { + "target_events": ["Transaction", "Span"], + "common":{ + "exact": { + "traceId": "5f2796876f44a3c898994ce2668e2222", + "sampled": true + }, + "expected": ["guid", "priority"], + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes"] + }, + "Transaction": { + "exact": { + "parentSpanId": "b4a146e3237b4df1" + }, + "expected": ["parent.transportType"], + "unexpected": [ + "parent.transportDuration", + "parent.type", + "parent.app", + "parent.account", + "parentId" + ] + }, + "Span": { + "exact": { + "parentId": "b4a146e3237b4df1" + }, + "expected": ["transactionId"], + "unexpected": [ + "parent.transportDuration", + "parent.type", + "parent.app", + "parent.account", + "parent.transportType", + "tracingVendors", + "trustedParentId" + ] + } + }, + "expected_metrics": [ + ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/all", 1], + ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/allWeb", 1] + ] + }, + { + "test_name": "missing_traceparent", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "force_adaptive_sampled": true, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "inbound_headers": [ + { + "tracestate": "foo=1,bar=2" + } + ], + "outbound_payloads": [ + { + "exact": { + "traceparent.version": "00", + "tracestate.tenant_id": "33", + "tracestate.version": "0", + "tracestate.parent_type": "0", + "tracestate.parent_account_id": "33" + }, + "expected": [ + "traceparent.trace_id", + "traceparent.trace_flags", + "traceparent.parent_id", + "tracestate.span_id", + "tracestate.transaction_id", + "tracestate.parent_application_id", + "tracestate.timestamp", + "tracestate.sampled", + "tracestate.priority" + ], + "vendors": [ + ] + } + ], + "expected_metrics": [ + ["Supportability/TraceContext/Create/Success", 1] + ] + }, + { + "test_name": "missing_traceparent_and_tracestate", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "force_adaptive_sampled": true, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "inbound_headers": [ + { } + ], + "outbound_payloads": [ + { + "exact": { + "traceparent.version": "00", + "tracestate.tenant_id": "33", + "tracestate.version": "0", + "tracestate.parent_type": "0", + "tracestate.parent_account_id": "33" + }, + "expected": [ + "traceparent.trace_id", + "traceparent.trace_flags", + "traceparent.parent_id", + "tracestate.span_id", + "tracestate.transaction_id", + "tracestate.parent_application_id", + "tracestate.timestamp", + "tracestate.sampled", + "tracestate.priority" + ] + } + ], "expected_metrics": [ - ["Supportability/TraceContext/TraceState/InvalidNrEntry", 1] + ["Supportability/TraceContext/Create/Success", 1] ] }, { - "test_name": "multiple_vendors_in_tracestate", + "test_name": "multiple_new_relic_trace_state_entries", "trusted_account_key": "33", - "account_id": "33", + "account_id": "99", "web_transaction": true, "raises_exception": false, - "force_sampled_true": true, + "force_adaptive_sampled": false, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { - "traceparent": "00-5f2796876f44a3c898994ce2668e2222-b4a146e3237b4df1-01", - "tracestate": "foo=1,bar=2" + "traceparent": "00-87b1c9a429205b25e5b687d890d4821f-afe162ae3117a892-00", + "tracestate": "44@nr=0-0-11-30299-afe162ae3117a892-0b752e7f02c85205-0-0.123456-1518469636035,33@nr=0-0-33-2827902-7d3efb1b173fecfa-b79e301bd0ffed87-1-1.23456-1518469636025" } ], "outbound_payloads": [ { "exact": { "traceparent.version": "00", - "traceparent.trace_id": "5f2796876f44a3c898994ce2668e2222", + "traceparent.trace_id": "87b1c9a429205b25e5b687d890d4821f", "tracestate.tenant_id": "33", - "tracestate.version": 0, - "tracestate.parent_type": 0 + "tracestate.version": "0", + "tracestate.parent_type": "0", + "tracestate.parent_account_id": "99", + "tracestate.sampled": "1", + "tracestate.priority": "1.23456" }, "expected": [ "traceparent.trace_flags", @@ -1200,13 +2470,10 @@ "tracestate.span_id", "tracestate.transaction_id", "tracestate.parent_application_id", - "tracestate.timestamp", - "tracestate.sampled", - "tracestate.priority" + "tracestate.timestamp" ], "vendors": [ - "foo", - "bar" + "44@nr" ] } ], @@ -1214,68 +2481,67 @@ "target_events": ["Transaction", "Span"], "common":{ "exact": { - "sampled": true, - "traceId": "5f2796876f44a3c898994ce2668e2222" + "traceId": "87b1c9a429205b25e5b687d890d4821f", + "priority": 1.23456, + "sampled": true }, - "expected": ["guid", "priority"], + "expected": ["guid"], "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes"] }, "Transaction": { "exact": { - "parentSpanId": "b4a146e3237b4df1" + "parent.type": "App", + "parent.app": "2827902", + "parent.account": "33", + "parent.transportType": "HTTP", + "parentId": "b79e301bd0ffed87", + "parentSpanId": "afe162ae3117a892" }, - "expected": ["parent.transportType"], - "unexpected": [ - "parent.transportDuration", - "parent.type", - "parent.app", - "parent.account", - "parentId" - ] + "expected": ["parent.transportDuration"] }, "Span": { "exact": { - "parentId": "b4a146e3237b4df1", - "tracingVendors": "foo,bar" + "parentId": "afe162ae3117a892", + "trustedParentId": "7d3efb1b173fecfa", + "tracingVendors": "44@nr" }, "expected": ["transactionId"], - "unexpected": [ - "parent.transportDuration", - "parent.type", - "parent.app", - "parent.account", - "parent.transportType" - ] + "unexpected": ["parent.transportDuration", "parent.type", "parent.app", "parent.account", "parent.transportType"] } }, "expected_metrics": [ - ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/all", 1], - ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/allWeb", 1] + ["DurationByCaller/App/33/2827902/HTTP/all", 1], + ["DurationByCaller/App/33/2827902/HTTP/allWeb", 1], + ["Supportability/TraceContext/Accept/Success", 1] ] }, { - "test_name": "missing_tracestate", + "test_name": "priority_not_converted_to_scientific_notation", "trusted_account_key": "33", - "account_id": "33", + "account_id": "99", "web_transaction": true, "raises_exception": false, - "force_sampled_true": true, + "force_adaptive_sampled": false, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { - "traceparent": "00-5f2796876f44a3c898994ce2668e2222-b4a146e3237b4df1-01" + "traceparent": "00-87b1c9a429205b25e5b687d890d4821f-afe162ae3117a892-00", + "tracestate": "33@nr=0-0-11-30299-afe162ae3117a892-0b752e7f02c85205-0-0.000012-1518469636035" } ], "outbound_payloads": [ { "exact": { "traceparent.version": "00", - "traceparent.trace_id": "5f2796876f44a3c898994ce2668e2222", + "traceparent.trace_id": "87b1c9a429205b25e5b687d890d4821f", "tracestate.tenant_id": "33", - "tracestate.version": 0, - "tracestate.parent_type": 0, - "tracestate.parent_account_id": "33" + "tracestate.version": "0", + "tracestate.parent_type": "0", + "tracestate.parent_account_id": "99", + "tracestate.sampled": "0", + "tracestate.priority": "0.000012" }, "expected": [ "traceparent.trace_flags", @@ -1283,254 +2549,381 @@ "tracestate.span_id", "tracestate.transaction_id", "tracestate.parent_application_id", - "tracestate.timestamp", - "tracestate.sampled", - "tracestate.priority" - ] + "tracestate.timestamp" + ] } + ], + "intrinsics": { + "target_events": ["Transaction"], + "common":{ + "exact": { + "traceId": "87b1c9a429205b25e5b687d890d4821f", + "priority": 0.000012, + "sampled": false + }, + "expected": ["guid"], + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes"] + }, + "Transaction": { + "exact": { + "parent.type": "App", + "parent.app": "30299", + "parent.account": "11", + "parent.transportType": "HTTP", + "parentId": "0b752e7f02c85205", + "parentSpanId": "afe162ae3117a892" + }, + "expected": ["parent.transportDuration"] + } + }, + "expected_metrics": [ + ["DurationByCaller/App/11/30299/HTTP/all", 1], + ["DurationByCaller/App/11/30299/HTTP/allWeb", 1], + ["Supportability/TraceContext/Accept/Success", 1] + ] + }, + { + "test_name": "w3c_and_newrelic_headers_present", + "comment": "outbound newrelic headers are built from w3c headers, ignoring inbound newrelic headers", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "force_adaptive_sampled": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "inbound_headers": [ + { + "traceparent": "00-da8bc8cc6d062849b0efcf3c169afb5a-7d3efb1b173fecfa-01", + "tracestate": "33@nr=0-0-33-2827902-7d3efb1b173fecfa-e8b91a159289ff74-1-1.23456-1518469636035", + "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"Mobile\",\"ac\":\"123\",\"ap\":\"51424\",\"id\":\"5f474d64b9cc9b2a\",\"tr\":\"6e2fea0b173fdad0\",\"pr\":0.1234,\"sa\":true,\"ti\":1482959525577,\"tx\":\"27856f70d3d314b7\"}}" + } + ], + "outbound_payloads": [ + { + "exact": { + "newrelic.v": [0, 1], + "newrelic.d.ty": "App", + "newrelic.d.ac": "33", + "newrelic.d.tr": "da8bc8cc6d062849b0efcf3c169afb5a", + "newrelic.d.pr": 1.23456, + "newrelic.d.sa": true + }, + "expected": [ + "newrelic.d.pr", + "newrelic.d.ap", + "newrelic.d.tx", + "newrelic.d.ti", + "newrelic.d.id"], + "unexpected": ["newrelic.d.tk"] } ], "intrinsics": { "target_events": ["Transaction", "Span"], "common":{ "exact": { - "traceId": "5f2796876f44a3c898994ce2668e2222", + "traceId": "da8bc8cc6d062849b0efcf3c169afb5a", + "priority": 1.23456, "sampled": true }, - "expected": ["guid", "priority"], + "expected": ["guid"], "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes"] }, "Transaction": { "exact": { - "parentSpanId": "b4a146e3237b4df1" + "parent.type": "App", + "parent.app": "2827902", + "parent.account": "33", + "parent.transportType": "HTTP", + "parentId": "e8b91a159289ff74", + "parentSpanId": "7d3efb1b173fecfa" }, - "expected": ["parent.transportType"], - "unexpected": [ - "parent.transportDuration", - "parent.type", - "parent.app", - "parent.account", - "parentId" - ] + "expected": ["parent.transportDuration"] }, "Span": { "exact": { - "parentId": "b4a146e3237b4df1" + "parentId": "7d3efb1b173fecfa", + "trustedParentId": "7d3efb1b173fecfa" }, "expected": ["transactionId"], - "unexpected": [ - "parent.transportDuration", - "parent.type", - "parent.app", - "parent.account", - "parent.transportType", - "tracingVendors", - "trustedParentId" - ] + "unexpected": ["parent.transportDuration", "parent.type", "parent.app", "parent.account", "parent.transportType", "tracingVendors"] } }, "expected_metrics": [ - ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/all", 1], - ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/allWeb", 1] + ["DurationByCaller/App/33/2827902/HTTP/all", 1], + ["DurationByCaller/App/33/2827902/HTTP/allWeb", 1], + ["TransportDuration/App/33/2827902/HTTP/all", 1], + ["TransportDuration/App/33/2827902/HTTP/allWeb", 1], + ["Supportability/TraceContext/Accept/Success", 1] ] }, { - "test_name": "missing_traceparent", + "test_name": "w3c_and_newrelic_headers_present_error_parsing_traceparent", + "comment": [ + "If the traceparent header is present on an inbound request, conforming agents MUST", + "ignore any newrelic header. If the traceparent header is invalid, a new trace MUST", + "be started. The newrelic header MUST be used _only_ when traceparent is _missing_." + ], "trusted_account_key": "33", "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": true, + "force_adaptive_sampled": true, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { - "tracestate": "foo=1,bar=2" + "traceparent": "garbage", + "tracestate": "33@nr=0-0-33-2827902-7d3efb1b173fecfa-e8b91a159289ff74-1-1.23456-1518469636035", + "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"Mobile\",\"ac\":\"33\",\"ap\":\"51424\",\"id\":\"5f474d64b9cc9b2a\",\"tr\":\"6e2fea0b173fdad0\",\"pr\":0.1234,\"sa\":true,\"ti\":1482959525577,\"tx\":\"27856f70d3d314b7\"}}" } ], "outbound_payloads": [ { "exact": { - "traceparent.version": "00", - "tracestate.tenant_id": "33", - "tracestate.version": 0, - "tracestate.parent_type": 0, - "tracestate.parent_account_id": "33" + "newrelic.v": [0, 1], + "newrelic.d.ty": "App", + "newrelic.d.ac": "33", + "newrelic.d.sa": true + }, + "notequal": { + "newrelic.d.tr": "6e2fea0b173fdad0" }, "expected": [ - "traceparent.trace_id", - "traceparent.trace_flags", - "traceparent.parent_id", - "tracestate.span_id", - "tracestate.transaction_id", - "tracestate.parent_application_id", - "tracestate.timestamp", - "tracestate.sampled", - "tracestate.priority" + "newrelic.d.pr", + "newrelic.d.ap", + "newrelic.d.tx", + "newrelic.d.ti", + "newrelic.d.id", + "newrelic.d.tr" ], - "vendors": [ - ] + "unexpected": ["newrelic.d.tk"] } ], + "intrinsics": { + "target_events": ["Span"], + "common":{ + "expected": ["guid", "traceId", "priority", "sampled"], + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.type", "parent.app", "parent.account", "parentId", "parentSpanId", "parent.transportDuration", "tracingVendors"] + }, + "Span": { + "expected": ["transactionId"] + } + }, "expected_metrics": [ - ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/all", 1], - ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/allWeb", 1] + ["Supportability/TraceContext/TraceParent/Parse/Exception", 1] ] }, { - "test_name": "missing_traceparent_and_tracestate", + "test_name": "w3c_and_newrelic_headers_present_error_parsing_tracestate", "trusted_account_key": "33", "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": true, + "force_adaptive_sampled": true, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ - { } + { + "traceparent": "00-da8bc8cc6d062849b0efcf3c169afb5a-7d3efb1b173fecfa-01", + "tracestate": "33@nr=garbage", + "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"Mobile\",\"ac\":\"123\",\"ap\":\"51424\",\"id\":\"5f474d64b9cc9b2a\",\"tr\":\"6e2fea0b173fdad0\",\"pr\":0.1234,\"sa\":true,\"ti\":1482959525577,\"tx\":\"27856f70d3d314b7\"}}" + } ], "outbound_payloads": [ { "exact": { - "traceparent.version": "00", - "tracestate.tenant_id": "33", - "tracestate.version": 0, - "tracestate.parent_type": 0, - "tracestate.parent_account_id": "33" + "newrelic.v": [0, 1], + "newrelic.d.ty": "App", + "newrelic.d.ac": "33", + "newrelic.d.tr": "da8bc8cc6d062849b0efcf3c169afb5a", + "newrelic.d.sa": true }, "expected": [ - "traceparent.trace_id", - "traceparent.trace_flags", - "traceparent.parent_id", - "tracestate.span_id", - "tracestate.transaction_id", - "tracestate.parent_application_id", - "tracestate.timestamp", - "tracestate.sampled", - "tracestate.priority" - ] + "newrelic.d.pr", + "newrelic.d.ap", + "newrelic.d.tx", + "newrelic.d.ti", + "newrelic.d.id" + ], + "unexpected": ["newrelic.d.tk"] } ], + "intrinsics": { + "target_events": ["Transaction", "Span"], + "common":{ + "exact": { + "traceId": "da8bc8cc6d062849b0efcf3c169afb5a", + "sampled": true + }, + "expected": ["guid", "priority"], + "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.type", "parent.app", "parent.account", "parent.transportDuration", "trustedParentId"] + }, + "Transaction": { + "exact": { + "parent.transportType": "HTTP", + "parentSpanId": "7d3efb1b173fecfa" + }, + "unexpected": ["parentId"] + }, + "Span": { + "exact": { + "parentId": "7d3efb1b173fecfa" + }, + "expected": ["transactionId"], + "unexpected": ["tracingVendors"] + } + }, "expected_metrics": [ ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/all", 1], - ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/allWeb", 1] + ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/allWeb", 1], + ["Supportability/TraceContext/TraceState/InvalidNrEntry", 1] ] }, { - "test_name": "multiple_new_relic_trace_state_entries", + "test_name": "newrelic_origin_trace_id_correctly_transformed_for_w3c", + "comment": [ + "Tests correct handling of newrelic headers", + "Agents may receive a traceId in upper-case, or shorter than 32 characters.", + "In this case, the traceId MUST be left-padded with zeros AND lower-cased", + "The outbound newrelic header, if configured, should include the traceId as-received." + ], "trusted_account_key": "33", - "account_id": "99", + "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": false, + "force_adaptive_sampled": false, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { - "traceparent": "00-87b1c9a429205b25e5b687d890d4821f-afe162ae3117a892-00", - "tracestate": "44@nr=0-0-11-30299-afe162ae3117a892-0b752e7f02c85205-0-0.123456-1518469636035,33@nr=0-0-33-2827902-7d3efb1b173fecfa-b79e301bd0ffed87-1-1.23456-1518469636025" + "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"App\",\"ac\":\"33\",\"ap\":\"51424\",\"id\":\"5f474d64b9cc9b2a\",\"tr\":\"6E2fEA0B173FDAD0\",\"pr\":1.1234321,\"sa\":true,\"ti\":1482959525577,\"tx\":\"27856f70d3d314b7\"}}" } ], "outbound_payloads": [ { "exact": { "traceparent.version": "00", - "traceparent.trace_id": "87b1c9a429205b25e5b687d890d4821f", + "traceparent.trace_id": "00000000000000006e2fea0b173fdad0", + "traceparent.trace_flags": "01", "tracestate.tenant_id": "33", - "tracestate.version": 0, - "tracestate.parent_type": 0, - "tracestate.parent_account_id": "99", - "tracestate.sampled": true, - "tracestate.priority": 1.23456 + "tracestate.version": "0", + "tracestate.parent_type": "0", + "tracestate.parent_account_id": "33", + "tracestate.sampled": "1", + "tracestate.priority": "1.123432", + "newrelic.v": [0, 1], + "newrelic.d.ty": "App", + "newrelic.d.ac": "33", + "newrelic.d.tr": "6E2fEA0B173FDAD0", + "newrelic.d.sa": true }, "expected": [ - "traceparent.trace_flags", "traceparent.parent_id", + "tracestate.timestamp", + "tracestate.parent_application_id", "tracestate.span_id", "tracestate.transaction_id", - "tracestate.parent_application_id", - "tracestate.timestamp" + "newrelic.d.ap", + "newrelic.d.tx", + "newrelic.d.ti", + "newrelic.d.id", + "newrelic.d.pr" ], - "vendors": [ - "44@nr" - ] + "unexpected": ["newrelic.d.tk"] } ], "intrinsics": { "target_events": ["Transaction", "Span"], "common":{ "exact": { - "traceId": "87b1c9a429205b25e5b687d890d4821f", - "priority": 1.23456, + "traceId": "6E2fEA0B173FDAD0", "sampled": true }, - "expected": ["guid"], + "expected": ["guid", "priority"], "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes"] }, "Transaction": { "exact": { "parent.type": "App", - "parent.app": "2827902", "parent.account": "33", + "parent.app": "51424", "parent.transportType": "HTTP", - "parentId": "b79e301bd0ffed87", - "parentSpanId": "afe162ae3117a892" + "parentSpanId": "5f474d64b9cc9b2a", + "parentId": "27856f70d3d314b7" }, "expected": ["parent.transportDuration"] }, "Span": { "exact": { - "parentId": "afe162ae3117a892", - "trustedParentId": "7d3efb1b173fecfa", - "tracingVendors": "44@nr" + "parentId": "5f474d64b9cc9b2a" }, "expected": ["transactionId"], - "unexpected": ["parent.transportDuration", "parent.type", "parent.app", "parent.account", "parent.transportType"] + "unexpected": ["tracingVendors"] } }, "expected_metrics": [ - ["DurationByCaller/App/33/2827902/HTTP/all", 1], - ["DurationByCaller/App/33/2827902/HTTP/allWeb", 1], - ["Supportability/TraceContext/Accept/Success", 1] + ["DurationByCaller/App/33/51424/HTTP/all", 1], + ["DurationByCaller/App/33/51424/HTTP/allWeb", 1], + ["TransportDuration/App/33/51424/HTTP/all", 1], + ["TransportDuration/App/33/51424/HTTP/allWeb", 1], + ["Supportability/DistributedTrace/AcceptPayload/Success", 1] ] }, { - "test_name": "w3c_and_newrelc_headers_present", + "test_name": "span_events_enabled_transaction_events_disabled", "trusted_account_key": "33", "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": false, + "force_adaptive_sampled": true, "span_events_enabled": true, + "transaction_events_enabled": false, "transport_type": "HTTP", "inbound_headers": [ { - "traceparent": "00-da8bc8cc6d062849b0efcf3c169afb5a-7d3efb1b173fecfa-01", - "tracestate": "33@nr=0-0-33-2827902-7d3efb1b173fecfa-e8b91a159289ff74-1-1.23456-1518469636035", - "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"Mobile\",\"ac\":\"123\",\"ap\":\"51424\",\"id\":\"5f474d64b9cc9b2a\",\"tr\":\"6e2fea0b173fdad0\",\"pr\":0.1234,\"sa\":true,\"ti\":1482959525577,\"tx\":\"27856f70d3d314b7\"}}" + "traceparent": "00-e22175eb1d68b6de32bf70e38458ccc3-7d3efb1b173fecfa-01", + "tracestate": "33@nr=0-0-33-2827902-7d3efb1b173fecfa-e8b91a159289ff74-1-1.23456-1518469636035" + } + ], + "outbound_payloads": [ + { + "exact": { + "traceparent.version": "00", + "traceparent.trace_id": "e22175eb1d68b6de32bf70e38458ccc3", + "traceparent.trace_flags": "01", + "tracestate.tenant_id": "33", + "tracestate.version": "0", + "tracestate.parent_type": "0", + "tracestate.parent_account_id": "33", + "tracestate.sampled": "1", + "tracestate.priority": "1.23456" + }, + "expected": [ + "traceparent.parent_id", + "tracestate.span_id", + "tracestate.timestamp", + "tracestate.parent_application_id" + ], + "unexpected": [ + "tracestate.transaction_id" + ] } ], "intrinsics": { - "target_events": ["Transaction", "Span"], + "target_events": ["Span"], "common":{ "exact": { - "traceId": "da8bc8cc6d062849b0efcf3c169afb5a", + "traceId": "e22175eb1d68b6de32bf70e38458ccc3", "priority": 1.23456, "sampled": true }, "expected": ["guid"], "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes"] }, - "Transaction": { - "exact": { - "parent.type": "App", - "parent.app": "2827902", - "parent.account": "33", - "parent.transportType": "HTTP", - "parentId": "e8b91a159289ff74", - "parentSpanId": "7d3efb1b173fecfa" - }, - "expected": ["parent.transportDuration"] - }, "Span": { "exact": { "parentId": "7d3efb1b173fecfa", @@ -1545,159 +2938,298 @@ ["DurationByCaller/App/33/2827902/HTTP/allWeb", 1], ["TransportDuration/App/33/2827902/HTTP/all", 1], ["TransportDuration/App/33/2827902/HTTP/allWeb", 1], - ["Supportability/TraceContext/Accept/Success", 1] + ["Supportability/TraceContext/Accept/Success", 1], + ["Supportability/TraceContext/Create/Success", 1] ] }, { - "test_name": "w3c_and_newrelc_headers_present_error_parsing_traceparent", + "test_name": "span_events_disabled_transaction_events_disabled", + "comment": [ + "With both spans and transaction events disabled, there will be no ", + "events to verify intrinsics against. tracestate.span_id and ", + "tracestate.transaction_id are not expected on outbound payloads." + ], "trusted_account_key": "33", "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": true, - "span_events_enabled": true, + "force_adaptive_sampled": true, + "span_events_enabled": false, + "transaction_events_enabled": false, "transport_type": "HTTP", "inbound_headers": [ { - "traceparent": "garbage", - "tracestate": "33@nr=0-0-33-2827902-7d3efb1b173fecfa-e8b91a159289ff74-1-1.23456-1518469636035", - "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"Mobile\",\"ac\":\"123\",\"ap\":\"51424\",\"id\":\"5f474d64b9cc9b2a\",\"tr\":\"6e2fea0b173fdad0\",\"pr\":0.1234,\"sa\":true,\"ti\":1482959525577,\"tx\":\"27856f70d3d314b7\"}}" + "traceparent": "00-e22175eb1d68b6de32bf70e38458ccc3-7d3efb1b173fecfa-01", + "tracestate": "33@nr=0-0-33-2827902-7d3efb1b173fecfa-e8b91a159289ff74-1-1.23456-1518469636035" } ], - "intrinsics": { - "target_events": ["Transaction", "Span"], - "common":{ - "expected": ["guid", "traceId", "priority", "sampled"], - "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.type", "parent.app", "parent.account", "parentId", "parentSpanId", "parent.transportDuration", "tracingVendors"] - }, - "Span": { - "expected": ["transactionId"] + "outbound_payloads": [ + { + "exact": { + "traceparent.version": "00", + "traceparent.trace_id": "e22175eb1d68b6de32bf70e38458ccc3", + "traceparent.trace_flags": "01", + "tracestate.tenant_id": "33", + "tracestate.version": "0", + "tracestate.parent_type": "0", + "tracestate.parent_account_id": "33", + "tracestate.sampled": "1", + "tracestate.priority": "1.23456" + }, + "expected": [ + "traceparent.parent_id", + "tracestate.timestamp", + "tracestate.parent_application_id" + ], + "unexpected": [ + "tracestate.span_id", + "tracestate.transaction_id" + ] } - }, + ], "expected_metrics": [ - ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/all", 1], - ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/allWeb", 1], - ["Supportability/TraceContext/TraceParent/Parse/Exception", 1] + ["DurationByCaller/App/33/2827902/HTTP/all", 1], + ["DurationByCaller/App/33/2827902/HTTP/allWeb", 1], + ["TransportDuration/App/33/2827902/HTTP/all", 1], + ["TransportDuration/App/33/2827902/HTTP/allWeb", 1], + ["Supportability/TraceContext/Accept/Success", 1], + ["Supportability/TraceContext/Create/Success", 1] ] }, { - "test_name": "w3c_and_newrelc_headers_present_error_parsing_tracestate", + "test_name": "w3c_and_newrelic_headers_present_emit_both_header_types", "trusted_account_key": "33", "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": true, + "force_adaptive_sampled": false, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { "traceparent": "00-da8bc8cc6d062849b0efcf3c169afb5a-7d3efb1b173fecfa-01", - "tracestate": "33@nr=garbage", + "tracestate": "33@nr=0-0-33-2827902-7d3efb1b173fecfa-e8b91a159289ff74-1-1.23456-1518469636035", "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"Mobile\",\"ac\":\"123\",\"ap\":\"51424\",\"id\":\"5f474d64b9cc9b2a\",\"tr\":\"6e2fea0b173fdad0\",\"pr\":0.1234,\"sa\":true,\"ti\":1482959525577,\"tx\":\"27856f70d3d314b7\"}}" } ], - "intrinsics": { - "target_events": ["Transaction", "Span"], - "common":{ - "exact": { - "traceId": "da8bc8cc6d062849b0efcf3c169afb5a", - "sampled": true - }, - "expected": ["guid", "priority"], - "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes", "parent.type", "parent.app", "parent.account", "parent.transportDuration", "trustedParentId"] - }, - "Transaction": { + "outbound_payloads": [ + { "exact": { - "parent.transportType": "HTTP", - "parentSpanId": "7d3efb1b173fecfa" + "traceparent.version": "00", + "traceparent.trace_id": "da8bc8cc6d062849b0efcf3c169afb5a", + "tracestate.tenant_id": "33", + "tracestate.version": "0", + "tracestate.parent_type": "0", + "tracestate.parent_account_id": "33", + "tracestate.sampled": "1", + "tracestate.priority": "1.23456", + "newrelic.v": [0, 1], + "newrelic.d.ty": "App", + "newrelic.d.ac": "33", + "newrelic.d.tr": "da8bc8cc6d062849b0efcf3c169afb5a", + "newrelic.d.sa": true, + "newrelic.d.pr": 1.23456 }, - "unexpected": ["parentId"] - }, - "Span": { + "expected": [ + "traceparent.trace_flags", + "traceparent.parent_id", + "tracestate.span_id", + "tracestate.transaction_id", + "tracestate.parent_application_id", + "tracestate.timestamp", + "newrelic.d.ap", + "newrelic.d.tx", + "newrelic.d.ti", + "newrelic.d.id" + ], + "unexpected": ["newrelic.d.tk"] + } + ], + "expected_metrics": [ + ["DurationByCaller/App/33/2827902/HTTP/all", 1], + ["DurationByCaller/App/33/2827902/HTTP/allWeb", 1], + ["TransportDuration/App/33/2827902/HTTP/all", 1], + ["TransportDuration/App/33/2827902/HTTP/allWeb", 1], + ["Supportability/TraceContext/Accept/Success", 1], + ["Supportability/TraceContext/Create/Success", 1], + ["Supportability/DistributedTrace/CreatePayload/Success", 1] + ] + }, + { + "test_name": "only_w3c_headers_present_emit_both_header_types", + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "force_adaptive_sampled": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "inbound_headers": [ + { + "traceparent": "00-da8bc8cc6d062849b0efcf3c169afb5a-7d3efb1b173fecfa-01", + "tracestate": "33@nr=0-0-33-2827902-7d3efb1b173fecfa-e8b91a159289ff74-1-1.23456-1518469636035" + } + ], + "outbound_payloads": [ + { "exact": { - "parentId": "7d3efb1b173fecfa" + "traceparent.version": "00", + "traceparent.trace_id": "da8bc8cc6d062849b0efcf3c169afb5a", + "tracestate.tenant_id": "33", + "tracestate.version": "0", + "tracestate.parent_type": "0", + "tracestate.parent_account_id": "33", + "tracestate.sampled": "1", + "tracestate.priority": "1.23456", + "newrelic.v": [0, 1], + "newrelic.d.ty": "App", + "newrelic.d.ac": "33", + "newrelic.d.tr": "da8bc8cc6d062849b0efcf3c169afb5a", + "newrelic.d.sa": true, + "newrelic.d.pr": 1.23456 }, - "expected": ["transactionId"], - "unexpected": ["tracingVendors"] + "expected": [ + "traceparent.trace_flags", + "traceparent.parent_id", + "tracestate.span_id", + "tracestate.transaction_id", + "tracestate.parent_application_id", + "tracestate.timestamp", + "newrelic.d.ap", + "newrelic.d.tx", + "newrelic.d.ti", + "newrelic.d.id" + ], + "unexpected": ["newrelic.d.tk"] } - }, + ], "expected_metrics": [ - ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/all", 1], - ["DurationByCaller/Unknown/Unknown/Unknown/HTTP/allWeb", 1], - ["Supportability/TraceContext/TraceState/InvalidNrEntry", 1] + ["DurationByCaller/App/33/2827902/HTTP/all", 1], + ["DurationByCaller/App/33/2827902/HTTP/allWeb", 1], + ["TransportDuration/App/33/2827902/HTTP/all", 1], + ["TransportDuration/App/33/2827902/HTTP/allWeb", 1], + ["Supportability/TraceContext/Accept/Success", 1], + ["Supportability/TraceContext/Create/Success", 1], + ["Supportability/DistributedTrace/CreatePayload/Success", 1] ] }, { - "test_name": "trace_id_is_left_padded_and_priority_rounded", + "test_name": "only_newrelic_headers_present_emit_both_header_types", "trusted_account_key": "33", "account_id": "33", "web_transaction": true, "raises_exception": false, - "force_sampled_true": false, + "force_adaptive_sampled": false, "span_events_enabled": true, + "transaction_events_enabled": true, "transport_type": "HTTP", "inbound_headers": [ { - "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"App\",\"ac\":\"33\",\"ap\":\"51424\",\"id\":\"5f474d64b9cc9b2a\",\"tr\":\"6e2fea0b173fdad0\",\"pr\":1.1234321,\"sa\":true,\"ti\":1482959525577,\"tx\":\"27856f70d3d314b7\"}}" + "newrelic": "{\"v\":[0,1],\"d\":{\"ty\":\"App\",\"ac\":\"33\",\"ap\":\"2827902\",\"id\":\"5f474d64b9cc9b2a\",\"tr\":\"da8bc8cc6d062849b0efcf3c169afb5a\",\"pr\":1.23456,\"sa\":true,\"ti\":1482959525577,\"tx\":\"27856f70d3d314b7\"}}" } ], "outbound_payloads": [ { "exact": { "traceparent.version": "00", - "traceparent.trace_id": "00000000000000006e2fea0b173fdad0", - "traceparent.trace_flags": "01", + "traceparent.trace_id": "da8bc8cc6d062849b0efcf3c169afb5a", "tracestate.tenant_id": "33", - "tracestate.version": 0, - "tracestate.parent_type": 0, + "tracestate.version": "0", + "tracestate.parent_type": "0", "tracestate.parent_account_id": "33", - "tracestate.sampled": true, - "tracestate.priority": 1.123432 + "tracestate.sampled": "1", + "tracestate.priority": "1.23456", + "newrelic.v": [0, 1], + "newrelic.d.ty": "App", + "newrelic.d.ac": "33", + "newrelic.d.tr": "da8bc8cc6d062849b0efcf3c169afb5a", + "newrelic.d.sa": true, + "newrelic.d.pr": 1.23456 }, "expected": [ + "traceparent.trace_flags", "traceparent.parent_id", - "tracestate.timestamp", - "tracestate.parent_application_id", "tracestate.span_id", - "tracestate.transaction_id" - ] + "tracestate.transaction_id", + "tracestate.parent_application_id", + "tracestate.timestamp", + "newrelic.d.ap", + "newrelic.d.tx", + "newrelic.d.ti", + "newrelic.d.id" + ], + "unexpected": ["newrelic.d.tk"] + } + ], + "expected_metrics": [ + ["DurationByCaller/App/33/2827902/HTTP/all", 1], + ["DurationByCaller/App/33/2827902/HTTP/allWeb", 1], + ["TransportDuration/App/33/2827902/HTTP/all", 1], + ["TransportDuration/App/33/2827902/HTTP/allWeb", 1], + ["Supportability/DistributedTrace/AcceptPayload/Success", 1], + ["Supportability/TraceContext/Create/Success", 1], + ["Supportability/DistributedTrace/CreatePayload/Success", 1] + ] + }, + { + "test_name": "inbound_payload_from_agent_in_serverless_mode", + "comment": [ + "Test a payload that originates from a serverless agent. The only", + "difference in the payload between a serverless and non-serverless agent", + "is the `appId` in the tracestate header will be 'Unknown'." + ], + "trusted_account_key": "33", + "account_id": "33", + "web_transaction": true, + "raises_exception": false, + "force_adaptive_sampled": false, + "span_events_enabled": true, + "transaction_events_enabled": true, + "transport_type": "HTTP", + "inbound_headers": [ + { + "traceparent": "00-da8bc8cc6d062849b0efcf3c169afb5a-7d3efb1b173fecfa-01", + "tracestate": "33@nr=0-0-33-Unknown-7d3efb1b173fecfa-e8b91a159289ff74-1-1.23456-1518469636035" } ], "intrinsics": { "target_events": ["Transaction", "Span"], "common":{ "exact": { - "traceId": "6e2fea0b173fdad0", + "traceId": "da8bc8cc6d062849b0efcf3c169afb5a", + "priority": 1.23456, "sampled": true }, - "expected": ["guid", "priority"], + "expected": ["guid"], "unexpected": ["grandparentId", "cross_process_id", "nr.tripId", "nr.pathHash", "nr.referringPathHash", "nr.guid", "nr.referringTransactionGuid", "nr.alternatePathHashes"] }, "Transaction": { "exact": { "parent.type": "App", + "parent.app": "Unknown", "parent.account": "33", - "parent.app": "51424", "parent.transportType": "HTTP", - "parentSpanId": "5f474d64b9cc9b2a", - "parentId": "27856f70d3d314b7" + "parentId": "e8b91a159289ff74", + "parentSpanId": "7d3efb1b173fecfa" }, "expected": ["parent.transportDuration"] }, "Span": { "exact": { - "parentId": "5f474d64b9cc9b2a" + "parentId": "7d3efb1b173fecfa", + "trustedParentId": "7d3efb1b173fecfa" }, "expected": ["transactionId"], - "unexpected": ["tracingVendors"] + "unexpected": ["parent.transportDuration", "parent.type", "parent.app", "parent.account", "parent.transportType", "tracingVendors"] } }, "expected_metrics": [ - ["DurationByCaller/App/33/51424/HTTP/all", 1], - ["DurationByCaller/App/33/51424/HTTP/allWeb", 1], - ["TransportDuration/App/33/51424/HTTP/all", 1], - ["TransportDuration/App/33/51424/HTTP/allWeb", 1], - ["Supportability/DistributedTrace/AcceptPayload/Success", 1] + ["DurationByCaller/App/33/Unknown/HTTP/all", 1], + ["DurationByCaller/App/33/Unknown/HTTP/allWeb", 1], + ["TransportDuration/App/33/Unknown/HTTP/all", 1], + ["TransportDuration/App/33/Unknown/HTTP/allWeb", 1] ] } ] diff --git a/tests/cross_agent/fixtures/samplers/README.md b/tests/cross_agent/fixtures/samplers/README.md new file mode 100644 index 0000000000..13c35ca8ed --- /dev/null +++ b/tests/cross_agent/fixtures/samplers/README.md @@ -0,0 +1,92 @@ +# Samplers + +With the introduction of Otel-style sampling algorithms and core tracing, we now have many configurable samplers +that may be working simultaneously within one application. These tests describe how the samplers should be set up +based on local config, and how they are expected to behave under traffic. + +## sampler_configuration.json + +This is a small test describing the samplers that should be created based on local config. + +### Full Test Parameters + +| Parameter | Description | +| --- | --- | +| `test_name` | The name of this test | +|`comment`| A longer description of the test | +|`config`| The local sampler config, provided as a nested JSON Object | +|`expected_samplers`|The samplers that should have been created based on the local config, provided as a nested JSON object whose keys are one or more of `full_root`, `full_remote_parent_sampled`, `full_remote_parent_not_sampled`, `partial_root`, `partial_remote_parent_sampled`, `partial_remote_parent_not_sampled`. If a sampler is not specified in `expected_samplers`, this is because the sampler is expected to have been disabled by the local config. | + +Additionally, each expected sampler will have one or more of the properties below: + +| Expected sampler property | Description | +| --- | --- | +| `type` | The type of the sampler that was created. Options are `always_on`, `always_off`, `trace_id_ratio_based`, and `adaptive`. | +| `is_global_adaptive_sampler` | Whether this sampler is the shared global instance of the adaptive sampler. If `false`, then this sampler MUST be a unique adaptive sampler instance. | +| `ratio` | The expected ratio this sampler should use, if this is a `trace_id_ratio_based` sampler. | +| `target` | The sampling target the sampler should use, if this is an `adaptive` sampler. If a test with an adaptive sampler is missing this, it is because the global adaptive sampler is in use and no global `adaptive_sampling_target` has been configured (so the target will vary depending on each team's default).| + + +## harvest_sampling_rates.json + +This test describes expected sampling rates during **one (the first), slow (60-sec) harvest** based on local config and specified traffic. + +### Test setup + +Every test case in this suite must be able to simulate a single slow harvest and the following types of transactions. Example headers are provided to help clarify the situation (you can use but you must generate random trace ids within the traceparent, otherwise ratio sampling will not work as expected). + +| Transaction type | Description | Example headers creating this scenario | +| --- | --- | --- | +| `root` | This is a root trace originating from this service | none | +| `parent_sampled_no_matching_acct_id` | The remote parent was sampled, and there was not a matching trusted account id in the headers. | trusted_account_key: 33,
{
traceparent: 00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01,
tracestate: 44@nr=0-0-44-2827902-0af7651916cd43dd--1--1518469636035
} | +| `parent_sampled_matching_acct_id_sampled_true` | The remote parent was sampled, there was a matching trusted acct id in the headers, and the tracestate sampled flag was set to true. | trusted_account_key: 33,
{
traceparent: 00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-01,
tracestate: 33@nr=0-0-33-2827902-0af7651916cd43dd--1--1518469636035
} | +| `parent_not_sampled_no_matching_acct_id` | The remote parent was not sampled, and there was not a matching trusted acct id in the headers. |trusted_account_key: 33,
{
traceparent: 00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-00,
tracestate: 44@nr=0-0-44-2827902-0af7651916cd43dd--1-1.2-1518469636035
}| +| `parent_not_sampled_matching_acct_id_sampled_true` | The remote parent not sampled, there was a matching trusted acct id in the headers, and the tracestate sampled flag was set to true.| trusted_account_key: 33,
{
traceparent: 00-0af7651916cd43dd8448eb211c80319c-00f067aa0ba902b7-00,
tracestate: 33@nr=0-0-33-2827902-0af7651916cd43dd--1--1518469636035
} | + +### Full Test Parameters + +| Parameter | Description | +| --- | --- | +| `test_name` | The name of this test | +|`comment` | A longer description of the test | +|`config` | The local sampler config, provided as a nested JSON Object | +|`root`| The number of transactions of this type to simulate during this harvest | +|`parent_sampled_no_matching_acct_id`|(as above)| +|`parent_sampled_matching_acct_id_sampled_true`|(as above)| +|`parent_not_sampled_no_matching_acct_id`|(as above)| +|`parent_not_sampled_matching_acct_id_sampled_true`|(as above)| +|`expected_sampled`| The total number of transactions that should have been sampled. | +|`expected_sampled_full`| The total number of transactions that should have been sampled at full granularity. | +|`expected_sampled_partial`| The total number of transactions that should have been sampled at partial granularity. | +|`expected_adaptive_sampler_decisions`| The number of new sampling decisions that the adaptive sampler had to compute. **Note**: This is an optional assertion, and would require mocking, spying or instrumentating the AdaptiveSampler to indicate it's being used to compute a sampling decision.| +|`variance`|The acceptable variance in the expected values for this test, expressed as a decimal. Eg: if `variance = 0.1` and `expected_sampled = 100`, the test passes if `90 <= actual total sampled <= 110`. This is provided for tests that include a trace id ratio based sampler (see Nondeterministic Sampler Behavior below).| + +### Explanation of traffic types + +The list of cases above might seem odd. The cases are intentionally specific to hone in on important details of how our samplers should work. +We need to verify the behavior for `root`, `remote_parent_sampled`, and `remote_parent_not_sampled` transactions for all of our samplers. + +We also need to verify additional `remote_parent` behavior for our adaptive sampler. For brevity, the explanation below is in WC3-speak (though proprietary newrelic headers also apply). +- After `remote_parent_sampled` or `remote_parent_not_sampled` has been determined from the traceparent header, +the adaptive sampler looks for a matching trusted account id off the tracestate header. The id it finds may or may not match. + - => We need to vary our cases based on whether or not a matching account id was found (eg, `parent_sampled_no_matching_acct_id` vs `parent_sampled_matching_acct_id_sampled_true`). +- Next, if a matching id was found, the adaptive sampler should not run, and instead reuse the `sampled` flag on the tracestate header. This `sampled` flag may or may not +match the `remote_parent_sampled/not_sampled` flag we pulled earlier from the traceparent. (It is also possible for the tracestate `sampled` flag to be missing, but that is out of scope for these tests). + - => We need to vary our test cases to cover scenarios where the two sampling flags match (`parent_sampled_matching_acct_id_sampled_true`) or + do not match (`parent_not_sampled_matching_acct_id_sampled_true`). + +By including this breadth of cases, we hope to ensure these tests cover common mistakes and gotchas. + +### Nondeterministic Sampler Behavior + +The always_on and always_off samplers behave deterministically. Their expected sampling totals are always exact. + +The adaptive and trace_id_ratio_based samplers are probabilistic in the wild, so their expected sampling totals not usually exact. +To account for this non-deterministic behavior in these tests, we make the following simplifications: + +- Adaptive Sampler: this sampler **does** behave deterministically in the first harvest, when it samples exactly its target. So, we use this +to our advantage, by running each test as though it is the first harvest. Please be aware, that testing harvests after the first is still important, +and **SHOULD** be done by each team in team-specific unit tests. +- Trace Id Ratio Based Sampler: this sampler is not deterministic, but it is highly faithful to its configured ratio, especially as the number of +samples increases. Any test with a trace_id_ratio_based sampler will include a **variance** parameter (described in the test parameters table above) to account for this small margin of error. + diff --git a/tests/cross_agent/fixtures/samplers/harvest_sampling_rates.json b/tests/cross_agent/fixtures/samplers/harvest_sampling_rates.json new file mode 100644 index 0000000000..c5472bf677 --- /dev/null +++ b/tests/cross_agent/fixtures/samplers/harvest_sampling_rates.json @@ -0,0 +1,216 @@ +[ + { + "test_name": "default_configuration_root_samples_global_sampling_target", + "comment": "When only root transactions are flowing, adaptive_sampling_target-many of them should be sampled", + "config": { + "sampler": { + "adaptive_sampling_target": 10 + } + }, + "root": 50, + + "expected_sampled": 10, + "expected_sampled_full": 10, + "expected_sampled_partial": 0, + "expected_adaptive_sampler_decisions": 50 + }, + { + "test_name": "multiple_transaction_types_count_towards_global_sampling_target", + "comment": "Transactions with remote parents still count towards the global target if they lack trusted acct ids.", + "config": { + "sampler": { + "adaptive_sampling_target": 10 + } + }, + "root": 50, + "parent_sampled_no_matching_acct_id": 50, + "parent_not_sampled_no_matching_acct_id": 50, + + "expected_sampled": 10, + "expected_sampled_full": 10, + "expected_sampled_partial": 0, + "expected_adaptive_sampler_decisions": 150 + }, + { + "test_name": "txns_with_remote_parents_and_matching_acct_ids_do_not_count_towards_global_sampling_target", + "comment": "Transactions with remote parents that have matching acct key ids do not run the adaptive sampler or count towards the sampling target. They reuse the sampling decision from the tracestate.", + "config": { + "sampler": { + "adaptive_sampling_target": 25 + } + }, + "root": 50, + "parent_sampled_matching_acct_id_sampled_true": 50, + "parent_not_sampled_matching_acct_id_sampled_true": 50, + + "expected_sampled": 125, + "expected_sampled_full": 125, + "expected_sampled_partial": 0, + "expected_adaptive_sampler_decisions": 50 + }, + { + "test_name": "inbound_decisions_do_not_influence_non_adaptive_samplers", + "comment": "All samplers other than adaptive type ignore the inbound sampling decision (only sampled/not sampled flag matters)", + "config": { + "sampler": { + "remote_parent_sampled": { + "trace_id_ratio_based": { + "ratio": 0.3 + } + }, + "remote_parent_not_sampled": "always_on" + } + }, + "parent_sampled_matching_acct_id_sampled_true": 5000, + "parent_sampled_no_matching_acct_id": 5000, + "parent_not_sampled_matching_acct_id_sampled_true": 60, + "parent_not_sampled_no_matching_acct_id": 40, + + "expected_sampled": 3100, + "expected_sampled_full": 3100, + "expected_sampled_partial": 0, + "variance": 0.05 + }, + { + "test_name": "trace_ratios_should_be_additive_when_layered", + "comment": "The partial granularity sampling ratio should be added to the full granularity ratio when samplers are used simultaneously.", + "config": { + "sampler": { + "root": { + "trace_id_ratio_based": { + "ratio": 0.5 + } + }, + "remote_parent_sampled": "always_off", + "remote_parent_not_sampled": "always_off", + "partial_granularity": { + "enabled": true, + "root": { + "trace_id_ratio_based": { + "ratio": 0.3 + } + }, + "remote_parent_sampled": "always_off", + "remote_parent_not_sampled": "always_off" + } + } + }, + "root": 10000, + "expected_sampled": 8000, + "expected_sampled_full": 5000, + "expected_sampled_partial": 3000, + "variance": 0.05 + }, + { + "test_name": "should_create_multiple_instances_of_adaptive_sampler", + "config": { + "sampler": { + "root": { + "adaptive": { + "sampling_target": 10 + } + }, + "remote_parent_sampled": { + "adaptive": { + "sampling_target": 10 + } + }, + "remote_parent_not_sampled": { + "adaptive": { + "sampling_target": 10 + } + }, + "partial_granularity": { + "enabled": true, + "root": { + "adaptive": { + "sampling_target": 15 + } + }, + "remote_parent_sampled": { + "adaptive": { + "sampling_target": 15 + } + }, + "remote_parent_not_sampled": { + "adaptive": { + "sampling_target": 15 + } + } + } + } + }, + "root": 100, + "parent_sampled_no_matching_acct_id": 100, + "parent_not_sampled_no_matching_acct_id": 100, + + "expected_sampled": 75, + "expected_sampled_full": 30, + "expected_sampled_partial": 45 + }, + { + "test_name": "giant_example_from_spec", + "comment": "Multiple sampler types are configured. 15000 root + 500 remote_parent_sampled + 500 remote_parent_not_sampled transactions are sampled.", + "config": { + "sampler": { + "root": { + "trace_id_ratio_based": { + "ratio": 0.1 + } + }, + "remote_parent_sampled": "always_off", + "remote_parent_not_sampled": "always_on", + "partial_granularity": { + "enabled": true, + "type": "essential", + "root": { + "trace_id_ratio_based": { + "ratio": 0.4 + } + }, + "remote_parent_sampled": { + "trace_id_ratio_based": { + "ratio": 1.0 + } + }, + "remote_parent_not_sampled": "always_off" + } + } + }, + "root": 15000, + "parent_sampled_matching_acct_id_sampled_true": 500, + "parent_not_sampled_matching_acct_id_sampled_true": 500, + + "expected_sampled": 8500, + "expected_sampled_full": 2000, + "expected_sampled_partial": 6500, + "variance": 0.05 + }, + { + "test_name": "adaptive_and_ratio_samplers_are_layered", + "comment": "30 roots are sampled by the adaptive sampler at full granularity, followed by 0.5 * (10000 remaining) = 5000 roots sampled at partial granularity.", + "config": { + "sampler": { + "root": { + "adaptive": { + "sampling_target": 30 + } + }, + "partial_granularity": { + "enabled": true, + "root": { + "trace_id_ratio_based": { + "ratio": 0.5 + } + } + } + } + }, + "root": 10030, + + "expected_sampled": 5030, + "expected_sampled_full": 30, + "expected_sampled_partial": 5000, + "variance": 0.05 + } +] diff --git a/tests/cross_agent/fixtures/samplers/sampler_configuration.json b/tests/cross_agent/fixtures/samplers/sampler_configuration.json new file mode 100644 index 0000000000..96ebac6054 --- /dev/null +++ b/tests/cross_agent/fixtures/samplers/sampler_configuration.json @@ -0,0 +1,207 @@ +[ + { + "test_name": "default_configuration", + "comment": "The default configuration uses the global adaptive sampler at full granularity.", + "config": {}, + "expected_samplers": { + "full_root": { + "type": "adaptive", + "is_global_adaptive_sampler": true + }, + "full_remote_parent_sampled": { + "type": "adaptive", + "is_global_adaptive_sampler": true + }, + "full_remote_parent_not_sampled": { + "type": "adaptive", + "is_global_adaptive_sampler": true + } + } + }, + + { + "test_name": "sampling_target_specified_uses_new_sampler_instance", + "comment": "When a valid sampling_target is specified, the global sampler instance is not used.", + "config": { + "sampler": { + "adaptive_sampling_target": 10, + "root": { + "adaptive": { + "sampling_target" : 35 + } + }, + "remote_parent_sampled": { + "adaptive": { + "sampling_target" : 10 + } + }, + "remote_parent_not_sampled" : "adaptive", + "partial_granularity": { + "enabled": true, + "root" : { + "banana" : {} + } + } + } + }, + "expected_samplers": { + "full_root": { + "type": "adaptive", + "is_global_adaptive_sampler": false, + "target": 35 + }, + "full_remote_parent_sampled": { + "type": "adaptive", + "is_global_adaptive_sampler": false, + "target": 10 + }, + "full_remote_parent_not_sampled": { + "type": "adaptive", + "is_global_adaptive_sampler": true, + "target": 10 + }, + "partial_root": { + "type": "adaptive", + "is_global_adaptive_sampler": true, + "target": 10 + }, + "partial_remote_parent_sampled": { + "type": "adaptive", + "is_global_adaptive_sampler": true, + "target": 10 + }, + "partial_remote_parent_not_sampled": { + "type": "adaptive", + "is_global_adaptive_sampler": true, + "target": 10 + } + } + }, + { + "test_name": "no_ratio_falls_back_to_global_sampler", + "comment": "When a trace_id_ratio_based sampler is configured without a valid ratio, we should fall back to the global adaptive sampler.", + "config" : { + "sampler": { + "root" : { + "trace_id_ratio_based": {} + }, + "remote_parent_sampled": { + "trace_id_ratio_based": { + } + }, + "remote_parent_not_sampled": { + "trace_id_ratio_based": { + "ratio": 0.33 + } + } + } + }, + "expected_samplers": { + "full_root": { + "type": "adaptive", + "is_global_adaptive_sampler": true + }, + "full_remote_parent_sampled": { + "type": "adaptive", + "is_global_adaptive_sampler": true + }, + "full_remote_parent_not_sampled": { + "type": "trace_id_ratio_based", + "ratio": 0.33 + } + } + }, + { + "test_name": "layering_ratio_samplers_adjusts_partial_ratio", + "comment": "The ratio of partial gran samplers should be added to the ratio of simultaneously configured full gran samplers.", + "config": { + "sampler" : { + "root": { + "trace_id_ratio_based": { + "ratio" : 0.4 + } + }, + "partial_granularity": { + "enabled": true, + "root": { + "trace_id_ratio_based" : { + "ratio" : 0.25 + } + }, + "remote_parent_sampled": { + "trace_id_ratio_based": { + "ratio": 0.1 + } + } + } + } + }, + "expected_samplers": { + "full_root": { + "type": "trace_id_ratio_based", + "ratio": 0.4 + }, + "full_remote_parent_sampled": { + "type": "adaptive", + "is_global_adaptive_sampler": true + }, + "full_remote_parent_not_sampled": { + "type": "adaptive", + "is_global_adaptive_sampler": true + }, + "partial_root": { + "type": "trace_id_ratio_based", + "ratio": 0.65 + }, + "partial_remote_parent_sampled": { + "type": "trace_id_ratio_based", + "ratio": 0.1 + }, + "partial_remote_parent_not_sampled": { + "type": "adaptive", + "is_global_adaptive_sampler": true + } + } + }, + { + "test_name": "layering_ratios_has_no_effect_if_full_disabled", + "comment": "Ratios are not additive if full granularity is disabled.", + "config": { + "sampler": { + "full_granularity": { + "enabled": false + }, + "root": { + "trace_id_ratio_based": { + "ratio": 0.5 + } + }, + "partial_granularity": { + "enabled": true, + "root": { + "trace_id_ratio_based": { + "ratio": 0.2 + } + }, + "remote_parent_sampled": "always_on" + } + } + }, + + "expected_full_granularity_enabled": false, + "expected_partial_granularity_enabled": true, + "expected_samplers": { + "partial_root": { + "type": "trace_id_ratio_based", + "ratio": 0.2 + }, + "partial_remote_parent_sampled": { + "type": "always_on" + }, + "partial_remote_parent_not_sampled": { + "type": "adaptive", + "is_global_adaptive_sampler": true + } + } + } +] diff --git a/tests/cross_agent/test_datastore_instance.py b/tests/cross_agent/test_datastore_instance.py index a35b3e65dd..9e2fd8a392 100644 --- a/tests/cross_agent/test_datastore_instance.py +++ b/tests/cross_agent/test_datastore_instance.py @@ -86,6 +86,8 @@ class FakeModule: guid=None, agent_attributes={}, user_attributes={}, + span_link_events={}, + span_event_events={}, ) empty_stats = StatsEngine() diff --git a/tests/cross_agent/test_distributed_tracing.py b/tests/cross_agent/test_distributed_tracing.py index 2d4ca1ed72..136b94ec5e 100644 --- a/tests/cross_agent/test_distributed_tracing.py +++ b/tests/cross_agent/test_distributed_tracing.py @@ -65,7 +65,7 @@ def load_tests(): def override_compute_sampled(override): - @transient_function_wrapper("newrelic.core.adaptive_sampler", "AdaptiveSampler.compute_sampled") + @transient_function_wrapper("newrelic.core.samplers.adaptive_sampler", "AdaptiveSampler.compute_sampled") def _override_compute_sampled(wrapped, instance, args, kwargs): if override: return True diff --git a/tests/cross_agent/test_distributed_tracing_trace_context.py b/tests/cross_agent/test_distributed_tracing_trace_context.py new file mode 100644 index 0000000000..fcd65a0147 --- /dev/null +++ b/tests/cross_agent/test_distributed_tracing_trace_context.py @@ -0,0 +1,355 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import base64 +import json +from pathlib import Path + +import pytest +import webtest +from testing_support.fixtures import override_application_settings, validate_attributes +from testing_support.validators.validate_error_event_attributes import validate_error_event_attributes +from testing_support.validators.validate_span_events import validate_span_events +from testing_support.validators.validate_transaction_event_attributes import validate_transaction_event_attributes +from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics + +import newrelic.agent +from newrelic.api.transaction import current_transaction +from newrelic.api.wsgi_application import wsgi_application +from newrelic.common.encoding_utils import ( + PARENT_TYPE, + DistributedTracePayload, + NrTraceState, + W3CTraceParent, + W3CTraceState, +) +from newrelic.common.object_wrapper import transient_function_wrapper + +FIXTURE = Path(__file__).parent / "fixtures" / "distributed_tracing" / "trace_context.json" + + +def load_tests(): + result = [] + with FIXTURE.open(encoding="utf-8") as fh: + tests = json.load(fh) + + for test in tests: + _id = test.pop("test_name", None) + test_desc = test.pop("comment", None) + settings = { + "distributed_tracing.sampler.full_granularity.enabled": test.pop("full_granularity_enabled", True), + "distributed_tracing.enabled": test.pop("distributed_tracing_enabled", True), + "span_events.enabled": test.pop("span_events_enabled", True), + "transaction_events.enabled": test.pop("transaction_events_enabled", True), + "distributed_tracing.sampler._root": test.pop("root", "adaptive"), + "distributed_tracing.sampler._remote_parent_sampled": test.pop("remote_parent_sampled", "adaptive"), + "distributed_tracing.sampler._remote_parent_not_sampled": test.pop("remote_parent_not_sampled", "adaptive"), + "trusted_account_key": test.pop("trusted_account_key", None), + "account_id": test.pop("account_id", None), + "distributed_tracing.sampler.partial_granularity.enabled": test.pop("partial_granularity_enabled", False), + "distributed_tracing.sampler.partial_granularity._root": test.pop("partial_granularity_root", "adaptive"), + "distributed_tracing.sampler.partial_granularity._remote_parent_sampled": test.pop( + "partial_granularity_remote_parent_sampled", "adaptive" + ), + "distributed_tracing.sampler.partial_granularity._remote_parent_not_sampled": test.pop( + "partial_granularity_remote_parent_not_sampled", "adaptive" + ), + } + full_gran_ratio = test.pop("full_granularity_ratio", None) + if full_gran_ratio is not None: + if settings["distributed_tracing.sampler._root"] == "trace_id_ratio_based": + settings["distributed_tracing.sampler.root.trace_id_ratio_based.ratio"] = full_gran_ratio + if settings["distributed_tracing.sampler._remote_parent_sampled"] == "trace_id_ratio_based": + settings["distributed_tracing.sampler.remote_parent_sampled.trace_id_ratio_based.ratio"] = ( + full_gran_ratio + ) + if settings["distributed_tracing.sampler._remote_parent_not_sampled"] == "trace_id_ratio_based": + settings["distributed_tracing.sampler.remote_parent_not_sampled.trace_id_ratio_based.ratio"] = ( + full_gran_ratio + ) + partial_gran_ratio = test.pop("partial_granularity_ratio", None) + if partial_gran_ratio is not None: + if settings["distributed_tracing.sampler.partial_granularity._root"] == "trace_id_ratio_based": + settings["distributed_tracing.sampler.partial_granularity.root.trace_id_ratio_based.ratio"] = ( + partial_gran_ratio + ) + if ( + settings["distributed_tracing.sampler.partial_granularity._remote_parent_sampled"] + == "trace_id_ratio_based" + ): + settings[ + "distributed_tracing.sampler.partial_granularity.remote_parent_sampled.trace_id_ratio_based.ratio" + ] = partial_gran_ratio + if ( + settings["distributed_tracing.sampler.partial_granularity._remote_parent_not_sampled"] + == "trace_id_ratio_based" + ): + settings[ + "distributed_tracing.sampler.partial_granularity.remote_parent_not_sampled.trace_id_ratio_based.ratio" + ] = partial_gran_ratio + + force_adaptive_sampled = test.pop("force_adaptive_sampled", None) + expected_metrics = test.pop("expected_metrics", []) + raises_exception = test.pop("raises_exception", False) + web_transaction = test.pop("web_transaction", False) + inbound_headers = (test.pop("inbound_headers", None) or [{}])[0] + expected_priority_between = test.pop("expected_priority_between", None) + intrinsics = test.pop("intrinsics", {}) + common_exact_intrinsics = intrinsics.get("common", {}).get("exact", {}) + common_expected_intrinsics = intrinsics.get("common", {}).get("expected", []) + common_unexpected_intrinsics = intrinsics.get("common", {}).get("unexpected", []) + span_exact_intrinsics = intrinsics.get("Span", {}).get("exact", {}) + span_expected_intrinsics = intrinsics.get("Span", {}).get("expected", []) + span_unexpected_intrinsics = intrinsics.get("Span", {}).get("unexpected", []) + transaction_exact_intrinsics = intrinsics.get("Transaction", {}).get("exact", {}) + transaction_expected_intrinsics = intrinsics.get("Transaction", {}).get("expected", []) + transaction_unexpected_intrinsics = intrinsics.get("Transaction", {}).get("unexpected", []) + if "Transaction" in intrinsics.get("target_events", []): + transaction_exact_intrinsics.update(common_exact_intrinsics) + transaction_expected_intrinsics.extend(common_expected_intrinsics) + transaction_unexpected_intrinsics.extend(common_unexpected_intrinsics) + check_span_events = False + if "Span" in intrinsics.get("target_events", []): + check_span_events = True + span_exact_intrinsics.update(common_exact_intrinsics) + span_expected_intrinsics.extend(common_expected_intrinsics) + span_unexpected_intrinsics.extend(common_unexpected_intrinsics) + + payload = (test.pop("outbound_payloads", None) or [{}])[0] + traceparent_key_map = {"trace_id": "tr", "parent_id": "id", "version": "v", "trace_flags": "sa"} + tracestate_key_map = { + "tenant_id": "ac", + "version": "v", + "parent_type": "ty", + "parent_account_id": "ac", + "sampled": "sa", + "priority": "pr", + "parent_id": "pi", + "timestamp": "ti", + "parent_application_id": "ap", + "span_id": "id", + "transaction_id": "tx", + } + expected_traceparent_exact = { + traceparent_key_map[key.split(".")[1]]: value + for key, value in payload.get("exact", {}).items() + if "traceparent" in key + } + expected_tracestate_exact = { + tracestate_key_map[key.split(".")[1]]: value + for key, value in payload.get("exact", {}).items() + if "tracestate" in key + } + expected_traceparent = [ + traceparent_key_map[key.split(".")[1]] for key in payload.get("expected", []) if "traceparent" in key + ] + expected_tracestate = [ + tracestate_key_map[key.split(".")[1]] for key in payload.get("expected", []) if "tracestate" in key + ] + outbound_payloads = ( + expected_traceparent_exact, + expected_tracestate_exact, + expected_traceparent, + expected_tracestate, + ) + + transport_type = test.pop("transport_type", "HTTP") + + assert not test, f"{test} has not been fully parsed" + + param = pytest.param( + settings, + force_adaptive_sampled, + transport_type, + raises_exception, + web_transaction, + inbound_headers, + expected_priority_between, + common_exact_intrinsics, + common_expected_intrinsics, + common_unexpected_intrinsics, + transaction_exact_intrinsics, + transaction_expected_intrinsics, + transaction_unexpected_intrinsics, + check_span_events, + span_exact_intrinsics, + span_expected_intrinsics, + span_unexpected_intrinsics, + outbound_payloads, + expected_metrics, + id=_id, + ) + result.append(param) + + return result + + +def override_compute_sampled(override): + @transient_function_wrapper("newrelic.core.samplers.adaptive_sampler", "AdaptiveSampler.compute_sampled") + def _override_compute_sampled(wrapped, instance, args, kwargs): + sampled = wrapped(*args, **kwargs) + if override is None: + return sampled + return override + + return _override_compute_sampled + + +@pytest.fixture +def create_transaction(): + def _create_transaction( + test_name, + web_transaction, + transport_type, + raises_exception, + inbound_headers, + outbound_payloads, + expected_priority_between, + ): + def _task(): + txn = current_transaction() + application = txn._application._agent._applications.get(txn.settings.app_name) + # Re-initialize sampler proxy after overriding settings. + application.sampler.__init__(txn.settings) + + if raises_exception: + try: + 1 / 0 # noqa: B018 + except ZeroDivisionError: + txn.notice_error() + + txn.accept_distributed_trace_headers(inbound_headers, transport_type) + + if outbound_payloads: + headers = [] + txn.insert_distributed_trace_headers(headers) + if test_name == "multiple_create_calls": + txn.insert_distributed_trace_headers(headers) + headers = dict(headers) + + expected_traceparent_exact, expected_tracestate_exact, expected_traceparent, expected_tracestate = ( + outbound_payloads + ) + + if expected_traceparent_exact or expected_traceparent: + traceparent = W3CTraceParent.decode(headers["traceparent"]) + for key, value in expected_traceparent_exact.items(): + if key == "sa": + assert traceparent.get(key, None) == bool(int(value, 2)) + continue + assert traceparent.get(key, None) == value + for key in expected_traceparent: + assert key in traceparent + + if expected_tracestate_exact or expected_tracestate: + vendors = W3CTraceState.decode(headers["tracestate"]) + trusted_account_key = txn.settings.trusted_account_key + newrelic = vendors.pop(f"{trusted_account_key}@nr", "") + tracestate = NrTraceState.decode(newrelic, trusted_account_key) + for key, value in expected_tracestate_exact.items(): + if key == "v": + assert tracestate.get(key, None) == value + continue + if key == "ty": + assert tracestate.get(key, None) == PARENT_TYPE[str(value)] + continue + if key == "sa": + assert tracestate.get(key, None) == bool(int(value)) + continue + if key == "pr": + assert f"{tracestate.get(key, None):.6f}".rstrip("0") == value + continue + assert tracestate.get(key, None) == value + for key in expected_tracestate: + assert key in tracestate + + if expected_priority_between: + assert expected_priority_between[0] < tracestate[key] < expected_priority_between[1] + + if web_transaction: + request = newrelic.agent.WebTransactionWrapper(_task, name=test_name) + else: + request = newrelic.agent.BackgroundTaskWrapper(_task, name=test_name) + + return request + + return _create_transaction + + +@pytest.mark.parametrize( + "settings,force_adaptive_sampled,transport_type,raises_exception,web_transaction,inbound_headers,expected_priority_between,exact_intrinsics,expected_intrinsics,unexpected_intrinsics,transaction_exact_intrinsics,transaction_expected_intrinsics,transaction_unexpected_intrinsics,check_span_events,span_exact_intrinsics,span_expected_intrinsics,span_unexpected_intrinsics,outbound_payloads,expected_metrics", + load_tests(), +) +def test_distributed_tracing( + settings, + force_adaptive_sampled, + transport_type, + raises_exception, + web_transaction, + inbound_headers, + expected_priority_between, + exact_intrinsics, + expected_intrinsics, + unexpected_intrinsics, + transaction_exact_intrinsics, + transaction_expected_intrinsics, + transaction_unexpected_intrinsics, + check_span_events, + span_exact_intrinsics, + span_expected_intrinsics, + span_unexpected_intrinsics, + outbound_payloads, + expected_metrics, + request, + create_transaction, +): + test_name = request.node.callspec.id + txn_event_required = {"agent": [], "user": [], "intrinsic": transaction_expected_intrinsics} + txn_event_forgone = {"agent": [], "user": [], "intrinsic": transaction_unexpected_intrinsics} + txn_event_exact = {"agent": {}, "user": {}, "intrinsic": transaction_exact_intrinsics} + + @validate_transaction_metrics(test_name, rollup_metrics=expected_metrics, background_task=not web_transaction) + @validate_transaction_event_attributes(txn_event_required, txn_event_forgone, txn_event_exact) + @override_compute_sampled(force_adaptive_sampled) + @override_application_settings(settings) + def _test(): + transaction = create_transaction( + test_name, + web_transaction, + transport_type, + raises_exception, + inbound_headers, + outbound_payloads, + expected_priority_between, + ) + + transaction() + + if raises_exception: + error_event_required = {"agent": [], "user": [], "intrinsic": expected_intrinsics} + error_event_forgone = {"agent": [], "user": [], "intrinsic": unexpected_intrinsics} + error_event_exact = {"agent": {}, "user": {}, "intrinsic": exact_intrinsics} + _test = validate_error_event_attributes(error_event_required, error_event_forgone, error_event_exact)(_test) + + if settings["span_events.enabled"]: + if check_span_events: + _test = validate_span_events( + exact_intrinsics=span_exact_intrinsics, + expected_intrinsics=span_expected_intrinsics, + unexpected_intrinsics=span_unexpected_intrinsics, + )(_test) + else: + _test = validate_span_events(count=0)(_test) + + _test() diff --git a/tests/cross_agent/test_harvest_sampling_rates.py b/tests/cross_agent/test_harvest_sampling_rates.py new file mode 100644 index 0000000000..bd09535fa5 --- /dev/null +++ b/tests/cross_agent/test_harvest_sampling_rates.py @@ -0,0 +1,261 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import json +import random +import tempfile +import time +from pathlib import Path + +import pytest +from testing_support.fixtures import failing_endpoint, override_application_settings, override_generic_settings +from testing_support.validators.validate_function_not_called import validate_function_not_called + +from newrelic.api.application import application_instance, register_application +from newrelic.api.background_task import background_task +from newrelic.api.transaction import current_transaction +from newrelic.common.agent_http import DeveloperModeClient +from newrelic.common.object_wrapper import function_wrapper, transient_function_wrapper +from newrelic.core.application import Application +from newrelic.core.config import finalize_application_settings, global_settings +from newrelic.core.custom_event import create_custom_event +from newrelic.core.error_node import ErrorNode +from newrelic.core.external_node import ExternalNode +from newrelic.core.function_node import FunctionNode +from newrelic.core.log_event_node import LogEventNode +from newrelic.core.root_node import RootNode +from newrelic.core.stats_engine import CustomMetrics, DimensionalMetrics, SampledDataSet +from newrelic.core.transaction_node import TransactionNode +from newrelic.network.exceptions import RetryDataForRequest + +FIXTURE = Path(__file__).parent / "fixtures" / "samplers" / "harvest_sampling_rates.json" + + +def replace_section(setting): + end = setting.split(".")[-1] + if end in ("root", "remote_parent_sampled", "remote_parent_not_sampled"): + return ".".join([*setting.split(".")[:-1], f"_{end}"]) + return setting + + +def parse_to_config_paths(settings, setting, config): + if isinstance(config, dict): + for key, value in config.items(): + if isinstance(value, dict) and not value: + new_setting = replace_section(setting) + settings[new_setting] = key + continue + # If there's a case where we have root.adaptive.sampling_target we also + # need to set _root = "adaptive". This usually happens in the config or + # env var parsing so this is special handling only needed for tests. + if key in ("root", "remote_parent_sampled", "remote_parent_not_sampled"): + new_setting = f"{setting}._{key}" + v = list(value.keys())[0] if isinstance(value, dict) else value + settings[new_setting] = v + new_setting = f"{setting}.{key}" + parse_to_config_paths(settings, new_setting, value) + else: + new_setting = replace_section(setting) + settings[new_setting] = config + + +def load_tests(): + result = [] + with FIXTURE.open(encoding="utf-8") as fh: + tests = json.load(fh) + + for test in tests: + _id = test.pop("test_name", None) + test_desc = test.pop("comment", None) + + config = test.pop("config", {}) + settings = {} + parse_to_config_paths(settings, "distributed_tracing", config) + + if "distributed_tracing.sampler.adaptive_sampling_target" in settings: + settings["sampling_target"] = settings.pop("distributed_tracing.sampler.adaptive_sampling_target") + root = test.pop("root", 0) + parent_sampled_no_matching_acct_id = test.pop("parent_sampled_no_matching_acct_id", 0) + parent_not_sampled_no_matching_acct_id = test.pop("parent_not_sampled_no_matching_acct_id", 0) + parent_sampled_matching_acct_id_sampled_true = test.pop("parent_sampled_matching_acct_id_sampled_true", 0) + parent_not_sampled_matching_acct_id_sampled_true = test.pop( + "parent_not_sampled_matching_acct_id_sampled_true", 0 + ) + expected_sampled = test.pop("expected_sampled", None) + expected_sampled_full = test.pop("expected_sampled_full", None) + expected_sampled_partial = test.pop("expected_sampled_partial", None) + expected_adaptive_sampler_decisions = test.pop("expected_adaptive_sampler_decisions", None) + variance = test.pop("variance", 0) + assert not test, f"{test} has not been fully parsed." + + param = pytest.param( + settings, + root, + parent_sampled_no_matching_acct_id, + parent_not_sampled_no_matching_acct_id, + parent_sampled_matching_acct_id_sampled_true, + parent_not_sampled_matching_acct_id_sampled_true, + expected_sampled, + expected_sampled_full, + expected_sampled_partial, + expected_adaptive_sampler_decisions, + variance, + id=_id, + ) + result.append(param) + + return result + + +@pytest.mark.skip(reason="These are too time consuming in CI") +@pytest.mark.parametrize( + "settings,root,parent_sampled_no_matching_acct_id,parent_not_sampled_no_matching_acct_id,parent_sampled_matching_acct_id_sampled_true,parent_not_sampled_matching_acct_id_sampled_true,expected_sampled,expected_sampled_full,expected_sampled_partial,expected_adaptive_sampler_decisions,variance", + load_tests(), +) +def test_harvest_sampling_rates( + settings, + root, + parent_sampled_no_matching_acct_id, + parent_not_sampled_no_matching_acct_id, + parent_sampled_matching_acct_id_sampled_true, + parent_not_sampled_matching_acct_id_sampled_true, + expected_sampled, + expected_sampled_full, + expected_sampled_partial, + expected_adaptive_sampler_decisions, + variance, +): + global total + total = 0 + global partial + partial = 0 + + overide_settings = { + "trusted_account_id": "33", + "trusted_account_key": "33", + "event_harvest_config.harvest_limits.span_event_data": 10000, + } + overide_settings.update(settings) + + @override_application_settings(overide_settings) + def _test(test_adaptive=False, test_totals=False, num_tests=1): + app = application_instance("Python Agent Test (cross_agent_tests)") + application = app._agent._applications.get("Python Agent Test (cross_agent_tests)") + # Re-initialize sampler proxy after overriding settings. + application.sampler.__init__(app.settings) + # Re-initialize span event with new harvest value. + application._stats_engine.reset_span_events() + # Reset adaptive sampling decision count. + global adaptive_sampling_decisons + adaptive_sampling_decisons = 0 + + @count_adaptive_sampling_decisions() + @background_task() + def _transaction(headers): + txn = current_transaction() + + txn.accept_distributed_trace_headers(headers, "HTTP") + + for _ in range(root): + _transaction({}) + + for _ in range(parent_sampled_no_matching_acct_id): + trace_id = f"{random.getrandbits(128):032x}" + _transaction( + { + "traceparent": f"00-{trace_id}-00f067aa0ba902b7-01", + "tracestate": "22@nr=0-0-33-2827902-0af7651916cd43dd--1-1.2-1518469636035", + } + ) + + for _ in range(parent_not_sampled_no_matching_acct_id): + trace_id = f"{random.getrandbits(128):032x}" + _transaction( + { + "traceparent": f"00-{trace_id}-00f067aa0ba902b7-00", + "tracestate": "22@nr=0-0-33-2827902-0af7651916cd43dd--1-1.2-1518469636035", + } + ) + + for _ in range(parent_sampled_matching_acct_id_sampled_true): + trace_id = f"{random.getrandbits(128):032x}" + _transaction( + { + "traceparent": f"00-{trace_id}-00f067aa0ba902b7-01", + "tracestate": "33@nr=0-0-33-2827902-0af7651916cd43dd--1-1.2-1518469636035", + } + ) + + for _ in range(parent_not_sampled_matching_acct_id_sampled_true): + trace_id = f"{random.getrandbits(128):032x}" + _transaction( + { + "traceparent": f"00-{trace_id}-00f067aa0ba902b7-00", + "tracestate": "33@nr=0-0-33-2827902-0af7651916cd43dd--1-1.2-1518469636035", + } + ) + + global total + total += application._stats_engine.span_events.num_samples + global partial + partial += len([event for event in application._stats_engine.span_events.samples if event[0].get("nr.pg")]) + + if test_totals: + if expected_sampled is not None: + assert ( + expected_sampled - expected_sampled * variance + <= total / num_tests + <= expected_sampled + expected_sampled * variance + ) + if expected_sampled_partial is not None: + assert ( + expected_sampled_partial - expected_sampled_partial * variance + <= partial / num_tests + <= expected_sampled_partial + expected_sampled_partial * variance + ) + if expected_sampled_full is not None: + assert ( + expected_sampled_full - expected_sampled_full * variance + <= (total - partial) / num_tests + <= expected_sampled_full + expected_sampled_full * variance + ) + + if test_adaptive and expected_adaptive_sampler_decisions is not None: + assert ( + expected_adaptive_sampler_decisions - expected_adaptive_sampler_decisions * variance + <= adaptive_sampling_decisons + <= expected_adaptive_sampler_decisions + expected_adaptive_sampler_decisions * variance + ) + + application.harvest() + assert application._stats_engine.span_events.num_samples == 0 + + num_tests = 5 + for n in range(num_tests): + if n == 0: + _test(test_adaptive=True) + elif n == num_tests - 1: + _test(num_tests=num_tests, test_totals=True) + else: + _test() + + +def count_adaptive_sampling_decisions(): + @transient_function_wrapper("newrelic.core.samplers.adaptive_sampler", "AdaptiveSampler.compute_sampled") + def _count_adaptive_sampling_decisions(wrapped, instance, args, kwargs): + global adaptive_sampling_decisons + adaptive_sampling_decisons += 1 + return wrapped(*args, **kwargs) + + return _count_adaptive_sampling_decisions diff --git a/tests/cross_agent/test_sampler_configuration.py b/tests/cross_agent/test_sampler_configuration.py new file mode 100644 index 0000000000..d9ebcb4ea1 --- /dev/null +++ b/tests/cross_agent/test_sampler_configuration.py @@ -0,0 +1,145 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import asyncio +import copy +import json +import random +import time +from pathlib import Path + +import pytest +import webtest +from testing_support.fixtures import override_application_settings, validate_attributes, validate_attributes_complete +from testing_support.validators.validate_error_event_attributes import validate_error_event_attributes +from testing_support.validators.validate_function_called import validate_function_called +from testing_support.validators.validate_function_not_called import validate_function_not_called +from testing_support.validators.validate_transaction_event_attributes import validate_transaction_event_attributes +from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics +from testing_support.validators.validate_transaction_object_attributes import validate_transaction_object_attributes + +from newrelic.api.application import application_instance +from newrelic.api.function_trace import function_trace +from newrelic.common.object_names import callable_name +from newrelic.common.object_wrapper import function_wrapper, transient_function_wrapper +from newrelic.core.samplers.adaptive_sampler import AdaptiveSampler +from newrelic.core.samplers.trace_id_ratio_based_sampler import TraceIdRatioBasedSampler + +try: + from newrelic.core.infinite_tracing_pb2 import AttributeValue, Span +except: + AttributeValue = None + Span = None + +from testing_support.mock_external_http_server import MockExternalHTTPHResponseHeadersServer +from testing_support.validators.validate_span_events import check_value_equals, validate_span_events + +from newrelic.api.application import application_instance +from newrelic.api.background_task import BackgroundTask, background_task +from newrelic.api.external_trace import ExternalTrace +from newrelic.api.time_trace import current_trace +from newrelic.api.transaction import ( + accept_distributed_trace_headers, + current_span_id, + current_trace_id, + current_transaction, + insert_distributed_trace_headers, +) +from newrelic.api.web_transaction import WSGIWebTransaction +from newrelic.api.wsgi_application import wsgi_application +from newrelic.core.attribute import Attribute + +FIXTURE = Path(__file__).parent / "fixtures" / "samplers" / "sampler_configuration.json" + + +def replace_section(setting): + end = setting.split(".")[-1] + if end in ("root", "remote_parent_sampled", "remote_parent_not_sampled"): + return ".".join([*setting.split(".")[:-1], f"_{end}"]) + return setting + + +def parse_to_config_paths(settings, setting, config): + if isinstance(config, dict): + for key, value in config.items(): + if isinstance(value, dict) and not value: + new_setting = replace_section(setting) + settings[new_setting] = key + continue + # If there's a case where we have root.adaptive.sampling_target we also + # need to set _root = "adaptive". This usually happens in the config or + # env var parsing so this is special handling only needed for tests. + if key in ("root", "remote_parent_sampled", "remote_parent_not_sampled"): + new_setting = ".".join([setting, f"_{key}"]) + v = list(value.keys())[0] if isinstance(value, dict) else value + settings[new_setting] = v + new_setting = f"{setting}.{key}" + parse_to_config_paths(settings, new_setting, value) + else: + new_setting = replace_section(setting) + settings[new_setting] = config + + +def load_tests(): + result = [] + with FIXTURE.open(encoding="utf-8") as fh: + tests = json.load(fh) + + for test in tests: + _id = test.pop("test_name", None) + test_desc = test.pop("comment", None) + + config = test.pop("config", {}) + settings = {} + parse_to_config_paths(settings, "distributed_tracing", config) + expected_samplers = test.pop("expected_samplers", {}) + param = pytest.param(settings, expected_samplers, id=_id) + result.append(param) + + return result + + +SECTIONS = { + "full_root": (True, 0), + "full_remote_parent_sampled": (True, 1), + "full_remote_parent_not_sampled": (True, 2), + "partial_root": (False, 0), + "partial_remote_parent_sampled": (False, 1), + "partial_remote_parent_not_sampled": (False, 2), +} + + +@pytest.mark.parametrize("settings,expected_samplers", load_tests()) +def test_sampler_configuration(settings, expected_samplers): + @override_application_settings(settings) + @background_task() + def _test(): + txn = current_transaction() + application = txn._application._agent._applications.get(txn.settings.app_name) + # Re-initialize sampler proxy after overriding settings. + application.sampler.__init__(txn.settings) + + for sampler, attributes in expected_samplers.items(): + instance = SECTIONS[sampler] + sampler_instance = application.sampler.get_sampler(*instance) + if attributes["type"] == "adaptive": + assert isinstance(sampler_instance, AdaptiveSampler) + elif attributes["type"] == "trace_id_ratio_based": + assert isinstance(sampler_instance, TraceIdRatioBasedSampler) + if "ratio" in attributes: + assert sampler_instance.ratio == attributes["ratio"] + if attributes.get("is_global_adaptive_sampler", False): + assert sampler_instance is application.sampler._samplers["global"] + + _test() diff --git a/tests/cross_agent/test_w3c_trace_context.py b/tests/cross_agent/test_w3c_trace_context.py deleted file mode 100644 index 0c51184f28..0000000000 --- a/tests/cross_agent/test_w3c_trace_context.py +++ /dev/null @@ -1,257 +0,0 @@ -# Copyright 2010 New Relic, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import json -from pathlib import Path - -import pytest -import webtest -from testing_support.fixtures import override_application_settings, validate_attributes -from testing_support.validators.validate_span_events import validate_span_events -from testing_support.validators.validate_transaction_event_attributes import validate_transaction_event_attributes -from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics - -from newrelic.api.transaction import ( - accept_distributed_trace_headers, - current_transaction, - insert_distributed_trace_headers, -) -from newrelic.api.wsgi_application import wsgi_application -from newrelic.common.encoding_utils import W3CTraceState -from newrelic.common.object_wrapper import transient_function_wrapper - -FIXTURE = Path(__file__).parent / "fixtures" / "distributed_tracing" / "trace_context.json" - - -_parameters_list = ( - "test_name", - "trusted_account_key", - "account_id", - "web_transaction", - "raises_exception", - "force_sampled_true", - "span_events_enabled", - "transport_type", - "inbound_headers", - "outbound_payloads", - "intrinsics", - "expected_metrics", -) - -_parameters = ",".join(_parameters_list) - - -XFAIL_TESTS = [ - "spans_disabled_root", - "missing_traceparent", - "missing_traceparent_and_tracestate", - "w3c_and_newrelc_headers_present_error_parsing_traceparent", -] - - -def load_tests(): - result = [] - with FIXTURE.open(encoding="utf-8") as fh: - tests = json.load(fh) - - for test in tests: - values = (test.get(param, None) for param in _parameters_list) - param = pytest.param(*values, id=test.get("test_name")) - result.append(param) - - return result - - -ATTR_MAP = { - "traceparent.version": 0, - "traceparent.trace_id": 1, - "traceparent.parent_id": 2, - "traceparent.trace_flags": 3, - "tracestate.version": 0, - "tracestate.parent_type": 1, - "tracestate.parent_account_id": 2, - "tracestate.parent_application_id": 3, - "tracestate.span_id": 4, - "tracestate.transaction_id": 5, - "tracestate.sampled": 6, - "tracestate.priority": 7, - "tracestate.timestamp": 8, - "tracestate.tenant_id": None, -} - - -def validate_outbound_payload(actual, expected, trusted_account_key): - traceparent = "" - tracestate = "" - for key, value in actual: - if key == "traceparent": - traceparent = value.split("-") - elif key == "tracestate": - vendors = W3CTraceState.decode(value) - nr_entry = vendors.pop(f"{trusted_account_key}@nr", "") - tracestate = nr_entry.split("-") - exact_values = expected.get("exact", {}) - expected_attrs = expected.get("expected", []) - unexpected_attrs = expected.get("unexpected", []) - expected_vendors = expected.get("vendors", []) - for key, value in exact_values.items(): - header = traceparent if key.startswith("traceparent.") else tracestate - attr = ATTR_MAP[key] - if attr is not None: - if isinstance(value, bool): - assert header[attr] == str(int(value)) - elif isinstance(value, int): - assert int(header[attr]) == value - else: - assert header[attr] == str(value) - - for key in expected_attrs: - header = traceparent if key.startswith("traceparent.") else tracestate - attr = ATTR_MAP[key] - if attr is not None: - assert header[attr], key - - for key in unexpected_attrs: - header = traceparent if key.startswith("traceparent.") else tracestate - attr = ATTR_MAP[key] - if attr is not None: - assert not header[attr], key - - for vendor in expected_vendors: - assert vendor in vendors - - -@wsgi_application() -def target_wsgi_application(environ, start_response): - transaction = current_transaction() - - if not environ[".web_transaction"]: - transaction.background_task = True - - if environ[".raises_exception"]: - try: - raise ValueError("oops") - except: - transaction.notice_error() - - if ".inbound_headers" in environ: - accept_distributed_trace_headers(environ[".inbound_headers"], transport_type=environ[".transport_type"]) - - payloads = [] - for _ in range(environ[".outbound_calls"]): - payloads.append([]) - insert_distributed_trace_headers(payloads[-1]) - - start_response("200 OK", [("Content-Type", "application/json")]) - return [json.dumps(payloads).encode("utf-8")] - - -test_application = webtest.TestApp(target_wsgi_application) - - -def override_compute_sampled(override): - @transient_function_wrapper("newrelic.core.adaptive_sampler", "AdaptiveSampler.compute_sampled") - def _override_compute_sampled(wrapped, instance, args, kwargs): - if override: - return True - return wrapped(*args, **kwargs) - - return _override_compute_sampled - - -@pytest.mark.parametrize(_parameters, load_tests()) -def test_trace_context( - test_name, - trusted_account_key, - account_id, - web_transaction, - raises_exception, - force_sampled_true, - span_events_enabled, - transport_type, - inbound_headers, - outbound_payloads, - intrinsics, - expected_metrics, -): - if test_name in XFAIL_TESTS: - pytest.xfail("Waiting on cross agent tests update.") - # Prepare assertions - if not intrinsics: - intrinsics = {} - - common = intrinsics.get("common", {}) - common_required = common.get("expected", []) - common_forgone = common.get("unexpected", []) - common_exact = common.get("exact", {}) - - txn_intrinsics = intrinsics.get("Transaction", {}) - txn_event_required = {"agent": [], "user": [], "intrinsic": txn_intrinsics.get("expected", [])} - txn_event_required["intrinsic"].extend(common_required) - txn_event_forgone = {"agent": [], "user": [], "intrinsic": txn_intrinsics.get("unexpected", [])} - txn_event_forgone["intrinsic"].extend(common_forgone) - txn_event_exact = {"agent": {}, "user": {}, "intrinsic": txn_intrinsics.get("exact", {})} - txn_event_exact["intrinsic"].update(common_exact) - - override_settings = { - "distributed_tracing.enabled": True, - "span_events.enabled": span_events_enabled, - "account_id": account_id, - "trusted_account_key": trusted_account_key, - } - - extra_environ = { - ".web_transaction": web_transaction, - ".raises_exception": raises_exception, - ".transport_type": transport_type, - ".outbound_calls": (outbound_payloads and len(outbound_payloads)) or 0, - } - - inbound_headers = (inbound_headers and inbound_headers[0]) or None - if transport_type != "HTTP": - extra_environ[".inbound_headers"] = inbound_headers - inbound_headers = None - - @validate_transaction_metrics( - test_name, group="Uri", rollup_metrics=expected_metrics, background_task=not web_transaction - ) - @validate_transaction_event_attributes(txn_event_required, txn_event_forgone, txn_event_exact) - @validate_attributes("intrinsic", common_required, common_forgone) - @override_application_settings(override_settings) - @override_compute_sampled(force_sampled_true) - def _test(): - return test_application.get(f"/{test_name}", headers=inbound_headers, extra_environ=extra_environ) - - if "Span" in intrinsics: - span_intrinsics = intrinsics.get("Span") - span_expected = span_intrinsics.get("expected", []) - span_expected.extend(common_required) - span_unexpected = span_intrinsics.get("unexpected", []) - span_unexpected.extend(common_forgone) - span_exact = span_intrinsics.get("exact", {}) - span_exact.update(common_exact) - - _test = validate_span_events( - exact_intrinsics=span_exact, expected_intrinsics=span_expected, unexpected_intrinsics=span_unexpected - )(_test) - elif not span_events_enabled: - _test = validate_span_events(count=0)(_test) - - response = _test() - assert response.status == "200 OK" - payloads = response.json - if outbound_payloads: - assert len(payloads) == len(outbound_payloads) - for actual, expected in zip(payloads, outbound_payloads): - validate_outbound_payload(actual, expected, trusted_account_key) diff --git a/tests/framework_grpc/test_distributed_tracing.py b/tests/framework_grpc/test_distributed_tracing.py index 457894516d..817b8e1aef 100644 --- a/tests/framework_grpc/test_distributed_tracing.py +++ b/tests/framework_grpc/test_distributed_tracing.py @@ -138,6 +138,11 @@ def _test(): decoded["d"].pop("tk", None) w3c_data.pop("tk") + # Round priority of newrelic header to 6 decimal places so it match tracestate. + decoded["d"]["pr"] = f"{decoded['d']['pr']:.6f}" + w3c_data["pr"] = f"{w3c_data['pr']:.6f}" + del w3c_data["v"] # Remove the version before comparing. + assert decoded["d"] == w3c_data _test() diff --git a/tests/hybridagent_aiopg/conftest.py b/tests/hybridagent_aiopg/conftest.py new file mode 100644 index 0000000000..4bdaa61d2d --- /dev/null +++ b/tests/hybridagent_aiopg/conftest.py @@ -0,0 +1,41 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +""" +This test suite tests the following scenarios: +1. Hybrid Agent with a framework that is instrumented by OpenTelemetry (aiopg) +but not New Relic. +2. Despite New Relic not having instrumentation support for aiopg, there are +framework dependencies that are present in this library (psycopg2) that New +Relic does instrument, so this ensures that these hooks are disabled so that +there is no conflict with OpenTelemetry instrumentation. +3. `opentelemetry.traces.enabled` setting is toggled on and off to ensure +that traces are created or not created as expected. +""" + +from testing_support.fixtures import collector_agent_registration_fixture, collector_available_fixture + +_default_settings = { + "package_reporting.enabled": False, # Turn off package reporting for testing as it causes slow downs. + "transaction_tracer.explain_threshold": 0.0, + "transaction_tracer.transaction_threshold": 0.0, + "transaction_tracer.stack_trace_threshold": 0.0, + "debug.log_data_collector_payloads": True, + "debug.record_transaction_failure": True, + "opentelemetry.enabled": True, +} + +collector_agent_registration = collector_agent_registration_fixture( + app_name="Python Agent Test (Hybrid Agent)", default_settings=_default_settings +) diff --git a/tests/hybridagent_aiopg/test_database.py b/tests/hybridagent_aiopg/test_database.py new file mode 100644 index 0000000000..dd305dbdb6 --- /dev/null +++ b/tests/hybridagent_aiopg/test_database.py @@ -0,0 +1,197 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import asyncio + +import aiopg +import pytest +from testing_support.db_settings import postgresql_settings +from testing_support.fixtures import override_application_settings +from testing_support.util import instance_hostname +from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics + +from newrelic.api.background_task import background_task + +DB_SETTINGS = postgresql_settings()[0] + +# Metrics +_base_scoped_metrics = ( + (f"Datastore/statement/postgresql/{DB_SETTINGS['table_name']}/insert", 1), + ("Datastore/operation/postgresql/create", 1), +) + +_base_rollup_metrics = ( + ("Datastore/all", 2), + ("Datastore/allOther", 2), + ("Datastore/postgresql/all", 2), + ("Datastore/postgresql/allOther", 2), + (f"Datastore/statement/postgresql/{DB_SETTINGS['table_name']}/insert", 1), + ("Datastore/operation/postgresql/insert", 1), + ("Datastore/operation/postgresql/create", 1), +) + +_disable_scoped_metrics = list(_base_scoped_metrics) +_disable_rollup_metrics = list(_base_rollup_metrics) + +_enable_scoped_metrics = list(_base_scoped_metrics) +_enable_rollup_metrics = list(_base_rollup_metrics) + +_host = instance_hostname(DB_SETTINGS["host"]) +_port = DB_SETTINGS["port"] + +_instance_metric_name = f"Datastore/instance/postgresql/{_host}/{_port}" + +_enable_rollup_metrics.append((_instance_metric_name, 2)) + +_disable_rollup_metrics.append((_instance_metric_name, None)) + + +# Query +async def _execute(cursor): + await cursor.execute(f"CREATE TABLE IF NOT EXISTS {DB_SETTINGS['table_name']} (testField INTEGER)") + await cursor.execute(f"INSERT INTO {DB_SETTINGS['table_name']} (testField) VALUES (123)") + + cursor.close() + + +async def _connect_db(): + dsn = f"dbname={DB_SETTINGS['name']} user={DB_SETTINGS['user']} password={DB_SETTINGS['password']} host={DB_SETTINGS['host']} port={DB_SETTINGS['port']}" + connection = await aiopg.connect(dsn=dsn) + + try: + cursor = await connection.cursor() + await _execute(cursor) + finally: + connection.close() + + +async def _create_pool_db(): + dsn = f"dbname={DB_SETTINGS['name']} user={DB_SETTINGS['user']} password={DB_SETTINGS['password']} host={DB_SETTINGS['host']} port={DB_SETTINGS['port']}" + pool = await aiopg.create_pool(dsn=dsn) + + try: + connection = await pool.acquire() + cursor = await connection.cursor() + await _execute(cursor) + finally: + connection.close() + + +# Tests +@pytest.mark.parametrize( + "db_instance_reporting,opentelemetry_traces_enabled", [(True, True), (True, False), (False, True), (False, False)] +) +def test_connect(db_instance_reporting, opentelemetry_traces_enabled): + kwargs = {} + if opentelemetry_traces_enabled: + kwargs = { + "scoped_metrics": _enable_scoped_metrics if db_instance_reporting else _disable_scoped_metrics, + "rollup_metrics": _enable_rollup_metrics if db_instance_reporting else _disable_rollup_metrics, + } + + @override_application_settings( + { + "datastore_tracer.instance_reporting.enabled": db_instance_reporting, + "opentelemetry.traces.enabled": opentelemetry_traces_enabled, + } + ) + @validate_transaction_metrics("test_database:test_connect.._test", background_task=True, **kwargs) + @background_task() + def _test(): + async def _inner_test(): + await _connect_db() + + asyncio.run(_inner_test()) + + _test() + + +@pytest.mark.parametrize("db_instance_reporting", (True, False)) +def test_connect_disable_opentelemetry_traces(db_instance_reporting): + with pytest.raises(AssertionError): + # This will expectedly fail when the metrics are not recorded + @override_application_settings( + { + "datastore_tracer.instance_reporting.enabled": db_instance_reporting, + "opentelemetry.traces.enabled": False, + } + ) + @validate_transaction_metrics( + "test_database:test_connect.._test", + scoped_metrics=_enable_scoped_metrics if db_instance_reporting else _disable_scoped_metrics, + rollup_metrics=_enable_rollup_metrics if db_instance_reporting else _disable_rollup_metrics, + background_task=True, + ) + @background_task() + def _test(): + async def _inner_test(): + await _connect_db() + + asyncio.run(_inner_test()) + + _test() + + +@pytest.mark.parametrize( + "db_instance_reporting,opentelemetry_traces_enabled", [(True, True), (True, False), (False, True), (False, False)] +) +def test_create_pool(db_instance_reporting, opentelemetry_traces_enabled): + kwargs = {} + if opentelemetry_traces_enabled: + kwargs = { + "scoped_metrics": _enable_scoped_metrics if db_instance_reporting else _disable_scoped_metrics, + "rollup_metrics": _enable_rollup_metrics if db_instance_reporting else _disable_rollup_metrics, + } + + @override_application_settings( + { + "datastore_tracer.instance_reporting.enabled": db_instance_reporting, + "opentelemetry.traces.enabled": opentelemetry_traces_enabled, + } + ) + @validate_transaction_metrics("test_database:test_create_pool.._test", background_task=True, **kwargs) + @background_task() + def _test(): + async def _inner_test(): + await _create_pool_db() + + asyncio.run(_inner_test()) + + _test() + + +@pytest.mark.parametrize("db_instance_reporting", (True, False)) +def test_create_pool_disable_opentelemetry_traces(db_instance_reporting): + with pytest.raises(AssertionError): + # This will expectedly fail when the metrics are not recorded + @override_application_settings( + { + "datastore_tracer.instance_reporting.enabled": db_instance_reporting, + "opentelemetry.traces.enabled": False, + } + ) + @validate_transaction_metrics( + "test_database:test_create_pool.._test", + scoped_metrics=_enable_scoped_metrics if db_instance_reporting else _disable_scoped_metrics, + rollup_metrics=_enable_rollup_metrics if db_instance_reporting else _disable_rollup_metrics, + background_task=True, + ) + @background_task() + def _test(): + async def _inner_test(): + await _create_pool_db() + + asyncio.run(_inner_test()) + + _test() diff --git a/tests/hybridagent_ariadne/__init__.py b/tests/hybridagent_ariadne/__init__.py new file mode 100644 index 0000000000..8030baccf7 --- /dev/null +++ b/tests/hybridagent_ariadne/__init__.py @@ -0,0 +1,13 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. diff --git a/tests/hybridagent_ariadne/_target_application.py b/tests/hybridagent_ariadne/_target_application.py new file mode 100644 index 0000000000..efd4639683 --- /dev/null +++ b/tests/hybridagent_ariadne/_target_application.py @@ -0,0 +1,126 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +import json + +from ariadne.contrib.tracing.opentelemetry import opentelemetry_extension + +from hybridagent_ariadne._target_schema_async import target_asgi_application as target_asgi_application_async +from hybridagent_ariadne._target_schema_async import target_schema as target_schema_async +from hybridagent_ariadne._target_schema_sync import ariadne_version_tuple +from hybridagent_ariadne._target_schema_sync import target_asgi_application as target_asgi_application_sync +from hybridagent_ariadne._target_schema_sync import target_schema as target_schema_sync +from hybridagent_ariadne._target_schema_sync import target_wsgi_application as target_wsgi_application_sync + + +def check_response(query, success, response): + if isinstance(query, str) and "error" not in query: + assert success + assert "errors" not in response, response + assert response.get("data", None), response + else: + assert "errors" in response, response + + +def run_sync(schema): + def _run_sync(query, middleware=None): + from ariadne import graphql_sync + + success, response = graphql_sync( + schema, {"query": query}, middleware=middleware, extensions=[opentelemetry_extension()] + ) + check_response(query, success, response) + + return response.get("data", {}) + + return _run_sync + + +def run_async(schema): + import asyncio + + loop = asyncio.new_event_loop() + + def _run_async(query, middleware=None): + from ariadne import graphql + + success, response = loop.run_until_complete( + graphql(schema, {"query": query}, middleware=middleware, extensions=[opentelemetry_extension()]) + ) + check_response(query, success, response) + + return response.get("data", {}) + + return _run_async + + +def run_wsgi(app): + def _run_asgi(query, middleware=None): + if not isinstance(query, str) or "error" in query: + expect_errors = True + else: + expect_errors = False + + app.app.middleware = middleware + + response = app.post( + "/", json.dumps({"query": query}), headers={"Content-Type": "application/json"}, expect_errors=expect_errors + ) + + body = json.loads(response.body.decode("utf-8")) + if expect_errors: + assert body["errors"] + else: + assert "errors" not in body or not body["errors"] + + return body.get("data", {}) + + return _run_asgi + + +def run_asgi(app): + def _run_asgi(query, middleware=None): + if ariadne_version_tuple < (0, 16): + app.asgi_application.middleware = middleware + + # In ariadne v0.16.0, the middleware attribute was removed from the GraphQL class in favor of the http_handler + elif ariadne_version_tuple >= (0, 16): + app.asgi_application.http_handler.middleware = middleware + + response = app.make_request( + "POST", "/", body=json.dumps({"query": query}), headers={"Content-Type": "application/json"} + ) + body = json.loads(response.body.decode("utf-8")) + + if not isinstance(query, str) or "error" in query: + try: + assert response.status != 200 + except AssertionError: + assert body["errors"] + else: + assert response.status == 200 + assert "errors" not in body or not body["errors"] + + return body.get("data", {}) + + return _run_asgi + + +target_application = { + "sync-sync": run_sync(target_schema_sync), + "async-sync": run_async(target_schema_sync), + "async-async": run_async(target_schema_async), + "wsgi-sync": run_wsgi(target_wsgi_application_sync), + "asgi-sync": run_asgi(target_asgi_application_sync), + "asgi-async": run_asgi(target_asgi_application_async), +} diff --git a/tests/hybridagent_ariadne/_target_schema_async.py b/tests/hybridagent_ariadne/_target_schema_async.py new file mode 100644 index 0000000000..6f35d5c527 --- /dev/null +++ b/tests/hybridagent_ariadne/_target_schema_async.py @@ -0,0 +1,91 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from pathlib import Path + +from ariadne import MutationType, QueryType, UnionType, load_schema_from_path, make_executable_schema +from ariadne.asgi import GraphQL as GraphQLASGI +from ariadne.asgi.handlers import GraphQLHTTPHandler +from ariadne.contrib.tracing.opentelemetry import OpenTelemetryExtension +from hybridagent_graphql._target_schema_sync import books, libraries, magazines +from testing_support.asgi_testing import AsgiTest + +schema_file = Path(__file__).parent / "schema.graphql" +type_defs = load_schema_from_path(schema_file) + +storage = [] + +mutation = MutationType() + + +@mutation.field("storage_add") +async def resolve_storage_add(self, info, string): + storage.append(string) + return string + + +item = UnionType("Item") + + +@item.type_resolver +async def resolve_type(obj, *args): + if "isbn" in obj: + return "Book" + elif "issue" in obj: + return "Magazine" + + return None + + +query = QueryType() + + +@query.field("library") +async def resolve_library(self, info, index): + return libraries[index] + + +@query.field("storage") +async def resolve_storage(self, info): + return [storage.pop()] + + +@query.field("search") +async def resolve_search(self, info, contains): + search_books = [b for b in books if contains in b["name"]] + search_magazines = [m for m in magazines if contains in m["name"]] + return search_books + search_magazines + + +@query.field("hello") +@query.field("error_middleware") +async def resolve_hello(self, info): + return "Hello!" + + +@query.field("echo") +async def resolve_echo(self, info, echo): + return echo + + +@query.field("error_non_null") +@query.field("error") +async def resolve_error(self, info): + raise RuntimeError("Runtime Error!") + + +target_schema = make_executable_schema(type_defs, query, mutation, item) +target_asgi_application = AsgiTest( + GraphQLASGI(target_schema, debug=True, http_handler=GraphQLHTTPHandler(extensions=[OpenTelemetryExtension])) +) diff --git a/tests/hybridagent_ariadne/_target_schema_sync.py b/tests/hybridagent_ariadne/_target_schema_sync.py new file mode 100644 index 0000000000..d950441dcb --- /dev/null +++ b/tests/hybridagent_ariadne/_target_schema_sync.py @@ -0,0 +1,103 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from pathlib import Path + +import webtest +from ariadne import MutationType, QueryType, UnionType, load_schema_from_path, make_executable_schema +from ariadne.asgi.handlers import GraphQLHTTPHandler +from ariadne.contrib.tracing.opentelemetry import OpenTelemetryExtension, opentelemetry_extension +from ariadne.wsgi import GraphQL as GraphQLWSGI +from hybridagent_graphql._target_schema_sync import books, libraries, magazines +from testing_support.asgi_testing import AsgiTest + +from hybridagent_ariadne.test_application import ARIADNE_VERSION + +ariadne_version_tuple = tuple(map(int, ARIADNE_VERSION.split("."))) + +if ariadne_version_tuple < (0, 16): + from ariadne.asgi import GraphQL as GraphQLASGI +elif ariadne_version_tuple >= (0, 16): + from ariadne.asgi.graphql import GraphQL as GraphQLASGI + + +schema_file = Path(__file__).parent / "schema.graphql" +type_defs = load_schema_from_path(schema_file) + +storage = [] + +mutation = MutationType() + + +@mutation.field("storage_add") +def resolve_storage_add(self, info, string): + storage.append(string) + return string + + +item = UnionType("Item") + + +@item.type_resolver +def resolve_type(obj, *args): + if "isbn" in obj: + return "Book" + elif "issue" in obj: + return "Magazine" + + return None + + +query = QueryType() + + +@query.field("library") +def resolve_library(self, info, index): + return libraries[index] + + +@query.field("storage") +def resolve_storage(self, info): + return [storage.pop()] + + +@query.field("search") +def resolve_search(self, info, contains): + search_books = [b for b in books if contains in b["name"]] + search_magazines = [m for m in magazines if contains in m["name"]] + return search_books + search_magazines + + +@query.field("hello") +@query.field("error_middleware") +def resolve_hello(self, info): + return "Hello!" + + +@query.field("echo") +def resolve_echo(self, info, echo): + return echo + + +@query.field("error_non_null") +@query.field("error") +def resolve_error(self, info): + raise RuntimeError("Runtime Error!") + + +target_schema = make_executable_schema(type_defs, query, mutation, item) +target_asgi_application = AsgiTest( + GraphQLASGI(target_schema, http_handler=GraphQLHTTPHandler(extensions=[OpenTelemetryExtension])) +) +target_wsgi_application = webtest.TestApp(GraphQLWSGI(target_schema, extensions=[opentelemetry_extension()])) diff --git a/tests/hybridagent_ariadne/conftest.py b/tests/hybridagent_ariadne/conftest.py new file mode 100644 index 0000000000..82539fda1a --- /dev/null +++ b/tests/hybridagent_ariadne/conftest.py @@ -0,0 +1,30 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from testing_support.fixtures import collector_agent_registration_fixture, collector_available_fixture + +_default_settings = { + "package_reporting.enabled": False, # Turn off package reporting for testing as it causes slow downs. + "transaction_tracer.explain_threshold": 0.0, + "transaction_tracer.transaction_threshold": 0.0, + "transaction_tracer.stack_trace_threshold": 0.0, + "debug.log_data_collector_payloads": True, + "debug.record_transaction_failure": True, + "opentelemetry.enabled": True, + "opentelemetry.traces.enabled": True, +} + +collector_agent_registration = collector_agent_registration_fixture( + app_name="Python Agent Test (Hybrid Agent, Ariadne)", default_settings=_default_settings +) diff --git a/tests/hybridagent_ariadne/schema.graphql b/tests/hybridagent_ariadne/schema.graphql new file mode 100644 index 0000000000..8bf64af512 --- /dev/null +++ b/tests/hybridagent_ariadne/schema.graphql @@ -0,0 +1,48 @@ +schema { + query: Query + mutation: Mutation +} + +type Author { + first_name: String + last_name: String +} + +type Book { + id: Int + name: String + isbn: String + author: Author + branch: String +} + +union Item = Book | Magazine + +type Library { + id: Int + branch: String + magazine: [Magazine] + book: [Book] +} + +type Magazine { + id: Int + name: String + issue: Int + branch: String +} + +type Mutation { + storage_add(string: String!): String +} + +type Query { + storage: [String] + library(index: Int!): Library + hello: String + search(contains: String!): [Item] + echo(echo: String!): String + error: String + error_non_null: String! + error_middleware: String +} diff --git a/tests/hybridagent_ariadne/test_application.py b/tests/hybridagent_ariadne/test_application.py new file mode 100644 index 0000000000..122ec57833 --- /dev/null +++ b/tests/hybridagent_ariadne/test_application.py @@ -0,0 +1,36 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +import pytest +from hybridagent_graphql.test_application import * # noqa: F403 + +from newrelic.common.package_version_utils import get_package_version + +ARIADNE_VERSION = get_package_version("ariadne") +ariadne_version_tuple = tuple(map(int, ARIADNE_VERSION.split("."))) + + +@pytest.fixture( + scope="session", params=["sync-sync", "async-sync", "async-async", "wsgi-sync", "asgi-sync", "asgi-async"] +) +def target_application(request): + from ._target_application import target_application + + target_application = target_application[request.param] + + param = request.param.split("-") + is_wsgi_or_asgi = param[0] if (param[0] in {"wsgi", "asgi"}) else False + schema_type = param[1] + + assert ARIADNE_VERSION is not None + return "Ariadne", target_application, is_wsgi_or_asgi, schema_type diff --git a/tests/hybridagent_dynamodb/_test_botocore_dynamodb_opentelemetry.py b/tests/hybridagent_dynamodb/_test_botocore_dynamodb_opentelemetry.py new file mode 100644 index 0000000000..f2c1bcd52a --- /dev/null +++ b/tests/hybridagent_dynamodb/_test_botocore_dynamodb_opentelemetry.py @@ -0,0 +1,157 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import uuid + +import botocore.session +import pytest +from moto import mock_aws +from testing_support.fixtures import dt_enabled, override_application_settings +from testing_support.validators.validate_span_events import validate_span_events +from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics +from testing_support.validators.validate_tt_segment_params import validate_tt_segment_params + +from newrelic.api.background_task import background_task +from newrelic.common.package_version_utils import get_package_version_tuple + +""" +Disable this test suite for now. +""" + +MOTO_VERSION = get_package_version_tuple("moto") +AWS_ACCESS_KEY_ID = "AAAAAAAAAAAACCESSKEY" +AWS_SECRET_ACCESS_KEY = "AAAAAASECRETKEY" +AWS_REGION = "us-east-1" + +TEST_TABLE = f"python-agent-test-{uuid.uuid4()}" + + +_dynamodb_scoped_metrics = [ + (f"Datastore/statement/dynamodb/{TEST_TABLE}/CreateTable", 1), + (f"Datastore/statement/dynamodb/{TEST_TABLE}/PutItem", 1), + (f"Datastore/statement/dynamodb/{TEST_TABLE}/GetItem", 1), + (f"Datastore/statement/dynamodb/{TEST_TABLE}/UpdateItem", 1), + (f"Datastore/statement/dynamodb/{TEST_TABLE}/Query", 1), + (f"Datastore/statement/dynamodb/{TEST_TABLE}/Scan", 1), + (f"Datastore/statement/dynamodb/{TEST_TABLE}/DeleteItem", 1), + (f"Datastore/statement/dynamodb/{TEST_TABLE}/DeleteTable", 1), +] + +_dynamodb_rollup_metrics = [ + ("Datastore/all", 8), + ("Datastore/allOther", 8), + ("Datastore/dynamodb/all", 8), + ("Datastore/dynamodb/allOther", 8), +] + + +@pytest.mark.parametrize("account_id", (None, 12345678901)) +def test_dynamodb(account_id): + expected_aws_agent_attrs = {} + if account_id: + expected_aws_agent_attrs = { + "cloud.resource_id": f"arn:aws:dynamodb:{AWS_REGION}:{account_id:012d}:table/{TEST_TABLE}", + "db.system": "dynamodb", + } + + @override_application_settings({"cloud.aws.account_id": account_id}) + @dt_enabled + @validate_span_events(expected_agents=("aws.requestId",), count=8) + @validate_span_events(exact_agents={"aws.operation": "PutItem"}, count=1) + @validate_span_events(exact_agents={"aws.operation": "GetItem"}, count=1) + @validate_span_events(exact_agents={"aws.operation": "DeleteItem"}, count=1) + @validate_span_events(exact_agents={"aws.operation": "CreateTable"}, count=1) + @validate_span_events(exact_agents={"aws.operation": "DeleteTable"}, count=1) + @validate_span_events(exact_agents={"aws.operation": "Query"}, count=1) + @validate_span_events(exact_agents={"aws.operation": "Scan"}, count=1) + @validate_tt_segment_params(present_params=("aws.requestId",)) + @validate_transaction_metrics( + "test_botocore_dynamodb:test_dynamodb.._test", + scoped_metrics=_dynamodb_scoped_metrics, + rollup_metrics=_dynamodb_rollup_metrics, + background_task=True, + ) + @background_task() + @mock_aws + def _test(): + session = botocore.session.get_session() + client = session.create_client( + "dynamodb", + region_name=AWS_REGION, + aws_access_key_id=AWS_ACCESS_KEY_ID, + aws_secret_access_key=AWS_SECRET_ACCESS_KEY, + ) + + # Create table + resp = client.create_table( + TableName=TEST_TABLE, + AttributeDefinitions=[ + {"AttributeName": "Id", "AttributeType": "N"}, + {"AttributeName": "Foo", "AttributeType": "S"}, + ], + KeySchema=[{"AttributeName": "Id", "KeyType": "HASH"}, {"AttributeName": "Foo", "KeyType": "RANGE"}], + ProvisionedThroughput={"ReadCapacityUnits": 5, "WriteCapacityUnits": 5}, + ) + assert resp["TableDescription"]["TableName"] == TEST_TABLE + + # Put item + resp = client.put_item( + TableName=TEST_TABLE, + Item={"Id": {"N": "101"}, "Foo": {"S": "hello_world"}, "SomeValue": {"S": "some_random_attribute"}}, + ) + + # Get item + resp = client.get_item(TableName=TEST_TABLE, Key={"Id": {"N": "101"}, "Foo": {"S": "hello_world"}}) + assert resp["Item"]["SomeValue"]["S"] == "some_random_attribute" + + # Update item + resp = client.update_item( + TableName=TEST_TABLE, + Key={"Id": {"N": "101"}, "Foo": {"S": "hello_world"}}, + AttributeUpdates={"Foo2": {"Value": {"S": "hello_world2"}, "Action": "PUT"}}, + ReturnValues="ALL_NEW", + ) + assert resp["Attributes"]["Foo2"] + + # Query for item + resp = client.query( + TableName=TEST_TABLE, + Select="ALL_ATTRIBUTES", + KeyConditionExpression="#Id = :v_id", + ExpressionAttributeNames={"#Id": "Id"}, + ExpressionAttributeValues={":v_id": {"N": "101"}}, + ) + assert len(resp["Items"]) == 1 + assert resp["Items"][0]["SomeValue"]["S"] == "some_random_attribute" + + # Scan + resp = client.scan(TableName=TEST_TABLE) + assert len(resp["Items"]) == 1 + + # Delete item + resp = client.delete_item(TableName=TEST_TABLE, Key={"Id": {"N": "101"}, "Foo": {"S": "hello_world"}}) + + # Delete table + resp = client.delete_table(TableName=TEST_TABLE) + assert resp["TableDescription"]["TableName"] == TEST_TABLE + + if account_id: + + @validate_span_events(exact_agents=expected_aws_agent_attrs, count=8) + def _test_apply_validator(): + _test() + + _test_apply_validator() + else: + _test() diff --git a/tests/hybridagent_dynamodb/conftest.py b/tests/hybridagent_dynamodb/conftest.py new file mode 100644 index 0000000000..dc6fd6dd90 --- /dev/null +++ b/tests/hybridagent_dynamodb/conftest.py @@ -0,0 +1,37 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from testing_support.fixtures import collector_agent_registration_fixture, collector_available_fixture + +from newrelic.common.package_version_utils import get_package_version + +BOTOCORE_VERSION = get_package_version("botocore") + +_default_settings = { + "package_reporting.enabled": False, # Turn off package reporting for testing as it causes slowdowns. + "transaction_tracer.explain_threshold": 0.0, + "transaction_tracer.transaction_threshold": 0.0, + "transaction_tracer.stack_trace_threshold": 0.0, + "debug.log_data_collector_payloads": True, + "debug.record_transaction_failure": True, + "custom_insights_events.max_attribute_value": 4096, + "ai_monitoring.enabled": True, + "opentelemetry.enabled": True, + "opentelemetry.traces.enabled": True, +} +collector_agent_registration = collector_agent_registration_fixture( + app_name="Python Agent Test (Hybrid Agent, botocore)", + default_settings=_default_settings, + linked_applications=["Python Agent Test (external_botocore)"], +) diff --git a/tests/hybridagent_dynamodb/test_botocore_dynamodb.py b/tests/hybridagent_dynamodb/test_botocore_dynamodb.py new file mode 100644 index 0000000000..00dca7445a --- /dev/null +++ b/tests/hybridagent_dynamodb/test_botocore_dynamodb.py @@ -0,0 +1,172 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import uuid + +import botocore.session +import pytest +from moto import mock_aws +from testing_support.fixtures import dt_enabled, override_application_settings +from testing_support.validators.validate_span_events import validate_span_events +from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics +from testing_support.validators.validate_tt_segment_params import validate_tt_segment_params + +from newrelic.api.background_task import background_task +from newrelic.common.package_version_utils import get_package_version_tuple + +MOTO_VERSION = get_package_version_tuple("moto") +AWS_ACCESS_KEY_ID = "AAAAAAAAAAAACCESSKEY" +AWS_SECRET_ACCESS_KEY = "AAAAAASECRETKEY" +AWS_REGION = "us-east-1" + +TEST_TABLE = f"python-agent-test-{uuid.uuid4()}" + +""" +This is taken directly from New Relic's external_botocore tests to ensure that +the hybrid agent setup is working as expected. In this case, we are verifying +that DynamoDB operations default to New Relic's instrumentation even when +using the Hybrid Agent because we have temporarily disabled that instrumentation. +""" + + +_dynamodb_scoped_metrics = [ + (f"Datastore/statement/DynamoDB/{TEST_TABLE}/create_table", 1), + (f"Datastore/statement/DynamoDB/{TEST_TABLE}/put_item", 1), + (f"Datastore/statement/DynamoDB/{TEST_TABLE}/get_item", 1), + (f"Datastore/statement/DynamoDB/{TEST_TABLE}/update_item", 1), + (f"Datastore/statement/DynamoDB/{TEST_TABLE}/query", 1), + (f"Datastore/statement/DynamoDB/{TEST_TABLE}/scan", 1), + (f"Datastore/statement/DynamoDB/{TEST_TABLE}/delete_item", 1), + (f"Datastore/statement/DynamoDB/{TEST_TABLE}/delete_table", 1), +] + +_dynamodb_rollup_metrics = [ + ("Datastore/all", 8), + ("Datastore/allOther", 8), + ("Datastore/DynamoDB/all", 8), + ("Datastore/DynamoDB/allOther", 8), +] + + +@pytest.mark.parametrize("account_id", (None, 12345678901)) +def test_dynamodb(account_id): + expected_aws_agent_attrs = {} + if account_id: + expected_aws_agent_attrs = { + "cloud.resource_id": f"arn:aws:dynamodb:{AWS_REGION}:{account_id:012d}:table/{TEST_TABLE}", + "db.system": "DynamoDB", + } + + @override_application_settings({"cloud.aws.account_id": account_id}) + @dt_enabled + @validate_span_events(expected_agents=("aws.requestId",), count=8) + @validate_span_events(exact_agents={"aws.operation": "PutItem"}, count=1) + @validate_span_events(exact_agents={"aws.operation": "GetItem"}, count=1) + @validate_span_events(exact_agents={"aws.operation": "DeleteItem"}, count=1) + @validate_span_events(exact_agents={"aws.operation": "CreateTable"}, count=1) + @validate_span_events(exact_agents={"aws.operation": "DeleteTable"}, count=1) + @validate_span_events(exact_agents={"aws.operation": "Query"}, count=1) + @validate_span_events(exact_agents={"aws.operation": "Scan"}, count=1) + @validate_tt_segment_params(present_params=("aws.requestId",)) + @validate_transaction_metrics( + "test_botocore_dynamodb:test_dynamodb.._test", + scoped_metrics=_dynamodb_scoped_metrics, + rollup_metrics=_dynamodb_rollup_metrics, + background_task=True, + ) + @background_task() + @mock_aws + def _test(): + session = botocore.session.get_session() + client = session.create_client( + "dynamodb", + region_name=AWS_REGION, + aws_access_key_id=AWS_ACCESS_KEY_ID, + aws_secret_access_key=AWS_SECRET_ACCESS_KEY, + ) + + # Create table + resp = client.create_table( + TableName=TEST_TABLE, + AttributeDefinitions=[ + {"AttributeName": "Id", "AttributeType": "N"}, + {"AttributeName": "Foo", "AttributeType": "S"}, + ], + KeySchema=[{"AttributeName": "Id", "KeyType": "HASH"}, {"AttributeName": "Foo", "KeyType": "RANGE"}], + ProvisionedThroughput={"ReadCapacityUnits": 5, "WriteCapacityUnits": 5}, + ) + assert resp["TableDescription"]["TableName"] == TEST_TABLE + # moto response is ACTIVE, AWS response is CREATING + # assert resp['TableDescription']['TableStatus'] == 'ACTIVE' + + # # AWS needs time to create the table + # import time + # time.sleep(15) + + # Put item + resp = client.put_item( + TableName=TEST_TABLE, + Item={"Id": {"N": "101"}, "Foo": {"S": "hello_world"}, "SomeValue": {"S": "some_random_attribute"}}, + ) + # No checking response, due to inconsistent return values. + # moto returns resp['Attributes']. AWS returns resp['ResponseMetadata'] + + # Get item + resp = client.get_item(TableName=TEST_TABLE, Key={"Id": {"N": "101"}, "Foo": {"S": "hello_world"}}) + assert resp["Item"]["SomeValue"]["S"] == "some_random_attribute" + + # Update item + resp = client.update_item( + TableName=TEST_TABLE, + Key={"Id": {"N": "101"}, "Foo": {"S": "hello_world"}}, + AttributeUpdates={"Foo2": {"Value": {"S": "hello_world2"}, "Action": "PUT"}}, + ReturnValues="ALL_NEW", + ) + assert resp["Attributes"]["Foo2"] + + # Query for item + resp = client.query( + TableName=TEST_TABLE, + Select="ALL_ATTRIBUTES", + KeyConditionExpression="#Id = :v_id", + ExpressionAttributeNames={"#Id": "Id"}, + ExpressionAttributeValues={":v_id": {"N": "101"}}, + ) + assert len(resp["Items"]) == 1 + assert resp["Items"][0]["SomeValue"]["S"] == "some_random_attribute" + + # Scan + resp = client.scan(TableName=TEST_TABLE) + assert len(resp["Items"]) == 1 + + # Delete item + resp = client.delete_item(TableName=TEST_TABLE, Key={"Id": {"N": "101"}, "Foo": {"S": "hello_world"}}) + # No checking response, due to inconsistent return values. + # moto returns resp['Attributes']. AWS returns resp['ResponseMetadata'] + + # Delete table + resp = client.delete_table(TableName=TEST_TABLE) + assert resp["TableDescription"]["TableName"] == TEST_TABLE + # moto response is ACTIVE, AWS response is DELETING + # assert resp['TableDescription']['TableStatus'] == 'DELETING' + + if account_id: + + @validate_span_events(exact_agents=expected_aws_agent_attrs, count=8) + def _test_apply_validator(): + _test() + + _test_apply_validator() + else: + _test() diff --git a/tests/hybridagent_fastapi/_target_opentelemetry_application.py b/tests/hybridagent_fastapi/_target_opentelemetry_application.py new file mode 100644 index 0000000000..06ec691e22 --- /dev/null +++ b/tests/hybridagent_fastapi/_target_opentelemetry_application.py @@ -0,0 +1,35 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from fastapi import FastAPI +from testing_support.asgi_testing import AsgiTest + +from newrelic.api.transaction import current_transaction + +app = FastAPI() + + +@app.get("/sync") +def sync(): + assert current_transaction() is not None + return {} + + +@app.get("/async") +async def non_sync(): + assert current_transaction() is not None + return {} + + +target_application = AsgiTest(app) diff --git a/tests/hybridagent_fastapi/conftest.py b/tests/hybridagent_fastapi/conftest.py new file mode 100644 index 0000000000..68f31129d6 --- /dev/null +++ b/tests/hybridagent_fastapi/conftest.py @@ -0,0 +1,40 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from testing_support.fixtures import collector_agent_registration_fixture, collector_available_fixture +from testing_support.fixtures import newrelic_caplog as caplog + +_default_settings = { + "package_reporting.enabled": False, # Turn off package reporting for testing as it causes slow downs. + "transaction_tracer.explain_threshold": 0.0, + "transaction_tracer.transaction_threshold": 0.0, + "transaction_tracer.stack_trace_threshold": 0.0, + "debug.log_data_collector_payloads": True, + "debug.record_transaction_failure": True, + "debug.log_autorum_middleware": True, + "opentelemetry.enabled": True, + "opentelemetry.traces.enabled": True, +} + +collector_agent_registration = collector_agent_registration_fixture( + app_name="Python Agent Test (Hybrid Agent, FastAPI)", default_settings=_default_settings +) + + +@pytest.fixture(scope="session") +def app(): + import _target_opentelemetry_application + + return _target_opentelemetry_application.target_application diff --git a/tests/hybridagent_fastapi/test_otel_application.py b/tests/hybridagent_fastapi/test_otel_application.py new file mode 100644 index 0000000000..35311dc795 --- /dev/null +++ b/tests/hybridagent_fastapi/test_otel_application.py @@ -0,0 +1,93 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import logging + +import pytest +from testing_support.fixtures import dt_enabled +from testing_support.validators.validate_span_events import validate_span_events +from testing_support.validators.validate_transaction_event_attributes import validate_transaction_event_attributes +from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics + +_exact_intrinsics = {"type": "Span"} +_exact_root_intrinsics = _exact_intrinsics.copy().update({"nr.entryPoint": True}) +_expected_intrinsics = [ + "traceId", + "transactionId", + "sampled", + "priority", + "timestamp", + "duration", + "name", + "category", + "guid", +] +_expected_root_intrinsics = [*_expected_intrinsics, "transaction.name"] +_expected_child_intrinsics = [*_expected_intrinsics, "parentId"] +_unexpected_root_intrinsics = ["parentId"] +_unexpected_child_intrinsics = ["nr.entryPoint", "transaction.name"] + +_test_application_rollup_metrics = [ + ("Supportability/DistributedTrace/CreatePayload/Success", 2), + ("Supportability/TraceContext/Create/Success", 2), + ("HttpDispatcher", 1), + ("WebTransaction", 1), + ("WebTransactionTotalTime", 1), +] + + +@pytest.mark.parametrize("endpoint", ("/sync", "/async")) +def test_application(caplog, app, endpoint): + caplog.set_level(logging.ERROR) + transaction_name = f"GET {endpoint}" + + @dt_enabled + @validate_span_events( + exact_intrinsics=_exact_root_intrinsics, + expected_intrinsics=_expected_root_intrinsics, + unexpected_intrinsics=_unexpected_root_intrinsics, + ) + @validate_transaction_event_attributes( + exact_attrs={ + "agent": { + "response.headers.contentType": "application/json", + "request.method": "GET", + "request.uri": endpoint, + "response.headers.contentLength": 2, + "response.status": "200", + }, + "intrinsic": {"name": f"WebTransaction/Uri/{transaction_name}"}, + "user": {}, + } + ) + @validate_span_events( + count=2, # "asgi.event.type": "http.response.start" and "http.response.body" + exact_intrinsics=_exact_intrinsics, + expected_intrinsics=_expected_child_intrinsics, + unexpected_intrinsics=_unexpected_child_intrinsics, + ) + @validate_transaction_metrics( + transaction_name, + group="Uri", + scoped_metrics=[(f"Function/{transaction_name} http send", 2)], + rollup_metrics=[(f"Function/{transaction_name} http send", 2), *_test_application_rollup_metrics], + ) + def _test(): + response = app.get(endpoint) + assert response.status == 200 + + # Catch context propagation error messages + assert not caplog.records + + _test() diff --git a/tests/hybridagent_flask/_test_application.py b/tests/hybridagent_flask/_test_application.py new file mode 100644 index 0000000000..2043f29b13 --- /dev/null +++ b/tests/hybridagent_flask/_test_application.py @@ -0,0 +1,70 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import webtest +from flask import Flask, abort, render_template, render_template_string +from werkzeug.exceptions import NotFound +from werkzeug.routing import Rule + +application = Flask(__name__) + + +@application.route("/index") +def index_page(): + return "INDEX RESPONSE" + + +application.url_map.add(Rule("/endpoint", endpoint="endpoint")) + + +@application.endpoint("endpoint") +def endpoint_page(): + return "ENDPOINT RESPONSE" + + +@application.route("/error") +def error_page(): + raise RuntimeError("RUNTIME ERROR") + + +@application.route("/abort_404") +def abort_404_page(): + abort(404) + + +@application.route("/exception_404") +def exception_404_page(): + raise NotFound + + +@application.route("/template_string") +def template_string(): + return render_template_string("

INDEX RESPONSE

") + + +@application.route("/template_not_found") +def template_not_found(): + return render_template("not_found") + + +@application.route("/html_insertion") +def html_insertion(): + return ( + "Some header" + "

My First Heading

My first paragraph.

" + "" + ) + + +_test_application = webtest.TestApp(application) diff --git a/tests/hybridagent_flask/_test_application_async.py b/tests/hybridagent_flask/_test_application_async.py new file mode 100644 index 0000000000..fefc2c05f3 --- /dev/null +++ b/tests/hybridagent_flask/_test_application_async.py @@ -0,0 +1,27 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import webtest +from _test_application import application +from conftest import async_handler_support + +# Async handlers only supported in Flask >2.0.0 +if async_handler_support: + + @application.route("/async") + async def async_page(): + return "ASYNC RESPONSE" + + +_test_application = webtest.TestApp(application) diff --git a/tests/hybridagent_flask/conftest.py b/tests/hybridagent_flask/conftest.py new file mode 100644 index 0000000000..093adb44c9 --- /dev/null +++ b/tests/hybridagent_flask/conftest.py @@ -0,0 +1,45 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import platform + +import pytest +from testing_support.fixtures import collector_agent_registration_fixture, collector_available_fixture + +from newrelic.common.package_version_utils import get_package_version_tuple + +FLASK_VERSION = get_package_version_tuple("flask") + +is_flask_v2 = FLASK_VERSION[0] >= 2 +is_not_flask_v2_3 = FLASK_VERSION < (2, 3, 0) +is_pypy = platform.python_implementation() == "PyPy" +async_handler_support = is_flask_v2 and not is_pypy +skip_if_not_async_handler_support = pytest.mark.skipif( + not async_handler_support, reason="Requires async handler support. (Flask >=v2.0.0, CPython)" +) + +_default_settings = { + "package_reporting.enabled": False, # Turn off package reporting for testing as it causes slow downs. + "transaction_tracer.explain_threshold": 0.0, + "transaction_tracer.transaction_threshold": 0.0, + "transaction_tracer.stack_trace_threshold": 0.0, + "debug.log_data_collector_payloads": True, + "debug.record_transaction_failure": True, + "opentelemetry.enabled": True, + "opentelemetry.traces.enabled": True, +} + +collector_agent_registration = collector_agent_registration_fixture( + app_name="Python Agent Test (Hybrid Agent, Flask)", default_settings=_default_settings +) diff --git a/tests/hybridagent_flask/test_application.py b/tests/hybridagent_flask/test_application.py new file mode 100644 index 0000000000..d9f64ecd48 --- /dev/null +++ b/tests/hybridagent_flask/test_application.py @@ -0,0 +1,266 @@ +# Copyright 2010 New Relic, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import pytest +from conftest import async_handler_support, skip_if_not_async_handler_support +from testing_support.fixtures import dt_enabled +from testing_support.validators.validate_error_event_attributes import validate_error_event_attributes +from testing_support.validators.validate_span_events import validate_span_events +from testing_support.validators.validate_transaction_errors import validate_transaction_errors +from testing_support.validators.validate_transaction_event_attributes import validate_transaction_event_attributes +from testing_support.validators.validate_transaction_metrics import validate_transaction_metrics + +try: + # The __version__ attribute was only added in 0.7.0. + # Flask team does not use semantic versioning during development. + from flask import __version__ as flask_version + + flask_version = tuple([int(v) for v in flask_version.split(".")]) + is_gt_flask060 = True + is_dev_version = False +except ValueError: + is_gt_flask060 = True + is_dev_version = True +except ImportError: + is_gt_flask060 = False + is_dev_version = False + +requires_endpoint_decorator = pytest.mark.skipif(not is_gt_flask060, reason="The endpoint decorator is not supported.") + + +def target_application(): + # We need to delay Flask application creation because of ordering + # issues whereby the agent needs to be initialised before Flask is + # imported and the routes configured. Normally pytest only runs the + # global fixture which will initialise the agent after each test + # file is imported, which is too late. + + if not async_handler_support: + from _test_application import _test_application + else: + from _test_application_async import _test_application + return _test_application + + +_exact_intrinsics = {"type": "Span"} +_exact_root_intrinsics = _exact_intrinsics.copy().update({"nr.entryPoint": True}) +_expected_intrinsics = [ + "traceId", + "transactionId", + "sampled", + "priority", + "timestamp", + "duration", + "name", + "category", + "guid", +] +_expected_root_intrinsics = [*_expected_intrinsics.copy(), "transaction.name"] +_expected_child_intrinsics = [*_expected_intrinsics.copy(), "parentId"] +_unexpected_root_intrinsics = ["parentId"] +_unexpected_child_intrinsics = ["nr.entryPoint", "transaction.name"] + +_test_application_rollup_metrics = [ + ("Supportability/DistributedTrace/CreatePayload/Success", 1), + ("Supportability/TraceContext/Create/Success", 1), + ("Python/WSGI/Input/Bytes", 1), + ("Python/WSGI/Input/Time", 1), + ("Python/WSGI/Input/Calls/read", 1), + ("Python/WSGI/Input/Calls/readline", 1), + ("Python/WSGI/Input/Calls/readlines", 1), + ("Python/WSGI/Output/Bytes", 1), + ("Python/WSGI/Output/Time", 1), + ("Python/WSGI/Output/Calls/yield", 1), + ("Python/WSGI/Output/Calls/write", 1), + ("HttpDispatcher", 1), + ("WebTransaction", 1), + ("WebTransactionTotalTime", 1), +] + + +@dt_enabled +@validate_transaction_errors(errors=[]) +@validate_transaction_event_attributes( + required_params={"agent": ["request.headers.host", "response.headers.contentType"], "intrinsic": [], "user": []}, + exact_attrs={ + "agent": { + "request.method": "GET", + "request.uri": "/index", + "response.headers.contentLength": 14, + "response.status": "200", + }, + "intrinsic": {"name": "WebTransaction/Uri/index"}, + "user": {}, + }, +) +@validate_transaction_metrics("index", group="Uri", rollup_metrics=_test_application_rollup_metrics) +@validate_span_events( + exact_intrinsics=_exact_root_intrinsics, + expected_intrinsics=_expected_root_intrinsics, + unexpected_intrinsics=_unexpected_root_intrinsics, + exact_agents={"otel.scope.name": "flask", "otel.library.name": "flask"}, + expected_agents=["otel.scope.version", "otel.library.version"], + exact_users={"library_name": "flask", "schema_url": "https://opentelemetry.io/schemas/1.11.0"}, + expected_users=["library_version"], +) +def test_opentelemetry_application_index(): + application = target_application() + response = application.get("/index") + response.mustcontain("INDEX RESPONSE") + + +@skip_if_not_async_handler_support +@dt_enabled +@validate_transaction_errors(errors=[]) +@validate_transaction_metrics("async", group="Uri", rollup_metrics=_test_application_rollup_metrics) +@validate_span_events( + exact_intrinsics=_exact_root_intrinsics, + expected_intrinsics=_expected_root_intrinsics, + unexpected_intrinsics=_unexpected_root_intrinsics, +) +def test_opentelemetry_application_async(): + application = target_application() + response = application.get("/async") + response.mustcontain("ASYNC RESPONSE") + + +@dt_enabled +@validate_transaction_errors(errors=[]) +@validate_transaction_metrics("endpoint", group="Uri", rollup_metrics=_test_application_rollup_metrics) +@validate_span_events( + exact_intrinsics=_exact_root_intrinsics, + expected_intrinsics=_expected_root_intrinsics, + unexpected_intrinsics=_unexpected_root_intrinsics, +) +def test_opentelemetry_application_endpoint(): + application = target_application() + response = application.get("/endpoint") + response.mustcontain("ENDPOINT RESPONSE") + + +@dt_enabled +@validate_transaction_errors(errors=["builtins:RuntimeError"]) +@validate_error_event_attributes( + exact_attrs={ + "agent": {}, + "intrinsic": { + "error.message": "RUNTIME ERROR", + "error.class": "builtins:RuntimeError", + "error.expected": False, + }, + "user": {"exception.escaped": False}, + } +) +@validate_transaction_metrics("error", group="Uri", rollup_metrics=_test_application_rollup_metrics) +@validate_span_events( + exact_intrinsics=_exact_root_intrinsics, + expected_intrinsics=_expected_root_intrinsics, + unexpected_intrinsics=_unexpected_root_intrinsics, +) +def test_opentelemetry_application_error(): + application = target_application() + application.get("/error", status=500, expect_errors=True) + + +@dt_enabled +@validate_transaction_errors(errors=[]) +@validate_transaction_metrics("abort_404", group="Uri", rollup_metrics=_test_application_rollup_metrics) +@validate_span_events( + exact_intrinsics=_exact_root_intrinsics, + expected_intrinsics=_expected_root_intrinsics, + unexpected_intrinsics=_unexpected_root_intrinsics, +) +def test_opentelemetry_application_abort_404(): + application = target_application() + application.get("/abort_404", status=404) + + +@dt_enabled +@validate_transaction_errors(errors=[]) +@validate_transaction_metrics("exception_404", group="Uri", rollup_metrics=_test_application_rollup_metrics) +@validate_span_events( + exact_intrinsics=_exact_root_intrinsics, + expected_intrinsics=_expected_root_intrinsics, + unexpected_intrinsics=_unexpected_root_intrinsics, +) +def test_application_exception_404(): + application = target_application() + application.get("/exception_404", status=404) + + +@dt_enabled +@validate_transaction_errors(errors=[]) +@validate_transaction_metrics("missing", group="Uri", rollup_metrics=_test_application_rollup_metrics) +@validate_span_events( + exact_intrinsics=_exact_root_intrinsics, + expected_intrinsics=_expected_root_intrinsics, + unexpected_intrinsics=_unexpected_root_intrinsics, +) +def test_application_not_found(): + application = target_application() + application.get("/missing", status=404) + + +_test_application_render_template_string_scoped_metrics = [ + ("Template/Compile/