Update to Maps SDK for iOS v4.0.0 #1076

bsudekum · 2018-01-26T23:53:09Z

This PR updates to the Mapbox Maps for iOS dependency to v4.0.0.

todo:

Blocked by mapbox/mapbox-gl-native#11615.

/cc @mapbox/navigation-ios

1ec5

I’m impressed that you got this far with the rudimentary state of NSExpression in the map SDK. 👍 There’s a lot more room for concision; I think this PR, as written, points to improvements we can make in our expression documentation and especially the expression migration guide we’re preparing.

/cc @jmkiley

1ec5 · 2018-01-27T02:06:46Z

MapboxNavigation.podspec

@@ -44,7 +44,7 @@ Pod::Spec.new do |s|
  s.module_name = "MapboxNavigation"

  s.dependency "MapboxCoreNavigation", "#{s.version.to_s}"
-  s.dependency "Mapbox-iOS-SDK", "~> 3.6"
+  s.dependency "Mapbox-iOS-SDK", "4.0.0-beta.1"


Remember to update the Cartfile and MapboxNavigation-Documentation.podspec before merging.

1ec5 · 2018-01-27T02:08:02Z

MapboxNavigation/NavigationMapView.swift

-    19: MGLStyleValue(rawValue: 22),
-    22: MGLStyleValue(rawValue: 28)
+
+let routeLineWidthAtZoomLevels: [Int: NSExpression] = [


No need to wrap these constant values in NSExpression. The dictionary can be [Int: Float] or [Int: Int], which also means you don’t need to declare the type, either.

1ec5 · 2018-01-27T02:11:37Z

MapboxNavigation/NavigationMapView.swift

+    13: NSExpression(forConstantValue: 9),
+    16: NSExpression(forConstantValue: 11),
+    19: NSExpression(forConstantValue: 22),
+    22: NSExpression(forConstantValue: 28)


@anandthakker, currently, it isn’t possible for a zoom expression ($zoomLevel) to appear outside a curve or interpolation. But would it be feasible to relax this restriction, so that this curve could be expressed as a single multiplication expression involving $zoomLevel?

Technically, it would be possible to relax the restriction on zoom expressions to:

If the expression is a zoom-only expression, no restrictions at all.

If the expression is also feature-dependent, it must be in the form F(zoom) * G(feature), where F is a step or interpolation expression using zoom as the input (and nowhere else), and G is not zoom-dependent.

We've chosen so far to go with the existing, less permissive restriction because it's so much simpler to understand. I think the above, which is maximally permissive (barring significant changes to the data-driven styling implementation), is likely way too complicated. We could go for something in between, but it'll be tricky to decide just where to draw the line.

1ec5 · 2018-01-27T02:12:50Z

MapboxNavigation/NavigationMapView.swift

-                arrow.lineColor = MGLStyleValue(rawValue: .white)
+                arrow.lineCap = NSExpression(forConstantValue: cap)
+                arrow.lineJoin = NSExpression(forConstantValue: join)
+                arrow.lineWidth = NSExpression(format: "FUNCTION($zoomLevel, 'mgl_interpolateWithCurveType:parameters:stops:', 'linear', nil, %@)", argumentArray: [routeLineWidthAtZoomLevels.multiplied(by: 1.5)])


Instead of calling multiplied(by:) on the array, multiply the FUNCTION call by 1.5 inside the format string.

1ec5 · 2018-01-27T02:14:06Z

MapboxNavigation/NavigationMapView.swift

-                arrow.lineColor = MGLStyleValue(rawValue: .white)
+                arrow.lineCap = NSExpression(forConstantValue: cap)
+                arrow.lineJoin = NSExpression(forConstantValue: join)
+                arrow.lineWidth = NSExpression(format: "FUNCTION($zoomLevel, 'mgl_interpolateWithCurveType:parameters:stops:', 'linear', nil, %@)", argumentArray: [routeLineWidthAtZoomLevels.multiplied(by: 1.5)])


Since you know in advance how many arguments this format string needs, use NSExpression(format:) instead of NSExpression(format:argumentArray:). The first argument to NSExpression(format:) takes a comma-separated list of arguments following the format string.

1ec5 · 2018-01-27T02:15:13Z

MapboxNavigation/NavigationMapView.swift

-                                                      cameraStops: routeLineWidthAtZoomLevels.multiplied(by: 0.80),
-                                                      options: [.defaultValue : MGLConstantStyleValue<NSNumber>(rawValue: 1.5)])
-                arrowStroke.lineColor = MGLStyleValue(rawValue: .defaultArrowStroke)
+                arrowStroke.lineCap = NSExpression(forConstantValue: cap)


