chore: migrate from supabase to postgresql #129

Ratnesh2003 · 2024-02-08T20:58:18Z

User description

Description

Removed the reliance on supabase as database for development and migrated to local Postgres using docker-compose.

Fixes #119

Dependencies

Removed the supabase dependency

Mentions

@rajdip-b

Developer's checklist

My PR follows the style guidelines of this project
I have performed a self-check on my work

If changes are made in the code:

I have followed the coding guidelines
My changes in code generate no new warnings
My changes are breaking another fix/feature of the project
I have added test cases to show that my feature works
I have added relevant screenshots in my PR
There are no UI/UX issues

Documentation Update

This PR requires an update to the documentation at docs.keyshade.xyz
I have made the necessary updates to the documentation, or no documentation changes are required.

Type

enhancement

Description

Migrated from Supabase to local Postgres using Docker and Prisma.
Removed all Supabase related modules, services, and tests.
Updated .dockerignore and .env.example to reflect changes.
Added docker-compose-dev.yml for local Postgres setup.
Removed @supabase/supabase-js dependency from package.json and pnpm-lock.yaml.

Changes walkthrough

Relevant files

Enhancement

4 files

app.module.ts `Migrate from Supabase to Prisma Module in AppModule` apps/api/src/app/app.module.ts Removed `SupabaseModule` import and usage. Added `PrismaModule` import and usage.	+0/-2
supabase.module.ts `Remove SupabaseModule File` apps/api/src/supabase/supabase.module.ts Entire `SupabaseModule` file removed.	+0/-9
supabase.service.spec.ts `Remove SupabaseService Test File` apps/api/src/supabase/supabase.service.spec.ts Entire `SupabaseService` spec file removed.	+0/-19
supabase.service.ts `Remove SupabaseService File` apps/api/src/supabase/supabase.service.ts Entire `SupabaseService` file removed.	+0/-23

Configuration changes

3 files

.dockerignore `Update .dockerignore to Exclude data Directory` .dockerignore Added `data/` directory to `.dockerignore`.	+2/-1
.env.example `Update Environment Variables Example` .env.example Removed Supabase environment variables.	+0/-2
docker-compose-dev.yml `Add Docker Compose for Development Database` docker-compose-dev.yml Added a new `docker-compose-dev.yml` for Postgres setup.	+13/-0

Dependencies

2 files

package.json `Remove Supabase Dependency from package.json` package.json Removed `@supabase/supabase-js` dependency.	+0/-1
pnpm-lock.yaml `Update Dependencies in pnpm-lock.yaml` pnpm-lock.yaml Removed `@supabase/supabase-js` and related dependencies.	+1/-63

✨ Usage guide:

Overview:
The describe tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

When commenting, to edit configurations related to the describe tool (pr_description section), use the following template:

/describe --pr_description.some_config1=... --pr_description.some_config2=...

With a configuration file, use the following template:

[pr_description]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the describe tool is: `pr_commands = ["/describe --pr_description.add_original_user_description=true" "--pr_description.keep_original_user_title=true", ...]` meaning the `describe` tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description. Markers are an alternative way to control the generated description, to give maximal control to the user. If you set: `pr_commands = ["/describe --pr_description.use_description_markers=true", ...]` the tool will replace every marker of the form `pr_agent:marker_name` in the PR description with the relevant content, where `marker_name` is one of the following: `type`: the PR type. `summary`: the PR summary. `walkthrough`: the PR walkthrough. Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.
Custom labels The default labels of the `describe` tool are quite generic: [`Bug fix`, `Tests`, `Enhancement`, `Documentation`, `Other`]. If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases. Examples for custom labels: `Main topic:performance` - pr_agent:The main topic of this PR is performance `New endpoint` - pr_agent:A new endpoint was added in this PR `SQL query` - pr_agent:A new SQL query was added in this PR `Dockerfile changes` - pr_agent:The PR contains changes in the Dockerfile ... The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases. Note that Labels are not mutually exclusive, so you can add multiple label categories. Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
Inline File Walkthrough 💎 For enhanced user experience, the `describe` tool can add file summaries directly to the "Files changed" tab in the PR page. This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs). To enable inline file summary, set `pr_description.inline_file_summary` in the configuration file, possible values are: `'table'`: File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab. `true`: A collapsable file comment with changes title and a changes summary for each file in the PR. `false` (default): File changes walkthrough will be added only to the "Conversation" tab.
Utilizing extra instructions The `describe` tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description. Examples for extra instructions: `[pr_description] extra_instructions=""" - The PR title should be in the format: '<PR type>: <title>' - The title should be short and concise (up to 10 words) - ... """` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the describe usage page for a comprehensive guide on using this tool.

