Revert of Revert "test(ssr-tests): print SSR Logs for errors in SSR tests, ALSO when a test times out (#19302)

package.json

@@ -209,6 +209,8 @@
  "jasmine-core": "~5.1.2",
  "jasmine-marbles": "^0.9.2",
  "jest": "^29.0.0",
+ "jest-circus": "^29.0.0",
+ "jest-environment-node": "^29.0.0",
  "jest-preset-angular": "13.1.6",
  "jsonc-parser": "~3.2.1",
  "karma": "~6.4.1",
@@ -238,4 +240,4 @@
  "webpack": "~5.94.0",
  "webpack-cli": "^5.0.0"
  }
-}
+}

projects/schematics/src/dependencies.json

@@ -25,7 +25,9 @@
  },
  "ssr-tests": {
  "@spartacus/core": "2211.29.0-2",
- "http-proxy": "^1.18.1"
+ "http-proxy": "^1.18.1",
+ "jest-circus": "^29.0.0",
+ "jest-environment-node": "^29.0.0"
  },
  "storefrontapp-e2e-cypress": {},
  "@spartacus/storefront": {

projects/ssr-tests/jest.config.js

@@ -1,23 +1,14 @@
 const { pathsToModuleNameMapper } = require('ts-jest');
 const { compilerOptions } = require('./tsconfig.json');
-const { defaultTransformerOptions } = require('jest-preset-angular/presets');
 
 /** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
 module.exports = {
- preset: 'jest-preset-angular',
  moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths || {}, {
  prefix: '<rootDir>/',
  }),
- setupFilesAfterEnv: ['<rootDir>/setup-jest.ts'],
  testMatch: ['**/+(*.)+(spec).+(ts)'],
  transform: {
- '^.+\\.(ts|js|mjs|html|svg)$': [
- 'jest-preset-angular',
- {
- ...defaultTransformerOptions,
- tsconfig: '<rootDir>/tsconfig.json',
- },
- ],
+ '^.+\\.(ts|js|mjs)$': ['ts-jest'],
  },
 
  collectCoverage: false,
@@ -31,4 +22,5 @@ module.exports = {
  lines: 90,
  },
  },
+ testEnvironment: './src/environments/custom-test-environment.ts',
 };

projects/ssr-tests/package.json

@@ -18,6 +18,8 @@
  },
  "peerDependencies": {
  "@spartacus/core": "2211.29.0-2",
- "http-proxy": "^1.18.1"
+ "http-proxy": "^1.18.1",
+ "jest-circus": "^29.0.0",
+ "jest-environment-node": "^29.0.0"
  }
 }

projects/ssr-tests/src/environments/custom-test-environment.ts

@@ -0,0 +1,61 @@
+/*
+ * SPDX-FileCopyrightText: 2024 SAP Spartacus team <[email protected]>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { Event, State } from 'jest-circus';
+import { TestEnvironment as NodeEnvironment } from 'jest-environment-node';
+import { getRawLogsPretty } from '../utils/log.utils';
+
+/**
+ * This is a custom Jest environment that adds the SSR logs to the test errors.
+ * The logs are added to the error `cause` property for failed tests,
+ * so those logs will be printed by Jest along with the test error.
+ */
+export default class CustomTestEnvironment extends NodeEnvironment {
+ // For comparison, see the original source code of Jest-Circus:
+ // https://github.com/jestjs/jest/blob/bd1c6db7c15c23788ca3e09c919138e48dd3b28a/packages/jest-circus/src/formatNodeAssertErrors.ts#L45
+ async handleTestEvent(event: Event, _state: State) {
+ if (event.name === 'test_done') {
+ event.test.errors = event.test.errors.map((errors) => {
+ if (Array.isArray(errors)) {
+ const [originalError, asyncError] = errors;
+
+ const ssrLogs = getSsrLogs();
+ // Error's `cause` property is the only property printed by Jest
+ // besides `message` that we can utilize for attaching logs.
+ // No other custom properties are printed by Jest.
+ // See their source code of their function `formatExecError`:
+ // https://github.com/jestjs/jest/blob/bd1c6db7c15c23788ca3e09c919138e48dd3b28a/packages/jest-message-util/src/index.ts#L436
+ addCauseToError({
+ error: originalError, // e.g. error when an expect() fails
+ cause: ssrLogs,
+ });
+ addCauseToError({
+ error: asyncError, // e.g. error when a test timeout happens
+ cause: ssrLogs,
+ });
+ }
+ return errors;
+ });
+ }
+ }
+}
+
+function addCauseToError({ error, cause }: { error: any; cause: any }) {
+ // in some cases, the error might be a string, not an object
+ if (
+ typeof error === 'object' &&
+ error !== null &&
+ 'message' in error &&
+ 'stack' in error
+ ) {
+ error.cause = cause;
+ }
+}
+
+function getSsrLogs() {
+ const readableLogs = getRawLogsPretty().join('\n');
+ return `(more context below)\n--- SSR LOGS (with JSONs pretty-printed) ---\n${readableLogs}\n--- SSR LOGS END ---`;
+}