NSExpression(forConstantValue: "cap") or NSExpression(format: "'cap'") is also allowed now, although what you’ve got is also perfectly fine if you want compile-time validation.

1ec5 · 2018-01-27T02:17:15Z

MapboxNavigation/NavigationMapView.swift

-        lineCasing.lineJoin = MGLStyleValue(rawValue: NSValue(mglLineJoin: .round))
-        lineCasing.lineOpacity = MGLStyleValue(rawValue: 0.9)
+        lineCasing.lineColor = NSExpression(forConstantValue: routeAlternateColor)
+        lineCasing.lineCap = NSExpression(forConstantValue: NSValue(mglLineCap: .round))


I think you can say something like MGLLineCap.round as NSValue instead of calling NSValue(mglLineCap:). NSExpression(forConstantValue: "round") and NSExpression(format: "'round'") are also options.

1ec5 · 2018-01-27T02:19:15Z

MapboxNavigation/NavigationMapView.swift

-        symbol.textFontSize = MGLStyleValue(rawValue: 10)
-        symbol.textHaloWidth = MGLStyleValue(rawValue: 0.25)
-        symbol.textHaloColor = MGLStyleValue(rawValue: .black)
+        symbol.text = NSExpression(forConstantValue: "{name}")


Pretty sure mapbox/mapbox-gl-native#10399 will prevent the legacy {token} syntax from working inside an expression. Use a key path expression instead: NSExpression(forKeyPath: "name") or NSExpression(format: "name").

Use a key path expression instead: NSExpression(forKeyPath: "name") or NSExpression(format: "name").

/ref #1076 (comment)

1ec5 · 2018-01-27T02:21:30Z

MapboxNavigation/NavigationMapView.swift

