feat: CXSPA-2066 SSR Error Handling

[pawelfras]

This PR contains one of the missing puzzles required to enjoy SSR provided by Spartacus - Error Handling.

In the current shape of Angular SSR, that Spartacus uses under the hood, if any async error occurs during rendering, the page renders without any information on whether the error occurred and an app returns the effect of rendering, potentially malformed, due to e.g. runtime error in the app logic, or due to the HTTP error when calling API, with the wrong, misleading status of 200. As a consequence, pages that encountered errors while rendering and are possibly missing some data are indexed by Google.

The same issue occurs, when customer enters the unknown URL - Spartacus returns an error page, but with misleading status 200. Because of that, unknown URLs are indexed by Google.

Both scenarios may drastically affect the SEO of the page.

To solve the issues mentioned above, Spartacus introduces SSR Error Handling to properly react to errors that occur during the rendering page on the server and to inform the user (and Google crawlers) about the encountered issue and its type.

The whole feature is controlled by three feature flags:

• enable the propagateErrorsToServer feature toggle to propagate to the ExpressJS the async error captured during the rendering,
• enable ssrStrictErrorHandlingForHttpAndNgrx feature toggle to capture async HTTP errors as well as runtime errors in NgRx flow,
• enable ssrFeatureToggle.avoidCachingErrors in SsrOptimizationOptions to not cache error pages

Architectural details:

• introduced HttpErrorHandlerinterceptor responsible for capturing HTTP errors and forwarding wrapped errors based on their cause:
  • CmsPageNotFoundOutboundHttpError if 404 HTTP error occurred when calling cms/pages
  • OnboundHttpError if any other HTTP error occurred (i.e. non-404 in cms/pages OR any http error in any other API call)
• introduced CxErrorHandlerEffect that captures NgRx actions of type ErrorAction and forwards error from their payload to the error handler.
• introduced multi-provided error handlers
  • LoggingErrorHandler using LoggingService under the hood to log captured errors
  • PropagatingToServerErrorHandler that propagates error capturied during SSR to CxCommonEngine
• introduced CxCommonEngine - wrapper for Angular's CommonEngine that handles propagated errors during SSR
• introduced defaultEspressErrorHandlers middleware for ExpressJS that handles captured errors and falls back to CSR with the proper response status
• provided changes to RenderingCache that help to avoid caching renders when an error occurs:
  • this can be controlled by the new optimization property ssrFeatureToggles.avoidCachingErrors (boolean, feature toggle which will be eventually removed due to breaking changes policy) or shouldCacheRenderingResult (function)
• provided changes to OptimizedSsrEngine to inform that rendering results with error (for better traceability)

Apart from a new functionality for customers, this PR introduces:

• new eslint rule no-ngrx-fail-action-without-error-action-implementation which makes sure that NgRx failure actions implement the ErrorAction interface necessary for an error in the NgRx flow to be caught
• a framework for SSR E2E testing

closes CXSPA-2066

[github-actions]

Merge Checks Failed

Please push a commit to re-trigger the build. 
To push an empty commit you can use `git commit --allow-empty -m "Trigger Build"`

[github-actions]

Merge Checks Failed

Please push a commit to re-trigger the build. 
To push an empty commit you can use `git commit --allow-empty -m "Trigger Build"`

[github-actions]

Merge Checks Failed

Please push a commit to re-trigger the build. 
To push an empty commit you can use `git commit --allow-empty -m "Trigger Build"`

[github-actions]

Merge Checks Failed

Please push a commit to re-trigger the build. 
To push an empty commit you can use `git commit --allow-empty -m "Trigger Build"`

[github-actions]

Merge Checks Failed

Please push a commit to re-trigger the build. 
To push an empty commit you can use `git commit --allow-empty -m "Trigger Build"`