Update MapLibre GL JS

[wipfli]

I would like to update the MapLibre GL JS submodule to the latest 1.x version. This will probably affect the shaders and the style spec.

[wipfli]

Relevant files could be:

scripts/generate-shaders.js
scripts/generate-style-code.js
platform/ios/scripts/generate-shaders.js
platform/ios/scripts/generate-style-code.js
platform/ios/platform/darwin/scripts/generate-style-code.js
platform/android/scripts/generate-style-code.js
platform/android/scripts/generate-test-code.js

[wipfli]

This commit from @petr-pokorny-1 could be relevant: https://github.com/maplibre/maplibre-gl-native/commit/672f2d86556a10c7f086c1f2ab577969dfd511e4

[wipfli]

https://github.com/maplibre/maplibre-gl-native/pull/6/files shows some things from GL JS which are used in native...

[wipfli]

Lot's of testing stuff seems shared, @HarelM

[wipfli]

#339

[wipfli]

The commit hashes in the src/shaders folder before typescript are

eeefc070d7333b21b205be3882df9b2e3cd444d1
d8cf29023392b7de85b365cdc17e50ae263a357c
e27049d87be346a4f67ef6956a5113d977de63d8
aa6b4b2e51ac19156ba1537baf32a63551313612
58a73906d6f467762e486fcddf0643b27193ba89
842ea2e08f57dbc4c70537dc9988512439d05f9d
12991995fa1bb62c5ecdb0282c7c142578b897e5

[wipfli]

I would like to run the update-gl-js.yml action on those and see at what point stuff breaks...

[ntadej]

Can you also confirm that the same set of tests is ignored in JS than in native?

[wipfli]

In native, depending on the platform different tests are ignored. For a full list, see https://github.com/maplibre/maplibre-gl-native/tree/main/metrics/ignores

In GL JS, we might actually run all the render tests. See https://github.com/maplibre/maplibre-gl-js/blob/main/test/integration/render/render.test.ts ...

[wipfli]

@HarelM How do we handle ignored tests again in GL JS? I remember there was some discussion about removing ignored tests...

[wipfli]

eeefc070d7333b21b205be3882df9b2e3cd444d1 is in #360

[wipfli]

d8cf29023392b7de85b365cdc17e50ae263a357c is in #361

[wipfli]

e27049d87be346a4f67ef6956a5113d977de63d8 is in #362

[HarelM]

We removed ignored tests.

[louwers]

This seems like a difficult but important ticket. I assigned myself because I am going to spend some time looking into this, but don't let that hold anyone back working on this or assigning themselves as well.

[acalcutt]

Is this still only trying to get MapLibre GL JS to lastest in the 1.X branch and not the current main 2.x/3.x release? If it was going to 2.x I also wanted to note the path to tests seems to have changed. If it is just to 1.X this is not an issue (yet)

For example, in a linux build you can run tests with xvfb-run -a ./build/mbgl-render-test-runner --manifestPath metrics/macos-xcode11-release-style.json and it uses a bunch of tests from maplibre-gl-js\test\integration\render-tests

But in the current main branch of maplibre-gl-js that path has moved to maplibre-gl-js\test\integration\render\tests https://github.com/maplibre/maplibre-gl-js/tree/main/test/integration/render/tests

I know there was also some discussion of moving these tests into this project...so maybe this would be fixed by doing that.

[ntadej]

The biggest issue is that we've observed breakage of tests when trying to update the version even in the 1.X branch. See some of the old open MRs.

[wipfli]

The strategy should probably be to update the GL JS submodule commit by commit and make sure everything works every time. So you would first go from Mapbox v1.x in March 2020 (where it is now) to something near December 2020 (time or fork). This period has some new features in GL JS from Mapbox but not so many. Then you would follow MapLibre v1 until something like August 2021 (TypeScript and v2). This period has almost no new features from MapLibre. And finally, you would follow MapLibre v2 until today. This time period also has very few new features.

So the good news is that there is some work to be done around tooling, but the style spec did not change much since March 2020 and so there is not that crazy much work to be done feature-wise...

[louwers]

$ cd maplibre-gl-js
$ git rev-list HEAD^..$(git rev-list -n 1 "v1.14.0") | wc -l
189

188 commits until v1.14.0

I am looking what kind of issues we run into and will make more issues for the milestone.

[louwers]

Note that the workflow does not run

platform/android/scripts/generate-style-code.js
platform/android/scripts/generate-test-code.js

https://github.com/maplibre/maplibre-gl-native/blob/main/.github/workflows/update-gl-js.yml

[louwers]

Change of plans. https://github.com/maplibre/maplibre-gl-native/pull/938