Warn users who set `non_exhaustive_omitted_patterns` lint level on a match arm #117094

Nadrieril · 2023-10-23T17:04:52Z

Before #116734, the recommended usage of the non_exhaustive_omitted_patterns lint was:

match Bar::A {
    Bar::A => {},
    #[warn(non_exhaustive_omitted_patterns)]
    _ => {},
}

After #116734 this no longer makes sense, and recommended usage is now:

#[warn(non_exhaustive_omitted_patterns)]
match Bar::A {
    Bar::A => {},
    _ => {},
}

As you can guess, this silently breaks all uses of the lint that used the previous form. This is a problem in particular because syn recommends usage of this lint to its users in the old way. This PR emits a warning when the previous form is used so users can update.

r? @cjgillot

rustbot · 2023-10-23T17:51:29Z

Some changes occurred in src/tools/clippy

cc @rust-lang/clippy

Nadrieril · 2023-10-27T13:59:27Z

(the only clippy change is a test output)

Nadrieril · 2023-10-27T14:00:59Z

I realized this will likely regress the match-stress bench because it has 8000 arms. Very much a case where this bench is not representative of the world

@bors try @rust-timer queue

bors · 2023-10-27T14:02:10Z

⌛ Trying commit d53f545 with merge c6ca96d...

Warn users who set `non_exhaustive_omitted_patterns` lint level on a match arm Before rust-lang#116734, the recommended usage of the [`non_exhaustive_omitted_patterns` lint](rust-lang#89554) was: ```rust match Bar::A { Bar::A => {}, #[warn(non_exhaustive_omitted_patterns)] _ => {}, } ``` After rust-lang#116734 this no longer makes sense, and recommended usage is now: ```rust #[warn(non_exhaustive_omitted_patterns)] match Bar::A { Bar::A => {}, _ => {}, } ``` As you can guess, this silently breaks all uses of the lint that used the previous form. This is a problem in particular because `syn` recommends usage of this lint to its users in the old way. This PR emits a warning when the previous form is used so users can update. r? `@cjgillot`

bors · 2023-10-27T15:25:31Z

☀️ Try build successful - checks-actions
Build commit: c6ca96d (c6ca96d0edee56cc12810efaafa59dfc8fb1e2b1)

rust-timer · 2023-10-27T18:58:59Z

Finished benchmarking commit (c6ca96d): comparison URL.

Overall result: ❌ regressions - ACTION NEEDED

Benchmarking this pull request likely means that it is perf-sensitive, so we're automatically marking it as not fit for rolling up. While you can manually mark this PR as fit for rollup, we strongly recommend not doing so since this PR may lead to changes in compiler perf.

Next Steps: If you can justify the regressions found in this try perf run, please indicate this with @rustbot label: +perf-regression-triaged along with sufficient written justification. If you cannot justify the regressions please fix the regressions and do another perf run. If the next run shows neutral or positive results, the label will be automatically removed.

@bors rollup=never
@rustbot label: -S-waiting-on-perf +perf-regression

Instruction count

This is a highly reliable metric that was used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	0.2%	[0.2%, 0.2%]	2
Regressions ❌ (secondary)	0.1%	[0.1%, 0.2%]	4
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	0.2%	[0.2%, 0.2%]	2

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	0.8%	[0.8%, 0.8%]	1
Improvements ✅ (primary)	-1.0%	[-1.0%, -1.0%]	1
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	-1.0%	[-1.0%, -1.0%]	1

Cycles

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	2.4%	[2.0%, 2.8%]	2
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	-	-	0

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 636.074s -> 636.231s (0.02%)
Artifact size: 304.47 MiB -> 304.47 MiB (-0.00%)

cjgillot · 2023-10-31T18:35:14Z

compiler/rustc_mir_build/src/thir/pattern/usefulness.rs

+                        arm.hir_id,
+                        arm.pat.span(),
+                        NonExhaustiveOmittedPatternLintOnArm,
+                    );


Should we add a suggestion to move the attribute on the match itself?

Oh yes good idea, I'll look into it!

