Revise proxy configuration, add integration testing #325

jhamon · 2024-03-19T03:55:00Z

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

This reverts commit 9f5f036.

gitguardian · 2024-03-20T00:14:23Z

⚠️ 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

Understand the implications of revoking this secret by investigating where it is used in your code.
Replace and store your secrets safely. Learn here the best practices.
Revoke and rotate these secrets.
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.

^{🦉 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!}

jhamon · 2024-03-21T16:41:33Z

.github/workflows/testing-dependency.yaml

@@ -158,3 +158,19 @@ jobs:
          index_name: '${{ needs.dependency-matrix-setup.outputs.index_name }}'
          PINECONE_API_KEY: '${{ secrets.PINECONE_API_KEY }}'
          urllib3_version: '${{ matrix.urllib3_version }}'
+
+  deps-cleanup:


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

jhamon · 2024-03-21T16:42:12Z

.github/workflows/testing-integration.yaml

@@ -3,6 +3,54 @@ name: "Integration Tests"
  workflow_call: {}

 jobs:
+  # setup-index:


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

jhamon · 2024-03-21T16:53:09Z

tests/integration/proxy_config/.mitm/proxy1/mitmproxy-ca-cert.cer

@@ -0,0 +1,20 @@
+-----BEGIN CERTIFICATE-----


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 · 2024-03-21T18:55:46Z

README.md

+### Proxy configuration
+
+If your network setup requires you to interact with Pinecone via a proxy, you will need
+to pass additional configuration using optional keyword parameters. These optional parameters are forwarded to `urllib3`, which is the underlying library currently used by the Pinecone client to make HTTP requests. You may find it helpful to refer to the  [urllib3 documentation on working with proxies](https://urllib3.readthedocs.io/en/stable/advanced-usage.html#http-and-https-proxies) while troubleshooting these settings. 


Nice docs-touch referring folks out to urllib3 👍

austin-denoble · 2024-03-21T19:02:24Z

pinecone/config/config.py

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?

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 · 2024-03-21T19:09:13Z

tests/integration/proxy_config/conftest.py

+    }
+}
+
+def docker_command(proxy):


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

* 'main' of github.com:pinecone-io/pinecone-python-client: [skip ci] Bump version to v4.1.0 Bump tqdm from 4.66.1 to 4.66.3 (pinecone-io#344) Bump idna from 3.4 to 3.7 (pinecone-io#345) Bump jinja2 from 3.1.3 to 3.1.4 (pinecone-io#343) Add better error messages for mistaken `from_texts` and `from_documents` (pinecone-io#342) Support proxy_url and ssl_ca_certs options for gRPC (pinecone-io#341) Remove serverless public preview warnings (pinecone-io#340) [skip ci] Bump version to v4.0.0 Improve upsert throughput by 3x (pinecone-io#334) Remove `merge` workflow and update `build-and-publish-docs` workflow to be manually runnable (pinecone-io#335) [skip ci] Bump version to v3.2.2 [Fix] openapi_config deprecation warning incorrectly shown (pinecone-io#327) Add grpc unit test run, expand testing of VectorFactory (pinecone-io#326) [skip ci] Bump version to v3.2.1 Allow clients to tag requests with a source_tag (pinecone-io#324) [skip ci] Bump version to v3.2.0 Revise proxy configuration, add integration testing (pinecone-io#325) [Fix] Configuring SSL proxy via openapi_config object (pinecone-io#321) Update README.md (pinecone-io#323)

jhamon added 18 commits March 18, 2024 23:54

Add integration tests with proxy

0d2ef35

Adjust working dir for github actions

c36f4b7

Update docs

9662045

Add debug output in tests

c228cde

Simplify compose up

8ee2695

Iterate on test setup

8ab5da0

More debug output

1e4555c

More debug output

e5f0130

List running containers

88a8c62

Adjust docker volumes

9f5f036

Revert "Adjust docker volumes"

8ac4bdf

This reverts commit 9f5f036.

Adjust volume config

da52763

Remove name from compose file

4653d03

Consolidate docker run into same step as test run

74ee9e7

Experiment: file permissions

8786d3d

Docker compose with no daemon option

0b97dd3

Adjust user permissions

3c24904

Remove docker compose

b9517f2

jhamon added 11 commits March 20, 2024 11:08

Adjust urls

677d282

Remove files accidentally committed

0e51730

Upload test log as artifacts

174816c

Log docker status

a6a1e9e

Adjust sleep

cb3ad73

Bump upload-artifact

87092a5

Temporarily comment other tests

edfb88c

Temporarily keep containers after they exit

72dd0b2

Adjust log out

c3a6566

Disable proxy tests in CI

e05923e

Reenable other tests

9714afd

Update README

a057145

jhamon changed the title ~~Proxy configuration and intiegration testing~~ Proxy configuration and integration testing Mar 21, 2024

jhamon changed the title ~~Proxy configuration and integration testing~~ Revise proxy configuration, add integration testing Mar 21, 2024

jhamon added 2 commits March 21, 2024 11:50

Update READMe

70b2d9a

Add inline comments

5450689

jhamon commented Mar 21, 2024

View reviewed changes

jhamon requested review from austin-denoble and jseldess March 21, 2024 16:56

jhamon marked this pull request as ready for review March 21, 2024 16:57

austin-denoble approved these changes Mar 21, 2024

View reviewed changes

jhamon merged commit 6fa0447 into main Mar 21, 2024
125 checks passed

jhamon deleted the jhamon/ssl-config-params branch March 21, 2024 19:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revise proxy configuration, add integration testing #325

Revise proxy configuration, add integration testing #325

jhamon commented Mar 19, 2024 •

edited

Loading

gitguardian bot commented Mar 20, 2024 •

edited

Loading

jhamon Mar 21, 2024 •

edited

Loading

jhamon Mar 21, 2024

jhamon Mar 21, 2024

austin-denoble left a comment

austin-denoble Mar 21, 2024

austin-denoble Mar 21, 2024

jhamon Mar 21, 2024 •

edited

Loading

austin-denoble Mar 21, 2024

Revise proxy configuration, add integration testing #325

Revise proxy configuration, add integration testing #325

Conversation

jhamon commented Mar 19, 2024 • edited Loading

Problem

Solution

Usage

Future work

Type of Change

Test Plan

gitguardian bot commented Mar 20, 2024 • edited Loading

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

jhamon Mar 21, 2024 • edited Loading

Choose a reason for hiding this comment

jhamon Mar 21, 2024

Choose a reason for hiding this comment

jhamon Mar 21, 2024

Choose a reason for hiding this comment

austin-denoble left a comment

Choose a reason for hiding this comment

austin-denoble Mar 21, 2024

Choose a reason for hiding this comment

austin-denoble Mar 21, 2024

Choose a reason for hiding this comment

jhamon Mar 21, 2024 • edited Loading

Choose a reason for hiding this comment

austin-denoble Mar 21, 2024

Choose a reason for hiding this comment

jhamon commented Mar 19, 2024 •

edited

Loading

gitguardian bot commented Mar 20, 2024 •

edited

Loading

jhamon Mar 21, 2024 •

edited

Loading

jhamon Mar 21, 2024 •

edited

Loading