Script authors: the Waze object is going to be removed!

In about two months time, the Waze object we use in a lot of scripts is going to be removed from the map editor. The shorthand counterpart “W” will remain available though. All scripts that rely on the Waze object (which will be most scripts, I estimate) will need to replace all references to Waze with W. Luckily, this is but a simple find & replace action to perform.

This can be done now and should be done as soon as possible. I’ll try to contact the script authors of the most prominent scripts next weekend. I propose we’ll whip up a spreadsheet in which we detail the current status of all scripts (I’ll work on that later today as well, though I’ll need help with that as it’s a big task).

For older scripts where the author is no longer active, I’ll provide a very simple userscript that fixes this. The script just needs to be executed before the other scripts run, but that shouldn’t be an issue. I’ll put that up later today.

EDIT: I’d advise to replace any reference to OpenLayers to OL as well while we’re at it. While this isn’t announced as something that will be cleaned up, it seems like a good bet to me.

2 Likes

This script can be used to reinstate the Waze object when it gets deprecated: https://greasyfork.org/scripts/38782-wme-waze-object-fixer This script has to be executed once before the broken scripts, so you may need to adjust the order of script in the list.

Ideally we won’t need it for any scripts, but now it’s there nonetheless.

Also, here’s the spreadsheet with an overview of several scripts (work in progress): https://docs.google.com/spreadsheets/d/1dKSlpNadVG7EQ8wFhpUkjJoGDpsH2Lgt65RIKofjjsg/edit?usp=sharing

EDIT: the spreadsheet is pretty much done now. There are probably still a few scripts missing from the list, but the list retrieved from the Discord channel (as suggested by mapomatic) helped a lot. Also thanks to JustinS83 who helped out with the spreadsheet!

2 Likes

Whilst this means a fair bit of work overall to update all the affected scripts, it’s about time we finally got an answer to the question I suspect many scripters have been asking for in some cases quite some time now - just what is the point of having both W. and Waze., and which one should we be using to minimise the risk of seeing one of them suddenly disappear in a future WME update…

So thanks to the devteam for NOT just springing this on us as an unpleasant surprise, and thanks to Glodenox for acting as coordinator here!

You can add WME FixUI to your spreadsheet as fixed. :mrgreen:

URO+ can also be crossed off the list…

1 Like

21 out of 49 tracked scripts have already been fixed. Thanks everybody for reacting so quickly! There’s still quite a bit of work to do, but we’re getting there :slight_smile:

My scripts listed in the spreadsheet have been updated. Thanks for driving this effort, Glodenox!

Also, WME Open In Mapillary was deleted. I’ve removed it from the original script spreadsheet.

Thanks for that! I still noticed a reference to Waze in the Route Speeds script, but it won’t break the script once the Waze object gets removed.

1 Like

Oops - my fault, missed that one. Been updated now.

1 Like

37 out of the 50 scripts we’re tracking have been fixed by now! A couple of these will never be fixed as their original author has become inactive, but usually those scripts weren’t working 100% already before, so they have usually already been forked by someone else. I also found that a couple of scripts were adjusted, but overlooked a reference or two. I’ll contact those script authors in the coming days (or they can see the note in the spreadsheet) so we won’t run into surprises.

I’m honestly amazed at how quickly we were able to process this change! Good job everyone!

I just had a look through the spreadsheet at the scripts marked as being Chrome extensions only.

WME Aerial Shifter definitely has references to Waze and OpenLayers. I’m surprised it still works, given that Berestovvsky has been away for so long. The same function is available in WME FixUI.

WME JNF. This seems to use W by default but then tries Waze if W isn’t found. However, on line 32 there is a definite reference to the Waze object. No references to OpenLayers.

WME PL Cleaner has no references to Waze or OpenLayers. Given that Justin’s well on top of these changes, I’m sure he would have fixed it by now it there were. :smiley:

WME Toolbox. It looks like it’s OK, but there could be something buried in the obfuscated code.

Correct - it does not interact with WME at all so nothing to change :slight_smile:

I integrated WME Roundabout Angles into WME RA Util as well since the original (and replacement) author are inactive so it will not be updated.

Should Aerial Shifter be removed from the sheet (as you said, it has not had an update since 2016, and the functionality now exists in WMEFU)?

Not sure if he has reported to you yet but, https://github.com/jangliss/WMETXDOTPlanning should be added to the sheet and has already been updated by jangliss

It occurs to me that, whilst you’re tracking scripts updated for the change in the object model, it might be worth checking the same scripts for whether they deal with the missing “/” on the editor URL. Some of my favourites still need it to work and this would be a good opportunity to try and put an end to that problem. :mrgreen:

That’s a good idea, though that issue isn’t as blocking as the issue with the Waze object. I think I’m going to use a separate topic for that, just so the discussion won’t get mixed up. There was already a topic that notified the script authors, but it would indeed be better to really contact the script authors whose scripts are still requiring a slash at the end of the URL.

Guess I should mention Wide-Angle Lens has been updated to use W and OL

Thanks for that!

With a couple of weeks left to go (even though I assume it won’t be exactly 2 months), there are about 10 scripts remaining. About 40 scripts were adjusted for this change, which is great news :slight_smile:

1 Like

I just went through the list again and there are still some scripts that haven’t been changed. The following scripts seem to still check for the presence of the Waze object or actively use the Waze object instead of the W object:
WME Aerial Shifter
WME Chat addon
WME Color Highlights
WME PlaceNames
WME Roundabout Angles
WME Route Checker
WME Speedlimits
WME UR-MP Tracking

For now these will continue to work correctly as Waze has implemented a proxy for the Waze object, which still seems to be present in the latest beta version, but it’s very likely these will fail later on.