Feature/geolocation outside extent or boundary #166

jedi-of-the-sea · 2024-08-28T14:12:34Z

Summary

user location is tracked even if user is not within boundaryLayer, but within map extent.

Instructions for local reproduction and review

I used the meldemichel client for the implementation. To simulate a moving target, I added

// let lastCoordinate: [number, number] = [564387.0212149565, 5992080.331721107] // Neumünster
// let lastCoordinate: [number, number] = [566990.45, 5933972.45] // Hamburg
let lastCoordinate: [number, number] = [356123.45, 5942345.67] // Kiel

function getNextCoordinate(): [number, number] {
  const offset = 0.1 // Versatzwert
  const newCoordinate: [number, number] = [
    lastCoordinate[0] + offset,
    lastCoordinate[1] + offset,
  ]
  lastCoordinate = newCoordinate
  return newCoordinate
}

on top of the actions and set transformedCoords to getNextCoordinate()

jedi-of-the-sea · 2024-08-28T14:18:44Z

Now that I'm finished I'm not sure if this is what was desired, as the extent of the map might be bigger than the boundaryLayer, and the user will be shown in an area where no map is rendered, as the case with meldemichel. I decided to leave it like that because I interpret the original description of the ticket like that, and let you decide if I should adjust the code. One could always adjust the map extent accordingly I think. Also, the info toast is triggered the whole time a user is outside the boundaryLayer. That was intentional, as I thought of someone moving around and seeing live if they are within the boundary. But the toasts might be annoying if the user is to far away?

warm-coolguy

🏓 @jedi-of-the-sea

warm-coolguy · 2024-09-05T06:20:09Z

packages/plugins/GeoLocation/CHANGELOG.md

@@ -3,6 +3,7 @@
 ## unpublished

 - Fix: Adjust documentation to properly describe optionality of configuration parameters.
+- Feature: Position is now tracked when user is outside of the view extent.


warm-coolguy · 2024-09-05T06:20:50Z

packages/plugins/GeoLocation/README.md

@@ -12,8 +12,8 @@ either `true` or `false`. When a users denies the location tracking, the button

 | fieldName | type | description |
 | - | - | - |
-| boundaryLayerId | string? | Id of a vector layer to restrict geolocation markers and zooms to. When geolocation outside of its features occurs, an information will be shown once and the feature is stopped. The map will wait at most 10s for the layer to load; should it not happen, the geolocation feature is turned off. |
-| boundaryOnError | ('strict' \| 'permissive')? | If the boundary layer check does not work due to loading or configuration errors, style `'strict'` will disable the geolocation feature, and style `'permissive'` will act as if no boundaryLayerId was set. Defaults to `'permissive'`. |
+| boundaryLayerId | string? | Id of a vector layer to restrict geolocation markers and zooms to. When geolocation outside of its features occurs, an information will be shown. When loading the boundary layer, the map will wait at most 10s; should it not happen, the geolocation feature is turned off. |


Please return to only showing the message once per "user is outside the boundary" state.

warm-coolguy · 2024-09-05T06:22:59Z

packages/plugins/GeoLocation/README.md

-| boundaryLayerId | string? | Id of a vector layer to restrict geolocation markers and zooms to. When geolocation outside of its features occurs, an information will be shown once and the feature is stopped. The map will wait at most 10s for the layer to load; should it not happen, the geolocation feature is turned off. |
-| boundaryOnError | ('strict' \| 'permissive')? | If the boundary layer check does not work due to loading or configuration errors, style `'strict'` will disable the geolocation feature, and style `'permissive'` will act as if no boundaryLayerId was set. Defaults to `'permissive'`. |
+| boundaryLayerId | string? | Id of a vector layer to restrict geolocation markers and zooms to. When geolocation outside of its features occurs, an information will be shown. When loading the boundary layer, the map will wait at most 10s; should it not happen, the geolocation feature is turned off. |
+| boundaryOnError | ('strict' \| 'permissive')? | If the boundary layer check does not work due to loading or configuration errors, style `'strict'` will disable the geolocation feature, and style `'permissive'` will act as if no boundaryLayerId was set.  Defaults to `'permissive'`. |


