[NOID] Fixes #2136: Support for additional HTTP headers in apoc.es procedures (#3953) (#3986)

vga91 · web-flow · commit fac7fb29cea7 · 2024-03-11T00:53:02.000+01:00
* [NOID] Fixes #2136: Support for additional HTTP headers in apoc.es procedures (#3953) * [NOID] fix compile errors and code formatting * [NOID] added license block
diff --git a/LICENSES.txt b/LICENSES.txt
@@ -28,16 +28,19 @@ Apache-2.0
   cassandra-driver-core-3.10.0.jar
   commons-beanutils-1.9.4.jar
   commons-cli-1.2.jar
+  commons-codec-1.15.jar
   commons-codec-1.16.1.jar
   commons-collections-3.2.2.jar
   commons-collections4-4.4.jar
-  commons-compress-1.26.0.jar
+  commons-compress-1.21.jar
+  commons-compress-1.22.jar
   commons-configuration2-2.8.0.jar
   commons-configuration2-2.9.0.jar
   commons-csv-1.9.0.jar
   commons-daemon-1.0.13.jar
-  commons-io-2.15.1.jar
+  commons-io-2.11.0.jar
   commons-io-2.9.0.jar
+  commons-lang3-3.12.0.jar
   commons-lang3-3.14.0.jar
   commons-logging-1.2.jar
   commons-math3-3.1.1.jar
diff --git a/NOTICE.txt b/NOTICE.txt
@@ -58,16 +58,19 @@ Apache-2.0
   cassandra-driver-core-3.10.0.jar
   commons-beanutils-1.9.4.jar
   commons-cli-1.2.jar
+  commons-codec-1.15.jar
   commons-codec-1.16.1.jar
   commons-collections-3.2.2.jar
   commons-collections4-4.4.jar
-  commons-compress-1.26.0.jar
+  commons-compress-1.21.jar
+  commons-compress-1.22.jar
   commons-configuration2-2.8.0.jar
   commons-configuration2-2.9.0.jar
   commons-csv-1.9.0.jar
   commons-daemon-1.0.13.jar
-  commons-io-2.15.1.jar
+  commons-io-2.11.0.jar
   commons-io-2.9.0.jar
+  commons-lang3-3.12.0.jar
   commons-lang3-3.14.0.jar
   commons-logging-1.2.jar
   commons-math3-3.1.1.jar
