Deprecate MapChange and provide dedicated callback methods #9498

tobrun · 2017-07-13T12:43:39Z

This PR deprecates using OnMapChangeListeners and replaces them with dedicated callbacks.

Proposed API:

    void onCameraWillChange(boolean animated);
    void onCameraIsChanging();
    void onCameraDidChange(boolean animated);

    void onWillStartLoadingMap();
    void onDidFinishLoadingMap();
    void onDidFailLoadingMap(String errorMessage);

    void onWillStartRenderingFrame();
    void onDidFinishRenderingFrame(boolean partial);

    void onWillStartRenderingMap();
    void onDidFinishRenderingMap(boolean partial);

    void onDidFinishLoadingStyle();

    void onSourceChangedListener(String id);

Closes #8389 / refs #9476

ivovandongen

@tobrun I did a first review. There are a couple of issues that need to be addressed. Sorry for the "From mbgl::RendererBackend" comment in the header. This is misleading as it is not true anymore... :(

ivovandongen · 2017-07-18T15:30:35Z

platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapboxMap.java

@@ -184,21 +184,32 @@ void onPostMapReady() {
  /**
   * Called when the region is changing or has changed.


Is this javadoc still correct?

ivovandongen · 2017-07-18T15:39:45Z

platform/android/MapboxGLAndroidSDK/src/main/java/com/mapbox/mapboxsdk/maps/MapView.java

@@ -174,6 +175,9 @@ private void initialise(@NonNull final Context context, @NonNull final MapboxMap
    // notify Map object about current connectivity state
    nativeMapView.setReachability(ConnectivityReceiver.instance(context).isConnected(context));

+    // bind internal components for map change events
+    mapChangeDispatcher.bind(mapCallback = new MapChangeResultHandler(mapboxMap));


Would it somehow be feasible to make this a constructor argument? Since it is required. That would make it possible to skip a lot of null checks in MapChangeDispatcher

Been looking into it but don't think so at the moment though this clearly shows we need to rethink our architecture. The issue here is a cyclic class dependency: NativeMapview depends on MapChangeDispatcher, MapboxMap depends on NativeMapView and MapChangeDispatcher depends on MapboxMap.

Somewhere during initialization we need to bind them together and require us to have null checking. Current setup follows the requirement of being able to listen to map change events as soon as possible. I don't see an a issue with internal components missing out on the initialization change events.

ivovandongen · 2017-07-18T15:42:28Z

platform/android/src/native_map_view.cpp

@@ -54,14 +54,14 @@
 namespace mbgl {
 namespace android {

-NativeMapView::NativeMapView(jni::JNIEnv& _env,


Could you revert indentation changes?

ivovandongen · 2017-07-18T15:42:34Z

platform/android/src/native_map_view.cpp

-    : javaPeer(_obj.NewWeakGlobalRef(_env)),
-      pixelRatio(_pixelRatio),
-      threadPool(sharedThreadPool()) {
+        : javaPeer(_obj.NewWeakGlobalRef(_env)),


ivovandongen · 2017-07-18T15:42:48Z

platform/android/src/native_map_view.cpp

@@ -112,7 +112,7 @@ void NativeMapView::bind() {
 /**
 * From mbgl::RendererBackend.
 */
-gl::ProcAddress NativeMapView::initializeExtension(const char* name) {
+gl::ProcAddress NativeMapView::initializeExtension(const char *name) {


ivovandongen · 2017-07-18T15:43:08Z

platform/android/src/native_map_view.cpp

 *
 * May be called from any thread
 */
-void NativeMapView::notifyMapChange(mbgl::MapChange change) {


Please also remove the declaration here: https://github.com/mapbox/mapbox-gl-native/blob/master/platform/android/src/native_map_view.hpp#L67

ivovandongen · 2017-07-18T15:45:39Z

platform/android/src/native_map_view.cpp

+void NativeMapView::onDidFailLoadingMap(std::exception_ptr eptr) {
+    assert(vm != nullptr);
+    try {
+        std::rethrow_exception(eptr);


Do we want to throw an exception here? Seems like we always want to invoke the listener. If re-throwing is required, it should happen where the exception is produced.

rethrowing was a way of getting the string message for the listener, let me try a different approach.

the exception is produced in core in style_impl.cpp and passed to the MapObserver, which invokes the method above. Don't think I can move re-throwing up the chain as it would impact other bindings. The code for retrieving the exception message was based of http://en.cppreference.com/w/cpp/error/exception_ptr.

No, you're right. That's a valid way to do it. Should've read more carefully.

ivovandongen · 2017-07-18T15:49:27Z

platform/android/src/native_map_view.cpp

    javaPeer->Call(*_env, onInvalidate);
 }

 /**
- * From mbgl::RendererBackend. Callback to java NativeMapView#onMapChanged(int).
+ * From mbgl::RendererBackend. Callback to java NativeMapView#onCameraWillChange().


Actually. This is from MapObserver and will only be coming from the main (map) thread. Could you update the comment in the header file as well?

ivovandongen · 2017-07-18T15:50:22Z

platform/android/src/native_map_view.cpp

 void NativeMapView::onCameraIsChanging() {
-    notifyMapChange(MapChange::MapChangeRegionIsChanging);
+    assert(vm != nullptr);
+    android::UniqueEnv _env = android::AttachEnv();


As this is not actually coming from any other thread then the main/map thread, this is not needed.

I changed it to something as:

void NativeMapView::onDidFinishLoadingStyle() { JNIEnv* env = nullptr; int resultCode = vm->GetEnv(reinterpret_cast<void**>(&env), JNI_VERSION_1_6); if(resultCode == JNI_OK) { static auto onDidFinishLoadingStyle = javaClass.GetMethod<void()>(*env, "onDidFinishLoadingStyle"); javaPeer->Call(*env, onDidFinishLoadingStyle); } }

lmk if there is a better way of getting the env

ivovandongen · 2017-07-18T15:50:44Z

platform/android/src/native_map_view.cpp

    _createSurface(ANativeWindow_fromSurface(&env, jni::Unwrap(*_surface)));
 }

-void NativeMapView::destroySurface(jni::JNIEnv&) {


more formatting changes

tobrun · 2017-10-13T11:17:50Z

I redid this PR in light of moving to GLSurfaceView (reason this PR was on hold).
A couple of changes since previous iteration:

we allow multiple listeners to be registered (this was required for plugin development, else a user or a plugin could override an already set listener).
usage of AttachEnv to get a reference to the jni environment

ivovandongen

Looks good. The only thing is that I found the naming of MapChangeHandler and MapChangeDispatcher a little confusing while reading the PR. But since neither is public that will probably not be a problem.

ivovandongen · 2017-10-26T10:33:57Z

platform/android/src/native_map_view.cpp

+void NativeMapView::onDidFailLoadingMap(std::exception_ptr eptr) {
+    try {
+       if(eptr) {
+           std::rethrow_exception(eptr);


You can use https://github.com/mapbox/mapbox-gl-native/blob/master/include/mbgl/util/string.hpp#L52 instead.

tobrun · 2017-10-26T15:42:37Z

Thank you for the review @ivovandongen,
re using toString for the exception ptr, this has been fixed.
re naming: I merged the concepts of MapChangeDispatcher and MapChangeHandler into MapChangeEventManager, feel free propose any changes to the name.

tobrun · 2018-05-08T14:09:50Z

stale

tobrun added the Android Mapbox Maps SDK for Android label Jul 13, 2017

tobrun added this to the android-v5.2.0 milestone Jul 13, 2017

tobrun self-assigned this Jul 13, 2017

tobrun force-pushed the 8389-deprecate-notifyMapChange branch 4 times, most recently from 17a1012 to b28423d Compare July 18, 2017 10:31

tobrun requested a review from ivovandongen July 18, 2017 10:32

ivovandongen suggested changes Jul 18, 2017

View reviewed changes

tobrun force-pushed the 8389-deprecate-notifyMapChange branch 2 times, most recently from 3bf83d2 to 6122934 Compare July 19, 2017 12:15

tobrun mentioned this pull request Aug 17, 2017

Improve documentation for map events #8947

Closed

tobrun force-pushed the 8389-deprecate-notifyMapChange branch from 6122934 to 24b95fc Compare October 12, 2017 20:51

tobrun changed the base branch from master to release-agua October 12, 2017 20:52

tobrun force-pushed the 8389-deprecate-notifyMapChange branch 2 times, most recently from 8dea25d to be86668 Compare October 13, 2017 11:11

tobrun requested a review from zugaldia October 17, 2017 15:21

ivovandongen suggested changes Oct 26, 2017

View reviewed changes

tobrun force-pushed the 8389-deprecate-notifyMapChange branch from be86668 to 9e9f999 Compare October 26, 2017 15:37

[android] - deprecate onMapChange, provide dedicated callbacks

8847b41

tobrun force-pushed the 8389-deprecate-notifyMapChange branch from 9e9f999 to 8847b41 Compare October 26, 2017 15:53

lilykaiser removed this from the android-v5.2.0 milestone Nov 16, 2017

zugaldia requested review from LukasPaczos and removed request for zugaldia December 23, 2017 17:46

tobrun closed this May 8, 2018

tobrun deleted the 8389-deprecate-notifyMapChange branch July 23, 2018 12:32

tobrun mentioned this pull request Oct 8, 2018

Replace OnMapChange with specific callbacks #13050

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate MapChange and provide dedicated callback methods #9498

Deprecate MapChange and provide dedicated callback methods #9498

tobrun commented Jul 13, 2017 •

edited

Loading

ivovandongen left a comment

ivovandongen Jul 18, 2017

ivovandongen Jul 18, 2017

tobrun Jul 19, 2017

ivovandongen Jul 18, 2017

ivovandongen Jul 18, 2017

ivovandongen Jul 18, 2017

ivovandongen Jul 18, 2017

ivovandongen Jul 18, 2017

tobrun Jul 19, 2017

tobrun Jul 19, 2017

ivovandongen Jul 19, 2017

ivovandongen Jul 18, 2017

ivovandongen Jul 18, 2017

tobrun Jul 19, 2017

ivovandongen Jul 18, 2017

tobrun commented Oct 13, 2017

ivovandongen left a comment

ivovandongen Oct 26, 2017

tobrun commented Oct 26, 2017

tobrun commented May 8, 2018

		@@ -184,21 +184,32 @@ void onPostMapReady() {
		/**
		* Called when the region is changing or has changed.

Deprecate MapChange and provide dedicated callback methods #9498

Deprecate MapChange and provide dedicated callback methods #9498

Conversation

tobrun commented Jul 13, 2017 • edited Loading

ivovandongen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tobrun commented Oct 13, 2017

ivovandongen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tobrun commented Oct 26, 2017

tobrun commented May 8, 2018

tobrun commented Jul 13, 2017 •

edited

Loading