Throw error when non-existing scale id is used (chartjs#518)

* Throw error when non-existing scale id is used * Improve test
typpo · Dec 2, 2021 · f2e2481 · f2e2481
1 parent 46ee11b
commit f2e2481
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 40 deletions.
diff --git a/karma.conf.js b/karma.conf.js
@@ -44,7 +44,10 @@ module.exports = function(karma) {
       chrome: {
         base: 'Chrome',
         flags: [
-          '--disable-accelerated-2d-canvas'
+          '--disable-accelerated-2d-canvas',
+          '--disable-background-timer-throttling',
+          '--disable-backgrounding-occluded-windows',
+          '--disable-renderer-backgrounding'
         ]
       },
       firefox: {

diff --git a/src/annotation.js b/src/annotation.js
@@ -65,6 +65,7 @@ export default {
     } else if (isArray(annotationOptions)) {
       annotations.push(...annotationOptions);
     }
+    verifyScaleOptions(annotations, chart.scales);
   },
 
   afterDataLimits(chart, args) {
@@ -278,3 +279,13 @@ function getScaleLimits(scale, annotations) {
   }
   return {min, max};
 }
+
+function verifyScaleOptions(annotations, scales) {
+  for (const annotation of annotations) {
+    for (const key of ['scaleID', 'xScaleID', 'yScaleID']) {
+      if (annotation[key] && !scales[annotation[key]]) {
+        throw new Error(`Non-existing scale '${annotation[key]}' defined as ${key} for annotation '${annotation.id}'. Configured scales: ${Object.keys(scales).join(', ')}`);
+      }
+    }
+  }
+}
diff --git a/test/fixtures/box/missingScale.js b/test/fixtures/box/missingScale.js
diff --git a/test/fixtures/box/missingScale.png b/test/fixtures/box/missingScale.png
diff --git a/test/specs/scales.spec.js b/test/specs/scales.spec.js
@@ -0,0 +1,29 @@
+describe('scale options', function() {
+  ['scaleID', 'xScaleID', 'yScaleID'].forEach(function(key) {
+    it(`should throw an exception when ${key} is not a defined scale`, function() {
+      function create() {
+        return acquireChart({
+          type: 'line',
+          data: {
+            datasets: [{
+              data: [1, 2, 3]
+            }]
+          },
+          options: {
+            plugins: {
+              annotation: {
+                annotations: {
+                  test: {
+                    type: 'line',
+                    [key]: 'missing'
+                  }
+                }
+              }
+            }
+          }
+        });
+      }
+      expect(create).toThrowError(`Non-existing scale 'missing' defined as ${key} for annotation 'test'. Configured scales: x, y`);
+    });
+  });
+});