feat: set up users analytics and waitlist using logsnag

sajdakabir commented 3 weeks ago

What does this PR do?

Fixes:

[ ] #XXX (GitHub issue number)
[ ] MAR-276(Linear issue number - should be visible at the bottom of the GitHub issue description)

Mandatory Tasks:

[X] I have self-reviewed the code (A decent size PR without self-review might be rejected)
[x] I confirm automated tests are in place that prove my fix is effective or that my feature works.

How should this be tested?

Environment Setup:

[ ] Required env variables:
```
# Add required env variables here
```

Test Data Requirements:

[ ]

Checklist:

[ ] My code follows the style guidelines of this project
[ ] I have commented my code, particularly in hard-to-understand areas
[ ] I have checked if my changes generate no new warnings
[ ] I have checked for Build errors
[ ] I have checked if my branch is up to date with preview

coderabbitai[bot] commented 3 weeks ago

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

## Walkthrough This pull request introduces several changes across multiple files in the backend and frontend applications. Key updates include the addition of the Logsnag dependency, modifications to user authentication and verification processes, and enhancements to the user model. A new waitlist component is also introduced in the frontend. The changes collectively improve user tracking, verification, and the overall structure of the applications. ## Changes | File Path | Change Summary | |------------------------------------------------|-------------------------------------------------------------------------------------------------| | `apps/backend/package.json` | Added dependency: `"@logsnag/node": "^1.0.1"` | | `apps/backend/src/controllers/core/auth.controller.js` | Added Logsnag tracking event for new users created via Google authentication. | | `apps/backend/src/loaders/environment.loader.js` | Added environment variables: `LOGSNAG_TOKEN`, `LOGSNAG_PROJECT_NAME`. | | `apps/backend/src/loaders/logsnag.loader.js` | Introduced Logsnag loader and exported `logsnag` instance. | | `apps/backend/src/middlewares/jwt.middleware.js` | Enhanced response structure in `checkUserVerificationController` to include user details. | | `apps/backend/src/models/core/user.model.js` | Added fields: `userVerification` (default: false) and `isWaitlisted` (default: true) to `UserSchema`. | | `apps/frontend/src/app/(waitlist)/waitlist/page.tsx` | Introduced new `Waitlist` component for rendering the waitlist page. | | `apps/frontend/src/middleware.ts` | Updated `verifyToken` function to return a detailed user verification structure. | ## Possibly related PRs - #318: The main PR introduces a new dependency for Logsnag, which is relevant to the feedback changes in PR #318 that also involve user interactions and tracking, enhancing the overall user experience. ## Suggested labels `community` > 🐰 In the garden of code, we hop with glee, > New dependencies sprout, as fresh as can be! > With Logsnag in tow, our users we track, > Waitlists and verifications, we won't look back! > So let’s celebrate this change, oh so bright, > For a smoother user journey, we take flight! ✈️

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

github-actions[bot] commented 3 weeks ago

Hey there! 👋

We require pull request titles to follow the Conventional Commits specification.

Valid types:

feat: A new feature
fix: A bug fix
docs: Documentation only changes
style: Changes that do not affect the meaning of the code
refactor: A code change that neither fixes a bug nor adds a feature
perf: A code change that improves performance
test: Adding missing or correcting existing tests
build: Changes that affect the build system or external dependencies
ci: Changes to CI configuration files and scripts
chore: Other changes that don't modify src or test files
revert: Reverts a previous commit

Format: type: description

Error details:

No release type found in pull request title "set up users analytics and waitlist using logsnag". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat
 - fix
 - docs
 - style
 - refactor
 - perf
 - test
 - build
 - ci
 - chore
 - revert

socket-security[bot] commented 3 weeks ago

New dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher

View full report↗︎

marchhq / march