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.

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

feat(cli): forge build for tests by default #1473

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from

Conversation

noahlitvin
Copy link
Member

No description provided.

Copy link

changeset-bot bot commented Oct 11, 2024

⚠️ No Changeset found

Latest commit: e492884

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

});
});
} else {
log(yellow('Skipping forge build...'));
Copy link

@juanpernu juanpernu Oct 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here could be something like: log(yellow('--skip-compile flag detected, skipping forge build...'));?🤔

const cannonfilePath = path.resolve(cannonfile);
const projectDirectory = path.dirname(cannonfilePath);

log(bold('Building the foundry project...'));

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could be inside line 172

const forgeBuildArgs = [
'build',
'--build-info',
'--ast',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the --ast flag.

Context: In a past Forge update (commit #7197) stopped generating AST by default. This creates compatibility issues with older Forge versions, where the AST was generated by default, and using the --ast flag can now trigger errors since some versions don’t recognize it.

Instead, the --build-info flag is supported across all Forge versions and reliably outputs the AST, making it the safer option.

Comment on lines +79 to +87
const artifact = JSON.parse(artifactBuffer.toString()) as any;
if (!artifact.ast) {
throw new Error(`Unable to find output from forge with ast for ${inputContractName} (from ${name}). Before running this command, run forge build --ast`);
}
possibleArtifacts.push(artifact);
}

if (!possibleArtifacts.length) {
throw new Error(`no contract was found by name: ${inputContractName} (from ${name})`);
throw new Error(`Unable to find output from forge with ast for ${inputContractName} (from ${name}). Before running this command, run forge build --ast`);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The cannon test command now runs forgeBuild, ensuring that artifacts always include the AST. This fix resolves the issue of missing AST in artifacts, so theoretically, this should no longer occur.

Previously, cannon test didn’t trigger a forge build, so forge executes forge build (when it wasn't built or it was the first time like for instance the CI) behind the scenes and by default it does not include the AST.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants