Error messages improved

[ashish-egov]

No description provided.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes enhance schema validation, error handling, and Kafka integration within the project. Key updates include adding an errorMessage parameter to the enrichSchema function, introducing Kafka topics for process tracking, and adding utility functions for process details and track persistence. Additionally, schema validation functions have been improved for better error handling and logging.

Changes

File Path	Change Summary
utilities/.../api/genericApis.ts	Added errorMessage parameter to enrichSchema and updated convertIntoSchema to handle error messages for properties.
utilities/.../config/index.ts	Introduced KAFKA_SAVE_PROCESS_TRACK_TOPIC and KAFKA_UPDATE_PROCESS_TRACK_TOPIC with default values.
utilities/.../utils/processTrackUtils.ts	Added functions for retrieving process details and persisting track information related to campaigns.
utilities/.../validators/campaignValidators.ts	Enhanced schema validation with addAjvErrors, improved error handling, and logging.
utilities/.../validators/genericValidator.ts	Updated return type of validateDataWithSchema, commented out specific validation lines, and adjusted destructuring assignment in validateHierarchyType.

Sequence Diagram(s)

sequenceDiagram
  participant Client
  participant Server
  participant Kafka

  Client->>Server: Send data for schema conversion
  Server->>Server: convertIntoSchema(data)
  Server->>Server: enrichSchema(data, properties, required, columns, unique, columnsNotToBeFreezed, errorMessage)
  Server->>Client: Return enriched schema

  Client->>Server: Send process details request
  Server->>Server: getProcessDetails(id)
  Server->>Kafka: Retrieve process details
  Kafka-->>Server: Return process details
  Server-->>Client: Return process details

  Client->>Server: Send track persistence request
  Server->>Server: persistTrack(campaignId, type, status, details, additionalDetails, id)
  Server->>Kafka: Produce message to KAFKA_SAVE_PROCESS_TRACK_TOPIC
  Server-->>Client: Acknowledge track persistence

Loading

Poem

In the code where schemas grow,
Error messages now bestow,
Kafka topics track the flow,
Processes with a unique glow.
Validators check with care,
Logging changes in the air,
CodeRabbit hops without compare! 🐰✨

---

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

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: 2

Outside diff range and nitpick comments (8)

utilities/project-factory/src/server/validators/genericValidator.ts (1)

Line range hint 225-225: Move variable declarations to the function's root.

The variable formattedErrorMessage is declared within a loop, which can lead to confusion and potential errors in larger functions. Consider moving this declaration to the root of the enclosing function to improve clarity and maintainability.

- let formattedErrorMessage = "";
+ let formattedErrorMessage;
  formattedErrorMessage = "";

utilities/project-factory/src/server/api/genericApis.ts (4)

Line range hint 67-69: Consider using optional chaining to simplify the code and enhance its robustness against potential undefined or null values.

