Create LOCALSETUP.md

[ashish-egov]

No description provided.

[coderabbitai]

Warning

Rate Limit Exceeded

@ashish-egov has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 47 minutes and 31 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 02ef19d and 70b8f94.

Walkthrough

This update revolves around restructuring the configuration handling within the ProjectFactory service, specifically focusing on how database configuration properties are accessed. The dbPoolConfig.ts and index.ts files have been modified to encapsulate database settings within a DB_CONFIG object. Additionally, some unused configuration values and a utility function have been removed to streamline the codebase.

Changes

Files	Change Summary
utilities/project-factory/LOCALSETUP.md	Updated setup instructions for ProjectFactory service, no changes to exported or public entities.
utilities/project-factory/src/server/config/dbPoolConfig.ts	Modified database configuration access to use nested DB_CONFIG object within the config object.
utilities/project-factory/src/server/config/index.ts	Restructured database configuration into DB_CONFIG object, removed hierarchyType declaration, and eliminated several unused configuration entries.
utilities/project-factory/src/server/utils/genericUtils.ts	Removed callSearchApi function and its dependencies, adjusted export list accordingly.

Poem

In the code, a change has come,
Configs nested, cleanup done.
Database settings now align,
Streamlined paths, a clearer sign.
Old functions bid their last goodbye,
The code evolves, and so do I.
🐇✨

---

Tip

Early Access Features

• gpt-4o model for chat

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
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 full the 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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 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 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.

[coderabbitai]

Actionable comments posted: 5

Outside diff range and nitpick comments (4)

utilities/project-factory/src/server/utils/genericUtils.ts (4)

Line range hint 39-39: Replace any with more specific types to enhance type safety and maintainability.

