fix: add protobuf time formatters

Author: artemmufazalov

src/types/api/common.ts

@@ -0,0 +1,5 @@
+export interface IProtobufTimeObject {
+    /** int64 */
+    seconds?: string;
+    nanos?: number;
+}

src/types/api/consumer.ts

@@ -1,5 +1,7 @@
 /* eslint-disable camelcase */
 
+import {IProtobufTimeObject} from './common';
+
 /**
  * endpoint: /json/describe_consumer
  *
@@ -65,27 +67,27 @@ interface PartitionConsumerStats {
      *
      * Timestamp of providing this partition to this session by server.
      */
-    partition_read_session_create_time?: string;
+    partition_read_session_create_time?: string | IProtobufTimeObject;
 
     /**
      * google.protobuf.Timestamp
      *
      * Timestamp of last read from this partition. */
-    last_read_time?: string;
+    last_read_time?: string | IProtobufTimeObject;
 
     /**
      * google.protobuf.Duration
      *
      * Maximum of differences between timestamp of read and write timestamp for all messages, read during last minute.
      */
-    max_read_time_lag?: string;
+    max_read_time_lag?: string | IProtobufTimeObject;
 
     /**
      * google.protobuf.Duration
      *
      * Maximum of differences between write timestamp and create timestamp for all messages, read during last minute.
      */
-    max_write_time_lag?: string;
+    max_write_time_lag?: string | IProtobufTimeObject;
 
     /** How much bytes were read during several windows statistics from this partiton. */
     bytes_read?: MultipleWindowsStat;
