Compare commits

...
7 changed files with 139 additions and 48 deletions

No files matched your search

@@ -5,6 +5,7 @@ import {
Job,
Metadata,
Platform,
Workflow,
} from '@expo/eas-build-job';
import { randomUUID } from 'crypto';
import fs from 'fs-extra';
@@ -171,6 +172,59 @@ describe('BuildContext', () => {
expect(ctx.env.NEW_ENV).toBe('new-env-value');
});
it('updates environment variables from resolved job information', async () => {
await vol.promises.mkdir('/workingdir/eas-environment-secrets/', { recursive: true });
const ctx = new BuildContext(
{
triggeredBy: BuildTrigger.GIT_BASED_INTEGRATION,
secrets: {},
} as Job,
{
env: {
__API_SERVER_URL: 'http://api.expo.test',
PATH: '/usr/bin',
EAS_BUILD_PROFILE: 'old-profile',
EAS_BUILD_ANDROID_VERSION_CODE: '1',
},
workingdir: '/workingdir',
logger: createMockLogger(),
logBuffer: { getLogs: () => [], getPhaseLogs: () => [] },
uploadArtifact: jest.fn(),
}
);
const originalPath = ctx.env.PATH;
ctx.updateJobInformation(
{
platform: Platform.ANDROID,
type: Workflow.MANAGED,
username: 'job-username',
version: {
versionCode: '42',
versionName: '1.2.3',
},
} as Job,
{
buildProfile: 'production',
gitCommitHash: 'abc123',
} as Metadata
);
expect(ctx.env).toEqual(
expect.objectContaining({
__API_SERVER_URL: 'http://api.expo.test',
PATH: originalPath,
EAS_BUILD_PROFILE: 'production',
EAS_BUILD_GIT_COMMIT_HASH: 'abc123',
EAS_BUILD_USERNAME: 'job-username',
EAS_BUILD_ANDROID_VERSION_CODE: '42',
EAS_BUILD_ANDROID_VERSION_NAME: '1.2.3',
})
);
});
it('emits build phase duration metrics for successful build phases', async () => {
const ctx = createTestBuildContext({ platform: Platform.IOS });
@@ -53,6 +53,50 @@ describe(CustomBuildContext, () => {
});
});
it('updates environment variables from resolved job information', () => {
const ctx = new BuildContext(
createTestIosJob({
triggeredBy: BuildTrigger.GIT_BASED_INTEGRATION,
}),
{
env: {
__API_SERVER_URL: 'http://api.expo.test',
EAS_BUILD_IOS_BUILD_NUMBER: '1',
},
logBuffer: { getLogs: () => [], getPhaseLogs: () => [] },
logger: createMockLogger(),
uploadArtifact: jest.fn(),
workingdir: '',
}
);
const customContext = new CustomBuildContext(ctx);
customContext.updateJobInformation(
{
version: {
buildNumber: '123',
appVersion: '1.2.3',
},
} as Ios.Job,
{
buildProfile: 'preview',
gitCommitHash: 'abc123',
username: 'metadata-username',
} as Metadata
);
expect(customContext.env).toEqual(
expect.objectContaining({
__API_SERVER_URL: 'http://api.expo.test',
EAS_BUILD_PROFILE: 'preview',
EAS_BUILD_GIT_COMMIT_HASH: 'abc123',
EAS_BUILD_USERNAME: 'metadata-username',
EAS_BUILD_IOS_BUILD_NUMBER: '123',
EAS_BUILD_IOS_APP_VERSION: '1.2.3',
})
);
});
describe('reportStepMetric', () => {
const expoApiV2BaseUrl = 'http://exp.test/--/api/v2/';
const workflowJobId = 'test-workflow-job-id';
+1 -23
View File
@@ -1,4 +1,4 @@
import { Android, Env, Job, Platform } from '@expo/eas-build-job';
import { Android, Env, Job } from '@expo/eas-build-job';
import { bunyan } from '@expo/logger';
import spawn from '@expo/turtle-spawn';
import fs from 'fs-extra';
@@ -55,7 +55,6 @@ export async function runGradleCommand(
env: {
...ctx.env,
...extraEnv,
...resolveVersionOverridesEnvs(ctx),
LC_ALL: 'C.UTF-8',
},
}
@@ -76,27 +75,6 @@ export function getGradleShellCommand({
return `${oomScoreAdjPrefix}exec ./gradlew ${gradleCommand} --profile ${verboseFlag}`;
}
// Version envs should be set at the beginning of the build, but when building
// from github those values are resolved later.
function resolveVersionOverridesEnvs(ctx: BuildContext<Job>): Env {
const extraEnvs: Env = {};
if (
ctx.job.platform === Platform.ANDROID &&
ctx.job.version?.versionCode &&
!ctx.env.EAS_BUILD_ANDROID_VERSION_CODE
) {
extraEnvs.EAS_BUILD_ANDROID_VERSION_CODE = ctx.job.version.versionCode;
}
if (
ctx.job.platform === Platform.ANDROID &&
ctx.job.version?.versionName &&
!ctx.env.EAS_BUILD_ANDROID_VERSION_NAME
) {
extraEnvs.EAS_BUILD_ANDROID_VERSION_NAME = ctx.job.version.versionName;
}
return extraEnvs;
}
export function resolveGradleCommand(job: Android.Job): string {
if (job.gradleCommand) {
return job.gradleCommand;
+30
View File
@@ -8,6 +8,8 @@ import {
LogMarker,
ManagedArtifactType,
Metadata,
Platform,
Workflow,
errors,
} from '@expo/eas-build-job';
import { BuildTrigger } from '@expo/eas-build-job/dist/common';
@@ -72,6 +74,33 @@ export interface BuildContextOptions {
export class SkipNativeBuildError extends Error {}
export function getResolvedJobInformationEnv(job: Job, metadata: Metadata): Env {
let username = metadata.username;
if (!username && 'type' in job && job.type === Workflow.MANAGED) {
username = job.username;
}
const env: Env = {
EAS_BUILD_PROFILE: metadata.buildProfile,
EAS_BUILD_GIT_COMMIT_HASH: metadata.gitCommitHash,
EAS_BUILD_USERNAME: username,
EAS_BUILD_ANDROID_VERSION_CODE: undefined,
EAS_BUILD_ANDROID_VERSION_NAME: undefined,
EAS_BUILD_IOS_BUILD_NUMBER: undefined,
EAS_BUILD_IOS_APP_VERSION: undefined,
};
if (job.platform === Platform.ANDROID) {
env.EAS_BUILD_ANDROID_VERSION_CODE = job.version?.versionCode;
env.EAS_BUILD_ANDROID_VERSION_NAME = job.version?.versionName;
} else if (job.platform === Platform.IOS) {
env.EAS_BUILD_IOS_BUILD_NUMBER = job.version?.buildNumber;
env.EAS_BUILD_IOS_APP_VERSION = job.version?.appVersion;
}
return env;
}
export class BuildContext<TJob extends Job = Job> {
public readonly workingdir: string;
public logger: bunyan;
@@ -287,6 +316,7 @@ export class BuildContext<TJob extends Job = Job> {
...(this._job.platform ? { expoBuildUrl: this._job.expoBuildUrl } : null),
};
this._metadata = metadata;
this._env = { ...this._env, ...getResolvedJobInformationEnv(this._job, metadata) };
}
private async handleBuildPhaseErrorAsync(
@@ -19,7 +19,7 @@ import { Client } from '@urql/core';
import assert from 'assert';
import path from 'path';
import { ArtifactToUpload, BuildContext } from './context';
import { ArtifactToUpload, BuildContext, getResolvedJobInformationEnv } from './context';
import { reportWorkflowHookMetricToDatadog } from './utils/hookMetrics';
import { uploadStepMetricsToWwwAsync } from './utils/stepMetrics';
@@ -155,6 +155,10 @@ export class CustomBuildContext<TJob extends Job = Job> implements ExternalBuild
...(this.job.platform ? { expoBuildUrl: this.job.expoBuildUrl } : null),
};
this.metadata = metadata;
this.updateEnv({
...this._env,
...getResolvedJobInformationEnv(this.job, this.metadata),
});
}
public reportStepMetric(metric: StepMetric): void {
+1
View File
@@ -22,6 +22,7 @@ export {
BuildContext,
BuildContextOptions,
CacheManager,
getResolvedJobInformationEnv,
LogBuffer,
SkipNativeBuildError,
} from './context';
+4 -24
View File
@@ -1,5 +1,5 @@
import { RuntimeSettings } from '@expo/build-tools';
import { Env, Job, Metadata, Platform, Workflow } from '@expo/eas-build-job';
import { RuntimeSettings, getResolvedJobInformationEnv } from '@expo/build-tools';
import { Env, Job, Metadata, Platform } from '@expo/eas-build-job';
import { spawnSync } from 'child_process';
import micromatch from 'micromatch';
import os from 'os';
@@ -46,8 +46,6 @@ export function getBuildEnv({
setEnv(env, 'NVM_NODEJS_ORG_MIRROR', nodeJsCacheUrl);
setEnv(env, 'EAS_BUILD_NPM_CACHE_URL', npmCacheUrl);
setEnv(env, 'EAS_BUILD_PROFILE', metadata.buildProfile);
setEnv(env, 'EAS_BUILD_GIT_COMMIT_HASH', metadata.gitCommitHash);
setEnv(env, 'EAS_BUILD_ID', buildId);
setEnv(env, 'LANG', 'en_US.UTF-8');
setEnv(env, 'EAS_BUILD_WORKINGDIR', path.join(config.workingdir, 'build'));
@@ -113,28 +111,10 @@ export function getBuildEnv({
);
}
if (job.platform === Platform.ANDROID) {
if (job.version?.versionCode) {
setEnv(env, 'EAS_BUILD_ANDROID_VERSION_CODE', job.version.versionCode);
}
if (job.version?.versionName) {
setEnv(env, 'EAS_BUILD_ANDROID_VERSION_NAME', job.version.versionName);
}
} else if (job.platform === Platform.IOS) {
if (job.version?.buildNumber) {
setEnv(env, 'EAS_BUILD_IOS_BUILD_NUMBER', job.version.buildNumber);
}
if (job.version?.appVersion) {
setEnv(env, 'EAS_BUILD_IOS_APP_VERSION', job.version.appVersion);
}
for (const [key, value] of Object.entries(getResolvedJobInformationEnv(job, metadata))) {
setEnv(env, key, value);
}
let username = metadata.username;
if (!username && 'type' in job && job.type === Workflow.MANAGED) {
username = job.username;
}
setEnv(env, 'EAS_BUILD_USERNAME', username);
if (config.env === Environment.DEVELOPMENT) {
setEnv(env, 'EXPO_LOCAL', '1');
} else if (config.env === Environment.STAGING) {