codu-code / codu

Codú's open-source codebase. A space for coders. Visit our community!
https://codu.co/
Apache License 2.0
141 stars 145 forks source link

Feat/multiple user support in e2e tests #1182

Closed JohnAllenTech closed 4 weeks ago

JohnAllenTech commented 1 month ago

✨ Codu Pull Request 💻

Will need to be merged after #1181

Pull Request details

Follow on from #1181. Now creating two E2E users and supporting using them in our E2E test suite.

This unlocks the ability to test interaction between two users in an E2E Test. ie one user comments on another users comment

Any Breaking changes

You can do this by running

npm run db:nuke
npm run db:migrate
npm run db:seed

Associated Screenshots

image

All tests passing locally

vercel[bot] commented 1 month ago

@JohnAllenTech is attempting to deploy a commit to the Codú Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request involve significant updates to the environment variable management for end-to-end (E2E) testing across multiple files. The README.md file has been revised to reflect new variable names and the introduction of additional user session identifiers. The drizzle/seed.ts file has been modified to accommodate the new structure for user data seeding. The E2E test suite has been adjusted to handle authenticated and unauthenticated user scenarios, and utility functions for user authentication have been added. Lastly, the sample.env file has been updated to reflect the new variable names.

Changes

File Change Summary
README.md Renamed E2E_USER_SESSION_ID to E2E_USER_ONE_SESSION_ID, added E2E_USER_TWO_SESSION_ID, removed E2E_USER_ID, added E2E_USER_ONE_ID and E2E_USER_TWO_ID. Updated descriptions for clarity.
drizzle/seed.ts Added new user session and ID variables, updated seedE2EUser and seedE2EUserSession functions to accept parameters. Adjusted calls in addSeedDataToDb.
e2e/articles.spec.ts Separated tests for authenticated and unauthenticated users, updated visibility checks and author name in tests. Enhanced scrolling behavior for loading articles.
e2e/teardown.ts Expanded environment variable checks for cleanup, updated database deletion logic to handle new user IDs.
e2e/utils/utils.ts Introduced loggedInAsUserOne and loggedInAsUserTwo functions for user authentication in E2E tests.
sample.env Replaced E2E_USER_ID and E2E_USER_SESSION_ID with new variables for two users.

Possibly related PRs

Suggested labels

hacktoberfest-accepted, hacktoberfest

Suggested reviewers

Poem

Hop, hop, hooray, what a change today!
User sessions now in twos, oh what fun to play!
With IDs and tokens, our tests shall soar,
E2E adventures, we shall explore!
Bouncing through code, with joy we’ll sing,
For every new variable, let the rabbit dance and spring! 🐇✨


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://coderabbit.ai/docs) 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.
vercel[bot] commented 4 weeks ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
codu ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 28, 2024 8:21pm
JohnAllenTech commented 4 weeks ago

This ones good to go @NiallJoeMaher

github-actions[bot] commented 4 weeks ago

Uh oh! @JohnAllenTech, the image you shared is missing helpful alt text. Check https://github.com/codu-code/codu/pull/1182#issuecomment-2442597176.

Alt text is an invisible description that helps screen readers describe images to blind or low-vision users. If you are using markdown to display images, add your alt text inside the brackets of the markdown image.

Learn more about alt text at Basic writing and formatting syntax: images on GitHub Docs.