Collect package data from specific tags #260
Merged
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
…ible to maintain unit tests on VCS During this change-over in testing strategy, I was able to find bugs in webhook handling for versions and squash them, as well as found we skipped validating a repo existed during version publication. And finally found the documentation of the type of return was incorrect on post version endpoint
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
After some complexity added to featureDetection, seems that now `nock` is being cleaned up right after the API returns, not giving a chance for featureDetection logic to use those endpoints to function as it runs afterwards. Attempting a simple method of waiting, otherwise may need more featureDetection specific logic
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.
Requirements
Filling out the template is required.
All new code requires tests to ensure against regressions.
Have you ran tests against this code?
This PR contains zero code changes.
Description of the Change
This PR enables the collection of package details via a specific
ref. This means that the backend now supports mono-repos or in the case of #205 supports non-standard repositories such as those mirroring other forges.The functionality differs slightly between:
Initial Publication
After verifying the repository exists, the backend first requests the available tags on GitHub. After collecting them then the data needed for the package (
README.md,package.json) are collected according to each available tag we found earlier. This also has the benefit of resolving a long standing issue where when retroactively publishing other versions on initial publication the data shown for these previous versions was technically incorrect as it'd only show whatever was the latest data.Publishing a Version
When we publish a new version we take the
refprovided within the request. (Which has always been present, but actually the backend has been ignoring and not even collecting this value so far in operation)This
refis then what's used to collect further details.During these changes I ended up scraping many of the VCS 'unit' tests, as they were so closely coupled to actual logic and mocks it became unwieldy to rewrite as needed, and instead was easier to rewrite them as full integration tests with
nock. With that I was able to discover some new issues, such as the documented return of the version publication endpoint being inaccurate, I discovered that during version publication we didn't ever verify the repository existed first, and finally found that if the version publication failed, the resulting webhook attempt to Discord could cause bigger failures than we'd hope. So of course this PR has also fixed all those above issues.Fixes #205
Fixes #255