Skip to content

Commit

Permalink
fix: move toggle-counters to metrics service
Browse files Browse the repository at this point in the history
  • Loading branch information
ivarconr committed Dec 10, 2021
1 parent 9f13b80 commit bb4e629
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 29 deletions.
23 changes: 6 additions & 17 deletions src/lib/services/client-metrics/client-instance-service.ts
@@ -1,6 +1,5 @@
import { applicationSchema } from './metrics-schema';
import { clientMetricsSchema } from './client-metrics-schema';
import { APPLICATION_CREATED, CLIENT_METRICS } from '../../types/events';
import { APPLICATION_CREATED } from '../../types/events';
import { IApplication } from './models';
import { IUnleashStores } from '../../types/stores';
import { IUnleashConfig } from '../../types/option';
Expand All @@ -17,8 +16,8 @@ import { IClientApp } from '../../types/model';
import { clientRegisterSchema } from './register-schema';

import { minutesToMilliseconds, secondsToMilliseconds } from 'date-fns';
import EventEmitter from 'events';
import { IClientMetricsStoreV2 } from '../../types/stores/client-metrics-store-v2';
import { clientMetricsSchema } from './client-metrics-schema';

export default class ClientInstanceService {
apps = {};
Expand All @@ -45,8 +44,6 @@ export default class ClientInstanceService {

private announcementInterval: number;

private eventBus: EventEmitter;

constructor(
{
clientMetricsStoreV2,
Expand All @@ -64,7 +61,7 @@ export default class ClientInstanceService {
| 'clientInstanceStore'
| 'eventStore'
>,
{ getLogger, eventBus }: Pick<IUnleashConfig, 'getLogger' | 'eventBus'>,
{ getLogger }: Pick<IUnleashConfig, 'getLogger'>,
bulkInterval = secondsToMilliseconds(5),
announcementInterval = minutesToMilliseconds(5),
) {
Expand All @@ -74,9 +71,10 @@ export default class ClientInstanceService {
this.clientApplicationsStore = clientApplicationsStore;
this.clientInstanceStore = clientInstanceStore;
this.eventStore = eventStore;
this.eventBus = eventBus;

this.logger = getLogger('/services/client-metrics/index.ts');
this.logger = getLogger(
'/services/client-metrics/client-instance-service.ts',
);

this.bulkInterval = bulkInterval;
this.announcementInterval = announcementInterval;
Expand All @@ -96,20 +94,11 @@ export default class ClientInstanceService {
clientIp: string,
): Promise<void> {
const value = await clientMetricsSchema.validateAsync(data);

await this.clientInstanceStore.insert({
appName: value.appName,
instanceId: value.instanceId,
clientIp,
});

// TODO: move to new service
const toggleNames = Object.keys(value.bucket.toggles);
if (toggleNames.length > 0) {
await this.featureToggleStore.setLastSeen(toggleNames);
}

this.eventBus.emit(CLIENT_METRICS, value);
}

public async registerClient(
Expand Down
25 changes: 21 additions & 4 deletions src/lib/services/client-metrics/client-metrics-service-v2.ts
Expand Up @@ -9,24 +9,37 @@ import {
} from '../../types/stores/client-metrics-store-v2';
import { clientMetricsSchema } from './client-metrics-schema';
import { hoursToMilliseconds, minutesToMilliseconds } from 'date-fns';
import { IFeatureToggleStore } from '../../types/stores/feature-toggle-store';
import EventEmitter from 'events';
import { CLIENT_METRICS } from '../../types/events';

export default class ClientMetricsServiceV2 {
private timer: NodeJS.Timeout;

private clientMetricsStoreV2: IClientMetricsStoreV2;

private featureToggleStore: IFeatureToggleStore;

private eventBus: EventEmitter;

private logger: Logger;

private bulkInterval: number;

constructor(
{ clientMetricsStoreV2 }: Pick<IUnleashStores, 'clientMetricsStoreV2'>,
{ getLogger }: Pick<IUnleashConfig, 'getLogger'>,
{
featureToggleStore,
clientMetricsStoreV2,
}: Pick<IUnleashStores, 'featureToggleStore' | 'clientMetricsStoreV2'>,
{ eventBus, getLogger }: Pick<IUnleashConfig, 'eventBus' | 'getLogger'>,
bulkInterval = minutesToMilliseconds(5),
) {
this.featureToggleStore = featureToggleStore;
this.clientMetricsStoreV2 = clientMetricsStoreV2;

this.logger = getLogger('/services/client-metrics/index.ts');
this.eventBus = eventBus;
this.logger = getLogger(
'/services/client-metrics/client-metrics-service-v2.ts',
);

this.bulkInterval = bulkInterval;
this.timer = setInterval(async () => {
Expand All @@ -41,6 +54,9 @@ export default class ClientMetricsServiceV2 {
): Promise<void> {
const value = await clientMetricsSchema.validateAsync(data);
const toggleNames = Object.keys(value.bucket.toggles);
if (toggleNames.length > 0) {
await this.featureToggleStore.setLastSeen(toggleNames);
}

this.logger.debug(`got metrics from ${clientIp}`);

Expand All @@ -57,6 +73,7 @@ export default class ClientMetricsServiceV2 {

// TODO: should we aggregate for a few minutes (bulkInterval) before pushing to DB?
await this.clientMetricsStoreV2.batchInsertMetrics(clientMetrics);
this.eventBus.emit(CLIENT_METRICS, value);
}

// Overview over usage last "hour" bucket and all applications using the toggle
Expand Down
9 changes: 4 additions & 5 deletions src/lib/services/client-metrics/client-metrics.test.ts
@@ -1,4 +1,3 @@
import EventEmitter from 'events';
import ClientInstanceService from './client-instance-service';
import getLogger from '../../../test/fixtures/no-logger';
import { IClientApp } from '../../types/model';
Expand Down Expand Up @@ -57,7 +56,7 @@ test('Multiple registrations of same appname and instanceid within same time per
clientInstanceStore,
eventStore: null,
},
{ getLogger, eventBus: new EventEmitter() },
{ getLogger },
);
const client1: IClientApp = {
appName: 'test_app',
Expand Down Expand Up @@ -107,7 +106,7 @@ test('Multiple unique clients causes multiple registrations', async () => {
clientInstanceStore,
eventStore: null,
},
{ getLogger, eventBus: new EventEmitter() },
{ getLogger },
);
const client1 = {
appName: 'test_app',
Expand Down Expand Up @@ -160,7 +159,7 @@ test('Same client registered outside of dedup interval will be registered twice'
clientInstanceStore,
eventStore: null,
},
{ getLogger, eventBus: new EventEmitter() },
{ getLogger },
bulkInterval,
);
const client1 = {
Expand Down Expand Up @@ -213,7 +212,7 @@ test('No registrations during a time period will not call stores', async () => {
clientInstanceStore,
eventStore: null,
},
{ getLogger, eventBus: new EventEmitter() },
{ getLogger },
);
jest.advanceTimersByTime(6000);
expect(appStoreSpy).toHaveBeenCalledTimes(0);
Expand Down
4 changes: 1 addition & 3 deletions src/test/e2e/services/client-metrics-service.e2e.test.ts
@@ -1,7 +1,6 @@
import ClientInstanceService from '../../../lib/services/client-metrics/client-instance-service';
import { IClientApp } from '../../../lib/types/model';
import { secondsToMilliseconds } from 'date-fns';
import EventEmitter from 'events';

const faker = require('faker');
const dbInit = require('../helpers/database-init');
Expand All @@ -15,14 +14,13 @@ let clientInstanceService;
beforeAll(async () => {
db = await dbInit('client_metrics_service_serial', getLogger);
stores = db.stores;
const eventBus = new EventEmitter();

const bulkInterval = secondsToMilliseconds(0.5);
const announcementInterval = secondsToMilliseconds(2);

clientInstanceService = new ClientInstanceService(
stores,
{ getLogger, eventBus },
{ getLogger },
bulkInterval,
announcementInterval,
);
Expand Down

0 comments on commit bb4e629

Please sign in to comment.