RD-5740 Migrate backend to TypeScript - part 1 (#2179)

* Migrate samlSetup.ts, LoggerHandler.ts and config.ts
* Remove unused functions and imports
* Refactor DB models types to allow using model data in frontend
* Add types for most of the backend routes
* Migrate backend tests to TypeScript

Author: qooban

app/actions/managers.ts

@@ -13,7 +13,7 @@ import { clearContext } from './context';
 import { setLicense, setLicenseRequired } from './license';
 import { setVersion } from './version';
 import type { ReduxState } from '../reducers';
-import type { AuthUserResponse } from '../../backend/routes/Auth.types';
+import type { GetAuthUserResponse } from '../../backend/routes/Auth.types';
 
 function requestLogin() {
     return {
@@ -77,7 +77,7 @@ export function login(
     };
 }
 
-function responseUserData({ username, role, groupSystemRoles, tenantsRoles, showGettingStarted }: AuthUserResponse) {
+function responseUserData({ username, role, groupSystemRoles, tenantsRoles, showGettingStarted }: GetAuthUserResponse) {
     return {
         type: types.SET_USER_DATA,
         username,

app/components/AuthRoutes.tsx

@@ -15,7 +15,7 @@ import Layout from '../containers/layout/Layout';
 import LicensePage from '../containers/LicensePage';
 import MaintenanceMode from '../containers/maintenance/MaintenanceModePageMessage';
 import SplashLoadingScreen from '../utils/SplashLoadingScreen';
-import type { AuthUserResponse } from '../../backend/routes/Auth.types';
+import type { GetAuthUserResponse } from '../../backend/routes/Auth.types';
 
 class NoTenantsError extends Error {}
 
@@ -34,7 +34,7 @@ const AuthRoutes: FunctionComponent = () => {
         dispatch(getManagerData())
             .then(() => dispatch(getTenants()))
             .then(() => dispatch(getUserData()))
-            .then(({ tenantsRoles, role }: AuthUserResponse) => {
+            .then(({ tenantsRoles, role }: GetAuthUserResponse) => {
                 if (isEmpty(tenantsRoles) && role !== Consts.ROLE.SYS_ADMIN) throw new NoTenantsError();
                 setManagerDataFetched();
             })

app/tsconfig.json

@@ -4,6 +4,7 @@
         "types": [],
         "plugins": [{ "name": "typescript-styled-plugin" }]
     },
-    "include": ["**/*", "**/*.json", "../backend/consts.ts", "../backend/serverSettings.ts", "../backend/types.ts", "../backend/routes/*.types.ts", "../backend/sharedUtils.ts", "../conf/*.json"],
+    "include": ["**/*", "**/*.json", "../backend/consts.ts", "../backend/serverSettings.ts", "../backend/**/types.ts",
+      "../backend/**/*.types.ts", "../backend/sharedUtils.ts", "../conf/*.json"],
     "files": ["../package.json"]
 }

app/utils/ConfigLoader.ts

@@ -2,10 +2,10 @@ import log from 'loglevel';
 import fetch from 'isomorphic-fetch';
 
 import StageUtils from './stageUtils';
-import type { ClientConfig } from '../../backend/routes/Config.types';
+import type { GetConfigResponse } from '../../backend/routes/Config.types';
 
 export default class ConfigLoader {
-    static load(): Promise<ClientConfig> {
+    static load(): Promise<GetConfigResponse> {
         return fetch(StageUtils.Url.url('/config'))
             .then(response => response.json())
             .catch(e => {

app/utils/auth.ts

@@ -6,7 +6,7 @@ import External from './External';
 import Internal from './Internal';
 import encodeTextToBase64 from './encodeTextToBase64';
 import type { ManagerData, LicenseData, LicenseStatus } from '../reducers/managerReducer';
-import type { AuthUserResponse, LicenseResponse } from '../../backend/routes/Auth.types';
+import type { GetAuthUserResponse, LicenseResponse } from '../../backend/routes/Auth.types';
 
 export default class Auth {
     static login(username: string, password: string) {
@@ -21,7 +21,7 @@ export default class Auth {
 
     static getUserData(managerData: ManagerData) {
         const internal = new Internal(managerData);
-        return internal.doGet('/auth/user') as Promise<AuthUserResponse>;
+        return internal.doGet('/auth/user') as Promise<GetAuthUserResponse>;
     }
 
     static logout(managerData: ManagerData) {

backend/app.ts

@@ -1,17 +1,15 @@
-// @ts-nocheck File not migrated fully to TS
 import fs from 'fs';
 import path from 'path';
 import expressStaticGzip from 'express-static-gzip';
 import express from 'express';
 import passport from 'passport';
 import cookieParser from 'cookie-parser';
 import morgan from 'morgan';
-import type { Router } from 'express';
+import type { ErrorRequestHandler, Router } from 'express';
 
-import { getConfig, getClientConfig } from './config';
+import { getConfig } from './config';
 import { CONTEXT_PATH } from './consts';
 import LoggerHandler from './handler/LoggerHandler';
-import { getMode } from './serverSettings';
 import { getResourcePath } from './utils';
 
 import getCookieStrategy from './auth/CookieStrategy';
@@ -46,13 +44,13 @@ const app = express();
 
 app.use(morgan('short', { stream: LoggerHandler.getStream('Express') }));
 
-app.all('/', (request, response) => {
+app.all('/', (_request, response) => {
     logger.info(`Redirecting to "${contextPath}".`);
     response.redirect(contextPath);
 });
 
 // For dev purposes
-app.use(contextPath, (req, res, next) => {
+app.use(contextPath, (_req, res, next) => {
     // Setting access control allow origin headers
     res.setHeader('Access-Control-Allow-Origin', 'http://localhost:4000');
     // Request methods you wish to allow
@@ -64,7 +62,7 @@ app.use(contextPath, (req, res, next) => {
     );
     // Set to true if you need the website to include cookies in the requests sent
     // to the API (e.g. in case you use sessions)
-    res.setHeader('Access-Control-Allow-Credentials', true);
+    res.setHeader('Access-Control-Allow-Credentials', 'true');
 
     next();
 });
@@ -83,11 +81,11 @@ app.use(passport.initialize());
 app.use(
     `${contextPath}/appData`,
     authenticateWithCookie,
-    expressStaticGzip(path.resolve(__dirname, '../dist/appData'), { indexFromEmptyFile: false })
+    expressStaticGzip(path.resolve(__dirname, '../dist/appData'), { index: false })
 );
 
 const translationsOverrides = 'overrides.json';
-app.use(`${contextPath}/userData/${translationsOverrides}`, (req, res) => {
+app.use(`${contextPath}/userData/${translationsOverrides}`, (_req, res) => {
     const overridesPath = getResourcePath(translationsOverrides, true);
     if (fs.existsSync(overridesPath)) res.sendFile(overridesPath);
     else res.send({});
@@ -97,7 +95,7 @@ app.use(
     `${contextPath}/userData`,
     authenticateWithCookie,
     expressStaticGzip(getResourcePath('', true), {
-        indexFromEmptyFile: false
+        index: false
     })
 );
 // API Routes with authentication
@@ -149,8 +147,7 @@ app.get('*', (request, response) => {
  * NOTE: error handlers must have 4 parameters, even if the last one is unused
  * @see https://expressjs.com/en/guide/error-handling.html
  */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-app.use((err, req, res, next) => {
+const errorHandler: ErrorRequestHandler = (err, _req, res, _next) => {
     logger.error('Error has occured ', err);
 
     let { message } = err;
@@ -159,6 +156,7 @@ app.use((err, req, res, next) => {
     }
 
     res.status(err.status || 404).send({ message: message || err });
-});
+};
+app.use(errorHandler);
 
 export default app;

backend/auth/SamlStrategy.ts

@@ -1,4 +1,5 @@
 import { Strategy } from 'passport-saml';
+import type { Strategy as PassportStrategy } from 'passport';
 import type { VerifyWithoutRequest } from 'passport-saml';
 import fs from 'fs';
 import { getConfig } from '../config';
@@ -18,5 +19,5 @@ export default () => {
             cert
         },
         ((user, done) => done(null, user!)) as VerifyWithoutRequest
-    );
+    ) as PassportStrategy;
 };

backend/config.ts

@@ -1,4 +1,3 @@
-// @ts-nocheck File not migrated fully to TS
 /* eslint-disable node/no-unpublished-import,global-require,import/no-dynamic-require */
 import _ from 'lodash';
 import flatten from 'flat';
@@ -22,7 +21,7 @@ try {
     let userDataConfig: Partial<UserConfig> = require(userDataConfigPath);
     userDataConfig = _.pick(userDataConfig, _.keys(flatten(userConfig, { safe: true }))); // Security reason - get only allowed parameters
     userConfig = _.defaultsDeep(userDataConfig, userConfig); // Create full user configuration
-} catch (err) {
+} catch (err: any) {
     if (err.code !== 'MODULE_NOT_FOUND') {
         throw err;
     }
@@ -34,7 +33,7 @@ export function loadMeJson() {
     try {
         // eslint-disable-next-line import/no-unresolved
         me = require('../conf/me.json');
-    } catch (err) {
+    } catch (err: any) {
         if (err.code !== 'MODULE_NOT_FOUND') {
             throw err;
         }

backend/db/models/BlueprintAdditionsModel.ts

@@ -1,10 +1,8 @@
-import type { CommonAttributes, Model, ModelFactory, Optional } from './types';
+// eslint-disable-next-line import/no-extraneous-dependencies,node/no-unpublished-import
+import type { Model, Optional } from 'sequelize';
+import type { ModelFactory } from 'cloudify-ui-common/backend/db';
+import type { BlueprintAdditionsAttributes } from './BlueprintAdditionsModel.types';
 
-interface BlueprintAdditionsAttributes extends CommonAttributes {
-    blueprintId: string;
-    image: any;
-    imageUrl: string;
-}
 type BlueprintAdditionsCreationAttributes = Optional<BlueprintAdditionsAttributes, 'image' | 'imageUrl'>;
 export type BlueprintAdditionsInstance = Model<BlueprintAdditionsAttributes, BlueprintAdditionsCreationAttributes> &
     BlueprintAdditionsAttributes;

backend/db/models/BlueprintAdditionsModel.types.ts

@@ -0,0 +1,9 @@
+import type { CommonAttributes } from './types';
+
+export interface BlueprintAdditionsData {
+    blueprintId: string;
+    image: any;
+    imageUrl: string;
+}
+
+export type BlueprintAdditionsAttributes = CommonAttributes & BlueprintAdditionsData;

backend/db/models/BlueprintUserDataModel.ts

@@ -1,10 +1,8 @@
-import type { CommonAttributes, Model, ModelFactory } from './types';
+// eslint-disable-next-line import/no-extraneous-dependencies,node/no-unpublished-import
+import type { Model } from 'sequelize';
+import type { ModelFactory } from 'cloudify-ui-common/backend/db';
+import type { BlueprintUserDataAttributes } from './BlueprintUserDataModel.types';
 
-interface BlueprintUserDataAttributes extends CommonAttributes {
-    blueprintId: string;
-    username: string;
-    layout: any;
-}
 type BlueprintUserDataCreationAttributes = BlueprintUserDataAttributes;
 export type BlueprintUserDataInstance = Model<BlueprintUserDataAttributes, BlueprintUserDataCreationAttributes> &
     BlueprintUserDataAttributes;

backend/db/models/BlueprintUserDataModel.types.ts

@@ -0,0 +1,8 @@
+import type { CommonAttributes } from './types';
+
+export interface BlueprintUserData {
+    blueprintId: string;
+    username: string;
+    layout: any;
+}
+export type BlueprintUserDataAttributes = CommonAttributes & BlueprintUserData;

backend/db/models/ResourcesModel.ts

@@ -1,6 +1,10 @@
-import type { CommonAttributes, Model, ModelFactory, Optional } from './types';
+// eslint-disable-next-line import/no-extraneous-dependencies,node/no-unpublished-import
+import type { Model, Optional } from 'sequelize';
+import type { ModelFactory } from 'cloudify-ui-common/backend/db';
+
 import type { ResourceType } from '../types/ResourceTypes';
 import ResourceTypes from '../types/ResourceTypes';
+import type { CommonAttributes } from './types';
 
 interface ResourcesAttributes extends CommonAttributes {
     resourceId: string;

backend/db/models/UserAppsModel.ts

@@ -1,16 +1,11 @@
-import type { CommonAttributes, Model, ModelFactory } from './types';
-import type { Mode } from '../../serverSettings';
+// eslint-disable-next-line import/no-extraneous-dependencies,node/no-unpublished-import
+import type { Model } from 'sequelize';
+import type { ModelFactory } from 'cloudify-ui-common/backend/db';
+
 import { MODE_COMMUNITY, MODE_CUSTOMER, MODE_MAIN } from '../../serverSettings';
-import type { PageFileDefinition } from '../../routes/Templates.types';
+import type { UserAppsAttributes } from './UserAppsModel.types';
 
-interface UserAppsAttributes extends CommonAttributes {
-    username: string;
-    appDataVersion: number;
-    mode: Mode;
-    tenant: string;
-    appData: { pages: PageFileDefinition[] };
-}
-type UserAppsCreationAttributes = UserAppsAttributes;
+export type UserAppsCreationAttributes = UserAppsAttributes;
 export type UserAppsInstance = Model<UserAppsAttributes, UserAppsCreationAttributes> & UserAppsAttributes;
 
 const UserAppsModelFactory: ModelFactory<UserAppsInstance> = (sequelize, dataTypes) =>

backend/db/models/UserAppsModel.types.ts

@@ -0,0 +1,13 @@
+import type { CommonAttributes } from './types';
+import type { Mode } from '../../serverSettings';
+import type { PageFileDefinition } from '../../routes/Templates.types';
+
+export interface UserAppsData {
+    username: string;
+    appDataVersion: number;
+    mode: Mode;
+    tenant: string;
+    appData: { pages: PageFileDefinition[] };
+}
+
+export type UserAppsAttributes = CommonAttributes & UserAppsData;

backend/db/models/WidgetBackendsModel.ts

@@ -1,11 +1,8 @@
-import type { CommonAttributes, Model, ModelFactory, Optional } from './types';
+// eslint-disable-next-line import/no-extraneous-dependencies,node/no-unpublished-import
+import type { Model, Optional } from 'sequelize';
+import type { ModelFactory } from 'cloudify-ui-common/backend/db';
+import type { WidgetBackendsAttributes } from './WidgetBackendsModel.types';
 
-interface WidgetBackendsAttributes extends CommonAttributes {
-    widgetId: string;
-    serviceName: string;
-    method: string;
-    script: string;
-}
 type WidgetBackendsCreationAttributes = Optional<WidgetBackendsAttributes, 'script'>;
 export type WidgetBackendsInstance = Model<WidgetBackendsAttributes, WidgetBackendsCreationAttributes> &
     WidgetBackendsAttributes;

backend/db/models/WidgetBackendsModel.types.ts

@@ -0,0 +1,10 @@
+import type { CommonAttributes } from './types';
+
+export interface WidgetBackendsData {
+    widgetId: string;
+    serviceName: string;
+    method: string;
+    script: string;
+}
+
+export type WidgetBackendsAttributes = CommonAttributes & WidgetBackendsData;

backend/db/models/types.ts

@@ -1,7 +1,3 @@
-// eslint-disable-next-line import/no-extraneous-dependencies,node/no-unpublished-import
-export type { Model, Optional } from 'sequelize';
-export type { ModelFactory } from 'cloudify-ui-common/backend/db';
-
 export interface CommonAttributes {
     readonly id?: number;
     readonly createdAt?: Date;