fix(aio): update redirects to fix unwanted 404s #21712
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,7 +19,7 @@ | |
| "routing": { | ||
| "index": "/index.html", | ||
| "routes": { | ||
| "^(?!/docs/.|(?:/guide/(?:cli-quickstart|metadata|ngmodule|service-worker-(?:getstart|comm|configref)|learning-angular)|/news/?)$|/testing|/api/(?:common/NgModel|platform-browser/AnimationDriver|testing|api)).*/(?!e?plnkr|(?:NgFor|MaxLengthValidator)-|Control(?:Group)?|AnimationStateDeclarationMetadata|CORE_DIRECTIVES|PLATFORM_PIPES|DirectiveMetadata|HTTP_PROVIDERS)[^/.]*$": { | ||
|
There was a problem hiding this comment. The -|/news/?)$
+|/news)/?$There was a problem hiding this comment. Are you sure? There was a problem hiding this comment. This is because of this PR. Before that, the optional trailing There was a problem hiding this comment. But this PR has not landed on 5.2 yet. |
||
| "match": "regex" | ||
| } | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| import { FirebaseGlob } from './FirebaseGlob'; | ||
|
|
||
| describe('FirebaseGlob', () => { | ||
|
|
||
| describe('test', () => { | ||
| it('should match * parts', () => { | ||
| testGlob('asdf/*.jpg', | ||
| ['asdf/asdf.jpg', 'asdf/asdf_asdf.jpg', 'asdf/.jpg'], | ||
| ['asdf/asdf/asdf.jpg', 'xxxasdf/asdf.jpgxxx']); | ||
| }); | ||
|
|
||
| it('should match ** parts', () => { | ||
| testGlob('asdf/**.jpg', | ||
| ['asdf/asdf.jpg', 'asdf/asdf_asdf.jpg', 'asdf/asdf/asdf.jpg', 'asdf/asdf/asdf/asdf/asdf.jpg'], | ||
| ['/asdf/asdf.jpg', 'asdff/asdf.jpg', 'xxxasdf/asdf.jpgxxx']); | ||
|
|
||
| testGlob('**/*.js', | ||
| ['asdf/asdf.js', 'asdf/asdf/asdfasdf_asdf.js', '/asdf/asdf.js', '/asdf/aasdf-asdf.2.1.4.js'], | ||
| ['/asdf/asdf.jpg', 'asdf.js']); | ||
| }); | ||
|
|
||
| it('should match groups', () => { | ||
| testGlob('asdf/*.(jpg|jpeg)', | ||
|
There was a problem hiding this comment. According to this, we should use There was a problem hiding this comment. Yes, this is my bad. |
||
| ['asdf/asdf.jpg', 'asdf/asdf_asdf.jpeg'], | ||
| ['/asdf/asdf.jpg', 'asdff/asdf.jpg']); | ||
|
There was a problem hiding this comment. Maybe test with a different extension as well. |
||
| }); | ||
|
|
||
| it('should match named parts', () => { | ||
| testGlob('/api/:package/:api-*', | ||
| ['/api/common/NgClass-directive', '/api/core/Renderer-class'], | ||
| ['/moo/common/NgClass-directive', '/api/common/', '/api/common/NgClass']); | ||
| }); | ||
|
|
||
| it('should match wildcard named parts', () => { | ||
| testGlob('/api/:rest*', | ||
| ['/api/a', '/api/a/b'], | ||
| ['/apx/a', '/apx/a/b']); | ||
| }); | ||
| }); | ||
|
|
||
| describe('match', () => { | ||
| it('should extract the named parts', () => { | ||
| const glob = new FirebaseGlob('/api/:package/:api-*'); | ||
| const match: any = glob.match('/api/common/NgClass-directive'); | ||
| expect(match).toEqual({package: 'common', api: 'NgClass'}); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| function testGlob(pattern: string, matches: string[], nonMatches: string[]) { | ||
| const glob = new FirebaseGlob(pattern); | ||
| matches.forEach(url => expect(glob.test(url)).toBe(true, url)); | ||
| nonMatches.forEach(url => expect(glob.test(url)).toBe(false, url)); | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| import * as XRegExp from 'xregexp'; | ||
|
|
||
| const questionExpr = /\?([^(])/g; | ||
| const catchAllNamedMatchExpr = /\/:([A-Za-z]+)\*/g | ||
| const namedMatchExpr = /\/:([A-Za-z]+)([^/]*)/g | ||
|
There was a problem hiding this comment. Nit: The |
||
| const wildcardSegmentExpr = /(^\/).🐷\//; | ||
|
There was a problem hiding this comment. The |
||
|
|
||
| export class FirebaseGlob { | ||
| pattern: string; | ||
| regex: XRegExp; | ||
| constructor(glob: string) { | ||
| const pattern = glob | ||
| .replace('.', '\\.') | ||
| .replace(questionExpr, '[^/]$1') | ||
|
There was a problem hiding this comment. There is no test for that 😉 There was a problem hiding this comment. I think we need to mock as close to Firebase as possible, otherwise our own redirect tests might not represent what happens in the real deployment. Perhaps we inadvertently add in a There was a problem hiding this comment. 👍 for that, as long as we test all the features we support 😛 |
||
| .replace(catchAllNamedMatchExpr, '/(?<$1>.+)') | ||
| .replace(namedMatchExpr, '/(?<$1>[^/]+)$2') | ||
| .replace('**', '.🐷') | ||
| .replace('*', '[^/]*') | ||
| .replace(wildcardSegmentExpr, '(?:$1|/.*/)') | ||
| .replace('.🐷', '.*'); | ||
| this.pattern = `^${pattern}$`; | ||
| this.regex = XRegExp(this.pattern); | ||
| } | ||
|
|
||
| test(url: string) { | ||
| return XRegExp.test(url, this.regex); | ||
| } | ||
|
|
||
| match(url: string) { | ||
| const match = XRegExp.exec(url, this.regex); | ||
| if (match) { | ||
| const result = {}; | ||
| const names = (this.regex as any).xregexp.captureNames || []; | ||
| names.forEach(name => result[name] = match[name]); | ||
| return result; | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| import { FirebaseRedirect } from './FirebaseRedirect'; | ||
|
|
||
| describe('FirebaseRedirect', () => { | ||
| describe('replace', () => { | ||
| it('should inject the named captures into the destination', () => { | ||
| const redirect = new FirebaseRedirect('/api/:package/:api-*', '<:package><:api>'); | ||
| const newUrl = redirect.replace('/api/common/NgClass-directive'); | ||
| expect(newUrl).toEqual('<common><NgClass>'); | ||
| }); | ||
|
|
||
| it('should handle empty ** sections', () => { | ||
| const redirect2 = new FirebaseRedirect('/**/a/b', '/xxx'); | ||
| expect(redirect2.replace('/a/b')).toEqual('/xxx'); | ||
| }); | ||
|
|
||
| it('should return `undefined` if the redirect failed to match', () => { | ||
| const redirect = new FirebaseRedirect('/api/:package/:api-*', '<:package><:api>'); | ||
| const newUrl = redirect.replace('/common/NgClass-directive'); | ||
| expect(newUrl).toBe(undefined); | ||
| }); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| import * as XRegExp from 'xregexp'; | ||
| import { FirebaseGlob } from './FirebaseGlob'; | ||
|
|
||
| export class FirebaseRedirect { | ||
| glob = new FirebaseGlob(this.source); | ||
| constructor(public source: string, public destination: string) {} | ||
|
|
||
| replace(url: string) { | ||
| const match = this.glob.match(url); | ||
| if (match) { | ||
| const replacers = Object.keys(match).map(name => [ XRegExp(`:${name}`, 'g'), match[name] ]); | ||
| return XRegExp.replaceEach(this.destination, replacers); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| import { FirebaseRedirector } from './FirebaseRedirector'; | ||
|
|
||
| describe('FirebaseRedirector', () => { | ||
| it('should replace with the first matching redirect', () => { | ||
| const redirector = new FirebaseRedirector([ | ||
| { source: '/a/b/c', destination: '/X/Y/Z' }, | ||
| { source: '/a/:foo/c', destination: '/X/:foo/Z' }, | ||
| { source: '/**/:foo/c', destination: '/A/:foo/zzz' }, | ||
| ]); | ||
| expect(redirector.redirect('/a/b/c')).toEqual('/X/Y/Z'); | ||
| expect(redirector.redirect('/a/moo/c')).toEqual('/X/moo/Z'); | ||
| expect(redirector.redirect('/x/y/a/b/c')).toEqual('/A/b/zzz'); | ||
| expect(redirector.redirect('/x/y/c')).toEqual('/A/y/zzz'); | ||
| }); | ||
|
|
||
| it('should return the original url if no redirect matches', () => { | ||
| const redirector = new FirebaseRedirector([ | ||
| { source: 'x', destination: 'X' }, | ||
| { source: 'y', destination: 'Y' }, | ||
| { source: 'z', destination: 'Z' }, | ||
| ]); | ||
| expect(redirector.redirect('a')).toEqual('a'); | ||
| }); | ||
|
|
||
| it('should recursively redirect', () => { | ||
| const redirector = new FirebaseRedirector([ | ||
| { source: 'a', destination: 'b' }, | ||
| { source: 'b', destination: 'c' }, | ||
| { source: 'c', destination: 'd' }, | ||
| ]); | ||
| expect(redirector.redirect('a')).toEqual('d'); | ||
| }); | ||
|
|
||
| it('should throw if stuck in an infinite loop', () => { | ||
| const redirector = new FirebaseRedirector([ | ||
| { source: 'a', destination: 'b' }, | ||
| { source: 'b', destination: 'c' }, | ||
| { source: 'c', destination: 'a' }, | ||
| ]); | ||
| expect(() => redirector.redirect('a')).toThrowError('infinite redirect loop'); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❤️