OL v10

[paul121]

Tracking for bumping the OL dependency to v7: https://github.com/openlayers/openlayers/releases/tag/v7.0.0

I noticed a couple breaking changes that may effect us:

The forEachLayerAtPixel method has been removed from the Map class.

I know we use this downstream in farmOS, likely in farmOS-map too?

Deprecated options have been removed from the Overlay component.

Might not directly effect us but should check on the ol-popup library which uses an overlay.

[paul121]

I only see one usage of the map.forEachLayerAtPixel method in farmOS-map core:

farmOS-map/examples/simple-html-consumer/static/index.html

Line 42 in e90a9f8

var feature = myMap.map.forEachFeatureAtPixel(event.pixel, function(feature, layer) { return feature; });

We use it much more in farmOS core for the "popup" behavior.

[mstenta]

@paul121 We don't use forEachLayerAtPixel() in either farmOS core or farmOS-map core, we use forEachFeatureAtPixel(), which hasn't been deprecated.

forEachFeatureAtPixel() is still part of OL 7.1.0: https://openlayers.org/en/latest/apidoc/module-ol_Map-Map.html#forEachFeatureAtPixel

[paul121]

Oh my, good catch thanks @mstenta !!

[mstenta]

OL v10 is now the latest version. Perhaps we should update this issue accordingly. :-)

[paul121]

The upgrade notes include all breaking changes and deprecations for the following major and minor versions:

• v7
• v8
• v9
• v10

[paul121]

OL v10.4 appears to be working pretty well! I had to upgrade ol-layerswitcher to v4 and ol-popup to v5 to include fixes for these issues that seem to have come with OL v7: walkermatt/ol-popup#322 walkermatt/ol-layerswitcher#487

The separate ol-grid and ol-side-panel dependencies still depend on OL v6 which makes NPM mad, but can still be installed with npm install --force. So far I'm only seeing one issue with these dependencies with OL v10.4 which is that the Snapping grid does not have any "snapping" functionality... The grid is created, but when using the editor to draw a geometry, it does not snap to the grid. Not sure which change might have caused this, still need to look closer

[paul121]

Things I am testing (verified they work unless noted otherwise):

• Current location control
• Geocoder control
• Snapshot
• Rotation/rotate to North
• Layer switcher (multiple layer types... testing all that farmOS core provides)
• Sidepanel w/ layer switcher
• Fullscreen control
• Edit controls
• Resizing map
• Snapping grid - the grid is displayed, but cursor does not snap to the grid in OL 10.4

[paul121]

the Snapping grid does not have any "snapping" functionality... The grid is created, but when using the editor to draw a geometry, it does not snap to the grid. Not sure which change might have caused this, still need to look closer

Looking closer it seems like this might be an issue with the Edit control. I discovered that the Edit control was snapping to geometries that are drawn in the current "session", but if you stopped drawing (press escape) and then resumed drawing again after clicking a drawing tool a second time, you could no longer snap to the previously drawn geometries in the map. A bit of an odd issue, but I also confirmed that this is not an issue in the current version of farmOS-map.

I was able to fix this by making sure we always re-load vector features from all layers when starting/resuming drawing - simply un-indenting this logic! Unfortunately this didn't enable snapping of the Snapping grid point features.

farmOS-map/src/control/Edit/Edit.js

Lines 390 to 404 in 280e316

	// Load all vector layer features in the map and add them to the snap
	// interaction's feature collection (so they can be snapped to).
	forEachLayer(this.getMap().getLayerGroup(), (layer) => {
	if (typeof layer.getSource === 'function') {
	const source = layer.getSource();
	if (source !== 'null' && source instanceof VectorSource) {
	const features = source.getFeatures();
	if (source.getState() === 'ready' && features.length > 0) {
	features.forEach((feature) => {
	this.snapInteraction.addFeature(feature);
	});
	}
	}
	}
	});

So... the other difference I'm learning is that the Snapping Grid's ol-grid interaction is creating an "unmanaged" vector layer when it calls layer.setMap(map/null)

See docs on layer.map property:

Sets the layer as overlay on a map. The map will not manage this layer in its layers collection, and the layer will be rendered on top. This is useful for temporary layers. The standard way to add a layer to a map and have it managed by the map is to use map.addLayer().

Basically, this layer won't be picked up by the map.getLayerGroup() method that we are calling in the Edit control's enableSnap logic. So... perhaps ol-grid could be updated to create a layer that is managed by the map, instead of this unmanaged layer overlay thing? 🤔 (curious your thoughts @symbioquine )

I'm still not sure what exactly changed in OL to affect these things... but getting closer to understanding why I am experiencing it :-)

[paul121]

the Snapping grid does not have any "snapping" functionality... The grid is created, but when using the editor to draw a geometry, it does not snap to the grid. Not sure which change might have caused this, still need to look closer

Oh, also worth noting that the snapping grid is able to snap to vector features when drawing the initial two points to orient the grid. It uses logic very similar to the Edit control to do this.

[symbioquine]

Basically, this layer won't be picked up by the map.getLayerGroup() method that we are calling in the Edit control's enableSnap logic. So... perhaps ol-grid could be updated to create a layer that is managed by the map, instead of this unmanaged layer overlay thing? 🤔 (curious your thoughts @symbioquine )

That's by design. The snapping grid control in farmOS-map adds its own snap interaction.

Notice in the edit control code how there isn't really any connection between the draw/modify interactions and the snap interaction (they're both just independently added to the map). In OL v6 (and my understanding) that meant that the snapping grid's snap interaction just needed to be added to the map - and have the correct control point features added (to the snap interaction that is).

My guess is that something either changed with how multiple snap interactions coexist or something broke with the logic that the snapping grid uses to maintain its own snap interaction... I'll try to take a look. Any chance you can push your changes so far so I can pick up with the snapping grid part where you've gotten to?

[paul121]

That's by design. The snapping grid control in farmOS-map adds its own snap interaction.

My guess is that something either changed with how multiple snap interactions coexist or something broke with the logic that the snapping grid uses to maintain its own snap interaction...

Ah that makes sense. It's interesting that the snapping behavior within the Edit control somewhat broke as well.

Opened a PR here #206