При использовании AOT изменения в объектах, переданных в forRoot, игнорируются при внедрении - PullRequest
0 голосов
/ 02 мая 2018

Обзор

Я вижу странное поведение в том, что свойства, которые добавляются к объекту посредством назначения деструктурирования (или Object.assign), присутствуют при передаче в forRoot, но не присутствуют при внедрении в службу. Кроме того, обновления, сделанные после инициализации, присутствуют при передаче в forRoot, но не присутствуют при внедрении в службу. Это происходит только при сборке с AOT.

Я создал минимальный проект, который воспроизводит проблему: https://github.com/bygrace1986/wat

Версии пакета

  • угловой: 5.2.0
  • angular-cli: 1.6.4 (мое приложение), 1.7.4 (мой тест)
  • машинопись: 2.4.2

Настройка

Создайте модуль со статическим forRoot методом, который будет принимать объект, который он затем предоставит через InjectionToken и внедрит в службу.

TestModule

import { NgModule, ModuleWithProviders } from '@angular/core';
import { CommonModule } from '@angular/common';

import { TestDependency, TEST_DEPENDENCY, TestService } from './test.service';

@NgModule({
  imports: [
    CommonModule
  ],
  declarations: []
})
export class TestModule {
  static forRoot(dependency?: TestDependency): ModuleWithProviders {
    return {
      ngModule: TestModule,
      providers: [
        TestService,
        { provide: TEST_DEPENDENCY, useValue: dependency }
      ]
    }
  }
}

TestService

import { Injectable, InjectionToken, Inject } from '@angular/core';

export interface TestDependency {
    property: string;
}

export const TEST_DEPENDENCY = new InjectionToken<TestDependency>('TEST_DEPENDENCY');

@Injectable()
export class TestService {
    constructor(@Inject(TEST_DEPENDENCY) dependency: TestDependency) {
        console.log('[TestService]', dependency);
    }
}

Сценарий немутантного объекта

Этот сценарий показывает, что передача немутатного объекта в forRoot правильно внедряется в службу, которая зависит от него.

Чтобы установить ссылку на TestService в app.component.html (или где-нибудь, где он будет введен). Передайте зависимость методу forRoot в TestModule.

AppModule

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

import { AppComponent } from './app.component';
import { TestModule } from './test/test.module';
import { TestDependency } from './test/test.service';

const dependency = {
  property: 'value'
} as TestDependency;
console.log('[AppModule]', dependency)

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    TestModule.forRoot(dependency)
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

Выполнить ng serve --aot.

выход

[AppModule] {property: "value"}
[TestService] {property: "value"}

Сценарий мутированного объекта

Этот сценарий иллюстрирует, что изменения, внесенные в объект посредством назначения деструктуризации объекта во время инициализации, или изменения, сделанные после инициализации, игнорируются, когда предоставленный объект внедряется в сервис, который зависит от него.

Для настройки создайте новый объект с дополнительными свойствами и используйте деструктуризацию объекта, чтобы присвоить свойства старого объекта новому. Затем обновите свойство в dependency и передайте его методу forRoot в TestModule.

AppModule

const dependency = {
  property: 'value'
} as TestDependency;
const dependencyCopy = { id: 1, name: 'first', ...dependency };
dependencyCopy.name = 'last';
console.log('[AppModule]', dependencyCopy);
...
TestModule.forRoot(dependencyCopy)

Выполнить ng serve --aot.

выход

[AppModule] {id: 1, name: "last", property: "value"}
[TestService] {id: 1, name: "first"}

Неожиданный результат

Любое свойство, добавленное с помощью назначения деструктурирования объекта, было удалено, и любое обновление, выполненное после инициализации, возвращается к тому, когда объект передается в forRoot и вводится в TestService. На самом деле, это не тот же объект (я отлаживал и проверял ===). Это как если бы исходный объект, созданный до назначения или мутации, использовался ... каким-то образом.

Мутированный объект, предоставленный в сценарии AppModule

Этот сценарий показывает, что мутации объекта не возвращаются, если они предоставлены на уровне AppModule, а не через forRoot.

Для настройки ничего не передавайте forRoot. Вместо этого используйте токен инъекции, чтобы предоставить объект в списке AppModule поставщиков.

AppModule

imports: [
  BrowserModule,
  TestModule.forRoot()
],
providers: [
  { provide: TEST_DEPENDENCY, useValue: dependencyCopy }
],

Выполнить ng serve --aot.

выход

[AppModule] {id: 1, name: "last", property: "value"}
[TestService] {id: 1, name: "last", property: "value"}

Вопрос

Почему изменения, внесенные в объект, предоставленный с помощью forRoot, возвращаются, когда объект внедряется в зависимый класс?

