-
Notifications
You must be signed in to change notification settings - Fork 39
/
Copy pathpackageInstaller.js
202 lines (186 loc) · 8.83 KB
/
packageInstaller.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
'use strict';
const archiver = require("archiver"),
path = require('path'),
fs = require('fs-extra'),
fileHelpers = require('./fileHelpers'),
logger = require("./logger").winstonLogger,
Constants = require('./constants'),
utils = require('./utils'),
{ get_version } = require('./usageReporting'),
process = require('process'),
{ spawn, execSync } = require('child_process'),
util = require('util');
let nodeProcess;
const setupPackageFolder = (runSettings, directoryPath) => {
return new Promise(function (resolve, reject) {
fileHelpers.deletePackageArchieve(false);
logger.debug(`Started creating ${directoryPath} folder`);
fs.mkdir(directoryPath, function (err) {
try {
if (err) {
return reject(err);
}
logger.debug(`Completed creating ${directoryPath}`);
let packageJSON = {};
if (typeof runSettings.package_config_options === 'object') {
Object.assign(packageJSON, runSettings.package_config_options);
}
if (typeof runSettings.npm_dependencies === 'object') {
Object.assign(packageJSON, {
devDependencies: runSettings.npm_dependencies,
});
}
if (Object.keys(packageJSON).length > 0) {
let packageJSONString = JSON.stringify(packageJSON);
let packagePath = path.join(directoryPath, "package.json");
fs.writeFileSync(packagePath, packageJSONString);
let cypressFolderPath = path.dirname(runSettings.cypressConfigFilePath);
let sourceNpmrc = path.join(cypressFolderPath, ".npmrc");
let destNpmrc = path.join(directoryPath, ".npmrc");
if (fs.existsSync(sourceNpmrc)) {
logger.debug(`Copying .npmrc file from ${sourceNpmrc} to ${destNpmrc}`);
fs.copyFileSync(sourceNpmrc, destNpmrc);
}
logger.debug(`${packagePath} file created with ${packageJSONString}`);
return resolve("Package file created");
}
logger.debug("Nothing in package file");
return reject("Nothing in package file");
} catch(error) {
logger.debug(`Creating ${directoryPath} failed with error ${error}`);
return reject(error);
}
})
})
};
const packageInstall = (packageDir) => {
return new Promise(function (resolve, reject) {
const nodeProcessCloseCallback = (code) => {
if(code == 0) {
logger.info(`Packages were installed locally successfully.`);
resolve('Packages were installed successfully.');
} else {
logger.error(`Some error occurred while installing packages. Error code ${code}. Please read npm_install_debug.log for more info.`);
reject(`Packages were not installed successfully. Error code ${code}`);
}
};
const nodeProcessErrorCallback = (error) => {
logger.error(`Some error occurred while installing packages: %j`, error);
reject(`Packages were not installed successfully. Error Description ${util.format('%j', error)}`);
};
let nodeProcess;
logger.debug(`Fetching npm version and its major version`);
const npm_version = get_version('npm')
const npm_major_version = utils.getMajorVersion(npm_version);
logger.debug(`Fetched npm version: ${npm_version} and its major version: ${npm_major_version}`);
try {
logger.info(`Running npm pack command : ${path.resolve(__dirname, '..', '..', '..', 'browserstack-cypress-cli')}`);
execSync(`${/^win/.test(process.platform) ? 'npm.cmd' : 'npm'} pack`, {cwd: path.resolve(__dirname, '..', '..', '..', 'browserstack-cypress-cli')}, function(err, stdout, stderr) {});
} catch(e) {
logger.info(`Error running npm pack command`);
}
// add --legacy-peer-deps flag while installing dependencies for npm v7+
// For more info please read "Peer Dependencies" section here -> https://github.blog/2021-02-02-npm-7-is-now-generally-available/
if (parseInt(npm_major_version) >= 7) {
logger.debug(`Running NPM install command: npm install --legacy-peer-deps --loglevel verbose > ../npm_install_debug.log`);
nodeProcess = spawn(/^win/.test(process.platform) ? 'npm.cmd' : 'npm', ['install', '--legacy-peer-deps', '--loglevel', 'verbose', '>', '../npm_install_debug.log', '2>&1'], {cwd: packageDir, shell: true});
} else {
logger.debug(`Running NPM install command: 'npm install --loglevel verbose > ../npm_install_debug.log'`);
nodeProcess = spawn(/^win/.test(process.platform) ? 'npm.cmd' : 'npm', ['install', '--loglevel', 'verbose', '>', '../npm_install_debug.log', '2>&1'], {cwd: packageDir, shell: true});
}
nodeProcess.on('close', nodeProcessCloseCallback);
nodeProcess.on('error', nodeProcessErrorCallback);
});
};
const packageArchiver = (packageDir, packageFile) => {
return new Promise(function (resolve, reject) {
let output = fs.createWriteStream(packageFile);
let archive = archiver('tar', {
gzip: true
});
archive.on('warning', function (err) {
if (err.code === 'ENOENT') {
logger.info(err);
} else {
logger.debug(`Archiving of node_modules failed with error ${err}`);
reject(err);
}
});
output.on('close', function () {
resolve('Zipping completed');
});
output.on('end', function () {
logger.info('Data has been drained');
});
archive.on('error', function (err) {
logger.debug(`Archiving of node_modules failed with error ${err}`);
reject(err);
});
archive.pipe(output);
archive.directory(packageDir, false);
archive.finalize();
})
}
const packageSetupAndInstaller = (bsConfig, packageDir, instrumentBlocks) => {
return new Promise(function (resolve) {
let obj = {
packagesInstalled: false
};
if (bsConfig && bsConfig.run_settings && bsConfig.run_settings.enforce_settings && bsConfig.run_settings.enforce_settings.toString() === 'true' ) {
logger.info("Enforce_settings is enabled in run_settings");
logger.debug(Constants.userMessages.SKIP_NPM_INSTALL);
return resolve(obj);
}
logger.info(Constants.userMessages.NPM_INSTALL);
instrumentBlocks.markBlockStart("packageInstaller.folderSetup");
logger.debug("Started setting up package folder");
return setupPackageFolder(bsConfig.run_settings, packageDir).then((_result) => {
logger.debug("Completed setting up package folder");
process.env.CYPRESS_INSTALL_BINARY = 0
instrumentBlocks.markBlockEnd("packageInstaller.folderSetup");
instrumentBlocks.markBlockStart("packageInstaller.packageInstall");
logger.debug("Started installing dependencies specified in browserstack.json");
return packageInstall(packageDir);
}).then((_result) => {
logger.debug("Completed installing dependencies");
instrumentBlocks.markBlockEnd("packageInstaller.packageInstall");
Object.assign(obj, { packagesInstalled: true });
return resolve(obj);
}).catch((err) => {
logger.warn(`Error occured while installing npm dependencies. Dependencies will be installed in runtime. This will have a negative impact on performance. Reach out to browserstack.com/contact, if you persistantly face this issue.`);
obj.error = err.stack ? err.stack.toString().substring(0,100) : err.toString().substring(0,100);
return resolve(obj);
})
})
}
const packageWrapper = (bsConfig, packageDir, packageFile, md5data, instrumentBlocks, packagesInstalled) => {
return new Promise(function (resolve) {
let obj = {
packageArchieveCreated: false
};
if (!packagesInstalled) {
logger.debug("Skipping the caching of npm packages since package installed failed")
return resolve(obj);
}
if (md5data.packageUrlPresent || !utils.isTrueString(bsConfig.run_settings.cache_dependencies)) {
logger.debug("Skipping the caching of npm packages since BrowserStack has already cached your npm dependencies that have not changed since the last run.")
return resolve(obj);
}
logger.info(Constants.userMessages.NPM_UPLOAD);
instrumentBlocks.markBlockStart("packageInstaller.packageArchive");
logger.debug("Started archiving node_modules")
return packageArchiver(packageDir, packageFile)
.then((_result) => {
logger.debug("Archiving of node_modules completed");
instrumentBlocks.markBlockEnd("packageInstaller.packageArchive");
Object.assign(obj, { packageArchieveCreated: true });
return resolve(obj);
}).catch((err) => {
logger.warn(`Error occured while caching npm dependencies. Dependencies will be installed in runtime. This will have a negative impact on performance. Reach out to browserstack.com/contact, if you persistantly face this issue.`);
obj.error = err.stack ? err.stack.toString().substring(0,100) : err.toString().substring(0,100);
return resolve(obj);
})
})
}
exports.packageWrapper = packageWrapper;
exports.packageSetupAndInstaller = packageSetupAndInstaller;