RC > Replaced error component with iframe

[Blackbaud-SteveBrush]

No description provided.

[codecov-io]

Codecov Report

Merging #436 into rc-2.0.0 will increase coverage by <.01%.
The diff coverage is 100%.

@@             Coverage Diff              @@
##           rc-2.0.0     #436      +/-   ##
============================================
+ Coverage     99.31%   99.32%   +<.01%     
============================================
  Files            73       73              
  Lines          1910     1912       +2     
  Branches        297      297              
============================================
+ Hits           1897     1899       +2     
  Misses           13       13

Flag	Coverage Δ
#builder	100% <100%> (ø)	⬆️
#runtime	95.56% <ø> (ø)	⬆️
#srcapp	100% <ø> (ø)	⬆️

Impacted Files	Coverage Δ
lib/sky-pages-route-generator.js	100% <100%> (ø)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1c928e6...4363a7f. Read the comment docs.

[Blackbaud-BobbyEarl]

I know I was absent while you and @Blackbaud-PaulCrowder talked about this, but I don't think I'm a fan of this approach as it currently stands.

I like the efficiency of referencing our own errors SPA, but I see that as problematic for external consumers and for users who want to customize it. I think I would probably be okay with it, if we gave a better escape hatch.

We do have some logic baked in to not include the ** route if a NotFoundComponent is found, unfortunately, it's not really usable unless you're in "advanced" mode where you define your own routes.

Looking at:

skyux-builder/lib/sky-pages-route-generator.js

Lines 128 to 136 in 35a038f

	if (skyAppConfig.runtime.handle404) {
	const err = `<sky-error errorType="notfound"></sky-error>`;
	entities.push({
	componentName: 'NotFoundComponent',
	componentDefinition: `@Component({ template: '${err}' }) export class NotFoundComponent { }`,
	routePath: ['**'],
	routeParams: []
	});
	}

What if we changed that to still register the route but reference the NotFoundComponent that the SPA owner has created, that would be sufficient?

[Blackbaud-BobbyEarl]

Maybe something like the following:

  let notFoundComponent = {
    componentName: 'NotFoundComponent',
    routePath: ['**'],
    routeParams: []
  }

  if (skyAppConfig.runtime.handle404) {
    const err = [
      '<iframe src="https://host.nxt.blackbaud.com/errors/notfound"',
      'style="border:0;height:100vh;width:100%;"',
      `[title]="'builder_page_not_found_iframe_title' | skyAppResources"></iframe>`
    ].join(' ');
    notFoundComponent['componentDefinition'] =
      `@Component({ template: \`${err}\` }) export class NotFoundComponent { }`;
  }

  entities.push(notFoundComponent);

To replace

skyux-builder/lib/sky-pages-route-generator.js

Lines 128 to 136 in 35a038f

	if (skyAppConfig.runtime.handle404) {
	const err = `<sky-error errorType="notfound"></sky-error>`;
	entities.push({
	componentName: 'NotFoundComponent',
	componentDefinition: `@Component({ template: '${err}' }) export class NotFoundComponent { }`,
	routePath: ['**'],
	routeParams: []
	});
	}

[Blackbaud-BobbyEarl]

@blackbaud-johnly we should probably take this opportunity to document this functionality, which I was about to do, but I'm having a hard time deciding a good place for it. Happen to have any suggestions?

[Blackbaud-SteveBrush]

@Blackbaud-BobbyEarl @blackbaud-johnly Think we should start a rc- branch on the docs repo?