Skip to content

chore: url validation & README to prevent gRPC footguns. #2130

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

Merged
naseemkullah merged 15 commits into from
May 3, 2021
Merged

chore: url validation & README to prevent gRPC footguns. #2130

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
3644ac4
extend README and url validation to avoid footguns.
lizthegrey Apr 20, 2021
7ebf326
deal with grpc(s) while here
lizthegrey Apr 20, 2021
e26cfed
fix tests by moving serverAddress checks earlier
lizthegrey Apr 20, 2021
d838c47
un-private so util can access
lizthegrey Apr 20, 2021
8d3d793
Update packages/opentelemetry-exporter-collector-grpc/src/CollectorEx…
lizthegrey Apr 21, 2021
368ff76
s#grpc#@grpc/grpc-js#
lizthegrey Apr 21, 2021
9ef56a0
address review feedback.
lizthegrey Apr 30, 2021
19a4bd3
fix lint and nullcheck
lizthegrey Apr 30, 2021
066b283
I hate prettier --fix
lizthegrey Apr 30, 2021
ca71abf
address review feedback.
lizthegrey Apr 30, 2021
0c584ed
my prettier config has diverged :(
lizthegrey Apr 30, 2021
9821727
address lint & review feedback.
lizthegrey Apr 30, 2021
71db080
Merge branch 'main' into lizf.update-grpc-docs
lizthegrey Apr 30, 2021
e55404b
Merge branch 'main' into lizf.update-grpc-docs
lizthegrey May 3, 2021
ea638cc
Merge branch 'main' into lizf.update-grpc-docs
lizthegrey May 3, 2021
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
Prev Previous commit
Next Next commit
fix lint and nullcheck
  • Loading branch information
@lizthegrey
lizthegrey committed Apr 30, 2021
commit 19a4bd39298d8e906d8ed20aa55e3e22fc94f274
2 changes: 1 addition & 1 deletion packages/opentelemetry-exporter-collector-grpc/src/CollectorExporterNodeBase.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ export abstract class CollectorExporterNodeBase<
onSuccess: () => void,
onError: (error: collectorTypes.CollectorExporterError) => void
): void {
const promise = new Promise<void>(resolve => {
const promise = new Promise<void>((resolve) => {
const _onSuccess = (): void => {
onSuccess();
_onFinish();
Expand Down
10 changes: 5 additions & 5 deletions packages/opentelemetry-exporter-collector-grpc/src/util.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import { globalErrorHandler } from '@opentelemetry/core';
import { collectorTypes } from '@opentelemetry/exporter-collector';
import * as path from 'path';
import { CollectorExporterNodeBase } from './CollectorExporterNodeBase';
import { parse } from 'url';
import { URL } from 'url';
import {
CollectorExporterConfigNode,
GRPCQueueItem,
Expand All @@ -47,7 +47,7 @@ export function onInit<ExportItem, ServiceRequest>(
oneofs: true,
includeDirs,
})
.then(packageDefinition => {
.then((packageDefinition) => {
const packageObject: any = grpc.loadPackageDefinition(packageDefinition);

if (collector.getServiceClientType() === ServiceClientType.SPANS) {
Expand All @@ -69,7 +69,7 @@ export function onInit<ExportItem, ServiceRequest>(
});
}
})
.catch(err => {
.catch((err) => {
globalErrorHandler(err);
});
}
Expand Down Expand Up @@ -106,11 +106,11 @@ export function send<ExportItem, ServiceRequest>(
}

export function fixUrl(url: string): string {
const target = parse(url);
const target = URL(url);
if (target.pathname !== '/') {
diag.warn('URL path should not be set when using grpc, ignoring.');
}
if (target.protocol !== '' && !target.protocol.match(/(http|grpc)s?/)) {
if (target.protocol !== '' && !target.protocol?.match(/(http|grpc)s?/)) {
diag.warn('URL protocol should match (http|grpc)s?, ignoring.');
}
return target.host;
Expand Down
21 changes: 12 additions & 9 deletions packages/opentelemetry-exporter-collector-grpc/test/CollectorMetricExporter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ const testCollectorMetricExporter = (params: TestParams) =>
let metrics: metrics.MetricRecord[];
let reqMetadata: grpc.Metadata | undefined;

before(done => {
before((done) => {
server = new grpc.Server();
protoLoader
.load(metricsServiceProtoPath, {
Expand Down Expand Up @@ -142,7 +142,7 @@ const testCollectorMetricExporter = (params: TestParams) =>
const counter: metrics.Metric<metrics.BoundCounter> &
Counter = mockCounter();
const observer: metrics.Metric<metrics.BoundObserver> &
ValueObserver = mockObserver(observerResult => {
ValueObserver = mockObserver((observerResult) => {
observerResult.observe(3, {});
observerResult.observe(6, {});
});
Expand All @@ -166,7 +166,7 @@ const testCollectorMetricExporter = (params: TestParams) =>

describe('instance', () => {
it('should warn about headers', () => {
// Need to stub/spy on the underlying logger as the "diag" instance is global
// Need to stub/spy on the underlying logger as the 'diag' instance is global
const spyLoggerWarn = sinon.stub(diag, 'warn');
collectorExporter = new CollectorMetricExporter({
serviceName: 'basic-service',
Expand All @@ -185,18 +185,21 @@ const testCollectorMetricExporter = (params: TestParams) =>
url: address + '/v1/metrics',
});
const args = spyLoggerWarn.args[0];
assert.strictEqual(args[0], 'URL path should not be set when using grpc, ignoring.');
assert.strictEqual(
args[0],
'URL path should not be set when using grpc, ignoring.'
);
});
});

describe('export', () => {
it('should export metrics', done => {
it('should export metrics', (done) => {
const responseSpy = sinon.spy();
collectorExporter.export(metrics, responseSpy);
setTimeout(() => {
assert.ok(
typeof exportedData !== 'undefined',
'resource' + " doesn't exist"
'resource' + ' doesn't exist'
);
let resource;
if (exportedData) {
Expand All @@ -223,7 +226,7 @@ const testCollectorMetricExporter = (params: TestParams) =>
);
assert.ok(
typeof resource !== 'undefined',
"resource doesn't exist"
'resource doesn't exist'
);
if (resource) {
ensureResourceIsCorrect(resource);
Expand All @@ -239,14 +242,14 @@ const testCollectorMetricExporter = (params: TestParams) =>
});

describe('CollectorMetricExporter - node (getDefaultUrl)', () => {
it('should default to localhost', done => {
it('should default to localhost', (done) => {
const collectorExporter = new CollectorMetricExporter({});
setTimeout(() => {
assert.strictEqual(collectorExporter['url'], 'localhost:4317');
done();
});
});
it('should keep the URL if included', done => {
it('should keep the URL if included', (done) => {
const url = 'http://foo.bar.com';
const collectorExporter = new CollectorMetricExporter({ url });
setTimeout(() => {
Expand Down
21 changes: 12 additions & 9 deletions packages/opentelemetry-exporter-collector-grpc/test/CollectorTraceExporter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ const testCollectorExporter = (params: TestParams) =>
| undefined;
let reqMetadata: grpc.Metadata | undefined;

before(done => {
before((done) => {
server = new grpc.Server();
protoLoader
.load(traceServiceProtoPath, {
Expand Down Expand Up @@ -115,7 +115,7 @@ const testCollectorExporter = (params: TestParams) =>
server.forceShutdown();
});

beforeEach(done => {
beforeEach((done) => {
const credentials = params.useTLS
? grpc.credentials.createSsl(
fs.readFileSync('./test/certs/ca.crt'),
Expand Down Expand Up @@ -143,7 +143,7 @@ const testCollectorExporter = (params: TestParams) =>

describe('instance', () => {
it('should warn about headers when using grpc', () => {
// Need to stub/spy on the underlying logger as the "diag" instance is global
// Need to stub/spy on the underlying logger as the 'diag' instance is global
const spyLoggerWarn = sinon.stub(diag, 'warn');
collectorExporter = new CollectorTraceExporter({
serviceName: 'basic-service',
Expand All @@ -162,19 +162,22 @@ const testCollectorExporter = (params: TestParams) =>
url: address + '/v1/trace',
});
const args = spyLoggerWarn.args[0];
assert.strictEqual(args[0], 'URL path should not be set when using grpc, ignoring.');
assert.strictEqual(
args[0],
'URL path should not be set when using grpc, ignoring.'
);
});
});

describe('export', () => {
it('should export spans', done => {
it('should export spans', (done) => {
const responseSpy = sinon.spy();
const spans = [Object.assign({}, mockedReadableSpan)];
collectorExporter.export(spans, responseSpy);
setTimeout(() => {
assert.ok(
typeof exportedData !== 'undefined',
'resource' + " doesn't exist"
'resource' + ' doesn't exist'
);
let spans;
let resource;
Expand All @@ -185,7 +188,7 @@ const testCollectorExporter = (params: TestParams) =>

assert.ok(
typeof resource !== 'undefined',
"resource doesn't exist"
'resource doesn't exist'
);
if (resource) {
ensureResourceIsCorrect(resource);
Expand All @@ -201,14 +204,14 @@ const testCollectorExporter = (params: TestParams) =>
});

describe('CollectorTraceExporter - node (getDefaultUrl)', () => {
it('should default to localhost', done => {
it('should default to localhost', (done) => {
const collectorExporter = new CollectorTraceExporter({});
setTimeout(() => {
assert.strictEqual(collectorExporter['url'], 'localhost:4317');
done();
});
});
it('should keep the URL if included', done => {
it('should keep the URL if included', (done) => {
const url = 'http://foo.bar.com';
const collectorExporter = new CollectorTraceExporter({ url });
setTimeout(() => {
Expand Down