Skip to content

Commit ed134c4

Browse files
rahuln-bsrahuln-bs
authored
Merge pull request #312 from roshan04/improving_instrumentation
Improving instrumentation
2 parents 754690e + 578bf12 commit ed134c4

File tree

17 files changed

+357
-164
lines changed

17 files changed

+357
-164
lines changed

‎bin/commands/generateDownloads.js

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
const logger = require("../helpers/logger").winstonLogger,
44
Constants = require("../helpers/constants"),
55
utils = require("../helpers/utils"),
6-
downloadBuildArtifacts = require('../helpers/buildArtifacts').downloadBuildArtifacts;
6+
downloadBuildArtifacts = require('../helpers/buildArtifacts').downloadBuildArtifacts,
7+
getInitialDetails = require('../helpers/getInitialDetails').getInitialDetails;
78

89

910
module.exports = async function generateDownloads(args, rawArgs) {
@@ -19,6 +20,8 @@ module.exports = async function generateDownloads(args, rawArgs) {
1920
// accept the access key from command line if provided
2021
utils.setAccessKey(bsConfig, args);
2122

23+
let buildReportData = await getInitialDetails(bsConfig, args, rawArgs);
24+
2225
utils.setUsageReportingFlag(bsConfig, args.disableUsageReporting);
2326

2427
// set cypress config filename
@@ -28,8 +31,8 @@ module.exports = async function generateDownloads(args, rawArgs) {
2831
let errorCode = null;
2932
let buildId = args._[1];
3033

31-
await downloadBuildArtifacts(bsConfig, buildId, args, rawArgs);
32-
utils.sendUsageReport(bsConfig, args, Constants.usageReportingConstants.GENERATE_DOWNLOADS, messageType, errorCode, null, rawArgs);
34+
await downloadBuildArtifacts(bsConfig, buildId, args, rawArgs, buildReportData);
35+
utils.sendUsageReport(bsConfig, args, Constants.usageReportingConstants.GENERATE_DOWNLOADS, messageType, errorCode, buildReportData, rawArgs);
3336
}).catch(function (err) {
3437
logger.error(err);
3538
utils.setUsageReportingFlag(null, args.disableUsageReporting);

‎bin/commands/generateReport.js

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
const logger = require("../helpers/logger").winstonLogger,
44
Constants = require("../helpers/constants"),
55
utils = require("../helpers/utils"),
6-
reporterHTML = require('../helpers/reporterHTML');
6+
reporterHTML = require('../helpers/reporterHTML'),
7+
getInitialDetails = require('../helpers/getInitialDetails').getInitialDetails;
78

89

910
module.exports = function generateReport(args, rawArgs) {
@@ -20,17 +21,22 @@ module.exports = function generateReport(args, rawArgs) {
2021
// accept the access key from command line if provided
2122
utils.setAccessKey(bsConfig, args);
2223

23-
utils.setUsageReportingFlag(bsConfig, args.disableUsageReporting);
24-
25-
// set cypress config filename
26-
utils.setCypressConfigFilename(bsConfig, args);
27-
28-
let messageType = Constants.messageTypes.INFO;
29-
let errorCode = null;
30-
let buildId = args._[1];
31-
32-
reportGenerator(bsConfig, buildId, args, rawArgs);
33-
utils.sendUsageReport(bsConfig, args, 'generate-report called', messageType, errorCode, null, rawArgs);
24+
getInitialDetails(bsConfig, args, rawArgs).then((buildReportData) => {
25+
26+
utils.setUsageReportingFlag(bsConfig, args.disableUsageReporting);
27+
28+
// set cypress config filename
29+
utils.setCypressConfigFilename(bsConfig, args);
30+
31+
let messageType = Constants.messageTypes.INFO;
32+
let errorCode = null;
33+
let buildId = args._[1];
34+
35+
reportGenerator(bsConfig, buildId, args, rawArgs, buildReportData);
36+
utils.sendUsageReport(bsConfig, args, 'generate-report called', messageType, errorCode, buildReportData, rawArgs);
37+
}).catch((err) => {
38+
logger.warn(err);
39+
});
3440
}).catch(function (err) {
3541
logger.error(err);
3642
utils.setUsageReportingFlag(null, args.disableUsageReporting);

‎bin/commands/info.js

Lines changed: 73 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ const request = require('request');
44
const config = require("../helpers/config"),
55
logger = require("../helpers/logger").winstonLogger,
66
Constants = require("../helpers/constants"),
7-
utils = require("../helpers/utils");
7+
utils = require("../helpers/utils"),
8+
getInitialDetails = require('../helpers/getInitialDetails').getInitialDetails;
89

910
module.exports = function info(args, rawArgs) {
1011
let bsConfigPath = utils.getConfigPath(args.cf);
@@ -18,82 +19,86 @@ module.exports = function info(args, rawArgs) {
1819
// accept the access key from command line if provided
1920
utils.setAccessKey(bsConfig, args);
2021

21-
utils.setUsageReportingFlag(bsConfig, args.disableUsageReporting);
22+
getInitialDetails(bsConfig, args, rawArgs).then((buildReportData) => {
2223

23-
// set cypress config filename
24-
utils.setCypressConfigFilename(bsConfig, args);
24+
utils.setUsageReportingFlag(bsConfig, args.disableUsageReporting);
2525

26-
let buildId = args._[1];
26+
// set cypress config filename
27+
utils.setCypressConfigFilename(bsConfig, args);
2728

28-
let options = {
29-
url: config.buildUrl + buildId,
30-
auth: {
31-
user: bsConfig.auth.username,
32-
password: bsConfig.auth.access_key,
33-
},
34-
headers: {
35-
'User-Agent': utils.getUserAgent(),
36-
},
37-
};
29+
let buildId = args._[1];
3830

39-
request.get(options, function (err, resp, body) {
40-
let message = null;
41-
let messageType = null;
42-
let errorCode = null;
43-
44-
if (err) {
45-
message = Constants.userMessages.BUILD_INFO_FAILED;
46-
messageType = Constants.messageTypes.ERROR;
47-
errorCode = 'api_failed_build_info';
48-
49-
logger.info(message);
50-
logger.error(utils.formatRequest(err, resp, body));
51-
} else {
52-
let build = null;
53-
try {
54-
build = JSON.parse(body);
55-
} catch (error) {
56-
build = null;
57-
}
58-
59-
if (resp.statusCode == 299) {
60-
messageType = Constants.messageTypes.INFO;
61-
errorCode = 'api_deprecated';
62-
63-
if (build) {
64-
message = build.message;
65-
logger.info(message);
66-
} else {
67-
message = Constants.userMessages.API_DEPRECATED;
68-
logger.info(message);
69-
}
70-
logger.info(utils.formatRequest(err, resp, body));
71-
} else if (resp.statusCode != 200) {
31+
let options = {
32+
url: config.buildUrl + buildId,
33+
auth: {
34+
user: bsConfig.auth.username,
35+
password: bsConfig.auth.access_key,
36+
},
37+
headers: {
38+
'User-Agent': utils.getUserAgent(),
39+
},
40+
};
41+
request.get(options, function (err, resp, body) {
42+
let message = null;
43+
let messageType = null;
44+
let errorCode = null;
45+
46+
if (err) {
47+
message = Constants.userMessages.BUILD_INFO_FAILED;
7248
messageType = Constants.messageTypes.ERROR;
7349
errorCode = 'api_failed_build_info';
74-
75-
if (build) {
76-
message = `${
77-
Constants.userMessages.BUILD_INFO_FAILED
78-
} with error: \n${JSON.stringify(build, null, 2)}`;
79-
logger.error(message);
80-
if (build.message === 'Unauthorized') errorCode = 'api_auth_failed';
81-
} else {
82-
message = Constants.userMessages.BUILD_INFO_FAILED;
83-
logger.error(message);
84-
}
50+
51+
logger.info(message);
8552
logger.error(utils.formatRequest(err, resp, body));
8653
} else {
87-
messageType = Constants.messageTypes.SUCCESS;
88-
message = `Build info for build id: \n ${JSON.stringify(
89-
build,
90-
null,
91-
2
92-
)}`;
93-
logger.info(message);
54+
let build = null;
55+
try {
56+
build = JSON.parse(body);
57+
} catch (error) {
58+
build = null;
59+
}
60+
61+
if (resp.statusCode == 299) {
62+
messageType = Constants.messageTypes.INFO;
63+
errorCode = 'api_deprecated';
64+
65+
if (build) {
66+
message = build.message;
67+
logger.info(message);
68+
} else {
69+
message = Constants.userMessages.API_DEPRECATED;
70+
logger.info(message);
71+
}
72+
logger.info(utils.formatRequest(err, resp, body));
73+
} else if (resp.statusCode != 200) {
74+
messageType = Constants.messageTypes.ERROR;
75+
errorCode = 'api_failed_build_info';
76+
77+
if (build) {
78+
message = `${
79+
Constants.userMessages.BUILD_INFO_FAILED
80+
} with error: \n${JSON.stringify(build, null, 2)}`;
81+
logger.error(message);
82+
if (build.message === 'Unauthorized') errorCode = 'api_auth_failed';
83+
} else {
84+
message = Constants.userMessages.BUILD_INFO_FAILED;
85+
logger.error(message);
86+
}
87+
logger.error(utils.formatRequest(err, resp, body));
88+
} else {
89+
messageType = Constants.messageTypes.SUCCESS;
90+
message = `Build info for build id: \n ${JSON.stringify(
91+
build,
92+
null,
93+
2
94+
)}`;
95+
logger.info(message);
96+
}
9497
}
95-
}
96-
utils.sendUsageReport(bsConfig, args, message, messageType, errorCode, null, rawArgs);
98+
utils.sendUsageReport(bsConfig, args, message, messageType, errorCode, buildReportData, rawArgs);
99+
});
100+
}).catch((err) => {
101+
logger.warn(err);
97102
});
98103
}).catch(function (err) {
99104
logger.error(err);

‎bin/commands/runs.js

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ const archiver = require("../helpers/archiver"),
1010
Constants = require("../helpers/constants"),
1111
utils = require("../helpers/utils"),
1212
fileHelpers = require("../helpers/fileHelpers"),
13+
getInitialDetails = require('../helpers/getInitialDetails').getInitialDetails,
1314
syncRunner = require("../helpers/syncRunner"),
1415
checkUploaded = require("../helpers/checkUploaded"),
1516
packageInstaller = require("../helpers/packageInstaller"),
@@ -52,6 +53,8 @@ module.exports = function run(args, rawArgs) {
5253
// accept the access key from command line or env variable if provided
5354
utils.setAccessKey(bsConfig, args);
5455

56+
let buildReportData = await getInitialDetails(bsConfig, args, rawArgs);
57+
5558
// accept the build name from command line if provided
5659
utils.setBuildName(bsConfig, args);
5760

@@ -128,7 +131,7 @@ module.exports = function run(args, rawArgs) {
128131
utils.setParallels(bsConfig, args, specFiles.length);
129132

130133
// warn if specFiles cross our limit
131-
utils.warnSpecLimit(bsConfig, args, specFiles, rawArgs);
134+
utils.warnSpecLimit(bsConfig, args, specFiles, rawArgs, buildReportData);
132135
markBlockEnd('preArchiveSteps');
133136
logger.debug("Completed pre-archive steps");
134137
markBlockStart('zip');
@@ -168,7 +171,7 @@ module.exports = function run(args, rawArgs) {
168171
//setup Local Testing
169172
markBlockStart('localSetup');
170173
logger.debug("Started setting up BrowserStack Local connection");
171-
let bs_local = await utils.setupLocalTesting(bsConfig, args, rawArgs);
174+
let bs_local = await utils.setupLocalTesting(bsConfig, args, rawArgs, buildReportData);
172175
logger.debug('Completed setting up BrowserStack Local connection');
173176
markBlockEnd('localSetup');
174177
logger.debug("Started build creation");
@@ -177,14 +180,10 @@ module.exports = function run(args, rawArgs) {
177180
logger.debug("Completed build creation");
178181
markBlockEnd('createBuild');
179182
markBlockEnd('total');
180-
utils.setProcessHooks(data.build_id, bsConfig, bs_local, args);
183+
utils.setProcessHooks(data.build_id, bsConfig, bs_local, args, buildReportData);
181184
let message = `${data.message}! ${Constants.userMessages.BUILD_CREATED} with build id: ${data.build_id}`;
182185
let dashboardLink = `${Constants.userMessages.VISIT_DASHBOARD} ${data.dashboard_url}`;
183-
let buildReportData = {
184-
'build_id': data.build_id,
185-
'user_id': data.user_id,
186-
'parallels': userSpecifiedParallels
187-
};
186+
buildReportData = { 'build_id': data.build_id, 'parallels': userSpecifiedParallels, ...buildReportData }
188187
utils.exportResults(data.build_id, `${config.dashboardUrl}${data.build_id}`);
189188
if ((utils.isUndefined(bsConfig.run_settings.parallels) && utils.isUndefined(args.parallels)) || (!utils.isUndefined(bsConfig.run_settings.parallels) && bsConfig.run_settings.parallels == Constants.cliMessages.RUN.DEFAULT_PARALLEL_MESSAGE)) {
190189
logger.warn(Constants.userMessages.NO_PARALLELS);
@@ -208,11 +207,11 @@ module.exports = function run(args, rawArgs) {
208207

209208
if (args.sync) {
210209
logger.debug("Started polling build status from BrowserStack");
211-
syncRunner.pollBuildStatus(bsConfig, data, rawArgs).then(async (exitCode) => {
210+
syncRunner.pollBuildStatus(bsConfig, data, rawArgs, buildReportData).then(async (exitCode) => {
212211
logger.debug("Completed polling of build status");
213212

214213
// stop the Local instance
215-
await utils.stopLocalBinary(bsConfig, bs_local, args, rawArgs);
214+
await utils.stopLocalBinary(bsConfig, bs_local, args, rawArgs, buildReportData);
216215

217216
// waiting for 5 secs for upload to complete (as a safety measure)
218217
await new Promise(resolve => setTimeout(resolve, 5000));
@@ -221,11 +220,11 @@ module.exports = function run(args, rawArgs) {
221220
if (exitCode != Constants.BUILD_FAILED_EXIT_CODE) {
222221
if (utils.nonEmptyArray(bsConfig.run_settings.downloads)) {
223222
logger.debug("Downloading build artifacts");
224-
await downloadBuildArtifacts(bsConfig, data.build_id, args, rawArgs);
223+
await downloadBuildArtifacts(bsConfig, data.build_id, args, rawArgs, buildReportData);
225224
}
226225

227226
// Generate custom report!
228-
reportGenerator(bsConfig, data.build_id, args, rawArgs, function(){
227+
reportGenerator(bsConfig, data.build_id, args, rawArgs, buildReportData, function(){
229228
utils.sendUsageReport(bsConfig, args, `${message}\n${dashboardLink}`, Constants.messageTypes.SUCCESS, null, buildReportData, rawArgs);
230229
utils.handleSyncExit(exitCode, data.dashboard_url);
231230
});
@@ -299,24 +298,24 @@ module.exports = function run(args, rawArgs) {
299298
// Build creation failed
300299
logger.error(err);
301300
// stop the Local instance
302-
await utils.stopLocalBinary(bsConfig, bs_local, args, rawArgs);
301+
await utils.stopLocalBinary(bsConfig, bs_local, args, rawArgs, buildReportData);
303302

304-
utils.sendUsageReport(bsConfig, args, err, Constants.messageTypes.ERROR, 'build_failed', null, rawArgs);
303+
utils.sendUsageReport(bsConfig, args, err, Constants.messageTypes.ERROR, 'build_failed', buildReportData, rawArgs);
305304
process.exitCode = Constants.ERROR_EXIT_CODE;
306305
});
307306
}).catch(function (err) {
308307
// Zip Upload failed | Local Start failed
309308
logger.error(err);
310309
if(err === Constants.userMessages.LOCAL_START_FAILED){
311-
utils.sendUsageReport(bsConfig, args, `${err}\n${Constants.userMessages.LOCAL_START_FAILED}`, Constants.messageTypes.ERROR, 'local_start_failed', null, rawArgs);
310+
utils.sendUsageReport(bsConfig, args, `${err}\n${Constants.userMessages.LOCAL_START_FAILED}`, Constants.messageTypes.ERROR, 'local_start_failed', buildReportData, rawArgs);
312311
} else {
313312
logger.error(Constants.userMessages.ZIP_UPLOAD_FAILED);
314313
fileHelpers.deleteZip();
315-
utils.sendUsageReport(bsConfig, args, `${err}\n${Constants.userMessages.ZIP_UPLOAD_FAILED}`, Constants.messageTypes.ERROR, 'zip_upload_failed', null, rawArgs);
314+
utils.sendUsageReport(bsConfig, args, `${err}\n${Constants.userMessages.ZIP_UPLOAD_FAILED}`, Constants.messageTypes.ERROR, 'zip_upload_failed', buildReportData, rawArgs);
316315
try {
317316
fileHelpers.deletePackageArchieve();
318317
} catch (err) {
319-
utils.sendUsageReport(bsConfig, args, Constants.userMessages.NPM_DELETE_FAILED, Constants.messageTypes.ERROR, 'npm_deletion_failed', null, rawArgs);
318+
utils.sendUsageReport(bsConfig, args, Constants.userMessages.NPM_DELETE_FAILED, Constants.messageTypes.ERROR, 'npm_deletion_failed', buildReportData, rawArgs);
320319
}
321320
}
322321
process.exitCode = Constants.ERROR_EXIT_CODE;
@@ -325,36 +324,36 @@ module.exports = function run(args, rawArgs) {
325324
// Zipping failed
326325
logger.error(err);
327326
logger.error(Constants.userMessages.FAILED_TO_ZIP);
328-
utils.sendUsageReport(bsConfig, args, `${err}\n${Constants.userMessages.FAILED_TO_ZIP}`, Constants.messageTypes.ERROR, 'zip_creation_failed', null, rawArgs);
327+
utils.sendUsageReport(bsConfig, args, `${err}\n${Constants.userMessages.FAILED_TO_ZIP}`, Constants.messageTypes.ERROR, 'zip_creation_failed', buildReportData, rawArgs);
329328
try {
330329
fileHelpers.deleteZip();
331330
} catch (err) {
332-
utils.sendUsageReport(bsConfig, args, Constants.userMessages.ZIP_DELETE_FAILED, Constants.messageTypes.ERROR, 'zip_deletion_failed', null, rawArgs);
331+
utils.sendUsageReport(bsConfig, args, Constants.userMessages.ZIP_DELETE_FAILED, Constants.messageTypes.ERROR, 'zip_deletion_failed', buildReportData, rawArgs);
333332
}
334333
try {
335334
fileHelpers.deletePackageArchieve();
336335
} catch (err) {
337-
utils.sendUsageReport(bsConfig, args, Constants.userMessages.NPM_DELETE_FAILED, Constants.messageTypes.ERROR, 'npm_deletion_failed', null, rawArgs);
336+
utils.sendUsageReport(bsConfig, args, Constants.userMessages.NPM_DELETE_FAILED, Constants.messageTypes.ERROR, 'npm_deletion_failed', buildReportData, rawArgs);
338337
}
339338
process.exitCode = Constants.ERROR_EXIT_CODE;
340339
});
341340
}).catch(function (err) {
342341
// package installer failed
343342
logger.error(err);
344343
logger.error(Constants.userMessages.FAILED_CREATE_NPM_ARCHIVE);
345-
utils.sendUsageReport(bsConfig, args, Constants.userMessages.FAILED_CREATE_NPM_ARCHIVE, Constants.messageTypes.ERROR, 'npm_package_archive_failed', null, rawArgs);
344+
utils.sendUsageReport(bsConfig, args, Constants.userMessages.FAILED_CREATE_NPM_ARCHIVE, Constants.messageTypes.ERROR, 'npm_package_archive_failed', buildReportData, rawArgs);
346345
try {
347346
fileHelpers.deletePackageArchieve();
348347
} catch (err) {
349-
utils.sendUsageReport(bsConfig, args, Constants.userMessages.NPM_DELETE_FAILED, Constants.messageTypes.ERROR, 'npm_deletion_failed', null, rawArgs);
348+
utils.sendUsageReport(bsConfig, args, Constants.userMessages.NPM_DELETE_FAILED, Constants.messageTypes.ERROR, 'npm_deletion_failed', buildReportData, rawArgs);
350349
}
351350
process.exitCode = Constants.ERROR_EXIT_CODE;
352351
});
353352
}).catch(function (err) {
354353
// md5 check failed
355354
logger.error(err);
356355
logger.error(Constants.userMessages.FAILED_MD5_CHECK);
357-
utils.sendUsageReport(bsConfig, args, Constants.userMessages.MD5_CHECK_FAILED, Constants.messageTypes.ERROR, 'zip_already_uploaded_failed', null, rawArgs);
356+
utils.sendUsageReport(bsConfig, args, Constants.userMessages.MD5_CHECK_FAILED, Constants.messageTypes.ERROR, 'zip_already_uploaded_failed', buildReportData, rawArgs);
358357
process.exitCode = Constants.ERROR_EXIT_CODE;
359358
});
360359
}).catch(function (err) {
@@ -368,7 +367,7 @@ module.exports = function run(args, rawArgs) {
368367
}
369368

370369
let error_code = utils.getErrorCodeFromMsg(err);
371-
utils.sendUsageReport(bsConfig, args, `${err}\n${Constants.validationMessages.NOT_VALID}`, Constants.messageTypes.ERROR, error_code, null, rawArgs);
370+
utils.sendUsageReport(bsConfig, args, `${err}\n${Constants.validationMessages.NOT_VALID}`, Constants.messageTypes.ERROR, error_code, buildReportData, rawArgs);
372371
process.exitCode = Constants.ERROR_EXIT_CODE;
373372
});
374373
}).catch(function (err) {

0 commit comments

Comments
 (0)