Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

[v2] Add configuration to disable host prefix injection #9268

Open
wants to merge 1 commit into
base: v2
Choose a base branch
from

Conversation

kdaily
Copy link
Member

@kdaily kdaily commented Jan 31, 2025

Issue #, if available:

Description of changes:

This change deviates from the upstream botocore to add the ability to disable jost prefix injection. It changes the default for inject_host_prefix in the Config object to be None (from True) so that the value can be determined using the configuration precedence. The fallback if the value remains True if it is set to None to preserve the CLI default behavior.

Testing

Tested with the following commands which uses an operation-specific host prefix:

  1. Default case (no disable host prefix configuration set) results in the host prefix being added:
$ aws omics create-sequence-store --name "test-sequence-store1" --description "Test store" --endpoint-url https://localhost:1234/ --tags "Environment=Test"

Could not connect to the endpoint URL: "https://control-storage-localhost:1234/sequencestore"
  1. Set config environment variable to False, which is the same as the default behavior:
AWS_DISABLE_HOST_PREFIX_INJECTION=False aws omics create-sequence-store --name "test-sequence-store1" --description "Test store" --endpoint-url https://localhost:1234/ --tags "Environment=Test"

Could not connect to the endpoint URL: "https://control-storage-localhost:1234/sequencestore"
  1. Set config environment variable to True, which prevents the host prefix from being prepended to the endpoint URL:
$ AWS_DISABLE_HOST_PREFIX_INJECTION=True aws omics create-sequence-store --name "test-sequence-store1" --description "Test store" --endpoint-url https://localhost:1234/ --tags "Environment=Test"

Could not connect to the endpoint URL: "https://localhost:1234/sequencestore"

I also confirmed the behavior applies when using the configuration file setting disable_host_prefix_injection, and even when not using a custom endpoint URL.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

This change deviates from the upstream `botocore` to add the ability
to disable jost prefix injection. It changes the default for
`inject_host_prefix` in the Config object to be `None` (from `True`) so
that the value can be determined using the configuration precedence. The
fallback if the value remains `True` if it is set to `None` to preserve
the CLI default behavior.
@kdaily kdaily requested review from hssyoo and a team January 31, 2025 22:07
Copy link
Contributor

@hssyoo hssyoo left a comment

Choose a reason for hiding this comment

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

Looks good, just a couple small suggestions. I'm also curious if there are existing unit/functional tests where you can actually set the environment variable or create a config file to test that they resolve correctly E2E.

@@ -212,7 +212,6 @@ def compute_client_args(self, service_model, client_config,
proxies_config=client_config.proxies_config,
retries=client_config.retries,
client_cert=client_config.client_cert,
inject_host_prefix=client_config.inject_host_prefix,
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should leave this in here and when we compute the value, we can check if this is not None.

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure, not opposed to this. I went for self-containing all of the logic in the compute method.

Comment on lines +260 to +264
def _compute_inject_host_prefix(self, client_config, config_kwargs):
if client_config is not None and client_config.inject_host_prefix is not None:
config_kwargs['inject_host_prefix'] = (
client_config.inject_host_prefix
)
Copy link
Contributor

Choose a reason for hiding this comment

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

So here we can remove client_config as a parameter and check

if config_kwargs.get('inject_host_prefix') is not None:
    # User explicitly set a client config value. Respect it and return.
    return

Copy link
Member

@ashovlin ashovlin left a comment

Choose a reason for hiding this comment

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

Could we wait to merge until we figure out the plan for botocore? Want to understand where V1 vs. V2 will land.

{
"type": "feature",
"category": "configuration",
"description": "Configure if the host prefix is prepended to the request URL in the shared configuration file or via an environment variable"
Copy link
Member

Choose a reason for hiding this comment

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

Could we document the specific environment variable and setting name here?

Suggested change
"description": "Configure if the host prefix is prepended to the request URL in the shared configuration file or via an environment variable"
"description": "Allow disabling the prepending of the host prefix to the request URL via ``disable_host_prefix_injection`` in the shared configuration file or the ``AWS_DISABLE_HOST_PREFIX_INJECTION`` environment variable"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants