Merge pull request #2977 from RedisInsight/feature/RI-5116-limit-tutorials-links

#RI-5116 - limit tutorials links

Author: vlad-dargel

redisinsight/api/src/common/decorators/index.ts

@@ -7,3 +7,4 @@ export * from './client-metadata';
 export * from './object-as-map.decorator';
 export * from './is-multi-number.decorator';
 export * from './is-bigger-than.decorator';
+export * from './is-github-link.decorator';

redisinsight/api/src/common/decorators/is-github-link.decorator.ts

@@ -0,0 +1,18 @@
+import {
+  registerDecorator,
+  ValidationOptions,
+} from 'class-validator';
+import { GitHubLink } from 'src/common/validators';
+
+export function IsGitHubLink(validationOptions?: ValidationOptions) {
+  return (object: any, propertyName: string) => {
+    registerDecorator({
+      name: 'IsGitHubLink',
+      target: object.constructor,
+      propertyName,
+      constraints: [],
+      options: validationOptions,
+      validator: GitHubLink,
+    });
+  };
+}

redisinsight/api/src/common/validators/github-link.validator.ts

@@ -0,0 +1,17 @@
+import {
+  ValidatorConstraint,
+  ValidatorConstraintInterface,
+} from 'class-validator';
+
+@ValidatorConstraint({ name: 'GitHubLink', async: false })
+export class GitHubLink implements ValidatorConstraintInterface {
+  validate(value: any) {
+    // Regular expression to match any GitHub URL
+    const githubUrlRegex = /^https:\/\/github\.com(?:\/[^\s/]+(?:\/[^\s/]+)*)?\/?$/;
+    return typeof value === 'string' && githubUrlRegex.test(value);
+  }
+
+  defaultMessage() {
+    return 'Enter a full GitHub link';
+  }
+}

redisinsight/api/src/common/validators/index.ts

@@ -2,3 +2,4 @@ export * from './redis-string.validator';
 export * from './zset-score.validator';
 export * from './multi-number.validator';
 export * from './bigger-than.validator';
+export * from './github-link.validator';

redisinsight/api/src/modules/custom-tutorial/dto/upload.custom-tutorial.dto.ts

@@ -3,6 +3,7 @@ import { IsNotEmpty, IsOptional, IsString } from 'class-validator';
 import {
   HasMimeType, IsFile, MaxFileSize, MemoryStoredFile,
 } from 'nestjs-form-data';
+import { IsGitHubLink } from 'src/common/decorators';
 
 export class UploadCustomTutorialDto {
   @ApiPropertyOptional({
@@ -23,5 +24,6 @@ export class UploadCustomTutorialDto {
   @IsOptional()
   @IsString()
   @IsNotEmpty()
+  @IsGitHubLink()
   link?: string;
 }

redisinsight/api/test/api/custom-tutorials/POST-custom-tutorials.test.ts

@@ -9,9 +9,9 @@ import {
   path,
   serverConfig, requirements,
   before,
+  nock,
   _,
 } from '../deps';
-import { getBaseURL } from '../../helpers/server';
 const { server, request, localDb } = deps;
 
 // create endpoint
@@ -107,6 +107,8 @@ const globalManifest = {
   children: [],
 };
 
+const nockScope = nock('https://github.com/somerepo');
+
 describe('POST /custom-tutorials', () => {
   requirements('rte.serverType=local');
 
@@ -197,7 +199,9 @@ describe('POST /custom-tutorials', () => {
 
     it('should import tutorial from the external link with manifest', async () => {
       const zip = new AdmZip(path.join(staticsFolder, 'test.zip'));
-      const link = `${getBaseURL()}/static/test.zip`;
+      const file = await fsExtra.readFile(path.join(staticsFolder, 'test.zip'))
+      nockScope.get('/test.zip').reply(200, file);
+      const link = `https://github.com/somerepo/test.zip`;
 
       await validateApiCall({
         endpoint: creatEndpoint,

redisinsight/ui/src/pages/workbench/components/enablement-area/EnablementArea/components/UploadTutorialForm/UploadTutorialForm.tsx

@@ -85,7 +85,7 @@ const UploadTutorialForm = (props: Props) => {
           </div>
           <div className={styles.hr}>OR</div>
           <EuiFieldText
-            placeholder="Tutorial Link"
+            placeholder="GitHub link to tutorials"
             value={formik.values.link}
             onChange={(e) => formik.setFieldValue('link', e.target.value)}
             className={styles.input}

tests/e2e/test-data/upload-tutorials/sample-manifest-link.zip

@@ -114,7 +114,7 @@ test
 // https://redislabs.atlassian.net/browse/RI-4186, https://redislabs.atlassian.net/browse/RI-4213, https://redislabs.atlassian.net/browse/RI-4302
 test('Verify that user can upload tutorial with URL with manifest.json', async t => {
     const labelFromManifest = 'LabelFromManifest';
-    const link = 'https://drive.google.com/uc?id=1puRUoT8HmyZCekkeWNxBzXe_48TzXcJc&export=download';
+    const link = 'https://github.com/RedisInsight/RedisInsight/tree/main/tests/e2e/test-data/upload-tutorials/sample-manifest-link.zip';
     internalLinkName1 = 'manifest-id';
     tutorialName = 'tutorialTestByLink';