Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

HoverController using AbortController instead of cancelToken #417

Merged
merged 2 commits into from
Sep 24, 2024
Merged

HoverController using AbortController instead of cancelToken #417

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73a2a0d
Converted HoverController CancelToken to AbortController
sronveaux Sep 20, 2024
7ff8731
Updated HoverController unit tests with AbortController instead of Ca…
sronveaux Sep 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions src/components/ol/HoverController.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export default class HoverController {
conf = null;
timerHandle = null;
activeOverlayId = null;
pendingRequestsCancelSrc = null;
pendingRequestsAbortCtrl = null;

/**
* Initializes the map hover functionality:
Expand Down Expand Up @@ -71,9 +71,9 @@ export default class HoverController {
me.timerHandle = null;
}

if (me.pendingRequestsCancelSrc) {
me.pendingRequestsCancelSrc.cancel();
me.pendingRequestsCancelSrc = null;
if (me.pendingRequestsAbortCtrl) {
me.pendingRequestsAbortCtrl.abort();
me.pendingRequestsAbortCtrl = null;
}

if (me.activeOverlayId) {
Expand All @@ -95,16 +95,16 @@ export default class HoverController {
const map = me.map;
const pixel = event.pixel;
const coordinate = event.coordinate;
const cancelToken = axios.CancelToken;
const abortController = new AbortController();
const featureInfos = [];
let resetTooltip = true;

// Cancel pending requests and create a new cancel token source which corresponds
// to all async requests sent in this iteration.
if (me.pendingRequestsCancelSrc) {
me.pendingRequestsCancelSrc.cancel();
if (me.pendingRequestsAbortCtrl) {
me.pendingRequestsAbortCtrl.abort();
}
me.pendingRequestsCancelSrc = cancelToken.source();
me.pendingRequestsAbortCtrl = abortController;

// Acquire features for all layers.
map.getLayers().forEach((layer) => {
Expand All @@ -114,7 +114,7 @@ export default class HoverController {
const source = layer.getSource();
if (source instanceof TileWmsSource || source instanceof ImageWMSSource) {
resetTooltip = false;
me.getWMSFeaturesAsync(map, layer, coordinate, me.pendingRequestsCancelSrc)
me.getWMSFeaturesAsync(map, layer, coordinate, me.pendingRequestsAbortCtrl)
.then(function (features) {
featureInfos.push(...features.map((feat) => {
return { layer, feature: feat };
Expand Down Expand Up @@ -162,10 +162,10 @@ export default class HoverController {
* @param {ol.Map} map OpenLayers map.
* @param {ol.layer.Tile | ol.layer.Image} layer The layer to acquire the features for.
* @param {ol.Coordinate} coordinate The coordinate in map projection.
* @param {axios.CancelTokenSource} cancelTokenSrc An optional cancel token to abort the request.
* @param {AbortController} abortCtrl An optional abort controller to abort the request.
* @returns {Promise<Array<ol.Feature>>}
*/
getWMSFeaturesAsync (map, layer, coordinate, cancelTokenSrc) {
getWMSFeaturesAsync (map, layer, coordinate, abortCtrl) {
const view = map.getView();
return new Promise((resolve, reject) => {
const url = layer.getSource().getFeatureInfoUrl(
Expand All @@ -183,7 +183,7 @@ export default class HoverController {
const request = {
method: 'GET',
url,
cancelToken: cancelTokenSrc?.token
signal: abortCtrl?.signal
};
axios(request)
.then(response => {
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/specs/components/ol/HoverController.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ describe('ol/HoverController.js', () => {
expect(comp.map).to.equal(map);
expect(comp.timerHandle).to.equal(null);
expect(comp.activeOverlayId).to.equal(null);
expect(comp.pendingRequestsCancelSrc).to.equal(null);
expect(comp.pendingRequestsAbortCtrl).to.equal(null);
expect(comp.conf.delay).to.equal(150)
expect(comp.conf.hideOnMousemove).to.equal(false)
expect(comp.conf.hoverOverlay).to.equal('wgu-hover-tooltip')
Expand Down
Loading