+            "heavy": NSExpression(forConstantValue: trafficHeavyColor),
+            "severe": NSExpression(forConstantValue: trafficSevereColor)
+            ])
+        line.lineOpacity = NSExpression(format: "FUNCTION($currentLegAttribute, 'mgl_interpolateWithCurveType:parameters:stops:', 'linear', nil, %@)", [


$currentLegAttribute would be a reference to an expression variable declared with mgl_expressionWithContext:. Use currentLegAttribute, without the dollar sign, to refer to an attribute of the current feature.

Actually, currentLegAttribute is the name of this variable. You have two options: either insert a key path expression created from the variable:

NSExpression(format: "FUNCTION(%@, 'mgl_interpolateWithCurveType:parameters:stops:', 'linear', nil, %@)", NSExpression(forKeyPath: currentLegAttribute), …)

or inline the key path and delete currentLegAttribute:

NSExpression(format: "FUNCTION(isCurrentLeg, 'mgl_interpolateWithCurveType:parameters:stops:', 'linear', nil, %@)", …)

1ec5 · 2018-01-27T04:42:04Z

MapboxNavigation/NavigationMapView.swift

+        line.lineOpacity = NSExpression(format: "FUNCTION($currentLegAttribute, 'mgl_interpolateWithCurveType:parameters:stops:', 'linear', nil, %@)", [
+            true: 1,
+            false: 0
+            ])


As a Boolean attribute, isCurrentLeg can have only two possible values, true and false, so a full stop dictionary is overkill. With an expression, you can express a condition directly:

NSExpression(format: "TERNARY(isCurrentLeg = true, 1, 0)")

or:

NSExpression(forConditional: NSPredicate(format: "isCurrentLeg = true"), true: 1, false: 0)

Then again, the usual way to accomplish this effect in a style is to let each line know which leg index it represents and add two layers to the style, one for the active leg and another for the inactive legs.

Both layers would have constant opacities. The filters (predicates) for the two layers would be updated every time the leg index changes:

activeLegLayer.predicate = NSPredicate(format: "legIndex = %@", routeProgess.legIndex) inactiveLegLayer.predicate = NSPredicate(format: "legIndex != %@", routeProgress.legIndex)

bsudekum · 2018-02-23T16:50:49Z

This is currently blocked upstream by mapbox/mapbox-gl-native#11277 & mapbox/mapbox-gl-native#10849

bsudekum · 2018-04-03T20:51:44Z

MapboxNavigation/NavigationMapView.swift

-        line.lineJoin = MGLStyleValue(rawValue: NSValue(mglLineJoin: .round))
+        line.lineWidth = NSExpression(format: "FUNCTION($zoomLevel, 'mgl_interpolateWithCurveType:parameters:stops:', 'linear', nil, %@)", argumentArray: [MBRouteLineWidthByZoomLevel])
+        line.lineOpacity = NSExpression(forConditional: NSPredicate(format: "\(MBCurrentLegAttribute) == true"), trueExpression: NSExpression(forConstantValue: 1), falseExpression: NSExpression(forConstantValue: 0.85))
+        line.lineColor = NSExpression(format: "%@.severe", [


@anandthakker @1ec5 this is failing with

Assertion failed: (literal), function operator(), file /Users/distiller/project/include/mbgl/style/conversion/data_driven_property_value.hpp, line 50.

@bsudekum @1ec5 could we dump the json expression representation that's getting produced by this NSExpression?

This expression assumes all traffic is severe. The format should be:

NSExpression(format: "FUNCTION(%@, 'valueForKeyPath:', congestion)")

Alternatively, use an MGL_MATCH expression:

NSExpression(format: "MGL_MATCH(congestion, 'unknown', %@, 'low', %@, 'moderate', %@, …)")

We can get the JSON expression representation via NSExpression.mgl_jsonExpressionObject(). It might be worth printing that out as part of the exception handler. Currently, the exception handler is in code that only knows about mbgl expressions, not NSExpression.

This is an expression parsing bug -- reopened here: mapbox/mapbox-gl-native#10849

1ec5 · 2018-04-03T20:58:18Z

MapboxNavigation/Constants.swift

-    19: MGLStyleValue(rawValue: 22),
-    22: MGLStyleValue(rawValue: 28)
+public let MBRouteLineWidthByZoomLevel: [Int: NSExpression] = [
+    10: NSExpression(forConstantValue: 8),


Pretty sure these don’t need to be NSExpressions; they can be bare Floats or NSNumbers.

1ec5 · 2018-04-03T21:00:14Z

MapboxNavigation/Dictionary.swift

-            newCameraStop[stop.key] = MGLStyleValue<NSNumber>(rawValue: NSNumber(value:newValue))
+        var newCameraStop: [Int: NSExpression] = [:]
+        for stop in self {
+            let currentValue = stop.value.constantValue as! Double


Note that this will crash if the dictionary contains any expression that isn’t a constant value. Since this is a public extension on Dictionary, we have to assume the developer is going to try to use it wherever the compiler lets them.

I continue to believe we should make this method private or remove it outright. A few explicit multiplications won’t greatly inconvenience the developer.

1ec5 · 2018-04-03T21:02:15Z

MapboxNavigation/NavigationMapView.swift

-
+                arrow.lineCap = NSExpression(forConstantValue: "cap")
+                arrow.lineJoin = NSExpression(forConstantValue: "join")
+                arrow.lineWidth = NSExpression(format: "FUNCTION($zoomLevel, 'mgl_interpolateWithCurveType:parameters:stops:', 'linear', nil, %@)", argumentArray: [MBRouteLineWidthByZoomLevel.multiplied(by: 0.70)])


The syntax has now changed to mgl_interpolate:withCurveType:parameters:stops:($zoomLevel, 'linear', nil, %@). (×7)

1ec5 · 2018-04-03T21:03:52Z

MapboxNavigation/NavigationMapView.swift

-                arrowSymbolLayer.iconAllowsOverlap = MGLStyleValue(rawValue: true)
+                arrowSymbolLayer.iconImageName = NSExpression(forConstantValue: "triangle-tip-navigation")
+                arrowSymbolLayer.iconColor = NSExpression(forConstantValue: UIColor.white)
+                arrowSymbolLayer.iconRotationAlignment = NSExpression(forConstantValue: NSValue(mglIconRotationAlignment: .map))


Simplify this to NSExpression(forConstantValue: "map") for consistency. (×2)

1ec5 · 2018-04-03T21:06:24Z

MapboxNavigation/NavigationMapView.swift

-                arrowSymbolLayerCasing.iconAllowsOverlap = MGLStyleValue(rawValue: true)
+                arrowSymbolLayerCasing.iconImageName = NSExpression(forConstantValue: "triangle-tip-navigation")
+                arrowSymbolLayerCasing.iconColor = NSExpression(forConstantValue: UIColor.defaultArrowStroke)
+                arrowSymbolLayerCasing.iconRotationAlignment = NSExpression(forConstantValue: NSValue(mglIconRotationAlignment: .map))


Reduce repetition by saying, for example:

arrowSymbolLayerCasing.iconRotationAlignment = arrowSymbolLayer.iconRotationAlignment

1ec5 · 2018-04-03T21:08:16Z

MapboxNavigation/NavigationMapView.swift

-        symbol.textFontSize = MGLStyleValue(rawValue: 10)
-        symbol.textHaloWidth = MGLStyleValue(rawValue: 0.25)
-        symbol.textHaloColor = MGLStyleValue(rawValue: .black)
+        symbol.text = NSExpression(forConstantValue: "{name}")


Use a key path expression instead: NSExpression(forKeyPath: "name") or NSExpression(format: "name").

/ref #1076 (comment)

1ec5 · 2018-04-03T21:13:14Z

MapboxNavigation/NavigationMapView.swift

-        line.lineJoin = MGLStyleValue(rawValue: NSValue(mglLineJoin: .round))
+        line.lineWidth = NSExpression(format: "FUNCTION($zoomLevel, 'mgl_interpolateWithCurveType:parameters:stops:', 'linear', nil, %@)", argumentArray: [MBRouteLineWidthByZoomLevel])
+        line.lineOpacity = NSExpression(forConditional: NSPredicate(format: "\(MBCurrentLegAttribute) == true"), trueExpression: NSExpression(forConstantValue: 1), falseExpression: NSExpression(forConstantValue: 0.85))
+        line.lineColor = NSExpression(format: "%@.severe", [


This expression assumes all traffic is severe. The format should be:

NSExpression(format: "FUNCTION(%@, 'valueForKeyPath:', congestion)")

Alternatively, use an MGL_MATCH expression:

NSExpression(format: "MGL_MATCH(congestion, 'unknown', %@, 'low', %@, 'moderate', %@, …)")

1ec5 · 2018-04-03T21:13:38Z

MapboxNavigation/NavigationMapView.swift

-                }
-            }
+
+// TODO:


Is this still to do?

1ec5 · 2018-04-04T21:35:14Z

MapboxNavigation/NavigationMapView.swift

@@ -672,7 +672,7 @@ open class NavigationMapView: MGLMapView, UIGestureRecognizerDelegate {
                arrowSymbolLayerCasing.minimumZoomLevel = minimumZoomLevel
                arrowSymbolLayerCasing.iconImageName = NSExpression(forConstantValue: "triangle-tip-navigation")
                arrowSymbolLayerCasing.iconColor = NSExpression(forConstantValue: UIColor.defaultArrowStroke)
-                arrowSymbolLayerCasing.iconRotationAlignment = NSExpression(forConstantValue: NSValue(mglIconRotationAlignment: .map))
+                arrowSymbolLayerCasing.iconRotationAlignment = arrowSymbolLayer.iconRotationAlignment


The idea behind #1076 (comment) was that we’d do the same thing for the dozens of other properties in this file.

1ec5 · 2018-04-04T21:36:17Z

MapboxNavigation/NavigationMapView.swift

-                "severe": trafficSevereColor
-            ])
-
+        line.lineColor = NSExpression(format: "MGL_MATCH(congestion, 'unknown', %@, 'low' , %@, 'moderate', %@, 'heavy', %@, 'severe', %@, %@)", trafficUnknownColor, trafficLowColor, trafficModerateColor, trafficHeavyColor, trafficSevereColor, UIColor.purple)


Remove the case for unknown and make trafficUnknownColor the fallback.

1ec5 · 2018-04-06T05:11:28Z

MapboxNavigationTests/NSExpressionTests.swift

+        ]
+        let expression = NSExpression.mgl_expression(withJSONObject: jsonExpression)
+        let localizedExpression = expression.localized(into: nil)
+        XCTAssertEqual(localizedExpression.mgl_jsonExpressionObject as! NSArray, localizedJSONExpression as NSArray)


This test will fail until mapbox/mapbox-gl-native#11615 lands in a build of the map SDK.

bsudekum · 2018-04-06T16:19:02Z

Fixed arrow width issue with c2b276a

1ec5

This PR is ready except for releasing the map SDK first (minor details!) and also updating the changelog.

1ec5 · 2018-04-16T22:27:33Z

MapboxNavigation/NSExpression.swift

+}
+
+extension NSExpression {
+    func localized(into locale: Locale?, replacingTokens replacesTokens: Bool) -> NSExpression {


Nearly all of this functionality has been upstreamed to the map SDK in mapbox/mapbox-gl-native#11651. So the implementation here can be replaced with a simple call to the similarly named method provided by the map SDK.

Done in 7bbfe0deb187c350638ff579788ee843bea50474.

1ec5 · 2018-04-20T04:27:01Z

I’ve been pretty involved with this PR, so I’d like to get another pair of 👀 from either @vincethecoder or @JThramer. Thanks!

1ec5 · 2018-04-23T21:31:04Z

Tests are failing due to #1327.

frederoni · 2018-04-24T08:47:51Z

Examples/Swift/CustomViewController.swift

-            line.lineJoin = MGLStyleValue(rawValue: NSValue(mglLineJoin: .round))
+            line.lineColor = NSExpression(forConstantValue: UIColor(red:0.00, green:0.45, blue:0.74, alpha:0.9))
+            line.lineWidth = NSExpression(forConstantValue: 5)
+            line.lineCap = NSExpression(forConstantValue: NSValue(mglLineCap: .round))


nit: NSExpression(forConstantValue: "round") seems to be the recommended way according to the documentation and we use throughout the migration except for here.

Fixed in 0294f1209b08f3c7329bd0eecb5752aea359b1a7.

Removed much of the expression localization code, now that it has been upstreamed into the map SDK.

bsudekum added the ⚠️ DO NOT MERGE PR should not be merged! label Jan 26, 2018

1ec5 reviewed Jan 27, 2018

View reviewed changes

This was referenced Feb 16, 2018

Move to constants, make a public #1124

Merged

Cannot apply multiple to zoom level styling mapbox/mapbox-gl-native#11277

Closed

bsudekum added the blocked: upstream label Feb 23, 2018

akitchen changed the title ~~Update to iOS v4.0.0~~ Update to Maps SDK for iOS v4.0.0 Mar 7, 2018

brsbl-zz added the pink label Mar 11, 2018

akitchen added the - chore label Apr 3, 2018

bsudekum commented Apr 3, 2018

View reviewed changes

1ec5 reviewed Apr 3, 2018

View reviewed changes

1ec5 reviewed Apr 4, 2018

View reviewed changes

akitchen removed the pink label Apr 4, 2018

1ec5 self-assigned this Apr 4, 2018

1ec5 removed the blocked: upstream label Apr 4, 2018

1ec5 added this to the v0.17.0 milestone Apr 4, 2018

1ec5 reviewed Apr 6, 2018

View reviewed changes

This comment has been minimized.

Sign in to view

1ec5 mentioned this pull request Apr 6, 2018

Automatic label localization should transform non-constant expressions mapbox/mapbox-gl-native#10713

Closed

1ec5 added the blocked: upstream label Apr 6, 2018

1ec5 force-pushed the v4.0.0 branch from 115fdaa to 5b27e4a Compare April 6, 2018 06:15

1ec5 added the ✓ ready for review label Apr 6, 2018

bsudekum force-pushed the v4.0.0 branch from c2b276a to cced8ad Compare April 6, 2018 17:57

1ec5 mentioned this pull request Apr 6, 2018

Localization plugin should transform expressions mapbox/mapbox-plugins-android#374

Closed

1ec5 previously approved these changes Apr 9, 2018

View reviewed changes

Guardiola31337 mentioned this pull request Apr 10, 2018

User should see an upcoming maneuver arrow on the route line mapbox/mapbox-navigation-android#604

Closed

1ec5 mentioned this pull request Apr 10, 2018

Localize expressions more thoroughly mapbox/mapbox-gl-native#11651

Merged

12 tasks

1ec5 reviewed Apr 16, 2018

View reviewed changes

1ec5 requested review from JThramer and vincethecoder April 20, 2018 04:26

1ec5 added ✓ ready for review and removed blocked: upstream ⚠️ DO NOT MERGE PR should not be merged! labels Apr 20, 2018

1ec5 force-pushed the v4.0.0 branch 3 times, most recently from bb8c034 to e0ee67a Compare April 23, 2018 19:55

1ec5 requested a review from frederoni April 23, 2018 21:17

1ec5 mentioned this pull request Apr 23, 2018

Test failures in ImageDownloaderTests — Semaphore timed out #1327

Closed

frederoni reviewed Apr 24, 2018

View reviewed changes

frederoni approved these changes Apr 24, 2018

View reviewed changes

Bobby Sudekum and others added 10 commits April 24, 2018 09:29

Update to iOS v4.0.0

7e73731

Migrated Swift example app to expressions

23d6ede

Alphabetized category files in group

6ecf2f7

Renamed extension file to match class

d395bfc

Comprehensively localize labels

33dbcc6

Simplified expressions

858d386

Fix arrow width

0a32a20

Upgraded to map SDK v4.0.0-rc.1

4e24ccf

Removed much of the expression localization code, now that it has been upstreamed into the map SDK.

Upgraded to v4.0.0

d59b750

Simplified enumeration expressions

a5328a5

1ec5 force-pushed the v4.0.0 branch from 0294f12 to a5328a5 Compare April 24, 2018 16:30

1ec5 merged commit 17970e1 into master Apr 24, 2018

1ec5 deleted the v4.0.0 branch April 24, 2018 21:13

Guardiola31337 mentioned this pull request May 21, 2018

Add upcoming maneuver arrow on the route line mapbox/mapbox-navigation-android#934

Merged

4 tasks

1ec5 mentioned this pull request Jul 9, 2018

Reimplement current road name label atop navigator status/electronic horizon #1440

Closed

1ec5 added the backwards incompatible changes that break backwards compatibility of public API label Dec 18, 2018

Update to Maps SDK for iOS v4.0.0 #1076

Update to Maps SDK for iOS v4.0.0 #1076

Conversation

bsudekum commented Jan 26, 2018 • edited by 1ec5 Loading

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

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

bsudekum commented Feb 23, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1ec5 Apr 3, 2018 • 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1ec5 Apr 3, 2018 • 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

This comment has been minimized.

bsudekum commented Apr 6, 2018

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

1ec5 commented Apr 20, 2018

1ec5 commented Apr 23, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bsudekum commented Jan 26, 2018 •

edited by 1ec5

Loading

1ec5 Apr 3, 2018 •

edited

Loading

1ec5 Apr 3, 2018 •

edited

Loading