Check for duplicate layer IDs #7257

ivovandongen · 2016-12-01T10:21:15Z

mention-bot · 2016-12-01T10:21:17Z

@ivovandongen, thanks for your PR! By analyzing this pull request, we identified @jfirebaugh, @boundsj and @tmpsantos to be potential reviewers.

ivovandongen · 2016-12-01T10:35:25Z

cc @1ec5 @jfirebaugh

1ec5 · 2016-12-01T10:49:30Z

platform/darwin/src/MGLStyle.mm

@@ -190,7 +190,11 @@ - (void)addLayer:(MGLStyleLayer *)layer
         layer];
    }

-    self.mapView.mbglMap->addLayer(std::unique_ptr<mbgl::style::Layer>(layer.layer));
+    try {
+        self.mapView.mbglMap->addLayer(std::unique_ptr<mbgl::style::Layer>(layer.layer));


What about the other addLayer() call in this class? (There’s also one in MGLMapView.mm, but that’ll go away as part of #7250.)

Added (tests) for MGLStyle#insertLayer and and MGLMapView#insertCustomStyleLayerWithIdentifier.

1ec5 · 2016-12-01T10:56:36Z

platform/darwin/src/MGLStyle.mm

+    try {
+        self.mapView.mbglMap->addLayer(std::unique_ptr<mbgl::style::Layer>(layer.layer));
+    } catch (std::runtime_error & err) {
+        [NSException raise:@"Could not add layer" format:@"%s", err.what()];


This reminds me that we need to be more disciplined about exception names in the SDK: #7258. (Not required for this PR.)

1ec5 · 2016-12-01T10:58:16Z

platform/ios/test/MGLLayerTests.m

@@ -0,0 +1,25 @@
+#import "MGLMapViewTests.h"


Since this file isn’t specific to iOS, it should live in platform/darwin/test/ and also be included in macos.xcodeproj. (This is the theme of our contributing documentation, although we neglected to point out that tests should be shared too when possible.)

Moved the files and added to macos as well. Excluded the custom layer tests for macos as the header is ios specific. Also changed the source test according to #7203 (comment)

That’s fine; the custom style layer API is getting folded into the normal style layer API in #7250, so soon there won’t be anything extra to test.

1ec5

Looks great!

Once we merge release-ios-v3.4.0 back to master, the particular call sites you’re wrapping in try-catch blocks will be replaced by new call sites in MGLStyle and the various MGLStyleLayer classes, due to #6793, #6793, #6097, and #7250. So we’ll need to be vigilant with that merge.

/cc @boundsj

1ec5 · 2016-12-01T17:02:19Z

platform/darwin/test/MGLLayerTests.m

+    MGLCustomStyleLayerPreparationHandler preparationHandler = ^{};
+    MGLCustomStyleLayerDrawingHandler drawingHandler = ^(CGSize size, CLLocationCoordinate2D centerCoordinate, double zoomLevel, CLLocationDirection direction, CGFloat pitch, CGFloat perspectiveSkew) {
+    };
+    MGLCustomStyleLayerCompletionHandler completionHander = ^{};


FYI, feel free to inline these blocks into the method call. Long lines are par for the course in Objective-C. 😉

1ec5 · 2016-12-01T17:09:21Z

The iOS test failure appears to be what I fixed in #7228 on the release-ios-v3.4.0 branch.

ivovandongen · 2016-12-02T10:20:37Z

The iOS test failure appears to be what I fixed in #7228 on the release-ios-v3.4.0 branch.

@1ec5 Could you merge this into master so I can rebase this pr on it?

1ec5 · 2016-12-04T03:28:44Z

platform/darwin/src/MGLStyle.mm

@@ -211,7 +215,11 @@ - (void)insertLayer:(MGLStyleLayer *)layer belowLayer:(MGLStyleLayer *)otherLaye
    }

    const mbgl::optional<std::string> belowLayerId{otherLayer.identifier.UTF8String};
-    self.mapView.mbglMap->addLayer(std::unique_ptr<mbgl::style::Layer>(layer.layer), belowLayerId);
+    try {
+        self.mapView.mbglMap->addLayer(std::unique_ptr<mbgl::style::Layer>(layer.layer), belowLayerId);


Now that #7282 has landed – including the changes in #6793, #6793, #6097, and #7250 – you’ll need to wrap any call to -[MGLStyleLayer addToMapView:] in this try-catch block or alternatively move this try-catch block to every implementation of -addToMapView: in the concrete subclasses of MGLStyleLayer.

ivovandongen · 2016-12-06T10:54:02Z

@1ec5 I've rebased and updated the ios handling/tests: c005962

1ec5

Once #7250 lands, we’ll want to push these try-catch blocks into -addToMapView:belowLayer: and -removeFromMapView:, and the separate code path for custom layers will go away, but this is the best we can do for now.

1ec5 · 2016-12-06T16:02:19Z

platform/ios/src/MGLMapView.mm

+                                                                      MGLDrawCustomStyleLayer, MGLFinishCustomStyleLayer, context),
+                           otherIdentifier ? mbgl::optional<std::string>(otherIdentifier.UTF8String) : mbgl::optional<std::string>());
+    } catch (std::runtime_error & err) {
+        [NSException raise:@"MGLRedundantLayerIdentiferException" format:@"%s", err.what()];


I just realized we’ve been saying “identifer” instead of “identifier”, both for layers and sources. I can fix that typo in a separate PR, since we also need to add a note to the documentation for the affected methods about MGLRedundantLayerIdentifierException (prior art involving sources).

If you’re in a good spot to do it, can you rename MGLRedundantLayerIdentiferException to MGLRedundantLayerIdentiferException? I don’t think we have any instances of it in the release branch, so this is a good branch to do it in. I can take care of MGLRedundantSourceIdentiferException separately: #7314.

ivovandongen · 2016-12-06T16:29:47Z

@kkaefer I've added the backend guard in 3f0c6c8 as you suggested and made activate/deactivate protected.

kkaefer · 2016-12-07T09:53:48Z

platform/darwin/src/MGLStyle.mm

-    [layer addToMapView:self.mapView];
+    try {
+        [layer addToMapView:self.mapView];
+    } catch (std::runtime_error & err) {


We're catching a generic exception here, but always forward a MGLRedundantLayerIdentifierException. What we should do long term is to convert all of the generic std::runtime_error into individual exception types, and to exception-specific catches that we can then forward.

kkaefer · 2016-12-07T09:54:13Z

src/mbgl/style/style.cpp

@@ -198,6 +198,16 @@ Layer* Style::getLayer(const std::string& id) const {
 Layer* Style::addLayer(std::unique_ptr<Layer> layer, optional<std::string> before) {
    // TODO: verify source

+    //Guard against duplicate layer ids


Code style is to have a space after //.

kkaefer · 2016-12-07T09:55:33Z

src/mbgl/style/style.cpp

+
+    if (it != layers.end()) {
+        std::string msg = "Layer " + layer->getID() + " already exists";
+        throw std::runtime_error(msg.c_str());


no need to to c_str() here; std::runtime_error also accepts std::string. You could change this to something like this;

throw std::runtime_error(std::string{"Layer "} + layer->getID() + " already exists");

kkaefer · 2016-12-07T09:56:17Z

test/style/style_layer.test.cpp

+        style.addLayer(std::make_unique<LineLayer>("line", "unusedsource"));
+        FAIL() << "Should not have been allowed to add a duplicate layer id";
+    } catch (std::runtime_error) {
+        //Expected


Check message here

kkaefer · 2016-12-07T09:57:24Z

test/style/style_layer.test.cpp

+    try {
+        style.addLayer(std::make_unique<LineLayer>("line", "unusedsource"));
+        FAIL() << "Should not have been allowed to add a duplicate layer id";
+    } catch (std::runtime_error) {


The rule for exceptions in C++ is to throw by value and catch a const reference

kkaefer · 2016-12-07T09:57:44Z

platform/darwin/src/MGLStyle.mm

-        [styleLayer addToMapView:self.mapView];
+        try {
+            [styleLayer addToMapView:self.mapView];
+        } catch (std::runtime_error & err) {


kkaefer · 2016-12-07T09:58:12Z

platform/darwin/test/MGLStyleTests.mm

+    XCTAssertThrowsSpecificNamed([self.mapView.style insertLayer:[[MGLFillStyleLayer alloc] initWithIdentifier:@"my-layer" source:source] aboveLayer:initial], NSException, @"MGLRedundantLayerIdentifierException");
+    XCTAssertThrowsSpecificNamed([self.mapView.style insertLayer:[[MGLFillStyleLayer alloc] initWithIdentifier:@"my-layer" source:source] atIndex:0], NSException, @"MGLRedundantLayerIdentifierException");
+
+    #if TARGET_OS_IPHONE


Macros are not indented

ivovandongen · 2016-12-07T16:43:22Z

@kkaefer Thanks for the review, I've addressed your notes.

ivovandongen added Core The cross-platform C++ core, aka mbgl ⚠️ DO NOT MERGE Work in progress, proof of concept, or on hold labels Dec 1, 2016

ivovandongen self-assigned this Dec 1, 2016

ivovandongen force-pushed the 7254-duplicate-layers branch from 43008a0 to 9f71100 Compare December 1, 2016 10:34

ivovandongen removed the ⚠️ DO NOT MERGE Work in progress, proof of concept, or on hold label Dec 1, 2016

1ec5 suggested changes Dec 1, 2016

View reviewed changes

ivovandongen force-pushed the 7254-duplicate-layers branch 4 times, most recently from 1008bbe to 89bfd97 Compare December 1, 2016 14:14

1ec5 approved these changes Dec 1, 2016

View reviewed changes

boundsj mentioned this pull request Dec 2, 2016

Crash when changing styleURL if there is an empty datasource? #7124

Closed

ivovandongen force-pushed the 7254-duplicate-layers branch from 89bfd97 to d0cb5fa Compare December 2, 2016 10:18

1ec5 suggested changes Dec 4, 2016

View reviewed changes

ivovandongen force-pushed the 7254-duplicate-layers branch 2 times, most recently from 04cbd5b to c005962 Compare December 6, 2016 10:53

ivovandongen force-pushed the 7254-duplicate-layers branch from c005962 to 93b5ea0 Compare December 6, 2016 12:48

1ec5 approved these changes Dec 6, 2016

View reviewed changes

ivovandongen force-pushed the 7254-duplicate-layers branch from 93b5ea0 to 617d3e4 Compare December 6, 2016 16:25

1ec5 mentioned this pull request Dec 6, 2016

Misspelled exception name when reusing source identifier #7314

Closed

ivovandongen force-pushed the 7254-duplicate-layers branch from 617d3e4 to 1ed3ff1 Compare December 7, 2016 09:34

kkaefer suggested changes Dec 7, 2016

View reviewed changes

ivovandongen added 2 commits December 7, 2016 17:42

[core] use raii to guard backend deactivation

a1cf025

[core] guard against duplicate layer ids

2b7ccf1

ivovandongen added 2 commits December 7, 2016 17:42

[android] test duplicate layer id exception handling

daa39cf

[ios, macos] handle duplicate layer error

57b0ba7

ivovandongen force-pushed the 7254-duplicate-layers branch from 1ed3ff1 to 57b0ba7 Compare December 7, 2016 16:42

kkaefer approved these changes Dec 12, 2016

View reviewed changes

ivovandongen merged commit e9f101a into master Dec 12, 2016

ivovandongen deleted the 7254-duplicate-layers branch December 12, 2016 14:05

boundsj mentioned this pull request Dec 12, 2016

Cherry pick 7257 into iOS 3.4.0 release branch #7394

Merged

1ec5 mentioned this pull request Jan 27, 2017

Replace std::runtime_error usage with more specialized exceptions #7890

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Check for duplicate layer IDs #7257

Check for duplicate layer IDs #7257

ivovandongen commented Dec 1, 2016

mention-bot commented Dec 1, 2016

ivovandongen commented Dec 1, 2016

1ec5 Dec 1, 2016 •

edited

Loading

ivovandongen Dec 1, 2016

1ec5 Dec 1, 2016

1ec5 Dec 1, 2016

ivovandongen Dec 1, 2016

1ec5 Dec 1, 2016

1ec5 left a comment

1ec5 Dec 1, 2016

1ec5 commented Dec 1, 2016

ivovandongen commented Dec 2, 2016

1ec5 Dec 4, 2016 •

edited

Loading

ivovandongen commented Dec 6, 2016

1ec5 left a comment

1ec5 Dec 6, 2016

1ec5 Dec 6, 2016

ivovandongen commented Dec 6, 2016

kkaefer Dec 7, 2016

kkaefer Dec 7, 2016

kkaefer Dec 7, 2016

kkaefer Dec 7, 2016

kkaefer Dec 7, 2016

kkaefer Dec 7, 2016

kkaefer Dec 7, 2016

ivovandongen commented Dec 7, 2016

Check for duplicate layer IDs #7257

Check for duplicate layer IDs #7257

Conversation

ivovandongen commented Dec 1, 2016

mention-bot commented Dec 1, 2016

ivovandongen commented Dec 1, 2016

1ec5 Dec 1, 2016 • edited Loading

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

1ec5 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1ec5 commented Dec 1, 2016

ivovandongen commented Dec 2, 2016

1ec5 Dec 4, 2016 • edited Loading

Choose a reason for hiding this comment

ivovandongen commented Dec 6, 2016

1ec5 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ivovandongen commented Dec 6, 2016

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

ivovandongen commented Dec 7, 2016

1ec5 Dec 1, 2016 •

edited

Loading

1ec5 Dec 4, 2016 •

edited

Loading