Skip to content
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

Jump to bottom

O11y - Handle edge cases for detecting package version #660

Merged
merged 5 commits into from
Aug 10, 2023
Merged

O11y - Handle edge cases for detecting package version #660

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3652c3e
handle edge cases for cypress package version
amaanbs Jul 30, 2023
1526747
minor fix
amaanbs Jul 31, 2023
c67eea1
minor fix pt.2
amaanbs Jul 31, 2023
00c81db
minor fix
amaanbs Aug 4, 2023
0694b16
Merge branch 'master' of github.com:browserstack/browserstack-cypress…
amaanbs Aug 10, 2023
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
41 changes: 38 additions & 3 deletions bin/testObservability/crashReporter/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ const http = require('http');
const https = require('https');

const logger = require("../../helpers/logger").winstonLogger;
const utils = require('../../helpers/utils');

const { API_URL, consoleHolder } = require('../helper/constants');

Expand Down Expand Up @@ -47,9 +48,43 @@ exports.requireModule = (module, internal = false) => {
return require(local_path);
}

getPackageVersion = (package_) => {
getPackageVersion = (package_, bsConfig = null) => {
if(packages[package_]) return packages[package_];
return packages[package_] = this.requireModule(`${package_}/package.json`).version;
let packageVersion;
/* Try to find version from module path */
try {
packages[package_] = this.requireModule(`${package_}/package.json`).version;
logger.info(`Getting ${package_} package version from module path = ${packages[package_]}`);
packageVersion = packages[package_];
} catch(e) {
debug(`Unable to find package ${package_} at module path with error ${e}`);
}

/* Read package version from npm_dependencies in browserstack.json file if present */
if(utils.isUndefined(packageVersion) && bsConfig && (process.env.BROWSERSTACK_AUTOMATION == "true" || process.env.BROWSERSTACK_AUTOMATION == "1")) {
const runSettings = bsConfig.run_settings;
if (runSettings && runSettings.npm_dependencies !== undefined &&
Object.keys(runSettings.npm_dependencies).length !== 0 &&
typeof runSettings.npm_dependencies === 'object') {
if (package_ in runSettings.npm_dependencies) {
packages[package_] = runSettings.npm_dependencies[package_];
logger.info(`Getting ${package_} package version from browserstack.json = ${packages[package_]}`);
packageVersion = packages[package_];
}
}
}

/* Read package version from project's package.json if present */
const packageJSONPath = path.join(process.cwd(), 'package.json');
if(utils.isUndefined(packageVersion) && fs.existsSync(packageJSONPath)) {
const packageJSONContents = require(packageJSONPath);
if(packageJSONContents.devDependencies && !utils.isUndefined(packageJSONContents.devDependencies[package_])) packages[package_] = packageJSONContents.devDependencies[package_];
if(packageJSONContents.dependencies && !utils.isUndefined(packageJSONContents.dependencies[package_])) packages[package_] = packageJSONContents.dependencies[package_];
logger.info(`Getting ${package_} package version from package.json = ${packages[package_]}`);
packageVersion = packages[package_];
}

return packageVersion;
}

getAgentVersion = () => {
Expand Down Expand Up @@ -96,7 +131,7 @@ class CrashReporter {
hashed_id: process.env.BS_TESTOPS_BUILD_HASHED_ID,
observability_version: {
frameworkName: 'Cypress',
frameworkVersion: getPackageVersion('cypress'),
frameworkVersion: getPackageVersion('cypress', this.userConfigForReporting.browserstackConfigFile),
sdkVersion: getAgentVersion()
},
exception: {
Expand Down
51 changes: 45 additions & 6 deletions bin/testObservability/helper/helper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,9 +351,43 @@ const getCiInfo = () => {

let packages = {};

exports.getPackageVersion = (package_) => {
exports.getPackageVersion = (package_, bsConfig = null) => {
if(packages[package_]) return packages[package_];
return packages[package_] = this.requireModule(`${package_}/package.json`).version;
let packageVersion;
/* Try to find version from module path */
try {
packages[package_] = this.requireModule(`${package_}/package.json`).version;
logger.info(`Getting ${package_} package version from module path = ${packages[package_]}`);
packageVersion = packages[package_];
} catch(e) {
exports.debug(`Unable to find package ${package_} at module path with error ${e}`);
amaanbs marked this conversation as resolved.
Show resolved Hide resolved
}

/* Read package version from npm_dependencies in browserstack.json file if present */
if(utils.isUndefined(packageVersion) && bsConfig && (process.env.BROWSERSTACK_AUTOMATION == "true" || process.env.BROWSERSTACK_AUTOMATION == "1")) {
const runSettings = bsConfig.run_settings;
if (runSettings && runSettings.npm_dependencies !== undefined &&
Object.keys(runSettings.npm_dependencies).length !== 0 &&
typeof runSettings.npm_dependencies === 'object') {
if (package_ in runSettings.npm_dependencies) {
packages[package_] = runSettings.npm_dependencies[package_];
logger.info(`Getting ${package_} package version from browserstack.json = ${packages[package_]}`);
packageVersion = packages[package_];
}
}
}

/* Read package version from project's package.json if present */
const packageJSONPath = path.join(process.cwd(), 'package.json');
if(utils.isUndefined(packageVersion) && fs.existsSync(packageJSONPath)) {
const packageJSONContents = require(packageJSONPath);
if(packageJSONContents.devDependencies && !utils.isUndefined(packageJSONContents.devDependencies[package_])) packages[package_] = packageJSONContents.devDependencies[package_];
if(packageJSONContents.dependencies && !utils.isUndefined(packageJSONContents.dependencies[package_])) packages[package_] = packageJSONContents.dependencies[package_];
logger.info(`Getting ${package_} package version from package.json = ${packages[package_]}`);
packageVersion = packages[package_];
}

return packageVersion;
}

exports.getAgentVersion = () => {
Expand Down Expand Up @@ -452,9 +486,14 @@ const setBrowserstackCypressCliDependency = (bsConfig) => {
}

const getCypressConfigFileContent = (bsConfig, cypressConfigPath) => {
const cypressConfigFile = require(path.resolve(bsConfig ? bsConfig.run_settings.cypress_config_file : cypressConfigPath));
if(bsConfig) process.env.OBS_CRASH_REPORTING_CYPRESS_CONFIG_PATH = bsConfig.run_settings.cypress_config_file;
return cypressConfigFile;
try {
const cypressConfigFile = require(path.resolve(bsConfig ? bsConfig.run_settings.cypress_config_file : cypressConfigPath));
if(bsConfig) process.env.OBS_CRASH_REPORTING_CYPRESS_CONFIG_PATH = bsConfig.run_settings.cypress_config_file;
return cypressConfigFile;
} catch(e) {
exports.debug(`Encountered an error when trying to import Cypress Config File ${e}`);
amaanbs marked this conversation as resolved.
Show resolved Hide resolved
return {};
}
}

exports.setCrashReportingConfigFromReporter = (credentialsStr, bsConfigPath, cypressConfigPath) => {
Expand Down Expand Up @@ -530,7 +569,7 @@ exports.launchTestSession = async (user_config, bsConfigPath) => {
'version_control': await getGitMetaData(),
'observability_version': {
frameworkName: "Cypress",
frameworkVersion: exports.getPackageVersion('cypress'),
frameworkVersion: exports.getPackageVersion('cypress', user_config),
sdkVersion: exports.getAgentVersion()
}
};
Expand Down