-
Notifications
You must be signed in to change notification settings - Fork 24.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Download artifacts from CI to speed up testing (#37971)
Summary: Testing releases takes a lot of time because we have to build locally several configurations. However, the artifacts that we build locally are also built in CI. The goal of this PR is to implement a mechanism to download those artifacts from the CI instead of build locally, so that testing the release locally can take much less time. As an example, the full test cycle can take more than 2 hours given that we need to repackage and rebuilt the app from the template. My plan is to add a table with the time saved once the PR is done - [x] Download Hermes tarball for RNTester iOS - [x] Download Hermes APK for RNTester Android - [x] Download JSC APK for RNTester Android - [x] Download Packaged version of React Native to create a new app - [x] Use the downloaded React Native to initialize an app from the template - [x] Download Maven Local prebuilt in CI and use it for Template Android app | Setup | Before [s] | After [s] | Notes | | --- | --- | --- | --- | | iOS RNTester Hermes | 339.68 | 194.86 | Time saved by downloading Hermes rather then building it | | iOS RNTester JSC | 129.80 | 123.35 | Not significant, expected as this workflow did not change | Android RNTester Hermes | 1188.82 | 5.28 | Huge improvement: we download the APK rather then build | | Android RNTester JSC | 103.10 | 6.28 | Huge improvement: we download the APK rather then build | | Creating the RNTestProject | 2074.82 | 191.16 | We download Maven, the packaged version of RN and Hermes instead of building from scratch | [Internal] - Speed up Release testing by downloading the CircleCI artifacts Pull Request resolved: #37971 Test Plan: - Tested the script locally Reviewed By: cortinico, dmytrorykun Differential Revision: D46859120 Pulled By: cipolleschi fbshipit-source-id: 8878ebaccf6edb801f8e9884e2bf3946380aa748
- Loading branch information
1 parent
ff37ddb
commit f73b646
Showing
7 changed files
with
651 additions
and
139 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,198 @@ | ||
#!/usr/bin/env node | ||
/** | ||
* Copyright (c) Meta Platforms, Inc. and affiliates. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
* | ||
* @format | ||
*/ | ||
|
||
'use strict'; | ||
|
||
const {exec} = require('shelljs'); | ||
|
||
const util = require('util'); | ||
const asyncRequest = require('request'); | ||
const request = util.promisify(asyncRequest); | ||
|
||
let circleCIHeaders; | ||
let jobs; | ||
let baseTemporaryPath; | ||
|
||
async function initialize(circleCIToken, baseTempPath, branchName) { | ||
console.info('Getting CircleCI information'); | ||
circleCIHeaders = {'Circle-Token': circleCIToken}; | ||
baseTemporaryPath = baseTempPath; | ||
exec(`mkdir -p ${baseTemporaryPath}`); | ||
const pipeline = await _getLastCircleCIPipelineID(branchName); | ||
const packageAndReleaseWorkflow = await _getPackageAndReleaseWorkflow( | ||
pipeline.id, | ||
); | ||
const testsWorkflow = await _getTestsWorkflow(pipeline.id); | ||
const jobsPromises = [ | ||
_getCircleCIJobs(packageAndReleaseWorkflow.id), | ||
_getCircleCIJobs(testsWorkflow.id), | ||
]; | ||
|
||
const jobsResults = await Promise.all(jobsPromises); | ||
|
||
jobs = jobsResults.flatMap(j => j); | ||
} | ||
|
||
function baseTmpPath() { | ||
return baseTemporaryPath; | ||
} | ||
|
||
async function _getLastCircleCIPipelineID(branchName) { | ||
const options = { | ||
method: 'GET', | ||
url: 'https://circleci.com/api/v2/project/gh/facebook/react-native/pipeline', | ||
qs: { | ||
branch: branchName, | ||
}, | ||
headers: circleCIHeaders, | ||
}; | ||
|
||
const response = await request(options); | ||
if (response.error) { | ||
throw new Error(error); | ||
} | ||
|
||
const items = JSON.parse(response.body).items; | ||
|
||
if (!items || items.length === 0) { | ||
throw new Error( | ||
'No pipelines found on this branch. Make sure that the CI has run at least once, successfully', | ||
); | ||
} | ||
|
||
const lastPipeline = items[0]; | ||
return {id: lastPipeline.id, number: lastPipeline.number}; | ||
} | ||
|
||
async function _getSpecificWorkflow(pipelineId, workflowName) { | ||
const options = { | ||
method: 'GET', | ||
url: `https://circleci.com/api/v2/pipeline/${pipelineId}/workflow`, | ||
headers: circleCIHeaders, | ||
}; | ||
const response = await request(options); | ||
if (response.error) { | ||
throw new Error(error); | ||
} | ||
|
||
const body = JSON.parse(response.body); | ||
let workflow = body.items.find(w => w.name === workflowName); | ||
_throwIfWorkflowNotFound(workflow, workflowName); | ||
return workflow; | ||
} | ||
|
||
function _throwIfWorkflowNotFound(workflow, name) { | ||
if (!workflow) { | ||
throw new Error( | ||
`Can't find a workflow named ${name}. Please check whether that workflow has started.`, | ||
); | ||
} | ||
} | ||
|
||
async function _getPackageAndReleaseWorkflow(pipelineId) { | ||
return _getSpecificWorkflow(pipelineId, 'package_and_publish_release_dryrun'); | ||
} | ||
|
||
async function _getTestsWorkflow(pipelineId) { | ||
return _getSpecificWorkflow(pipelineId, 'tests'); | ||
} | ||
|
||
async function _getCircleCIJobs(workflowId) { | ||
const options = { | ||
method: 'GET', | ||
url: `https://circleci.com/api/v2/workflow/${workflowId}/job`, | ||
headers: circleCIHeaders, | ||
}; | ||
const response = await request(options); | ||
if (response.error) { | ||
throw new Error(error); | ||
} | ||
|
||
const body = JSON.parse(response.body); | ||
return body.items; | ||
} | ||
|
||
async function _getJobsArtifacts(jobNumber) { | ||
const options = { | ||
method: 'GET', | ||
url: `https://circleci.com/api/v2/project/gh/facebook/react-native/${jobNumber}/artifacts`, | ||
headers: circleCIHeaders, | ||
}; | ||
const response = await request(options); | ||
if (response.error) { | ||
throw new Error(error); | ||
} | ||
|
||
const body = JSON.parse(response.body); | ||
return body.items; | ||
} | ||
|
||
async function _findUrlForJob(jobName, artifactPath) { | ||
const job = jobs.find(j => j.name === jobName); | ||
_throwIfJobIsNull(job); | ||
_throwIfJobIsUnsuccessful(job); | ||
|
||
const artifacts = await _getJobsArtifacts(job.job_number); | ||
return artifacts.find(artifact => artifact.path.indexOf(artifactPath) > -1) | ||
.url; | ||
} | ||
|
||
function _throwIfJobIsNull(job) { | ||
if (!job) { | ||
throw new Error( | ||
`Can't find a job with name ${job.name}. Please verify that it has been executed and that all its dependencies completed successfully.`, | ||
); | ||
} | ||
} | ||
|
||
function _throwIfJobIsUnsuccessful(job) { | ||
if (job.status !== 'success') { | ||
throw new Error( | ||
`The job ${job.name} status is ${job.status}. We need a 'success' status to proceed with the testing.`, | ||
); | ||
} | ||
} | ||
|
||
async function artifactURLHermesDebug() { | ||
return _findUrlForJob('build_hermes_macos-Debug', 'hermes-ios-debug.tar.gz'); | ||
} | ||
|
||
async function artifactURLForMavenLocal() { | ||
return _findUrlForJob('build_and_publish_npm_package-2', 'maven-local.zip'); | ||
} | ||
|
||
async function artifactURLForHermesRNTesterAPK(emulatorArch) { | ||
return _findUrlForJob( | ||
'test_android', | ||
`rntester-apk/hermes/debug/app-hermes-${emulatorArch}-debug.apk`, | ||
); | ||
} | ||
|
||
async function artifactURLForJSCRNTesterAPK(emulatorArch) { | ||
return _findUrlForJob( | ||
'test_android', | ||
`rntester-apk/jsc/debug/app-jsc-${emulatorArch}-debug.apk`, | ||
); | ||
} | ||
|
||
function downloadArtifact(artifactURL, destination) { | ||
exec(`rm -rf ${destination}`); | ||
exec(`curl ${artifactURL} -Lo ${destination}`); | ||
} | ||
|
||
module.exports = { | ||
initialize, | ||
downloadArtifact, | ||
artifactURLForJSCRNTesterAPK, | ||
artifactURLForHermesRNTesterAPK, | ||
artifactURLForMavenLocal, | ||
artifactURLHermesDebug, | ||
baseTmpPath, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
/** | ||
* Copyright (c) Meta Platforms, Inc. and affiliates. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
* | ||
* @format | ||
*/ | ||
|
||
'use strict'; | ||
|
||
/** | ||
* `package` is an object form of package.json | ||
* `dependencies` is a map of dependency to version string | ||
* | ||
* This replaces both dependencies and devDependencies in package.json | ||
*/ | ||
function applyPackageVersions(originalPackageJson, packageVersions) { | ||
const packageJson = {...originalPackageJson}; | ||
|
||
for (const name of Object.keys(packageVersions)) { | ||
if ( | ||
packageJson.dependencies != null && | ||
packageJson.dependencies[name] != null | ||
) { | ||
packageJson.dependencies[name] = packageVersions[name]; | ||
} | ||
|
||
if ( | ||
packageJson.devDependencies != null && | ||
packageJson.devDependencies[name] != null | ||
) { | ||
packageJson.devDependencies[name] = packageVersions[name]; | ||
} | ||
} | ||
return packageJson; | ||
} | ||
|
||
module.exports = { | ||
applyPackageVersions | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.