[SPN-1438] Guardrail to add deprecated metric for class methods in the codebase #124
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… report on deprecated web APIs
right now this just includes strong typing for params and returns
…tric' into BK/integators/SPN-1447/strongTypingForServiceMethodDocumentationCheck
… to ensure doc blocks match contract
jlesueur
approved these changes
Jan 21, 2025
jlesueur
reviewed
Jan 21, 2025
…pingForServiceMethodDocumentationCheck [SPN-1447] Start of Service Documentation Guardrail
…tric' into BK/integators/SPN-1440/deprecatedApiAttributeMetric # Conflicts: # src/Checks/ErrorConstants.php # src/NodeVisitors/StaticAnalyzer.php # tests/units/Checks/TestTemplates.php
…edApiAttributeMetric [SPN-1440] Web Api Documentation Check and Deprecated API Attribute Metric
jlesueur
approved these changes
Jan 23, 2025
…edApiAttributeMetric handle both methods and functions
* fix some of the edge cases for the ServiceMethodDocumentationCheck.php. * Add better error descriptions * only run the checks on services and controllers * handle nullable types in the service check
jlesueur
reviewed
Jan 24, 2025
| @@ -69,8 +71,23 @@ public function run($fileName, Node $node, ClassLike $inside = null, Scope $scop | |||
| } | |||
| } | |||
|
|
|||
| private function isControllerMethod(ClassLike $inside = null): bool { | |||
There was a problem hiding this comment.
can we rename to isControllerClass()? it's not checking the method, just the class.
There was a problem hiding this comment.
A note, there is $this->symbolTable->isParentClassOrInterface("fully\qualified\className", $name) available. I don't know if it's entirely appropriate for your use, but thought I'd bring it up in case it can be.
jlesueur
reviewed
Jan 24, 2025
| } | ||
| } | ||
|
|
||
| private function isServiceMethod(?ClassLike $inside = null) { |
There was a problem hiding this comment.
This is also isServiceClass(), not method.
jlesueur
approved these changes
Jan 24, 2025
jongardiner
approved these changes
Jan 27, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.