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.

Sign up for GitHub

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

Jump to bottom

New feature: Detect EnumCaseAdded as a BC break #767

Closed
bdsl opened this issue May 18, 2024 · 1 comment · Fixed by #768
Closed

New feature: Detect EnumCaseAdded as a BC break #767

bdsl opened this issue May 18, 2024 · 1 comment · Fixed by #768
Assignees
@Ocramius
Labels
enhancement
Milestone
8.8.0

Comments

@bdsl
Copy link
Contributor

bdsl commented May 18, 2024

As far as I can tell this isn't something currently detected, but I think adding a new enum case should be considered a breaking change, as it will break any consuming code that was previously relying on being able to exhaustively handle all cases of an enum.

For instance consuming code will often use match with an enum, which will throw UnhandledMatchError if the enum cases is a new one.

Would people be interested in a PR to implement this check?
@Ocramius
Copy link
Member

Yes please!

bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767 WIP - add tests
85d08a2
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767 WIP - add tests
6450385
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767 Create EnumCaseAdded class
6adaeb6
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767: Rename ClassBased/EnumCaseAdded to EnumBased/CaseAdded use…
8a1bbee 
… in CompareClasses s
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767: Rename ClassBased/EnumCaseAdded to EnumBased/CaseAdded use…
69e22a7 
… in CompareClasses s
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767: Rename ClassBased/EnumCaseAdded to EnumBased/CaseAdded use…
20779b5 
… in CompareClasses s
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767: Allow adding @internal enum cases without BC break
66a57c2
@bdsl bdsl mentioned this issue May 19, 2024
Merged
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767 : Fix BC break
bc29606 
Afaik this product is a tool rather than a library, so I'm not sure if
BC breaks on a function are really an issue, but the build is reporting
an unexpected BC break here

https://github.com/Roave/BackwardCompatibilityCheck/actions/runs/9148688556/job/25151720875
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767 : Fix BC break
d195486 
Afaik this product is a tool rather than a library, so I'm not sure if
BC breaks on a function are really an issue, but the build is reporting
an unexpected BC break here

https://github.com/Roave/BackwardCompatibilityCheck/actions/runs/9148688556/job/25151720875
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767 : Fix BC break
3d288ec 
Afaik this product is a tool rather than a library, so I'm not sure if
BC breaks on a function are really an issue, but the build is reporting
an unexpected BC break here

https://github.com/Roave/BackwardCompatibilityCheck/actions/runs/9148688556/job/25151720875
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767: Improve test coverage
56cf628
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767: Remove unecassary array_values calls
7007cd1 
Infection detected that these were not needed
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767: Improve test coverage
a9cd256
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767: Remove unecassary array_values calls
b5cfc9b 
Infection detected that these were not needed
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767 Create EnumCaseAdded class
77fd27e
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767: Rename ClassBased/EnumCaseAdded to EnumBased/CaseAdded use…
be55ca1 
… in CompareClasses s
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767: Allow adding @internal enum cases without BC break
8c41bc8
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767 : Fix BC break
a1e3738 
Afaik this product is a tool rather than a library, so I'm not sure if
BC breaks on a function are really an issue, but the build is reporting
an unexpected BC break here

https://github.com/Roave/BackwardCompatibilityCheck/actions/runs/9148688556/job/25151720875
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767: Improve test coverage
b2c4ddc
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767: Remove unecassary array_values calls
6f7c9dc 
Infection detected that these were not needed
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767: Remove covers annotation on new test case
458cab3 
Trying to work out whether this is related to the infection check
failure - I haven't been able to reproduce the way its failing on my
local.
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 19, 2024
@bdsl
Roave#767: Add tests about enums to CompareClassesTests
7f01d47
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 21, 2024
@bdsl
Roave#767: Refactor, remove new EnumBased interface, treat Enums as j…
eb5c8a6 
…ust classes
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 21, 2024
@bdsl
Roave#767: Refactor, remove new EnumBased interface, treat Enums as j…
850e7a3 
…ust classes
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 21, 2024
@bdsl
Roave#767: Add check in test that Enum case names are case sensitve
d9d3b04
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 21, 2024
@bdsl
Roave#767: add check for enum case became internal
61231a8
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 21, 2024
@bdsl
Roave#767: Detect enum becoming non-enum and vice-versa as BC break
9da3f6d
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 21, 2024
@bdsl
Roave#767: Refacotr, rename class CasedChanged -> EnumCasesChanged
00c4500
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 21, 2024
@bdsl
Roave#767: Refactor, rename class CasedChanged -> EnumCasesChanged
aa85d92
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 21, 2024
@bdsl
Roave#767: Fix Psalm and PHPCS errors
35e77b3
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 22, 2024
@bdsl
Roave#767: Add check for enum case becoming not internal
aa9c85d 
Perhaps the semantics are arguable, but I think it's safest to say
making a case no longer internal is a BC break, as it means we no-longer
gurantee to not return it and client code may need to check for it as
part of an exhaustive match.
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 22, 2024
@bdsl
Roave#767: Remove outdated comments from test
77a2f08
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 22, 2024
@bdsl
Roave#767: Add @Covers to EnumCasesChangedTest
5519e97
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 22, 2024
@bdsl
Roave#767: Remove redundant term in if condition
190968c
bdsl added a commit to bdsl/BackwardCompatibilityCheck that referenced this issue May 22, 2024
@bdsl
Roave#767: Remove unecassary comment
6703c31 
See Roave#768 (comment)
@Ocramius Ocramius added this to the 8.8.0 milestone May 22, 2024
@Ocramius Ocramius self-assigned this May 22, 2024
@Ocramius Ocramius linked a pull request May 22, 2024 that will close this issue
Detect changes in ENUMs as BC breaks #768
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Ocramius Ocramius

Labels
enhancement
Projects
None yet
Milestone
8.8.0
Development

Successfully merging a pull request may close this issue.

Detect changes in ENUMs as BC breaks bdsl/BackwardCompatibilityCheck
2 participants
@Ocramius @bdsl