Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

get the dev-postgres branch to the minimal base state #2597

Open
wants to merge 12 commits into
base: dev-postgres
Choose a base branch
from

Conversation

xoldd
Copy link
Contributor

@xoldd xoldd commented Oct 17, 2024

What kind of change does this PR introduce?

Implements all changes required to get the dev-postgres branch to a minimal base state to have a easier time making the additional changes on top of.

Issue Number:

Fixes #2596

Did you add tests for your changes?

Yes

Snapshots/Videos:

If relevant, did you update the documentation?

Summary

Does this PR introduce a breaking change?

Other information

Review guide: Each commit is related to a specific tool/topic and includes changes related to exactly that(mostly) so it's easier to review commits one by one because they (build on top of each other) instead of reviewing all changes at once.

@palisadoes I wouldn't squash and merge this PR but it's your choice.

Have you read the contributing guide?

the old codebase is largely incompatible with the new changes that
will be made and it is a huge hassle to do it incrementally while
keeping the backwards compatibility

as such the entire codebase is being wiped to start from scratch and the
redundant stuff or new changes from the old codebase will be manually
copied into the new codebase as needed
initialized an empty node.js esm project

added some documents from the previous project

modified dependabot config from npm to pnpm package manager
added the lefthook package

added the package.json scripts for enabling/disabling the git hooks
added dependencies for typescript and node.js integration

added tsconfig.json with configuration for node.js and esmodules

added package.json script for checking type errors in the codebase

added root /src directory for storing runtime typescript application
logic
added dependencies for integrating biome.js

added biome.jsonc for configuring biome.js format/lint

added package.json scripts for checking and fixing format/lint issues
with biome.js

added git hook commands for biome.js
added dependencies for swc transpilation

added package.json script for transpiling typescript code in /src
directory to javascript for production usage
added dependencies for fastify
added initial code for starting a fastify server
added type-safe json schema parsing for environment variables
added .env file for development and production environments
added packages for graphql, mercurius and pothos

integrated fastify graphql route handling using mercurius

added docs for pothos and developer workflows related to it

added script for generating the sdl graphql schema from pothos schema
added packages for drizzle orm and postgres

added drizzle schema definition in postgres dialect reflecting the
domain models of talawa application

added configuration environment variables for postgres client

added fastify plugin for registering the drizzle client on the global
fastify instance

added package.json scripts for drizzle orm, postgres and sql related
workflows

added zod enums for easily reusing type and runtime values between the
drizzle schema and the graphql schema
added the packages for general and graphql specific testing needs

added the configuration for vitest

added the tooling for writing type safe graphql operations in tests

added the scripts for checking schema errors in graphql operations
used in the tests

added a dummy query for showing the testing workflow, will be removed
in the future

added relevant documentation for the test directory

added the env file for ci environment
added OCI compliant Containerfile with multi-staged builds for creating
talawa api docker images for different environments

added docker compose configuration for automating setup of talawa api
infrastructure in different environments

added devcontainer configuration for automating talawa api development
environment setup

added env files specific to different talawa api environments
Copy link

coderabbitai bot commented Oct 17, 2024

Caution

Review failed

The head commit changed during the review from fead500 to 2719535.


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:

  1. The overall code coverage drops below the target threshold of the repository
  2. Any file in the pull request has code coverage levels below the repository threshold
  3. Merge conflicts

The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant