Add Invalid Encoding Channel Warning

vega · Mar 4, 2018 · cc2594c · cc2594c
1 parent e9ab717
commit cc2594c
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 2 deletions.
diff --git a/src/encoding.ts b/src/encoding.ts
@@ -1,6 +1,6 @@
 
 import {isArray} from 'vega-util';
-import {Channel, CHANNELS, supportMark} from './channel';
+import {Channel, CHANNELS, isChannel, supportMark} from './channel';
 import {FacetMapping} from './facet';
 import {
   ChannelDef,
@@ -145,7 +145,13 @@ export function isAggregate(encoding: EncodingWithFacet<Field>) {
 }
 
 export function normalizeEncoding(encoding: Encoding<string>, mark: Mark): Encoding<string> {
-  return keys(encoding).reduce((normalizedEncoding: Encoding<string>, channel: Channel) => {
+   return keys(encoding).reduce((normalizedEncoding: Encoding<string>, channel: Channel | string) => {
+    if (!isChannel(channel)) {
+      // Drop invalid channel
+      log.warn(log.message.invalidEncodingChannel(channel));
+      return normalizedEncoding;
+    }
+
     if (!supportMark(channel, mark)) {
       // Drop unsupported channel
 

diff --git a/src/log.ts b/src/log.ts
@@ -175,6 +175,10 @@ export namespace message {
     return `${channel} dropped as it is incompatible with "${markOrFacet}"${when ? ` when ${when}` : ''}.`;
   }
 
+  export function invalidEncodingChannel(channel: string) {
+    return `${channel}-encoding is dropped as ${channel} is not a valid encoding channel.`;
+  }
+
   export function facetChannelShouldBeDiscrete(channel: string) {
     return `${channel} encoding should be discrete (ordinal / nominal / binned).`;
   }

diff --git a/test/compile/unit.test.ts b/test/compile/unit.test.ts
@@ -19,6 +19,16 @@ describe('UnitModel', function() {
         assert.equal(localLogger.warns[0], log.message.incompatibleChannel(SHAPE, BAR));
       }));
 
+    it('should drop invalid channel and throws warning', log.wrap((localLogger) => {
+        const _model = parseUnitModel({
+          mark: 'bar',
+          encoding: {
+            _y: {type: 'quantitative'}
+          }
+        } as any); // To make parseUnitModel accept the model with invalid encoding channel
+        assert.equal(localLogger.warns[0], log.message.invalidEncodingChannel('_y'));
+      }));
+
     it('should drop channel without field and value and throws warning', log.wrap((localLogger) => {
         const model = parseUnitModel({
           mark: 'bar',