- const throwErrorViaRequest = (message: any = "Internal Server Error") => {
+ const throwErrorViaRequest = (message: string | Error = "Internal Server Error") => {

Also applies to: 41-41, 47-47, 59-59, 60-60, 62-62, 69-69, 85-85, 103-103, 162-162

---

Line range hint 43-43: Use template literals for string concatenation to improve readability and maintain consistency with modern JavaScript practices.

- logger.error("Error : " + error + " " + (message?.description || ""));
+ logger.error(`Error : ${error} ${message?.description || ""}`);

Also applies to: 126-126, 137-137, 138-138

---

Line range hint 46-51: Remove unnecessary else clause to simplify control flow and improve code readability.

- else {
-   queryString += " type = $1 AND hierarchytype = $2 AND tenantid = $3 AND status = $4";
-   queryValues = [type, hierarchyType, tenantId, status];
- }

---

Line range hint 61-61: Use === instead of == for strict equality checks to avoid potential bugs related to type coercion.

- status = errorResult?.code == "UNKNOWN_ERROR" ? 500 : status;
+ status = errorResult?.code === "UNKNOWN_ERROR" ? 500 : status;

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3a67d25 and 29ac1b6.

Files selected for processing (4)

• utilities/project-factory/LOCALSETUP.md (1 hunks)
• utilities/project-factory/src/server/config/dbPoolConfig.ts (1 hunks)
• utilities/project-factory/src/server/config/index.ts (2 hunks)
• utilities/project-factory/src/server/utils/genericUtils.ts (4 hunks)

Additional Context Used

LanguageTool (8)

utilities/project-factory/LOCALSETUP.md (8)

Near line 3: The word “setup” is a noun. The verb is spelled with a white space.
Context: # Local Setup To setup the ProjectFactory service in your loca...
Rule ID: NOUN_VERB_CONFUSION

---

Near line 7: To make your text as clear as possible to all readers, do not use this foreign term. Possible alternatives are “below” or “further on” (in a document).
Context: .../DIGIT-Frontend). ## Dependencies ### Infra Dependency - [x] Postgres DB - [ ] Red...
Rule ID: INFRA

---

Near line 19: The word “setup” is a noun. The verb is spelled with a white space.
Context: ... Running Locally ### Local setup 1. To setup the ProjectFactory service, clone the [...
Rule ID: NOUN_VERB_CONFUSION

---

Near line 30: A comma might be missing here.
Context: ...n dev` > Note: After running the above command if kafka error comes then make sure tha...
Rule ID: AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA

---

Near line 30: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...then make sure that kafka and zookeeper runs in background and if other microservice...
Rule ID: AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER

---

Near line 30: You might be missing the article “the” here.
Context: ...e sure that kafka and zookeeper runs in background and if other microservice connection er...
Rule ID: AI_EN_LECTOR_MISSING_DETERMINER_THE

---

Near line 30: Consider adding a comma.
Context: ...ther microservice connection error comes then make sure that in data config the url m...
Rule ID: IF_THEN_COMMA

---

Near line 30: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...mentioned in external mapping is correct or you can port-forward that particular se...
Rule ID: COMMA_COMPOUND_SENTENCE

Markdownlint (5)

utilities/project-factory/LOCALSETUP.md (5)

25: Expected: 0 or 2; Actual: 54
Trailing spaces

---

27: Expected: 0 or 2; Actual: 145
Trailing spaces

---

18: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

---

19: null
Lists should be surrounded by blank lines

---

20: null
Bare URL used

Biome (22)

utilities/project-factory/src/server/config/dbPoolConfig.ts (1)

9-9: Use Number.parseInt instead of the equivalent global.

utilities/project-factory/src/server/config/index.ts (1)

59-59: Use Number.parseInt instead of the equivalent global.

utilities/project-factory/src/server/utils/genericUtils.ts (20)

39-39: Unexpected any. Specify a different type.

---

41-41: Unexpected any. Specify a different type.

---

43-43: Template literals are preferred over string concatenation.

---

46-51: This else clause can be omitted because previous branches break early.

---

47-47: Unexpected any. Specify a different type.

---

49-49: Template literals are preferred over string concatenation.

---

59-59: Unexpected any. Specify a different type.

---

60-60: Unexpected any. Specify a different type.

---

61-61: Use === instead of ==.
== is only allowed when comparing against null

---

62-62: Unexpected any. Specify a different type.

---

69-69: Unexpected any. Specify a different type.

---

69-69: Unexpected any. Specify a different type.

---

85-85: Unexpected any. Specify a different type.

---

103-103: Unexpected any. Specify a different type.

---

105-105: This type annotation is trivially inferred from its initialization.

---

126-126: Template literals are preferred over string concatenation.

---

137-137: Template literals are preferred over string concatenation.

---

138-138: Template literals are preferred over string concatenation.

---

154-154: Use === instead of ==.
== is only allowed when comparing against null

---

162-162: Unexpected any. Specify a different type.

[coderabbitai]

Actionable comments posted: 5

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 29ac1b6 and 02ef19d.

Files selected for processing (1)

• utilities/project-factory/LOCALSETUP.md (1 hunks)

Additional Context Used

LanguageTool (5)

utilities/project-factory/LOCALSETUP.md (5)

Near line 3: The word “setup” is a noun. The verb is spelled with a white space.
Context: # Local Setup To setup the ProjectFactory service in your loca...
Rule ID: NOUN_VERB_CONFUSION

---

Near line 7: To make your text as clear as possible to all readers, do not use this foreign term. Possible alternatives are “below” or “further on” (in a document).
Context: .../DIGIT-Frontend). ## Dependencies ### Infra Dependency - [x] Postgres DB - [ ] Red...
Rule ID: INFRA

---

Near line 19: The word “setup” is a noun. The verb is spelled with a white space.
Context: ... Running Locally ### Local setup 1. To setup the ProjectFactory service, clone the [...
Rule ID: NOUN_VERB_CONFUSION

---

Near line 32: Consider adding a comma.
Context: ...ther microservice connection error comes then make sure that in data config the url m...
Rule ID: IF_THEN_COMMA

---

Near line 32: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...mentioned in external mapping is correct or you can port-forward that particular se...
Rule ID: COMMA_COMPOUND_SENTENCE

Markdownlint (5)

utilities/project-factory/LOCALSETUP.md (5)

27: Expected: 0 or 2; Actual: 54
Trailing spaces

---

29: Expected: 0 or 2; Actual: 145
Trailing spaces

---

18: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

---

19: null
Lists should be surrounded by blank lines

---

21: null
Bare URL used

Additional comments not posted (4)

utilities/project-factory/LOCALSETUP.md (4)

7-7: Improve section title for clarity.

- ### Infra Dependency
+ ### Infrastructure Dependencies

---

19-19: Ensure lists are surrounded by blank lines for proper markdown formatting.

+ 
1. To set up the ProjectFactory service, clone the [Digit Frontend repository](https://github.com/egovernments/DIGIT-Frontend).
+ 

---

19-19: Correct verb usage for "set up".

- 1. To setup the ProjectFactory service
+ 1. To set up the ProjectFactory service

---

32-32: Improve grammar and punctuation in the note about Kafka and microservices for better readability.

- > Note: After running the above command if kafka error comes then make sure that kafka and zookeeper runs in background and if other microservice connection error comes then make sure that in data config the url mentioned in external mapping is correct or you can port-forward that particular service
+ > Note: After running the above command, if a Kafka error occurs, ensure that Kafka and Zookeeper are running in the background. If a connection error with another microservice occurs, ensure that the URL mentioned in the external mapping of the data config is correct, or you can port-forward that particular service.