diff --git a/build.gradle b/build.gradle
@@ -135,7 +135,7 @@ apply from: "licenses-3rdparties.gradle"
 ext {
     publicDir =  "${project.rootDir}"
     // NB: due to version.json generation by parsing this file, the next line must not have any if/then/else logic
-    neo4jVersion = "4.4.32"
+    neo4jVersion = "4.4.31"
     // instead we apply the override logic here
     neo4jVersionEffective = project.hasProperty("neo4jVersionOverride") ? project.getProperty("neo4jVersionOverride") : neo4jVersion
     testContainersVersion = '1.17.6'
diff --git a/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.es.get.adoc b/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.es.get.adoc
@@ -1,5 +1,5 @@
 ¦xref::overview/apoc.es/apoc.es.get.adoc[apoc.es.get icon:book[]] +
 
-`apoc.es.get(host-or-port,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null) yield value` - perform a GET operation on elastic search
+`apoc.es.get(host-or-port,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null,$config) yield value` - perform a GET operation on elastic search
 ¦label:procedure[]
 ¦label:apoc-full[]
diff --git a/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.es.getRaw.adoc b/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.es.getRaw.adoc
@@ -1,5 +1,5 @@
 ¦xref::overview/apoc.es/apoc.es.getRaw.adoc[apoc.es.getRaw icon:book[]] +
 
-`apoc.es.getRaw(host-or-port,path,payload-or-null) yield value` - perform a raw GET operation on elastic search
+`apoc.es.getRaw(host-or-port,path,payload-or-null,$config) yield value` - perform a raw GET operation on elastic search
 ¦label:procedure[]
 ¦label:apoc-full[]
diff --git a/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.es.post.adoc b/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.es.post.adoc
@@ -1,5 +1,5 @@
 ¦xref::overview/apoc.es/apoc.es.post.adoc[apoc.es.post icon:book[]] +
 
-`apoc.es.post(host-or-port,index-or-null,type-or-null,query-or-null,payload-or-null) yield value` - perform a POST operation on elastic search
+`apoc.es.post(host-or-port,index-or-null,type-or-null,query-or-null,payload-or-null,$config) yield value` - perform a POST operation on elastic search
 ¦label:procedure[]
 ¦label:apoc-full[]
diff --git a/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.es.postRaw.adoc b/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.es.postRaw.adoc
@@ -1,5 +1,5 @@
 ¦xref::overview/apoc.es/apoc.es.postRaw.adoc[apoc.es.postRaw icon:book[]] +
 
-`apoc.es.postRaw(host-or-port,path,payload-or-null) yield value` - perform a raw POST operation on elastic search
+`apoc.es.postRaw(host-or-port,path,payload-or-null,$config) yield value` - perform a raw POST operation on elastic search
 ¦label:procedure[]
 ¦label:apoc-full[]
diff --git a/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.es.put.adoc b/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.es.put.adoc
@@ -1,5 +1,5 @@
 ¦xref::overview/apoc.es/apoc.es.put.adoc[apoc.es.put icon:book[]] +
 
-`apoc.es.put(host-or-port,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null) yield value` - perform a PUT operation on elastic search
+`apoc.es.put(host-or-port,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null,$config) yield value` - perform a PUT operation on elastic search
 ¦label:procedure[]
 ¦label:apoc-full[]
diff --git a/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.es.query.adoc b/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.es.query.adoc
@@ -1,5 +1,5 @@
 ¦xref::overview/apoc.es/apoc.es.query.adoc[apoc.es.query icon:book[]] +
 
-`apoc.es.query(host-or-port,index-or-null,type-or-null,query-or-null,payload-or-null) yield value` - perform a SEARCH operation on elastic search
+`apoc.es.query(host-or-port,index-or-null,type-or-null,query-or-null,payload-or-null,$config) yield value` - perform a SEARCH operation on elastic search
 ¦label:procedure[]
 ¦label:apoc-full[]
diff --git a/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.es.stats.adoc b/docs/asciidoc/modules/ROOT/examples/generated-documentation/apoc.es.stats.adoc
@@ -1,5 +1,5 @@
 ¦xref::overview/apoc.es/apoc.es.stats.adoc[apoc.es.stats icon:book[]] +
 
-`apoc.es.stats(host-url-Key)` - elastic search statistics
+`apoc.es.stats(host-url-Key,$config)` - elastic search statistics
 ¦label:procedure[]
 ¦label:apoc-full[]
diff --git a/docs/asciidoc/modules/ROOT/pages/database-integration/elasticsearch.adoc b/docs/asciidoc/modules/ROOT/pages/database-integration/elasticsearch.adoc
@@ -88,7 +88,7 @@ This example was tested on a Mac Book Pro with 16GB of RAM. Loading 20000 docume
 
 [source,cypher]
 ----
-call apoc.es.post(host-or-port,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null) yield value
+call apoc.es.post(host-or-port,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null,$config) yield value
 
 // GET/PUT/POST url/index/type/id?query -d payload
 ----
@@ -125,6 +125,34 @@ Query can be a map which is turned into a query string, a direct string or null
 
 Payload can be a *map* which will be turned into a json payload or a string which will be sent directly or null.
 
+=== config parameter
+
+Config can be an optional *map*, which can have the following entries:
+
+.Config parameters
+[opts=header, cols="1,1,1,4"]
+|===
+| name | type | default | description
+| headers | `Map` | {`content-type`: "application/json", `method`, "<httpMethod>"} | Contains a header map to add (or replace) the default one.
+    The `method: <httpMethod>` is needed by APOC to figure out under the hood, which http request method to pass. 
+    That is, by default, it is `PUT` with the `apoc.es.put`, POST with the `apoc.es.post` and `apoc.es.postRaw`, and GET in other cases.
+|===
+
+
+For example, by using the `apoc.es.stats`, we can execute:
+[source, cypher]
+----
+CALL apoc.es.stats('custom', { headers: {Authorization: "Basic <Base64Token>"} })
+----
+
+to use a https://www.elastic.co/guide/en/elasticsearch/reference/current/http-clients.html[Basic authentication] 
+and create the following HTTP header:
+```
+Authorization: Basic <Base64Token>
+method: GET
+Content-Type: application/json
+```
+
 
 === Results
 
diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.es/apoc.es.get.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.es/apoc.es.get.adoc
@@ -8,13 +8,13 @@ This file is generated by DocsTest, so don't change it!
 label:procedure[] label:apoc-full[]
 
 [.emphasis]
-apoc.es.get(host-or-port,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null) yield value - perform a GET operation on elastic search
+apoc.es.get(host-or-port,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null,$config) yield value - perform a GET operation on elastic search
 
 == Signature
 
 [source]
 ----
-apoc.es.get(host :: STRING?, index :: STRING?, type :: STRING?, id :: STRING?, query :: ANY?, payload :: ANY?) :: (value :: MAP?)
+apoc.es.get(host :: STRING?, index :: STRING?, type :: STRING?, id :: STRING?, query :: ANY?, payload :: ANY?, config = {} :: MAP?) :: (value :: MAP?)
 ----
 
 == Input parameters
@@ -27,6 +27,7 @@ apoc.es.get(host :: STRING?, index :: STRING?, type :: STRING?, id :: STRING?, q
 |id|STRING?|null
 |query|ANY?|null
 |payload|ANY?|null
+|config|MAP?|{}
 |===
 
 == Output parameters
diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.es/apoc.es.getRaw.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.es/apoc.es.getRaw.adoc
@@ -8,13 +8,13 @@ This file is generated by DocsTest, so don't change it!
 label:procedure[] label:apoc-full[]
 
 [.emphasis]
-apoc.es.getRaw(host-or-port,path,payload-or-null) yield value - perform a raw GET operation on elastic search
+apoc.es.getRaw(host-or-port,path,payload-or-null,$config) yield value - perform a raw GET operation on elastic search
 
 == Signature
 
 [source]
 ----
-apoc.es.getRaw(host :: STRING?, path :: STRING?, payload :: ANY?) :: (value :: MAP?)
+apoc.es.getRaw(host :: STRING?, path :: STRING?, payload :: ANY?, config = {} :: MAP?) :: (value :: MAP?)
 ----
 
 == Input parameters
@@ -24,6 +24,7 @@ apoc.es.getRaw(host :: STRING?, path :: STRING?, payload :: ANY?) :: (value :: M
 |host|STRING?|null
 |path|STRING?|null
 |payload|ANY?|null
+|config|MAP?|{}
 |===
 
 == Output parameters
diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.es/apoc.es.post.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.es/apoc.es.post.adoc
@@ -8,13 +8,13 @@ This file is generated by DocsTest, so don't change it!
 label:procedure[] label:apoc-full[]
 
 [.emphasis]
-apoc.es.post(host-or-port,index-or-null,type-or-null,query-or-null,payload-or-null) yield value - perform a POST operation on elastic search
+apoc.es.post(host-or-port,index-or-null,type-or-null,query-or-null,payload-or-null,$config) yield value - perform a POST operation on elastic search
 
 == Signature
 
 [source]
 ----
-apoc.es.post(host :: STRING?, index :: STRING?, type :: STRING?, query :: ANY?, payload = {} :: MAP?) :: (value :: MAP?)
+apoc.es.post(host :: STRING?, index :: STRING?, type :: STRING?, query :: ANY?, payload = {} :: MAP?, config = {} :: MAP?) :: (value :: MAP?)
 ----
 
 == Input parameters
@@ -26,6 +26,7 @@ apoc.es.post(host :: STRING?, index :: STRING?, type :: STRING?, query :: ANY?,
 |type|STRING?|null
 |query|ANY?|null
 |payload|MAP?|{}
+|config|MAP?|{}
 |===
 
 == Output parameters
diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.es/apoc.es.postRaw.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.es/apoc.es.postRaw.adoc
@@ -8,13 +8,13 @@ This file is generated by DocsTest, so don't change it!
 label:procedure[] label:apoc-full[]
 
 [.emphasis]
-apoc.es.postRaw(host-or-port,path,payload-or-null) yield value - perform a raw POST operation on elastic search
+apoc.es.postRaw(host-or-port,path,payload-or-null,$config) yield value - perform a raw POST operation on elastic search
 
 == Signature
 
 [source]
 ----
-apoc.es.postRaw(host :: STRING?, path :: STRING?, payload :: ANY?) :: (value :: MAP?)
+apoc.es.postRaw(host :: STRING?, path :: STRING?, payload :: ANY?, config = {} :: MAP?) :: (value :: MAP?)
 ----
 
 == Input parameters
@@ -24,6 +24,7 @@ apoc.es.postRaw(host :: STRING?, path :: STRING?, payload :: ANY?) :: (value ::
 |host|STRING?|null
 |path|STRING?|null
 |payload|ANY?|null
+|config|MAP?|{}
 |===
 
 == Output parameters
diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.es/apoc.es.put.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.es/apoc.es.put.adoc
@@ -8,13 +8,13 @@ This file is generated by DocsTest, so don't change it!
 label:procedure[] label:apoc-full[]
 
 [.emphasis]
-apoc.es.put(host-or-port,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null) yield value - perform a PUT operation on elastic search
+apoc.es.put(host-or-port,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null,$config) yield value - perform a PUT operation on elastic search
 
 == Signature
 
 [source]
 ----
-apoc.es.put(host :: STRING?, index :: STRING?, type :: STRING?, id :: STRING?, query :: ANY?, payload = {} :: MAP?) :: (value :: MAP?)
+apoc.es.put(host :: STRING?, index :: STRING?, type :: STRING?, id :: STRING?, query :: ANY?, config = {} :: MAP?) :: (value :: MAP?)
 ----
 
 == Input parameters
@@ -27,6 +27,7 @@ apoc.es.put(host :: STRING?, index :: STRING?, type :: STRING?, id :: STRING?, q
 |id|STRING?|null
 |query|ANY?|null
 |payload|MAP?|{}
+|config|MAP?|{}
 |===
 
 == Output parameters
diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.es/apoc.es.query.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.es/apoc.es.query.adoc
@@ -8,13 +8,13 @@ This file is generated by DocsTest, so don't change it!
 label:procedure[] label:apoc-full[]
 
 [.emphasis]
-apoc.es.query(host-or-port,index-or-null,type-or-null,query-or-null,payload-or-null) yield value - perform a SEARCH operation on elastic search
+apoc.es.query(host-or-port,index-or-null,type-or-null,query-or-null,payload-or-null,$config) yield value - perform a SEARCH operation on elastic search
 
 == Signature
 
 [source]
 ----
-apoc.es.query(host :: STRING?, index :: STRING?, type :: STRING?, query :: ANY?, payload :: ANY?) :: (value :: MAP?)
+apoc.es.query(host :: STRING?, index :: STRING?, type :: STRING?, query :: ANY?, payload :: ANY?, config = {} :: MAP?) :: (value :: MAP?)
 ----
 
 == Input parameters
@@ -26,6 +26,7 @@ apoc.es.query(host :: STRING?, index :: STRING?, type :: STRING?, query :: ANY?,
 |type|STRING?|null
 |query|ANY?|null
 |payload|ANY?|null
+|config|MAP?|{}
 |===
 
 == Output parameters
diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.es/apoc.es.stats.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.es/apoc.es.stats.adoc
@@ -8,20 +8,21 @@ This file is generated by DocsTest, so don't change it!
 label:procedure[] label:apoc-full[]
 
 [.emphasis]
-apoc.es.stats(host-url-Key) - elastic search statistics
+apoc.es.stats(host-url-Key,$config) - elastic search statistics
 
 == Signature
 
 [source]
 ----
-apoc.es.stats(host :: STRING?) :: (value :: MAP?)
+apoc.es.stats(host :: STRING?, payload = {} :: MAP?, config = {} :: MAP?) :: (value :: MAP?)
 ----
 
 == Input parameters
 [.procedures, opts=header]
 |===
 | Name | Type | Default 
 |host|STRING?|null
+|config|MAP?|{}
 |===
 
 == Output parameters
diff --git a/docs/asciidoc/modules/ROOT/pages/overview/apoc.es/index.adoc b/docs/asciidoc/modules/ROOT/pages/overview/apoc.es/index.adoc
@@ -10,37 +10,37 @@ This file is generated by DocsTest, so don't change it!
 | Qualified Name | Type | Release
 |xref::overview/apoc.es/apoc.es.get.adoc[apoc.es.get icon:book[]]
 
-apoc.es.get(host-or-port,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null) yield value - perform a GET operation on elastic search
+apoc.es.get(host-or-port,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null,$config) yield value - perform a GET operation on elastic search
 |label:procedure[]
 |label:apoc-full[]
 |xref::overview/apoc.es/apoc.es.getRaw.adoc[apoc.es.getRaw icon:book[]]
 
-apoc.es.getRaw(host-or-port,path,payload-or-null) yield value - perform a raw GET operation on elastic search
+apoc.es.getRaw(host-or-port,path,payload-or-null,$config) yield value - perform a raw GET operation on elastic search
 |label:procedure[]
 |label:apoc-full[]
 |xref::overview/apoc.es/apoc.es.post.adoc[apoc.es.post icon:book[]]
 
-apoc.es.post(host-or-port,index-or-null,type-or-null,query-or-null,payload-or-null) yield value - perform a POST operation on elastic search
+apoc.es.post(host-or-port,index-or-null,type-or-null,query-or-null,payload-or-null,$config) yield value - perform a POST operation on elastic search
 |label:procedure[]
 |label:apoc-full[]
 |xref::overview/apoc.es/apoc.es.postRaw.adoc[apoc.es.postRaw icon:book[]]
 
-apoc.es.postRaw(host-or-port,path,payload-or-null) yield value - perform a raw POST operation on elastic search
+apoc.es.postRaw(host-or-port,path,payload-or-null,$config) yield value - perform a raw POST operation on elastic search
 |label:procedure[]
 |label:apoc-full[]
 |xref::overview/apoc.es/apoc.es.put.adoc[apoc.es.put icon:book[]]
 
-apoc.es.put(host-or-port,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null) yield value - perform a PUT operation on elastic search
+apoc.es.put(host-or-port,index-or-null,type-or-null,id-or-null,query-or-null,payload-or-null,$config) yield value - perform a PUT operation on elastic search
 |label:procedure[]
 |label:apoc-full[]
 |xref::overview/apoc.es/apoc.es.query.adoc[apoc.es.query icon:book[]]
 
-apoc.es.query(host-or-port,index-or-null,type-or-null,query-or-null,payload-or-null) yield value - perform a SEARCH operation on elastic search
+apoc.es.query(host-or-port,index-or-null,type-or-null,query-or-null,payload-or-null,$config) yield value - perform a SEARCH operation on elastic search
 |label:procedure[]
 |label:apoc-full[]
 |xref::overview/apoc.es/apoc.es.stats.adoc[apoc.es.stats icon:book[]]
 
-apoc.es.stats(host-url-Key) - elastic search statistics
+apoc.es.stats(host-url-Key,$config) - elastic search statistics
 |label:procedure[]
 |label:apoc-full[]
 |===
diff --git a/docs/asciidoc/modules/ROOT/partials/generated-documentation/documentation.adoc b/docs/asciidoc/modules/ROOT/partials/generated-documentation/documentation.adoc
diff --git a/docs/index.html b/docs/index.html
diff --git a/full/src/main/java/apoc/es/ElasticSearch.java b/full/src/main/java/apoc/es/ElasticSearch.java
diff --git a/full/src/main/java/apoc/es/ElasticSearchConfig.java b/full/src/main/java/apoc/es/ElasticSearchConfig.java
diff --git a/full/src/test/java/apoc/es/ElasticSearchTest.java b/full/src/test/java/apoc/es/ElasticSearchTest.java