There's a random extra whitespace here?

warm-coolguy · 2024-09-05T06:33:13Z

packages/plugins/GeoLocation/src/store/getters.ts

+    const zoomLevel = rootGetters.configuration?.geoLocation?.zoomLevel
+    if (zoomLevel !== undefined && zoomLevel !== null) {
+      return zoomLevel
+    }
+    return 7


Good catch. I'm pretty sure the nullish coalescing operator also works in our setup, so you may write it shorter as this:

Suggested change

const zoomLevel = rootGetters.configuration?.geoLocation?.zoomLevel

if (zoomLevel !== undefined && zoomLevel !== null) {

return zoomLevel

}

return 7

return rootGetters.configuration?.geoLocation?.zoomLevel ?? 7

warm-coolguy · 2024-09-05T06:34:14Z

packages/plugins/GeoLocation/src/utils/positionChanged.ts

+  position: number[],
+  transformedCoords: number[]


The names are confusing to me, I'd prefer something like "oldPosition" and "newPosition". I know they're named like that in the other spot, but for a multi-purpose function this is oddly specific.

jedi-of-the-sea · 2024-09-11T16:27:02Z

@warm-coolguy I implemented your suggestions and tried to change the code so that the geolocation tool behaves differently:

when user is outside of boundary layer but inside map extent, tracking continues but the toast message is only triggered once and there is no zoom to the marker anymore.

It should work like that, but I have not tested this with every parameter settings yet, so feel free to wait with further reviews until I have done that.

jedi-of-the-sea added 8 commits August 22, 2024 16:45

fix bug in zoomLevel getter

a59194f

track user position if it is outside of extent

6ea4af3

update changelog

c439490

simplify and clean up code

b6cb224

refactoring

a9fd197

fix code to consider boundaryOnError

ea7bbaf

change code so boundaryOnError does what docu says

e1f31e3

update readme

c16e9b8

jedi-of-the-sea requested review from warm-coolguy and dopenguin as code owners August 28, 2024 14:12

jedi-of-the-sea self-assigned this Aug 28, 2024

jedi-of-the-sea added the enhancement New feature or request label Aug 28, 2024

warm-coolguy requested changes Sep 5, 2024

View reviewed changes

warm-coolguy and others added 9 commits September 5, 2024 08:38

Merge branch 'main' into feature/geolocation-outside-extent-or-boundary

84b390d

correct changelog entry

a9255fa

simplify getter zoomLevel

79cac2a

rename variables

88ff58f

only show info message once if user is out of boundayLayer

71b9295

addition to changelog

c5f83f2

correct readme

e5c2b5b

do not zoom to marker if user is outside of boundaryLayer

1015533

fix bug

48cfcc5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/geolocation outside extent or boundary #166

Feature/geolocation outside extent or boundary #166

jedi-of-the-sea commented Aug 28, 2024

jedi-of-the-sea commented Aug 28, 2024 •

edited

Loading

warm-coolguy left a comment

warm-coolguy Sep 5, 2024

jedi-of-the-sea Sep 11, 2024

warm-coolguy Sep 5, 2024

jedi-of-the-sea Sep 11, 2024

warm-coolguy Sep 5, 2024

jedi-of-the-sea Sep 11, 2024

warm-coolguy Sep 5, 2024

jedi-of-the-sea Sep 11, 2024

warm-coolguy Sep 5, 2024

jedi-of-the-sea Sep 11, 2024

jedi-of-the-sea commented Sep 11, 2024

Feature/geolocation outside extent or boundary #166

Are you sure you want to change the base?

Feature/geolocation outside extent or boundary #166

Conversation

jedi-of-the-sea commented Aug 28, 2024

Summary

Instructions for local reproduction and review

jedi-of-the-sea commented Aug 28, 2024 • edited Loading

warm-coolguy left a 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

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

jedi-of-the-sea commented Sep 11, 2024

jedi-of-the-sea commented Aug 28, 2024 •

edited

Loading