This commit introduces a custom error object to provide additional context for errors throwing during parsing and compiling operations, improving troubleshooting. By integrating error context handling, the error messages become more informative and user-friendly, providing sequence of trace with context to aid in troubleshooting. Changes include: - Introduce custom error object that extends errors with contextual information. This replaces previous usages of `AggregateError` which is not displayed well by browsers when logged. - Improve parsing functions to encapsulate error context with more details. - Increase unit test coverage and refactor the related code to be more testable.
119 lines
4.1 KiB
TypeScript
119 lines
4.1 KiB
TypeScript
import { describe } from 'vitest';
|
|
import { VueDependencyInjectionApiStub } from '@tests/unit/shared/Stubs/VueDependencyInjectionApiStub';
|
|
import { InjectionKeys } from '@/presentation/injectionSymbols';
|
|
import { provideDependencies, type VueDependencyInjectionApi } from '@/presentation/bootstrapping/DependencyProvider';
|
|
import { ApplicationContextStub } from '@tests/unit/shared/Stubs/ApplicationContextStub';
|
|
import { itIsSingletonFactory } from '@tests/unit/shared/TestCases/SingletonFactoryTests';
|
|
import type { IApplicationContext } from '@/application/Context/IApplicationContext';
|
|
import { itIsTransientFactory } from '@tests/unit/shared/TestCases/TransientFactoryTests';
|
|
|
|
describe('DependencyProvider', () => {
|
|
describe('provideDependencies', () => {
|
|
const testCases: {
|
|
readonly [K in keyof typeof InjectionKeys]: (injectionKey: symbol) => void;
|
|
} = {
|
|
useCollectionState: createTransientTests(),
|
|
useApplication: createSingletonTests(),
|
|
useRuntimeEnvironment: createSingletonTests(),
|
|
useAutoUnsubscribedEvents: createTransientTests(),
|
|
useClipboard: createTransientTests(),
|
|
useCurrentCode: createTransientTests(),
|
|
useUserSelectionState: createTransientTests(),
|
|
useLogger: createTransientTests(),
|
|
useCodeRunner: createTransientTests(),
|
|
useDialog: createTransientTests(),
|
|
useScriptDiagnosticsCollector: createTransientTests(),
|
|
useAutoUnsubscribedEventListener: createTransientTests(),
|
|
};
|
|
Object.entries(testCases).forEach(([key, runTests]) => {
|
|
const registeredKey = InjectionKeys[key].key;
|
|
describe(`Key: "${registeredKey.toString()}"`, () => {
|
|
runTests(registeredKey);
|
|
});
|
|
});
|
|
});
|
|
});
|
|
|
|
function createTransientTests() {
|
|
return (injectionKey: symbol) => {
|
|
it('should register a function when transient dependency is resolved', () => {
|
|
// arrange
|
|
const api = new VueDependencyInjectionApiStub();
|
|
// act
|
|
new ProvideDependenciesBuilder()
|
|
.withApi(api)
|
|
.provideDependencies();
|
|
// expect
|
|
const registeredObject = api.inject(injectionKey);
|
|
expect(registeredObject).to.be.instanceOf(Function);
|
|
});
|
|
describe('should return different instances for transient dependency', () => {
|
|
// arrange
|
|
const api = new VueDependencyInjectionApiStub();
|
|
new ProvideDependenciesBuilder()
|
|
.withApi(api)
|
|
.provideDependencies();
|
|
// act
|
|
const getFactoryResult = () => {
|
|
const registeredObject = api.inject(injectionKey);
|
|
const factory = registeredObject as () => unknown;
|
|
return factory();
|
|
};
|
|
// assert
|
|
itIsTransientFactory({
|
|
getter: getFactoryResult,
|
|
});
|
|
});
|
|
};
|
|
}
|
|
|
|
function createSingletonTests() {
|
|
return (injectionKey: symbol) => {
|
|
it('should register an object when singleton dependency is resolved', () => {
|
|
// arrange
|
|
const api = new VueDependencyInjectionApiStub();
|
|
// act
|
|
new ProvideDependenciesBuilder()
|
|
.withApi(api)
|
|
.provideDependencies();
|
|
// expect
|
|
const registeredObject = api.inject(injectionKey);
|
|
expect(registeredObject).to.be.instanceOf(Object);
|
|
});
|
|
describe('should return the same instance for singleton dependency', () => {
|
|
// arrange
|
|
const singletonContext = new ApplicationContextStub();
|
|
const api = new VueDependencyInjectionApiStub();
|
|
new ProvideDependenciesBuilder()
|
|
.withContext(singletonContext)
|
|
.withApi(api)
|
|
.provideDependencies();
|
|
// act
|
|
const getRegisteredInstance = () => api.inject(injectionKey);
|
|
// assert
|
|
itIsSingletonFactory({
|
|
getter: getRegisteredInstance,
|
|
});
|
|
});
|
|
};
|
|
}
|
|
class ProvideDependenciesBuilder {
|
|
private context: IApplicationContext = new ApplicationContextStub();
|
|
|
|
private api: VueDependencyInjectionApi = new VueDependencyInjectionApiStub();
|
|
|
|
public withApi(api: VueDependencyInjectionApi): this {
|
|
this.api = api;
|
|
return this;
|
|
}
|
|
|
|
public withContext(context: IApplicationContext): this {
|
|
this.context = context;
|
|
return this;
|
|
}
|
|
|
|
public provideDependencies() {
|
|
return provideDependencies(this.context, this.api);
|
|
}
|
|
}
|