Skip to content

Commit

Permalink
test: fix hbarSpendingPlanConfigService.spec.ts
Browse files Browse the repository at this point in the history 
Signed-off-by: Victor Yanev <[email protected]>
  • Loading branch information
@victor-yanev
victor-yanev committed Oct 31, 2024
1 parent d1abc7b commit 4eea649
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 60 deletions.
1 change: 1 addition & 0 deletions packages/relay/src/lib/clients/cache/localLRUCache.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,7 @@ export class LocalLRUCache implements ICacheClient {
*/
public async clear(): Promise<void> {
this.cache.clear();
this.reservedCache?.clear();
}

/**
Expand Down
8 changes: 4 additions & 4 deletions packages/relay/src/lib/config/hbarSpendingPlanConfigService.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,8 @@ export class HbarSpendingPlanConfigService {
const spendingPlanConfig = ConfigService.get('HBAR_SPENDING_PLANS_CONFIG') as string;

Check warning on line 131 in packages/relay/src/lib/config/hbarSpendingPlanConfigService.ts

View check run for this annotation

Codecov / codecov/patch

packages/relay/src/lib/config/hbarSpendingPlanConfigService.ts#L131 

Added line #L131 was not covered by tests

if (!spendingPlanConfig) {
throw new Error('HBAR_SPENDING_PLANS_CONFIG is undefined');
logger.trace('HBAR_SPENDING_PLANS_CONFIG is undefined');

Check warning on line 134 in packages/relay/src/lib/config/hbarSpendingPlanConfigService.ts

View check run for this annotation

Codecov / codecov/patch

packages/relay/src/lib/config/hbarSpendingPlanConfigService.ts#L134 

Added line #L134 was not covered by tests
return [];
}

// Try to parse the value directly as JSON
Expand All @@ -148,9 +149,8 @@ export class HbarSpendingPlanConfigService {
const fileContent = fs.readFileSync(configFilePath, 'utf-8');
return JSON.parse(fileContent) as SpendingPlanConfig[];

Check warning on line 150 in packages/relay/src/lib/config/hbarSpendingPlanConfigService.ts

View check run for this annotation

Codecov / codecov/patch

packages/relay/src/lib/config/hbarSpendingPlanConfigService.ts#L149-L150 

Added lines #L149 - L150 were not covered by tests
} else {
throw new Error(
`HBAR Spending Configuration file not found at path "${configFilePath ?? spendingPlanConfig}"`,
);
logger.trace(`HBAR Spending Configuration file not found at path "${configFilePath ?? spendingPlanConfig}"`);
return [];

Check warning on line 153 in packages/relay/src/lib/config/hbarSpendingPlanConfigService.ts

View check run for this annotation

Codecov / codecov/patch

packages/relay/src/lib/config/hbarSpendingPlanConfigService.ts#L153 

Added line #L153 was not covered by tests
}
} catch (fileError: any) {
throw new Error(`File error: ${fileError.message}`);

Check warning on line 156 in packages/relay/src/lib/config/hbarSpendingPlanConfigService.ts

View check run for this annotation

Codecov / codecov/patch

packages/relay/src/lib/config/hbarSpendingPlanConfigService.ts#L156 

Added line #L156 was not covered by tests
Expand Down
85 changes: 34 additions & 51 deletions packages/relay/tests/lib/config/hbarSpendingPlanConfigService.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,8 @@ import { SpendingPlanConfig } from '../../../src/lib/types/spendingPlanConfig';
import { RequestDetails } from '../../../src/lib/types';
import {
overrideEnvsInMochaDescribe,
startRedisInMemoryServer,
stopRedisInMemoryServer,
toHex,
useInMemoryRedisServer,
verifyResult,
withOverriddenEnvsInMochaTest,
} from '../../helpers';
Expand All @@ -47,8 +46,6 @@ import {
HbarSpendingPlanNotFoundError,
IPAddressHbarSpendingPlanNotFoundError,
} from '../../../src/lib/db/types/hbarLimiter/errors';
import { ConfigServiceTestHelper } from '@hashgraph/json-rpc-config-service/tests/configServiceTestHelper';
import { RedisInMemoryServer } from '../../redisInMemoryServer';

chai.use(chaiAsPromised);

Expand All @@ -71,7 +68,7 @@ describe('HbarSpendingPlanConfigService', function () {
const path = findConfig(spendingPlansConfigFile);
const spendingPlansConfig = JSON.parse(fs.readFileSync(path!, 'utf-8')) as SpendingPlanConfig[];

const tests = (isSharedCacheEnabled: boolean, isSpendingPlansConfigFile: boolean) => {
const tests = (hbarSpendingPlansConfigEnv: string) => {
let cacheService: CacheService;
let hbarSpendingPlanRepository: HbarSpendingPlanRepository;
let ethAddressHbarSpendingPlanRepository: EthAddressHbarSpendingPlanRepository;
Expand All @@ -83,26 +80,14 @@ describe('HbarSpendingPlanConfigService', function () {
let hbarSpendingPlanRepositorySpy: sinon.SinonSpiedInstance<HbarSpendingPlanRepository>;
let ethAddressHbarSpendingPlanRepositorySpy: sinon.SinonSpiedInstance<EthAddressHbarSpendingPlanRepository>;
let ipAddressHbarSpendingPlanRepositorySpy: sinon.SinonSpiedInstance<IPAddressHbarSpendingPlanRepository>;
let redisInMemoryServer: RedisInMemoryServer;

overrideEnvsInMochaDescribe({
HBAR_SPENDING_PLANS_CONFIG: hbarSpendingPlansConfigEnv,
CACHE_TTL: '100',
CACHE_MAX: spendingPlansConfig.length.toString(),
});

if (isSpendingPlansConfigFile) {
ConfigServiceTestHelper.dynamicOverride('HBAR_SPENDING_PLANS_CONFIG', spendingPlansConfigFile);
} else {
ConfigServiceTestHelper.dynamicOverride('HBAR_SPENDING_PLANS_CONFIG', JSON.stringify(spendingPlansConfig));
}

before(async function () {
if (isSharedCacheEnabled) {
redisInMemoryServer = await startRedisInMemoryServer(logger, 6384);
} else {
overrideEnvsInMochaDescribe({ REDIS_ENABLED: 'false' });
}

const reservedKeys = HbarSpendingPlanConfigService.getPreconfiguredSpendingPlanKeys(logger);
cacheService = new CacheService(logger.child({ name: 'cache-service' }), registry, reservedKeys);
hbarSpendingPlanRepository = new HbarSpendingPlanRepository(
Expand All @@ -125,13 +110,7 @@ describe('HbarSpendingPlanConfigService', function () {
);
});

after(async function () {
if (isSharedCacheEnabled) {
await stopRedisInMemoryServer(redisInMemoryServer);
}
});

beforeEach(function () {
beforeEach(async function () {
loggerSpy = sinon.spy(logger);
cacheServiceSpy = sinon.spy(cacheService);
hbarSpendingPlanRepositorySpy = sinon.spy(hbarSpendingPlanRepository);
Expand All @@ -158,9 +137,9 @@ describe('HbarSpendingPlanConfigService', function () {
() => {
it('should throw an error if configuration file is not a parsable JSON', async function () {
sinon.stub(fs, 'readFileSync').returns('invalid JSON');
await expect(hbarSpendingPlanConfigService.populatePreconfiguredSpendingPlans()).to.be.rejectedWith(
`Unexpected token 'i', "invalid JSON" is not valid JSON`,
);
await expect(
hbarSpendingPlanConfigService.populatePreconfiguredSpendingPlans(),
).to.be.eventually.rejectedWith(`Unexpected token 'i', "invalid JSON" is not valid JSON`);
});
},
);
Expand All @@ -175,9 +154,9 @@ describe('HbarSpendingPlanConfigService', function () {
.stub(HbarSpendingPlanConfigService, 'loadSpendingPlansConfig' as any)
.returns([...spendingPlansConfig, invalidPlan]);

await expect(hbarSpendingPlanConfigService.populatePreconfiguredSpendingPlans()).to.be.rejectedWith(
`Invalid spending plan configuration: ${JSON.stringify(invalidPlan)}`,
);
await expect(
hbarSpendingPlanConfigService.populatePreconfiguredSpendingPlans(),
).to.be.eventually.rejectedWith(`Invalid spending plan configuration: ${JSON.stringify(invalidPlan)}`);
});

it('should throw an error if the configuration file has entry without name', async function () {
Expand All @@ -190,9 +169,9 @@ describe('HbarSpendingPlanConfigService', function () {
.stub(HbarSpendingPlanConfigService, 'loadSpendingPlansConfig' as any)
.returns([...spendingPlansConfig, invalidPlan]);

await expect(hbarSpendingPlanConfigService.populatePreconfiguredSpendingPlans()).to.be.rejectedWith(
`Invalid spending plan configuration: ${JSON.stringify(invalidPlan)}`,
);
await expect(
hbarSpendingPlanConfigService.populatePreconfiguredSpendingPlans(),
).to.be.eventually.rejectedWith(`Invalid spending plan configuration: ${JSON.stringify(invalidPlan)}`);
});

it('should throw an error if the configuration file has entry without subscriptionTier', async function () {
Expand All @@ -205,9 +184,9 @@ describe('HbarSpendingPlanConfigService', function () {
.stub(HbarSpendingPlanConfigService, 'loadSpendingPlansConfig' as any)
.returns([...spendingPlansConfig, invalidPlan]);

await expect(hbarSpendingPlanConfigService.populatePreconfiguredSpendingPlans()).to.be.rejectedWith(
`Invalid spending plan configuration: ${JSON.stringify(invalidPlan)}`,
);
await expect(
hbarSpendingPlanConfigService.populatePreconfiguredSpendingPlans(),
).to.be.eventually.rejectedWith(`Invalid spending plan configuration: ${JSON.stringify(invalidPlan)}`);
});

it('should throw an error if the configuration file has entry with invalid subscriptionTier', async function () {
Expand All @@ -221,9 +200,9 @@ describe('HbarSpendingPlanConfigService', function () {
.stub(HbarSpendingPlanConfigService, 'loadSpendingPlansConfig' as any)
.returns([...spendingPlansConfig, invalidPlan]);

await expect(hbarSpendingPlanConfigService.populatePreconfiguredSpendingPlans()).to.be.rejectedWith(
`Invalid spending plan configuration: ${JSON.stringify(invalidPlan)}`,
);
await expect(
hbarSpendingPlanConfigService.populatePreconfiguredSpendingPlans(),
).to.be.eventually.rejectedWith(`Invalid spending plan configuration: ${JSON.stringify(invalidPlan)}`);
});

it('should throw an error if the configuration file has entry without ethAddresses and ipAddresses', async function () {
Expand All @@ -236,9 +215,9 @@ describe('HbarSpendingPlanConfigService', function () {
.stub(HbarSpendingPlanConfigService, 'loadSpendingPlansConfig' as any)
.returns([...spendingPlansConfig, invalidPlan]);

await expect(hbarSpendingPlanConfigService.populatePreconfiguredSpendingPlans()).to.be.rejectedWith(
`Invalid spending plan configuration: ${JSON.stringify(invalidPlan)}`,
);
await expect(
hbarSpendingPlanConfigService.populatePreconfiguredSpendingPlans(),
).to.be.eventually.rejectedWith(`Invalid spending plan configuration: ${JSON.stringify(invalidPlan)}`);
});

it('should throw an error if the configuration file has entry with empty ethAddresses and ipAddresses', async function () {
Expand All @@ -253,9 +232,9 @@ describe('HbarSpendingPlanConfigService', function () {
.stub(HbarSpendingPlanConfigService, 'loadSpendingPlansConfig' as any)
.returns([...spendingPlansConfig, invalidPlan]);

await expect(hbarSpendingPlanConfigService.populatePreconfiguredSpendingPlans()).to.be.rejectedWith(
`Invalid spending plan configuration: ${JSON.stringify(invalidPlan)}`,
);
await expect(
hbarSpendingPlanConfigService.populatePreconfiguredSpendingPlans(),
).to.be.eventually.rejectedWith(`Invalid spending plan configuration: ${JSON.stringify(invalidPlan)}`);
});
});

Expand Down Expand Up @@ -680,22 +659,26 @@ describe('HbarSpendingPlanConfigService', function () {
};

describe('using Redis cache', function () {
useInMemoryRedisServer(logger, 6384);

describe('and with a spending plan config file', function () {
tests(true, true);
tests(spendingPlansConfigFile);
});

describe('and with a spending plan config variable', function () {
tests(true, false);
tests(JSON.stringify(spendingPlansConfig));
});
});

describe('using LRU cache', function () {
describe.only('using LRU cache', function () {
overrideEnvsInMochaDescribe({ REDIS_ENABLED: false });

describe('and with a spending plan config file', function () {
tests(false, true);
tests(spendingPlansConfigFile);
});

describe('and with a spending plan config variable', function () {
tests(false, false);
tests(JSON.stringify(spendingPlansConfig));
});
});
});
6 changes: 1 addition & 5 deletions packages/relay/tests/lib/relay.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@

import chai, { expect } from 'chai';
import chaiAsPromised from 'chai-as-promised';
import findConfig from 'find-config';
import fs from 'fs';
import pino from 'pino';
import sinon from 'sinon';
Expand Down Expand Up @@ -107,7 +106,7 @@ describe('RelayImpl', () => {

describe('when no configuration file is provided', () => {
const nonExistingFile = 'nonExistingFile.json';
overrideEnvsInMochaDescribe({ HBAR_SPENDING_PLANS_CONFIG_FILE: nonExistingFile });
overrideEnvsInMochaDescribe({ HBAR_SPENDING_PLANS_CONFIG: nonExistingFile });

it('should not throw an error', async () => {
expect((relay = new RelayImpl(logger, register))).to.not.throw;
Expand All @@ -119,12 +118,9 @@ describe('RelayImpl', () => {
});

describe('when a configuration file with invalid JSON is provided', () => {
let path: string | null;

overrideEnvsInMochaDescribe({ HBAR_SPENDING_PLANS_CONFIG: 'spendingPlansConfig.example.json' });

beforeEach(() => {
path = findConfig('spendingPlansConfig.example.json');
sinon.stub(fs, 'readFileSync').returns('invalid JSON');
});

Expand Down

0 comments on commit 4eea649

Please sign in to comment.