Increase testability through dependency injection

- Remove existing integration tests for hooks as they're redundant after
  this change.
- Document the pattern in relevant documentation.
- Introduce `useEnvironment` to increase testability.
- Update components to inject dependencies rather than importing hooks
  directly.
This commit is contained in:
undergroundwires
2023-08-15 18:11:30 +02:00
parent 39e650cf11
commit ae75059cc1
32 changed files with 209 additions and 201 deletions

View File

@@ -0,0 +1,5 @@
# Hooks
This folder contains shared hooks used throughout the application.
To use the hooks, prefer using Vue-native `provide` / `inject` pattern to keep the components independently testable without side-effect.

View File

@@ -1,16 +1,9 @@
import { ApplicationFactory } from '@/application/ApplicationFactory';
import { IApplication } from '@/domain/IApplication';
/* Application is always static */
let cachedApplication: IApplication;
// Running tests through Vue CLI throws 'Top-level-await is only supported in EcmaScript Modules'
// This is a temporary workaround until migrating to Vite
ApplicationFactory.Current.getApp().then((app) => {
cachedApplication = app;
});
export function useApplication(application: IApplication = cachedApplication) {
export function useApplication(application: IApplication) {
if (!application) {
throw new Error('missing application');
}
return {
application,
info: application.info,

View File

@@ -1,18 +1,13 @@
import { ref, computed, readonly } from 'vue';
import { IApplicationContext, IReadOnlyApplicationContext } from '@/application/Context/IApplicationContext';
import { buildContext } from '@/application/Context/ApplicationContextFactory';
import { ICategoryCollectionState, IReadOnlyCategoryCollectionState } from '@/application/Context/State/ICategoryCollectionState';
import { EventSubscriptionCollection } from '@/infrastructure/Events/EventSubscriptionCollection';
let singletonContext: IApplicationContext;
export function useCollectionState(context: IApplicationContext) {
if (!context) {
throw new Error('missing context');
}
// Running tests through Vue CLI throws 'Top-level-await is only supported in EcmaScript Modules'
// This is a temporary workaround until migrating to Vite
buildContext().then((context) => {
singletonContext = context;
});
export function useCollectionState(context: IApplicationContext = singletonContext) {
const events = new EventSubscriptionCollection();
const ownEvents = new EventSubscriptionCollection();

View File

@@ -0,0 +1,8 @@
import { IEnvironment } from '@/application/Environment/IEnvironment';
export function useEnvironment(environment: IEnvironment) {
if (!environment) {
throw new Error('missing environment');
}
return environment;
}