feature(common) add @WithAlias route decorator #5117

sjones6 · 2020-07-19T04:06:08Z

Add @WithAlias decorator which allows arbitrary aliases to be attached to Controller methods and later retrieved in views and resolved to full route path.

Resolves #3743.

I'm not fully convinced of the implementation in router-execution-context.ts especially. This doesn't seem the best way to inject the getUrl helper into render context, so open to suggestions. This could be attached to expressApp.locals to the same effect in express.

Also, open to suggestions on getUrl method name if something else is preferred.

Lastly, does this require fastify support? If so, may require an additional e2e test.

PR Checklist

Please check if your PR fulfills the following requirements:

[x ] The commit message follows our guidelines: https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

Docs PR: nestjs/docs.nestjs.com#1400

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Other... Please describe:

What is the current behavior?

New feature/not-implemented.

Issue Number: #3743

What is the new behavior?

A new (non-breaking) decorator is available in @nestjs/common which allows arbitrary aliases to be attached to Controller route handlers, which can then be resolved to the full path of the route.

Additionally, a getUrl(alias: string, params?: object): string method is exposed for MVC views / server-rendered template views.

Example Controller:

import { Controller, Get, Render, WithAlias } from '@nestjs/common';

@Controller('hello')
export class HelloController {
  constructor(private readonly helloService: HelloService) {}

  @Get()
  @Render('hello')
  @WithAlias('hello')
  index() {
    return { message: 'Hello World!' }
  }

  @Get(':id')
  @Render('hello')
  @WithAlias('hello-id')
  index() {
    return { message: 'Hello World!', id: 1 }
  }
}

In your views...

<a href="{{ getUrl('hello') }}">Resolves to `/hello`</a>
<a href="{{ getUrl('hello-id', { id: id }) }}">Resolves to `/hello/1`</a>

Does this PR introduce a breaking change?

[ ] Yes
[x ] No

Please double check—initial implementation decorates response.locals with a getUrl method. This shouldn't cause breakages and should only be additive.

Other information

Some tests and an example were switched from hbs template engine to nunjucks, due to a limitation in hbs which disallows function evaluation in templates. Based on this issue, this seems highly unlikely to change at any time. Nunjucks, on the other hand, evaluates these as you would expect.

Add @WithAlias decorator which allows arbitrary aliases to be attached to Controller methods and later retrieved in views and resolved to full route path. Resolves nestjs#3743

sjones6 · 2020-07-19T04:06:47Z

packages/core/router/router-execution-context.ts

@@ -164,6 +167,11 @@ export class RouterExecutionContext {
    };
  }

+  public bindResponseLocals(response) {


See comment in PR. This feels unlikely to stay, but if kept—need some guidance on proper typing.

coveralls · 2020-07-19T04:14:36Z

Pull Request Test Coverage Report for Build 0cfed26a-e063-488c-9864-689cb67731c7

38 of 41 (92.68%) changed or added relevant lines in 6 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.02%) to 94.798%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
packages/core/router/router-execution-context.ts	5	6	83.33%
packages/core/router/route-alias-resolver.ts	22	24	91.67%

Totals
Change from base Build 8177763b-a5cb-48f7-b162-2e74b53bcd25:	-0.02%
Covered Lines:	4957
Relevant Lines:	5229

💛 - Coveralls

sjones6 · 2020-07-19T04:14:51Z

integration/hello-world/e2e/mvc.express.spec.ts

@@ -0,0 +1,54 @@
+import { join } from 'path';


currently, didn't see examples in integration tests that rendered html using the @Render decorator unless I'm mistaken. So, this tests that along with new changes..

kamilmysliwiec · 2020-07-29T09:41:44Z

Great job!

Can you create a PR to the docs as well? https://docs.nestjs.com/techniques/mvc

Documents the @WithAlias() decorator and getUrl helper introduced in PR nestjs/nest#5117

sjones6 · 2020-08-02T19:13:02Z

@kamilmysliwiec , sure thing. Here's a PR for the update to docs: nestjs/docs.nestjs.com#1400.

kamilmysliwiec · 2020-08-19T11:04:10Z

Thanks @sjones6! Ill review as soon as possible

kamilmysliwiec · 2020-10-30T14:08:35Z

