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

71 files + 1 71 suites +1 1m 25s ⏱️ -2s
1 152 tests +14 1 152 ✅ +14 0 💤 ±0 0 ❌ ±0
1 191 runs +14 1 191 ✅ +14 0 💤 ±0 0 ❌ ±0

Results for commit 1de5901. ± Comparison against base commit b9bca70.

This pull request removes 190 and adds 50 tests. Note that renamed tests count towards both.

                           …, 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

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

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

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

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

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

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

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

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

search-service/src/test/kotlin/com/egm/stellio/search/support/BusinessObjectsFactory.kt

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

bobeal · 2025-01-06T16:38:34Z

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

@@ -206,3 +190,30 @@ fun buildTimerelAndTime(
    } else {
        "'timerel' and 'time' must be used in conjunction".left()
    }
+
+fun extractTemporalRepresentation(requestParams: MultiValueMap<String, String>):


I guess it can be a private function?

we now call it queryParams, and no longer requestParams

still the 1st point

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

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

…isted (#1307)

bobeal · 2025-01-08T18:09:19Z

don't know why you merged develop in your branch (we never do that, we rebase on develop), but it is a bit a mess. there is at least one commit from develop which is included in the branch...

bobeal · 2025-01-08T18:21:31Z

...ice/src/test/kotlin/com/egm/stellio/search/temporal/service/AttributeInstanceServiceTests.kt

@@ -199,7 +200,8 @@ class AttributeInstanceServiceTests : WithTimescaleContainer, WithKafkaContainer
            buildDefaultTestTemporalQuery(
                timerel = Timerel.AFTER,
                timeAt = now.minusHours(1)
-            )
+            ),
+            TemporalRepresentation.NORMALIZED


this parameter is useless if equals to NORMALIZED (it is the default in gimmeTemporalEntitiesQuery). here and in every other calls below.

This was fixed but the merge must've removed it (same thing for the private function)

bobeal · 2025-01-08T18:30:45Z

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

