Fix problems caused by routerPath

[cooperhsiung]

ctx.params is unexpectedly affected by other routers

const Koa = require('koa');
const Router = require('@koa/router');

const app = new Koa();
const router1 = new Router();
const router2 = new Router();

router1.get('/users/:userId', async (ctx, next) => {
 console.log(ctx.params) // got { userId: '123' }
 await next();
});

router2.get('/users/:id', async (ctx, next) => {
 console.log(ctx.params) // got { userId: '123', id: ':userId' }
 ctx.body = 'hello, user is ' + ctx.params.id;
});

app.use(router1.routes());
app.use(router2.routes());

app.listen(3000);

send a request

const axios = require('axios');

axios
  .get('http://127.0.0.1:3000/users/123')
  .then((ret) => {
    console.log(ret.data);  // got hello, user is :userId
  })
  .catch((err) => {
    console.error(err);
  });

what is expected is hello, user is 123, instead of hello, user is :userId

I found that the problem stemmed from this line:

router/lib/router.js

Line 366 in 1aead99

ctx.routerPath = layer.path;

It seems that it has caused a series of problems

originnal feature imports

• supports custom routing detect path: ctx.routerPath ZijianHe/koa-router#73
• The ctx. _matchedRoute is not the match route. #34

unexpected code import

• Fix current ctx._matchedRoute #93

related pull requests

• [WIP] Add routerPath to Context #85
• Fix ctx.routerPath causes routes to fail path matches issue #102
• fix: other routers except the first one fails to match in some scenes #123

related issues

• The matchedRoute fix is a breaking change and should be documented #126
• ctx.routerPath causes routes to fail path matches #101

ctx.params shouldn't have been affected by other routers, this looks like a bug that needs to be fixed for this essential module of the koa ecosystem.

In order not to break compatibility, I choose to restore ctx.routerPath after layers match and added corresponding tests

[etroynov]

@3imed-jaberi, @alecmev can you look at it?

[titanism]

We have just published @koajs/router v11.0.0 which resolves this issue. This is mirrored to koa-router as well.

https://github.com/koajs/router/releases/tag/v11.0.0

This project is maintained by Forward Email and Lad.