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

Fix crate name validation #127581

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

Conversation

fmease
Copy link
Member

@fmease fmease commented Jul 10, 2024

Reject macro calls inside attribute #![crate_name] like #![crate_name = concat!("na", "me")].

Prior to #117584, the result of the expansion (here: "name") would actually be properly picked up by the compiler and used as the crate name. However since #117584 / on master, we extract the "value" (i.e., the literal string literal) of the #![crate_name] much earlier in the pipeline way before macro expansion and skip/ignore any #![crate_name]s "assigned to" a macro call. See also #122001.

T-lang has ruled to reject #![crate_name = MACRO!(...)] outright very similar to other built-in attributes whose value we need early like #![crate_type]. See accepted FCP: #122001 (comment).

Note that the check as implemented in this PR is even more "aggressive" compared to the one of #![crate_type] by running as early as possible in order to reject #![crate_name = MACRO!(...)] even in "non-normal" executions of rustc, namely on print requests (e.g., --print=crate-name and --print=file-names). If I were to move the validation step a bit further back close to the #![crate_type] one, --print=crate-name (etc.) would not exit fatally with an error in this kind of situation but happily report an incorrect crate name (i.e., the "crate name" as if #![crate_name] didn't exist / deduced from other sources like --crate-name or the file name) which would match the behavior on master. Again, see also #122001.

I'm mentioning this explicitly because I'm not sure if it was that clear in the FCP'ed issue. I argue that my current approach is the most reasonable one. I know (from reading the code and from past experiments) that various print requests are still quite broken (mostly lack of validation).

To the best of my knowledge, there's no print request whose output references/contains a crate type, so there's no "inherent need" to move #![crate_type]'s validation to happen earlier.


Fixes #122001.

relnotes Marks issues that should be documented in the release notes of the next release. : Compatibility. Breaking change.

@fmease fmease added the relnotes Marks issues that should be documented in the release notes of the next release. label Jul 10, 2024
@rustbot
Copy link
Collaborator

rustbot commented Jul 10, 2024

r? @wesleywiser

rustbot has assigned @wesleywiser.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Jul 10, 2024
@rust-log-analyzer

This comment has been minimized.

fmease

This comment was marked as duplicate.

@fmease fmease marked this pull request as draft July 10, 2024 17:26
@fmease fmease force-pushed the fix-crate_name-validation branch from 7b933ad to 3de58e6 Compare July 10, 2024 17:51
@fmease fmease marked this pull request as ready for review July 10, 2024 17:51
@rust-log-analyzer

This comment has been minimized.

@fmease fmease changed the title Fix crate name validation Fix crate name validation & cleanup Jul 10, 2024
@fmease fmease changed the title Fix crate name validation & cleanup Fix crate name validation & clean up Jul 10, 2024
@fmease fmease force-pushed the fix-crate_name-validation branch from 3de58e6 to e688f5e Compare July 10, 2024 20:37
@fmease
Copy link
Member Author

fmease commented Jul 18, 2024

I've finally added a proper PR description. Sorry about the delay ^^'.

@bors

This comment was marked as resolved.

Copy link
Member

@wesleywiser wesleywiser left a comment

Choose a reason for hiding this comment

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

Is the last commit still WIP?

@@ -179,12 +179,12 @@ fn mod_file_path_from_attr(
let first_path = attrs.iter().find(|at| at.has_name(sym::path))?;
let Some(path_sym) = first_path.value_str() else {
// This check is here mainly to catch attempting to use a macro,
// such as #[path = concat!(...)]. This isn't currently supported
// such as `#[path = concat!(...)]`. This isn't currently supported
Copy link
Member

Choose a reason for hiding this comment

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

Nit, maybe say "This isn't supported" and drop the "currently" because it sounds like something we want to fix in the future and we've conclusively decided we do not want to do that.

@fmease fmease changed the title Fix crate name validation & clean up Fix crate name validation Jul 31, 2024
@fmease fmease force-pushed the fix-crate_name-validation branch from e688f5e to d169eee Compare July 31, 2024 18:18
@fmease
Copy link
Member Author

fmease commented Jul 31, 2024

Is the last commit still WIP?

I've now dropped the WIP commit as I still need to investigate the implications of its changes. I'll submit it as a follow-up PR if everything works out.

I've adjusted the wording in the comment to no longer use the word 'currently'.

Ready for re-review. Nothing WIP left.

@bors

This comment was marked as resolved.

Note that `need-crate-arg-ignore-tidy$x.rs` used to be in `tests/ui/command/`
which wasn't 'correct' as that directory concerns `std::process::Command` tests
not CLI tests.
Gets rid of two top-level UI tests which is always great.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
relnotes Marks issues that should be documented in the release notes of the next release. S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

#![crate_name = EXPR] semantically allows EXPR to be a macro call but otherwise mostly ignores it
5 participants