feat: add support for the format parameter #1299

ranim-n · 2024-12-24T16:06:15Z

No description provided.

github-actions · 2024-12-24T16:12:28Z

Test Results

69 files ±0 69 suites ±0 1m 23s ⏱️ -1s
1 111 tests +1 1 111 ✅ +1 0 💤 ±0 0 ❌ ±0
1 150 runs +1 1 150 ✅ +1 0 💤 ±0 0 ❌ ±0

Results for commit 873b29e. ± Comparison against base commit a76f793.

This pull request removes 189 and adds 34 tests. Note that renamed tests count towards both.

                                    { "id":…, withTemporalValues=true, withAudit=false, expectation={
                      "@id": "https://uri…
                      "@type": "@json",
                      …
                    "@value": "/A/B"
                    "@value": "/C/D"
                    "@value": 20
                    "…
                    {
                  "@type": "https://uri.etsi.org/ngsi-ld/DateTime",
…

com.egm.stellio.search.entity.util.PatchAttributeTests ‑ [1] source={
    "attribute": {
        "type": "Property",
        "value": 12.0,
        "observedAt": "2024-04-14T12:34:56Z"
    }
}, target={
    "attribute": {
        "type": "Property",
        "value": 12.2,
        "unitCode": "GRM"
    }
}, expected={
    "attribute": {
        "type": "Property",
        "value": 12.2,
        "unitCode": "GRM",
        "observedAt": "2024-04-14T12:34:56Z"
    }
}
com.egm.stellio.search.entity.util.PatchAttributeTests ‑ [1] source={
    "attribute": {
        "type": "Property",
        "value": 12.0,
        "observedAt": "2024-04-14T12:34:56Z",
        "subAttribute": {
            "type": "Property",
            "value": "subAttribute"
        }
    }
}, target={
    "attribute": {
        "type": "Property",
        "value": 12.2,
        "unitCode": "GRM",
        "subAttribute": {
            "type": "Property",
            "value": "newSubAttributeValue"
        }
    }
}, expected={
    "attribute": {
        "type": "Property",
        "value": 12.2,
        "unitCode": "GRM",
        "observedAt": "2024-04-14T12:34:56Z",
        "subAttribute": {
            "type": "Property",
            "value": "newSubAttributeValue"
        }
    }
}
com.egm.stellio.search.entity.util.PatchAttributeTests ‑ [2] source={
    "attribute": {
        "type": "Property",
        "value": { "en": "car", "fr": "voiture" }
    }
}, target={
    "attribute": {
        "type": "Property",
        "value": { "fr": "vélo", "es": "bicicleta" }
    }
}, expected={
    "attribute": {
        "type": "Property",
        "value": { "en": "car", "fr": "vélo", "es": "bicicleta" }
    }
}
com.egm.stellio.search.entity.util.PatchAttributeTests ‑ [2] source={
    "incoming": {
        "type": "JsonProperty",
        "json": { "id": 1, "b": null, "c": 12.4 },
        "observedAt": "2022-12-24T14:01:22.066Z",
        "subAttribute": {
            "type": "Property",
            "value": "subAttribute"
        }
    }
}, target={
    "incoming": {
        "type": "JsonProperty",
        "json": { "id": 2, "b": "something" },
        "observedAt": "2023-12-24T14:01:22.066Z"
    }
}, expected={
    "incoming": {
        "type": "JsonProperty",
        "json": { "id": 2, "b": "something" },
        "observedAt": "2023-12-24T14:01:22.066Z",
        "subAttribute": {
            "type": "Property",
            "value": "subAttribute"
        }
    }
}
com.egm.stellio.search.entity.util.PatchAttributeTests ‑ [3] source={
    "attribute": {
        "type": "Property",
        "value": [ "car", "voiture" ]
    }
}, target={
    "attribute": {
        "type": "Property",
        "value": [ "vélo", "bicicleta" ]
    }
}, expected={
    "attribute": {
        "type": "Property",
        "value": [ "vélo", "bicicleta" ]
    }
}
com.egm.stellio.search.entity.util.PatchAttributeTests ‑ [3] source={
    "attribute": {
        "type": "VocabProperty",
        "vocab": "stellio"
    }
}, target={
    "attribute": {
        "type": "VocabProperty",
        "vocab": "egm"
    }
}, expected={
    "attribute": {
        "type": "VocabProperty",
        "vocab": "egm"
    }
}
com.egm.stellio.search.entity.util.PatchAttributeTests ‑ [4] source={
    "attribute": {
        "type": "Relationship",
        "object": "urn:ngsi-ld:Entity:01"
    }
}, target={
    "attribute": {
        "type": "Relationship",
        "object": "urn:ngsi-ld:Entity:02"
    }
}, expected={
    "attribute": {
        "type": "Relationship",
        "object": "urn:ngsi-ld:Entity:02"
    }
}
com.egm.stellio.search.entity.util.PatchAttributeTests ‑ [5] source={
    "attribute": {
        "type": "LanguageProperty",
        "languageMap": { "en": "train", "fr": "train" }
    }
}, target={
    "attribute": {
        "type": "LanguageProperty",
        "languageMap": { "fr": "TGV", "es": "tren" }
    }
}, expected={
    "attribute": {
        "type": "LanguageProperty",
        "languageMap": { "en": "train", "fr": "TGV", "es": "tren" }
    }
}
com.egm.stellio.search.entity.util.PatchAttributeTests ‑ [6] source={
    "incoming": {
        "type": "JsonProperty",
        "json": { "a": 1, "b": "thing" }
    }
}, target={
    "incoming": {
        "type": "JsonProperty",
        "json": { "a": 2, "c": "other thing" }
    }
}, expected={
    "incoming": {
        "type": "JsonProperty",
        "json": { "a": 2, "b": "thing", "c": "other thing" }
    }
}
com.egm.stellio.search.entity.util.PatchAttributeTests ‑ [7] source={
    "attribute": {
        "type": "VocabProperty",
        "vocab": "stellio"
    }
}, target={
    "attribute": {
        "type": "VocabProperty",
        "vocab": "egm"
    }
}, expected={
    "attribute": {
        "type": "VocabProperty",
        "vocab": "egm"
    }
}
…

sonarqubecloud · 2024-12-24T16:13:32Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
57.4% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

bobeal · 2024-12-25T11:32:25Z

shared/src/main/kotlin/com/egm/stellio/shared/model/NgsiLdDataRepresentation.kt

@@ -28,9 +29,14 @@ data class NgsiLdDataRepresentation(
            acceptMediaType: MediaType
        ): NgsiLdDataRepresentation {
            val optionsParam = queryParams.getOrDefault(QueryParameter.OPTIONS.key, emptyList())
+            val formatParam = queryParams.getOrDefault(QueryParameter.FORMAT.key, emptyList())
+            val attributeRepresentation = when {


since you are in it and since it is very related, also add support for the simplified value for the format query param (synonym of keyValues)

bobeal · 2024-12-25T11:34:34Z

shared/src/main/kotlin/com/egm/stellio/shared/queryparameter/FormatValue.kt

+package com.egm.stellio.shared.queryparameter
+
+enum class FormatValue(val value: String) {
+    KEY_VALUES("keyValues"),


don't forget to remove it in the OptionsValues enum

bobeal · 2024-12-25T11:36:01Z

shared/src/main/kotlin/com/egm/stellio/shared/queryparameter/FormatValue.kt

+    KEY_VALUES("keyValues"),
+    NORMALIZED("normalized"),
+    TEMPORAL_VALUES("temporalValues"),
+    AGGREGATED_VALUES("aggregatedValues")


TEMPORAL_VALUES and AGGREGATED_VALUES are unused, this is problematic

bobeal · 2024-12-25T11:40:29Z

shared/src/main/kotlin/com/egm/stellio/shared/util/ApiUtils.kt

    TEMPORAL_VALUES("temporalValues"),
    AUDIT("audit"),
    AGGREGATED_VALUES("aggregatedValues")
 }

-fun hasValueInOptionsParam(options: Optional<String>, optionValue: OptionsParamValue): Boolean =
+fun hasValueInQueryParam(options: Optional<String>, queryParamValue: QueryParamValue): Boolean =


options is no longer a good name for the 1st parameter

bobeal · 2024-12-25T11:41:53Z

shared/src/main/kotlin/com/egm/stellio/shared/util/ApiUtils.kt

@@ -168,16 +168,16 @@ internal fun canExpandJsonLdKeyFromCore(contexts: List<String>): Boolean {
    return expandedType == NGSILD_DATASET_ID_PROPERTY
 }

-enum class OptionsParamValue(val value: String) {
+enum class QueryParamValue(val value: String) {


TEMPORAL_VALUES and AGGREGATED_VALUES should be moved / merged in FormatValue. AUDIT should be moved / merged in OptionsValue

bobeal · 2024-12-25T11:45:54Z

shared/src/test/kotlin/com/egm/stellio/shared/util/ApiUtilsTests.kt

@@ -33,27 +33,27 @@ class ApiUtilsTests {

    @Test
    fun `it should not find a value if there is no options query param`() {


also update the names of the test functions (options is no longer valid)

bobeal · 2024-12-25T11:49:33Z

search-service/src/test/kotlin/com/egm/stellio/search/entity/web/EntityHandlerTests.kt

@@ -480,6 +480,47 @@ class EntityHandlerTests {
            )
    }

+    @Test
+    fun `get entity by id should correctly return the representation asked in the format parameter`() {


better add one or more tests on the parseRepresentations function in NgsiLdDataRepresentation

bobeal · 2024-12-25T11:54:02Z

search-service/src/main/kotlin/com/egm/stellio/search/temporal/util/TemporalQueryUtils.kt

@@ -45,18 +45,22 @@ fun composeTemporalEntitiesQueryFromGet(

    if (inQueryEntities)
        entitiesQueryFromGet.validateMinimalQueryEntitiesParameters().bind()
+    val optionsParam = Optional.ofNullable(requestParams.getFirst(QueryParameter.OPTIONS.key))
+    val formatParam = Optional.ofNullable(requestParams.getFirst(QueryParameter.FORMAT.key))
+    val withTemporalValues = when {


you could take this opportunity to return an APIException if both temporalValues and aggregatedValues are provided

feat: add support for the format parameter

873b29e

ranim-n added feature New feature or request common Relates to common behaviors ngsild-1.8.1 labels Dec 24, 2024

ranim-n requested review from bobeal and thomasBousselin December 24, 2024 16:06

ranim-n self-assigned this Dec 24, 2024

ranim-n linked an issue Dec 24, 2024 that may be closed by this pull request

Add support for the format parameter #1206

Open

bobeal reviewed Dec 25, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add support for the format parameter #1299

feat: add support for the format parameter #1299

ranim-n commented Dec 24, 2024

github-actions bot commented Dec 24, 2024

sonarqubecloud bot commented Dec 24, 2024

bobeal Dec 25, 2024

bobeal Dec 25, 2024

bobeal Dec 25, 2024

bobeal Dec 25, 2024

bobeal Dec 25, 2024

bobeal Dec 25, 2024

bobeal Dec 25, 2024

bobeal Dec 25, 2024

		@@ -33,27 +33,27 @@ class ApiUtilsTests {

		@Test
		fun `it should not find a value if there is no options query param`() {

feat: add support for the format parameter #1299

Are you sure you want to change the base?

feat: add support for the format parameter #1299

Conversation

ranim-n commented Dec 24, 2024

github-actions bot commented Dec 24, 2024

Test Results

sonarqubecloud bot commented Dec 24, 2024

Quality Gate passed

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment