Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add full-value config storage to provide repl for config #5

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

add full-value config storage to provide repl for config #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9b72ff5
feat: add full-value config storage
Velmisov Jul 15, 2020
3f0de9f
feat: make it possible to get configs
Velmisov Jul 15, 2020
cb7d3c7
feat: provide repl for config
Velmisov Jul 15, 2020
416c9ee
test: add repl to example
Velmisov Jul 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion example/app.module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
import { Module } from '@nestjs/common';
import { ConfigModule } from '../src';
import { CatModule } from './cat/cat.module';
import { AppConfig } from './app.config';

@Module({
imports: [ConfigModule.forRoot({}), CatModule],
imports: [
ConfigModule.forRoot({
fromFile: process.env.NODE_ENV === 'production' ? undefined : '.env',
configs: [AppConfig],
}),
CatModule,
],
})
export class AppModule {}
16 changes: 16 additions & 0 deletions example/repl.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import { NestFactory } from '@nestjs/core';
import { startWithAppContext } from '../src/repl';
import { AppModule } from './app.module';

(async () => {
const applicationContext = await NestFactory.createApplicationContext(
AppModule,
);
startWithAppContext(applicationContext);
})();

/** or built-in:
(async () => {
await startWithAppModule(AppModule);
})();
*/
226 changes: 193 additions & 33 deletions src/lib/facade.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,51 @@
import { LoggerService } from '@nestjs/common';
import { ConfigFacade } from './facade';
import { ConfigExtractor } from './extractor';
import { Config, Env } from '../decorator';
import { Integer } from '../types';
import { ConfigStorage } from './storage';
import { ConfigExtractor } from './extractor';
import { ConfigParser } from './parser';
import { ConfigFactory } from './factory';
import { ConfigValidator } from './validator';
import { ConfigLogger } from './logger';
import { ConfigSource } from './types';

