automatically detect dates in strings (#25)

Author: michaelneale

dist/module.js

@@ -21,7 +21,7 @@
     ],
     "screenshots": [],
     "version": "1.1.2",
-    "updated": "2020-06-30"
+    "updated": "2020-07-01"
   },
 
   "dependencies": {

dist/module.js.map

@@ -14,7 +14,8 @@
     "@grafana/data": "7.0.3",
     "@grafana/runtime": "7.0.3",
     "@grafana/toolkit": "7.0.3",
-    "@grafana/ui": "7.0.3"
+    "@grafana/ui": "7.0.3",
+    "moment":"*"
   },
   "dependencies": {
     "@types/lodash": "^4.14.144"

dist/plugin.json

@@ -15,7 +15,7 @@ import { MyQuery, MyDataSourceOptions, defaultQuery } from './types';
 import { dateTime, MutableDataFrame, FieldType, DataFrame } from '@grafana/data';
 import { getTemplateSrv } from '@grafana/runtime';
 import _ from 'lodash';
-import { flatten } from './util';
+import { flatten, isRFC3339_ISO6801 } from './util';
 
 export class DataSource extends DataSourceApi<MyQuery, MyDataSourceOptions> {
   basicAuth: string | undefined;
@@ -168,7 +168,7 @@ export class DataSource extends DataSourceApi<MyQuery, MyDataSourceOptions> {
               }
               for (const fieldName in doc) {
                 let t: FieldType = FieldType.string;
-                if (fieldName === 'Time') {
+                if (fieldName === 'Time' || isRFC3339_ISO6801(doc[fieldName])) {
                   t = FieldType.time;
                 } else if (_.isNumber(doc[fieldName])) {
                   t = FieldType.number;

package.json

@@ -1,4 +1,4 @@
-import { flatten } from './util';
+import { flatten, isRFC3339_ISO6801 } from './util';
 
 test('flatten function test', () => {
   let obj = {
@@ -35,3 +35,15 @@ test('flatten function test', () => {
 
   expect(flatten(obj)).toEqual(flattenObj);
 });
+
+test('RFC3339 and ISO8601 valid string test', () => {
+  expect(isRFC3339_ISO6801('I am not a date but a string')).toBe(false);
+  expect(isRFC3339_ISO6801('1234')).toBe(false);
+  expect(isRFC3339_ISO6801(8)).toBe(false);
+  expect(isRFC3339_ISO6801(null)).toBe(false);
+  expect(isRFC3339_ISO6801('2020-06-01T00:00:00.000Z')).toBe(true);
+  expect(isRFC3339_ISO6801('2020-06-01T00:00:00Z')).toBe(true);
+  expect(isRFC3339_ISO6801(true)).toBe(false);
+  expect(isRFC3339_ISO6801(0)).toBe(false);
+  expect(isRFC3339_ISO6801(0.111111)).toBe(false);
+});

src/DataSource.ts

@@ -1,7 +1,23 @@
+import { dateTime, ISO_8601 } from '@grafana/data';
+
 export function flatten<T extends Record<string, any>>(object: T, path: string | null = null, separator = '.'): T {
   return Object.keys(object).reduce((acc: T, key: string): T => {
     const isObject = typeof object[key] === 'object' && object[key] != null;
     const newPath = [path, key].filter(Boolean).join(separator);
     return isObject ? { ...acc, ...flatten(object[key], newPath, separator) } : { ...acc, [newPath]: object[key] };
   }, {} as T);
 }
+
+export function isRFC3339_ISO6801(str: any): boolean {
+  let date = dateTime(str, ISO_8601);
+  if (date.isValid()) {
+    let iso = date.toISOString();
+    if (iso === str) {
+      return true;
+    } else {
+      // some RFC3339 dates don't include fractions of a second to same resolution, but still valid.
+      return iso.substring(0, 19) === str.substring(0, 19);
+    }
+  }
+  return false;
+}

src/util.test.ts

@@ -7648,16 +7648,16 @@ mkdirp@0.x, "mkdirp@>=0.5 0", mkdirp@^0.5.0, mkdirp@^0.5.1, mkdirp@^0.5.3, mkdir
   dependencies:
     minimist "^1.2.5"
 
+moment@*, moment@2.x:
+  version "2.27.0"
+  resolved "https://registry.yarnpkg.com/moment/-/moment-2.27.0.tgz#8bff4e3e26a236220dfe3e36de756b6ebaa0105d"
+  integrity sha512-al0MUK7cpIcglMv3YF13qSgdAIqxHTO7brRtaz3DlSULbqfazqkc5kEjNrLDOM7fsjshoFIihnU8snrP7zUvhQ==
+
 moment@2.24.0:
   version "2.24.0"
   resolved "https://registry.yarnpkg.com/moment/-/moment-2.24.0.tgz#0d055d53f5052aa653c9f6eb68bb5d12bf5c2b5b"
   integrity sha512-bV7f+6l2QigeBBZSM/6yTNq4P2fNpSWj/0e7jQcy87A8e7o2nAfP/34/2ky5Vw4B9S446EtIhodAzkFCcR4dQg==
 
-moment@2.x:
-  version "2.27.0"
-  resolved "https://registry.yarnpkg.com/moment/-/moment-2.27.0.tgz#8bff4e3e26a236220dfe3e36de756b6ebaa0105d"
-  integrity sha512-al0MUK7cpIcglMv3YF13qSgdAIqxHTO7brRtaz3DlSULbqfazqkc5kEjNrLDOM7fsjshoFIihnU8snrP7zUvhQ==
-
 move-concurrently@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/move-concurrently/-/move-concurrently-1.0.1.tgz#be2c005fda32e0b29af1f05d7c4b33214c701f92"