URL encode user-inputted Ids, migrate to Github actions (#63)

* fix: URL encode user-inputted Ids to prevent injection

Also allow special characters to be used in Ids

* ci: migrate from circleci to github actions

* fix: build error `The system cannot find the path specified` for `openapi.yml` file

* fix-build: javadoc

* fix: use enum for documents index actions query param

- breaking change: documents index actions is now an enum instead of string

* ci: run tests using jdk 8, 11, 17

* fix-build: javadoc `bad use of '>'`

* fix-build: declare `generateSwaggerCodeTypesense` as dependency for task `sourcesJar`

`Task ':sourcesJar' uses this output of task ':generateSwaggerCodeTypesense' without declaring an explicit or implicit dependency`

* ci: use matrix for artifact name

* ci: test results logging

* ci: remove unused `books.jsonl` downloading

* build: fail fast for task `downloadApiSpec`

* remove unnecessary URL encoding of special characters

Author: haydenhoang

.circleci/config.yml

@@ -0,0 +1,49 @@
+name: Test
+
+on:
+  push:
+    paths-ignore:
+      - '**/*.md'
+  pull_request:
+    paths-ignore:
+      - '**/*.md'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        java: ['8', '11', '17']
+    services:
+      typesense:
+        image: typesense/typesense:27.0
+        ports:
+          - 8108:8108/tcp
+        volumes:
+          - /tmp/typesense-server-data:/data
+        env:
+          TYPESENSE_DATA_DIR: '/data'
+          TYPESENSE_API_KEY: 'xyz'
+          TYPESENSE_ENABLE_CORS: true
+          TYPESENSE_URL: 'http://localhost:8108'
+    name: Java ${{ matrix.Java }}
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: ${{ matrix.java }}
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v4
+
+      - name: Build with Gradle
+        run: ./gradlew build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: Java ${{ matrix.Java }}
+          path: build/libs

.github/workflows/test.yml

@@ -4,3 +4,4 @@
 .out/
 **/books.jsonl
 config.json
+/bin

.gitignore

@@ -7,6 +7,9 @@ plugins {
     id 'org.hidetake.swagger.generator' version '2.19.2'
 }
 
+import org.gradle.api.tasks.testing.logging.TestExceptionFormat
+import org.gradle.api.tasks.testing.logging.TestLogEvent
+
 apply plugin: DownloadSpecsPlugin
 
 repositories {
@@ -29,6 +32,42 @@ jar {
     exclude "META-INF/DEPENDENCIES"
 }
 
+tasks.withType(Test) {
+    testLogging {
+        // set options for log level LIFECYCLE
+        events TestLogEvent.FAILED,
+               TestLogEvent.PASSED,
+               TestLogEvent.SKIPPED,
+               TestLogEvent.STANDARD_OUT
+        exceptionFormat TestExceptionFormat.FULL
+        showExceptions true
+        showCauses true
+        showStackTraces true
+
+        // set options for log level DEBUG and INFO
+        debug {
+            events TestLogEvent.STARTED,
+                   TestLogEvent.FAILED,
+                   TestLogEvent.PASSED,
+                   TestLogEvent.SKIPPED,
+                   TestLogEvent.STANDARD_ERROR,
+                   TestLogEvent.STANDARD_OUT
+            exceptionFormat TestExceptionFormat.FULL
+        }
+        info.events = debug.events
+        info.exceptionFormat = debug.exceptionFormat
+
+        afterSuite { desc, result ->
+            if (!desc.parent) { // will match the outermost suite
+                def output = "Results: ${result.resultType} (${result.testCount} tests, ${result.successfulTestCount} passed, ${result.failedTestCount} failed, ${result.skippedTestCount} skipped)"
+                def startItem = '|  ', endItem = '  |'
+                def repeatLength = startItem.length() + output.length() + endItem.length()
+                println('\n' + ('-' * repeatLength) + '\n' + startItem + output + endItem + '\n' + ('-' * repeatLength))
+            }
+        }
+    }
+}
+
 sourceSets {
     integrationTest {
         compileClasspath += sourceSets.main.output
@@ -94,6 +133,7 @@ swaggerSources {
 }
 
 swaggerSources.typesense.code.dependsOn downloadApiSpec
+sourcesJar.dependsOn swaggerSources.typesense.code
 compileJava.dependsOn swaggerSources.typesense.code
 sourceSets.main.java.srcDir "${swaggerSources.typesense.code.outputDir}/src/main/java"
 sourceSets.main.resources.srcDir "${swaggerSources.typesense.code.outputDir}/src/main/resources"

build.gradle

@@ -12,7 +12,12 @@ class DownloadSpecsPlugin implements Plugin<Project> {
     void apply(Project project) {
         project.tasks.register("downloadApiSpec") {
             println('Downloading spec')
-            new File("${project.buildDir}/openapi.yml").withOutputStream { out ->
+            File file = new File("${project.buildDir}/openapi.yml")
+            if (!file.getParentFile().exists())
+                file.getParentFile().mkdirs();
+            if (!file.exists())
+                file.createNewFile();
+            file.withOutputStream { out ->
                 new URL(specUrl).withInputStream { from -> out << from }
             }
         }

buildSrc/src/main/groovy/DownloadSpecsPlugin.groovy

@@ -1,5 +1,6 @@
 package org.typesense.api;
 
+import org.typesense.api.utils.URLEncoding;
 import org.typesense.model.CollectionAlias;
 
 public class Alias {
@@ -20,7 +21,7 @@ public CollectionAlias delete() throws Exception {
         return this.apiCall.delete(this.getEndpoint(), null, CollectionAlias.class);
     }
 
-    public String getEndpoint(){
-        return Aliases.RESOURCE_PATH + "/" + this.name;
+    public String getEndpoint() {
+        return Aliases.RESOURCE_PATH + "/" + URLEncoding.encodeURIComponent(this.name);
     }
 }

src/main/java/org/typesense/api/Alias.java

@@ -1,5 +1,6 @@
 package org.typesense.api;
 
+import org.typesense.api.utils.URLEncoding;
 import org.typesense.model.CollectionAlias;
 import org.typesense.model.CollectionAliasSchema;
 import org.typesense.model.CollectionAliasesResponse;
@@ -9,13 +10,13 @@ public class Aliases {
     private ApiCall apiCall;
     public final static String RESOURCE_PATH = "/aliases";
 
-    public Aliases(ApiCall apiCall){
+    public Aliases(ApiCall apiCall) {
         this.apiCall = apiCall;
     }
 
-
     public CollectionAlias upsert(String name, CollectionAliasSchema collectionAliasSchema) throws Exception {
-        return this.apiCall.put(RESOURCE_PATH + "/" + name, collectionAliasSchema, null, CollectionAlias.class);
+        return this.apiCall.put(RESOURCE_PATH + "/" + URLEncoding.encodeURIComponent(name), collectionAliasSchema, null,
+                CollectionAlias.class);
     }
 
     public CollectionAliasesResponse retrieve() throws Exception {

src/main/java/org/typesense/api/Aliases.java

@@ -1,5 +1,6 @@
 package org.typesense.api;
 
+import org.typesense.api.utils.URLEncoding;
 import org.typesense.model.CollectionResponse;
 import org.typesense.model.CollectionUpdateSchema;
 
@@ -25,11 +26,11 @@ public class Collection {
 
     private final String endpoint;
 
-    Collection(String name, ApiCall apiCall, Configuration configuration){
-        this.name =name;
+    Collection(String name, ApiCall apiCall, Configuration configuration) {
+        this.name = name;
         this.apiCall = apiCall;
         this.configuration = configuration;
-        this.endpoint = Collections.RESOURCE_PATH + "/" + this.name;
+        this.endpoint = Collections.RESOURCE_PATH + "/" + URLEncoding.encodeURIComponent(this.name);
         this.documents = new Documents(this.name, this.apiCall, this.configuration);
         this.individualDocuments = new HashMap<>();
         this.synonyms = new Synonyms(this.name, this.apiCall);
@@ -50,44 +51,44 @@ public CollectionResponse delete() throws Exception {
         return this.apiCall.delete(endpoint, null, CollectionResponse.class);
     }
 
-    public Documents documents(){
+    public Documents documents() {
         return this.documents;
     }
 
-    public Document documents(String documentId){
+    public Document documents(String documentId) {
         Document retVal;
 
-        if(!this.individualDocuments.containsKey(documentId)){
-            this.individualDocuments.put(documentId,new Document(this.name, documentId, this.apiCall));
+        if (!this.individualDocuments.containsKey(documentId)) {
+            this.individualDocuments.put(documentId, new Document(this.name, documentId, this.apiCall));
         }
 
         retVal = this.individualDocuments.get(documentId);
-        return  retVal;
+        return retVal;
     }
 
-    public Synonyms synonyms(){
+    public Synonyms synonyms() {
         return this.synonyms;
     }
 
-    public Synonym synonyms(String synonymId){
+    public Synonym synonyms(String synonymId) {
         Synonym retVal;
 
-        if(!this.individualSynonyms.containsKey(synonymId)){
+        if (!this.individualSynonyms.containsKey(synonymId)) {
             this.individualSynonyms.put(synonymId, new Synonym(this.name, synonymId, this.apiCall));
         }
 
         retVal = this.individualSynonyms.get(synonymId);
-        return  retVal;
+        return retVal;
     }
 
-    public Overrides overrides(){
+    public Overrides overrides() {
         return this.overrides;
     }
 
-    public Override overrides(String overrideId){
+    public Override overrides(String overrideId) {
         Override retVal;
 
-        if(!this.individualOverrides.containsKey(overrideId)){
+        if (!this.individualOverrides.containsKey(overrideId)) {
             this.individualOverrides.put(overrideId, new Override(this.name, overrideId, this.apiCall));
         }
 

src/main/java/org/typesense/api/Collection.java

@@ -1,6 +1,7 @@
 package org.typesense.api;
 
 import java.util.Map;
+import org.typesense.api.utils.URLEncoding;
 
 public class Document {
     private String collectionName;
@@ -13,18 +14,19 @@ public class Document {
         this.documentId = documentId;
         this.apiCall = apiCall;
 
-        this.endpoint = Collections.RESOURCE_PATH + "/" +  this.collectionName + Documents.RESOURCE_PATH + "/" + this.documentId;
+        this.endpoint = Collections.RESOURCE_PATH + "/" + URLEncoding.encodeURIComponent(this.collectionName)
+                + Documents.RESOURCE_PATH + "/" + URLEncoding.encodeURIComponent(this.documentId);
     }
 
-    public Map<String,Object> retrieve() throws Exception {
+    public Map<String, Object> retrieve() throws Exception {
         return this.apiCall.get(endpoint, null, Map.class);
     }
 
     public Map<String, Object> delete() throws Exception {
         return this.apiCall.delete(this.endpoint, null, Map.class);
     }
 
-    public Map<String , Object> update(Map<String, Object> document) throws Exception {
+    public Map<String, Object> update(Map<String, Object> document) throws Exception {
         return this.apiCall.patch(this.endpoint, document, null, Map.class);
     }