@@ -113,14 +115,14 @@ export interface PartitionStats {
      *
      * Timestamp of last write.
      */
-    last_write_time?: string;
+    last_write_time?: string | IProtobufTimeObject;
 
     /**
      * google.protobuf.Duration
      *
      * Maximum of differences between write timestamp and create timestamp for all messages, written during last minute.
      */
-    max_write_time_lag?: string;
+    max_write_time_lag?: string | IProtobufTimeObject;
 
     /** How much bytes were written during several windows in this partition. */
     bytes_written?: MultipleWindowsStat;
@@ -148,7 +150,7 @@ export interface Consumer {
      *
      * All messages with smaller server written_at timestamp will be skipped.
      */
-    read_from?: string;
+    read_from?: string | IProtobufTimeObject;
 
     /**
      * List of supported codecs by this consumer.
@@ -170,21 +172,21 @@ interface ConsumerStats {
      *
      * Minimal timestamp of last read from partitions.
      */
-    min_partitions_last_read_time?: string;
+    min_partitions_last_read_time?: string | IProtobufTimeObject;
 
     /**
      * google.protobuf.Duration
      *
      * Maximum of differences between timestamp of read and write timestamp for all messages, read during last minute.
      */
-    max_read_time_lag?: string;
+    max_read_time_lag?: string | IProtobufTimeObject;
 
     /**
      * google.protobuf.Duration
      *
      * Maximum of differences between write timestamp and create timestamp for all messages, read during last minute.
      */
-    max_write_time_lag?: string;
+    max_write_time_lag?: string | IProtobufTimeObject;
 
     /** Bytes read stastics. */
     bytes_read?: MultipleWindowsStat;

src/types/api/topic.ts

@@ -1,5 +1,6 @@
 /* eslint-disable camelcase */
 
+import {IProtobufTimeObject} from './common';
 import {Consumer, Entry, MultipleWindowsStat, PartitionStats, SupportedCodecs} from './consumer';
 
 /**
@@ -27,7 +28,7 @@ export interface DescribeTopicResult {
      *
      * How long data in partition should be stored.
      */
-    retention_period?: string;
+    retention_period?: string | IProtobufTimeObject;
 
     /**
      * int64
@@ -98,7 +99,7 @@ interface PartitionInfo {
     partition_stats?: PartitionStats;
 }
 
-interface TopicStats {
+export interface TopicStats {
     /**
      * int64
      *
@@ -111,14 +112,14 @@ interface TopicStats {
      *
      * Minimum of timestamps of last write among all partitions.
      */
-    min_last_write_time?: string;
+    min_last_write_time?: string | IProtobufTimeObject;
 
     /**
      * google.protobuf.Duration
      *
      * Maximum of differences between write timestamp and create timestamp for all messages, written during last minute.
      */
-    max_write_time_lag?: string;
+    max_write_time_lag?: string | IProtobufTimeObject;
 
     /** How much bytes were written statistics. */
     bytes_written?: MultipleWindowsStat;

src/utils/constants.ts

@@ -18,7 +18,7 @@ export const MINUTE_IN_SECONDS = 60;
 export const HOUR_IN_SECONDS = 60 * MINUTE_IN_SECONDS;
 export const DAY_IN_SECONDS = 24 * HOUR_IN_SECONDS;
 
-export const NANOS_IN_MS = 1000000;
+export const MS_IN_NANOSECONDS = 1000000;
 
 export const TABLET_STATES = {
     TABLET_VOLATILE_STATE_UNKNOWN: 'unknown',

src/utils/timeParsers/__test__/protobuf.test.ts

@@ -0,0 +1,74 @@
+import {
+    parseProtobufDurationToMs,
+    parseProtobufTimeObjectToMs,
+    parseProtobufTimestampToMs,
+} from '../';
+
+describe('Protobuf time parsers', () => {
+    // 1 - nanoseconds only
+    const timeObjectWithNanoseconds = {
+        nanos: 123000000,
+    };
+    const timeWithNanosecondsInMs = 123;
+
+    // 2 - seconds only
+    const timeObjectWithSeconds = {
+        seconds: '12',
+    };
+    const timeWithSecondsInMs = 12000;
+    const stringDurationSeconds = '12s';
+
+    // 3 - days
+    const timeObjectWithDays = {
+        seconds: '439234',
+        nanos: 123000000,
+    };
+    const timeWithDaysInMs = 439234123;
+
+    // 4 - TimeStamp
+    const timestamp = '2023-01-16T14:26:34.466Z';
+    const timestampInMs = 1673879194466;
+    const timestampObject = {
+        seconds: '1673879194',
+        nanos: 466000000,
+    };
+
+    describe('parseProtobufTimeObjectToMs', () => {
+        it('should work with timestamp object values', () => {
+            expect(parseProtobufTimeObjectToMs(timeObjectWithDays)).toEqual(timeWithDaysInMs);
+        });
+        it('should work with timestamp object without seconds', () => {
+            expect(parseProtobufTimeObjectToMs(timeObjectWithNanoseconds)).toEqual(
+                timeWithNanosecondsInMs,
+            );
+        });
+        it('should work with timestamp object without nanos', () => {
+            expect(parseProtobufTimeObjectToMs(timeObjectWithSeconds)).toEqual(timeWithSecondsInMs);
+        });
+        it('should work with empty object values', () => {
+            expect(parseProtobufTimeObjectToMs({})).toEqual(0);
+        });
+    });
+    describe('parseProtobufTimestampToMs', () => {
+        it('should work with string date values', () => {
+            expect(parseProtobufTimestampToMs(timestamp)).toEqual(timestampInMs);
+        });
+        it('should work with timestamp object values', () => {
+            expect(parseProtobufTimestampToMs(timestampObject)).toEqual(timestampInMs);
+        });
+        it('should work with empty object values', () => {
+            expect(parseProtobufTimestampToMs({})).toEqual(0);
+        });
+    });
+    describe('parseProtobufDurationToMs', () => {
+        it('should work with string values', () => {
+            expect(parseProtobufDurationToMs(stringDurationSeconds)).toEqual(timeWithSecondsInMs);
+        });
+        it('should work with duration object values', () => {
+            expect(parseProtobufDurationToMs(timeObjectWithDays)).toEqual(timeWithDaysInMs);
+        });
+        it('should work with empty object values', () => {
+            expect(parseProtobufDurationToMs({})).toEqual(0);
+        });
+    });
+});

src/utils/timeParsers/index.ts

@@ -0,0 +1,2 @@
+export * from './formatDuration';
+export * from './protobuf';

src/utils/timeParsers/protobuf.ts

@@ -0,0 +1,36 @@
+import type {IProtobufTimeObject} from '../../types/api/common';
+
+import {MS_IN_NANOSECONDS} from '../constants';
+
+/**
+ * Parses Google.protobuf Duration and Timestamp represented by objects
+ */
+export const parseProtobufTimeObjectToMs = (value: IProtobufTimeObject): number => {
+    const secondsInMs = value.seconds ? Number(value.seconds) * 1000 : 0;
+    const nanosecondsInMs = value.nanos ? value.nanos / MS_IN_NANOSECONDS : 0;
+    return secondsInMs + nanosecondsInMs;
+};
+
+/**
+ * Parses Google.protobuf Timestamp to ms.
+ * Timestamp could be represented as object or as date string
+ */
+export const parseProtobufTimestampToMs = (value: string | IProtobufTimeObject) => {
+    if (typeof value === 'string') {
+        return Date.parse(value);
+    } else {
+        return parseProtobufTimeObjectToMs(value);
+    }
+};
+
+/**
+ * Parses Google.protobuf Duration to ms.
+ * Duration could be represented as object or as string with format '12345s'
+ */
+export const parseProtobufDurationToMs = (value: string | IProtobufTimeObject) => {
+    if (typeof value === 'string') {
+        return parseInt(value, 10) * 1000;
+    } else {
+        return parseProtobufTimeObjectToMs(value);
+    }
+};