Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: koa-views always return the result of the first execution #780

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Fix: koa-views always return the result of the first execution #780

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cdfeb05
fix: After the first rendering of html, all request results return th…
Sep 30, 2021
01579b2
Merge branch 'develop' into develop
nanyuantingfeng Mar 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 34 additions & 4 deletions src/driver/koa/KoaDriver.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,11 +247,13 @@ export class KoaDriver extends BaseDriver {
}
} else if (action.renderedTemplate) {
// if template is set then render it // TODO: not working in koa
const renderOptions = result && result instanceof Object ? result : {};
options.context.renderOptions = {
page : action.renderedTemplate,
locals : result && result instanceof Object ? result : {},
}
// eslint-disable-next-line @typescript-eslint/unbound-method
if(this.koa.middleware.indexOf(this.loadKoaViews) === -1) this.koa.use(this.loadKoaViews)

this.koa.use(async function (ctx: any, next: any) {
await ctx.render(action.renderedTemplate, renderOptions);
});
} else if (result === undefined) {
// throw NotFoundError on undefined response
if (action.undefinedResultCode instanceof Function) {
Expand Down Expand Up @@ -401,4 +403,32 @@ export class KoaDriver extends BaseDriver {
throw new Error('@koa/multer package was not found installed. Try to install it: npm install @koa/multer --save');
}
}


/**
* This middleware fixes a bug on koa-multer implementation.
*
* This bug should be fixed by koa-multer PR #15: https://github.com/koa-modules/multer/pull/15
*/
private async fixMulterRequestAssignment(ctx: any, next: Function) {
if ('request' in ctx) {
if (ctx.req.body) ctx.request.body = ctx.req.body;
if (ctx.req.file) ctx.request.file = ctx.req.file;
if (ctx.req.files) {
ctx.request.files = ctx.req.files;
ctx.files = ctx.req.files;
}
}

return await next();
}

private async loadKoaViews(ctx: any, next: Function) {
if('renderOptions' in ctx){
return await ctx.render(ctx.renderOptions.page, ctx.renderOptions.locals)
}

return await next()
}

}
113 changes: 91 additions & 22 deletions test/functional/render-decorator.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,55 @@ import express, { Application as ExpressApplication } from 'express';
import { Server as HttpServer } from 'http';
import HttpStatusCodes from 'http-status-codes';
import mustacheExpress from 'mustache-express';
import koaViews from 'koa-views';
import path from 'path';
import { Controller } from '../../src/decorator/Controller';
import { Get } from '../../src/decorator/Get';
import { Render } from '../../src/decorator/Render';
import { Res } from '../../src/decorator/Res';
import { createExpressServer, getMetadataArgsStorage } from '../../src/index';
import { createExpressServer, createKoaServer, getMetadataArgsStorage } from '../../src/index';
import { axios } from '../utilities/axios';
import DoneCallback = jest.DoneCallback;

describe(``, () => {
let expressServer: HttpServer;

function cases(){

it('should render a template and use given variables', async () => {
expect.assertions(6);
const response = await axios.get('/index');
expect(response.status).toEqual(HttpStatusCodes.OK);
expect(response.data).toContain('<html>');
expect(response.data).toContain('<body>');
expect(response.data).toContain('Routing-controllers');
expect(response.data).toContain('</body>');
expect(response.data).toContain('</html>');
});

it('should render a template with given variables and locals variables', async () => {
expect.assertions(7);
const response = await axios.get('/locals');
expect(response.status).toEqual(HttpStatusCodes.OK);
expect(response.data).toContain('<html>');
expect(response.data).toContain('<body>');
expect(response.data).toContain('Routing-controllers');
expect(response.data).toContain('my-variable');
expect(response.data).toContain('</body>');
expect(response.data).toContain('</html>');
});

it('should render to different html by random variables', async () => {
expect.assertions(2);
const response = await axios.get('/random');
expect(response.status).toEqual(HttpStatusCodes.OK);
const response2 = await axios.get('/random');
expect(response.data).not.toEqual(response2.data)
});
}

describe('template rendering', () => {
let expressServer: HttpServer;

beforeAll((done: DoneCallback) => {
getMetadataArgsStorage().reset();

Expand All @@ -37,6 +73,14 @@ describe(``, () => {
name: 'Routing-controllers',
};
}

@Get('/random')
@Render('render-test-spec.html')
random(): any {
return {
name: Math.random(),
};
}
}

const resourcePath: string = path.resolve(__dirname, '../resources');
Expand All @@ -52,27 +96,52 @@ describe(``, () => {
expressServer.close(done);
});

it('should render a template and use given variables', async () => {
expect.assertions(6);
const response = await axios.get('/index');
expect(response.status).toEqual(HttpStatusCodes.OK);
expect(response.data).toContain('<html>');
expect(response.data).toContain('<body>');
expect(response.data).toContain('Routing-controllers');
expect(response.data).toContain('</body>');
expect(response.data).toContain('</html>');
});
cases()
});

it('should render a template with given variables and locals variables', async () => {
expect.assertions(7);
const response = await axios.get('/locals');
expect(response.status).toEqual(HttpStatusCodes.OK);
expect(response.data).toContain('<html>');
expect(response.data).toContain('<body>');
expect(response.data).toContain('Routing-controllers');
expect(response.data).toContain('my-variable');
expect(response.data).toContain('</body>');
expect(response.data).toContain('</html>');
describe('template rendering in koa', () => {
let koaServer: HttpServer;

beforeAll((done: DoneCallback) => {
getMetadataArgsStorage().reset();

@Controller()
class RenderController {
@Get('/index')
@Render('render-test-spec.html')
index(): any {
return {
name: 'Routing-controllers',
};
}

@Get('/locals')
@Render('render-test-locals-spec.html')
locals(@Res() res: any): any {

return {
name: 'Routing-controllers',
myVariable: 'my-variable'
};
}

@Get('/random')
@Render('render-test-spec.html')
random(): any {
return {
name: Math.random(),
};
}
}

const resourcePath: string = path.resolve(__dirname, '../resources');
const app = createKoaServer();
app.use(koaViews(resourcePath, { map: { html: "handlebars" }}));
koaServer = app.listen(3001, done);
});

afterAll((done: DoneCallback) => koaServer.close(done));

cases()
});
});