Merge pull request #449 from FgForrest/dev

Documentation fixes release

Author: lukashornych

documentation/blog/en/examples/string_contains/bom.gradle

@@ -1 +1 @@
-implementation 'io.evitadb:evita_external_api_graphql:0.9.ALPHA'
+implementation 'io.evitadb:evita_external_api_graphql:2024.1.3'

documentation/blog/en/examples/string_contains/bom.maven

@@ -1,6 +1,6 @@
 <dependency>
     <groupId>io.evitadb</groupId>
     <artifactId>evita_external_api_graphql</artifactId>
-    <version>0.9.ALPHA</version>
+    <version>2024.1.3</version>
     <type>pom</type>
 </dependency>

documentation/blog/en/examples/string_contains/model.xml

@@ -24,6 +24,6 @@
 <dependency>
 	<groupId>io.evitadb</groupId>
 	<artifactId>evita_external_api_graphql</artifactId>
-	<version>0.9.ALPHA</version>
+	<version>2024.1.3</version>
 	<type>pom</type>
 </dependency>

documentation/publishing/root.cz/03-query-basics/motive.png

@@ -70,7 +70,7 @@ To integrate evitaDB into your project, use the following steps:
 </CodeTabsBlock>
 <CodeTabsBlock>
 ```Gradle
-implementation 'io.evitadb:evita_db:0.9.ALPHA'
+implementation 'io.evitadb:evita_db:2024.1.3'
 ```
 </CodeTabsBlock>
 </CodeTabs>
@@ -115,7 +115,7 @@ exception when you enable the corresponding API in evitaDB's configuration.
 </CodeTabsBlock>
 <CodeTabsBlock>
 ```Gradle
-implementation 'io.evitadb:evita_external_api_grpc:0.9.ALPHA'
+implementation 'io.evitadb:evita_external_api_grpc:2024.1.3'
 ```
 </CodeTabsBlock>
 </CodeTabs>
@@ -135,7 +135,7 @@ implementation 'io.evitadb:evita_external_api_grpc:0.9.ALPHA'
 </CodeTabsBlock>
 <CodeTabsBlock>
 ```Gradle
-implementation 'io.evitadb:evita_external_api_graphql:0.9.ALPHA'
+implementation 'io.evitadb:evita_external_api_graphql:2024.1.3'
 ```
 </CodeTabsBlock>
 </CodeTabs>
@@ -155,7 +155,7 @@ implementation 'io.evitadb:evita_external_api_graphql:0.9.ALPHA'
 </CodeTabsBlock>
 <CodeTabsBlock>
 ```Gradle
-implementation 'io.evitadb:evita_external_api_rest:0.9.ALPHA'
+implementation 'io.evitadb:evita_external_api_rest:2024.1.3'
 ```
 </CodeTabsBlock>
 </CodeTabs>

documentation/user/en/get-started/run-evitadb.md

@@ -90,7 +90,7 @@ This is an example of how the query is composed and how evitaDB is called. The e
 <SourceClass>evita_query/src/main/java/io/evitadb/api/query/Query.java</SourceClass> and
 <SourceClass>evita_query/src/main/java/io/evitadb/api/query/QueryConstraints.java</SourceClass>.
 
-<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java" local>
+<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java">
 
 [Java query example](/documentation/user/en/use/api/example/java-query-example.java)
 </SourceCodeTabs>
@@ -99,7 +99,7 @@ This is an example of how the query is composed and how evitaDB is called. The e
 
 The query may also contain "dirty" parts - that is, null constraints and unnecessary parts:
 
-<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java" local>
+<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java">
 
 [Java dirty query example](/documentation/user/en/use/api/example/java-dirty-query-example.java)
 </SourceCodeTabs>
@@ -145,7 +145,7 @@ represented by the
 <SourceClass>evita_api/src/main/java/io/evitadb/api/requestResponse/data/EntityReferenceContract.java</SourceClass>
 interface.
 
-<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java" local>
+<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java">
 
 [Default query example](/documentation/user/en/use/api/example/default-query-example.java)
 </SourceCodeTabs>
@@ -179,7 +179,7 @@ Although there are simpler variants for querying entities, the typical method is
 
 The next example documents fetching the second page of products in a category with calculated facet statistics:
 
-<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java" local>
+<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java">
 
 [Fetching example](/documentation/user/en/use/api/example/query-example.java)
 </SourceCodeTabs>
@@ -200,7 +200,7 @@ To enrich, a.k.a. lazy fetch missing data to an existing entity, you must pass t
 method and specify a set of additional require constraints that should be satisfied. Due to immutability properties
 enforced by database design, enriching an entity object returns a new instance of the entity.
 
-<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java" local>
+<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java">
 
 [Lazy loading example](/documentation/user/en/use/api/example/lazy-fetch-example.java)
 </SourceCodeTabs>
@@ -505,7 +505,7 @@ This is an example of how the query is composed and how evitaDB is called.
 The example imports previously mentioned interface
 <SourceClass>EvitaDB.Client/Queries/IQueryConstraints.cs</SourceClass> statically.
 
