From da2534f009661b31122b761dd0bdb4e89ecac540 Mon Sep 17 00:00:00 2001 From: zalenskiSofteq Date: Wed, 17 Jan 2024 12:42:21 +0100 Subject: [PATCH] #RI-5310 - [BE] Cover new tutorials --- redisinsight/api/config/default.ts | 10 ----- redisinsight/api/config/production.ts | 1 - redisinsight/api/config/staging.ts | 1 - redisinsight/api/package.json | 3 +- redisinsight/api/scripts/default-guides.ts | 39 ------------------- .../auto-updated-statics.provider.spec.ts | 16 ++++---- .../statics-management.module.ts | 17 -------- 7 files changed, 9 insertions(+), 78 deletions(-) delete mode 100644 redisinsight/api/scripts/default-guides.ts diff --git a/redisinsight/api/config/default.ts b/redisinsight/api/config/default.ts index 2d6d57a886..5fc40aed34 100644 --- a/redisinsight/api/config/default.ts +++ b/redisinsight/api/config/default.ts @@ -29,8 +29,6 @@ export default { pluginsAssets: join(staticDir, 'resources', 'plugins'), commands: join(homedir, 'commands'), defaultCommandsDir: join(defaultsDir, 'commands'), - guides: process.env.RI_GUIDES_PATH || join(homedir, 'guides'), - defaultGuides: join(defaultsDir, 'guides'), tutorials: process.env.RI_TUTORIALS_PATH || join(homedir, 'tutorials'), defaultTutorials: join(defaultsDir, 'tutorials'), content: process.env.RI_CONTENT_PATH || join(homedir, 'content'), @@ -47,7 +45,6 @@ export default { globalPrefix: 'api', customPluginsUri: '/plugins', staticUri: '/static', - guidesUri: '/static/guides', tutorialsUri: '/static/tutorials', customTutorialsUri: '/static/custom-tutorials', contentUri: '/static/content', @@ -110,13 +107,6 @@ export default { plugins: { stateMaxSize: parseInt(process.env.RI_PLUGIN_STATE_MAX_SIZE, 10) || 1024 * 1024, }, - guides: { - updateUrl: process.env.RI_GUIDES_UPDATE_URL - || 'https://github.com/RedisInsight/Guides/releases/download/2.x.x', - zip: process.env.RI_GUIDES_ZIP || dataZipFileName, - buildInfo: process.env.RI_GUIDES_INFO || buildInfoFileName, - devMode: !!process.env.RI_GUIDES_PATH, - }, tutorials: { updateUrl: process.env.RI_TUTORIALS_UPDATE_URL || 'https://github.com/RedisInsight/Tutorials/releases/download/2.x.x', diff --git a/redisinsight/api/config/production.ts b/redisinsight/api/config/production.ts index b79847ea02..688608947d 100644 --- a/redisinsight/api/config/production.ts +++ b/redisinsight/api/config/production.ts @@ -14,7 +14,6 @@ export default { customPlugins: join(homedir, 'plugins'), customTutorials: join(homedir, 'custom-tutorials'), commands: join(homedir, 'commands'), - guides: process.env.RI_GUIDES_PATH || join(homedir, 'guides'), tutorials: process.env.RI_TUTORIALS_PATH || join(homedir, 'tutorials'), content: process.env.RI_CONTENT_PATH || join(homedir, 'content'), caCertificates: join(homedir, 'ca_certificates'), diff --git a/redisinsight/api/config/staging.ts b/redisinsight/api/config/staging.ts index 36ad6eb350..efa3c0d5eb 100644 --- a/redisinsight/api/config/staging.ts +++ b/redisinsight/api/config/staging.ts @@ -14,7 +14,6 @@ export default { customPlugins: join(homedir, 'plugins'), customTutorials: join(homedir, 'custom-tutorials'), commands: join(homedir, 'commands'), - guides: process.env.RI_GUIDES_PATH || join(homedir, 'guides'), tutorials: process.env.RI_TUTORIALS_PATH || join(homedir, 'tutorials'), content: process.env.RI_CONTENT_PATH || join(homedir, 'content'), caCertificates: join(homedir, 'ca_certificates'), diff --git a/redisinsight/api/package.json b/redisinsight/api/package.json index d0b160fa67..f357bf4e64 100644 --- a/redisinsight/api/package.json +++ b/redisinsight/api/package.json @@ -10,10 +10,9 @@ }, "scripts": { "build:defaults:commands": "ts-node ./scripts/default-commands.ts", - "build:defaults:guides": "ts-node ./scripts/default-guides.ts", "build:defaults:tutorials": "ts-node ./scripts/default-tutorials.ts", "build:defaults:content": "ts-node ./scripts/default-content.ts", - "build:defaults": "yarn build:defaults:guides && yarn build:defaults:commands && yarn build:defaults:content && yarn build:defaults:tutorials", + "build:defaults": "yarn build:defaults:commands && yarn build:defaults:content && yarn build:defaults:tutorials", "prebuild": "rimraf dist", "build": "nest build", "build:prod": "rimraf dist && nest build -p ./tsconfig.build.prod.json && cross-env NODE_ENV=production", diff --git a/redisinsight/api/scripts/default-guides.ts b/redisinsight/api/scripts/default-guides.ts deleted file mode 100644 index a2dc2aa525..0000000000 --- a/redisinsight/api/scripts/default-guides.ts +++ /dev/null @@ -1,39 +0,0 @@ -import * as path from 'path'; -import { getFile, updateFolderFromArchive, updateFile } from '../src/utils/file-helper'; -import { get } from '../src/utils/config'; - -const PATH_CONFIG = get('dir_path'); -const GUIDES_CONFIG = get('guides'); - -const archiveUrl = new URL(path.join( - GUIDES_CONFIG.updateUrl, - GUIDES_CONFIG.zip, -)).toString(); - -const buildInfoUrl = new URL(path.join( - GUIDES_CONFIG.updateUrl, - GUIDES_CONFIG.buildInfo, -)).toString(); - -async function init() { - try { - // // get archive - const data = await getFile(archiveUrl); - - // extract archive to default folder - await updateFolderFromArchive(PATH_CONFIG.defaultGuides, data); - - // // get build info - const buildInfo = await getFile(buildInfoUrl); - - // save build info to default folder - await updateFile(PATH_CONFIG.defaultGuides, GUIDES_CONFIG.buildInfo, buildInfo); - - process.exit(0); - } catch (e) { - console.error('Something went wrong trying to get default guides archive', e); - process.exit(1); - } -} - -init(); diff --git a/redisinsight/api/src/modules/statics-management/providers/auto-updated-statics.provider.spec.ts b/redisinsight/api/src/modules/statics-management/providers/auto-updated-statics.provider.spec.ts index 3791481f9f..211579edc8 100644 --- a/redisinsight/api/src/modules/statics-management/providers/auto-updated-statics.provider.spec.ts +++ b/redisinsight/api/src/modules/statics-management/providers/auto-updated-statics.provider.spec.ts @@ -4,7 +4,7 @@ import config from 'src/utils/config'; import { AutoUpdatedStaticsProvider } from './auto-updated-statics.provider'; const PATH_CONFIG = config.get('dir_path'); -const GUIDES = config.get('guides'); +const TUTORIALS = config.get('tutorials'); jest.mock('axios'); const mockedAxios = axios as jest.Mocked; @@ -26,13 +26,13 @@ describe('AutoUpdatedStaticsProvider', () => { jest.mock('adm-zip', () => jest.fn().mockImplementation(() => mockedAdmZip)); service = new AutoUpdatedStaticsProvider({ - name: 'GuidesProvider', - destinationPath: PATH_CONFIG.guides, - defaultSourcePath: PATH_CONFIG.defaultGuides, - updateUrl: GUIDES.updateUrl, - buildInfo: GUIDES.buildInfo, - zip: GUIDES.zip, - devMode: GUIDES.devMode, + name: 'TutorialsProvider', + destinationPath: PATH_CONFIG.tutorials, + defaultSourcePath: PATH_CONFIG.defaultTutorials, + updateUrl: TUTORIALS.updateUrl, + buildInfo: TUTORIALS.buildInfo, + zip: TUTORIALS.zip, + devMode: TUTORIALS.devMode, }); }); diff --git a/redisinsight/api/src/modules/statics-management/statics-management.module.ts b/redisinsight/api/src/modules/statics-management/statics-management.module.ts index 55a72eb963..ef60f630ac 100644 --- a/redisinsight/api/src/modules/statics-management/statics-management.module.ts +++ b/redisinsight/api/src/modules/statics-management/statics-management.module.ts @@ -6,20 +6,12 @@ import { AutoUpdatedStaticsProvider } from './providers/auto-updated-statics.pro const SERVER_CONFIG = config.get('server') as Config['server']; const PATH_CONFIG = config.get('dir_path') as Config['dir_path']; -const GUIDES_CONFIG = config.get('guides') as Config['guides']; const TUTORIALS_CONFIG = config.get('tutorials') as Config['tutorials']; const CONTENT_CONFIG = config.get('content'); @Module({ imports: [ - ServeStaticModule.forRoot({ - serveRoot: SERVER_CONFIG.guidesUri, - rootPath: join(PATH_CONFIG.guides), - serveStaticOptions: { - fallthrough: false, - }, - }), ServeStaticModule.forRoot({ serveRoot: SERVER_CONFIG.tutorialsUri, rootPath: join(PATH_CONFIG.tutorials), @@ -64,15 +56,6 @@ const CONTENT_CONFIG = config.get('content'); }), ], providers: [ - { - provide: 'GuidesProvider', - useFactory: () => new AutoUpdatedStaticsProvider({ - name: 'GuidesProvider', - destinationPath: PATH_CONFIG.guides, - defaultSourcePath: PATH_CONFIG.defaultGuides, - ...GUIDES_CONFIG, - }), - }, { provide: 'TutorialsProvider', useFactory: () => new AutoUpdatedStaticsProvider({