feat: initial commit of Snapshot middleware #219
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
|
## Walkthrough
This commit introduces a new Snapshot middleware project, including configuration files, custom error handling, utility functions, and integration with external services like Rollbar. It provides functionality for processing and forwarding requests, handling retries on errors, and logging. Initial tests and documentation are also included to support deployment and development.
## Changes
| Files | Summary |
|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `.editorconfig`, `.gitignore` | Initial commit of configuration files to maintain consistent coding styles and ignore unnecessary files in the repository. |
| `README.md` | Instructions for deploying and developing the Snapshot middleware locally, detailing setup steps and testing procedures. |
| `src/exceptions.js`, `src/utils.js` | Introduction of custom error classes and a utility function for making HTTP requests with retry logic on specific errors. |
| `src/index.js` | New middleware for handling snapshot requests, validating data, and processing messages from a queue. |
| `src/snapshot.js` | Implementation of `SnapshotApi` class for uploading images to an API endpoint using base64 encoding and handling responses. |
| `src/rollbar.js` | Module for logging errors using Rollbar, providing methods to send traces and telemetry data to the Rollbar API. |
| `src/test.js` | Initial commit of a JSON template for sending detailed error or event data to a service like Rollbar. |
| `test/index.spec.js` | Test suite for a Cloudflare worker, verifying basic response functionality. |
> In code we trust, through bytes we sail,
> A middleware tale where errors pale.
> With Rollbar's watchful eye, logs take flight,
> As snapshots dance in the digital night.
> Retry, resolve, in harmony they sing,
> A rabbit's joy in every spring! 🐇✨Uplevel your code reviews with CodeRabbit ProCodeRabbit ProIf you like this project, please support us by purchasing the Pro version. The Pro version has advanced context, superior noise reduction and several proprietary improvements compared to the open source version. Moreover, CodeRabbit Pro is free for open source projects. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Files selected (11)
- snapshot-middleware/.editorconfig (1)
- snapshot-middleware/.gitignore (1)
- snapshot-middleware/README.md (1)
- snapshot-middleware/src/exceptions.js (1)
- snapshot-middleware/src/index.js (1)
- snapshot-middleware/src/rollbar.js (1)
- snapshot-middleware/src/snapshot.js (1)
- snapshot-middleware/src/test.js (1)
- snapshot-middleware/src/utils.js (1)
- snapshot-middleware/test/index.spec.js (1)
- snapshot-middleware/vitest.config.js (1)
Files ignored due to filter (4)
- snapshot-middleware/package-lock.json
- snapshot-middleware/package.json
- snapshot-middleware/rollbar.toml
- snapshot-middleware/wrangler.toml
Files skipped from review due to trivial changes (3)
- snapshot-middleware/.editorconfig
- snapshot-middleware/.gitignore
- snapshot-middleware/src/test.js (diff too large)
Review comments generated (19)
- Review: 7
- LGTM: 12
Tips
Chat with 
CodeRabbit Bot (@coderabbitai)
- Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
- Invite the bot into a review comment chain by tagging
@coderabbitaiin a reply.
Code suggestions
- The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
- You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.
Pausing incremental reviews
- Add
@coderabbitai: ignoreanywhere in the PR description to pause further reviews from the bot.
There was a problem hiding this comment.
Files selected (4)
- snapshot-middleware/src/index.js (1)
- snapshot-middleware/src/rollbar.js (1)
- snapshot-middleware/src/snapshot.js (1)
- snapshot-middleware/test/index.spec.js (1)
Review comments generated (14)
- Review: 5
- LGTM: 9
Tips
Chat with CodeRabbit Bot (@coderabbitai)
- Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
- Invite the bot into a review comment chain by tagging
@coderabbitaiin a reply.
Code suggestions
- The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
- You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.
Pausing incremental reviews
- Add
@coderabbitai: ignoreanywhere in the PR description to pause further reviews from the bot.
marcbelmont
requested review from
Pefington
and removed request for
stevelukis
There was a problem hiding this comment.
Files selected (10)
- snapshot-middleware/.editorconfig (1)
- snapshot-middleware/.gitignore (1)
- snapshot-middleware/README.md (1)
- snapshot-middleware/src/exceptions.js (1)
- snapshot-middleware/src/index.js (1)
- snapshot-middleware/src/rollbar.js (1)
- snapshot-middleware/src/snapshot.js (1)
- snapshot-middleware/src/utils.js (1)
- snapshot-middleware/test/index.spec.js (1)
- snapshot-middleware/vitest.config.js (1)
Files ignored due to filter (4)
- snapshot-middleware/package-lock.json
- snapshot-middleware/package.json
- snapshot-middleware/rollbar.toml
- snapshot-middleware/wrangler.toml
Files skipped from review due to trivial changes (2)
- snapshot-middleware/.editorconfig
- snapshot-middleware/.gitignore
Review comments generated (26)
- Review: 8
- LGTM: 18
Tips
Chat with CodeRabbit Bot (@coderabbitai)
- Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
- Invite the bot into a review comment chain by tagging
@coderabbitaiin a reply.
Code suggestions
- The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
- You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.
Pausing incremental reviews
- Add
@coderabbitai: ignoreanywhere in the PR description to pause further reviews from the bot.
There was a problem hiding this comment.
Files selected (3)
- .github/workflows/code-review.yml (1)
- snapshot-middleware/src/index.js (1)
- snapshot-middleware/src/rollbar.js (1)
Review comments generated (5)
- Review: 3
- LGTM: 2
Tips
Chat with CodeRabbit Bot (@coderabbitai)
- Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
- Invite the bot into a review comment chain by tagging
@coderabbitaiin a reply.
Code suggestions
- The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
- You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.
Pausing incremental reviews
- Add
@coderabbitai: ignoreanywhere in the PR description to pause further reviews from the bot.
There was a problem hiding this comment.
Files selected (1)
- snapshot-middleware/README.md (1)
Files ignored due to filter (2)
- snapshot-middleware/rollbar.toml
- snapshot-middleware/wrangler.toml
Review comments generated (1)
- Review: 0
- LGTM: 1
Tips
Chat with CodeRabbit Bot (@coderabbitai)
- Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
- Invite the bot into a review comment chain by tagging
@coderabbitaiin a reply.
Code suggestions
- The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
- You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.
Pausing incremental reviews
- Add
@coderabbitai: ignoreanywhere in the PR description to pause further reviews from the bot.
Pefington
requested changes
Oct 21, 2024
Pefington
approved these changes
Oct 21, 2024
marcbelmont
approved these changes
Oct 22, 2024
@danleyb2 Don't hesitate to install and use Prettier and eslint for JS/TS. |
improve rollbar parsing of exceptions messages
|
@danleyb2 |
marcbelmont
approved these changes
Oct 29, 2024
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.
Summary by CodeRabbit
.editorconfigand.gitignorefor consistent coding style and repository cleanliness.