Merge branch 'epic/upgrade-to-angular-19' into epic/CXSPA-90943-boots…

…trap-angular-19
SAP · Jan 13, 2025 · d399c2f · d399c2f
2 parents f554f79 + b5500cb
commit d399c2f
Show file tree

Hide file tree

Showing 998 changed files with 11,990 additions and 7,625 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -15,7 +15,6 @@
       ],
       "plugins": ["deprecation", "@typescript-eslint", "@nx", "@stylistic/ts"],
       "rules": {
-        "@angular-eslint/no-host-metadata-property": "off",
         "deprecation/deprecation": "warn",
         "prefer-arrow/prefer-arrow-functions": "off",
         "space-before-function-paren": "off",
@@ -30,6 +29,7 @@
         "no-fallthrough": "off",
         "prefer-const": "off",
         "@angular-eslint/use-lifecycle-interface": "error",
+        "@angular-eslint/prefer-standalone": "off",
         "@stylistic/ts/quotes": "off",
         "@stylistic/ts/member-delimiter-style": [
           "error",

diff --git a/core-libs/setup/jest.config.js b/core-libs/setup/jest.config.js
@@ -5,9 +5,18 @@ 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>/',
-  }),
+  moduleNameMapper: {
+    ...pathsToModuleNameMapper(compilerOptions.paths || {}, {
+      prefix: '<rootDir>/',
+    }),
+    // mapping required to use `beasties` from node modules that has proper ES module format
+    // instead of the version internalized by the Angular Team which file format is not supported
+    // by Jest.
+    // for more, see: https://github.com/angular/angular-cli/pull/28228
+    // and: https://github.com/angular/angular-cli/pull/28726
+    '^../third_party/beasties/index.js$':
+      '<rootDir>/../../node_modules/beasties',
+  },
   setupFilesAfterEnv: ['<rootDir>/setup-jest.ts'],
   transform: {
     '^.+\\.(ts|js|mjs|html|svg)$': [

diff --git a/core-libs/setup/package.json b/core-libs/setup/package.json
@@ -19,15 +19,15 @@
     "tslib": "^2.6.2"
   },
   "peerDependencies": {
-    "@angular/core": "^18.2.9",
-    "@angular/ssr": "^18.2.9",
+    "@angular/core": "^19.0.3",
+    "@angular/ssr": "^19.0.4",
     "@spartacus/cart": "2211.32.0-1",
     "@spartacus/core": "2211.32.0-1",
     "@spartacus/order": "2211.32.0-1",
     "@spartacus/user": "2211.32.0-1"
   },
   "optionalDependencies": {
-    "@angular/platform-server": "^18.2.9",
+    "@angular/platform-server": "^19.0.3",
     "express": "^4.21.2"
   },
   "publishConfig": {

diff --git a/core-libs/setup/ssr/engine-decorator/ng-express-engine-decorator.ts b/core-libs/setup/ssr/engine-decorator/ng-express-engine-decorator.ts
@@ -4,7 +4,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { CommonEngineOptions, CommonEngineRenderOptions } from '@angular/ssr';
+import {
+  CommonEngineOptions,
+  CommonEngineRenderOptions,
+} from '@angular/ssr/node';
 import { NgSetupOptions } from '../engine/ng-express-engine';
 import {
   OptimizedSsrEngine,

diff --git a/core-libs/setup/ssr/engine/__snapshots__/cx-common-engine.spec.ts.snap b/core-libs/setup/ssr/engine/__snapshots__/cx-common-engine.spec.ts.snap
@@ -7,6 +7,6 @@ exports[`CxCommonEngine should handle APP_INITIALIZER errors the standard Angula
 
 exports[`CxCommonEngine should handle errors propagated from SSR 1`] = `"test error"`;
 
-exports[`CxCommonEngine should not override providers passed to options 1`] = `"<html data-critters-container><head></head><body><cx-token ng-version="18.2.9" ng-server-context="ssr">message:test</cx-token></body></html>"`;
+exports[`CxCommonEngine should not override providers passed to options 1`] = `"<html data-beasties-container><head></head><body><cx-token ng-version="19.0.3" ng-server-context="ssr">message:test</cx-token></body></html>"`;
 
-exports[`CxCommonEngine should return html if no errors 1`] = `"<html data-critters-container><head></head><body><cx-mock ng-version="18.2.9" ng-server-context="ssr">some template</cx-mock></body></html>"`;
+exports[`CxCommonEngine should return html if no errors 1`] = `"<html data-beasties-container><head></head><body><cx-mock ng-version="19.0.3" ng-server-context="ssr">some template</cx-mock></body></html>"`;
diff --git a/core-libs/setup/ssr/engine/cx-common-engine.spec.ts b/core-libs/setup/ssr/engine/cx-common-engine.spec.ts
@@ -8,7 +8,11 @@ import { PROPAGATE_ERROR_TO_SERVER } from '../error-handling/error-response/prop
 import { CxCommonEngine } from './cx-common-engine';
 
 // Test how the CxCommonEngine handles successful server-side rendering
-@Component({ selector: 'cx-mock', template: 'some template' })
+@Component({
+  selector: 'cx-mock',
+  template: 'some template',
+  standalone: false,
+})
 export class SuccessComponent {}
 
 @NgModule({
@@ -22,6 +26,7 @@ export class SuccessServerModule {}
 @Component({
   selector: 'cx-response',
   template: ``,
+  standalone: false,
 })
 export class WithPropagatedErrorComponent {
   constructor() {
@@ -43,6 +48,7 @@ export const SOME_TOKEN = new InjectionToken<string>('SOME_TOKEN');
 @Component({
   selector: 'cx-token',
   template: `message:{{ someToken }}`,
+  standalone: false,
 })
 export class TokenComponent {
   someToken = inject(SOME_TOKEN);

diff --git a/core-libs/setup/ssr/engine/cx-common-engine.ts b/core-libs/setup/ssr/engine/cx-common-engine.ts
@@ -8,7 +8,7 @@ import {
   CommonEngine,
   CommonEngineOptions,
   CommonEngineRenderOptions,
-} from '@angular/ssr';
+} from '@angular/ssr/node';
 import { PROPAGATE_ERROR_TO_SERVER } from '../error-handling/error-response/propagate-error-to-server';
 
 /**

diff --git a/core-libs/setup/ssr/engine/ng-express-engine.spec.ts b/core-libs/setup/ssr/engine/ng-express-engine.spec.ts
@@ -25,7 +25,11 @@ import { ngExpressEngine } from './ng-express-engine';
  * - https://github.com/angular/universal/blob/e798d256de5e4377b704e63d993dc56ea35df97d/modules/express-engine/spec/mock.server.module.ts
  *
  */
-@Component({ selector: 'cx-mock', template: 'some template' })
+@Component({
+  selector: 'cx-mock',
+  template: 'some template',
+  standalone: false,
+})
 export class MockComponent {}
 
 /**
@@ -57,7 +61,11 @@ export class MockServerModule {}
  * - https://github.com/angular/universal/blob/e798d256de5e4377b704e63d993dc56ea35df97d/modules/express-engine/spec/mock.server.module.ts
  *
  */
-@Component({ selector: 'cx-request', template: `url:{{ _req.url }}` })
+@Component({
+  selector: 'cx-request',
+  template: `url:{{ _req.url }}`,
+  standalone: false,
+})
 export class RequestComponent {
   constructor(@Inject(REQUEST) public readonly _req: any) {}
 }
@@ -94,6 +102,7 @@ export class RequestServerModule {}
 @Component({
   selector: 'cx-response',
   template: `statusCode:{{ _res.statusCode }}`,
+  standalone: false,
 })
 export class ResponseComponent {
   constructor(@Inject(RESPONSE) public readonly _res: any) {}
@@ -144,6 +153,7 @@ export const SOME_TOKEN = new InjectionToken<string>('SOME_TOKEN');
 @Component({
   selector: 'cx-token',
   template: `message:{{ _someToken.message }}`,
+  standalone: false,
 })
 export class TokenComponent {
   constructor(@Inject(SOME_TOKEN) public readonly _someToken: any) {}

diff --git a/core-libs/setup/ssr/engine/ng-express-engine.ts b/core-libs/setup/ssr/engine/ng-express-engine.ts
@@ -5,7 +5,10 @@
  */
 
 import { StaticProvider } from '@angular/core';
-import { CommonEngineOptions, CommonEngineRenderOptions } from '@angular/ssr';
+import {
+  CommonEngineOptions,
+  CommonEngineRenderOptions,
+} from '@angular/ssr/node';
 import { Request, Response } from 'express';
 import { REQUEST, RESPONSE } from '../tokens/express.tokens';
 import { CxCommonEngine } from './cx-common-engine';

diff --git a/core-libs/setup/ssr/optimized-engine/rendering-cache.ts b/core-libs/setup/ssr/optimized-engine/rendering-cache.ts
@@ -28,7 +28,10 @@ export class RenderingCache {
     if (this.options?.cacheSize) {
       this.renders.delete(key);
       if (this.renders.size >= this.options.cacheSize) {
-        this.renders.delete(this.renders.keys().next().value);
+        const oldestKey = this.renders.keys().next().value;
+        if (oldestKey !== undefined) {
+          this.renders.delete(oldestKey);
+        }
       }
     }
     // cache only if shouldCacheRenderingResult return true

diff --git a/docs/migration/2211_ng18/migration.md b/docs/migration/2211_ng18/migration.md
diff --git a/docs/migration/2211_ng19/migration.md b/docs/migration/2211_ng19/migration.md
@@ -0,0 +1,53 @@
+# (EARLY NOTES) Migrating a custom app to use Spartacus with Angular v18
+
+Before upgrading Spartacus to the new version with Angular 18, you need to first:
+- upgrade to the latest 2211.x of Spartacus
+- upgrade Angular to version v18 and then to v19
+
+## Update Angular to 18 and 19
+
+### Update Angular to 18 and 3rd party deps to be compatible with Angular 18
+
+Follow the [Angular guidelines for upgrading from v17 to v18](https://angular.dev/update-guide?v=17.0-18.0&l=3) and bump the Angular version locally, and update other 3rd party dependencies from Angular ecosystem  to versions compatible with Angular 18 (e.g. `@ng-select/ng-select@13`, `@ngrx/store@18`, `ngx-infinite-scroll@18`):
+
+```bash
+ng update @angular/core@18 @angular/cli@18 @ng-select/ng-select@13 @ngrx/store@18 ngx-infinite-scroll@18 --force
+git add .
+git commit -m "update angular 18 and 3rd party deps angular 18 compatible"
+```
+Note: Do not select `use-application-builder` migration when migrating to Angular 18. Applications created before SPA 2211.19 doesn't support this builder. Applications created starting from 2211.19 already supports it.
+
+### Update Angular to 19 and 3rd party deps to be compatible with Angular 19
+
+Follow the [Angular guidelines for upgrading from v18 to v19](https://angular.dev/update-guide?v=18.0-19.0&l=3) and bump the Angular version locally, and update other 3rd party dependencies from Angular ecosystem  to versions compatible with Angular 19 (e.g. `@ng-select/ng-select@14`, `@ngrx/store@19`, `ngx-infinite-scroll@19`):
+
+```bash
+ng update @angular/cli@19 @angular/core@19 ngx-infinite-scroll@19 @ng-select/ng-select@14 @ngrx/store@19 angular-oauth2-oidc@19 --force
+git add .
+git commit -m "update angular 19 and 3rd party deps angular 19 compatible"
+```
+
+Note: Unselect `use-application-builder` migration when migrating to Angular 19. Applications created before SPA 2211.19 doesn't support this builder. Applications created starting from 2211.19 already supports it.
+
+## Run Spartacus update
+
+After successfully updating the application to Angular 19, execute this command to initiate the Spartacus update process.
+
+```bash
+ng update @spartacus/schematics@latest
+```
+
+### If using Server Side Rendering (SSR) and `application` builder
+
+For applications using `application` builder having SSR support, you need to adjust the `server.ts` file to be compatible with the output generated by the builder.
+
+```diff
+/* ... */
+- const indexHtml = path.join(browserDistFolder, 'index.html');
++ const indexHtml = path.join(serverDistFolder, 'index.server.html');
+```
+
+
+
+
+
diff --git a/feature-libs/asm/.eslintrc.json b/feature-libs/asm/.eslintrc.json
@@ -1,4 +1,9 @@
 {
   "extends": "../../.eslintrc.json",
-  "ignorePatterns": ["schematics/**/*.d.ts"]
+  "ignorePatterns": ["schematics/**/*.d.ts"],
+  "overrides": [
+    {
+      "files": ["*.ts"]
+    }
+  ]
 }
diff --git a/feature-libs/asm/components/asm-bind-cart-dialog/asm-bind-cart-dialog.component.spec.ts b/feature-libs/asm/components/asm-bind-cart-dialog/asm-bind-cart-dialog.component.spec.ts
@@ -9,6 +9,7 @@ import {
 
 @Pipe({
   name: 'cxTranslate',
+  standalone: false,
 })
 class MockTranslatePipe implements PipeTransform {
   transform(): any {}

diff --git a/feature-libs/asm/components/asm-bind-cart-dialog/asm-bind-cart-dialog.component.ts b/feature-libs/asm/components/asm-bind-cart-dialog/asm-bind-cart-dialog.component.ts
@@ -15,6 +15,7 @@ export enum BIND_CART_DIALOG_ACTION {
 @Component({
   selector: 'cx-asm-bind-cart-dialog',
   templateUrl: './asm-bind-cart-dialog.component.html',
+  standalone: false,
 })
 export class AsmBindCartDialogComponent {
   BIND_CART_ACTION = BIND_CART_DIALOG_ACTION;

diff --git a/feature-libs/asm/components/asm-bind-cart/asm-bind-cart.component.spec.ts b/feature-libs/asm/components/asm-bind-cart/asm-bind-cart.component.spec.ts
@@ -49,6 +49,7 @@ import createSpy = jasmine.createSpy;
 @Component({
   selector: 'cx-icon',
   template: '',
+  standalone: false,
 })
 class MockCxIconComponent {
   @Input() type: ICON_TYPE;
@@ -85,6 +86,7 @@ class MockActiveCartService implements Partial<ActiveCartFacade> {
 
 @Pipe({
   name: 'cxTranslate',
+  standalone: false,
 })
 class MockTranslatePipe implements PipeTransform {
   transform(): any {}

diff --git a/feature-libs/asm/components/asm-bind-cart/asm-bind-cart.component.ts b/feature-libs/asm/components/asm-bind-cart/asm-bind-cart.component.ts
@@ -56,6 +56,7 @@ import { AsmComponentService } from '../services/asm-component.service';
   selector: 'cx-asm-bind-cart',
   templateUrl: './asm-bind-cart.component.html',
   changeDetection: ChangeDetectionStrategy.OnPush,
+  standalone: false,
 })
 export class AsmBindCartComponent implements OnInit, OnDestroy {
   activeCartValidator: ValidatorFn = (control) => {

diff --git a/...e-libs/asm/components/asm-create-customer-form/asm-create-customer-form.component.spec.ts b/...e-libs/asm/components/asm-create-customer-form/asm-create-customer-form.component.spec.ts
@@ -80,6 +80,7 @@ const duplicatedUidErrorResponse: HttpErrorModel = {
 @Component({
   selector: 'cx-icon',
   template: '',
+  standalone: false,
 })
 class MockCxIconComponent {
   @Input() type: ICON_TYPE;
@@ -99,6 +100,7 @@ class MockAsmCreateCustomerFacade implements Partial<AsmCreateCustomerFacade> {
 
 @Directive({
   selector: '[cxFocus]',
+  standalone: false,
 })
 export class MockKeyboadFocusDirective {
   @Input('cxFocus') config: FocusConfig = {};

diff --git a/feature-libs/asm/components/asm-create-customer-form/asm-create-customer-form.component.ts b/feature-libs/asm/components/asm-create-customer-form/asm-create-customer-form.component.ts
@@ -29,6 +29,7 @@ import { CreatedCustomer } from './asm-create-customer-form.model';
 @Component({
   selector: 'cx-asm-create-customer-form',
   templateUrl: './asm-create-customer-form.component.html',
+  standalone: false,
 })
 export class AsmCreateCustomerFormComponent {
   createdCustomer: CreatedCustomer;

diff --git a/feature-libs/asm/components/asm-main-ui/asm-main-ui.component.spec.ts b/feature-libs/asm/components/asm-main-ui/asm-main-ui.component.spec.ts
@@ -48,6 +48,7 @@ class MockAuthService implements Partial<AuthService> {
 @Component({
   selector: 'cx-icon',
   template: '',
+  standalone: false,
 })
 class MockCxIconComponent {
   @Input() type: ICON_TYPE;
@@ -103,18 +104,21 @@ class MockLaunchDialogService implements Partial<LaunchDialogService> {
 @Component({
   selector: 'cx-asm-toggle-ui',
   template: '',
+  standalone: false,
 })
 class MockAsmToggleUiComponent {}
 
 @Component({
   selector: 'cx-asm-session-timer',
   template: '',
+  standalone: false,
 })
 class MockAsmSessionTimerComponent {}
 
 @Component({
   selector: 'cx-customer-selection',
   template: '',
+  standalone: false,
 })
 class MockCustomerSelectionComponent {
   @Output()
@@ -123,6 +127,7 @@ class MockCustomerSelectionComponent {
 @Component({
   selector: 'cx-csagent-login-form',
   template: '',
+  standalone: false,
 })
 class MockCSAgentLoginFormComponent {
   @Output()
@@ -133,6 +138,7 @@ class MockCSAgentLoginFormComponent {
 @Component({
   template: '',
   selector: 'cx-customer-emulation',
+  standalone: false,
 })
 class MockCustomerEmulationComponent {}