cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor(aio): use one argument for DocViewer error reporting (#21293)

Browse Source 
Pass one argument to `logger.error()` to improve error reporting in
environments that do not handle more than one arguments well (e.g.
Googlebot's web rendering service).

Related to #21272.

PR Close #21293
This commit is contained in:
George Kalpakas 2018-01-03 23:42:55 +02:00 committed by Kara Erickson
parent cdc66f6164
commit ccea37256e
2 changed files with 22 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
aio/src/app/layout/doc-viewer/doc-viewer.component.spec.ts
View File

@ -536,7 +536,7 @@ describe('DocViewerComponent', () => {
expect(swapViewsSpy).not.toHaveBeenCalled(); expect(swapViewsSpy).not.toHaveBeenCalled();
expect(docViewer.nextViewContainer.innerHTML).toBe(''); expect(docViewer.nextViewContainer.innerHTML).toBe('');
expect(logger.output.error).toEqual([ expect(logger.output.error).toEqual([
['[DocViewer]: Error preparing document \'foo\'.', error], [`[DocViewer] Error preparing document 'foo': ${error.stack}`],
]); ]);
}); });
@ -555,7 +555,7 @@ describe('DocViewerComponent', () => {
expect(swapViewsSpy).not.toHaveBeenCalled(); expect(swapViewsSpy).not.toHaveBeenCalled();
expect(docViewer.nextViewContainer.innerHTML).toBe(''); expect(docViewer.nextViewContainer.innerHTML).toBe('');
expect(logger.output.error).toEqual([ expect(logger.output.error).toEqual([
['[DocViewer]: Error preparing document \'bar\'.', error], [`[DocViewer] Error preparing document 'bar': ${error.stack}`],
]); ]);
}); });
@ -574,7 +574,7 @@ describe('DocViewerComponent', () => {
expect(swapViewsSpy).not.toHaveBeenCalled(); expect(swapViewsSpy).not.toHaveBeenCalled();
expect(docViewer.nextViewContainer.innerHTML).toBe(''); expect(docViewer.nextViewContainer.innerHTML).toBe('');
expect(logger.output.error).toEqual([ expect(logger.output.error).toEqual([
['[DocViewer]: Error preparing document \'baz\'.', error], [`[DocViewer] Error preparing document 'baz': ${error.stack}`],
]); ]);
}); });
@ -593,7 +593,23 @@ describe('DocViewerComponent', () => {
expect(swapViewsSpy).toHaveBeenCalledTimes(1); expect(swapViewsSpy).toHaveBeenCalledTimes(1);
expect(docViewer.nextViewContainer.innerHTML).toBe(''); expect(docViewer.nextViewContainer.innerHTML).toBe('');
expect(logger.output.error).toEqual([ expect(logger.output.error).toEqual([
['[DocViewer]: Error preparing document \'qux\'.', error], [`[DocViewer] Error preparing document 'qux': ${error.stack}`],
]);
});
it('when something fails with non-Error', async () => {
const error = 'Typical string error';
swapViewsSpy.and.callFake(() => {
expect(docViewer.nextViewContainer.innerHTML).not.toBe('');
throw error;
});
await doRender('Some content', 'qux');
expect(swapViewsSpy).toHaveBeenCalledTimes(1);
expect(docViewer.nextViewContainer.innerHTML).toBe('');
expect(logger.output.error).toEqual([
[`[DocViewer] Error preparing document 'qux': ${error}`],
]); ]);
}); });
}); });

3
aio/src/app/layout/doc-viewer/doc-viewer.component.ts
View File

@ -153,8 +153,9 @@ export class DocViewerComponent implements DoCheck, OnDestroy {
.switchMap(() => this.swapViews(addTitleAndToc)) .switchMap(() => this.swapViews(addTitleAndToc))
.do(() => this.docRendered.emit()) .do(() => this.docRendered.emit())
.catch(err => { .catch(err => {
const errorMessage = (err instanceof Error) ? err.stack : err;
this.logger.error(`[DocViewer] Error preparing document '${doc.id}': ${errorMessage}`);
this.nextViewContainer.innerHTML = ''; this.nextViewContainer.innerHTML = '';
this.logger.error(`[DocViewer]: Error preparing document '${doc.id}'.`, err);
return this.void$; return this.void$;
}); });
} }