Обновление

  • Понял, что обновления после инициализации также отменены.
  • Понял, что это может быть воспроизведено только с флагом --aot, а не с более широким флагом --prod.
  • Обновлено до последней стабильной версии cli (1.7.4), но проблема все еще есть.
  • Открыта ошибка в проекте angular-cli: https://github.com/angular/angular-cli/issues/10610
  • Из чтения сгенерированного кода я думаю, что проблема заключается в перезаписи метаданных фазы 2. Когда только ссылка на переменную в forRoot, я получаю это: i0.ɵmpd(256, i6.TEST_DEPENDENCY, { id: 1, name: "first" }, [])]);. Когда на него ссылаются в списке AppModule провайдеров, я получаю это: i0.ɵmpd(256, i6.TEST_DEPENDENCY, i1.ɵ0, [])]);, а затем это в модуле приложения var ɵ0 = dependencyCopy; exports.ɵ0 = ɵ0;.

1 Ответ

0 голосов
/ 06 мая 2018

Ядром AOT является Сборщик метаданных .

Требуется ts.SourceFile, затем рекурсивно проходит по всем узлам AST этого файла и преобразует все узлы в представление JSON.

Collector проверяет следующие типы узлов AST на верхнем уровне файла:

ts.SyntaxKind.ExportDeclaration
ts.SyntaxKind.ClassDeclaration
ts.SyntaxKind.TypeAliasDeclaration
ts.SyntaxKind.InterfaceDeclaration
ts.SyntaxKind.FunctionDeclaration
ts.SyntaxKind.EnumDeclaration
ts.SyntaxKind.VariableStatement

Угловой компилятор также пытается вычислить все метаданные во время выполнения, используя так называемый Evaluator , чтобы он мог понимать подмножество выражений javascript, которые слушаются в docs

Следует отметить, что компилятор поддерживает оператор распространения, но только в литералах массива , а не в объектах

Дело 1

const dependency = {
  property: 'value'               ===========> Non-exported VariableStatement
} as TestDependency;                           with value { property: 'value' }

imports: [
  ...,
  TestModule.forRoot(dependency)  ===========> Call expression with 
                                               ts.SyntaxKind.Identifier argument 
                                               which is calculated above
]

Итак, мы получим метаданные, такие как: enter image description here

Обратите внимание, что аргумент является просто статическим значением объекта.

Дело 2

const dependency = {
  property: 'value'               ===========> Non-exported VariableStatement
} as TestDependency;                           with value { property: 'value' }

const dependencyCopy = { 
  id: 1,                         ============> Non-exported VariableStatement
  name: 'first',                               with value { id: 1, name: 'first' }                       
  ...dependency                                (Spread operator is not supported here)
};
dependencyCopy.name = 'last';     ===========> ExpressionStatement is skipped
                                               (see list of supported types above)

...
TestModule.forRoot(dependencyCopy) ===========> Call expression with 
                                                ts.SyntaxKind.Identifier argument 
                                                which is calculated above

Вот что мы получаем сейчас: enter image description here

Дело 3

providers: [
  { provide: TEST_DEPENDENCY, useValue: dependencyCopy }
],

В версии 5 angular перенесен (почти) в собственный процесс компиляции TS с использованием преобразователей и вводит так называемый преобразователь нижних выражений , что в основном означает, что теперь мы можем использовать функции стрелок в метаданных декоратора Например:

providers: [{provide: SERVER, useFactory: () => TypicalServer}]

будет автоматически преобразован угловым компилятором в следующее:

export const ɵ0 = () => new TypicalServer();
...
providers: [{provide: SERVER, useFactory: ɵ0}]

Теперь давайте прочитаем документацию :

Компилятор обрабатывает литералы объектов, содержащие поля useClass , useValue , useFactory и data специально. Компилятор преобразует выражение, инициализирующее одно из этих полей в экспортируемую переменную , который заменяет выражение. Этот процесс переписывания этих выражения снимает все ограничения на то, что в них может быть потому что компилятору не нужно знать значение выражения - это просто нужно уметь генерировать ссылку на значение .

Теперь посмотрим, как это работает в нашем третьем случае: enter image description here

Мы видим, что angular теперь использует ссылку на dependencyCopy объект. И, как вы уже заметили, он будет использоваться как var ɵ0 = dependencyCopy; в сгенерированной фабрике.

Возможное решение:

test.module.ts

export class TestModule {
  static forRoot(dependency?: { data: TestDependency }): ModuleWithProviders {
    return {
      ngModule: TestModule,
      providers: [
        TestService,
        { provide: TEST_DEPENDENCY, useValue: dependency.data }
      ]
    };
  }
}

app.module.ts

TestModule.forRoot({ data: dependencyCopy })
...