Apologies for the delay! @sjones6 would you like to jump in once again and add an e2e test for fastify too (+ update an example)? This should be the last thing we need in order to get it merged :)

sjones6 · 2020-10-30T15:57:51Z

@kamilmysliwiec , sure—I'll get those in an ping once it's updated. (Looks like some conflicts to resolve too.)

cojack · 2020-11-19T13:31:01Z

packages/core/router/route-alias-resolver.ts

+  }
+  public register(alias: string | Symbol, basePath: string, path: string[]) {
+    if (this.aliasMap.has(alias)) {
+      throw new Error(`Conflict ${alias} already registered`);


I would like to suggest a new Error object here, like RouterAliasError or something else, Error it too much generic

RouteNameError

cojack · 2020-11-19T13:31:57Z

packages/core/router/route-alias-resolver.ts

+  private stripSlashes(str: string) {
+    return str.replace(/^\/?(.*)\/?$/, '$1')
+  }
+}


at the end of the files, there should be a new line

cojack · 2020-11-19T13:38:58Z

package.json

@@ -147,6 +147,7 @@
    "mysql": "2.18.1",
    "nats": "1.4.9",
    "nodemon": "2.0.4",
+    "nunjucks": "^3.2.1",


what's the reason to put that here?

Looks like it's for a new integration test. As it's in devDeps it should be fine

cojack · 2020-11-22T16:28:26Z

Tbh WithAlias decorator might be misleadin, I would like to suggest smth like RouteName. There is a second PR that will add ap possibility to create an alias to specific path, so looking for router alias might be difficult, pointing to two different actions.

cojack · 2021-02-02T10:37:42Z

Tbh WithAlias decorator might be misleadin, I would like to suggest smth like RouteName. There is a second PR that will add ap possibility to create an alias to specific path, so looking for router alias might be difficult, pointing to two different actions.

Nobody care?

CDaxi · 2021-02-19T04:20:43Z

@cojack: From my point of view RouteName will be the better name and i really like to see this feature in nestjs.
It will be really handy to change route paths and attributes only on one place - the controller.

omcg33 · 2021-04-05T15:01:45Z

Any steps to merge pr?

DimitriSauvage · 2021-06-01T07:12:23Z

Hello @cojack @sjones6 @kamilmysliwiec and others,

I agree with cojack, @RouteName is a better name which is more releavant than @WithAlias.
Except this little point, this is an awesome feature ! Thanks

ivmilicevic · 2021-09-03T11:47:13Z

I'm sorry but will this get merged? It seems like thing it's waiting on is name change

rpCal · 2021-09-12T08:02:58Z

@sjones6 Thank you very much for the code.... @kamilmysliwiec @cojack Any updates soon? :)

fadillzzz · 2022-03-17T00:43:17Z

Any updates on this? Seems like too good of a feature to not have as part of the official release.

spearmootz · 2022-03-25T19:01:02Z

yes please. this would be very useful for migrating from symfony

marcelobrk · 2022-06-29T20:31:46Z

What is missing for this to be merged?

engAmirEng · 2022-09-12T10:24:52Z

Is this feature ever going to be added?

MrOplus · 2022-10-28T14:57:35Z

is this pr going to get merged after almost 2 years?

corentinalcoy · 2023-06-03T09:41:20Z

@kamilmysliwiec @sjones6, It is a really nice feature, Is this PR going to be merged?

orige · 2024-07-11T18:55:19Z

Any news on this?

feature(common) add @WithAlias decorator

cb2af8a

Add @WithAlias decorator which allows arbitrary aliases to be attached to Controller methods and later retrieved in views and resolved to full route path. Resolves nestjs#3743

sjones6 commented Jul 19, 2020

View reviewed changes

sjones6 mentioned this pull request Jul 19, 2020

Named routes #3743

Closed

sjones6 commented Jul 19, 2020

View reviewed changes

kamilmysliwiec added scope: core type: feature 🎉 labels Jul 23, 2020

sjones6 added a commit to sjones6/docs.nestjs.com that referenced this pull request Aug 2, 2020

docs(content/techniques/mvc): document @WithAlias() decorator

6711e69

Documents the @WithAlias() decorator and getUrl helper introduced in PR nestjs/nest#5117

sjones6 added a commit to sjones6/docs.nestjs.com that referenced this pull request Aug 2, 2020

docs(techniques/mvc): introduce @WithAlias() decorator

