@mapwhit/tilerenderer 0.48.0 → 0.50.0

package/src/style-spec/expression/parsing_context.js

@@ -1,10 +1,10 @@
+const assert = require('assert');
 const Scope = require('./scope');
 
 const { checkSubtype } = require('./types');
 const ParsingError = require('./parsing_error');
 const Literal = require('./definitions/literal');
 const Assertion = require('./definitions/assertion');
-const ArrayAssertion = require('./definitions/array');
 const Coercion = require('./definitions/coercion');
 const EvaluationContext = require('./evaluation_context');
 const { CollatorExpression } = require('./definitions/collator');
@@ -49,6 +49,16 @@ class ParsingContext {
       expr = ['literal', expr];
     }
 
+    function annotate(parsed, type, typeAnnotation) {
+      if (typeAnnotation === 'assert') {
+        return new Assertion(type, [parsed]);
+      }
+      if (typeAnnotation === 'coerce') {
+        return new Coercion(type, [parsed]);
+      }
+      return parsed;
+    }
+
     if (Array.isArray(expr)) {
       if (expr.length === 0) {
         return this.error(
@@ -74,34 +84,29 @@ class ParsingContext {
           const expected = this.expectedType;
           const actual = parsed.type;
 
-          // When we expect a number, string, boolean, or array but
-          // have a Value, we can wrap it in a refining assertion.
-          // When we expect a Color but have a String or Value, we
-          // can wrap it in "to-color" coercion.
+          // When we expect a number, string, boolean, or array but have a value, wrap it in an assertion.
+          // When we expect a color or formatted string, but have a string or value, wrap it in a coercion.
           // Otherwise, we do static type-checking.
+          //
+          // These behaviors are overridable for:
+          //   * The "coalesce" operator, which needs to omit type annotations.
+          //   * String-valued properties (e.g. `text-field`), where coercion is more convenient than assertion.
+          //
           if (
             (expected.kind === 'string' ||
               expected.kind === 'number' ||
               expected.kind === 'boolean' ||
-              expected.kind === 'object') &&
+              expected.kind === 'object' ||
+              expected.kind === 'array') &&
             actual.kind === 'value'
           ) {
-            if (!options.omitTypeAnnotations) {
-              parsed = new Assertion(expected, [parsed]);
-            }
-          } else if (expected.kind === 'array' && actual.kind === 'value') {
-            if (!options.omitTypeAnnotations) {
-              parsed = new ArrayAssertion(expected, parsed);
-            }
-          } else if (expected.kind === 'color' && (actual.kind === 'value' || actual.kind === 'string')) {
-            if (!options.omitTypeAnnotations) {
-              parsed = new Coercion(expected, [parsed]);
-            }
-          } else if (expected.kind === 'formatted' && (actual.kind === 'value' || actual.kind === 'string')) {
-            if (!options.omitTypeAnnotations) {
-              parsed = new Coercion(expected, [parsed]);
-            }
-          } else if (this.checkSubtype(this.expectedType, parsed.type)) {
+            parsed = annotate(parsed, expected, options.typeAnnotation || 'assert');
+          } else if (
+            (expected.kind === 'color' || expected.kind === 'formatted') &&
+            (actual.kind === 'value' || actual.kind === 'string')
+          ) {
+            parsed = annotate(parsed, expected, options.typeAnnotation || 'coerce');
+          } else if (this.checkSubtype(expected, actual)) {
             return null;
           }
         }
@@ -188,8 +193,7 @@ function isConstant(expression) {
     return false;
   }
 
-  const isTypeAnnotation =
-    expression instanceof Coercion || expression instanceof Assertion || expression instanceof ArrayAssertion;
+  const isTypeAnnotation = expression instanceof Coercion || expression instanceof Assertion;
 
   let childrenConstant = true;
   expression.eachChild(child => {

package/src/style-spec/expression/types/collator.js

@@ -0,0 +1,24 @@
+class Collator {
+  constructor(caseSensitive, diacriticSensitive, locale) {
+    if (caseSensitive) this.sensitivity = diacriticSensitive ? 'variant' : 'case';
+    else this.sensitivity = diacriticSensitive ? 'accent' : 'base';
+
+    this.locale = locale;
+    this.collator = new Intl.Collator(this.locale ? this.locale : [], {
+      sensitivity: this.sensitivity,
+      usage: 'search'
+    });
+  }
+
+  compare(lhs, rhs) {
+    return this.collator.compare(lhs, rhs);
+  }
+
+  resolvedLocale() {
+    // We create a Collator without "usage: search" because we don't want
+    // the search options encoded in our result (e.g. "en-u-co-search")
+    return new Intl.Collator(this.locale ? this.locale : []).resolvedOptions().locale;
+  }
+}
+
+module.exports = { Collator };

package/src/style-spec/expression/types/formatted.js

@@ -0,0 +1,39 @@
+class FormattedSection {
+  constructor(text, scale, fontStack = null) {
+    this.text = text;
+    this.scale = scale;
+    this.fontStack = fontStack;
+  }
+}
+
+class Formatted {
+  constructor(sections) {
+    this.sections = sections;
+  }
+
+  static fromString(unformatted) {
+    return new Formatted([new FormattedSection(unformatted, null, null)]);
+  }
+
+  toString() {
+    return this.sections.map(section => section.text).join('');
+  }
+
+  serialize() {
+    const serialized = ['format'];
+    for (const section of this.sections) {
+      serialized.push(section.text);
+      const options = {};
+      if (section.fontStack) {
+        options['text-font'] = ['literal', section.fontStack.split(',')];
+      }
+      if (section.scale) {
+        options['font-scale'] = section.scale;
+      }
+      serialized.push(options);
+    }
+    return serialized;
+  }
+}
+
+module.exports = { Formatted, FormattedSection };

package/src/style-spec/expression/types.js

@@ -53,7 +53,7 @@ function checkSubtype(expected, t) {
   if (expected.kind === 'array') {
     if (
       t.kind === 'array' &&
-      !checkSubtype(expected.itemType, t.itemType) &&
+      ((t.N === 0 && t.itemType.kind === 'value') || !checkSubtype(expected.itemType, t.itemType)) &&
       (typeof expected.N !== 'number' || expected.N === t.N)
     ) {
       return null;

package/src/style-spec/expression/values.js

@@ -1,7 +1,8 @@
 const assert = require('assert');
 
 const Color = require('../util/color');
-const { Collator } = require('./definitions/collator');
+const { Collator } = require('./types/collator');
+const { Formatted } = require('./types/formatted');
 const {
   NullType,
   NumberType,
@@ -11,6 +12,7 @@ const {
   ObjectType,
   ValueType,
   CollatorType,
+  FormattedType,
   array
 } = require('./types');
 
@@ -58,6 +60,9 @@ function isValue(mixed) {
   if (mixed instanceof Collator) {
     return true;
   }
+  if (mixed instanceof Formatted) {
+    return true;
+  }
   if (Array.isArray(mixed)) {
     for (const item of mixed) {
       if (!isValue(item)) {
@@ -96,6 +101,9 @@ function typeOf(value) {
   if (value instanceof Collator) {
     return CollatorType;
   }
+  if (value instanceof Formatted) {
+    return FormattedType;
+  }
   if (Array.isArray(value)) {
     const length = value.length;
     let itemType;
@@ -117,7 +125,22 @@ function typeOf(value) {
   return ObjectType;
 }
 
+function toString(value) {
+  const type = typeof value;
+  if (value === null) {
+    return '';
+  }
+  if (type === 'string' || type === 'number' || type === 'boolean') {
+    return String(value);
+  }
+  if (value instanceof Color || value instanceof Formatted) {
+    return value.toString();
+  }
+  return JSON.stringify(value);
+}
+
 module.exports = {
+  toString,
   Color,
   Collator,
   validateRGBA,

package/src/style-spec/feature_filter/convert.js

@@ -0,0 +1,197 @@
+const { isExpressionFilter } = require('./index');
+
+module.exports = convertFilter;
+
+/**
+ * Convert the given legacy filter to (the JSON representation of) an
+ * equivalent expression
+ * @private
+ */
+function convertFilter(filter) {
+  return _convertFilter(filter, {});
+}
+
+/*
+ * Convert the given filter to an expression, storing the expected types for
+ * any feature properties referenced in expectedTypes.
+ *
+ * These expected types are needed in order to construct preflight type checks
+ * needed for handling 'any' filters. A preflight type check is necessary in
+ * order to mimic legacy filters' semantics around expected type mismatches.
+ * For example, consider the legacy filter:
+ *
+ *     ["any", ["all", [">", "y", 0], [">", "y", 0]], [">", "x", 0]]
+ *
+ * Naively, we might convert this to the expression:
+ *
+ *     ["any", ["all", [">", ["get", "y"], 0], [">", ["get", "z"], 0]], [">", ["get", "x"], 0]]
+ *
+ * But if we tried to evaluate this against, say `{x: 1, y: null, z: 0}`, the
+ * [">", ["get", "y"], 0] would cause an evaluation error, leading to the
+ * entire filter returning false. Legacy filter semantics, though, ask for
+ * [">", "y", 0] to simply return `false` when `y` is of the wrong type,
+ * allowing the subsequent terms of the outer "any" expression to be evaluated
+ * (resulting, in this case, in a `true` value, because x > 0).
+ *
+ * We account for this by inserting a preflight type-checking expression before
+ * each "any" term, allowing us to avoid evaluating the actual converted filter
+ * if any type mismatches would cause it to produce an evalaution error:
+ *
+ *     ["any",
+ *       ["case",
+ *         ["all", ["==", ["typeof", ["get", "y"]], "number"], ["==", ["typeof", ["get", "z"], "number]],
+ *         ["all", [">", ["get", "y"], 0], [">", ["get", "z"], 0]],
+ *         false
+ *       ],
+ *       ["case",
+ *         ["==", ["typeof", ["get", "x"], "number"]],
+ *         [">", ["get", "x"], 0],
+ *         false
+ *       ]
+ *     ]
+ *
+ * An alternative, possibly more direct approach would be to use type checks
+ * in the conversion of each comparison operator, so that the converted version
+ * of each individual ==, >=, etc. would mimic the legacy filter semantics. The
+ * downside of this approach is that it can lead to many more type checks than
+ * would otherwise be necessary: outside the context of an "any" expression,
+ * bailing out due to a runtime type error (expression semantics) and returning
+ * false (legacy filter semantics) are equivalent: they cause the filter to
+ * produce a `false` result.
+ */
+function _convertFilter(filter, expectedTypes) {
+  if (isExpressionFilter(filter)) {
+    return filter;
+  }
+
+  if (!filter) return true;
+  const op = filter[0];
+  if (filter.length <= 1) return op !== 'any';
+
+  let converted;
+
+  if (op === '==' || op === '!=' || op === '<' || op === '>' || op === '<=' || op === '>=') {
+    const [, property, value] = filter;
+    converted = convertComparisonOp(property, value, op, expectedTypes);
+  } else if (op === 'any') {
+    const children = filter.slice(1).map(f => {
+      const types = {};
+      const child = _convertFilter(f, types);
+      const typechecks = runtimeTypeChecks(types);
+      return typechecks === true ? child : ['case', typechecks, child, false];
+    });
+    return ['any'].concat(children);
+  } else if (op === 'all') {
+    const children = filter.slice(1).map(f => _convertFilter(f, expectedTypes));
+    return ['all'].concat(children);
+  } else if (op === 'none') {
+    return ['!', _convertFilter(['any'].concat(filter.slice(1)), {})];
+  } else if (op === 'in') {
+    converted = convertInOp(filter[1], filter.slice(2));
+  } else if (op === '!in') {
+    converted = convertInOp(filter[1], filter.slice(2), true);
+  } else if (op === 'has') {
+    converted = convertHasOp(filter[1]);
+  } else if (op === '!has') {
+    converted = ['!', convertHasOp(filter[1])];
+  } else {
+    converted = true;
+  }
+
+  return converted;
+}
+
+// Given a set of feature properties and an expected type for each one,
+// construct an boolean expression that tests whether each property has the
+// right type.
+// E.g.: for {name: 'string', population: 'number'}, return
+// [ 'all',
+//   ['==', ['typeof', ['get', 'name'], 'string']],
+//   ['==', ['typeof', ['get', 'population'], 'number]]
+// ]
+function runtimeTypeChecks(expectedTypes) {
+  const conditions = [];
+  for (const property in expectedTypes) {
+    const get = property === '$id' ? ['id'] : ['get', property];
+    conditions.push(['==', ['typeof', get], expectedTypes[property]]);
+  }
+  if (conditions.length === 0) return true;
+  if (conditions.length === 1) return conditions[0];
+  return ['all'].concat(conditions);
+}
+
+function convertComparisonOp(property, value, op, expectedTypes) {
+  let get;
+  if (property === '$type') {
+    return [op, ['geometry-type'], value];
+  }
+  if (property === '$id') {
+    get = ['id'];
+  } else {
+    get = ['get', property];
+  }
+
+  if (expectedTypes && value !== null) {
+    const type = typeof value;
+    expectedTypes[property] = type;
+  }
+
+  if (op === '==' && property !== '$id' && value === null) {
+    return [
+      'all',
+      ['has', property], // missing property != null for legacy filters
+      ['==', get, null]
+    ];
+  }
+  if (op === '!=' && property !== '$id' && value === null) {
+    return [
+      'any',
+      ['!', ['has', property]], // missing property != null for legacy filters
+      ['!=', get, null]
+    ];
+  }
+
+  return [op, get, value];
+}
+
+function convertInOp(property, values, negate = false) {
+  if (values.length === 0) return negate;
+
+  let get;
+  if (property === '$type') {
+    get = ['geometry-type'];
+  } else if (property === '$id') {
+    get = ['id'];
+  } else {
+    get = ['get', property];
+  }
+
+  // Determine if the list of values to be searched is homogenously typed.
+  // If so (and if the type is string or number), then we can use a
+  // [match, input, [...values], true, false] construction rather than a
+  // bunch of `==` tests.
+  let uniformTypes = true;
+  const type = typeof values[0];
+  for (const value of values) {
+    if (typeof value !== type) {
+      uniformTypes = false;
+      break;
+    }
+  }
+
+  if (uniformTypes && (type === 'string' || type === 'number')) {
+    return ['match', get, values, !negate, negate];
+  }
+
+  return [negate ? 'all' : 'any'].concat(values.map(v => [negate ? '!=' : '==', get, v]));
+}
+
+function convertHasOp(property) {
+  if (property === '$type') {
+    return true;
+  }
+  if (property === '$id') {
+    return ['!=', ['id'], null];
+  }
+  return ['has', property];
+}

package/src/style-spec/feature_filter/index.js

@@ -5,6 +5,9 @@ module.exports = createFilter;
 createFilter.isExpressionFilter = isExpressionFilter;
 
 function isExpressionFilter(filter) {
+  if (filter === true || filter === false) {
+    return true;
+  }
   if (!Array.isArray(filter) || filter.length === 0) {
     return false;
   }
@@ -61,7 +64,7 @@ const filterSpec = {
  * @returns {Function} filter-evaluating function
  */
 function createFilter(filter) {
-  if (!filter) {
+  if (filter === null || filter === undefined) {
     return () => true;
   }