feat: BACK-8055 Detect unused definitions #154
Conversation
ClaireGuerreGiordano
force-pushed
the
fixformat
branch
from
90a55e1
to
32c7e3f
Compare
ClaireGuerreGiordano
force-pushed
the
fixformat
branch
from
32c7e3f
to
c41d245
Compare
Wiz Scan Summary
To detect these findings earlier in the dev lifecycle, try using Wiz Code VS Code Extension. |
ClaireGuerreGiordano
force-pushed
the
fixformat
branch
15 times, most recently
from
36fa848
to
d418e6d
Compare
ClaireGuerreGiordano
force-pushed
the
fixformat
branch
from
2dcc97e
to
b6b597d
Compare
There was a problem hiding this comment.
I think it makes no sense to implement this at ERC7730Linter level, since it works on resolved descriptors where we already have inlined references.
I think, the right place is to do it ERC7730InputToResolved, since this is where we use references. Just keep track of which references are used at least once in ERC7730InputToResolved, for instance by using a wrapping container that counts calls, and output a warning at the end if some have never been called.
| @@ -13,5 +14,5 @@ class ERC7730Linter(ABC): | |||
| """ | |||
|
|
|||
| @abstractmethod | |||
| def lint(self, descriptor: ResolvedERC7730Descriptor, out: OutputAdder) -> None: | |||
| def lint(self, descriptor: ResolvedERC7730Descriptor | InputERC7730Descriptor, out: OutputAdder) -> None: | |||
There was a problem hiding this comment.
This can't be changed like this, linter runs on resolved descriptors. This only tricks the (python) linter but at runtime it takes resolved descriptors (see main class)
| for future in (executor.submit(lint_file, file, input_linter, out, label(file)) for file in files): | ||
| future.result() | ||
|
|
||
| with ThreadPoolExecutor() as executor: |
| resolved_descriptor = ERC7730InputToResolved().convert(input_descriptor, out) | ||
| if resolved_descriptor is not None: | ||
| linter.lint(resolved_descriptor, out) | ||
| if isinstance(linter, DefinitionLinter): |
There was a problem hiding this comment.
We can see here that it doesn't fit. Interface is not good if you have to do special cases here
This pr aims to enrich linter with unused field definition capability. If a field exists under descriptor.display.definition, it should be used elsewhere under format.
JIRA Ticket