codiumai-pr-agent-free · 2024-02-08T20:59:06Z

PR Description updated to latest commit (e21762b)

codiumai-pr-agent-free · 2024-02-08T20:59:26Z

PR Analysis

🎯 Main theme: Migration from Supabase to PostgreSQL
📝 PR summary: This PR removes the reliance on Supabase as the database for development and migrates to a local Postgres setup using Docker and Prisma. All Supabase related modules, services, and tests have been removed. The .dockerignore and .env.example files have been updated to reflect these changes.
📌 Type of PR: Enhancement
🧪 Relevant tests added: No
⏱️ Estimated effort to review [1-5]: 3, because the PR involves a significant change in the database setup which requires a good understanding of both Supabase and PostgreSQL. However, the code changes are straightforward and well-documented.
🔒 Security concerns: No

PR Feedback

💡 General suggestions: The PR is well-structured and the changes are clearly explained. However, it would be beneficial to add tests to ensure the new database setup works as expected. Also, it would be helpful to provide a migration guide or script for existing data in Supabase to the new PostgreSQL setup.

✨ Usage guide:

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions The `review` tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: `[pr_reviewer] # /review # extra_instructions=""" In the 'general suggestions' section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
How to enable\disable automation When you first install PR-Agent app, the default mode for the `review` tool is: `pr_commands = ["/review", ...]` meaning the `review` tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations
Auto-labels The `review` tool can auto-generate two specific types of labels for a PR: a `possible security issue` label, that detects possible security issues (`enable_review_labels_security` flag) a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag)
Extra sub-tools The `review` tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: `require_score_review`, `require_soc2_ticket`, and more.
Auto-approve PRs By invoking: `/review auto_approve` The tool will automatically approve the PR, and add a comment with the approval. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: `[pr_reviewer] enable_auto_approval = true` (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) You can also enable auto-approval only if the PR meets certain requirements, such as that the `estimated_review_effort` is equal or below a certain threshold, by adjusting the flag: `[pr_reviewer] maximal_review_effort = 5`
More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

codiumai-pr-agent-free · 2024-02-08T21:00:46Z

PR Code Suggestions

Suggestions

security

Add `.env` to the `.dockerignore` file to enhance security. Consider adding `.env` to your `.dockerignore` file to prevent accidentally including environment configuration files in your Docker context. This can help avoid unintentionally exposing sensitive information. .dockerignore [1-2] node_modules/ data/ +.env
Use environment variables for sensitive values in `docker-compose-dev.yml`. For the `dev-db` service, consider using environment variables for `POSTGRES_PASSWORD` and other sensitive values instead of hardcoding them. This can be achieved by using the `.env` file or Docker secrets for better security practices. docker-compose-dev.yml [8-10] environment: POSTGRES_USER: postgres - POSTGRES_PASSWORD: password + POSTGRES_PASSWORD: ${DB_PASSWORD} POSTGRES_DB: keyshade_db

enhancement

Use environment variable references in `.env.example` for better security and flexibility. Replace `{PASSWORD}` and `{HOST}` placeholders in `DATABASE_URL` with environment variable references (e.g., `${DB_PASSWORD}`) to enhance security and flexibility. This allows for easier configuration changes without modifying the codebase. .env.example [1] -DATABASE_URL=postgres://postgres:{PASSWORD}@{HOST}:5432/postgres +DATABASE_URL=postgres://postgres:${DB_PASSWORD}@${DB_HOST}:5432/postgres
Confirm all necessary PostgreSQL dependencies are included in `app.module.ts`. Ensure that all dependencies and modules required for PostgreSQL are properly imported and configured within `app.module.ts`, especially if there were specific Supabase services being used that have direct PostgreSQL equivalents. apps/api/src/app/app.module.ts [1-5] import { Module } from '@nestjs/common' import { AppController } from './app.controller' import { ConfigModule } from '@nestjs/config' import { PassportModule } from '@nestjs/passport' import { AuthModule } from '../auth/auth.module' +// Ensure all necessary PostgreSQL modules are imported here

✨ Usage guide:

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the improve tool is: `pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...]` meaning the `improve` tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.
Utilizing extra instructions Extra instructions are very important for the `improve` tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: `[pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
A note on code suggestions quality While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool With large PRs, best quality will be obtained by using 'improve --extended' mode.
More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.

rajdip-b

@Ratnesh2003 hey, could you please update your branch with main, run pnpm install and make the push again. Except that, all looks fine!

rajdip-b · 2024-02-09T04:45:17Z

@Ratnesh2003

…pabase-to-postgresql

nx-cloud · 2024-02-09T12:45:04Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit c8f5df3. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 5 targets

Sent with 💌 from NxCloud.

codecov · 2024-02-09T12:47:21Z

Codecov Report

Attention: 159 lines in your changes are missing coverage. Please review.

Comparison is base (ae73e7a) 31.22% compared to head (d60b892) 51.78%.
Report is 13 commits behind head on develop.

❗ Current head d60b892 differs from pull request most recent head c8f5df3. Consider uploading reports for the commit c8f5df3 to get more accurate results

Files	Patch %	Lines
apps/api/src/common/create-event.ts	41.66%	35 Missing ⚠️
apps/api/src/event/service/event.service.ts	26.47%	25 Missing ⚠️
...pps/api/src/workspace/service/workspace.service.ts	4.00%	24 Missing ⚠️
apps/api/src/secret/service/secret.service.ts	13.63%	19 Missing ⚠️
apps/api/src/auth/guard/auth/auth.guard.ts	65.78%	13 Missing ⚠️
apps/api/src/common/get-secret-with-authority.ts	26.66%	11 Missing ⚠️
...api/src/environment/service/environment.service.ts	18.18%	9 Missing ⚠️
apps/api/src/event/controller/event.controller.ts	64.28%	5 Missing ⚠️
apps/api/src/project/service/project.service.ts	20.00%	4 Missing ⚠️
apps/api/src/auth/controller/auth.controller.ts	57.14%	3 Missing ⚠️
... and 5 more

Additional details and impacted files

@@             Coverage Diff              @@
##           develop     #129       +/-   ##
============================================
+ Coverage    31.22%   51.78%   +20.55%     
============================================
  Files           54       75       +21     
  Lines         1156     1516      +360     
  Branches       210      267       +57     
============================================
+ Hits           361      785      +424     
+ Misses         795      731       -64

Flag	Coverage Δ
api-e2e-tests	`51.78% <53.64%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

rajdip-b · 2024-02-09T12:52:12Z

@Ratnesh2003 yo! drop into discord if you want to discuss or clarigy anything about this issue.

P.S. don't worry about the codecov reports, I am working on fixing that.

docker-compose-dev.yml

.env.example

…3/keyshade into modify/supabase-to-postgresql

sonarqubecloud · 2024-02-09T15:18:45Z

Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

## [1.1.0](v1.0.0...v1.1.0) (2024-02-12) ### 🚀 Features * **api:** add event ([#115](#115)) ([19e6603](19e6603)) ### 🔧 Miscellaneous Chores * **ci:** CI rework ([788c141](788c141)) * **ci:** update CI of web and API ([bd171da](bd171da)) * **husky:** Update precommit ([b170cf3](b170cf3)) * migrate from supabase to postgresql ([#129](#129)) ([e1ff912](e1ff912)) * update CI ([32eb820](32eb820)) * Update release config in package.json ([71c75a7](71c75a7)) * **version:** Upgrade next from 14.0.4 to 14.1.0 ([#136](#136)) ([c958865](c958865)) * **version:** Upgrade reflect-metadata from 0.1.14 to 0.2.1 ([#137](#137)) ([574b6ce](574b6ce))

rajdip-b · 2024-02-12T19:19:22Z

🎉 This PR is included in version 1.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

enhancement: migrate from supabase to postgresql

e21762b

codiumai-pr-agent-free bot added the type: enhancement New feature or request label Feb 8, 2024

codiumai-pr-agent-free bot added the Review effort [1-5]: 3 label Feb 8, 2024

rajdip-b requested changes Feb 9, 2024

View reviewed changes

rajdip-b changed the title ~~enhancement: migrate from supabase to postgresql~~ chore: migrate from supabase to postgresql Feb 9, 2024

Merge branch 'main' of github.com:Ratnesh2003/keyshade into modify/su…

6b2c228

…pabase-to-postgresql

Merge branch 'develop' into modify/supabase-to-postgresql

d60b892

rajdip-b requested changes Feb 9, 2024

View reviewed changes

docker-compose-dev.yml Outdated Show resolved Hide resolved

.env.example Outdated Show resolved Hide resolved

.env.example Outdated Show resolved Hide resolved

Ratnesh2003 and others added 3 commits February 9, 2024 19:43

refactor: DB connection URL in env file

7915263

Merge branch 'modify/supabase-to-postgresql' of github.com:Ratnesh200…

05be665

…3/keyshade into modify/supabase-to-postgresql

final touches

c8f5df3

rajdip-b approved these changes Feb 9, 2024

View reviewed changes

rajdip-b merged commit e1ff912 into keyshade-xyz:develop Feb 9, 2024
8 checks passed

rajdip-b added the released label Feb 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: migrate from supabase to postgresql #129

chore: migrate from supabase to postgresql #129

Ratnesh2003 commented Feb 8, 2024 •

edited by codiumai-pr-agent-free bot

Loading

codiumai-pr-agent-free bot commented Feb 8, 2024

codiumai-pr-agent-free bot commented Feb 8, 2024

codiumai-pr-agent-free bot commented Feb 8, 2024

rajdip-b left a comment

rajdip-b commented Feb 9, 2024

nx-cloud bot commented Feb 9, 2024 •

edited

Loading

codecov bot commented Feb 9, 2024 •

edited

Loading

rajdip-b commented Feb 9, 2024 •

edited

Loading

sonarqubecloud bot commented Feb 9, 2024

rajdip-b commented Feb 12, 2024

chore: migrate from supabase to postgresql #129

chore: migrate from supabase to postgresql #129

Conversation

Ratnesh2003 commented Feb 8, 2024 • edited by codiumai-pr-agent-free bot Loading

User description

Description

Dependencies

Mentions

Developer's checklist

Documentation Update

Type

Description

Changes walkthrough

codiumai-pr-agent-free bot commented Feb 8, 2024

codiumai-pr-agent-free bot commented Feb 8, 2024

PR Analysis

PR Feedback

codiumai-pr-agent-free bot commented Feb 8, 2024

PR Code Suggestions

rajdip-b left a comment

Choose a reason for hiding this comment

rajdip-b commented Feb 9, 2024

nx-cloud bot commented Feb 9, 2024 • edited Loading

☁️ Nx Cloud Report

codecov bot commented Feb 9, 2024 • edited Loading

Codecov Report

rajdip-b commented Feb 9, 2024 • edited Loading

sonarqubecloud bot commented Feb 9, 2024

Quality Gate passed

rajdip-b commented Feb 12, 2024

Ratnesh2003 commented Feb 8, 2024 •

edited by codiumai-pr-agent-free bot

Loading

nx-cloud bot commented Feb 9, 2024 •

edited

Loading

codecov bot commented Feb 9, 2024 •

edited

Loading

rajdip-b commented Feb 9, 2024 •

edited

Loading