Release candidate/2024 07 (#142)

## Problem

Add deletion protection and generate code based on latest open api spec.

## Solution

Generated code based on 2024-07 open api spec which includes deletion
protection support. Manually added deletion protection support to the
control plane wrapper along with integration tests.

## Type of Change

- [X] New feature (non-breaking change which adds functionality)

## Test Plan

Added integration tests

---------

Co-authored-by: Jennifer Hamon <[email protected]>

Author: rohanshah18

.gitignore

@@ -79,4 +79,6 @@ nb-configuration.xml
 ##############################
 ## OS X
 ##############################
-.DS_Store
+.DS_Store
+
+gen

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "codegen/apis"]
+	path = codegen/apis
+	url = [email protected]:pinecone-io/apis.git

README.md

@@ -39,8 +39,7 @@ having to obtain the *pinecone-client* dependencies separately.
 ### Initializing the client
 
 Before you can use the Pinecone Java SDK, you must sign up for a Pinecone account and find your API key in the Pinecone 
-console 
-dashboard at [https://app.pinecone.io](https://app.pinecone.io).
+console dashboard at [https://app.pinecone.io](https://app.pinecone.io).
 
 #### Using apiKey
 
@@ -75,7 +74,7 @@ public class InitializeClientExample {
 
         OkHttpClient httpClient = builder.build();
 
-        Pinecone pinecone = new Pinecone.Builder("PINECONE_API_KEY").build();
+        Pinecone pinecone = new Pinecone.Builder("PINECONE_API_KEY").withOkHttpClient(httpClient).build();
     }
 }
 ```

codegen/apis

@@ -0,0 +1,87 @@
+#!/bin/bash
+
+set -eux -o pipefail
+
+version=$1 # e.g. 2024-07
+modules=("control")
+
+destination="src/main/java/org/openapitools"
+build_dir="gen"
+
+update_apis_repo() {
+	echo "Updating apis repo"
+	pushd codegen/apis
+		git fetch
+		git checkout main
+		git pull
+		just build
+	popd
+}
+
+verify_spec_version() {
+	local version=$1
+	echo "Verifying spec version $version exists in apis repo"
+	if [ -z "$version" ]; then
+		echo "Version is required"
+		exit 1
+	fi
+
+	verify_directory_exists "codegen/apis/_build/${version}"
+}
+
+verify_file_exists() {
+	local filename=$1
+	if [ ! -f "$filename" ]; then
+		echo "File does not exist at $filename"
+		exit 1
+	fi
+}
+
+verify_directory_exists() {
+	local directory=$1
+	if [ ! -d "$directory" ]; then
+		echo "Directory does not exist at $directory"
+		exit 1
+	fi
+}
+
+generate_client() {
+	local module_name=$1
+
+	oas_file="codegen/apis/_build/${version}/${module_name}_${version}.oas.yaml"
+	
+	verify_file_exists $oas_file
+
+	# Cleanup previous build files
+	echo "Cleaning up previous build files"
+	rm -rf "${build_dir}"
+
+	# Generate client module
+	docker run --rm -v $(pwd):/workspace openapitools/openapi-generator-cli:v7.0.1 generate \
+		--input-spec "/workspace/$oas_file" \
+		--generator-name java \
+		--additional-properties=dateLibrary='java8',disallowAdditionalPropertiesIfNotPresent=false \
+		--output "/workspace/${build_dir}"
+
+	# Copy the generated module to the correct location
+	rm -rf "${destination}/${module_name}"
+	mkdir -p "${destination}/${module_name}"
+
+	path_to_copy="${build_dir}/src/main/java/org/openapitools/client"
+	cp -r $path_to_copy "${destination}/${module_name}"
+
+	# Adjust package names in generated file
+  find "${destination}/${module_name}" -name "*.java" | while IFS= read -r file; do
+    sed -i '' "s/org\.openapitools\.client/org\.openapitools\.${module_name}\.client/g" "$file"
+  done
+}
+
+update_apis_repo
+verify_spec_version $version
+
+rm -rf "${destination}"
+mkdir -p "${destination}"
+
+for module in "${modules[@]}"; do
+	generate_client $module
+done

codegen/build-oas.sh

@@ -5,7 +5,7 @@
 import io.pinecone.clients.Pinecone;
 import io.pinecone.exceptions.PineconeException;
 import io.pinecone.proto.DescribeIndexStatsResponse;
-import org.openapitools.client.model.*;
+import org.openapitools.control.client.model.*;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -50,8 +50,8 @@ public class TestResourcesManager {
             ? "us-east4-gcp"
             : System.getenv("PINECONE_ENVIRONMENT");
     private static final String metric = System.getenv("METRIC") == null
-            ? IndexMetric.DOTPRODUCT.toString()
-            : IndexMetric.valueOf(System.getenv("METRIC")).toString();
+            ? IndexModel.MetricEnum.DOTPRODUCT.toString()
+            : IndexModel.MetricEnum.valueOf(System.getenv("METRIC")).toString();
     private static final String cloud = System.getenv("CLOUD") == null
             ? ServerlessSpec.CloudEnum.AWS.toString()
             : System.getenv("CLOUD");
@@ -317,7 +317,7 @@ public String getOrCreateServerlessIndex() throws InterruptedException, Pinecone
         String indexName = RandomStringBuilder.build("serverless-index", 8);
 
         serverlessIndexModel = pineconeClient.createServerlessIndex(indexName, metric, dimension, cloud,
-                region);
+                region, DeletionProtection.DISABLED);
         waitUntilIndexIsReady(pineconeClient, indexName);
 
         // Explicitly wait after ready to avoid the "no healthy upstream" issue

src/integration/java/io/pinecone/helpers/TestResourcesManager.java

@@ -4,7 +4,7 @@
 import io.pinecone.clients.Pinecone;
 import io.pinecone.proto.DescribeIndexStatsResponse;
 import io.pinecone.proto.NamespaceSummary;
-import org.openapitools.client.model.*;
+import org.openapitools.control.client.model.*;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 

src/integration/java/io/pinecone/helpers/TestUtilities.java

@@ -12,7 +12,7 @@
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
-import org.openapitools.client.model.*;
+import org.openapitools.control.client.model.*;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -117,11 +117,11 @@ public void testIndexFromCollectionHappyPath() throws InterruptedException {
     public void testCreateIndexFromCollectionWithDiffMetric() throws InterruptedException {
         // Use a different metric than the source index
         String[] metrics = {
-                IndexMetric.COSINE.toString(),
-                IndexMetric.EUCLIDEAN.toString(),
-                IndexMetric.DOTPRODUCT.toString()
+                IndexModel.MetricEnum.COSINE.toString(),
+                IndexModel.MetricEnum.EUCLIDEAN.toString(),
+                IndexModel.MetricEnum.DOTPRODUCT.toString()
         };
-        String targetMetric = IndexMetric.COSINE.toString();
+        String targetMetric = IndexModel.MetricEnum.COSINE.toString();
         for (String metric : metrics) {
             if (!metric.equals(sourceIndexMetric)) {
                 targetMetric = metric;

src/integration/java/io/pinecone/integration/controlPlane/pod/CollectionTest.java

@@ -8,9 +8,10 @@
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
-import org.openapitools.client.model.IndexModel;
-import org.openapitools.client.model.IndexModelStatus;
-import org.openapitools.client.model.PodSpec;
+import org.openapitools.control.client.model.DeletionProtection;
+import org.openapitools.control.client.model.IndexModel;
+import org.openapitools.control.client.model.IndexModelStatus;
+import org.openapitools.control.client.model.PodSpec;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -55,7 +56,7 @@ public void afterEach() throws InterruptedException {
     @Test
     public void configureIndexWithInvalidIndexName() {
         try {
-            controlPlaneClient.configureIndex("non-existent-index", 3);
+            controlPlaneClient.configurePodsIndex("non-existent-index", 3, DeletionProtection.DISABLED);
 
             fail("Expected to throw PineconeNotFoundException");
         } catch (PineconeNotFoundException expected) {
@@ -66,7 +67,7 @@ public void configureIndexWithInvalidIndexName() {
     @Test
     public void configureIndexExceedingQuota() {
         try {
-            controlPlaneClient.configureIndex(indexName, 600);
+            controlPlaneClient.configurePodsIndex(indexName, 30, DeletionProtection.DISABLED);
             fail("Expected to throw PineconeForbiddenException");
         } catch (PineconeForbiddenException expected) {
             assertTrue(expected.getLocalizedMessage().contains("reached the max pods allowed"));
@@ -81,7 +82,7 @@ public void scaleUpAndDown() throws InterruptedException {
 
         // Verify the scaled up replicas
         assertWithRetry(() -> {
-            controlPlaneClient.configureIndex(indexName, 3);
+            controlPlaneClient.configurePodsIndex(indexName, 3, DeletionProtection.DISABLED);
             PodSpec podSpec = controlPlaneClient.describeIndex(indexName).getSpec().getPod();
             assertNotNull(podSpec);
             assertEquals(podSpec.getReplicas(), 3);
@@ -91,7 +92,7 @@ public void scaleUpAndDown() throws InterruptedException {
 
         // Verify replicas were scaled down
         assertWithRetry(() -> {
-            controlPlaneClient.configureIndex(indexName, 1);
+            controlPlaneClient.configurePodsIndex(indexName, 1, DeletionProtection.DISABLED);
             PodSpec podSpec = controlPlaneClient.describeIndex(indexName).getSpec().getPod();
             assertNotNull(podSpec);
             assertEquals(podSpec.getReplicas(), 1);
@@ -107,7 +108,7 @@ public void changingBasePodType() throws InterruptedException {
             assertEquals(1, indexModel.getSpec().getPod().getReplicas());
 
             // Try to change the base pod type
-            controlPlaneClient.configureIndex(indexName, "p2.x2");
+            controlPlaneClient.configurePodsIndex(indexName, "p2.x2");
 
             fail("Expected to throw PineconeBadRequestException");
         } catch (PineconeBadRequestException expected) {
@@ -125,7 +126,7 @@ public void sizeIncrease() throws InterruptedException {
         // Change the pod type to a larger one
         // Get the index description to verify the new pod type
         assertWithRetry(() -> {
-            controlPlaneClient.configureIndex(indexName, "p1.x2");
+            controlPlaneClient.configurePodsIndex(indexName, "p1.x2");
             PodSpec podSpec = controlPlaneClient.describeIndex(indexName).getSpec().getPod();
             assertNotNull(podSpec);
             assertEquals(podSpec.getPodType(), "p1.x2");

src/integration/java/io/pinecone/integration/controlPlane/pod/ConfigureIndexTest.java

@@ -6,7 +6,7 @@
 import io.pinecone.helpers.TestResourcesManager;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
-import org.openapitools.client.model.*;
+import org.openapitools.control.client.model.*;
 
 import static org.junit.jupiter.api.Assertions.*;
 
@@ -36,7 +36,7 @@ public void describeAndListIndex() {
         assertNotNull(indexModel);
         assertEquals(indexDimension, indexModel.getDimension());
         assertEquals(indexName, indexModel.getName());
-        assertEquals(IndexMetric.DOTPRODUCT, indexModel.getMetric());
+        assertEquals(IndexModel.MetricEnum.DOTPRODUCT, indexModel.getMetric());
         assertNotNull(indexModel.getSpec().getPod());
         assertEquals(indexPodType, indexModel.getSpec().getPod().getPodType());
 
@@ -63,7 +63,7 @@ public void createPodsIndexWithMinimumRequiredParams() {
         assertEquals(podType, podsIndex.getSpec().getPod().getPodType());
 
         // Confirm defaults are put in by the backend when not supplied by the user
-        assertEquals(IndexMetric.COSINE, podsIndex.getMetric());
+        assertEquals(IndexModel.MetricEnum.COSINE, podsIndex.getMetric());
         assertEquals(1, podsIndex.getSpec().getPod().getPods());
         assertEquals(1, podsIndex.getSpec().getPod().getReplicas());
         assertEquals(1, podsIndex.getSpec().getPod().getShards());