Revise proxy configuration, add integration testing

[jhamon]

Problem

We want to expose proxy configuration fields as top-level config params and move away from users passing an OpenApiConfiguration instance with openapi_config (as was done in 2.x versions of the sdk). Passing these objects is not something we documented or had shown as a named configuration param, but is something people assumed would work as a hangover from the way things were done in the old client.

Currently OpenApi generated code is part of our implementation, but we may want to swap out something else in the future so it doesn't make sense to use this OpenApiConfiguration object as part of our public interface. And since the openapi config object also needs to be configured with api key and host, it competes with these other config params in a way that is pretty confusing.

Solution

• Add new configuration parameters for proxy_url, proxy_headers, ssl_ca_certs, and ssl_verify.
• Document the use of these properties in the README and doc strings
• Emit a warning message when users are passing openapi_config encouraging them to use the new properties.
• Implement integration tests that run with mitmproxy docker image. For now these are only run in local development.

Usage

from pinecone import Pinecone
import urllib3 import make_headers

pc = Pinecone(
    api_key="YOUR_API_KEY",
    proxy_url='https://your-proxy.com',
    proxy_headers=make_headers(proxy_basic_auth='username:password'),
    ssl_ca_certs='path/to/cert-bundle.pem'
)

This will work, but should emit a deprecation warning:

from pinecone import Pinecone
from pinecone.core.client.configuration import OpenApiConfiguration
import urllib3 import make_headers

config = OpenApiConfiguration()
config.ssl_ca_certs = 'path/to/cert-bundle.pem'
config.proxy_headers = make_headers(proxy_basic_auth='username:password')
config.proxy_url = 'https://your-proxy.com'

pc = Pinecone(
    api_key="YOUR_API_KEY",
    openapi_config=config
) # emits deprecation notice

Future work

We will need to figure out how to deploy the mitmproxy elsewhere (cloud run?) before running tests in CI because Github Actions seems to have a lot of issues with running these docker containers and debugging the errors has proven quite difficult. While GHA can run docker containers, mounting a volume with the required certs causes the container to crash. I'm guessing this is some kind of file permissions issue, but don't have much visibility for debugging.

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• Infrastructure change (CI configs, etc)
• Non-code change (docs, etc)
• None of the above: (explain here)

Test Plan

Run new tests locally with PINECONE_API_KEY='foo' PINECONE_INDEX_NAME='bar' poetry run pytest tests/integration/proxy_config/ -s -v

[gitguardian]

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
10042887	Triggered	RSA Private Key	b9517f2	tests/integration/proxy_config/.mitm/proxy1/mitmproxy-ca.pem	View secret
10042888	Triggered	RSA Private Key	b9517f2	tests/integration/proxy_config/.mitm/proxy2/mitmproxy-ca.pem	View secret

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code.
2. Replace and store your secrets safely. Learn here the best practices.
3. Revoke and rotate these secrets.
4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

• following these best practices for managing and storing secrets including API keys and other credentials
• install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

---

<sup>🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!</sup>

[jhamon]

This is not really related to the config changes, but keeps us from getting failures due to 20 index per-project limit.

[jhamon]

Leaving this commented code in as I have plans to bring back CI integration tests in a future PR.

[jhamon]

All of these cert / key things are generated by mitmproxy.

[austin-denoble]

Thanks for putting so much effort into this, I think what you've learned working on the implementation here will help us across the board. Overall this all looks good to me, thanks for adding test coverage generally. 🚢

[austin-denoble]

Nice docs-touch referring folks out to urllib3 👍

[austin-denoble]

I may be reading this incorrectly, but it doesn't look like we're doing anything with kwargs here or in build?

Is the comment meant to be referencing overriding openapi_config with config?

[jhamon]

The config object is built using kwarg values (specifically PineconeConfig.build called from the Pinecone constructor). Sorry it's not more clear. Things get confusing when trying to manage and merge these different sources of configuration, which is a big reason I want to deprecate passing openapi_config.

[austin-denoble]

Nice work getting all of this set up, thank you.