+    companion object {
+        fun fromString(key: String): Either<APIException, OptionsValue> = either {
+            OptionsValue.entries.find { it.value == key }
+                ?: return InvalidRequestException("'$key' is not a valid options value").left()


Suggested change

?: return InvalidRequestException("'$key' is not a valid options value").left()

?: return InvalidRequestException("'$key' is not a valid value for the options query parameter").left()

shared/src/test/kotlin/com/egm/stellio/shared/model/NgsiLdDataRepresentationTests.kt

bobeal · 2025-01-08T18:44:46Z

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

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


fun hasValueInOptionsParam( optionsParam: Optional<String>, optionsValue: OptionsValue ): Either<APIException, Boolean> = either { optionsParam .map { it.split(",") } .orElse(emptyList()) .map { OptionsValue.fromString(it).bind() } .any { it == optionsValue } }

bobeal · 2025-01-08T18:47:54Z

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

@@ -206,3 +190,30 @@ fun buildTimerelAndTime(
    } else {
        "'timerel' and 'time' must be used in conjunction".left()
    }
+
+fun extractTemporalRepresentation(requestParams: MultiValueMap<String, String>):


still the 1st point

bobeal · 2025-01-08T20:09:01Z

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

+        if (!optionsParam.isEmpty) {
+            val hasTemporal = hasValueInOptionsParam(optionsParam, OptionsValue.TEMPORAL_VALUES).bind()
+            val hasAggregated = hasValueInOptionsParam(optionsParam, OptionsValue.AGGREGATED_VALUES).bind()
+            when {
+                hasTemporal && hasAggregated ->
+                    return BadRequestDataException("Only one temporal representation can be present").left()
+                hasTemporal -> return TemporalRepresentation.TEMPORAL_VALUES.right()
+                hasAggregated -> return TemporalRepresentation.AGGREGATED_VALUES.right()
+                else -> return TemporalRepresentation.NORMALIZED.right()
+            }
+        } else
+            return TemporalRepresentation.NORMALIZED.right()


Suggested change

if (!optionsParam.isEmpty) {

val hasTemporal = hasValueInOptionsParam(optionsParam, OptionsValue.TEMPORAL_VALUES).bind()

val hasAggregated = hasValueInOptionsParam(optionsParam, OptionsValue.AGGREGATED_VALUES).bind()

when {

hasTemporal && hasAggregated ->

return BadRequestDataException("Only one temporal representation can be present").left()

hasTemporal -> return TemporalRepresentation.TEMPORAL_VALUES.right()

hasAggregated -> return TemporalRepresentation.AGGREGATED_VALUES.right()

else -> return TemporalRepresentation.NORMALIZED.right()

}

} else

return TemporalRepresentation.NORMALIZED.right()

return if (!optionsParam.isEmpty) {

val hasTemporal = hasValueInOptionsParam(optionsParam, OptionsValue.TEMPORAL_VALUES).bind()

val hasAggregated = hasValueInOptionsParam(optionsParam, OptionsValue.AGGREGATED_VALUES).bind()

when {

hasTemporal && hasAggregated ->

BadRequestDataException(

"Found different temporal representations in options query parameter, only one can be provided"

).left()

hasTemporal -> TemporalRepresentation.TEMPORAL_VALUES.right()

hasAggregated -> TemporalRepresentation.AGGREGATED_VALUES.right()

else -> TemporalRepresentation.NORMALIZED.right()

}

} else

TemporalRepresentation.NORMALIZED.right()

bobeal · 2025-01-08T20:25:41Z

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

+                .flatMap { it.split(",") }
+            val formatParam = queryParams.getFirst(QueryParameter.FORMAT.key)
+            if (formatParam != null && FormatValue.fromString(formatParam) == null) {
+                return InvalidRequestException("'$formatParam' is not a valid format value").left()
+            }
+
+            optionsParam.forEach { option ->
+                OptionsValue.fromString(option).bind()
+            }
+            val attributeRepresentation = when {
+                formatParam == FormatValue.KEY_VALUES.value ||
+                    formatParam == FormatValue.SIMPLIFIED.value -> AttributeRepresentation.SIMPLIFIED
+                formatParam == FormatValue.NORMALIZED.value -> AttributeRepresentation.NORMALIZED
+                optionsParam.contains(FormatValue.KEY_VALUES.value) ||
+                    optionsParam.contains(FormatValue.SIMPLIFIED.value) -> AttributeRepresentation.SIMPLIFIED
+                else -> AttributeRepresentation.NORMALIZED
+            }
            val includeSysAttrs = optionsParam.contains(OptionsValue.SYS_ATTRS.value)


Suggested change

.flatMap { it.split(",") }

val formatParam = queryParams.getFirst(QueryParameter.FORMAT.key)

if (formatParam != null && FormatValue.fromString(formatParam) == null) {

return InvalidRequestException("'$formatParam' is not a valid format value").left()

}

optionsParam.forEach { option ->

OptionsValue.fromString(option).bind()

}

val attributeRepresentation = when {

formatParam == FormatValue.KEY_VALUES.value ||

formatParam == FormatValue.SIMPLIFIED.value -> AttributeRepresentation.SIMPLIFIED

formatParam == FormatValue.NORMALIZED.value -> AttributeRepresentation.NORMALIZED

optionsParam.contains(FormatValue.KEY_VALUES.value) ||

optionsParam.contains(FormatValue.SIMPLIFIED.value) -> AttributeRepresentation.SIMPLIFIED

else -> AttributeRepresentation.NORMALIZED

}

val includeSysAttrs = optionsParam.contains(OptionsValue.SYS_ATTRS.value)

.flatMap { it.split(",") }

.map { OptionsValue.fromString(it).bind() }

val formatParam = queryParams.getFirst(QueryParameter.FORMAT.key)?.let {

FormatValue.fromString(it).bind()

}

val attributeRepresentation = when {

formatParam == FormatValue.KEY_VALUES || formatParam == FormatValue.SIMPLIFIED ->

AttributeRepresentation.SIMPLIFIED

formatParam == FormatValue.NORMALIZED ->

AttributeRepresentation.NORMALIZED

optionsParam.contains(OptionsValue.KEY_VALUES) || optionsParam.contains(OptionsValue.SIMPLIFIED) ->

AttributeRepresentation.SIMPLIFIED

else -> AttributeRepresentation.NORMALIZED

}

val includeSysAttrs = optionsParam.contains(OptionsValue.SYS_ATTRS)

bobeal · 2025-01-08T20:27:09Z

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

+        fun fromString(key: String): FormatValue? =
+            FormatValue.entries.find { it.value == key }


Suggested change

fun fromString(key: String): FormatValue? =

FormatValue.entries.find { it.value == key }

fun fromString(key: String): Either<APIException, FormatValue> = either {

FormatValue.entries.find { it.value == key }

?: return InvalidRequestException("'$key' is not a valid value for the format query parameter").left()

}

ranim-n · 2025-01-09T08:09:34Z

don't know why you merged develop in your branch (we never do that, we rebase on develop), but it is a bit a mess. there is at least one commit from develop which is included in the branch...

There were conflicts with develop that I fixed on github, I clicked on commit after and it did a merge. Can it be fixed?

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

sonarqubecloud · 2025-01-09T11:28:08Z

Quality Gate passed

Issues
3 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

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

...ch-service/src/test/kotlin/com/egm/stellio/search/temporal/web/TemporalEntityHandlerTests.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 2 commits January 6, 2025 09:19

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

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

bobeal reviewed Jan 6, 2025

View reviewed changes

ranim-n and others added 2 commits January 6, 2025 17:57

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

a9fe227

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

feat: return exceptions for invalid format and options

e4d3857

ranim-n linked an issue Jan 7, 2025 that may be closed by this pull request

6.3.20 return invalidRequest for bad values of Options parameter #1292

Open

ranim-n and others added 4 commits January 7, 2025 16:50

Merge branch 'develop' into feature/add-support-for-format-parameter

29fb4b9

fix(core): ensure to have correct attribute id when a previous one ex…

21da9d3

…isted (#1307)

fix: resolve conflicts with remote

8f035d0

fix: more conflicts with develop

89a5d61

ranim-n marked this pull request as ready for review January 8, 2025 10:13

bobeal requested a review from thomasBousselin January 8, 2025 17:37

bobeal reviewed Jan 8, 2025

View reviewed changes

ranim-n and others added 2 commits January 9, 2025 09:39

Update shared/src/test/kotlin/com/egm/stellio/shared/model/NgsiLdData…

6661df9

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

fix: PR comments + suggestions

1de5901

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

bobeal Jan 6, 2025

bobeal Jan 6, 2025

bobeal Jan 8, 2025

bobeal commented Jan 8, 2025

bobeal Jan 8, 2025

ranim-n Jan 9, 2025

bobeal Jan 8, 2025

bobeal Jan 8, 2025

bobeal Jan 8, 2025

bobeal Jan 8, 2025

bobeal Jan 8, 2025

bobeal Jan 8, 2025

ranim-n commented Jan 9, 2025

sonarqubecloud bot commented Jan 9, 2025

	?: return InvalidRequestException("'$key' is not a valid options value").left()
	?: return InvalidRequestException("'$key' is not a valid value for the options query parameter").left()

		fun fromString(key: String): FormatValue? =
		FormatValue.entries.find { it.value == key }

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

bobeal commented Jan 4, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bobeal commented Jan 8, 2025

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

ranim-n commented Jan 9, 2025

sonarqubecloud bot commented Jan 9, 2025

Quality Gate passed

github-actions bot commented Dec 24, 2024 •

edited

Loading