perf: prevent watching reactive props continously

BREAKING CHANGE: the composable `usePropsAsObjectProperties` which is used as foundation in all components has been refactored. Props were watched always deeply and for lot's of components this was done multiple times since the components implement watchers by themselves. However, even if not expected, this may cause some side effects with reactive changes which must be applied for individual components when not implemented and therefore considered as a breaking change. Please check your app carefully when updating to the new major version.
MelihAltintas · Apr 12, 2024 · 45f9326 · 45f9326
1 parent 4646392
commit 45f9326
Show file tree

Hide file tree

Showing 71 changed files with 90 additions and 103 deletions.
diff --git a/src/components/animations/OlAnimationFeature.vue b/src/components/animations/OlAnimationFeature.vue
@@ -21,7 +21,7 @@ const props = withDefaults(
 const map = inject("map");
 const vectorLayer = inject<Ref<VectorSource<Geometry>> | null>("vectorLayer");
 
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 defineExpose({
   map,

diff --git a/src/components/interaction/OlClusterSelectInteraction.vue b/src/components/interaction/OlClusterSelectInteraction.vue
@@ -27,7 +27,7 @@ const props = withDefaults(defineProps<Options>(), {
 
 const map = inject<Map>("map");
 
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const select = computed(() => {
   return new SelectCluster({

diff --git a/src/components/interaction/OlDragBoxInteraction.vue b/src/components/interaction/OlDragBoxInteraction.vue
@@ -20,7 +20,7 @@ const props = withDefaults(defineProps<Options>(), {});
 
 const map = inject<Map>("map");
 
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const dragbox = computed(() => {
   const s = new DragBox({

diff --git a/src/components/interaction/OlDragRotateInteraction.vue b/src/components/interaction/OlDragRotateInteraction.vue
@@ -22,12 +22,10 @@ const props = withDefaults(
 
 const map = inject<Map>("map");
 
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const dragrotate = computed(() => {
-  const s = new DragRotate({
-    ...properties,
-  });
+  const s = new DragRotate(properties);
 
   return s;
 });

diff --git a/src/components/interaction/OlDragRotateZoomInteraction.vue b/src/components/interaction/OlDragRotateZoomInteraction.vue
@@ -19,7 +19,7 @@ const props = withDefaults(
 );
 
 const map = inject<Map>("map");
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 const dragRotateZoom = computed(() => {
   const OlDragRotateAndZoom = new DragRotateAndZoom({
     ...properties,

diff --git a/src/components/interaction/OlLinktInteraction.vue b/src/components/interaction/OlLinktInteraction.vue
@@ -29,7 +29,7 @@ const props = withDefaults(defineProps<Options>(), {
 });
 
 const map = inject<Map>("map");
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const link = shallowRef(new Link(properties));
 

diff --git a/src/components/interaction/OlSelectInteraction.vue b/src/components/interaction/OlSelectInteraction.vue
@@ -35,7 +35,7 @@ const props = withDefaults(
 );
 
 const map = inject<Map>("map");
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const select = computed(() => {
   return new Select({

diff --git a/src/components/interaction/OlSnapInteraction.vue b/src/components/interaction/OlSnapInteraction.vue
@@ -26,7 +26,7 @@ const props = withDefaults(
 const map = inject<Map>("map");
 const source = inject<Ref<VectorSource> | null>("vectorSource");
 
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const createSnap = () => {
   const olSnap = new Snap({

diff --git a/src/components/interaction/OlTransformInteraction.vue b/src/components/interaction/OlTransformInteraction.vue
@@ -43,7 +43,7 @@ defineOptions({
 
 const map = inject<Map>("map");
 
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const transform = computed(() => {
   const olTransform = new Transform({

diff --git a/src/components/layers/OlAnimatedClusterLayer.vue b/src/components/layers/OlAnimatedClusterLayer.vue
@@ -59,7 +59,7 @@ const props = withDefaults(
 const map = inject<Map>("map");
 const layerGroup = inject<LayerGroup | null>("layerGroup", null);
 
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const clusterSource = shallowRef(
   new Cluster({

diff --git a/src/components/layers/OlHeatmapLayer.vue b/src/components/layers/OlHeatmapLayer.vue
@@ -47,7 +47,7 @@ const props = withDefaults(
 const map = inject<Map>("map");
 const layerGroup = inject<LayerGroup | null>("layerGroup", null);
 
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 const heatmapLayer = shallowRef(new HeatmapLayer(properties));
 
 watch(

diff --git a/src/components/layers/OlImageLayer.vue b/src/components/layers/OlImageLayer.vue
@@ -23,7 +23,7 @@ const props = withDefaults(
 const map = inject<Map>("map");
 const layerGroup = inject<LayerGroup | null>("layerGroup", null);
 
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const imageLayer = ref(new ImageLayer(properties));
 

diff --git a/src/components/layers/OlLayerGroup.vue b/src/components/layers/OlLayerGroup.vue
@@ -30,7 +30,7 @@ const props = withDefaults(
 );
 
 const map = inject<Map>("map");
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const layerGroup = shallowRef(new LayerGroup(properties));
 useOpenLayersEvents(layerGroup, [

diff --git a/src/components/layers/OlTileLayer.vue b/src/components/layers/OlTileLayer.vue
@@ -40,7 +40,7 @@ const map = inject<Map>("map");
 const layerGroup = inject<LayerGroup | null>("layerGroup", null);
 const overViewMap = inject<Ref<OverviewMap | null> | null>("overviewMap", null);
 
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const tileLayer = ref(new TileLayer(properties));
 

diff --git a/src/components/layers/OlVectorImageLayer.vue b/src/components/layers/OlVectorImageLayer.vue
@@ -36,7 +36,7 @@ const props = withDefaults(
 const map = inject<Map>("map");
 const layerGroup = inject<LayerGroup | null>("layerGroup", null);
 
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const vectorImageLayer = computed(() => new VectorImageLayer(properties));
 

diff --git a/src/components/layers/OlVectorLayer.vue b/src/components/layers/OlVectorLayer.vue
@@ -39,7 +39,7 @@ const props = withDefaults(
 const map = inject<Map>("map");
 const layerGroup = inject<LayerGroup | null>("layerGroup", null);
 
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const vectorLayer = computed(() => new VectorLayer(properties));
 

diff --git a/src/components/layers/OlVectorTileLayer.vue b/src/components/layers/OlVectorTileLayer.vue
@@ -41,7 +41,7 @@ const props = withDefaults(
 const map = inject<Map>("map");
 const layerGroup = inject<LayerGroup | null>("layerGroup", null);
 
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const vectorTileLayer = computed(() => new VectorTileLayer(properties));
 

diff --git a/src/components/layers/OlWebglTileLayer.vue b/src/components/layers/OlWebglTileLayer.vue
@@ -28,7 +28,7 @@ const layerGroup = inject<LayerGroup | null>("layerGroup", null);
 
 const overViewMap = inject<Ref<OverviewMap | null> | null>("overviewMap", null);
 
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const tileLayer = shallowRef(new TileLayer(properties));
 

diff --git a/src/components/layers/OlWebglVectorLayer.vue b/src/components/layers/OlWebglVectorLayer.vue
@@ -39,7 +39,7 @@ const props = withDefaults(
 const map = inject<Map>("map");
 const layerGroup = inject<LayerGroup | null>("layerGroup", null);
 
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const webglVectorLayer = computed(() => {
   return new WebGLVectorLayer({

diff --git a/src/components/map/OlGeoLocation.vue b/src/components/map/OlGeoLocation.vue
@@ -31,7 +31,7 @@ const props = withDefaults(defineProps<Options>(), {
   }),
 });
 
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const geoLoc = computed(() => new Geolocation(properties));
 

diff --git a/src/components/map/OlMap.vue b/src/components/map/OlMap.vue
@@ -37,7 +37,7 @@ const emit = defineEmits([
   "rendercomplete",
 ]);
 
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const mapRef = ref<string | HTMLElement | undefined>(undefined);
 let map: Map | undefined = new Map(properties);

diff --git a/src/components/map/OlOverlay.vue b/src/components/map/OlOverlay.vue
@@ -33,7 +33,7 @@ const map = inject<Map>("map");
 
 const htmlContent = ref<HTMLElement>();
 
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const overlay = shallowRef(new Overlay(properties));
 

diff --git a/src/components/map/OlView.vue b/src/components/map/OlView.vue
@@ -27,7 +27,7 @@ const props = withDefaults(defineProps<ViewOptions>(), {
 });
 
 const map = inject<Map>("map");
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const createProp = () => {
   return {

diff --git a/src/components/mapControls/OlAttributionControl.vue b/src/components/mapControls/OlAttributionControl.vue
@@ -32,7 +32,7 @@ const props = withDefaults(
 );
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 const { control } = useControl(Attribution, properties, attrs);
 
 defineExpose({

diff --git a/src/components/mapControls/OlButtonControl.vue b/src/components/mapControls/OlButtonControl.vue
@@ -20,7 +20,7 @@ const props = withDefaults(
 );
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const { control } = useControl(Button, properties, attrs);
 

diff --git a/src/components/mapControls/OlContextMenuControl.vue b/src/components/mapControls/OlContextMenuControl.vue
@@ -21,7 +21,7 @@ defineOptions({
 });
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const { control } = useControl(ContextMenu, properties, attrs);
 useOpenLayersEvents(control, ["beforeopen", "open", "close", "add-menu-entry"]);

diff --git a/src/components/mapControls/OlControlBar.vue b/src/components/mapControls/OlControlBar.vue
@@ -20,7 +20,7 @@ const props = withDefaults(
 );
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const { control } = useControl(Bar, properties, attrs);
 

diff --git a/src/components/mapControls/OlFullScreenControl.vue b/src/components/mapControls/OlFullScreenControl.vue
@@ -33,7 +33,7 @@ const props = withDefaults(
 );
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 const { control } = useControl(FullScreen, properties, attrs);
 
 defineExpose({

diff --git a/src/components/mapControls/OlLayerSwitcherControl.vue b/src/components/mapControls/OlLayerSwitcherControl.vue
@@ -17,7 +17,7 @@ const props = withDefaults(defineProps<Options>(), {
 });
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const { control } = useControl(LayerSwitcher, properties, attrs);
 

diff --git a/src/components/mapControls/OlLayerSwitcherImageControl.vue b/src/components/mapControls/OlLayerSwitcherImageControl.vue
@@ -18,7 +18,7 @@ const props = withDefaults(defineProps<Options>(), {
 });
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const { control } = useControl(LayerSwitcherImage, properties, attrs);
 

diff --git a/src/components/mapControls/OlMousePositionControl.vue b/src/components/mapControls/OlMousePositionControl.vue
@@ -21,7 +21,7 @@ const props = withDefaults(
 );
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const { control } = useControl(MousePosition, properties, attrs);
 defineExpose({

diff --git a/src/components/mapControls/OlOverviewMapControl.vue b/src/components/mapControls/OlOverviewMapControl.vue
@@ -13,7 +13,7 @@ import usePropsAsObjectProperties from "@/composables/usePropsAsObjectProperties
 const props = defineProps<Options>();
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 const { control } = useControl(OverviewMap, properties, attrs);
 
 provide("overviewMap", control);

diff --git a/src/components/mapControls/OlPrintDialogControl.vue b/src/components/mapControls/OlPrintDialogControl.vue
@@ -13,7 +13,7 @@ import usePropsAsObjectProperties from "@/composables/usePropsAsObjectProperties
 const props = withDefaults(defineProps<Options>(), {});
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const { control } = useControl(PrintDialog, properties, attrs);
 

diff --git a/src/components/mapControls/OlProfileControl.vue b/src/components/mapControls/OlProfileControl.vue
@@ -16,7 +16,7 @@ defineOptions({
 const props = withDefaults(defineProps<Options>(), {});
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 const { control } = useControl(Profile, properties, attrs);
 
 useOpenLayersEvents(control, [

diff --git a/src/components/mapControls/OlRotateControl.vue b/src/components/mapControls/OlRotateControl.vue
@@ -30,7 +30,7 @@ const props = withDefaults(
 );
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const { control } = useControl(Rotate, properties, attrs);
 

diff --git a/src/components/mapControls/OlScaleLineControl.vue b/src/components/mapControls/OlScaleLineControl.vue
@@ -31,7 +31,7 @@ const props = withDefaults(
 );
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const { control } = useControl(ScaleLine, properties, attrs);
 

diff --git a/src/components/mapControls/OlSearchControl.vue b/src/components/mapControls/OlSearchControl.vue
@@ -14,7 +14,7 @@ const props = withDefaults(defineProps<Options>(), {
 });
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const { control } = useControl(Search, properties, attrs);
 

diff --git a/src/components/mapControls/OlSwipeControl.vue b/src/components/mapControls/OlSwipeControl.vue
@@ -23,7 +23,7 @@ const props = withDefaults(
 );
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const { control } = useControl(Swipe, properties, attrs);
 

diff --git a/src/components/mapControls/OlToggleControl.vue b/src/components/mapControls/OlToggleControl.vue
@@ -11,7 +11,7 @@ import usePropsAsObjectProperties from "@/composables/usePropsAsObjectProperties
 const props = withDefaults(defineProps<Options>(), {});
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const { control } = useControl(Toggle, properties, attrs);
 

diff --git a/src/components/mapControls/OlVideoRecorderControl.vue b/src/components/mapControls/OlVideoRecorderControl.vue
@@ -20,7 +20,7 @@ const props = withDefaults(defineProps<Options & { downloadName?: string }>(), {
 });
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 const { control } = useControl(VideoRecorder, properties, attrs);
 
 useOpenLayersEvents(control, ["start", "stop", "pause", "resume"]);

diff --git a/src/components/mapControls/OlZoneControl.vue b/src/components/mapControls/OlZoneControl.vue
@@ -23,7 +23,7 @@ const props = withDefaults(
 );
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const { control } = useControl(MapZone, properties, attrs);
 

diff --git a/src/components/mapControls/OlZoomControl.vue b/src/components/mapControls/OlZoomControl.vue
@@ -20,7 +20,7 @@ const props = withDefaults(defineProps<Options>(), {
 });
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const { control } = useControl(Zoom, properties, attrs);
 defineExpose({

diff --git a/src/components/mapControls/OlZoomSliderControl.vue b/src/components/mapControls/OlZoomSliderControl.vue
@@ -20,7 +20,7 @@ const props = withDefaults(
 );
 
 const attrs = useAttrs();
-const { properties } = usePropsAsObjectProperties(props);
+const properties = usePropsAsObjectProperties(props);
 
 const { control } = useControl(ZoomSlider, properties, attrs);
 defineExpose({