Add support for Typesense Service Connection

Docker Compose and Testcontainers Service Connection support for
Typesense.

spring-ai-spring-boot-docker-compose/src/main/java/org/springframework/ai/docker/compose/service/connection/typesense/TypesenseDockerComposeConnectionDetailsFactory.java

@@ -0,0 +1,82 @@
+/*
+ * Copyright 2023 - 2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.ai.docker.compose.service.connection.typesense;
+
+import org.springframework.ai.autoconfigure.vectorstore.typesense.TypesenseConnectionDetails;
+import org.springframework.boot.docker.compose.core.RunningService;
+import org.springframework.boot.docker.compose.service.connection.DockerComposeConnectionDetailsFactory;
+import org.springframework.boot.docker.compose.service.connection.DockerComposeConnectionSource;
+
+/**
+ * @author Eddú Meléndez
+ */
+public class TypesenseDockerComposeConnectionDetailsFactory
+		extends DockerComposeConnectionDetailsFactory<TypesenseConnectionDetails> {
+
+	private static final int TYPESENSE_PORT = 8108;
+
+	protected TypesenseDockerComposeConnectionDetailsFactory() {
+		super("typesense/typesense");
+	}
+
+	@Override
+	protected TypesenseConnectionDetails getDockerComposeConnectionDetails(DockerComposeConnectionSource source) {
+		return new TypesenseComposeConnectionDetails(source.getRunningService());
+	}
+
+	/**
+	 * {@link TypesenseConnectionDetails} backed by a {@code Typesense}
+	 * {@link RunningService}.
+	 */
+	static class TypesenseComposeConnectionDetails extends DockerComposeConnectionDetails
+			implements TypesenseConnectionDetails {
+
+		private final TypesenseEnvironment environment;
+
+		private final String host;
+
+		private final int port;
+
+		TypesenseComposeConnectionDetails(RunningService service) {
+			super(service);
+			this.environment = new TypesenseEnvironment(service.env());
+			this.host = service.host();
+			this.port = service.ports().get(TYPESENSE_PORT);
+		}
+
+		@Override
+		public String getHost() {
+			return this.host;
+		}
+
+		@Override
+		public String getProtocol() {
+			return "http";
+		}
+
+		@Override
+		public int getPort() {
+			return this.port;
+		}
+
+		@Override
+		public String getApiKey() {
+			return this.environment.getApiKey();
+		}
+
+	}
+
+}

spring-ai-spring-boot-docker-compose/src/main/java/org/springframework/ai/docker/compose/service/connection/typesense/TypesenseEnvironment.java

@@ -0,0 +1,17 @@
+package org.springframework.ai.docker.compose.service.connection.typesense;
+
+import java.util.Map;
+
+class TypesenseEnvironment {
+
+	private final String apiKey;
+
+	TypesenseEnvironment(Map<String, String> env) {
+		this.apiKey = env.get("TYPESENSE_API_KEY");
+	}
+
+	public String getApiKey() {
+		return this.apiKey;
+	}
+
+}

spring-ai-spring-boot-docker-compose/src/main/resources/META-INF/spring.factories

@@ -3,4 +3,5 @@ org.springframework.ai.docker.compose.service.connection.chroma.ChromaDockerComp
 org.springframework.ai.docker.compose.service.connection.ollama.OllamaDockerComposeConnectionDetailsFactory,\
 org.springframework.ai.docker.compose.service.connection.qdrant.QdrantDockerComposeConnectionDetailsFactory,\
 org.springframework.ai.docker.compose.service.connection.redis.RedisDockerComposeConnectionDetailsFactory,\
+org.springframework.ai.docker.compose.service.connection.typesense.TypesenseDockerComposeConnectionDetailsFactory,\
 org.springframework.ai.docker.compose.service.connection.weaviate.WeaviateDockerComposeConnectionDetailsFactory

spring-ai-spring-boot-docker-compose/src/test/java/org/springframework/ai/docker/compose/service/connection/typesense/TypesenseDockerComposeConnectionDetailsFactoryTests.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2023 - 2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.ai.docker.compose.service.connection.typesense;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.ai.autoconfigure.vectorstore.typesense.TypesenseConnectionDetails;
+import org.springframework.boot.docker.compose.service.connection.test.AbstractDockerComposeIntegrationTests;
+import org.testcontainers.utility.DockerImageName;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class TypesenseDockerComposeConnectionDetailsFactoryTests extends AbstractDockerComposeIntegrationTests {
+
+	TypesenseDockerComposeConnectionDetailsFactoryTests() {
+		super("typesense-compose.yaml", DockerImageName.parse("typesense/typesense:26.0"));
+	}
+
+	@Test
+	void runCreatesConnectionDetails() {
+		TypesenseConnectionDetails connectionDetails = run(TypesenseConnectionDetails.class);
+		assertThat(connectionDetails.getHost()).isNotNull();
+		assertThat(connectionDetails.getPort()).isGreaterThan(0);
+		assertThat(connectionDetails.getProtocol()).isEqualTo("http");
+		assertThat(connectionDetails.getApiKey()).isEqualTo("secret");
+	}
+
+}

spring-ai-spring-boot-docker-compose/src/test/java/org/springframework/ai/docker/compose/service/connection/typesense/TypesenseEnvironmentTests.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2023 - 2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.ai.docker.compose.service.connection.typesense;
+
+import org.junit.jupiter.api.Test;
+
+import java.util.Collections;
+import java.util.Map;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class TypesenseEnvironmentTests {
+
+	@Test
+	void getApiKeyWhenNoApiKey() {
+		TypesenseEnvironment environment = new TypesenseEnvironment(Collections.emptyMap());
+		assertThat(environment.getApiKey()).isNull();
+	}
+
+	@Test
+	void getApiKeyWhenHasApiKey() {
+		TypesenseEnvironment environment = new TypesenseEnvironment(Map.of("TYPESENSE_API_KEY", "secret"));
+		assertThat(environment.getApiKey()).isEqualTo("secret");
+	}
+
+}

spring-ai-spring-boot-docker-compose/src/test/resources/org/springframework/ai/docker/compose/service/connection/typesense/typesense-compose.yaml

@@ -0,0 +1,8 @@
+services:
+  typesense:
+    image: '{imageName}'
+    ports:
+      - '8108'
+    command: '--data-dir /tmp --enable-cors'
+    environment:
+        - TYPESENSE_API_KEY=secret