feat: add add GitHub helpers for findFilesByFilenameAndRef and findFilesByExtensionAndRef #712
Conversation
google-cla
bot
added
the
cla: yes
Codecov Report
@@ Coverage Diff @@
## master #712 +/- ##
==========================================
+ Coverage 86.78% 86.96% +0.18%
==========================================
Files 55 55
Lines 6582 6673 +91
Branches 586 594 +8
==========================================
+ Hits 5712 5803 +91
Misses 869 869
Partials 1 1
Continue to review full report at Codecov.
|
chingor13
changed the title
There was a problem hiding this comment.
The comment re: using sinon for mocking doesn't need to be a blocker, but I wonder if it makes the codebase more maintainable long term.
I've found people really wrestle with nock, and it might be better to only use it for select things, where we want to be darn sure we've exercised code paths that rely on it.
| let path = file.path!; | ||
| // strip the prefix if provided | ||
| if (prefix) { | ||
| const pfix = new RegExp(`^${prefix}[/\\\\]`); |
There was a problem hiding this comment.
this is elegant, I like the approach.
| extension: string, | ||
| ref: string, |
There was a problem hiding this comment.
Should ref be optional, based on the description of the method?
There was a problem hiding this comment.
I originally had it optional as an overload of fileFilesByExtension(extension, prefix?, ref?), but then opted to make it a separate explicit method. I'll fix the docs to not make it optional.
| const graphql = JSON.parse( | ||
| readFileSync(resolve(fixturesPath, 'commits-yoshi-java.json'), 'utf8') | ||
| ); | ||
| const req = nock('https://api.github.com') |
There was a problem hiding this comment.
I'm wondering if it would be worth moving some of this logic to sinon, like here I've been finding that it feels a bit more maintainable than enumerating all of the GitHub endpoints we'll be interacting with.
There was a problem hiding this comment.
I like this a lot. Let me do it in a separate, follow-up PR to avoid muddying up this PR.
Fixes #656 - using the git tree API should be instantaneous and not reliant on the search API.
Fixes #710 - provides extra helpers for finding files by filename/extension within a branch.
Refactors findFiles to use the tree API for listing files.