projects/ssr-tests/src/ssr-testing.spec.ts

@@ -23,73 +23,61 @@ describe('SSR E2E', () => {
  await SsrUtils.startSsrServer();
  });
 
- it(
- 'should receive success response with request',
- LogUtils.attachLogsToErrors(async () => {
- backendProxy = await ProxyUtils.startBackendProxyServer({
- target: BACKEND_BASE_URL,
- });
- const response: any = await HttpUtils.sendRequestToSsrServer({
- path: REQUEST_PATH,
- });
- expect(response.statusCode).toEqual(200);
+ it('should receive success response with request', async () => {
+ backendProxy = await ProxyUtils.startBackendProxyServer({
+ target: BACKEND_BASE_URL,
+ });
+ const response: any = await HttpUtils.sendRequestToSsrServer({
+ path: REQUEST_PATH,
+ });
+ expect(response.statusCode).toEqual(200);
 
- const logsMessages = LogUtils.getLogsMessages();
- expect(logsMessages).toContain(`Rendering started (${REQUEST_PATH})`);
- expect(logsMessages).toContain(
- `Request is waiting for the SSR rendering to complete (${REQUEST_PATH})`
- );
- })
- );
+ const logsMessages = LogUtils.getLogsMessages();
+ expect(logsMessages).toContain(`Rendering started (${REQUEST_PATH})`);
+ expect(logsMessages).toContain(
+ `Request is waiting for the SSR rendering to complete (${REQUEST_PATH})`
+ );
+ });
 
- it(
- 'should receive response with 404 when page does not exist',
- LogUtils.attachLogsToErrors(async () => {
- backendProxy = await ProxyUtils.startBackendProxyServer({
- target: BACKEND_BASE_URL,
- });
- const response = await HttpUtils.sendRequestToSsrServer({
- path: REQUEST_PATH + 'not-existing-page',
- });
- expect(response.statusCode).toEqual(404);
- })
- );
+ it('should receive response with 404 when page does not exist', async () => {
+ backendProxy = await ProxyUtils.startBackendProxyServer({
+ target: BACKEND_BASE_URL,
+ });
+ const response = await HttpUtils.sendRequestToSsrServer({
+ path: REQUEST_PATH + 'not-existing-page',
+ });
+ expect(response.statusCode).toEqual(404);
+ });
 
- it(
- 'should receive response with status 404 if HTTP error occurred when calling cms/pages API URL',
- LogUtils.attachLogsToErrors(async () => {
- backendProxy = await ProxyUtils.startBackendProxyServer({
- target: BACKEND_BASE_URL,
- callback: (proxyRes, req) => {
- if (req.url?.includes('cms/pages')) {
- proxyRes.statusCode = 404;
- }
- },
- });
- const response = await HttpUtils.sendRequestToSsrServer({
- path: REQUEST_PATH,
- });
- expect(response.statusCode).toEqual(404);
- })
- );
+ it('should receive response with status 404 if HTTP error occurred when calling cms/pages API URL', async () => {
+ backendProxy = await ProxyUtils.startBackendProxyServer({
+ target: BACKEND_BASE_URL,
+ callback: (proxyRes, req) => {
+ if (req.url?.includes('cms/pages')) {
+ proxyRes.statusCode = 404;
+ }
+ },
+ });
+ const response = await HttpUtils.sendRequestToSsrServer({
+ path: REQUEST_PATH,
+ });
+ expect(response.statusCode).toEqual(404);
+ });
 
