Clean up / improve: commit-safety-checks.js
#391
Merged
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR cleans up the commit-safety-checks.js logic by adding defensive guards around timestamp fields and enhancing the commit verification branch, and it extends the test suite with new failure and edge-case tests.
- Introduced
comment_created_at,commit_created_at, andverified_atvariables and added checks to throw if required timestamps are missing. - Added a guardrail for
inputs.commit_verification === truewhenverified_atis not present, and exportedisTimestampOlderfor reuse. - Expanded tests to cover missing comment/commit dates, missing
verified_at, and edge cases ofisTimestampOlder.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/functions/commit-safety-checks.js | Added defensive timestamp existence checks, guard for missing verified_at, and exported isTimestampOlder. |
| tests/functions/commit-safety-checks.test.js | Added tests for missing timestamps, missing verified_at, and isTimestampOlder error cases. |
Comments suppressed due to low confidence (3)
src/functions/commit-safety-checks.js:12
- [nitpick] Variable names in JavaScript typically use camelCase. Consider renaming
comment_created_attocommentCreatedAt(and similarly for other timestamp variables) to align with project conventions.
const comment_created_at = context?.payload?.comment?.created_at
src/functions/commit-safety-checks.js:33
- Add a unit test for the branch where the commit is authored after the trigger comment (i.e., when
isTimestampOlder(commentCreatedAt, commitCreatedAt)returns true) to ensure the early return with the correct error message.
if (isTimestampOlder(comment_created_at, commit_created_at)) {
src/functions/commit-safety-checks.js:75
- Add a unit test for the scenario where the commit signature was verified after the comment (i.e., when
isTimestampOlder(commentCreatedAt, verifiedAt)returns true underinputs.commit_verification === true) to cover that guardrail.
isTimestampOlder(comment_created_at, verified_at)
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.
This pull request cleans up the
commit-safety-checksfile a bit and add some more guardrails / tests.