fix: pass ip as query parameter

Author: rosen-vladimirov

config/config.json

@@ -6,7 +6,7 @@
 	"DISABLE_HOOKS": false,
 	"UPLOAD_PLAYGROUND_FILES_ENDPOINT": "https://play.nativescript.org/api/files",
 	"SHORTEN_URL_ENDPOINT": "https://play.nativescript.org/api/shortenurl?longUrl=%s",
-	"INSIGHTS_URL_ENDPOINT": "https://play.nativescript.org/api/insights",
+	"INSIGHTS_URL_ENDPOINT": "https://play.nativescript.org/api/insights?ipAddress=%s",
 	"WHOAMI_URL_ENDPOINT": "https://play.nativescript.org/api/whoami",
 	"PREVIEW_APP_ENVIRONMENT": "live",
 	"GA_TRACKING_ID": "UA-111455-51"

lib/controllers/company-insights-controller.ts

@@ -1,9 +1,11 @@
+
 import { AnalyticsEventLabelDelimiter } from "../constants";
 import { cache } from "../common/decorators";
 import * as path from "path";
+import * as util from "util";
 
 export class CompanyInsightsController implements ICompanyInsightsController {
-	private static CACHE_TIMEOUT = 48 * 60 * 60 * 1000; // 2 days in milliseconds
+	private static CACHE_TIMEOUT = 30 * 24 * 60 * 60 * 1000; // 30 days in milliseconds
 	private get $jsonFileSettingsService(): IJsonFileSettingsService {
 		return this.$injector.resolve<IJsonFileSettingsService>("jsonFileSettingsService", {
 			jsonFileSettingsPath: path.join(this.$settingsService.getProfileDir(), "company-insights-data.json")
@@ -23,8 +25,8 @@ export class CompanyInsightsController implements ICompanyInsightsController {
 
 		companyData = await this.getCompanyDataFromCache(cacheKey);
 
-		if (!companyData) {
-			companyData = await this.getCompanyDataFromPlaygroundInsightsEndpoint();
+		if (!companyData && currentPublicIP) {
+			companyData = await this.getCompanyDataFromPlaygroundInsightsEndpoint(currentPublicIP);
 			if (companyData && currentPublicIP) {
 				await this.$jsonFileSettingsService.saveSetting<ICompanyData>(cacheKey, companyData, { useCaching: true });
 			}
@@ -62,11 +64,12 @@ export class CompanyInsightsController implements ICompanyInsightsController {
 	}
 
 	@cache()
-	private async getCompanyDataFromPlaygroundInsightsEndpoint(): Promise<ICompanyData> {
+	private async getCompanyDataFromPlaygroundInsightsEndpoint(ipAddress: string): Promise<ICompanyData> {
 		let companyData: ICompanyData = null;
 
 		try {
-			const response = await this.$httpClient.httpRequest(this.$config.INSIGHTS_URL_ENDPOINT);
+			const url = util.format(this.$config.INSIGHTS_URL_ENDPOINT, encodeURIComponent(ipAddress));
+			const response = await this.$httpClient.httpRequest(url);
 			const data = <IPlaygroundInsightsEndpointData>(JSON.parse(response.body));
 			if (data.company) {
 				const industries = _.isArray(data.company.industries) ? data.company.industries.join(AnalyticsEventLabelDelimiter) : null;

test/controllers/company-insights-controller.ts

@@ -4,10 +4,10 @@ import { LoggerStub } from "../stubs";
 import { CompanyInsightsController } from "../../lib/controllers/company-insights-controller";
 
 describe("companyInsightsController", () => {
-	const insightsUrlEndpoint = "/api/insights";
+	const insightsUrlEndpoint = "/api/insights?ipAddress=%s";
 	const currentIp = "8.8.8.8";
 	const profileDir = "profileDir";
-	const cacheTimeout = 48 * 60 * 60 * 1000; // 2 days in milliseconds
+	const cacheTimeout = 30 * 24 * 60 * 60 * 1000; // 2 days in milliseconds
 	const defaultCompanyData = {
 		company: {
 			name: "Progress",
@@ -138,6 +138,17 @@ describe("companyInsightsController", () => {
 				const companyData = await companyInsightsController.getCompanyData();
 				assert.deepEqual(companyData, null);
 			});
+
+			it("unable to get current ip address", async () => {
+				const ipService = testInjector.resolve<IIPService>("ipService");
+				ipService.getCurrentIPv4Address = async (): Promise<string> => { throw new Error("Unable to get current ip addreess"); };
+
+				const companyData = await companyInsightsController.getCompanyData();
+				assert.deepEqual(companyData, null);
+				assert.equal(httpRequestCounter, 0, "We should not have any http request");
+				assert.deepEqual(dataPassedToGetSettingValue, [], "When we are unable to get IP, we should not try to get value from the cache.");
+				assert.deepEqual(dataPassedToSaveSettingValue, [], "When we are unable to get IP, we should not persist anything.");
+			});
 		});
 
 		describe("returns correct data when", () => {
@@ -155,17 +166,6 @@ describe("companyInsightsController", () => {
 
 			describe("data for current ip does not exist in the cache and", () => {
 
-				it("unable to get current ip address, but still can get company information", async () => {
-					const ipService = testInjector.resolve<IIPService>("ipService");
-					ipService.getCurrentIPv4Address = async (): Promise<string> => { throw new Error("Unable to get current ip addreess"); };
-
-					const companyData = await companyInsightsController.getCompanyData();
-					assert.deepEqual(companyData, defaultExpectedCompanyData);
-					assert.equal(httpRequestCounter, 1, "We should have only one http request");
-					assert.deepEqual(dataPassedToGetSettingValue, [], "When we are unable to get IP, we should not try to get value from the cache.");
-					assert.deepEqual(dataPassedToSaveSettingValue, [], "When we are unable to get IP, we should not persist anything.");
-				});
-
 				it("response contains company property", async () => {
 					const companyData = await companyInsightsController.getCompanyData();
 					assert.deepEqual(companyData, defaultExpectedCompanyData);