- it.skip(
- 'should receive response with status 500 if HTTP error occurred when calling other than cms/pages API URL',
- LogUtils.attachLogsToErrors(async () => {
- backendProxy = await ProxyUtils.startBackendProxyServer({
- target: BACKEND_BASE_URL,
- callback: (proxyRes, req) => {
- if (req.url?.includes('cms/components')) {
- proxyRes.statusCode = 404;
- }
- },
- });
- const response = await HttpUtils.sendRequestToSsrServer({
- path: REQUEST_PATH,
- });
- expect(response.statusCode).toEqual(500);
- })
- );
+ it.skip('should receive response with status 500 if HTTP error occurred when calling other than cms/pages API URL', async () => {
+ backendProxy = await ProxyUtils.startBackendProxyServer({
+ target: BACKEND_BASE_URL,
+ callback: (proxyRes, req) => {
+ if (req.url?.includes('cms/components')) {
+ proxyRes.statusCode = 404;
+ }
+ },
+ });
+ const response = await HttpUtils.sendRequestToSsrServer({
+ path: REQUEST_PATH,
+ });
+ expect(response.statusCode).toEqual(500);
+ });
  });
 
  describe('With caching enabled', () => {
@@ -99,7 +87,7 @@ describe('SSR E2E', () => {
 
  it(
  'should take the response from cache for the next request if previous render succeeded',
- LogUtils.attachLogsToErrors(async () => {
+ async () => {
  backendProxy = await ProxyUtils.startBackendProxyServer({
  target: BACKEND_BASE_URL,
  });
@@ -123,13 +111,13 @@ describe('SSR E2E', () => {
  expect(logsMessages2).toContain(
  `Render from cache (${REQUEST_PATH})`
  );
- }),
+ },
  2 * SsrUtils.DEFAULT_SSR_TIMEOUT // increase timeout for this test as it calls the SSR server twice
  );
 
  it(
  'should render for the next request if previous render failed',
- LogUtils.attachLogsToErrors(async () => {
+ async () => {
  backendProxy = await ProxyUtils.startBackendProxyServer({
  target: BACKEND_BASE_URL,
  callback: (proxyRes, req) => {
@@ -152,7 +140,7 @@ describe('SSR E2E', () => {
  expect(logsMessages).not.toContain(
  `Render from cache (${REQUEST_PATH})`
  );
- }),
+ },
  2 * SsrUtils.DEFAULT_SSR_TIMEOUT // increase timeout for this test as it calls the SSR server twice
  );
  });

projects/ssr-tests/src/utils/log.utils.ts

@@ -126,43 +126,3 @@ export async function waitUntilLogContainsText(
  );
  });
 }
-
-/**
- * A higher-order function that wraps a test callback and includes SSR logs
- * in any error thrown during the test execution. The logs are put into the `cause`
- * property of the Error.
- *
- * @param testFn - The original test function to be wrapped.
- * @returns A new function that can be passed to Jest's `it()` or `test()`.
- *
- * @example
- * it('should perform SSR correctly', attachLogsToErrors(async () => {
- * // Your test code here
- * }));
- */
-export function attachLogsToErrors(
- testFn: () => Promise<void> | void
-): () => Promise<void> {
- return async () => {
- try {
- await testFn();
- } catch (error: unknown) {
- const readableLogs = getRawLogsPretty().join('\n');
- const ssrLogs = `(more context below)\n--- SSR LOGS (with JSONs pretty-printed) ---\n${readableLogs}\n--- SSR LOGS END ---`;
-
- if (error instanceof Error) {
- // Error's `cause` property is the only property printed by Jest
- // besides `message` that we can utilize for attaching logs.
- // No other custom properties are printed by Jest.
- // See their source code of their function `formatExecError`:
- // https://github.com/jestjs/jest/blob/bd1c6db7c15c23788ca3e09c919138e48dd3b28a/packages/jest-message-util/src/index.ts#L436
-
- error.cause = ssrLogs;
- } else {
- throw new Error(error as string, { cause: ssrLogs });
- }
-
- throw error;
- }
- };
-}