Merge pull request #3730 from RedisInsight/feature/RI-5934-format-timestamps-across-entire-application

Feature/ri 5934 format timestamps across entire application

Author: mariasergeenko

package.json

@@ -222,7 +222,8 @@
     "classnames": "^2.3.1",
     "connection-string": "^4.3.2",
     "d3": "^7.6.1",
-    "date-fns": "^2.16.1",
+    "date-fns": "^3.6.0",
+    "date-fns-tz": "^3.1.3",
     "electron-context-menu": "^3.1.0",
     "electron-log": "^4.2.4",
     "electron-store": "^8.0.0",

redisinsight/api/src/__mocks__/app-settings.ts

@@ -11,6 +11,8 @@ export const mockSettings = Object.assign(new Settings(), {
     theme: 'DARK',
     scanThreshold: 500,
     batchSize: 10,
+    dateFormat: null,
+    timezone: null,
   },
 });
 

redisinsight/api/src/modules/settings/dto/settings.dto.ts

@@ -18,6 +18,11 @@ import { IAgreementSpec } from 'src/modules/settings/models/agreements.interface
 const REDIS_SCAN_CONFIG = config.get('redis_scan');
 const WORKBENCH_CONFIG = config.get('workbench');
 
+export enum TimezoneOption {
+  Local = 'local',
+  UTC = 'UTC',
+}
+
 export class GetAgreementsSpecResponse {
   @ApiProperty({
     description: 'Version of agreements specification.',
@@ -70,6 +75,24 @@ export class GetAppSettingsResponse {
   @Default(null)
   theme: string = null;
 
+  @ApiProperty({
+    description: 'Applied application date format',
+    type: String,
+    example: 'yyyy-mm-dd',
+  })
+  @Expose()
+  @Default(null)
+  dateFormat: string = null;
+
+  @ApiProperty({
+    description: 'Applied application timezone',
+    enum: TimezoneOption,
+    example: 'local',
+  })
+  @Expose()
+  @Default(null)
+  timezone: TimezoneOption = null;
+
   @ApiProperty({
     description: 'Applied the threshold for scan operation.',
     type: Number,
@@ -113,6 +136,24 @@ export class UpdateSettingsDto {
   @IsString()
   theme?: string;
 
+  @ApiPropertyOptional({
+    description: 'Application date format.',
+    type: String,
+    example: 'yyyy-mm-dd',
+  })
+  @IsOptional()
+  @IsString()
+  dateFormat?: string;
+
+  @ApiPropertyOptional({
+    description: 'Application timezone.',
+    type: String,
+    example: 'local',
+  })
+  @IsOptional()
+  @IsString()
+  timezone?: string;
+
   @ApiPropertyOptional({
     description: 'Threshold for scan operation.',
     type: Number,

redisinsight/api/src/modules/settings/settings.analytics.spec.ts

@@ -85,6 +85,8 @@ describe('SettingsAnalytics', () => {
       agreements: null,
       scanThreshold: 10000,
       batchSize: 5,
+      dateFormat: null,
+      timezone: null,
       theme: null,
     };
     it('should emit [SETTINGS_KEYS_TO_SCAN_CHANGED] event', async () => {

redisinsight/api/src/modules/settings/settings.service.spec.ts

@@ -93,11 +93,14 @@ describe('SettingsService', () => {
         theme: null,
         scanThreshold: REDIS_SCAN_CONFIG.scanThreshold,
         batchSize: WORKBENCH_CONFIG.countBatch,
+        dateFormat: null,
+        timezone: null,
         agreements: null,
       });
 
       expect(eventEmitter.emit).not.toHaveBeenCalled();
     });
+
     it('should return some application settings already defined by user', async () => {
       agreementsRepository.getOrCreate.mockResolvedValue(mockAgreements);
       settingsRepository.getOrCreate.mockResolvedValue(mockSettings);
@@ -112,6 +115,7 @@ describe('SettingsService', () => {
         },
       });
     });
+
     it('should throw InternalServerError', async () => {
       agreementsRepository.getOrCreate.mockRejectedValue(new Error('some error'));
 
@@ -185,6 +189,8 @@ describe('SettingsService', () => {
 
       const dto: UpdateSettingsDto = {
         batchSize: 6,
+        dateFormat: 'hh-mmm-ss',
+        timezone: 'UTC',
         agreements: new Map(Object.entries({
           notifications: false,
         })),
@@ -195,6 +201,8 @@ describe('SettingsService', () => {
         ...mockSettings,
         data: {
           batchSize: 6,
+          dateFormat: 'hh-mmm-ss',
+          timezone: 'UTC',
         },
 
       });

redisinsight/api/test/api/settings/GET-settings.test.ts

@@ -17,6 +17,8 @@ const responseSchema = Joi.object().keys({
   theme: Joi.string().allow(null).required(),
   scanThreshold: Joi.number().required(),
   batchSize: Joi.number().required(),
+  dateFormat: Joi.string().allow(null),
+  timezone: Joi.string().allow(null),
   agreements: Joi.object().keys({
     version: Joi.string().required(),
     eula: Joi.bool().required(),

redisinsight/api/test/api/settings/PATCH-settings.test.ts

@@ -21,6 +21,8 @@ const responseSchema = Joi.object().keys({
   theme: Joi.string().allow(null).required(),
   scanThreshold: Joi.number().required(),
   batchSize: Joi.number().required(),
+  dateFormat: Joi.string().allow(null),
+  timezone: Joi.string().allow(null),
   agreements: Joi.object().keys({
     version: Joi.string().required(),
     eula: Joi.bool().required(),
@@ -32,6 +34,8 @@ const responseSchema = Joi.object().keys({
 const dataSchema = Joi.object({
   theme: Joi.string().allow(null).optional(),
   scanThreshold: Joi.number().allow(null).min(500).optional(),
+  dateFormat: Joi.string().allow(null),
+  timezone: Joi.string().allow(null),
   agreements: Joi.object().keys({
     eula: Joi.boolean().label('.eula').optional(),
     encryption: Joi.boolean().label('.encryption').optional(),
@@ -45,6 +49,8 @@ const validInputData = {
   theme: 'DARK',
   scanThreshold: 100000,
   batchSize: 5,
+  dateFormat: null,
+  timezone: null,
   agreements: {
     eula: true,
     analytics: false,

redisinsight/api/test/helpers/constants.ts

@@ -19,6 +19,8 @@ const APP_DEFAULT_SETTINGS = {
   scanThreshold: 10000,
   batchSize: 5,
   theme: null,
+  dateFormat: null,
+  timezone: null,
   agreements: null,
 };
 const TEST_LIBRARY_NAME = 'lib';