describe('ConfigFacade', () => {
const configExtractor = { extract: jest.fn() };
const configParser = { parse: jest.fn() };
const configFactory = { createConfig: jest.fn() };
const configValidator = { validate: jest.fn() };
const logger = { error: jest.fn() };
let configStorage: ConfigStorage;
let configExtractor: jest.Mocked<Partial<ConfigExtractor>>;
let configParser: jest.Mocked<ConfigParser>;
let configFactory: jest.Mocked<ConfigFactory>;
let configValidator: jest.Mocked<ConfigValidator>;
let logger: jest.Mocked<Partial<ConfigLogger>>;
let configStorageSpies: {
envsGetter: jest.SpyInstance;
envsSetter: jest.SpyInstance;
rawConfigGetter: jest.SpyInstance;
rawConfigSetter: jest.SpyInstance;
parsedGetter: jest.SpyInstance;
parsedSetter: jest.SpyInstance;
addConfig: jest.SpyInstance;
getConfig: jest.SpyInstance;
};

beforeEach(() => {
configStorage = new ConfigStorage();
configExtractor = { extract: jest.fn() };
configParser = { parse: jest.fn() };
configFactory = { createConfig: jest.fn() };
configValidator = { validate: jest.fn() };
logger = { error: jest.fn() };
configStorageSpies = {
envsGetter: jest.spyOn(configStorage, 'envs', 'get'),
envsSetter: jest.spyOn(configStorage, 'envs', 'set'),
rawConfigGetter: jest.spyOn(configStorage, 'RAW_CONFIG', 'get'),
rawConfigSetter: jest.spyOn(configStorage, 'RAW_CONFIG', 'set'),
parsedGetter: jest.spyOn(configStorage, 'parsed', 'get'),
parsedSetter: jest.spyOn(configStorage, 'parsed', 'set'),
addConfig: jest.spyOn(configStorage, 'addConfig'),
getConfig: jest.spyOn(configStorage, 'getConfig'),
};
});

afterEach(() => {
jest.clearAllMocks();
Expand All @@ -25,18 +61,18 @@ describe('ConfigFacade', () => {
[variableName] = variableValue;
}

const configStorage = {};
const expectedConfig = {
[variableName]: variableValue,
};

configExtractor.extract.mockReturnValueOnce(configStorage);
configParser.parse.mockReturnValueOnce(configStorage);
configExtractor.extract.mockReturnValueOnce({});
configParser.parse.mockReturnValueOnce({});
configFactory.createConfig.mockReturnValueOnce(new TestConfig());

const configSource = {};
const configSource: ConfigSource = {};

const configFacade = new ConfigFacade(
configStorage,
(configExtractor as unknown) as ConfigExtractor,
configParser,
configFactory,
Expand All @@ -47,14 +83,16 @@ describe('ConfigFacade', () => {

expect(configFacade.createConfig(TestConfig)).toMatchObject(expectedConfig);

expect(configStorageSpies.rawConfigSetter).toHaveBeenCalledWith({});
expect(configExtractor.extract).toHaveBeenCalledWith(configSource);
expect(configParser.parse).toHaveBeenCalledWith(configStorage);
expect(configFactory.createConfig).toHaveBeenCalledWith(
configStorage,
TestConfig,
);
expect(configStorageSpies.envsSetter).toHaveBeenCalledWith({});
expect(configParser.parse).toHaveBeenCalledWith({});
expect(configStorageSpies.parsedSetter).toHaveBeenCalledWith({});
expect(configStorageSpies.getConfig).toHaveBeenCalledWith(TestConfig);
expect(configFactory.createConfig).toHaveBeenCalledWith({}, TestConfig);
expect(configValidator.validate).toHaveBeenCalledWith(expectedConfig);
expect(logger.error).not.toHaveBeenCalled();
expect(configStorageSpies.addConfig).toHaveBeenCalledWith(expectedConfig);
});

it('should create config and override default values', () => {
Expand All @@ -70,20 +108,24 @@ describe('ConfigFacade', () => {
[variableName] = variableValue;
}

const configStorage = {
const envs = {
[`${envModuleName}__${envVariableName}`]: newValue,
};
const parsed = {
[envModuleName]: { [envVariableName]: newValue },
};
const expectedConfig = {
[variableName]: newValue,
};

configExtractor.extract.mockReturnValueOnce(configStorage);
configParser.parse.mockReturnValueOnce(configStorage);
configExtractor.extract.mockReturnValueOnce(envs);
configParser.parse.mockReturnValueOnce(parsed);
configFactory.createConfig.mockReturnValueOnce(expectedConfig);

const configSource = { fromFile: '.env.test' };
const configSource: ConfigSource = { fromFile: '.env.test' };

const configFacade = new ConfigFacade(
configStorage,
(configExtractor as unknown) as ConfigExtractor,
configParser,
configFactory,
Expand All @@ -94,14 +136,16 @@ describe('ConfigFacade', () => {

expect(configFacade.createConfig(TestConfig)).toMatchObject(expectedConfig);

expect(configStorageSpies.rawConfigSetter).toHaveBeenCalledWith({});
expect(configExtractor.extract).toHaveBeenCalledWith(configSource);
expect(configParser.parse).toHaveBeenCalledWith(configStorage);
expect(configFactory.createConfig).toHaveBeenCalledWith(
configStorage,
TestConfig,
);
expect(configStorageSpies.envsSetter).toHaveBeenCalledWith(envs);
expect(configParser.parse).toHaveBeenCalledWith(envs);
expect(configStorageSpies.parsedSetter).toHaveBeenCalledWith(parsed);
expect(configStorageSpies.getConfig).toHaveBeenCalledWith(TestConfig);
expect(configFactory.createConfig).toHaveBeenCalledWith(parsed, TestConfig);
expect(configValidator.validate).toHaveBeenCalledWith(expectedConfig);
expect(logger.error).not.toHaveBeenCalled();
expect(configStorageSpies.addConfig).toHaveBeenCalledWith(expectedConfig);
});

it('should throw error if validation fails', () => {
Expand All @@ -118,24 +162,28 @@ describe('ConfigFacade', () => {
[variableName] = variableValue;
}

const configStorage = {
const envs = {
[`${envModuleName}__${envVariableName}`]: newValue,
};
const parsed = {
[envModuleName]: { [envVariableName]: newValue },
};
const expectedConfig = {
[variableName]: newValue,
};

const errorMessage = 'error message';

configExtractor.extract.mockReturnValueOnce(configStorage);
configParser.parse.mockReturnValueOnce(configStorage);
configExtractor.extract.mockReturnValueOnce(envs);
configParser.parse.mockReturnValueOnce(parsed);
configFactory.createConfig.mockReturnValueOnce(expectedConfig);
configValidator.validate.mockImplementationOnce(() => {
throw new Error(errorMessage);
});

const configSource = { raw: { variable: 'value' } };
const configSource: ConfigSource = { raw: { variable: 'value' } };
const configFacade = new ConfigFacade(
configStorage,
(configExtractor as unknown) as ConfigExtractor,
configParser,
configFactory,
Expand All @@ -148,13 +196,125 @@ describe('ConfigFacade', () => {
errorMessage,
);

expect(configExtractor.extract).toHaveBeenCalledWith(configSource);
expect(configParser.parse).toHaveBeenCalledWith(configStorage);
expect(configFactory.createConfig).toHaveBeenCalledWith(
configStorage,
TestConfig,
expect(configStorageSpies.rawConfigSetter).toHaveBeenCalledWith(
configSource.raw,
);
expect(configExtractor.extract).toHaveBeenCalledWith(configSource);
expect(configStorageSpies.envsSetter).toHaveBeenCalledWith(envs);
expect(configParser.parse).toHaveBeenCalledWith(envs);
expect(configStorageSpies.parsedSetter).toHaveBeenCalledWith(parsed);
expect(configStorageSpies.getConfig).toHaveBeenCalledWith(TestConfig);
expect(configFactory.createConfig).toHaveBeenCalledWith(parsed, TestConfig);
expect(configValidator.validate).toHaveBeenCalledWith(expectedConfig);
expect(logger.error).toHaveBeenCalled();
expect(configStorageSpies.addConfig).not.toHaveBeenCalled();
});

it('should return already exists config', () => {
const variableName = 'name';
const variableValue = 'value';

@Config('TEST')
class TestConfig {
@Env('VARIABLE')
[variableName] = variableValue;
}

const expectedConfig = {
[variableName]: variableValue,
};

configExtractor.extract.mockReturnValueOnce({});
configParser.parse.mockReturnValueOnce({});
configFactory.createConfig.mockReturnValueOnce(new TestConfig());

const configSource: ConfigSource = {};

const configFacade = new ConfigFacade(
configStorage,
(configExtractor as unknown) as ConfigExtractor,
configParser,
configFactory,
configValidator,
(logger as unknown) as LoggerService,
configSource,
);

expect(configFacade.createConfig(TestConfig)).toMatchObject(expectedConfig);
jest.clearAllMocks();
expect(configFacade.createConfig(TestConfig)).toMatchObject(expectedConfig);

expect(configStorageSpies.getConfig).toHaveBeenCalledWith(TestConfig);
expect(configFactory.createConfig).not.toHaveBeenCalled();
expect(configValidator.validate).not.toHaveBeenCalled();
expect(logger.error).not.toHaveBeenCalled();
expect(configStorageSpies.addConfig).not.toHaveBeenCalled();
});

it('should return all generated configs', () => {
const variableName = 'name';
const variableValue = 'value';

@Config('TEST')
class TestConfig1 {
@Env('VARIABLE')
[variableName] = variableValue;
}

@Config('TEST')
class TestConfig2 {
@Env('VARIABLE')
[variableName] = variableValue;
}

const expectedConfig = {
[variableName]: variableValue,
};

configExtractor.extract.mockReturnValueOnce({});
configParser.parse.mockReturnValueOnce({});
configFactory.createConfig.mockReturnValueOnce(new TestConfig1());
configFactory.createConfig.mockReturnValueOnce(new TestConfig2());
configFactory.createConfig.mockReturnValueOnce(new TestConfig1());

const configSource: ConfigSource = {};

const configFacade = new ConfigFacade(
configStorage,
(configExtractor as unknown) as ConfigExtractor,
configParser,
configFactory,
configValidator,
(logger as unknown) as LoggerService,
configSource,
);

configFacade.createConfig(TestConfig1);
configFacade.createConfig(TestConfig2);
configFacade.createConfig(TestConfig1);

expect(configFacade.getAllGeneratedConfigs()).toEqual({
[TestConfig1.name]: expectedConfig,
[TestConfig2.name]: expectedConfig,
});
});

it('should return raw config', () => {
configExtractor.extract.mockReturnValueOnce({});
configParser.parse.mockReturnValueOnce({});

const configSource: ConfigSource = { raw: { variable: 'value' } };

const configFacade = new ConfigFacade(
configStorage,
(configExtractor as unknown) as ConfigExtractor,
configParser,
configFactory,
configValidator,
(logger as unknown) as LoggerService,
configSource,
);

expect(configFacade.getRawConfig()).toEqual(configSource.raw);
});
});
Loading