-<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java" local>
+<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java">
 
 [C# query example](/documentation/user/en/use/api/example/csharp-query-example.cs)
 </SourceCodeTabs>
@@ -514,7 +514,7 @@ The example imports previously mentioned interface
 
 The query may also contain "dirty" parts - that is, null constraints and unnecessary parts:
 
-<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java" local>
+<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java">
 
 [C# dirty query example](/documentation/user/en/use/api/example/csharp-dirty-query-example.cs)
 </SourceCodeTabs>
@@ -537,7 +537,7 @@ represented by the
 <SourceClass>EvitaDB.Client/Models/Data/IEntityReference.cs</SourceClass>
 interface.
 
-<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java" local>
+<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java">
 
 [Default query example](/documentation/user/en/use/api/example/default-query-example.cs)
 </SourceCodeTabs>
@@ -571,7 +571,7 @@ Although there are simpler variants for querying entities, the typical method is
 
 The next example documents fetching the second page of products in a category with calculated facet statistics:
 
-<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java" local>
+<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java">
 
 [Fetching example](/documentation/user/en/use/api/example/query-example.cs)
 </SourceCodeTabs>
@@ -592,7 +592,7 @@ To enrich, a.k.a. lazy fetch missing data to an existing entity, you must pass t
 method and specify a set of additional require constraints that should be satisfied. Due to immutability properties
 enforced by database design, enriching an entity object returns a new instance of the entity.
 
-<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java" local>
+<SourceCodeTabs requires="evita_functional_tests/src/test/resources/META-INF/documentation/evitaql-init.java">
 
 [Lazy loading example](/documentation/user/en/use/api/example/lazy-fetch-example.cs)
 </SourceCodeTabs>

documentation/user/en/use/api/query-data.md

@@ -51,7 +51,7 @@ artifact into your project:
 </CodeTabsBlock>
 <CodeTabsBlock>
 ```Gradle
-implementation 'io.evitadb:evita_test_support:0.9.ALPHA'
+implementation 'io.evitadb:evita_test_support:2024.1.3'
 ```
 </CodeTabsBlock>
 </CodeTabs>

documentation/user/en/use/api/write-tests.md

@@ -23,6 +23,7 @@
 
 package io.evitadb.externalApi.rest.api.builder;
 
+import com.fasterxml.jackson.databind.MapperFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
 import com.fasterxml.jackson.databind.module.SimpleModule;
@@ -109,6 +110,7 @@ protected ObjectMapper setupObjectMapper() {
 		module.addSerializer(new BigDecimalSerializer());
 		objectMapper.registerModule(module);
 		objectMapper.enable(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS);
+		objectMapper.setConfig(objectMapper.getSerializationConfig().with(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY));
 
 		return objectMapper;
 	}

evita_external_api/evita_external_api_rest/src/main/java/io/evitadb/externalApi/rest/api/builder/RestBuildingContext.java

@@ -6,7 +6,7 @@
  *             |  __/\ V /| | || (_| | |_| | |_) |
  *              \___| \_/ |_|\__\__,_|____/|____/
  *
- *   Copyright (c) 2023
+ *   Copyright (c) 2023-2024
  *
  *   Licensed under the Business Source License, Version 1.1 (the "License");
  *   you may not use this file except in compliance with the License.
@@ -88,9 +88,9 @@ public static Builder newCatalogEndpoint(@Nonnull CatalogSchemaContract catalogS
 	@Nonnull
 	@Override
 	public RestEndpointHandler<CatalogRestHandlingContext> toHandler(@Nonnull ObjectMapper objectMapper,
-	                                                                    @Nonnull Evita evita,
-	                                                                    @Nonnull OpenAPI openApi,
-	                                                                    @Nonnull Map<String, Class<? extends Enum<?>>> enumMapping) {
+	                                                                 @Nonnull Evita evita,
+	                                                                 @Nonnull OpenAPI openApi,
+	                                                                 @Nonnull Map<String, Class<? extends Enum<?>>> enumMapping) {
 		final CatalogRestHandlingContext context = new CatalogRestHandlingContext(
 			objectMapper,
 			evita,

evita_external_api/evita_external_api_rest/src/main/java/io/evitadb/externalApi/rest/api/openApi/OpenApiCatalogEndpoint.java

@@ -27,6 +27,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import io.evitadb.documentation.Environment;
 import io.evitadb.exception.EvitaInternalError;
+import lombok.extern.slf4j.Slf4j;
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
@@ -58,11 +59,8 @@
  * temporary folder and provides a method for executing C# code and fetching its results. The results are returned as a
  * string messages from which the actual results are parsed.
  */
+@Slf4j
 public class CShell {
-    /**
-     * URL of the latest version of C# query validator executable.
-     */
-    private static final String VALIDATOR_ZIP_URL = new GithubLatestAssetUrlFetcher().fetchAssetUrl("Validator"+(isWindows() ? "-win" : "")+".zip");
     /**
      * Path to the C# query validator folder locates in a system temp folder.
      */
@@ -152,14 +150,16 @@ private static void downloadValidator() {
         }
         final Path zipPath = Paths.get(VALIDATOR_TEMP_FOLDER_PATH.toString(), "Validator.zip");
 
-        try (InputStream in = new URL(VALIDATOR_ZIP_URL).openStream()) {
+        final String zipUrl = new GithubLatestAssetUrlFetcher().fetchAssetUrl("Validator" + (isWindows() ? "-win" : "") + ".zip");
+        log.info("Downloading C# query validator from {} to {}", zipUrl, zipPath);
+        try (InputStream in = new URL(zipUrl).openStream()) {
             Files.copy(in, Paths.get(zipPath.toUri()), StandardCopyOption.REPLACE_EXISTING);
             unzip(zipPath.toString(), VALIDATOR_TEMP_FOLDER_PATH.toString());
             if (!isWindows()) {
                 setExecutablePermission();
             }
         } catch (IOException ex) {
-            throw new EvitaInternalError("Failed to download C# query validator.");
+            throw new EvitaInternalError("Failed to download C# query validator.", ex);
         }
     }
 
@@ -204,7 +204,7 @@ private static void unzip(@Nonnull String zipPath, @Nonnull String destDir) thro
             zis.close();
             fis.close();
         } catch (IOException e) {
-            throw new EvitaInternalError("Failed to unzip C# query validator executable.");
+            throw new EvitaInternalError("Failed to unzip C# query validator executable.", e);
         }
     }