https://issues.newrelic.com/browse/NR-1007: /no-auth/nr-ingest-key endpoint

Author: cstryker

api_server/modules/analytics/analytics.js

@@ -86,7 +86,6 @@ class Analytics extends APIServerModule {
 			}
 		};
 	}
-
 }
 
 module.exports = Analytics;

api_server/modules/newrelic/newrelic_auth.js

@@ -11,13 +11,26 @@ const OAUTH_CONFIG = {
 	needsConfigure: true
 };
 
+const ROUTES = [
+	{
+		method: 'get',
+		path: '/no-auth/nr-ingest-key',
+		func: 'handleNRIngestKey',
+		describe: 'describeNRIngestKey'
+	}
+];
+
 class NewRelicAuth extends OAuthModule {
 
 	constructor (config) {
 		super(config);
 		this.oauthConfig = OAUTH_CONFIG;
 	}
 
+	getRoutes () {
+		return ROUTES;
+	}
+
 	async providerInfoHook (info) {
 		if (!info.data || !info.data.accessToken || !info.teamId || !info.request) { return; }
 
@@ -77,6 +90,41 @@ class NewRelicAuth extends OAuthModule {
 			info.request.warn(`Could not publish company update to channel ${channel}: ${JSON.stringify(error)}`);
 		}
 	}
+
+	// handle request to fetch ingest key information for New Relic data ingest,
+	// one level of indirection used to retrieve the keys the client will use for ingest
+	handleNRIngestKey (request, response) {
+		if (!request.headers['x-cs-plugin-ide']) {
+			const error = 'IDE key not present in header';
+			this.api.warn(error);
+			return response.status(403).send({ error });
+		}
+
+		const { browserIngestKey, licenseIngestKey, telemetryEndpoint } = this.api.config.integrations.newrelic;
+		response.send({
+			browserIngestKey,
+			licenseIngestKey,
+			telemetryEndpoint
+		});
+	}
+
+	describeIngestKey () {
+		return {
+			tag: 'nr-ingest-key',
+			summary: 'Retrieve ingest key for New Relic APM',
+			description: 'Retrieve ingest key and other info for use with New Relic application monitoring',
+			access: 'User must provide the secret',
+			input: 'Specify the secret in the query parameter "secret"',
+			returns: {
+				summary: 'The New Relic ingest key to use when initializing client-side New Relic APM',
+				looksLike: {
+					browserIngestKey: '<The key for browser ingest>',
+					licenseIngestKey: '<The key for agent ingest>',
+					telemetryEndpoint: '<Endpoint hostname for ingest collector>'
+				}
+			}
+		};
+	}
 }
 
 module.exports = NewRelicAuth;

api_server/modules/newrelic/test/ingest_key_test.js

@@ -0,0 +1,48 @@
+// base class for all ingest key tests
+
+'use strict';
+
+const CodeStreamAPITest = require(process.env.CSSVC_BACKEND_ROOT + '/api_server/lib/test_base/codestream_api_test');
+const Assert = require('assert');
+
+class IngestKeyTest extends CodeStreamAPITest {
+
+	constructor (options) {
+		super(options);
+		this.userOptions.numRegistered = 0;
+		delete this.teamOptions.creatorIndex;
+	}
+
+	get description () {
+		return 'should send the ingest key when requested with the proper secret';
+	}
+	
+	get method () {
+		return 'get';
+	}
+
+	get path () {
+		return '/no-auth/nr-ingest-key';
+	}
+
+	before (callback) {
+		super.before(error => {
+			if (error) { return callback(error); }
+			this.apiRequestOptions = this.apiRequestOptions || {};
+			this.apiRequestOptions.headers = this.apiRequestOptions.headers || {};
+			this.apiRequestOptions.headers = {
+				'X-CS-Plugin-IDE': 'test'
+			};
+			callback();
+		});
+	}
+
+	// validate the response to the test request
+	validateResponse (data) {
+		const { browserIngestKey, licenseIngestKey, telemetryEndpoint } = this.apiConfig.integrations.newrelic;
+		const expectedResponse = { browserIngestKey, licenseIngestKey, telemetryEndpoint };
+		Assert.deepStrictEqual(data, expectedResponse, 'incorrect response');
+	}
+}
+
+module.exports = IngestKeyTest;

api_server/modules/newrelic/test/no_plugin_header_test.js

@@ -0,0 +1,26 @@
+'use strict';
+
+const IngestKeyTest = require('./ingest_key_test');
+
+class NoPluginHeaderTest extends IngestKeyTest {
+
+	get description () {
+		return 'should return an error when an attempt is made to fetch the New Relic ingest key without providing the x-cs-plugin-ide header';
+	}
+
+	getExpectedError () {
+		return {
+			error: 'IDE key not present in header'
+		};
+	}
+
+	before (callback) {
+		super.before (error => {
+			if (error) { return callback(error); }
+			delete this.apiRequestOptions.headers['X-CS-Plugin-IDE'];
+			callback();
+		});
+	}
+}
+
+module.exports = NoPluginHeaderTest;

api_server/modules/newrelic/test/test.js

@@ -0,0 +1,15 @@
+// unit tests associated with the New Relic module
+
+'use strict';
+
+// make eslint happy
+/* globals describe */
+
+const IngestKeyTest = require('./ingest_key_test');
+const NoPluginHeaderTest = require('./no_plugin_header_test');
+
+describe('new relic', function() {
+
+	new IngestKeyTest().test();
+	new NoPluginHeaderTest().test();
+});

api_server/modules/test.js

@@ -9,6 +9,7 @@ describe('modules', () => {
 	require('./authenticator/test/test.js');
 	require('./versioner/test/test.js');
 	require('./analytics/test/test.js');
+	require('./newrelic/test/test.js');
 	require('./broadcaster/test/test.js');
 	require('./users/test/test.js');
 	require('./providers/test/test.js');