feat(ivy): verify whether TypeScript version is supported (#33377)
During the creation of an Angular program in the compiler, a check is done to verify whether the version of TypeScript is considered supported, producing an error if it is not. This check was missing in the Ivy compiler, so users may have ended up running an unsupported TypeScript version inadvertently. Resolves FW-1643 PR Close #33377
This commit is contained in:
@ -11,6 +11,7 @@ import * as ts from 'typescript';
|
||||
|
||||
import * as api from '../transformers/api';
|
||||
import {nocollapseHack} from '../transformers/nocollapse_hack';
|
||||
import {verifySupportedTypeScriptVersion} from '../typescript_support';
|
||||
|
||||
import {ComponentDecoratorHandler, DirectiveDecoratorHandler, InjectableDecoratorHandler, NgModuleDecoratorHandler, NoopReferencesRegistry, PipeDecoratorHandler, ReferencesRegistry} from './annotations';
|
||||
import {BaseDefDecoratorHandler} from './annotations/src/base_def';
|
||||
@ -74,6 +75,10 @@ export class NgtscProgram implements api.Program {
|
||||
constructor(
|
||||
rootNames: ReadonlyArray<string>, private options: api.CompilerOptions,
|
||||
private host: api.CompilerHost, oldProgram?: NgtscProgram) {
|
||||
if (!options.disableTypeScriptVersionCheck) {
|
||||
verifySupportedTypeScriptVersion();
|
||||
}
|
||||
|
||||
if (shouldEnablePerfTracing(options)) {
|
||||
this.perfTracker = PerfTracker.zeroedToNow();
|
||||
this.perfRecorder = this.perfTracker;
|
||||
|
@ -13,9 +13,9 @@ import * as path from 'path';
|
||||
import * as ts from 'typescript';
|
||||
|
||||
import {TypeCheckHost, translateDiagnostics} from '../diagnostics/translate_diagnostics';
|
||||
import {compareVersions} from '../diagnostics/typescript_version';
|
||||
import {MetadataCollector, ModuleMetadata, createBundleIndexHost} from '../metadata';
|
||||
import {NgtscProgram} from '../ngtsc/program';
|
||||
import {verifySupportedTypeScriptVersion} from '../typescript_support';
|
||||
|
||||
import {CompilerHost, CompilerOptions, CustomTransformers, DEFAULT_ERROR_CODE, Diagnostic, DiagnosticMessageChain, EmitFlags, LazyRoute, LibrarySummary, Program, SOURCE, TsEmitArguments, TsEmitCallback, TsMergeEmitResultsCallback} from './api';
|
||||
import {CodeGenerator, TsCompilerAotCompilerTypeCheckHostAdapter, getOriginalReferences} from './compiler_host';
|
||||
@ -67,19 +67,6 @@ const defaultEmitCallback: TsEmitCallback =
|
||||
program.emit(
|
||||
targetSourceFile, writeFile, cancellationToken, emitOnlyDtsFiles, customTransformers);
|
||||
|
||||
/**
|
||||
* Minimum supported TypeScript version
|
||||
* ∀ supported typescript version v, v >= MIN_TS_VERSION
|
||||
*/
|
||||
const MIN_TS_VERSION = '3.6.4';
|
||||
|
||||
/**
|
||||
* Supremum of supported TypeScript versions
|
||||
* ∀ supported typescript version v, v < MAX_TS_VERSION
|
||||
* MAX_TS_VERSION is not considered as a supported TypeScript version
|
||||
*/
|
||||
const MAX_TS_VERSION = '3.7.0';
|
||||
|
||||
class AngularCompilerProgram implements Program {
|
||||
private rootNames: string[];
|
||||
private metadataCache: MetadataCache;
|
||||
@ -116,7 +103,9 @@ class AngularCompilerProgram implements Program {
|
||||
private host: CompilerHost, oldProgram?: Program) {
|
||||
this.rootNames = [...rootNames];
|
||||
|
||||
checkVersion(ts.version, MIN_TS_VERSION, MAX_TS_VERSION, options.disableTypeScriptVersionCheck);
|
||||
if (!options.disableTypeScriptVersionCheck) {
|
||||
verifySupportedTypeScriptVersion();
|
||||
}
|
||||
|
||||
this.oldTsProgram = oldProgram ? oldProgram.getTsProgram() : undefined;
|
||||
if (oldProgram) {
|
||||
@ -864,33 +853,6 @@ class AngularCompilerProgram implements Program {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether a given version ∈ [minVersion, maxVersion[
|
||||
* An error will be thrown if the following statements are simultaneously true:
|
||||
* - the given version ∉ [minVersion, maxVersion[,
|
||||
* - the result of the version check is not meant to be bypassed (the parameter disableVersionCheck
|
||||
* is false)
|
||||
*
|
||||
* @param version The version on which the check will be performed
|
||||
* @param minVersion The lower bound version. A valid version needs to be greater than minVersion
|
||||
* @param maxVersion The upper bound version. A valid version needs to be strictly less than
|
||||
* maxVersion
|
||||
* @param disableVersionCheck Indicates whether version check should be bypassed
|
||||
*
|
||||
* @throws Will throw an error if the following statements are simultaneously true:
|
||||
* - the given version ∉ [minVersion, maxVersion[,
|
||||
* - the result of the version check is not meant to be bypassed (the parameter disableVersionCheck
|
||||
* is false)
|
||||
*/
|
||||
export function checkVersion(
|
||||
version: string, minVersion: string, maxVersion: string,
|
||||
disableVersionCheck: boolean | undefined) {
|
||||
if ((compareVersions(version, minVersion) < 0 || compareVersions(version, maxVersion) >= 0) &&
|
||||
!disableVersionCheck) {
|
||||
throw new Error(
|
||||
`The Angular Compiler requires TypeScript >=${minVersion} and <${maxVersion} but ${version} was found instead.`);
|
||||
}
|
||||
}
|
||||
|
||||
export function createProgram({rootNames, options, host, oldProgram}: {
|
||||
rootNames: ReadonlyArray<string>,
|
||||
|
59
packages/compiler-cli/src/typescript_support.ts
Normal file
59
packages/compiler-cli/src/typescript_support.ts
Normal file
@ -0,0 +1,59 @@
|
||||
/**
|
||||
* @license
|
||||
* Copyright Google Inc. All Rights Reserved.
|
||||
*
|
||||
* Use of this source code is governed by an MIT-style license that can be
|
||||
* found in the LICENSE file at https://angular.io/license
|
||||
*/
|
||||
import * as ts from 'typescript';
|
||||
import {compareVersions} from './diagnostics/typescript_version';
|
||||
|
||||
/**
|
||||
* Minimum supported TypeScript version
|
||||
* ∀ supported typescript version v, v >= MIN_TS_VERSION
|
||||
*/
|
||||
const MIN_TS_VERSION = '3.6.4';
|
||||
|
||||
/**
|
||||
* Supremum of supported TypeScript versions
|
||||
* ∀ supported typescript version v, v < MAX_TS_VERSION
|
||||
* MAX_TS_VERSION is not considered as a supported TypeScript version
|
||||
*/
|
||||
const MAX_TS_VERSION = '3.7.0';
|
||||
|
||||
/**
|
||||
* The currently used version of TypeScript, which can be adjusted for testing purposes using
|
||||
* `setTypeScriptVersionForTesting` and `restoreTypeScriptVersionForTesting` below.
|
||||
*/
|
||||
let tsVersion = ts.version;
|
||||
|
||||
export function setTypeScriptVersionForTesting(version: string): void {
|
||||
tsVersion = version;
|
||||
}
|
||||
|
||||
export function restoreTypeScriptVersionForTesting(): void {
|
||||
tsVersion = ts.version;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether a given version ∈ [minVersion, maxVersion[
|
||||
* An error will be thrown if the following statements are simultaneously true:
|
||||
* - the given version ∉ [minVersion, maxVersion[,
|
||||
*
|
||||
* @param version The version on which the check will be performed
|
||||
* @param minVersion The lower bound version. A valid version needs to be greater than minVersion
|
||||
* @param maxVersion The upper bound version. A valid version needs to be strictly less than
|
||||
* maxVersion
|
||||
*
|
||||
* @throws Will throw an error if the given version ∉ [minVersion, maxVersion[
|
||||
*/
|
||||
export function checkVersion(version: string, minVersion: string, maxVersion: string) {
|
||||
if ((compareVersions(version, minVersion) < 0 || compareVersions(version, maxVersion) >= 0)) {
|
||||
throw new Error(
|
||||
`The Angular Compiler requires TypeScript >=${minVersion} and <${maxVersion} but ${version} was found instead.`);
|
||||
}
|
||||
}
|
||||
|
||||
export function verifySupportedTypeScriptVersion(): void {
|
||||
checkVersion(tsVersion, MIN_TS_VERSION, MAX_TS_VERSION);
|
||||
}
|
Reference in New Issue
Block a user