Skip to content

Remove Logger from performance backend log use case #2460

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.

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

Merged
merged 7 commits into from
Dec 23, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 2 additions & 6 deletions packages/performance/src/services/cc_service.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@

import { stub, useFakeTimers, SinonStub } from 'sinon';
import { use, expect } from 'chai';
import { Logger, LogLevel } from '@firebase/logger';
import * as sinonChai from 'sinon-chai';

use(sinonChai);
Expand Down Expand Up @@ -50,9 +49,8 @@ describe('Firebase Performance > cc_service', () => {
});

it('throws an error when logging an empty message', () => {
const logger = new Logger('@firebase/performance/cc');
expect(() => {
testCCHandler(logger, LogLevel.SILENT, '');
testCCHandler('');
}).to.throw;
});

Expand All @@ -69,16 +67,14 @@ describe('Firebase Performance > cc_service', () => {
});

it('attempts to log an event to clearcut after DEFAULT_SEND_INTERVAL_MS if queue not empty', () => {
const logger = new Logger('@firebase/performance/cc');

fetchStub.resolves(
new Response('', {
status: 200,
headers: { 'Content-type': 'application/json' }
})
);

testCCHandler(logger, LogLevel.SILENT, 'someEvent');
testCCHandler('someEvent');
clock.tick(DEFAULT_SEND_INTERVAL_MS);
expect(fetchStub).to.have.been.calledOnce;
});
Expand Down
7 changes: 2 additions & 5 deletions packages/performance/src/services/cc_service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
* limitations under the License.
*/

import { LogHandler, Logger, LogLevel } from '@firebase/logger';
import { SettingsService } from './settings_service';
import { ERROR_FACTORY, ErrorCode } from '../utils/errors';
import { consoleLogger } from '../utils/console_logger';
Expand Down Expand Up @@ -135,10 +134,8 @@ function addToQueue(evt: BatchEvent): void {
export function ccHandler(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
serializer: (...args: any[]) => string
): LogHandler {
// The underscores for loggerInstance and level parameters are added to avoid the
// noUnusedParameters related error.
return (_loggerInstance: Logger, _level: LogLevel, ...args) => {
): (...args: unknown[]) => void {
return (...args) => {
const message = serializer(...args);
addToQueue({
message,
Expand Down
7 changes: 4 additions & 3 deletions packages/performance/src/services/perf_logger.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@

import { stub, SinonStub, useFakeTimers, SinonFakeTimers } from 'sinon';
import { Trace } from '../resources/trace';
import { LogHandler, Logger, LogLevel } from '@firebase/logger';
import * as ccService from './cc_service';
import * as iidService from './iid_service';
import { expect } from 'chai';
Expand Down Expand Up @@ -49,8 +48,10 @@ describe('Performance Monitoring > perf_logger', () => {
let getIidStub: SinonStub<[], string | undefined>;
let clock: SinonFakeTimers;

function mockCcHandler(serializer: (...args: any[]) => string): LogHandler {
return (_loggerInstance: Logger, _level: LogLevel, ...args) => {
function mockCcHandler(
serializer: (...args: any[]) => string
): (...args: any[]) => void {
return (...args) => {
const message = serializer(...args);
addToQueueStub({
message,
Expand Down
33 changes: 18 additions & 15 deletions packages/performance/src/services/perf_logger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ import {
isPerfInitialized,
getInitializationPromise
} from './initialization_service';
import { Logger } from '@firebase/logger';
import { ccHandler } from './cc_service';
import { SDK_VERSION } from '../constants';

Expand Down Expand Up @@ -83,18 +82,22 @@ interface TraceMetric {
counters?: Array<{ key: string; value: number }>;
custom_attributes?: Array<{ key: string; value: string }>;
}

/* eslint-enble camelcase */

let logger: Logger | undefined;
let logger: (
resource: NetworkRequest | Trace,
resourceType: ResourceType
) => void | undefined;
// This method is not called before initialization.
function getLogger(): Logger {
if (logger) {
return logger;
function sendLog(
resource: NetworkRequest | Trace,
resourceType: ResourceType
): void {
if (!logger) {
logger = ccHandler(serializer);
}
const ccLogger = ccHandler(serializer);
logger = new Logger('@firebase/performance/cc');
logger.logHandler = ccLogger;
return logger;
logger(resource, resourceType);
}

export function logTrace(trace: Trace): void {
Expand Down Expand Up @@ -137,7 +140,7 @@ export function logTrace(trace: Trace): void {

function sendTraceLog(trace: Trace): void {
if (getIid()) {
setTimeout(() => getLogger().log(trace, ResourceType.Trace), 0);
setTimeout(() => sendLog(trace, ResourceType.Trace), 0);
}
}

Expand All @@ -159,13 +162,13 @@ export function logNetworkRequest(networkRequest: NetworkRequest): void {
return;
}

setTimeout(
() => getLogger().log(networkRequest, ResourceType.NetworkRequest),
0
);
setTimeout(() => sendLog(networkRequest, ResourceType.NetworkRequest), 0);
}

function serializer(resource: {}, resourceType: ResourceType): string {
function serializer(
resource: NetworkRequest | Trace,
resourceType: ResourceType
): string {
if (resourceType === ResourceType.NetworkRequest) {
return serializeNetworkRequest(resource as NetworkRequest);
}
Expand Down