Перейти до основного вмісту

Колізії провайдерів

Уявіть, що у вас є Module3, куди ви імпортували Module2 та Module1. Ви зробили такий імпорт, бо вам потрібні відповідно Provider2 та Provider1 із цих модулів. Ви проглядаєте результат роботи даних провайдерів, але по якійсь причині Provider1 працює не так як очікується. Ви починаєте дебажити і виявляється, що Provider1 експортується з обох модулів: Module2 та Module1. Ви очікували, що Provider1 експортуватиметься лише з Module1, але насправді спрацювала та версія, що експортується з Module2:

import { featureModule, rootModule } from '@ditsmod/core';

class Provider1 {}
class Provider2 {}

@featureModule({
providersPerReq: [Provider1],
exports: [Provider1]
})
class Module1 {}

@featureModule({
providersPerReq: [{ token: Provider1, useValue: 'some value' }, Provider2],
exports: [Provider1, Provider2],
})
class Module2 {}

@rootModule({
imports: [Module1, Module2],
})
class Module3 {}

Щоб цього не сталось, якщо ви імпортуєте два або більше модулі, в яких експортуються неідентичні провайдери з однаковим токеном, Ditsmod кидатиме приблизно таку помилку:

Error: Importing providers to Module3 failed: exports from Module1, Module2 causes collision with Provider1. You should add Provider1 to resolvedCollisionsPerReq in this module. For example: resolvedCollisionsPerReq: [ [Provider1, Module1] ].

Конкретно у цій ситуації:

  1. і Module1 експортує провайдер з токеном Provider1;
  2. і Module2 підмінює, а потім експортує провайдер з токеном Provider1;
  3. провайдери з токеном Provider1 є неідентичними у Module1 та Module2.

І оскільки обидва ці модулі імпортуються у Module3, якраз тому і виникає "колізія провайдерів", розробник може не знати який провайдер буде працювати в Module3.

Вирішення колізії

Якщо Module3 оголошено у вашому застосунку (тобто не імпортовано з node_modules), колізія вирішується шляхом додавання до resolvedCollisionsPer* масиву з двох елементів, де на першому місці йде токен провайдера, а на другому - модуль, з якого потрібно брати відповідний провайдер:

import { featureModule, rootModule } from '@ditsmod/core';

class Provider1 {}
class Provider2 {}

@featureModule({
providersPerReq: [Provider1],
exports: [Provider1]
})
class Module1 {}

@featureModule({
providersPerReq: [{ token: Provider1, useValue: 'some value' }, Provider2],
exports: [Provider1, Provider2],
})
class Module2 {}

@rootModule({
imports: [Module1, Module2],
resolvedCollisionsPerReq: [ [Provider1, Module1] ]
})
class Module3 {}

Якщо Module3 ви встановили за допомогою менеджера пакетів (npm, npm run і т.д.), немає сенсу локально змінювати цей модуль щоб вирішити колізію. Така ситуація може виникнути лише якщо Module1 та Module2 експортуються з кореневого модуля, тому вам потрібно видалити один із цих модулів звідти. Ну і, звичайно ж, після цього вам прийдеться явно імпортувати видалений модуль у ті модулі, де він необхідний.