packages/compiler-cli/src/ngtsc/annotations/common/test/diagnostics_spec.ts - main - githubmirror/angular

packages/compiler-cli/src/ngtsc/annotations/common/test/diagnostics_spec.ts
129 строк5 KB
Joey Perrott
refactor: update license text to point to angular.dev (#57901)
24 сен 2024, 16:33
24 сен 2024, 16:339dbe6fc
/**
 * @license
 * Copyright Google LLC 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.dev/license
 */

import ts from 'typescript';

import {absoluteFrom as _, getSourceFileOrError} from '../../../file_system';
import {runInEachFileSystem, TestFile} from '../../../file_system/testing';
import {PartialEvaluator} from '../../../partial_evaluator';
import {TypeScriptReflectionHost} from '../../../reflection';
import {getDeclaration, makeProgram} from '../../../testing';
import {createValueHasWrongTypeError} from '../src/diagnostics';

runInEachFileSystem(() => {
  describe('ngtsc annotation diagnostics', () => {
    describe('createValueError()', () => {
      it('should include a trace for dynamic values', () => {
        const {error, program} = createError('', 'nonexistent', 'Error message');
        const entrySf = getSourceFileOrError(program, _('/entry.ts'));

        if (typeof error.diagnosticMessage === 'string') {
          return fail('Created error must have a message chain');
        }
        expect(error.diagnosticMessage.messageText).toBe('Error message');
        expect(error.diagnosticMessage.next!.length).toBe(1);
        expect(error.diagnosticMessage.next![0].messageText).toBe(
          `Value could not be determined statically.`,
        );

        expect(error.relatedInformation).toBeDefined();
        expect(error.relatedInformation!.length).toBe(1);

        expect(error.relatedInformation![0].messageText).toBe('Unknown reference.');
        expect(error.relatedInformation![0].file!.fileName).toBe(entrySf.fileName);
        expect(getSourceCode(error.relatedInformation![0])).toBe('nonexistent');
      });

      it('should include a pointer for a reference to a named declaration', () => {
        const {error, program} = createError(`import {Foo} from './foo';`, 'Foo', 'Error message', [
          {name: _('/foo.ts'), contents: 'export class Foo {}'},
        ]);
        const fooSf = getSourceFileOrError(program, _('/foo.ts'));

        if (typeof error.diagnosticMessage === 'string') {
          return fail('Created error must have a message chain');
        }
        expect(error.diagnosticMessage.messageText).toBe('Error message');
        expect(error.diagnosticMessage.next!.length).toBe(1);
        expect(error.diagnosticMessage.next![0].messageText).toBe(`Value is a reference to 'Foo'.`);

        expect(error.relatedInformation).toBeDefined();
        expect(error.relatedInformation!.length).toBe(1);
        expect(error.relatedInformation![0].messageText).toBe('Reference is declared here.');
        expect(error.relatedInformation![0].file!.fileName).toBe(fooSf.fileName);
        expect(getSourceCode(error.relatedInformation![0])).toBe('Foo');
      });

      it('should include a pointer for a reference to an anonymous declaration', () => {
        const {error, program} = createError(`import Foo from './foo';`, 'Foo', 'Error message', [
          {name: _('/foo.ts'), contents: 'export default class {}'},
        ]);
        const fooSf = getSourceFileOrError(program, _('/foo.ts'));

        if (typeof error.diagnosticMessage === 'string') {
          return fail('Created error must have a message chain');
        }
        expect(error.diagnosticMessage.messageText).toBe('Error message');
        expect(error.diagnosticMessage.next!.length).toBe(1);
        expect(error.diagnosticMessage.next![0].messageText).toBe(
          `Value is a reference to an anonymous declaration.`,
        );

        expect(error.relatedInformation).toBeDefined();
        expect(error.relatedInformation!.length).toBe(1);
        expect(error.relatedInformation![0].messageText).toBe('Reference is declared here.');
        expect(error.relatedInformation![0].file!.fileName).toBe(fooSf.fileName);
        expect(getSourceCode(error.relatedInformation![0])).toBe('export default class {}');
      });

      it("should include a representation of the value's type", () => {
        const {error} = createError('', '{a: 2}', 'Error message');

        if (typeof error.diagnosticMessage === 'string') {
          return fail('Created error must have a message chain');
        }
        expect(error.diagnosticMessage.messageText).toBe('Error message');
        expect(error.diagnosticMessage.next!.length).toBe(1);
        expect(error.diagnosticMessage.next![0].messageText).toBe(
          `Value is of type '{ a: number }'.`,
        );

        expect(error.relatedInformation).not.toBeDefined();
      });
    });
  });
});

function getSourceCode(diag: ts.DiagnosticRelatedInformation): string {
  const text = diag.file!.text;
  return text.slice(diag.start!, diag.start! + diag.length!);
}

function createError(
  code: string,
  expr: string,
  messageText: string,
  supportingFiles: TestFile[] = [],
) {
  const {program} = makeProgram(
    [{name: _('/entry.ts'), contents: `${code}; const target$ = ${expr}`}, ...supportingFiles],
    /* options */ undefined,
    /* host */ undefined,
    /* checkForErrors */ false,
  );
  const checker = program.getTypeChecker();
  const decl = getDeclaration(program, _('/entry.ts'), 'target$', ts.isVariableDeclaration);
  const valueExpr = decl.initializer!;

  const reflectionHost = new TypeScriptReflectionHost(checker);
  const evaluator = new PartialEvaluator(reflectionHost, checker, /* dependencyTracker */ null);

  const value = evaluator.evaluate(valueExpr);
  const error = createValueHasWrongTypeError(valueExpr, value, messageText);
  return {error, program};
}