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

70 files +1 70 suites +1 1m 21s ⏱️ -1s
1 116 tests +6 1 116 ✅ +6 0 💤 ±0 0 ❌ ±0
1 155 runs +6 1 155 ✅ +6 0 💤 ±0 0 ❌ ±0

Results for commit e89b116. ± Comparison against base commit a76f793.

This pull request removes 194 and adds 44 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"
    }
}
…

♻️ This comment has been updated with latest results.

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

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

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

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

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

…/util/TemporalQueryUtils.kt Co-authored-by: Thomas Bousselin <[email protected]>

bobeal · 2025-01-04T08:38:47Z

A note about the behavior of the MultiValueMap holding the query parameters:

if you pass such a query string to the endpoint: ?type=Beehive&options=sysAttrs,audit&options=keyValues
the map of the query parameters received in the handler will be this one:

In other words:

it takes care of "accumulating" the values of query parameters with the same name
it does not do the split of a query parameter which has a comma separated list of values

So this has to be handled in the code.

...ch-service/src/test/kotlin/com/egm/stellio/search/temporal/web/TemporalEntityHandlerTests.kt

bobeal · 2025-01-04T08:50:49Z

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

@@ -42,21 +43,29 @@ fun composeTemporalEntitiesQueryFromGet(
        requestParams,
        contexts
    ).bind()
-
-    if (inQueryEntities)
+    var withTemporalValues = false


instead of using these 2 booleans, it will be cleaner to switch to an enum similar to the AttributeRepresentation one

…/web/TemporalEntityHandlerTests.kt Co-authored-by: Benoit Orihuela <[email protected]>

sonarqubecloud · 2025-01-06T08:27:48Z

Quality Gate passed

Issues
3 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

thomasBousselin · 2025-01-06T13:58:41Z

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

+fun extractTemporalRepresentation(requestParams: MultiValueMap<String, String>):
+    Either<APIException, TemporalRepresentation> = either {
+    val optionsParam = Optional.ofNullable(requestParams.getFirst(QueryParameter.OPTIONS.key))
+    val formatParam = requestParams.getFirst(QueryParameter.FORMAT.key)
+    return when (formatParam) {
+        FormatValue.TEMPORAL_VALUES.value -> TemporalRepresentation.TEMPORAL_VALUES.right()
+        FormatValue.AGGREGATED_VALUES.value -> TemporalRepresentation.AGGREGATED_VALUES.right()
+        else -> {
+            val hasTemporal = hasValueInQueryParam(optionsParam, QueryParamValue.TEMPORAL_VALUES)
+            val hasAggregated = hasValueInQueryParam(optionsParam, QueryParamValue.AGGREGATED_VALUES)
+            when {
+                hasTemporal && hasAggregated ->
+                    return BadRequestDataException("Only one temporal representation can be present").left()
+                hasTemporal -> TemporalRepresentation.TEMPORAL_VALUES.right()
+                hasAggregated -> TemporalRepresentation.AGGREGATED_VALUES.right()
+                else -> TemporalRepresentation.NONE.right()
+            }
+        }
+    }
+}


Can be simplified. By adding a fromString function to the TemporalRepresentation enum.

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

thomasBousselin reviewed Jan 2, 2025

View reviewed changes

search-service/src/main/kotlin/com/egm/stellio/search/temporal/util/TemporalQueryUtils.kt Outdated Show resolved Hide resolved

search-service/src/main/kotlin/com/egm/stellio/search/temporal/util/TemporalQueryUtils.kt Outdated Show resolved Hide resolved

ranim-n and others added 4 commits January 3, 2025 09:14

Update search-service/src/main/kotlin/com/egm/stellio/search/temporal…

7863668

…/util/TemporalQueryUtils.kt Co-authored-by: Thomas Bousselin <[email protected]>

Update search-service/src/main/kotlin/com/egm/stellio/search/temporal…

98144cc

…/util/TemporalQueryUtils.kt Co-authored-by: Thomas Bousselin <[email protected]>

fix: commit suggestion

98e6891

fix: PR comments + other changes

06b7ec4

bobeal reviewed Jan 4, 2025

View reviewed changes

Update search-service/src/test/kotlin/com/egm/stellio/search/temporal…

e89b116

…/web/TemporalEntityHandlerTests.kt Co-authored-by: Benoit Orihuela <[email protected]>

fix: change temporal representations to an enum

7e46c4e

thomasBousselin reviewed Jan 6, 2025

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 •

edited

Loading

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 commented Jan 4, 2025

bobeal Jan 4, 2025

sonarqubecloud bot commented Jan 6, 2025

thomasBousselin Jan 6, 2025

		@@ -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 • edited Loading

Test Results

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

bobeal commented Jan 4, 2025

Choose a reason for hiding this comment

sonarqubecloud bot commented Jan 6, 2025

Quality Gate passed

Choose a reason for hiding this comment

github-actions bot commented Dec 24, 2024 •

edited

Loading