fix(components): Replacing package luxon by day.js on roDateTime an…

…d `roTimespan` #28 (#29) * fix(components): Replacing package luxon by day.js on `roDateTime` and `roTimespan` #28 * Fixed prettier issue
rokucommunity · Nov 21, 2023 · 5f13b59 · 5f13b59
1 parent 7ef68bb
commit 5f13b59
Show file tree

Hide file tree

Showing 8 changed files with 73 additions and 48 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -29,10 +29,10 @@
   ],
   "dependencies": {
     "commander": "^2.12.2",
+    "dayjs": "^1.11.10",
     "decompress": "^4.2.1",
     "fast-glob": "^3.0.1",
     "long": "^3.2.0",
-    "luxon": "^1.8.3",
     "memory-fs": "^0.4.1",
     "nanomatch": "^1.2.13",
     "p-settle": "^2.1.0",
@@ -45,7 +45,6 @@
     "@types/istanbul-lib-coverage": "^2.0.3",
     "@types/lolex": "^2.1.3",
     "@types/long": "^3.0.32",
-    "@types/luxon": "^1.4.1",
     "@types/memory-fs": "^0.3.2",
     "@types/node": "^8.5.2",
     "@types/p-settle": "^2.0.1",

diff --git a/src/brsTypes/components/RoDateTime.ts b/src/brsTypes/components/RoDateTime.ts
@@ -1,17 +1,21 @@
 import { BrsValue, ValueKind, BrsString, BrsInvalid, BrsBoolean } from "../BrsType";
 import { BrsComponent } from "./BrsComponent";
-import { BrsType } from "..";
+import { BrsType, ValidDateFormats } from "..";
 import { Callable, StdlibArgument } from "../Callable";
 import { Interpreter } from "../../interpreter";
 import { Int32 } from "../Int32";
-import * as luxon from "luxon";
+import dayjs from "dayjs";
+import utc from "dayjs/plugin/utc";
+import customParseFormat from "dayjs/plugin/customParseFormat";
 
 export class RoDateTime extends BrsComponent implements BrsValue {
     readonly kind = ValueKind.Object;
     private markTime = Date.now();
 
     constructor() {
         super("roDateTime");
+        dayjs.extend(utc);
+        dayjs.extend(customParseFormat);
         this.registerMethods({
             ifDateTime: [
                 this.mark,
@@ -208,12 +212,11 @@ export class RoDateTime extends BrsComponent implements BrsValue {
             returns: ValueKind.Void,
         },
         impl: (_: Interpreter, dateString: BrsString) => {
-            let dateToParse = luxon.DateTime.fromISO(dateString.value, { zone: "utc" });
-            if (dateToParse.isValid) {
-                this.markTime = Date.parse(dateToParse.toISO());
-            } else {
-                this.markTime = 0;
+            let dateParsed = dayjs(dateString.value, ValidDateFormats, true).utc(true);
+            if (!dateParsed.isValid()) {
+                dateParsed = dayjs(0);
             }
+            this.markTime = dateParsed.toDate().valueOf();
             return BrsInvalid.Instance;
         },
     });

diff --git a/src/brsTypes/components/Timespan.ts b/src/brsTypes/components/Timespan.ts
@@ -1,17 +1,21 @@
 import { BrsValue, ValueKind, BrsString, BrsInvalid, BrsBoolean } from "../BrsType";
 import { BrsComponent } from "./BrsComponent";
-import { BrsType } from "..";
+import { BrsType, ValidDateFormats } from "..";
 import { Callable, StdlibArgument } from "../Callable";
 import { Interpreter } from "../../interpreter";
 import { Int32 } from "../Int32";
-import * as luxon from "luxon";
+import dayjs from "dayjs";
+import utc from "dayjs/plugin/utc";
+import customParseFormat from "dayjs/plugin/customParseFormat";
 
 export class Timespan extends BrsComponent implements BrsValue {
     readonly kind = ValueKind.Object;
     private markTime = Date.now();
 
     constructor() {
         super("roTimespan");
+        dayjs.extend(utc);
+        dayjs.extend(customParseFormat);
         this.registerMethods({
             ifTimespan: [
                 this.mark,
@@ -79,16 +83,12 @@ export class Timespan extends BrsComponent implements BrsValue {
             returns: ValueKind.Int32,
         },
         impl: (_: Interpreter, date: BrsString) => {
-            let dateAsSeconds;
-            let now = Date.now();
-            let dateToParse = luxon.DateTime.fromISO(date.value, { zone: "utc" });
-
-            if (dateToParse.isValid) {
-                dateAsSeconds = Math.round((Date.parse(dateToParse.toISO()) - now) / 1000);
-            } else {
-                dateAsSeconds = 2077252342;
+            let dateAsSeconds = 2077252342;
+            const now = Date.now();
+            const dateParsed = dayjs(date.value, ValidDateFormats, true).utc(true);
+            if (dateParsed.isValid()) {
+                dateAsSeconds = Math.round((dateParsed.toDate().valueOf() - now) / 1000);
             }
-
             return new Int32(dateAsSeconds);
         },
     });

diff --git a/src/brsTypes/index.ts b/src/brsTypes/index.ts
@@ -133,3 +133,22 @@ export type AllComponents = { kind: ValueKind.Object } & BrsComponent & BrsValue
 
 /** The set of all supported types in BrightScript. */
 export type BrsType = BrsPrimitive | Iterable | Callable | AllComponents | Uninitialized;
+
+/** The valid ISO Date formats for roDateTime and roTimeSpan parsing */
+export const ValidDateFormats = [
+    "YYYY-MM-DDTHH:mm:ss.SSS[Z]",
+    "YYYY-MM-DDTHH:mm:ss.SSS",
+    "YYYY-MM-DDTHH:mm:ss[Z]",
+    "YYYY-MM-DDTHH:mm:ss",
+    "YYYY-MM-DDTHH:mm[Z]",
+    "YYYY-MM-DDTHH:mm",
+    "YYYY-MM-DDTHH[Z]",
+    "YYYY-MM-DDTHH",
+    "YYYY-MM-DDT",
+    "YYYY-MM-DD[Z]",
+    "YYYY-MM-DD",
+    "YYYY-MM[Z]",
+    "YYYY-MM",
+    "YYYY[Z]",
+    "YYYY",
+];
diff --git a/src/parser/Statement.ts b/src/parser/Statement.ts
@@ -1,7 +1,6 @@
 import * as Expr from "./Expression";
 import { Token, Identifier, Location, Lexeme } from "../lexer";
 import { BrsType, BrsInvalid } from "../brsTypes";
-import { InvalidZone } from "luxon";
 import { AstNode } from "./AstNode";
 
 /** A set of reasons why a `Block` stopped executing. */

diff --git a/test/e2e/BrsComponents.test.js b/test/e2e/BrsComponents.test.js
@@ -131,6 +131,20 @@ describe("end to end brightscript functions", () => {
         expect(allArgs(outputStreams.stdout.write).filter((arg) => arg !== "\n")).toEqual([
             "can return seconds from date until now: ",
             "373447701",
+            "can return seconds from date until now: ",
+            "373447701",
+            "can return seconds from date until now: ",
+            "373447649",
+            "can return seconds from date until now: ",
+            "373444829",
+            "can return seconds from date until now: ",
+            "373426829",
+            "can return seconds from date until now: ",
+            "373426829",
+            "can return seconds from date until now: ",
+            "372649229",
+            "can return seconds from date until now: ",
+            "346383629",
             "can return 2077252342 for date that can't be parsed: ",
             "2077252342",
         ]);

diff --git a/test/e2e/resources/components/roTimespan.brs b/test/e2e/resources/components/roTimespan.brs
@@ -2,5 +2,12 @@ sub main()
     ts = createObject("roTimespan")
 
     print "can return seconds from date until now: " ts.getsecondstoiso8601date("2030-11-10T05:47:52Z")
+    print "can return seconds from date until now: " ts.getsecondstoiso8601date("2030-11-10T05:47:52")
+    print "can return seconds from date until now: " ts.getsecondstoiso8601date("2030-11-10T05:47")
+    print "can return seconds from date until now: " ts.getsecondstoiso8601date("2030-11-10T05")
+    print "can return seconds from date until now: " ts.getsecondstoiso8601date("2030-11-10T")
+    print "can return seconds from date until now: " ts.getsecondstoiso8601date("2030-11-10")
+    print "can return seconds from date until now: " ts.getsecondstoiso8601date("2030-11")
+    print "can return seconds from date until now: " ts.getsecondstoiso8601date("2030")
     print "can return 2077252342 for date that can't be parsed: " ts.getsecondstoiso8601date("14 Jun 2017 00:00:00 PDT")
 end sub