feat(cli): format dates (#170)

Custom date formatting + timezone conversion
Leo4815162342 · Mar 4, 2024 · 1b4292f · 1b4292f
1 parent e5b361b
commit 1b4292f
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 8 deletions.
diff --git a/package.json b/package.json
@@ -52,6 +52,7 @@
 		"chalk": "3.0.0",
 		"cli-progress": "3.10.0",
 		"commander": "5.0.0",
+		"dayjs": "1.11.10",
 		"debug": "4.3.4",
 		"fastest-validator": "1.10.0",
 		"fs-extra": "10.1.0",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/cli/cli.ts b/src/cli/cli.ts
@@ -14,12 +14,18 @@ import { processData } from '../processor';
 import { formatBytes } from '../utils/formatBytes';
 import chalk from 'chalk';
 import debug from 'debug';
+import dayjs from 'dayjs';
+import utc from 'dayjs/plugin/utc';
+import tz from 'dayjs/plugin/timezone';
 
 import { version } from '../../package.json';
 import { BatchStreamWriter } from '../stream-writer';
 import { BufferObject } from '../buffer-fetcher/types';
 import { formatTimeDuration } from '../utils/formatTimeDuration';
 
+dayjs.extend(utc);
+dayjs.extend(tz);
+
 const DEBUG_NAMESPACE = 'dukascopy-node:cli';
 
 export async function run(argv: NodeJS.Process['argv']) {
@@ -47,7 +53,9 @@ export async function run(argv: NodeJS.Process['argv']) {
     failAfterRetryCount,
     retryOnEmpty,
     pauseBetweenRetriesMs,
-    fileName: customFileName
+    fileName: customFileName,
+    dateFormat,
+    timeZone
   } = input;
 
   if (isDebugActive) {
@@ -187,7 +195,22 @@ export async function run(argv: NodeJS.Process['argv']) {
               ignoreFlats
             });
 
-            await batchStreamWriter.writeBatch(processedBatch);
+            await batchStreamWriter.writeBatch(
+              processedBatch,
+              dateFormat
+                ? timeStamp => {
+                    if (dateFormat === 'iso') {
+                      return new Date(timeStamp).toISOString();
+                    }
+
+                    if (timeZone) {
+                      return dayjs(timeStamp).tz(timeZone).format(dateFormat);
+                    }
+
+                    return dayjs(timeStamp).utc().format(dateFormat);
+                  }
+                : undefined
+            );
           }
 
           if (isLastBatch) {

diff --git a/src/cli/config.ts b/src/cli/config.ts
@@ -14,6 +14,8 @@ export interface CliConfig extends ConfigBase {
   debug: boolean;
   inline: boolean;
   fileName: string;
+  dateFormat: string;
+  timeZone: string;
 }
 
 const now = 'now';
@@ -44,6 +46,8 @@ const commanderSchema = program
   .option('-bp, --batch-pause <value>', 'Pause between batches in ms', Number, 1000)
   .option('-ch, --cache', 'Use cache', false)
   .option('-chpath, --cache-path <value>', 'Folder path for cache data', './.dukascopy-cache')
+  .option('-df, --date-format <value>', 'Date format', '')
+  .option('-tz, --time-zone <value>', 'Timezone', '')
   .option('-r, --retries <value>', 'Number of retries for a failed artifact download', Number, 0)
   .option('-rp, --retry-pause <value>', 'Pause between retries in milliseconds', Number, 500)
   .option(
@@ -95,7 +99,9 @@ export function getConfigFromCliArgs(argv: NodeJS.Process['argv']) {
     pauseBetweenRetriesMs: options.retryPause,
     debug: options.debug,
     inline: options.inline,
-    fileName: options.fileName
+    fileName: options.fileName,
+    dateFormat: options.dateFormat,
+    timeZone: options.timeZone
   };
 
   const cliSchema: InputSchema<CliConfig> = {
@@ -105,7 +111,9 @@ export function getConfigFromCliArgs(argv: NodeJS.Process['argv']) {
       silent: { type: 'boolean', required: false } as RuleBoolean,
       debug: { type: 'boolean', required: false } as RuleBoolean,
       inline: { type: 'boolean', required: false } as RuleBoolean,
-      fileName: { type: 'string', required: false } as RuleString
+      fileName: { type: 'string', required: false } as RuleString,
+      dateFormat: { type: 'string', required: false } as RuleString,
+      timeZone: { type: 'string', required: false } as RuleString
     }
   };
 

diff --git a/src/stream-writer/index.ts b/src/stream-writer/index.ts
@@ -101,7 +101,7 @@ export class BatchStreamWriter {
   private initHeaders() {
     const bodyHeaders =
       this.timeframe === Timeframe.tick
-        ? ['timestamp', 'askPrice', 'bidPrice', 'askVolume', 'bidVolume']
+        ? ['timestamp', 'askPrice', 'bidPrice', 'askVolume', 'bidVolume'] // TODO: add custom header names as cli options
         : ['timestamp', 'open', 'high', 'low', 'close', 'volume'];
 
     if (!this.volumes) {
@@ -114,21 +114,25 @@ export class BatchStreamWriter {
     return bodyHeaders;
   }
 
-  public async writeBatch(batch: number[][]) {
-    const batchWithinRange: number[][] = [];
+  public async writeBatch(batch: number[][], dateFormatter?: (timestamp: number) => string) {
+    const batchWithinRange: (number | string)[][] = [];
 
     for (let j = 0; j < batch.length; j++) {
       const item = batch[j];
       const isItemInRange =
         item.length > 0 && item[0] >= this.startDateTs && item[0] < this.endDateTs;
 
       if (isItemInRange) {
+        if (dateFormatter) {
+          //@ts-expect-error TODO: fix this
+          item[0] = dateFormatter(item[0]);
+        }
         batchWithinRange.push(item);
       }
     }
 
     for (let i = 0; i < batchWithinRange.length; i++) {
-      const item = batchWithinRange[i];
+      let item = batchWithinRange[i];
 
       const isFirstItem = i === 0;
       const isLastItem = i === batchWithinRange.length - 1;
@@ -152,6 +156,10 @@ export class BatchStreamWriter {
           body += ',' + (!this.isInline ? '\n' : '');
         }
 
+        if (dateFormatter && (this.format === Format.json || this.format === Format.array)) {
+          item[0] = `"${item[0]}"`;
+        }
+
         if (this.format === Format.json) {
           const jsonObjectBody = item.map((val, i) => `"${this.bodyHeaders[i]}":${val}`).join(',');
           body += `{${jsonObjectBody}}`;