#RI-1977 avoid blocking of main thread using I/O sync commands

Author: Artem

redisinsight/api/package.json

@@ -48,6 +48,7 @@
     "class-transformer": "^0.2.3",
     "class-validator": "^0.12.2",
     "express": "^4.17.1",
+    "fs-extra": "^10.0.0",
     "ioredis": "^4.27.1",
     "is-glob": "^4.0.1",
     "jsonpath": "^1.1.1",

redisinsight/api/src/modules/commands/commands-json.provider.spec.ts

@@ -1,5 +1,5 @@
 import axios from 'axios';
-import * as fs from 'fs';
+import * as fs from 'fs-extra';
 import { Test, TestingModule } from '@nestjs/testing';
 import {
   mockMainCommands,
@@ -10,18 +10,15 @@ import { CommandsJsonProvider } from 'src/modules/commands/commands-json.provide
 jest.mock('axios');
 const mockedAxios = axios as jest.Mocked<typeof axios>;
 
-jest.mock('fs');
+jest.mock('fs-extra');
 const mockedFs = fs as jest.Mocked<typeof fs>;
 
 describe('CommandsJsonProvider', () => {
   let service: CommandsJsonProvider;
 
   beforeEach(async () => {
-    jest.mock('fs', () => mockedFs);
+    jest.mock('fs-extra', () => mockedFs);
 
-    mockedFs.existsSync.mockReturnValue(true);
-    mockedFs.mkdirSync.mockReturnValue('');
-    mockedFs.writeFileSync.mockReturnValue(undefined);
     mockedAxios.get.mockResolvedValue({ data: JSON.stringify(mockMainCommands) });
 
     const module: TestingModule = await Test.createTestingModule({
@@ -37,57 +34,47 @@ describe('CommandsJsonProvider', () => {
   });
 
   describe('updateLatestJson', () => {
-    it('Should create dir and save proper json', async () => {
-      mockedFs.existsSync.mockReturnValueOnce(false);
-
-      await service.updateLatestJson();
-
-      // todo: uncomment after enable esModuleInterop in the tsconfig
-      // expect(mockedFs.mkdirSync).toHaveBeenCalled();
-      // expect(mockedFs.writeFileSync).toHaveBeenCalled();
-    });
     it('should not fail when incorrect data retrieved', async () => {
       mockedAxios.get.mockResolvedValueOnce('json');
       await service.updateLatestJson();
 
-      // todo: uncomment after enable esModuleInterop in the tsconfig
-      // expect(mockedFs.writeFileSync).not.toHaveBeenCalled();
+      expect(mockedFs.writeFile).not.toHaveBeenCalled();
     });
   });
 
   describe('getCommands', () => {
     it('should return default config when file was not found', async () => {
-      mockedFs.readFileSync.mockImplementationOnce(() => { throw new Error('No file'); });
-      mockedFs.readFileSync.mockReturnValueOnce(JSON.stringify(mockMainCommands));
+      mockedFs.readFile.mockRejectedValueOnce(new Error('No file'));
+      mockedFs.readFile.mockResolvedValueOnce(Buffer.from(JSON.stringify(mockMainCommands)));
 
       expect(await service.getCommands()).toEqual(mockMainCommands);
     });
     it('should return default config when incorrect json received from file', async () => {
-      mockedFs.readFileSync.mockReturnValueOnce('incorrect json');
-      mockedFs.readFileSync.mockReturnValueOnce(JSON.stringify(mockMainCommands));
+      mockedFs.readFile.mockResolvedValueOnce(Buffer.from('incorrect json'));
+      mockedFs.readFile.mockResolvedValueOnce(Buffer.from(JSON.stringify(mockMainCommands)));
 
       expect(await service.getCommands()).toEqual(mockMainCommands);
     });
     it('should return latest commands', async () => {
-      mockedFs.readFileSync.mockReturnValueOnce(JSON.stringify(mockRedijsonCommands));
+      mockedFs.readFile.mockResolvedValue(Buffer.from(JSON.stringify(mockRedijsonCommands)));
 
       expect(await service.getCommands()).toEqual(mockRedijsonCommands);
     });
   });
 
   describe('getDefaultCommands', () => {
     it('should return empty object when file was not found', async () => {
-      mockedFs.readFileSync.mockImplementationOnce(() => { throw new Error('No file'); });
+      mockedFs.readFile.mockRejectedValue(new Error('No file'));
 
       expect(await service.getDefaultCommands()).toEqual({});
     });
     it('should return empty object when incorrect json received from file', async () => {
-      mockedFs.readFileSync.mockReturnValue('incorrect json');
+      mockedFs.readFile.mockResolvedValue(Buffer.from('incorrect json'));
 
       expect(await service.getDefaultCommands()).toEqual({});
     });
     it('should return default commands', async () => {
-      mockedFs.readFileSync.mockReturnValue(JSON.stringify(mockRedijsonCommands));
+      mockedFs.readFile.mockResolvedValue(Buffer.from(JSON.stringify(mockRedijsonCommands)));
 
       expect(await service.getDefaultCommands()).toEqual(mockRedijsonCommands);
     });

redisinsight/api/src/modules/commands/commands-json.provider.ts

@@ -1,6 +1,6 @@
 import { Injectable, Logger } from '@nestjs/common';
 import axios from 'axios';
-import * as fs from 'fs';
+import * as fs from 'fs-extra';
 import * as path from 'path';
 import config from 'src/utils/config';
 
@@ -31,11 +31,9 @@ export class CommandsJsonProvider {
         transformResponse: [(raw) => raw],
       });
 
-      if (!fs.existsSync(PATH_CONFIG.commands)) {
-        fs.mkdirSync(PATH_CONFIG.commands);
-      }
+      await fs.ensureDir(PATH_CONFIG.commands);
 
-      fs.writeFileSync(
+      await fs.writeFile(
         path.join(PATH_CONFIG.commands, `${this.name}.json`),
         JSON.stringify(JSON.parse(data)), // check that we received proper json object
       );
@@ -51,7 +49,7 @@ export class CommandsJsonProvider {
    */
   async getCommands() {
     try {
-      return JSON.parse(fs.readFileSync(
+      return JSON.parse(await fs.readFile(
         path.join(PATH_CONFIG.commands, `${this.name}.json`),
         'utf8',
       ));
@@ -67,7 +65,7 @@ export class CommandsJsonProvider {
    */
   async getDefaultCommands() {
     try {
-      return JSON.parse(fs.readFileSync(
+      return JSON.parse(await fs.readFile(
         path.join(PATH_CONFIG.defaultCommandsDir, `${this.name}.json`),
         'utf8',
       ));

redisinsight/api/yarn.lock

@@ -3686,6 +3686,15 @@ [email protected], fs-extra@^9.0.0:
     jsonfile "^6.0.1"
     universalify "^2.0.0"
 
+fs-extra@^10.0.0:
+  version "10.0.0"
+  resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-10.0.0.tgz#9ff61b655dde53fb34a82df84bb214ce802e17c1"
+  integrity sha512-C5owb14u9eJwizKGdchcDUQeFtlSHHthBk8pbX9Vc1PFZrLombudjDnNns88aYslCyF6IY5SUw3Roz6xShcEIQ==
+  dependencies:
+    graceful-fs "^4.2.0"
+    jsonfile "^6.0.1"
+    universalify "^2.0.0"
+
 fs-minipass@^1.2.7:
   version "1.2.7"
   resolved "https://registry.yarnpkg.com/fs-minipass/-/fs-minipass-1.2.7.tgz#ccff8570841e7fe4265693da88936c55aed7f7c7"