cde93ca

Documents the @WithAlias() decorator and getUrl helper introduced in PR nestjs/nest#5117

sjones6 mentioned this pull request Aug 2, 2020

docs(techniques/mvc): introduce @WithAlias() decorator nestjs/docs.nestjs.com#1400

Open

1 task

kamilmysliwiec added this to the 7.5.0 milestone Oct 5, 2020

sjones6 closed this Oct 30, 2020

sjones6 reopened this Oct 30, 2020

kamilmysliwiec removed this from the 7.5.0 milestone Nov 2, 2020

cojack reviewed Nov 19, 2020

View reviewed changes

cojack suggested changes Nov 19, 2020

View reviewed changes

kamilmysliwiec mentioned this pull request Dec 21, 2020

Support generation of URLs for routes including URL params #1030

Closed

florimondmanca mentioned this pull request Sep 22, 2023

Réécriture du frontend (ancien) fairnesscoop/permacoop#406

Closed

6 tasks

florimondmanca mentioned this pull request Oct 27, 2023

Réécriture du frontend fairnesscoop/permacoop#415

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature(common) add @WithAlias route decorator #5117

feature(common) add @WithAlias route decorator #5117

sjones6 commented Jul 19, 2020 •

edited

Loading

sjones6 Jul 19, 2020

coveralls commented Jul 19, 2020

sjones6 Jul 19, 2020

kamilmysliwiec commented Jul 29, 2020

sjones6 commented Aug 2, 2020

kamilmysliwiec commented Aug 19, 2020

kamilmysliwiec commented Oct 30, 2020

sjones6 commented Oct 30, 2020

cojack Nov 19, 2020

cojack Nov 23, 2020 •

edited

Loading

cojack Nov 19, 2020

cojack Nov 19, 2020

jmcdo29 Nov 22, 2020

cojack commented Nov 22, 2020

cojack commented Feb 2, 2021

CDaxi commented Feb 19, 2021

omcg33 commented Apr 5, 2021

DimitriSauvage commented Jun 1, 2021

ivmilicevic commented Sep 3, 2021

rpCal commented Sep 12, 2021

fadillzzz commented Mar 17, 2022

spearmootz commented Mar 25, 2022

marcelobrk commented Jun 29, 2022

engAmirEng commented Sep 12, 2022

MrOplus commented Oct 28, 2022

corentinalcoy commented Jun 3, 2023

orige commented Jul 11, 2024

feature(common) add @WithAlias route decorator #5117

Are you sure you want to change the base?

feature(common) add @WithAlias route decorator #5117

Conversation

sjones6 commented Jul 19, 2020 • edited Loading

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

sjones6 Jul 19, 2020

Choose a reason for hiding this comment

coveralls commented Jul 19, 2020

Pull Request Test Coverage Report for Build 0cfed26a-e063-488c-9864-689cb67731c7

💛 - Coveralls

sjones6 Jul 19, 2020

Choose a reason for hiding this comment

kamilmysliwiec commented Jul 29, 2020

sjones6 commented Aug 2, 2020

kamilmysliwiec commented Aug 19, 2020

kamilmysliwiec commented Oct 30, 2020

sjones6 commented Oct 30, 2020

cojack Nov 19, 2020

Choose a reason for hiding this comment

cojack Nov 23, 2020 • edited Loading

Choose a reason for hiding this comment

cojack Nov 19, 2020

Choose a reason for hiding this comment

cojack Nov 19, 2020

Choose a reason for hiding this comment

jmcdo29 Nov 22, 2020

Choose a reason for hiding this comment

cojack commented Nov 22, 2020

cojack commented Feb 2, 2021

CDaxi commented Feb 19, 2021

omcg33 commented Apr 5, 2021

DimitriSauvage commented Jun 1, 2021

ivmilicevic commented Sep 3, 2021

rpCal commented Sep 12, 2021

fadillzzz commented Mar 17, 2022

spearmootz commented Mar 25, 2022

marcelobrk commented Jun 29, 2022

engAmirEng commented Sep 12, 2022

MrOplus commented Oct 28, 2022

corentinalcoy commented Jun 3, 2023

orige commented Jul 11, 2024

sjones6 commented Jul 19, 2020 •

edited

Loading

cojack Nov 23, 2020 •

edited

Loading