Merge branch 'feature/RI-4186-Upload_custom_tutorials' into fe/feature/I-4181_to-tutorial-button

Author: vlad-dargel

redisinsight/api/src/__mocks__/custom-tutorial.ts

@@ -161,6 +161,7 @@ export const mockCustomTutorialManifestProvider = jest.fn(() => ({
   getOriginalManifestJson: jest.fn().mockResolvedValue(mockCustomTutorialManifestJson),
   getManifestJson: jest.fn().mockResolvedValue(mockCustomTutorialManifestJson),
   generateTutorialManifest: jest.fn().mockResolvedValue(mockCustomTutorialManifest),
+  isOriginalManifestExists: jest.fn().mockResolvedValue(true),
 }));
 
 export const mockCustomTutorialRepository = jest.fn(() => ({

redisinsight/api/src/modules/custom-tutorial/custom-tutorial.service.spec.ts

@@ -108,6 +108,7 @@ describe('CustomTutorialService', () => {
 
     it('Should create custom tutorial from external url (w/o manifest)', async () => {
       customTutorialManifestProvider.getOriginalManifestJson.mockResolvedValue(null);
+      customTutorialManifestProvider.isOriginalManifestExists.mockResolvedValue(false);
 
       const result = await service.create(mockUploadCustomTutorialExternalLinkDto);
 
@@ -124,6 +125,18 @@ describe('CustomTutorialService', () => {
       }
     });
 
+    it('Should throw BadRequestException in case when manifest exists but unable to parse it', async () => {
+      customTutorialManifestProvider.getOriginalManifestJson.mockResolvedValueOnce(null);
+      customTutorialManifestProvider.isOriginalManifestExists.mockResolvedValueOnce(true);
+
+      try {
+        await service.create(mockUploadCustomTutorialExternalLinkDto);
+      } catch (e) {
+        expect(e).toBeInstanceOf(BadRequestException);
+        expect(e.message).toEqual('Unable to parse manifest.json file');
+      }
+    });
+
     it('Should throw BadRequestException in case when manifest is not an object', async () => {
       customTutorialManifestProvider.getOriginalManifestJson.mockResolvedValue([mockCustomTutorialManifest]);
 

redisinsight/api/src/modules/custom-tutorial/custom-tutorial.service.ts

@@ -41,6 +41,10 @@ export class CustomTutorialService {
   private async validateManifestJson(path: string): Promise<void> {
     const manifest = await this.customTutorialManifestProvider.getOriginalManifestJson(path);
 
+    if (!manifest && await this.customTutorialManifestProvider.isOriginalManifestExists(path)) {
+      throw new BadRequestException('Unable to parse manifest.json file');
+    }
+
     if (manifest) {
       if (!isPlainObject(manifest)) {
         throw new BadRequestException('Manifest json should be an object');

redisinsight/api/src/modules/custom-tutorial/providers/custom-tutorial.manifest.provider.spec.ts

@@ -195,7 +195,10 @@ describe('CustomTutorialManifestProvider', () => {
 
       const result = await service.generateTutorialManifest(mockCustomTutorial);
 
-      expect(result).toEqual(null);
+      expect(result).toEqual({
+        ...mockCustomTutorialManifest,
+        children: [],
+      });
     });
 
     it('should return null in case of any error', async () => {

redisinsight/api/src/modules/custom-tutorial/providers/custom-tutorial.manifest.provider.ts

@@ -84,6 +84,10 @@ export class CustomTutorialManifestProvider {
     return manifest;
   }
 
+  public async isOriginalManifestExists(path: string): Promise<boolean> {
+    return fs.existsSync(join(path, MANIFEST_FILE));
+  }
+
   public async getOriginalManifestJson(path: string): Promise<RootCustomTutorialManifest> {
     try {
       return JSON.parse(
@@ -143,16 +147,16 @@ export class CustomTutorialManifestProvider {
    */
   public async generateTutorialManifest(tutorial: CustomTutorial): Promise<RootCustomTutorialManifest> {
     try {
-      const manifest = await this.getManifestJson(tutorial.absolutePath);
+      const manifest = await this.getManifestJson(tutorial.absolutePath) || {} as RootCustomTutorialManifest;
 
       return {
         ...manifest,
         _actions: tutorial.actions,
         _path: tutorial.path,
         type: CustomTutorialManifestType.Group,
         id: tutorial.id,
-        label: tutorial.name || manifest.label,
-        children: manifest.children || [],
+        label: tutorial.name || manifest?.label,
+        children: manifest?.children || [],
       };
     } catch (e) {
       this.logger.warn('Unable to generate manifest for tutorial', e);