seperate version detection for angular/core and ssr

Author: hrishikesh-k

src/helpers/getPackageVersion.js

@@ -3,20 +3,15 @@ import { createRequire } from 'node:module'
 import { join } from 'node:path'
 
 /**
- * Get Angular version from package.json.
+ * Get @angular/core version from package.json.
  * @param {string} root
  * @returns {Promise<string | undefined>}
  */
-export async function getAngularVersion(root) {
+export async function getAngularCoreVersion(root) {
   let packagePath
   try {
     const require = createRequire(import.meta.url)
-
-    // we're checking @angular/ssr version
-    // there could be patch-level differences in this and @angular/core
-    // but in serverModuleHelpers.js, we need patch-level matching of the ssr package
-    // so we cannot rely on the version of core anymore
-    packagePath = require.resolve('@angular/ssr/package.json', { paths: [root] })
+    packagePath = require.resolve('@angular/core/package.json', { paths: [root] })
   } catch {
     // module not found
     return
@@ -46,3 +41,23 @@ export async function getAngularRuntimeVersion(root) {
   const { version } = JSON.parse(contents)
   return version
 }
+
+/**
+ * Get @angular/ssr from package.json.
+ * @param {string} root
+ * @returns {Promise<string | undefined>}
+ */
+export async function getAngularSsrVersion(root) {
+  let packagePath
+  try {
+    const require = createRequire(import.meta.url)
+    packagePath = require.resolve('@angular/ssr/package.json', { paths: [root] })
+  } catch {
+    // module not found
+    return
+  }
+
+  const contents = await readFile(packagePath)
+  const { version } = JSON.parse(contents)
+  return version
+}

src/helpers/serverModuleHelpers.js

@@ -125,22 +125,30 @@ function guessUsedEngine(serverModuleContents) {
  *
  * @returns {'AppEngine' | 'CommonEngine' | undefined}
  */
-export async function fixServerTs({ angularVersion, siteRoot, failPlugin, failBuild, workspaceType, packagePath }) {
-  if (!satisfies(angularVersion, '>=19.0.0-rc', { includePrerelease: true })) {
+export async function fixServerTs({
+  angularCoreVersion,
+  angularSsrVersion,
+  siteRoot,
+  failPlugin,
+  failBuild,
+  workspaceType,
+  packagePath,
+}) {
+  if (!satisfies(angularCoreVersion, '>=19.0.0-rc', { includePrerelease: true })) {
     // for pre-19 versions, we don't need to do anything
     return
   }
 
   const angularJson = getAngularJson({ failPlugin, siteRoot, workspaceType, packagePath })
 
-  // Angular v21.1 introduced `allowedHosts`: https://github.com/angular/angular-cli/blob/21.1.x/packages/angular/ssr/src/app-engine.ts
-  // Angular v21.2.9 introduced `trustProxyHeaders` as well: https://github.com/angular/angular-cli/blob/21.2.x/packages/angular/ssr/src/app-engine.ts
+  // @angular/ssr v21.1.5 introduced `allowedHosts`: https://github.com/angular/angular-cli/releases/tag/v21.1.5
+  // @angular/ssr v21.2.9 introduced `trustProxyHeaders`: https://github.com/angular/angular-cli/releases/tag/v21.2.9
   // we cannot add the config if the version doesn't support it
   // because TypeScript complains about invalid properties
   let NetlifyServerTsAppEngine = NetlifyServerTsAppEngine21Dot0
-  if (satisfies(angularVersion, '>=21.2.9', { includePrerelease: true })) {
+  if (satisfies(angularSsrVersion, '>=21.2.9', { includePrerelease: true })) {
     NetlifyServerTsAppEngine = NetlifyServerTsAppEngine21Dot2Dot9
-  } else if (satisfies(angularVersion, '>=21.1.5', { includePrerelease: true })) {
+  } else if (satisfies(angularSsrVersion, '>=21.1.5', { includePrerelease: true })) {
     NetlifyServerTsAppEngine = NetlifyServerTsAppEngine21Dot1Dot5
   }
 
@@ -158,11 +166,11 @@ export async function fixServerTs({ angularVersion, siteRoot, failPlugin, failBu
   const angularRuntimeVersionInstalledByUser = await getAngularRuntimeVersion(siteRoot)
   if (!angularRuntimeVersionInstalledByUser) {
     failBuild(
-      `Angular@${angularVersion} SSR on Netlify requires '@netlify/angular-runtime' version 2.2.0 or later to be installed. Please install it and try again.`,
+      `Angular@${angularCoreVersion} SSR on Netlify requires '@netlify/angular-runtime' version 2.2.0 or later to be installed. Please install it and try again.`,
     )
   } else if (!satisfies(angularRuntimeVersionInstalledByUser, '>=2.2.0', { includePrerelease: true })) {
     failBuild(
-      `Angular@${angularVersion} SSR on Netlify requires '@netlify/angular-runtime' version 2.2.0 or later to be installed. Found version "${angularRuntimeVersionInstalledByUser}". Please update it to version 2.2.0 or later and try again.`,
+      `Angular@${angularCoreVersion} SSR on Netlify requires '@netlify/angular-runtime' version 2.2.0 or later to be installed. Found version "${angularRuntimeVersionInstalledByUser}". Please update it to version 2.2.0 or later and try again.`,
     )
   }
 
@@ -212,7 +220,7 @@ export async function fixServerTs({ angularVersion, siteRoot, failPlugin, failBu
     return 'CommonEngine'
   }
 
-  if (satisfies(angularVersion, '<20', { includePrerelease: true })) {
+  if (satisfies(angularCoreVersion, '<20', { includePrerelease: true })) {
     // at this point we know that user's server.ts is not Netlify compatible so user intervention is required
     // we will try to inspect server.ts to determine which engine is used and provide more accurate error message
     const guessedUsedEngine = guessUsedEngine(serverModuleContents)

src/index.js

@@ -4,7 +4,7 @@ import ensureNoCompetingPlugin from './helpers/ensureNoCompetingPlugin.js'
 import fixOutputDir from './helpers/fixOutputDir.js'
 import getAngularJson from './helpers/getAngularJson.js'
 import { getAngularRoot } from './helpers/getAngularRoot.js'
-import { getAngularVersion } from './helpers/getPackageVersion.js'
+import { getAngularCoreVersion, getAngularSsrVersion } from './helpers/getPackageVersion.js'
 import { fixServerTs, revertServerTsFix } from './helpers/serverModuleHelpers.js'
 import { getBuildInformation, setUpEdgeFunction } from './helpers/setUpEdgeFunction.js'
 import { setUpHeaders } from './helpers/setUpHeaders.js'
@@ -16,8 +16,16 @@ let usedEngine
 export async function onPreBuild({ netlifyConfig, utils, constants }) {
   const { failBuild, failPlugin } = utils.build
   const { siteRoot, workspaceType } = getAngularRoot({ failBuild, netlifyConfig })
-  const angularVersion = await getAngularVersion(siteRoot)
-  isValidAngularProject = validateAngularVersion(angularVersion)
+
+  // @angular/core and @angular/ssr are only synced to major versions
+  // for minor or patch versions, it's not guaranteed to be in sync
+  // we need to check versions of both deps as @angular/ssr might not
+  // be installed by users not trying to use SSR, but we need
+  // patch-version level detection in serverModuleHelpers.js
+  const angularCoreVersion = await getAngularCoreVersion(siteRoot)
+  const angularSsrVersion = await getAngularSsrVersion(siteRoot)
+
+  isValidAngularProject = validateAngularVersion(angularCoreVersion)
 
   if (!isValidAngularProject) {
     console.warn('Skipping build plugin.')
@@ -40,7 +48,8 @@ export async function onPreBuild({ netlifyConfig, utils, constants }) {
   })
 
   usedEngine = await fixServerTs({
-    angularVersion,
+    angularCoreVersion,
+    angularSsrVersion,
     siteRoot,
     failPlugin,
     failBuild,