Add end to end test suite to test NextJS app in Edge runtime w/TS client

[aulorbe]

Problem

We do not currently have a good way to test how our client behaves end to end in different environments. One of the chief problems our users have brought to our attention in the past is that some functionalities do not work in certain runtimes, e.g. Edge or Bun, and/or with certain frameworks, e.g. NextJS.

Solution

Build an external application in a runtime and framework known to have caused problems in the past and test our client from the end-user's perspective.

This PR introduces and end-to-end test suite that interacts with an external application written using the NextJS framework and the Edge runtime.

Note: the app is automagically run in Edge by way of it using middleware (middleware.ts), and the Headers() API.

Overview of changes

• We now have a public repo that contains a super simple application that builds a Pinecone serverless index, seeds it with data, and queries that data. We plan to add more operations in the near future; this is just a start.
• This sample application creates an API endpoint that our client repo can send a POST request to and assert on the response. If the endpoint fails to deliver the expected response, we know that something is wrong with the most recent changes we are proposing to introduce in the client.
• This PR enables 2 types of interaction with the sample application:
  • Local end-to-end tests: for local runs, there is a new bash script that devs can execute. This will spin up the application on their localhost:3000. Once the app is up and running, they can hit the endpoint with cURL, Postman, etc.
  • CI end-to-end tests: for CI runs, we will now run this end-to-end test automatically by way of adding it the testing.yml file that is run for each push to an open PR. In CI, the Github workflow and action hit the application's endpoint and assert on its response. In this environment, the Github action is hitting a version of the app that is hosted on Pinecone's Enterprise Vercel account. Note: if this app's Vercel deployment gets rolled back for any reason, the CI tests will fail.
• There is a new CONTRIBUTING.md file with some info on this new test suite + the other existing ones, as well as a new README in the end-to-end dir itself with more in depth information.

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

If reviewers can pull down the code in this branch and try to run the end-to-end tests locally, that'd be great.

To Dos

I'll add a README and a CONTRIBUTING file to the external app

[aulorbe]

Just a note for the previous step: npm pack packages up the existing code on the existing branch, so it'll run the code devs are proposing to merge in their PR, rather than whatever code is on npm etc. This removes the need for us to merge things before testing them end to end.

[aulorbe]

This is where we assert on the response in CI

[aulorbe]

Index names are randomized in the app. We then save the index name to the GITHUB_ENV environment variable file, so that we can delete them later -- this ensures we can have simultaneous runs of this workflow, from creating the index to deleting it later

[aulorbe]

This will overwrite the portion in the app's package.json that says "@pinecone-database/pinecone": "^3.0.4-rc.2024-10.0". Instead, it'll link to your local version.

You must run it after npm install, or else npm install will change package.json back to "^3.0.4-rc.2024-10.0", since that's the latest version up on npm as of this writing.

[aulorbe]

We do have to install NextJS globally or else the next dev command (to spin up the app on your localhost:3000 won't work when run from the ts-client repo, which is where this bash file is being executed. If you don't want Next globally, you can uncomment line 54 and uninstall it.