Well, I added a suggestion to add the lint on the match, I didn't find how to add a suggestion to remove the lint on the arm. Should I do this too?

You need to suggest an empty string in place of the current lint attribute's span.

Hmm, I can get the span for the lint level, but it's not the span of the whole attribute; removing it does:

- #[deny(non_exhaustive_omitted_patterns)] + #[deny()] _ => {}

It seems lint_level_at_node does not return anything else than this span to identify where the lint was set. Can I use the span to get to the span of the whole attribute somehow? Or use the arm HirId? It's not helping that rustc internal docs are missing atm :'(

Turns out that even with a better span, it's pretty hard to make clear that I'm suggesting to remove the line. Instead I added a "remove this" span label, it's a lot clearer ^^

bors · 2023-11-04T07:08:09Z

☔ The latest upstream changes (presumably #117564) made this pull request unmergeable. Please resolve the merge conflicts.

cjgillot · 2023-11-04T14:32:29Z

@bors r+

bors · 2023-11-04T14:32:31Z

📌 Commit f0e8330 has been approved by cjgillot

It is now in the queue for this repository.

bors · 2023-11-04T14:33:41Z

⌛ Testing commit f0e8330 with merge f81d6f0...

Nadrieril · 2023-11-04T14:50:02Z

Thank u!

bors · 2023-11-04T16:30:00Z

☀️ Test successful - checks-actions
Approved by: cjgillot
Pushing f81d6f0 to master...

rust-timer · 2023-11-05T07:20:36Z

Finished benchmarking commit (f81d6f0): comparison URL.

Overall result: ❌ regressions - ACTION NEEDED

Next Steps: If you can justify the regressions found in this perf run, please indicate this with @rustbot label: +perf-regression-triaged along with sufficient written justification. If you cannot justify the regressions please open an issue or create a new PR that fixes the regressions, add a comment linking to the newly created issue or PR, and then add the perf-regression-triaged label to this PR.

@rustbot label: +perf-regression
cc @rust-lang/wg-compiler-performance

Instruction count

This is a highly reliable metric that was used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	0.2%	[0.2%, 0.3%]	3
Regressions ❌ (secondary)	0.1%	[0.1%, 0.1%]	4
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	0.2%	[0.2%, 0.3%]	3

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	0.6%	[0.6%, 0.7%]	2
Regressions ❌ (secondary)	3.8%	[3.8%, 3.8%]	1
Improvements ✅ (primary)	-1.2%	[-2.1%, -0.4%]	4
Improvements ✅ (secondary)	-1.8%	[-3.2%, -1.2%]	4
All ❌✅ (primary)	-0.6%	[-2.1%, 0.7%]	6

Cycles

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	0.6%	[0.4%, 0.7%]	3
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	0.6%	[0.4%, 0.7%]	3

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 635.472s -> 635.521s (0.01%)
Artifact size: 304.37 MiB -> 304.34 MiB (-0.01%)

pnkfelix · 2023-11-07T17:48:38Z

regressed check incr-full for cranelift-codegen (0.25%), cargo (0.22%) and hyper (0.21%).
this small amount does not appear to be noise
but it shouldn't have any (significant) effect if the non_exhaustive_omitted_patterns lint is not in use.
marking as triaged

@rustbot label: +perf-regression-triaged

rustbot assigned cjgillot Oct 23, 2023

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 Oct 23, 2023

This was referenced Oct 23, 2023

The non_exhaustive_omitted_patterns lint changed dtolnay/syn#1522

Closed

Tracking Issue for #![feature(non_exhaustive_omitted_patterns_lint)] #89554

Open

This comment has been minimized.

Sign in to view

Nadrieril force-pushed the warn-lint-on-arm branch from 18e7783 to d53f545 Compare October 23, 2023 17:51

This comment has been minimized.

Sign in to view

rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Oct 27, 2023

This comment has been minimized.

Sign in to view

Nadrieril force-pushed the warn-lint-on-arm branch from d53f545 to 485b566 Compare October 27, 2023 17:59

rustbot added perf-regression Performance regression. and removed S-waiting-on-perf Status: Waiting on a perf run to be completed. labels Oct 27, 2023

cjgillot reviewed Oct 31, 2023

View reviewed changes

This comment was marked as outdated.

Sign in to view

Nadrieril force-pushed the warn-lint-on-arm branch 2 times, most recently from feac3b9 to 64577dc Compare November 2, 2023 05:21

This comment has been minimized.

Sign in to view

Nadrieril added 3 commits November 4, 2023 14:44

Add tests

7b19fb8

Warn when lint level is set on a match arm

61d0fc7

Suggest to set lint level on whole match

f0e8330

Nadrieril force-pushed the warn-lint-on-arm branch from 64577dc to f0e8330 Compare November 4, 2023 13:44

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 4, 2023

bors added the merged-by-bors This PR was explicitly merged by bors. label Nov 4, 2023

bors merged commit f81d6f0 into rust-lang:master Nov 4, 2023
12 checks passed

rustbot added this to the 1.75.0 milestone Nov 4, 2023

Nadrieril deleted the warn-lint-on-arm branch November 4, 2023 16:50

github-actions bot mentioned this pull request Nov 6, 2023

Automated pull from upstream master ferrocene/ferrocene#84

Merged

rustbot added the perf-regression-triaged The performance regression has been triaged. label Nov 7, 2023

Nadrieril added the F-non_exhaustive_omitted_patterns_lint `#![feature(non_exhaustive_omitted_patterns_lint)]` label Dec 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Warn users who set `non_exhaustive_omitted_patterns` lint level on a match arm #117094

Warn users who set `non_exhaustive_omitted_patterns` lint level on a match arm #117094

Nadrieril commented Oct 23, 2023

This comment has been minimized.

rustbot commented Oct 23, 2023

Nadrieril commented Oct 27, 2023

Nadrieril commented Oct 27, 2023

This comment has been minimized.

bors commented Oct 27, 2023

bors commented Oct 27, 2023

This comment has been minimized.

rust-timer commented Oct 27, 2023

cjgillot Oct 31, 2023

Nadrieril Oct 31, 2023

Nadrieril Oct 31, 2023

Nadrieril Oct 31, 2023 •

edited

Loading

cjgillot Nov 1, 2023

Nadrieril Nov 2, 2023

Nadrieril Nov 2, 2023

This comment was marked as outdated.

This comment has been minimized.

bors commented Nov 4, 2023

cjgillot commented Nov 4, 2023

bors commented Nov 4, 2023

bors commented Nov 4, 2023

Nadrieril commented Nov 4, 2023

bors commented Nov 4, 2023

rust-timer commented Nov 5, 2023

pnkfelix commented Nov 7, 2023

Warn users who set non_exhaustive_omitted_patterns lint level on a match arm #117094

Warn users who set non_exhaustive_omitted_patterns lint level on a match arm #117094

Conversation

Nadrieril commented Oct 23, 2023

This comment has been minimized.

rustbot commented Oct 23, 2023

Nadrieril commented Oct 27, 2023

Nadrieril commented Oct 27, 2023

This comment has been minimized.

bors commented Oct 27, 2023

bors commented Oct 27, 2023

This comment has been minimized.

rust-timer commented Oct 27, 2023

Overall result: ❌ regressions - ACTION NEEDED

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Nadrieril Oct 31, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as outdated.

This comment has been minimized.

bors commented Nov 4, 2023

cjgillot commented Nov 4, 2023

bors commented Nov 4, 2023

bors commented Nov 4, 2023

Nadrieril commented Nov 4, 2023

bors commented Nov 4, 2023

rust-timer commented Nov 5, 2023

Overall result: ❌ regressions - ACTION NEEDED

pnkfelix commented Nov 7, 2023

Warn users who set `non_exhaustive_omitted_patterns` lint level on a match arm #117094

Warn users who set `non_exhaustive_omitted_patterns` lint level on a match arm #117094

Nadrieril Oct 31, 2023 •

edited

Loading