- if (boundary.children.length > 0) {
+ if (boundary.children?.length > 0) {

---

Line range hint 568-568: The continue statement here is unnecessary as it is the last statement in the loop. Removing it will clean up the code without affecting functionality.

- continue;

---

Line range hint 640-658: These else clauses can be omitted because the previous branches break early, simplifying the control flow.

- else {
-   logger.info("Boundary Entities are already in the system")
- }

Also applies to: 655-657

---

Line range hint 246-246: The use of String as a type should be replaced with the lowercase string to maintain consistency and follow TypeScript best practices.

- idFormat: String,
+ idFormat: string,

- idFormat: String,
+ idFormat: string,

Also applies to: 287-287

utilities/project-factory/src/server/validators/campaignValidators.ts (3)

Line range hint 116-116: Avoid assignments within expressions to enhance clarity and maintainability.

- if (data.length == 0) {
+ if (data.length === 0) {

---

Line range hint 220-220: Replace hasOwnProperty with Object.hasOwn to avoid issues with objects that lack a prototype.

- if (obj.hasOwnProperty(lowestLevelHierarchy) && obj[lowestLevelHierarchy]) {
+ if (Object.hasOwn(obj, lowestLevelHierarchy) && obj[lowestLevelHierarchy]) {

Also applies to: 433-433, 443-443, 458-458

---

Line range hint 299-299: Declare variables at the root of the function to avoid potential hoisting issues.

- var response = await httpRequest(config.host.boundaryHost + config.paths.boundaryRelationship, request.body, boundaryEntitySearchParams);
+ let response = await httpRequest(config.host.boundaryHost + config.paths.boundaryRelationship, request.body, boundaryEntitySearchParams);

Also applies to: 707-707, 731-737

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b3a0b33 and 79b5ec1.

Files ignored due to path filters (3)

• utilities/project-factory/package-lock.json is excluded by !**/package-lock.json, !**/*.json
• utilities/project-factory/package.json is excluded by !**/*.json
• utilities/project-factory/yarn.lock is excluded by !**/*.lock, !**/*.lock

Files selected for processing (5)

• utilities/project-factory/src/server/api/genericApis.ts (6 hunks)
• utilities/project-factory/src/server/config/index.ts (1 hunks)
• utilities/project-factory/src/server/utils/processTrackUtils.ts (1 hunks)
• utilities/project-factory/src/server/validators/campaignValidators.ts (3 hunks)
• utilities/project-factory/src/server/validators/genericValidator.ts (3 hunks)

Additional context used

Biome

utilities/project-factory/src/server/validators/genericValidator.ts

[error] 200-200: Unsafe usage of optional chaining. (lint/correctness/noUnsafeOptionalChaining)

If it short-circuits with 'undefined' the evaluation will throw TypeError here:

---

[error] 201-201: Unsafe usage of optional chaining. (lint/correctness/noUnsafeOptionalChaining)

If it short-circuits with 'undefined' the evaluation will throw TypeError here:

---

[error] 203-203: Unsafe usage of optional chaining. (lint/correctness/noUnsafeOptionalChaining)

If it short-circuits with 'undefined' the evaluation will throw TypeError here:

---

[error] 224-224: Unsafe usage of optional chaining. (lint/correctness/noUnsafeOptionalChaining)

If it short-circuits with 'undefined' the evaluation will throw TypeError here:

---

[error] 225-225: This var should be declared at the root of the enclosing function. (lint/correctness/noInnerDeclarations)

The var is accessible in the whole body of the enclosing function.
To avoid confusion, it should be declared at the root of the enclosing function.

---

[error] 255-255: Unsafe usage of optional chaining. (lint/correctness/noUnsafeOptionalChaining)

If it short-circuits with 'undefined' the evaluation will throw TypeError here:

utilities/project-factory/src/server/api/genericApis.ts

[error] 67-69: Change to an optional chain. (lint/complexity/useOptionalChain)

Unsafe fix: Change to an optional chain.

---

[error] 568-568: Unnecessary continue statement (lint/correctness/noUnnecessaryContinue)

Unsafe fix: Delete the unnecessary continue statement

---

[error] 640-658: This else clause can be omitted because previous branches break early. (lint/style/noUselessElse)

Unsafe fix: Omit the else clause.

---

[error] 655-657: This else clause can be omitted because previous branches break early. (lint/style/noUselessElse)

Unsafe fix: Omit the else clause.

---

[error] 800-800: Unsafe usage of optional chaining. (lint/correctness/noUnsafeOptionalChaining)

If it short-circuits with 'undefined' the evaluation will throw TypeError here:

---

[error] 829-829: Unsafe usage of optional chaining. (lint/correctness/noUnsafeOptionalChaining)

If it short-circuits with 'undefined' the evaluation will throw TypeError here:

---

[error] 831-831: Unsafe usage of optional chaining. (lint/correctness/noUnsafeOptionalChaining)

If it short-circuits with 'undefined' the evaluation will throw TypeError here:

---

[error] 835-835: This var should be declared at the root of the enclosing function. (lint/correctness/noInnerDeclarations)

The var is accessible in the whole body of the enclosing function.
To avoid confusion, it should be declared at the root of the enclosing function.

---

[error] 923-923: This var should be declared at the root of the enclosing function. (lint/correctness/noInnerDeclarations)

The var is accessible in the whole body of the enclosing function.
To avoid confusion, it should be declared at the root of the enclosing function.

---

[error] 924-924: This var should be declared at the root of the enclosing function. (lint/correctness/noInnerDeclarations)

The var is accessible in the whole body of the enclosing function.
To avoid confusion, it should be declared at the root of the enclosing function.

---

[error] 246-246: Don't use 'String' as a type. (lint/complexity/noBannedTypes)

Use lowercase primitives for consistency.
Safe fix: Use 'string' instead

---

[error] 287-287: Don't use 'String' as a type. (lint/complexity/noBannedTypes)

Use lowercase primitives for consistency.
Safe fix: Use 'string' instead

utilities/project-factory/src/server/validators/campaignValidators.ts

[error] 116-116: The assignment should not be in an expression. (lint/suspicious/noAssignInExpressions)

The use of assignments in expressions is confusing.
Expressions are often considered as side-effect free.

---

[error] 220-220: Do not access Object.prototype method 'hasOwnProperty' from target object. (lint/suspicious/noPrototypeBuiltins)

It's recommended using Object.hasOwn() instead of using Object.hasOwnProperty().
See MDN web docs for more details.

---

[error] 299-299: This var should be declared at the root of the enclosing function. (lint/correctness/noInnerDeclarations)

The var is accessible in the whole body of the enclosing function.
To avoid confusion, it should be declared at the root of the enclosing function.

---

[error] 420-420: Unsafe usage of optional chaining. (lint/correctness/noUnsafeOptionalChaining)

If it short-circuits with 'undefined' the evaluation will throw TypeError here:

---

[error] 433-433: Do not access Object.prototype method 'hasOwnProperty' from target object. (lint/suspicious/noPrototypeBuiltins)

It's recommended using Object.hasOwn() instead of using Object.hasOwnProperty().
See MDN web docs for more details.

---

[error] 443-443: Do not access Object.prototype method 'hasOwnProperty' from target object. (lint/suspicious/noPrototypeBuiltins)

It's recommended using Object.hasOwn() instead of using Object.hasOwnProperty().
See MDN web docs for more details.

---

[error] 458-458: Do not access Object.prototype method 'hasOwnProperty' from target object. (lint/suspicious/noPrototypeBuiltins)

It's recommended using Object.hasOwn() instead of using Object.hasOwnProperty().
See MDN web docs for more details.

---

[error] 468-468: Unsafe usage of optional chaining. (lint/correctness/noUnsafeOptionalChaining)

If it short-circuits with 'undefined' the evaluation will throw TypeError here:

---

[error] 707-707: This var should be declared at the root of the enclosing function. (lint/correctness/noInnerDeclarations)

The var is accessible in the whole body of the enclosing function.
To avoid confusion, it should be declared at the root of the enclosing function.

---

[error] 716-716: Unsafe usage of optional chaining. (lint/correctness/noUnsafeOptionalChaining)

If it short-circuits with 'undefined' the evaluation will throw TypeError here:

---

[error] 731-737: This var should be declared at the root of the enclosing function. (lint/correctness/noInnerDeclarations)

The var is accessible in the whole body of the enclosing function.
To avoid confusion, it should be declared at the root of the enclosing function.

---

[error] 869-869: Unsafe usage of optional chaining. (lint/correctness/noUnsafeOptionalChaining)

If it short-circuits with 'undefined' the evaluation will throw TypeError here:

Additional comments not posted (8)

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

45-46: Validate the necessity of new Kafka topics.

The addition of KAFKA_SAVE_PROCESS_TRACK_TOPIC and KAFKA_UPDATE_PROCESS_TRACK_TOPIC to the configuration is noted. Please ensure that these topics are necessary and properly integrated into the system's Kafka message handling architecture.

Verification successful

---

The new Kafka topics KAFKA_SAVE_PROCESS_TRACK_TOPIC and KAFKA_UPDATE_PROCESS_TRACK_TOPIC are indeed referenced in the codebase, specifically in processTrackUtils.ts. This indicates that they are being utilized within the system.

• utilities/project-factory/src/server/utils/processTrackUtils.ts: References to both KAFKA_SAVE_PROCESS_TRACK_TOPIC and KAFKA_UPDATE_PROCESS_TRACK_TOPIC.

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify the usage of new Kafka topics in the system.

# Test: Search for the Kafka topic usage. Expect: References to these topics in Kafka consumers.
rg --type typescript $'KAFKA_SAVE_PROCESS_TRACK_TOPIC|KAFKA_UPDATE_PROCESS_TRACK_TOPIC'

Length of output: 123

---

---

Script:

#!/bin/bash
# Description: Verify the usage of new Kafka topics in the system.

# Test: Search for the Kafka topic usage. Expect: References to these topics in Kafka consumers.
rg --type ts 'KAFKA_SAVE_PROCESS_TRACK_TOPIC|KAFKA_UPDATE_PROCESS_TRACK_TOPIC'

Length of output: 584

utilities/project-factory/src/server/validators/genericValidator.ts (1)

12-12: Review the changes to error handling in validation.

The modifications in validateDataWithSchema to include detailed error logging are appropriate and enhance the error visibility, which is crucial for debugging and maintaining the validation logic.

utilities/project-factory/src/server/api/genericApis.ts (2)

Line range hint 1108-1139: The convertIntoSchema function now initializes an errorMessage object and populates it based on property error messages. This enhancement supports better error handling by allowing specific error messages to be associated with each property. Ensure that the error messages are comprehensive and cover all potential validation failures.

---

Line range hint 1075-1102: The enrichSchema function has been updated to include an errorMessage parameter. This change aligns with the PR's objective to improve error messages. However, ensure that all calls to this function across the codebase are updated to include this new parameter.

Verification successful

---

The function enrichSchema has been updated to include an errorMessage parameter, and all calls to this function within the codebase have been updated accordingly.

• utilities/project-factory/src/server/api/genericApis.ts: The function call includes the errorMessage parameter.

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify all function calls to `enrichSchema` match the new signature.

# Test: Search for the function usage. Expect: Only occurrences of the new signature.
rg --type typescript $'enrichSchema'

Length of output: 70

---

---

Script:

#!/bin/bash
# Description: Verify all function calls to `enrichSchema` match the new signature.

# Test: Search for the function usage. Expect: Only occurrences of the new signature.
rg --type ts $'enrichSchema'

Length of output: 378

utilities/project-factory/src/server/validators/campaignValidators.ts (4)

22-22: Import of addAjvErrors from "ajv-errors" is added to enhance error handling in AJV validations.

---

327-336: The function changeSchemaErrorMessage dynamically localizes schema error messages based on a provided map. This is a good practice for supporting multiple languages in error messages.

---

339-398: The function validateViaSchema has been significantly refactored to include dynamic error message handling and more robust validation logic. Ensure that all dependent functions and modules are updated to handle these changes effectively.

Verification successful

---

The search results indicate that the function validateViaSchema is only called within the same file where it is defined, and it matches the new signature.

• utilities/project-factory/src/server/validators/campaignValidators.ts:
  • Definition: async function validateViaSchema(data: any, schema: any, request: any, localizationMap?: any)
  • Call: await validateViaSchema(data, schema, request, localizationMap)

This confirms that the changes to validateViaSchema have been correctly applied and there are no other dependencies that need updating.

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Verify all function calls to `validateViaSchema` match the new signature and handle the changes.

# Test: Search for the function usage. Expect: Only occurances of the new signature.
rg --type typescript $'validateViaSchema'

Length of output: 75

---

---

Script:

#!/bin/bash
# Description: Verify all function calls to `validateViaSchema` match the new signature and handle the changes.

# Test: Search for the function usage. Expect: Only occurrences of the new signature.
rg --type ts 'validateViaSchema'

Length of output: 337

---

Line range hint 420-420: Check the usage of optional chaining to ensure that it does not lead to runtime errors if the chain evaluates to undefined.

Also applies to: 468-468, 716-716, 869-869