eduvia/workavia-drive
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

♻️ oo-connector: refactored router system to something more coherent (#525)

Browse Source
This commit is contained in:
Eric Doughty-Papassideris
2024-09-04 03:47:59 +02:00
parent afe6562804
commit 9bc9dcafee
10 changed files with 97 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tdrive/connectors/onlyoffice-connector/src/app.ts
+7 -8
View File
@@ -5,24 +5,25 @@ import cors from 'cors';
import { renderFile } from 'eta';
import path from 'path';
import errorMiddleware from './middlewares/error.middleware';
import { SERVER_PORT, SERVER_PREFIX } from '@config';
import { SERVER_PORT } from '@config';
import logger from './lib/logger';
import cookieParser from 'cookie-parser';
import apiService from './services/api.service';
import onlyofficeService from './services/onlyoffice.service';
import { makeURLTo, mountRoutes } from './routes';
class App {
public app: express.Application;
public env: string;
public port: string | number;
constructor(routes: Routes[]) {
constructor() {
this.app = express();
this.env = NODE_ENV;
this.initViews();
this.initMiddlewares();
this.initRoutes(routes);
this.initRoutes();
this.initErrorHandling();
}
@@ -34,15 +35,13 @@ class App {
public getServer = () => this.app;
private initRoutes = (routes: Routes[]) => {
private initRoutes = () => {
this.app.use((req, res, next) => {
logger.info(`Received request: ${req.method} ${req.originalUrl} from ${req.header('user-agent')} (${req.ip})`);
next();
});
routes.forEach(route => {
this.app.use(route.path ?? '/', route.router);
});
mountRoutes(this.app);
this.app.get('/health', (_req, res) => {
Promise.all([onlyofficeService.getLatestLicence(), apiService.hasToken(), onlyofficeService.getForgottenList()]).then(
@@ -58,7 +57,7 @@ class App {
});
this.app.use(
SERVER_PREFIX.replace(/\/$/, '') + '/assets',
makeURLTo.assets(),
(req, res, next) => {
res.header('Access-Control-Allow-Origin', '*');
res.header('Access-Control-Allow-Headers', 'X-Requested-With');
tdrive/connectors/onlyoffice-connector/src/config/index.ts
+2
View File
@@ -16,3 +16,5 @@ export const {
export const twakeDriveTokenRefrehPeriodMS = 10 * 60 * 1000;
export const onlyOfficeForgottenFilesCheckPeriodMS = 10 * 60 * 1000;
export const onlyOfficeConnectivityCheckPeriodMS = 10 * 60 * 1000;
export const SERVER_TDRIVE_API_PREFIX = '/tdriveApi/1';
tdrive/connectors/onlyoffice-connector/src/controllers/index.controller.ts → tdrive/connectors/onlyoffice-connector/src/controllers/browser-editor.controller.ts
+6 -7
View File
@@ -1,13 +1,13 @@
import editorService from '@/services/editor.service';
import { NextFunction, Request, Response } from 'express';
import { CREDENTIALS_SECRET, SERVER_ORIGIN, SERVER_PREFIX } from '@config';
import { CREDENTIALS_SECRET } from '@config';
import jwt from 'jsonwebtoken';
import driveService from '@/services/drive.service';
import { DriveFileType } from '@/interfaces/drive.interface';
import fileService from '@/services/file.service';
import { OfficeToken } from '@/interfaces/routes.interface';
import logger from '@/lib/logger';
import * as Utils from '@/utils';
import { makeURLTo } from '@/routes';
interface RequestQuery {
mode: string;
@@ -29,7 +29,7 @@ interface RequestEditorQuery {
* The user is redirected from there to open directly the OnlyOffice edition server's web UI, with appropriate preview or not
* and rights checks.
*/
class IndexController {
class BrowserEditorController {
/**
* Opened by the user's browser, proxied through the Twake Drive backend. Checks access to the
* file with the backend, then redirects the user to the `editor` method but directly on this
@@ -98,9 +98,8 @@ class IndexController {
expiresIn: 60 * 60 * 24 * 30,
},
);
res.redirect(
Utils.joinURL([SERVER_ORIGIN ?? '', SERVER_PREFIX, 'editor'], {
makeURLTo.editorAbsolute({
token,
file_id,
editing_session_key: editingSessionKey,
@@ -145,7 +144,7 @@ class IndexController {
res.render('index', {
...initResponse,
docId: preview ? file_id : editing_session_key,
server: Utils.joinURL([SERVER_ORIGIN, SERVER_PREFIX]),
server: makeURLTo.rootAbsolute(),
token: inPageToken,
});
} catch (error) {
@@ -155,4 +154,4 @@ class IndexController {
};
}
export default IndexController;
export default BrowserEditorController;
tdrive/connectors/onlyoffice-connector/src/middlewares/error.middleware.ts
+2 -3
View File
@@ -1,7 +1,6 @@
import logger from '@/lib/logger';
import { NextFunction, Request, Response } from 'express';
import * as Utils from '@/utils';
import { SERVER_ORIGIN, SERVER_PREFIX } from '@config';
import { makeURLTo } from '@/routes';
export default (error: Error & { status?: number }, req: Request, res: Response, next: NextFunction): void => {
try {
@@ -12,7 +11,7 @@ export default (error: Error & { status?: number }, req: Request, res: Response,
res.status(status);
res.render('error', {
server: Utils.joinURL([SERVER_ORIGIN, SERVER_PREFIX]),
server: makeURLTo.rootAbsolute(),
errorMessage: message,
});
} catch (error) {
tdrive/connectors/onlyoffice-connector/src/routes/backend-callbacks.route.ts
+8 -13
View File
@@ -1,21 +1,16 @@
import TwakeDriveBackendCallbackController from '@/controllers/backend-callbacks.controller';
import { Routes } from '@/interfaces/routes.interface';
import authMiddleware from '@/middlewares/auth.middleware';
import { Router } from 'express';
import type { Router } from 'express';
/**
* These routes are called by Twake Drive backend, for ex. before editing or retreiving a file,
* if it has an editing_session_key still, get the status of that and force a resolution.
*/
export default class TwakeDriveBackendCallbackRoutes implements Routes {
public readonly router = Router();
public readonly path = '/tdriveApi/1';
private readonly controller: TwakeDriveBackendCallbackController;
constructor() {
this.controller = new TwakeDriveBackendCallbackController();
export const TwakeDriveBackendCallbackRoutes = {
mount(router: Router) {
const controller = new TwakeDriveBackendCallbackController();
// Why post ? to garantee it is never cached and always ran
this.router.post('/session/:editing_session_key/check', authMiddleware, this.controller.checkSessionStatus);
this.router.delete('/session/:editing_session_key', authMiddleware, this.controller.deleteSessionKey);
}
}
router.post('/session/:editing_session_key/check', authMiddleware, controller.checkSessionStatus);
router.delete('/session/:editing_session_key', authMiddleware, controller.deleteSessionKey);
},
};
tdrive/connectors/onlyoffice-connector/src/routes/browser-editor.route.ts
+16
View File
@@ -0,0 +1,16 @@
import BrowserEditorController from '@/controllers/browser-editor.controller';
import authMiddleware from '@/middlewares/auth.middleware';
import requirementsMiddleware from '@/middlewares/requirements.middleware';
import type { Router } from 'express';
/**
* When the user previews or edits a file in Twake Drive, their browser is sent to these routes
* which return a webpage that instantiates the client side JS Only Office component.
*/
export const BrowserEditorRoutes = {
mount(router: Router) {
const controller = new BrowserEditorController();
router.get('/', requirementsMiddleware, authMiddleware, controller.index);
router.get('/editor', requirementsMiddleware, authMiddleware, controller.editor);
},
};
tdrive/connectors/onlyoffice-connector/src/routes/index.route.ts
-28
View File
@@ -1,28 +0,0 @@
import IndexController from '@/controllers/index.controller';
import { Routes } from '@/interfaces/routes.interface';
import authMiddleware from '@/middlewares/auth.middleware';
import requirementsMiddleware from '@/middlewares/requirements.middleware';
import { Router } from 'express';
import { SERVER_PREFIX } from '@config';
/**
* When the user previews or edits a file in Twake Drive, their browser is sent to these routes
* which return a webpage that instantiates the client side JS Only Office component.
*/
class IndexRoute implements Routes {
public path = SERVER_PREFIX;
public router = Router();
public indexController: IndexController;
constructor() {
this.indexController = new IndexController();
this.initRoutes();
}
private initRoutes = () => {
this.router.get('/', requirementsMiddleware, authMiddleware, this.indexController.index);
this.router.get('/editor', requirementsMiddleware, authMiddleware, this.indexController.editor);
};
}
export default IndexRoute;
tdrive/connectors/onlyoffice-connector/src/routes/index.ts
+43
View File
@@ -0,0 +1,43 @@
import { Application, Router } from 'express';
import * as Utils from '@/utils';
import { TwakeDriveBackendCallbackRoutes } from './backend-callbacks.route';
import { BrowserEditorRoutes } from './browser-editor.route';
import { OnlyOfficeRoutes } from './onlyoffice.route';
import { SERVER_ORIGIN, SERVER_PREFIX, SERVER_TDRIVE_API_PREFIX } from '@config';
export function mountRoutes(app: Application) {
// These routes are forwarded through the Twake Drive front, back and here
const proxiedRouter = Router();
BrowserEditorRoutes.mount(proxiedRouter);
OnlyOfficeRoutes.mount(proxiedRouter);
console.log('Mounting at ' + SERVER_PREFIX);
app.use(SERVER_PREFIX, proxiedRouter);
// These endpoints should only be accessible to the Twake Drive backend
const apiRouter = Router();
console.log('Mounting at ' + SERVER_TDRIVE_API_PREFIX);
TwakeDriveBackendCallbackRoutes.mount(apiRouter);
app.use(SERVER_TDRIVE_API_PREFIX, apiRouter);
}
export const makeURLTo = {
rootAbsolute: () => Utils.joinURL([SERVER_ORIGIN, SERVER_PREFIX]),
assets: () => Utils.joinURL([SERVER_PREFIX, 'assets']),
editorAbsolute(params: { token: string; file_id: string; editing_session_key: string; company_id: string; preview: string; office_token: string }) {
return Utils.joinURL([SERVER_ORIGIN ?? '', SERVER_PREFIX, 'editor'], params);
},
};
// export function makeURLToEditor2() {
// const initResponse = await editorService.init(company_id, file_name, file_id, user, preview, drive_file_id || file_id);
// res.render('index', {
// ...initResponse,
// docId: preview ? file_id : editing_session_key,
// server: Utils.joinURL([SERVER_ORIGIN, SERVER_PREFIX]),
// token: inPageToken,
// });
// }
tdrive/connectors/onlyoffice-connector/src/routes/onlyoffice.route.ts
+12 -20
View File
@@ -1,23 +1,15 @@
import OnlyOfficeController from '@/controllers/onlyoffice.controller';
import { Routes } from '@/interfaces/routes.interface';
import requirementsMiddleware from '@/middlewares/requirements.middleware';
import { Router } from 'express';
import { SERVER_PREFIX } from '@config';
import type { Router } from 'express';
class OnlyOfficeRoute implements Routes {
public path = SERVER_PREFIX;
public router = Router();
public onlyOfficeController: OnlyOfficeController;
constructor() {
this.onlyOfficeController = new OnlyOfficeController();
this.initRoutes();
}
private initRoutes = () => {
this.router.get(`:mode/read`, requirementsMiddleware, this.onlyOfficeController.read);
this.router.post(`:mode/callback`, requirementsMiddleware, this.onlyOfficeController.ooCallback);
};
}
export default OnlyOfficeRoute;
/**
* These routes are called by the Only Office server
* when reading a document or updating an editing session
*/
export const OnlyOfficeRoutes = {
mount(router: Router) {
const controller = new OnlyOfficeController();
router.get(`/:mode/read`, requirementsMiddleware, controller.read);
router.post(`/:mode/callback`, requirementsMiddleware, controller.ooCallback);
},
};
tdrive/connectors/onlyoffice-connector/src/server.ts
+1 -4
View File
@@ -1,8 +1,5 @@
import App from '@/app';
import IndexRoute from './routes/index.route';
import OnlyOfficeRoute from './routes/onlyoffice.route';
import TwakeDriveBackendCallbacksRoutes from './routes/backend-callbacks.route';
const app = new App([new IndexRoute(), new OnlyOfficeRoute(), new TwakeDriveBackendCallbacksRoutes()]);
const app = new App();
app.listen();